Display the tool selection state of a mitk::ToolManager. More...

#include <QmitkToolSelectionBox.h>

Inheritance diagram for QmitkToolSelectionBox:

Collaboration diagram for QmitkToolSelectionBox:

[legend]

Public Slots
virtual void	setEnabled (bool)
	Enables or disables the widget and all its tool buttons. More...

virtual void	SetLayoutColumns (int)
	Sets the number of columns for the tool button grid layout. More...

virtual void	SetShowNames (bool)
	Sets whether tool names are displayed alongside their icons. More...

virtual void	SetGenerateAccelerators (bool)
	Sets whether keyboard accelerators (shortcuts) are generated for tools. More...

virtual void	SetToolGUIArea (QWidget *parentWidget)
	Sets the parent widget where tool-specific GUIs will be displayed. More...

void	SetMultiLabelInspector (QmitkMultiLabelInspector *inspector)
	Sets the label inspector forwarded to each created tool GUI. More...

Signals
void	ToolSelected (int id)

Public Member Functions
	QmitkToolSelectionBox (QWidget parent=nullptr, mitk::DataStorage storage=nullptr)
	Constructs the tool selection box widget. More...

	~QmitkToolSelectionBox () override

mitk::ToolManager *	GetToolManager ()
	Returns the associated ToolManager. More...

void	SetToolManager (mitk::ToolManager &)
	Sets the associated ToolManager. A valid manager is required (no nullptr). More...

void	SetDisplayedToolGroups (const std::string &toolGroups={})
	Specifies which tool groups should be displayed in this widget. More...

void	OnToolManagerToolModified ()
	Called when a tool is modified. Public for itk::Command callbacks. More...

void	OnToolManagerReferenceDataModified ()
	Called when reference data is modified. Public for itk::Command callbacks. More...

void	OnToolManagerWorkingDataModified ()
	Called when working data is modified. Public for itk::Command callbacks. More...

void	OnToolGUIProcessEventsMessage ()
	Called to process pending GUI events from a tool. Public for itk::Command callbacks. More...

void	OnToolErrorMessage (std::string s)
	Called when a tool reports an error message. Public for itk::Command callbacks. More...

void	OnGeneralToolMessage (std::string s)
	Called when a tool reports a general status message. Public for itk::Command callbacks. More...

void	RecreateButtons ()
	Destroys and recreates all tool buttons based on the current ToolManager state. More...

Protected Slots
void	toolButtonClicked (int id)

void	UpdateButtonsEnabledState ()

Protected Member Functions
void	SetOrUnsetButtonForActiveTool ()

Protected Attributes
mitk::ToolManager::Pointer	m_ToolManager

bool	m_SelfCall

std::string	m_DisplayedGroups

std::map< int, int >	m_ButtonIDForToolID
	stores relationship between button IDs of the Qt widget and tool IDs of ToolManager More...

std::map< int, int >	m_ToolIDForButtonID
	stores relationship between button IDs of the Qt widget and tool IDs of ToolManager More...

int	m_LayoutColumns

bool	m_ShowNames

bool	m_GenerateAccelerators

QWidget *	m_ToolGUIWidget

QmitkToolGUI *	m_LastToolGUI

QmitkMultiLabelInspector *	m_MultiLabelInspector

QButtonGroup *	m_ToolButtonGroup

QGridLayout *	m_ButtonLayout

Detailed Description

Display the tool selection state of a mitk::ToolManager.

See also: mitk::ToolManager

This widget graphically displays the active tool of a mitk::ToolManager as a set of toggle buttons. Each button show the identification of a Tool (icon and name). When a button's toggle state is "down", the tool is activated. When a different button is clicked, the active tool is switched. When you click an already active button, the associated tool is deactivated with no replacement, which means that no tool is active then.

When this widget is enabled/disabled it (normally) also enables/disables the tools. There could be cases where two QmitkToolSelectionBox widgets are associated to the same ToolManager, but if this happens, please look deeply into the code.

Definition at line 49 of file QmitkToolSelectionBox.h.

Constructor & Destructor Documentation

◆ QmitkToolSelectionBox()

QmitkToolSelectionBox::QmitkToolSelectionBox	(	QWidget *	parent = `nullptr`,
		mitk::DataStorage *	storage = `nullptr`
	)

