The description of this class will come soon ! More...

#include <qttreepropertybrowser.h>

Public Types
enum	ResizeMode { Interactive, Stretch, Fixed, ResizeToContents }

Signals
void	collapsed (QtBrowserItem *item)

void	expanded (QtBrowserItem *item)

Signals inherited from QtAbstractPropertyBrowser
void	currentItemChanged (QtBrowserItem *)

Public Member Functions
bool	alternatingRowColors () const

QColor	backgroundColor (QtBrowserItem *item) const

QColor	calculatedBackgroundColor (QtBrowserItem *item) const

void	editItem (QtBrowserItem *item)

int	indentation () const

bool	isExpanded (QtBrowserItem *item) const

bool	isHeaderVisible () const

bool	isItemVisible (QtBrowserItem *item) const

bool	propertiesWithoutValueMarked () const

	QtTreePropertyBrowser (QWidget *parent=nullptr)

ResizeMode	resizeMode () const

bool	rootIsDecorated () const

void	setAlternatingRowColors (bool enable)

void	setBackgroundColor (QtBrowserItem *item, const QColor &color)

void	setExpanded (QtBrowserItem *item, bool expanded)

void	setHeaderVisible (bool visible)

void	setIndentation (int i)

void	setItemVisible (QtBrowserItem *item, bool visible)

void	setPropertiesWithoutValueMarked (bool mark)

void	setResizeMode (ResizeMode mode)

void	setRootIsDecorated (bool show)

void	setSplitterPosition (int position)

int	splitterPosition () const

	~QtTreePropertyBrowser () override

Public Member Functions inherited from QtAbstractPropertyBrowser
void	clear ()

QtBrowserItem *	currentItem () const

QList< QtBrowserItem * >	items (QtProperty *property) const

QList< QtProperty * >	properties () const

	QtAbstractPropertyBrowser (QWidget *parent=nullptr)

void	setCurrentItem (QtBrowserItem *)

template<class PropertyManager >
void	setFactoryForManager (PropertyManager manager, QtAbstractEditorFactory< PropertyManager > factory)

QtBrowserItem *	topLevelItem (QtProperty *property) const

QList< QtBrowserItem * >	topLevelItems () const

void	unsetFactoryForManager (QtAbstractPropertyManager *manager)

	~QtAbstractPropertyBrowser () override

Protected Member Functions
void	itemChanged (QtBrowserItem *item) override

void	itemInserted (QtBrowserItem item, QtBrowserItem afterItem) override

void	itemRemoved (QtBrowserItem *item) override

Protected Member Functions inherited from QtAbstractPropertyBrowser
virtual QWidget *	createEditor (QtProperty property, QWidget parent)

Properties
bool	alternatingRowColors
	whether to draw the background using alternating colors. By default this property is set to true. More...

bool	headerVisible
	whether to show the header. More...

int	indentation
	indentation of the items in the tree view. More...

bool	propertiesWithoutValueMarked
	whether to enable or disable marking properties without value. More...

ResizeMode	resizeMode
	the resize mode of setions in the header. More...

bool	rootIsDecorated
	whether to show controls for expanding and collapsing root items. More...

int	splitterPosition
	the position of the splitter between the colunms. More...

