Class to create events from within the application to signal about internal events. More...

#include <mitkInternalEvent.h>

Inheritance diagram for mitk::InternalEvent:

Collaboration diagram for mitk::InternalEvent:

[legend]

Public Member Functions
	mitkClassMacro (InternalEvent, InteractionEvent)

	mitkNewMacro3Param (Self, BaseRenderer , DataInteractor , const std::string &)

std::string	GetSignalName () const
	Get the signal name that identifies this internal event. More...

DataInteractor *	GetTargetInteractor () const
	Get the DataInteractor that this event targets. More...

bool	IsSuperClassOf (const InteractionEvent::Pointer &baseClass) const override
	Check whether this event's class is a superclass of the given event. More...

Public Member Functions inherited from mitk::InteractionEvent
	mitkClassMacroItkParent (InteractionEvent, itk::LightObject)

	mitkNewMacro1Param (Self, BaseRenderer *)

void	SetSender (BaseRenderer *sender)
	Set the BaseRenderer that sent this event. More...

BaseRenderer *	GetSender () const
	Get the BaseRenderer that sent this event. More...

Protected Member Functions
	InternalEvent (BaseRenderer , DataInteractor destInteractor, const std::string &signalName)
	Construct an internal event. More...

	~InternalEvent () override

bool	IsEqual (const InteractionEvent &) const override
	Compare this event to another InteractionEvent for equality. More...

Protected Member Functions inherited from mitk::InteractionEvent
	InteractionEvent (BaseRenderer *)

	~InteractionEvent () override

Additional Inherited Members
Public Types inherited from mitk::InteractionEvent
enum	MouseButtons { NoButton , LeftMouseButton , RightMouseButton , MiddleMouseButton }
	Enumeration of mouse button states. More...

enum	ModifierKeys { NoKey , ShiftKey , ControlKey , AltKey }
	Enumeration of keyboard modifier keys. More...

Static Public Attributes inherited from mitk::InteractionEvent
static const std::string	KeyEsc
	String constants for special keys used in key events and state machine patterns. More...

static const std::string	KeyEnter
	"Enter" key constant. More...

static const std::string	KeyReturn
	"Return" key constant. More...

static const std::string	KeyDelete
	"Delete" key constant. More...

static const std::string	KeyArrowUp
	"ArrowUp" key constant. More...

static const std::string	KeyArrowDown
	"ArrowDown" key constant. More...

static const std::string	KeyArrowLeft
	"ArrowLeft" key constant. More...

static const std::string	KeyArrowRight
	"ArrowRight" key constant. More...

static const std::string	KeyF1
	"F1" key constant. More...

static const std::string	KeyF2
	"F2" key constant. More...

static const std::string	KeyF3
	"F3" key constant. More...

static const std::string	KeyF4
	"F4" key constant. More...

static const std::string	KeyF5
	"F5" key constant. More...

static const std::string	KeyF6
	"F6" key constant. More...

static const std::string	KeyF7
	"F7" key constant. More...

static const std::string	KeyF8
	"F8" key constant. More...

static const std::string	KeyF9
	"F9" key constant. More...

static const std::string	KeyF10
	"F10" key constant. More...

static const std::string	KeyF11
	"F11" key constant. More...

static const std::string	KeyF12
	"F12" key constant. More...

static const std::string	KeyPos1
	"Pos1" (Home) key constant. More...

static const std::string	KeyEnd
	"End" key constant. More...

static const std::string	KeyInsert
	"Insert" key constant. More...

static const std::string	KeyPageUp
	"PageUp" key constant. More...

static const std::string	KeyPageDown
	"PageDown" key constant. More...

static const std::string	KeySpace
	"Space" key constant. More...

Detailed Description

Class to create events from within the application to signal about internal events.

These events can target a specific DataInteractor, if this DataInteractor is specified in the constructor; else this parameter is set to nullptr and the event is treated as a regular event.

See also: InteractionEvent; DataInteractor

Definition at line 37 of file mitkInternalEvent.h.

Constructor & Destructor Documentation

◆ InternalEvent()

mitk::InternalEvent::InternalEvent	(	BaseRenderer *	,
		DataInteractor *	destInteractor,
		const std::string &	signalName
	)

protected

Construct an internal event.

Parameters

destInteractor	The target DataInteractor, or nullptr for untargeted events.
signalName	The name identifying this internal event signal.

◆ ~InternalEvent()

mitk::InternalEvent::~InternalEvent ( )

overrideprotected

Member Function Documentation

◆ GetSignalName()

std::string mitk::InternalEvent::GetSignalName ( ) const

Get the signal name that identifies this internal event.

Returns: The signal name string.

◆ GetTargetInteractor()

DataInteractor* mitk::InternalEvent::GetTargetInteractor ( ) const

Get the DataInteractor that this event targets.

Returns: Pointer to the target DataInteractor, or nullptr if no specific target.

◆ IsEqual()

bool mitk::InternalEvent::IsEqual ( const InteractionEvent & ) const

overrideprotectedvirtual

Compare this event to another InteractionEvent for equality.

Two InternalEvents are equal if they have the same signal name.

Returns: True if the events are equal.

Reimplemented from mitk::InteractionEvent.

◆ IsSuperClassOf()

bool mitk::InternalEvent::IsSuperClassOf ( const InteractionEvent::Pointer & baseClass ) const

overridevirtual

Check whether this event's class is a superclass of the given event.

Parameters

baseClass The event to check against.

Returns: True if this class is a superclass of baseClass.

Reimplemented from mitk::InteractionEvent.

◆ mitkClassMacro()

mitk::InternalEvent::mitkClassMacro	(	InternalEvent	,
		InteractionEvent
	)

◆ mitkNewMacro3Param()

mitk::InternalEvent::mitkNewMacro3Param	(	Self	,
		BaseRenderer *	,
		DataInteractor *	,
		const std::string &
	)

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

mitkInternalEvent.h

Public Member Functions

Protected Member Functions

Additional Inherited Members