The QtTreePropertyBrowser class provides QTreeWidget based property browser. More...

#include <ArmarXGui/libraries/qtpropertybrowser/src/qttreepropertybrowser.h>

Inheritance diagram for QtTreePropertyBrowser:

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=0)

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=0)

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

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

Definition at line 51 of file qttreepropertybrowser.h.

Member Enumeration Documentation

◆ ResizeMode

enum ResizeMode

The resize mode specifies the behavior of the header sections.

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

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

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

\value 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

Definition at line 64 of file qttreepropertybrowser.h.

Constructor & Destructor Documentation

◆ QtTreePropertyBrowser()

QtTreePropertyBrowser ( QWidget * parent = 0 )

Creates a property browser with the given parent.

Definition at line 941 of file qttreepropertybrowser.cpp.

Here is the call graph for this function:

◆ ~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

Definition at line 961 of file qttreepropertybrowser.cpp.

Member Function Documentation

◆ alternatingRowColors()

bool alternatingRowColors ( ) const

◆ backgroundColor()

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

Definition at line 1218 of file qttreepropertybrowser.cpp.

◆ calculatedBackgroundColor()

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

Definition at line 1231 of file qttreepropertybrowser.cpp.

Here is the call graph for this function:

◆ collapsed

void collapsed ( QtBrowserItem * item )

signal

This signal is emitted when the item is collapsed.

See also: expanded(), setExpanded()

Here is the caller graph for this function:

◆ editItem()

void editItem ( QtBrowserItem * item )

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

Definition at line 1300 of file qttreepropertybrowser.cpp.

Here is the call graph for this function:

◆ expanded

void expanded ( QtBrowserItem * item )

signal

This signal is emitted when the item is expanded.

See also: collapsed(), setExpanded()

Here is the caller graph for this function:

◆ indentation()

int indentation ( ) const

◆ isExpanded()

bool isExpanded ( QtBrowserItem * item ) const

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

See also: setExpanded()

Definition at line 1142 of file qttreepropertybrowser.cpp.

◆ isHeaderVisible()

bool isHeaderVisible ( ) const

Definition at line 1025 of file qttreepropertybrowser.cpp.

◆ isItemVisible()

bool isItemVisible ( QtBrowserItem * item ) const

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

See also: setItemVisible()

Since: 4.5

Definition at line 1161 of file qttreepropertybrowser.cpp.

◆ itemChanged()

void itemChanged ( QtBrowserItem * item )

overrideprotectedvirtual

\reimp

Implements QtAbstractPropertyBrowser.

Definition at line 1292 of file qttreepropertybrowser.cpp.

Here is the call graph for this function:

◆ itemInserted()

void itemInserted	(	QtBrowserItem *	item,
		QtBrowserItem *	afterItem
	)

overrideprotectedvirtual

\reimp

Implements QtAbstractPropertyBrowser.

Definition at line 1276 of file qttreepropertybrowser.cpp.

Here is the call graph for this function:

◆ itemRemoved()

void itemRemoved ( QtBrowserItem * item )

overrideprotectedvirtual

\reimp

Implements QtAbstractPropertyBrowser.

Definition at line 1284 of file qttreepropertybrowser.cpp.

Here is the call graph for this function:

◆ propertiesWithoutValueMarked()

bool propertiesWithoutValueMarked ( ) const

◆ resizeMode()

ResizeMode resizeMode ( ) const

◆ rootIsDecorated()

bool rootIsDecorated ( ) const

◆ setAlternatingRowColors()

void setAlternatingRowColors ( bool enable )

Definition at line 1015 of file qttreepropertybrowser.cpp.

◆ setBackgroundColor()

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

Definition at line 1193 of file qttreepropertybrowser.cpp.

◆ setExpanded()

void setExpanded	(	QtBrowserItem *	item,
		bool	expanded
	)

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

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

Definition at line 1126 of file qttreepropertybrowser.cpp.

◆ setHeaderVisible()

void setHeaderVisible ( bool visible )

Definition at line 1030 of file qttreepropertybrowser.cpp.

Here is the caller graph for this function:

◆ setIndentation()

void setIndentation ( int i )

Definition at line 975 of file qttreepropertybrowser.cpp.

◆ setItemVisible()

void setItemVisible	(	QtBrowserItem *	item,
		bool	visible
	)

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

See also: isItemVisible()

Since: 4.5

Definition at line 1178 of file qttreepropertybrowser.cpp.

◆ setPropertiesWithoutValueMarked()

void setPropertiesWithoutValueMarked ( bool mark )

Definition at line 1245 of file qttreepropertybrowser.cpp.

Here is the caller graph for this function:

◆ setResizeMode()

void setResizeMode ( QtTreePropertyBrowser::ResizeMode mode )

Definition at line 1072 of file qttreepropertybrowser.cpp.

◆ setRootIsDecorated()

void setRootIsDecorated ( bool show )

Definition at line 989 of file qttreepropertybrowser.cpp.

Here is the caller graph for this function:

◆ setSplitterPosition()

void setSplitterPosition ( int position )

Definition at line 1115 of file qttreepropertybrowser.cpp.

◆ splitterPosition()

int splitterPosition ( ) const

Property Documentation

◆ alternatingRowColors

bool alternatingRowColors

readwrite

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

Definition at line 57 of file qttreepropertybrowser.h.

◆ headerVisible

headerVisible

readwrite

whether to show the header.

Definition at line 58 of file qttreepropertybrowser.h.

◆ indentation

int indentation

readwrite

indentation of the items in the tree view.

Definition at line 55 of file qttreepropertybrowser.h.

◆ propertiesWithoutValueMarked

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

Definition at line 61 of file qttreepropertybrowser.h.

◆ resizeMode

QtTreePropertyBrowser::ResizeMode resizeMode

readwrite

the resize mode of setions in the header.

Definition at line 59 of file qttreepropertybrowser.h.

◆ rootIsDecorated

bool rootIsDecorated

readwrite

whether to show controls for expanding and collapsing root items.

Definition at line 56 of file qttreepropertybrowser.h.

◆ splitterPosition

int splitterPosition

readwrite

the position of the splitter between the colunms.

Definition at line 60 of file qttreepropertybrowser.h.

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

ArmarXGui/libraries/qtpropertybrowser/src/qttreepropertybrowser.h
ArmarXGui/libraries/qtpropertybrowser/src/qttreepropertybrowser.cpp

Public Types

Signals

Public Member Functions

Protected Member Functions

Properties

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

◆ resizeMode()

◆ rootIsDecorated()

◆ setAlternatingRowColors()

◆ setBackgroundColor()

◆ setExpanded()

◆ setHeaderVisible()

◆ setIndentation()

◆ setItemVisible()

◆ setPropertiesWithoutValueMarked()

◆ setResizeMode()

◆ setRootIsDecorated()

◆ setSplitterPosition()

◆ splitterPosition()

Property Documentation

◆ alternatingRowColors

◆ headerVisible

◆ indentation

◆ propertiesWithoutValueMarked

◆ resizeMode

◆ rootIsDecorated

◆ splitterPosition