juce_DialogWindow.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   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
{
 
//==============================================================================
class JUCE_API  DialogWindow   : public DocumentWindow
{
public:
    //==============================================================================
    DialogWindow (const String& name,
                  Colour backgroundColour,
                  bool escapeKeyTriggersCloseButton,
                  bool addToDesktop = true,
                  float desktopScale = 1.0f);

    ~DialogWindow() override;
 
    //==============================================================================
    struct JUCE_API  LaunchOptions
    {
        LaunchOptions() noexcept;

        String dialogTitle;

        Colour dialogBackgroundColour = Colours::lightgrey;

        OptionalScopedPointer<Component> content;

        Component* componentToCentreAround = nullptr;

        bool escapeKeyTriggersCloseButton = true;
        bool useNativeTitleBar = true;
        bool resizable = true;
        bool useBottomRightCornerResizer = false;

        DialogWindow* launchAsync();

        DialogWindow* create();
 
       #if JUCE_MODAL_LOOPS_PERMITTED
        int runModal();
       #endif
 
        JUCE_DECLARE_NON_COPYABLE (LaunchOptions)
    };
 
    //==============================================================================
    static void showDialog (const String& dialogTitle,
                            Component* contentComponent,
                            Component* componentToCentreAround,
                            Colour backgroundColour,
                            bool escapeKeyTriggersCloseButton,
                            bool shouldBeResizable = false,
                            bool useBottomRightCornerResizer = false,
                            bool useNativeTitleBar = true);
 
   #if JUCE_MODAL_LOOPS_PERMITTED
    static int showModalDialog (const String& dialogTitle,
                                Component* contentComponent,
                                Component* componentToCentreAround,
                                Colour backgroundColour,
                                bool escapeKeyTriggersCloseButton,
                                bool shouldBeResizable = false,
                                bool useBottomRightCornerResizer = false,
                                bool useNativeTitleBar = true);
   #endif
 

    virtual bool escapeKeyPressed();
 
protected:
    //==============================================================================
    void resized() override;
    bool keyPressed (const KeyPress&) override;
    float getDesktopScaleFactor() const override { return desktopScale * Desktop::getInstance().getGlobalScaleFactor(); }
 
private:
    std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
 
    float desktopScale = 1.0f;
    bool escapeKeyTriggersCloseButton;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (DialogWindow)
};
 
} // namespace juce