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 | |
Component * | getAssociatedComponent () const noexcept |
Returns the component that the dialog box is associated with. More... | |
String | getButtonText (int buttonIndex) const |
Returns the text that has been set for one of the buttons of the dialog box. More... | |
MessageBoxIconType | getIconType () const noexcept |
Returns the icon type of the dialog box. More... | |
String | getMessage () const |
Returns the message of the dialog box. More... | |
int | getNumButtons () const noexcept |
Returns the number of buttons that have been added to the dialog box. More... | |
String | getTitle () const |
Returns the title of the dialog box. More... | |
MessageBoxOptions & | operator= (const MessageBoxOptions &)=default |
JUCE_NODISCARD MessageBoxOptions | withAssociatedComponent (Component *component) const |
The component that the dialog box should be associated with. More... | |
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. More... | |
JUCE_NODISCARD MessageBoxOptions | withIconType (MessageBoxIconType type) const |
Sets the type of icon that should be used for the dialog box. More... | |
JUCE_NODISCARD MessageBoxOptions | withMessage (const String &boxMessage) const |
Sets the message that should be displayed in the dialog box. More... | |
JUCE_NODISCARD MessageBoxOptions | withTitle (const String &boxTitle) const |
Sets the title of the dialog box. More... | |
Static Private Member Functions | |
template<typename Member , typename Item > | |
static MessageBoxOptions | with (MessageBoxOptions options, Member &&member, Item &&item) |
Private Attributes | |
WeakReference< Component > | associatedComponent |
StringArray | buttons |
MessageBoxIconType | iconType = MessageBoxIconType::InfoIcon |
String | message |
String | title |
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.
@tags{GUI}
|
default |
|
default |
|
inlinenoexcept |
Returns the component that the dialog box is associated with.
Returns the text that has been set for one of the buttons of the dialog box.
|
inlinenoexcept |
Returns the icon type of the dialog box.
|
inline |
|
inlinenoexcept |
Returns the number of buttons that have been added to the dialog box.
|
inline |
Returns the title of the dialog box.
|
default |
|
inlinestaticprivate |
|
inline |
The component that the dialog box should be associated with.
References associatedComponent.
|
inline |
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::StandardApplicationCommandIDs::copy, and juce::UnitTestCategories::text.
|
inline |
Sets the type of icon that should be used for the dialog box.
References iconType, and juce::gl::type.
|
inline |
Sets the message that should be displayed in the dialog box.
References message.
|
inline |
Sets the title of the dialog box.
References title.
|
private |
Referenced by withAssociatedComponent().
|
private |
|
private |
Referenced by withIconType().
|
private |
Referenced by withMessage().
|
private |
Referenced by withTitle().