Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Private Attributes | Static Private Attributes | List of all members
rviz::StatusProperty Class Reference

#include <status_property.h>

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

Public Types

enum  Level { Ok = 0, Warn = 1, Error = 2 }
 

Public Member Functions

virtual Level getLevel () const
 
QVariant getViewData (int column, int role) const override
 Return data appropriate for the given column (0 or 1) and role for this StatusProperty. More...
 
Qt::ItemFlags getViewFlags (int column) const override
 Return item flags appropriate for the given column (0 or 1) for this StatusProperty. More...
 
virtual void setLevel (Level level)
 
bool setValue (const QVariant &new_value) override
 Set the status text. Overridden from Property. More...
 
QIcon statusIcon (Level level) const
 
 StatusProperty (const QString &name, const QString &text, Level level, Property *parent)
 
- 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...
 
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 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
 
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 ()
 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...
 
void hide ()
 Hide this Property in any PropertyTreeWidgets. 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...
 
 Property (const QString &name=QString(), const QVariant default_value=QVariant(), const QString &description=QString(), Property *parent=nullptr, const char *changed_slot=nullptr, QObject *receiver=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 true and getReadOnly() is false, shouldBeSaved will return true; otherwise false. Default is true. More...
 
bool shouldBeSaved () const
 Returns true if the property is not read-only AND 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...
 

Static Public Member Functions

static QColor statusColor (Level level)
 Return the color appropriate for the given status level. More...
 
static QString statusWord (Level level)
 Return the word appropriate for the given status level: "Ok", "Warn", or "Error". More...
 

Protected Attributes

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

Private Attributes

QIcon status_icons_ [3]
 

Static Private Attributes

static QColor status_colors_ [3] = {QColor(), QColor(192, 128, 0), QColor(192, 32, 32)}
 
static QString status_words_ [3] = {"Ok", "Warn", "Error"}
 

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 38 of file status_property.h.

Member Enumeration Documentation

◆ Level

Enumerator
Ok 
Warn 
Error 

Definition at line 42 of file status_property.h.

Constructor & Destructor Documentation

◆ StatusProperty()

rviz::StatusProperty::StatusProperty ( const QString &  name,
const QString &  text,
Level  level,
Property parent 
)

Definition at line 44 of file status_property.cpp.

Member Function Documentation

◆ getLevel()

virtual Level rviz::StatusProperty::getLevel ( ) const
inlinevirtual

Definition at line 73 of file status_property.h.

◆ getViewData()

QVariant rviz::StatusProperty::getViewData ( int  column,
int  role 
) const
overridevirtual

Return data appropriate for the given column (0 or 1) and role for this StatusProperty.

Reimplemented from rviz::Property.

Definition at line 62 of file status_property.cpp.

◆ getViewFlags()

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

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

Reimplemented from rviz::Property.

Definition at line 75 of file status_property.cpp.

◆ setLevel()

void rviz::StatusProperty::setLevel ( Level  level)
virtual

Reimplemented in rviz::StatusList.

Definition at line 101 of file status_property.cpp.

◆ setValue()

bool rviz::StatusProperty::setValue ( const QVariant &  new_value)
overridevirtual

Set the status text. Overridden from Property.

Reimplemented from rviz::Property.

Definition at line 56 of file status_property.cpp.

◆ statusColor()

QColor rviz::StatusProperty::statusColor ( Level  level)
static

Return the color appropriate for the given status level.

Definition at line 81 of file status_property.cpp.

◆ statusIcon()

QIcon rviz::StatusProperty::statusIcon ( Level  level) const

Definition at line 87 of file status_property.cpp.

◆ statusWord()

QString rviz::StatusProperty::statusWord ( Level  level)
static

Return the word appropriate for the given status level: "Ok", "Warn", or "Error".

Definition at line 95 of file status_property.cpp.

Member Data Documentation

◆ level_

Level rviz::StatusProperty::level_
protected

Definition at line 79 of file status_property.h.

◆ status_colors_

QColor rviz::StatusProperty::status_colors_ = {QColor(), QColor(192, 128, 0), QColor(192, 32, 32)}
staticprivate

Definition at line 82 of file status_property.h.

◆ status_icons_

QIcon rviz::StatusProperty::status_icons_[3]
private

Definition at line 84 of file status_property.h.

◆ status_words_

QString rviz::StatusProperty::status_words_ = {"Ok", "Warn", "Error"}
staticprivate

Definition at line 83 of file status_property.h.


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


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Mon Aug 15 2022 02:05:18