alecs/plasma-framework
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add some much needed apidox to PopupApplet.

Browse Source 
svn path=/trunk/KDE/kdebase/workspace/libs/plasma/; revision=852548
This commit is contained in:
Rob Scheepmaker 2008-08-25 23:46:00 +00:00
parent 56fc76d150
commit 3127a7be81
1 changed files with 47 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
popupapplet.h
View File

@ -33,6 +33,18 @@ class Dialog;
class Icon;
class PopupAppletPrivate;
/**
* Allows applets to automatically 'collapse' into an icon when put in an panel, and is a convenient
* base class for any applet that wishes to use extenders.
* Applets that subclass this class should implement either widget() or graphicsWidget() to return a
* widget that will be displayed in the applet if the applet is in a Planar or MediaCenter form
* factor. If the applet is put in a panel, an icon will be displayed instead, which shows the
* widget in a popup when clicked.
* If you use this class as a base class for your extender using applet, you should implement
* graphicsWidget() to return extender(), and connect the extenders geometryChanged() signal to the
* widgetGeometryChanged() slot.
*/
class PLASMA_EXPORT PopupApplet : public Plasma::Applet
{
Q_OBJECT
@ -40,17 +52,52 @@ public:
PopupApplet(QObject *parent, const QVariantList &args);
~PopupApplet();
/**
* @arg icon the icon that has to be displayed when the applet is in a panel.
*/
void setIcon(const QIcon &icon);
/**
* @arg icon the icon that has to be displayed when the applet is in a panel.
*/
void setIcon(const QString &iconName);
/**
* @return the icon that is displayed when the applet is in a panel.
*/
QIcon icon() const;
/**
* Implement either this function or graphicsWidget.
* @return the widget that will get shown in either a layout in the applet, or in a Dialog,
* depending on the form factor of the applet.
*/
virtual QWidget *widget();
/**
* Implement either this function or widget.
* @return the widget that will get shown in either a layout in the applet, or in a Dialog,
* depending on the form factor of the applet.
*/
virtual QGraphicsWidget *graphicsWidget();
/**
* Shows the dialog showing the widget if the applet is in a panel.
* @arg displayTime the time in ms that the popup should be displayed, defaults to 0 which means
* always (until the user closes it again, that is).
*/
void showPopup(uint displayTime = 0);
public Q_SLOTS:
/**
* Hides the popup.
*/
void hidePopup();
/**
* Notify PopupApplet that the geometry of the graphicsWidget has changed. When you use an
* extender you'll want to connect the extender's geometryChanged() signal to this slot.
*/
void widgetGeometryChanged();
protected: