KDE 4.2 PyKDE API Reference

- KDE's Python API

# KTabBar Class Reference

`from PyKDE4.kdeui import *`

Inherits: QTabBar → QWidget → QObject

## Detailed Description

A QTabBar with extended features.

## Signals

| closeRequest (int a0)
| contextMenu (int a0, QPoint a1)
| emptyAreaContextMenu (QPoint a0)
| initiateDrag (int a0)
| mouseDoubleClick (int a0)
| mouseMiddleClick (int a0)
| moveTab (int a0, int a1)
| newTabRequest ()
| receivedDropEvent (int a0, QDropEvent a1)
| tabDoubleClicked (int a0)
| testCanDecode (QDragMoveEvent a0, bool a1)
| wheelDelta (int a0)

## Methods

| __init__ (self, QWidget parent=0)
| activateDragSwitchTab (self)
| closeButtonClicked (self)
| closeRequest (self, int a0)
| contextMenu (self, int a0, QPoint a1)
| dragEnterEvent (self, QDragEnterEvent event)
| dragMoveEvent (self, QDragMoveEvent event)
| dropEvent (self, QDropEvent event)
| emptyAreaContextMenu (self, QPoint a0)
| enableCloseButton (self)
bool | hoverCloseButton (self)
bool | hoverCloseButtonDelayed (self)
| initiateDrag (self, int a0)
bool | isCloseButtonEnabled (self)
bool | isTabReorderingEnabled (self)
| leaveEvent (self, QEvent event)
| mouseDoubleClick (self, int a0)
| mouseDoubleClickEvent (self, QMouseEvent event)
| mouseMiddleClick (self, int a0)
| mouseMoveEvent (self, QMouseEvent event)
| mousePressEvent (self, QMouseEvent event)
| mouseReleaseEvent (self, QMouseEvent event)
| moveTab (self, int a0, int a1)
| newTabRequest (self)
| paintEvent (self, QPaintEvent event)
| receivedDropEvent (self, int a0, QDropEvent a1)
int | selectTab (self, QPoint position)
| setCloseButtonEnabled (self, bool a0)
| setHoverCloseButton (self, bool a0)
| setHoverCloseButtonDelayed (self, bool a0)
| setTabCloseActivatePrevious (self, bool a0)
| setTabReorderingEnabled (self, bool enable)
bool | tabCloseActivatePrevious (self)
| tabDoubleClicked (self, int a0)
| tabLayoutChange (self)
QSize | tabSizeHint (self, int index)
| testCanDecode (self, QDragMoveEvent a0, bool a1)
| wheelDelta (self, int a0)
| wheelEvent (self, QWheelEvent event)

## Method Documentation

__init__ | ( | self, |
|  | QWidget | parent=0
| ) |  |  |

Creates a new tab bar.

Parameters:

  | parent | The parent widget.

activateDragSwitchTab | ( |  | self ) |

closeButtonClicked | ( |  | self ) |

Deprecated:

closeRequest | ( | self, |
|  | int | a0
| ) |  |  |

Signal syntax:
  `QObject.connect(source, SIGNAL("closeRequest(int)"), target_slot)`

contextMenu | ( | self, |
|  | int | a0,
|  | QPoint | a1
| ) |  |  |

Emitted when the user right-clicks a tab.

Signal syntax:
  `QObject.connect(source, SIGNAL("contextMenu(int, const QPoint&)"), target_slot)`

dragEnterEvent | ( | self, |
|  | QDragEnterEvent | event
| ) |  |  |

dragMoveEvent | ( | self, |
|  | QDragMoveEvent | event
| ) |  |  |

dropEvent | ( | self, |
|  | QDropEvent | event
| ) |  |  |

emptyAreaContextMenu | ( | self, |
|  | QPoint | a0
| ) |  |  |

Emitted when the user right-clicks the empty area on the tab bar.

Signal syntax:
  `QObject.connect(source, SIGNAL("emptyAreaContextMenu(const QPoint&)"), target_slot)`

enableCloseButton | ( |  | self ) |

Deprecated:

bool hoverCloseButton | ( |  | self ) |

Deprecated:
  Use KTabBar.isCloseButtonEnabled() instead.

bool hoverCloseButtonDelayed | ( |  | self ) |

Deprecated:
  Use KTabBar.isCloseButtonEnabled() instead.

initiateDrag | ( | self, |
|  | int | a0
| ) |  |  |

Signal syntax:
  `QObject.connect(source, SIGNAL("initiateDrag(int)"), target_slot)`

