ChangeBroadcaster Class Reference

Manages a list of ChangeListeners, and can send them messages. More...

Inherited by AudioDeviceManager, AudioThumbnail, AudioTransportSource, ColourSelector, ComponentAnimator, DirectoryContentsList, FileBasedDocument, FileBrowserComponent, KeyPressMappingSet, KnownPluginList, MidiKeyboardComponent, PropertiesFile, SelectedItemSet< SelectableItemType >, TabbedButtonBar, and UndoManager.

List of all members.

Public Member Functions

 ChangeBroadcaster () throw ()
 Creates an ChangeBroadcaster.
virtual ~ChangeBroadcaster ()
 Destructor.
void addChangeListener (ChangeListener *listener) throw ()
 Adds a listener to the list.
void removeChangeListener (ChangeListener *listener) throw ()
 Removes a listener from the list.
void removeAllChangeListeners () throw ()
 Removes all listeners from the list.
void sendChangeMessage (void *objectThatHasChanged) throw ()
 Broadcasts a change message to all the registered listeners.
void sendSynchronousChangeMessage (void *objectThatHasChanged)
 Sends a synchronous change message to all the registered listeners.
void dispatchPendingMessages ()
 If a change message has been sent but not yet dispatched, this will use sendSynchronousChangeMessage() to make the callback immediately.

Detailed Description

Manages a list of ChangeListeners, and can send them messages.

To quickly add methods to your class that can add/remove change listeners and broadcast to them, you can derive from this.

See also:
ChangeListenerList, ChangeListener

Constructor & Destructor Documentation

ChangeBroadcaster::ChangeBroadcaster (  )  throw ()

Creates an ChangeBroadcaster.

virtual ChangeBroadcaster::~ChangeBroadcaster (  )  [virtual]

Destructor.


Member Function Documentation

void ChangeBroadcaster::addChangeListener ( ChangeListener listener  )  throw ()

Adds a listener to the list.

(Trying to add a listener that's already on the list will have no effect).

void ChangeBroadcaster::removeChangeListener ( ChangeListener listener  )  throw ()

Removes a listener from the list.

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

void ChangeBroadcaster::removeAllChangeListeners (  )  throw ()

Removes all listeners from the list.

void ChangeBroadcaster::sendChangeMessage ( void *  objectThatHasChanged  )  throw ()

Broadcasts a change message to all the registered listeners.

The message will be delivered asynchronously by the event thread, so this method will not directly call any of the listeners. For a synchronous message, use sendSynchronousChangeMessage().

See also:
ChangeListenerList::sendActionMessage

Referenced by SelectedItemSet< SelectableItemType >::changed().

void ChangeBroadcaster::sendSynchronousChangeMessage ( void *  objectThatHasChanged  ) 

Sends a synchronous change message to all the registered listeners.

See also:
ChangeListenerList::sendSynchronousChangeMessage

Referenced by SelectedItemSet< SelectableItemType >::changed().

void ChangeBroadcaster::dispatchPendingMessages (  ) 

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


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Mon Apr 26 11:42:10 2010 for JUCE by  doxygen 1.6.3