openshot-audio  0.1.4
Classes | Public Member Functions | Friends | List of all members
juce::ChangeBroadcaster Class Reference

#include <juce_events.h>

Inheritance diagram for juce::ChangeBroadcaster:
juce::AudioDeviceManager juce::AudioTransportSource juce::ColourSelector juce::ComponentAnimator juce::DirectoryContentsList juce::FileBasedDocument juce::KeyPressMappingSet juce::KnownPluginList juce::PropertiesFile juce::SelectedItemSet< SelectableItemType > juce::TabbedButtonBar juce::UndoManager

Public Member Functions

 ChangeBroadcaster () noexcept
 
virtual ~ChangeBroadcaster ()
 
void addChangeListener (ChangeListener *listener)
 
void removeChangeListener (ChangeListener *listener)
 
void removeAllChangeListeners ()
 
void sendChangeMessage ()
 
void sendSynchronousChangeMessage ()
 
void dispatchPendingMessages ()
 

Friends

class ChangeBroadcasterCallback
 

Detailed Description

Holds a list of ChangeListeners, and sends messages to them when instructed.

See also
ChangeListener

Constructor & Destructor Documentation

◆ ChangeBroadcaster()

ChangeBroadcaster::ChangeBroadcaster ( )
noexcept

Creates an ChangeBroadcaster.

◆ ~ChangeBroadcaster()

ChangeBroadcaster::~ChangeBroadcaster ( )
virtual

Destructor.

Member Function Documentation

◆ addChangeListener()

void ChangeBroadcaster::addChangeListener ( ChangeListener listener)

Registers a listener to receive change callbacks from this broadcaster. Trying to add a listener that's already on the list will have no effect.

◆ dispatchPendingMessages()

void ChangeBroadcaster::dispatchPendingMessages ( )

If a change message has been sent but not yet dispatched, this will call sendSynchronousChangeMessage() to make the callback immediately.

For thread-safety reasons, you must only call this method on the main message thread.

◆ removeAllChangeListeners()

void ChangeBroadcaster::removeAllChangeListeners ( )

Removes all listeners from the list.

◆ removeChangeListener()

void ChangeBroadcaster::removeChangeListener ( ChangeListener listener)

Unregisters a listener from the list. If the listener isn't on the list, this won't have any effect.

◆ sendChangeMessage()

void ChangeBroadcaster::sendChangeMessage ( )

Causes an asynchronous change message to be sent to all the registered listeners.

The message will be delivered asynchronously by the main message thread, so this method will return immediately. To call the listeners synchronously use sendSynchronousChangeMessage().

◆ sendSynchronousChangeMessage()

void ChangeBroadcaster::sendSynchronousChangeMessage ( )

Sends a synchronous change message to all the registered listeners.

This will immediately call all the listeners that are registered. For thread-safety reasons, you must only call this method on the main message thread.

See also
dispatchPendingMessages

Friends And Related Function Documentation

◆ ChangeBroadcasterCallback

friend class ChangeBroadcasterCallback
friend

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