juce_MultiDocumentPanel.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 MultiDocumentPanel;
 
 
//==============================================================================
class JUCE_API  MultiDocumentPanelWindow  : public DocumentWindow
{
public:
    //==============================================================================
    MultiDocumentPanelWindow (Colour backgroundColour);

    ~MultiDocumentPanelWindow() override;
 
    //==============================================================================
    void maximiseButtonPressed() override;
    void closeButtonPressed() override;
    void activeWindowStatusChanged() override;
    void broughtToFront() override;
 
private:
    //==============================================================================
    void updateOrder();
    MultiDocumentPanel* getOwner() const noexcept;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (MultiDocumentPanelWindow)
};
 
 
//==============================================================================
class JUCE_API  MultiDocumentPanel  : public Component,
                                      private ComponentListener
{
public:
    //==============================================================================
    MultiDocumentPanel();

    ~MultiDocumentPanel() override;
 
    //==============================================================================
   #if JUCE_MODAL_LOOPS_PERMITTED
    bool closeAllDocuments (bool checkItsOkToCloseFirst);
   #endif

    void closeAllDocumentsAsync (bool checkItsOkToCloseFirst,
                                 std::function<void (bool)> callback);

    bool addDocument (Component* component,
                      Colour backgroundColour,
                      bool deleteWhenRemoved);
 
   #if JUCE_MODAL_LOOPS_PERMITTED
    bool closeDocument (Component* component,
                        bool checkItsOkToCloseFirst);
   #endif

    void closeDocumentAsync (Component* component,
                             bool checkItsOkToCloseFirst,
                             std::function<void (bool)> callback);

    int getNumDocuments() const noexcept;

    Component* getDocument (int index) const noexcept;

    Component* getActiveDocument() const noexcept;

    void setActiveDocument (Component* component);

    virtual void activeDocumentChanged();

    void setMaximumNumDocuments (int maximumNumDocuments);

    void useFullscreenWhenOneDocument (bool shouldUseTabs);

    bool isFullscreenWhenOneDocument() const noexcept;
 
    //==============================================================================
    enum LayoutMode
    {
        FloatingWindows,            
        MaximisedWindowsWithTabs    
    };

    void setLayoutMode (LayoutMode newLayoutMode);

    LayoutMode getLayoutMode() const noexcept                           { return mode; }

    void setBackgroundColour (Colour newBackgroundColour);

    Colour getBackgroundColour() const noexcept                         { return backgroundColour; }

    TabbedComponent* getCurrentTabbedComponent() const noexcept         { return tabComponent.get(); }
 
    //==============================================================================
   #if JUCE_MODAL_LOOPS_PERMITTED
    virtual bool tryToCloseDocument (Component* component);
   #endif

    virtual void tryToCloseDocumentAsync (Component* component, std::function<void (bool)> callback) = 0;

    virtual MultiDocumentPanelWindow* createNewDocumentWindow();
 
    //==============================================================================
    void paint (Graphics&) override;
    void resized() override;
    void componentNameChanged (Component&) override;
 
private:
    //==============================================================================
    void closeDocumentInternal (Component*);
    static void closeLastDocumentRecursive (SafePointer<MultiDocumentPanel>,
                                            bool,
                                            std::function<void (bool)>);
 
    //==============================================================================
    struct TabbedComponentInternal;
    friend class MultiDocumentPanelWindow;
 
    Component* getContainerComp (Component*) const;
    void updateOrder();
    void addWindow (Component*);
 
    LayoutMode mode = MaximisedWindowsWithTabs;
    Array<Component*> components;
    std::unique_ptr<TabbedComponent> tabComponent;
    Colour backgroundColour { Colours::lightblue };
    int maximumNumDocuments = 0, numDocsBeforeTabsUsed = 0;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (MultiDocumentPanel)
};
 
} // namespace juce