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

Implementation of the model/view API based on the tree of SUIT_DataObject class instances. More...

#include <SUIT_TreeModel.h>

Inheritance diagram for SUIT_TreeModel:
Inheritance graph

Classes

struct  ColumnInfo
 
class  TreeItem
 Internal class used for tree view synchronizaton with data object tree. More...
 
class  TreeSync
 Functor class for synchronizing data tree and tree model when the data tree is changed outside the model. More...
 

Public Types

enum  Role {
  DisplayRole = Qt::DisplayRole, DecorationRole = Qt::DecorationRole, EditRole = Qt::EditRole, ToolTipRole = Qt::ToolTipRole,
  StatusTipRole = Qt::StatusTipRole, WhatsThisRole = Qt::WhatsThisRole, FontRole = Qt::FontRole, TextAlignmentRole = Qt::TextAlignmentRole,
  BackgroundRole = Qt::BackgroundRole, ForegroundRole = Qt::ForegroundRole, CheckStateRole = Qt::CheckStateRole, SizeHintRole = Qt::SizeHintRole,
  BaseColorRole = Qt::UserRole, TextColorRole, HighlightRole, HighlightedTextRole,
  AppropriateRole = Qtx::AppropriateRole
}
 Data role. More...
 

Public Slots

virtual void updateTree (const QModelIndex &)
 Update tree model. More...
 
virtual void updateTree (SUIT_DataObject *=0)
 Update tree model. More...
 

Signals

void modelUpdated ()
 
void clicked (SUIT_DataObject *, int)
 
void dropped (const QList< SUIT_DataObject * > &, SUIT_DataObject *, int, Qt::DropAction)
 
void renamed (SUIT_DataObject *)
 

Public Member Functions

 SUIT_TreeModel (QObject *=0)
 Constructor. More...
 
 SUIT_TreeModel (SUIT_DataObject *, QObject *=0)
 Constructor. More...
 
 ~SUIT_TreeModel ()
 Destructor. More...
 
SUIT_DataObjectroot () const
 Get data tree root object. More...
 
void setRoot (SUIT_DataObject *)
 Set data tree root object. More...
 
virtual QVariant data (const QModelIndex &, int=DisplayRole) const
 Get data for the specified model index and data role. More...
 
virtual bool setData (const QModelIndex &, const QVariant &, int=EditRole)
 Set data for the specified model index and data role. More...
 
virtual Qt::ItemFlags flags (const QModelIndex &) const
 Get data flags for specified model index. More...
 
virtual QVariant headerData (int, Qt::Orientation, int=Qt::DisplayRole) const
 Get header data (can be used in any data view). More...
 
virtual Qt::DropActions supportedDropActions () const
 
virtual QModelIndex index (int, int, const QModelIndex &=QModelIndex()) const
 Create model index. More...
 
virtual QModelIndex parent (const QModelIndex &) const
 Get parent model index. More...
 
virtual int columnCount (const QModelIndex &=QModelIndex()) const
 Get number of data columns. More...
 
virtual int rowCount (const QModelIndex &=QModelIndex()) const
 Get number of data rows (children of the specified model index). More...
 
virtual void registerColumn (const int group_id, const QString &name, const int custom_id)
 Register new column in the model. More...
 
virtual void unregisterColumn (const int group_id, const QString &name)
 Remove column from the model. More...
 
virtual void setColumnIcon (const QString &name, const QPixmap &icon)
 Change column icon. More...
 
virtual QPixmap columnIcon (const QString &name) const
 Get column icon. More...
 
virtual void setAppropriate (const QString &name, const Qtx::Appropriate appr)
 Change appropriate status. More...
 
virtual Qtx::Appropriate appropriate (const QString &name) const
 Check if the column should appear in the tree view header popup menu (to show/hide the column). More...
 
virtual void setVisibilityState (const QString &id, Qtx::VisibilityState state, bool emitChanged=true)
 Set visibility state of the object. More...
 
virtual void setVisibilityStateForAll (Qtx::VisibilityState state)
 Set visibility state for all objects. More...
 
virtual Qtx::VisibilityState visibilityState (const QString &id) const
 Get visibility state of the object. More...
 
virtual void setHeaderFlags (const QString &name, const Qtx::HeaderViewFlags flags)
 Set header flags. More...
 
virtual Qtx::HeaderViewFlags headerFlags (const QString &name) const
 Get the header flags. More...
 
virtual void emitClicked (SUIT_DataObject *obj, const QModelIndex &index)
 
SUIT_DataObjectobject (const QModelIndex &=QModelIndex()) const
 Get data object by the specified model index. More...
 
QModelIndex index (const SUIT_DataObject *, int=0) const
 Get model index by the specified data object. More...
 
bool autoDeleteTree () const
 Get 'auto-delete data tree' flag value. More...
 
void setAutoDeleteTree (const bool)
 Set 'auto-delete data tree' flag value. More...
 
bool autoUpdate () const
 Get 'auto-update tree' flag value. More...
 
void setAutoUpdate (const bool)
 Set 'auto-update tree' flag value. More...
 
bool updateModified () const
 Get 'updateModified' flag value. More...
 
void setUpdateModified (const bool)
 Set 'updateModified' flag value. More...
 
virtual bool customSorting (const int) const
 Check if the specified column supports custom sorting. More...
 
virtual bool lessThan (const QModelIndex &left, const QModelIndex &right) const
 Compares two model indexes for the sorting purposes. More...
 
virtual void forgetObject (const SUIT_DataObject *)
 
QAbstractItemDelegate * delegate () const
 Get item delegate for the model. More...
 
virtual void updateTreeModel (SUIT_DataObject *, TreeItem *)
 
virtual QStringList mimeTypes () const
 Drag and Drop support. More...
 
virtual QMimeDatamimeData (const QModelIndexList &indexes) const
 Called when the data objects are exported(dragged) from the tree. More...
 
virtual bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
 
- Public Member Functions inherited from SUIT_AbstractModel
 SUIT_AbstractModel ()
 
 operator const QAbstractItemModel * () const
 
 operator QAbstractItemModel * ()
 
 operator const QObject * () const
 
virtual void updateTree (const QModelIndex &)=0
 
virtual void updateTree (SUIT_DataObject *=0)=0
 
virtual SUIT_DataSearchersearcher () const
 
virtual void setSearcher (SUIT_DataSearcher *)
 

Private Types

typedef SUIT_DataObjectObjPtr
 
typedef SUIT_TreeModel::TreeItemItemPtr
 
typedef QMap< SUIT_DataObject
*, TreeItem * > 
ItemMap
 
typedef QMap< QString,
Qtx::VisibilityState
VisibilityMap
 

Private Slots

void onInserted (SUIT_DataObject *, SUIT_DataObject *)
 Called when the data object is inserted to the tree. More...
 
void onRemoved (SUIT_DataObject *, SUIT_DataObject *)
 Called when the data object is removed from the tree. More...
 
void onModified (SUIT_DataObject *)
 Called when the data object is modified. TreeSync is not used here for maximum efficiency. It is assumed that it is up to the application to decide when its data objects are modified. More...
 

Private Member Functions

void initialize ()
 Initialize tree model. More...
 
TreeItemrootItem () const
 Get root tree item. More...
 
TreeItemtreeItem (const QModelIndex &) const
 Get tree item corresponding to the specified model index. More...
 
TreeItemtreeItem (const SUIT_DataObject *) const
 Get tree item corresponding to the specified data object. More...
 
SUIT_DataObjectobject (const TreeItem *) const
 Get data object corresponding to the specified tree item. More...
 
QString objectId (const QModelIndex &=QModelIndex()) const
 Get unique object identifier. More...
 
TreeItemcreateItem (SUIT_DataObject *, TreeItem *=0, TreeItem *=0)
 Create an item corresponding to the data object. More...
 
TreeItemcreateItemAtPos (SUIT_DataObject *, TreeItem *=0, int pos=0)
 Create an item corresponding to the data object. More...
 
void updateItem (TreeItem *, bool emitLayoutChanged)
 Update tree item. More...
 
void removeItem (TreeItem *)
 Remove tree item (recursively). More...
 

Private Attributes

SUIT_DataObjectmyRoot
 
TreeItemmyRootItem
 
ItemMap myItems
 
VisibilityMap myVisibilityMap
 
bool myAutoDeleteTree
 
bool myAutoUpdate
 
bool myUpdateModified
 
