Editable Enum property. More...

#include <editable_enum_property.h>

Inheritance diagram for rviz::EditableEnumProperty:

[legend]

Public Slots
virtual void	setString (const QString &str)

Public Slots inherited from rviz::StringProperty
bool	setStdString (const std::string &std_str)

bool	setString (const QString &str)

Signals
void	requestOptions (EditableEnumProperty *property_in_need_of_options)
	requestOptions() is emitted each time createEditor() is called. More...

Signals inherited from rviz::Property
void	aboutToChange ()
	Emitted by setValue() just before the value has changed. More...

void	changed ()
	Emitted by setValue() just after the value has changed. More...

void	childListChanged (Property *this_property)
	Emitted after insertions and deletions of child Properties. More...

Public Member Functions
virtual void	addOption (const QString &option)

void	addOptionStd (const std::string &option)

virtual void	clearOptions ()

QWidget *	createEditor (QWidget *parent, const QStyleOptionViewItem &option) override
	Create an editor widget to edit the value of this property. More...

template<typename Func , typename P >
	EditableEnumProperty (const QString &name, const QString &default_value, const QString &description, P *parent, Func &&changed_slot)

template<typename Func , typename R >
	EditableEnumProperty (const QString &name, const QString &default_value, const QString &description, Property parent, Func &&changed_slot, const R receiver)

	EditableEnumProperty (const QString &name=QString(), const QString &default_value=QString(), const QString &description=QString(), Property *parent=nullptr)

void	sortOptions ()
	Sort the option strings. More...

Public Member Functions inherited from rviz::StringProperty
std::string	getStdString ()

QString	getString ()

template<typename Func , typename P >
	StringProperty (const QString &name, const QString &default_value, const QString &description, P *parent, Func &&changed_slot)

template<typename Func , typename R >
	StringProperty (const QString &name, const QString &default_value, const QString &description, Property parent, Func &&changed_slot, const R receiver)

	StringProperty (const QString &name=QString(), const QString &default_value=QString(), const QString &description=QString(), Property *parent=nullptr)

Public Member Functions inherited from rviz::Property
virtual void	addChild (Property *child, int index=-1)
	Add a child property. More...

Property *	childAt (int index) const
	Return the child Property with the given index, or NULL if the index is out of bounds or if the child at that index is not a Property. More...

virtual Property *	childAtUnchecked (int index) const
	Return the child Property with the given index, without checking whether the index is within bounds. More...

virtual void	collapse ()
	Collapse (hide the children of) this Property. More...

template<typename Func >
std::enable_if<!QtPrivate::FunctionPointer< Func >::IsPointerToMemberFunction, QMetaObject::Connection >::type	connect (const QObject *context, Func &&slot, Qt::ConnectionType type=Qt::AutoConnection)
	Connect changed() signal to given slot functor, considering context. More...

QMetaObject::Connection	connect (const QObject receiver, const char slot, Qt::ConnectionType type=Qt::AutoConnection)
	Connect changed() signal to given slot of receiver. More...

template<typename Func , typename R >
std::enable_if< QtPrivate::FunctionPointer< Func >::IsPointerToMemberFunction, QMetaObject::Connection >::type	connect (const R *receiver, Func &&slot, Qt::ConnectionType type=Qt::AutoConnection)
	Connect changed() signal to given slot member function of receiver object. More...

template<typename Func >
std::enable_if<!QtPrivate::FunctionPointer< Func >::IsPointerToMemberFunction, QMetaObject::Connection >::type	connect (Func &&slot, Qt::ConnectionType type=Qt::AutoConnection)
	Connect changed() signal to given slot functor, using this as context. More...

bool	contains (Property *possible_child) const
	Return true if the list of children includes possible_child, false if not. More...

virtual void	expand ()
	Expand (show the children of) this Property. More...

virtual QString	getDescription () const
	Return the description. More...

virtual bool	getDisableChildren ()
	If true, the children of this property should set their ItemIsEnabled flag to false. More...

virtual bool	getHidden () const
	Return the hidden/shown state. True means hidden, false means visible. More...

virtual QIcon	getIcon () const

PropertyTreeModel *	getModel () const
	Return the model managing this Property and its childrent. More...

