• Skip to content
• Skip to link menu

KDE 4.0 API Reference

• KDE API Reference
• API Reference

• Sitemap
• Contact Us

 

libplasma

applet.h

Go to the documentation of this file.

/*
 *   Copyright 2006-2007 by Aaron Seigo <aseigo@kde.org>
 *   Copyright 2007 by Riccardo Iaconelli <riccardo@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_APPLET_H
#define PLASMA_APPLET_H

#include <QtGui/QGraphicsItem>
#include <QtGui/QWidget>

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

#include <plasma/configxml.h>
#include <plasma/plasma.h>
#include <plasma/widgets/widget.h>

namespace Plasma
{

class Containment;
class DataEngine;
class Package;

class PLASMA_EXPORT Applet : public Widget
{
    Q_OBJECT
//    Q_PROPERTY( QRectF maxSizeHint READ maxSizeHint )
    Q_PROPERTY( bool hasConfigurationInterface READ hasConfigurationInterface WRITE setHasConfigurationInterface )
    Q_PROPERTY( QString name READ name )
    Q_PROPERTY( QString category READ category )
    Q_PROPERTY( bool immutable READ isImmutable WRITE setImmutable )
    Q_PROPERTY( bool drawStandardBackground READ drawStandardBackground WRITE setDrawStandardBackground )
    Q_PROPERTY( bool failedToLaunch READ failedToLaunch WRITE setFailedToLaunch )
    Q_PROPERTY( bool needsConfiguring READ needsConfiguring WRITE setNeedsConfiguring )
    Q_PROPERTY( QRectF boundingRect READ boundingRect )
    Q_PROPERTY( QRectF geometry READ geometry WRITE setGeometry )
    Q_PROPERTY( bool shouldConserveResources READ shouldConserveResources )

    public:
        typedef QList<Applet*> List;
        typedef QHash<QString, Applet*> Dict;

        explicit Applet(QGraphicsItem* parent = 0,
                        const QString& serviceId = QString(),
                        uint appletId = 0);

        Applet(QObject* parent, const QVariantList& args);

        ~Applet();

        virtual void init();

        uint id() const;

        KConfigGroup config() const;

        KConfigGroup config(const QString &group) const;

        void save(KConfigGroup* group) const;

        KConfigGroup globalConfig() const;

        ConfigXml* configXml() const;

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

        const Package* package() const;

        void updateConstraints(Plasma::Constraints constraints = Plasma::AllConstraints);

        virtual void constraintsUpdated(Plasma::Constraints constraints);

        virtual FormFactor formFactor() const;

        virtual Location location() const;

        QRectF contentRect() const;

        QSizeF contentSize() const;

        void setContentSize(const QSizeF &size);

        void setContentSize(int width, int height);

        virtual QSizeF contentSizeHint() const;

        void setMinimumContentSize(const QSizeF &minSize);

        void setMinimumContentSize(int minWidth, int minHeight);

        QSizeF minimumContentSize() const;

        void setMaximumContentSize(const QSizeF &maxSize);

        void setMaximumContentSize(int maxWidth, int maxHeight);

        QSizeF maximumContentSize() const;

        static KPluginInfo::List knownApplets(const QString &category = QString(),
                                              const QString &parentApp = QString());

        static KPluginInfo::List knownAppletsForMimetype(const QString &mimetype);

        static QStringList knownCategories(const QString &parentApp = QString(), bool visibleOnly = true);

        bool hasConfigurationInterface();

        static Applet* loadApplet(const QString &name, uint appletId = 0,
                                  const QVariantList& args = QVariantList());

        static Applet* loadApplet(const KPluginInfo& info, uint appletId = 0,
                                  const QVariantList& args = QVariantList());

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

        QString name() const;

        QString pluginName() const;

        bool shouldConserveResources() const;

        QString icon() const;

        QString category() const;

        QColor color() const;

        static QString category(const KPluginInfo& applet);

        static QString category(const QString& appletName);

        bool isImmutable() const;

        bool isKioskImmutable() const;

        bool drawStandardBackground();

        void setDrawStandardBackground(bool drawBackground);

        bool failedToLaunch() const;

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

        bool needsConfiguring() const;

        void setNeedsConfiguring(bool needsConfiguring);
        enum { Type = Plasma::AppletType };

        int type() const;

        QRectF boundingRect () const;

        virtual QList<QAction*> contextActions();

        void setShadowShown(bool);
        bool isShadowShown() const;

        // reimplemented from LayoutItem
        // value is the same as contentSizeHint() if drawStandardBackground() is false
        // or contentSizeHint() plus the size of the border otherwise.
        virtual QSizeF sizeHint() const;

        void setGeometry(const QRectF &geometry);

        void setIsContainment(bool isContainment);

        bool isContainment() const;

        void resetConfigurationObject();

    Q_SIGNALS:
        void requestFocus( bool focus );

        void geometryChanged();

        void configNeedsSaving();

    public Q_SLOTS:
        void setImmutable(bool immutable);

        void destroy();

        virtual void showConfigurationInterface();

        void flushUpdatedConstraints();

        Containment* containment() const;

    protected:
        virtual void saveState(KConfigGroup* config) const;

        QString globalName() const;

        QString instanceName() const;

        void watchForFocus( QObject *widget, bool watch = true );

        void needsFocus(bool focus);

        void setHasConfigurationInterface(bool hasInterface);

        bool eventFilter( QObject *o, QEvent *e );

        QVariant itemChange(GraphicsItemChange change, const QVariant &value);

    protected Q_SLOTS:
        void performSetupConfig();

        void checkImmutability();

    private:
        Q_DISABLE_COPY(Applet)

        
        void paintWidget(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);

        class Private;
        Private* const d;
};

} // Plasma namespace

#define K_EXPORT_PLASMA_APPLET(libname, classname) \
K_PLUGIN_FACTORY(factory, registerPlugin<classname>();) \
K_EXPORT_PLUGIN(factory("plasma_applet_" #libname))

#endif // multiple inclusion guard

libplasma

Skip menu "libplasma"

• Main Page
• Namespace List
• Class Hierarchy
• Alphabetical List
• Class List
• File List
• Namespace Members
• Class Members
• Related Pages

API Reference

Skip menu "API Reference"

• KWin
•   KWin Libraries
• Libraries
•   libkworkspace
•   libplasma
• Plasma
•   Animators
•   Applets
•   Engines
• Solid Modules

Generated for API Reference by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE^® and the K Desktop Environment^® logo are registered trademarks of KDE e.V. | Legal