bool_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 BOOL_PROPERTY_H
30 #define BOOL_PROPERTY_H
31 
33 #include "rviz/rviz_export.h"
34 
35 namespace rviz
36 {
38 class RVIZ_EXPORT BoolProperty : public Property
39 {
40  Q_OBJECT
41 public:
42  BoolProperty(const QString& name = QString(),
43  bool default_value = false,
44  const QString& description = QString(),
45  Property* parent = nullptr,
46  const char* changed_slot = nullptr,
47  QObject* receiver = nullptr);
48 
49  ~BoolProperty() override;
50 
51  virtual bool getBool() const;
52 
53  //* If this is true, will disable it's children when it's own bool value is false */
54  void setDisableChildrenIfFalse(bool disable);
55 
56  bool getDisableChildrenIfFalse();
57 
58  //* Overridden from Property */
59  bool getDisableChildren() override;
60 
61 public Q_SLOTS:
62  bool setBool(bool value)
63  {
64  return setValue(value);
65  }
66 
67 private:
69 };
70 
71 } // end namespace rviz
72 
73 #endif // BOOL_PROPERTY_H
bool disable_children_if_false_
Definition: bool_property.h:68
A single element of a property tree, with a name, value, description, and possibly children...
Definition: property.h:100
def default_value(type_)
description
Property specialized to provide getter for booleans.
Definition: bool_property.h:38
bool setBool(bool value)
Definition: bool_property.h:62


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Sat Nov 6 2021 02:06:34