Public Member Functions | Private Slots | Private Attributes | List of all members
rviz::PropertyTreeWithHelp Class Reference

#include <property_tree_with_help.h>

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

Public Member Functions

PropertyTreeWidgetgetTree ()
 
void load (const Config &config)
 Read state from the given Config. More...
 
 PropertyTreeWithHelp (QWidget *parent=nullptr)
 
void save (Config config) const
 Write state to the given Config. More...
 

Private Slots

void showHelpForProperty (const Property *property)
 

Private Attributes

QTextBrowser * help_
 
PropertyTreeWidgetproperty_tree_
 

Detailed Description

A PropertyTreeWidget with built-in help info display.

Definition at line 44 of file property_tree_with_help.h.

Constructor & Destructor Documentation

◆ PropertyTreeWithHelp()

rviz::PropertyTreeWithHelp::PropertyTreeWithHelp ( QWidget *  parent = nullptr)

Definition at line 39 of file property_tree_with_help.cpp.

Member Function Documentation

◆ getTree()

PropertyTreeWidget* rviz::PropertyTreeWithHelp::getTree ( )
inline

Definition at line 50 of file property_tree_with_help.h.

◆ load()

void rviz::PropertyTreeWithHelp::load ( const Config config)

Read state from the given Config.

Definition at line 88 of file property_tree_with_help.cpp.

◆ save()

void rviz::PropertyTreeWithHelp::save ( Config  config) const

Write state to the given Config.

Definition at line 79 of file property_tree_with_help.cpp.

◆ showHelpForProperty

void rviz::PropertyTreeWithHelp::showHelpForProperty ( const Property property)
privateslot

Definition at line 63 of file property_tree_with_help.cpp.

Member Data Documentation

◆ help_

QTextBrowser* rviz::PropertyTreeWithHelp::help_
private

Definition at line 66 of file property_tree_with_help.h.

◆ property_tree_

PropertyTreeWidget* rviz::PropertyTreeWithHelp::property_tree_
private

Definition at line 65 of file property_tree_with_help.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