1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00
JUCE/modules/juce_gui_basics/windows/juce_ScopedMessageBox.h
reuk 79ed81c24a
ScopedMessageBox: Add new helper type to bound alert window lifetimes
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.
2023-02-22 21:00:08 +00:00

69 lines
2 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
{
/**
Objects of this type can be used to programmatically close message boxes.
@see NativeMessageBox::showScopedAsync(), AlertWindow::showScopedAsync()
*/
class ScopedMessageBox
{
public:
/** Constructor */
ScopedMessageBox();
/** Destructor */
~ScopedMessageBox() noexcept;
/** Move constructor */
ScopedMessageBox (ScopedMessageBox&&) noexcept;
/** Move assignment operator */
ScopedMessageBox& operator= (ScopedMessageBox&&) noexcept;
/** Closes the message box, if it is currently showing.
This is also called automatically during ~ScopedMessageBox. This is useful if you want
to display a message corresponding to a particular view, and hide the message automatically
when the view is hidden. This situation commonly arises when displaying messages in plugin
editors.
*/
void close();
/** @internal */
class Pimpl;
private:
explicit ScopedMessageBox (std::shared_ptr<Pimpl>);
std::shared_ptr<Pimpl> pimpl;
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ScopedMessageBox)
};
} // namespace juce