Computer Assited Medical Intervention Tool Kit  version 5.0
InterfaceNode.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 INTERFACENODE_H
27 #define INTERFACENODE_H
28 
29 #include "CamiTKAPI.h"
30 
31 // -- QT stuff classes
32 class QPixmap;
33 class QMenu;
34 class QWidget;
35 
36 namespace camitk {
37 
59 public:
61  virtual ~InterfaceNode() = default;
62 
64  virtual QString getName() const = 0;
65 
67  virtual void setName(const QString&) = 0;
68 
70  virtual const ComponentList& getChildren() = 0;
71 
79  virtual void addChild(InterfaceNode*) = 0;
80 
85  virtual void attachChild(InterfaceNode*) = 0;
86 
88  virtual void removeChild(InterfaceNode*) = 0;
89 
91  virtual void deleteChildren() = 0;
92 
94  virtual InterfaceNode* getParent() = 0;
95 
97  virtual void setParent(InterfaceNode*) = 0;
98 
100  virtual bool inItalic() const = 0;
101 
106  virtual bool doubleClicked() = 0;
107 
139  virtual QPixmap getIcon() = 0;
140 
142  virtual QMenu* getPopupMenu(QWidget* parent = nullptr) = 0;
143 
146  virtual void setNodeModified(bool) = 0;
147 
149  virtual bool getNodeModified() const = 0;
150 };
151 
152 
153 }
154 
155 #endif
camitk::InterfaceNode::getPopupMenu
virtual QMenu * getPopupMenu(QWidget *parent=nullptr)=0
get the popup menu to display (or NULL if inexistant)
camitk::InterfaceNode::getNodeModified
virtual bool getNodeModified() const =0
Get the current modification flag.
camitk::InterfaceNode::getIcon
virtual QPixmap getIcon()=0
Get the pixmap that will be displayed for this node.
camitk::InterfaceNode::setNodeModified
virtual void setNodeModified(bool)=0
Set up the node modification flag.
CamiTKAPI.h
camitk::InterfaceNode::deleteChildren
virtual void deleteChildren()=0
delete all sub Component, but do not delete the pointer (only the top-level component has the right t...
camitk::InterfaceNode::doubleClicked
virtual bool doubleClicked()=0
this method is called each time the InterfaceNode is double clicked by the user.
camitk::InterfaceNode::getParent
virtual InterfaceNode * getParent()=0
get the parent Component
camitk::InterfaceNode::getChildren
virtual const ComponentList & getChildren()=0
get the list of the InterfaceNode children (sub items in the hierarchy)
camitk::InterfaceNode::setName
virtual void setName(const QString &)=0
set the name to be displayed
camitk::InterfaceNode::~InterfaceNode
virtual ~InterfaceNode()=default
empty virtual destructor, to avoid memory leak
camitk::InterfaceNode::inItalic
virtual bool inItalic() const =0
should the name be displayed in italic?
camitk::InterfaceNode::attachChild
virtual void attachChild(InterfaceNode *)=0
add a child Component (but leave its parent unchanged)
camitk::ComponentList
QList< Component * > ComponentList
A list of Component.
Definition: CamiTKAPI.h:127
camitk::InterfaceNode::addChild
virtual void addChild(InterfaceNode *)=0
add a child Component (sub item in the hierarchy), and modify the child's parent to be equal to this ...
camitk::InterfaceNode::removeChild
virtual void removeChild(InterfaceNode *)=0
remove a sub Component (only the top-level component has the right to do that)
camitk::InterfaceNode::setParent
virtual void setParent(InterfaceNode *)=0
set the parent Component
camitk::InterfaceNode::getName
virtual QString getName() const =0
get the name to be displayed
camitk::InterfaceNode
This class describe what are the methods to implement for a hierarchical tree node.
Definition: InterfaceNode.h:58
camitk
Definition: Action.cpp:35