property_tree_with_help.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011, 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 RVIZ_PROPERTY_TREE_WITH_HELP_H
30 #define RVIZ_PROPERTY_TREE_WITH_HELP_H
31 
32 #include <QSplitter>
33 
34 #include "rviz/config.h"
35 
36 class QTextBrowser;
37 
38 namespace rviz
39 {
40 class Property;
41 class PropertyTreeWidget;
42 
44 class PropertyTreeWithHelp : public QSplitter
45 {
46  Q_OBJECT
47 public:
48  PropertyTreeWithHelp(QWidget* parent = nullptr);
49 
51  {
52  return property_tree_;
53  }
54 
56  void save(Config config) const;
57 
59  void load(const Config& config);
60 
61 private Q_SLOTS:
62  void showHelpForProperty(const Property* property);
63 
64 private:
66  QTextBrowser* help_;
67 };
68 
69 } // end namespace rviz
70 
71 #endif // RVIZ_PROPERTY_TREE_WITH_HELP_H
PropertyTreeWidget * getTree()
A single element of a property tree, with a name, value, description, and possibly children...
Definition: property.h:100
config
void save(Config config) const
Write state to the given Config.
Configuration data storage class.
Definition: config.h:124
PropertyTreeWidget * property_tree_
PropertyTreeWithHelp(QWidget *parent=nullptr)
void showHelpForProperty(const Property *property)
void load(const Config &config)
Read state from the given Config.


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