Version: 6.3.1
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Private Types | Private Slots | Private Member Functions | Private Attributes

LightApp_Preferences Class Reference

#include <LightApp_Preferences.h>

Inheritance diagram for LightApp_Preferences:
Inheritance graph

Public Types

enum  PrefItemType {
  Auto, Space, Bool, Color,
  String, Selector, DblSpin, IntSpin,
  Double, Integer, GroupBox, Tab,
  Frame, Font, DirList, File,
  Slider, Shortcut, ShortcutTree, UserDefined = 1000
}

Public Slots

virtual void setVisible (bool)
 Customize show/hide widget operation.

Signals

void preferenceChanged (QString &, QString &, QString &)
void resourceChanged (int)
void resourceChanged (QString &, QString &)
void resourcesChanged (const QMap< int, QString > &)

Public Member Functions

 LightApp_Preferences (QtxResourceMgr *, QWidget *=0)
virtual ~LightApp_Preferences ()
int addPreference (const QString &label, const int pId=-1, const int=Auto, const QString &section=QString(), const QString &param=QString())
int addPreference (const QString &modName, const QString &label, const int pId=-1, const int=Auto, const QString &section=QString(), const QString &param=QString())
bool hasModule (const QString &) const
void activateItem (const QString &) const
QIcon itemIcon (const int) const
void setItemIcon (const int, const QIcon &)
QVariant itemProperty (const QString &, const int=-1) const
void setItemProperty (const QString &, const QVariant &, const int=-1)
int addItem (const QString &, const int pId=-1, const PrefItemType=Auto, const QString &=QString(), const QString &=QString())
virtual QSize sizeHint () const
 Get recommended size for the widget.
virtual QSize minimumSizeHint () const
 Get recommended minimum size for the widget.
virtual void updateContents ()
 Update widget contents.
virtual QtxResourceMgrresourceMgr () const
 Get the resources manager.
virtual QtxPreferenceMgrpreferenceMgr () const
 Get the parent preferences manager.
QVariant option (const int, const QString &) const
 Get preference item option value.
QVariant option (const QString &) const
 Get preference item option value.
void setOption (const int, const QString &, const QVariant &)
 Set preference item option value.
void setOption (const QString &, const QVariant &)
 Set preference item option value.
virtual void store ()
 Store all preferences item to the resource manager.
virtual void retrieve ()
 Retrieve all preference items from the resource manager.
virtual void update ()
 Update preferences manager.
virtual void toBackup ()
 Dumps all values to the backup container.
virtual void fromBackup ()
 Restore all values from the backup container.
int id () const
 Get unique item identifier.
virtual int rtti () const
 Get unique item type identifier.
QtxPreferenceItemrootItem () const
 Get root preference item.
QtxPreferenceItemparentItem () const
 Get parent preference item.
QList< QtxPreferenceItem * > childItems (const bool=false) const
 Get all child preference items.
int depth () const
 Get preference item depth.
int count () const
 Get child preference items number.
virtual bool isEmpty () const
 Check if the item has children.
void appendItem (QtxPreferenceItem *)
 Append child preference item.
void removeItem (QtxPreferenceItem *)
 Remove child preference item.
void insertItem (QtxPreferenceItem *, QtxPreferenceItem *=0)
 Insert child preference item before specified item. If the before item is 0 then new item is appended.
QIcon icon () const
 Get preference item icon.
QString title () const
 Get preference item title.
void resource (QString &, QString &) const
 Get resource file settings associated to the preference item.
virtual void setIcon (const QIcon &)
 Set prefence item icon.
virtual void setTitle (const QString &)
 Set preference item title .
virtual void setResource (const QString &, const QString &)
 Assign resource file settings to the preference item.
bool isEvaluateValues () const
void setEvaluateValues (const bool)
QString resourceValue () const
 Get the value of the associated resource file setting.
void setResourceValue (const QString &)
 Get the value of the associated resource file setting.
QtxPreferenceItemfindItem (const int, const bool=false) const
 Find the item by the specified identifier.