Constructs the tool selection box widget.

◆ ~QmitkToolSelectionBox()

QmitkToolSelectionBox::~QmitkToolSelectionBox ( )

override

Member Function Documentation

◆ GetToolManager()

mitk::ToolManager* QmitkToolSelectionBox::GetToolManager ( )

Returns the associated ToolManager.

◆ OnGeneralToolMessage()

void QmitkToolSelectionBox::OnGeneralToolMessage ( std::string s )

Called when a tool reports a general status message. Public for itk::Command callbacks.

◆ OnToolErrorMessage()

void QmitkToolSelectionBox::OnToolErrorMessage ( std::string s )

Called when a tool reports an error message. Public for itk::Command callbacks.

◆ OnToolGUIProcessEventsMessage()

void QmitkToolSelectionBox::OnToolGUIProcessEventsMessage ( )

Called to process pending GUI events from a tool. Public for itk::Command callbacks.

◆ OnToolManagerReferenceDataModified()

void QmitkToolSelectionBox::OnToolManagerReferenceDataModified ( )

Called when reference data is modified. Public for itk::Command callbacks.

◆ OnToolManagerToolModified()

void QmitkToolSelectionBox::OnToolManagerToolModified ( )

Called when a tool is modified. Public for itk::Command callbacks.

◆ OnToolManagerWorkingDataModified()

void QmitkToolSelectionBox::OnToolManagerWorkingDataModified ( )

Called when working data is modified. Public for itk::Command callbacks.

◆ RecreateButtons()

void QmitkToolSelectionBox::RecreateButtons ( )

Destroys and recreates all tool buttons based on the current ToolManager state.

◆ SetDisplayedToolGroups()

void QmitkToolSelectionBox::SetDisplayedToolGroups ( const std::string & toolGroups = {} )

Specifies which tool groups should be displayed in this widget.

Every Tool can report its group as a string. This method will try to find the tool's group inside the supplied string toolGroups. If there is a match, the tool is displayed. Effectively, you can provide a human readable list like "default, lymphnodevolumetry, oldERISstuff".

Parameters

toolGroups A comma-separated string of tool group names to display.

◆ setEnabled

virtual void QmitkToolSelectionBox::setEnabled ( bool )

virtualslot

Enables or disables the widget and all its tool buttons.

◆ SetGenerateAccelerators

virtual void QmitkToolSelectionBox::SetGenerateAccelerators ( bool )

virtualslot

Sets whether keyboard accelerators (shortcuts) are generated for tools.

◆ SetLayoutColumns

virtual void QmitkToolSelectionBox::SetLayoutColumns ( int )

virtualslot

Sets the number of columns for the tool button grid layout.

◆ SetMultiLabelInspector

void QmitkToolSelectionBox::SetMultiLabelInspector ( QmitkMultiLabelInspector * inspector )

slot

Sets the label inspector forwarded to each created tool GUI.

The inspector is propagated to every QmitkToolGUI right after SetTool(), giving tool GUIs a deterministic handle to the host's label-management widget. Pointer ownership stays with the caller; lifetime must outlive any tool GUI that consults it. May be null.

◆ SetOrUnsetButtonForActiveTool()

void QmitkToolSelectionBox::SetOrUnsetButtonForActiveTool ( )

protected

◆ SetShowNames

virtual void QmitkToolSelectionBox::SetShowNames ( bool )

virtualslot

Sets whether tool names are displayed alongside their icons.

◆ SetToolGUIArea

virtual void QmitkToolSelectionBox::SetToolGUIArea ( QWidget * parentWidget )

virtualslot

Sets the parent widget where tool-specific GUIs will be displayed.

◆ SetToolManager()

void QmitkToolSelectionBox::SetToolManager ( mitk::ToolManager & )

Sets the associated ToolManager. A valid manager is required (no nullptr).

◆ toolButtonClicked

void QmitkToolSelectionBox::toolButtonClicked ( int id )

protectedslot

◆ ToolSelected

void QmitkToolSelectionBox::ToolSelected ( int id )

signal

