Gin
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
ActionMessageLambda Class Reference

A utility class that adapts an ActionBroadcaster to use a lambda callback. More...

#include <gin_util.h>

Inherits juce::ActionListener.

Public Member Functions

 ActionMessageLambda (juce::ActionBroadcaster &src_, std::function< void(juce::String)> handler_)
 Creates an ActionMessageLambda that listens to the given broadcaster.
 
 ~ActionMessageLambda () override
 
void actionListenerCallback (const juce::String &message) override
 

Public Attributes

juce::ActionBroadcaster & src
 
std::function< void(juce::String)> handler
 

Detailed Description

A utility class that adapts an ActionBroadcaster to use a lambda callback.

This class provides a convenient way to listen to ActionBroadcaster messages using a lambda or std::function instead of implementing the ActionListener interface directly.

The listener is automatically registered on construction and unregistered on destruction.

Example usage:

juce::ActionBroadcaster broadcaster;
ActionMessageLambda listener (broadcaster, [] (const juce::String& message)
{
DBG ("Received: " + message);
});
broadcaster.sendActionMessage ("Hello"); // Lambda will be called
A utility class that adapts an ActionBroadcaster to use a lambda callback.
Definition utilities/gin_util.h:372
A lightweight 2D point class for projects that don't use juce_graphics.
Definition gin_point.h:25
See also
juce::ActionBroadcaster, juce::ActionListener

Constructor & Destructor Documentation

◆ ActionMessageLambda()

ActionMessageLambda::ActionMessageLambda ( juce::ActionBroadcaster &  src_,
std::function< void(juce::String)>  handler_ 
)

Creates an ActionMessageLambda that listens to the given broadcaster.

Parameters
src_The ActionBroadcaster to listen to. Must remain valid for the lifetime of this object.
handler_A function to call when an action message is received. The function receives the message string as its parameter.

References src.

◆ ~ActionMessageLambda()

ActionMessageLambda::~ActionMessageLambda ( )
override

References src.

Member Function Documentation

◆ actionListenerCallback()

void ActionMessageLambda::actionListenerCallback ( const juce::String &  message)
override

References handler.

Member Data Documentation

◆ src

juce::ActionBroadcaster& ActionMessageLambda::src

◆ handler

std::function<void(juce::String)> ActionMessageLambda::handler

Referenced by actionListenerCallback().


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