QtxPreferenceItemfindItem (const QString &, const bool=false) const
 Find the item by the specified title.
QtxPreferenceItemfindItem (const QString &, const int, const bool=false) const
 Find the item by the specified title and identifier.
virtual void activate ()
void ensureVisible ()

Static Public Member Functions

static int RTTI ()
 Specify unique item class identifier.

Protected Types

typedef QMap
< QtxPreferenceItem *, QString > 
ResourceMap
typedef QList
< QtxPreferenceItem * > 
ItemList

Protected Member Functions

void changedResources (const ResourceMap &)
virtual QVariant optionValue (const QString &) const
virtual void setOptionValue (const QString &, const QVariant &)
virtual void itemAdded (QtxPreferenceItem *)
 Callback function which is called when the child preference item is added.
virtual void itemRemoved (QtxPreferenceItem *)
 Callback function which is called when the child preference item is removed.
virtual void itemChanged (QtxPreferenceItem *)
 Callback function which is called when the child preference item is modified.
void resourceValues (QMap< int, QString > &) const
 Get all resources items values.
void resourceValues (ResourceMap &) const
 Get all resources items values.
void setResourceValues (QMap< int, QString > &) const
 Set all resources items values.
void setResourceValues (ResourceMap &) const
 Set all resources items values.
void differentValues (const QMap< int, QString > &, const QMap< int, QString > &, QMap< int, QString > &, const bool fromFirst=false) const
 Compare two maps of resources values to find differences.
void differentValues (const ResourceMap &, const ResourceMap &, ResourceMap &, const bool fromFirst=false) const
 Compare two maps of resources values to find differences.
virtual void ensureVisible (QtxPreferenceItem *)
int getInteger (const int=0) const
 Get integer resources value corresponding to the item.
double getDouble (const double=0.0) const
 Get double resources value corresponding to the item.
bool getBoolean (const bool=false) const
 Get boolean resources value corresponding to the item.
QColor getColor (const QColor &=QColor()) const
 Get color resources value corresponding to the item.
QFont getFont (const QFont &=QFont()) const
 Get font resources value corresponding to the item.
QString getString (const QString &=QString()) const
 Get string resources value corresponding to the item.
void setInteger (const int)
 Set integer resources value corresponding to the item.
void setDouble (const double)
 Set double resources value corresponding to the item.
void setBoolean (const bool)
 Set boolean resources value corresponding to the item.
void setColor (const QColor &)
 Set color resources value corresponding to the item.
void setFont (const QFont &)
 Set font resources value corresponding to the item.
void setString (const QString &)
 Set string resources value corresponding to the item.
void sendItemChanges ()
 Initiate item changing call back operation.
virtual void triggerUpdate ()
 Initiate item updating.

Private Types

typedef QMap< int, QString > PrefModuleMap

Private Slots

void onHelp ()
void onApply ()

Private Member Functions

QString module (const int) const

Private Attributes

PrefModuleMap myPrefMod

Detailed Description

Custom preference container. Assign each preference category with module. Emits signal on preference changing


Member Typedef Documentation

typedef QMap<int, QString> LightApp_Preferences.PrefModuleMap [private]
typedef QMap<QtxPreferenceItem*, QString> QtxPreferenceMgr.ResourceMap [protected, inherited]
typedef QList<QtxPreferenceItem*> QtxPreferenceItem.ItemList [protected, inherited]

Member Enumeration Documentation

Enumerator:
Auto 
Space 
Bool 
Color 
String 
Selector 
DblSpin 
IntSpin 
Double 
Integer 
GroupBox 
Tab 
Frame 
Font 
DirList 
File 
Slider 
Shortcut 
ShortcutTree 
UserDefined 

Constructor & Destructor Documentation

LightApp_Preferences::LightApp_Preferences ( QtxResourceMgr resMgr,
QWidget parent = 0 
)

Constructor.Initialize by resource manager and parent QWidget.

LightApp_Preferences::~LightApp_Preferences ( ) [virtual]

