Computer Assited Medical Intervention Tool Kit  version 5.0
ActionExtension.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2021 Univ. Grenoble Alpes, CNRS, Grenoble INP, TIMC, 38000 Grenoble, France
6  *
7  * Visit http://camitk.imag.fr for more information
8  *
9  * This file is part of CamiTK.
10  *
11  * CamiTK is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * CamiTK is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License version 3 for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
22  *
23  * $CAMITK_LICENCE_END$
24  ****************************************************************************/
25 
26 #ifndef ACTION_EXTENSION_H
27 #define ACTION_EXTENSION_H
28 
29 #include "CamiTKAPI.h"
30 
31 // -- QT stuff
32 #include <QObject>
33 #include <QTranslator>
34 
35 namespace camitk {
36 class Action;
37 
38 // a bit simplistic, but greatly simply syntax (and explanation)
39 // to be used in an ActionExtension register method
40 #define registerNewAction(X) registerAction(new X(this))
41 
57 class CAMITK_API ActionExtension : public QObject {
58 
59 protected :
61  ActionExtension();
62 
63 public :
65  ~ActionExtension() override;
66 
68  virtual QString getName() = 0;
69 
71  virtual QString getDescription() = 0;
72 
74  virtual void init() = 0;
75 
77  const ActionList& getActions();
78 
80  void setLocation(const QString loc);
81 
83  QString getLocation() const;
84 
86  void initResources();
87 
88 protected:
90  void registerAction(Action*);
91 
93  ActionList actions;
94 
95 private:
97  QString dynamicLibraryFileName;
98 
100  QTranslator* translator;
101 };
102 
103 }
104 // -------------------- declare the interface for QPluginLoader --------------------
105 Q_DECLARE_INTERFACE(camitk::ActionExtension, "TIMC-IMAG. Action Extension/2.1")
106 
107 
108 #endif //ACTION_EXTENSION_H
CamiTKAPI.h
camitk::Application::getSelectedLanguage
static QString getSelectedLanguage()
Returns for the current CamiTK application, the selected language (stored in its ....
Definition: Application.cpp:1437
CAMITK_INFO
#define CAMITK_INFO(MSG)
Log for info verbosity (the second most verbose one) The msg will appear only if the user asked for I...
Definition: Log.h:261
Action.h
camitk::ActionList
QList< Action * > ActionList
A list of Action.
Definition: CamiTKAPI.h:136
ActionExtension.h
camitk::ActionExtension::translator
QTranslator * translator
Provide internationalization support for text output.
Definition: ActionExtension.h:123
Log.h
camitk::Action
Action class is an abstract class that enables you to build a action (generally on a component)....
Definition: Action.h:231
camitk::ActionExtension::registerAction
void registerAction(Action *)
register an action instance
Definition: ActionExtension.cpp:116
camitk::ActionExtension::initResources
void initResources()
Load, for the selected langage (asked to the Application), the associated .qm file.
Definition: ActionExtension.cpp:94
camitk::ActionExtension
This class describes what is a generic Action extension. To add a ActionExtension to CamiTK core,...
Definition: ActionExtension.h:80
camitk::ActionExtension::getActions
const ActionList & getActions()
get the list of actions registered y this extension
Definition: ActionExtension.cpp:122
Core.h
camitk::ActionExtension::ActionExtension
ActionExtension()
constructor
Definition: ActionExtension.cpp:62
camitk::ActionExtension::actions
ActionList actions
the list of actions
Definition: ActionExtension.h:116
camitk::ActionExtension::setLocation
void setLocation(const QString loc)
set the file path (once loaded as a dynamic library)
Definition: ActionExtension.cpp:84
camitk::ActionExtension::getLocation
QString getLocation() const
get the file path (location of the .dll/.so/.dylib) of this plugin
Definition: ActionExtension.cpp:89
camitk::ActionExtension::dynamicLibraryFileName
QString dynamicLibraryFileName
the shared lib (.so, .dll or .dylib) used to instantiate the ComponentExtension subclass instance
Definition: ActionExtension.h:120
camitk::ActionExtension::~ActionExtension
~ActionExtension() override
destructor
Definition: ActionExtension.cpp:67
Application.h
CAMITK_API
#define CAMITK_API
Definition: CamiTKAPI.h:49
camitk
Definition: Action.cpp:35