.TH "KTabWidget" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KTabWidget \- A widget containing multiple tabs.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <ktabwidget.h>\fP
.PP
Inherits \fBQTabWidget\fP.
.PP
.SS "Public Slots"

.in +1c
.ti -1c
.RI "virtual void \fBmoveTab\fP (int, int)"
.br
.ti -1c
.RI "virtual void \fBremovePage\fP (\fBQWidget\fP *w)"
.br
.ti -1c
.RI "void \fBsetTabReorderingEnabled\fP (bool enable)"
.br
.ti -1c
.RI "void \fBsetHoverCloseButton\fP (bool enable)"
.br
.ti -1c
.RI "void \fBsetHoverCloseButtonDelayed\fP (bool delayed)"
.br
.ti -1c
.RI "void \fBsetTabCloseActivatePrevious\fP (bool previous)"
.br
.ti -1c
.RI "void \fBsetAutomaticResizeTabs\fP (bool enable)"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBtestCanDecode\fP (const \fBQDragMoveEvent\fP *e, bool &accept)"
.br
.ti -1c
.RI "void \fBreceivedDropEvent\fP (\fBQDropEvent\fP *)"
.br
.ti -1c
.RI "void \fBreceivedDropEvent\fP (\fBQWidget\fP *, \fBQDropEvent\fP *)"
.br
.ti -1c
.RI "void \fBinitiateDrag\fP (\fBQWidget\fP *)"
.br
.ti -1c
.RI "void \fBcontextMenu\fP (const \fBQPoint\fP &)"
.br
.ti -1c
.RI "void \fBcontextMenu\fP (\fBQWidget\fP *, const \fBQPoint\fP &)"
.br
.ti -1c
.RI "void \fBmovedTab\fP (int, int)"
.br
.ti -1c
.RI "void \fBmouseDoubleClick\fP ()"
.br
.ti -1c
.RI "void \fBmouseDoubleClick\fP (\fBQWidget\fP *)"
.br
.ti -1c
.RI "void \fBmouseMiddleClick\fP ()"
.br
.ti -1c
.RI "void \fBmouseMiddleClick\fP (\fBQWidget\fP *)"
.br
.ti -1c
.RI "void \fBcloseRequest\fP (\fBQWidget\fP *)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKTabWidget\fP (\fBQWidget\fP *parent=0, const char *name=0, WFlags f=0)"
.br
.ti -1c
.RI "virtual \fB~KTabWidget\fP ()"
.br
.ti -1c
.RI "void \fBsetTabColor\fP (\fBQWidget\fP *, const \fBQColor\fP &color)"
.br
.ti -1c
.RI "\fBQColor\fP \fBtabColor\fP (\fBQWidget\fP *) const "
.br
.ti -1c
.RI "bool \fBisTabReorderingEnabled\fP () const "
.br
.ti -1c
.RI "bool \fBhoverCloseButton\fP () const "
.br
.ti -1c
.RI "bool \fBhoverCloseButtonDelayed\fP () const "
.br
.ti -1c
.RI "bool \fBtabCloseActivatePrevious\fP () const "
.br
.ti -1c
.RI "bool \fBautomaticResizeTabs\fP () const "
.br
.ti -1c
.RI "void \fBsetTabBarHidden\fP (bool hide)"
.br
.ti -1c
.RI "bool \fBisTabBarHidden\fP () const "
.br
.ti -1c
.RI "virtual void \fBinsertTab\fP (\fBQWidget\fP *, const \fBQString\fP &, int index=-1)"
.br
.ti -1c
.RI "virtual void \fBinsertTab\fP (\fBQWidget\fP *child, const \fBQIconSet\fP &iconset, const \fBQString\fP &label, int index=-1)"
.br
.ti -1c
.RI "virtual void \fBinsertTab\fP (\fBQWidget\fP *, \fBQTab\fP *, int index=-1)"
.br
.ti -1c
.RI "void \fBchangeTab\fP (\fBQWidget\fP *, const \fBQString\fP &)"
.br
.ti -1c
.RI "void \fBchangeTab\fP (\fBQWidget\fP *child, const \fBQIconSet\fP &iconset, const \fBQString\fP &label)"
.br
.ti -1c
.RI "\fBQString\fP \fBlabel\fP (int) const "
.br
.ti -1c
.RI "\fBQString\fP \fBtabLabel\fP (\fBQWidget\fP *) const "
.br
.ti -1c
.RI "void \fBsetTabLabel\fP (\fBQWidget\fP *, const \fBQString\fP &)"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "virtual void \fBreceivedDropEvent\fP (int, \fBQDropEvent\fP *)"
.br
.ti -1c
.RI "virtual void \fBinitiateDrag\fP (int)"
.br
.ti -1c
.RI "virtual void \fBcontextMenu\fP (int, const \fBQPoint\fP &)"
.br
.ti -1c
.RI "virtual void \fBmouseDoubleClick\fP (int)"
.br
.ti -1c
.RI "virtual void \fBmouseMiddleClick\fP (int)"
.br
.ti -1c
.RI "virtual void \fBcloseRequest\fP (int)"
.br
.ti -1c
.RI "virtual void \fBwheelDelta\fP (int)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBmouseDoubleClickEvent\fP (\fBQMouseEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBmousePressEvent\fP (\fBQMouseEvent\fP *)"
.br
.ti -1c
.RI "virtual void \fBdragMoveEvent\fP (\fBQDragMoveEvent\fP *)"
.br
.ti -1c
.RI "virtual void \fBdropEvent\fP (\fBQDropEvent\fP *)"
.br
.ti -1c
.RI "unsigned int \fBtabBarWidthForMaxChars\fP (uint maxLength)"
.br
.ti -1c
.RI "virtual void \fBwheelEvent\fP (\fBQWheelEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBresizeEvent\fP (\fBQResizeEvent\fP *)"
.br
.in -1c
.SS "Properties"

.in +1c
.ti -1c
.RI "bool \fBtabReorderingEnabled\fP"
.br
.ti -1c
.RI "bool \fBhoverCloseButton\fP"
.br
.ti -1c
.RI "bool \fBhoverCloseButtonDelayed\fP"
.br
.ti -1c
.RI "bool \fBtabCloseActivatePrevious\fP"
.br
.ti -1c
.RI "bool \fBautomaticResizeTabs\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
A widget containing multiple tabs. 

\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 36 of file ktabwidget.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KTabWidget::~\fBKTabWidget\fP ()\fC [virtual]\fP"
.PP
Destructor. 
.PP
Definition at line 71 of file ktabwidget.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void KTabWidget::setTabColor (\fBQWidget\fP *, const \fBQColor\fP & color)"
.PP
Set the tab of the given widget to \fIcolor\fP. 
.PP
Definition at line 122 of file ktabwidget.cpp.
.PP
References QTab::identifier(), QTabWidget::indexOf(), and QTabWidget::tabBar().
.PP
Referenced by moveTab().
.SS "bool KTabWidget::isTabReorderingEnabled () const"
.PP
Returns true if tab ordering with the middle mouse button has been enabled. 
.PP
Definition at line 145 of file ktabwidget.cpp.
.PP
References QTabWidget::tabBar().
.SS "bool KTabWidget::hoverCloseButton () const"
.PP
Returns true if the close button is shown on tabs when mouse is hovering over them. 
.SS "bool KTabWidget::hoverCloseButtonDelayed () const"
.PP
Returns true if the close button is shown on tabs after a delay. 
.SS "bool KTabWidget::tabCloseActivatePrevious () const"
.PP
Returns true if closing the current tab activates the previous actice tab instead of the one to the right. 
.PP
\fBSince:\fP
.RS 4
3.3 
.RE
.PP

.SS "bool KTabWidget::automaticResizeTabs () const"
.PP
Returns true if calling setTitle() will resize tabs to the width of the tab bar. 
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.SS "void KTabWidget::setTabBarHidden (bool hide)"
.PP
If \fIhide\fP is true, the tabbar is hidden along with any corner widgets. 
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 101 of file ktabwidget.cpp.
.PP
References QTabWidget::cornerWidget(), QWidget::hide(), QWidget::show(), and QTabWidget::tabBar().
.SS "bool KTabWidget::isTabBarHidden () const"
.PP
Return true if the tabbar is hidden. 
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 117 of file ktabwidget.cpp.
.PP
References QTabWidget::tabBar().
.SS "void KTabWidget::insertTab (\fBQWidget\fP *, const \fBQString\fP &, int index = \fC-1\fP)\fC [virtual]\fP"
.PP
Reimplemented for internal reasons. 
.PP
Reimplemented from \fBQTabWidget\fP.
.PP
Definition at line 76 of file ktabwidget.cpp.
.PP
References QTabWidget::insertTab(), and label().
.SS "void KTabWidget::insertTab (\fBQWidget\fP * child, const \fBQIconSet\fP & iconset, const \fBQString\fP & label, int index = \fC-1\fP)\fC [virtual]\fP"
.PP
Reimplemented for internal reasons. 
.PP
Reimplemented from \fBQTabWidget\fP.
.PP
Definition at line 81 of file ktabwidget.cpp.
.PP
References QTabWidget::insertTab(), and label().
.SS "void KTabWidget::insertTab (\fBQWidget\fP *, \fBQTab\fP *, int index = \fC-1\fP)\fC [virtual]\fP"
.PP
Reimplemented for internal reasons. 
.PP
Reimplemented from \fBQTabWidget\fP.
.PP
Definition at line 86 of file ktabwidget.cpp.
.PP
References QTabWidget::count(), and QTabWidget::insertTab().
.SS "void KTabWidget::changeTab (\fBQWidget\fP *, const \fBQString\fP &)"
.PP
Reimplemented for internal reasons. 
.PP
Reimplemented from \fBQTabWidget\fP.
.PP
Definition at line 184 of file ktabwidget.cpp.
.PP
References QTabWidget::changeTab(), QTabWidget::indexOf(), and label().
.PP
Referenced by moveTab().
.SS "void KTabWidget::changeTab (\fBQWidget\fP * child, const \fBQIconSet\fP & iconset, const \fBQString\fP & label)"
.PP
Reimplemented for internal reasons. 
.PP
Reimplemented from \fBQTabWidget\fP.
.PP
Definition at line 196 of file ktabwidget.cpp.
.PP
References QTabWidget::changeTab(), QTabWidget::indexOf(), and label().
.SS "\fBQString\fP KTabWidget::label (int) const"
.PP
Reimplemented for internal reasons. 
.PP
Reimplemented from \fBQTabWidget\fP.
.PP
Definition at line 208 of file ktabwidget.cpp.
.PP
References QTabWidget::count(), and QTabWidget::label().
.PP
Referenced by changeTab(), insertTab(), and moveTab().
.SS "\fBQString\fP KTabWidget::tabLabel (\fBQWidget\fP *) const"
.PP
Reimplemented for internal reasons. 
.PP
Reimplemented from \fBQTabWidget\fP.
.PP
Definition at line 220 of file ktabwidget.cpp.
.PP
References QTabWidget::indexOf(), and QTabWidget::tabLabel().
.SS "void KTabWidget::setTabLabel (\fBQWidget\fP *, const \fBQString\fP &)"
.PP
Reimplemented for internal reasons. 
.PP
Reimplemented from \fBQTabWidget\fP.
.PP
Definition at line 233 of file ktabwidget.cpp.
.PP
References QTabWidget::indexOf(), and QTabWidget::setTabLabel().
.SS "void KTabWidget::moveTab (int, int)\fC [virtual, slot]\fP"
.PP
Move a widget's tab from first to second specified index and emit signal \fBmovedTab( int, int )\fP afterwards. 
.PP
Definition at line 398 of file ktabwidget.cpp.
.PP
References changeTab(), QTabWidget::count(), QTabWidget::currentPage(), QTabWidget::insertTab(), QTabWidget::isTabEnabled(), label(), movedTab(), QTabWidget::page(), removePage(), setTabColor(), QTabWidget::setTabEnabled(), QTabWidget::setTabToolTip(), QTab::setText(), QTabWidget::showPage(), QTabWidget::tabIconSet(), and QTabWidget::tabToolTip().
.SS "void KTabWidget::removePage (\fBQWidget\fP * w)\fC [virtual, slot]\fP"
.PP
Removes the widget, reimplemented for internal reasons (keeping labels in sync). 
.PP
Reimplemented from \fBQTabWidget\fP.
.PP
Definition at line 433 of file ktabwidget.cpp.
.PP
References QTabWidget::indexOf(), and QTabWidget::removePage().
.PP
Referenced by moveTab().
.SS "void KTabWidget::setTabReorderingEnabled (bool enable)\fC [slot]\fP"
.PP
If \fIenable\fP is true, tab reordering with middle button will be enabled.
.PP
Note that once enabled you shouldn't rely on previously queried \fBcurrentPageIndex()\fP or indexOf( QWidget * ) values anymore.
.PP
You can connect to signal \fBmovedTab(int, int)\fP which will notify you from which index to which index a tab has been moved. 
.PP
Definition at line 140 of file ktabwidget.cpp.
.PP
References QTabWidget::tabBar().
.SS "void KTabWidget::setHoverCloseButton (bool enable)\fC [slot]\fP"
.PP
If \fIenable\fP is true, a close button will be shown on mouse hover over tab icons which will emit signal \fBcloseRequest( QWidget * )\fP when pressed. 
.PP
Definition at line 470 of file ktabwidget.cpp.
.PP
References QTabWidget::tabBar().
.SS "void KTabWidget::setHoverCloseButtonDelayed (bool delayed)\fC [slot]\fP"
.PP
If \fIdelayed\fP is true, a close button will be shown on mouse hover over tab icons after mouse double click delay else immediately. 
.PP
Definition at line 480 of file ktabwidget.cpp.
.PP
References QTabWidget::tabBar().
.SS "void KTabWidget::setTabCloseActivatePrevious (bool previous)\fC [slot]\fP"
.PP
If \fIdelayed\fP is true, closing the current tab activates the previous active tab instead of the one to the right. 
.PP
\fBSince:\fP
.RS 4
3.3 
.RE
.PP

.PP
Definition at line 150 of file ktabwidget.cpp.
.PP
References QTabWidget::tabBar().
.SS "void KTabWidget::setAutomaticResizeTabs (bool enable)\fC [slot]\fP"
.PP
If \fIenable\fP is true, tabs will be resized to the width of the tab bar.
.PP
Does not work reliable with 'QTabWidget* foo=new KTabWidget()' and if you change tabs via the tabbar or by accessing tabs directly. 
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 490 of file ktabwidget.cpp.
.PP
References QTabWidget::count(), QTab::setText(), and QTabWidget::tabBar().
.SS "void KTabWidget::testCanDecode (const \fBQDragMoveEvent\fP * e, bool & accept)\fC [signal]\fP"
.PP
Connect to this and set accept to true if you can and want to decode the event. 
.SS "void KTabWidget::receivedDropEvent (\fBQDropEvent\fP *)\fC [signal]\fP"
.PP
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. 
.SS "void KTabWidget::receivedDropEvent (\fBQWidget\fP *, \fBQDropEvent\fP *)\fC [signal]\fP"
.PP
Received an drop event on given widget's tab. This signal is only possible after testCanDecode and positive accept result. 
.SS "void KTabWidget::initiateDrag (\fBQWidget\fP *)\fC [signal]\fP"
.PP
Request to start a drag operation on the given tab. 
.SS "void KTabWidget::contextMenu (const \fBQPoint\fP &)\fC [signal]\fP"
.PP
The right mouse button was pressed over empty space besides tabbar. 
.SS "void KTabWidget::contextMenu (\fBQWidget\fP *, const \fBQPoint\fP &)\fC [signal]\fP"
.PP
The right mouse button was pressed over a widget. 
.SS "void KTabWidget::movedTab (int, int)\fC [signal]\fP"
.PP
A tab was moved from first to second index. This signal is only possible after you have called setTabReorderingEnabled( true ). 
.PP
Referenced by moveTab().
.SS "void KTabWidget::mouseDoubleClick ()\fC [signal]\fP"
.PP
A double left mouse button click was performed over empty space besides tabbar. 
.PP
\fBSince:\fP
.RS 4
3.3 
.RE
.PP

.SS "void KTabWidget::mouseDoubleClick (\fBQWidget\fP *)\fC [signal]\fP"
.PP
A double left mouse button click was performed over the widget. 
.SS "void KTabWidget::mouseMiddleClick ()\fC [signal]\fP"
.PP
A middle mouse button click was performed over empty space besides tabbar. 
.SS "void KTabWidget::mouseMiddleClick (\fBQWidget\fP *)\fC [signal]\fP"
.PP
A middle mouse button click was performed over the widget. 
.SS "void KTabWidget::closeRequest (\fBQWidget\fP *)\fC [signal]\fP"
.PP
The close button of a widget's tab was clicked. This signal is only possible after you have called setHoverCloseButton( true ). 

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
