|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric4.Preferences.ShortcutDialog</title> |
|
6 <style> |
|
7 body { |
|
8 background:white; |
|
9 margin: 0em 1em 10em 1em; |
|
10 color: black; |
|
11 } |
|
12 |
|
13 h1 { color: white; background: #4FA4FF; } |
|
14 h2 { color: white; background: #4FA4FF; } |
|
15 h3 { color: white; background: #00557F; } |
|
16 h4 { color: white; background: #00557F; } |
|
17 |
|
18 a { color: #AA5500; } |
|
19 |
|
20 </style> |
|
21 </head> |
|
22 <body><a NAME="top" ID="top"></a> |
|
23 <h1>eric4.Preferences.ShortcutDialog</h1> |
|
24 <p> |
|
25 Module implementing a dialog for the configuration of a keyboard shortcut. |
|
26 </p> |
|
27 <h3>Global Attributes</h3> |
|
28 <table> |
|
29 <tr><td>None</td></tr> |
|
30 </table> |
|
31 <h3>Classes</h3> |
|
32 <table> |
|
33 <tr> |
|
34 <td><a href="#ShortcutDialog">ShortcutDialog</a></td> |
|
35 <td>Class implementing a dialog for the configuration of a keyboard shortcut.</td> |
|
36 </tr> |
|
37 </table> |
|
38 <h3>Functions</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <hr /><hr /> |
|
43 <a NAME="ShortcutDialog" ID="ShortcutDialog"></a> |
|
44 <h2>ShortcutDialog</h2> |
|
45 <p> |
|
46 Class implementing a dialog for the configuration of a keyboard shortcut. |
|
47 </p><h4>Signals</h4> |
|
48 <dl> |
|
49 <dt>shortcutChanged(QKeySequence, QKeySequence, bool, objectType)</dt> |
|
50 <dd> |
|
51 emitted |
|
52 after the OK button was pressed |
|
53 </dd> |
|
54 </dl> |
|
55 <h3>Derived from</h3> |
|
56 QDialog, Ui_ShortcutDialog |
|
57 <h3>Class Attributes</h3> |
|
58 <table> |
|
59 <tr><td>None</td></tr> |
|
60 </table> |
|
61 <h3>Methods</h3> |
|
62 <table> |
|
63 <tr> |
|
64 <td><a href="#ShortcutDialog.__init__">ShortcutDialog</a></td> |
|
65 <td>Constructor</td> |
|
66 </tr><tr> |
|
67 <td><a href="#ShortcutDialog.__clear">__clear</a></td> |
|
68 <td>Private slot to handle the Clear button press.</td> |
|
69 </tr><tr> |
|
70 <td><a href="#ShortcutDialog.__setKeyLabelText">__setKeyLabelText</a></td> |
|
71 <td>Private method to set the text of a key label.</td> |
|
72 </tr><tr> |
|
73 <td><a href="#ShortcutDialog.__typeChanged">__typeChanged</a></td> |
|
74 <td>Private slot to handle the change of the shortcuts type.</td> |
|
75 </tr><tr> |
|
76 <td><a href="#ShortcutDialog.eventFilter">eventFilter</a></td> |
|
77 <td>Method called to filter the event queue.</td> |
|
78 </tr><tr> |
|
79 <td><a href="#ShortcutDialog.keyPressEvent">keyPressEvent</a></td> |
|
80 <td>Private method to handle a key press event.</td> |
|
81 </tr><tr> |
|
82 <td><a href="#ShortcutDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td> |
|
83 <td>Private slot to handle the OK button press.</td> |
|
84 </tr><tr> |
|
85 <td><a href="#ShortcutDialog.setKeys">setKeys</a></td> |
|
86 <td>Public method to set the key to be configured.</td> |
|
87 </tr> |
|
88 </table> |
|
89 <a NAME="ShortcutDialog.__init__" ID="ShortcutDialog.__init__"></a> |
|
90 <h4>ShortcutDialog (Constructor)</h4> |
|
91 <b>ShortcutDialog</b>(<i>parent = None, name = None, modal = False</i>) |
|
92 <p> |
|
93 Constructor |
|
94 </p><dl> |
|
95 <dt><i>parent</i></dt> |
|
96 <dd> |
|
97 The parent widget of this dialog. (QWidget) |
|
98 </dd><dt><i>name</i></dt> |
|
99 <dd> |
|
100 The name of this dialog. (string) |
|
101 </dd><dt><i>modal</i></dt> |
|
102 <dd> |
|
103 Flag indicating a modal dialog. (boolean) |
|
104 </dd> |
|
105 </dl><a NAME="ShortcutDialog.__clear" ID="ShortcutDialog.__clear"></a> |
|
106 <h4>ShortcutDialog.__clear</h4> |
|
107 <b>__clear</b>(<i></i>) |
|
108 <p> |
|
109 Private slot to handle the Clear button press. |
|
110 </p><a NAME="ShortcutDialog.__setKeyLabelText" ID="ShortcutDialog.__setKeyLabelText"></a> |
|
111 <h4>ShortcutDialog.__setKeyLabelText</h4> |
|
112 <b>__setKeyLabelText</b>(<i>txt</i>) |
|
113 <p> |
|
114 Private method to set the text of a key label. |
|
115 </p><dl> |
|
116 <dt><i>txt</i></dt> |
|
117 <dd> |
|
118 text to be set (string) |
|
119 </dd> |
|
120 </dl><a NAME="ShortcutDialog.__typeChanged" ID="ShortcutDialog.__typeChanged"></a> |
|
121 <h4>ShortcutDialog.__typeChanged</h4> |
|
122 <b>__typeChanged</b>(<i></i>) |
|
123 <p> |
|
124 Private slot to handle the change of the shortcuts type. |
|
125 </p><a NAME="ShortcutDialog.eventFilter" ID="ShortcutDialog.eventFilter"></a> |
|
126 <h4>ShortcutDialog.eventFilter</h4> |
|
127 <b>eventFilter</b>(<i>watched, event</i>) |
|
128 <p> |
|
129 Method called to filter the event queue. |
|
130 </p><dl> |
|
131 <dt><i>watched</i></dt> |
|
132 <dd> |
|
133 the QObject being watched |
|
134 </dd><dt><i>event</i></dt> |
|
135 <dd> |
|
136 the event that occurred |
|
137 </dd> |
|
138 </dl><dl> |
|
139 <dt>Returns:</dt> |
|
140 <dd> |
|
141 always False |
|
142 </dd> |
|
143 </dl><a NAME="ShortcutDialog.keyPressEvent" ID="ShortcutDialog.keyPressEvent"></a> |
|
144 <h4>ShortcutDialog.keyPressEvent</h4> |
|
145 <b>keyPressEvent</b>(<i>evt</i>) |
|
146 <p> |
|
147 Private method to handle a key press event. |
|
148 </p><dl> |
|
149 <dt><i>evt</i></dt> |
|
150 <dd> |
|
151 the key event (QKeyEvent) |
|
152 </dd> |
|
153 </dl><a NAME="ShortcutDialog.on_buttonBox_accepted" ID="ShortcutDialog.on_buttonBox_accepted"></a> |
|
154 <h4>ShortcutDialog.on_buttonBox_accepted</h4> |
|
155 <b>on_buttonBox_accepted</b>(<i></i>) |
|
156 <p> |
|
157 Private slot to handle the OK button press. |
|
158 </p><a NAME="ShortcutDialog.setKeys" ID="ShortcutDialog.setKeys"></a> |
|
159 <h4>ShortcutDialog.setKeys</h4> |
|
160 <b>setKeys</b>(<i>key, alternateKey, noCheck, objectType</i>) |
|
161 <p> |
|
162 Public method to set the key to be configured. |
|
163 </p><dl> |
|
164 <dt><i>key</i></dt> |
|
165 <dd> |
|
166 key sequence to be changed (QKeySequence) |
|
167 </dd><dt><i>alternateKey</i></dt> |
|
168 <dd> |
|
169 alternate key sequence to be changed (QKeySequence) |
|
170 </dd><dt><i>noCheck</i></dt> |
|
171 <dd> |
|
172 flag indicating that no uniqueness check should |
|
173 be performed (boolean) |
|
174 </dd><dt><i>objectType</i></dt> |
|
175 <dd> |
|
176 type of the object (string). |
|
177 </dd> |
|
178 </dl> |
|
179 <div align="right"><a href="#top">Up</a></div> |
|
180 <hr /> |
|
181 </body></html> |