|
JUCE-7.0.12-0-g4f43011b96 JUCE-7.0.12-0-g4f43011b96
JUCE — C++ application framework with suport for VST, VST3, LV2 audio plug-ins
« « « Anklang Documentation |
This class contains some static methods for showing native alert windows. More...
#include "juce_NativeMessageBox.h"
Static Public Member Functions | |
| static void JUCE_CALLTYPE | showAsync (const MessageBoxOptions &options, ModalComponentManager::Callback *callback) |
| Shows a dialog box using the specified options. | |
| static void JUCE_CALLTYPE | showAsync (const MessageBoxOptions &options, std::function< void(int)> callback) |
| Shows a dialog box using the specified options. | |
| static void JUCE_CALLTYPE | showMessageBoxAsync (MessageBoxIconType iconType, const String &title, const String &message, Component *associatedComponent=nullptr, ModalComponentManager::Callback *callback=nullptr) |
| Shows a dialog box that just has a message and a single 'ok' button to close it. | |
| static bool JUCE_CALLTYPE | showOkCancelBox (MessageBoxIconType iconType, const String &title, const String &message, Component *associatedComponent, ModalComponentManager::Callback *callback) |
| Shows a dialog box with two buttons. | |
| static int JUCE_CALLTYPE | showYesNoCancelBox (MessageBoxIconType iconType, const String &title, const String &message, Component *associatedComponent, ModalComponentManager::Callback *callback) |
| Shows a dialog box with three buttons. | |
| static int JUCE_CALLTYPE | showYesNoBox (MessageBoxIconType iconType, const String &title, const String &message, Component *associatedComponent, ModalComponentManager::Callback *callback) |
| Shows a dialog box with two buttons. | |
| static ScopedMessageBox | showScopedAsync (const MessageBoxOptions &options, std::function< void(int)> callback) |
| Shows a dialog box using the specified options. | |
This class contains some static methods for showing native alert windows.
@tags{GUI}
Definition at line 35 of file juce_NativeMessageBox.h.
|
static |
Shows a dialog box using the specified options.
The box will be displayed and placed into a modal state, but this method will return immediately, and the callback will be invoked later when the user dismisses the box.
| options | the options to use when creating the dialog. |
| callback | if this is non-null, the callback will receive a call to its modalStateFinished() when the box is dismissed with the index of the button that was clicked as its argument. The callback object will be owned and deleted by the system, so make sure that it works safely and doesn't keep any references to objects that might be deleted before it gets called. |
Definition at line 140 of file juce_NativeMessageBox.cpp.
|
static |
Shows a dialog box using the specified options.
The box will be displayed and placed into a modal state, but this method will return immediately, and the callback will be invoked later when the user dismisses the box.
| options | the options to use when creating the dialog. |
| callback | if this is non-null, the callback will be called when the box is dismissed with the index of the button that was clicked as its argument. |
Definition at line 146 of file juce_NativeMessageBox.cpp.
|
static |
Shows a dialog box that just has a message and a single 'ok' button to close it.
The box will be displayed and placed into a modal state, but this method will return immediately, and the callback will be invoked later when the user dismisses the box.
| iconType | the type of icon to show. |
| title | the headline to show at the top of the box. |
| message | a longer, more descriptive message to show underneath the title. |
| associatedComponent | if this is non-null, it specifies the component that the alert window should be associated with. Depending on the look and feel, this might be used for positioning of the alert window. |
| callback | if this is non-null, the callback will receive a call to its modalStateFinished() when the box is dismissed. The callback object will be owned and deleted by the system, so make sure that it works safely and doesn't keep any references to objects that might be deleted before it gets called. You can use the ModalCallbackFunction to easily pass in a lambda for this parameter. |
Definition at line 104 of file juce_NativeMessageBox.cpp.
|
static |
Shows a dialog box with two buttons.
Ideal for ok/cancel or yes/no choices. The return key can also be used to trigger the first button, and the escape key for the second button.
If the callback parameter is null and modal loops are enabled, the box is shown modally, and the method will block until the user has clicked the button (or pressed the escape or return keys). If the callback parameter is non-null, the box will be displayed and placed into a modal state, but this method will return immediately, and the callback will be invoked later when the user dismisses the box.
| iconType | the type of icon to show. |
| title | the headline to show at the top of the box. |
| message | a longer, more descriptive message to show underneath the title. |
| associatedComponent | if this is non-null, it specifies the component that the alert window should be associated with. Depending on the look and feel, this might be used for positioning of the alert window. |
| callback | if this is non-null, the box will be launched asynchronously, returning immediately, and the callback will receive a call to its modalStateFinished() when the box is dismissed, with its parameter being 1 if the ok button was pressed, or 0 for cancel, The callback object will be owned and deleted by the system, so make sure that it works safely and doesn't keep any references to objects that might be deleted before it gets called. You can use the ModalCallbackFunction to easily pass in a lambda for this parameter. |
Definition at line 113 of file juce_NativeMessageBox.cpp.
|
static |
Shows a dialog box using the specified options.
The box will be displayed and placed into a modal state, but this method will return immediately, and the callback will be invoked later when the user dismisses the box.
This function is always asynchronous, even if the callback is null.
For consistency with AlertWindow, the result codes returned by the alert window are as follows.
Another way of expressing this is that, when there are N buttons, then the result code for button X is equal to ((X + 1) % N).
| options | the options to use when creating the dialog. |
| callback | if this is non-null, the callback will receive a call to its modalStateFinished() when the box is dismissed with the index of the button that was clicked as its argument. The callback object will be owned and deleted by the system, so make sure that it works safely and doesn't keep any references to objects that might be deleted before it gets called. |
Definition at line 152 of file juce_NativeMessageBox.cpp.
|
static |
Shows a dialog box with two buttons.
Ideal for yes/no boxes.
The escape key can be used to trigger the no button.
If the callback parameter is null and modal loops are enabled, the box is shown modally, and the method will block until the user has clicked the button (or pressed the escape or return keys). If the callback parameter is non-null, the box will be displayed and placed into a modal state, but this method will return immediately, and the callback will be invoked later when the user dismisses the box.
| iconType | the type of icon to show. |
| title | the headline to show at the top of the box. |
| message | a longer, more descriptive message to show underneath the title. |
| associatedComponent | if this is non-null, it specifies the component that the alert window should be associated with. Depending on the look and feel, this might be used for positioning of the alert window. |
| callback | if this is non-null, the box will be launched asynchronously, returning immediately, and the callback will receive a call to its modalStateFinished() when the box is dismissed, with its parameter being 1 if the "yes" button was pressed or 0 for the "no" button was pressed. The callback object will be owned and deleted by the system, so make sure that it works safely and doesn't keep any references to objects that might be deleted before it gets called. You can use the ModalCallbackFunction to easily pass in a lambda for this parameter. |
Definition at line 131 of file juce_NativeMessageBox.cpp.
|
static |
Shows a dialog box with three buttons.
Ideal for yes/no/cancel boxes.
The escape key can be used to trigger the third button.
If the callback parameter is null and modal loops are enabled, the box is shown modally, and the method will block until the user has clicked the button (or pressed the escape or return keys). If the callback parameter is non-null, the box will be displayed and placed into a modal state, but this method will return immediately, and the callback will be invoked later when the user dismisses the box.
| iconType | the type of icon to show. |
| title | the headline to show at the top of the box. |
| message | a longer, more descriptive message to show underneath the title. |
| associatedComponent | if this is non-null, it specifies the component that the alert window should be associated with. Depending on the look and feel, this might be used for positioning of the alert window. |
| callback | if this is non-null, the box will be launched asynchronously, returning immediately, and the callback will receive a call to its modalStateFinished() when the box is dismissed, with its parameter being 1 if the "yes" button was pressed, 2 for the "no" button, or 0 if it was cancelled, The callback object will be owned and deleted by the system, so make sure that it works safely and doesn't keep any references to objects that might be deleted before it gets called. You can use the ModalCallbackFunction to easily pass in a lambda for this parameter. |
Definition at line 122 of file juce_NativeMessageBox.cpp.