Whenever a tool is activated. id is the index of the active tool. Counting starts at 0, -1 indicates "no tool selected" This signal is also emitted, when the whole QmitkToolSelectionBox get disabled. Then it will claim ToolSelected(-1) When it is enabled again, there will be another ToolSelected event with the tool that is currently selected

◆ UpdateButtonsEnabledState

void QmitkToolSelectionBox::UpdateButtonsEnabledState ( )

protectedslot

Member Data Documentation

◆ m_ButtonIDForToolID

std::map<int, int> QmitkToolSelectionBox::m_ButtonIDForToolID

protected

stores relationship between button IDs of the Qt widget and tool IDs of ToolManager

Definition at line 140 of file QmitkToolSelectionBox.h.

◆ m_ButtonLayout

QGridLayout* QmitkToolSelectionBox::m_ButtonLayout

protected

Definition at line 154 of file QmitkToolSelectionBox.h.

◆ m_DisplayedGroups

std::string QmitkToolSelectionBox::m_DisplayedGroups

protected

Definition at line 137 of file QmitkToolSelectionBox.h.

◆ m_GenerateAccelerators

bool QmitkToolSelectionBox::m_GenerateAccelerators

protected

Definition at line 146 of file QmitkToolSelectionBox.h.

◆ m_LastToolGUI

QmitkToolGUI* QmitkToolSelectionBox::m_LastToolGUI

protected

Definition at line 149 of file QmitkToolSelectionBox.h.

◆ m_LayoutColumns

int QmitkToolSelectionBox::m_LayoutColumns

protected

Definition at line 144 of file QmitkToolSelectionBox.h.

◆ m_MultiLabelInspector

QmitkMultiLabelInspector* QmitkToolSelectionBox::m_MultiLabelInspector

protected

Definition at line 150 of file QmitkToolSelectionBox.h.

◆ m_SelfCall

bool QmitkToolSelectionBox::m_SelfCall

protected

Definition at line 135 of file QmitkToolSelectionBox.h.

◆ m_ShowNames

bool QmitkToolSelectionBox::m_ShowNames

protected

Definition at line 145 of file QmitkToolSelectionBox.h.

◆ m_ToolButtonGroup

QButtonGroup* QmitkToolSelectionBox::m_ToolButtonGroup

protected

Definition at line 153 of file QmitkToolSelectionBox.h.

◆ m_ToolGUIWidget

QWidget* QmitkToolSelectionBox::m_ToolGUIWidget

protected

Definition at line 148 of file QmitkToolSelectionBox.h.

◆ m_ToolIDForButtonID

std::map<int, int> QmitkToolSelectionBox::m_ToolIDForButtonID

protected

stores relationship between button IDs of the Qt widget and tool IDs of ToolManager

Definition at line 142 of file QmitkToolSelectionBox.h.

◆ m_ToolManager

mitk::ToolManager::Pointer QmitkToolSelectionBox::m_ToolManager

protected

Definition at line 133 of file QmitkToolSelectionBox.h.

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

QmitkToolSelectionBox.h

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QmitkToolSelectionBox()

◆ ~QmitkToolSelectionBox()

Member Function Documentation

◆ GetToolManager()

◆ OnGeneralToolMessage()

◆ OnToolErrorMessage()

◆ OnToolGUIProcessEventsMessage()

◆ OnToolManagerReferenceDataModified()

◆ OnToolManagerToolModified()

◆ OnToolManagerWorkingDataModified()

◆ RecreateButtons()

◆ SetDisplayedToolGroups()

◆ setEnabled

◆ SetGenerateAccelerators

◆ SetLayoutColumns

◆ SetMultiLabelInspector

◆ SetOrUnsetButtonForActiveTool()

◆ SetShowNames

◆ SetToolGUIArea

◆ SetToolManager()

◆ toolButtonClicked

◆ ToolSelected

◆ UpdateButtonsEnabledState

Member Data Documentation

◆ m_ButtonIDForToolID

◆ m_ButtonLayout

◆ m_DisplayedGroups

◆ m_GenerateAccelerators

◆ m_LastToolGUI

◆ m_LayoutColumns

◆ m_MultiLabelInspector

◆ m_SelfCall

◆ m_ShowNames

◆ m_ToolButtonGroup

◆ m_ToolGUIWidget

◆ m_ToolIDForButtonID

◆ m_ToolManager