CustusX  16.5
An IGT application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cxFilePathProperty.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 CXFILEPATHPROPERTY_H
34 #define CXFILEPATHPROPERTY_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 
56 class cxResource_EXPORT EmbeddedFilepath
57 {
58 public:
59  void appendRootPath(QString path);
60  void setFilepath(QString filename);
61 
62  QString getRelativeFilepath() const;
63  QString getAbsoluteFilepath() const;
64  bool exists() const;
65  QString getRootPath() const;
66  QStringList getRootPaths() const;
67 
68 private:
69  void evaluate(QString* foundRoot, bool* found, QString* foundRelative, QString* foundAbsolute) const;
70  QStringList mRoots;
71  QString mFilePath;
72 };
73 
74 typedef boost::shared_ptr<class FilePathProperty> FilePathPropertyPtr;
75 
79 class cxResource_EXPORT FilePathProperty: public Property
80 {
81 Q_OBJECT
82 public:
86  static FilePathPropertyPtr initialize(const QString& uid, QString name, QString help, QString value,
87  QStringList paths, QDomNode root = QDomNode());
88 
89 public:
90  // inherited interface
91  virtual QString getDisplayName() const;
92  virtual QString getUid() const;
93 
94  virtual QVariant getValueAsVariant() const;
95  virtual void setValueFromVariant(QVariant val);
96 
97  virtual bool setValue(const QString& value);
98  virtual QString getValue() const;
99  virtual QString getHelp() const;
100  virtual void setHelp(QString val);
101 
102  EmbeddedFilepath getEmbeddedPath();
103 
104 signals:
105  void valueWasSet();
106 
107 private:
108  FilePathProperty();
109  QString mName;
110  QString mUid;
111  QString mHelp;
112  EmbeddedFilepath mFilePath;
113  XmlOptionItem mStore;
114 };
115 
116 
117 } // namespace cx
118 
119 #endif // CXFILEPATHPROPERTY_H
cx::Property
Superclass for all data adapters.
Definition: cxProperty.h:64
cx::XmlOptionItem
Helper class for storing one string value in an xml document.
Definition: cxXmlOptionItem.h:59
cx::FilePathPropertyPtr
boost::shared_ptr< class FilePathProperty > FilePathPropertyPtr
Definition: cxLocalServerStreamerServer.h:47