/* ============================================================================== 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 { //============================================================================== /** This class contains some static methods for showing native alert windows. @tags{GUI} */ class NativeMessageBox { public: #if JUCE_MODAL_LOOPS_PERMITTED /** Shows a dialog box that just has a message and a single 'ok' button to close it. The box is shown modally, and the method will block until the user has clicked its button (or pressed the escape or return keys). @param iconType the type of icon to show. @param title the headline to show at the top of the box. @param message a longer, more descriptive message to show underneath the title. @param associatedComponent if this is non-null, it specifies the component that the alert window should be associated with. Depending on the look and feel, this might be used for positioning of the alert window. */ static void JUCE_CALLTYPE showMessageBox (MessageBoxIconType iconType, const String& title, const String& message, Component* associatedComponent = nullptr); /** Shows a dialog box using the specified options. The box is shown modally, and the method will block until the user dismisses it. @param options the options to use when creating the dialog. @returns the index of the button that was clicked. @see MessageBoxOptions */ static int JUCE_CALLTYPE show (const MessageBoxOptions& options); #endif /** Shows a dialog box using the specified options. The box will be displayed and placed into a modal state, but this method will return immediately, and the callback will be invoked later when the user dismisses the box. @param options the options to use when creating the dialog. @param callback if this is non-null, the callback will receive a call to its modalStateFinished() when the box is dismissed with the index of the button that was clicked as its argument. The callback object will be owned and deleted by the system, so make sure that it works safely and doesn't keep any references to objects that might be deleted before it gets called. @see MessageBoxOptions */ static void JUCE_CALLTYPE showAsync (const MessageBoxOptions& options, ModalComponentManager::Callback* callback); /** Shows a dialog box using the specified options. The box will be displayed and placed into a modal state, but this method will return immediately, and the callback will be invoked later when the user dismisses the box. @param options the options to use when creating the dialog. @param callback if this is non-null, the callback will be called when the box is dismissed with the index of the button that was clicked as its argument. @see MessageBoxOptions */ static void JUCE_CALLTYPE showAsync (const MessageBoxOptions& options, std::function callback); /** Shows a dialog box that just has a message and a single 'ok' button to close it. The box will be displayed and placed into a modal state, but this method will return immediately, and the callback will be invoked later when the user dismisses the box. @param iconType the type of icon to show. @param title the headline to show at the top of the box. @param message a longer, more descriptive message to show underneath the title. @param associatedComponent if this is non-null, it specifies the component that the alert window should be associated with. Depending on the look and feel, this might be used for positioning of the alert window. @param callback if this is non-null, the callback will receive a call to its modalStateFinished() when the box is dismissed. The callback object will be owned and deleted by the system, so make sure that it works safely and doesn't keep any references to objects that might be deleted before it gets called. You can use the ModalCallbackFunction to easily pass in a lambda for this parameter. @see ModalCallbackFunction */ static void JUCE_CALLTYPE showMessageBoxAsync (MessageBoxIconType iconType, const String& title, const String& message, Component* associatedComponent = nullptr, ModalComponentManager::Callback* callback = nullptr); /** Shows a dialog box with two buttons. Ideal for ok/cancel or yes/no choices. The return key can also be used to trigger the first button, and the escape key for the second button. If the callback parameter is null and modal loops are enabled, the box is shown modally, and the method will block until the user has clicked the button (or pressed the escape or return keys). If the callback parameter is non-null, the box will be displayed and placed into a modal state, but this method will return immediately, and the callback will be invoked later when the user dismisses the box. @param iconType the type of icon to show. @param title the headline to show at the top of the box. @param message a longer, more descriptive message to show underneath the title. @param associatedComponent if this is non-null, it specifies the component that the alert window should be associated with. Depending on the look and feel, this might be used for positioning of the alert window. @param callback if this is non-null, the box will be launched asynchronously, returning immediately, and the callback will receive a call to its modalStateFinished() when the box is dismissed, with its parameter being 1 if the ok button was pressed, or 0 for cancel, The callback object will be owned and deleted by the system, so make sure that it works safely and doesn't keep any references to objects that might be deleted before it gets called. You can use the ModalCallbackFunction to easily pass in a lambda for this parameter. @returns true if button 1 was clicked, false if it was button 2. If the callback parameter is not null, the method always returns false, and the user's choice is delivered later by the callback. @see ModalCallbackFunction */ static bool JUCE_CALLTYPE showOkCancelBox (MessageBoxIconType iconType, const String& title, const String& message, #if JUCE_MODAL_LOOPS_PERMITTED Component* associatedComponent = nullptr, ModalComponentManager::Callback* callback = nullptr); #else Component* associatedComponent, ModalComponentManager::Callback* callback); #endif /** Shows a dialog box with three buttons. Ideal for yes/no/cancel boxes. The escape key can be used to trigger the third button. If the callback parameter is null and modal loops are enabled, the box is shown modally, and the method will block until the user has clicked the button (or pressed the escape or return keys). If the callback parameter is non-null, the box will be displayed and placed into a modal state, but this method will return immediately, and the callback will be invoked later when the user dismisses the box. @param iconType the type of icon to show. @param title the headline to show at the top of the box. @param message a longer, more descriptive message to show underneath the title. @param associatedComponent if this is non-null, it specifies the component that the alert window should be associated with. Depending on the look and feel, this might be used for positioning of the alert window. @param callback if this is non-null, the box will be launched asynchronously, returning immediately, and the callback will receive a call to its modalStateFinished() when the box is dismissed, with its parameter being 1 if the "yes" button was pressed, 2 for the "no" button, or 0 if it was cancelled, The callback object will be owned and deleted by the system, so make sure that it works safely and doesn't keep any references to objects that might be deleted before it gets called. You can use the ModalCallbackFunction to easily pass in a lambda for this parameter. @returns If the callback parameter has been set, this returns 0. Otherwise, it returns one of the following values: - 0 if 'cancel' was pressed - 1 if 'yes' was pressed - 2 if 'no' was pressed @see ModalCallbackFunction */ static int JUCE_CALLTYPE showYesNoCancelBox (MessageBoxIconType iconType, const String& title, const String& message, #if JUCE_MODAL_LOOPS_PERMITTED Component* associatedComponent = nullptr, ModalComponentManager::Callback* callback = nullptr); #else Component* associatedComponent, ModalComponentManager::Callback* callback); #endif /** Shows a dialog box with two buttons. Ideal for yes/no boxes. The escape key can be used to trigger the no button. If the callback parameter is null and modal loops are enabled, the box is shown modally, and the method will block until the user has clicked the button (or pressed the escape or return keys). If the callback parameter is non-null, the box will be displayed and placed into a modal state, but this method will return immediately, and the callback will be invoked later when the user dismisses the box. @param iconType the type of icon to show. @param title the headline to show at the top of the box. @param message a longer, more descriptive message to show underneath the title. @param associatedComponent if this is non-null, it specifies the component that the alert window should be associated with. Depending on the look and feel, this might be used for positioning of the alert window. @param callback if this is non-null, the box will be launched asynchronously, returning immediately, and the callback will receive a call to its modalStateFinished() when the box is dismissed, with its parameter being 1 if the "yes" button was pressed or 0 for the "no" button was pressed. The callback object will be owned and deleted by the system, so make sure that it works safely and doesn't keep any references to objects that might be deleted before it gets called. You can use the ModalCallbackFunction to easily pass in a lambda for this parameter. @returns If the callback parameter has been set, this returns 0. Otherwise, it returns one of the following values: - 0 if 'no' was pressed - 1 if 'yes' was pressed @see ModalCallbackFunction */ static int JUCE_CALLTYPE showYesNoBox (MessageBoxIconType iconType, const String& title, const String& message, #if JUCE_MODAL_LOOPS_PERMITTED Component* associatedComponent = nullptr, ModalComponentManager::Callback* callback = nullptr); #else Component* associatedComponent, ModalComponentManager::Callback* callback); #endif private: NativeMessageBox() = delete; JUCE_DECLARE_NON_COPYABLE (NativeMessageBox) }; } // namespace juce