Cinder  0.9.1
Public Types | Public Member Functions | List of all members
cinder::app::CollectorEvent< EventT > Struct Template Reference

#include <Event.h>

Public Types

typedef void CollectorResult
 

Public Member Functions

 CollectorEvent ()
 
 CollectorEvent (const EventT *event)
 
bool operator() () const
 
CollectorResult getResult () const
 

Detailed Description

template<typename EventT>
struct cinder::app::CollectorEvent< EventT >

A Collector for use with signals::Signal, which will keep the callback chain running until Event::isHandled() returns true.

Member Typedef Documentation

template<typename EventT >
typedef void cinder::app::CollectorEvent< EventT >::CollectorResult

Constructor & Destructor Documentation

template<typename EventT >
cinder::app::CollectorEvent< EventT >::CollectorEvent ( )

Default constructor, sets the internal EventT pointer to null.

template<typename EventT >
cinder::app::CollectorEvent< EventT >::CollectorEvent ( const EventT *  event)

Constructor that takes a pointer to an EventT instance, which will be used to determine when to stop signal emission because the event has been handled.

Member Function Documentation

template<typename EventT >
bool cinder::app::CollectorEvent< EventT >::operator() ( ) const

Called by the signal's CollectorInvoker, allows emission to continue until Event::isHandled() returns true.

template<typename EventT >
CollectorResult cinder::app::CollectorEvent< EventT >::getResult ( ) const

This Collector does not return a result.


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