BaseData Class Reference

Provides a interface sharing common data between modules in System Settings. More...

#include <BaseData.h>

Inheritance diagram for BaseData:

[legend]

List of all members.

Public Member Functions
	~BaseData ()
KConfigGroup	configGroup (const QString &pluginName)
MenuItem *	menuItem ()
void	setMenuItem (MenuItem *item)
Static Public Member Functions
static BaseData *	instance ()

---

Detailed Description

Provides a interface sharing common data between modules in System Settings.

BaseData is a standard interface in System Settings to retrieve information that is shared between all modules. It is a singleton, and will be automatically cleaned up.

Author:

Ben Cooksley <ben@eclipse.endoftheinternet.org>

Definition at line 38 of file BaseData.h.

---

Constructor & Destructor Documentation

BaseData::~BaseData

(

)

Normal destructor that handles cleanup.

Any objects created through BaseData must be assumed to be invalid afterwards.

Definition at line 43 of file BaseData.cpp.

---

Member Function Documentation

KConfigGroup BaseData::configGroup

(

const QString &

pluginName

)

Returns the configuration group by the name provided in the current applications configuration file.

Parameters:

pluginName

the name of the group that is required.

Returns:

The configuration group that is required.

Definition at line 65 of file BaseData.cpp.

BaseData * BaseData::instance

(

)

[static]

Provides a pointer to access the shared BaseData instance in order to retrieve data.

Returns:

Access to the shared instance of BaseData.

Definition at line 47 of file BaseData.cpp.

MenuItem * BaseData::menuItem

(

)

Provides the shared MenuItem which lists all categories and modules, for use with MenuModel.

Returns:

the shared MenuItem.

Definition at line 55 of file BaseData.cpp.

void BaseData::setMenuItem

(

MenuItem *

item

)

Sets the MenuItem which the Singleton will return.

For internal use only.

Parameters:

item

A pointer to the MenuItem object

Definition at line 60 of file BaseData.cpp.

---

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

• BaseData.h
• BaseData.cpp