KPanelMenu Class Reference
This class allows to build menu entries that will be dynamically added either to the K-menu, or to the panel as a normal button. Base class to build dynamically loaded menu entries for the K-menu, or the panel. More...
#include <kpanelmenu.h>
Inheritance diagram for KPanelMenu:


Public Slots | |
void | reinitialize () |
void | deinitialize () |
Public Member Functions | |
KPanelMenu (QWidget *parent=0, const char *name=0) | |
KPanelMenu (const QString &startDir, QWidget *parent=0, const char *name=0) | |
virtual | ~KPanelMenu () |
const QString & | path () const |
void | setPath (const QString &p) |
bool | initialized () const |
void | setInitialized (bool on) |
void | disableAutoClear () |
Protected Slots | |
virtual void | slotAboutToShow () |
virtual void | slotExec (int id)=0 |
virtual void | initialize ()=0 |
void | slotClear () |
Protected Member Functions | |
virtual void | hideEvent (QHideEvent *ev) |
void | init (const QString &path=QString::null) |
virtual void | virtual_hook (int id, void *data) |
Detailed Description
This class allows to build menu entries that will be dynamically added either to the K-menu, or to the panel as a normal button. Base class to build dynamically loaded menu entries for the K-menu, or the panel.These dynamic menus are located in shared libraries that will be loaded at runtime by Kicker (the KDE panel).
To build such a menu, you have to inherit this class and implement the pure virtual functions initialize() and slotExec(). You also have to provide a factory object in your library, see KLibFactory. This factory is only used to construct the menu object.
Finally, you also have to provide a desktop file describing your dynamic menu. The relevant entries are: Name, Comment, Icon and X-KDE-Library (which contains the library name without any extension). This desktop file has to be installed in $KDEDIR/share/apps/kicker/menuext/.
- Author:
- The kicker maintainer, Michael Goffioul <kdeprint@swing.be>
Definition at line 52 of file kpanelmenu.h.
Constructor & Destructor Documentation
|
Construct a KPanelMenu object. This is the normal constructor to use when building extrernal menu entries. Definition at line 49 of file kpanelmenu.cpp. References init(). |
|
Constructor used internally by Kicker. You don't really want to use it.
References init(). |
|
Destructor. Definition at line 74 of file kpanelmenu.cpp. |
Member Function Documentation
|
Get the directory path associated with this menu, or QString::null if there's no such associated path.
|
|
Set a directory path to be associated with this menu.
|
|
Tell if the menu has been initialized, that is it already contains items. This is useful when you need to know if you have to clear the menu, or to fill it.
|
|
Set the initial state. Set it to true when you menu is filled with the items you want.
Referenced by init(), and slotClear(). |
|
Disable the automatic clearing of the menu. Kicker uses a cache system for its menus. After a specific configurable delay, the menu will be cleared. Use this function if you want to disable kicker's cache system, and avoid the clearing of your menu. Definition at line 109 of file kpanelmenu.cpp. |
|
Reinitialize the menu: the menu is first cleared, the initial state is set to false, and finally initialize() is called. Use this if you want to refill your menu immediately. Definition at line 134 of file kpanelmenu.cpp. References deinitialize(). |
|
Deinitialize the menu: the menu is cleared and the initialized state is set to false. initialize() is NOT called. It will be called before the menu is next shown, however. Use this slot if you want a delayed reinitialization.
References slotClear(). Referenced by reinitialize(). |
|
This slot is called just before the menu is shown. This allows your menu to update itself if needed. However you should instead re-implement initialize to provide this feature. This function is responsible for the cache system handling, so if you re-implement it, you should call the base function also. Calls initialize().
Referenced by init(). |
|
This is slot is called when an item from the menu has been selected. Your applet is then supposed to perform some action. You must re-implement this function.
Referenced by init(). |
|
This slots is called to initialize the menu. It is called automatically by slotAboutToShow(). By re-implementing this functions, you can reconstruct the menu before it is being shown. At the end of this function, you should call setInitialize() with true to tell the system that the menu is OK. You applet must re-implement this function.
|
|
Clears the menu, and update the initial state accordingly.
References setInitialized(). Referenced by deinitialize(), and hideEvent(). |
|
Re-implemented for internal reasons.
Reimplemented from KPopupMenu. Definition at line 98 of file kpanelmenu.cpp. References slotClear(). |
|
For internal use only. Used by constructors. Definition at line 55 of file kpanelmenu.cpp. References KGlobal::config(), KConfigBase::readNumEntry(), KConfigBase::setGroup(), setInitialized(), KPopupMenu::setKeyboardShortcutsEnabled(), slotAboutToShow(), and slotExec(). Referenced by KPanelMenu(). |
The documentation for this class was generated from the following files: