ContainerWidget.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Widgets
File: ContainerWidget
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/RibbonArea.h>
#include <NDEVR/QCustomStackedWidget.h>
#include <NDEVR/Dictionary.h>
#include <NDEVR/UUID.h>
#include <QPointer>
class QPoint;
class QSplitter;
class QMenu;
class QBoxLayout;
class QGridLayout;
 
namespace NDEVR
{
    class SectionWidget;
    class DropOverlay;
    class InternalContentData;
    class QCustomSplitter;
    class FloatingWidget;
    class SectionContent;
    class SharedSectionContentArea;
    /**--------------------------------------------------------------------------------------------------
    \brief The root class that manages a series of SectionContent that can share the same space or lay out 
        in various patterns including as floating windows used within NDEVR API Widget Docking system.
    While the NDEVR API Widget Docking system allows widgets to be floating, they must still subrscribe
        to a ContainerWidgetBase which acts as a parent window and, if necessary, causes the widget
        to rejoin the Container. When asked for being displayed full-screen, the widget will take over
        the complete space of the ContainerWidgetBase.
    A ContainerWidgetBase inherits from QCustomStackedWidgetBase which which is only used when a 
        widget wants to go fullscreen. Othewise it is always on index 0 which contains the section content
        in the specified layout.
     **/
    class NDEVR_WIDGETS_API ContainerWidgetBase : public QCustomStackedWidgetBase
    {
        Q_OBJECT
        friend class SectionContent;
        friend class SectionWidget;
        friend class FloatingWidget;
        friend class SectionTab;
        friend class DockItem;
        friend class QCustomDockWidget;
        friend class CustomDockButton;
        friend class MainWindow;
    public:
        explicit ContainerWidgetBase(QWidget *parent = nullptr);
        virtual ~ContainerWidgetBase();
    protected:
        virtual SectionWidget* addSectionContent(SectionContent* sc, SectionWidget* sw, DropArea area = e_drop_center);
        virtual FloatingWidget* addSectionContent(SectionContent* sc);
        FloatingWidget* makeFloating(SectionContent* sc, bool show, PopupInfo start = PopupInfo(), PopupInfo end = PopupInfo());
        FloatingWidget* makeFullScreen(SectionContent* sc, PopupInfo start = PopupInfo());
        bool popWindowStack();
        bool hasSectionContent(SectionContent* sc);
        bool removeSectionContent(SectionContent* sc);
        void resizeEvent(QResizeEvent* event) override;
        bool showSectionContent(SectionContent* sc, PopupInfo start = PopupInfo(), PopupInfo end = PopupInfo());
        bool hideSectionContent(SectionContent* sc, PopupInfo end = PopupInfo());
        bool raiseSectionContent(SectionContent* sc);
        void bringFloatingWidgetsForward();
        void setTabLock(bool tab_lock);
        void beginResetAll();
        void removeFromResetShow(UUID id);
        void endResetAll();
        bool isSectionContentVisible(SectionContent* sc);
        void swapSectionContent(SectionContent* section_a, SectionContent* section_b);
        Buffer<SectionContent*> contents() const;
        QRect outerTopDropRect() const;
        QRect outerRightDropRect() const;
        QRect outerBottomDropRect() const;
        QRect outerLeftDropRect() const;
        QSize sizeHint() const override;
        DropOverlay* dropOverlay();
        virtual void setShouldAnimateAdd(bool animate);
        virtual void clearAllSectionContent();
        virtual void clearAllNonFloatingContent();
    protected:
        QSize minimumSizeHint() const override;
        bool event(QEvent* event) override;
    private:
        SharedSectionContentArea* createSection(Qt::Orientation orientation, QWidget* parent);
        void exitCurrentFullscreen();
        void pullFromFullScreenStack(FloatingWidget* widget);
        SharedSectionContentArea* findParentSplitter(const QWidget* w, QWidget** parent_widget = nullptr);
        void pullContent(SectionWidget* sw, SectionContent* data);
        SectionWidget* dropContent(SectionContent* data, SectionWidget* targetSection, DropArea area);
        void addSection(SectionWidget* section);
        SectionWidget* sectionAt(const QPoint& pos) const;
        SectionWidget* dropContentOuterHelper(QLayout* l, SectionContent* data, Qt::Orientation orientation, bool append);
        bool splitterContainsSectionWidget(SharedSectionContentArea* splitter);
        void deleteEmptySplitters();
        void pushCurrentToFullscreenStack();
    protected:
        Dictionary<UUID, SectionWidget*> m_sections;
        Dictionary<UUID, SectionContent*> m_section_content;
        SharedSectionContentArea* m_top_splitter = nullptr;
        DropOverlay* m_drop_overlay;
        SectionWidget* m_top_section_widget = nullptr;
        Buffer<SharedSectionContentArea*> m_shared_content;
        Buffer<std::pair<QPointer<QWidget>, Buffer<QPointer<FloatingWidget>>>> m_fullscreen_stack;
        Buffer<std::pair<QPointer<QWidget>, Buffer<QPointer<FloatingWidget>>>> m_reset_fullscreen_stack;
        Buffer<UUID> m_reset_visible_sections;
        bool m_animate_add = true;
        bool m_reset_is_on_home = false;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief manages a series of SectionContent that can share the same space or lay out in various patterns
        including as floating windows used within NDEVR API Widget Docking system.
    While the NDEVR API Widget Docking system allows widgets to be floating, they must still subrscribe
        to a ContainerWidgetBase which acts as a parent window and, if necessary, causes the widget
        to rejoin the Container. When asked for being displayed full-screen, the widget will take over
        the complete space of the ContainerWidgetBase.
    A ContainerWidgetBase inherits from QCustomStackedWidgetBase which which is only used when a
        widget wants to go fullscreen. Othewise it is always on index 0 which contains the section content
        in the specified layout.
     **/
    class NDEVR_WIDGETS_API ContainerWidget : public ContainerWidgetBase
    {
    public:
        ContainerWidget(QWidget* parent = nullptr)
            : ContainerWidgetBase(parent)
        {}
        void clearAllSectionContent() override
        {
            ContainerWidgetBase::clearAllSectionContent();
        };
        void setShouldAnimateAdd(bool animate) override
        {
            ContainerWidgetBase::setShouldAnimateAdd(animate);
        }
        void setTabLock(bool tab_lock)
        {
            ContainerWidgetBase::setTabLock(tab_lock);
        }
    };
}