juce_DocumentWindow.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  DocumentWindow   : public ResizableWindow
{
public:
    //==============================================================================
    enum TitleBarButtons
    {
        minimiseButton = 1,
        maximiseButton = 2,
        closeButton = 4,

        allButtons = 7
    };
 
    //==============================================================================
    DocumentWindow (const String& name,
                    Colour backgroundColour,
                    int requiredButtons,
                    bool addToDesktop = true);

    ~DocumentWindow() override;
 
    //==============================================================================
    void setName (const String& newName) override;

    void setIcon (const Image& imageToUse);

    void setTitleBarHeight (int newHeight);

    int getTitleBarHeight() const;

    void setTitleBarButtonsRequired (int requiredButtons,
                                     bool positionTitleBarButtonsOnLeft);

    void setTitleBarTextCentred (bool textShouldBeCentred);
 
    //==============================================================================
    void setMenuBar (MenuBarModel* menuBarModel,
                     int menuBarHeight = 0);

    Component* getMenuBarComponent() const noexcept;

    void setMenuBarComponent (Component* newMenuBarComponent);
 
    //==============================================================================
    virtual void closeButtonPressed();

    virtual void minimiseButtonPressed();

    virtual void maximiseButtonPressed();
 
    //==============================================================================
    Button* getCloseButton() const noexcept;

    Button* getMinimiseButton() const noexcept;

    Button* getMaximiseButton() const noexcept;
 
    //==============================================================================
    enum ColourIds
    {
        textColourId                = 0x1005701,  
    };
 
    //==============================================================================
    struct JUCE_API  LookAndFeelMethods
    {
        virtual ~LookAndFeelMethods() = default;
 
        virtual void drawDocumentWindowTitleBar (DocumentWindow&,
                                                 Graphics&, int w, int h,
                                                 int titleSpaceX, int titleSpaceW,
                                                 const Image* icon,
                                                 bool drawTitleTextOnLeft) = 0;
 
        virtual Button* createDocumentWindowButton (int buttonType) = 0;
 
        virtual void positionDocumentWindowButtons (DocumentWindow&,
                                                    int titleBarX, int titleBarY, int titleBarW, int titleBarH,
                                                    Button* minimiseButton,
                                                    Button* maximiseButton,
                                                    Button* closeButton,
                                                    bool positionTitleBarButtonsOnLeft) = 0;
    };
 
    //==============================================================================
   #ifndef DOXYGEN
    void paint (Graphics&) override;
    void resized() override;
    void lookAndFeelChanged() override;
    BorderSize<int> getBorderThickness() override;
    BorderSize<int> getContentComponentBorder() override;
    void mouseDoubleClick (const MouseEvent&) override;
    void userTriedToCloseWindow() override;
    void activeWindowStatusChanged() override;
    int getDesktopWindowStyleFlags() const override;
    void parentHierarchyChanged() override;
    Rectangle<int> getTitleBarArea();
   #endif
 
private:
    //==============================================================================
    int titleBarHeight = 26, menuBarHeight = 24, requiredButtons;
    bool positionTitleBarButtonsOnLeft, drawTitleTextCentred = true;
    std::unique_ptr<Button> titleBarButtons [3];
    Image titleBarIcon;
    std::unique_ptr<Component> menuBar;
    MenuBarModel* menuBarModel = nullptr;
 
    class ButtonListenerProxy;
    std::unique_ptr<ButtonListenerProxy> buttonListener;
 
    void repaintTitleBar();
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (DocumentWindow)
};
 
} // namespace juce