Abstract base class for properties. More...
#include <property.h>
Public Member Functions | |
| virtual void | addLegacyName (const std::string &name)=0 |
| void | changed () |
| Notify that the value in this property has changed. Should be called from within the setter function. | |
| void | configChanged () |
| Notify that the value of this property has changed such that it affects the config file. | |
| virtual void | doWriteToGrid ()=0 |
| virtual std::string | getName ()=0 |
| virtual CategoryPropertyWPtr | getParent ()=0 |
| virtual std::string | getPrefix ()=0 |
| virtual PropertyTreeWidget * | getPropertyTreeWidget () |
| virtual bool | getSave ()=0 |
| void * | getUserData () |
| virtual PropertyWidgetItem * | getWidgetItem ()=0 |
| virtual void | hide () |
| virtual bool | isSelected () |
| virtual void | loadFromConfig (Config *config)=0 |
| PropertyBase () | |
| virtual void | readFromGrid ()=0 |
| virtual void | reset () |
| virtual void | saveToConfig (Config *config)=0 |
| virtual void | setPrefix (const std::string &prefix)=0 |
| virtual void | setPropertyTreeWidget (PropertyTreeWidget *grid) |
| virtual void | setUserData (void *user_data) |
| virtual void | show () |
| void | writeToGrid () |
| virtual | ~PropertyBase () |
Protected Attributes | |
| PropertyTreeWidget * | grid_ |
| void * | user_data_ |
| PropertyWidgetItem * | widget_item_ |
Private Attributes | |
| PropertyManager * | manager_ |
Friends | |
| class | PropertyManager |
Detailed Description
Abstract base class for properties.
Definition at line 74 of file property.h.
Constructor & Destructor Documentation
Definition at line 117 of file property.cpp.
| rviz::PropertyBase::~PropertyBase | ( | ) | [virtual] |
Definition at line 125 of file property.cpp.
Member Function Documentation
| virtual void rviz::PropertyBase::addLegacyName | ( | const std::string & | name | ) | [pure virtual] |
| void rviz::PropertyBase::changed | ( | ) |
Notify that the value in this property has changed. Should be called from within the setter function.
Definition at line 169 of file property.cpp.
| void rviz::PropertyBase::configChanged | ( | ) |
Notify that the value of this property has changed such that it affects the config file.
Definition at line 182 of file property.cpp.
| virtual void rviz::PropertyBase::doWriteToGrid | ( | ) | [pure virtual] |
Implemented in rviz::QuaternionProperty, rviz::Vector3Property, rviz::CategoryProperty, rviz::TFFrameProperty, rviz::EditEnumProperty, rviz::EnumProperty, rviz::ColorProperty, rviz::ROSTopicStringProperty, rviz::StringProperty, rviz::FloatProperty, rviz::IntProperty, rviz::BoolProperty, and rviz::StatusProperty.
| virtual std::string rviz::PropertyBase::getName | ( | ) | [pure virtual] |
| virtual CategoryPropertyWPtr rviz::PropertyBase::getParent | ( | ) | [pure virtual] |
| virtual std::string rviz::PropertyBase::getPrefix | ( | ) | [pure virtual] |
| virtual PropertyTreeWidget* rviz::PropertyBase::getPropertyTreeWidget | ( | ) | [inline, virtual] |
Definition at line 97 of file property.h.
| virtual bool rviz::PropertyBase::getSave | ( | ) | [pure virtual] |
| void* rviz::PropertyBase::getUserData | ( | ) | [inline] |
Definition at line 100 of file property.h.
| virtual PropertyWidgetItem* rviz::PropertyBase::getWidgetItem | ( | ) | [pure virtual] |
| void rviz::PropertyBase::hide | ( | ) | [virtual] |
Definition at line 143 of file property.cpp.
| bool rviz::PropertyBase::isSelected | ( | ) | [virtual] |
Definition at line 159 of file property.cpp.
| virtual void rviz::PropertyBase::loadFromConfig | ( | Config * | config | ) | [pure virtual] |
| virtual void rviz::PropertyBase::readFromGrid | ( | ) | [pure virtual] |
| void rviz::PropertyBase::reset | ( | ) | [virtual] |
Reimplemented in rviz::QuaternionProperty, rviz::Vector3Property, and rviz::CategoryProperty.
Definition at line 130 of file property.cpp.
| virtual void rviz::PropertyBase::saveToConfig | ( | Config * | config | ) | [pure virtual] |
| virtual void rviz::PropertyBase::setPrefix | ( | const std::string & | prefix | ) | [pure virtual] |
| void rviz::PropertyBase::setPropertyTreeWidget | ( | PropertyTreeWidget * | grid | ) | [virtual] |
Definition at line 138 of file property.cpp.
| virtual void rviz::PropertyBase::setUserData | ( | void * | user_data | ) | [inline, virtual] |
Definition at line 99 of file property.h.
| void rviz::PropertyBase::show | ( | ) | [virtual] |
Definition at line 151 of file property.cpp.
| void rviz::PropertyBase::writeToGrid | ( | ) |
Definition at line 53 of file property.cpp.
Friends And Related Function Documentation
friend class PropertyManager [friend] |
Definition at line 128 of file property.h.
Member Data Documentation
PropertyTreeWidget* rviz::PropertyBase::grid_ [protected] |
Definition at line 118 of file property.h.
PropertyManager* rviz::PropertyBase::manager_ [private] |
Definition at line 129 of file property.h.
void* rviz::PropertyBase::user_data_ [protected] |
Definition at line 120 of file property.h.
PropertyWidgetItem* rviz::PropertyBase::widget_item_ [protected] |
Definition at line 119 of file property.h.
The documentation for this class was generated from the following files: