File indexing completed on 2024-04-21 14:56:00

 /* This file is part of the KDE libraries
     Copyright (C) 2003 Stephan Binner <binner@kde.org>
     Copyright (C) 2003 Zack Rusin <zack@kde.org>
     Copyright (C) 2009 Urs Wolfer <uwolfer @ kde.org>
 
     This library is free software; you can redistribute it and/or
     modify it under the terms of the GNU Library General Public
     License as published by the Free Software Foundation; either
     version 2 of the License, or (at your option) any later version.
 
     This library is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Library General Public License for more details.
 
     You should have received a copy of the GNU Library General Public License
     along with this library; see the file COPYING.LIB.  If not, write to
     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
     Boston, MA 02110-1301, USA.
 */
 
 #ifndef KTABWIDGET_H
 #define KTABWIDGET_H
 
 #include <kdelibs4support_export.h>
 
 #include <QTabWidget>
 
 class QTab;
 
 /**
  * \brief A widget containing multiple tabs
  *
  * It extends the Qt QTabWidget, providing extra optionally features such as close buttons when you hover
  * over the icon in the tab, and also adds functionality such as responding to mouse wheel scroll events to switch
  * the active tab.
  *
  * It is recommended to use KTabWidget instead of QTabWidget unless you have a good reason not to.
  *
  * See also the QTabWidget documentation.
  *
  * \image html ktabwidget.png "KDE Tab Widget"
  */
 class KDELIBS4SUPPORT_DEPRECATED_EXPORT KTabWidget : public QTabWidget //krazy:exclude=qclasses
 {
     Q_OBJECT
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     Q_PROPERTY(bool tabReorderingEnabled READ isTabReorderingEnabled WRITE setTabReorderingEnabled)
     Q_PROPERTY(bool hoverCloseButton READ hoverCloseButton WRITE setHoverCloseButton)
     Q_PROPERTY(bool hoverCloseButtonDelayed READ hoverCloseButtonDelayed WRITE setHoverCloseButtonDelayed)
     Q_PROPERTY(bool closeButtonEnabled READ isCloseButtonEnabled WRITE setCloseButtonEnabled)
     Q_PROPERTY(bool tabCloseActivatePrevious READ tabCloseActivatePrevious WRITE setTabCloseActivatePrevious)
 #endif
     Q_PROPERTY(bool automaticResizeTabs READ automaticResizeTabs WRITE setAutomaticResizeTabs)
 
 public:
 
     /**
      * Creates a new tab widget.
      *
      * @param parent The parent widgets.
      * @param flags The Qt window flags @see QWidget.
      */
     KDELIBS4SUPPORT_DEPRECATED explicit KTabWidget(QWidget *parent = nullptr, Qt::WindowFlags flags = {});
 
     /**
      * Destroys the tab widget.
      */
     ~KTabWidget() override;
 
     /**
      * Set the tab of the given widget to \a color.
      * This is simply a convenience method for QTabBar::setTabTextColor.
      */
     void setTabTextColor(int index, const QColor &color);
 
     /**
      * Returns the tab color for the given widget.
      * This is simply a convenience method for QTabBar::tabTextColor.
      */
     QColor tabTextColor(int index) const;
 
     /**
      * Returns true if tab ordering with the middle mouse button
      * has been enabled.
      *
      * @deprecated Use QTabWidget::isMovable() instead.
      */
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     KDELIBS4SUPPORT_DEPRECATED bool isTabReorderingEnabled() const;
 #endif
 
     /**
      * Returns true if the close button is shown on tabs
      * when mouse is hovering over them.
      *
      * @deprecated Use QTabWidget::tabsClosable() instead.
      */
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     KDELIBS4SUPPORT_DEPRECATED bool hoverCloseButton() const;
 #endif
 
     /**
      * Returns true if the close button is shown on tabs
      * after a delay.
      *
      * @deprecated Use QTabWidget::setTabsClosable() instead.
      */
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     KDELIBS4SUPPORT_DEPRECATED bool hoverCloseButtonDelayed() const;
 #endif
 
     /**
      * Returns true if the close button is shown on tabs.
      *
      * @since 4.1
      *
      * @deprecated Use QTabWidget::tabsClosable() instead.
      */
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     KDELIBS4SUPPORT_DEPRECATED bool isCloseButtonEnabled() const;
 #endif
 
     /**
      * Returns true if closing the current tab activates the previous
      * actice tab instead of the one to the right.
      *
      * @deprecated Use tabBar()->selectionBehaviorOnRemove() instead.
      */
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     KDELIBS4SUPPORT_DEPRECATED bool tabCloseActivatePrevious() const;
 #endif
 
     /**
      * Returns true if calling setTitle() will resize tabs
      * to the width of the tab bar.
      */
     bool automaticResizeTabs() const;
 
     /**
      * If \a hide is true, the tabbar is hidden along with any corner
      * widgets.
      *
      * @deprecated since 5.0, use tabBar()->hide() instead.
      */
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     KDELIBS4SUPPORT_DEPRECATED void setTabBarHidden(bool hide);
 #endif
 
     /**
      * Returns true if the tabbar was hidden by a call to setTabBarHidden( true ).
      * Returns false if the widget itself is hidden, but no call to setTabBarHidden( true )
      * has been made.
      *
      * @deprecated since 5.0, use tabBar()->isHidden() instead.
      */
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     KDELIBS4SUPPORT_DEPRECATED bool isTabBarHidden() const;
 #endif
 
     /**
       Reimplemented for internal reasons.
      *
     virtual void insertTab( QWidget *, const QString &, int index = -1 );
 
     *!
       Reimplemented for internal reasons.
      *
     virtual void insertTab( QWidget *child, const QIcon& iconset,
                             const QString &label, int index = -1 );
     *!
       Reimplemented for internal reasons.
     *
     virtual void insertTab( QWidget *, QTab *, int index = -1 );*/
 
     /**
      * Reimplemented for internal reasons.
      */
     QString tabText(int) const;   // but it's not virtual...
 
 #ifdef KDE3_SUPPORT
     /**
      * @deprecated use tabText
      */
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     inline KDELIBS4SUPPORT_DEPRECATED QString label(int index) const
     {
         return tabText(index);
     }
 #endif
 
     /**
      * @deprecated use tabText
      */
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     inline KDELIBS4SUPPORT_DEPRECATED QString tabLabel(QWidget *w) const
     {
         return tabText(indexOf(w));
     }
 #endif
 
     /**
      * @deprecated use setTabText
      */
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     inline KDELIBS4SUPPORT_DEPRECATED void setTabLabel(QWidget *w, const QString &l)
     {
         setTabText(indexOf(w), l);
     }
 #endif
 #endif
 
     /**
      * Reimplemented for internal reasons.
      */
     void setTabText(int, const QString &);
 
     using QTabWidget::tabBar;
 
 public Q_SLOTS:
     /**
      * Move a widget's tab from first to second specified index and emit
      * signal movedTab( int, int ) afterwards.
      */
     virtual void moveTab(int, int);
 
     /**
      * Removes the widget, reimplemented for
      * internal reasons (keeping labels in sync).
      * @deprecated since 4.0
      */
     virtual QT_MOC_COMPAT void removePage(QWidget *w);
 
     /**
      * Removes the widget, reimplemented for
      * internal reasons (keeping labels in sync).
      */
     virtual void removeTab(int index); // but it's not virtual in QTabWidget...
 
     /**
      * If \a enable is true, tab reordering with middle button will be enabled.
      *
      * Note that once enabled you shouldn't rely on previously queried
      * currentPageIndex() or indexOf( QWidget * ) values anymore.
      *
      * You can connect to signal movedTab(int, int) which will notify
      * you from which index to which index a tab has been moved.
      *
      * @deprecated Use QTabWidget::setMovable() instead.
      *
      * Note, however, that QTabWidget::setMovable(true) disables
      * dragging tabs out of the KTabBar (e.g., dragging the tab
      * URL from Konqueror to another application)!
      */
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     QT_MOC_COMPAT void setTabReorderingEnabled(bool enable);
 #endif
 
     /**
      * If \a enable is true, a close button will be shown on mouse hover
      * over tab icons which will emit signal closeRequest( QWidget * )
      * when pressed.
      *
      * @deprecated Use QTabWidget::setTabsClosable() instead.
      */
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     QT_MOC_COMPAT void setHoverCloseButton(bool enable);
 #endif
 
     /**
      * If \a delayed is true, a close button will be shown on mouse hover
      * over tab icons after mouse double click delay else immediately.
      *
      * @deprecated Use QTabWidget::setTabsClosable() instead.
      */
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     QT_MOC_COMPAT void setHoverCloseButtonDelayed(bool delayed);
 #endif
 
     /**
      * If enabled, a close button is available for each tab. The
      * signal KTabWidget::closeRequest() is emitted, if the close button
      * has been clicked.
      *
      * @since 4.1
      *
      * @deprecated Use QTabWidget::setTabsClosable() instead.
      */
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     QT_MOC_COMPAT void setCloseButtonEnabled(bool);
 #endif
 
     /**
      * If \a previous is true, closing the current tab activates the
      * previous active tab instead of the one to the right.
      *
      * @deprecated Use tabBar()->setSelectionBehaviorOnRemove() instead.
      */
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     QT_MOC_COMPAT void setTabCloseActivatePrevious(bool previous);
 #endif
 
     /**
      * If \a enable is true, tabs will be resized to the width of the tab bar.
      *
      * Does not work reliably with "QTabWidget* foo=new KTabWidget()" and if
      * you change tabs via the tabbar or by accessing tabs directly.
      */
     void setAutomaticResizeTabs(bool enable);
 
 Q_SIGNALS:
     /**
      * Connect to this and set accept to true if you can and want to decode the event.
      */
     void testCanDecode(const QDragMoveEvent *e, bool &accept /* result */);
 
     /**
      * Received an event in the empty space beside tabbar. Usually creates a new tab.
      * This signal is only possible after testCanDecode and positive accept result.
      */
     void receivedDropEvent(QDropEvent *);
 
     /**
      * Received an drop event on given widget's tab.
      * This signal is only possible after testCanDecode and positive accept result.
      */
     void receivedDropEvent(QWidget *, QDropEvent *);
 
     /**
      * Request to start a drag operation on the given tab.
      */
     void initiateDrag(QWidget *);
 
     /**
      * The right mouse button was pressed over empty space besides tabbar.
      */
     void contextMenu(const QPoint &);
 
     /**
      * The right mouse button was pressed over a widget.
      */
     void contextMenu(QWidget *, const QPoint &);
 
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     /**
      * A tab was moved from first to second index. This signal is only
      * possible after you have called setTabReorderingEnabled( true ).
      */
     void movedTab(int, int);
 #endif
 
     /**
      * A double left mouse button click was performed over empty space besides tabbar.
      * The signal is emitted on the second press of the mouse button, before the release.
      */
     void mouseDoubleClick();
 
     /**
      * A double left mouse button click was performed over the widget.
      * The signal is emitted on the second press of the mouse button, before the release.
      */
     void mouseDoubleClick(QWidget *);
 
     /**
      * A middle mouse button click was performed over empty space besides tabbar.
      * The signal is emitted on the release of the mouse button.
      */
     void mouseMiddleClick();
 
     /**
      * A middle mouse button click was performed over the widget.
      * The signal is emitted on the release of the mouse button.
      */
     void mouseMiddleClick(QWidget *);
 
     /**
      * The close button of a widget's tab was clicked. This signal is
      * only possible after you have called setCloseButtonEnabled( true ).
      */
     void closeRequest(QWidget *);
 
 protected:
     void mouseDoubleClickEvent(QMouseEvent *) override;
     void mousePressEvent(QMouseEvent *) override;
     void mouseReleaseEvent(QMouseEvent *) override;
     void dragEnterEvent(QDragEnterEvent *) override;
     void dragMoveEvent(QDragMoveEvent *) override;
     void dropEvent(QDropEvent *) override;
     int tabBarWidthForMaxChars(int);
 #ifndef QT_NO_WHEELEVENT
     void wheelEvent(QWheelEvent *) override;
 #endif
     void resizeEvent(QResizeEvent *) override;
     void tabInserted(int) override;
     void tabRemoved(int) override;
 
     /**
      * @deprecated  This method has no effect and should not be called
      */
 #ifndef KDELIBS4SUPPORT_NO_DEPRECATED
     KDELIBS4SUPPORT_DEPRECATED void currentChanged(int);
 #endif
 
 protected Q_SLOTS:
     virtual void receivedDropEvent(int, QDropEvent *);
     virtual void initiateDrag(int);
     virtual void contextMenu(int, const QPoint &);
     virtual void mouseDoubleClick(int);
     virtual void mouseMiddleClick(int);
     virtual void closeRequest(int);
 #ifndef QT_NO_WHEELEVENT
     virtual void wheelDelta(int);
 #endif
 
 private:
     class Private;
     Private *const d;
 
     Q_PRIVATE_SLOT(d, void slotTabMoved(int, int))
 };
 
 #endif