Destructor.


Member Function Documentation

int LightApp_Preferences::addPreference ( const QString &  label,
const int  pId = -1,
const int  type = Auto,
const QString &  section = QString(),
const QString &  param = QString() 
)

Adds preference.

References SUIT_PreferenceMgr.addItem().

int LightApp_Preferences::addPreference ( const QString &  mod,
const QString &  label,
const int  pId = -1,
const int  type = Auto,
const QString &  section = QString(),
const QString &  param = QString() 
)
bool LightApp_Preferences::hasModule ( const QString &  mod) const

Checks: is preferences has module with name mod.

References myPrefMod.

void LightApp_Preferences::activateItem ( const QString &  mod) const
void LightApp_Preferences::changedResources ( const ResourceMap map) [protected, virtual]

Emit preference changed.

Reimplemented from QtxPreferenceMgr.

References module(), and preferenceChanged().

void LightApp_Preferences.preferenceChanged ( QString &  ,
QString &  ,
QString &   
) [signal]
void LightApp_Preferences::onHelp ( ) [private, slot]

Do nothing.

void LightApp_Preferences::onApply ( ) [private, slot]

Store preferences on apply.

References QtxPreferenceMgr.store().

QString LightApp_Preferences::module ( const int  id) const [private]

Gets module name by id, if exist.

References myPrefMod.

QIcon SUIT_PreferenceMgr::itemIcon ( const int  id) const [inherited]
void SUIT_PreferenceMgr::setItemIcon ( const int  id,
const QIcon &  ico 
) [inherited]
QVariant SUIT_PreferenceMgr::itemProperty ( const QString &  prop,
const int  id = -1 
) const [inherited]
void SUIT_PreferenceMgr::setItemProperty ( const QString &  prop,
const QVariant &  val,
const int  id = -1 
) [inherited]
int SUIT_PreferenceMgr::addItem ( const QString &  title,
const int  pId = -1,
const PrefItemType  type = Auto,
const QString &  sect = QString(),
const QString &  param = QString() 
) [inherited]
QVariant SUIT_PreferenceMgr::optionValue ( const QString &  name) const [protected, virtual, inherited]
void SUIT_PreferenceMgr::setOptionValue ( const QString &  name,
const QVariant &  val 
) [protected, virtual, inherited]
QSize QtxPagePrefMgr::sizeHint ( ) const [virtual, inherited]
Returns:
recommended widget size
QSize QtxPagePrefMgr::minimumSizeHint ( ) const [virtual, inherited]
Returns:
recommended minimum widget size
void QtxPagePrefMgr::updateContents ( ) [virtual, inherited]
void QtxPagePrefMgr.resourceChanged ( int  ) [signal, inherited]
void QtxPagePrefMgr.resourceChanged ( QString &  ,
QString &   
) [signal, inherited]
void QtxPagePrefMgr.resourcesChanged ( const QMap< int, QString > &  ) [signal, inherited]
void QtxPagePrefMgr::setVisible ( bool  on) [virtual, slot, inherited]
Parameters:
onif true the widget is being shown, otherswise it is being hidden

References QtxPagePrefMgr.initialize().

void QtxPagePrefMgr::itemAdded ( QtxPreferenceItem ) [protected, virtual, inherited]
Parameters:
itemchild item being added
See also:
itemRemoved(), itemChanged()

Reimplemented from QtxPreferenceItem.

References QtxPreferenceItem.triggerUpdate().

void QtxPagePrefMgr::itemRemoved ( QtxPreferenceItem ) [protected, virtual, inherited]
Parameters:
itemchild item being removed
See also:
itemAdded(), itemChanged()

Reimplemented from QtxPreferenceItem.

References QtxPreferenceItem.triggerUpdate().

void QtxPagePrefMgr::itemChanged ( QtxPreferenceItem ) [protected, virtual, inherited]
Parameters:
itemchild item being modified
See also:
itemAdded(), itemRemoved()

Reimplemented from QtxPreferenceItem.

