Computer Assisted Medical Intervention Tool Kit  version 5.1
 
Loading...
Searching...
No Matches
FrameExplorer Class Reference

Frame Explorer window, display the hierachy of the frames of all the data currently opened in the application. More...

#include <FrameExplorer.h>

Public Member Functions

General
Q_INVOKABLE FrameExplorer (QString)
 Construtor.
 
 ~FrameExplorer () override=default
 Destructor.
 
- Public Member Functions inherited from camitk::Viewer
*get the list of Component class manages by this viewer *default is set to i e all type of Component *QStringList getComponentClassNames ()
 
QString getDescription () const
 get the name of the viewer
 
QDockWidget * getDockWidget ()
 Get the QDockWidget* where this viewer is currently docked (or nullptr if it is not docked anywhere or if the viewer is of type EMBEDDED)
 
QLayout * getEmbedder ()
 Get the QLayout* where this viewer is currently embedded (or nullptr if it is not embedded anywhere or if the viewer is of type DOCKED)
 
virtual QPixmap getIcon ()
 get the viewer icon
 
virtual QMenu * getMenu ()
 get the viewer menu (returns nullptr by default, i.e. there are no default edit menu)
 
QString getName () const
 get the name of the viewer
 
virtual QObject * getPropertyObject ()
 get the viewer property object (returns nullptr by default, i.e. there are no property to edit)
 
virtual QToolBar * getToolBar ()
 get the viewer toolbar (returns nullptr by default, i.e. there are no default toolbar)
 
bool getToolBarVisibility ()
 get the current value of the toolbar visibility
 
ViewerType getType ()
 get the viewer layout
 
 Q_ENUM (ViewerType) Viewer(QString name
 default constructor
 
virtual void refresh (Viewer *whoIsAsking=nullptr)=0
 refresh the view (can be interesting to know which other viewer is calling this)
 
bool setDockWidget (QDockWidget *)
 If the viewer type is DOCKED, dock the widget inside the given dock widget (do nothing if the type is EMBEDDED or if the viewer has already been docked before) Note that once set, the dock widget cannot be modified.
 
bool setEmbedder (QLayout *)
 If the viewer type is EMBEDDED, embed the viewer widget in the given layout (do nothing if the type is DOCKED) Note that you can call this method any time you want to move the viewer's widget to another layout (but there is only one embedder at a time)
 
void setToolBarVisibility (bool)
 set the visibility of the toolbar in the main window (true by default).
 
void setType (ViewerType)
 set the viewer layout (the type can be changed dynamically to fit the developer's purpose)
 
void setVisible (bool)
 set the visibility of the viewer (show or hide its widget)
 
virtual ~Viewer () override
 default destructor
 

Inherited from Viewer

void refresh (Viewer *whoIsAsking=nullptr) override
 
QWidget * getWidget () override
 get the frame explorer widget (QTreeWidget)
 

Additional Inherited Members

- Public Types inherited from camitk::Viewer
enum  ViewerType { EMBEDDED , DOCKED }
 describes where this viewer should appear More...
 
- Signals inherited from camitk::Viewer
void selectionChanged ()
 this signal is emitted when the current selection was changed by the viewer
 
- Public Attributes inherited from camitk::Viewer
*get the list of Component class manages by this viewer *default is set to Component
 
ViewerType type = EMBEDDED)
 this viewer's layout
 
- Protected Member Functions inherited from camitk::Viewer
void clearSelection ()
 clear the selection
 
*set the list of component class names managed by this viewer *note Default is set to Component (all type of components) */void setComponentClassNames(QStringList)
 
void selectionChanged (Component *comp)
 the selection has changed to be just one comp
 
void selectionChanged (ComponentList &compSet)
 The selection has changed to the given ComponentList.
 
void setDescription (QString)
 set the viewer's description
 
void setIcon (QPixmap icon)
 set the default icon for the viewer extension
 

Detailed Description

Frame Explorer window, display the hierachy of the frames of all the data currently opened in the application.

All frames are displayed in a QListView widget and can be selected (single/multiple selection is available).

It manages the camitk::InterfaceNode facet of components.

If this viewer extension is loaded, the default instance of this viewer can be accessed directly by Application::getViewer("Frame Explorer").

See also
camitk::InterfaceFrame
camitk::Viewer

Constructor & Destructor Documentation

◆ FrameExplorer()

FrameExplorer::FrameExplorer ( QString  name)

◆ ~FrameExplorer()

FrameExplorer::~FrameExplorer ( )
overridedefault

Destructor.

Member Function Documentation

◆ getWidget()

QWidget * FrameExplorer::getWidget ( )
overridevirtual

get the frame explorer widget (QTreeWidget)

Implements camitk::Viewer.

◆ refresh()

void FrameExplorer::refresh ( Viewer whoIsAsking = nullptr)
override

refresh the frame explorer (can be interesting to know which other viewer is calling this)

References camitk::Application::getAllComponents().


The documentation for this class was generated from the following files: