CustusX  15.4.0-beta
An IGT application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cxColorProperty.h
Go to the documentation of this file.
1 /*=========================================================================
2 This file is part of CustusX, an Image Guided Therapy Application.
3 
4 Copyright (c) 2008-2014, SINTEF Department of Medical Technology
5 All rights reserved.
6 
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
9 
10 1. Redistributions of source code must retain the above copyright notice,
11  this list of conditions and the following disclaimer.
12 
13 2. Redistributions in binary form must reproduce the above copyright notice,
14  this list of conditions and the following disclaimer in the documentation
15  and/or other materials provided with the distribution.
16 
17 3. Neither the name of the copyright holder nor the names of its contributors
18  may be used to endorse or promote products derived from this software
19  without specific prior written permission.
20 
21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 =========================================================================*/
32 
33 #ifndef CXCOLORPROPERTY_H_
34 #define CXCOLORPROPERTY_H_
35 
36 #include "cxResourceExport.h"
37 
38 #include "cxColorPropertyBase.h"
39 #include "cxXmlOptionItem.h"
40 
41 
42 namespace cx
43 {
44 typedef boost::shared_ptr<class ColorProperty> ColorPropertyPtr;
45 
53 class cxResource_EXPORT ColorProperty: public ColorPropertyBase
54 {
55 Q_OBJECT
56 public:
57  virtual ~ColorProperty()
58  {
59  }
60 
64  static ColorPropertyPtr initialize(const QString& uid, QString name, QString help, QColor value, QDomNode root =
65  QDomNode());
66 
67 public:
68  // basic methods
69  virtual QString getDisplayName() const;
70  virtual QString getUid() const;
71  virtual bool setValue(QColor value);
72  virtual QColor getValue() const;
73 
74 public:
75  // optional methods
76  virtual QString getHelp() const;
77 
78 signals:
79  void valueWasSet();
80 
81 private:
82  QString mName;
83  QString mUid;
84  QString mHelp;
85  QColor mValue;
86  XmlOptionItem mStore;
87 
88 };
89 
90 } // namespace cx
91 
92 
93 #endif // CXCOLORPROPERTY_H_
boost::shared_ptr< class ColorProperty > ColorPropertyPtr
virtual ~ColorProperty()
Helper class for storing one string value in an xml document.