References QtxPreferenceItem.triggerUpdate().

QtxResourceMgr * QtxPreferenceMgr::resourceMgr ( ) const [virtual, inherited]
Returns:
resource manager pointer or 0 if it is not defined

Reimplemented from QtxPreferenceItem.

References QtxPreferenceMgr.myResMgr.

QtxPreferenceMgr * QtxPreferenceMgr::preferenceMgr ( ) const [virtual, inherited]
Returns:
pointer to itself

Reimplemented from QtxPreferenceItem.

QVariant QtxPreferenceMgr::option ( const int  id,
const QString &  propName 
) const [inherited]
Parameters:
idpreference item ID
propNameoption name
Returns:
property value or null QVariant if option is not set
See also:
setOption()

References QtxPreferenceItem.findItem(), and QtxPreferenceItem.option().

QVariant QtxPreferenceItem::option ( const QString &  name) const [inherited]
Parameters:
nameoption name
Returns:
property value or null QVariant if option is not set
See also:
setOption()

References QtxPreferenceItem.optionValue().

void QtxPreferenceMgr::setOption ( const int  id,
const QString &  propName,
const QVariant &  propValue 
) [inherited]
Parameters:
idpreference item ID
propNameoption name
propValuenew property value
See also:
option()

References QtxPreferenceItem.findItem(), and QtxPreferenceItem.setOption().

void QtxPreferenceItem::setOption ( const QString &  name,
const QVariant &  val 
) [inherited]
Parameters:
nameoption name
valnew property value
See also:
option()

References QtxPreferenceItem.optionValue(), QtxPreferenceItem.sendItemChanges(), and QtxPreferenceItem.setOptionValue().

void QtxPreferenceMgr::store ( ) [virtual, inherited]
void QtxPreferenceMgr::retrieve ( ) [virtual, inherited]
See also:
store()

Implements QtxPreferenceItem.

References QtxPreferenceItem.childItems().

void QtxPreferenceMgr::update ( ) [virtual, inherited]

Base implementation does nothing.

void QtxPreferenceMgr::toBackup ( ) [virtual, inherited]
void QtxPreferenceMgr::fromBackup ( ) [virtual, inherited]
void QtxPreferenceMgr::resourceValues ( QMap< int, QString > &  map) const [protected, inherited]
void QtxPreferenceMgr::resourceValues ( ResourceMap map) const [protected, inherited]
void QtxPreferenceMgr::setResourceValues ( QMap< int, QString > &  map) const [protected, inherited]
Parameters:
mapmap with resources values (<ID>:

)

See also:
resourceValues()

References QtxPreferenceItem.findItem(), and QtxPreferenceItem.setResourceValue().

void QtxPreferenceMgr::setResourceValues ( ResourceMap map) const [protected, inherited]
Parameters:
mapmap with resources values (:

)

See also:
resourceValues()
void QtxPreferenceMgr::differentValues ( const QMap< int, QString > &  map1,
const QMap< int, QString > &  map2,
QMap< int, QString > &  resMap,
const bool  fromFirst = false 
) const [protected, inherited]
Parameters:
map1first map
map2second map
resMapmap to be filled with different values
fromFirstif true, then resMap will be filled with the values from map1, otherwise - from map2
void QtxPreferenceMgr::differentValues ( const ResourceMap map1,
const ResourceMap map2,
ResourceMap resMap,
const bool  fromFirst = false 
) const [protected, inherited]
Parameters:
map1first map
map2second map
resMapmap to be filled with different values
fromFirstif true, then resMap will be filled with the values from map1, otherwise - from map2
int QtxPreferenceItem::id ( ) const [inherited]
Returns:
item ID

References QtxPreferenceItem.myId.

int QtxPreferenceItem::rtti ( ) const [virtual, inherited]
Returns:
item type ID

References QtxPreferenceItem.RTTI().

QtxPreferenceItem * QtxPreferenceItem::rootItem ( ) const [inherited]
Returns:
root item

References QtxPreferenceItem.parentItem().

