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:

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_DataObject *	root () 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_DataObject *	object (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 QMimeData *	mimeData (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_DataSearcher *	searcher () const

virtual void	setSearcher (SUIT_DataSearcher *)

Private Types
typedef SUIT_DataObject *	ObjPtr

typedef SUIT_TreeModel::TreeItem *	ItemPtr

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...

TreeItem *	rootItem () const
	Get root tree item. More...

TreeItem *	treeItem (const QModelIndex &) const
	Get tree item corresponding to the specified model index. More...

TreeItem *	treeItem (const SUIT_DataObject *) const
	Get tree item corresponding to the specified data object. More...

SUIT_DataObject *	object (const TreeItem *) const
	Get data object corresponding to the specified tree item. More...

QString	objectId (const QModelIndex &=QModelIndex()) const
	Get unique object identifier. More...

TreeItem *	createItem (SUIT_DataObject , TreeItem =0, TreeItem *=0)
	Create an item corresponding to the data object. More...

TreeItem *	createItemAtPos (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_DataObject *	myRoot

TreeItem *	myRootItem

ItemMap	myItems

VisibilityMap	myVisibilityMap

bool	myAutoDeleteTree

bool	myAutoUpdate

bool	myUpdateModified

QVector< ColumnInfo >	myColumns

Friends
class	SUIT_TreeModel::TreeSync

Detailed Description

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

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

◆ ItemMap

typedef QMap<SUIT_DataObject*, TreeItem*> SUIT_TreeModel::ItemMap

private

◆ ItemPtr

typedef SUIT_TreeModel::TreeItem* SUIT_TreeModel::ItemPtr

private

◆ ObjPtr

typedef SUIT_DataObject* SUIT_TreeModel::ObjPtr

private

◆ VisibilityMap

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

private

Member Enumeration Documentation

◆ Role

enum SUIT_TreeModel::Role

Data role.

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() [1/2]

SUIT_TreeModel::SUIT_TreeModel ( QObject * parent = 0 )

Constructor.

Parameters

parent parent object

References initialize().

◆ SUIT_TreeModel() [2/2]

SUIT_TreeModel::SUIT_TreeModel	(	SUIT_DataObject *	root,
		QObject *	parent = `0`
	)

Constructor.

Parameters

root	root data object
parent	parent object

References initialize().

◆ ~SUIT_TreeModel()

SUIT_TreeModel::~SUIT_TreeModel ( )

Destructor.

References autoDeleteTree(), SUIT_DataObject::disconnect(), myRoot, myRootItem, onInserted(), onModified(), and onRemoved().

Member Function Documentation

◆ appropriate()

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

virtual

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

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, and Qtx::Shown.

◆ autoDeleteTree()

bool SUIT_TreeModel::autoDeleteTree ( ) const

virtual

Get 'auto-delete data tree' flag value.

Returns: 'auto-delete data tree' flag value

See also: setAutoDeleteTree()

Implements SUIT_AbstractModel.

References myAutoDeleteTree.

◆ autoUpdate()

bool SUIT_TreeModel::autoUpdate ( ) const

virtual

Get 'auto-update tree' flag value.

Returns: 'auto-update tree' flag value

See also: setAutoUpdate(), updateTree()

Implements SUIT_AbstractModel.

References myAutoUpdate.

◆ clicked

void SUIT_TreeModel::clicked	(	SUIT_DataObject *	,
		int
	)

signal

◆ columnCount()

int SUIT_TreeModel::columnCount ( const QModelIndex & = QModelIndex() ) const

virtual

Get number of data columns.

Parameters

parent parent model index (not used)

Returns: data columns number

See also: rowCount()

References myColumns.

◆ columnIcon()

QPixmap SUIT_TreeModel::columnIcon ( const QString & name ) const

virtual

Get column icon.

Parameters

name	- column name

Returns: icon of the specified column

Implements SUIT_AbstractModel.

References myColumns.

◆ createItem()

SUIT_TreeModel::TreeItem * SUIT_TreeModel::createItem	(	SUIT_DataObject *	obj,
		SUIT_TreeModel::TreeItem *	parent = `0`,
		SUIT_TreeModel::TreeItem *	after = `0`
	)

private

Create an item corresponding to the data object.

Parameters

obj	source data object
parent	parent tree item
after	tree item after which new item should be inserted

Returns: created tree item or 0 if item could not be created

References index(), myItems, object(), parent(), SUIT_DataObject::position(), and SUIT_DataObject::setModified().

◆ createItemAtPos()

SUIT_TreeModel::TreeItem * SUIT_TreeModel::createItemAtPos	(	SUIT_DataObject *	obj,
		SUIT_TreeModel::TreeItem *	parent = `0`,
		int	pos = `0`
	)

private

Create an item corresponding to the data object.

Parameters

obj	source data object
parent	parent tree item
pos	tree item position into which new item should be inserted

Returns: created tree item or 0 if item could not be created

References index(), myItems, object(), parent(), and SUIT_DataObject::setModified().

◆ customSorting()

bool SUIT_TreeModel::customSorting ( const int column ) const

virtual

Check if the specified column supports custom sorting.

Parameters

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

◆ data()

QVariant SUIT_TreeModel::data	(	const QModelIndex &	index,
		int	role = `DisplayRole`
	)		const

virtual

Get data for the specified model index and data role.

Parameters

index	model index
role	data role

Returns: requested data

See also: setData()

◆ delegate()

QAbstractItemDelegate * SUIT_TreeModel::delegate ( ) const

virtual

Get item delegate for the model.

Returns: new item delegate

Implements SUIT_AbstractModel.

◆ dropMimeData()

bool SUIT_TreeModel::dropMimeData	(	const QMimeData *	data,
		Qt::DropAction	action,
		int	row,
		int	column,
		const QModelIndex &	parent
	)

virtual

References data(), dropped(), SUIT_DataSearcher::findObject(), object(), parent(), and SUIT_AbstractModel::searcher().

◆ dropped

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

signal

◆ emitClicked()

void SUIT_TreeModel::emitClicked	(	SUIT_DataObject *	obj,
		const QModelIndex &	index
	)

virtual

Implements SUIT_AbstractModel.

References clicked(), SUIT_DataObject::groupId(), index(), myColumns, and SUIT_TreeModel::ColumnInfo::myIds.

◆ flags()

Qt::ItemFlags SUIT_TreeModel::flags ( const QModelIndex & index ) const

virtual

Get data flags for specified model index.

Parameters

index model index

Returns: data flags

References index(), SUIT_DataObject::isCheckable(), SUIT_DataObject::isDraggable(), SUIT_DataObject::isDropAccepted(), SUIT_DataObject::isEnabled(), SUIT_DataObject::isSelectable(), object(), and SUIT_DataObject::renameAllowed().

◆ forgetObject()

void SUIT_TreeModel::forgetObject ( const SUIT_DataObject * obj )

virtual

Implements SUIT_AbstractModel.

References removeItem(), and treeItem().

◆ headerData()

QVariant SUIT_TreeModel::headerData	(	int	column,
		Qt::Orientation	orientation,
		int	role = `Qt::DisplayRole`
	)		const

virtual

Get header data (can be used in any data view).

Parameters

column	column number
orientation	header orientation
role	data role

Returns: header data

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

◆ headerFlags()

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

virtual

Get the header flags.

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 Qtx::ShowNone.

◆ index() [1/2]

QModelIndex SUIT_TreeModel::index	(	const SUIT_DataObject *	obj,
		int	column = `0`
	)		const

virtual

Get model index by the specified data object.

Parameters

obj	data object
column	data object column

Returns: model index

Implements SUIT_AbstractModel.

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

◆ index() [2/2]

QModelIndex SUIT_TreeModel::index	(	int	row,
		int	column,
		const QModelIndex &	parent = `QModelIndex()`
	)		const

virtual

Create model index.

Parameters

row	data row
column	data column
parent	parent model index

Returns: model index

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

◆ initialize()

void SUIT_TreeModel::initialize ( )

private

Initialize tree model.

References autoUpdate(), SUIT_DataObject::connect(), SUIT_DataObject::disconnect(), QtxResourceMgr::loadPixmap(), myItems, myRootItem, SUIT_DataObject::NameId, onInserted(), onModified(), onRemoved(), registerColumn(), SUIT_Session::resourceMgr(), SUIT_Session::session(), setColumnIcon(), setHeaderFlags(), Qtx::ShowIcon, updateTree(), and SUIT_DataObject::VisibilityId.

◆ lessThan()

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

virtual

Compares two model indexes for the sorting purposes.

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

Parameters

left	first index to compare
right	second index to compare

Returns: result of the comparison

See also: customSorting()

Implements SUIT_AbstractModel.

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

◆ mimeData()

QMimeData * SUIT_TreeModel::mimeData ( const QModelIndexList & indexes ) const

virtual

Called when the data objects are exported(dragged) from the tree.

Parameters

indexes the list of exported objects

References index(), and objectId().

◆ mimeTypes()

QStringList SUIT_TreeModel::mimeTypes ( ) const

virtual

Drag and Drop support.

◆ modelUpdated

void SUIT_TreeModel::modelUpdated ( )

signal

◆ object() [1/2]

SUIT_DataObject * SUIT_TreeModel::object ( const QModelIndex & index = QModelIndex() ) const

virtual

Get data object by the specified model index.

Parameters

index model index

Returns: data object corresponding to the model index

Implements SUIT_AbstractModel.

References index(), and treeItem().

◆ object() [2/2]

SUIT_DataObject * SUIT_TreeModel::object ( const TreeItem * item ) const

private

Get data object corresponding to the specified tree item.

Parameters

item tree item

Returns: data object or 0 if there is no data object corresponding to item

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

◆ objectId()

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

private

Get unique object identifier.

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

Parameters

index model index

Returns: object identifier or null string if it isn't specified

See also: SUIT_DataObject::customData()

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

◆ onInserted

void SUIT_TreeModel::onInserted	(	SUIT_DataObject *	,
		SUIT_DataObject *	parent
	)

privateslot

Called when the data object is inserted to the tree.

Parameters

object	data object being inserted
parent	parent data object

References autoUpdate(), parent(), and updateTree().

◆ onModified

void SUIT_TreeModel::onModified ( SUIT_DataObject * obj )

privateslot

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.

Parameters

obj	data object that has been modified

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

◆ onRemoved

void SUIT_TreeModel::onRemoved	(	SUIT_DataObject *	,
		SUIT_DataObject *	parent
	)

privateslot

Called when the data object is removed from the tree.

Parameters

object	data object being removed
parent	parent data object

References autoUpdate(), parent(), and updateTree().

◆ parent()

QModelIndex SUIT_TreeModel::parent ( const QModelIndex & index ) const

virtual

Get parent model index.

Parameters

index model index

Returns: parent model index

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

◆ registerColumn()

void SUIT_TreeModel::registerColumn	(	const int	group_id,
		const QString &	name,
		const int	custom_id
	)

virtual

Register new column in the model.

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, SUIT_TreeModel::ColumnInfo::myName, Qtx::ShowAll, and Qtx::Shown.

◆ removeItem()

void SUIT_TreeModel::removeItem ( SUIT_TreeModel::TreeItem * item )

private

Remove tree item (recursively).

Parameters

item	tree item to be removed

References SUIT_TreeModel::TreeItem::child(), SUIT_TreeModel::TreeItem::childCount(), index(), myItems, object(), SUIT_TreeModel::TreeItem::parent(), parent(), SUIT_TreeModel::TreeItem::position(), root(), and setRoot().

◆ renamed

void SUIT_TreeModel::renamed ( SUIT_DataObject * )

signal

◆ root()

SUIT_DataObject * SUIT_TreeModel::root ( ) const

virtual

Get data tree root object.

Returns: data tree root

See also: setRoot()

Implements SUIT_AbstractModel.

References myRoot.

◆ rootItem()

SUIT_TreeModel::TreeItem * SUIT_TreeModel::rootItem ( ) const

private

Get root tree item.

Returns: root tree item

References myRootItem.

◆ rowCount()

int SUIT_TreeModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

virtual

Get number of data rows (children of the specified model index).

Parameters

parent parent model index

Returns: data rows (children) number

See also: columnCount()

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

◆ setAppropriate()

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

virtual

Change appropriate status.

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, and myColumns.

◆ setAutoDeleteTree()

void SUIT_TreeModel::setAutoDeleteTree ( const bool on )

virtual

Set 'auto-delete data tree' flag value.

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.

◆ setAutoUpdate()

void SUIT_TreeModel::setAutoUpdate ( const bool on )

virtual

Set 'auto-update tree' flag value.

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

◆ setColumnIcon()

void SUIT_TreeModel::setColumnIcon	(	const QString &	name,
		const QPixmap &	icon
	)

virtual

Change column icon.

Parameters

name	- column name
icon	- new icon of the specified column

Implements SUIT_AbstractModel.

References myColumns.

◆ setData()

bool SUIT_TreeModel::setData	(	const QModelIndex &	index,
		const QVariant &	value,
		int	role = `EditRole`
	)

virtual

Set data for the specified model index and data role.

Parameters

index	model index
value	new data value
role	data role

Returns: true if data is set

See also: data()

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

◆ setHeaderFlags()

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

virtual

Set header flags.

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, and myColumns.

◆ setRoot()

void SUIT_TreeModel::setRoot ( SUIT_DataObject * r )

virtual

Set data tree root object.

Parameters

r	new data tree root

See also: root()

Implements SUIT_AbstractModel.

References autoDeleteTree(), SUIT_TreeModel::TreeItem::children(), SUIT_DataObject::disconnect(), modelUpdated(), myRoot, myRootItem, onInserted(), onModified(), onRemoved(), and root().

◆ setUpdateModified()

void SUIT_TreeModel::setUpdateModified ( const bool on )

virtual

Set 'updateModified' flag value.

Parameters

on	'updateModified' flag value

Implements SUIT_AbstractModel.

References myUpdateModified.

◆ setVisibilityState()

void SUIT_TreeModel::setVisibilityState	(	const QString &	id,
		Qtx::VisibilityState	state,
		bool	emitChanged = `true`
	)

virtual

Set visibility state of the object.

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.

◆ setVisibilityStateForAll()

void SUIT_TreeModel::setVisibilityStateForAll ( Qtx::VisibilityState state )

virtual

Set visibility state for all objects.

Parameters

state - visible state

Implements SUIT_AbstractModel.

References myVisibilityMap, and setVisibilityState().

◆ supportedDropActions()

Qt::DropActions SUIT_TreeModel::supportedDropActions ( ) const

virtual

◆ treeItem() [1/2]

SUIT_TreeModel::TreeItem * SUIT_TreeModel::treeItem ( const QModelIndex & index ) const

private

Get tree item corresponding to the specified model index.

Parameters

index model index

Returns: tree item or root item if index is invalid

References index(), and rootItem().

◆ treeItem() [2/2]

SUIT_TreeModel::TreeItem * SUIT_TreeModel::treeItem ( const SUIT_DataObject * obj ) const

private

Get tree item corresponding to the specified data object.

Parameters

obj	data object

Returns: tree item or 0 if there is no tree item corresponding to obj

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

◆ unregisterColumn()

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

virtual

Remove column from the model.

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.

◆ updateItem()

void SUIT_TreeModel::updateItem	(	SUIT_TreeModel::TreeItem *	item,
		bool	emitLayoutChanged
	)

private

Update tree item.

Parameters

item	tree item to be updated
emitLayoutChanged	if signal about changed layout should be emitted

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

◆ updateModified()

bool SUIT_TreeModel::updateModified ( ) const

virtual

Get 'updateModified' flag value.

Returns: 'updateModified' flag value

Implements SUIT_AbstractModel.

References myUpdateModified.

◆ updateTree [1/2]

void SUIT_TreeModel::updateTree ( const QModelIndex & index )

virtualslot

Update tree model.

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

index starting index for the updating

See also: setAutoUpdate()

References index().

◆ updateTree [2/2]

void SUIT_TreeModel::updateTree ( SUIT_DataObject * obj = 0 )

virtualslot

Update tree model.

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

obj	starting data object for the updating

See also: setAutoUpdate()

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

◆ updateTreeModel()

void SUIT_TreeModel::updateTreeModel	(	SUIT_DataObject *	obj,
		TreeItem *	item
	)

virtual

References SUIT_TreeModel::TreeItem::child(), SUIT_DataObject::childCount(), SUIT_TreeModel::TreeItem::childCount(), SUIT_DataObject::childObject(), createItemAtPos(), SUIT_TreeModel::TreeItem::dataObject(), SUIT_DataObject::modified(), removeItem(), treeItem(), SUIT_DataObject::update(), and updateItem().

◆ visibilityState()

Qtx::VisibilityState SUIT_TreeModel::visibilityState ( const QString & id ) const

virtual

Get visibility state of the object.

Parameters

id	- column name

Returns: visible state

Implements SUIT_AbstractModel.

References myVisibilityMap, and Qtx::UnpresentableState.

Friends And Related Function Documentation

◆ SUIT_TreeModel::TreeSync

friend class SUIT_TreeModel::TreeSync

friend

Member Data Documentation

◆ myAutoDeleteTree

bool SUIT_TreeModel::myAutoDeleteTree

private

◆ myAutoUpdate

bool SUIT_TreeModel::myAutoUpdate

private

◆ myColumns

QVector<ColumnInfo> SUIT_TreeModel::myColumns

private

◆ myItems

ItemMap SUIT_TreeModel::myItems

private

◆ myRoot

SUIT_DataObject* SUIT_TreeModel::myRoot

private

◆ myRootItem

TreeItem* SUIT_TreeModel::myRootItem

private

◆ myUpdateModified

bool SUIT_TreeModel::myUpdateModified

private

◆ myVisibilityMap

VisibilityMap SUIT_TreeModel::myVisibilityMap

private

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

src/SUIT/SUIT_TreeModel.h
src/SUIT/SUIT_TreeModel.cxx

Classes

Public Types

Public Slots

Signals

Public Member Functions

Private Types

Private Slots

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ItemMap

◆ ItemPtr

◆ ObjPtr

◆ VisibilityMap

Member Enumeration Documentation

◆ Role

Constructor & Destructor Documentation

◆ SUIT_TreeModel() [1/2]

◆ SUIT_TreeModel() [2/2]

◆ ~SUIT_TreeModel()

Member Function Documentation

◆ appropriate()

◆ autoDeleteTree()

◆ autoUpdate()

◆ clicked

◆ columnCount()

◆ columnIcon()

◆ createItem()

◆ createItemAtPos()

◆ customSorting()

◆ data()

◆ delegate()

◆ dropMimeData()

◆ dropped

◆ emitClicked()

◆ flags()

◆ forgetObject()

◆ headerData()

◆ headerFlags()

◆ index() [1/2]

◆ index() [2/2]

◆ initialize()

◆ lessThan()

◆ mimeData()

◆ mimeTypes()

◆ modelUpdated

◆ object() [1/2]

◆ object() [2/2]

◆ objectId()

◆ onInserted

◆ onModified

◆ onRemoved

◆ parent()

◆ registerColumn()

◆ removeItem()

◆ renamed

◆ root()

◆ rootItem()

◆ rowCount()

◆ setAppropriate()

◆ setAutoDeleteTree()

◆ setAutoUpdate()

◆ setColumnIcon()

◆ setData()

◆ setHeaderFlags()

◆ setRoot()

◆ setUpdateModified()

◆ setVisibilityState()

◆ setVisibilityStateForAll()

◆ supportedDropActions()

◆ treeItem() [1/2]

◆ treeItem() [2/2]

◆ unregisterColumn()

◆ updateItem()

◆ updateModified()

◆ updateTree [1/2]

◆ updateTree [2/2]

◆ updateTreeModel()