Version: 9.15.0
QtxPreferenceItem Class Referenceabstract

Base class for implementing of all the preference items. More...

#include <QtxPreferenceMgr.h>

Inheritance diagram for QtxPreferenceItem:
Inheritance graph

Classes

class  Updater
 Preference item updater. More...
 

Public Member Functions

 QtxPreferenceItem (QtxPreferenceItem *=0)
 Constructor. More...
 
 QtxPreferenceItem (const QString &, QtxPreferenceItem *)
 Constructor. More...
 
 QtxPreferenceItem (const QString &, const QString &, const QString &, QtxPreferenceItem *)
 Constructor. More...
 
virtual ~QtxPreferenceItem ()
 Destructor. More...
 
int id () const
 Get unique item identifier. More...
 
virtual int rtti () const
 Get unique item type identifier. More...
 
QtxPreferenceItemrootItem () const
 Get root preference item. More...
 
QtxPreferenceItemparentItem () const
 Get parent preference item. More...
 
QList< QtxPreferenceItem * > childItems (const bool=false) const
 Get all child preference items. More...
 
int depth () const
 Get preference item depth. More...
 
int count () const
 Get child preference items number. More...
 
virtual bool isEmpty () const
 Check if the item has children. More...
 
void appendItem (QtxPreferenceItem *)
 Append child preference item. More...
 
void removeItem (QtxPreferenceItem *)
 Remove child preference item. More...
 
void insertItem (QtxPreferenceItem *, QtxPreferenceItem *=0)
 Insert child preference item before specified item. If the before item is 0, then new item is appended. More...
 
QIcon icon () const
 Get preference item icon. More...
 
QString title () const
 Get preference item title. More...
 
void resource (QString &, QString &) const
 Get resource file settings associated to the preference item. More...
 
virtual void setIcon (const QIcon &)
 Set prefence item icon. More...
 
virtual void setTitle (const QString &)
 Set preference item title . More...
 
virtual void setResource (const QString &, const QString &)
 Assign resource file settings to the preference item. More...
 
virtual void updateContents ()
 Update preference item. More...
 
QVariant option (const QString &) const
 Get preference item option value. More...
 
void setOption (const QString &, const QVariant &)
 Set preference item option value. More...
 
bool isEvaluateValues () const
 Get variables auto-conversion option value. More...
 
void setEvaluateValues (const bool)
 Switch variables auto-conversion option on/off. More...
 
bool isRestartRequired () const
 Get restart needed option value. More...
 
void setRestartRequired (const bool)
 Switch restart needed option on/off. More...
 
virtual void store ()=0
 Save preference item (for example, to the resource file). More...
 
virtual void retrieve ()=0
 Restore preference item (for example, from the resource file). More...
 
virtual void retrieveDefault ()
 Restore preference item (for example, from the resource file, ignoring user preferences). If not overridden, it is equivalent to retrieve(). More...
 
QString resourceValue () const
 Get the value of the associated resource file setting. More...
 
void setResourceValue (const QString &)
 Get the value of the associated resource file setting. More...
 
QtxPreferenceItemfindItem (const int, const bool=false) const
 Find the item by the specified identifier. More...
 
QtxPreferenceItemfindItem (const QString &, const bool=false) const
 Find the item by the specified title. More...
 
QtxPreferenceItemfindItem (const QString &, const int, const bool=false) const
 Find the item by the specified title and identifier. More...
 
virtual QtxResourceMgrresourceMgr () const
 Get the resources manager. More...
 
virtual QtxPreferenceMgrpreferenceMgr () const
 Get the parent preferences manager. More...
 
virtual void activate ()
 
void ensureVisible ()
 

Static Public Member Functions

static int RTTI ()
 Specify unique item class identifier. More...
 

Protected Types

typedef QList< QtxPreferenceItem * > ItemList
 

Protected Member Functions

int getInteger (const int=0) const
 Get integer resources value corresponding to the item. More...
 
