plasma-workspace/containmentinterface.h

/***************************************************************************
 *   Copyright (C) 2014 by Eike Hein <hein@kde.org>                        *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, 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 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 CONTAINMENTINTERFACE_H
#define CONTAINMENTINTERFACE_H

#include <QObject>
#include <QUrl>

namespace Plasma {
    class Applet;
    class Containment;
}

class ContainmentInterface : public QObject
{
    Q_OBJECT

    public:
        enum Target {
            Desktop = 0,
            Panel,
            TaskManager
        };

        Q_ENUM(Target)

        explicit ContainmentInterface(QObject *parent = nullptr);
        ~ContainmentInterface() override;

        static Q_INVOKABLE bool mayAddLauncher(QObject *appletInterface, Target target, const QString &entryPath = QString());

        static Q_INVOKABLE void addLauncher(QObject *appletInterface, Target target, const QString &entryPath);

        static Q_INVOKABLE QObject* screenContainment(QObject *appletInterface);
        static Q_INVOKABLE bool screenContainmentMutable(QObject *appletInterface);
        static Q_INVOKABLE void ensureMutable(Plasma::Containment *containment);

    private:
        static QStringList m_knownTaskManagers;
};

#endif