QtTreePropertyBrowser Class Reference

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

#include <qttreepropertybrowser.h>

Inheritance diagram for QtTreePropertyBrowser:

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

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.

\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

Constructor & Destructor Documentation

QtTreePropertyBrowser()

QtTreePropertyBrowser::QtTreePropertyBrowser

(

QWidget *

parent = nullptr

)

Creates a property browser with the given parent.

References QtAbstractPropertyBrowser::currentItemChanged(), and QtTreePropertyBrowserPrivate::init().

Here is the call graph for this function:

~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

Member Function Documentation

alternatingRowColors()

bool QtTreePropertyBrowser::alternatingRowColors

(

)

const

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

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

Here is the call graph for this function:

collapsed

void QtTreePropertyBrowser::collapsed ( QtBrowserItem *  item )

signal

This signal is emitted when the item is collapsed.

See also

expanded(), setExpanded()

Referenced by QtTreePropertyBrowserPrivate::slotCollapsed().

Here is the caller graph for this function:

editItem()

void QtTreePropertyBrowser::editItem

(

QtBrowserItem *

item

)

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

References QtTreePropertyBrowserPrivate::editItem().

Here is the call graph for this function:

expanded

void QtTreePropertyBrowser::expanded ( QtBrowserItem *  item )

signal

This signal is emitted when the item is expanded.

See also

collapsed(), setExpanded()

Referenced by setExpanded(), and QtTreePropertyBrowserPrivate::slotExpanded().

Here is the caller graph for this function:

indentation()

int QtTreePropertyBrowser::indentation

(

)

const

isExpanded()

bool QtTreePropertyBrowser::isExpanded

(

QtBrowserItem *

item

)

const

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

See also

setExpanded()

isHeaderVisible()

bool QtTreePropertyBrowser::isHeaderVisible

(

)

const

isItemVisible()

bool QtTreePropertyBrowser::isItemVisible

(

QtBrowserItem *

item

)

const

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

See also

setItemVisible()

Since

4.5

itemChanged()

void QtTreePropertyBrowser::itemChanged ( QtBrowserItem *  item )

overrideprotectedvirtual

\reimp

Implements QtAbstractPropertyBrowser.

References QtTreePropertyBrowserPrivate::propertyChanged().

Here is the call graph for this function:

itemInserted()

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

overrideprotectedvirtual

\reimp

Implements QtAbstractPropertyBrowser.

References QtTreePropertyBrowserPrivate::propertyInserted().

Here is the call graph for this function:

itemRemoved()

void QtTreePropertyBrowser::itemRemoved ( QtBrowserItem *  item )

overrideprotectedvirtual

\reimp

Implements QtAbstractPropertyBrowser.

References QtTreePropertyBrowserPrivate::propertyRemoved().

Here is the call graph for this function:

propertiesWithoutValueMarked()

bool QtTreePropertyBrowser::propertiesWithoutValueMarked

(

)

const

resizeMode()

QtTreePropertyBrowser::ResizeMode QtTreePropertyBrowser::resizeMode

(

)

const

rootIsDecorated()

bool QtTreePropertyBrowser::rootIsDecorated

(

)

const

setAlternatingRowColors()

void QtTreePropertyBrowser::setAlternatingRowColors

(

bool

enable

)

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

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

setHeaderVisible()

void QtTreePropertyBrowser::setHeaderVisible

(

bool

visible

)

setIndentation()

void QtTreePropertyBrowser::setIndentation

(

int

i

)

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

setPropertiesWithoutValueMarked()

void QtTreePropertyBrowser::setPropertiesWithoutValueMarked

(

bool

mark

)

Referenced by main().

Here is the caller graph for this function:

setResizeMode()

void QtTreePropertyBrowser::setResizeMode

(

QtTreePropertyBrowser::ResizeMode

mode

)

setRootIsDecorated()

void QtTreePropertyBrowser::setRootIsDecorated

(

bool

show

)

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

Here is the caller graph for this function:

setSplitterPosition()

void QtTreePropertyBrowser::setSplitterPosition

(

int

position

)

splitterPosition()

int QtTreePropertyBrowser::splitterPosition

(

)

const

Property Documentation

alternatingRowColors

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

QtTreePropertyBrowser::indentation

readwrite

indentation of the items in the tree view.

propertiesWithoutValueMarked

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

readwrite

the resize mode of setions in the header.

rootIsDecorated

QtTreePropertyBrowser::rootIsDecorated

readwrite

whether to show controls for expanding and collapsing root items.

splitterPosition

QtTreePropertyBrowser::splitterPosition

readwrite

the position of the splitter between the colunms.

---

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

• qttreepropertybrowser.h
• qttreepropertybrowser.cpp