Home · All Classes · Main Classes · Deprecated
Public Member Functions | Protected Attributes

MAppletSettings Class Reference

List of all members.

Public Member Functions

 MAppletSettings (const QString &metaDataFileName, const MAppletId &appletId)
 MAppletSettings (const QString &metaDataFileName, const QString &appletId)
virtual ~MAppletSettings ()
const MSettingsLanguageBinaryinstanceSettingsBinary () const
const MSettingsLanguageBinaryglobalSettingsBinary () const
bool hasSettings () const
MDataStoreinstanceDataStore () const
MDataStoreglobalDataStore () const
MDataAccessdataAccess () const
void removeInstanceSettingValues () const

Protected Attributes

MAppletSettingsPrivate *const d_ptr

Detailed Description

This class handles parsing of the applet instance and global settings files and creation of settings binaries.


Constructor & Destructor Documentation

MAppletSettings::MAppletSettings ( const QString metaDataFileName,
const MAppletId &  appletId 
)

Constructs a MAppletSettings object.

Parameters:
metaDataFileName Name of the applet metadata file
appletId The applet's id
MAppletSettings::MAppletSettings ( const QString metaDataFileName,
const QString appletId 
)

Constructs a MAppletSettings object.

Parameters:
metaDataFileName Name of the applet metadata file
appletId The applet's id as a string with the form applicationName/mashupCanvasName/instanceid, for example: myapp/canvas1/1
MAppletSettings::~MAppletSettings (  )  [virtual]

Destructor.


Member Function Documentation

MDataAccess * MAppletSettings::dataAccess (  )  const

Returns a data access for the applet global and instance settings. Returns NULL if the applet has no settings.

MDataStore * MAppletSettings::globalDataStore (  )  const

Returns the datastore for the applet global settings. Returns NULL if the applet has no settings.

const MSettingsLanguageBinary * MAppletSettings::globalSettingsBinary (  )  const

Gets the MSettingsLanguageBinary object for the global settings. Returns NULL if the applet has no global settings.

Returns:
the applet global settings binary.
bool MAppletSettings::hasSettings (  )  const

Returns true if applet has settings (either instance or global or both), false otherwise.

Returns:
a boolean telling whether applet has settings or not.
MDataStore * MAppletSettings::instanceDataStore (  )  const

Returns the datastore for the applet instance settings. Returns NULL if the applet has no settings.

const MSettingsLanguageBinary * MAppletSettings::instanceSettingsBinary (  )  const

Gets the MSettingsLanguageBinary object for the instance settings. Returns NULL if the applet has no instance settings.

Returns:
the applet instance settings binary.
void MAppletSettings::removeInstanceSettingValues (  )  const

Removes all applet instance settings from the storage backend. The handles to the instance settings still remain in this object though. For example instanceSettingsBinary() still returns a binary object that contains all the instance settings.


Member Data Documentation

MAppletSettingsPrivate* const MAppletSettings::d_ptr [protected]

Copyright © 2010 Nokia Corporation
MeeGo Touch