QCustomToolBox.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: QCustomTabWidget
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/ContainerWidget.h>
namespace NDEVR
{
    class QCustomDockWidget;
    class TranslatedString;
    /**--------------------------------------------------------------------------------------------------
    \brief A toolbox is a widget that displays a column of tabs one above the other, with the current 
        item displayed below the current tab. Every tab has an index position within the column of tabs.
    **/
    class NDEVR_WIDGETS_API QCustomToolBox : public ContainerWidgetBase
    {
        Q_OBJECT
    public:
        explicit QCustomToolBox(QWidget* parent = nullptr);
        virtual ~QCustomToolBox();
        void setMenuMode(bool menu_mode);
 
        uint04 addWidget(QWidget* child) override;
        int addItem(QWidget* widget);
        int addItem(QWidget* widget, const QString&);
        int addItem(QWidget* widget, const TranslatedString&);
        int addItem(QWidget* widget, const QIcon& icon, const QString& label);
 
        int insertItem(int index, QWidget* widget);
        int insertItem(int index, QWidget* widget, const QString&);
        int insertItem(int index, QWidget* widget, const TranslatedString&);
        int insertItem(int index, QWidget* widget, const QIcon& icon, const QString& label);
 
        SectionContent* content(int index) const;
        QWidget* removeItem(int index);
        void removeItem(QWidget* widget);
 
        bool isItemEnabled(int index) const;
        void setItemEnabled(int index, bool);
 
        QString itemText(int index) const;
        void setItemText(int index, const QString&);
 
        QIcon tabIcon(int index) const;
        void setTabIcon(int index, const QIcon& icon);
        //void setTabPosition(QTabWidget::TabPosition position, bool horizontal = false);
        void setTabToolTip(int index, const QString& tip);
        QString tabToolTip(int index) const;
 
        void setTabWhatsThis(int index, const QString& text);
        QString tabWhatsThis(int index) const;
 
        int currentIndex() const;
        QWidget* currentWidget() const;
        QWidget* widget(int index) const;
        QWidget* tabArea() const;
        int indexOf(QWidget* widget) const;
        int count() const;
        void setCurrentIndex(uint04 index);
        void setCurrentWidget(QWidget* widget);
        void setupAsBoxWidget(bool is_box_widget);
        void setTabVisible(bool tab_visible);
        void setTabLock(bool lock_tab);
        void setTabBarAutoHide(bool enabled);
 
        void clear();
    protected:
        Dictionary<QWidget*, QCustomDockWidget*> m_managed_section_content;
        QPointer<SectionWidget> m_main_section;
        RibbonArea m_main_ribbon_area;
    signals:
        void currentTabChangedSignal(int index);
    public Q_SLOTS:
        void setCurrentIndexSlot(int index);
        void setCurrentWidgetSlot(QWidget* widget);
    };
}