virtual QString	getName () const
	Return the name of this Property as a QString. More...

std::string	getNameStd () const
	Return the name of this Property as a std::string. More...

Property *	getParent () const
	Return the parent Property. More...

virtual bool	getReadOnly () const
	Return the read-only-ness of this property. More...

virtual QVariant	getValue () const
	Return the value of this Property as a QVariant. If the value has never been set, an invalid QVariant is returned. More...

virtual QVariant	getViewData (int column, int role) const
	Return data appropriate for the given column (0 or 1) and role for this Property. More...

virtual Qt::ItemFlags	getViewFlags (int column) const
	Return item flags appropriate for the given column (0 or 1) for this Property. More...

void	hide ()
	Hide this Property in any PropertyTreeWidgets. More...

void	insertChildSorted (Property *child)
	Insert a child property, sorted by name. More...

bool	isAncestorOf (Property *possible_child) const
	Returns true if `this` is an ancestor of possible_child, meaning is the parent or parent of parent etc. More...

virtual void	load (const Config &config)
	Load the value of this property and/or its children from the given Config reference. More...

virtual void	moveChild (int from_index, int to_index)
	Move the child at from_index to to_index. More...

virtual int	numChildren () const
	Return the number of child objects (Property or otherwise). More...

virtual bool	paint (QPainter *painter, const QStyleOptionViewItem &option) const
	Hook to provide custom painting of the value data (right-hand column) in a subclass. More...

template<typename Func , typename P >
	Property (const QString &name, const QVariant &default_value, const QString &description, P *parent, Func &&changed_slot)

template<typename Func , typename R >
	Property (const QString &name, const QVariant &default_value, const QString &description, Property parent, Func &&changed_slot, const R receiver)

	Property (const QString &name=QString(), const QVariant &default_value=QVariant(), const QString &description=QString(), Property *parent=nullptr)
	Constructor. More...

virtual void	removeChildren (int start_index=0, int count=-1)
	Remove and delete some or all child Properties. Does not change the value of this Property. More...

int	rowNumberInParent () const
	Return the row number of this property within its parent, or -1 if it has no parent. More...

virtual void	save (Config config) const
	Write the value of this property and/or its children into the given Config reference. More...

virtual void	setDescription (const QString &description)
	Set the description. More...

virtual void	setHidden (bool hidden)
	Hide or show this property in any PropertyTreeWidget viewing its parent. More...

virtual void	setIcon (const QIcon &icon)
	Set the icon to be displayed next to the property. More...

void	setModel (PropertyTreeModel *model)
	Set the model managing this Property and all its child properties, recursively. More...

virtual void	setName (const QString &name)
	Set the name. More...

void	setParent (Property *new_parent)
	Set parent property, without telling the parent. More...

virtual void	setReadOnly (bool read_only)
	Prevent or allow users to edit this property from a PropertyTreeWidget. More...

void	setShouldBeSaved (bool save)
	If save is false, neither the property nor its children will get saved. If true (the default), the property itself will only get saved if it is not read-only; children will get saved in any case (according to their save + read-only flags). More...

virtual bool	setValue (const QVariant &new_value)
	Set the new value for this property. Returns true if the new value is different from the old value, false if same. More...

bool	shouldBeSaved () const
	Returns true if the property has data worth saving. More...

void	show ()
	Show this Property in any PropertyTreeWidgets. More...

virtual Property *	subProp (const QString &sub_name)
	Return the first child Property with the given name, or the FailureProperty if no child has the name. More...

Property *	takeChild (Property *child)
	Remove a given child object and return a pointer to it. More...

virtual Property *	takeChildAt (int index)
	Take a child out of the child list, but don't destroy it. More...

	~Property () override
	Destructor. Removes this property from its parent's list of children. More...

Protected Attributes
QStringList	strings_

Protected Attributes inherited from rviz::Property
bool	child_indexes_valid_
	True if row_number_within_parent_ of all children is valid, false if not. More...

QIcon	icon_

PropertyTreeModel *	model_
	Pointer to the PropertyTreeModel managing this property tree. More...

QVariant	value_
	This is the central property value. If you set it directly in a subclass, do so with care because many things depend on the aboutToChange() and changed() events emitted by setValue(). More...

