kdeui Library API Documentation

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 void removePage (QWidget *w)
void setTabReorderingEnabled (bool enable)
void setHoverCloseButton (bool enable)
void setHoverCloseButtonDelayed (bool delayed)
void setTabCloseActivatePrevious (bool previous)
void setAutomaticResizeTabs (bool enable)

Signals

void testCanDecode (const QDragMoveEvent *e, bool &accept)
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 *)

Public Member Functions

 KTabWidget (QWidget *parent=0, const char *name=0, WFlags f=0)
virtual ~KTabWidget ()
void setTabColor (QWidget *, const QColor &color)
QColor tabColor (QWidget *) const
bool isTabReorderingEnabled () const
bool hoverCloseButton () const
bool hoverCloseButtonDelayed () const
bool tabCloseActivatePrevious () const
bool automaticResizeTabs () const
void setTabBarHidden (bool hide)
bool isTabBarHidden () const
virtual void insertTab (QWidget *, const QString &, int index=-1)
virtual void insertTab (QWidget *child, const QIconSet &iconset, const QString &label, int index=-1)
virtual void insertTab (QWidget *, QTab *, int index=-1)
void changeTab (QWidget *, const QString &)
void changeTab (QWidget *child, const QIconSet &iconset, const QString &label)
QString label (int) const
QString tabLabel (QWidget *) const
void setTabLabel (QWidget *, const QString &)

Protected 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)
virtual void wheelDelta (int)

Protected Member Functions

virtual void mouseDoubleClickEvent (QMouseEvent *e)
virtual void mousePressEvent (QMouseEvent *)
virtual void dragMoveEvent (QDragMoveEvent *)
virtual void dropEvent (QDropEvent *)
unsigned int tabBarWidthForMaxChars (uint maxLength)
virtual void wheelEvent (QWheelEvent *e)
virtual void resizeEvent (QResizeEvent *)

Properties

bool tabReorderingEnabled
bool hoverCloseButton
bool hoverCloseButtonDelayed
bool tabCloseActivatePrevious
bool automaticResizeTabs

Detailed Description

A widget containing multiple tabs.

Since:
3.2

Definition at line 36 of file ktabwidget.h.


Constructor & Destructor Documentation

KTabWidget::~KTabWidget  )  [virtual]
 

Destructor.

Definition at line 71 of file ktabwidget.cpp.


Member Function Documentation

void KTabWidget::setTabColor QWidget ,
const QColor color
 

Set the tab of the given widget to color.

Definition at line 122 of file ktabwidget.cpp.

Referenced by moveTab().

bool KTabWidget::isTabReorderingEnabled  )  const
 

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

Definition at line 145 of file ktabwidget.cpp.

bool KTabWidget::hoverCloseButton  )  const
 

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

bool KTabWidget::hoverCloseButtonDelayed  )  const
 

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

bool KTabWidget::tabCloseActivatePrevious  )  const
 

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

Since:
3.3

bool KTabWidget::automaticResizeTabs  )  const
 

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

Since:
3.4

void KTabWidget::setTabBarHidden bool  hide  ) 
 

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

Since:
3.4

Definition at line 101 of file ktabwidget.cpp.

bool KTabWidget::isTabBarHidden  )  const
 

Return true if the tabbar is hidden.

Since:
3.4

Definition at line 117 of file ktabwidget.cpp.

void KTabWidget::insertTab QWidget ,
const QString ,
int  index = -1
[virtual]
 

Reimplemented for internal reasons.

Definition at line 76 of file ktabwidget.cpp.

void KTabWidget::insertTab QWidget child,
const QIconSet iconset,
const QString label,
int  index = -1
[virtual]
 

Reimplemented for internal reasons.

Definition at line 81 of file ktabwidget.cpp.

void KTabWidget::insertTab QWidget ,
QTab ,
int  index = -1
[virtual]
 

Reimplemented for internal reasons.

Definition at line 86 of file ktabwidget.cpp.

void KTabWidget::changeTab QWidget ,
const QString
 

Reimplemented for internal reasons.

Definition at line 184 of file ktabwidget.cpp.

Referenced by moveTab().

void KTabWidget::changeTab QWidget child,
const QIconSet iconset,
const QString label
 

Reimplemented for internal reasons.

Definition at line 196 of file ktabwidget.cpp.

QString KTabWidget::label int   )  const
 

Reimplemented for internal reasons.

Definition at line 208 of file ktabwidget.cpp.

Referenced by moveTab().

QString KTabWidget::tabLabel QWidget  )  const
 

Reimplemented for internal reasons.

Definition at line 220 of file ktabwidget.cpp.

void KTabWidget::setTabLabel QWidget ,
const QString
 

Reimplemented for internal reasons.

Definition at line 233 of file ktabwidget.cpp.

void KTabWidget::moveTab int  ,
int 
[virtual, slot]
 

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

Definition at line 398 of file ktabwidget.cpp.

References changeTab(), label(), movedTab(), removePage(), and setTabColor().

void KTabWidget::removePage QWidget w  )  [virtual, slot]
 

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

Definition at line 433 of file ktabwidget.cpp.

Referenced by moveTab().

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.

Definition at line 140 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.

Definition at line 470 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.

Definition at line 480 of file ktabwidget.cpp.

void KTabWidget::setTabCloseActivatePrevious bool  previous  )  [slot]
 

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

Since:
3.3

Definition at line 150 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 reliable with "QTabWidget* foo=new KTabWidget()" and if you change tabs via the tabbar or by accessing tabs directly.

Since:
3.4

Definition at line 490 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::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::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::initiateDrag QWidget  )  [signal]
 

Request to start a drag operation on the given tab.

void KTabWidget::contextMenu const QPoint  )  [signal]
 

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

void KTabWidget::contextMenu QWidget ,
const QPoint
[signal]
 

The right mouse button was pressed over a widget.

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

Referenced by moveTab().

void KTabWidget::mouseDoubleClick  )  [signal]
 

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

Since:
3.3

void KTabWidget::mouseDoubleClick QWidget  )  [signal]
 

A double left 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::mouseMiddleClick QWidget  )  [signal]
 

A middle mouse button click was performed over the widget.

void KTabWidget::closeRequest QWidget  )  [signal]
 

The close button of a widget's tab was clicked. This signal is only possible after you have called setHoverCloseButton( true ).


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdeui Library Version 3.4.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed May 4 07:12:33 2005 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003