mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-10 23:44:24 +00:00
79ed81c24a
The biggest new feature in this commit is the addition of NativeMessageBox::scopedAsync and AlertWindow::scopedAsync, both of which return an instance of ScopedMessageBox that will hide the message box in its destructor. The code for displaying modal dialogs on Windows has also been updated. Now, the dialog itself is run from a new thread with its own message loop. This means that when the dialog is dismissed, the background thread can be joined safely. In plugins, this means that there's no danger of the plugin view being destroyed from within the message box runloop, for example.
187 lines
8.3 KiB
C++
187 lines
8.3 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE library.
|
|
Copyright (c) 2022 - Raw Material Software Limited
|
|
|
|
JUCE is an open source library subject to commercial or open-source
|
|
licensing.
|
|
|
|
By using JUCE, you agree to the terms of both the JUCE 7 End-User License
|
|
Agreement and JUCE Privacy Policy.
|
|
|
|
End User License Agreement: www.juce.com/juce-7-licence
|
|
Privacy Policy: www.juce.com/juce-privacy-policy
|
|
|
|
Or: You may also use this code under the terms of the GPL v3 (see
|
|
www.gnu.org/licenses).
|
|
|
|
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
|
|
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
|
|
DISCLAIMED.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
namespace juce
|
|
{
|
|
|
|
/** The type of icon to show in the dialog box. */
|
|
enum class MessageBoxIconType
|
|
{
|
|
NoIcon, /**< No icon will be shown on the dialog box. */
|
|
QuestionIcon, /**< A question-mark icon, for dialog boxes that need the
|
|
user to answer a question. */
|
|
WarningIcon, /**< An exclamation mark to indicate that the dialog is a
|
|
warning about something and shouldn't be ignored. */
|
|
InfoIcon /**< An icon that indicates that the dialog box is just
|
|
giving the user some information, which doesn't require
|
|
a response from them. */
|
|
};
|
|
|
|
//==============================================================================
|
|
/** 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. @code
|
|
AlertWindow::showAsync (MessageBoxOptions()
|
|
.withIconType (MessageBoxIconType::InfoIcon)
|
|
.withTitle ("A Title")
|
|
.withMessage ("A message.")
|
|
.withButton ("OK")
|
|
.withButton ("Cancel")
|
|
.withAssociatedComponent (myComp),
|
|
myCallback);
|
|
@endcode
|
|
|
|
@tags{GUI}
|
|
*/
|
|
class JUCE_API MessageBoxOptions
|
|
{
|
|
public:
|
|
MessageBoxOptions() = default;
|
|
MessageBoxOptions (const MessageBoxOptions&) = default;
|
|
MessageBoxOptions& operator= (const MessageBoxOptions&) = default;
|
|
|
|
//==============================================================================
|
|
/** Sets the type of icon that should be used for the dialog box. */
|
|
[[nodiscard]] MessageBoxOptions withIconType (MessageBoxIconType type) const { return with (*this, &MessageBoxOptions::iconType, type); }
|
|
|
|
/** Sets the title of the dialog box. */
|
|
[[nodiscard]] MessageBoxOptions withTitle (const String& boxTitle) const { return with (*this, &MessageBoxOptions::title, boxTitle); }
|
|
|
|
/** Sets the message that should be displayed in the dialog box. */
|
|
[[nodiscard]] MessageBoxOptions withMessage (const String& boxMessage) const { return with (*this, &MessageBoxOptions::message, boxMessage); }
|
|
|
|
/** 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.
|
|
*/
|
|
[[nodiscard]] MessageBoxOptions withButton (const String& text) const { auto copy = *this; copy.buttons.add (text); return copy; }
|
|
|
|
/** The component that the dialog box should be associated with. */
|
|
[[nodiscard]] MessageBoxOptions withAssociatedComponent (Component* component) const { return with (*this, &MessageBoxOptions::associatedComponent, component); }
|
|
|
|
//==============================================================================
|
|
/** Returns the icon type of the dialog box.
|
|
|
|
@see withIconType
|
|
*/
|
|
MessageBoxIconType getIconType() const noexcept { return iconType; }
|
|
|
|
/** Returns the title of the dialog box.
|
|
|
|
@see withTitle
|
|
*/
|
|
String getTitle() const { return title; }
|
|
|
|
/** Returns the message of the dialog box.
|
|
|
|
@see withMessage
|
|
*/
|
|
String getMessage() const { return message; }
|
|
|
|
/** Returns the number of buttons that have been added to the dialog box.
|
|
|
|
@see withButtonText
|
|
*/
|
|
int getNumButtons() const noexcept { return buttons.size(); }
|
|
|
|
/** Returns the text that has been set for one of the buttons of the dialog box.
|
|
|
|
@see withButtonText, getNumButtons
|
|
*/
|
|
String getButtonText (int buttonIndex) const { return buttons[buttonIndex]; }
|
|
|
|
/** Returns the component that the dialog box is associated with.
|
|
|
|
@see withAssociatedComponent
|
|
*/
|
|
Component* getAssociatedComponent() const noexcept { return associatedComponent; }
|
|
|
|
/** Creates options suitable for a message box with a single button.
|
|
|
|
If no button text is supplied, "OK" will be used.
|
|
*/
|
|
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 two buttons.
|
|
|
|
If no button text is supplied, "OK" and "Cancel" will be used.
|
|
*/
|
|
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.
|
|
|
|
If no button text is supplied, "Yes" and "No" will be used.
|
|
*/
|
|
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 three buttons.
|
|
*
|
|
If no button text is supplied, "Yes", "No", and "Cancel" will be used.
|
|
*/
|
|
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);
|
|
|
|
private:
|
|
//==============================================================================
|
|
template <typename Member, typename Item>
|
|
static MessageBoxOptions with (MessageBoxOptions options, Member&& member, Item&& item)
|
|
{
|
|
options.*member = std::forward<Item> (item);
|
|
return options;
|
|
}
|
|
|
|
//==============================================================================
|
|
MessageBoxIconType iconType = MessageBoxIconType::InfoIcon;
|
|
String title, message;
|
|
StringArray buttons;
|
|
WeakReference<Component> associatedComponent;
|
|
};
|
|
|
|
} // namespace juce
|