QVector< ColumnInfomyColumns
 

Friends

class SUIT_TreeModel::TreeSync
 

Detailed Description

The SUIT_TreeModel class does not support insertion/removal of rows. It is synchronized automatically with the tree of data objects used by SUIT-based applications to expose their data in a hierarchical form to the user.

Member Typedef Documentation

typedef QMap<QString,Qtx::VisibilityState> SUIT_TreeModel::VisibilityMap
private

Member Enumeration Documentation

Enumerator
DisplayRole 

text label

DecorationRole 

icon

EditRole 

edit mode

ToolTipRole 

tooltip

StatusTipRole 

status tip

WhatsThisRole 

what's this info

FontRole 

font

TextAlignmentRole 

text alignment

BackgroundRole 

background color

ForegroundRole 

text color

CheckStateRole 

check state

SizeHintRole 

size hint

BaseColorRole 

(editor) background color

TextColorRole 

(editor) text color (Qt::UserRole + 1)

HighlightRole 

highlight color (Qt::UserRole + 2)

HighlightedTextRole 

highlighted text color (Qt::UserRole + 3)

AppropriateRole 

appropriate flag (Qt::UserRole + 100)

Constructor & Destructor Documentation

SUIT_TreeModel::SUIT_TreeModel ( QObject parent = 0)
Parameters
parentparent object

References initialize().

SUIT_TreeModel::SUIT_TreeModel ( SUIT_DataObject root,
QObject parent = 0 
)
Parameters
rootroot data object
parentparent object

References initialize().

SUIT_TreeModel::~SUIT_TreeModel ( )

Member Function Documentation

Qtx::Appropriate SUIT_TreeModel::appropriate ( const QString &  name) const
virtual

Default implementation (if appropriate status is not specified yet) returns Shown, it means that column should be always visible.

Parameters
name- column name
Returns
appropriate status

Implements SUIT_AbstractModel.

References myColumns, myName, and Qtx::Shown.

bool SUIT_TreeModel::autoDeleteTree ( ) const
virtual
Returns
'auto-delete data tree' flag value
See Also
setAutoDeleteTree()

Implements SUIT_AbstractModel.

References myAutoDeleteTree.

bool SUIT_TreeModel::autoUpdate ( ) const
virtual
Returns
'auto-update tree' flag value
See Also
setAutoUpdate(), updateTree()

Implements SUIT_AbstractModel.

References myAutoUpdate.

void SUIT_TreeModel::clicked ( SUIT_DataObject ,
int   
)
signal
int SUIT_TreeModel::columnCount ( const QModelIndex &  = QModelIndex()) const
virtual
Parameters
parentparent model index (not used)
Returns
data columns number
See Also
rowCount()

References myColumns.

QPixmap SUIT_TreeModel::columnIcon ( const QString &  name) const
virtual
Parameters
name- column name
Returns
icon of the specified column

Implements SUIT_AbstractModel.

References myColumns, and myName.

SUIT_TreeModel::TreeItem * SUIT_TreeModel::createItem ( SUIT_DataObject obj,
SUIT_TreeModel::TreeItem parent = 0,
SUIT_TreeModel::TreeItem after = 0 
)
private
Parameters
objsource data object
parentparent tree item
aftertree item after which new item should be inserted
Returns
created tree item or 0 if item could not be created

References SUIT_TreeModel::TreeItem::child(), SUIT_TreeModel::TreeItem::childCount(), index(), myItems, obj, object(), SUIT_DataObject::position(), SUIT_DataObject::setModified(), and SUIT_TreeModel::TreeItem::setPosition().

SUIT_TreeModel::TreeItem * SUIT_TreeModel::createItemAtPos ( SUIT_DataObject obj,
SUIT_TreeModel::TreeItem parent = 0,
int  pos = 0 
)
private
Parameters
objsource data object
parentparent tree item
postree item position into which new item should be inserted
Returns
created tree item or 0 if item could not be created

References SUIT_TreeModel::TreeItem::child(), SUIT_TreeModel::TreeItem::childCount(), index(), myItems, obj, object(), SUIT_DataObject::setModified(), and SUIT_TreeModel::TreeItem::setPosition().

bool SUIT_TreeModel::customSorting ( const int  column) const
virtual
Parameters
columncolumn index on which data is being sorted
Returns
true if column requires custom sorting
See Also
lessThan()

Implements SUIT_AbstractModel.

References SUIT_DataObject::customSorting(), and root().

QAbstractItemDelegate * SUIT_TreeModel::delegate ( ) const
virtual
Returns
new item delegate

Implements SUIT_AbstractModel.

bool SUIT_TreeModel::dropMimeData ( const QMimeData data,
Qt::DropAction  action,
int  row,
int  column,
const QModelIndex &  parent 
)
virtual
void SUIT_TreeModel::dropped ( const QList< SUIT_DataObject * > &  ,
SUIT_DataObject ,
int  ,
Qt::DropAction   
)
signal
void SUIT_TreeModel::emitClicked ( SUIT_DataObject obj,
const QModelIndex &  index 
)
virtual
Qt::ItemFlags SUIT_TreeModel::flags ( const QModelIndex &  index) const
virtual
void SUIT_TreeModel::forgetObject ( const SUIT_DataObject obj)
virtual

Implements SUIT_AbstractModel.

References removeItem(), and treeItem().

QVariant SUIT_TreeModel::headerData ( int  column,
Qt::Orientation  orientation,
int  role = Qt::DisplayRole 
) const
virtual
Parameters
columncolumn number
orientationheader orientation
roledata role
Returns
header data

References AppropriateRole, DecorationRole, DisplayRole, Horizontal, myColumns, root(), Qtx::ShowAll, Qtx::ShowIcon, and Qtx::ShowText.

Qtx::HeaderViewFlags SUIT_TreeModel::headerFlags ( const QString &  name) const
virtual

These flags allow show in the header of the column text (name of the column), icon or both text and icon.

Parameters
name- column name
Returns
header flags

Implements SUIT_AbstractModel.

References flags(), myColumns, and myName.

QModelIndex SUIT_TreeModel::index ( int  row,
int  column,
const QModelIndex &  parent = QModelIndex() 
) const
virtual
Parameters
rowdata row
columndata column
parentparent model index
Returns
model index

References SUIT_TreeModel::TreeItem::child(), and treeItem().

QModelIndex SUIT_TreeModel::index ( const SUIT_DataObject obj,
int  column = 0 
) const
virtual
Parameters
objdata object
columndata object column
Returns
model index

Implements SUIT_AbstractModel.

References SUIT_TreeModel::TreeItem::position(), root(), and treeItem().

bool SUIT_TreeModel::lessThan ( const QModelIndex &  left,
const QModelIndex &  right 
) const
virtual

This method is called only for those columns for which customSorting() method returns true.

Parameters
leftfirst index to compare
rightsecond index to compare
Returns
result of the comparison
See Also
customSorting()

Implements SUIT_AbstractModel.

References SUIT_DataObject::compare(), data(), and root().

QMimeData * SUIT_TreeModel::mimeData ( const QModelIndexList &  indexes) const
virtual
Parameters
indexesthe list of exported objects

References index(), and objectId().

QStringList SUIT_TreeModel::mimeTypes ( ) const
virtual
void SUIT_TreeModel::modelUpdated ( )
signal
SUIT_DataObject * SUIT_TreeModel::object ( const QModelIndex &  index = QModelIndex()) const
virtual
Parameters
indexmodel index
Returns
data object corresponding to the model index

Implements SUIT_AbstractModel.

References treeItem().

SUIT_DataObject * SUIT_TreeModel::object ( const TreeItem item) const
private
Parameters
itemtree item
Returns
data object or 0 if there is no data object corresponding to item

References SUIT_TreeModel::TreeItem::dataObject(), myItems, obj, root(), and rootItem().

QString SUIT_TreeModel::objectId ( const QModelIndex &  index = QModelIndex()) const
private

Object identifier is customized via the Qtx::IdType custom data

Parameters
indexmodel index
Returns
object identifier or null string if it isn't specified
See Also
SUIT_DataObject::customData()

References SUIT_DataObject::customData(), data(), Qtx::IdType, obj, and object().

void SUIT_TreeModel::onInserted ( SUIT_DataObject ,
SUIT_DataObject parent 
)
privateslot
Parameters
objectdata object being inserted
parentparent data object

References autoUpdate(), and updateTree().

void SUIT_TreeModel::onModified ( SUIT_DataObject obj)
privateslot
Parameters
objdata object that has been modified

References autoUpdate(), columnCount(), index(), and SUIT_DataObject::setModified().

void SUIT_TreeModel::onRemoved ( SUIT_DataObject ,
SUIT_DataObject parent 
)
privateslot
Parameters
objectdata object being removed
parentparent data object

References autoUpdate(), and updateTree().

QModelIndex SUIT_TreeModel::parent ( const QModelIndex &  index) const
virtual
Parameters
indexmodel index
Returns
parent model index

References SUIT_TreeModel::TreeItem::parent(), SUIT_TreeModel::TreeItem::position(), rootItem(), and treeItem().

void SUIT_TreeModel::registerColumn ( const int  group_id,
const QString &  name,
const int  custom_id 
)
virtual
Parameters
group_id- unique data object group identificator
name- translated column name
custom_id- custom column id that should be passed into method SUIT_DataObject::data()

Implements SUIT_AbstractModel.

References SUIT_TreeModel::ColumnInfo::myAppropriate, myColumns, SUIT_TreeModel::ColumnInfo::myHeaderFlags, SUIT_TreeModel::ColumnInfo::myIds, myName, SUIT_TreeModel::ColumnInfo::myName, Qtx::ShowAll, and Qtx::Shown.

void SUIT_TreeModel::renamed ( SUIT_DataObject )
signal
SUIT_DataObject * SUIT_TreeModel::root ( ) const
virtual
Returns
data tree root
See Also
setRoot()

Implements SUIT_AbstractModel.

References myRoot.

SUIT_TreeModel::TreeItem * SUIT_TreeModel::rootItem ( ) const
private
Returns
root tree item

References myRootItem.

int SUIT_TreeModel::rowCount ( const QModelIndex &  parent = QModelIndex()) const
virtual
Parameters
parentparent model index
Returns
data rows (children) number
See Also
columnCount()

References SUIT_TreeModel::TreeItem::childCount(), and treeItem().

void SUIT_TreeModel::setAppropriate ( const QString &  name,
const Qtx::Appropriate  appr 
)
virtual

Appropriate status determines if the column should appear in the tree view header popup menu (to show/hide the column).

If appropriate status is not specified yet, the Shown value is taken, it means that column should be always visible.

Parameters
name- column name
appr- new appropriate status

Implements SUIT_AbstractModel.

References Horizontal, myColumns, and myName.

void SUIT_TreeModel::setAutoDeleteTree ( const bool  on)
virtual

If this flag is set to true, the data tree is deleted when the tree model is destroyed. Default value for this flag is false.

Parameters
on'auto-delete data tree' flag value
See Also
autoDeleteTree()

Implements SUIT_AbstractModel.

References myAutoDeleteTree.

void SUIT_TreeModel::setAutoUpdate ( const bool  on)
virtual

If this flag is set to true (by default), the model is updated automatically when data tree is changed.

Parameters
on'auto-update tree' flag value
See Also
autoUpdate(), updateTree()

Implements SUIT_AbstractModel.

References SUIT_DataObject::connect(), SUIT_DataObject::disconnect(), myAutoUpdate, onInserted(), onModified(), onRemoved(), and updateTree().

void SUIT_TreeModel::setColumnIcon ( const QString &  name,
const QPixmap &  icon 
)
virtual
Parameters
name- column name
icon- new icon of the specified column

Implements SUIT_AbstractModel.

References myColumns, and myName.

bool SUIT_TreeModel::setData ( const QModelIndex &  index,
const QVariant &  value,
int  role = EditRole 
)
virtual
Parameters
indexmodel index
valuenew data value
roledata role
Returns
true if data is set
See Also
data()

References CheckStateRole, EditRole, SUIT_DataObject::isCheckable(), SUIT_DataObject::name(), obj, object(), renamed(), SUIT_DataObject::setName(), and SUIT_DataObject::setOn().

void SUIT_TreeModel::setHeaderFlags ( const QString &  name,
const Qtx::HeaderViewFlags  flags 
)
virtual

These flags allow show in the header of the column text (name of the column), icon or both text and icon.

Parameters
name- column name
flags- header flags

Implements SUIT_AbstractModel.

References flags(), Horizontal, myColumns, and myName.

void SUIT_TreeModel::setRoot ( SUIT_DataObject r)
virtual
void SUIT_TreeModel::setUpdateModified ( const bool  on)
virtual
Parameters
on'updateModified' flag value

Implements SUIT_AbstractModel.

References myUpdateModified.

void SUIT_TreeModel::setVisibilityState ( const QString &  id,
Qtx::VisibilityState  state,
bool  emitChanged = true 
)
virtual
Parameters
id- column name
state- visible state
emitChanged- if set to false, blocks dataChanged() signal, this can be used to prevent emitting dataChanged() several times for the same data object

Implements SUIT_AbstractModel.

References DisplayRole, SUIT_DataSearcher::findObject(), Qtx::IdType, index(), myVisibilityMap, root(), SUIT_AbstractModel::searcher(), Qtx::UnpresentableState, and SUIT_DataObject::VisibilityId.

void SUIT_TreeModel::setVisibilityStateForAll ( Qtx::VisibilityState  state)
virtual
Parameters
state- visible state

Implements SUIT_AbstractModel.

References myVisibilityMap, and setVisibilityState().

Qt::DropActions SUIT_TreeModel::supportedDropActions ( ) const
virtual
SUIT_TreeModel::TreeItem * SUIT_TreeModel::treeItem ( const QModelIndex &  index) const
private
Parameters
indexmodel index
Returns
tree item or root item if index is invalid

References rootItem().

SUIT_TreeModel::TreeItem * SUIT_TreeModel::treeItem ( const SUIT_DataObject obj) const
private
Parameters
objdata object
Returns
tree item or 0 if there is no tree item corresponding to obj

References myItems, root(), and rootItem().

void SUIT_TreeModel::unregisterColumn ( const int  group_id,
const QString &  name 
)
virtual

Please take into account that column is removed only for given group_id, it means that information of data objects with such group_id won't be shown. If there is not any registered group_id for this column after removing, the column will be hidden otherwise it continue to be shown

Parameters
group_id- unique data object identificator allowing the classification of objects
name- translated column name

Implements SUIT_AbstractModel.

References myColumns, and myName.

void SUIT_TreeModel::updateItem ( SUIT_TreeModel::TreeItem item,
bool  emitLayoutChanged 
)
private
Parameters
itemtree item to be updated
emitLayoutChangedif signal about changed layout should be emitted

References columnCount(), index(), obj, object(), and SUIT_DataObject::setModified().

bool SUIT_TreeModel::updateModified ( ) const
virtual
Returns
'updateModified' flag value

Implements SUIT_AbstractModel.

References myUpdateModified.

void SUIT_TreeModel::updateTree ( const QModelIndex &  index)
virtualslot

Call this method when data tree is changed outside the model. If the 'auto-update' flag is set to true, the model is updated automatically when the data tree is changed.

Parameters
indexstarting index for the updating
See Also
setAutoUpdate()
void SUIT_TreeModel::updateTree ( SUIT_DataObject obj = 0)
virtualslot

Call this method when data tree is changed outside the model. If the 'auto-update' flag is set to true, the model is updated automatically when the data tree is changed.

Parameters
objstarting data object for the updating
See Also
setAutoUpdate()

References modelUpdated(), obj, SUIT_DataObject::root(), root(), treeItem(), updateModified(), and updateTreeModel().

Qtx::VisibilityState SUIT_TreeModel::visibilityState ( const QString &  id) const
virtual
Parameters
id- column name
Returns
visible state

Implements SUIT_AbstractModel.

References myVisibilityMap, and Qtx::UnpresentableState.

Friends And Related Function Documentation

friend class SUIT_TreeModel::TreeSync
friend

Member Data Documentation

bool SUIT_TreeModel::myAutoDeleteTree
private
bool SUIT_TreeModel::myAutoUpdate
private
QVector<ColumnInfo> SUIT_TreeModel::myColumns
private
ItemMap SUIT_TreeModel::myItems
private
SUIT_DataObject* SUIT_TreeModel::myRoot
private
TreeItem* SUIT_TreeModel::myRootItem
private
bool SUIT_TreeModel::myUpdateModified
private
VisibilityMap SUIT_TreeModel::myVisibilityMap
private

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