• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KTabWidget Class Reference

A widget containing multiple tabs. More...

#include <ktabwidget.h>

Inheritance diagram for KTabWidget:
QTabWidget

List of all members.

Public Slots

virtual void moveTab (int, int)
virtual QT_MOC_COMPAT void removePage (QWidget *w)
virtual void removeTab (int index)
void setAutomaticResizeTabs (bool enable)
QT_MOC_COMPAT void setCloseButtonEnabled (bool)
QT_MOC_COMPAT void setHoverCloseButton (bool enable)
QT_MOC_COMPAT void setHoverCloseButtonDelayed (bool delayed)
QT_MOC_COMPAT void setTabCloseActivatePrevious (bool previous)
QT_MOC_COMPAT void setTabReorderingEnabled (bool enable)

Signals

void closeRequest (QWidget *)
void contextMenu (QWidget *, const QPoint &)
void contextMenu (const QPoint &)
void initiateDrag (QWidget *)
void mouseDoubleClick (QWidget *)
void mouseDoubleClick ()
void mouseMiddleClick (QWidget *)
void mouseMiddleClick ()
void movedTab (int, int)
void receivedDropEvent (QWidget *, QDropEvent *)
void receivedDropEvent (QDropEvent *)
void testCanDecode (const QDragMoveEvent *e, bool &accept)

Public Member Functions

bool automaticResizeTabs () const
KDE_DEPRECATED bool hoverCloseButton () const
KDE_DEPRECATED bool hoverCloseButtonDelayed () const
KDE_DEPRECATED bool isCloseButtonEnabled () const
bool isTabBarHidden () const
bool isTabReorderingEnabled () const
 KTabWidget (QWidget *parent=0, Qt::WFlags flags=0)
void setTabBarHidden (bool hide)
void setTabText (int, const QString &)
void setTabTextColor (int index, const QColor &color)
KDE_DEPRECATED bool tabCloseActivatePrevious () const
QString tabText (int) const
QColor tabTextColor (int index) const
virtual ~KTabWidget ()

Protected Slots

virtual void closeRequest (int)
virtual void contextMenu (int, const QPoint &)
void currentChanged (int)
virtual void initiateDrag (int)
virtual void mouseDoubleClick (int)
virtual void mouseMiddleClick (int)
virtual void receivedDropEvent (int, QDropEvent *)
virtual void wheelDelta (int)

Protected Member Functions

virtual void dragEnterEvent (QDragEnterEvent *)
virtual void dragMoveEvent (QDragMoveEvent *)
virtual void dropEvent (QDropEvent *)
virtual void mouseDoubleClickEvent (QMouseEvent *)
virtual void mousePressEvent (QMouseEvent *)
virtual void mouseReleaseEvent (QMouseEvent *)
virtual void resizeEvent (QResizeEvent *)
int tabBarWidthForMaxChars (int)
virtual void tabInserted (int)
virtual void tabRemoved (int)
virtual void wheelEvent (QWheelEvent *)

Properties

bool automaticResizeTabs
bool closeButtonEnabled
bool hoverCloseButton
bool hoverCloseButtonDelayed
bool tabCloseActivatePrevious
bool tabReorderingEnabled

Detailed Description

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.

Definition at line 42 of file ktabwidget.h.


Constructor & Destructor Documentation

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

Creates a new tab widget.

Parameters:
parent The parent widgets.
flags The Qt window flags
See also:
QWidget.

Definition at line 234 of file ktabwidget.cpp.

KTabWidget::~KTabWidget (  )  [virtual]

Destroys the tab widget.

Definition at line 258 of file ktabwidget.cpp.


Member Function Documentation

bool KTabWidget::automaticResizeTabs (  )  const

Returns true if calling setTitle() will resize tabs to the width of the tab bar.

void KTabWidget::closeRequest ( int  index  )  [protected, virtual, slot]

Definition at line 666 of file ktabwidget.cpp.

void KTabWidget::closeRequest ( QWidget *   )  [signal]

The close button of a widget's tab was clicked.

This signal is only possible after you have called setCloseButtonEnabled( true ).

void KTabWidget::contextMenu ( int  index,
const QPoint &  point 
) [protected, virtual, slot]

Definition at line 534 of file ktabwidget.cpp.

void KTabWidget::contextMenu ( QWidget *  ,
const QPoint &   
) [signal]

The right mouse button was pressed over a widget.

