ktabwidget.h

Go to the documentation of this file.

/* 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 <kdeui_export.h>

#include <QtGui/QTabWidget>

class QTab;

class KDEUI_EXPORT KTabWidget : public QTabWidget //krazy:exclude=qclasses
{
    Q_OBJECT
#ifndef KDE_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:

    explicit KTabWidget( QWidget *parent = 0, Qt::WFlags flags = 0 );

    virtual ~KTabWidget();

    void setTabTextColor( int index, const QColor& color );

    QColor tabTextColor( int index ) const;

    bool isTabReorderingEnabled() const;

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED bool hoverCloseButton() const;
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED bool hoverCloseButtonDelayed() const;
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED bool isCloseButtonEnabled() const;
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED bool tabCloseActivatePrevious() const;
#endif

    bool automaticResizeTabs() const;

    void setTabBarHidden( bool hide );

    bool isTabBarHidden() const;

    QString tabText( int ) const; // but it's not virtual...

#ifdef KDE3_SUPPORT

#ifndef KDE_NO_DEPRECATED
    inline KDE_DEPRECATED QString label( int index ) const { return tabText( index ); }
#endif

#ifndef KDE_NO_DEPRECATED
    inline KDE_DEPRECATED QString tabLabel( QWidget *w ) const { return tabText( indexOf( w ) ); }
#endif

#ifndef KDE_NO_DEPRECATED
    inline KDE_DEPRECATED void setTabLabel( QWidget *w, const QString &l ) { setTabText( indexOf( w ),l ); }
#endif
#endif

    void setTabText( int , const QString & );

    using QTabWidget::tabBar;

  public Q_SLOTS:
    virtual void moveTab( int, int );

    virtual QT_MOC_COMPAT void removePage ( QWidget * w );

    virtual void removeTab(int index); // but it's not virtual in QTabWidget...

#ifndef KDE_NO_DEPRECATED
    QT_MOC_COMPAT void setTabReorderingEnabled( bool enable );
#endif

#ifndef KDE_NO_DEPRECATED
    QT_MOC_COMPAT void setHoverCloseButton( bool enable );
#endif

#ifndef KDE_NO_DEPRECATED
    QT_MOC_COMPAT void setHoverCloseButtonDelayed( bool delayed );
#endif

#ifndef KDE_NO_DEPRECATED
    QT_MOC_COMPAT void setCloseButtonEnabled( bool );
#endif

#ifndef KDE_NO_DEPRECATED
    QT_MOC_COMPAT void setTabCloseActivatePrevious( bool previous );
#endif

    void setAutomaticResizeTabs( bool enable );

  Q_SIGNALS:
    void testCanDecode(const QDragMoveEvent *e, bool &accept /* result */);

    void receivedDropEvent( QDropEvent * );

    void receivedDropEvent( QWidget *, QDropEvent * );

    void initiateDrag( QWidget * );

    void contextMenu( const QPoint & );

    void contextMenu( QWidget *, const QPoint & );

    void movedTab( int, int );

    void mouseDoubleClick();

    void mouseDoubleClick( QWidget * );

    void mouseMiddleClick();

    void mouseMiddleClick( QWidget * );

    void closeRequest( QWidget * );

  protected:
    virtual void mouseDoubleClickEvent( QMouseEvent* );
    virtual void mousePressEvent( QMouseEvent* );
    virtual void mouseReleaseEvent( QMouseEvent* );
    virtual void dragEnterEvent( QDragEnterEvent* );
    virtual void dragMoveEvent( QDragMoveEvent* );
    virtual void dropEvent( QDropEvent* );
    int tabBarWidthForMaxChars( int );
#ifndef QT_NO_WHEELEVENT
    virtual void wheelEvent( QWheelEvent* );
#endif
    virtual void resizeEvent( QResizeEvent* );
    virtual void tabInserted( int );
    virtual void tabRemoved ( int );

#ifndef KDE_NO_DEPRECATED
    KDE_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;
};

#endif