Class used to create a set of options to pass to the AlertWindow and NativeMessageBox methods for showing dialog boxes.
More...
Class used to create a set of options to pass to the AlertWindow and NativeMessageBox methods for showing dialog boxes.
You can chain together a series of calls to this class's methods to create a set of whatever options you want to specify.
E.g.
myCallback);
static void JUCE_CALLTYPE showAsync(const MessageBoxOptions &options, ModalComponentManager::Callback *callback)
Shows a dialog box using the specified options.
MessageBoxOptions withButton(const String &text) const
If the string passed in is not empty, this will add a button to the dialog box with the specified tex...
Definition: juce_MessageBoxOptions.h:88
MessageBoxOptions withIconType(MessageBoxIconType type) const
Sets the type of icon that should be used for the dialog box.
Definition: juce_MessageBoxOptions.h:74
MessageBoxOptions withTitle(const String &boxTitle) const
Sets the title of the dialog box.
Definition: juce_MessageBoxOptions.h:77
MessageBoxOptions withAssociatedComponent(Component *component) const
The component that the dialog box should be associated with.
Definition: juce_MessageBoxOptions.h:91
MessageBoxOptions withMessage(const String &boxMessage) const
Sets the message that should be displayed in the dialog box.
Definition: juce_MessageBoxOptions.h:80
MessageBoxOptions()=default
◆ MessageBoxOptions() [1/2]
MessageBoxOptions::MessageBoxOptions |
( |
| ) |
|
|
default |
◆ MessageBoxOptions() [2/2]
◆ operator=()
◆ withIconType()
Sets the type of icon that should be used for the dialog box.
◆ withTitle()
Sets the title of the dialog box.
◆ withMessage()
Sets the message that should be displayed in the dialog box.
◆ withButton()
If the string passed in is not empty, this will add a button to the dialog box with the specified text.
Generally up to 3 buttons are supported for dialog boxes, so adding any more than this may have no effect.
◆ withAssociatedComponent()
The component that the dialog box should be associated with.
◆ getIconType()
Returns the icon type of the dialog box.
- See also
- withIconType
◆ getTitle()
String MessageBoxOptions::getTitle |
( |
| ) |
const |
Returns the title of the dialog box.
- See also
- withTitle
◆ getMessage()
String MessageBoxOptions::getMessage |
( |
| ) |
const |
Returns the message of the dialog box.
- See also
- withMessage
◆ getNumButtons()
int MessageBoxOptions::getNumButtons |
( |
| ) |
const |
|
noexcept |
Returns the number of buttons that have been added to the dialog box.
- See also
- withButtonText
◆ getButtonText()
String MessageBoxOptions::getButtonText |
( |
int |
buttonIndex | ) |
const |
Returns the text that has been set for one of the buttons of the dialog box.
- See also
- withButtonText, getNumButtons
◆ getAssociatedComponent()
Component * MessageBoxOptions::getAssociatedComponent |
( |
| ) |
const |
|
noexcept |
The documentation for this class was generated from the following file: