Slicer  4.13
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
qSlicerLoadableModule.h
Go to the documentation of this file.
1 /*==============================================================================
2 
3  Program: 3D Slicer
4 
5  Copyright (c) Kitware Inc.
6 
7  See COPYRIGHT.txt
8  or http://www.slicer.org/copyright/copyright.txt for details.
9 
10  Unless required by applicable law or agreed to in writing, software
11  distributed under the License is distributed on an "AS IS" BASIS,
12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  See the License for the specific language governing permissions and
14  limitations under the License.
15 
16  This file was originally developed by Jean-Christophe Fillion-Robin, Kitware Inc.
17  and was partially funded by NIH grant 3P41RR013218-12S1
18 
19 ==============================================================================*/
20 
21 #ifndef __qSlicerLoadableModule_h
22 #define __qSlicerLoadableModule_h
23 
24 // CTK includes
25 #include <ctkPimpl.h>
26 
27 // Slicer includes
28 #include "qSlicerAbstractModule.h"
29 
30 #include "qSlicerBaseQTGUIExport.h"
31 
32 class qSlicerLoadableModulePrivate;
34 
35 class Q_SLICER_BASE_QTGUI_EXPORT qSlicerLoadableModule : public qSlicerAbstractModule
36 {
37  Q_OBJECT
38 
39 public:
40 
43  qSlicerLoadableModule(QObject *parent=nullptr);
44  ~qSlicerLoadableModule() override;
45 
47  QString helpText()const override;
48  QString acknowledgementText()const override;
49 
67  static bool importModulePythonExtensions(qSlicerCorePythonManager * pythonManager,
68  const QString& intDir,
69  const QString& modulePath,
70  bool isEmbedded=false);
71 
74  static bool addModuleToSlicerModules(qSlicerCorePythonManager * pythonManager,
75  qSlicerAbstractModule *module,
76  const QString& moduleName);
77 
80  static bool addModuleNameToSlicerModuleNames(qSlicerCorePythonManager * pythonManager,
81  const QString& moduleName);
82 
83 protected:
84  void setup() override;
85 
86 protected:
87  QScopedPointer<qSlicerLoadableModulePrivate> d_ptr;
88 
89 private:
90  Q_DECLARE_PRIVATE(qSlicerLoadableModule);
91  Q_DISABLE_COPY(qSlicerLoadableModule);
92 };
93 
95  "org.slicer.modules.loadable.qSlicerLoadableModule/1.0");
96 
97 #endif
qSlicerLoadableModule Self
QScopedPointer< qSlicerLoadableModulePrivate > d_ptr
virtual QString acknowledgementText() const
virtual QString helpText() const
qSlicerAbstractModule Superclass
Q_DECLARE_INTERFACE(qSlicerLoadableModule, "org.slicer.modules.loadable.qSlicerLoadableModule/1.0")
virtual void setup()=0
All initialization code should be done in the setup.