juce::MessageBoxOptions Class Reference

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>

Collaboration diagram for juce::MessageBoxOptions:

Public Member Functions
	MessageBoxOptions ()=default
	MessageBoxOptions (const MessageBoxOptions &)=default
Component *	getAssociatedComponent () const noexcept
	Returns the component that the dialog box is associated with.
String	getButtonText (int buttonIndex) const
	Returns the text that has been set for one of the buttons of the dialog box.
MessageBoxIconType	getIconType () const noexcept
	Returns the icon type 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.
Component *	getParentComponent () const noexcept
	Returns the component that will be used as the parent of the dialog box.
String	getTitle () const
	Returns the title of the dialog box.
MessageBoxOptions &	operator= (const MessageBoxOptions &)=default
MessageBoxOptions	withAssociatedComponent (Component *component) const
	The component that the dialog box should be associated with.
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.
MessageBoxOptions	withIconType (MessageBoxIconType type) const
	Sets the type of icon that should be used for the dialog box.
MessageBoxOptions	withMessage (const String &boxMessage) const
	Sets the message that should be displayed in the dialog box.
MessageBoxOptions	withParentComponent (Component *component) const
	The component that will contain the message box (e.g.
MessageBoxOptions	withTitle (const String &boxTitle) const
	Sets the title of the dialog box.

Static Public Member Functions
static MessageBoxOptions	makeOptionsOk (MessageBoxIconType iconType, const String &title, const String &message, const String &buttonText=String(), Component *associatedComponent=nullptr)
	Creates options suitable for a message box with a single button.
static MessageBoxOptions	makeOptionsOkCancel (MessageBoxIconType iconType, const String &title, const String &message, const String &button1Text=String(), const String &button2Text=String(), Component *associatedComponent=nullptr)
	Creates options suitable for a message box with two buttons.
static MessageBoxOptions	makeOptionsYesNo (MessageBoxIconType iconType, const String &title, const String &message, const String &button1Text=String(), const String &button2Text=String(), Component *associatedComponent=nullptr)
	Creates options suitable for a message box with two buttons.
static MessageBoxOptions	makeOptionsYesNoCancel (MessageBoxIconType iconType, const String &title, const String &message, const String &button1Text=String(), const String &button2Text=String(), const String &button3Text=String(), Component *associatedComponent=nullptr)
	Creates options suitable for a message box with three buttons.

Private Attributes
WeakReference< Component >	associatedComponent
StringArray	buttons
MessageBoxIconType	iconType = MessageBoxIconType::InfoIcon
String	message
WeakReference< Component >	parentComponent
String	title

Detailed Description

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.

AlertWindow::showAsync (MessageBoxOptions()
                          .withIconType (MessageBoxIconType::InfoIcon)
                          .withTitle ("A Title")
                          .withMessage ("A message.")
                          .withButton ("OK")
                          .withButton ("Cancel")
                          .withAssociatedComponent (myComp),
                        myCallback);

@tags{GUI}

Constructor & Destructor Documentation

MessageBoxOptions() [1/2]

juce::MessageBoxOptions::MessageBoxOptions ( )

default

MessageBoxOptions() [2/2]

juce::MessageBoxOptions::MessageBoxOptions ( const MessageBoxOptions &  )

default

Member Function Documentation

getAssociatedComponent()

Component * juce::MessageBoxOptions::getAssociatedComponent ( ) const

inlinenoexcept

Returns the component that the dialog box is associated with.

See also

withAssociatedComponent

getButtonText()

String juce::MessageBoxOptions::getButtonText ( int  buttonIndex ) const

inline

Returns the text that has been set for one of the buttons of the dialog box.

See also

withButtonText, getNumButtons

getIconType()

MessageBoxIconType juce::MessageBoxOptions::getIconType ( ) const

inlinenoexcept

Returns the icon type of the dialog box.

See also

withIconType

getMessage()

String juce::MessageBoxOptions::getMessage ( ) const

inline

Returns the message of the dialog box.

See also

withMessage

getNumButtons()

int juce::MessageBoxOptions::getNumButtons ( ) const

inlinenoexcept

Returns the number of buttons that have been added to the dialog box.

See also

withButtonText

getParentComponent()

Component * juce::MessageBoxOptions::getParentComponent ( ) const

inlinenoexcept

Returns the component that will be used as the parent of the dialog box.

See also

withParentComponent

getTitle()

String juce::MessageBoxOptions::getTitle ( ) const

inline

Returns the title of the dialog box.

See also

withTitle

makeOptionsOk()

static MessageBoxOptions juce::MessageBoxOptions::makeOptionsOk ( MessageBoxIconType  iconType, const String &  title, const String &  message, const String &  buttonText = String(), Component *  associatedComponent = nullptr  )

static

Creates options suitable for a message box with a single button.

If no button text is supplied, "OK" will be used.

Referenced by juce::StandalonePluginHolder::askUserToLoadState(), and juce::StandalonePluginHolder::askUserToSaveState().

makeOptionsOkCancel()

static MessageBoxOptions juce::MessageBoxOptions::makeOptionsOkCancel ( MessageBoxIconType  iconType, const String &  title, const String &  message, const String &  button1Text = String(), const String &  button2Text = String(), Component *  associatedComponent = nullptr  )

static

Creates options suitable for a message box with two buttons.

If no button text is supplied, "OK" and "Cancel" will be used.

makeOptionsYesNo()

static MessageBoxOptions juce::MessageBoxOptions::makeOptionsYesNo ( MessageBoxIconType  iconType, const String &  title, const String &  message, const String &  button1Text = String(), const String &  button2Text = String(), Component *  associatedComponent = nullptr  )

static

Creates options suitable for a message box with two buttons.

If no button text is supplied, "Yes" and "No" will be used.

makeOptionsYesNoCancel()

static MessageBoxOptions juce::MessageBoxOptions::makeOptionsYesNoCancel ( MessageBoxIconType  iconType, const String &  title, const String &  message, const String &  button1Text = String(), const String &  button2Text = String(), const String &  button3Text = String(), Component *  associatedComponent = nullptr  )

static

Creates options suitable for a message box with three buttons.

If no button text is supplied, "Yes", "No", and "Cancel" will be used.

operator=()

MessageBoxOptions & juce::MessageBoxOptions::operator= ( const MessageBoxOptions &  )

default

withAssociatedComponent()

MessageBoxOptions juce::MessageBoxOptions::withAssociatedComponent ( Component *  component ) const

inline

The component that the dialog box should be associated with.

References juce::withMember().

withButton()

MessageBoxOptions juce::MessageBoxOptions::withButton ( const String &  text ) const

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.

withIconType()

MessageBoxOptions juce::MessageBoxOptions::withIconType ( MessageBoxIconType  type ) const

inline

Sets the type of icon that should be used for the dialog box.

References juce::withMember().

withMessage()

MessageBoxOptions juce::MessageBoxOptions::withMessage ( const String &  boxMessage ) const

inline

Sets the message that should be displayed in the dialog box.

References juce::withMember().

withParentComponent()

MessageBoxOptions juce::MessageBoxOptions::withParentComponent ( Component *  component ) const

inline

The component that will contain the message box (e.g.

the AudioProcessorEditor in a plugin).

This will only affect JUCE AlertWindows. It won't affect the drawing of native message boxes. This is mainly intended for use in AU plugins, where opening additional windows can be problematic.

References juce::withMember().

withTitle()

MessageBoxOptions juce::MessageBoxOptions::withTitle ( const String &  boxTitle ) const

inline

Sets the title of the dialog box.

References juce::withMember().

Member Data Documentation

associatedComponent

WeakReference<Component> juce::MessageBoxOptions::associatedComponent

private

buttons

StringArray juce::MessageBoxOptions::buttons

private

iconType

MessageBoxIconType juce::MessageBoxOptions::iconType = MessageBoxIconType::InfoIcon

private

message

String juce::MessageBoxOptions::message

private

parentComponent

WeakReference<Component> juce::MessageBoxOptions::parentComponent

private

title

String juce::MessageBoxOptions::title

private

---

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

• juce_MessageBoxOptions.h