containment.h

/*
 *   Copyright 2007 by Aaron Seigo <[email protected]>
 *   Copyright 2008 by Ménard Alexis <[email protected]>
 *   Copyright (c) 2009 Chani Armitage <[email protected]>
 *
 *   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_CONTAINMENT_H
#define PLASMA_CONTAINMENT_H

#include <ksharedconfig.h>
#include <plasma/applet.h>

namespace Plasma
{

class DataEngine;
class Package;
class Corona;
class ContainmentActions;
class ContainmentPrivate;

class PLASMA_EXPORT Containment : public Applet
{
    Q_OBJECT
    Q_PROPERTY(QString wallpaper READ wallpaper WRITE setWallpaper NOTIFY wallpaperChanged)
    Q_PROPERTY(bool isUiReady READ isUiReady NOTIFY uiReadyChanged)

public:
    explicit Containment(QObject *parent = nullptr,
                         const QString &serviceId = QString(),
                         uint containmentId = 0);

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

    ~Containment() override;

    void init() override;

    Plasma::Types::ContainmentType containmentType() const;

    Corona *corona() const;

    Applet *createApplet(const QString &name, const QVariantList &args = QVariantList());

    void addApplet(Applet *applet);

    QList<Applet *> applets() const;

    int screen() const;

    int lastScreen() const;

    void save(KConfigGroup &group) const override;

    void restore(KConfigGroup &group) override;

    void setWallpaper(const QString &pluginName);

    QString wallpaper() const;

    void setActivity(const QString &activityId);

    QString activity() const;

    void setContainmentActions(const QString &trigger, const QString &pluginName);

    QHash<QString, ContainmentActions *> &containmentActions();

    bool isUiReady() const;

Q_SIGNALS:
    void appletAdded(Plasma::Applet *applet);

    void appletRemoved(Plasma::Applet *applet);

    void appletCreated(Plasma::Applet *applet);

    void activityChanged(const QString &activity);

    void showAddWidgetsInterface(const QPointF &pos);

    void screenChanged(int newScreen);

    void configureRequested(Plasma::Applet *applet);

    void appletAlternativesRequested(Plasma::Applet *applet);

    void wallpaperChanged();

    void locationChanged(Plasma::Types::Location location);

    void formFactorChanged(Plasma::Types::FormFactor formFactor);

    void uiReadyChanged(bool uiReady);

    void containmentTypeChanged();

public Q_SLOTS:
    void setLocation(Plasma::Types::Location location);

    void setFormFactor(Plasma::Types::FormFactor formFactor);

    void setContainmentType(Plasma::Types::ContainmentType type);

    void reactToScreenChange();

protected:
    virtual void saveContents(KConfigGroup &group) const;

    virtual void restoreContents(KConfigGroup &group);

private:
    Containment(const KPluginMetaData &md, uint appletId);

    Q_PRIVATE_SLOT(d, void appletDeleted(Plasma::Applet *))
    Q_PRIVATE_SLOT(d, void triggerShowAddWidgets())
    Q_PRIVATE_SLOT(d, void checkStatus(Plasma::Types::ItemStatus))

    friend class Applet;
    friend class AppletPrivate;
    friend class CoronaPrivate;
    friend class ContainmentPrivate;
    friend class ContainmentActions;
    ContainmentPrivate *const d;
};

} // Plasma namespace

#endif // multiple inclusion guard