workspace/plasma/shells/common/appletbrowser.h

   1 /*
   2  *   Copyright (C) 2007 Ivan Cukic <ivan.cukic+kde@gmail.com>
   3  *
   4  *   This program is free software; you can redistribute it and/or modify
   5  *   it under the terms of the GNU Library/Lesser General Public License
   6  *   version 2, or (at your option) any later version, as published by the
   7  *   Free Software Foundation
   8  *
   9  *   This program is distributed in the hope that it will be useful,
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *   GNU General Public License for more details
  13  *
  14  *   You should have received a copy of the GNU Library/Lesser General Public
  15  *   License along with this program; if not, write to the
  16  *   Free Software Foundation, Inc.,
  17  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  */
  19
  20 #ifndef PLASMA_APPLETBROWSER_H
  21 #define PLASMA_APPLETBROWSER_H
  22
  23 #include <KDE/KDialog>
  24
  25 namespace Plasma
  26 {
  27
  28 class Corona;
  29 class Containment;
  30 class Applet;
  31 class AppletBrowserPrivate;
  32 class AppletBrowserWidgetPrivate;
  33
  34 class AppletBrowserWidget : public QWidget
  35 {
  36     Q_OBJECT
  37 public:
  38     explicit AppletBrowserWidget(QWidget *parent = 0, Qt::WindowFlags f = 0);
  39     virtual ~AppletBrowserWidget();
  40
  41     void setApplication(const QString &application = QString());
  42     QString application();
  43
  44     /**
  45      * Changes the current default containment to add applets to
  46      *
  47      * @arg containment the new default
  48      */
  49     void setContainment(Plasma::Containment *containment);
  50
  51     /**
  52      * @return the current default containment to add applets to
  53      */
  54     Containment *containment() const;
  55
  56 public Q_SLOTS:
  57     /**
  58      * Adds currently selected applets
  59      */
  60     void addApplet();
  61
  62     /**
  63      * Destroy all applets with this name
  64      */
  65     void destroyApplets(const QString &name);
  66
  67     /**
  68      * Launches a download dialog to retrieve new applets from the Internet
  69      *
  70      * @arg type the type of widget to download; an empty string means the default
  71      *           Plasma widgets will be accessed, any other value should map to a
  72      *           PackageStructure PluginInfo-Name entry that provides a widget browser.
  73      */
  74     void downloadWidgets(const QString &type = QString());
  75
  76     /**
  77      * Opens a file dialog to open a widget from a local file
  78      */
  79     void openWidgetFile();
  80
  81     /**
  82      * Shows infos about applets.
  83      */
  84     void infoAboutApplet(const QString &name);
  85
  86 private:
  87     Q_PRIVATE_SLOT(d, void appletAdded(Plasma::Applet*))
  88     Q_PRIVATE_SLOT(d, void appletRemoved(Plasma::Applet*))
  89     Q_PRIVATE_SLOT(d, void containmentDestroyed())
  90
  91     AppletBrowserWidgetPrivate * const d;
  92 };
  93
  94 class AppletBrowser: public KDialog
  95 {
  96     Q_OBJECT
  97 public:
  98     explicit AppletBrowser(QWidget *parent = 0, Qt::WindowFlags f = 0);
  99     virtual ~AppletBrowser();
 100
 101     void setApplication(const QString &application = QString());
 102     QString application();
 103
 104     /**
 105      * Changes the current default containment to add applets to
 106      *
 107      * @arg containment the new default
 108      */
 109     void setContainment(Plasma::Containment *containment);
 110
 111     /**
 112      * @return the current default containment to add applets to
 113      */
 114     Containment *containment() const;
 115
 116 private:
 117     Q_PRIVATE_SLOT(d, void populateWidgetsMenu())
 118     AppletBrowserPrivate * const d;
 119 };
 120
 121 } // namespace Plasma
 122
 123 #endif /*APPLETBROWSERWINDOW_H_*/