CustusX  16.5
An IGT application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cxStringProperty.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 CXSTRINGPROPERTY_H_
34 #define CXSTRINGPROPERTY_H_
35 
36 #include "cxResourceExport.h"
37 
38 #include <QDomElement>
39 #include <QStringList>
40 #include "cxStringPropertyBase.h"
41 #include "cxXmlOptionItem.h"
42 
43 namespace cx
44 {
45 
46 typedef boost::shared_ptr<class StringProperty> StringPropertyPtr;
47 
59 class cxResource_EXPORT StringProperty: public StringPropertyBase
60 {
61 Q_OBJECT
62 public:
66  static StringPropertyPtr initialize(const QString& uid, QString name, QString help, QString value, QStringList range, QDomNode root = QDomNode());
67  static StringPropertyPtr initialize(const QString& uid, QString name, QString help, QString value, QDomNode root = QDomNode());
68 
69 public:
70  // inherited interface
71  virtual QString getDisplayName() const;
72  virtual QString getUid() const;
73  virtual bool setValue(const QString& value);
74  virtual QString getValue() const;
75  virtual QString getHelp() const;
76  virtual void setHelp(QString val);
77  virtual QStringList getValueRange() const;
78  virtual void setValueRange(QStringList range);
79  virtual QString convertInternal2Display(QString internal);
80  virtual void setDisplayNames(std::map<QString, QString> names);
81  virtual std::map<QString, QString> getDisplayNames() const { return mDisplayNames; }
82 
83  virtual bool isReadOnly() const { return mIsReadOnly; }
84  virtual bool getAllowOnlyValuesInRange() const { return mAllowOnlyValuesInRange; }
85  void setReadOnly(bool val);
86  virtual void setDisplayName(QString val);
87 
88 
89 signals:
90  void valueWasSet();
91 
92 private:
94  QString mName;
95  QString mUid;
96  QString mHelp;
97  QString mValue;
98  QStringList mRange;
99  XmlOptionItem mStore;
100  std::map<QString, QString> mDisplayNames;
101  bool mIsReadOnly;
102  bool mAllowOnlyValuesInRange;
103 };
104 
105 
106 } // namespace cx
107 
108 #endif /* CXSTRINGPROPERTY_H_ */
virtual bool getAllowOnlyValuesInRange() const
Abstract interface for interaction with internal string-valued data.
Helper class for storing one string value in an xml document.
boost::shared_ptr< class StringProperty > StringPropertyPtr
virtual bool isReadOnly() const
Represents one option of the string type. The data are stored within a xml document.
virtual std::map< QString, QString > getDisplayNames() const