Object browser widget which can be used to handle tree-like data model. More...

#include <OB_Browser.h>

Inheritance diagram for OB_Browser:

Public Types
typedef QMap< QString, bool >	MapOfOpenStates

Signals
void	selectionChanged ()
	Emitted when selection is changed in the Object Browser. More...

Public Member Functions
	OB_Browser (QWidget =0, QAbstractItemModel =0)
	Constructor. More...

virtual	~OB_Browser ()
	Destructor. More...

QAbstractItemModel *	model () const
	Get data model. More...

void	setModel (QAbstractItemModel *)
	Set data model. More...

QAbstractItemDelegate *	itemDelegate () const
	Get current item delegate (items renderer). More...

void	setItemDelegate (QAbstractItemDelegate *)
	Set item delegate (items renderer). More...

bool	rootIsDecorated () const
	Check if controls for expanding and collapsing top-level items are shown. More...

void	setRootIsDecorated (const bool)
	Show/hide controls for expanding and collapsing top-level items. More...

bool	sortMenuEnabled () const

void	setSortMenuEnabled (const bool)

QtxSearchTool *	searchTool () const
	Get search tool widget. More...

bool	isSearchToolEnabled () const
	Check if search tool is enabled. More...

void	setSearchToolEnabled (const bool)
	Enable/disable search tool. More...

int	autoOpenLevel () const
	Get number of levels which should be automatically expanded when updating the data tree. More...

void	setAutoOpenLevel (const int)
	Set number of levels which should be automatically expanded when updating the data tree. More...

void	openLevels (const int=-1)
	Expand all branches to the specified number of levels. More...

int	numberOfSelected () const
	Get number of selected items. More...

QModelIndexList	selectedIndexes () const
	Get all selected items. More...

const QItemSelection	selection () const
	Get selection containing information about selected ranges. More...

virtual void	select (const QModelIndex &, const bool, const bool=true)
	Select/deselect specified model index. More...

virtual void	select (const QModelIndexList &, const bool, const bool=true)
	Select/deselect specified model indices. More...

bool	isOpen (const QModelIndex &) const
	Check if specified model index is expanded or collapsed. More...

virtual void	setOpen (const QModelIndex &theObject, const bool theOpen=true)
	Expand/collapse the specified model index. More...

void	adjustWidth ()
	Adjust first column width to its contents. More...

void	adjustFirstColumnWidth ()
	Adjust first column width to its contents. More...

void	adjustColumnsWidth ()
	Adjust all columns width to its contents except the first column. More...

unsigned long	getModifiedTime () const
	Get the time of the latest updating. More...

void	setModified ()
	Update the time of the latest updating. More...

QtxTreeView *	treeView () const
	Get tree view widget. More...

QByteArray	getOpenStates (int theColumn) const

void	setOpenStates (const QByteArray &, int theColumn)

void	openStates (bool isGet, MapOfOpenStates &, const QModelIndex &theIndex, int theColumn)

Protected Member Functions
virtual void	contextMenuEvent (QContextMenuEvent *)
	Process context menu request event. More...

virtual void	createPopupMenu (QMenu *)
	Add custom actions to the popup menu. More...

Private Slots
void	onExpandAll ()
	Called when "Expand all" popup menu command is activated. More...

void	onCollapseAll ()
	Called when "Collapse all" popup menu command is activated. More...

virtual void	onExpanded (const QModelIndex &)

Private Member Functions
bool	hasCollased (const QModelIndex &) const
	Check if model index is collapsed or has collapsed children. More...

bool	hasExpanded (const QModelIndex &) const
	Check if model index is expanded or has expanded children. More...

Private Attributes
QtxTreeView *	myView

QtxSearchTool *	mySearchTool

int	myAutoOpenLevel

unsigned long	myModifiedTime

Detailed Description

Object browser widget which can be used to handle tree-like data model.

Constructor

Destructor

It is called when there is a possibility that a tool tip should be shown and must decide whether there is a tool tip for the point in the widget that this QToolTip object relates to.

Parameters

pos	- point co-ordinates

The class OB_Browser implements public API of an object browser widget that can be used to display arbitrary application data in a hierarchical form. It is based on Qt4 model/view architecture.

Object browser can be used with conjuction of any custom item model inherited from QAbstractItemModel class (see Qt 4 reference manual).

