Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
Public Types | Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
QmitkToolSelectionBox Class Reference
Classes related to the Segmentation plugin

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

#include <QmitkToolSelectionBox.h>

Inheritance diagram for QmitkToolSelectionBox:
Inheritance graph
[legend]
Collaboration diagram for QmitkToolSelectionBox:
Collaboration graph
[legend]

Public Types

enum  EnabledMode { EnabledWithReferenceAndWorkingDataVisible, EnabledWithReferenceData, EnabledWithWorkingData, AlwaysEnabled }
 

Public Slots

virtual void setEnabled (bool)
 
virtual void SetEnabledMode (EnabledMode mode)
 
virtual void SetLayoutColumns (int)
 
virtual void SetShowNames (bool)
 
virtual void SetGenerateAccelerators (bool)
 
virtual void SetToolGUIArea (QWidget *parentWidget)
 

Signals

void ToolSelected (int id)
 

Public Member Functions

 QmitkToolSelectionBox (QWidget *parent=nullptr, mitk::DataStorage *storage=nullptr)
 
 ~QmitkToolSelectionBox () override
 
mitk::ToolManager * GetToolManager ()
 
void SetToolManager (mitk::ToolManager &)
 
void setTitle (const QString &title)
 
void SetDisplayedToolGroups (const std::string &toolGroups=nullptr)
 
void OnToolManagerToolModified ()
 
void OnToolManagerReferenceDataModified ()
 
void OnToolManagerWorkingDataModified ()
 
void OnToolGUIProcessEventsMessage ()
 
void OnToolErrorMessage (std::string s)
 
void OnGeneralToolMessage (std::string s)
 
void RecreateButtons ()
 

Protected Slots

void toolButtonClicked (int id)
 
void SetGUIEnabledAccordingToToolManagerState ()
 

Protected Member Functions

void showEvent (QShowEvent *) override
 
void hideEvent (QHideEvent *) override
 
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
 
QButtonGroup * m_ToolButtonGroup
 
QGridLayout * m_ButtonLayout
 
EnabledMode m_EnabledMode
 

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.

Last contributor:

Author
maleike

Definition at line 50 of file QmitkToolSelectionBox.h.

Member Enumeration Documentation

◆ EnabledMode

enum QmitkToolSelectionBox::EnabledMode
Enumerator
EnabledWithReferenceAndWorkingDataVisible 
EnabledWithReferenceData 
EnabledWithWorkingData 
AlwaysEnabled 

Definition at line 56 of file QmitkToolSelectionBox.h.

Constructor & Destructor Documentation

◆ QmitkToolSelectionBox()

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

Definition at line 34 of file QmitkToolSelectionBox.cpp.

References mitk::ToolManagerProvider::GetInstance(), mitk::ToolManagerProvider::GetToolManager(), m_ToolButtonGroup, m_ToolManager, OnToolManagerReferenceDataModified(), OnToolManagerToolModified(), OnToolManagerWorkingDataModified(), RecreateButtons(), SetOrUnsetButtonForActiveTool(), and toolButtonClicked().

◆ ~QmitkToolSelectionBox()

QmitkToolSelectionBox::~QmitkToolSelectionBox ( )
override

Definition at line 85 of file QmitkToolSelectionBox.cpp.

References m_ToolManager, OnToolManagerReferenceDataModified(), OnToolManagerToolModified(), and OnToolManagerWorkingDataModified().

Member Function Documentation

◆ GetToolManager()

mitk::ToolManager * QmitkToolSelectionBox::GetToolManager ( )

Definition at line 101 of file QmitkToolSelectionBox.cpp.

References m_ToolManager.

◆ hideEvent()

void QmitkToolSelectionBox::hideEvent ( QHideEvent *  e)
overrideprotected

Definition at line 712 of file QmitkToolSelectionBox.cpp.

References SetGUIEnabledAccordingToToolManagerState().

◆ OnGeneralToolMessage()

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

Definition at line 647 of file QmitkToolSelectionBox.cpp.

Referenced by RecreateButtons().

◆ OnToolErrorMessage()

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

Definition at line 641 of file QmitkToolSelectionBox.cpp.

Referenced by RecreateButtons().

◆ OnToolGUIProcessEventsMessage()

void QmitkToolSelectionBox::OnToolGUIProcessEventsMessage ( )

Definition at line 636 of file QmitkToolSelectionBox.cpp.

Referenced by RecreateButtons().

◆ OnToolManagerReferenceDataModified()

void QmitkToolSelectionBox::OnToolManagerReferenceDataModified ( )

Definition at line 293 of file QmitkToolSelectionBox.cpp.

References m_SelfCall, MITK_DEBUG, and SetGUIEnabledAccordingToToolManagerState().

Referenced by QmitkToolSelectionBox(), SetToolManager(), and ~QmitkToolSelectionBox().

◆ OnToolManagerToolModified()

void QmitkToolSelectionBox::OnToolManagerToolModified ( )

