juce::DialogWindow::LaunchOptions Struct Reference

#include <juce_DialogWindow.h>

Public Member Functions
	LaunchOptions () noexcept
DialogWindow *	launchAsync ()
DialogWindow *	create ()

Public Attributes
String	dialogTitle
Colour	dialogBackgroundColour = Colours::lightgrey
OptionalScopedPointer< Component >	content
Component *	componentToCentreAround = nullptr
bool	escapeKeyTriggersCloseButton = true
bool	useNativeTitleBar = true
bool	resizable = true
bool	useBottomRightCornerResizer = false

Detailed Description

This class defines a collection of settings to be used to open a DialogWindow.

The easiest way to open a DialogWindow is to create yourself a LaunchOptions structure, initialise its fields with the appropriate details, and then call its launchAsync() method to launch the dialog.

Constructor & Destructor Documentation

LaunchOptions()

juce::DialogWindow::LaunchOptions::LaunchOptions ( )

noexcept

Member Function Documentation

create()

DialogWindow * juce::DialogWindow::LaunchOptions::create

(

)

Creates a new DialogWindow instance with these settings. This method simply creates the window, it doesn't run it modally. In most cases you'll want to use launchAsync() or runModal() instead.

launchAsync()

DialogWindow * juce::DialogWindow::LaunchOptions::launchAsync

(

)

Launches a new modal dialog window. This will create a dialog based on the settings in this structure, launch it modally, and return immediately. The window that is returned will be automatically deleted when the modal state is terminated.

When the dialog's close button is clicked, it'll automatically terminate its modal state, but you can also do this programmatically by calling exitModalState (returnValue) on the DialogWindow.

If your content component needs to find the dialog window that it is contained in, a quick trick is to do this:

if (DialogWindow* dw = contentComponent->findParentComponentOfClass<DialogWindow>())
    dw->exitModalState (1234);

Member Data Documentation

componentToCentreAround

Component* juce::DialogWindow::LaunchOptions::componentToCentreAround = nullptr

If this is not a nullptr, it indicates a component that you'd like to position this dialog box in front of. See the DocumentWindow::centreAroundComponent() method for more info about this parameter.

content

OptionalScopedPointer<Component> juce::DialogWindow::LaunchOptions::content

The content component to show in the window. This must not be null! Using an OptionalScopedPointer to hold this pointer lets you indicate whether you'd like the dialog to automatically delete the component when the dialog has terminated.

dialogBackgroundColour

Colour juce::DialogWindow::LaunchOptions::dialogBackgroundColour = Colours::lightgrey

The background colour for the window.

dialogTitle

String juce::DialogWindow::LaunchOptions::dialogTitle

The title to give the window.

escapeKeyTriggersCloseButton

bool juce::DialogWindow::LaunchOptions::escapeKeyTriggersCloseButton = true

If true, then the escape key will trigger the dialog's close button.

resizable

bool juce::DialogWindow::LaunchOptions::resizable = true

If true, the window will be resizable. See ResizableWindow::setResizable()

useBottomRightCornerResizer

bool juce::DialogWindow::LaunchOptions::useBottomRightCornerResizer = false

Indicates whether to use a border or corner resizer component. See ResizableWindow::setResizable()

useNativeTitleBar

bool juce::DialogWindow::LaunchOptions::useNativeTitleBar = true

If true, the dialog will use a native title bar. See TopLevelWindow::setUsingNativeTitleBar()

---

The documentation for this struct was generated from the following files:

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/windows/juce_DialogWindow.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/windows/juce_DialogWindow.cpp