CallbackMessage Class Reference

A message that invokes a callback method when it gets delivered. More...

#include <juce_CallbackMessage.h>

Inheritance diagram for CallbackMessage:

Public Member Functions
	CallbackMessage ()=default
	~CallbackMessage () override=default
	Destructor.
void	messageCallback () override=0
	Called when the message is delivered.
Public Member Functions inherited from MessageManager::MessageBase
	MessageBase ()=default
	~MessageBase () override=default
bool	post ()
Public Member Functions inherited from ReferenceCountedObject
void	incReferenceCount () noexcept
	Increments the object's reference count.
void	decReferenceCount () noexcept
	Decreases the object's reference count.
bool	decReferenceCountWithoutDeleting () noexcept
	Decreases the object's reference count.
int	getReferenceCount () const noexcept
	Returns the object's current reference count.

Additional Inherited Members
Public Types inherited from MessageManager::MessageBase
using	Ptr = ReferenceCountedObjectPtr<MessageBase>
Protected Member Functions inherited from ReferenceCountedObject
	ReferenceCountedObject ()=default
	Creates the reference-counted object (with an initial ref count of zero).
	ReferenceCountedObject (const ReferenceCountedObject &) noexcept
	Copying from another object does not affect this one's reference-count.
	ReferenceCountedObject (ReferenceCountedObject &&) noexcept
	Copying from another object does not affect this one's reference-count.
ReferenceCountedObject &	operator= (const ReferenceCountedObject &) noexcept
	Copying from another object does not affect this one's reference-count.
ReferenceCountedObject &	operator= (ReferenceCountedObject &&) noexcept
	Copying from another object does not affect this one's reference-count.
virtual	~ReferenceCountedObject ()
	Destructor.
void	resetReferenceCount () noexcept
	Resets the reference count to zero without deleting the object.

Detailed Description

A message that invokes a callback method when it gets delivered.

You can use this class to fire off actions that you want to be performed later on the message thread.

To use it, create a subclass of CallbackMessage which implements the messageCallback() method, then call post() to dispatch it. The event thread will then invoke your messageCallback() method later on, and will automatically delete the message object afterwards.

Always create a new instance of a CallbackMessage on the heap, as it will be deleted automatically after the message has been delivered.

Note that this class was essential back in the days before C++11, but in modern times you may prefer to use MessageManager::callAsync() with a lambda.

See also

MessageManager::callAsync, MessageListener, ActionListener, ChangeListener

Constructor & Destructor Documentation

CallbackMessage()

CallbackMessage::CallbackMessage ( )

default

~CallbackMessage()

CallbackMessage::~CallbackMessage ( )

overridedefault

Destructor.

Member Function Documentation

messageCallback()

void CallbackMessage::messageCallback ( )

overridepure virtual

Called when the message is delivered.

You should implement this method and make it do whatever action you want to perform.

Note that like all other messages, this object will be deleted immediately after this method has been invoked.

Implements MessageManager::MessageBase.

---

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

• juce_CallbackMessage.h