Tree view class with possibility to display columns popup menu. More...

#include <QtxTreeView.h>

Inheritance diagram for QtxTreeView:

Classes
class	Header
	Custom tree view header class. More...

Signals
void	sortingEnabled (bool)
	Emitted when "Sorting" commans is enabled/disabled from the popup menu. More...

void	selectionChanged ()
	Emitted when selection is changed in the tree view. More...

Public Member Functions
	QtxTreeView (QWidget *=0)
	Constructor. More...

	QtxTreeView (const bool, QWidget *=0)
	Constructor. More...

virtual	~QtxTreeView ()
	Destructor. More...

void	expandLevels (const int)
	Expand all branches for specified number of levels. More...

void	collapseLevels (const int)
	Collapse all branches for specified number of levels. More...

void	expandAll (const QModelIndex &)
	Expand the branch specifed by the \index and all its children recursively. More...

void	collapseAll (const QModelIndex &)
	Collapse the branch specifed by the \index and all its children recursively. More...

void	setSortMenuEnabled (const bool)

bool	sortMenuEnabled () const

void	resizeColumnToEncloseContents (int)
	Resizes the given column in order to enclose its contents. The size will be changed only if it is smaller than the size of contents. More...

virtual void	setModel (QAbstractItemModel *)

virtual void	scrollTo (const QModelIndex &index, QAbstractItemView::ScrollHint hint=QAbstractItemView::EnsureVisible)

Protected Slots
void	onHeaderClicked (int)

void	rowsAboutToBeRemoved (const QModelIndex &, int, int)
	Called when rows are about to be removed. More...

void	selectionChanged (const QItemSelection &, const QItemSelection &)
	Called when the selection is changed. More...

void	onAppropriate (Qt::Orientation, int, int)

Protected Member Functions
void	setOpened (const QModelIndex &, const int, bool)
	Expand/collapse the specified item (recursively). More...

Private Member Functions
void	emitSortingEnabled (bool)
	Emit sortingEnabled(bool) signal. More...

Friends
class	QtxTreeView::Header

Detailed Description

Tree view class with possibility to display columns popup menu.

The QtxTreeView class represents a customized tree view class. In addition to the base functionality inherited from the QTreeView class, clicking at the tree view header with the right mouse button displays the popup menu allowing the user to show/hide specified columns.

By default the popup menu contains items corresponding to all the tree view columns. In order to disable some columns from being shown in the popup menu one may customize the data model (see QAbstractItemModel class). The custom model should implement headerData() method and return true for the Qtx::AppropriateRole role for those columns which should be available in the popup menu and false for the columns which should not be added to it.

Constructor & Destructor Documentation

◆ QtxTreeView() [1/2]

QtxTreeView::QtxTreeView ( QWidget * parent = 0 )

Constructor.

Parameters

parent parent widget

◆ QtxTreeView() [2/2]

QtxTreeView::QtxTreeView	(	const bool	enableSortMenu,
		QWidget *	parent = `0`
	)

Constructor.

Parameters

enableSortMenu	show "Sorting" header menu command if `true`
parent	parent widget

◆ ~QtxTreeView()

QtxTreeView::~QtxTreeView ( )

virtual

Destructor.

Member Function Documentation

◆ collapseAll()

void QtxTreeView::collapseAll ( const QModelIndex & index )

Collapse the branch specifed by the \index and all its children recursively.

Parameters

index model index to be collapsed

See also: expandAll()

References setOpened().

◆ collapseLevels()

void QtxTreeView::collapseLevels ( const int levels )

Collapse all branches for specified number of levels.

If levels < 0, all branches are collapsed (the same results can be achieved with collapseAll() method).

Parameters

levels number of levels to be collapsed

See also: expandLevels(), setOpened()

References setOpened().

◆ emitSortingEnabled()

void QtxTreeView::emitSortingEnabled ( bool enabled )

private

Emit sortingEnabled(bool) signal.

Parameters

enabled "enable sorting" flag state

References sortingEnabled().

◆ expandAll()

