status_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 STATUSPROPERTY_H
30 #define STATUSPROPERTY_H
31 
33 
34 #include <QIcon>
35 
36 namespace rviz
37 {
38 class StatusProperty : public Property
39 {
40  Q_OBJECT
41 public:
42  enum Level
43  {
44  Ok = 0,
45  Warn = 1,
46  Error = 2
47  }; // values index into status_colors_ array.
48 
49  StatusProperty(const QString& name, const QString& text, Level level, Property* parent);
50 
52  bool setValue(const QVariant& new_value) override;
53 
57  QVariant getViewData(int column, int role) const override;
58 
61  Qt::ItemFlags getViewFlags(int column) const override;
62 
64  static QColor statusColor(Level level);
65 
68  static QString statusWord(Level level);
69 
70  QIcon statusIcon(Level level) const;
71 
72  virtual void setLevel(Level level);
73  virtual Level getLevel() const
74  {
75  return level_;
76  }
77 
78 protected:
80 
81 private:
82  static QColor status_colors_[3];
83  static QString status_words_[3];
84  QIcon status_icons_[3];
85 };
86 
88 
89 } // end namespace rviz
90 
91 #endif // STATUSPROPERTY_H
rviz::StatusProperty::Error
@ Error
Definition: status_property.h:46
property.h
rviz::StatusProperty::Level
Level
Definition: status_property.h:42
rviz::StatusProperty::status_words_
static QString status_words_[3]
Definition: status_property.h:83
rviz::StatusProperty::StatusProperty
StatusProperty(const QString &name, const QString &text, Level level, Property *parent)
Definition: status_property.cpp:44
rviz::StatusProperty::setValue
bool setValue(const QVariant &new_value) override
Set the status text. Overridden from Property.
Definition: status_property.cpp:56
rviz::Property
A single element of a property tree, with a name, value, description, and possibly children.
Definition: property.h:100
rviz::StatusProperty::statusColor
static QColor statusColor(Level level)
Return the color appropriate for the given status level.
Definition: status_property.cpp:81
rviz::StatusProperty
Definition: status_property.h:38
rviz::StatusProperty::level_
Level level_
Definition: status_property.h:79
rviz
Definition: add_display_dialog.cpp:54
rviz::StatusProperty::getLevel
virtual Level getLevel() const
Definition: status_property.h:73
rviz::StatusProperty::getViewData
QVariant getViewData(int column, int role) const override
Return data appropriate for the given column (0 or 1) and role for this StatusProperty.
Definition: status_property.cpp:62
rviz::StatusProperty::Ok
@ Ok
Definition: status_property.h:44
rviz::StatusProperty::Warn
@ Warn
Definition: status_property.h:45
rviz::StatusProperty::status_icons_
QIcon status_icons_[3]
Definition: status_property.h:84
Level
Level
rviz::StatusProperty::setLevel
virtual void setLevel(Level level)
Definition: status_property.cpp:101
rviz::StatusProperty::status_colors_
static QColor status_colors_[3]
Definition: status_property.h:82
rviz::StatusProperty::statusWord
static QString statusWord(Level level)
Return the word appropriate for the given status level: "Ok", "Warn", or "Error".
Definition: status_property.cpp:95
rviz::StatusLevel
StatusProperty::Level StatusLevel
Definition: status_property.h:87
rviz::StatusProperty::getViewFlags
Qt::ItemFlags getViewFlags(int column) const override
Return item flags appropriate for the given column (0 or 1) for this StatusProperty.
Definition: status_property.cpp:75
rviz::StatusProperty::statusIcon
QIcon statusIcon(Level level) const
Definition: status_property.cpp:87


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust, William Woodall
autogenerated on Fri Dec 13 2024 03:31:03