QtxPagePrefItem Class Reference

Base class for implementation of all the widget-based preference items.

#include <QtxPagePrefMgr.h>

Inheritance diagram for QtxPagePrefItem:

Classes
class	Listener

Public Member Functions
	QtxPagePrefItem (const QString &, QtxPreferenceItem *=0, const QString &=QString(), const QString &=QString())
	Constructor. More...
virtual	~QtxPagePrefItem ()
	Destructor. More...
QWidget *	widget () const
	Get preference item editor widget. More...
virtual void	activate ()
Public Member Functions inherited from QtxPreferenceItem
	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...
QtxPreferenceItem *	rootItem () const
	Get root preference item. More...
QtxPreferenceItem *	parentItem () 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...
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...
QtxPreferenceItem *	findItem (const int, const bool=false) const
	Find the item by the specified identifier. More...
QtxPreferenceItem *	findItem (const QString &, const bool=false) const
	Find the item by the specified title. More...
QtxPreferenceItem *	findItem (const QString &, const int, const bool=false) const
	Find the item by the specified title and identifier. More...
virtual QtxResourceMgr *	resourceMgr () const
	Get the resources manager. More...
virtual QtxPreferenceMgr *	preferenceMgr () const
	Get the parent preferences manager. More...
void	ensureVisible ()

Protected Member Functions
void	setWidget (QWidget *)
	Set preference item editor widget. 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...
void	pageChildItems (QList< QtxPagePrefItem * > &, const bool=false) const
	Find all child items of the QtxPagePrefItem type. More...
virtual void	store ()
	Store preference item to the resource manager. More...
virtual void	retrieve ()
	Retrieve preference item from the resource manager. More...
virtual void	widgetShown ()
	Invoked when preference item widget is shown. More...
virtual void	widgetHided ()
	Invoked when preference item widget is hided. More...
virtual void	ensureVisible (QtxPreferenceItem *)
Protected Member Functions inherited from QtxPreferenceItem
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...
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...

Private Member Functions
virtual void	contentChanged ()
	Called when contents is changed (item is added, removed or modified). More...

Private Attributes
QPointer< QWidget >	myWidget
Listener *	myListener

Additional Inherited Members
Static Public Member Functions inherited from QtxPreferenceItem
static int	RTTI ()
	Specify unique item class identifier. More...
Protected Types inherited from QtxPreferenceItem
typedef QList < QtxPreferenceItem * >	ItemList

Constructor & Destructor Documentation

QtxPagePrefItem::QtxPagePrefItem	(	const QString &	title,
		QtxPreferenceItem *	parent = 0,
		const QString &	sect = QString(),
		const QString &	param = QString()
	)

Parameters

title	preference item title
parent	parent preference item
sect	resource file section associated with the preference item
param	resource file parameter associated with the preference item

QtxPagePrefItem::~QtxPagePrefItem ( )

virtual

References myListener, and myWidget.

Member Function Documentation

void QtxPagePrefItem::activate ( )

virtual

Reimplemented from QtxPreferenceItem.

References QtxPreferenceItem::activate(), and widget().

void QtxPagePrefItem::contentChanged ( )

privatevirtual

Triggers the item update.

References QtxPreferenceItem::triggerUpdate().

void QtxPagePrefItem::ensureVisible ( QtxPreferenceItem *  i )

protectedvirtual

Reimplemented from QtxPreferenceItem.

Reimplemented in QtxPagePrefTabsItem, QtxPagePrefToolBoxItem, and QtxPagePrefListItem.

References QtxPreferenceItem::ensureVisible(), and widget().

void QtxPagePrefItem::itemAdded ( QtxPreferenceItem *  )

protectedvirtual

Parameters

item	child item being added

See Also

itemRemoved(), itemChanged()

Reimplemented from QtxPreferenceItem.

References contentChanged().

void QtxPagePrefItem::itemChanged ( QtxPreferenceItem *  )

protectedvirtual

Parameters

item	child item being modified

See Also

itemAdded(), itemRemoved()

Reimplemented from QtxPreferenceItem.

References contentChanged().

void QtxPagePrefItem::itemRemoved ( QtxPreferenceItem *  )

protectedvirtual

Parameters

item	child item being removed

See Also

itemAdded(), itemChanged()

Reimplemented from QtxPreferenceItem.

References contentChanged().

void QtxPagePrefItem::pageChildItems ( QList< QtxPagePrefItem * > &  list, const bool  rec = false  ) const

protected

Parameters

list	used to return list of child items
rec	if true, perform recursive search

References QtxPreferenceItem::childItems().

void QtxPagePrefItem::retrieve ( )

protectedvirtual

This method should be reimplemented in the subclasses. Base implementation does nothing.

See Also

store()

Implements QtxPreferenceItem.

Reimplemented in QtxUserDefinedItem, QtxPagePrefBackgroundItem, QtxPagePrefShortcutTreeItem, QtxPagePrefShortcutBtnsItem, QtxPagePrefDateTimeItem, QtxPagePrefPathListItem, QtxPagePrefPathItem, QtxPagePrefFontItem, QtxPagePrefBiColorItem, QtxPagePrefColorItem, QtxPagePrefTextItem, QtxPagePrefSpinItem, QtxPagePrefSelectItem, QtxPagePrefSliderItem, QtxPagePrefEditItem, QtxPagePrefCheckItem, and QtxPagePrefGroupItem.

void QtxPagePrefItem::setWidget ( QWidget *  wid )

protected

Parameters

wid	editor widget

See Also

widget()

References myListener, myWidget, and QtxPreferenceItem::sendItemChanges().

void QtxPagePrefItem::store ( )

protectedvirtual

This method should be reimplemented in the subclasses. Base implementation does nothing.

See Also

retrieve()

Implements QtxPreferenceItem.

Reimplemented in QtxUserDefinedItem, QtxPagePrefBackgroundItem, QtxPagePrefShortcutTreeItem, QtxPagePrefShortcutBtnsItem, QtxPagePrefDateTimeItem, QtxPagePrefPathListItem, QtxPagePrefPathItem, QtxPagePrefFontItem, QtxPagePrefBiColorItem, QtxPagePrefColorItem, QtxPagePrefTextItem, QtxPagePrefSpinItem, QtxPagePrefSelectItem, QtxPagePrefSliderItem, QtxPagePrefEditItem, QtxPagePrefCheckItem, and QtxPagePrefGroupItem.

QWidget * QtxPagePrefItem::widget

(

)

const

Returns

editor widget

See Also

setWidget()

References myWidget.

void QtxPagePrefItem::widgetHided ( )

protectedvirtual

void QtxPagePrefItem::widgetShown ( )

protectedvirtual

Reimplemented in QtxPagePrefGroupItem, QtxPagePrefFrameItem, and QtxPagePrefListItem.

Member Data Documentation

Listener* QtxPagePrefItem::myListener

private

QPointer<QWidget> QtxPagePrefItem::myWidget

private

---

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

• src/Qtx/QtxPagePrefMgr.h
• src/Qtx/QtxPagePrefMgr.cxx