qtabbar.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtWidgets module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
 
#ifndef QTABBAR_H
#define QTABBAR_H
 
#include <QtWidgets/qtwidgetsglobal.h>
#include <QtWidgets/qwidget.h>
 
QT_REQUIRE_CONFIG(tabbar);
 
QT_BEGIN_NAMESPACE
 
class QIcon;
class QTabBarPrivate;
class QStyleOptionTab;
 
class Q_WIDGETS_EXPORT QTabBar: public QWidget
{
    Q_OBJECT
 
    Q_PROPERTY(Shape shape READ shape WRITE setShape)
    Q_PROPERTY(int currentIndex READ currentIndex WRITE setCurrentIndex NOTIFY currentChanged)
    Q_PROPERTY(int count READ count)
    Q_PROPERTY(bool drawBase READ drawBase WRITE setDrawBase)
    Q_PROPERTY(QSize iconSize READ iconSize WRITE setIconSize)
    Q_PROPERTY(Qt::TextElideMode elideMode READ elideMode WRITE setElideMode)
    Q_PROPERTY(bool usesScrollButtons READ usesScrollButtons WRITE setUsesScrollButtons)
    Q_PROPERTY(bool tabsClosable READ tabsClosable WRITE setTabsClosable)
    Q_PROPERTY(SelectionBehavior selectionBehaviorOnRemove READ selectionBehaviorOnRemove
               WRITE setSelectionBehaviorOnRemove)
    Q_PROPERTY(bool expanding READ expanding WRITE setExpanding)
    Q_PROPERTY(bool movable READ isMovable WRITE setMovable)
    Q_PROPERTY(bool documentMode READ documentMode WRITE setDocumentMode)
    Q_PROPERTY(bool autoHide READ autoHide WRITE setAutoHide)
    Q_PROPERTY(bool changeCurrentOnDrag READ changeCurrentOnDrag WRITE setChangeCurrentOnDrag)
 
public:
    explicit QTabBar(QWidget *parent = nullptr);
    ~QTabBar();
 
    enum Shape { RoundedNorth, RoundedSouth, RoundedWest, RoundedEast,
                 TriangularNorth, TriangularSouth, TriangularWest, TriangularEast
    };
    Q_ENUM(Shape)
 
    enum ButtonPosition {
        LeftSide,
        RightSide
    };
 
    enum SelectionBehavior {
        SelectLeftTab,
        SelectRightTab,
        SelectPreviousTab
    };
 
    Shape shape() const;
    void setShape(Shape shape);
 
    int addTab(const QString &text);
    int addTab(const QIcon &icon, const QString &text);
 
    int insertTab(int index, const QString &text);
    int insertTab(int index, const QIcon&icon, const QString &text);
 
    void removeTab(int index);
    void moveTab(int from, int to);
 
    bool isTabEnabled(int index) const;
    void setTabEnabled(int index, bool enabled);
 
    bool isTabVisible(int index) const;
    void setTabVisible(int index, bool visible);
 
    QString tabText(int index) const;
    void setTabText(int index, const QString &text);
 
    QColor tabTextColor(int index) const;
    void setTabTextColor(int index, const QColor &color);
 
    QIcon tabIcon(int index) const;
    void setTabIcon(int index, const QIcon &icon);
 
    Qt::TextElideMode elideMode() const;
    void setElideMode(Qt::TextElideMode mode);
 
#if QT_CONFIG(tooltip)
    void setTabToolTip(int index, const QString &tip);
    QString tabToolTip(int index) const;
#endif
 
#if QT_CONFIG(whatsthis)
    void setTabWhatsThis(int index, const QString &text);
    QString tabWhatsThis(int index) const;
#endif
 
    void setTabData(int index, const QVariant &data);
    QVariant tabData(int index) const;
 
    QRect tabRect(int index) const;
    int tabAt(const QPoint &pos) const;
 
    int currentIndex() const;
    int count() const;
 
    QSize sizeHint() const override;
    QSize minimumSizeHint() const override;
 
    void setDrawBase(bool drawTheBase);
    bool drawBase() const;
 
    QSize iconSize() const;
    void setIconSize(const QSize &size);
 
    bool usesScrollButtons() const;
    void setUsesScrollButtons(bool useButtons);
 
    bool tabsClosable() const;
    void setTabsClosable(bool closable);
 
    void setTabButton(int index, ButtonPosition position, QWidget *widget);
    QWidget *tabButton(int index, ButtonPosition position) const;
 
    SelectionBehavior selectionBehaviorOnRemove() const;
    void setSelectionBehaviorOnRemove(SelectionBehavior behavior);
 
    bool expanding() const;
    void setExpanding(bool enabled);
 
    bool isMovable() const;
    void setMovable(bool movable);
 
    bool documentMode() const;
    void setDocumentMode(bool set);
 
    bool autoHide() const;
    void setAutoHide(bool hide);
 
    bool changeCurrentOnDrag() const;
    void setChangeCurrentOnDrag(bool change);
 
#ifndef QT_NO_ACCESSIBILITY
    QString accessibleTabName(int index) const;
    void setAccessibleTabName(int index, const QString &name);
#endif
 
public Q_SLOTS:
    void setCurrentIndex(int index);
 
Q_SIGNALS:
    void currentChanged(int index);
    void tabCloseRequested(int index);
    void tabMoved(int from, int to);
    void tabBarClicked(int index);
    void tabBarDoubleClicked(int index);
 
protected:
    virtual QSize tabSizeHint(int index) const;
    virtual QSize minimumTabSizeHint(int index) const;
    virtual void tabInserted(int index);
    virtual void tabRemoved(int index);
    virtual void tabLayoutChange();
 
    bool event(QEvent *) override;
    void resizeEvent(QResizeEvent *) override;
    void showEvent(QShowEvent *) override;
    void hideEvent(QHideEvent *) override;
    void paintEvent(QPaintEvent *) override;
    void mousePressEvent(QMouseEvent *) override;
    void mouseMoveEvent(QMouseEvent *) override;
    void mouseReleaseEvent(QMouseEvent *) override;
    void mouseDoubleClickEvent(QMouseEvent *) override;
#if QT_CONFIG(wheelevent)
    void wheelEvent(QWheelEvent *event) override;
#endif
    void keyPressEvent(QKeyEvent *) override;
    void changeEvent(QEvent *) override;
    void timerEvent(QTimerEvent *event) override;
    virtual void initStyleOption(QStyleOptionTab *option, int tabIndex) const;
 
#ifndef QT_NO_ACCESSIBILITY
    friend class QAccessibleTabBar;
#endif
private:
    Q_DISABLE_COPY(QTabBar)
    Q_DECLARE_PRIVATE(QTabBar)
    Q_PRIVATE_SLOT(d_func(), void _q_scrollTabs())
    Q_PRIVATE_SLOT(d_func(), void _q_closeTab())
};
 
QT_END_NAMESPACE
 
#endif // QTABBAR_H