Private Member Functions
	Q_PRIVATE_SLOT (d_func(), void slotCollapsed(const QModelIndex &)) Q_PRIVATE_SLOT(d_func()

void void	slotCurrentBrowserItemChanged (QtBrowserItem *)) Q_PRIVATE_SLOT(d_func()

void	slotExpanded (const QModelIndex &)) Q_PRIVATE_SLOT(d_func()

Private Attributes
QtTreePropertyBrowserPrivate *	d_ptr

Additional Inherited Members
Public Slots inherited from QtAbstractPropertyBrowser
QtBrowserItem *	addProperty (QtProperty *property)

QtBrowserItem *	insertProperty (QtProperty property, QtProperty afterProperty)

void	removeProperty (QtProperty *property)

Detailed Description

The description of this class will come soon !

The QtTreePropertyBrowser class provides QTreeWidget based property browser.

A property browser is a widget that enables the user to edit a given set of properties. Each property is represented by a label specifying the property's name, and an editing widget (e.g. a line edit or a combobox) holding its value. A property can have zero or more subproperties.

QtTreePropertyBrowser provides a tree based view for all nested properties, i.e. properties that have subproperties can be in an expanded (subproperties are visible) or collapsed (subproperties are hidden) state. For example:

Use the QtAbstractPropertyBrowser API to add, insert and remove properties from an instance of the QtTreePropertyBrowser class. The properties themselves are created and managed by implementations of the QtAbstractPropertyManager class.

See also: QtGroupBoxPropertyBrowser, QtAbstractPropertyBrowser

Member Enumeration Documentation

◆ ResizeMode

enum QtTreePropertyBrowser::ResizeMode

The resize mode specifies the behavior of the header sections.

Interactive The user can resize the sections. The sections can also be resized programmatically using setSplitterPosition().

Fixed The user cannot resize the section. The section can only be resized programmatically using setSplitterPosition().

Stretch QHeaderView will automatically resize the section to fill the available space. The size cannot be changed by the user or programmatically.

ResizeToContents QHeaderView will automatically resize the section to its optimal size based on the contents of the entire column. The size cannot be changed by the user or programmatically.

See also: setResizeMode()

Enumerator
Interactive
Stretch
Fixed
ResizeToContents

Constructor & Destructor Documentation

◆ QtTreePropertyBrowser()

QtTreePropertyBrowser::QtTreePropertyBrowser ( QWidget * parent = nullptr )

Creates a property browser with the given parent.

References QtAbstractPropertyBrowser::currentItemChanged(), d_ptr, QtTreePropertyBrowserPrivate::init(), QtTreePropertyBrowserPrivate::q_ptr, and slotCurrentBrowserItemChanged().

◆ ~QtTreePropertyBrowser()

QtTreePropertyBrowser::~QtTreePropertyBrowser ( )

override

Destroys this property browser.

Note that the properties that were inserted into this browser are not destroyed since they may still be used in other browsers. The properties are owned by the manager that created them.

See also: QtProperty, QtAbstractPropertyManager

References d_ptr, indentation(), and QtTreePropertyBrowserPrivate::m_treeWidget.

Member Function Documentation

◆ alternatingRowColors()

bool QtTreePropertyBrowser::alternatingRowColors ( ) const

Referenced by setRootIsDecorated().

◆ backgroundColor()

QColor QtTreePropertyBrowser::backgroundColor ( QtBrowserItem * item ) const

Returns the item's color. If there is no color set for item it returns invalid color.

See also: calculatedBackgroundColor(), setBackgroundColor()

References d_ptr, and QtTreePropertyBrowserPrivate::m_indexToBackgroundColor.

◆ calculatedBackgroundColor()

QColor QtTreePropertyBrowser::calculatedBackgroundColor ( QtBrowserItem * item ) const

Returns the item's color. If there is no color set for item it returns parent item's color (if there is no color set for parent it returns grandparent's color and so on). In case the color is not set for item and it's top level item it returns invalid color.

See also: backgroundColor(), setBackgroundColor()

References QtTreePropertyBrowserPrivate::calculatedBackgroundColor(), and d_ptr.

◆ collapsed

void QtTreePropertyBrowser::collapsed ( QtBrowserItem * item )

signal

This signal is emitted when the item is collapsed.

See also: expanded(), setExpanded()

◆ editItem()

void QtTreePropertyBrowser::editItem ( QtBrowserItem * item )

Sets the current item to item and opens the relevant editor for it.

References d_ptr, and QtTreePropertyBrowserPrivate::editItem().

◆ expanded

void QtTreePropertyBrowser::expanded ( QtBrowserItem * item )

signal

This signal is emitted when the item is expanded.

See also: collapsed(), setExpanded()

◆ indentation()

int QtTreePropertyBrowser::indentation ( ) const

Referenced by ~QtTreePropertyBrowser().

◆ isExpanded()

bool QtTreePropertyBrowser::isExpanded ( QtBrowserItem * item ) const

Returns true if the item is expanded; otherwise returns false.

See also: setExpanded()

References d_ptr, and QtTreePropertyBrowserPrivate::m_indexToItem.

Referenced by MainWindow::updateExpandState().

◆ isHeaderVisible()

bool QtTreePropertyBrowser::isHeaderVisible ( ) const

References d_ptr, and QtTreePropertyBrowserPrivate::m_headerVisible.

◆ isItemVisible()

bool QtTreePropertyBrowser::isItemVisible ( QtBrowserItem * item ) const

Returns true if the item is visible; otherwise returns false.

See also: setItemVisible()

Since: 4.5

References d_ptr, and QtTreePropertyBrowserPrivate::m_indexToItem.

◆ itemChanged()

void QtTreePropertyBrowser::itemChanged ( QtBrowserItem * item )

overrideprotectedvirtual

Implements QtAbstractPropertyBrowser.

References d_ptr, and QtTreePropertyBrowserPrivate::propertyChanged().

◆ itemInserted()

void QtTreePropertyBrowser::itemInserted	(	QtBrowserItem *	item,
		QtBrowserItem *	afterItem
	)

overrideprotectedvirtual

Implements QtAbstractPropertyBrowser.

References d_ptr, and QtTreePropertyBrowserPrivate::propertyInserted().

◆ itemRemoved()

void QtTreePropertyBrowser::itemRemoved ( QtBrowserItem * item )

overrideprotectedvirtual

Implements QtAbstractPropertyBrowser.

References d_ptr, and QtTreePropertyBrowserPrivate::propertyRemoved().

◆ propertiesWithoutValueMarked()

bool QtTreePropertyBrowser::propertiesWithoutValueMarked ( ) const

Referenced by setPropertiesWithoutValueMarked().

◆ Q_PRIVATE_SLOT()

QtTreePropertyBrowser::Q_PRIVATE_SLOT	(	d_func()	,
		void	slotCollapsedconst QModelIndex &
	)

private

◆ resizeMode()

ResizeMode QtTreePropertyBrowser::resizeMode ( ) const

Referenced by setHeaderVisible().

◆ rootIsDecorated()

bool QtTreePropertyBrowser::rootIsDecorated ( ) const

Referenced by setIndentation().

◆ setAlternatingRowColors()

void QtTreePropertyBrowser::setAlternatingRowColors ( bool enable )

References d_ptr, QtTreePropertyBrowserPrivate::m_itemToIndex, and QtTreePropertyBrowserPrivate::m_treeWidget.

◆ setBackgroundColor()

void QtTreePropertyBrowser::setBackgroundColor	(	QtBrowserItem *	item,
		const QColor &	color
	)

Sets the item's background color to color. Note that while item's background is rendered every second row is being drawn with alternate color (which is a bit lighter than items color)

See also: backgroundColor(), calculatedBackgroundColor()

References d_ptr, QtTreePropertyBrowserPrivate::m_indexToBackgroundColor, QtTreePropertyBrowserPrivate::m_indexToItem, and QtTreePropertyBrowserPrivate::m_treeWidget.

◆ setExpanded()

void QtTreePropertyBrowser::setExpanded	(	QtBrowserItem *	item,
		bool	expanded
	)

Sets the item to either collapse or expanded, depending on the value of expanded.

See also: isExpanded(), expanded(), collapsed()

References d_ptr, and QtTreePropertyBrowserPrivate::m_indexToItem.

Referenced by MainWindow::addProperty().

◆ setHeaderVisible()

void QtTreePropertyBrowser::setHeaderVisible ( bool visible )

References d_ptr, QtTreePropertyBrowserPrivate::m_headerVisible, QtTreePropertyBrowserPrivate::m_resizeMode, QtTreePropertyBrowserPrivate::m_treeWidget, and resizeMode().

◆ setIndentation()

void QtTreePropertyBrowser::setIndentation ( int i )

References d_ptr, QtTreePropertyBrowserPrivate::m_treeWidget, and rootIsDecorated().

◆ setItemVisible()

void QtTreePropertyBrowser::setItemVisible	(	QtBrowserItem *	item,
		bool	visible
	)

Sets the item to be visible, depending on the value of visible.

See also: isItemVisible()

Since: 4.5

References d_ptr, and QtTreePropertyBrowserPrivate::m_indexToItem.

◆ setPropertiesWithoutValueMarked()

void QtTreePropertyBrowser::setPropertiesWithoutValueMarked ( bool mark )

References d_ptr, QtTreePropertyBrowserPrivate::m_itemToIndex, QtTreePropertyBrowserPrivate::m_markPropertiesWithoutValue, QtTreePropertyBrowserPrivate::m_treeWidget, propertiesWithoutValueMarked(), and QtTreePropertyBrowserPrivate::updateItem().

Referenced by main().

◆ setResizeMode()

void QtTreePropertyBrowser::setResizeMode ( QtTreePropertyBrowser::ResizeMode mode )

References d_ptr, Fixed, Interactive, QtTreePropertyBrowserPrivate::m_resizeMode, QtTreePropertyBrowserPrivate::m_treeWidget, ResizeToContents, splitterPosition(), and Stretch.

◆ setRootIsDecorated()

void QtTreePropertyBrowser::setRootIsDecorated ( bool show )

References alternatingRowColors(), d_ptr, QtTreePropertyBrowserPrivate::m_itemToIndex, QtTreePropertyBrowserPrivate::m_treeWidget, and QtTreePropertyBrowserPrivate::updateItem().

Referenced by main(), and ObjectController::ObjectController().

◆ setSplitterPosition()

void QtTreePropertyBrowser::setSplitterPosition ( int position )

References d_ptr, and QtTreePropertyBrowserPrivate::m_treeWidget.

◆ slotCurrentBrowserItemChanged()

void void QtTreePropertyBrowser::slotCurrentBrowserItemChanged ( QtBrowserItem * )

private

Referenced by QtTreePropertyBrowser().

◆ slotExpanded()

void QtTreePropertyBrowser::slotExpanded ( const QModelIndex & )

private

◆ splitterPosition()

int QtTreePropertyBrowser::splitterPosition ( ) const

Referenced by setResizeMode().

Member Data Documentation

◆ d_ptr

Property Documentation

◆ alternatingRowColors

bool QtTreePropertyBrowser::alternatingRowColors

readwrite

whether to draw the background using alternating colors. By default this property is set to true.

◆ headerVisible

QtTreePropertyBrowser::headerVisible

readwrite

whether to show the header.

◆ indentation

int QtTreePropertyBrowser::indentation

readwrite

indentation of the items in the tree view.

◆ propertiesWithoutValueMarked

bool QtTreePropertyBrowser::propertiesWithoutValueMarked

readwrite

whether to enable or disable marking properties without value.

When marking is enabled the item's background is rendered in dark color and item's foreground is rendered with light color.

See also: propertiesWithoutValueMarked()

◆ resizeMode

QtTreePropertyBrowser::ResizeMode QtTreePropertyBrowser::resizeMode

readwrite

the resize mode of setions in the header.

◆ rootIsDecorated

bool QtTreePropertyBrowser::rootIsDecorated

readwrite

whether to show controls for expanding and collapsing root items.

◆ splitterPosition

int QtTreePropertyBrowser::splitterPosition

readwrite

the position of the splitter between the colunms.

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

Public Types

Signals

Public Member Functions

Protected Member Functions

Properties

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ResizeMode

Constructor & Destructor Documentation

◆ QtTreePropertyBrowser()

◆ ~QtTreePropertyBrowser()

Member Function Documentation

◆ alternatingRowColors()

◆ backgroundColor()

◆ calculatedBackgroundColor()

◆ collapsed

◆ editItem()

◆ expanded

◆ indentation()

◆ isExpanded()

◆ isHeaderVisible()

◆ isItemVisible()

◆ itemChanged()

◆ itemInserted()

◆ itemRemoved()

◆ propertiesWithoutValueMarked()

◆ Q_PRIVATE_SLOT()

◆ resizeMode()

◆ rootIsDecorated()

◆ setAlternatingRowColors()

◆ setBackgroundColor()

◆ setExpanded()

◆ setHeaderVisible()

◆ setIndentation()

◆ setItemVisible()

◆ setPropertiesWithoutValueMarked()

◆ setResizeMode()

◆ setRootIsDecorated()

◆ setSplitterPosition()

◆ slotCurrentBrowserItemChanged()

◆ slotExpanded()

◆ splitterPosition()

Member Data Documentation

◆ d_ptr

Property Documentation

◆ alternatingRowColors

◆ headerVisible

◆ indentation

◆ propertiesWithoutValueMarked

◆ resizeMode

◆ rootIsDecorated

◆ splitterPosition