QtxPreferenceItem * QtxPreferenceItem::parentItem ( ) const [inherited]
Returns:
parent item

References QtxPreferenceItem.myParent.

QList< QtxPreferenceItem * > QtxPreferenceItem::childItems ( const bool  rec = false) const [inherited]
Parameters:
recrecursion boolean flag
Returns:
list of child items

References QtxPreferenceItem.myChildren.

int QtxPreferenceItem::depth ( ) const [inherited]
Returns:
item depth

References QtxPreferenceItem.depth(), and QtxPreferenceItem.parentItem().

int QtxPreferenceItem::count ( ) const [inherited]
Returns:
number of child items
See also:
isEmpty()

References QtxPreferenceItem.myChildren.

bool QtxPreferenceItem::isEmpty ( ) const [virtual, inherited]
Returns:
true if item does not have children
See also:
count()

References QtxPreferenceItem.myChildren.

void QtxPreferenceItem::appendItem ( QtxPreferenceItem item) [inherited]

Removes (if necessary) the item from the previous parent.

Parameters:
itemitem to be added
See also:
removeItem()

References QtxPreferenceItem.insertItem().

void QtxPreferenceItem::removeItem ( QtxPreferenceItem item) [inherited]
Parameters:
itemitem to be removed
See also:
insertItem()

References QtxPreferenceItem.itemRemoved(), QtxPreferenceItem.myChildren, and QtxPreferenceItem.myParent.

void QtxPreferenceItem::insertItem ( QtxPreferenceItem item,
QtxPreferenceItem before = 0 
) [inherited]

Removes (if necessary) the item from the previous parent.

Parameters:
itemitem to be added
beforeitem before which is inserted new
See also:
removeItem()

References QtxPreferenceItem.itemAdded(), QtxPreferenceItem.myChildren, QtxPreferenceItem.myParent, QtxPreferenceItem.parentItem(), and QtxPreferenceItem.removeItem().

QIcon QtxPreferenceItem::icon ( ) const [inherited]
Returns:
item icon
See also:
setIcon()

References QtxPreferenceItem.myIcon.

QString QtxPreferenceItem::title ( ) const [inherited]
Returns:
item title
See also:
setTitle()

References QtxPreferenceItem.myTitle.

void QtxPreferenceItem::resource ( QString &  sec,
QString &  param 
) const [inherited]
Parameters:
secused to return resource file section name
paramused to return resource file parameter name
See also:
setResource()

References QtxPreferenceItem.myParameter, and QtxPreferenceItem.mySection.

void QtxPreferenceItem::setIcon ( const QIcon &  ico) [virtual, inherited]
Parameters:
iconew item icon
See also:
icon()

References QtxPreferenceItem.myIcon, and QtxPreferenceItem.sendItemChanges().

void QtxPreferenceItem::setTitle ( const QString &  title) [virtual, inherited]
void QtxPreferenceItem::setResource ( const QString &  sec,
const QString &  param 
) [virtual, inherited]
Parameters:
secresource file section name
paramresource file parameter name
See also:
resource()

Reimplemented in QtxPagePrefGroupItem.

References QtxPreferenceItem.myParameter, and QtxPreferenceItem.mySection.

bool QtxPreferenceItem::isEvaluateValues ( ) const [inherited]
void QtxPreferenceItem::setEvaluateValues ( const bool  on) [inherited]
QString QtxPreferenceItem::resourceValue ( ) const [inherited]
Returns:
associated resource file setting value
See also:
setResourceValue()

References QtxPreferenceItem.getString().

void QtxPreferenceItem::setResourceValue ( const QString &  val) [inherited]
Parameters:
valnew associated resource file setting value
See also:
resourceValue()

References QtxPreferenceItem.setString().

QtxPreferenceItem * QtxPreferenceItem::findItem ( const int  id,
const bool  rec = false 
) const [inherited]
Parameters:
idchild item ID
recif true recursive search is done
Returns:
child item or 0 if it is not found

References QtxPreferenceItem.findItem(), QtxPreferenceItem.id(), and QtxPreferenceItem.myChildren.

