You.i Engine
CYITaskEvent Class Reference

Detailed Description

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

See also

#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< CYIEventClone () const
const CYIStringGetName () const
CYIEvent::Type GetType () const
void SetType (CYIEvent::Type eventType)
bool IsActionEvent () const
std::unique_ptr< CYIActionEventCloneAsActionEvent () const
bool IsKeyEvent () const
std::unique_ptr< CYIKeyEventCloneAsKeyEvent () const
bool IsFocusEvent () const
std::unique_ptr< CYIFocusEventCloneAsFocusEvent () const
bool IsTrackpadEvent () const
std::unique_ptr< CYITrackpadEventCloneAsTrackpadEvent () const
bool IsAccessibilityEvent () const
std::unique_ptr< CYIAccessibilityEventCloneAsAccessibilityEvent () const
bool IsGestureEvent () const
std::unique_ptr< CYIGestureEventCloneAsGestureEvent () const
bool IsSwipeGestureEvent () const
bool IsScrubGestureEvent () const
std::unique_ptr< CYISwipeGestureEventCloneAsSwipeGestureEvent () const
void SetTarget (CYIEventTarget *pTarget)
CYIEventTargetGetTarget () const
const std::shared_ptr< CYIEventTargetProxy > & GetTargetProxy () const
void SetCurrentTarget (CYIEventTarget *pTarget)
const CYIEventTargetGetCurrentTarget () const
CYIEventTargetGetCurrentTarget ()
const std::shared_ptr< CYIEventTargetProxy > & GetCurrentTargetProxy () const

Additional Inherited Members

- Public Types inherited from CYIEvent
enum  Type : uint8_t {
  Type::None = 0,
 The event type of the CYIEvent class instance. More...
enum  Phase : uint8_t {
  Phase::None = 0,
 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 ( )

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: