Class for managing preferences items.

#include <QtxPreferenceMgr.h>

Inheritance diagram for QtxPreferenceMgr:

Public Member Functions
	QtxPreferenceMgr (QtxResourceMgr *)
	Constructor.
virtual	~QtxPreferenceMgr ()
	Destructor.
virtual QtxResourceMgr *	resourceMgr () const
	Get the resources manager.
virtual QtxPreferenceMgr *	preferenceMgr () const
	Get the parent preferences manager.
QVariant	option (const int, const QString &) const
	Get preference item option value.
void	setOption (const int, const QString &, const QVariant &)
	Set preference item option value.
virtual void	store ()
	Store all preferences item to the resource manager.
virtual void	retrieve ()
	Retrieve all preference items from the resource manager.
virtual void	update ()
	Update preferences manager.
virtual void	toBackup ()
	Dumps all values to the backup container.
virtual void	fromBackup ()
	Restore all values from the backup container.
int	id () const
	Get unique item identifier.
virtual int	rtti () const
	Get unique item type identifier.
QtxPreferenceItem *	rootItem () const
	Get root preference item.
QtxPreferenceItem *	parentItem () const
	Get parent preference item.
QList< QtxPreferenceItem * >	childItems (const bool=false) const
	Get all child preference items.
int	depth () const
	Get preference item depth.
int	count () const
	Get child preference items number.
virtual bool	isEmpty () const
	Check if the item has children.
void	appendItem (QtxPreferenceItem *)
	Append child preference item.
void	removeItem (QtxPreferenceItem *)
	Remove child preference item.
void	insertItem (QtxPreferenceItem , QtxPreferenceItem =0)
	Insert child preference item before specified item. If the before item is 0 then new item is appended.
QIcon	icon () const
	Get preference item icon.
QString	title () const
	Get preference item title.
void	resource (QString &, QString &) const
	Get resource file settings associated to the preference item.
virtual void	setIcon (const QIcon &)
	Set prefence item icon.
virtual void	setTitle (const QString &)
	Set preference item title .
virtual void	setResource (const QString &, const QString &)
	Assign resource file settings to the preference item.
virtual void	updateContents ()
	Update preference item.
QVariant	option (const QString &) const
	Get preference item option value.
void	setOption (const QString &, const QVariant &)
	Set preference item option value.
bool	isEvaluateValues () const
void	setEvaluateValues (const bool)
QString	resourceValue () const
	Get the value of the associated resource file setting.
void	setResourceValue (const QString &)
	Get the value of the associated resource file setting.
QtxPreferenceItem *	findItem (const int, const bool=false) const
	Find the item by the specified identifier.
QtxPreferenceItem *	findItem (const QString &, const bool=false) const
	Find the item by the specified title.
QtxPreferenceItem *	findItem (const QString &, const int, const bool=false) const
	Find the item by the specified title and identifier.
virtual void	activate ()
void	ensureVisible ()
Static Public Member Functions
static int	RTTI ()
	Specify unique item class identifier.
Protected Types
typedef QMap < QtxPreferenceItem *, QString >	ResourceMap
typedef QList < QtxPreferenceItem * >	ItemList
Protected Member Functions
void	resourceValues (QMap< int, QString > &) const
	Get all resources items values.
void	resourceValues (ResourceMap &) const
	Get all resources items values.
void	setResourceValues (QMap< int, QString > &) const
	Set all resources items values.
void	setResourceValues (ResourceMap &) const
	Set all resources items values.
void	differentValues (const QMap< int, QString > &, const QMap< int, QString > &, QMap< int, QString > &, const bool fromFirst=false) const
	Compare two maps of resources values to find differences.
void	differentValues (const ResourceMap &, const ResourceMap &, ResourceMap &, const bool fromFirst=false) const
	Compare two maps of resources values to find differences.
virtual void	changedResources (const ResourceMap &)
	Perform custom activity on resource changing.
virtual void	ensureVisible (QtxPreferenceItem *)
int	getInteger (const int=0) const
	Get integer resources value corresponding to the item.
double	getDouble (const double=0.0) const
	Get double resources value corresponding to the item.