Definition at line 176 of file QmitkToolSelectionBox.cpp.

References SetOrUnsetButtonForActiveTool().

Referenced by QmitkToolSelectionBox(), SetToolManager(), and ~QmitkToolSelectionBox().

◆ OnToolManagerWorkingDataModified()

void QmitkToolSelectionBox::OnToolManagerWorkingDataModified ( )

Definition at line 303 of file QmitkToolSelectionBox.cpp.

References m_SelfCall, MITK_DEBUG, and SetGUIEnabledAccordingToToolManagerState().

Referenced by QmitkToolSelectionBox(), SetToolManager(), and ~QmitkToolSelectionBox().

◆ RecreateButtons()

void QmitkToolSelectionBox::RecreateButtons ( )

Definition at line 376 of file QmitkToolSelectionBox.cpp.

References mitk::Tool::CanHandle(), mitk::Tool::ErrorMessage, mitk::Tool::GeneralMessage, mitk::DataNode::GetData(), mitk::Tool::GetGroup(), mitk::Tool::GetIconResource(), mitk::Tool::GetName(), us::ModuleResource::GetSuffix(), mitk::Tool::GetXPM(), mitk::Tool::GUIProcessEventsMessage, Json::in(), us::ModuleResource::IsValid(), m_ButtonIDForToolID, m_ButtonLayout, m_DisplayedGroups, m_GenerateAccelerators, m_LayoutColumns, m_ShowNames, m_ToolButtonGroup, m_ToolIDForButtonID, m_ToolManager, MITK_DEBUG, OnGeneralToolMessage(), OnToolErrorMessage(), OnToolGUIProcessEventsMessage(), and QmitkStyleManager::ThemeIcon().

Referenced by QmitkToolSelectionBox(), SetDisplayedToolGroups(), SetGenerateAccelerators(), SetLayoutColumns(), SetShowNames(), and SetToolManager().

◆ SetDisplayedToolGroups()

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

You may specify a list of tool "groups" that 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

Parameters
toolGroups.If there is a match, the tool is displayed. Effectively, you can provide a human readable list like "default, lymphnodevolumetry, oldERISstuff".

Definition at line 653 of file QmitkToolSelectionBox.cpp.

References m_DisplayedGroups, MITK_DEBUG, RecreateButtons(), and SetOrUnsetButtonForActiveTool().

◆ setEnabled

void QmitkToolSelectionBox::setEnabled ( bool  )
virtualslot

External enableization...

Definition at line 371 of file QmitkToolSelectionBox.cpp.

References SetGUIEnabledAccordingToToolManagerState().

◆ SetEnabledMode

void QmitkToolSelectionBox::SetEnabledMode ( EnabledMode  mode)
virtualslot

Definition at line 95 of file QmitkToolSelectionBox.cpp.

References m_EnabledMode, and SetGUIEnabledAccordingToToolManagerState().

◆ SetGenerateAccelerators

void QmitkToolSelectionBox::SetGenerateAccelerators ( bool  accel)
virtualslot

Definition at line 688 of file QmitkToolSelectionBox.cpp.

References m_GenerateAccelerators, and RecreateButtons().

◆ SetGUIEnabledAccordingToToolManagerState

void QmitkToolSelectionBox::SetGUIEnabledAccordingToToolManagerState ( )
protectedslot

Implementes the logic, which decides, when tools are activated/deactivated.

Definition at line 316 of file QmitkToolSelectionBox.cpp.

References AlwaysEnabled, EnabledWithReferenceAndWorkingDataVisible, EnabledWithReferenceData, EnabledWithWorkingData, mitk::BaseRenderer::GetInstance(), mitk::BaseRenderer::GetRenderWindowByName(), mitk::DataNode::IsVisible(), m_EnabledMode, m_ToolManager, and ToolSelected().

Referenced by hideEvent(), OnToolManagerReferenceDataModified(), OnToolManagerWorkingDataModified(), setEnabled(), SetEnabledMode(), and showEvent().

◆ SetLayoutColumns

void QmitkToolSelectionBox::SetLayoutColumns ( int  columns)
virtualslot

Definition at line 670 of file QmitkToolSelectionBox.cpp.

References m_LayoutColumns, and RecreateButtons().

◆ SetOrUnsetButtonForActiveTool()

void QmitkToolSelectionBox::SetOrUnsetButtonForActiveTool ( )
protected

Definition at line 181 of file QmitkToolSelectionBox.cpp.

References mitk::Tool::GetGroup(), mitk::Tool::GetGUI(), m_ButtonIDForToolID, m_LastToolGUI, m_ToolButtonGroup, m_ToolGUIWidget, m_ToolManager, QmitkToolGUI::SetTool(), and ToolSelected().

Referenced by OnToolManagerToolModified(), QmitkToolSelectionBox(), SetDisplayedToolGroups(), and SetToolManager().

◆ SetShowNames

void QmitkToolSelectionBox::SetShowNames ( bool  show)
virtualslot

Definition at line 679 of file QmitkToolSelectionBox.cpp.

References m_ShowNames, and RecreateButtons().

◆ setTitle()

void QmitkToolSelectionBox::setTitle ( const QString &  title)

Definition at line 702 of file QmitkToolSelectionBox.cpp.

◆ SetToolGUIArea

void QmitkToolSelectionBox::SetToolGUIArea ( QWidget *  parentWidget)
virtualslot

Definition at line 697 of file QmitkToolSelectionBox.cpp.

References m_ToolGUIWidget.

◆ SetToolManager()

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

Definition at line 106 of file QmitkToolSelectionBox.cpp.

References m_ToolManager, OnToolManagerReferenceDataModified(), OnToolManagerToolModified(), OnToolManagerWorkingDataModified(), RecreateButtons(), and SetOrUnsetButtonForActiveTool().

◆ showEvent()

void QmitkToolSelectionBox::showEvent ( QShowEvent *  e)
overrideprotected

Definition at line 706 of file QmitkToolSelectionBox.cpp.

References SetGUIEnabledAccordingToToolManagerState().

◆ toolButtonClicked

void QmitkToolSelectionBox::toolButtonClicked ( int  id)
protectedslot

Definition at line 142 of file QmitkToolSelectionBox.cpp.

References m_ButtonIDForToolID, m_SelfCall, m_ToolButtonGroup, m_ToolIDForButtonID, m_ToolManager, and MITK_DEBUG.

Referenced by QmitkToolSelectionBox().

◆ 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

Referenced by SetGUIEnabledAccordingToToolManagerState(), and SetOrUnsetButtonForActiveTool().

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 129 of file QmitkToolSelectionBox.h.

Referenced by RecreateButtons(), SetOrUnsetButtonForActiveTool(), and toolButtonClicked().

◆ m_ButtonLayout

QGridLayout* QmitkToolSelectionBox::m_ButtonLayout
protected

Definition at line 142 of file QmitkToolSelectionBox.h.

Referenced by RecreateButtons().

◆ m_DisplayedGroups

std::string QmitkToolSelectionBox::m_DisplayedGroups
protected

Definition at line 126 of file QmitkToolSelectionBox.h.

Referenced by RecreateButtons(), and SetDisplayedToolGroups().

◆ m_EnabledMode

EnabledMode QmitkToolSelectionBox::m_EnabledMode
protected

Definition at line 144 of file QmitkToolSelectionBox.h.

Referenced by SetEnabledMode(), and SetGUIEnabledAccordingToToolManagerState().

◆ m_GenerateAccelerators

bool QmitkToolSelectionBox::m_GenerateAccelerators
protected

Definition at line 135 of file QmitkToolSelectionBox.h.

Referenced by RecreateButtons(), and SetGenerateAccelerators().

◆ m_LastToolGUI

QmitkToolGUI* QmitkToolSelectionBox::m_LastToolGUI
protected

Definition at line 138 of file QmitkToolSelectionBox.h.

Referenced by SetOrUnsetButtonForActiveTool().

◆ m_LayoutColumns

int QmitkToolSelectionBox::m_LayoutColumns
protected

Definition at line 133 of file QmitkToolSelectionBox.h.

Referenced by RecreateButtons(), and SetLayoutColumns().

◆ m_SelfCall

bool QmitkToolSelectionBox::m_SelfCall
protected

Definition at line 124 of file QmitkToolSelectionBox.h.

Referenced by OnToolManagerReferenceDataModified(), OnToolManagerWorkingDataModified(), and toolButtonClicked().

◆ m_ShowNames

bool QmitkToolSelectionBox::m_ShowNames
protected

Definition at line 134 of file QmitkToolSelectionBox.h.

Referenced by RecreateButtons(), and SetShowNames().

◆ m_ToolButtonGroup

QButtonGroup* QmitkToolSelectionBox::m_ToolButtonGroup
protected

Definition at line 141 of file QmitkToolSelectionBox.h.

Referenced by QmitkToolSelectionBox(), RecreateButtons(), SetOrUnsetButtonForActiveTool(), and toolButtonClicked().

◆ m_ToolGUIWidget

QWidget* QmitkToolSelectionBox::m_ToolGUIWidget
protected

Definition at line 137 of file QmitkToolSelectionBox.h.

Referenced by SetOrUnsetButtonForActiveTool(), and SetToolGUIArea().

◆ 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 131 of file QmitkToolSelectionBox.h.

Referenced by RecreateButtons(), and toolButtonClicked().

◆ m_ToolManager

mitk::ToolManager::Pointer QmitkToolSelectionBox::m_ToolManager
protected

Definition at line 122 of file QmitkToolSelectionBox.h.

Referenced by GetToolManager(), QmitkToolSelectionBox(), RecreateButtons(), SetGUIEnabledAccordingToToolManagerState(), SetOrUnsetButtonForActiveTool(), SetToolManager(), toolButtonClicked(), and ~QmitkToolSelectionBox().

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