help_panel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012, Willow Garage, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Willow Garage, Inc. nor the names of its
14  * contributors may be used to endorse or promote products derived from
15  * this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 #ifndef HELP_PANEL_H
30 #define HELP_PANEL_H
31 
32 #include <string>
33 
34 #include "rviz/panel.h"
35 
36 class QTextBrowser;
37 
38 namespace rviz
39 {
40 class HelpPanel : public Panel
41 {
42  Q_OBJECT
43 public:
44  HelpPanel(QWidget* parent = nullptr);
45  ~HelpPanel() override;
46 
47  void onInitialize() override;
48 
50  void setHelpFile(const QString& file_path);
51 
52 private:
53  QTextBrowser* browser_;
54 };
55 
56 } // end namespace rviz
57 
58 #endif // HELP_PANEL_H
~HelpPanel() override
Definition: help_panel.cpp:51
QTextBrowser * browser_
Definition: help_panel.h:53
void onInitialize() override
Definition: help_panel.cpp:55
void setHelpFile(const QString &file_path)
Load the given html file.
Definition: help_panel.cpp:60
HelpPanel(QWidget *parent=nullptr)
Definition: help_panel.cpp:44


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