void KTabWidget::contextMenu ( const QPoint &   )  [signal]

The right mouse button was pressed over empty space besides tabbar.

void KTabWidget::currentChanged ( int  idx  )  [protected, slot]

Definition at line 687 of file ktabwidget.cpp.

void KTabWidget::dragEnterEvent ( QDragEnterEvent *  event  )  [protected, virtual]

Definition at line 418 of file ktabwidget.cpp.

void KTabWidget::dragMoveEvent ( QDragMoveEvent *  event  )  [protected, virtual]

Definition at line 433 of file ktabwidget.cpp.

void KTabWidget::dropEvent ( QDropEvent *  event  )  [protected, virtual]

Definition at line 448 of file ktabwidget.cpp.

KDE_DEPRECATED bool KTabWidget::hoverCloseButton (  )  const

Returns true if the close button is shown on tabs when mouse is hovering over them.

Deprecated:
Use QTabWidget::tabsClosable() instead.
KDE_DEPRECATED bool KTabWidget::hoverCloseButtonDelayed (  )  const

Returns true if the close button is shown on tabs after a delay.

Deprecated:
Use QTabWidget::setTabsClosable() instead.
void KTabWidget::initiateDrag ( int  index  )  [protected, virtual, slot]

Definition at line 529 of file ktabwidget.cpp.

void KTabWidget::initiateDrag ( QWidget *   )  [signal]

Request to start a drag operation on the given tab.

bool KTabWidget::isCloseButtonEnabled (  )  const

Returns true if the close button is shown on tabs.

Since:
4.1
Deprecated:
Use QTabWidget::tabsClosable() instead.

Definition at line 635 of file ktabwidget.cpp.

bool KTabWidget::isTabBarHidden (  )  const

Returns true if the tabbar is hidden.

Definition at line 304 of file ktabwidget.cpp.

bool KTabWidget::isTabReorderingEnabled (  )  const

Returns true if tab ordering with the middle mouse button has been enabled.

Deprecated:
Use QTabWidget::isMovable() instead.

Definition at line 324 of file ktabwidget.cpp.

void KTabWidget::mouseDoubleClick ( int  index  )  [protected, virtual, slot]

Definition at line 539 of file ktabwidget.cpp.

void KTabWidget::mouseDoubleClick ( QWidget *   )  [signal]

A double left mouse button click was performed over the widget.

void KTabWidget::mouseDoubleClick (  )  [signal]

A double left mouse button click was performed over empty space besides tabbar.

void KTabWidget::mouseDoubleClickEvent ( QMouseEvent *  event  )  [protected, virtual]

Definition at line 487 of file ktabwidget.cpp.

void KTabWidget::mouseMiddleClick ( int  index  )  [protected, virtual, slot]

Definition at line 544 of file ktabwidget.cpp.

void KTabWidget::mouseMiddleClick ( QWidget *   )  [signal]

A middle mouse button click was performed over the widget.

void KTabWidget::mouseMiddleClick (  )  [signal]

A middle mouse button click was performed over empty space besides tabbar.

void KTabWidget::mousePressEvent ( QMouseEvent *  event  )  [protected, virtual]

Definition at line 500 of file ktabwidget.cpp.

void KTabWidget::mouseReleaseEvent ( QMouseEvent *  event  )  [protected, virtual]

Definition at line 512 of file ktabwidget.cpp.

void KTabWidget::movedTab ( int  ,
int   
) [signal]

A tab was moved from first to second index.

This signal is only possible after you have called setTabReorderingEnabled( true ).

void KTabWidget::moveTab ( int  from,
int  to 
) [virtual, slot]

Move a widget's tab from first to second specified index and emit signal movedTab( int, int ) afterwards.

Definition at line 549 of file ktabwidget.cpp.

void KTabWidget::receivedDropEvent ( int  index,
QDropEvent *  event 
) [protected, virtual, slot]

Definition at line 524 of file ktabwidget.cpp.

void KTabWidget::receivedDropEvent ( QWidget *  ,
QDropEvent *   
) [signal]

Received an drop event on given widget's tab.

This signal is only possible after testCanDecode and positive accept result.

void KTabWidget::receivedDropEvent ( QDropEvent *   )  [signal]

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 KTabWidget::removePage ( QWidget *  w  )  [virtual, slot]

Removes the widget, reimplemented for internal reasons (keeping labels in sync).

