eric7/Documentation/Source/eric7.EricWidgets.EricToolButton.html

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

<p>
Module implementing a specialized tool button subclass.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#EricToolButton">EricToolButton</a></td>
<td>Class implementing a specialized tool button subclass.</td>
</tr>
<tr>
<td><a href="#EricToolButtonOptions">EricToolButtonOptions</a></td>
<td>Class defining the tool button options.</td>
</tr>
</table>
<h3>Functions</h3>

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

<p>
    Class implementing a specialized tool button subclass.
</p>
<h3>Signals</h3>
<dl>

<dt>aboutToHideMenu()</dt>
<dd>
emitted before the tool button menu is hidden
</dd>
<dt>aboutToShowMenu()</dt>
<dd>
emitted before the tool button menu is shown
</dd>
<dt>controlClicked()</dt>
<dd>
emitted when the left mouse button was
        clicked while pressing the Ctrl key
</dd>
<dt>doubleClicked()</dt>
<dd>
emitted when the left mouse button was
        double clicked
</dd>
<dt>middleClicked()</dt>
<dd>
emitted when the middle mouse button was clicked
</dd>
</dl>
<h3>Derived from</h3>
QToolButton
<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="#EricToolButton.__init__">EricToolButton</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricToolButton.__menuAboutToHide">__menuAboutToHide</a></td>
<td>Private slot to handle the tool button menu about to be hidden.</td>
</tr>
<tr>
<td><a href="#EricToolButton.__showMenu">__showMenu</a></td>
<td>Private slot to show the tool button menu.</td>
</tr>
<tr>
<td><a href="#EricToolButton.badgeText">badgeText</a></td>
<td>Public method to get the badge text.</td>
</tr>
<tr>
<td><a href="#EricToolButton.contextMenuEvent">contextMenuEvent</a></td>
<td>Protected method to handle context menu events.</td>
</tr>
<tr>
<td><a href="#EricToolButton.menu">menu</a></td>
<td>Public method to get a reference to the tool button menu.</td>
</tr>
<tr>
<td><a href="#EricToolButton.mouseDoubleClickEvent">mouseDoubleClickEvent</a></td>
<td>Protected method to handle mouse double click events.</td>
</tr>
<tr>
<td><a href="#EricToolButton.mousePressEvent">mousePressEvent</a></td>
<td>Protected method to handle mouse press events.</td>
</tr>
<tr>
<td><a href="#EricToolButton.mouseReleaseEvent">mouseReleaseEvent</a></td>
<td>Protected method to handle mouse release events.</td>
</tr>
<tr>
<td><a href="#EricToolButton.setBadgeText">setBadgeText</a></td>
<td>Public method to set the badge text.</td>
</tr>
<tr>
<td><a href="#EricToolButton.setMenu">setMenu</a></td>
<td>Public method to set the tool button menu.</td>
</tr>
<tr>
<td><a href="#EricToolButton.setShowMenuInside">setShowMenuInside</a></td>
<td>Public method to set a flag to show the menu edge aligned with the button.</td>
</tr>
<tr>
<td><a href="#EricToolButton.setToolbarButtonLook">setToolbarButtonLook</a></td>
<td>Public method to set the toolbar look state.</td>
</tr>
<tr>
<td><a href="#EricToolButton.showMenuInside">showMenuInside</a></td>
<td>Public method to check, if the menu edge shall be aligned with the button.</td>
</tr>
<tr>
<td><a href="#EricToolButton.toolbarButtonLook">toolbarButtonLook</a></td>
<td>Public method to check, if the button has the toolbar look.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

<a NAME="EricToolButton.__init__" ID="EricToolButton.__init__"></a>
<h4>EricToolButton (Constructor)</h4>
<b>EricToolButton</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="EricToolButton.__menuAboutToHide" ID="EricToolButton.__menuAboutToHide"></a>
<h4>EricToolButton.__menuAboutToHide</h4>
<b>__menuAboutToHide</b>(<i></i>)

<p>
        Private slot to handle the tool button menu about to be hidden.
</p>
<a NAME="EricToolButton.__showMenu" ID="EricToolButton.__showMenu"></a>
<h4>EricToolButton.__showMenu</h4>
<b>__showMenu</b>(<i></i>)

<p>
        Private slot to show the tool button menu.
</p>
<a NAME="EricToolButton.badgeText" ID="EricToolButton.badgeText"></a>
<h4>EricToolButton.badgeText</h4>
<b>badgeText</b>(<i></i>)

<p>
        Public method to get the badge text.
