KPanelApplet Class Reference
Implement a panel applet. KDE Panel Applet class. More...
#include <kpanelapplet.h>
Inheritance diagram for KPanelApplet:


Public Types | |
enum | Type { Normal = 0, Stretch } |
enum | Action { About = 1, Help = 2, Preferences = 4, ReportBug = 8 } |
enum | Position { pLeft = 0, pRight, pTop, pBottom } |
enum | Alignment { LeftTop = 0, Center, RightBottom } |
enum | Direction { Up = 0, Down, Left, Right } |
Signals | |
void | updateLayout () |
void | requestFocus () |
Public Member Functions | |
KPanelApplet (const QString &configFile, Type t=Normal, int actions=0, QWidget *parent=0, const char *name=0, WFlags f=0) | |
~KPanelApplet () | |
virtual int | widthForHeight (int height) const |
virtual int | heightForWidth (int width) const |
KConfig * | config () const |
KSharedConfig::Ptr | sharedConfig () const |
Type | type () const |
int | actions () const |
virtual void | action (Action a) |
const QPopupMenu * | customMenu () const |
void | setPosition (Position p) |
void | setAlignment (Alignment a) |
Protected Member Functions | |
virtual void | about () |
virtual void | help () |
virtual void | preferences () |
virtual void | reportBug () |
Orientation | orientation () const |
Position | position () const |
Alignment | alignment () const |
virtual void | positionChange (Position p) |
virtual void | alignmentChange (Alignment) |
void | setCustomMenu (const QPopupMenu *) |
virtual KDE_DEPRECATED void | orientationChange (Orientation) |
Direction | popupDirection () KDE_DEPRECATED |
virtual KDE_DEPRECATED void | popupDirectionChange (Direction) |
virtual void | virtual_hook (int id, void *data) |
Protected Attributes | |
KPanelAppletPrivate * | d |
Detailed Description
Implement a panel applet. KDE Panel Applet class.Panel applets
- Are small applications living in the KDE panel.
- Are implemented as DSOs (Dynamic Shared Objects).
The panel locates available applets by searching for applet desktop files in (ALL_KDEDIRS)/share/apps/kicker/applets. Every panel applet should install a desktop file there to be recognized by the panel.
Besides standard keys like "Name", "Comment" and "Icon" there are two panel applet specific keys:
X-KDE-Library
Used by the panel to locate the applet DSO (Dynamic Shared Object) Example: X-KDE-Library=libexampleapplet
X-KDE-UniqueApplet
Similar to KApplication and KUniqueApplication there are two types of panel applets. Use unique applets when it makes no sence to run more than one instance of a applet in the panel. A good example for unique applets is the taskbar applet. Use normal applets when you need instance specific configuration. An example is the koolclock applet where you might want to run two instances in your panel, one configured as analog clock, the other one as digital clock. X-KDE-UniqueApplet is a boolean key which defaults to "false". Example: X-KDE-UniqueApplet=true
Back to panel applet DSOs, the following conventions are used for KDE: Name: lib<appletname>applet.la LDFLAGS: -module -no-undefined
To implement a panel applet it is not enough to write a class inheriting from KPanelApplet but you also have to provide a factory function in your DSO. A sample factory function could look like this:
extern "C" { KPanelApplet* init(QWidget *parent, const QString& configFile) { KGlobal::locale()->insertCatalogue("exampleapplet"); return new ExampleApplet(configFile, KPanelApplet::Normal, KPanelApplet::About | KPanelApplet::Help | KPanelApplet::Preferences, parent, "exampleapplet"); } }
Note: Don't change the factory function signature or the panel will fail to load your applet.
- Author:
- Matthias Elter <elter@kde.org>
Definition at line 99 of file kpanelapplet.h.
Member Enumeration Documentation
|
This enum describes the type of the applet.
Definition at line 108 of file kpanelapplet.h. Referenced by type(). |
|
This enum holds flags which can be ORed together to describe which items the context menu over the applet handle contains.
Definition at line 113 of file kpanelapplet.h. |
Constructor & Destructor Documentation
|
Constructs a KPanelApplet just like any other widget.
Definition at line 38 of file kpanelapplet.cpp. References QPalette::active(), QPalette::inactive(), KStdAccel::name(), QFrame::setFrameStyle(), and QPalette::setInactive(). |
|
Destructor.
Definition at line 60 of file kpanelapplet.cpp. |
Member Function Documentation
|
Returns a suggested width for a given height. Every applet should reimplement this function. Depending on the panel orientation the height (horizontal panel) or the width (vertical panel) of the applets is fixed. The exact values of the fixed size component depend on the panel size.
On a horizontal panel the applet height is fixed, the panel will call widthForHeight(int height) with The applet can now choose the other size component (width) based on the given height. The width you return is granted. Definition at line 158 of file kpanelapplet.h. |
|
Depending on the panel orientation the height (horizontal panel) or the width (vertical panel) of the applets is fixed. The exact values of the fixed size component depend on the panel size.
On a vertical panel the applet width is fixed, the panel will call heightForWidth(int width) with The applet can now choose the other size component (height) based on the given width. The height you return is granted. Definition at line 179 of file kpanelapplet.h. |
|
Always use this KConfig object to save/load your applets configuration. For unique applets this config object will write to a config file called <appletname>rc in the users local KDE directory. For normal applets this config object will write to a instance specific config file called <appletname><instanceid>rc in the users local KDE directory. Definition at line 190 of file kpanelapplet.h. |
|
Definition at line 197 of file kpanelapplet.h. References Type. |
|
Definition at line 203 of file kpanelapplet.h. |
|
Generic action dispatcher. Called when the user selects an item from the applets RMB menu. Reimplement this function to handle actions. For About, Help, Preferences and ReportBug, use the convenience handlers ref about(), help(), preferences(), reportBug() Definition at line 109 of file kpanelapplet.cpp. References about(), help(), preferences(), and reportBug(). |
|
Definition at line 121 of file kpanelapplet.cpp. |
|
Emit this signal to make the panel relayout all applets, when you want to change your width (horizontal panel) or height (vertical panel). The panel is going to relayout all applets based on their widthForHeight(int height) (horizontal panel) or heightForWidth(int width) (vertical panel). Please note that the panel may change the applets location if the new widthForHeight(int height) (horizontal panel) or heightForWidth(int width) (vertical panel) does not fit into the current panel layout. |
|
Request keyboard focus from the panel.
|
|
Is called when the user selects "About" from the applet's RMB menu. Reimplement this function to launch a about dialog. Note that this is called only when your applet supports the About action. See Action and KPanelApplet(). Definition at line 263 of file kpanelapplet.h. Referenced by action(). |
|
Is called when the user selects "Help" from the applet's RMB menu. Reimplement this function to launch a manual or help page. Note that this is called only when your applet supports the Help action. See Action and KPanelApplet(). Definition at line 272 of file kpanelapplet.h. Referenced by action(). |
|
Is called when the user selects "Preferences" from the applet's RMB menu. Reimplement this function to launch a preferences dialog or kcontrol module. Note that this is called only when your applet supports the preferences action. See Action and KPanelApplet(). Definition at line 281 of file kpanelapplet.h. Referenced by action(). |
|
Is called when the user selects "Report bug" from the applet's RMB menu. Reimplement this function to launch a bug reporting dialog. Note that this is called only when your applet supports the ReportBug action. See Action and KPanelApplet() Definition at line 291 of file kpanelapplet.h. Referenced by action(). |
|
Definition at line 88 of file kpanelapplet.cpp. Referenced by positionChange(). |
|
Definition at line 300 of file kpanelapplet.h. |
|
Definition at line 304 of file kpanelapplet.h. |
|
The panel on which this applet resides has changed its position. Reimplement this change handler in order to adjust the look of your applet. Definition at line 80 of file kpanelapplet.cpp. References orientation(), orientationChange(), popupDirection(), popupDirectionChange(), and QFrame::resizeEvent(). |
|
The panel on which this applet resides has changed its alignment. Reimplement this change handler in order to adjust the look of your applet. Definition at line 318 of file kpanelapplet.h. |
|
Use this method to set the custom menu for this applet so that it can be shown in the applet handle menu and other appropriate places that the applet many not itself be aware of. The applet itself is still responsible for deleting and managing the the menu. If the menu is deleted during the life of the applet, be sure to call this method again with the new menu (or 0) to avoid crashes Definition at line 126 of file kpanelapplet.cpp. |
|
The orientation changed to Reimplement this change handler in order to adjust the look of your applet.
Definition at line 338 of file kpanelapplet.h. Referenced by positionChange(). |
|
You may need this if you want to popup menus at the right position.
Definition at line 98 of file kpanelapplet.cpp. Referenced by positionChange(). |
|
The popup direction changed to Reimplement this change handler in order to adjust the look of your applet.
Definition at line 357 of file kpanelapplet.h. Referenced by positionChange(). |
The documentation for this class was generated from the following files: