Ribbon.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: Ribbon
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/RibbonLayoutMode.h>
#include <NDEVR/ContainerWidget.h>
#include <NDEVR/QCustomDockWidget.h>
#include <NDEVR/RibbonArea.h>
#include <NDEVR/String.h>
#include <NDEVR/BaseValues.h>
#include <NDEVR/Dictionary.h>
#include <QFrame>
class QBoxLayout;
namespace NDEVR
{
    class RibbonGroup;
    /**--------------------------------------------------------------------------------------------------
    \brief The UI ribbon is a horizontal menu bar typically located at the top of the application 
        interface or along the side. It organizes commands and tools into tabs and groups for easy access. 
    Each tab contains related functionality, categorized into sections such as File, Edit, View, etc. 
    Within these sections, buttons, dropdowns, and other controls allow users to interact with the application features efficiently.
    The ribbon improves usability by presenting frequently-used commands in a visually organized manner.
    **/
    class NDEVR_WIDGETS_API Ribbon : public ContainerWidgetBase
    {
    public:
        explicit Ribbon(QWidget* parent = nullptr);
        ~Ribbon();
        bool isVertical() { return m_is_vertical; };
        const RibbonGroup& group(const TranslatedString& group_name) const;
        void setGroupName(uint04 index, const TranslatedString& group_name);
        void setInverseRibbonArea(bool inverse_ribbon_area);
        RibbonGroup& group(const TranslatedString& group_name);
        DockWidget<RibbonGroup>* groupDock(const RibbonGroup* group);
        DockWidget<RibbonGroup>* groupDock(const TranslatedString& group_name)
        {
            return m_groups[group_name];
        }
        
        RibbonGroup& group(uint04 index);
        DockWidget<RibbonGroup>* groupDock(uint04 index)
        {
            return m_index_groups[index];
        }
        void updateRibbonLayout();
        /// Handle window drag events
        virtual RibbonGroup* addGroup(const TranslatedString& label);
        virtual void addGroup(RibbonGroup* group);
        virtual void removeGroup(const TranslatedString& label);
        virtual void removeGroup(uint04 index);
        virtual void removeAllGroups();
        virtual bool hasGroup(const TranslatedString& group) const;
        SectionWidget* section() const;
        RibbonGroup& operator[](const TranslatedString& location)
        {
            if (!hasGroup(location))
                addGroup(location);
            return group(location);
        }
        void setLayoutMode(RibbonLayoutMode mode);
        void resizeEvent(QResizeEvent *resize_event) override;
        void setFixedNumOfRows(uint01 fixed_num_of_rows);
        QSize sizeHint() const override;
        QSize minimumSizeHint() const override;
        Dictionary<TranslatedString, DockWidget<RibbonGroup>*>& groups() { return m_groups; };
        void addTopLeftWidget(QWidget* widget);
        void addBottomRightWidget(QWidget* widget);
        void slideInIdx(uint04 idx, enum StackAnimationDirection direction = StackAnimationDirection::e_automatic) override {
            QCustomStackedWidgetBase::slideInIdx(idx, direction);
        }
        void setTabLock(bool tab_lock) { ContainerWidgetBase::setTabLock(tab_lock); }
    private:
        virtual void _setVertical(bool is_vertical);
    private:
        bool m_is_vertical;
        bool m_inverse_ribbon_area;
        RibbonLayoutMode m_layout_mode;
        uint01 m_fixed_num_of_rows;
        Dictionary<TranslatedString, DockWidget<RibbonGroup>*> m_groups;
        Buffer<DockWidget<RibbonGroup>*> m_index_groups;
        Buffer<QPointer<QWidget>> m_top_left_widgets;
        Buffer<QPointer<QWidget>> m_bottom_right_widgets;
        Buffer<TranslatedString> m_index_names;
    };
 
 
}