</p>
<dl>
<dt>Return:</dt>
<dd>
badge text
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="EricToolButton.contextMenuEvent" ID="EricToolButton.contextMenuEvent"></a>
<h4>EricToolButton.contextMenuEvent</h4>
<b>contextMenuEvent</b>(<i>evt</i>)

<p>
        Protected method to handle context menu events.
</p>
<dl>

<dt><i>evt</i> (QContextMenuEvent)</dt>
<dd>
reference to the context menu event
</dd>
</dl>
<a NAME="EricToolButton.menu" ID="EricToolButton.menu"></a>
<h4>EricToolButton.menu</h4>
<b>menu</b>(<i></i>)

<p>
        Public method to get a reference to the tool button menu.
</p>
<dl>
<dt>Return:</dt>
<dd>
reference to the tool button menu
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu
</dd>
</dl>
<a NAME="EricToolButton.mouseDoubleClickEvent" ID="EricToolButton.mouseDoubleClickEvent"></a>
<h4>EricToolButton.mouseDoubleClickEvent</h4>
<b>mouseDoubleClickEvent</b>(<i>evt</i>)

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

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

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

<dt><i>evt</i> (QMouseEvent)</dt>
<dd>
reference to the mouse event
</dd>
</dl>
<a NAME="EricToolButton.mouseReleaseEvent" ID="EricToolButton.mouseReleaseEvent"></a>
<h4>EricToolButton.mouseReleaseEvent</h4>
<b>mouseReleaseEvent</b>(<i>evt</i>)

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

<dt><i>evt</i> (QMouseEvent)</dt>
<dd>
reference to the mouse event
</dd>
</dl>
<a NAME="EricToolButton.setBadgeText" ID="EricToolButton.setBadgeText"></a>
<h4>EricToolButton.setBadgeText</h4>
<b>setBadgeText</b>(<i>text</i>)

<p>
        Public method to set the badge text.
</p>
<dl>

<dt><i>text</i> (str)</dt>
<dd>
badge text to be set
</dd>
</dl>
<a NAME="EricToolButton.setMenu" ID="EricToolButton.setMenu"></a>
<h4>EricToolButton.setMenu</h4>
<b>setMenu</b>(<i>menu</i>)

<p>
        Public method to set the tool button menu.
</p>
<dl>

<dt><i>menu</i> (QMenu)</dt>
<dd>
reference to the tool button menu
</dd>
</dl>
<a NAME="EricToolButton.setShowMenuInside" ID="EricToolButton.setShowMenuInside"></a>
<h4>EricToolButton.setShowMenuInside</h4>
<b>setShowMenuInside</b>(<i>enable</i>)

<p>
        Public method to set a flag to show the menu edge aligned with
        the button.
</p>
<dl>

<dt><i>enable</i> (bool)</dt>
<dd>
flag indicating to align the menu edge to the button
</dd>
</dl>
<a NAME="EricToolButton.setToolbarButtonLook" ID="EricToolButton.setToolbarButtonLook"></a>
<h4>EricToolButton.setToolbarButtonLook</h4>
<b>setToolbarButtonLook</b>(<i>enable</i>)

<p>
        Public method to set the toolbar look state.
</p>
<dl>

<dt><i>enable</i> (bool)</dt>
<dd>
flag indicating toolbar look
</dd>
</dl>
<a NAME="EricToolButton.showMenuInside" ID="EricToolButton.showMenuInside"></a>
<h4>EricToolButton.showMenuInside</h4>
<b>showMenuInside</b>(<i></i>)

<p>
        Public method to check, if the menu edge shall be aligned with
        the button.
</p>
<dl>
<dt>Return:</dt>
<dd>
flag indicating that the menu edge shall be aligned
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="EricToolButton.toolbarButtonLook" ID="EricToolButton.toolbarButtonLook"></a>
<h4>EricToolButton.toolbarButtonLook</h4>
<b>toolbarButtonLook</b>(<i></i>)

<p>
        Public method to check, if the button has the toolbar look.
</p>
<dl>
<dt>Return:</dt>
<dd>
flag indicating toolbar look
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="EricToolButtonOptions" ID="EricToolButtonOptions"></a>
<h2>EricToolButtonOptions</h2>

<p>
    Class defining the tool button options.
</p>
<h3>Derived from</h3>
enum.IntEnum
<h3>Class Attributes</h3>

<table>
<tr><td>DEFAULT</td></tr><tr><td>SHOW_MENU_INSIDE</td></tr><tr><td>TOOLBAR_LOOKUP</td></tr>
</table>
<h3>Class Methods</h3>

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

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

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

<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>