QtxPreferenceItem * QtxPreferenceItem::findItem ( const QString &  title,
const bool  rec = false 
) const [inherited]
Parameters:
titlechild item title
recif true recursive search is done
Returns:
child item or 0 if it is not found

References QtxPreferenceItem.findItem(), QtxPreferenceItem.myChildren, and QtxPreferenceItem.title().

QtxPreferenceItem * QtxPreferenceItem::findItem ( const QString &  title,
const int  id,
const bool  rec = false 
) const [inherited]
Parameters:
titlechild item title
idchild item ID
recif true recursive search is done
Returns:
child item or 0 if it is not found

References QtxPreferenceItem.findItem(), QtxPreferenceItem.id(), QtxPreferenceItem.myChildren, and QtxPreferenceItem.title().

void QtxPreferenceItem::activate ( ) [virtual, inherited]

Reimplemented in QtxPagePrefItem.

void QtxPreferenceItem::ensureVisible ( ) [inherited]
void QtxPreferenceItem::ensureVisible ( QtxPreferenceItem ) [protected, virtual, inherited]
int QtxPreferenceItem::RTTI ( ) [static, inherited]
Returns:
item class ID
int QtxPreferenceItem::getInteger ( const int  val = 0) const [protected, inherited]
Parameters:
valdefault value (returned if there is no such resource)
Returns:
integer value of the associated resource
See also:
setInteger()

References QtxResourceMgr.integerValue(), QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, and QtxPreferenceItem.resourceMgr().

double QtxPreferenceItem::getDouble ( const double  val = 0.0) const [protected, inherited]
Parameters:
valdefault value (returned if there is no such resource)
Returns:
double value of the associated resource
See also:
setDouble()

References QtxResourceMgr.doubleValue(), QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, and QtxPreferenceItem.resourceMgr().

bool QtxPreferenceItem::getBoolean ( const bool  val = false) const [protected, inherited]
Parameters:
valdefault value (returned if there is no such resource)
Returns:
boolean value of the associated resource
See also:
setBoolean()

References QtxResourceMgr.booleanValue(), QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, and QtxPreferenceItem.resourceMgr().

QColor QtxPreferenceItem::getColor ( const QColor &  val = QColor()) const [protected, inherited]
Parameters:
valdefault value (returned if there is no such resource)
Returns:
color value of the associated resource
See also:
setColor()

References QtxResourceMgr.colorValue(), QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, and QtxPreferenceItem.resourceMgr().

QFont QtxPreferenceItem::getFont ( const QFont &  val = QFont()) const [protected, inherited]
Parameters:
valdefault value (returned if there is no such resource)
Returns:
font value of the associated resource
See also:
setFont()

References QtxResourceMgr.fontValue(), QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, and QtxPreferenceItem.resourceMgr().

QString QtxPreferenceItem::getString ( const QString &  val = QString()) const [protected, inherited]
Parameters:
valdefault value (returned if there is no such resource)
Returns:
string value of the associated resource
See also:
setString()

References QtxPreferenceItem.isEvaluateValues(), QtxPreferenceItem.myParameter, QtxPreferenceItem.mySection, QtxPreferenceItem.resourceMgr(), and QtxResourceMgr.value().

void QtxPreferenceItem::setInteger ( const int  val) [protected, inherited]
void QtxPreferenceItem::setDouble ( const double  val) [protected, inherited]
void QtxPreferenceItem::setBoolean ( const bool  val) [protected, inherited]
void QtxPreferenceItem::setColor ( const QColor &  val) [protected, inherited]
void QtxPreferenceItem::setFont ( const QFont &  val) [protected, inherited]
void QtxPreferenceItem::setString ( const QString &  val) [protected, inherited]
void QtxPreferenceItem::sendItemChanges ( ) [protected, inherited]
void QtxPreferenceItem::triggerUpdate ( ) [protected, virtual, inherited]

Field Documentation

Copyright © 2007-2011 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS