You.i Engine
Public Member Functions | Friends | List of all members
CYIEventFilter Class Referenceabstract
Events

Detailed Description

Allows children that inherit from this class to implement processing before and after events are handled.

Event filters can be registered using CYIEventDispatcher::RegisterEventFilter, or CYIEventHandler::RegisterEventFilter.

#include <event/YiEventFilter.h>

Inheritance diagram for CYIEventFilter:
Inheritance graph
[legend]

Public Member Functions

 CYIEventFilter ()
 
 CYIEventFilter (const CYIEventFilter &other)
 
virtual ~CYIEventFilter ()
 
CYIEventFilter & operator= (const CYIEventFilter &other)
 
virtual bool PreFilterEvent (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent, CYIEventHandler *pDestination)=0
 
virtual bool PostFilterEvent (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent, CYIEventHandler *pDestination)=0
 

Friends

class CYIEventDispatcher
 
class CYIEventHandler
 

Constructor & Destructor Documentation

◆ CYIEventFilter() [1/2]

CYIEventFilter::CYIEventFilter ( )

◆ CYIEventFilter() [2/2]

CYIEventFilter::CYIEventFilter ( const CYIEventFilter &  other)

◆ ~CYIEventFilter()

virtual CYIEventFilter::~CYIEventFilter ( )
virtual

Member Function Documentation

◆ operator=()

CYIEventFilter& CYIEventFilter::operator= ( const CYIEventFilter &  other)

◆ PostFilterEvent()

virtual bool CYIEventFilter::PostFilterEvent ( const std::shared_ptr< CYIEventDispatcher > &  pDispatcher,
CYIEvent *  pEvent,
CYIEventHandler *  pDestination 
)
pure virtual

Called after pEvent is handled. Returning true filters the event so that no other CYIEventHandler receives the event.

◆ PreFilterEvent()

virtual bool CYIEventFilter::PreFilterEvent ( const std::shared_ptr< CYIEventDispatcher > &  pDispatcher,
CYIEvent *  pEvent,
CYIEventHandler *  pDestination 
)
pure virtual

Called before pEvent is handled. Returning true filters the event so that no other CYIEventHandler receives the event.

Friends And Related Function Documentation

◆ CYIEventDispatcher

friend class CYIEventDispatcher
friend

◆ CYIEventHandler

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