QtxPagePrefFrameItem Class Reference

GUI implementation of the frame widget container. More...

#include <QtxPagePrefMgr.h>

Inheritance diagram for QtxPagePrefFrameItem:

Public Member Functions
	QtxPagePrefFrameItem (const QString &, QtxPreferenceItem *=0, const QString &=QString(), const QString &=QString(), const bool=false)
	Constructor. More...
virtual	~QtxPagePrefFrameItem ()
	Destructor. More...
virtual void	updateContents ()
	Update widget contents. More...
bool	stretch () const
	Check if the frame widget stretching is enabled. More...
void	setStretch (const bool)
	Enable/disable frame widget stretching. More...
int	margin () const
	Get frame margin. More...
void	setMargin (const int)
	Get frame margin. More...
int	spacing () const
	Get frame spacing. More...
void	setSpacing (const int)
	Set frame spacing. More...
int	columns () const
	Get number of frame columns. More...
void	setColumns (const int)
	Set number of frame columns. More...
Qt::Orientation	orientation () const
	Get frame box orientation. More...
void	setOrientation (const Qt::Orientation)
	Set frame box orientation. 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...
virtual void	setResource (const QString &, const QString &)
	Assign resource file settings to the 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
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	store ()
	Store preference item to the resource manager. More...
virtual void	retrieve ()
	Retrieve preference item from the resource manager. 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	updateFrame ()
	Update frame widget. More...

Private Attributes
QtxGridBox *	myBox

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

Detailed Description

GUI implementation of the frame widget container.

Constructor & Destructor Documentation

QtxPagePrefFrameItem()

QtxPagePrefFrameItem::QtxPagePrefFrameItem	(	const QString &	title,
		QtxPreferenceItem *	parent = 0,
		const QString &	sect = QString(),
		const QString &	param = QString(),
		const bool	scrollable = false
	)

Constructor.

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, main(), myBox, and QtxPagePrefItem::setWidget().

~QtxPagePrefFrameItem()

QtxPagePrefFrameItem::~QtxPagePrefFrameItem ( )

virtual

Destructor.

Member Function Documentation

columns()

int QtxPagePrefFrameItem::columns

(

)

const

Get number of frame columns.

Returns

current columns number

See also

setColumns()

References QtxGridBox::columns(), and myBox.

margin()

int QtxPagePrefFrameItem::margin

(

)

const

Get frame margin.

Returns

current frame margin

See also

setMargin()

References QtxGridBox::insideMargin(), and myBox.

optionValue()

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

protectedvirtual

Get preference item option value.

Parameters

name	option name

Returns

property value or null QVariant if option is not set

See also

setOptionValue()

Reimplemented from QtxPreferenceItem.

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

orientation()

Qt::Orientation QtxPagePrefFrameItem::orientation

(

)

const

Get frame box orientation.

Returns

current frame orientation

See also

setOrientation()

References myBox, and QtxGridBox::orientation().

setColumns()

void QtxPagePrefFrameItem::setColumns

(

const int

c

)

Set number of frame columns.

Parameters

c	new columns number

See also

columns()

References myBox, and QtxGridBox::setColumns().

setMargin()

void QtxPagePrefFrameItem::setMargin

(

const int

m

)

Get frame margin.

Parameters

m	new frame margin

See also

margin()

References myBox, and QtxGridBox::setInsideMargin().

setOptionValue()

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

protectedvirtual

Set preference item option value.

Parameters

name	option name
val	new property value

See also

optionValue()

Reimplemented from QtxPreferenceItem.

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

setOrientation()

void QtxPagePrefFrameItem::setOrientation

(

const Qt::Orientation

o

)

Set frame box orientation.

Parameters

o	new frame orientation

See also

orientation()

References myBox, and QtxGridBox::setOrientation().

setSpacing()

void QtxPagePrefFrameItem::setSpacing

(

const int

s

)

Set frame spacing.

Parameters

s	new frame spacing

See also

spacing()

References myBox, and QtxGridBox::setInsideSpacing().

setStretch()

void QtxPagePrefFrameItem::setStretch

(

const bool

on

)

Enable/disable frame widget stretching.

Parameters

on	new stretchable state

See also

stretch()

References QtxPagePrefItem::widget().

spacing()

int QtxPagePrefFrameItem::spacing

(

)

const

Get frame spacing.

Returns

current frame spacing

See also

setSpacing()

References QtxGridBox::insideSpacing(), and myBox.

stretch()

bool QtxPagePrefFrameItem::stretch

(

)

const

Check if the frame widget stretching is enabled.

Returns

true if the widget is stretchable

See also

setStretch()

References Vertical, and QtxPagePrefItem::widget().

updateContents()

void QtxPagePrefFrameItem::updateContents ( )

virtual

Update widget contents.

Reimplemented from QtxPreferenceItem.

References QtxPageNamedPrefItem::adjustLabels(), QtxPreferenceItem::updateContents(), and updateFrame().

updateFrame()

void QtxPagePrefFrameItem::updateFrame ( )

private

Update frame widget.

References myBox, and QtxPagePrefItem::pageChildItems().

widgetShown()

void QtxPagePrefFrameItem::widgetShown ( )

protectedvirtual

Invoked when preference item widget is shown.

Reimplemented from QtxPagePrefItem.

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

Member Data Documentation

myBox

QtxGridBox* QtxPagePrefFrameItem::myBox

private

---

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

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