The class provides a functionality get/modify selection, drag-n-drop of the objects, etc.

Member Typedef Documentation

◆ MapOfOpenStates

typedef QMap<QString, bool> OB_Browser::MapOfOpenStates

Constructor & Destructor Documentation

◆ OB_Browser()

OB_Browser::OB_Browser	(	QWidget *	parent = `0`,
		QAbstractItemModel *	model = `0`
	)

Constructor.

Parameters

parent	paren widget
model	data model

References main(), model(), mySearchTool, myView, selectionChanged(), QtxSearchTool::setActivators(), setModel(), QtxSearchTool::setSearcher(), QtxSearchTool::SlashKey, and QtxSearchTool::StandardKey.

◆ ~OB_Browser()

OB_Browser::~OB_Browser ( )

virtual

Destructor.

Member Function Documentation

◆ adjustColumnsWidth()

void OB_Browser::adjustColumnsWidth ( )

Adjust all columns width to its contents except the first column.

References myView, and QtxTreeView::resizeColumnToEncloseContents().

◆ adjustFirstColumnWidth()

void OB_Browser::adjustFirstColumnWidth ( )

Adjust first column width to its contents.

References myView, and QtxTreeView::resizeColumnToEncloseContents().

◆ adjustWidth()

void OB_Browser::adjustWidth ( )

Adjust first column width to its contents.

References myView, and QtxTreeView::resizeColumnToEncloseContents().

◆ autoOpenLevel()

int OB_Browser::autoOpenLevel ( ) const

Get number of levels which should be automatically expanded when updating the data tree.

Returns: number of levels to be auto-opened on tree updating

See also: setAutoOpenLevel()

References myAutoOpenLevel.

◆ contextMenuEvent()

void OB_Browser::contextMenuEvent ( QContextMenuEvent * e )

protectedvirtual

Process context menu request event.

Parameters

e	context menu event

Reimplemented in SUIT_DataBrowser.

References createPopupMenu(), and Qtx::simplifySeparators().

◆ createPopupMenu()

void OB_Browser::createPopupMenu ( QMenu * menu )

protectedvirtual

Add custom actions to the popup menu.

SLOT: called if SUIT object is destroyed

SLOT: called on finish of drag-n-drop operation

Parameters

items	- dragged items
item	- destination (item on that they were dropped)
action	- QDropEvent::Action

Updates texts of items

Returns: true if item must be updated

Parameters

item	- item to be checked

Updates texts of item

Parameters

item	- item to be updated
menu	popup menu

References hasCollased(), hasExpanded(), isSearchToolEnabled(), onCollapseAll(), onExpandAll(), searchTool(), and selectedIndexes().

◆ getModifiedTime()

unsigned long OB_Browser::getModifiedTime ( ) const

Get the time of the latest updating.

Returns: latest updating time

References myModifiedTime.

◆ getOpenStates()

QByteArray OB_Browser::getOpenStates ( int theColumn ) const

References openStates().

◆ hasCollased()

bool OB_Browser::hasCollased ( const QModelIndex & index ) const

private

Check if model index is collapsed or has collapsed children.

Expands item with all it's children

Returns: true if item or one of its children is collapsed

References hasCollased(), model(), and myView.

◆ hasExpanded()

bool OB_Browser::hasExpanded ( const QModelIndex & index ) const

private

Check if model index is expanded or has expanded children.

Returns: true if item or one of its children is expanded

References hasExpanded(), model(), and myView.

◆ isOpen()

bool OB_Browser::isOpen ( const QModelIndex & index ) const

Check if specified model index is expanded or collapsed.

Parameters

index model index

Returns: true if model index is expanded

See also: setOpen()

References model(), and myView.

◆ isSearchToolEnabled()

bool OB_Browser::isSearchToolEnabled ( ) const

Check if search tool is enabled.

Returns: true if search tool is enabled

See also: setSearchToolEnabled(), searchTool()

References mySearchTool.

◆ itemDelegate()

QAbstractItemDelegate * OB_Browser::itemDelegate ( ) const

Get current item delegate (items renderer).

Returns: currently used item delegate

See also: setItemDelegate()

References myView.

◆ model()

QAbstractItemModel * OB_Browser::model ( ) const

Get data model.

Returns: data model

See also: setModel()

References myView.

◆ numberOfSelected()

int OB_Browser::numberOfSelected ( ) const

Get number of selected items.

Returns: state "are tooltips shown"

Sets new value of state "are tooltips shown"

Parameters

theDisplay - new value

Returns: number of selected items

References myView.

◆ onCollapseAll

void OB_Browser::onCollapseAll ( )

privateslot

Called when "Collapse all" popup menu command is activated.

Collapse all selected items recursively.

References QtxTreeView::collapseAll(), myView, and selectedIndexes().

◆ onExpandAll

void OB_Browser::onExpandAll ( )

privateslot

Called when "Expand all" popup menu command is activated.

Expands all selected items recursively.

References QtxTreeView::expandAll(), myView, onExpanded(), selectedIndexes(), and treeView().

◆ onExpanded

virtual void OB_Browser::onExpanded ( const QModelIndex & )

inlineprivatevirtualslot

◆ openLevels()

void OB_Browser::openLevels ( const int levels = -1 )

Expand all branches to the specified number of levels.

If levels value is negative, then autoOpenLevel() value is used instead.

Parameters

levels number of levels to be expanded

See also: autoOpenLevel()

References autoOpenLevel(), QtxTreeView::expandLevels(), and myView.

◆ openStates()

void OB_Browser::openStates	(	bool	isGet,
		MapOfOpenStates &	theMap,
		const QModelIndex &	theIndex,
		int	theColumn
	)

References isOpen(), model(), openStates(), and treeView().

◆ rootIsDecorated()

bool OB_Browser::rootIsDecorated ( ) const

Check if controls for expanding and collapsing top-level items are shown.

Returns: true if top-level items are decorated

See also: setRootIsDecorated()

References myView.

◆ searchTool()

QtxSearchTool * OB_Browser::searchTool ( ) const

Get search tool widget.

Returns: search tool widget

See also: isSearchToolEnabled(), setSearchToolEnabled()

References mySearchTool.

◆ select() [1/2]

void OB_Browser::select	(	const QModelIndex &	index,
		const bool	on,
		const bool	keepSelection = `true`
	)

virtual

Select/deselect specified model index.

Parameters

index	model index to be selected/deselected
on	if `true`, the index will be selected, otherwise - deselected
keepSelection	if `true` (default) the previous selection is kept, otherwise it is first cleared

References myView.

◆ select() [2/2]

void OB_Browser::select	(	const QModelIndexList &	indexes,
		const bool	on,
		const bool	keepSelection = `true`
	)

virtual

Select/deselect specified model indices.

Parameters

indexes	model indices to be selected/deselected
on	if `true`, the indices will be selected, otherwise - deselected
keepSelection	if `true` (default) the previous selection is kept, otherwise it is first cleared

References myView, and selectionChanged().

◆ selectedIndexes()

QModelIndexList OB_Browser::selectedIndexes ( ) const

Get all selected items.

Returns: unsorted list of selected indexes with no duplicates

References myView.

◆ selection()

const QItemSelection OB_Browser::selection ( ) const

Get selection containing information about selected ranges.

Returns: QItemSelection instance

References myView.

◆ selectionChanged

void OB_Browser::selectionChanged ( )

signal

Emitted when selection is changed in the Object Browser.

Removes SUIT object

Parameters

obj	- SUIT object to be removed
autoUpd	- auto tree updating

Opens branches from 1 to autoOpenLevel()

See also: autoOpenLevel()

Opens branch

Parameters

item
level

SLOT: called on double click on item, emits signal

◆ setAutoOpenLevel()

void OB_Browser::setAutoOpenLevel ( const int levels )

Set number of levels which should be automatically expanded when updating the data tree.

Parameters

levels number of levels to be auto-opened on tree updating

See also: autoOpenLevel()

References myAutoOpenLevel.

◆ setItemDelegate()

void OB_Browser::setItemDelegate ( QAbstractItemDelegate * d )

Set item delegate (items renderer).

Parameters

d	custom item delegate

See also: itemDelegate()

References myView.

◆ setModel()

void OB_Browser::setModel ( QAbstractItemModel * model )

Set data model.

Parameters

model data model

See also: model()

References model(), myView, QtxTreeView::setModel(), and setModified().

◆ setModified()

void OB_Browser::setModified ( )

Update the time of the latest updating.

References myModifiedTime.

◆ setOpen()

void OB_Browser::setOpen	(	const QModelIndex &	index,
		const bool	open = `true`
	)

virtual

Expand/collapse the specified model index.

Parameters

index	model index
open	if `true`, the index will be expanded, otherwse - collapsed

See also: isOpen()

References myView.

◆ setOpenStates()

void OB_Browser::setOpenStates	(	const QByteArray &	theData,
		int	theColumn
	)

References isOpen(), and openStates().

◆ setRootIsDecorated()

void OB_Browser::setRootIsDecorated ( const bool decor )

Show/hide controls for expanding and collapsing top-level items.

Parameters

decor if true, top-level items are decorated

See also: rootIsDecorated()

References myView, and rootIsDecorated().

◆ setSearchToolEnabled()

void OB_Browser::setSearchToolEnabled ( const bool enable )

Enable/disable search tool.

Parameters

enable pass true to enable search tool

See also: isSearchToolEnabled(), searchTool()

References mySearchTool.

◆ setSortMenuEnabled()

void OB_Browser::setSortMenuEnabled ( const bool enabled )

References myView, QtxTreeView::setSortMenuEnabled(), and sortMenuEnabled().

◆ sortMenuEnabled()

bool OB_Browser::sortMenuEnabled ( ) const

References myView, and QtxTreeView::sortMenuEnabled().

◆ treeView()

QtxTreeView * OB_Browser::treeView ( ) const

Get tree view widget.

Returns: SUIT object correspondint to item at position 'pos'

Parameters

pos	- position

Returns: filter of list view

Changes filter of list view

Parameters

f	- new filter

Sets global width mode

Parameters

mode	- new width mode

Updates tree

Parameters

obj	- start object
autoOpen	- to open automatically branches of autoOpenLevel()

See also: autoOpenLevel()

Replaces part of tree starting at object 'src' by tree starting at object 'trg'

Adjusts width by item

Parameters

item

\remove all items referencing current (through data objects)

Connects all children to SLOT onDestroyed

Disconnects all children from SLOT onDestroyed

Stores states (opened, selected) of current tree items

Returns: current item

Parameters

selObjs,selKeys	- maps of selected objects
openObjs,openKeys	- maps of opened objects
curKey	- map of current objects

Restores states (opened, selected) of current tree items

Parameters

selObjs,selKeys	- maps of selected objects
openObjs,openKeys	- maps of opened objects
curKey	- map of current objects

Creates object key by tree item

Creates object key by SUIT object

Returns: tree view widget of the object browser

References myView.

Member Data Documentation

◆ myAutoOpenLevel

int OB_Browser::myAutoOpenLevel

private

◆ myModifiedTime

unsigned long OB_Browser::myModifiedTime

private

◆ mySearchTool

QtxSearchTool* OB_Browser::mySearchTool

private

◆ myView

QtxTreeView* OB_Browser::myView

private

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

src/ObjBrowser/OB_Browser.h
src/ObjBrowser/OB_Browser.cxx

Public Types

Signals

Public Member Functions

Protected Member Functions

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ MapOfOpenStates

Constructor & Destructor Documentation

◆ OB_Browser()

◆ ~OB_Browser()

Member Function Documentation

◆ adjustColumnsWidth()

◆ adjustFirstColumnWidth()

◆ adjustWidth()

◆ autoOpenLevel()

◆ contextMenuEvent()

◆ createPopupMenu()

◆ getModifiedTime()

◆ getOpenStates()

◆ hasCollased()

◆ hasExpanded()

◆ isOpen()

◆ isSearchToolEnabled()

◆ itemDelegate()

◆ model()

◆ numberOfSelected()

◆ onCollapseAll

◆ onExpandAll

◆ onExpanded

◆ openLevels()

◆ openStates()

◆ rootIsDecorated()

◆ searchTool()

◆ select() [1/2]

◆ select() [2/2]

◆ selectedIndexes()

◆ selection()

◆ selectionChanged

◆ setAutoOpenLevel()

◆ setItemDelegate()

◆ setModel()

◆ setModified()

◆ setOpen()

◆ setOpenStates()

◆ setRootIsDecorated()

◆ setSearchToolEnabled()

◆ setSortMenuEnabled()

◆ sortMenuEnabled()

◆ treeView()

Member Data Documentation

◆ myAutoOpenLevel

◆ myModifiedTime

◆ mySearchTool

◆ myView