Home · All Namespaces · All Classes · Main Classes
Public Slots | Signals | Public Member Functions | Friends

DcpWidget Class Reference

#include <dcpwidget.h>

List of all members.

Public Slots

void setProgressIndicatorVisible (bool visible)
 Show a progress indicator.

Signals

void changeWidget (int widgetId)
 Emitted when the windget change is requested.
bool activatePluginByName (const QString &appletName) const
 Should be activated to request the activation of an applet.
void closePage ()
 Should be emitted when duicontrolpanel should close the page for you.
void inProgress (bool isInProgress)
 Emitted when setProgressIndicatorVisible gets called.

Public Member Functions

 DcpWidget (QGraphicsWidget *parent=0)
 The constructor. No referer for default.
virtual ~DcpWidget ()
virtual void setReferer (int widgetId)
 deprecated function
virtual bool back ()
 This method gets called when user presses 'Back' on the applet page.
virtual bool pagePans () const
int getWidgetId ()
bool setWidgetId (int widgetId)
 Sets the widgetId and returns true if the ID could be set.
virtual QString title () const
 Specifies the title for the page where the widget is put.
bool isProgressIndicatorVisible () const

Friends

class Ut_DcpWidget

Detailed Description

The base class for applet view

The control panel applets usually have one or more views containing the actual GUI of the applet. The DcpWidget is the base class for these views (sometimes called pages).


Constructor & Destructor Documentation

DcpWidget::DcpWidget ( QGraphicsWidget *  parent = 0  ) 

The constructor. No referer for default.

DcpWidget::~DcpWidget (  )  [virtual]

Member Function Documentation

bool DcpWidget::activatePluginByName ( const QString &  appletName  )  const [signal]

Should be activated to request the activation of an applet.

Parameters:
appletName The name of the applet that should be activated
Returns:
true if the applet could be found

This signal should be emitted by the plugin when the activation of an other applet is requested.

bool DcpWidget::back (  )  [virtual]

This method gets called when user presses 'Back' on the applet page.

Returns:
true if back should close the page and false if not
void DcpWidget::changeWidget ( int  widgetId  )  [signal]

Emitted when the windget change is requested.

Parameters:
widgetId the id of the requested widget instead of this one.

change can be requested by pressing a button on the widget, for example.

In that case, this signal is handled by DcpAppletPage: it destroys this widget and creates and shows the new one at the given widgetId.

void DcpWidget::closePage (  )  [signal]

Should be emitted when duicontrolpanel should close the page for you.

int DcpWidget::getWidgetId (  ) 

Returns the widgetId for the DcpWidget object.

void DcpWidget::inProgress ( bool  isInProgress  )  [signal]

Emitted when setProgressIndicatorVisible gets called.

Parameters:
isInProgress If true, the progress indicator becomes visible. If false, it will become hidden.
bool DcpWidget::isProgressIndicatorVisible (  )  const
bool DcpWidget::pagePans (  )  const [virtual]

The pannable area for the entire view (page) will be enabled if this function returns true. The default implementation of the function returns true, so the pannable area will be enabled.

void DcpWidget::setProgressIndicatorVisible ( bool  visible  )  [slot]

Show a progress indicator.

With this function the widget can show a progress indicator indicating that a longer operation is running. Same as calling MApplicationPage::setProgressIndicatorVisible.

Parameters:
visible If true, the progress indicator becomes visible. If false, it will become hidden.
void DcpWidget::setReferer ( int  widgetId  )  [virtual]

deprecated function

Parameters:
widgetId This function is no longer in use, kept only for preserving binary compatibility.
bool DcpWidget::setWidgetId ( int  widgetId  ) 

Sets the widgetId and returns true if the ID could be set.

Sets the widgetId for the DcpWidget class widget. The WidgetId is set by the controlpanel, and should not changed by the cp applet. Once the widgetId is set it can not be changed.

QString DcpWidget::title (  )  const [virtual]

Specifies the title for the page where the widget is put.

Redefine this function to provide a title for a page of the applet. If you do not need separate titles for different pages, you can leave this default, and then all titles of the pages will be the Name of the applet specified in the applet's desktop file.


Friends And Related Function Documentation

friend class Ut_DcpWidget [friend]

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

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