mitk::InternalEvent Class Reference

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:

Public Types
typedef InternalEvent	Self
typedef InteractionEvent	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
Public Types inherited from mitk::InteractionEvent
enum	MouseButtons { NoButton, LeftMouseButton, RightMouseButton, MiddleMouseButton }
enum	ModifierKeys { NoKey, ShiftKey, ControlKey, AltKey }
typedef InteractionEvent	Self
typedef itk::LightObject	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer

Public Member Functions
virtual std::vector< std::string >	GetClassHierarchy () const override
virtual const char *	GetClassName () const
std::string	GetSignalName () const
DataInteractor *	GetTargetInteractor () const
virtual bool	IsSuperClassOf (const InteractionEvent::Pointer &baseClass) const override
Public Member Functions inherited from mitk::InteractionEvent
void	SetSender (BaseRenderer *sender)
BaseRenderer *	GetSender () const

Static Public Member Functions
static const char *	GetStaticNameOfClass ()
static Pointer	New (BaseRenderer *_arga, DataInteractor *_argb, const std::string &_argc)
Static Public Member Functions inherited from mitk::InteractionEvent
static const char *	GetStaticNameOfClass ()
static Pointer	New (BaseRenderer *_arg)

Protected Member Functions
	InternalEvent (BaseRenderer *, DataInteractor *destInteractor, const std::string &signalName)
virtual	~InternalEvent ()
virtual bool	IsEqual (const InteractionEvent &) const override
Protected Member Functions inherited from mitk::InteractionEvent
	InteractionEvent (BaseRenderer *)
virtual	~InteractionEvent ()

Additional Inherited Members
Static Public Attributes inherited from mitk::InteractionEvent
static const std::string	KeyEsc
static const std::string	KeyEnter
static const std::string	KeyReturn
static const std::string	KeyDelete
static const std::string	KeyArrowUp
static const std::string	KeyArrowDown
static const std::string	KeyArrowLeft
static const std::string	KeyArrowRight
static const std::string	KeyF1
static const std::string	KeyF2
static const std::string	KeyF3
static const std::string	KeyF4
static const std::string	KeyF5
static const std::string	KeyF6
static const std::string	KeyF7
static const std::string	KeyF8
static const std::string	KeyF9
static const std::string	KeyF10
static const std::string	KeyF11
static const std::string	KeyF12
static const std::string	KeyPos1
static const std::string	KeyEnd
static const std::string	KeyInsert
static const std::string	KeyPageUp
static const std::string	KeyPageDown
static const std::string	KeySpace

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 NULL and the event is treated as a regular event.

Definition at line 38 of file mitkInternalEvent.h.

Member Typedef Documentation

typedef itk::SmartPointer<const Self> mitk::InternalEvent::ConstPointer

Definition at line 41 of file mitkInternalEvent.h.

typedef itk::SmartPointer<Self> mitk::InternalEvent::Pointer

Definition at line 41 of file mitkInternalEvent.h.

typedef InternalEvent mitk::InternalEvent::Self

Definition at line 41 of file mitkInternalEvent.h.

typedef InteractionEvent mitk::InternalEvent::Superclass

Definition at line 41 of file mitkInternalEvent.h.

Constructor & Destructor Documentation

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

protected

Definition at line 20 of file mitkInternalEvent.cpp.

mitk::InternalEvent::~InternalEvent ( )

protectedvirtual

Definition at line 33 of file mitkInternalEvent.cpp.

Member Function Documentation

virtual std::vector<std::string> mitk::InternalEvent::GetClassHierarchy ( ) const

inlineoverridevirtual

Reimplemented from mitk::InteractionEvent.

Definition at line 41 of file mitkInternalEvent.h.

virtual const char* mitk::InternalEvent::GetClassName ( ) const

virtual

Reimplemented from mitk::InteractionEvent.

std::string mitk::InternalEvent::GetSignalName

(

)

const

Definition at line 37 of file mitkInternalEvent.cpp.

Referenced by mitk::EventConfig::GetMappedEvent(), and IsEqual().

static const char* mitk::InternalEvent::GetStaticNameOfClass ( )

inlinestatic

Definition at line 41 of file mitkInternalEvent.h.

mitk::DataInteractor * mitk::InternalEvent::GetTargetInteractor

(

)

const

Definition at line 42 of file mitkInternalEvent.cpp.

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

overrideprotectedvirtual

Reimplemented from mitk::InteractionEvent.

Definition at line 27 of file mitkInternalEvent.cpp.

References GetSignalName().

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

overridevirtual

This class implements an up cast to check if the provided baseClass object is derived from this class. This function is used to support polymorphism on state machine pattern (XML) level.

Reimplemented from mitk::InteractionEvent.

Definition at line 47 of file mitkInternalEvent.cpp.

static Pointer mitk::InternalEvent::New ( BaseRenderer *  _arga, DataInteractor *  _argb, const std::string &  _argc  )

inlinestatic

Definition at line 42 of file mitkInternalEvent.h.

Referenced by mitk::PointSetDataInteractor::Abort(), mitk::PointSetDataInteractor::AddPoint(), mitk::EventFactory::CreateEvent(), mitk::PointSetDataInteractor::IsClosedContour(), QmitkRenderWindow::leaveEvent(), and mitk::PlanarFigureInteractor::RemoveSelectedPoint().

---

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

• mitkInternalEvent.h
• mitkInternalEvent.cpp