RibbonSubGroup.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: RibbonSubGroup
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/RibbonLayoutMode.h>
#include <NDEVR/Button.h>
#include <NDEVR/QCustomLabel.h>
class QGridLayout;
namespace NDEVR
{
    class Button;
    class QCustomLabel;
    class Button;
    /**--------------------------------------------------------------------------------------------------
    \brief Represents a sub-section of "Tab" of a ribbon represting a grouping of buttons or widgets within
        a tab that provide similar functions.
    **/
    class NDEVR_WIDGETS_API RibbonSubGroup : public QWidget
    {
        Q_OBJECT
            friend class RibbonGroup;
    public:
        RibbonSubGroup(QWidget* parent = nullptr);
        void init();
        RibbonSubGroup(const TranslatedString& title, QWidget* parent = nullptr);
        Button* addButton(Button* button, uint04 index = Constant<uint04>::Invalid, bool update_layout = false);
        const Buffer<Button*>& buttons() const { return m_buttons; }
        void removeButton(Button* button);
        Vector<2, int> calcSize() const;
        void clear();
        void setIgnoredSize(bool ignored);
        QSize sizeHint() const override;
        QSize minimumSizeHint() const override;
        void setSpacing(int spacing);
        int currentPrimary() const;
        int currentSecondary() const;
        int largeButtonWidth() const;
        int mediumButtonWidth() const;
        void setIconSizeMultiplier(fltp04 size_multiplier);
        Vector<2, int> minSize() const;
 
        Vector<2, int> estimatedSize() const { return m_estimated_size; }
        virtual void setVisible(bool is_visible) override;
 
        void setLayoutMode(RibbonLayoutMode layout_mode) { m_layout_mode = layout_mode; }
 
        void setNumberOfRows(uint04 number_of_rows);
        int marginThickness() const;
        void setExpandingIcons(bool expanding);
 
        void setTitle(const TranslatedString& title);
        const TranslatedString& title() const { return m_title; }
        uint04 numOfColumns() const;
        void resizeEvent(QResizeEvent* resize_event) override;
        void setFixedNumOfRows(uint01 fixed_num_of_rows);
        void updateRibbonLayout();
        virtual void sortButtons(const std::function<bool(Button*, Button*)>& sorter);
        void setVertical(bool is_vertical);
    signals:
        void requestLayoutUpdate();
    private:
        void updateButtonSize(uint04 button, int secondary_size, bool use_default);
        bool event(QEvent* ev) override;
        void customLayout();
        void addToButtonSize(Button* button);
        Vector<2, int> largeButtonSize() { return m_large_button_size; }
        void updateLayout(QSize size);
        int secondarySize();
        void resetButtonState();
        bool requestLarger();
        bool requestLarger(int secondary_size);
        bool requestSmaller(uint01 priority, uint04 col_count);
        bool requestSmaller(uint01 priority, uint04 col_count, int secondary_size);
        void autoFitIcons();
        uint04 weight() const;
        void updateLabel();
        void _ribbonResizeEvent(int primary, int secondary);
    protected:
        Buffer<Button*> m_buttons;
        QGridLayout* m_layout;
        QCustomLabel* m_label;
        int m_last_width;
        QWidget* m_button_panel;
        RibbonLayoutMode m_layout_mode;
        Vector<2, int> m_full_size;
        Vector<2, int> m_large_button_size;
        Vector<2, int> m_estimated_size;
 
        TranslatedString m_title;
        uint01 m_num_of_rows;
        uint01 m_fixed_num_of_rows;
 
        bool m_is_vertical;
        bool m_ignored_size;
        bool m_expanding_icons;
        bool m_auto_fill_table;
        fltp04 m_icon_size_multiplier;
    };
}