bool	getBoolean (const bool=false) const
	Get boolean resources value corresponding to the item.
QColor	getColor (const QColor &=QColor()) const
	Get color resources value corresponding to the item.
QFont	getFont (const QFont &=QFont()) const
	Get font resources value corresponding to the item.
QString	getString (const QString &=QString()) const
	Get string resources value corresponding to the item.
void	setInteger (const int)
	Set integer resources value corresponding to the item.
void	setDouble (const double)
	Set double resources value corresponding to the item.
void	setBoolean (const bool)
	Set boolean resources value corresponding to the item.
void	setColor (const QColor &)
	Set color resources value corresponding to the item.
void	setFont (const QFont &)
	Set font resources value corresponding to the item.
void	setString (const QString &)
	Set string resources value corresponding to the item.
virtual void	itemAdded (QtxPreferenceItem *)
	Callback function which is called when the child preference item is added.
virtual void	itemRemoved (QtxPreferenceItem *)
	Callback function which is called when the child preference item is removed.
virtual void	itemChanged (QtxPreferenceItem *)
	Callback function which is called when the child preference item is modified.
void	sendItemChanges ()
	Initiate item changing call back operation.
virtual void	triggerUpdate ()
	Initiate item updating.
virtual QVariant	optionValue (const QString &) const
	Get preference item option value.
virtual void	setOptionValue (const QString &, const QVariant &)
	Set preference item option value.
Private Attributes
QtxResourceMgr *	myResMgr
ResourceMap	myBackup

Member Typedef Documentation

typedef QMap<QtxPreferenceItem*, QString> QtxPreferenceMgr.ResourceMap [protected]

typedef QList<QtxPreferenceItem*> QtxPreferenceItem.ItemList [protected, inherited]

Constructor & Destructor Documentation

QtxPreferenceMgr::QtxPreferenceMgr ( QtxResourceMgr * mgr )

Parameters:

mgr	resources manager

QtxPreferenceMgr::~QtxPreferenceMgr ( ) [virtual]

Member Function Documentation

QtxResourceMgr * QtxPreferenceMgr::resourceMgr ( ) const [virtual]

Returns:: resource manager pointer or 0 if it is not defined

Reimplemented from QtxPreferenceItem.

References myResMgr.

QtxPreferenceMgr * QtxPreferenceMgr::preferenceMgr ( ) const [virtual]

Returns:: pointer to itself

Reimplemented from QtxPreferenceItem.

QVariant QtxPreferenceMgr::option	(	const int	id,
		const QString &	propName
	)		const

Parameters:

id	preference item ID
propName	option name

Returns:: property value or null QVariant if option is not set

See also:: setOption()

References QtxPreferenceItem.findItem(), and QtxPreferenceItem.option().

void QtxPreferenceMgr::setOption	(	const int	id,
		const QString &	propName,
		const QVariant &	propValue
	)

Parameters:

id	preference item ID
propName	option name
propValue	new property value

See also:: option()

References QtxPreferenceItem.findItem(), and QtxPreferenceItem.setOption().

void QtxPreferenceMgr::store ( ) [virtual]

See also:: retrieve()

Implements QtxPreferenceItem.

References changedResources(), QtxPreferenceItem.childItems(), differentValues(), and resourceValues().

void QtxPreferenceMgr::retrieve ( ) [virtual]

See also:: store()

Implements QtxPreferenceItem.

References QtxPreferenceItem.childItems().

void QtxPreferenceMgr::update ( ) [virtual]

Base implementation does nothing.

void QtxPreferenceMgr::toBackup ( ) [virtual]

See also:: fromBackup()

References myBackup, and resourceValues().

void QtxPreferenceMgr::fromBackup ( ) [virtual]

See also:: toBackup()

References changedResources(), differentValues(), myBackup, resourceValues(), and setResourceValues().

void QtxPreferenceMgr::resourceValues ( QMap< int, QString > & map ) const [protected]

Parameters:

map	used as container filled with the resources values (<ID>:

)

See also:: setResourceValues()

