Version: 9.12.0
QtxUserDefinedItem Class Reference

#include <QtxPagePrefMgr.h>

Inheritance diagram for QtxUserDefinedItem:
Inheritance graph

Public Member Functions

 QtxUserDefinedItem (QtxPreferenceItem *parent)
 Constructor. More...
 
void setContent (QtxUserDefinedContent *theContent)
 Defines content of the property item as a Widget which has to be inherited from QtxUserDefinedContent class. More...
 
virtual void store ()
 Lets to Store preferences for content instance. More...
 
virtual void retrieve ()
 Lets to Retrieve preferences for content instance. More...
 
- Public Member Functions inherited from QtxPageNamedPrefItem
 QtxPageNamedPrefItem (const QString &, QtxPreferenceItem *=0, const QString &=QString(), const QString &=QString())
 Constructor. More...
 
virtual ~QtxPageNamedPrefItem ()
 Destructor. More...
 
virtual void setTitle (const QString &)
 Set preference title. 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 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...
 
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 &theName) const
 Returns option value. More...
 
virtual void setOptionValue (const QString &theName, const QVariant &theVal)
 Sets option value. More...
 
- Protected Member Functions inherited from QtxPageNamedPrefItem
QLabellabel () const
 Get label widget corresponding to the preference item. More...
 
QWidgetcontrol () const
 Get control widget corresponding to the preference item. More...
 
void setControl (QWidget *)
 Set control widget corresponding to the preference item. 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 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...
 

Private Attributes

QtxUserDefinedContentmyContent
 

Additional Inherited Members

- Static Public Member Functions inherited from QtxPageNamedPrefItem
static void adjustLabels (QtxPagePrefItem *)
 
- 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

◆ QtxUserDefinedItem()

QtxUserDefinedItem::QtxUserDefinedItem ( QtxPreferenceItem parent)

Constructor.

Creates preference item of user defined widget. The item widget has to be inherited from QtxUserDefinedContent class. An instance of this class has to be installed into the item with help of setContent method. Methods optionValue and setOptionValue use pointer on the content widget an qint64 value.

Parameters
parentparent preference item

Member Function Documentation

◆ optionValue()

QVariant QtxUserDefinedItem::optionValue ( const QString &  theName) const
protectedvirtual

Returns option value.

Parameters
theNameis a string "content"
Returns
pointer on QtxUserDefinedContent class instance as a qint64 value

Reimplemented from QtxPreferenceItem.

References myContent, and QtxPreferenceItem::optionValue().

◆ retrieve()

void QtxUserDefinedItem::retrieve ( )
virtual

Lets to Retrieve preferences for content instance.

See also
store()

Reimplemented from QtxPagePrefItem.

References myContent, QtxPreferenceItem::preferenceMgr(), QtxPreferenceItem::resourceMgr(), and QtxUserDefinedContent::retrieve().

◆ setContent()

void QtxUserDefinedItem::setContent ( QtxUserDefinedContent theContent)

Defines content of the property item as a Widget which has to be inherited from QtxUserDefinedContent class.

Parameters
theContentis an QtxUserDefinedContent class instance.

References myContent, and QtxPageNamedPrefItem::setControl().

◆ setOptionValue()

void QtxUserDefinedItem::setOptionValue ( const QString &  theName,
const QVariant &  theVal 
)
protectedvirtual

Sets option value.

Parameters
theNameis a string "content"
theValis a pointer on QtxUserDefinedContent class instance represented as qint64 value

Reimplemented from QtxPreferenceItem.

References setContent(), and QtxPreferenceItem::setOptionValue().

◆ store()

void QtxUserDefinedItem::store ( )
virtual

Lets to Store preferences for content instance.

See also
retrieve()

Reimplemented from QtxPagePrefItem.

References myContent, QtxPreferenceItem::preferenceMgr(), QtxPreferenceItem::resourceMgr(), and QtxUserDefinedContent::store().

Member Data Documentation

◆ myContent

QtxUserDefinedContent* QtxUserDefinedItem::myContent
private

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