enum_property.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 ENUM_PROPERTY_H
30 #define ENUM_PROPERTY_H
31 
32 #include <QStringList>
33 
35 
36 namespace rviz
37 {
47 {
48  Q_OBJECT
49 public:
50  EnumProperty(const QString& name = QString(),
51  const QString& default_value = QString(),
52  const QString& description = QString(),
53  Property* parent = nullptr,
54  const char* changed_slot = nullptr,
55  QObject* receiver = nullptr);
56 
60  virtual void clearOptions();
61  virtual void addOption(const QString& option, int value = 0);
62  void addOptionStd(const std::string& option, int value = 0)
63  {
64  addOption(QString::fromStdString(option), value);
65  }
66 
69  virtual int getOptionInt();
70 
71  QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option) override;
72 
73 public Q_SLOTS:
76  virtual void setString(const QString& str);
77 
80  void setStringStd(const std::string& str)
81  {
82  setString(QString::fromStdString(str));
83  }
84 
86  void sortOptions()
87  {
88  strings_.sort();
89  }
90 
91 Q_SIGNALS:
102  void requestOptions(EnumProperty* property_in_need_of_options);
103 
104 private:
105  QStringList strings_;
106  QHash<QString, int> ints_;
107 };
108 
109 } // end namespace rviz
110 
111 #endif // ENUM_PROPERTY_H
void setStringStd(const std::string &str)
Set the value of this property to the given std::string. Does not force the value to be one of the li...
Definition: enum_property.h:80
void requestOptions(EnumProperty *property_in_need_of_options)
requestOptions() is emitted each time createEditor() is called.
QHash< QString, int > ints_
QWidget * createEditor(QWidget *parent, const QStyleOptionViewItem &option) override
Create an editor widget to edit the value of this property.
A single element of a property tree, with a name, value, description, and possibly children...
Definition: property.h:100
virtual void clearOptions()
Clear the list of options.
def default_value(type_)
description
virtual void addOption(const QString &option, int value=0)
void addOptionStd(const std::string &option, int value=0)
Definition: enum_property.h:62
Property specialized for string values.
QStringList strings_
EnumProperty(const QString &name=QString(), const QString &default_value=QString(), const QString &description=QString(), Property *parent=nullptr, const char *changed_slot=nullptr, QObject *receiver=nullptr)
virtual int getOptionInt()
Return the int value of the currently-chosen option, or 0 if the current option string does not have ...
void sortOptions()
Sort the option strings. Does not change string/int associations.
Definition: enum_property.h:86
virtual void setString(const QString &str)
Set the value of this property to the given string. Does not force the value to be one of the list of...
Enum property.
Definition: enum_property.h:46


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Sat May 27 2023 02:06:24