References QtxPreferenceItem.childItems(), QtxResourceMgr.hasValue(), QtxPreferenceItem.id(), QtxPreferenceItem.resource(), resourceMgr(), and QtxPreferenceItem.resourceValue().

void QtxPreferenceMgr::resourceValues ( ResourceMap & map ) const [protected]

Parameters:

map	used as container filled with the resources values (:

)

See also:: setResourceValues()

References QtxPreferenceItem.childItems(), QtxResourceMgr.hasValue(), QtxPreferenceItem.resource(), resourceMgr(), and QtxPreferenceItem.resourceValue().

void QtxPreferenceMgr::setResourceValues ( QMap< int, QString > & map ) const [protected]

Parameters:

map	map with resources values (<ID>:

)

See also:: resourceValues()

References QtxPreferenceItem.findItem(), and QtxPreferenceItem.setResourceValue().

void QtxPreferenceMgr::setResourceValues ( ResourceMap & map ) const [protected]

Parameters:

map	map with resources values (:

)

See also:: resourceValues()

void QtxPreferenceMgr::differentValues	(	const QMap< int, QString > &	map1,
		const QMap< int, QString > &	map2,
		QMap< int, QString > &	resMap,
		const bool	fromFirst = `false`
	)		const `[protected]`

Parameters:

map1	first map
map2	second map
resMap	map to be filled with different values
fromFirst	if `true`, then resMap will be filled with the values from map1, otherwise - from map2

void QtxPreferenceMgr::differentValues	(	const ResourceMap &	map1,
		const ResourceMap &	map2,
		ResourceMap &	resMap,
		const bool	fromFirst = `false`
	)		const `[protected]`

Parameters:

map1	first map
map2	second map
resMap	map to be filled with different values
fromFirst	if `true`, then resMap will be filled with the values from map1, otherwise - from map2

void QtxPreferenceMgr::changedResources ( const ResourceMap & ) [protected, virtual]

This method is called from store() and fromBackup() methods. Base implementation does nothing.

See also:: store(), fromBackup()

Reimplemented in LightApp_Preferences.

int QtxPreferenceItem::id ( ) const [inherited]

Returns:: item ID

References QtxPreferenceItem.myId.

int QtxPreferenceItem::rtti ( ) const [virtual, inherited]

Returns:: item type ID

References QtxPreferenceItem.RTTI().

QtxPreferenceItem * QtxPreferenceItem::rootItem ( ) const [inherited]

Returns:: root item

References QtxPreferenceItem.parentItem().

QtxPreferenceItem * QtxPreferenceItem::parentItem ( ) const [inherited]

Returns:: parent item

References QtxPreferenceItem.myParent.

QList< QtxPreferenceItem * > QtxPreferenceItem::childItems ( const bool rec = false ) const [inherited]

Parameters:

rec	recursion boolean flag

Returns:: list of child items

References QtxPreferenceItem.myChildren.

int QtxPreferenceItem::depth ( ) const [inherited]

Returns:: item depth

References QtxPreferenceItem.depth(), and QtxPreferenceItem.parentItem().

int QtxPreferenceItem::count ( ) const [inherited]

Returns:: number of child items

See also:: isEmpty()

References QtxPreferenceItem.myChildren.

bool QtxPreferenceItem::isEmpty ( ) const [virtual, inherited]

Returns:: true if item does not have children

See also:: count()

References QtxPreferenceItem.myChildren.

void QtxPreferenceItem::appendItem ( QtxPreferenceItem * item ) [inherited]

Removes (if necessary) the item from the previous parent.

Parameters:

item	item to be added

See also:: removeItem()

References QtxPreferenceItem.insertItem().

void QtxPreferenceItem::removeItem ( QtxPreferenceItem * item ) [inherited]

Parameters:

item	item to be removed

See also:: insertItem()

References QtxPreferenceItem.itemRemoved(), QtxPreferenceItem.myChildren, and QtxPreferenceItem.myParent.

void QtxPreferenceItem::insertItem	(	QtxPreferenceItem *	item,
		QtxPreferenceItem *	before = `0`
	)		`[inherited]`

Removes (if necessary) the item from the previous parent.

Parameters:

item	item to be added
before	item before which is inserted new

