Version: 8.3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
QtxPagePrefFrameItem Class Reference

GUI implementation of the frame widget container.

#include <QtxPagePrefMgr.h>

Inheritance diagram for QtxPagePrefFrameItem:
Inheritance graph

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...
 
QWidgetwidget () 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...
 
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...
 
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...
 
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...
 
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

QtxGridBoxmyBox
 

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

QtxPagePrefFrameItem::QtxPagePrefFrameItem ( const QString &  title,
QtxPreferenceItem parent = 0,
const QString &  sect = QString(),
const QString &  param = QString(),
const bool  scrollable = false 
)
Parameters
titlepreference item title
parentparent preference item
sectresource file section associated with the preference item
paramresource file parameter associated with the preference item

References Horizontal, main(), myBox, and QtxPagePrefItem::setWidget().

QtxPagePrefFrameItem::~QtxPagePrefFrameItem ( )
virtual

Member Function Documentation

int QtxPagePrefFrameItem::columns ( ) const
Returns
current columns number
See Also
setColumns()

References QtxGridBox::columns(), and myBox.

int QtxPagePrefFrameItem::margin ( ) const
Returns
current frame margin
See Also
setMargin()

References QtxGridBox::insideMargin(), and myBox.

QVariant QtxPagePrefFrameItem::optionValue ( const QString &  name) const
protectedvirtual
Parameters
nameoption 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().

Qt::Orientation QtxPagePrefFrameItem::orientation ( ) const
Returns
current frame orientation
See Also
setOrientation()

References myBox, and QtxGridBox::orientation().

void QtxPagePrefFrameItem::setColumns ( const int  c)
Parameters
cnew columns number
See Also
columns()

References myBox, and QtxGridBox::setColumns().

void QtxPagePrefFrameItem::setMargin ( const int  m)
Parameters
mnew frame margin
See Also
margin()

References myBox, and QtxGridBox::setInsideMargin().

void QtxPagePrefFrameItem::setOptionValue ( const QString &  name,
const QVariant &  val 
)
protectedvirtual
Parameters
nameoption name
valnew property value
See Also
optionValue()

Reimplemented from QtxPreferenceItem.

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

void QtxPagePrefFrameItem::setOrientation ( const Qt::Orientation  o)
Parameters
onew frame orientation
See Also
orientation()

References myBox, and QtxGridBox::setOrientation().

void QtxPagePrefFrameItem::setSpacing ( const int  s)
Parameters
snew frame spacing
See Also
spacing()

References myBox, and QtxGridBox::setInsideSpacing().

void QtxPagePrefFrameItem::setStretch ( const bool  on)
Parameters
onnew stretchable state
See Also
stretch()

References s, and QtxPagePrefItem::widget().

int QtxPagePrefFrameItem::spacing ( ) const
Returns
current frame spacing
See Also
setSpacing()

References QtxGridBox::insideSpacing(), and myBox.

bool QtxPagePrefFrameItem::stretch ( ) const
Returns
true if the widget is stretchable
See Also
setStretch()

References s, Vertical, and QtxPagePrefItem::widget().

void QtxPagePrefFrameItem::updateContents ( )
virtual
void QtxPagePrefFrameItem::updateFrame ( )
private
void QtxPagePrefFrameItem::widgetShown ( )
protectedvirtual

Member Data Documentation

QtxGridBox* QtxPagePrefFrameItem::myBox
private

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