src/eric7/Documentation/Source/eric7.EricWidgets.EricTabWidget.html

<!DOCTYPE html>
<html><head>
<title>eric7.EricWidgets.EricTabWidget</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricWidgets.EricTabWidget</h1>

<p>
Module implementing a TabWidget class substituting QTabWidget.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#EricDnDTabBar">EricDnDTabBar</a></td>
<td>Class implementing a tab bar class substituting QTabBar.</td>
</tr>
<tr>
<td><a href="#EricTabWidget">EricTabWidget</a></td>
<td>Class implementing a tab widget class substituting QTabWidget.</td>
</tr>
<tr>
<td><a href="#EricWheelTabBar">EricWheelTabBar</a></td>
<td>Class implementing a tab bar class substituting QTabBar to support wheel events.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="EricDnDTabBar" ID="EricDnDTabBar"></a>
<h2>EricDnDTabBar</h2>

<p>
    Class implementing a tab bar class substituting QTabBar.
</p>
<h3>Signals</h3>
<dl>

<dt>tabMoveRequested(int, int)</dt>
<dd>
emitted to signal a tab move request
        giving the old and new index position
</dd>
</dl>
<h3>Derived from</h3>
EricWheelTabBar
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#EricDnDTabBar.__init__">EricDnDTabBar</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricDnDTabBar.dragEnterEvent">dragEnterEvent</a></td>
<td>Protected method to handle drag enter events.</td>
</tr>
<tr>
<td><a href="#EricDnDTabBar.dropEvent">dropEvent</a></td>
<td>Protected method to handle drop events.</td>
</tr>
<tr>
<td><a href="#EricDnDTabBar.mouseMoveEvent">mouseMoveEvent</a></td>
<td>Protected method to handle mouse move events.</td>
</tr>
<tr>
<td><a href="#EricDnDTabBar.mousePressEvent">mousePressEvent</a></td>
<td>Protected method to handle mouse press events.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="EricDnDTabBar.__init__" ID="EricDnDTabBar.__init__"></a>
<h4>EricDnDTabBar (Constructor)</h4>
<b>EricDnDTabBar</b>(<i>parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>parent</i></dt>
<dd>
reference to the parent widget (QWidget)
</dd>
</dl>
<a NAME="EricDnDTabBar.dragEnterEvent" ID="EricDnDTabBar.dragEnterEvent"></a>
<h4>EricDnDTabBar.dragEnterEvent</h4>
<b>dragEnterEvent</b>(<i>event</i>)

<p>
        Protected method to handle drag enter events.
</p>
<dl>

<dt><i>event</i></dt>
<dd>
reference to the drag enter event (QDragEnterEvent)
</dd>
</dl>
<a NAME="EricDnDTabBar.dropEvent" ID="EricDnDTabBar.dropEvent"></a>
<h4>EricDnDTabBar.dropEvent</h4>
<b>dropEvent</b>(<i>event</i>)

<p>
        Protected method to handle drop events.
</p>
<dl>

<dt><i>event</i></dt>
<dd>
reference to the drop event (QDropEvent)
</dd>
</dl>
<a NAME="EricDnDTabBar.mouseMoveEvent" ID="EricDnDTabBar.mouseMoveEvent"></a>
<h4>EricDnDTabBar.mouseMoveEvent</h4>
<b>mouseMoveEvent</b>(<i>event</i>)

<p>
        Protected method to handle mouse move events.
</p>
<dl>

<dt><i>event</i></dt>
<dd>
reference to the mouse move event (QMouseEvent)
</dd>
</dl>
<a NAME="EricDnDTabBar.mousePressEvent" ID="EricDnDTabBar.mousePressEvent"></a>
<h4>EricDnDTabBar.mousePressEvent</h4>
<b>mousePressEvent</b>(<i>event</i>)

<p>
        Protected method to handle mouse press events.
</p>
<dl>

<dt><i>event</i></dt>
<dd>
reference to the mouse press event (QMouseEvent)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="EricTabWidget" ID="EricTabWidget"></a>
<h2>EricTabWidget</h2>

<p>
    Class implementing a tab widget class substituting QTabWidget.
</p>
<p>
    It provides slots to show the previous and next tab and give
    them the input focus and it allows to have a context menu for the tabs.
</p>
<h3>Signals</h3>
<dl>

<dt>customTabContextMenuRequested(const QPoint & point, int index)</dt>
<dd>
        emitted when a context menu for a tab is requested
</dd>
</dl>
<h3>Derived from</h3>
QTabWidget
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#EricTabWidget.__init__">EricTabWidget</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricTabWidget.__currentChanged">__currentChanged</a></td>
<td>Private slot to handle the currentChanged signal.</td>
</tr>
<tr>
<td><a href="#EricTabWidget.__freeSide">__freeSide</a></td>
<td>Private method to determine the free side of a tab.</td>
</tr>
<tr>
<td><a href="#EricTabWidget.__handleTabCustomContextMenuRequested">__handleTabCustomContextMenuRequested</a></td>
<td>Private slot to handle the context menu request for the tabbar.</td>
</tr>
<tr>
<td><a href="#EricTabWidget.animationLabel">animationLabel</a></td>
<td>Public slot to set an animated icon.</td>
</tr>
<tr>
<td><a href="#EricTabWidget.moveTab">moveTab</a></td>
<td>Public method to move a tab to a new index.</td>
</tr>
<tr>
<td><a href="#EricTabWidget.nextTab">nextTab</a></td>
<td>Public slot used to show the next tab.</td>
</tr>
<tr>
<td><a href="#EricTabWidget.prevTab">prevTab</a></td>
<td>Public slot used to show the previous tab.</td>
</tr>
<tr>
<td><a href="#EricTabWidget.resetAnimation">resetAnimation</a></td>
<td>Public slot to reset an animated icon.</td>
</tr>
<tr>
<td><a href="#EricTabWidget.selectTab">selectTab</a></td>
<td>Public method to get the index of a tab given a position.</td>
</tr>
<tr>
<td><a href="#EricTabWidget.setCustomTabBar">setCustomTabBar</a></td>
<td>Public method to set a custom tab bar.</td>
</tr>
<tr>
<td><a href="#EricTabWidget.setTabContextMenuPolicy">setTabContextMenuPolicy</a></td>
<td>Public method to set the context menu policy of the tab.</td>
</tr>
<tr>
<td><a href="#EricTabWidget.switchTab">switchTab</a></td>
<td>Public slot used to switch between the current and the previous current tab.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="EricTabWidget.__init__" ID="EricTabWidget.__init__"></a>
<h4>EricTabWidget (Constructor)</h4>
<b>EricTabWidget</b>(<i>parent=None, dnd=False</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>parent</i></dt>
<dd>
reference to the parent widget (QWidget)
</dd>
<dt><i>dnd</i></dt>
<dd>
flag indicating the support for Drag & Drop (boolean)
</dd>
</dl>
<a NAME="EricTabWidget.__currentChanged" ID="EricTabWidget.__currentChanged"></a>
<h4>EricTabWidget.__currentChanged</h4>
<b>__currentChanged</b>(<i>index</i>)

<p>
        Private slot to handle the currentChanged signal.
</p>
<dl>

<dt><i>index</i></dt>
<dd>
index of the current tab
</dd>
</dl>
<a NAME="EricTabWidget.__freeSide" ID="EricTabWidget.__freeSide"></a>
<h4>EricTabWidget.__freeSide</h4>
<b>__freeSide</b>(<i></i>)

<p>
        Private method to determine the free side of a tab.
</p>
<dl>
<dt>Return:</dt>
<dd>
free side (QTabBar.ButtonPosition)
</dd>
</dl>
<a NAME="EricTabWidget.__handleTabCustomContextMenuRequested" ID="EricTabWidget.__handleTabCustomContextMenuRequested"></a>
<h4>EricTabWidget.__handleTabCustomContextMenuRequested</h4>
<b>__handleTabCustomContextMenuRequested</b>(<i>point</i>)

<p>
        Private slot to handle the context menu request for the tabbar.
</p>
<dl>

<dt><i>point</i></dt>
<dd>
point the context menu was requested (QPoint)
</dd>
</dl>
<a NAME="EricTabWidget.animationLabel" ID="EricTabWidget.animationLabel"></a>
<h4>EricTabWidget.animationLabel</h4>
<b>animationLabel</b>(<i>index, animationFile, interval=100</i>)

<p>
        Public slot to set an animated icon.
</p>
<dl>

<dt><i>index</i> (int)</dt>
<dd>
tab index
</dd>
<dt><i>animationFile</i> (str)</dt>
<dd>
name of the file containing the animation
</dd>
<dt><i>interval</i> (int)</dt>
<dd>
interval in milliseconds between animation frames
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the created label
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
EricAnimatedLabel
</dd>
</dl>
<a NAME="EricTabWidget.moveTab" ID="EricTabWidget.moveTab"></a>
<h4>EricTabWidget.moveTab</h4>
<b>moveTab</b>(<i>curIndex, newIndex</i>)

<p>
        Public method to move a tab to a new index.
</p>
<dl>

<dt><i>curIndex</i></dt>
<dd>
index of tab to be moved (integer)
</dd>
<dt><i>newIndex</i></dt>
<dd>
index the tab should be moved to (integer)
</dd>
</dl>
<a NAME="EricTabWidget.nextTab" ID="EricTabWidget.nextTab"></a>
<h4>EricTabWidget.nextTab</h4>
<b>nextTab</b>(<i></i>)

<p>
        Public slot used to show the next tab.
</p>
<a NAME="EricTabWidget.prevTab" ID="EricTabWidget.prevTab"></a>
<h4>EricTabWidget.prevTab</h4>
<b>prevTab</b>(<i></i>)

<p>
        Public slot used to show the previous tab.
</p>
<a NAME="EricTabWidget.resetAnimation" ID="EricTabWidget.resetAnimation"></a>
<h4>EricTabWidget.resetAnimation</h4>
<b>resetAnimation</b>(<i>index</i>)

<p>
        Public slot to reset an animated icon.
</p>
<dl>

<dt><i>index</i></dt>
<dd>
tab index (integer)
</dd>
</dl>
<a NAME="EricTabWidget.selectTab" ID="EricTabWidget.selectTab"></a>
<h4>EricTabWidget.selectTab</h4>
<b>selectTab</b>(<i>pos</i>)

<p>
        Public method to get the index of a tab given a position.
</p>
<dl>

<dt><i>pos</i></dt>
<dd>
position determining the tab index (QPoint)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
index of the tab (integer)
</dd>
</dl>
<a NAME="EricTabWidget.setCustomTabBar" ID="EricTabWidget.setCustomTabBar"></a>
<h4>EricTabWidget.setCustomTabBar</h4>
<b>setCustomTabBar</b>(<i>dnd, tabBar</i>)

<p>
        Public method to set a custom tab bar.
</p>
<dl>

<dt><i>dnd</i></dt>
<dd>
flag indicating the support for Drag & Drop (boolean)
</dd>
<dt><i>tabBar</i></dt>
<dd>
reference to the tab bar to set (QTabBar)
</dd>
</dl>
<a NAME="EricTabWidget.setTabContextMenuPolicy" ID="EricTabWidget.setTabContextMenuPolicy"></a>
<h4>EricTabWidget.setTabContextMenuPolicy</h4>
<b>setTabContextMenuPolicy</b>(<i>policy</i>)

<p>
        Public method to set the context menu policy of the tab.
</p>
<dl>

<dt><i>policy</i></dt>
<dd>
context menu policy to set (Qt.ContextMenuPolicy)
</dd>
</dl>
<a NAME="EricTabWidget.switchTab" ID="EricTabWidget.switchTab"></a>
<h4>EricTabWidget.switchTab</h4>
<b>switchTab</b>(<i></i>)

<p>
        Public slot used to switch between the current and the previous
        current tab.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="EricWheelTabBar" ID="EricWheelTabBar"></a>
<h2>EricWheelTabBar</h2>

<p>
    Class implementing a tab bar class substituting QTabBar to support wheel
    events.
</p>
<h3>Derived from</h3>
QTabBar
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#EricWheelTabBar.__init__">EricWheelTabBar</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricWheelTabBar.wheelEvent">wheelEvent</a></td>
<td>Protected slot to support wheel events.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="EricWheelTabBar.__init__" ID="EricWheelTabBar.__init__"></a>
<h4>EricWheelTabBar (Constructor)</h4>
<b>EricWheelTabBar</b>(<i>parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>parent</i></dt>
<dd>
reference to the parent widget (QWidget)
</dd>
</dl>
<a NAME="EricWheelTabBar.wheelEvent" ID="EricWheelTabBar.wheelEvent"></a>
<h4>EricWheelTabBar.wheelEvent</h4>
<b>wheelEvent</b>(<i>event</i>)

<p>
        Protected slot to support wheel events.
</p>
<dl>

<dt><i>event</i></dt>
<dd>
reference to the wheel event (QWheelEvent)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>