Home · All Namespaces · All Classes · Main Classes
Public Member Functions

DcpAppletIf Class Reference

Applet interface for DuiControlPanel applets. More...

#include <dcpappletif.h>

List of all members.

Public Member Functions

virtual ~DcpAppletIf ()
virtual void init ()
 Initializes applet right after loading it.
virtual DcpWidget
*Q_DECL_DEPRECATED 
constructWidget (int widgetId)
 Contstructs the widget specified by widgetId that the applet provides.
virtual QString Q_DECL_DEPRECATED title () const
 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 DcpBriefconstructBrief (int partId=0)
 The Brief view of the applet Brief widget is the button-look on category pages of DuiControlpanel 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 ()
virtual DcpStylableWidgetconstructStylableWidget (int widgetId)
 Contstructs the widget specified by widgetId that the applet provides.
virtual MSheet * constructSheet (int widgetId)

Detailed Description

Applet interface for DuiControlPanel applets.

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


Constructor & Destructor Documentation

virtual DcpAppletIf::~DcpAppletIf (  )  [inline, virtual]

Member Function Documentation

virtual DcpBrief* DcpAppletIf::constructBrief ( int  partId = 0  )  [inline, virtual]

The Brief view of the applet Brief widget is the button-look on category pages of DuiControlpanel 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 MSheet* DcpAppletIf::constructSheet ( int  widgetId  )  [inline, virtual]
virtual DcpStylableWidget* DcpAppletIf::constructStylableWidget ( int  widgetId  )  [inline, 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 DcpWidget::changeWidget signal.

This is the same as the constructWidget() call, but gives back an MStylableWidget instead of an MWidget which can be necessery in case of using themes (.css files).

virtual DcpWidget* Q_DECL_DEPRECATED DcpAppletIf::constructWidget ( int  widgetId  )  [inline, 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 DcpWidget::changeWidget signal.

virtual void DcpAppletIf::init (  )  [inline, 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 DcpAppletIf::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.

virtual int DcpAppletIf::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.

virtual QString Q_DECL_DEPRECATED DcpAppletIf::title (  )  const [inline, 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 DcpBrief::title() and DcpWidget::title() instead.

virtual QVector<MAction *> DcpAppletIf::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:

Copyright © 2009 Nokia Corporation Generated on Tue Jul 5 2011 15:01:31
Doxygen 1.7.1
Meego control panel