JUCE
|
Class used to create a set of options to pass to the AlertWindow and NativeMessageBox methods for showing dialog boxes. More...
#include <juce_MessageBoxOptions.h>
Public Member Functions | |
MessageBoxOptions ()=default | |
MessageBoxOptions (const MessageBoxOptions &)=default | |
MessageBoxOptions & | operator= (const MessageBoxOptions &)=default |
JUCE_NODISCARD MessageBoxOptions | withIconType (MessageBoxIconType type) const |
Sets the type of icon that should be used for the dialog box. | |
JUCE_NODISCARD MessageBoxOptions | withTitle (const String &boxTitle) const |
Sets the title of the dialog box. | |
JUCE_NODISCARD MessageBoxOptions | withMessage (const String &boxMessage) const |
Sets the message that should be displayed in the dialog box. | |
JUCE_NODISCARD 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 text. | |
JUCE_NODISCARD MessageBoxOptions | withAssociatedComponent (Component *component) const |
The component that the dialog box should be associated with. | |
MessageBoxIconType | getIconType () const noexcept |
Returns the icon type of the dialog box. | |
String | getTitle () const |
Returns the title of the dialog box. | |
String | getMessage () const |
Returns the message of the dialog box. | |
int | getNumButtons () const noexcept |
Returns the number of buttons that have been added to the dialog box. | |
String | getButtonText (int buttonIndex) const |
Returns the text that has been set for one of the buttons of the dialog box. | |
Component * | getAssociatedComponent () const noexcept |
Returns the component that the dialog box is associated with. | |
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.
|
default |
Referenced by MessageBoxOptions(), operator=(), withAssociatedComponent(), withButton(), withIconType(), withMessage(), and withTitle().
|
default |
References MessageBoxOptions().
|
default |
References MessageBoxOptions().
JUCE_NODISCARD MessageBoxOptions MessageBoxOptions::withIconType | ( | MessageBoxIconType | type | ) | const |
Sets the type of icon that should be used for the dialog box.
References JUCE_NODISCARD, and MessageBoxOptions().
JUCE_NODISCARD MessageBoxOptions MessageBoxOptions::withTitle | ( | const String & | boxTitle | ) | const |
Sets the title of the dialog box.
References JUCE_NODISCARD, and MessageBoxOptions().
JUCE_NODISCARD MessageBoxOptions MessageBoxOptions::withMessage | ( | const String & | boxMessage | ) | const |
Sets the message that should be displayed in the dialog box.
References JUCE_NODISCARD, and MessageBoxOptions().
JUCE_NODISCARD MessageBoxOptions 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 text.
Generally up to 3 buttons are supported for dialog boxes, so adding any more than this may have no effect.
References JUCE_NODISCARD, and MessageBoxOptions().
JUCE_NODISCARD MessageBoxOptions MessageBoxOptions::withAssociatedComponent | ( | Component * | component | ) | const |
The component that the dialog box should be associated with.
References Component, JUCE_NODISCARD, and MessageBoxOptions().
|
noexcept |
Returns the icon type of the dialog box.
String MessageBoxOptions::getMessage | ( | ) | const |
Returns the message of the dialog box.
|
noexcept |
Returns the number of buttons that have been added to the dialog box.
String MessageBoxOptions::getButtonText | ( | int | buttonIndex | ) | const |
Returns the text that has been set for one of the buttons of the dialog box.
|
noexcept |
Returns the component that the dialog box is associated with.
References Component.