double getDouble (const double=0.0) const
 Get double resources value corresponding to the item. More...
 
bool getBoolean (const bool=false) const
 Get boolean resources value corresponding to the item. More...
 
QColor getColor (const QColor &=QColor()) const
 Get color resources value corresponding to the item. More...
 
QFont getFont (const QFont &=QFont()) const
 Get font resources value corresponding to the item. More...
 
QString getString (const QString &=QString()) const
 Get string resources value corresponding to the item. More...
 
void setInteger (const int)
 Set integer resources value corresponding to the item. More...
 
void setDouble (const double)
 Set double resources value corresponding to the item. More...
 
void setBoolean (const bool)
 Set boolean resources value corresponding to the item. More...
 
void setColor (const QColor &)
 Set color resources value corresponding to the item. More...
 
void setFont (const QFont &)
 Set font resources value corresponding to the item. More...
 
void setString (const QString &)
 Set string resources value corresponding to the item. More...
 
virtual void itemAdded (QtxPreferenceItem *)
 Callback function which is called when the child preference item is added. More...
 
virtual void itemRemoved (QtxPreferenceItem *)
 Callback function which is called when the child preference item is removed. More...
 
virtual void itemChanged (QtxPreferenceItem *)
 Callback function which is called when the child preference item is modified. More...
 
virtual void ensureVisible (QtxPreferenceItem *)
 
void sendItemChanges ()
 Initiate item changing call back operation. More...
 
virtual void triggerUpdate ()
 Initiate item updating. More...
 
virtual QVariant optionValue (const QString &) const
 Get preference item option value. More...
 
virtual void setOptionValue (const QString &, const QVariant &)
 Set preference item option value. More...
 

Static Private Member Functions

static int generateId ()
 Generate unique preference item identifier. More...
 

Private Attributes

int myId
 
QtxPreferenceItemmyParent
 
ItemList myChildren
 
bool myEval
 
bool myRestartNeeded
 
QIcon myIcon
 
QString myTitle
 
QString mySection
 
QString myParameter
 

Detailed Description

Base class for implementing of all the preference items.

To implement any specific preference item, subclass from the QtxPreferenceItem and redefine store() and retrieve() methods.

Member Typedef Documentation

◆ ItemList

Constructor & Destructor Documentation

◆ QtxPreferenceItem() [1/3]

QtxPreferenceItem::QtxPreferenceItem ( QtxPreferenceItem parent = 0)

Constructor.

Parameters
parentparent preference item

References generateId(), insertItem(), and myId.

◆ QtxPreferenceItem() [2/3]

QtxPreferenceItem::QtxPreferenceItem ( const QString &  title,
QtxPreferenceItem parent 
)

Constructor.

Parameters
titleitem title
parentparent preference item

References generateId(), insertItem(), and myId.

◆ QtxPreferenceItem() [3/3]

QtxPreferenceItem::QtxPreferenceItem ( const QString &  title,
const QString &  sect,
const QString &  param,
QtxPreferenceItem parent 
)

Constructor.

Parameters
titleitem title
sectresource file section to be associated with the item
paramresource file parameter to be associated with the item
parentparent preference item

References generateId(), insertItem(), and myId.

◆ ~QtxPreferenceItem()

QtxPreferenceItem::~QtxPreferenceItem ( )
virtual

Member Function Documentation

◆ activate()

void QtxPreferenceItem::activate ( )
virtual

Reimplemented in QtxPagePrefItem.

◆ appendItem()

void QtxPreferenceItem::appendItem ( QtxPreferenceItem item)

Append child preference item.

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

Parameters
itemitem to be added
See also
removeItem()

References insertItem().

◆ childItems()

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

Get all child preference items.

Parameters
recrecursion boolean flag
Returns
list of child items

References myChildren.

◆ count()

int QtxPreferenceItem::count ( ) const

Get child preference items number.

Returns
number of child items
See also
isEmpty()

References myChildren.

◆ depth()

