corona.h

Go to the documentation of this file.

/*
 *   Copyright 2007 Aaron Seigo <aseigo@kde.org>
 *   Copyright 2007 Matt Broadstone <mbroadst@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 PLASMA_CORONA_H
#define PLASMA_CORONA_H

#include <QtGui/QGraphicsScene>

#include <plasma/applet.h>
#include <plasma/containment.h>
#include <plasma/plasma.h>
#include <plasma/plasma_export.h>

class QGraphicsGridLayout;
class QAction;

class KAction;

namespace Plasma
{

class CoronaPrivate;
class ContainmentActionsPluginsConfig;
class AbstractDialogManager;

class PLASMA_EXPORT Corona : public QGraphicsScene
{
    Q_OBJECT

//typedef QHash<QString, QList<Plasma::Applet*> > layouts;

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

    void setAppletMimeType(const QString &mimetype);

    QString appletMimeType();

    QString defaultContainmentPlugin() const;

    QList<Containment*> containments() const;

    void clearContainments();

    KSharedConfig::Ptr config() const;

    Containment *addContainment(const QString &name, const QVariantList &args = QVariantList());

    Containment *containmentForScreen(int screen, int desktop = -1) const;

    Containment *containmentForScreen(int screen, int desktop,
                                      const QString &defaultPluginIfNonExistent,
                                      const QVariantList &defaultArgs = QVariantList());
    void addOffscreenWidget(QGraphicsWidget *widget);

    void removeOffscreenWidget(QGraphicsWidget *widget);

    QList <QGraphicsWidget *> offscreenWidgets() const;

    virtual int numScreens() const;

    virtual QRect screenGeometry(int id) const;

    virtual QRegion availableScreenRegion(int id) const;

    QPoint popupPosition(const QGraphicsItem *item, const QSize &size);

    QPoint popupPosition(const QGraphicsItem *item, const QSize &size, Qt::AlignmentFlag alignment);

    QList<Plasma::Location> freeEdges(int screen) const;

    QAction *action(QString name) const;

    void addAction(QString name, QAction *action);

    QList<QAction*> actions() const;

    void enableAction(const QString &name, bool enable);

    void updateShortcuts();

    void addShortcuts(KActionCollection *newShortcuts);

    KAction* addAction(QString name);

    void setContainmentActionsDefaults(Containment::Type containmentType, const ContainmentActionsPluginsConfig &config);

    ContainmentActionsPluginsConfig containmentActionsDefaults(Containment::Type containmentType);

    void setDialogManager(AbstractDialogManager *manager);

    AbstractDialogManager *dialogManager();

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED QList<Plasma::Containment *> importLayout(const KConfigBase &config);
#endif

    QString preferredToolBoxPlugin(const Containment::Type type) const;

    QList<Plasma::Containment *> importLayout(const KConfigGroup &config);

    void exportLayout(KConfigGroup &config, QList<Containment*> containments);

public Q_SLOTS:
    void initializeLayout(const QString &config = QString());

    void loadLayout(const QString &config = QString());

    void saveLayout(const QString &config = QString()) const;

    ImmutabilityType immutability() const;

    void setImmutability(const ImmutabilityType immutable);

    void requestConfigSync();

    void requireConfigSync();

    void layoutContainments();

Q_SIGNALS:
    void containmentAdded(Plasma::Containment *containment);

    void screenOwnerChanged(int wasScreen, int isScreen, Plasma::Containment *containment);

    void releaseVisualFocus();

    void configSynced();

    void availableScreenRegionChanged();

    void immutabilityChanged(Plasma::ImmutabilityType immutability);

    void shortcutsChanged();

protected:
    virtual void loadDefaultLayout();

    Containment *addContainmentDelayed(const QString &name,
                                       const QVariantList &args = QVariantList());

    void mapAnimation(Animator::Animation from, Animator::Animation to);

    void mapAnimation(Animator::Animation from, const QString &to);

    void setPreferredToolBoxPlugin(const Containment::Type type, const QString &plugin);

    void setDefaultContainmentPlugin(const QString &name);

    //Reimplemented from QGraphicsScene
    void dragEnterEvent(QGraphicsSceneDragDropEvent *event);
    void dragLeaveEvent(QGraphicsSceneDragDropEvent *event);
    void dragMoveEvent(QGraphicsSceneDragDropEvent *event);

private:
    CoronaPrivate *const d;

    Q_PRIVATE_SLOT(d, void containmentDestroyed(QObject*))
    Q_PRIVATE_SLOT(d, void offscreenWidgetDestroyed(QObject *))
    Q_PRIVATE_SLOT(d, void syncConfig())
    Q_PRIVATE_SLOT(d, void toggleImmutability())
    Q_PRIVATE_SLOT(d, void showShortcutConfig())

    friend class CoronaPrivate;
    friend class View;
};

} // namespace Plasma

#endif