Deprecated:
since 4.0

Definition at line 582 of file ktabwidget.cpp.

void KTabWidget::removeTab ( int  index  )  [virtual, slot]

Removes the widget, reimplemented for internal reasons (keeping labels in sync).

Definition at line 595 of file ktabwidget.cpp.

void KTabWidget::resizeEvent ( QResizeEvent *  event  )  [protected, virtual]

Definition at line 671 of file ktabwidget.cpp.

void KTabWidget::setAutomaticResizeTabs ( bool  enable  )  [slot]

If 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.

Definition at line 640 of file ktabwidget.cpp.

void KTabWidget::setCloseButtonEnabled ( bool  enable  )  [slot]

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.

Definition at line 630 of file ktabwidget.cpp.

void KTabWidget::setHoverCloseButton ( bool  enable  )  [slot]

If 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.

Definition at line 606 of file ktabwidget.cpp.

void KTabWidget::setHoverCloseButtonDelayed ( bool  delayed  )  [slot]

If 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.

Definition at line 618 of file ktabwidget.cpp.

void KTabWidget::setTabBarHidden ( bool  hide  ) 

If hide is true, the tabbar is hidden along with any corner widgets.

Definition at line 288 of file ktabwidget.cpp.

void KTabWidget::setTabCloseActivatePrevious ( bool  previous  )  [slot]

If previous is true, closing the current tab activates the previous active tab instead of the one to the right.

Deprecated:
Use QTabWidget::setSelectionBehaviorOnRemove() instead.

Definition at line 329 of file ktabwidget.cpp.

void KTabWidget::setTabReorderingEnabled ( bool  enable  )  [slot]

If 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.

Definition at line 319 of file ktabwidget.cpp.

void KTabWidget::setTabText ( int  index,
const QString &  text 
)

Reimplemented for internal reasons.

Definition at line 388 of file ktabwidget.cpp.

void KTabWidget::setTabTextColor ( int  index,
const QColor &  color 
)

Set the tab of the given widget to color.

This is simply a convenience method for QTabBar::setTabTextColor.

Definition at line 309 of file ktabwidget.cpp.

int KTabWidget::tabBarWidthForMaxChars ( int  maxLength  )  [protected]

Definition at line 339 of file ktabwidget.cpp.

KDE_DEPRECATED bool KTabWidget::tabCloseActivatePrevious (  )  const

Returns true if closing the current tab activates the previous actice tab instead of the one to the right.

Deprecated:
Use QTabBar::selectionBehaviorOnRemove() instead.
void KTabWidget::tabInserted ( int  idx  )  [protected, virtual]

Definition at line 677 of file ktabwidget.cpp.

void KTabWidget::tabRemoved ( int  idx  )  [protected, virtual]

Definition at line 682 of file ktabwidget.cpp.

QString KTabWidget::tabText ( int  index  )  const

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.

Definition at line 368 of file ktabwidget.cpp.

QColor KTabWidget::tabTextColor ( int  index  )  const

Returns the tab color for the given widget.

This is simply a convenience method for QTabBar::tabTextColor.

Definition at line 314 of file ktabwidget.cpp.

void KTabWidget::testCanDecode ( const QDragMoveEvent *  e,
bool &  accept 
) [signal]

Connect to this and set accept to true if you can and want to decode the event.

void KTabWidget::wheelDelta ( int  delta  )  [protected, virtual, slot]

Definition at line 470 of file ktabwidget.cpp.

void KTabWidget::wheelEvent ( QWheelEvent *  event  )  [protected, virtual]

Definition at line 459 of file ktabwidget.cpp.


Property Documentation

bool KTabWidget::automaticResizeTabs [read, write]

Definition at line 50 of file ktabwidget.h.

bool KTabWidget::closeButtonEnabled [read, write]

Definition at line 48 of file ktabwidget.h.

bool KTabWidget::hoverCloseButton [read, write]

Definition at line 46 of file ktabwidget.h.

bool KTabWidget::hoverCloseButtonDelayed [read, write]

Definition at line 47 of file ktabwidget.h.

bool KTabWidget::tabCloseActivatePrevious [read, write]

Definition at line 49 of file ktabwidget.h.

bool KTabWidget::tabReorderingEnabled [read, write]

Definition at line 45 of file ktabwidget.h.


The documentation for this class was generated from the following files:
  • ktabwidget.h
  • ktabwidget.cpp

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal