reference

This documentation is automatically generated from the openFrameworks source code using doxygen and refers to the most recent release, version 0.12.0.

ofEventUtils.h File Reference
#include "ofEvent.h"
#include "ofConstants.h"
#include <stdio.h>
#include <stdlib.h>

Go to the source code of this file.

Functions

template<class EventType , typename ArgumentsType , class ListenerClass >
void ofAddListener (EventType &event, ListenerClass *listener, void(ListenerClass::*listenerMethod)(const void *, ArgumentsType &), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class EventType , typename ArgumentsType , class ListenerClass >
void ofAddListener (EventType &event, ListenerClass *listener, void(ListenerClass::*listenerMethod)(ArgumentsType &), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class ListenerClass >
void ofAddListener (ofEvent< void > &event, ListenerClass *listener, void(ListenerClass::*listenerMethod)(const void *), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class ListenerClass >
void ofAddListener (ofEvent< void > &event, ListenerClass *listener, void(ListenerClass::*listenerMethod)(), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class EventType , typename ArgumentsType , class ListenerClass >
void ofAddListener (EventType &event, ListenerClass *listener, bool(ListenerClass::*listenerMethod)(const void *, ArgumentsType &), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class EventType , typename ArgumentsType , class ListenerClass >
void ofAddListener (EventType &event, ListenerClass *listener, bool(ListenerClass::*listenerMethod)(ArgumentsType &), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class ListenerClass >
void ofAddListener (ofEvent< void > &event, ListenerClass *listener, bool(ListenerClass::*listenerMethod)(const void *), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class ListenerClass >
void ofAddListener (ofEvent< void > &event, ListenerClass *listener, bool(ListenerClass::*listenerMethod)(), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class EventType , typename ArgumentsType >
void ofAddListener (EventType &event, void(*listenerFunction)(const void *, ArgumentsType &), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class EventType , typename ArgumentsType >
void ofAddListener (EventType &event, void(*listenerFunction)(ArgumentsType &), int prio=OF_EVENT_ORDER_AFTER_APP)
 
void ofAddListener (ofEvent< void > &event, void(*listenerFunction)(const void *), int prio=OF_EVENT_ORDER_AFTER_APP)
 
void ofAddListener (ofEvent< void > &event, void(*listenerFunction)(), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class EventType , typename ArgumentsType >
void ofAddListener (EventType &event, bool(*listenerFunction)(const void *, ArgumentsType &), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class EventType , typename ArgumentsType >
void ofAddListener (EventType &event, bool(*listenerFunction)(ArgumentsType &), int prio=OF_EVENT_ORDER_AFTER_APP)
 
void ofAddListener (ofEvent< void > &event, bool(*listenerFunction)(const void *), int prio=OF_EVENT_ORDER_AFTER_APP)
 
void ofAddListener (ofEvent< void > &event, bool(*listenerFunction)(), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class EventType , typename ArgumentsType , class ListenerClass >
void ofRemoveListener (EventType &event, ListenerClass *listener, void(ListenerClass::*listenerMethod)(const void *, ArgumentsType &), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class EventType , typename ArgumentsType , class ListenerClass >
void ofRemoveListener (EventType &event, ListenerClass *listener, void(ListenerClass::*listenerMethod)(ArgumentsType &), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class ListenerClass >
void ofRemoveListener (ofEvent< void > &event, ListenerClass *listener, void(ListenerClass::*listenerMethod)(const void *), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class ListenerClass >
void ofRemoveListener (ofEvent< void > &event, ListenerClass *listener, void(ListenerClass::*listenerMethod)(), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class EventType , typename ArgumentsType , class ListenerClass >
void ofRemoveListener (EventType &event, ListenerClass *listener, bool(ListenerClass::*listenerMethod)(const void *, ArgumentsType &), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class EventType , typename ArgumentsType , class ListenerClass >
void ofRemoveListener (EventType &event, ListenerClass *listener, bool(ListenerClass::*listenerMethod)(ArgumentsType &), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class ListenerClass >
void ofRemoveListener (ofEvent< void > &event, ListenerClass *listener, bool(ListenerClass::*listenerMethod)(const void *), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class ListenerClass >
void ofRemoveListener (ofEvent< void > &event, ListenerClass *listener, bool(ListenerClass::*listenerMethod)(), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class EventType , typename ArgumentsType >
void ofRemoveListener (EventType &event, void(*listenerFunction)(const void *, ArgumentsType &), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class EventType , typename ArgumentsType >
void ofRemoveListener (EventType &event, void(*listenerFunction)(ArgumentsType &), int prio=OF_EVENT_ORDER_AFTER_APP)
 
void ofRemoveListener (ofEvent< void > &event, void(*listenerFunction)(const void *), int prio=OF_EVENT_ORDER_AFTER_APP)
 
void ofRemoveListener (ofEvent< void > &event, void(*listenerFunction)(), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class EventType , typename ArgumentsType >
void ofRemoveListener (EventType &event, bool(*listenerFunction)(const void *, ArgumentsType &), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class EventType , typename ArgumentsType >
void ofRemoveListener (EventType &event, bool(*listenerFunction)(ArgumentsType &), int prio=OF_EVENT_ORDER_AFTER_APP)
 
void ofRemoveListener (ofEvent< void > &event, bool(*listenerFunction)(const void *), int prio=OF_EVENT_ORDER_AFTER_APP)
 
void ofRemoveListener (ofEvent< void > &event, bool(*listenerFunction)(), int prio=OF_EVENT_ORDER_AFTER_APP)
 
template<class EventType , typename ArgumentsType , typename SenderType >
bool ofNotifyEvent (EventType &event, ArgumentsType &args, SenderType *sender)
 
template<class EventType , typename ArgumentsType >
bool ofNotifyEvent (EventType &event, ArgumentsType &args)
 
template<class EventType , typename ArgumentsType , typename SenderType >
bool ofNotifyEvent (EventType &event, const ArgumentsType &args, SenderType *sender)
 
template<class EventType , typename ArgumentsType >
bool ofNotifyEvent (EventType &event, const ArgumentsType &args)
 
template<typename SenderType >
bool ofNotifyEvent (ofEvent< void > &event, SenderType *sender)
 
bool ofNotifyEvent (ofEvent< void > &event)
 

Function Documentation

◆ ofAddListener() [1/16]

template<class EventType , typename ArgumentsType >
void ofAddListener ( EventType &  event,
bool(*)(ArgumentsType &)  listenerFunction,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofAddListener() [2/16]

template<class EventType , typename ArgumentsType >
void ofAddListener ( EventType &  event,
bool(*)(const void *, ArgumentsType &)  listenerFunction,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofAddListener() [3/16]

template<class EventType , typename ArgumentsType , class ListenerClass >
void ofAddListener ( EventType &  event,
ListenerClass *  listener,
bool(ListenerClass::*)(ArgumentsType &)  listenerMethod,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofAddListener() [4/16]

template<class EventType , typename ArgumentsType , class ListenerClass >
void ofAddListener ( EventType &  event,
ListenerClass *  listener,
bool(ListenerClass::*)(const void *, ArgumentsType &)  listenerMethod,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofAddListener() [5/16]

template<class EventType , typename ArgumentsType , class ListenerClass >
void ofAddListener ( EventType &  event,
ListenerClass *  listener,
void(ListenerClass::*)(ArgumentsType &)  listenerMethod,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofAddListener() [6/16]

template<class EventType , typename ArgumentsType , class ListenerClass >
void ofAddListener ( EventType &  event,
ListenerClass *  listener,
void(ListenerClass::*)(const void *, ArgumentsType &)  listenerMethod,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

register any method of any class to an event.

the method must provide one of the following signatures: void method(ArgumentsType & args) void method(const void * sender, ArgumentsType &args) ie: ofAddListener(addon.newIntEvent, this, &Class::method)

◆ ofAddListener() [7/16]

template<class EventType , typename ArgumentsType >
void ofAddListener ( EventType &  event,
void(*)(ArgumentsType &)  listenerFunction,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofAddListener() [8/16]

template<class EventType , typename ArgumentsType >
void ofAddListener ( EventType &  event,
void(*)(const void *, ArgumentsType &)  listenerFunction,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofAddListener() [9/16]

void ofAddListener ( ofEvent< void > &  event,
bool(*)()  listenerFunction,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)
inline

◆ ofAddListener() [10/16]

void ofAddListener ( ofEvent< void > &  event,
bool(*)(const void *)  listenerFunction,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)
inline

◆ ofAddListener() [11/16]

template<class ListenerClass >
void ofAddListener ( ofEvent< void > &  event,
ListenerClass *  listener,
bool(ListenerClass::*)()  listenerMethod,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofAddListener() [12/16]

template<class ListenerClass >
void ofAddListener ( ofEvent< void > &  event,
ListenerClass *  listener,
bool(ListenerClass::*)(const void *)  listenerMethod,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofAddListener() [13/16]

template<class ListenerClass >
void ofAddListener ( ofEvent< void > &  event,
ListenerClass *  listener,
void(ListenerClass::*)()  listenerMethod,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofAddListener() [14/16]

template<class ListenerClass >
void ofAddListener ( ofEvent< void > &  event,
ListenerClass *  listener,
void(ListenerClass::*)(const void *)  listenerMethod,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofAddListener() [15/16]

void ofAddListener ( ofEvent< void > &  event,
void(*)()  listenerFunction,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)
inline

◆ ofAddListener() [16/16]

void ofAddListener ( ofEvent< void > &  event,
void(*)(const void *)  listenerFunction,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)
inline

◆ ofNotifyEvent() [1/6]

template<class EventType , typename ArgumentsType >
bool ofNotifyEvent ( EventType &  event,
ArgumentsType &  args 
)
inline

◆ ofNotifyEvent() [2/6]

template<class EventType , typename ArgumentsType , typename SenderType >
bool ofNotifyEvent ( EventType &  event,
ArgumentsType &  args,
SenderType *  sender 
)
inline

notifies an event so all the registered listeners get called

ie: ofNotifyEvent(addon.newIntEvent, intArgument, this)

or in case there's no sender: ofNotifyEvent(addon.newIntEvent, intArgument)

Returns
: true in case any listener attended the event

◆ ofNotifyEvent() [3/6]

template<class EventType , typename ArgumentsType >
bool ofNotifyEvent ( EventType &  event,
const ArgumentsType &  args 
)
inline

◆ ofNotifyEvent() [4/6]

template<class EventType , typename ArgumentsType , typename SenderType >
bool ofNotifyEvent ( EventType &  event,
const ArgumentsType &  args,
SenderType *  sender 
)
inline

◆ ofNotifyEvent() [5/6]

bool ofNotifyEvent ( ofEvent< void > &  event)
inline

◆ ofNotifyEvent() [6/6]

template<typename SenderType >
bool ofNotifyEvent ( ofEvent< void > &  event,
SenderType *  sender 
)
inline

◆ ofRemoveListener() [1/16]

template<class EventType , typename ArgumentsType >
void ofRemoveListener ( EventType &  event,
bool(*)(ArgumentsType &)  listenerFunction,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofRemoveListener() [2/16]

template<class EventType , typename ArgumentsType >
void ofRemoveListener ( EventType &  event,
bool(*)(const void *, ArgumentsType &)  listenerFunction,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofRemoveListener() [3/16]

template<class EventType , typename ArgumentsType , class ListenerClass >
void ofRemoveListener ( EventType &  event,
ListenerClass *  listener,
bool(ListenerClass::*)(ArgumentsType &)  listenerMethod,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofRemoveListener() [4/16]

template<class EventType , typename ArgumentsType , class ListenerClass >
void ofRemoveListener ( EventType &  event,
ListenerClass *  listener,
bool(ListenerClass::*)(const void *, ArgumentsType &)  listenerMethod,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofRemoveListener() [5/16]

template<class EventType , typename ArgumentsType , class ListenerClass >
void ofRemoveListener ( EventType &  event,
ListenerClass *  listener,
void(ListenerClass::*)(ArgumentsType &)  listenerMethod,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofRemoveListener() [6/16]

template<class EventType , typename ArgumentsType , class ListenerClass >
void ofRemoveListener ( EventType &  event,
ListenerClass *  listener,
void(ListenerClass::*)(const void *, ArgumentsType &)  listenerMethod,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

unregister any method of any class to an event.

the method must provide one the following signatures: void method(ArgumentsType & args) void method(const void * sender, ArgumentsType &args) ie: ofAddListener(addon.newIntEvent, this, &Class::method)

◆ ofRemoveListener() [7/16]

template<class EventType , typename ArgumentsType >
void ofRemoveListener ( EventType &  event,
void(*)(ArgumentsType &)  listenerFunction,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofRemoveListener() [8/16]

template<class EventType , typename ArgumentsType >
void ofRemoveListener ( EventType &  event,
void(*)(const void *, ArgumentsType &)  listenerFunction,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofRemoveListener() [9/16]

void ofRemoveListener ( ofEvent< void > &  event,
bool(*)()  listenerFunction,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)
inline

◆ ofRemoveListener() [10/16]

void ofRemoveListener ( ofEvent< void > &  event,
bool(*)(const void *)  listenerFunction,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)
inline

◆ ofRemoveListener() [11/16]

template<class ListenerClass >
void ofRemoveListener ( ofEvent< void > &  event,
ListenerClass *  listener,
bool(ListenerClass::*)()  listenerMethod,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofRemoveListener() [12/16]

template<class ListenerClass >
void ofRemoveListener ( ofEvent< void > &  event,
ListenerClass *  listener,
bool(ListenerClass::*)(const void *)  listenerMethod,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofRemoveListener() [13/16]

template<class ListenerClass >
void ofRemoveListener ( ofEvent< void > &  event,
ListenerClass *  listener,
void(ListenerClass::*)()  listenerMethod,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofRemoveListener() [14/16]

template<class ListenerClass >
void ofRemoveListener ( ofEvent< void > &  event,
ListenerClass *  listener,
void(ListenerClass::*)(const void *)  listenerMethod,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)

◆ ofRemoveListener() [15/16]

void ofRemoveListener ( ofEvent< void > &  event,
void(*)()  listenerFunction,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)
inline

◆ ofRemoveListener() [16/16]

void ofRemoveListener ( ofEvent< void > &  event,
void(*)(const void *)  listenerFunction,
int  prio = OF_EVENT_ORDER_AFTER_APP 
)
inline