appletscript.h

Go to the documentation of this file.

/*
 *   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>

#include <kgenericfactory.h>
#include <kplugininfo.h>

#include <plasma/containment.h>
#include <plasma/plasma_export.h>
#include <plasma/scripting/scriptengine.h>

class QAction;
class QPainter;
class QStyleOptionGraphicsItem;
class KConfigDialog;

namespace Plasma
{

class Animation;
class AppletScriptPrivate;
class Extender;

class PLASMA_EXPORT AppletScript : public ScriptEngine
{
    Q_OBJECT

public:
    explicit AppletScript(QObject *parent = 0);
    ~AppletScript();

    void setApplet(Plasma::Applet *applet);

    Plasma::Applet *applet() const;

    virtual void paintInterface(QPainter *painter,
                                const QStyleOptionGraphicsItem *option,
                                const QRect &contentsRect);

    Q_INVOKABLE QSizeF size() const;

    virtual void constraintsEvent(Plasma::Constraints constraints);

    virtual QList<QAction*> contextualActions();

    virtual QPainterPath shape() const;

    void setHasConfigurationInterface(bool hasInterface);

    void setConfigurationRequired(bool req, const QString &reason = QString());

    void setFailedToLaunch(bool failed, const QString &reason = QString());

    void configNeedsSaving() const;

    Extender *extender() const;

    //FIXME plasma2: setWallpaperEnabled and setContainmentType should become public?
     bool drawWallpaper() const;
     void setDrawWallpaper(bool drawWallpaper);

     Containment::Type containmentType() const;

     void setContainmentType(Containment::Type type);

Q_SIGNALS:
    void saveState(KConfigGroup &group) const;

    void popupEvent(bool popped) const;

public Q_SLOTS:

    virtual void showConfigurationInterface();

    virtual void configChanged();

protected:
    Q_INVOKABLE DataEngine *dataEngine(const QString &engine) const;

    QString mainScript() const;

    const Package *package() const;

    KPluginInfo description() const;

    KConfigDialog *standardConfigurationDialog();

    void addStandardConfigurationPages(KConfigDialog *dialog);

    void showMessage(const QIcon &icon, const QString &message, const MessageButtons buttons);

    void registerAsDragHandle(QGraphicsItem *item);

    void unregisterAsDragHandle(QGraphicsItem *item);

    bool isRegisteredAsDragHandle(QGraphicsItem *item);

    Animation *loadAnimationFromPackage(const QString &name, QObject *parent);

private:
    friend class Applet;
    friend class PopupApplet;

    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