Public Slots | Public Member Functions | Protected Attributes | List of all members
rviz::DisplayVisibilityProperty Class Reference

#include <display_visibility_property.h>

Inheritance diagram for rviz::DisplayVisibilityProperty:
Inheritance graph
[legend]

Public Slots

bool setValue (const QVariant &new_value) override
 
- Public Slots inherited from rviz::BoolProperty
bool setBool (bool value)
 

Public Member Functions

template<typename Func , typename P >
 DisplayVisibilityProperty (uint32_t vis_bit, Display *display, const QString &name, bool default_value, const QString &description, P *parent, Func &&changed_slot)
 
template<typename Func , typename R >
 DisplayVisibilityProperty (uint32_t vis_bit, Display *display, const QString &name, bool default_value, const QString &description, Property *parent, Func &&changed_slot, const R *receiver)
 
 DisplayVisibilityProperty (uint32_t vis_bit, Display *display, const QString &name=QString(), bool default_value=false, const QString &description=QString(), Property *parent=nullptr)
 
bool getBool () const override
 
Qt::ItemFlags getViewFlags (int column) const override
 Return item flags appropriate for the given column (0 or 1) for this Property. More...
 
virtual void update ()
 
 ~DisplayVisibilityProperty () override
 
- Public Member Functions inherited from rviz::BoolProperty
template<typename Func , typename P >
 BoolProperty (const QString &name, bool default_value, const QString &description, P *parent, Func &&changed_slot)
 
template<typename Func , typename R >
 BoolProperty (const QString &name, bool default_value, const QString &description, Property *parent, Func &&changed_slot, const R *receiver)
 
 BoolProperty (const QString &name=QString(), bool default_value=false, const QString &description=QString(), Property *parent=nullptr)
 
bool getDisableChildren () override
 If true, the children of this property should set their ItemIsEnabled flag to false. More...
 
bool getDisableChildrenIfFalse ()
 
void setDisableChildrenIfFalse (bool disable)
 
 ~BoolProperty () override
 
- Public Member Functions inherited from rviz::Property
virtual void addChild (Property *child, int index=-1)
 Add a child property. More...
 
PropertychildAt (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 PropertychildAtUnchecked (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 QWidget * createEditor (QWidget *parent, const QStyleOptionViewItem &option)
 Create an editor widget to edit the value of this property. More...
 
virtual void expand ()
 Expand (show the children of) this Property. More...
 
virtual QString getDescription () const
 Return the description. More...
 
virtual bool getHidden () const
 Return the hidden/shown state. True means hidden, false means visible. More...
 
virtual QIcon getIcon () const
 
PropertyTreeModelgetModel () 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...
 
PropertygetParent () 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...
 
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 PropertysubProp (const QString &sub_name)
 Return the first child Property with the given name, or the FailureProperty if no child has the name. More...
 
PropertytakeChild (Property *child)
 Remove a given child object and return a pointer to it. More...
 
virtual PropertytakeChildAt (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

bool custom_name_
 
Displaydisplay_
 
uint32_t vis_bit_
 
- 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_
 
PropertyTreeModelmodel_
 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

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

Definition at line 55 of file display_visibility_property.h.

Constructor & Destructor Documentation

◆ DisplayVisibilityProperty() [1/3]

rviz::DisplayVisibilityProperty::DisplayVisibilityProperty ( uint32_t  vis_bit,
Display display,
const QString &  name = QString(),
bool  default_value = false,
const QString &  description = QString(),
Property parent = nullptr 
)

Definition at line 40 of file display_visibility_property.cpp.

◆ DisplayVisibilityProperty() [2/3]

template<typename Func , typename R >
rviz::DisplayVisibilityProperty::DisplayVisibilityProperty ( uint32_t  vis_bit,
Display display,
const QString &  name,
bool  default_value,
const QString &  description,
Property parent,
Func &&  changed_slot,
const R *  receiver 
)
inline

Definition at line 67 of file display_visibility_property.h.

◆ DisplayVisibilityProperty() [3/3]

template<typename Func , typename P >
rviz::DisplayVisibilityProperty::DisplayVisibilityProperty ( uint32_t  vis_bit,
Display display,
const QString &  name,
bool  default_value,
const QString &  description,
P *  parent,
Func &&  changed_slot 
)
inline

Definition at line 82 of file display_visibility_property.h.

◆ ~DisplayVisibilityProperty()

rviz::DisplayVisibilityProperty::~DisplayVisibilityProperty ( )
override

Definition at line 52 of file display_visibility_property.cpp.

Member Function Documentation

◆ getBool()

bool rviz::DisplayVisibilityProperty::getBool ( ) const
overridevirtual

Reimplemented from rviz::BoolProperty.

Definition at line 83 of file display_visibility_property.cpp.

◆ getViewFlags()

Qt::ItemFlags rviz::DisplayVisibilityProperty::getViewFlags ( int  column) const
overridevirtual

Return item flags appropriate for the given column (0 or 1) for this Property.

Parameters
column0 for left column, 1 for right column.
Returns
The Qt::ItemFlags for the given column of this property, including Qt::ItemIsSelectable, Qt::ItemIsEditable, etc.

Reimplemented from rviz::Property.

Definition at line 92 of file display_visibility_property.cpp.

◆ setValue

bool rviz::DisplayVisibilityProperty::setValue ( const QVariant &  new_value)
overrideslot

Definition at line 73 of file display_visibility_property.cpp.

◆ update()

void rviz::DisplayVisibilityProperty::update ( )
virtual

Reimplemented in rviz::DisplayGroupVisibilityProperty.

Definition at line 56 of file display_visibility_property.cpp.

Member Data Documentation

◆ custom_name_

bool rviz::DisplayVisibilityProperty::custom_name_
protected

Definition at line 109 of file display_visibility_property.h.

◆ display_

Display* rviz::DisplayVisibilityProperty::display_
protected

Definition at line 108 of file display_visibility_property.h.

◆ vis_bit_

uint32_t rviz::DisplayVisibilityProperty::vis_bit_
protected

Definition at line 107 of file display_visibility_property.h.


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


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust, William Woodall
autogenerated on Fri Aug 2 2024 08:43:10