McpAppletIf Class Reference

Applet interface for MControlPanel applets. More...

#include <mcpappletif.h>

List of all members.

Public Member Functions
virtual	~McpAppletIf ()
virtual void	init ()=0
	Initializes applet right after loading it.
virtual McpWidget *	constructWidget (int widgetId)=0
	Contstructs the widget specified by widgetId that the applet provides.
virtual QString Q_DECL_DEPRECATED	title () const =0
	Title of the applet that displayed in title row of applet page.
virtual QVector< MAction * >	viewMenuItems ()=0
	Menu items that applet can provide in the main menu of the applet page.
virtual McpBrief *	constructBrief (int partId=0)=0
	The Brief view of the applet Brief widget is the button-look on category pages of MControlpanel It displays the applet name and the current value. Value must be provided and formatted by the applet implementation. Clicking on the widget displays the applet itself.
virtual int	partID (const QString &partStr)
virtual int	interfaceVersion ()

---

Detailed Description

Applet interface for MControlPanel applets.

The class implements the basic communication API between the MControlPanel and the control panel applet.

Definition at line 33 of file mcpappletif.h.

---

Constructor & Destructor Documentation

virtual McpAppletIf::~McpAppletIf

(

)

[inline, virtual]

Definition at line 36 of file mcpappletif.h.

{}

---

Member Function Documentation

virtual McpBrief* McpAppletIf::constructBrief

(

int

partId = 0

)

[pure virtual]

The Brief view of the applet Brief widget is the button-look on category pages of MControlpanel It displays the applet name and the current value. Value must be provided and formatted by the applet implementation. Clicking on the widget displays the applet itself.

virtual McpWidget* McpAppletIf::constructWidget

(

int

widgetId

)

[pure virtual]

Contstructs the widget specified by widgetId that the applet provides.

Parameters:

widgetId

the Id of the widget implemented by the applet that we want to show. This widget is usually a container or a dialog

The "entrance" widget (that is displayed on first page) will be queried with 0 id. Further applet pages can be requested through the McpWidget::changeWidget signal.

virtual void McpAppletIf::init

(

)

[pure virtual]

Initializes applet right after loading it.

Parameters:

part

The part name of the applet, if it implements more dialogs or views (parts) and it needs only one part

virtual int McpAppletIf::interfaceVersion

(

)

[inline, virtual]

Control panel uses this function to determine with which version of the interface the plugin was compiled with. It lets controlpanel extend the interface without the need to recompile all applets.

Definition at line 97 of file mcpappletif.h.

{ return 4; }

virtual int McpAppletIf::partID

(

const QString &

partStr

)

[inline, virtual]

Translates Part strings which are present in the desktop file of the applet into part ids, which are used when requesting a page from the applet.

Definition at line 90 of file mcpappletif.h.

{ Q_UNUSED(partStr); return 0; }

virtual QString Q_DECL_DEPRECATED McpAppletIf::title

(

)

const [pure virtual]

Title of the applet that displayed in title row of applet page.

Returns:

A title which is displayed in title row of page. It can vary by each widget

This function is DEPRECATED and will be removed in near future. Please use McpBrief::title() and McpWidget::title() instead.

virtual QVector<MAction *> McpAppletIf::viewMenuItems

(

)

[pure virtual]

Menu items that applet can provide in the main menu of the applet page.

---

The documentation for this class was generated from the following file:

• src/appletdb/mcpappletif.h