juce::ModalCallbackFunction Class Reference

This class provides some handy utility methods for creating ModalComponentManager::Callback objects that will invoke a static function with some parameters when a modal component is dismissed. More...

#include "juce_ModalComponentManager.h"

Static Public Member Functions
template<typename CallbackFn >
static ModalComponentManager::Callback *	create (CallbackFn &&fn)
	This is a utility function to create a ModalComponentManager::Callback that will call a callable object.
template<typename ParamType >
static ModalComponentManager::Callback *	create (void(*functionToCall)(int, ParamType), ParamType parameterValue)
	This is a utility function to create a ModalComponentManager::Callback that will call a static function with a parameter.
template<typename ParamType1 , typename ParamType2 >
static ModalComponentManager::Callback *	withParam (void(*functionToCall)(int, ParamType1, ParamType2), ParamType1 parameterValue1, ParamType2 parameterValue2)
	This is a utility function to create a ModalComponentManager::Callback that will call a static function with two custom parameters.
template<class ComponentType >
static ModalComponentManager::Callback *	forComponent (void(*functionToCall)(int, ComponentType *), ComponentType *component)
	This is a utility function to create a ModalComponentManager::Callback that will call a static function with a component.
template<class ComponentType , typename ParamType >
static ModalComponentManager::Callback *	forComponent (void(*functionToCall)(int, ComponentType *, ParamType), ComponentType *component, ParamType param)
	Creates a ModalComponentManager::Callback that will call a static function with a component.

Detailed Description

This class provides some handy utility methods for creating ModalComponentManager::Callback objects that will invoke a static function with some parameters when a modal component is dismissed.

@tags{GUI}

Definition at line 162 of file juce_ModalComponentManager.h.

Member Function Documentation

create() [1/2]

template<typename CallbackFn >

static ModalComponentManager::Callback * juce::ModalCallbackFunction::create ( CallbackFn &&  fn )

static

This is a utility function to create a ModalComponentManager::Callback that will call a callable object.

The function that you supply must take an integer parameter, which is the result code that was returned when the modal component was dismissed.

See also

ModalComponentManager::Callback

Definition at line 174 of file juce_ModalComponentManager.h.

create() [2/2]

template<typename ParamType >

static ModalComponentManager::Callback * juce::ModalCallbackFunction::create ( void(*)(int, ParamType)  functionToCall, ParamType  parameterValue  )

static

This is a utility function to create a ModalComponentManager::Callback that will call a static function with a parameter.

The function that you supply must take two parameters - the first being an int, which is the result code that was used when the modal component was dismissed, and the second can be a custom type. Note that this custom value will be copied and stored, so it must be a primitive type or a class that provides copy-by-value semantics.

E.g.

static void myCallbackFunction (int modalResult, double customValue)
{
    if (modalResult == 1)
        doSomethingWith (customValue);
}
 
Component* someKindOfComp;
...
someKindOfComp->enterModalState (true, ModalCallbackFunction::create (myCallbackFunction, 3.0));

See also

ModalComponentManager::Callback

Definition at line 210 of file juce_ModalComponentManager.h.

forComponent() [1/2]

template<class ComponentType >

static ModalComponentManager::Callback * juce::ModalCallbackFunction::forComponent ( void(*)(int, ComponentType *)  functionToCall, ComponentType *  component  )

static

This is a utility function to create a ModalComponentManager::Callback that will call a static function with a component.

The function that you supply must take two parameters - the first being an int, which is the result code that was used when the modal component was dismissed, and the second can be a Component class. The component will be stored as a WeakReference, so that if it gets deleted before this callback is invoked, the pointer that is passed to the function will be null.

E.g.

static void myCallbackFunction (int modalResult, Slider* mySlider)
{
    if (modalResult == 1 && mySlider != nullptr) // (must check that mySlider isn't null in case it was deleted..)
        mySlider->setValue (0.0);
}
 
Component* someKindOfComp;
Slider* mySlider;
...
someKindOfComp->enterModalState (true, ModalCallbackFunction::forComponent (myCallbackFunction, mySlider));

See also

ModalComponentManager::Callback

Definition at line 276 of file juce_ModalComponentManager.h.

forComponent() [2/2]

template<class ComponentType , typename ParamType >

static ModalComponentManager::Callback * juce::ModalCallbackFunction::forComponent ( void(*)(int, ComponentType *, ParamType)  functionToCall, ComponentType *  component, ParamType  param  )

static

Creates a ModalComponentManager::Callback that will call a static function with a component.

The function that you supply must take three parameters - the first being an int, which is the result code that was used when the modal component was dismissed, the second being a Component class, and the third being a custom type (which must be a primitive type or have copy-by-value semantics). The component will be stored as a WeakReference, so that if it gets deleted before this callback is invoked, the pointer that is passed into the function will be null.

E.g.

static void myCallbackFunction (int modalResult, Slider* mySlider, String customParam)
{
    if (modalResult == 1 && mySlider != nullptr) // (must check that mySlider isn't null in case it was deleted..)
        mySlider->setName (customParam);
}
 
Component* someKindOfComp;
Slider* mySlider;
...
someKindOfComp->enterModalState (true, ModalCallbackFunction::forComponent (myCallbackFunction, mySlider, String ("hello")));

See also

ModalComponentManager::Callback

Definition at line 309 of file juce_ModalComponentManager.h.

withParam()

template<typename ParamType1 , typename ParamType2 >

static ModalComponentManager::Callback * juce::ModalCallbackFunction::withParam ( void(*)(int, ParamType1, ParamType2)  functionToCall, ParamType1  parameterValue1, ParamType2  parameterValue2  )

static

This is a utility function to create a ModalComponentManager::Callback that will call a static function with two custom parameters.

The function that you supply must take three parameters - the first being an int, which is the result code that was used when the modal component was dismissed, and the next two are your custom types. Note that these custom values will be copied and stored, so they must be primitive types or classes that provide copy-by-value semantics.

E.g.

static void myCallbackFunction (int modalResult, double customValue1, String customValue2)
{
    if (modalResult == 1)
        doSomethingWith (customValue1, customValue2);
}
 
Component* someKindOfComp;
...
someKindOfComp->enterModalState (true, ModalCallbackFunction::create (myCallbackFunction, 3.0, String ("xyz")));

See also

ModalComponentManager::Callback

Definition at line 242 of file juce_ModalComponentManager.h.

---

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

• juce_gui_basics/components/juce_ModalComponentManager.h