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. 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

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

References juce::gl::message.

getNumButtons()

int juce::MessageBoxOptions::getNumButtons ( ) const

inlinenoexcept

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

See also

withButtonText

getTitle()

String juce::MessageBoxOptions::getTitle ( ) const

inline

Returns the title of the dialog box.

See also

withTitle

operator=()

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

default

with()

template<typename Member , typename Item >

static MessageBoxOptions juce::MessageBoxOptions::with ( MessageBoxOptions  options, Member &&  member, Item &&  item  )

inlinestaticprivate

withAssociatedComponent()

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

inline

The component that the dialog box should be associated with.

References associatedComponent.

withButton()

JUCE_NODISCARD 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.

References juce::StandardApplicationCommandIDs::copy, and juce::UnitTestCategories::text.

withIconType()

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

inline

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

References iconType, and juce::gl::type.

withMessage()

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

inline

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

References message.

withTitle()

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

inline

Sets the title of the dialog box.

References title.

Member Data Documentation

associatedComponent

WeakReference<Component> juce::MessageBoxOptions::associatedComponent

private

Referenced by withAssociatedComponent().

buttons

StringArray juce::MessageBoxOptions::buttons

private

iconType

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

private

Referenced by withIconType().

message

String juce::MessageBoxOptions::message

private

Referenced by withMessage().

title

String juce::MessageBoxOptions::title

private

Referenced by withTitle().

---

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

• juce_MessageBoxOptions.h