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

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

<p>
Module implementing a horizontal and a vertical toolbox class.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#EricHorizontalToolBox">EricHorizontalToolBox</a></td>
<td>Class implementing a vertical QToolBox like widget.</td>
</tr>
<tr>
<td><a href="#EricVerticalToolBox">EricVerticalToolBox</a></td>
<td>Class implementing a ToolBox class substituting QToolBox to support wheel events.</td>
</tr>
</table>
<h3>Functions</h3>

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

<p>
    Class implementing a vertical QToolBox like widget.
</p>
<h3>Derived from</h3>
EricTabWidget
<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="#EricHorizontalToolBox.__init__">EricHorizontalToolBox</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricHorizontalToolBox.addItem">addItem</a></td>
<td>Public method to add a widget to the toolbox.</td>
</tr>
<tr>
<td><a href="#EricHorizontalToolBox.insertItem">insertItem</a></td>
<td>Public method to add a widget to the toolbox.</td>
</tr>
<tr>
<td><a href="#EricHorizontalToolBox.removeItem">removeItem</a></td>
<td>Public method to remove a widget from the toolbox.</td>
</tr>
<tr>
<td><a href="#EricHorizontalToolBox.setCurrentWidget">setCurrentWidget</a></td>
<td>Public slot to set the current widget.</td>
</tr>
<tr>
<td><a href="#EricHorizontalToolBox.setItemEnabled">setItemEnabled</a></td>
<td>Public method to set the enabled state of an item.</td>
</tr>
<tr>
<td><a href="#EricHorizontalToolBox.setItemToolTip">setItemToolTip</a></td>
<td>Public method to set the tooltip of an item.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

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

<p>
        Constructor
</p>
<dl>

<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="EricHorizontalToolBox.addItem" ID="EricHorizontalToolBox.addItem"></a>
<h4>EricHorizontalToolBox.addItem</h4>
<b>addItem</b>(<i>widget, icon, text</i>)

<p>
        Public method to add a widget to the toolbox.
</p>
<dl>

<dt><i>widget</i> (QWidget)</dt>
<dd>
reference to the widget to be added
</dd>
<dt><i>icon</i> (QIcon)</dt>
<dd>
the icon to be shown
</dd>
<dt><i>text</i> (str)</dt>
<dd>
the text to be shown
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
index of the added widget
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
int
</dd>
</dl>
<a NAME="EricHorizontalToolBox.insertItem" ID="EricHorizontalToolBox.insertItem"></a>
<h4>EricHorizontalToolBox.insertItem</h4>
<b>insertItem</b>(<i>index, widget, icon, text</i>)

<p>
        Public method to add a widget to the toolbox.
</p>
<dl>

<dt><i>index</i> (int)</dt>
<dd>
position at which the widget should be inserted
</dd>
<dt><i>widget</i> (QWidget)</dt>
<dd>
reference to the widget to be added
</dd>
<dt><i>icon</i> (QIcon)</dt>
<dd>
the icon to be shown
</dd>
<dt><i>text</i> (str)</dt>
<dd>
the text to be shown
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
index of the added widget
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
int
</dd>
</dl>
<a NAME="EricHorizontalToolBox.removeItem" ID="EricHorizontalToolBox.removeItem"></a>
<h4>EricHorizontalToolBox.removeItem</h4>
<b>removeItem</b>(<i>index</i>)

<p>
        Public method to remove a widget from the toolbox.
</p>
<dl>

<dt><i>index</i> (int)</dt>
<dd>
index of the widget to remove
</dd>
</dl>
<a NAME="EricHorizontalToolBox.setCurrentWidget" ID="EricHorizontalToolBox.setCurrentWidget"></a>
<h4>EricHorizontalToolBox.setCurrentWidget</h4>
<b>setCurrentWidget</b>(<i>widget</i>)

<p>
        Public slot to set the current widget.
</p>
<dl>

<dt><i>widget</i> (QWidget)</dt>
<dd>
reference to the widget to become the current widget
</dd>
</dl>
<a NAME="EricHorizontalToolBox.setItemEnabled" ID="EricHorizontalToolBox.setItemEnabled"></a>
<h4>EricHorizontalToolBox.setItemEnabled</h4>
<b>setItemEnabled</b>(<i>index, enabled</i>)

<p>
        Public method to set the enabled state of an item.
</p>
<dl>

<dt><i>index</i> (int)</dt>
<dd>
index of the item
</dd>
<dt><i>enabled</i> (bool)</dt>
<dd>
flag indicating the enabled state
</dd>
</dl>
<a NAME="EricHorizontalToolBox.setItemToolTip" ID="EricHorizontalToolBox.setItemToolTip"></a>
<h4>EricHorizontalToolBox.setItemToolTip</h4>
<b>setItemToolTip</b>(<i>index, toolTip</i>)

<p>
        Public method to set the tooltip of an item.
</p>
<dl>

<dt><i>index</i> (int)</dt>
<dd>
index of the item
</dd>
<dt><i>toolTip</i> (str)</dt>
<dd>
tooltip text to be set
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="EricVerticalToolBox" ID="EricVerticalToolBox"></a>
<h2>EricVerticalToolBox</h2>

<p>
    Class implementing a ToolBox class substituting QToolBox to support wheel
    events.
</p>
<h3>Derived from</h3>
QToolBox
<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="#EricVerticalToolBox.__init__">EricVerticalToolBox</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricVerticalToolBox.setCurrentWidget">setCurrentWidget</a></td>
<td>Public slot to set the current widget.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

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

<p>
        Constructor
</p>
<dl>

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

<p>
        Public slot to set the current widget.
</p>
<dl>

<dt><i>widget</i> (QWidget)</dt>
<dd>
reference to the widget to become the current widget
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>