The base class for objects that can be sent to a MessageListener. More...

#include "juce_Message.h"

Inheritance diagram for juce::Message:

Public Types
using	Ptr = ReferenceCountedObjectPtr< Message >

Public Types inherited from juce::MessageManager::MessageBase
using	Ptr = ReferenceCountedObjectPtr< MessageBase >

Public Member Functions
	Message () noexcept
	Creates an uninitialised message.

Public Member Functions inherited from juce::MessageManager::MessageBase
bool	post ()

Public Member Functions inherited from juce::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.

Friends
class	MessageListener

Additional Inherited Members
Protected Member Functions inherited from juce::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

The base class for objects that can be sent to a MessageListener.

If you want to send a message that carries some kind of custom data, just create a subclass of Message with some appropriate member variables to hold your data.

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

See also: MessageListener, MessageManager, ActionListener, ChangeListener

@tags{Events}

Definition at line 43 of file juce_Message.h.

Member Typedef Documentation

◆ Ptr

using juce::Message::Ptr = ReferenceCountedObjectPtr<Message>

Definition at line 51 of file juce_Message.h.

Constructor & Destructor Documentation

◆ Message()

juce::Message::Message ( )

noexcept

Creates an uninitialised message.

Definition at line 26 of file juce_MessageListener.cpp.

◆ ~Message()

juce::Message::~Message ( )

override

Definition at line 27 of file juce_MessageListener.cpp.

Friends And Related Symbol Documentation

◆ MessageListener

friend class MessageListener

friend

Definition at line 55 of file juce_Message.h.

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

juce_events/messages/juce_Message.h
juce_events/messages/juce_MessageListener.cpp

Public Types

Public Member Functions

Friends

Additional Inherited Members