CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
ctkCmdLineModuleDefaultPathBuilder.h
Go to the documentation of this file.
1 /*=============================================================================
2 
3  Library: CTK
4 
5  Copyright (c) University College London
6 
7  Licensed under the Apache License, Version 2.0 (the "License");
8  you may not use this file except in compliance with the License.
9  You may obtain a copy of the License at
10 
11  http://www.apache.org/licenses/LICENSE-2.0
12 
13  Unless required by applicable law or agreed to in writing, software
14  distributed under the License is distributed on an "AS IS" BASIS,
15  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  See the License for the specific language governing permissions and
17  limitations under the License.
18 
19 =============================================================================*/
20 
21 #ifndef __ctkCmdLineModuleDefaultPathBuilder_h
22 #define __ctkCmdLineModuleDefaultPathBuilder_h
23 
24 #include "ctkCommandLineModulesCoreExport.h"
25 #include <QStringList>
26 #include <QScopedPointer>
27 
28 struct ctkCmdLineModuleDefaultPathBuilderPrivate;
29 
52 class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleDefaultPathBuilder
53 {
54 
55 public:
56 
59 
63  virtual void clear();
64 
70  virtual void setStrictMode(const bool& strict);
71 
75  virtual bool strictMode() const;
76 
83  virtual void addHomeDir(const QString& subFolder = QString());
84 
91  virtual void addCurrentDir(const QString& subFolder = QString());
92 
96  virtual void addApplicationDir(const QString& subFolder = QString());
97 
103  virtual void addCtkModuleLoadPath();
104 
109  virtual QStringList getDirectoryList() const;
110 
111 private:
112 
113  QScopedPointer<ctkCmdLineModuleDefaultPathBuilderPrivate> d;
114  Q_DISABLE_COPY(ctkCmdLineModuleDefaultPathBuilder)
115 };
116 
117 #endif
Builds up a list of directory paths to search for command line modules.
virtual void addHomeDir(const QString &subFolder=QString())
Adds the users home directory, or if specified a sub-directory.
virtual void addCurrentDir(const QString &subFolder=QString())
Adds the current working directory, or if specified a sub-directory.
virtual void addApplicationDir(const QString &subFolder=QString())
Adds the application installation directory, or if specified a sub-directory.
virtual QStringList getDirectoryList() const
Returns the QStringList containing directories.
virtual void clear()
Clears the current list of directories.
virtual bool strictMode() const
Returns the strict mode flag.
virtual void setStrictMode(const bool &strict)
Sets strict mode which checks that all directories already exist.
virtual void addCtkModuleLoadPath()
Adds the directories denoted by the environment variable CTK_MODULE_LOAD_PATH.