eric7/Documentation/Source/eric7.Preferences.MouseClickDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.Preferences.MouseClickDialog.html	Mon May 24 11:19:57 2021 +0200
@@ -0,0 +1,187 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Preferences.MouseClickDialog</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.Preferences.MouseClickDialog</h1>
+
+<p>
+Module implementing a dialog for the configuration of a mouse click sequence.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#MouseClickDialog">MouseClickDialog</a></td>
+<td>Class implementing a dialog for the configuration of a mouse click sequence.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="MouseClickDialog" ID="MouseClickDialog"></a>
+<h2>MouseClickDialog</h2>
+
+<p>
+    Class implementing a dialog for the configuration of a mouse click
+    sequence.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_MouseClickDialog
+<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="#MouseClickDialog.__init__">MouseClickDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#MouseClickDialog.__showClickText">__showClickText</a></td>
+<td>Private method to show a string representing the entered mouse click sequence.</td>
+</tr>
+<tr>
+<td><a href="#MouseClickDialog.eventFilter">eventFilter</a></td>
+<td>Public method called to filter the event queue.</td>
+</tr>
+<tr>
+<td><a href="#MouseClickDialog.getClick">getClick</a></td>
+<td>Public method to get the entered mouse click sequence.</td>
+</tr>
+<tr>
+<td><a href="#MouseClickDialog.on_clearButton_clicked">on_clearButton_clicked</a></td>
+<td>Private slot to clear the entered sequence.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="MouseClickDialog.__init__" ID="MouseClickDialog.__init__"></a>
+<h4>MouseClickDialog (Constructor)</h4>
+<b>MouseClickDialog</b>(<i>modifiers, button, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>modifiers</i> (Qt.KeyboardModifiers)</dt>
+<dd>
+keyboard modifiers of the handler
+</dd>
+<dt><i>button</i> (Qt.MouseButton)</dt>
+<dd>
+mouse button of the handler
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl>
+<a NAME="MouseClickDialog.__showClickText" ID="MouseClickDialog.__showClickText"></a>
+<h4>MouseClickDialog.__showClickText</h4>
+<b>__showClickText</b>(<i></i>)
+
+<p>
+        Private method to show a string representing the entered mouse click
+        sequence.
+</p>
+<a NAME="MouseClickDialog.eventFilter" ID="MouseClickDialog.eventFilter"></a>
+<h4>MouseClickDialog.eventFilter</h4>
+<b>eventFilter</b>(<i>watched, event</i>)
+
+<p>
+        Public method called to filter the event queue.
+</p>
+<dl>
+
+<dt><i>watched</i> (QObject)</dt>
+<dd>
+reference to the watched object
+</dd>
+<dt><i>event</i> (QEvent)</dt>
+<dd>
+reference to the event that occurred
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a handled event
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="MouseClickDialog.getClick" ID="MouseClickDialog.getClick"></a>
+<h4>MouseClickDialog.getClick</h4>
+<b>getClick</b>(<i></i>)
+
+<p>
+        Public method to get the entered mouse click sequence.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing the modifiers and the mouse button
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of Qt.KeyboardModifiers and Qt.MouseButton
+</dd>
+</dl>
+<a NAME="MouseClickDialog.on_clearButton_clicked" ID="MouseClickDialog.on_clearButton_clicked"></a>
+<h4>MouseClickDialog.on_clearButton_clicked</h4>
+<b>on_clearButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to clear the entered sequence.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial