CYIFocusEvent Class Reference

Detailed Description

Focus events represent when a view receives or loses focus.

Focus events are available in all event phases. Event handlers interested in the capture or bubble phases of focus events can use the focus target and related target to see how the focus is changing: interesting cases may be between descendants and between a descendant and an unrelated target.

Note

Possible event types are YI_FOCUS_IN and YI_FOCUS_OUT.

See also

IsFocusEvent

#include <event/YiFocusEvent.h>

Inheritance diagram for CYIFocusEvent:

Public Member Functions
	CYIFocusEvent (YI_EVENT_TYPE eventType)
	CYIFocusEvent (const CYIFocusEvent &rOther)=default
virtual	~CYIFocusEvent ()
virtual std::unique_ptr< CYIEvent >	Clone () const override
Public Member Functions inherited from CYIEvent
	CYIEvent (YI_EVENT_TYPE eventType)
	CYIEvent (const CYIEvent &rOther)
virtual	~CYIEvent ()
const CYIString &	GetName () const
YI_EVENT_TYPE	GetType () const
void	SetType (YI_EVENT_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
Public Member Functions inherited from CYIScriptableObject
	CYIScriptableObject ()
	CYIScriptableObject (const CYIScriptableObject &other)
CYIScriptableObject &	operator= (const CYIScriptableObject &other)
virtual	~CYIScriptableObject ()
CYIBindingImplementation *	GetBindingImplementation () const
void	SetBindingImplementation (CYIBindingImplementation *pBindingImplementation)
virtual const CYIRuntimeTypeInfo *	GetRuntimeTypeInfoForScriptObject () const

Public Attributes
std::shared_ptr< CYISceneNodeProxy >	m_pFocusTarget
std::shared_ptr< CYISceneNodeProxy >	m_pRelatedFocusTarget
Public Attributes inherited from CYIEvent
CYIEventTarget *	m_pTarget
CYIEventTarget *	m_pCurrentTarget
YI_EVENT_PHASE	m_ePhase
bool	m_bCanCancel
bool	m_bCanBubble
bool	m_bCanCapture
bool	m_bStopPropagation
bool	m_bHandled
uint64_t	m_uEventTimeMs

Constructor & Destructor Documentation

CYIFocusEvent::CYIFocusEvent

(

YI_EVENT_TYPE

eventType

)

Constructs a focus event from eventType. Will assert if the type is not a focus event.

CYIFocusEvent::CYIFocusEvent ( const CYIFocusEvent &  rOther )

default

virtual CYIFocusEvent::~CYIFocusEvent ( )

virtual

Member Function Documentation

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

overridevirtual

Reimplemented from CYIEvent.

Member Data Documentation

std::shared_ptr<CYISceneNodeProxy> CYIFocusEvent::m_pFocusTarget

For focus in events, the focus target is the node receiving focus, and for focus out events, it is the node losing focus.

std::shared_ptr<CYISceneNodeProxy> CYIFocusEvent::m_pRelatedFocusTarget

For focus in events, the related target is the node losing focus, and for focus out events, it is the node receiving focus.

---

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

• event/YiFocusEvent.h