workspace/libs/plasma/scripting/appletscript.h

   1 /*
   2  *   Copyright 2007 by Aaron Seigo <aseigo@kde.org>
   3  *
   4  *   This program is free software; you can redistribute it and/or modify
   5  *   it under the terms of the GNU Library General Public License as
   6  *   published by the Free Software Foundation; either version 2, or
   7  *   (at your option) any later version.
   8  *
   9  *   This program is distributed in the hope that it will be useful,
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *   GNU General Public License for more details
  13  *
  14  *   You should have received a copy of the GNU Library General Public
  15  *   License along with this program; if not, write to the
  16  *   Free Software Foundation, Inc.,
  17  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  */
  19
  20 #ifndef PLASMA_APPLETSCRIPT_H
  21 #define PLASMA_APPLETSCRIPT_H
  22
  23
  24 #include <QtCore/QObject>
  25 #include <QtCore/QRect>
  26 #include <QtCore/QSizeF>
  27
  28 #include <KGenericFactory>
  29
  30 #include <plasma/plasma_export.h>
  31 #include <plasma/scripting/scriptengine.h>
  32
  33 class QPainter;
  34 class QStyleOptionGraphicsItem;
  35
  36 namespace Plasma
  37 {
  38
  39 class PLASMA_EXPORT AppletScript : public ScriptEngine
  40 {
  41     Q_OBJECT
  42
  43 public:
  44     /**
  45      * Default constructor for an AppletScript.
  46      * Subclasses should not attempt to access the Plasma::Applet
  47      * associated with this AppletScript in the constructor. All
  48      * such set up that requires the Applet itself should be done
  49      * in the init() method.
  50      */
  51     explicit AppletScript(QObject *parent = 0);
  52     ~AppletScript();
  53
  54     /**
  55      * Sets the applet associated with this AppletScript
  56      */
  57     void setApplet(Plasma::Applet *applet);
  58
  59     /**
  60      * Returns the Plasma::Applet associated with this script component
  61      */
  62     Plasma::Applet* applet() const;
  63
  64     /**
  65      * Called when the script should paint the applet
  66      *
  67      * @param painter the QPainter to use
  68      * @param option the style option containing such flags as selection, level of detail, etc
  69      **/
  70     virtual void paintInterface(QPainter* painter,
  71                                 const QStyleOptionGraphicsItem* option,
  72                                 const QRect &contentsRect);
  73
  74     /**
  75      * Called to discover the content size hint for the item.
  76      * The default implementation simply returns the Applet's contentSizeHint
  77      */
  78     virtual QSizeF contentSizeHint() const;
  79
  80     Q_INVOKABLE QSizeF size() const;
  81
  82 protected:
  83     /**
  84      * @arg engine name of the engine
  85      * @return a data engine associated with this plasmoid
  86      */
  87     Q_INVOKABLE DataEngine* dataEngine(const QString &engine) const;
  88
  89     /**
  90      * @return absolute path to the main script file for this plasmoid
  91      **/
  92     QString mainScript() const;
  93
  94     /**
  95      * @return the Package associated with this plasmoid which can
  96      *         be used to request resources, such as images and
  97      *         interface files.
  98      */
  99     const Package* package() const;
 100
 101 private:
 102     class Private;
 103     Private * const d;
 104 };
 105
 106 #define K_EXPORT_PLASMA_APPLETSCRIPTENGINE(libname, classname) \
 107 K_PLUGIN_FACTORY(factory, registerPlugin<classname>();) \
 108 K_EXPORT_PLUGIN(factory("plasma_appletscriptengine_" #libname))
 109
 110 } //Plasma namespace
 111
 112 #endif