See also:: removeItem()

References QtxPreferenceItem.itemAdded(), QtxPreferenceItem.myChildren, QtxPreferenceItem.myParent, QtxPreferenceItem.parentItem(), and QtxPreferenceItem.removeItem().

QIcon QtxPreferenceItem::icon ( ) const [inherited]

Returns:: item icon

See also:: setIcon()

References QtxPreferenceItem.myIcon.

QString QtxPreferenceItem::title ( ) const [inherited]

Returns:: item title

See also:: setTitle()

References QtxPreferenceItem.myTitle.

void QtxPreferenceItem::resource	(	QString &	sec,
		QString &	param
	)		const `[inherited]`

Parameters:

sec	used to return resource file section name
param	used to return resource file parameter name

See also:: setResource()

References QtxPreferenceItem.myParameter, and QtxPreferenceItem.mySection.

void QtxPreferenceItem::setIcon ( const QIcon & ico ) [virtual, inherited]

Parameters:

ico	new item icon

See also:: icon()

References QtxPreferenceItem.myIcon, and QtxPreferenceItem.sendItemChanges().

void QtxPreferenceItem::setTitle ( const QString & title ) [virtual, inherited]

Parameters:

title new item title

See also:: title()

Reimplemented in QtxPageNamedPrefItem, QtxPagePrefLabelItem, and QtxPagePrefCheckItem.

References QtxPreferenceItem.myTitle, QtxPreferenceItem.sendItemChanges(), and QtxPreferenceItem.title().

void QtxPreferenceItem::setResource	(	const QString &	sec,
		const QString &	param
	)		`[virtual, inherited]`

Parameters:

sec	resource file section name
param	resource file parameter name

See also:: resource()

Reimplemented in QtxPagePrefGroupItem.

References QtxPreferenceItem.myParameter, and QtxPreferenceItem.mySection.

void QtxPreferenceItem::updateContents ( ) [virtual, inherited]

Reimplemented in QtxPagePrefMgr, QtxPagePrefListItem, QtxPagePrefToolBoxItem, QtxPagePrefTabsItem, QtxPagePrefFrameItem, and QtxPagePrefGroupItem.

References QtxPreferenceItem.Updater.instance(), and QtxPreferenceItem.Updater.removeItem().

QVariant QtxPreferenceItem::option ( const QString & name ) const [inherited]

Parameters:

name	option name

Returns:: property value or null QVariant if option is not set

See also:: setOption()

References QtxPreferenceItem.optionValue().

void QtxPreferenceItem::setOption	(	const QString &	name,
		const QVariant &	val
	)		`[inherited]`

Parameters:

name	option name
val	new property value

See also:: option()

References QtxPreferenceItem.optionValue(), QtxPreferenceItem.sendItemChanges(), and QtxPreferenceItem.setOptionValue().

bool QtxPreferenceItem::isEvaluateValues ( ) const [inherited]

References QtxPreferenceItem.myEval.

void QtxPreferenceItem::setEvaluateValues ( const bool on ) [inherited]

References QtxPreferenceItem.myEval.

QString QtxPreferenceItem::resourceValue ( ) const [inherited]

Returns:: associated resource file setting value

See also:: setResourceValue()

References QtxPreferenceItem.getString().

void QtxPreferenceItem::setResourceValue ( const QString & val ) [inherited]

Parameters:

val	new associated resource file setting value

See also:: resourceValue()

References QtxPreferenceItem.setString().

QtxPreferenceItem * QtxPreferenceItem::findItem	(	const int	id,
		const bool	rec = `false`
	)		const `[inherited]`

Parameters:

id	child item ID
rec	if `true` recursive search is done

Returns:: child item or 0 if it is not found

References QtxPreferenceItem.findItem(), QtxPreferenceItem.id(), and QtxPreferenceItem.myChildren.

QtxPreferenceItem * QtxPreferenceItem::findItem	(	const QString &	title,
		const bool	rec = `false`
	)		const `[inherited]`

Parameters:

title	child item title
rec	if `true` recursive search is done

Returns:: child item or 0 if it is not found

