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

DcpAppletObject Class Reference

This class represents all informations about the applet. More...

#include <dcpappletobject.h>

Inheritance diagram for DcpAppletObject:
Inheritance graph
[legend]
Collaboration diagram for DcpAppletObject:
Collaboration graph
[legend]

List of all members.

Public Slots

void slotClicked ()
void setToggle (bool checked)
bool activatePluginByName (const QString &name) const
 A slot for the inter plugin activation.
void activateSlot (int widgetId=-1)
void setValue (const QVariant &value)

Signals

void briefChanged ()
void activate (int pageId)
void requestPluginActivation (const QString &pluginName)

Public Member Functions

 DcpAppletObject (DcpAppletMetadata *metadata)
 DcpAppletObject (DcpAppletMetadata *metadata, bool tryLoad)
virtual ~DcpAppletObject ()
QString toggleIconId () const
int widgetTypeID () const
 Returns what type of brief widget shall an applet variant use.
Qt::Alignment align () const
bool toggle () const
QString text1 () const
QString text2 () const
QString iconName () const
QString imageName () const
int getMainWidgetId () const
 Calls the applet and returns the partid set for this desktop file.
QString helpId () const
DcpBriefbrief () const
QVariant value () const
int minValue () const
int maxValue () const
int sliderSteps () const
int briefVersion () const
 Version of the DcpBrief of the applet.

Protected Member Functions

void setBrief (DcpBrief *brief)
 Q_DISABLE_COPY (DcpAppletObject)

Protected Attributes

DcpAppletObjectPrivate *const d_ptr

Detailed Description

This class represents all informations about the applet.

It both gives access to the binary libs of the applet, and its desktop file.


Constructor & Destructor Documentation

DcpAppletObject::DcpAppletObject ( DcpAppletMetadata metadata  ) 
DcpAppletObject::DcpAppletObject ( DcpAppletMetadata metadata,
bool  tryLoad 
)
DcpAppletObject::~DcpAppletObject (  )  [virtual]

Member Function Documentation

void DcpAppletObject::activate ( int  pageId  )  [signal]
bool DcpAppletObject::activatePluginByName ( const QString &  appletName  )  const [slot]

A slot for the inter plugin activation.

Parameters:
appletName The name of the applet to activate.

This slot will request activation of an other applet. (Emits the requestPluginActivation() signal.

void DcpAppletObject::activateSlot ( int  widgetId = -1  )  [slot]
Qt::Alignment DcpAppletObject::align (  )  const
DcpBrief * DcpAppletObject::brief (  )  const
void DcpAppletObject::briefChanged (  )  [signal]
int DcpAppletObject::briefVersion (  )  const

Version of the DcpBrief of the applet.

Similar to interfaceVersion(), except that this function returns the version of the DcpBrief instead of the applet. -1 if the applet does not have a brief, but big enough if the appletObject does not have an applet, but has a brief.

int DcpAppletObject::getMainWidgetId (  )  const

Calls the applet and returns the partid set for this desktop file.

This function will take the "DCP/Part" key and call the "int partID(const QString& partStr)" function of the plugin to get the widgetId for the first/main widget. If the applet is not available the function will return -1, that is an invalid widgetId.

QString DcpAppletObject::helpId (  )  const

Returns the help id of the applet. Value which comes from DcpBrief overrides the value from the desktop file.

QString DcpAppletObject::iconName (  )  const

Returns the icon name for the applet by calling the DcpBrief::icon() or DcpBrief::image() virtual method. If the applet returns the empty string (default implementation) the method will return the icon name provided in the desktop file.

QString DcpAppletObject::imageName (  )  const

Same as iconName()

int DcpAppletObject::maxValue (  )  const
int DcpAppletObject::minValue (  )  const
DcpAppletObject::Q_DISABLE_COPY ( DcpAppletObject   )  [protected]
void DcpAppletObject::requestPluginActivation ( const QString &  pluginName  )  [signal]
void DcpAppletObject::setBrief ( DcpBrief brief  )  [protected]
void DcpAppletObject::setToggle ( bool  checked  )  [slot]
void DcpAppletObject::setValue ( const QVariant &  value  )  [slot]
int DcpAppletObject::sliderSteps (  )  const
void DcpAppletObject::slotClicked (  )  [slot]

This slot will 1) count the activations for the 'most used' category 2) re-enable if the applet is disabled and 3) send the activate() signal so thath the applet will be loaded and shown.

QString DcpAppletObject::text1 (  )  const
QString DcpAppletObject::text2 (  )  const
bool DcpAppletObject::toggle (  )  const
QString DcpAppletObject::toggleIconId (  )  const
QVariant DcpAppletObject::value (  )  const
int DcpAppletObject::widgetTypeID (  )  const

Returns what type of brief widget shall an applet variant use.

Gets the required brief widget type code of the applet variant.


Member Data Documentation

DcpAppletObjectPrivate* const DcpAppletObject::d_ptr [protected]

Reimplemented from DcpAppletPlugin.


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