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