kdeui Library API Documentation

KTabWidget Class Reference

Since:
3.2
More...

#include <ktabwidget.h>

Inheritance diagram for KTabWidget:

QTabWidget List of all members.

Public Slots

virtual void moveTab (int, int)
void setTabReorderingEnabled (bool enable)
void setHoverCloseButton (bool enable)
void setHoverCloseButtonDelayed (bool delayed)

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 (QWidget *)
void mouseMiddleClick ()
void mouseMiddleClick (QWidget *)
void closeRequest (QWidget *)

Public Methods

virtual ~KTabWidget ()
void setTabColor (QWidget *, const QColor &color)
bool isTabReorderingEnabled () const
bool hoverCloseButton () const
bool hoverCloseButtonDelayed () const

Detailed Description

Since:
3.2

Definition at line 31 of file ktabwidget.h.


Constructor & Destructor Documentation

KTabWidget::~KTabWidget   [virtual]
 

Destructor.

Definition at line 42 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 48 of file ktabwidget.cpp.

References QTab::identifier(), QTabWidget::indexOf(), and QTabWidget::tabBar().

Referenced by moveTab().

bool KTabWidget::isTabReorderingEnabled  
 

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

Definition at line 71 of file ktabwidget.cpp.

References QTabWidget::tabBar().

bool KTabWidget::hoverCloseButton  
 

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

Definition at line 190 of file ktabwidget.cpp.

References QTabWidget::tabBar().

bool KTabWidget::hoverCloseButtonDelayed  
 

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

Definition at line 200 of file ktabwidget.cpp.

References QTabWidget::tabBar().

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 140 of file ktabwidget.cpp.

References QTabWidget::changeTab(), QTabWidget::currentPage(), QTabWidget::insertTab(), QTabWidget::isTabEnabled(), QTabWidget::label(), movedTab(), QTabWidget::page(), QTabWidget::removePage(), setTabColor(), QTabWidget::setTabEnabled(), QTabWidget::setTabToolTip(), QTabWidget::showPage(), QTabWidget::tabIconSet(), and QTabWidget::tabToolTip().

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 66 of file ktabwidget.cpp.

References QTabWidget::tabBar().

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 185 of file ktabwidget.cpp.

References QTabWidget::tabBar().

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 195 of file ktabwidget.cpp.

References QTabWidget::tabBar().

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 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.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Apr 22 14:23:37 2004 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2003