SectionWidgetTabsScrollArea.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: SectionWidgetTabsScrollArea
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/RibbonArea.h>
#include <NDEVR/Buffer.h>
#include <QWidget>
class QScrollArea;
class QFrame;
class QBoxLayout;
class QSpacerItem;
namespace NDEVR
{
    class SelectionHighlightBar;
    class ScrollEdge;
    /**--------------------------------------------------------------------------------------------------
    \brief Custom scrollable implementation for docked tabs using the NDEVR API Widget Docking system.
    **/
    class NDEVR_WIDGETS_API SectionWidgetTabsScrollArea : public QWidget
    {
        Q_OBJECT
    public:
        SectionWidgetTabsScrollArea(QWidget* parent = nullptr);
        virtual ~SectionWidgetTabsScrollArea();
        QSize sizeHint() const override;
        QSize minimumSizeHint() const override;
        QWidget* tabsContainer() const { return m_tabs_container_widget; }
        void removeMainWidget(bool animate);
        void insertMainWidget(uint04 index, QWidget* widget, bool animate);
        void insertTabWidget(uint04 index, QWidget* widget);
        void removeTabWidget(QWidget* widget);
        bool hasTabWidget(QWidget* widget);
        void setWidgetSelected(QWidget* widget);
        void resizeEvent(QResizeEvent* event) override;
        QScrollArea* scrollArea() { return m_scroll_area; }
        void setArea(RibbonArea area);
        RibbonArea area() const { return m_ribbon_area; }
        uint04 indexOf(QWidget* widget) const;
        uint04 count() const;
        QWidget* widget(uint04 index);
        void swap(uint04 a, uint04 b);
        void move(uint04 from, uint04 to);
        bool isAtBottom() const;
        bool isAtTop() const;
        bool isVertical() const;
        bool isRelativeVertical() const;
        bool isTextVertical() const;
        void jumpToBottom();
        void setAutoExpand(bool auto_expand);
        void paintEvent(QPaintEvent* event) override;
        void updateSeperatorSizes();
        void showEvent(QShowEvent*) override;
        bool event(QEvent* event) override;
        QWidget* mainWidget() const;
    signals:
        void boundsUpdateFinishedSignal();
    protected:
        QSize scrollSizeHint() const;
        void setupSeperator(QFrame* line);
        QBoxLayout* tabsLayout() { return m_tabs_layout; }
        void resetScroller();
        void recalculateScrollerSnaps();
        void updateSelectionWidgetHighlight();
        void updateEdgeLocations();
        void updateSizePolicy();
    protected:
        virtual void wheelEvent(QWheelEvent*) override;
        QScrollArea* m_scroll_area;
        QWidget* m_tabs_container_widget;
        QBoxLayout* m_tabs_layout;
        QWidget* m_inner_scroll;
        QWidget* m_selected_widget;
        QWidget* m_float_widget;
        QBoxLayout* m_inner_scroll_layout;
        QSpacerItem* m_spacer_item;
        Buffer<QFrame*> m_seperators;
        Buffer<QWidget*> m_widgets;
        QWidget* m_main_widget = nullptr;
        SelectionHighlightBar* m_highlight_bar;
        RibbonArea m_ribbon_area;
        QTimer* m_bounds_updater;
        ScrollEdge* m_top_edge;
        ScrollEdge* m_bottom_edge;
        bool m_is_shown;
        bool m_is_bottom = false;
        bool m_auto_scroll_to_bottom;
        bool m_auto_expand = false;
        uint04 m_update_count;
        uint04 m_main_widget_location = Constant<uint04>::Invalid;
    };
}