Additional Inherited Members
Protected Member Functions inherited from rviz::Property
void	loadValue (const Config &config)
	Load the value of this property specifically, not including children. More...

Detailed Description

Editable Enum property.

An editable enum property works like a string property, but with the addition of a drop-down list of predefined choices.

Definition at line 43 of file editable_enum_property.h.

Constructor & Destructor Documentation

◆ EditableEnumProperty() [1/3]

rviz::EditableEnumProperty::EditableEnumProperty	(	const QString &	name = `QString()`,
		const QString &	default_value = `QString()`,
		const QString &	description = `QString()`,
		Property *	parent = `nullptr`
	)

Definition at line 37 of file editable_enum_property.cpp.

◆ EditableEnumProperty() [2/3]

template<typename Func , typename R >

rviz::EditableEnumProperty::EditableEnumProperty	(	const QString &	name,
		const QString &	default_value,
		const QString &	description,
		Property *	parent,
		Func &&	changed_slot,
		const R *	receiver
	)

inline

Definition at line 53 of file editable_enum_property.h.

◆ EditableEnumProperty() [3/3]

template<typename Func , typename P >

rviz::EditableEnumProperty::EditableEnumProperty	(	const QString &	name,
		const QString &	default_value,
		const QString &	description,
		P *	parent,
		Func &&	changed_slot
	)

inline

Definition at line 66 of file editable_enum_property.h.

Member Function Documentation

◆ addOption()

void rviz::EditableEnumProperty::addOption ( const QString & option )

virtual

Definition at line 50 of file editable_enum_property.cpp.

◆ addOptionStd()

void rviz::EditableEnumProperty::addOptionStd ( const std::string & option )

inline

Definition at line 78 of file editable_enum_property.h.

◆ clearOptions()

void rviz::EditableEnumProperty::clearOptions ( )

virtual

Definition at line 45 of file editable_enum_property.cpp.

◆ createEditor()

QWidget * rviz::EditableEnumProperty::createEditor	(	QWidget *	parent,
		const QStyleOptionViewItem &	option
	)

overridevirtual

Create an editor widget to edit the value of this property.

Parameters

parent	The QWidget to set as the parent of the returned QWidget.
option	A QStyleOptionViewItem with parameters of the editor widget, like the rectangle, alignments, etc.

Returns: the newly-created editor widget. The default implementation creates a QSpinBox for integer values, a FloatEdit for float or double values, or a QLineEdit for anything else.

If this function returns NULL, a QStyledItemDelegate will make an editor widget.

The widget returned by createEditor() must have one Q_PROPERTY with USER set to true. The PropertyTreeDelegate finds it, sets it with the results of PropertyTreeModel::data() after creation, and after editing is finished it reads it and calls PropertyTreeModel::setData() with the contents.

Reimplemented from rviz::Property.

Definition at line 55 of file editable_enum_property.cpp.

◆ requestOptions

void rviz::EditableEnumProperty::requestOptions ( EditableEnumProperty * property_in_need_of_options )

signal

requestOptions() is emitted each time createEditor() is called.

A connection to this signal should never be made with a queued connection, because then the "emit" would return before the changes to the options in the EnumProperty were made.

A connected slot should make calls to clearOptions() and/or addOption() as needed. The option list in the EditableEnumProperty will not be cleared before the signal is emitted.

◆ setString

void rviz::EditableEnumProperty::setString ( const QString & str )

virtualslot

Definition at line 74 of file editable_enum_property.cpp.

◆ sortOptions()

void rviz::EditableEnumProperty::sortOptions ( )

inline

Sort the option strings.

Definition at line 86 of file editable_enum_property.h.

Member Data Documentation

◆ strings_

QStringList rviz::EditableEnumProperty::strings_

protected

Definition at line 108 of file editable_enum_property.h.

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

Public Slots

Signals

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EditableEnumProperty() [1/3]

◆ EditableEnumProperty() [2/3]

◆ EditableEnumProperty() [3/3]

Member Function Documentation

◆ addOption()

◆ addOptionStd()

◆ clearOptions()

◆ createEditor()

◆ requestOptions

◆ setString

◆ sortOptions()

Member Data Documentation

◆ strings_