OpenShot Library | libopenshot-audio 0.2.0
|
Holds a set of objects and can invoke a member function callback on each object in the set with a single call. More...
#include <juce_ListenerList.h>
Classes | |
struct | DummyBailOutChecker |
A dummy bail-out checker that always returns false. More... | |
struct | Iterator |
Iterates the listeners in a ListenerList. More... | |
Public Types | |
using | ThisType = ListenerList< ListenerClass, ArrayType > |
using | ListenerType = ListenerClass |
Public Member Functions | |
ListenerList ()=default | |
Creates an empty list. | |
~ListenerList ()=default | |
Destructor. | |
void | add (ListenerClass *listenerToAdd) |
Adds a listener to the list. | |
void | remove (ListenerClass *listenerToRemove) |
Removes a listener from the list. | |
int | size () const noexcept |
Returns the number of registered listeners. | |
bool | isEmpty () const noexcept |
Returns true if no listeners are registered, false otherwise. | |
void | clear () |
Clears the list. | |
bool | contains (ListenerClass *listener) const noexcept |
Returns true if the specified listener has been added to the list. | |
const ArrayType & | getListeners () const noexcept |
Returns the raw array of listeners. | |
template<typename Callback > | |
void | call (Callback &&callback) |
Calls a member function on each listener in the list, with multiple parameters. | |
template<typename Callback > | |
void | callExcluding (ListenerClass *listenerToExclude, Callback &&callback) |
Calls a member function with 1 parameter, on all but the specified listener in the list. | |
template<typename Callback , typename BailOutCheckerType > | |
void | callChecked (const BailOutCheckerType &bailOutChecker, Callback &&callback) |
Calls a member function on each listener in the list, with 1 parameter and a bail-out-checker. | |
template<typename Callback , typename BailOutCheckerType > | |
void | callCheckedExcluding (ListenerClass *listenerToExclude, const BailOutCheckerType &bailOutChecker, Callback &&callback) |
Calls a member function, with 1 parameter, on all but the specified listener in the list with a bail-out-checker. | |
Holds a set of objects and can invoke a member function callback on each object in the set with a single call.
Use a ListenerList to manage a set of objects which need a callback, and you can invoke a member function by simply calling call() or callChecked().
E.g.
If you add or remove listeners from the list during one of the callbacks - i.e. while it's in the middle of iterating the listeners, then it's guaranteed that no listeners will be mistakenly called after they've been removed, but it may mean that some of the listeners could be called more than once, or not at all, depending on the list's order.
Sometimes, there's a chance that invoking one of the callbacks might result in the list itself being deleted while it's still iterating - to survive this situation, you can use callChecked() instead of call(), passing it a local object to act as a "BailOutChecker". The BailOutChecker must implement a method of the form "bool shouldBailOut()", and the list will check this after each callback to determine whether it should abort the operation. For an example of a bail-out checker, see the Component::BailOutChecker class, which can be used to check when a Component has been deleted. See also ListenerList::DummyBailOutChecker, which is a dummy checker that always returns false.
Definition at line 72 of file juce_ListenerList.h.
using juce::ListenerList< ListenerClass, ArrayType >::ThisType = ListenerList<ListenerClass, ArrayType> |
Definition at line 189 of file juce_ListenerList.h.
using juce::ListenerList< ListenerClass, ArrayType >::ListenerType = ListenerClass |
Definition at line 190 of file juce_ListenerList.h.
|
inline |
Adds a listener to the list.
A listener can only be added once, so if the listener is already in the list, this method has no effect.
Definition at line 88 of file juce_ListenerList.h.
References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::addIfNotAlreadyThere().
|
inline |
Removes a listener from the list.
If the listener wasn't in the list, this has no effect.
Definition at line 99 of file juce_ListenerList.h.
References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::removeFirstMatchingValue().
|
inlinenoexcept |
Returns the number of registered listeners.
Definition at line 106 of file juce_ListenerList.h.
References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size().
|
inlinenoexcept |
Returns true if no listeners are registered, false otherwise.
Definition at line 109 of file juce_ListenerList.h.
References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::isEmpty().
|
inline |
Clears the list.
Definition at line 112 of file juce_ListenerList.h.
References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::clear().
|
inlinenoexcept |
Returns true if the specified listener has been added to the list.
Definition at line 115 of file juce_ListenerList.h.
References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::contains().
|
inlinenoexcept |
Returns the raw array of listeners.
Definition at line 118 of file juce_ListenerList.h.
|
inline |
Calls a member function on each listener in the list, with multiple parameters.
Definition at line 123 of file juce_ListenerList.h.
References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getLock().
|
inline |
Calls a member function with 1 parameter, on all but the specified listener in the list.
This can be useful if the caller is also a listener and needs to exclude itself.
Definition at line 135 of file juce_ListenerList.h.
References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getLock().
|
inline |
Calls a member function on each listener in the list, with 1 parameter and a bail-out-checker.
See the class description for info about writing a bail-out checker.
Definition at line 152 of file juce_ListenerList.h.
References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getLock().
|
inline |
Calls a member function, with 1 parameter, on all but the specified listener in the list with a bail-out-checker.
This can be useful if the caller is also a listener and needs to exclude itself. See the class description for info about writing a bail-out checker.
Definition at line 165 of file juce_ListenerList.h.
References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getLock().