Computer Assited Medical Intervention Tool Kit  version 4.1
ActionWidget.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2018 Univ. Grenoble Alpes, CNRS, TIMC-IMAG UMR 5525 (GMCAO)
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 ACTIONWIDGET_H
27 #define ACTIONWIDGET_H
28 
29 // -- Core stuff
30 #include "CamiTKAPI.h"
31 #include "Action.h"
32 
33 //-- Qt
34 #include <QFrame>
35 #include <QLabel>
36 #include <QScrollArea>
37 #include <QTextEdit>
38 
39 namespace camitk {
40 
41 // foward declaration
42 class ObjectController;
43 
73 class CAMITK_API ActionWidget : public QFrame {
74 public:
76  ActionWidget(Action*);
77 
78  ~ActionWidget() override;
79 
81  void update();
82 
84  void setButtonVisibility(bool);
85 
88  void setNameVisibility(bool visible);
89 
92  void setDescriptionVisibility(bool visible);
93 
95  void setAutoUpdateProperty(bool autoUpdate);
96 
97 protected:
99  QString getTargetLabel();
100 
101 private:
103  Action* myAction;
104 
106  ObjectController* objectController;
107 
109  QLabel* targetLabel;
110 
112  QLabel* actionNameLabel;
113 
115  QTextEdit* descriptionTextEdit;
116 
118  QFrame* buttonFrame;
119 
120 };
121 
122 }
123 #endif // ACTIONWIDGET_H
ObjectController
Definition: objectcontroller.h:47
CamiTKAPI.h
camitk::ActionWidget::setButtonVisibility
void setButtonVisibility(bool)
if false then the apply/revert buttons are shown
Definition: ActionWidget.cpp:160
camitk::ActionWidget::setNameVisibility
void setNameVisibility(bool visible)
defines whether the name of the widget is visible or not true by default
Definition: ActionWidget.cpp:165
camitk::ActionWidget::ActionWidget
ActionWidget(Action *)
create a default action widget for the given action
Definition: ActionWidget.cpp:62
camitk::ActionWidget::setAutoUpdateProperty
void setAutoUpdateProperty(bool autoUpdate)
automatically update the action properties whenever there is a change in the GUI
Definition: ActionWidget.cpp:195
camitk::Action::getTargets
const ComponentList getTargets() const
the currently selected and valid (regarding the component property) components, for which this action...
Definition: Action.cpp:159
camitk::ActionWidget::targetLabel
QLabel * targetLabel
the target list label
Definition: ActionWidget.h:132
Action.h
camitk::ActionWidget::buttonFrame
QFrame * buttonFrame
this frame contains the Apply/Revert buttons and can be hide using setButtonVisibility()
Definition: ActionWidget.h:141
camitk::ActionWidget::getTargetLabel
QString getTargetLabel()
return a text with the target component names followed by their class names
Definition: ActionWidget.cpp:183
ActionWidget.h
camitk::ActionWidget::objectController
ObjectController * objectController
the object controller with the properties of the default widget
Definition: ActionWidget.h:129
camitk::ActionWidget::~ActionWidget
~ActionWidget() override
Definition: ActionWidget.cpp:155
camitk::Action
Action class is an abstract class that enables you to build a action (generally on a component)....
Definition: Action.h:230
camitk::ObjectController::setObject
void setObject(QObject *object)
mutatorMethod of the object at unroll in the property browser
Definition: ObjectController.cpp:577
camitk::ObjectController
The object controller class.
Definition: ObjectController.h:185
camitk::ActionViewer::action
Action * action
Current action.
Definition: ActionViewer.h:170
camitk::ActionWidget::actionNameLabel
QLabel * actionNameLabel
the action name displayed in the widget
Definition: ActionWidget.h:135
camitk::Component::getName
QString getName() const override
get the name to be displayed
Definition: sdk/libraries/core/component/Component.h:849
camitk::ObjectController::setAutoUpdateProperty
void setAutoUpdateProperty(bool)
if set, the properties are immediatly updated in the managed object (default false)
Definition: ObjectController.cpp:616
ObjectController.h
MainWindow.h
camitk::ObjectController::BUTTON
@ BUTTON
It is like the GROUPBOX but the buttons allow the user to control the comput display of arborescence.
Definition: ObjectController.h:198
camitk::ActionWidget::update
void update()
update display (target and property controller)
Definition: ActionWidget.cpp:175
camitk::setObjectName
setObjectName("RendererWidget")
camitk::ActionWidget::descriptionTextEdit
QTextEdit * descriptionTextEdit
the description of the action displayed in the widget
Definition: ActionWidget.h:138
camitk::ActionWidget::myAction
Action * myAction
the managed action
Definition: ActionWidget.h:126
camitk::ActionWidget::setDescriptionVisibility
void setDescriptionVisibility(bool visible)
defines whether the description of the widget is visible or not true by default
Definition: ActionWidget.cpp:170
camitk::Component
A Component represents something that could be included in the explorer view, the interactive 3D view...
Definition: sdk/libraries/core/component/Component.h:298
Application.h
CAMITK_API
#define CAMITK_API
Definition: CamiTKAPI.h:49
camitk
Definition: Action.cpp:36