extender.h

Go to the documentation of this file.

/*
 * Copyright 2008, 2009 by Rob Scheepmaker <r.scheepmaker@student.utwente.nl>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA  02110-1301  USA
 */

#ifndef PLASMA_EXTENDER_H
#define PLASMA_EXTENDER_H

#include <QtGui/QGraphicsWidget>

#include "plasma/framesvg.h"
#include "plasma/plasma_export.h"

namespace Plasma
{

class ExtenderGroup;
class ExtenderPrivate;
class ExtenderItem;
class Applet;

class PLASMA_EXPORT Extender : public QGraphicsWidget
{
    Q_OBJECT
    Q_PROPERTY(QString emptyExtenderMessage READ emptyExtenderMessage WRITE setEmptyExtenderMessage)
    Q_PROPERTY(QList<ExtenderItem*> items READ items())
    Q_PROPERTY(QList<ExtenderItem*> attachedItems READ attachedItems())
    Q_PROPERTY(QList<ExtenderItem*> detachedItems READ detachedItems())
    Q_PROPERTY(QList<ExtenderGroup*> groups READ groups())
    Q_PROPERTY(bool empty READ isEmpty())

    public:
        enum Appearance {
            NoBorders = 0,  
            BottomUpStacked = 1, 
            TopDownStacked = 2 
        };

        explicit Extender(Applet *applet);

        ~Extender();

        void setEmptyExtenderMessage(const QString &message);

        QString emptyExtenderMessage() const;

        QList<ExtenderItem*> items() const;

        QList<ExtenderItem*> attachedItems() const;

        QList<ExtenderItem*> detachedItems() const;

        Q_INVOKABLE ExtenderItem *item(const QString &name) const;

        Q_INVOKABLE ExtenderGroup *group(const QString &name) const;

        Q_INVOKABLE bool hasItem(const QString &name) const;

        bool isEmpty() const;

        void setAppearance(Appearance appearance);

        Appearance appearance() const;

        QList<ExtenderGroup*> groups() const;

        Applet *applet() const;

    protected:
        virtual void itemAddedEvent(ExtenderItem *item, const QPointF &pos = QPointF(-1, -1));

        virtual void itemRemovedEvent(ExtenderItem *item);

        virtual void itemHoverEnterEvent(ExtenderItem *item);

        virtual void itemHoverMoveEvent(ExtenderItem *item, const QPointF &pos);

        virtual void itemHoverLeaveEvent(ExtenderItem *item);

        virtual void saveState();

        virtual FrameSvg::EnabledBorders enabledBordersForItem(ExtenderItem *item) const;

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

        void resizeEvent(QGraphicsSceneResizeEvent *event);

        void mousePressEvent(QGraphicsSceneMouseEvent *event);

        void dragEnterEvent(QGraphicsSceneDragDropEvent *event);

        void dragMoveEvent(QGraphicsSceneDragDropEvent *event);

        void dragLeaveEvent(QGraphicsSceneDragDropEvent *event);

        void dropEvent(QGraphicsSceneDragDropEvent *event);

    Q_SIGNALS:
        void itemAttached(Plasma::ExtenderItem *);

        void itemDetached(Plasma::ExtenderItem *);

        void geometryChanged();

    private:
        ExtenderPrivate *const d;

        Q_PRIVATE_SLOT(d, void delayItemAddedEvent())
        Q_PRIVATE_SLOT(d, void extenderItemDestroyed(Plasma::ExtenderItem *item))
        Q_PRIVATE_SLOT(d, void viewportGeometryChanged(const QRectF &))

        friend class ExtenderPrivate;
        friend class ExtenderGroup;
        friend class ExtenderGroupPrivate;
        friend class ExtenderItem;
        friend class ExtenderItemPrivate;
        //dialog needs access to the extender's applet location.
        friend class DialogPrivate;
        //applet should be able to call saveState();
        friend class Applet;

    };
} // Plasma namespace

#endif //PLASMA_EXTENDER_H