JUCE v8.0.9
JUCE API
 
Loading...
Searching...
No Matches
juce::ScopedMessageBox Class Reference

Objects of this type can be used to programmatically close message boxes. More...

#include <juce_ScopedMessageBox.h>

Collaboration diagram for juce::ScopedMessageBox:

Public Member Functions

 ScopedMessageBox ()
 Constructor.
 
 ScopedMessageBox (ScopedMessageBox &&) noexcept
 Move constructor.
 
 ScopedMessageBox (std::shared_ptr< detail::ScopedMessageBoxImpl >)
 
 ~ScopedMessageBox () noexcept
 Destructor.
 
void close ()
 Closes the message box, if it is currently showing.
 
ScopedMessageBoxoperator= (ScopedMessageBox &&) noexcept
 Move assignment operator.
 

Private Attributes

std::shared_ptr< detail::ScopedMessageBoxImplimpl
 

Detailed Description

Objects of this type can be used to programmatically close message boxes.

See also
NativeMessageBox::showScopedAsync(), AlertWindow::showScopedAsync()

@tags{GUI}

Constructor & Destructor Documentation

◆ ScopedMessageBox() [1/3]

juce::ScopedMessageBox::ScopedMessageBox ( std::shared_ptr< detail::ScopedMessageBoxImpl )
explicit

◆ ScopedMessageBox() [2/3]

juce::ScopedMessageBox::ScopedMessageBox ( )

Constructor.

◆ ~ScopedMessageBox()

juce::ScopedMessageBox::~ScopedMessageBox ( )
noexcept

Destructor.

◆ ScopedMessageBox() [3/3]

juce::ScopedMessageBox::ScopedMessageBox ( ScopedMessageBox &&  )
noexcept

Move constructor.

Member Function Documentation

◆ close()

void juce::ScopedMessageBox::close ( )

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.

◆ operator=()

ScopedMessageBox & juce::ScopedMessageBox::operator= ( ScopedMessageBox &&  )
noexcept

Move assignment operator.

Member Data Documentation

◆ impl

std::shared_ptr<detail::ScopedMessageBoxImpl> juce::ScopedMessageBox::impl
private

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