RibbonGroup.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: NDEVR
File: RibbonGroup
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/RibbonLayoutMode.h>
#include <NDEVR/Buffer.h>
#include <NDEVR/String.h>
#include <NDEVR/Dictionary.h>
#include <QWidget>
#include <QBoxLayout>
class QFrame;
namespace NDEVR
{
    class QCustomLabel;
    class RibbonSubGroup;
    class TranslatedString;
    /**--------------------------------------------------------------------------------------------------
    \brief Represents the "Tab" of a widget. For example sections such as Home, View, Edit, Measurements
        would all be RibbonGroups and children of a Ribbon object. 
    **/
    class NDEVR_WIDGETS_API RibbonGroup : public QWidget
    {
        Q_OBJECT
    public:
        RibbonGroup(QWidget* parent = nullptr);
        RibbonSubGroup* addSubGroup(const TranslatedString& sub_group_name);
        void addSubGroup(QWidget* sub_group);
        RibbonSubGroup& operator[](const TranslatedString& location);
        QSize minimumSizeHint() const override;
        bool hasSubGroup(const TranslatedString& sub_group) const;
        int currentPrimaryDimension() const;
        int currentSecondaryDimension() const;
        int marginThickness() const;
        bool event(QEvent* ev) override;
        int largeButtonWidth() const;
        int mediumButtonWidth() const;
        uint04 maxNumOfColumns() const;
        void setupSeperator(QFrame* seperator) const;
        Vector<2, int> minSize() const;
        void setNumberOfRows(uint04 number_of_rows);
        void ribbonResizeEvent(int primary, int secondary);
        void resizeEvent(QResizeEvent* resize_event) override;
        void updateLayout(QSize size);
        void setVertical(bool is_vertical);
        void resetButtonStates();
        void adjustButtonsToFit(int primary, int secondary);
        void setFixedNumOfRows(uint01 fixed_num_of_rows);
    public slots:
        void layoutSubGroups();
    public:
        Buffer<QWidget*> m_sub_groups;
        Buffer<QFrame*> m_seperators;
        Dictionary<String, RibbonSubGroup*> m_sub_group_lookup;
        uint04 m_row_num;
        RibbonLayoutMode m_layout_mode;
        bool m_is_vertical;
        int m_last_width;
        uint01 m_fixed_num_of_rows;
        QBoxLayout* m_layout;
    };
 
}