Medical Imaging Interaction Toolkit  2021.10.99-1c4db16f
Medical Imaging Interaction Toolkit
mitk::InteractionKeyEvent Class Reference

Handles key events Takes a std::string for pressed key or special key description, mitk::ModifierKeys for modifiers. More...

#include <mitkInteractionKeyEvent.h>

Inheritance diagram for mitk::InteractionKeyEvent:
Collaboration diagram for mitk::InteractionKeyEvent:

Public Types

typedef InteractionKeyEvent Self
 
typedef InteractionEvent Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- 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< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
bool IsSuperClassOf (const InteractionEvent::Pointer &baseClass) const override
 
ModifierKeys GetModifiers () const
 
std::string GetKey () const
 
- Public Member Functions inherited from mitk::InteractionEvent
void SetSender (BaseRenderer *sender)
 
BaseRendererGetSender () const
 

Static Public Member Functions

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

Protected Member Functions

 InteractionKeyEvent (BaseRenderer *, const std::string &key, ModifierKeys modifiers)
 
 ~InteractionKeyEvent () override
 
bool IsEqual (const InteractionEvent &) const override
 
- Protected Member Functions inherited from mitk::InteractionEvent
 InteractionEvent (BaseRenderer *)
 
 ~InteractionEvent () override
 

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

Handles key events Takes a std::string for pressed key or special key description, mitk::ModifierKeys for modifiers.

Definition at line 36 of file mitkInteractionKeyEvent.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ InteractionKeyEvent()

mitk::InteractionKeyEvent::InteractionKeyEvent ( BaseRenderer ,
const std::string &  key,
ModifierKeys  modifiers 
)
protected

◆ ~InteractionKeyEvent()

mitk::InteractionKeyEvent::~InteractionKeyEvent ( )
overrideprotected

Member Function Documentation

◆ GetClassHierarchy()

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

Reimplemented from mitk::InteractionEvent.

Definition at line 39 of file mitkInteractionKeyEvent.h.

◆ GetClassName()

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

Reimplemented from mitk::InteractionEvent.

◆ GetKey()

std::string mitk::InteractionKeyEvent::GetKey ( ) const

◆ GetModifiers()

ModifierKeys mitk::InteractionKeyEvent::GetModifiers ( ) const

◆ GetStaticNameOfClass()

static const char* mitk::InteractionKeyEvent::GetStaticNameOfClass ( )
inlinestatic

Definition at line 39 of file mitkInteractionKeyEvent.h.

◆ IsEqual()

bool mitk::InteractionKeyEvent::IsEqual ( const InteractionEvent ) const
overrideprotectedvirtual

Reimplemented from mitk::InteractionEvent.

◆ IsSuperClassOf()

bool mitk::InteractionKeyEvent::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.

◆ New()

static Pointer mitk::InteractionKeyEvent::New ( BaseRenderer _arga,
const std::string &  _argb,
ModifierKeys  _argc 
)
inlinestatic

Definition at line 40 of file mitkInteractionKeyEvent.h.


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