#include <help_panel.h>
Inheritance diagram for rviz::HelpPanel:
Public Member Functions | |
| HelpPanel (QWidget *parent=nullptr) | |
| void | onInitialize () override |
| void | setHelpFile (const QString &file_path) |
| Load the given html file. More... | |
| ~HelpPanel () override | |
 Public Member Functions inherited from rviz::Panel | |
| virtual QString | getClassId () const |
| Return the class identifier which was used to create this instance. This version just returns whatever was set with setClassId(). More... | |
| virtual QString | getDescription () const |
| Return a description of this Panel. More... | |
| virtual QString | getName () const |
| void | initialize (VisualizationManager *manager) |
| virtual void | load (const Config &config) |
| Override to load configuration data. This version loads the name of the panel. More... | |
| Panel (QWidget *parent=nullptr) | |
| virtual void | save (Config config) const |
| Override to save configuration data. This version saves the name and class ID of the panel. More... | |
| virtual void | setClassId (const QString &class_id) |
| Set the class identifier used to create this instance. Typically this will be set by the factory object which created it. More... | |
| virtual void | setDescription (const QString &description) |
| Set a description of this Panel. Called by the factory which creates it. More... | |
| virtual void | setName (const QString &name) |
| ~Panel () override | |
Private Attributes | |
| QTextBrowser * | browser_ |
Additional Inherited Members | |
| Signals inherited from rviz::Panel | |
| void | configChanged () |
| Subclasses must emit this whenever a configuration change happens. More... | |
| Protected Attributes inherited from rviz::Panel | |
| VisualizationManager * | vis_manager_ |
Detailed Description
Definition at line 40 of file help_panel.h.
Constructor & Destructor Documentation
◆ HelpPanel()
| rviz::HelpPanel::HelpPanel | ( | QWidget * | parent = nullptr | ) |
Definition at line 44 of file help_panel.cpp.
◆ ~HelpPanel()
|
override |
Definition at line 51 of file help_panel.cpp.
Member Function Documentation
◆ onInitialize()
|
overridevirtual |
Override to do initialization which depends on the VisualizationManager being available. This base implementation does nothing.
Reimplemented from rviz::Panel.
Definition at line 55 of file help_panel.cpp.
◆ setHelpFile()
| void rviz::HelpPanel::setHelpFile | ( | const QString & | file_path | ) |
Load the given html file.
Definition at line 60 of file help_panel.cpp.
Member Data Documentation
◆ browser_
|
private |
Definition at line 53 of file help_panel.h.
The documentation for this class was generated from the following files: