abstractgroup.h

Go to the documentation of this file.

/*
 *   Copyright 2009-2010 by Giulio Camuffo <giuliocamuffo@gmail.com>
 *
 *   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 ABSTRACTGROUP_H
#define ABSTRACTGROUP_H

#include <QtGui/QGraphicsWidget>
#include <Plasma/Applet>

#include "groupinfo.h"
#include "groupfactory_p.h"
#include "groupingcontainment_export.h"

class KConfigGroup;

class GroupingContainment;
class Handle;
class AbstractGroupPrivate;

class PLASMA_GROUPINGCONTAINMENT_EXPORT AbstractGroup : public QGraphicsWidget
{
    Q_OBJECT
    Q_PROPERTY(bool hasInterface READ hasConfigurationInterface)
    Q_PROPERTY(uint id READ id)
    Q_PROPERTY(GroupType groupType READ groupType)
    Q_PROPERTY(bool isMainGroup READ isMainGroup)

    public:
        enum GroupType {
            ConstrainedGroup = 0,   
            FreeGroup = 1           
        };
        Q_ENUMS(GroupType)

        
        enum BackgroundHint {
            NoBackground  = 0,        
            StandardBackground = 1,   
            PlainBackground = 2       
        };
        Q_DECLARE_FLAGS(BackgroundHints, BackgroundHint)

        
        explicit AbstractGroup(QGraphicsItem *parent = 0, Qt::WindowFlags wFlags = 0);

        virtual ~AbstractGroup();

        virtual void init();

        AbstractGroup *parentGroup() const;

        void addApplet(Plasma::Applet *applet, bool layoutApplet = true);

        void addSubGroup(AbstractGroup *group, bool layoutGroup = true);

        void removeApplet(Plasma::Applet *applet, AbstractGroup *newGroup = 0);

        void removeSubGroup(AbstractGroup *group, AbstractGroup *newGroup = 0);

        virtual void saveChildGroupInfo(QGraphicsWidget *child, KConfigGroup config) const = 0;

        virtual void restoreChildGroupInfo(QGraphicsWidget *child, const KConfigGroup &group) = 0;

        QGraphicsView *view() const;

        void destroy();

        KConfigGroup config() const;

        virtual void save(KConfigGroup &group) const;

        virtual void saveChildren() const;

        virtual void restore(KConfigGroup &group);

        virtual void restoreChildren();

        virtual bool showDropZone(const QPointF &pos);

        Plasma::Applet::List applets() const;

        QList<AbstractGroup *> subGroups() const;

        QList<QGraphicsWidget *> children() const;

        uint id() const;

        Plasma::ImmutabilityType immutability() const;

        GroupingContainment *containment() const;

        virtual QString pluginName() const = 0;

        void setIsMainGroup();

        bool isMainGroup() const;

        void setBackgroundHints(BackgroundHints hint);

        BackgroundHints backgroundHints() const;

        bool useSimplerBackgroundForChildren() const;

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

        enum {
            Type = UserType + 2
        };
        virtual int type() const;

        void raise();

        virtual Handle *createHandleForChild(QGraphicsWidget *child);

        GroupType groupType() const;

        virtual void createConfigurationInterface(KConfigDialog *parent);

        bool hasConfigurationInterface() const;

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

        virtual void releaseChild(QGraphicsWidget *child);

        static QString mimeType();

        static AbstractGroup *load(const QString &name, QGraphicsItem *parent = 0);

        static QStringList availableGroups();

        static GroupInfo groupInfo(const QString &name);

    public slots:
        void setImmutability(Plasma::ImmutabilityType immutability);

        virtual void showConfigurationInterface();

    protected:
        virtual QVariant itemChange(GraphicsItemChange change, const QVariant &value);

        virtual void dragLeaveEvent(QGraphicsSceneDragDropEvent *event);

        virtual void resizeEvent(QGraphicsSceneResizeEvent *event);

        virtual void layoutChild(QGraphicsWidget *child, const QPointF &pos) = 0;

        void setGroupType(GroupType type);

        void setHasConfigurationInterface(bool hasInterface);

        void setUseSimplerBackgroundForChildren(bool use);

        virtual void constraintsEvent(Plasma::Constraints constraints);

    signals:
        void groupDestroyed(AbstractGroup *group);

        void appletAddedInGroup(Plasma::Applet *applet, AbstractGroup *group);

        void subGroupAddedInGroup(AbstractGroup *subGroup, AbstractGroup *group);

        void appletRemovedFromGroup(Plasma::Applet *applet, AbstractGroup *group);

        void subGroupRemovedFromGroup(AbstractGroup *subGroup, AbstractGroup *group);

        void geometryChanged();

        void groupTransformedByUser();

        void configNeedsSaving();

        void immutabilityChanged(Plasma::ImmutabilityType immutability);

    private:
        Q_PRIVATE_SLOT(d, void appletDestroyed(Plasma::Applet *applet))
        Q_PRIVATE_SLOT(d, void subGroupDestroyed(AbstractGroup *subGroup))
        Q_PRIVATE_SLOT(d, void destroyGroup())
        Q_PRIVATE_SLOT(d, void onChildGeometryChanged())

        AbstractGroupPrivate *const d;

        friend class AbstractGroupPrivate;
        friend class Handle;
        friend class GroupingContainment;
        friend class GroupingContainmentPrivate;

};

Q_DECLARE_METATYPE(AbstractGroup *)

#define REGISTER_GROUP(class) \
    static const bool g_##class = GroupFactory::instance()->registerGroup<class>();

#endif // ABSTRACTGROUP_H