Mercurial Repositories > eric / file diff

diff: eric7/Documentation/Source/eric7.EricWidgets.EricModelToolBar.html

eric7/Documentation/Source/eric7.EricWidgets.EricModelToolBar.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.EricWidgets.EricModelToolBar.html	Mon May 24 11:19:57 2021 +0200
@@ -0,0 +1,375 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.EricWidgets.EricModelToolBar</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.EricWidgets.EricModelToolBar</h1>
+
+<p>
+Module implementing a tool bar populated from a QAbstractItemModel.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#EricModelToolBar">EricModelToolBar</a></td>
+<td>Class implementing a tool bar populated from a QAbstractItemModel.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="EricModelToolBar" ID="EricModelToolBar"></a>
+<h2>EricModelToolBar</h2>
+
+<p>
+    Class implementing a tool bar populated from a QAbstractItemModel.
+</p>
+<h3>Signals</h3>
+<dl>
+
+<dt>activated(QModelIndex)</dt>
+<dd>
+emitted when an action has been triggered
+</dd>
+</dl>
+<h3>Derived from</h3>
+QToolBar
+<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="#EricModelToolBar.__init__">EricModelToolBar</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#EricModelToolBar._build">_build</a></td>
+<td>Protected slot to build the tool bar.</td>
+</tr>
+<tr>
+<td><a href="#EricModelToolBar._createMenu">_createMenu</a></td>
+<td>Protected method to create the menu for a tool bar action.</td>
+</tr>
+<tr>
+<td><a href="#EricModelToolBar.dragEnterEvent">dragEnterEvent</a></td>
+<td>Protected method to handle drag enter events.</td>
+</tr>
+<tr>
+<td><a href="#EricModelToolBar.dropEvent">dropEvent</a></td>
+<td>Protected method to handle drop events.</td>
+</tr>
+<tr>
+<td><a href="#EricModelToolBar.eventFilter">eventFilter</a></td>
+<td>Public method to handle event for other objects.</td>
+</tr>
+<tr>
+<td><a href="#EricModelToolBar.hideEvent">hideEvent</a></td>
+<td>Protected method to handle hide events.</td>
+</tr>
+<tr>
+<td><a href="#EricModelToolBar.index">index</a></td>
+<td>Public method to get the index of an action.</td>
+</tr>
+<tr>
+<td><a href="#EricModelToolBar.model">model</a></td>
+<td>Public method to get a reference to the model.</td>
+</tr>
+<tr>
+<td><a href="#EricModelToolBar.mouseMoveEvent">mouseMoveEvent</a></td>
+<td>Protected method to handle mouse move events.</td>
+</tr>
+<tr>
+<td><a href="#EricModelToolBar.resetFlags">resetFlags</a></td>
+<td>Public method to reset the saved internal state.</td>
+</tr>
+<tr>
+<td><a href="#EricModelToolBar.rootIndex">rootIndex</a></td>
+<td>Public method to get the root index.</td>
+</tr>
+<tr>
+<td><a href="#EricModelToolBar.setModel">setModel</a></td>
+<td>Public method to set the model for the tool bar.</td>
+</tr>
+<tr>
+<td><a href="#EricModelToolBar.setRootIndex">setRootIndex</a></td>
+<td>Public method to set the root index.</td>
+</tr>
+<tr>
+<td><a href="#EricModelToolBar.showEvent">showEvent</a></td>
+<td>Protected method to handle show events.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="EricModelToolBar.__init__" ID="EricModelToolBar.__init__"></a>
+<h4>EricModelToolBar (Constructor)</h4>
+<b>EricModelToolBar</b>(<i>title=None, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>title</i></dt>
+<dd>
+title for the tool bar (string)
+</dd>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl>
+<a NAME="EricModelToolBar._build" ID="EricModelToolBar._build"></a>
+<h4>EricModelToolBar._build</h4>
+<b>_build</b>(<i></i>)
+
+<p>
+        Protected slot to build the tool bar.
+</p>
+<a NAME="EricModelToolBar._createMenu" ID="EricModelToolBar._createMenu"></a>
+<h4>EricModelToolBar._createMenu</h4>
+<b>_createMenu</b>(<i></i>)
+
+<p>
+        Protected method to create the menu for a tool bar action.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+menu for a tool bar action (EricModelMenu)
+</dd>
+</dl>
+<a NAME="EricModelToolBar.dragEnterEvent" ID="EricModelToolBar.dragEnterEvent"></a>
+<h4>EricModelToolBar.dragEnterEvent</h4>
+<b>dragEnterEvent</b>(<i>evt</i>)
+
+<p>
+        Protected method to handle drag enter events.
+</p>
+<dl>
+
+<dt><i>evt</i></dt>
+<dd>
+reference to the event (QDragEnterEvent)
+</dd>
+</dl>
+<a NAME="EricModelToolBar.dropEvent" ID="EricModelToolBar.dropEvent"></a>
+<h4>EricModelToolBar.dropEvent</h4>
+<b>dropEvent</b>(<i>evt</i>)
+
+<p>
+        Protected method to handle drop events.
+</p>
+<dl>
+
+<dt><i>evt</i></dt>
+<dd>
+reference to the event (QDropEvent)
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised to indicate an invalid model index
+</dd>
+</dl>
+<a NAME="EricModelToolBar.eventFilter" ID="EricModelToolBar.eventFilter"></a>
+<h4>EricModelToolBar.eventFilter</h4>
+<b>eventFilter</b>(<i>obj, evt</i>)
+
+<p>
+        Public method to handle event for other objects.
+</p>
+<dl>
+
+<dt><i>obj</i></dt>
+<dd>
+reference to the object (QObject)
+</dd>
+<dt><i>evt</i></dt>
+<dd>
+reference to the event (QEvent)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating that the event should be filtered out (boolean)
+</dd>
+</dl>
+<a NAME="EricModelToolBar.hideEvent" ID="EricModelToolBar.hideEvent"></a>
+<h4>EricModelToolBar.hideEvent</h4>
+<b>hideEvent</b>(<i>evt</i>)
+
+<p>
+        Protected method to handle hide events.
+</p>
+<dl>
+
+<dt><i>evt</i></dt>
+<dd>
+reference to the hide event (QHideEvent)
+</dd>
+</dl>
+<a NAME="EricModelToolBar.index" ID="EricModelToolBar.index"></a>
+<h4>EricModelToolBar.index</h4>
+<b>index</b>(<i>action</i>)
+
+<p>
+        Public method to get the index of an action.
+</p>
+<dl>
+
+<dt><i>action</i></dt>
+<dd>
+reference to the action to get the index for (QAction)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+index of the action (QModelIndex)
+</dd>
+</dl>
+<a NAME="EricModelToolBar.model" ID="EricModelToolBar.model"></a>
+<h4>EricModelToolBar.model</h4>
+<b>model</b>(<i></i>)
+
+<p>
+        Public method to get a reference to the model.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the model (QAbstractItemModel)
+</dd>
+</dl>
+<a NAME="EricModelToolBar.mouseMoveEvent" ID="EricModelToolBar.mouseMoveEvent"></a>
+<h4>EricModelToolBar.mouseMoveEvent</h4>
+<b>mouseMoveEvent</b>(<i>evt</i>)
+
+<p>
+        Protected method to handle mouse move events.
+</p>
+<dl>
+
+<dt><i>evt</i></dt>
+<dd>
+reference to the event (QMouseEvent)
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised to indicate an invalid model index
+</dd>
+</dl>
+<a NAME="EricModelToolBar.resetFlags" ID="EricModelToolBar.resetFlags"></a>
+<h4>EricModelToolBar.resetFlags</h4>
+<b>resetFlags</b>(<i></i>)
+
+<p>
+        Public method to reset the saved internal state.
+</p>
+<a NAME="EricModelToolBar.rootIndex" ID="EricModelToolBar.rootIndex"></a>
+<h4>EricModelToolBar.rootIndex</h4>
+<b>rootIndex</b>(<i></i>)
+
+<p>
+        Public method to get the root index.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+root index (QModelIndex)
+</dd>
+</dl>
+<a NAME="EricModelToolBar.setModel" ID="EricModelToolBar.setModel"></a>
+<h4>EricModelToolBar.setModel</h4>
+<b>setModel</b>(<i>model</i>)
+
+<p>
+        Public method to set the model for the tool bar.
+</p>
+<dl>
+
+<dt><i>model</i></dt>
+<dd>
+reference to the model (QAbstractItemModel)
+</dd>
+</dl>
+<a NAME="EricModelToolBar.setRootIndex" ID="EricModelToolBar.setRootIndex"></a>
+<h4>EricModelToolBar.setRootIndex</h4>
+<b>setRootIndex</b>(<i>idx</i>)
+
+<p>
+        Public method to set the root index.
+</p>
+<dl>
+
+<dt><i>idx</i></dt>
+<dd>
+index to be set as the root index (QModelIndex)
+</dd>
+</dl>
+<a NAME="EricModelToolBar.showEvent" ID="EricModelToolBar.showEvent"></a>
+<h4>EricModelToolBar.showEvent</h4>
+<b>showEvent</b>(<i>evt</i>)
+
+<p>
+        Protected method to handle show events.
+</p>
+<dl>
+
+<dt><i>evt</i></dt>
+<dd>
+reference to the hide event (QHideEvent)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

Mercurial Repository: eric

eric ide

mercurial