References QtxPreferenceItem.findItem(), QtxPreferenceItem.myChildren, and QtxPreferenceItem.title().

QtxPreferenceItem * QtxPreferenceItem::findItem	(	const QString &	title,
		const int	id,
		const bool	rec = `false`
	)		const `[inherited]`

Parameters:

title	child item title
id	child item ID
rec	if `true` recursive search is done

Returns:: child item or 0 if it is not found

References QtxPreferenceItem.findItem(), QtxPreferenceItem.id(), QtxPreferenceItem.myChildren, and QtxPreferenceItem.title().

void QtxPreferenceItem::activate ( ) [virtual, inherited]

Reimplemented in QtxPagePrefItem.

void QtxPreferenceItem::ensureVisible ( ) [inherited]

References QtxPreferenceItem.ensureVisible(), and QtxPreferenceItem.parentItem().

void QtxPreferenceItem::ensureVisible ( QtxPreferenceItem * ) [protected, virtual, inherited]

Reimplemented in QtxPagePrefItem, QtxPagePrefListItem, QtxPagePrefToolBoxItem, and QtxPagePrefTabsItem.

References QtxPreferenceItem.ensureVisible().

int QtxPreferenceItem::RTTI ( ) [static, inherited]

Returns:: item class ID

int QtxPreferenceItem::getInteger ( const int val = 0 ) const [protected, inherited]

Parameters:

val	default value (returned if there is no such resource)

Returns:: integer value of the associated resource

See also:: setInteger()

References QtxResourceMgr.integerValue(), QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, and QtxPreferenceItem.resourceMgr().

double QtxPreferenceItem::getDouble ( const double val = 0.0 ) const [protected, inherited]

Parameters:

val	default value (returned if there is no such resource)

Returns:: double value of the associated resource

See also:: setDouble()

References QtxResourceMgr.doubleValue(), QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, and QtxPreferenceItem.resourceMgr().

bool QtxPreferenceItem::getBoolean ( const bool val = false ) const [protected, inherited]

Parameters:

val	default value (returned if there is no such resource)

Returns:: boolean value of the associated resource

See also:: setBoolean()

References QtxResourceMgr.booleanValue(), QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, and QtxPreferenceItem.resourceMgr().

QColor QtxPreferenceItem::getColor ( const QColor & val = QColor() ) const [protected, inherited]

Parameters:

val	default value (returned if there is no such resource)

Returns:: color value of the associated resource

See also:: setColor()

References QtxResourceMgr.colorValue(), QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, and QtxPreferenceItem.resourceMgr().

QFont QtxPreferenceItem::getFont ( const QFont & val = QFont() ) const [protected, inherited]

Parameters:

val	default value (returned if there is no such resource)

Returns:: font value of the associated resource

See also:: setFont()

References QtxResourceMgr.fontValue(), QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, and QtxPreferenceItem.resourceMgr().

QString QtxPreferenceItem::getString ( const QString & val = QString() ) const [protected, inherited]

Parameters:

val	default value (returned if there is no such resource)

Returns:: string value of the associated resource

See also:: setString()

References QtxPreferenceItem.isEvaluateValues(), QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, QtxPreferenceItem.resourceMgr(), and QtxResourceMgr.value().

void QtxPreferenceItem::setInteger ( const int val ) [protected, inherited]

Parameters:

val new value

See also:: getInteger()

References QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, QtxPreferenceItem.resourceMgr(), and QtxResourceMgr.setValue().

void QtxPreferenceItem::setDouble ( const double val ) [protected, inherited]

Parameters:

val new value

See also:: getDouble()

References QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, QtxPreferenceItem.resourceMgr(), and QtxResourceMgr.setValue().

void QtxPreferenceItem::setBoolean ( const bool val ) [protected, inherited]

Parameters:

val new value

See also:: getBoolean()

References QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, QtxPreferenceItem.resourceMgr(), and QtxResourceMgr.setValue().

void QtxPreferenceItem::setColor ( const QColor & val ) [protected, inherited]

Parameters:

val new value

See also:: getColor()

References QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, QtxPreferenceItem.resourceMgr(), and QtxResourceMgr.setValue().

