mitk::DisplayScrollEvent Class Reference

Display action event carrying a slice scroll delta and auto-repeat flag. More...

#include <mitkDisplayActionEvents.h>

Inheritance diagram for mitk::DisplayScrollEvent:

Collaboration diagram for mitk::DisplayScrollEvent:

Public Types
typedef DisplayScrollEvent	Self
typedef DisplayActionEvent	Superclass
Public Types inherited from mitk::DisplayActionEvent
typedef DisplayActionEvent	Self
typedef itk::AnyEvent	Superclass

Public Member Functions
	DisplayScrollEvent ()
	DisplayScrollEvent (InteractionEvent *interactionEvent, int sliceDelta, bool autoRepeat)
	Construct with the originating event, slice delta, and auto-repeat flag. More...
	~DisplayScrollEvent () override
const char *	GetEventName () const override
bool	CheckEvent (const itk::EventObject *e) const override
itk::EventObject *	MakeObject () const override
int	GetSliceDelta () const
	Get the number of slices to scroll. More...
bool	GetAutoRepeat () const
	Get whether auto-repeat (wrap-around) is enabled. More...
	DisplayScrollEvent (const Self &s)
	Copy constructor. More...
Public Member Functions inherited from mitk::DisplayActionEvent
	DisplayActionEvent ()
	Default constructor with no interaction event. More...
	DisplayActionEvent (InteractionEvent *interactionEvent)
	Construct with the originating interaction event. More...
	~DisplayActionEvent () override
const char *	GetEventName () const override
bool	CheckEvent (const itk::EventObject *e) const override
itk::EventObject *	MakeObject () const override
InteractionEvent *	GetInteractionEvent () const
	Get the originating interaction event. More...
BaseRenderer *	GetSender () const
	Get the BaseRenderer that sent the interaction event. More...
	DisplayActionEvent (const Self &s)
	Copy constructor. More...

Detailed Description

Display action event carrying a slice scroll delta and auto-repeat flag.

See also

DisplayActionEvent

Definition at line 214 of file mitkDisplayActionEvents.h.

Member Typedef Documentation

Self

typedef DisplayScrollEvent mitk::DisplayScrollEvent::Self

Definition at line 217 of file mitkDisplayActionEvents.h.

Superclass

typedef DisplayActionEvent mitk::DisplayScrollEvent::Superclass

Definition at line 218 of file mitkDisplayActionEvents.h.

Constructor & Destructor Documentation

DisplayScrollEvent() [1/3]

mitk::DisplayScrollEvent::DisplayScrollEvent ( )

inline

Definition at line 220 of file mitkDisplayActionEvents.h.

DisplayScrollEvent() [2/3]

mitk::DisplayScrollEvent::DisplayScrollEvent ( InteractionEvent *  interactionEvent, int  sliceDelta, bool  autoRepeat  )

inline

Construct with the originating event, slice delta, and auto-repeat flag.

Parameters

interactionEvent	The interaction event that triggered this action.
sliceDelta	Number of slices to scroll (positive or negative).
autoRepeat	Whether scrolling wraps around at the data set boundary.

Definition at line 228 of file mitkDisplayActionEvents.h.

~DisplayScrollEvent()

mitk::DisplayScrollEvent::~DisplayScrollEvent ( )

inlineoverride

Definition at line 234 of file mitkDisplayActionEvents.h.

DisplayScrollEvent() [3/3]

mitk::DisplayScrollEvent::DisplayScrollEvent ( const Self &  s )

inline

Copy constructor.

Definition at line 252 of file mitkDisplayActionEvents.h.

Member Function Documentation

CheckEvent()

bool mitk::DisplayScrollEvent::CheckEvent ( const itk::EventObject *  e ) const

inlineoverride

Definition at line 236 of file mitkDisplayActionEvents.h.

GetAutoRepeat()

bool mitk::DisplayScrollEvent::GetAutoRepeat ( ) const

inline

Get whether auto-repeat (wrap-around) is enabled.

Returns

true if scrolling wraps around at data set boundaries.

Definition at line 249 of file mitkDisplayActionEvents.h.

GetEventName()

const char* mitk::DisplayScrollEvent::GetEventName ( ) const

inlineoverride

Definition at line 235 of file mitkDisplayActionEvents.h.

GetSliceDelta()

int mitk::DisplayScrollEvent::GetSliceDelta ( ) const

inline

Get the number of slices to scroll.

Returns

The slice delta (positive = forward, negative = backward).

Definition at line 243 of file mitkDisplayActionEvents.h.

MakeObject()

itk::EventObject* mitk::DisplayScrollEvent::MakeObject ( ) const

inlineoverride

Definition at line 237 of file mitkDisplayActionEvents.h.

---

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

• mitkDisplayActionEvents.h