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 
55  template <typename Func, typename R>
56  EnumProperty(const QString& name,
57  const QString& default_value,
58  const QString& description,
59  Property* parent,
60  Func&& changed_slot,
61  const R* receiver)
62  : EnumProperty(name, default_value, description, parent)
63  {
64  connect(receiver, std::forward<Func>(changed_slot));
65  }
66 
67  // this variant is required to allow omitting the receiver argument
68  template <typename Func, typename P>
69  EnumProperty(const QString& name,
70  const QString& default_value,
71  const QString& description,
72  P* parent,
73  Func&& changed_slot)
74  : EnumProperty(name, default_value, description, parent)
75  {
76  connect(parent, std::forward<Func>(changed_slot));
77  }
78 
82  virtual void clearOptions();
83  virtual void addOption(const QString& option, int value = 0);
84  void addOptionStd(const std::string& option, int value = 0)
85  {
86  addOption(QString::fromStdString(option), value);
87  }
88 
91  virtual int getOptionInt();
92 
93  QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option) override;
94 
95 public Q_SLOTS:
98  virtual void setString(const QString& str);
99 
102  void setStringStd(const std::string& str)
103  {
104  setString(QString::fromStdString(str));
105  }
106 
108  void sortOptions()
109  {
110  strings_.sort();
111  }
112 
113 Q_SIGNALS:
124  void requestOptions(EnumProperty* property_in_need_of_options);
125 
126 private:
127  QStringList strings_;
128  QHash<QString, int> ints_;
129 };
130 
131 } // end namespace rviz
132 
133 #endif // ENUM_PROPERTY_H
rviz::EnumProperty::getOptionInt
virtual int getOptionInt()
Return the int value of the currently-chosen option, or 0 if the current option string does not have ...
Definition: enum_property.cpp:56
rviz::EnumProperty::clearOptions
virtual void clearOptions()
Clear the list of options.
Definition: enum_property.cpp:44
rviz::EnumProperty::EnumProperty
EnumProperty(const QString &name, const QString &default_value, const QString &description, P *parent, Func &&changed_slot)
Definition: enum_property.h:69
rviz::EnumProperty::sortOptions
void sortOptions()
Sort the option strings. Does not change string/int associations.
Definition: enum_property.h:108
rviz::EnumProperty::setString
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...
Definition: enum_property.cpp:82
rviz::EnumProperty::EnumProperty
EnumProperty(const QString &name=QString(), const QString &default_value=QString(), const QString &description=QString(), Property *parent=nullptr)
Definition: enum_property.cpp:36
description
description
rviz::EnumProperty::requestOptions
void requestOptions(EnumProperty *property_in_need_of_options)
requestOptions() is emitted each time createEditor() is called.
rviz::Property::connect
QMetaObject::Connection connect(const QObject *receiver, const char *slot, Qt::ConnectionType type=Qt::AutoConnection)
Connect changed() signal to given slot of receiver.
Definition: property.cpp:78
rviz::EnumProperty
Enum property.
Definition: enum_property.h:46
rviz::Property
A single element of a property tree, with a name, value, description, and possibly children.
Definition: property.h:100
rviz::EnumProperty::addOption
virtual void addOption(const QString &option, int value=0)
Definition: enum_property.cpp:50
rviz
Definition: add_display_dialog.cpp:54
rviz::StringProperty
Property specialized for string values.
Definition: string_property.h:39
string_property.h
rviz::EnumProperty::addOptionStd
void addOptionStd(const std::string &option, int value=0)
Definition: enum_property.h:84
default_value
def default_value(type_)
rviz::EnumProperty::setStringStd
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:102
rviz::EnumProperty::EnumProperty
EnumProperty(const QString &name, const QString &default_value, const QString &description, Property *parent, Func &&changed_slot, const R *receiver)
Definition: enum_property.h:56
rviz::EnumProperty::strings_
QStringList strings_
Definition: enum_property.h:127
rviz::EnumProperty::ints_
QHash< QString, int > ints_
Definition: enum_property.h:128
rviz::EnumProperty::createEditor
QWidget * createEditor(QWidget *parent, const QStyleOptionViewItem &option) override
Create an editor widget to edit the value of this property.
Definition: enum_property.cpp:67


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust, William Woodall
autogenerated on Fri Aug 2 2024 08:43:09