int QtxPreferenceItem::depth ( ) const

Get preference item depth.

Returns
item depth

References depth(), and parentItem().

◆ ensureVisible() [1/2]

void QtxPreferenceItem::ensureVisible ( )

References ensureVisible(), and parentItem().

◆ ensureVisible() [2/2]

void QtxPreferenceItem::ensureVisible ( QtxPreferenceItem )
protectedvirtual

◆ findItem() [1/3]

QtxPreferenceItem * QtxPreferenceItem::findItem ( const int  id,
const bool  rec = false 
) const

Find the item by the specified identifier.

Parameters
idchild item ID
recif true recursive search is done
Returns
child item or 0 if it is not found

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

◆ findItem() [2/3]

QtxPreferenceItem * QtxPreferenceItem::findItem ( const QString &  title,
const bool  rec = false 
) const

Find the item by the specified title.

Parameters
titlechild item title
recif true recursive search is done
Returns
child item or 0 if it is not found

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

◆ findItem() [3/3]

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

Find the item by the specified title and identifier.

Parameters
titlechild item title
idchild item ID
recif true recursive search is done
Returns
child item or 0 if it is not found

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

◆ generateId()

int QtxPreferenceItem::generateId ( )
staticprivate

Generate unique preference item identifier.

Returns
unique item ID

◆ getBoolean()

bool QtxPreferenceItem::getBoolean ( const bool  val = false) const
protected

Get boolean resources value corresponding to the item.

Parameters
valdefault value (returned if there is no such resource)
Returns
boolean value of the associated resource
See also
setBoolean()

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

◆ getColor()

QColor QtxPreferenceItem::getColor ( const QColor &  val = QColor()) const
protected

Get color resources value corresponding to the item.

Parameters
valdefault value (returned if there is no such resource)
Returns
color value of the associated resource
See also
setColor()

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

◆ getDouble()

double QtxPreferenceItem::getDouble ( const double  val = 0.0) const
protected

Get double resources value corresponding to the item.

Parameters
valdefault value (returned if there is no such resource)
Returns
double value of the associated resource
See also
setDouble()

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

◆ getFont()

QFont QtxPreferenceItem::getFont ( const QFont &  val = QFont()) const
protected

Get font resources value corresponding to the item.

Parameters
valdefault value (returned if there is no such resource)
Returns
font value of the associated resource
See also
setFont()

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

◆ getInteger()

int QtxPreferenceItem::getInteger ( const int  val = 0) const
protected

Get integer resources value corresponding to the item.

Parameters
valdefault value (returned if there is no such resource)
Returns
integer value of the associated resource
See also
setInteger()

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

◆ getString()

QString QtxPreferenceItem::getString ( const QString &  val = QString()) const
protected

Get string resources value corresponding to the item.

Parameters
valdefault value (returned if there is no such resource)
Returns
string value of the associated resource
See also
setString()

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

◆ icon()

QIcon QtxPreferenceItem::icon ( ) const

Get preference item icon.

Returns
item icon
See also
setIcon()

References myIcon.

◆ id()

int QtxPreferenceItem::id ( ) const

Get unique item identifier.

Returns
item ID

References myId.

◆ insertItem()

void QtxPreferenceItem::insertItem ( QtxPreferenceItem item,
QtxPreferenceItem before = 0 
)

Insert child preference item before specified item. If the before item is 0, then new item is appended.

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

Parameters
itemitem to be added
beforeitem before which is inserted new \aitem
See also
removeItem()

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

◆ isEmpty()

bool QtxPreferenceItem::isEmpty ( ) const
virtual

Check if the item has children.

Returns
true if item does not have children
See also
count()

References myChildren.

◆ isEvaluateValues()

bool QtxPreferenceItem::isEvaluateValues ( ) const

Get variables auto-conversion option value.

Returns
option value

References myEval.

◆ isRestartRequired()

bool QtxPreferenceItem::isRestartRequired ( ) const

Get restart needed option value.

