CustusX  16.5.0-rc9
An IGT application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cxSettings.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 #ifndef CXSETTINGS_H_
33 #define CXSETTINGS_H_
34 
35 #include "cxResourceExport.h"
36 
37 #include "boost/shared_ptr.hpp"
38 #include <QObject>
39 #include <QSettings>
40 
41 namespace cx
42 {
43 
50 typedef boost::shared_ptr<class QSettings> QSettingsPtr;
51 
58 class cxResource_EXPORT Settings : public QObject
59 {
60  Q_OBJECT
61 
62 public:
63 
64  void setValueIfNotDefault(const QString& key, const QVariant& value, const QVariant& defaultValue);
65  //forwarding functions from QSettings
66  void setValue(const QString& key, const QVariant& value);
67  QVariant value(const QString& key, const QVariant& defaultValue = QVariant()) const;
68 
69  bool contains(const QString& key) const;
70  QString fileName() const;
71 
72  void sync();
73 
74  void resetFile(QString filename);
75  Settings();
76  virtual ~Settings();
77 
80  template<class T>
81  void fillDefault(QString name, T value)
82  {
83  if (!this->contains(name))
84  this->setValue(name, value);
85  }
86 
87 signals:
88  void valueChangedFor(QString key);
89 
90 private slots:
91 private:
92  QSettingsPtr mSettings;
93 
94 };
95 
97 cxResource_EXPORT Settings* settings();
98 
103 }
104 
105 #endif /* CXSETTINGS_H_ */
cx::Settings
Customized interface for setting values in QSettings.
Definition: cxSettings.h:58
cx::QSettingsPtr
boost::shared_ptr< class QSettings > QSettingsPtr
Definition: cxProfile.h:45
cx::settings
Settings * settings()
Shortcut for accessing the settings instance.
Definition: cxSettings.cpp:42
cx::Settings::fillDefault
void fillDefault(QString name, T value)
Definition: cxSettings.h:81