QtxPagePrefGroupItem Class Reference

GUI implementation of the group widget container.

#include <QtxPagePrefMgr.h>

Inheritance diagram for QtxPagePrefGroupItem:

Public Member Functions
	QtxPagePrefGroupItem (const QString &, QtxPreferenceItem *=0, const QString &=QString(), const QString &=QString())
	Constructor. More...
	QtxPagePrefGroupItem (const int, const QString &, QtxPreferenceItem *=0, const QString &=QString(), const QString &=QString())
	Constructor. More...
virtual	~QtxPagePrefGroupItem ()
	Destructor. More...
virtual void	updateContents ()
	Update widget contents. More...
int	margin () const
	Get group box margin. More...
void	setMargin (const int)
	Get group box margin. More...
int	spacing () const
	Get group box spacing. More...
void	setSpacing (const int)
	Set group box spacing. More...
int	columns () const
	Get number of group box columns. More...
void	setColumns (const int)
	Set number of group box columns. More...
Qt::Orientation	orientation () const
	Get group box orientation. More...
void	setOrientation (const Qt::Orientation)
	Set group box orientation. More...
bool	isFlat () const
	Get 'flat' flag of the group box widget. More...
void	setFlat (const bool)
	Get 'flat' flag of the group box widget. More...
virtual void	setResource (const QString &, const QString &)
	Assign resource file settings to the preference item. More...
virtual void	store ()
	Store preference item to the resource manager. More...
virtual void	retrieve ()
	Retrieve preference item from the resource manager. More...
QtxGridBox *	gridBox () const
	Return widget contained grid layout of this group. More...
Public Member Functions inherited from QtxPagePrefItem
	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...
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
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...
virtual void	widgetShown ()
	Invoked when preference item widget is shown. More...
Protected Member Functions inherited from QtxPagePrefItem
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	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...

Private Member Functions
void	updateState ()
	Update widget state. More...
void	updateGroup ()
	Update group box widget. More...

Private Attributes
QtxGridBox *	myBox
QtxGroupBox *	myGroup

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

QtxPagePrefGroupItem::QtxPagePrefGroupItem	(	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

References Horizontal, myBox, myGroup, QtxGroupBox::setWidget(), QtxPagePrefItem::setWidget(), and updateState().

QtxPagePrefGroupItem::QtxPagePrefGroupItem	(	const int	cols,
		const QString &	title,
		QtxPreferenceItem *	parent = 0,
		const QString &	sect = QString(),
		const QString &	param = QString()
	)

Parameters

cols	columns number
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

References Horizontal, myBox, myGroup, QtxGroupBox::setWidget(), QtxPagePrefItem::setWidget(), and updateState().

QtxPagePrefGroupItem::~QtxPagePrefGroupItem ( )

virtual

Member Function Documentation

int QtxPagePrefGroupItem::columns

(

)

const

Returns

current columns number

See Also

setColumns()

References QtxGridBox::columns(), and myBox.

QtxGridBox * QtxPagePrefGroupItem::gridBox

(

)

const

References myBox.

bool QtxPagePrefGroupItem::isFlat

(

)

const

Returns

true if the group box is flat

References myGroup.

int QtxPagePrefGroupItem::margin

(

)

const

Returns

current group box margin

See Also

setMargin()

References QtxGridBox::insideMargin(), and myBox.

QVariant QtxPagePrefGroupItem::optionValue ( const QString &  name ) const

protectedvirtual

Parameters

name	option name

Returns

property value or null QVariant if option is not set

See Also

setOptionValue()

Reimplemented from QtxPreferenceItem.

References columns(), isFlat(), margin(), QtxPreferenceItem::optionValue(), orientation(), and spacing().

Qt::Orientation QtxPagePrefGroupItem::orientation

(

)

const

Returns

current group box orientation

See Also

setOrientation()

References myBox, and QtxGridBox::orientation().

void QtxPagePrefGroupItem::retrieve ( )

virtual

See Also

store()

Reimplemented from QtxPagePrefItem.

References QtxPreferenceItem::getBoolean(), and myGroup.

void QtxPagePrefGroupItem::setColumns

(

const int

c

)

Parameters

c	new columns number

See Also

columns()

References myBox, and QtxGridBox::setColumns().

void QtxPagePrefGroupItem::setFlat

(

const bool

on

)

Parameters

on	if true the group box will be made flat

References myGroup.

void QtxPagePrefGroupItem::setMargin

(

const int

m

)

Parameters

m	new group box margin

See Also

margin()

References myBox, and QtxGridBox::setInsideMargin().

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

protectedvirtual

Parameters

name	option name
val	new property value

See Also

optionValue()

Reimplemented from QtxPreferenceItem.

References setColumns(), setFlat(), setMargin(), QtxPreferenceItem::setOptionValue(), setOrientation(), and setSpacing().

void QtxPagePrefGroupItem::setOrientation

(

const Qt::Orientation

o

)

Parameters

o	new group box orientation

See Also

orientation()

References myBox, and QtxGridBox::setOrientation().

void QtxPagePrefGroupItem::setResource ( const QString &  sect, const QString &  param  )

virtual

Parameters

sect	resource file section name
param	resource file parameter name

See Also

resource()

Reimplemented from QtxPreferenceItem.

References QtxPreferenceItem::setResource(), and updateState().

void QtxPagePrefGroupItem::setSpacing

(

const int

s

)

Parameters

s	new group box spacing

See Also

spacing()

References myBox, and QtxGridBox::setInsideSpacing().

int QtxPagePrefGroupItem::spacing

(

)

const

Returns

current group box spacing

See Also

setSpacing()

References QtxGridBox::insideSpacing(), and myBox.

void QtxPagePrefGroupItem::store ( )

virtual

See Also

retrieve()

Reimplemented from QtxPagePrefItem.

References myGroup, and QtxPreferenceItem::setBoolean().

void QtxPagePrefGroupItem::updateContents ( )

virtual

Reimplemented from QtxPreferenceItem.

References QtxPageNamedPrefItem::adjustLabels(), myGroup, QtxPreferenceItem::title(), QtxPreferenceItem::updateContents(), updateGroup(), and updateState().

void QtxPagePrefGroupItem::updateGroup ( )

private

References myBox, and QtxPagePrefItem::pageChildItems().

void QtxPagePrefGroupItem::updateState ( )

private

References QtxPreferenceItem::isEmpty(), myGroup, QtxPreferenceItem::resource(), and QtxPreferenceItem::title().

void QtxPagePrefGroupItem::widgetShown ( )

protectedvirtual

Reimplemented from QtxPagePrefItem.

References QtxPageNamedPrefItem::adjustLabels(), and QtxPagePrefItem::widgetShown().

Member Data Documentation

QtxGridBox* QtxPagePrefGroupItem::myBox

private

QtxGroupBox* QtxPagePrefGroupItem::myGroup

private

---

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

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