Detailed Description

Event class containing CYITaskBase items. Supports the task being executed when the event is handled.

See also: CYITask

#include <event/YiTaskEvent.h>

Inheritance diagram for CYITaskEvent:

Public Member Functions
	CYITaskEvent (std::unique_ptr< CYITaskBase > pTask)

virtual	~CYITaskEvent ()

void	Execute ()

Public Member Functions inherited from CYIEvent
	CYIEvent (CYIEvent::Type eventType)

	CYIEvent (const CYIEvent &rOther)

virtual	~CYIEvent ()

virtual std::unique_ptr< CYIEvent >	Clone () const

const CYIString &	GetName () const

CYIEvent::Type	GetType () const

void	SetType (CYIEvent::Type eventType)

bool	IsActionEvent () const

std::unique_ptr< CYIActionEvent >	CloneAsActionEvent () const

bool	IsKeyEvent () const

std::unique_ptr< CYIKeyEvent >	CloneAsKeyEvent () const

bool	IsFocusEvent () const

std::unique_ptr< CYIFocusEvent >	CloneAsFocusEvent () const

bool	IsTrackpadEvent () const

std::unique_ptr< CYITrackpadEvent >	CloneAsTrackpadEvent () const

bool	IsAccessibilityEvent () const

std::unique_ptr< CYIAccessibilityEvent >	CloneAsAccessibilityEvent () const

bool	IsGestureEvent () const

std::unique_ptr< CYIGestureEvent >	CloneAsGestureEvent () const

bool	IsSwipeGestureEvent () const

bool	IsScrubGestureEvent () const

std::unique_ptr< CYISwipeGestureEvent >	CloneAsSwipeGestureEvent () const

void	SetTarget (CYIEventTarget *pTarget)

CYIEventTarget *	GetTarget () const

const std::shared_ptr< CYIEventTargetProxy > &	GetTargetProxy () const

void	SetCurrentTarget (CYIEventTarget *pTarget)

const CYIEventTarget *	GetCurrentTarget () const

CYIEventTarget *	GetCurrentTarget ()

const std::shared_ptr< CYIEventTargetProxy > &	GetCurrentTargetProxy () const

Additional Inherited Members
Public Types inherited from CYIEvent
enum	Type : uint8_t { Type::None = 0, Type::ActionMove, Type::ActionDown, Type::ActionDelayedDown, Type::ActionUp, Type::ActionWheel, Type::ActionWheelHorizontal, Type::ActionWheelVertical, Type::ActionClick, Type::ActionOut, Type::ActionIn, Type::ActionEnter, Type::ActionLeave, Type::ActionPick, Type::ActionLongPress, Type::ActionSuppressedMove, Type::KeyDown, Type::KeyUp, Type::KeyInput, Type::SignalEmit, Type::StateMachineWrapped, Type::StateMachineSignal, Type::GPUGenerateHandle, Type::GPULoadBuffer, Type::GPUUnloadBuffer, Type::GPUFreeHandle, Type::GPUInvalidateHandle, Type::FocusIn, Type::FocusOut, Type::TrackpadDown, Type::TrackpadMove, Type::TrackpadUp, Type::DeferredDeletion, Type::Task, Type::AccessibilityAnnounce, Type::AccessibilityFocusIn, Type::AccessibilityFocusOut, Type::AccessibilityFocusNext, Type::AccessibilityFocusPrevious, Type::GestureTap, Type::GestureDoubleTap, Type::GestureSwipe, Type::GestureDrag, Type::GestureScrub, Type::TypesCount }
	The event type of the CYIEvent class instance. More...

enum	Phase : uint8_t { Phase::None = 0, Phase::Capture, Phase::AtTarget, Phase::Bubble, Phase::Broadcast }
	The current processing phase of the event. More...

enum	Priority { Priority::Highest = 2, Priority::High = 1, Priority::Normal = 0, Priority::Low = -1, Priority::Lowest = -2, Priority::Default = Normal }
	Priority of the event in the event queue. More...

Public Attributes inherited from CYIEvent
uint64_t	m_eventTimeMs

Phase	m_phase

bool	m_canCancel

bool	m_canBubble

bool	m_canCapture

bool	m_stopPropagation

bool	m_handled

Constructor & Destructor Documentation

◆ CYITaskEvent()

CYITaskEvent::CYITaskEvent ( std::unique_ptr< CYITaskBase > pTask )

◆ ~CYITaskEvent()

virtual CYITaskEvent::~CYITaskEvent ( )

virtual

Member Function Documentation

◆ Execute()

void CYITaskEvent::Execute ( )

Execute the task associated with this event.

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

event/YiTaskEvent.h