QtButtonPropertyBrowser Class Reference

The QtButtonPropertyBrowser class provides a drop down QToolButton based property browser. More...

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

+ Inheritance diagram for QtButtonPropertyBrowser:

Signals

void collapsed (QtBrowserItem *item)
 
void expanded (QtBrowserItem *item)
 
- Signals inherited from QtAbstractPropertyBrowser
void currentItemChanged (QtBrowserItem *)
 

Public Member Functions

bool isExpanded (QtBrowserItem *item) const
 
 QtButtonPropertyBrowser (QWidget *parent=0)
 
void setExpanded (QtBrowserItem *item, bool expanded)
 
 ~QtButtonPropertyBrowser () 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)
 

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 QtButtonPropertyBrowser class provides a drop down QToolButton 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.

QtButtonPropertyBrowser provides drop down button for all nested properties, i.e. subproperties are enclosed by a container associated with the drop down button. The parent property's name is displayed as button text. For example:

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

See also
QtTreePropertyBrowser, QtAbstractPropertyBrowser

Constructor & Destructor Documentation

◆ QtButtonPropertyBrowser()

QtButtonPropertyBrowser ( QWidget * parent = 0)

Creates a property browser with the given parent.

◆ ~QtButtonPropertyBrowser()

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

◆ collapsed

void collapsed ( QtBrowserItem * item)
signal

This signal is emitted when the item is collapsed.

See also
expanded(), setExpanded()

◆ expanded

void expanded ( QtBrowserItem * item)
signal

This signal is emitted when the item is expanded.

See also
collapsed(), setExpanded()

◆ isExpanded()

bool isExpanded ( QtBrowserItem * item) const

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

See also
setExpanded()

◆ itemChanged()

void itemChanged ( QtBrowserItem * item)
overrideprotectedvirtual

\reimp

Implements QtAbstractPropertyBrowser.

◆ itemInserted()

void itemInserted ( QtBrowserItem * item,
QtBrowserItem * afterItem )
overrideprotectedvirtual

\reimp

Implements QtAbstractPropertyBrowser.

◆ itemRemoved()

void itemRemoved ( QtBrowserItem * item)
overrideprotectedvirtual

\reimp

Implements QtAbstractPropertyBrowser.

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

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