ComponentExplorer Class Reference

The Component Explorer viewer displays the list of all data currently opened in the application. More...

#include <ComponentExplorer.h>

Inheritance diagram for ComponentExplorer:

Collaboration diagram for ComponentExplorer:

Public Slots
void	renameItem ()
	slot called by the explorer menu when the user wants to rename the currently selected Component

Public Member Functions
General
Q_INVOKABLE	ComponentExplorer (QString)
	Construtor.
	~ComponentExplorer () override
	Destructor.
Inherited from Viewer
void	refresh (camitk::Viewer *whoIsAsking=nullptr) override
QWidget *	getWidget () override
	get the explorer widget (QTreeWidget)
QMenu *	getMenu () override
	get the explorer menu
Public Member Functions inherited from camitk::Viewer
QStringList	getComponentClassNames () const
	get the list of Component class manages by this viewer (default is set to "Component", i.e.
QString	getDescription () const
	get the name of the viewer
virtual QDockWidget *	getDockWidget () const
	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)
virtual QLayout *	getEmbedder () const
	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 () const
	get the viewer icon
QString	getName () const
	get the name of the viewer
virtual PropertyObject *	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)
virtual bool	getToolBarVisibility () const
	get the current value of the toolbar visibility
ViewerType	getType () const
	get the viewer layout
QUuid	getUuid () const
	get the Uuid of this viewer
	Q_ENUM (ViewerType) Viewer(QString name
	default constructor
void	setDescription (QString)
	set the viewer's description
virtual 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.
virtual 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)
virtual 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)
bool	setUuid (QUuid id)
	set the Uuid of this viewer
virtual void	setVisible (bool)
	set the visibility of the viewer (show or hide its widget)
virtual	~Viewer () override
	default destructor

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
ViewerType	type = EMBEDDED)
	this viewer's layout
Protected Member Functions inherited from camitk::Viewer
void	clearSelection ()
	clear the selection
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	setComponentClassNames (QStringList)
	set the list of component class names managed by this viewer
void	setIcon (QPixmap icon)
	set the default icon for the viewer extension

Detailed Description

The Component Explorer viewer displays the list of all data currently opened in the application.

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

The component explorer viewer.

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("Component Explorer").

See also

camitk::InterfaceNode

camitk::Viewer

Constructor & Destructor Documentation

ComponentExplorer()

ComponentExplorer::ComponentExplorer

(

QString

name

)

Construtor.

References camitk::Viewer::setDescription(), and camitk::Viewer::setIcon().

Here is the call graph for this function:

~ComponentExplorer()

ComponentExplorer::~ComponentExplorer ( )

override

Destructor.

Member Function Documentation

getMenu()

QMenu * ComponentExplorer::getMenu ( )

overridevirtual

get the explorer menu

Reimplemented from camitk::Viewer.

References camitk::Application::getSelectedComponents(), and renameItem().

Here is the call graph for this function:

getWidget()

QWidget * ComponentExplorer::getWidget ( )

overridevirtual

get the explorer widget (QTreeWidget)

Implements camitk::Viewer.

refresh()

void ComponentExplorer::refresh ( camitk::Viewer *  whoIsAsking = nullptr )

overridevirtual

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

Implements camitk::Viewer.

References camitk::Application::getAllComponents(), camitk::Application::getSelectedComponents(), and camitk::Application::getTopLevelComponents().

Here is the call graph for this function:

renameItem

void ComponentExplorer::renameItem ( )

slot

slot called by the explorer menu when the user wants to rename the currently selected Component

References CAMITK_INFO, camitk::Component::getName(), camitk::Component::refresh(), and camitk::Component::setName().

Referenced by getMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• ComponentExplorer.h
• ComponentExplorer.cpp