Returns
option value

References myRestartNeeded.

◆ itemAdded()

void QtxPreferenceItem::itemAdded ( QtxPreferenceItem )
protectedvirtual

Callback function which is called when the child preference item is added.

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

Parameters
itemchild item being added
See also
itemRemoved(), itemChanged()

Reimplemented in QtxPagePrefItem, and QtxPagePrefMgr.

◆ itemChanged()

void QtxPreferenceItem::itemChanged ( QtxPreferenceItem )
protectedvirtual

Callback function which is called when the child preference item is modified.

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

Parameters
itemchild item being modified
See also
itemAdded(), itemRemoved()

Reimplemented in QtxPagePrefItem, and QtxPagePrefMgr.

◆ itemRemoved()

void QtxPreferenceItem::itemRemoved ( QtxPreferenceItem )
protectedvirtual

Callback function which is called when the child preference item is removed.

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

Parameters
itemchild item being removed
See also
itemAdded(), itemChanged()

Reimplemented in QtxPagePrefItem, and QtxPagePrefMgr.

◆ option()

QVariant QtxPreferenceItem::option ( const QString &  name) const

Get preference item option value.

Parameters
nameoption name
Returns
property value or null QVariant if option is not set
See also
setOption()

References optionValue().

◆ optionValue()

QVariant QtxPreferenceItem::optionValue ( const QString &  name) const
protectedvirtual

Get preference item option value.

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

Parameters
nameoption name
Returns
property value or null QVariant if option is not set
See also
setOptionValue()

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

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

◆ parentItem()

QtxPreferenceItem * QtxPreferenceItem::parentItem ( ) const

Get parent preference item.

Returns
parent item

References myParent.

◆ preferenceMgr()

QtxPreferenceMgr * QtxPreferenceItem::preferenceMgr ( ) const
virtual

Get the parent preferences manager.

Returns
preferences manager or 0 if it is not defined

Reimplemented in QtxPreferenceMgr.

References parentItem(), and preferenceMgr().

◆ removeItem()

void QtxPreferenceItem::removeItem ( QtxPreferenceItem item)

Remove child preference item.

Parameters
itemitem to be removed
See also
insertItem()

References itemRemoved(), myChildren, and myParent.

◆ resource()

void QtxPreferenceItem::resource ( QString &  sec,
QString &  param 
) const

Get resource file settings associated to the preference item.

Parameters
secused to return resource file section name
paramused to return resource file parameter name
See also
setResource()

References myParameter, and mySection.

◆ resourceMgr()

QtxResourceMgr * QtxPreferenceItem::resourceMgr ( ) const
virtual

Get the resources manager.

Returns
resource manager pointer or 0 if it is not defined

Reimplemented in QtxPreferenceMgr.

References preferenceMgr(), and QtxPreferenceMgr::resourceMgr().

◆ resourceValue()

QString QtxPreferenceItem::resourceValue ( ) const

Get the value of the associated resource file setting.

Returns
associated resource file setting value
See also
setResourceValue()

References getString().

◆ retrieve()

◆ retrieveDefault()

void QtxPreferenceItem::retrieveDefault ( )
virtual

Restore preference item (for example, from the resource file, ignoring user preferences). If not overridden, it is equivalent to retrieve().

Reimplemented in SUIT_PagePrefShortcutTreeItem, and QtxPreferenceMgr.

References retrieve().

◆ rootItem()

QtxPreferenceItem * QtxPreferenceItem::rootItem ( ) const

Get root preference item.

Returns
root item

References parentItem().

◆ RTTI()

int QtxPreferenceItem::RTTI ( )
static

Specify unique item class identifier.

Returns
item class ID

◆ rtti()

int QtxPreferenceItem::rtti ( ) const
virtual

Get unique item type identifier.

Returns
item type ID

References RTTI().

◆ sendItemChanges()

void QtxPreferenceItem::sendItemChanges ( )
protected

Initiate item changing call back operation.

References itemChanged(), and parentItem().

◆ setBoolean()

void QtxPreferenceItem::setBoolean ( const bool  val)
protected

Set boolean resources value corresponding to the item.

Parameters
valnew value
See also
getBoolean()

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

◆ setColor()

void QtxPreferenceItem::setColor ( const QColor &  val)
protected

Set color resources value corresponding to the item.

Parameters
valnew value
See also
getColor()

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

◆ setDouble()

void QtxPreferenceItem::setDouble ( const double  val)
protected

Set double resources value corresponding to the item.

Parameters
valnew value
See also
getDouble()

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

◆ setEvaluateValues()

void QtxPreferenceItem::setEvaluateValues ( const bool  on)

Switch variables auto-conversion option on/off.

Parameters
onoption value

References myEval.

◆ setFont()

void QtxPreferenceItem::setFont ( const QFont &  val)
protected

Set font resources value corresponding to the item.

Parameters
valnew value
See also
getFont()

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

◆ setIcon()

void QtxPreferenceItem::setIcon ( const QIcon &  ico)
virtual

Set prefence item icon.

Parameters
iconew item icon
See also
icon()

References myIcon, and sendItemChanges().

◆ setInteger()

void QtxPreferenceItem::setInteger ( const int  val)
protected

Set integer resources value corresponding to the item.

Parameters
valnew value
See also
getInteger()

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

◆ setOption()

void QtxPreferenceItem::setOption ( const QString &  name,
const QVariant &  val 
)

Set preference item option value.

Parameters
nameoption name
valnew property value
See also
option()

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

◆ setOptionValue()

void QtxPreferenceItem::setOptionValue ( const QString &  name,
const QVariant &  val 
)
protectedvirtual

◆ setResource()

void QtxPreferenceItem::setResource ( const QString &  sec,
const QString &  param 
)
virtual

Assign resource file settings to the preference item.

Parameters
secresource file section name
paramresource file parameter name
See also
resource()

Reimplemented in QtxPagePrefGroupItem.

References myParameter, and mySection.

◆ setResourceValue()

void QtxPreferenceItem::setResourceValue ( const QString &  val)

Get the value of the associated resource file setting.

Parameters
valnew associated resource file setting value
See also
resourceValue()

References setString().

◆ setRestartRequired()

void QtxPreferenceItem::setRestartRequired ( const bool  on)

Switch restart needed option on/off.

Parameters
onoption value

References myRestartNeeded.

◆ setString()

void QtxPreferenceItem::setString ( const QString &  val)
protected

Set string resources value corresponding to the item.

Parameters
valnew value
See also
getString()

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

◆ setTitle()

void QtxPreferenceItem::setTitle ( const QString &  title)
virtual

Set preference item title .

Parameters
titlenew item title
See also
title()

Reimplemented in QtxPagePrefCheckItem, QtxPagePrefLabelItem, and QtxPageNamedPrefItem.

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

◆ store()

◆ title()

QString QtxPreferenceItem::title ( ) const

Get preference item title.

Returns
item title
See also
setTitle()

References myTitle.

◆ triggerUpdate()

void QtxPreferenceItem::triggerUpdate ( )
protectedvirtual

◆ updateContents()

void QtxPreferenceItem::updateContents ( )
virtual

Member Data Documentation

◆ myChildren

ItemList QtxPreferenceItem::myChildren
private

◆ myEval

bool QtxPreferenceItem::myEval
private

◆ myIcon

QIcon QtxPreferenceItem::myIcon
private

◆ myId

int QtxPreferenceItem::myId
private

◆ myParameter

QString QtxPreferenceItem::myParameter
private

◆ myParent

QtxPreferenceItem* QtxPreferenceItem::myParent
private

◆ myRestartNeeded

bool QtxPreferenceItem::myRestartNeeded
private

◆ mySection

QString QtxPreferenceItem::mySection
private

◆ myTitle

QString QtxPreferenceItem::myTitle
private

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