bool isCloseButtonEnabled | ( |  | self ) |

Returns true if the close button is shown on tabs.

Since:
  4.1

bool isTabReorderingEnabled | ( |  | self ) |

Returns whether tab reordering is enabled.

leaveEvent | ( | self, |
|  | QEvent | event
| ) |  |  |

mouseDoubleClick | ( | self, |
|  | int | a0
| ) |  |  |

Deprecated:
  use tabDoubleClicked(int) and newTabRequest() instead.

Signal syntax:
  `QObject.connect(source, SIGNAL("mouseDoubleClick(int)"), target_slot)`

mouseDoubleClickEvent | ( | self, |
|  | QMouseEvent | event
| ) |  |  |

mouseMiddleClick | ( | self, |
|  | int | a0
| ) |  |  |

Emitted when a tab has been middle-clicked.

Signal syntax:
  `QObject.connect(source, SIGNAL("mouseMiddleClick(int)"), target_slot)`

mouseMoveEvent | ( | self, |
|  | QMouseEvent | event
| ) |  |  |

mousePressEvent | ( | self, |
|  | QMouseEvent | event
| ) |  |  |

mouseReleaseEvent | ( | self, |
|  | QMouseEvent | event
| ) |  |  |

moveTab | ( | self, |
|  | int | a0,
|  | int | a1
| ) |  |  |

Signal syntax:
  `QObject.connect(source, SIGNAL("moveTab(int, int)"), target_slot)`

newTabRequest | ( |  | self ) |

Emitted when the user double-clicks the empty area on the tab bar.

Signal syntax:
  `QObject.connect(source, SIGNAL("newTabRequest()"), target_slot)`

paintEvent | ( | self, |
|  | QPaintEvent | event
| ) |  |  |

receivedDropEvent | ( | self, |
|  | int | a0,
|  | QDropEvent | a1
| ) |  |  |

Signal syntax:
  `QObject.connect(source, SIGNAL("receivedDropEvent(int, QDropEvent*)"), target_slot)`

int selectTab | ( | self, |
|  | QPoint | position
| ) |  |  |

Selects the tab which has a tab header at given

Parameters:

  | position. |
  | position | the coordinates of the tab

setCloseButtonEnabled | ( | self, |
|  | bool | a0
| ) |  |  |

If enabled, a close button is available for each tab. The signal KTabBar.closeRequest() is emitted, if the close button has been clicked.

Since:
  4.1

setHoverCloseButton | ( | self, |
|  | bool | a0
| ) |  |  |

If enabled, a close button is shown above the tab icon. The signal KTabBar.closeRequest() is emitted, if the close button has been clicked. Note that the tab must have an icon to use this feature.

Deprecated:
  Use KTabBar.setCloseButtonEnabled() instead.

setHoverCloseButtonDelayed | ( | self, |
|  | bool | a0
| ) |  |  |

If enabled, the close button cannot get clicked until a minor delay has been passed. This prevents that user accidentally closes a tab.

Deprecated:
  Use KTabBar.setCloseButtonEnabled() instead.

setTabCloseActivatePrevious | ( | self, |
|  | bool | a0
| ) |  |  |

Sets the 'activate previous tab on close' feature enabled or disabled. If enabled, as soon as you close a tab, the previously selected tab is activated again.

setTabReorderingEnabled | ( | self, |
|  | bool | enable
| ) |  |  |

Sets the tab reordering enabled or disabled. If enabled, the user can reorder the tabs by drag and drop the tab headers.

bool tabCloseActivatePrevious | ( |  | self ) |

Returns whether the 'activate previous tab on close' feature is enabled.

tabDoubleClicked | ( | self, |
|  | int | a0
| ) |  |  |

Emitted when a tab has been double-clicked.

Signal syntax:
  `QObject.connect(source, SIGNAL("tabDoubleClicked(int)"), target_slot)`

tabLayoutChange | ( |  | self ) |

QSize tabSizeHint | ( | self, |
|  | int | index
| ) |  |  |

testCanDecode | ( | self, |
|  | QDragMoveEvent | a0,
|  | bool | a1
| ) |  |  |

Signal syntax:
  `QObject.connect(source, SIGNAL("testCanDecode(const QDragMoveEvent*, bool&)"), target_slot)`

wheelDelta | ( | self, |
|  | int | a0
| ) |  |  |

Signal syntax:
  `QObject.connect(source, SIGNAL("wheelDelta(int)"), target_slot)`

wheelEvent | ( | self, |
|  | QWheelEvent | event
| ) |  |  |