--- a/Documentation/Source/eric5.E4Gui.E4TabWidget.html Tue Jan 12 18:39:15 2010 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,371 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' -'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> -<html><head> -<title>eric5.E4Gui.E4TabWidget</title> -<style> -body { - background:white; - margin: 0em 1em 10em 1em; - color: black; -} - -h1 { color: white; background: #4FA4FF; } -h2 { color: white; background: #4FA4FF; } -h3 { color: white; background: #00557F; } -h4 { color: white; background: #00557F; } - -a { color: #AA5500; } - -</style> -</head> -<body><a NAME="top" ID="top"></a> -<h1>eric5.E4Gui.E4TabWidget</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="#E4DnDTabBar">E4DnDTabBar</a></td> -<td>Class implementing a tab bar class substituting QTabBar.</td> -</tr><tr> -<td><a href="#E4TabWidget">E4TabWidget</a></td> -<td>Class implementing a tab widget class substituting QTabWidget.</td> -</tr><tr> -<td><a href="#E4WheelTabBar">E4WheelTabBar</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="E4DnDTabBar" ID="E4DnDTabBar"></a> -<h2>E4DnDTabBar</h2> -<p> - Class implementing a tab bar class substituting QTabBar. -</p><h4>Signals</h4> -<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> -E4WheelTabBar -<h3>Class Attributes</h3> -<table> -<tr><td>None</td></tr> -</table> -<h3>Methods</h3> -<table> -<tr> -<td><a href="#E4DnDTabBar.__init__">E4DnDTabBar</a></td> -<td>Constructor</td> -</tr><tr> -<td><a href="#E4DnDTabBar.dragEnterEvent">dragEnterEvent</a></td> -<td>Protected method to handle drag enter events.</td> -</tr><tr> -<td><a href="#E4DnDTabBar.dropEvent">dropEvent</a></td> -<td>Protected method to handle drop events.</td> -</tr><tr> -<td><a href="#E4DnDTabBar.mouseMoveEvent">mouseMoveEvent</a></td> -<td>Protected method to handle mouse move events.</td> -</tr><tr> -<td><a href="#E4DnDTabBar.mousePressEvent">mousePressEvent</a></td> -<td>Protected method to handle mouse press events.</td> -</tr> -</table> -<a NAME="E4DnDTabBar.__init__" ID="E4DnDTabBar.__init__"></a> -<h4>E4DnDTabBar (Constructor)</h4> -<b>E4DnDTabBar</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="E4DnDTabBar.dragEnterEvent" ID="E4DnDTabBar.dragEnterEvent"></a> -<h4>E4DnDTabBar.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="E4DnDTabBar.dropEvent" ID="E4DnDTabBar.dropEvent"></a> -<h4>E4DnDTabBar.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="E4DnDTabBar.mouseMoveEvent" ID="E4DnDTabBar.mouseMoveEvent"></a> -<h4>E4DnDTabBar.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="E4DnDTabBar.mousePressEvent" ID="E4DnDTabBar.mousePressEvent"></a> -<h4>E4DnDTabBar.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="E4TabWidget" ID="E4TabWidget"></a> -<h2>E4TabWidget</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><h4>Signals</h4> -<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>Methods</h3> -<table> -<tr> -<td><a href="#E4TabWidget.__init__">E4TabWidget</a></td> -<td>Constructor</td> -</tr><tr> -<td><a href="#E4TabWidget.__currentChanged">__currentChanged</a></td> -<td>Private slot to handle the currentChanged signal.</td> -</tr><tr> -<td><a href="#E4TabWidget.__freeSide">__freeSide</a></td> -<td>Private method to determine the free side of a tab.</td> -</tr><tr> -<td><a href="#E4TabWidget.__handleTabCustomContextMenuRequested">__handleTabCustomContextMenuRequested</a></td> -<td>Private slot to handle the context menu request for the tabbar.</td> -</tr><tr> -<td><a href="#E4TabWidget.animationLabel">animationLabel</a></td> -<td>Public slot to set an animated icon.</td> -</tr><tr> -<td><a href="#E4TabWidget.moveTab">moveTab</a></td> -<td>Public method to move a tab to a new index.</td> -</tr><tr> -<td><a href="#E4TabWidget.nextTab">nextTab</a></td> -<td>Public slot used to show the next tab.</td> -</tr><tr> -<td><a href="#E4TabWidget.prevTab">prevTab</a></td> -<td>Public slot used to show the previous tab.</td> -</tr><tr> -<td><a href="#E4TabWidget.resetAnimation">resetAnimation</a></td> -<td>Public slot to reset an animated icon.</td> -</tr><tr> -<td><a href="#E4TabWidget.selectTab">selectTab</a></td> -<td>Public method to get the index of a tab given a position.</td> -</tr><tr> -<td><a href="#E4TabWidget.setTabContextMenuPolicy">setTabContextMenuPolicy</a></td> -<td>Public method to set the context menu policy of the tab.</td> -</tr><tr> -<td><a href="#E4TabWidget.switchTab">switchTab</a></td> -<td>Public slot used to switch between the current and the previous current tab.</td> -</tr> -</table> -<a NAME="E4TabWidget.__init__" ID="E4TabWidget.__init__"></a> -<h4>E4TabWidget (Constructor)</h4> -<b>E4TabWidget</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="E4TabWidget.__currentChanged" ID="E4TabWidget.__currentChanged"></a> -<h4>E4TabWidget.__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="E4TabWidget.__freeSide" ID="E4TabWidget.__freeSide"></a> -<h4>E4TabWidget.__freeSide</h4> -<b>__freeSide</b>(<i></i>) -<p> - Private method to determine the free side of a tab. -</p><dl> -<dt>Returns:</dt> -<dd> -free side (QTabBar.ButtonPosition) -</dd> -</dl><a NAME="E4TabWidget.__handleTabCustomContextMenuRequested" ID="E4TabWidget.__handleTabCustomContextMenuRequested"></a> -<h4>E4TabWidget.__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="E4TabWidget.animationLabel" ID="E4TabWidget.animationLabel"></a> -<h4>E4TabWidget.animationLabel</h4> -<b>animationLabel</b>(<i>index, animationFile</i>) -<p> - Public slot to set an animated icon. -</p><dl> -<dt><i>index</i></dt> -<dd> -tab index (integer) -</dd><dt><i>animationFile</i></dt> -<dd> -name of the file containing the animation (string) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -reference to the created label (QLabel) -</dd> -</dl><a NAME="E4TabWidget.moveTab" ID="E4TabWidget.moveTab"></a> -<h4>E4TabWidget.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="E4TabWidget.nextTab" ID="E4TabWidget.nextTab"></a> -<h4>E4TabWidget.nextTab</h4> -<b>nextTab</b>(<i></i>) -<p> - Public slot used to show the next tab. -</p><a NAME="E4TabWidget.prevTab" ID="E4TabWidget.prevTab"></a> -<h4>E4TabWidget.prevTab</h4> -<b>prevTab</b>(<i></i>) -<p> - Public slot used to show the previous tab. -</p><a NAME="E4TabWidget.resetAnimation" ID="E4TabWidget.resetAnimation"></a> -<h4>E4TabWidget.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="E4TabWidget.selectTab" ID="E4TabWidget.selectTab"></a> -<h4>E4TabWidget.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>Returns:</dt> -<dd> -index of the tab (integer) -</dd> -</dl><a NAME="E4TabWidget.setTabContextMenuPolicy" ID="E4TabWidget.setTabContextMenuPolicy"></a> -<h4>E4TabWidget.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="E4TabWidget.switchTab" ID="E4TabWidget.switchTab"></a> -<h4>E4TabWidget.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="E4WheelTabBar" ID="E4WheelTabBar"></a> -<h2>E4WheelTabBar</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>Methods</h3> -<table> -<tr> -<td><a href="#E4WheelTabBar.__init__">E4WheelTabBar</a></td> -<td>Constructor</td> -</tr><tr> -<td><a href="#E4WheelTabBar.wheelEvent">wheelEvent</a></td> -<td>Protected slot to support wheel events.</td> -</tr> -</table> -<a NAME="E4WheelTabBar.__init__" ID="E4WheelTabBar.__init__"></a> -<h4>E4WheelTabBar (Constructor)</h4> -<b>E4WheelTabBar</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="E4WheelTabBar.wheelEvent" ID="E4WheelTabBar.wheelEvent"></a> -<h4>E4WheelTabBar.wheelEvent</h4> -<b>wheelEvent</b>(<i>event</i>) -<p> - Protected slot to support wheel events. -</p><dl> -<dt><i>reference</i></dt> -<dd> -to the wheel event (QWheelEvent) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -</body></html> \ No newline at end of file