Version: 9.12.0
QtxPagePrefEditItem Class Reference

GUI implementation of the resources line edit box item for string, integer and double values. More...

#include <QtxPagePrefMgr.h>

Inheritance diagram for QtxPagePrefEditItem:
Inheritance graph

Public Types

enum  InputType { String , Integer , Double }
 

Public Member Functions

 QtxPagePrefEditItem (const QString &, QtxPreferenceItem *=0, const QString &=QString(), const QString &=QString())
 Constructor. More...
 
 QtxPagePrefEditItem (const int, const QString &, QtxPreferenceItem *=0, const QString &=QString(), const QString &=QString())
 Constructor. More...
 
virtual ~QtxPagePrefEditItem ()
 Destructor. More...
 
int inputType () const
 Get edit box preference item input type. More...
 
void setInputType (const int)
 Set edit box preference item input type. More...
 
int decimals () const
 Get number of digits after decimal point (for Double input type) More...
 
void setDecimals (const int)
 Set number of digits after decimal point (for Double input type) More...
 
int echoMode () const
 Get the line edit's echo mode. More...
 
void setEchoMode (const int)
 Set the line edit's echo mode. More...
 
virtual void store ()
 Store preference item to the resource manager. More...
 
virtual void retrieve ()
 Retrieve preference item from the resource manager. 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 &) const
 Get preference item option value. More...
 
virtual void setOptionValue (const QString &, const QVariant &)
 Set preference item 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 Member Functions

void updateEditor ()
 Update edit box widget. More...
 

Private Attributes

int myType
 
int myDecimals
 
int myEchoMode
 
QLineEditmyEditor
 

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
 

Detailed Description

GUI implementation of the resources line edit box item for string, integer and double values.

Member Enumeration Documentation

◆ InputType

Enumerator
String 
Integer 
Double 

Constructor & Destructor Documentation

◆ QtxPagePrefEditItem() [1/2]

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

Constructor.

Creates preference item for string value editing.

Parameters
titlepreference item title
parentparent preference item
sectresource file section associated with the preference item
paramresource file parameter associated with the preference item

References myEditor, QtxPageNamedPrefItem::setControl(), and updateEditor().

◆ QtxPagePrefEditItem() [2/2]

QtxPagePrefEditItem::QtxPagePrefEditItem ( const int  type,
const QString &  title,
QtxPreferenceItem parent = 0,
const QString &  sect = QString(),
const QString &  param = QString() 
)

Constructor.

Creates preference item for editing of the value which type is specified by parameter type.

Parameters
typepreference item input type (QtxPagePrefEditItem::InputType)
titlepreference item title
parentparent preference item
sectresource file section associated with the preference item
paramresource file parameter associated with the preference item

References myEditor, QtxPageNamedPrefItem::setControl(), and updateEditor().

◆ ~QtxPagePrefEditItem()

QtxPagePrefEditItem::~QtxPagePrefEditItem ( )
virtual

Destructor.

Member Function Documentation

◆ decimals()

int QtxPagePrefEditItem::decimals ( ) const

Get number of digits after decimal point (for Double input type)

Returns
preference item decimals value
See also
setDecimals()

References myDecimals.

◆ echoMode()

int QtxPagePrefEditItem::echoMode ( ) const

Get the line edit's echo mode.

Returns
preference item echo mode value
See also
setEchoMode()

References myEchoMode.

◆ inputType()

int QtxPagePrefEditItem::inputType ( ) const

Get edit box preference item input type.

Returns
preference item input type (QtxPagePrefEditItem::InputType)
See also
setInputType()

References myType.

◆ optionValue()

QVariant QtxPagePrefEditItem::optionValue ( const QString &  name) const
protectedvirtual

Get preference item option value.

Parameters
nameoption name
Returns
property value or null QVariant if option is not set
See also
setOptionValue()

Reimplemented from QtxPreferenceItem.

References decimals(), echoMode(), inputType(), and QtxPreferenceItem::optionValue().

◆ retrieve()

void QtxPagePrefEditItem::retrieve ( )
virtual

Retrieve preference item from the resource manager.

See also
store()

Reimplemented from QtxPagePrefItem.

References fixupAndSet(), QtxPreferenceItem::getString(), and myEditor.

◆ setDecimals()

void QtxPagePrefEditItem::setDecimals ( const int  dec)

Set number of digits after decimal point (for Double input type)

Parameters
decnew preference item decimals value
See also
decimals()

References myDecimals, and updateEditor().

◆ setEchoMode()

void QtxPagePrefEditItem::setEchoMode ( const int  echo)

Set the line edit's echo mode.

Parameters
echonew preference item echo mode value
See also
echoMode()

References myEchoMode, and updateEditor().

◆ setInputType()

void QtxPagePrefEditItem::setInputType ( const int  type)

Set edit box preference item input type.

Parameters
typenew preference item input type (QtxPagePrefEditItem::InputType)
See also
inputType()

References myType, and updateEditor().

◆ setOptionValue()

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

Set preference item option value.

Parameters
nameoption name
valnew property value
See also
optionValue()

Reimplemented from QtxPreferenceItem.

References setDecimals(), setEchoMode(), setInputType(), and QtxPreferenceItem::setOptionValue().

◆ store()

void QtxPagePrefEditItem::store ( )
virtual

Store preference item to the resource manager.

See also
retrieve()

Reimplemented from QtxPagePrefItem.

References myEditor, and QtxPreferenceItem::setString().

◆ updateEditor()

void QtxPagePrefEditItem::updateEditor ( )
private

Update edit box widget.

References Double, fixupAndSet(), inputType(), Integer, myDecimals, myEchoMode, myEditor, and setDecimals().

Member Data Documentation

◆ myDecimals

int QtxPagePrefEditItem::myDecimals
private

◆ myEchoMode

int QtxPagePrefEditItem::myEchoMode
private

◆ myEditor

QLineEdit* QtxPagePrefEditItem::myEditor
private

◆ myType

int QtxPagePrefEditItem::myType
private

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