containmentactions.h

Go to the documentation of this file.

/*
 *   Copyright (c) 2009 Chani Armitage <chani@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_CONTAINMENTACTIONS_H
#define PLASMA_CONTAINMENTACTIONS_H

#include <QList>

#include <kplugininfo.h>

#include <plasma/plasma.h>
#include <plasma/packagestructure.h>
#include <plasma/version.h>

class QAction;

namespace Plasma
{

class DataEngine;
class Containment;
class ContainmentActionsPrivate;

class PLASMA_EXPORT ContainmentActions : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString name READ name)
    Q_PROPERTY(QString pluginName READ pluginName)
    Q_PROPERTY(QString icon READ icon)

    public:
        explicit ContainmentActions(QObject * parent = 0);

        ~ContainmentActions();

        static KPluginInfo::List listContainmentActionsInfo();

        static ContainmentActions *load(Containment *parent, const QString &name, const QVariantList &args = QVariantList());

        static ContainmentActions *load(Containment *parent, const KPluginInfo &info, const QVariantList &args = QVariantList());

        static PackageStructure::Ptr packageStructure();

        QString name() const;

        QString pluginName() const;

        QString icon() const;

        bool isInitialized() const;

        void restore(const KConfigGroup &config);

        virtual void save(KConfigGroup &config);

        virtual QWidget *createConfigurationInterface(QWidget *parent);

        virtual void configurationAccepted();

        virtual void contextEvent(QEvent *event);

        virtual QList<QAction*> contextualActions();

        Q_INVOKABLE DataEngine *dataEngine(const QString &name) const;

        bool configurationRequired() const;

        static QString eventToString(QEvent *event);

        QPoint popupPosition(const QSize &s, QEvent *event);

        bool event(QEvent *e);

        void setContainment(Containment *newContainment);

    protected:
        ContainmentActions(QObject *parent, const QVariantList &args);

        virtual void init(const KConfigGroup &config);

        void setConfigurationRequired(bool needsConfiguring = true);

        Containment *containment();

        void paste(QPointF scenePos, QPoint screenPos);

    private:
        friend class ContainmentActionsPackage;
        friend class ContainmentActionsPrivate;
        ContainmentActionsPrivate *const d;
};

} // Plasma namespace

#define K_EXPORT_PLASMA_CONTAINMENTACTIONS(libname, classname) \
K_PLUGIN_FACTORY(factory, registerPlugin<classname>();) \
K_EXPORT_PLUGIN(factory("plasma_containmentactions_" #libname)) \
K_EXPORT_PLUGIN_VERSION(PLASMA_VERSION)

#endif // PLASMA_CONTAINMENTACTIONS_H