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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Preferences.MouseClickDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Preferences.MouseClickDialog</h1>
10
11 <p>
12 Module implementing a dialog for the configuration of a mouse click sequence.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#MouseClickDialog">MouseClickDialog</a></td>
25 <td>Class implementing a dialog for the configuration of a mouse click sequence.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="MouseClickDialog" ID="MouseClickDialog"></a>
36 <h2>MouseClickDialog</h2>
37
38 <p>
39 Class implementing a dialog for the configuration of a mouse click
40 sequence.
41 </p>
42 <h3>Derived from</h3>
43 QDialog, Ui_MouseClickDialog
44 <h3>Class Attributes</h3>
45
46 <table>
47 <tr><td>None</td></tr>
48 </table>
49 <h3>Class Methods</h3>
50
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55
56 <table>
57
58 <tr>
59 <td><a href="#MouseClickDialog.__init__">MouseClickDialog</a></td>
60 <td>Constructor</td>
61 </tr>
62 <tr>
63 <td><a href="#MouseClickDialog.__showClickText">__showClickText</a></td>
64 <td>Private method to show a string representing the entered mouse click sequence.</td>
65 </tr>
66 <tr>
67 <td><a href="#MouseClickDialog.eventFilter">eventFilter</a></td>
68 <td>Public method called to filter the event queue.</td>
69 </tr>
70 <tr>
71 <td><a href="#MouseClickDialog.getClick">getClick</a></td>
72 <td>Public method to get the entered mouse click sequence.</td>
73 </tr>
74 <tr>
75 <td><a href="#MouseClickDialog.on_clearButton_clicked">on_clearButton_clicked</a></td>
76 <td>Private slot to clear the entered sequence.</td>
77 </tr>
78 </table>
79 <h3>Static Methods</h3>
80
81 <table>
82 <tr><td>None</td></tr>
83 </table>
84
85 <a NAME="MouseClickDialog.__init__" ID="MouseClickDialog.__init__"></a>
86 <h4>MouseClickDialog (Constructor)</h4>
87 <b>MouseClickDialog</b>(<i>modifiers, button, parent=None</i>)
88
89 <p>
90 Constructor
91 </p>
92 <dl>
93
94 <dt><i>modifiers</i> (Qt.KeyboardModifiers)</dt>
95 <dd>
96 keyboard modifiers of the handler
97 </dd>
98 <dt><i>button</i> (Qt.MouseButton)</dt>
99 <dd>
100 mouse button of the handler
101 </dd>
102 <dt><i>parent</i> (QWidget)</dt>
103 <dd>
104 reference to the parent widget
105 </dd>
106 </dl>
107 <a NAME="MouseClickDialog.__showClickText" ID="MouseClickDialog.__showClickText"></a>
108 <h4>MouseClickDialog.__showClickText</h4>
109 <b>__showClickText</b>(<i></i>)
110
111 <p>
112 Private method to show a string representing the entered mouse click
113 sequence.
114 </p>
115 <a NAME="MouseClickDialog.eventFilter" ID="MouseClickDialog.eventFilter"></a>
116 <h4>MouseClickDialog.eventFilter</h4>
117 <b>eventFilter</b>(<i>watched, event</i>)
118
119 <p>
120 Public method called to filter the event queue.
121 </p>
122 <dl>
123
124 <dt><i>watched</i> (QObject)</dt>
125 <dd>
126 reference to the watched object
127 </dd>
128 <dt><i>event</i> (QEvent)</dt>
129 <dd>
130 reference to the event that occurred
131 </dd>
132 </dl>
133 <dl>
134 <dt>Return:</dt>
135 <dd>
136 flag indicating a handled event
137 </dd>
138 </dl>
139 <dl>
140 <dt>Return Type:</dt>
141 <dd>
142 bool
143 </dd>
144 </dl>
145 <a NAME="MouseClickDialog.getClick" ID="MouseClickDialog.getClick"></a>
146 <h4>MouseClickDialog.getClick</h4>
147 <b>getClick</b>(<i></i>)
148
149 <p>
150 Public method to get the entered mouse click sequence.
151 </p>
152 <dl>
153 <dt>Return:</dt>
154 <dd>
155 tuple containing the modifiers and the mouse button
156 </dd>
157 </dl>
158 <dl>
159 <dt>Return Type:</dt>
160 <dd>
161 tuple of Qt.KeyboardModifiers and Qt.MouseButton
162 </dd>
163 </dl>
164 <a NAME="MouseClickDialog.on_clearButton_clicked" ID="MouseClickDialog.on_clearButton_clicked"></a>
165 <h4>MouseClickDialog.on_clearButton_clicked</h4>
166 <b>on_clearButton_clicked</b>(<i></i>)
167
168 <p>
169 Private slot to clear the entered sequence.
170 </p>
171 <div align="right"><a href="#top">Up</a></div>
172 <hr />
173 </body></html>

eric ide

mercurial