MenuAppletInterface Struct Reference

Plugins for the Menu Applet/StartMenu. More...

#include </home/clem/local/src/opie/library/menuappletinterface.h>

Inheritance diagram for MenuAppletInterface:

[legend]Collaboration diagram for MenuAppletInterface:

[legend]List of all members.

Public Member Functions
virtual QString	name () const =0
	Translated name of the Menu Applet.
virtual int	position () const =0
	the wished position of this applet
virtual QIconSet	icon () const =0
	return a QIconSet.
virtual QString	text () const =0
	return a Text shown to the user in the menu
virtual QPopupMenu *	popup (QWidget *parent) const =0
	Provide a SubMenu popup if you want.
virtual void	activated ()=0
	This method gets called once the user clicked on the item.

---

Detailed Description

Plugins for the Menu Applet/StartMenu.

You can extend the startmenu by plugins implementing this interface. You need to place the plugin in plugins/applets from where they will be loaded.

Definition at line 44 of file menuappletinterface.h.

---

Member Function Documentation

void MenuAppletInterface::activated (   )  [pure virtual]

This method gets called once the user clicked on the item. This is the way you get informed about user input. Your plugin has just been clicked Implemented in AboutApplet, HomeApplet, LockMenuApplet, LogoutApplet, RestartApplet, RotateApplet, SuspendApplet, VTApplet, and MenuAppletExample.

QIconSet MenuAppletInterface::icon (   )  const [pure virtual]

return a QIconSet. The returned icon set will be shown next to text(). Make use of AppLnk::smallIconSize() Implemented in AboutApplet, HomeApplet, LockMenuApplet, LogoutApplet, RestartApplet, RotateApplet, SuspendApplet, VTApplet, and MenuAppletExample. Referenced by StartMenu::addApplets().

QString MenuAppletInterface::name (   )  const [pure virtual]

Translated name of the Menu Applet. Return a translated name using QObject::tr of your plugin Implemented in AboutApplet, HomeApplet, LockMenuApplet, LogoutApplet, RestartApplet, RotateApplet, SuspendApplet, VTApplet, and MenuAppletExample.

QPopupMenu * MenuAppletInterface::popup (  QWidget *  parent  )  const [pure virtual]

Provide a SubMenu popup if you want. You can provide a Submenu popup for your item as well. If you return 0 no popup will be shown. You can use the QPopupMenu::aboutToShow() signal to be informed before showing the popup Parameters: parent  The parent of the to be created popup. See also: QPopupMenu Implemented in AboutApplet, HomeApplet, LockMenuApplet, LogoutApplet, RestartApplet, RotateApplet, SuspendApplet, VTApplet, and MenuAppletExample. Referenced by StartMenu::loadApplets().

int MenuAppletInterface::position (   )  const [pure virtual]

the wished position of this applet The position where you want to be placed. 0 for the down most Implemented in AboutApplet, HomeApplet, LockMenuApplet, LogoutApplet, RestartApplet, RotateApplet, SuspendApplet, VTApplet, and MenuAppletExample. Referenced by compareAppletPositions().

QString MenuAppletInterface::text (   )  const [pure virtual]

return a Text shown to the user in the menu Implemented in AboutApplet, HomeApplet, LockMenuApplet, LogoutApplet, RestartApplet, RotateApplet, SuspendApplet, VTApplet, and MenuAppletExample. Referenced by StartMenu::addApplets().

---

The documentation for this struct was generated from the following files:

• library/menuappletinterface.h
• library/dummy_api_docu.cpp

---