2008-11-04 00:08:39 +01:00
|
|
|
/*
|
|
|
|
* Copyright 2007 by Aaron Seigo <aseigo@kde.org>
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU Library General Public License as
|
|
|
|
* published by the Free Software Foundation; either version 2, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Library General Public
|
|
|
|
* License along with this program; if not, write to the
|
|
|
|
* Free Software Foundation, Inc.,
|
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef PLASMA_APPLETSCRIPT_H
|
|
|
|
#define PLASMA_APPLETSCRIPT_H
|
|
|
|
|
|
|
|
#include <QtCore/QObject>
|
|
|
|
#include <QtCore/QRect>
|
|
|
|
#include <QtCore/QSizeF>
|
|
|
|
|
2009-11-11 01:25:54 +01:00
|
|
|
#include <kplugininfo.h>
|
2008-11-04 00:08:39 +01:00
|
|
|
|
2011-02-22 13:21:33 +01:00
|
|
|
#include <plasma/containment.h>
|
2008-11-04 00:08:39 +01:00
|
|
|
#include <plasma/plasma_export.h>
|
|
|
|
#include <plasma/scripting/scriptengine.h>
|
|
|
|
|
|
|
|
class QAction;
|
|
|
|
class QPainter;
|
|
|
|
class QStyleOptionGraphicsItem;
|
2009-02-24 03:32:48 +01:00
|
|
|
class KConfigDialog;
|
2008-11-04 00:08:39 +01:00
|
|
|
|
|
|
|
namespace Plasma
|
|
|
|
{
|
|
|
|
|
|
|
|
class AppletScriptPrivate;
|
2009-06-01 17:53:32 +02:00
|
|
|
class Extender;
|
2008-11-04 00:08:39 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @class AppletScript plasma/scripting/appletscript.h <Plasma/Scripting/AppletScript>
|
|
|
|
*
|
|
|
|
* @short Provides a restricted interface for scripted applets.
|
|
|
|
*/
|
|
|
|
class PLASMA_EXPORT AppletScript : public ScriptEngine
|
|
|
|
{
|
|
|
|
Q_OBJECT
|
|
|
|
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* Default constructor for an AppletScript.
|
|
|
|
*
|
|
|
|
* Subclasses should not attempt to access the Plasma::Applet
|
|
|
|
* associated with this AppletScript in the constructor. All
|
|
|
|
* such set up that requires the Applet itself should be done
|
|
|
|
* in the init() method.
|
|
|
|
*/
|
|
|
|
explicit AppletScript(QObject *parent = 0);
|
|
|
|
~AppletScript();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the applet associated with this AppletScript
|
|
|
|
*/
|
|
|
|
void setApplet(Plasma::Applet *applet);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the Plasma::Applet associated with this script component
|
|
|
|
*/
|
|
|
|
Plasma::Applet *applet() const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Called when the script should paint the applet
|
|
|
|
*
|
|
|
|
* @param painter the QPainter to use
|
|
|
|
* @param option the style option containing such flags as selection, level of detail, etc
|
2009-01-10 01:08:31 +01:00
|
|
|
* @param contentsRect the rect to paint within; automatically adjusted for
|
|
|
|
* the background, if any
|
2008-11-04 00:08:39 +01:00
|
|
|
*/
|
|
|
|
virtual void paintInterface(QPainter *painter,
|
|
|
|
const QStyleOptionGraphicsItem *option,
|
|
|
|
const QRect &contentsRect);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the area within which contents can be painted.
|
|
|
|
**/
|
|
|
|
Q_INVOKABLE QSizeF size() const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Called when any of the geometry constraints have been updated.
|
|
|
|
*
|
|
|
|
* This is always called prior to painting and should be used as an
|
|
|
|
* opportunity to layout the widget, calculate sizings, etc.
|
|
|
|
*
|
|
|
|
* Do not call update() from this method; an update() will be triggered
|
|
|
|
* at the appropriate time for the applet.
|
|
|
|
*
|
|
|
|
* @param constraints the type of constraints that were updated
|
|
|
|
*/
|
|
|
|
virtual void constraintsEvent(Plasma::Constraints constraints);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns a list of context-related QAction instances.
|
|
|
|
*
|
|
|
|
* @return A list of actions. The default implementation returns an
|
|
|
|
* empty list.
|
|
|
|
*/
|
|
|
|
virtual QList<QAction*> contextualActions();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets whether or not this script has a configuration interface or not
|
|
|
|
*
|
2011-06-13 14:47:29 +02:00
|
|
|
* @param hasInterface true if the applet is user configurable
|
2008-11-04 00:08:39 +01:00
|
|
|
*/
|
|
|
|
void setHasConfigurationInterface(bool hasInterface);
|
|
|
|
|
2008-12-29 09:22:28 +01:00
|
|
|
/**
|
|
|
|
* @see Applet
|
|
|
|
*/
|
|
|
|
void setConfigurationRequired(bool req, const QString &reason = QString());
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @see Applet
|
|
|
|
*/
|
|
|
|
void setFailedToLaunch(bool failed, const QString &reason = QString());
|
|
|
|
|
2009-01-06 04:02:22 +01:00
|
|
|
/**
|
|
|
|
* @see Applet
|
|
|
|
*/
|
|
|
|
void configNeedsSaving() const;
|
|
|
|
|
2011-02-22 13:21:33 +01:00
|
|
|
/**
|
|
|
|
* @return true if the applet is a containment AND if the wallpaper is enabled
|
|
|
|
* @see Containment
|
|
|
|
* @since 4.7
|
|
|
|
*/
|
|
|
|
bool drawWallpaper() const;
|
|
|
|
/**
|
|
|
|
* set if the containment draws its own wallpaper: it has no effect if the applet is not a containment
|
|
|
|
* @see Containment
|
|
|
|
* @since 4.7
|
|
|
|
*/
|
|
|
|
void setDrawWallpaper(bool drawWallpaper);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @see Containment
|
|
|
|
* @since 4.7
|
|
|
|
*/
|
|
|
|
Containment::Type containmentType() const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @see Containment
|
|
|
|
* @since 4.7
|
|
|
|
*/
|
|
|
|
void setContainmentType(Containment::Type type);
|
|
|
|
|
2009-11-05 19:43:39 +01:00
|
|
|
Q_SIGNALS:
|
|
|
|
/**
|
|
|
|
* @see Applet
|
|
|
|
*/
|
|
|
|
void saveState(KConfigGroup &group) const;
|
|
|
|
|
2010-02-28 16:10:30 +01:00
|
|
|
/**
|
|
|
|
* @see PopupApplet
|
|
|
|
*/
|
|
|
|
void popupEvent(bool popped) const;
|
|
|
|
|
2008-11-04 00:08:39 +01:00
|
|
|
public Q_SLOTS:
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Show a configuration dialog.
|
|
|
|
*/
|
|
|
|
virtual void showConfigurationInterface();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Configure was changed.
|
|
|
|
*/
|
|
|
|
virtual void configChanged();
|
|
|
|
|
|
|
|
protected:
|
|
|
|
/**
|
2011-06-13 14:47:29 +02:00
|
|
|
* @param engine name of the engine
|
2008-11-04 00:08:39 +01:00
|
|
|
* @return a data engine associated with this plasmoid
|
|
|
|
*/
|
|
|
|
Q_INVOKABLE DataEngine *dataEngine(const QString &engine) const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return absolute path to the main script file for this plasmoid
|
|
|
|
*/
|
|
|
|
QString mainScript() const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return the Package associated with this plasmoid which can
|
|
|
|
* be used to request resources, such as images and
|
|
|
|
* interface files.
|
|
|
|
*/
|
2011-07-15 13:04:16 +02:00
|
|
|
Package package() const;
|
2008-11-04 00:08:39 +01:00
|
|
|
|
2009-11-11 01:25:54 +01:00
|
|
|
/**
|
|
|
|
* @return the KPluginInfo associated with this plasmoid
|
|
|
|
*/
|
|
|
|
KPluginInfo description() const;
|
|
|
|
|
2009-02-24 03:32:48 +01:00
|
|
|
/**
|
|
|
|
* @return a standard Plasma applet configuration dialog, ready
|
|
|
|
* to have pages added to it.
|
|
|
|
*
|
|
|
|
* Note that the dialog returned is set to delete on close.
|
|
|
|
*/
|
|
|
|
KConfigDialog *standardConfigurationDialog();
|
|
|
|
|
2009-08-20 20:19:44 +02:00
|
|
|
/**
|
|
|
|
* This method should be called after a scripting applet has added
|
|
|
|
* its own pages to a configuration dialog
|
2009-08-21 16:50:29 +02:00
|
|
|
*
|
|
|
|
* @since 4.3.1
|
2009-08-20 20:19:44 +02:00
|
|
|
*/
|
|
|
|
void addStandardConfigurationPages(KConfigDialog *dialog);
|
|
|
|
|
2009-11-05 19:43:39 +01:00
|
|
|
/**
|
|
|
|
* @see Applet
|
|
|
|
*/
|
|
|
|
void showMessage(const QIcon &icon, const QString &message, const MessageButtons buttons);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @see Applet
|
|
|
|
*/
|
|
|
|
void registerAsDragHandle(QGraphicsItem *item);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @see Applet
|
|
|
|
*/
|
|
|
|
void unregisterAsDragHandle(QGraphicsItem *item);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @see Applet
|
|
|
|
*/
|
|
|
|
bool isRegisteredAsDragHandle(QGraphicsItem *item);
|
|
|
|
|
2008-11-04 00:08:39 +01:00
|
|
|
private:
|
2009-11-05 19:43:39 +01:00
|
|
|
friend class Applet;
|
2010-02-28 16:10:30 +01:00
|
|
|
friend class PopupApplet;
|
2009-11-05 19:43:39 +01:00
|
|
|
|
2008-11-04 00:08:39 +01:00
|
|
|
AppletScriptPrivate *const d;
|
|
|
|
};
|
|
|
|
|
|
|
|
#define K_EXPORT_PLASMA_APPLETSCRIPTENGINE(libname, classname) \
|
|
|
|
K_PLUGIN_FACTORY(factory, registerPlugin<classname>();) \
|
|
|
|
K_EXPORT_PLUGIN(factory("plasma_appletscriptengine_" #libname))
|
|
|
|
|
|
|
|
} //Plasma namespace
|
|
|
|
|
|
|
|
#endif
|