int_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 INT_PROPERTY_H
30 #define INT_PROPERTY_H
31 
33 
34 namespace rviz
35 {
37 class IntProperty : public Property
38 {
39  Q_OBJECT
40 public:
54  IntProperty(const QString& name = QString(),
55  int default_value = 0,
56  const QString& description = QString(),
57  Property* parent = nullptr);
58 
59  template <typename Func, typename R>
60  IntProperty(const QString& name,
61  int default_value,
62  const QString& description,
63  Property* parent,
64  Func&& changed_slot,
65  const R* receiver)
66  : IntProperty(name, default_value, description, parent)
67  {
68  connect(receiver, std::forward<Func>(changed_slot));
69  }
70 
71  // this variant is required to allow omitting the receiver argument
72  template <typename Func, typename P>
73  IntProperty(const QString& name,
74  int default_value,
75  const QString& description,
76  P* parent,
77  Func&& changed_slot)
78  : IntProperty(name, default_value, description, parent)
79  {
80  connect(parent, std::forward<Func>(changed_slot));
81  }
82 
90  bool setValue(const QVariant& new_value) override;
91 
96  virtual int getInt() const
97  {
98  return getValue().toInt();
99  }
100 
101  void setMin(int min);
102  int getMin()
103  {
104  return min_;
105  }
106  void setMax(int max);
107  int getMax()
108  {
109  return max_;
110  }
111 
116  QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option) override;
117 
118 public Q_SLOTS:
122  void setInt(int new_value)
123  {
124  setValue(new_value);
125  }
126 
127 private:
128  int min_;
129  int max_;
130 };
131 
132 } // end namespace rviz
133 
134 #endif // INT_PROPERTY_H
rviz::IntProperty::setMin
void setMin(int min)
Definition: int_property.cpp:52
rviz::IntProperty::getMin
int getMin()
Definition: int_property.h:102
property.h
description
description
rviz::IntProperty::min_
int min_
Definition: int_property.h:128
rviz::Property::getValue
virtual QVariant getValue() const
Return the value of this Property as a QVariant. If the value has never been set, an invalid QVariant...
Definition: property.cpp:150
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::Property
A single element of a property tree, with a name, value, description, and possibly children.
Definition: property.h:100
rviz::IntProperty::setValue
bool setValue(const QVariant &new_value) override
Set the new value for this property. Returns true if the new value is different from the old value,...
Definition: int_property.cpp:47
rviz::IntProperty::IntProperty
IntProperty(const QString &name=QString(), int default_value=0, const QString &description=QString(), Property *parent=nullptr)
Constructor.
Definition: int_property.cpp:39
rviz
Definition: add_display_dialog.cpp:54
rviz::IntProperty::setMax
void setMax(int max)
Definition: int_property.cpp:58
rviz::IntProperty::createEditor
QWidget * createEditor(QWidget *parent, const QStyleOptionViewItem &option) override
Overridden to create a QSpinBox with the min and max set and with a signal/slot connection to setInt(...
Definition: int_property.cpp:64
rviz::IntProperty::setInt
void setInt(int new_value)
Set the value of this property to the given integer.
Definition: int_property.h:122
rviz::IntProperty::getMax
int getMax()
Definition: int_property.h:107
default_value
def default_value(type_)
rviz::IntProperty::getInt
virtual int getInt() const
Return the internal property value as an integer.
Definition: int_property.h:96
rviz::IntProperty::IntProperty
IntProperty(const QString &name, int default_value, const QString &description, P *parent, Func &&changed_slot)
Definition: int_property.h:73
rviz::IntProperty::IntProperty
IntProperty(const QString &name, int default_value, const QString &description, Property *parent, Func &&changed_slot, const R *receiver)
Definition: int_property.h:60
rviz::IntProperty::max_
int max_
Definition: int_property.h:129
rviz::IntProperty
Property specialized to provide max/min enforcement for integers.
Definition: int_property.h:37


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust, William Woodall
autogenerated on Wed May 1 2024 02:30:33