JUCE  v5.1.1-3-g1a0b28c73
JUCE API
MessageManager::MessageBase Class Referenceabstract

Internal class used as the base class for all message objects. More...

#include <juce_MessageManager.h>

Inheritance diagram for MessageManager::MessageBase:
Collaboration diagram for MessageManager::MessageBase:

Public Types

typedef ReferenceCountedObjectPtr< MessageBasePtr
 

Public Member Functions

 MessageBase () noexcept
 
virtual ~MessageBase ()
 
void decReferenceCount () noexcept
 Decreases the object's reference count. More...
 
bool decReferenceCountWithoutDeleting () noexcept
 Decreases the object's reference count. More...
 
int getReferenceCount () const noexcept
 Returns the object's current reference count. More...
 
void incReferenceCount () noexcept
 Increments the object's reference count. More...
 
virtual void messageCallback ()=0
 
bool post ()
 

Protected Member Functions

void resetReferenceCount () noexcept
 Resets the reference count to zero without deleting the object. More...
 

Detailed Description

Internal class used as the base class for all message objects.

You shouldn't need to use this directly - see the CallbackMessage or Message classes instead.

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ MessageBase()

MessageManager::MessageBase::MessageBase ( )
inlinenoexcept

◆ ~MessageBase()

virtual MessageManager::MessageBase::~MessageBase ( )
inlinevirtual

Member Function Documentation

◆ decReferenceCount()

void ReferenceCountedObject::decReferenceCount ( )
inlinenoexceptinherited

Decreases the object's reference count.

If the count gets to zero, the object will be deleted.

References jassert.

◆ decReferenceCountWithoutDeleting()

bool ReferenceCountedObject::decReferenceCountWithoutDeleting ( )
inlinenoexceptinherited

Decreases the object's reference count.

If the count gets to zero, the object will not be deleted, but this method will return true, allowing the caller to take care of deletion.

References jassert.

◆ getReferenceCount()

int ReferenceCountedObject::getReferenceCount ( ) const
inlinenoexceptinherited

Returns the object's current reference count.

◆ incReferenceCount()

void ReferenceCountedObject::incReferenceCount ( )
inlinenoexceptinherited

Increments the object's reference count.

This is done automatically by the smart pointer, but is public just in case it's needed for nefarious purposes.

◆ messageCallback()

virtual void MessageManager::MessageBase::messageCallback ( )
pure virtual

◆ post()

bool MessageManager::MessageBase::post ( )

◆ resetReferenceCount()

void ReferenceCountedObject::resetReferenceCount ( )
inlineprotectednoexceptinherited

Resets the reference count to zero without deleting the object.

You should probably never need to use this!


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