void QtxPreferenceItem::setFont ( const QFont & val ) [protected, inherited]

Parameters:

val new value

See also:: getFont()

References QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, QtxPreferenceItem.resourceMgr(), and QtxResourceMgr.setValue().

void QtxPreferenceItem::setString ( const QString & val ) [protected, inherited]

Parameters:

val new value

See also:: getString()

References QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, QtxPreferenceItem.resourceMgr(), and QtxResourceMgr.setValue().

void QtxPreferenceItem::itemAdded ( QtxPreferenceItem * ) [protected, virtual, inherited]

This function can be reimplemented in the subclasses to customize child item addition operation. Base implementation does nothing.

Parameters:

item	child item being added

See also:: itemRemoved(), itemChanged()

Reimplemented in QtxPagePrefMgr, and QtxPagePrefItem.

void QtxPreferenceItem::itemRemoved ( QtxPreferenceItem * ) [protected, virtual, inherited]

This function can be reimplemented in the subclasses to customize child item removal operation. Base implementation does nothing.

Parameters:

item	child item being removed

See also:: itemAdded(), itemChanged()

Reimplemented in QtxPagePrefMgr, and QtxPagePrefItem.

void QtxPreferenceItem::itemChanged ( QtxPreferenceItem * ) [protected, virtual, inherited]

This function can be reimplemented in the subclasses to customize child item modifying operation. Base implementation does nothing.

Parameters:

item	child item being modified

See also:: itemAdded(), itemRemoved()

Reimplemented in QtxPagePrefMgr, and QtxPagePrefItem.

void QtxPreferenceItem::sendItemChanges ( ) [protected, inherited]

References QtxPreferenceItem.itemChanged(), and QtxPreferenceItem.parentItem().

void QtxPreferenceItem::triggerUpdate ( ) [protected, virtual, inherited]

References QtxPreferenceItem.Updater.instance(), and QtxPreferenceItem.Updater.updateItem().

QVariant QtxPreferenceItem::optionValue ( const QString & name ) const [protected, virtual, inherited]

This function can be reimplemented in the subclasses. Base implementation does nothing.

Parameters:

name	option name

Returns:: property value or null QVariant if option is not set

See also:: setOptionValue()

Reimplemented in QtxPagePrefMgr, QtxPagePrefListItem, QtxPagePrefTabsItem, QtxPagePrefFrameItem, QtxPagePrefGroupItem, QtxPagePrefLabelItem, QtxPagePrefSpaceItem, QtxPagePrefEditItem, QtxPagePrefSliderItem, QtxPagePrefSelectItem, QtxPagePrefSpinItem, QtxPagePrefFontItem, QtxPagePrefPathItem, QtxPagePrefPathListItem, QtxPagePrefDateTimeItem, QtxUserDefinedItem, and SUIT_PreferenceMgr.

References QtxPreferenceItem.isEvaluateValues(), and QtxPreferenceItem.title().

void QtxPreferenceItem::setOptionValue	(	const QString &	name,
		const QVariant &	val
	)		`[protected, virtual, inherited]`

This function can be reimplemented in the subclasses. Base implementation does nothing.

Parameters:

name	option name
val	new property value

See also:: optionValue()

Reimplemented in QtxPagePrefMgr, QtxPagePrefListItem, QtxPagePrefTabsItem, QtxPagePrefFrameItem, QtxPagePrefGroupItem, QtxPagePrefLabelItem, QtxPagePrefSpaceItem, QtxPagePrefEditItem, QtxPagePrefSliderItem, QtxPagePrefSelectItem, QtxPagePrefSpinItem, QtxPagePrefFontItem, QtxPagePrefPathItem, QtxPagePrefPathListItem, QtxPagePrefDateTimeItem, QtxUserDefinedItem, and SUIT_PreferenceMgr.

References QtxPreferenceItem.setEvaluateValues(), and QtxPreferenceItem.setTitle().

Field Documentation

QtxResourceMgr* QtxPreferenceMgr.myResMgr [private]

ResourceMap QtxPreferenceMgr.myBackup [private]

QtxPreferenceMgr Class Reference

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Private Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation