SectionWidget.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: SectionWidget
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/SectionContent.h>
#include <NDEVR/QCustomStackedWidget.h>
#include <NDEVR/UUID.h>
#include <NDEVR/Buffer.h>
#include <QScrollArea>
class QBoxLayout;
class QStackedLayout;
class QPushButton;
class QMenu;
class QToolButton;
class QPropertyAnimation;
namespace NDEVR
{
    class ContainerWidgetBase;
    class Button;
    class SectionWidgetTabsScrollArea;
    /**--------------------------------------------------------------------------------------------------
    \brief SectionWidget manages multiple instances of SectionContent. It displays a title TAB, which is 
        clickable and will switch to the contents associated to the title when clicked.
    **/
    class NDEVR_WIDGETS_API SectionWidget : public QCustomStackedWidgetBase
    {
        Q_OBJECT
        Q_PROPERTY(double animation_progress READ animationProgress WRITE setAnimationProgress)
    public:
        explicit SectionWidget(ContainerWidgetBase* parent, RibbonArea ribbon_area);
        virtual ~SectionWidget();
        explicit operator const QWidget* () const { return this; }
        explicit operator QWidget* () { return this; }
        explicit operator const QObject* () const { return this; }
        explicit operator QObject* () { return this; }
        UUID uid() const;
        ContainerWidgetBase* containerWidget() const;
        RibbonArea ribbonArea() const { return m_ribbon_area; }
        void setRibbonArea(RibbonArea area);
        const Buffer<SectionContent*>& contents() const { return m_contents; }
        void addContent(SectionContent* c);
        void addContent(SectionContent* data, bool animate);
        void insertContent(uint04 index, SectionContent* data, bool animate);
        bool takeContent(uint04 index);
        bool takeContent(SectionContent* data);
        uint04 indexOfContent(SectionContent* c) const;
        uint04 contentCount() const;
        uint04 indexOfContentByUid(UUID uid) const;
        uint04 indexOfContentByTitlePos(const QPoint& pos, QWidget* exclude = nullptr) const;
        bool isLayoutVertical() const;
        void hideCurrentSection();
        bool isRibbonHorizontal() const;
        bool isRibbonLayoutHorizontal() const;
        void setTabLock(bool tab_lock);
        void setTabVisible(bool visible);
        uint04 activeIndex() const;
        uint04 currentIndex() const;
        uint04 indexOf(SectionContent* c);
        void setAnimationProgress(double width);
        void finishAnimation();
        void setCurrentIndex(uint04 index, bool animate);
        SectionWidgetTabsScrollArea* tabScrollArea() { return m_tabs_scroll_area; };
        bool showTabs() const { return m_show_tabs; }
        bool hasVisibleTab() const;
        void updateLayout(QBoxLayout* layout);
        void setMinimizeAllowed(bool allowed);
        bool minimizeAllowed();
        void setupAsBoxWidget(bool is_box_widget);
        QRect titleAreaGeometry() const;
        void moveContent(uint04 from, uint04 to) override;
        void swapIndices(uint04 from, uint04 to) override;
        QSize minimumSizeHint() const override;
        QSize sizeHint() const override;
    protected:
        virtual void showEvent(QShowEvent*) override;
        void resizeEvent(QResizeEvent* event) override;
        bool event(QEvent* event) override;
    private:
        int prefferedContentWidth() const;
        double animationProgress() const { return m_max_animation_progress; };
        QSize normalMinimumSize() const;
        void createCollapseAnimation();
        uint04 convertToIndexVisibleIndex(uint04 index);
        int tabSize() const;
    signals:
        void ribbonLocationChangedSignal(RibbonArea area);
        void tabChangedSignal(uint04 idx);
        void userChangedCurrentTabSignal(uint04 idx);
    private slots:
        void showTabMenuButtonIfNeeded();
        void onTabsMenuButtonClicked();
        void onSectionTitleClicked(SectionContent* content);
        void onSpecialTitleClicked(SectionContent* content);
        void onTabsMenuActionTriggered(bool);
    public slots:
        void updateTabs();
    private:
        const UUID m_uid;
        ContainerWidgetBase* m_container;
        Buffer<SectionContent*> m_contents;
        Buffer<SectionTab*> m_section_titles;
        Buffer<QWidget*> m_section_contents;
        RibbonArea m_ribbon_area;
        SectionWidgetTabsScrollArea* m_tabs_scroll_area;
        Button* m_tabs_button;
        uint04 m_current_index;
        int m_last_width;
        double m_max_animation_progress;
        QPixmap* m_cached_image;
        QPointer<QPropertyAnimation> m_resize_animation;
        fltp08 m_location;
        bool m_has_rendered = false;
        bool m_minimize_allowed = true;
        bool m_show_tabs = true;
    };
 
    
}