QCustomTabWidget.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>
#include <QTabWidget>
namespace NDEVR
{
    class QCustomDockWidget;
    class TranslatedString;
    /**--------------------------------------------------------------------------------------------------
    \brief A tab widget provides a tab area and a "page area" that is used to display pages related 
        to each tab. By default, the tab bar is shown above the page area, but different configurations 
        are available
    **/
    class NDEVR_WIDGETS_API QCustomTabWidget : public ContainerWidgetBase
    {
        Q_OBJECT
    public:
        explicit QCustomTabWidget(QWidget* parent = nullptr);
        virtual ~QCustomTabWidget();
        void hideBackground(bool hide_background);
        uint04 addWidget(QWidget* child) override;
        int addTab(QWidget* widget);
        int addTab(QWidget* widget, const QString&);
        int addTab(QWidget* widget, const TranslatedString&);
        int addTab(QWidget* widget, const QIcon& icon, const QString& label);
 
        int insertTab(int index, QWidget* widget);
        int insertTab(int index, QWidget* widget, const QString&);
        int insertTab(int index, QWidget* widget, const TranslatedString&);
        int insertTab(int index, QWidget* widget, const QIcon& icon, const QString& label);
 
        SectionContent* content(int index) const;
        void removeTab(int index);
        void removeTab(QWidget* widget);
 
        bool isTabEnabled(int index) const;
        void setTabEnabled(int index, bool);
 
        QString tabText(int index) const;
        void setTabText(int index, const QString&);
 
        QIcon tabIcon(int index) const;
        void setTabIcon(int index, const QIcon& icon);
        void setupAsMenu();
        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;
        bool m_hide_background = false;
    signals:
        void currentTabChangedSignal(int index);
        void userChangedCurrentTabSignal(int inex);
    public Q_SLOTS:
        void setCurrentIndexSlot(int index);
        void setCurrentWidgetSlot(QWidget* widget);
 
    };
 
    
}