void QtxTreeView::expandAll ( const QModelIndex & index )

Expand the branch specifed by the \index and all its children recursively.

Parameters

index model index to be expanded

See also: collapseAll()

References setOpened().

◆ expandLevels()

void QtxTreeView::expandLevels ( const int levels )

Expand all branches for specified number of levels.

If levels < 0, all branches are expanded (the same results can be achieved with expandAll() method).

Parameters

levels number of levels to be opened

See also: collapseLevels(), setOpened()

References setOpened().

◆ onAppropriate

void QtxTreeView::onAppropriate	(	Qt::Orientation	orient,
		int	first,
		int	last
	)

protectedslot

References Qtx::AppropriateRole, Qtx::Hidden, and Horizontal.

◆ onHeaderClicked

void QtxTreeView::onHeaderClicked ( int column )

protectedslot

◆ resizeColumnToEncloseContents()

void QtxTreeView::resizeColumnToEncloseContents ( int column )

Resizes the given column in order to enclose its contents. The size will be changed only if it is smaller than the size of contents.

Parameters

column number of column

◆ rowsAboutToBeRemoved

void QtxTreeView::rowsAboutToBeRemoved	(	const QModelIndex &	parent,
		int	start,
		int	end
	)

protectedslot

Called when rows are about to be removed.

Parameters

parent	model index
start	first row to remove
end	last row to remove

◆ scrollTo()

void QtxTreeView::scrollTo	(	const QModelIndex &	index,
		QAbstractItemView::ScrollHint	hint = `QAbstractItemView::EnsureVisible`
	)

virtual

◆ selectionChanged [1/2]

QtxTreeView::selectionChanged ( )

signal

Emitted when selection is changed in the tree view.

◆ selectionChanged [2/2]

void QtxTreeView::selectionChanged	(	const QItemSelection &	selected,
		const QItemSelection &	deselected
	)

protectedslot

Called when the selection is changed.

Emits selectionChanged() signal.

Parameters

selected	new selection
deselected	previous selection

References selectionChanged().

◆ setModel()

void QtxTreeView::setModel ( QAbstractItemModel * m )

virtual

References onAppropriate().

◆ setOpened()

void QtxTreeView::setOpened	(	const QModelIndex &	index,
		const int	levels,
		bool	open
	)

protected

Expand/collapse the specified item (recursively).

Parameters

index	model index
levels	number of levels to be expanded/collapsed
open	if `true`, item is expanded, otherwise it is collapsed

See also: expandLevels(), collapseLevels()

◆ setSortMenuEnabled()

void QtxTreeView::setSortMenuEnabled ( const bool enableSortMenu )

References QtxTreeView::Header::setSortMenuEnabled().

◆ sortingEnabled

QtxTreeView::sortingEnabled ( bool on )

signal

Emitted when "Sorting" commans is enabled/disabled from the popup menu.

Parameters

on	`true` if sorting is enabled and `false` otherwise

◆ sortMenuEnabled()

bool QtxTreeView::sortMenuEnabled ( ) const

References QtxTreeView::Header::sortMenuEnabled().

Friends And Related Function Documentation

◆ QtxTreeView::Header

friend class QtxTreeView::Header

friend

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

src/Qtx/QtxTreeView.h
src/Qtx/QtxTreeView.cxx

Classes

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ QtxTreeView() [1/2]

◆ QtxTreeView() [2/2]

◆ ~QtxTreeView()

Member Function Documentation

◆ collapseAll()

◆ collapseLevels()

◆ emitSortingEnabled()

◆ expandAll()

◆ expandLevels()

◆ onAppropriate

◆ onHeaderClicked

◆ resizeColumnToEncloseContents()

◆ rowsAboutToBeRemoved

◆ scrollTo()

◆ selectionChanged [1/2]

◆ selectionChanged [2/2]

◆ setModel()

◆ setOpened()

◆ setSortMenuEnabled()

◆ sortingEnabled

◆ sortMenuEnabled()

Friends And Related Function Documentation

◆ QtxTreeView::Header