Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Preferences.ShortcutsDialog.html

eric6/Documentation/Source/eric6.Preferences.ShortcutsDialog.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Preferences.ShortcutsDialog</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.ShortcutsDialog</h1>
23 <p>
24 Module implementing a dialog for the configuration of eric6's keyboard
25 shortcuts.
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="#ShortcutsDialog">ShortcutsDialog</a></td>
35 <td>Class implementing a dialog for the configuration of eric6's keyboard shortcuts.</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="ShortcutsDialog" ID="ShortcutsDialog"></a>
44 <h2>ShortcutsDialog</h2>
45 <p>
46 Class implementing a dialog for the configuration of eric6's keyboard
47 shortcuts.
48 </p><h3>Signals</h3>
49 <dl>
50 <dt>updateShortcuts()</dt>
51 <dd>
52 emitted when the user pressed the dialogs OK
53 button
54 </dd>
55 </dl>
56 <h3>Derived from</h3>
57 QDialog, Ui_ShortcutsDialog
58 <h3>Class Attributes</h3>
59 <table>
60 <tr><td>noCheckRole</td></tr><tr><td>objectNameRole</td></tr><tr><td>objectTypeRole</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66 <h3>Methods</h3>
67 <table>
68 <tr>
69 <td><a href="#ShortcutsDialog.__init__">ShortcutsDialog</a></td>
70 <td>Constructor</td>
71 </tr><tr>
72 <td><a href="#ShortcutsDialog.__checkShortcut">__checkShortcut</a></td>
73 <td>Private method to check a keysequence for uniqueness.</td>
74 </tr><tr>
75 <td><a href="#ShortcutsDialog.__generateCategoryItem">__generateCategoryItem</a></td>
76 <td>Private method to generate a category item.</td>
77 </tr><tr>
78 <td><a href="#ShortcutsDialog.__generateShortcutItem">__generateShortcutItem</a></td>
79 <td>Private method to generate a keyboard shortcut item.</td>
80 </tr><tr>
81 <td><a href="#ShortcutsDialog.__resizeColumns">__resizeColumns</a></td>
82 <td>Private method to resize the list columns.</td>
83 </tr><tr>
84 <td><a href="#ShortcutsDialog.__resort">__resort</a></td>
85 <td>Private method to resort the tree.</td>
86 </tr><tr>
87 <td><a href="#ShortcutsDialog.__saveCategoryActions">__saveCategoryActions</a></td>
88 <td>Private method to save the actions for a category.</td>
89 </tr><tr>
90 <td><a href="#ShortcutsDialog.__shortcutChanged">__shortcutChanged</a></td>
91 <td>Private slot to handle the shortcutChanged signal of the shortcut dialog.</td>
92 </tr><tr>
93 <td><a href="#ShortcutsDialog.on_actionButton_toggled">on_actionButton_toggled</a></td>
94 <td>Private slot called, when the action radio button is toggled.</td>
95 </tr><tr>
96 <td><a href="#ShortcutsDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td>
97 <td>Private slot to handle the OK button press.</td>
98 </tr><tr>
99 <td><a href="#ShortcutsDialog.on_searchEdit_textChanged">on_searchEdit_textChanged</a></td>
100 <td>Private slot called, when the text in the search edit changes.</td>
101 </tr><tr>
102 <td><a href="#ShortcutsDialog.on_shortcutButton_toggled">on_shortcutButton_toggled</a></td>
103 <td>Private slot called, when the shortcuts radio button is toggled.</td>
104 </tr><tr>
105 <td><a href="#ShortcutsDialog.on_shortcutsList_itemChanged">on_shortcutsList_itemChanged</a></td>
106 <td>Private slot to handle the edit of a shortcut key.</td>
107 </tr><tr>
108 <td><a href="#ShortcutsDialog.on_shortcutsList_itemClicked">on_shortcutsList_itemClicked</a></td>
109 <td>Private slot to handle a click in the shortcuts list.</td>
110 </tr><tr>
111 <td><a href="#ShortcutsDialog.on_shortcutsList_itemDoubleClicked">on_shortcutsList_itemDoubleClicked</a></td>
112 <td>Private slot to handle a double click in the shortcuts list.</td>
113 </tr><tr>
114 <td><a href="#ShortcutsDialog.populate">populate</a></td>
115 <td>Public method to populate the dialog.</td>
116 </tr>
117 </table>
118 <h3>Static Methods</h3>
119 <table>
120 <tr><td>None</td></tr>
121 </table>
122 <a NAME="ShortcutsDialog.__init__" ID="ShortcutsDialog.__init__"></a>
123 <h4>ShortcutsDialog (Constructor)</h4>
124 <b>ShortcutsDialog</b>(<i>parent=None</i>)
125 <p>
126 Constructor
127 </p><dl>
128 <dt><i>parent</i> (QWidget)</dt>
129 <dd>
130 parent widget of this dialog
131 </dd>
132 </dl><a NAME="ShortcutsDialog.__checkShortcut" ID="ShortcutsDialog.__checkShortcut"></a>
133 <h4>ShortcutsDialog.__checkShortcut</h4>
134 <b>__checkShortcut</b>(<i>keysequence, objectType, origTopItem</i>)
135 <p>
136 Private method to check a keysequence for uniqueness.
137 </p><dl>
138 <dt><i>keysequence</i></dt>
139 <dd>
140 the keysequence to check (QKeySequence)
141 </dd><dt><i>objectType</i></dt>
142 <dd>
143 type of the object (string). Entries with the same
144 object type are not checked for uniqueness.
145 </dd><dt><i>origTopItem</i></dt>
146 <dd>
147 refrence to the parent of the item to be checked
148 (QTreeWidgetItem)
149 </dd>
150 </dl><dl>
151 <dt>Returns:</dt>
152 <dd>
153 flag indicating uniqueness (boolean)
154 </dd>
155 </dl><a NAME="ShortcutsDialog.__generateCategoryItem" ID="ShortcutsDialog.__generateCategoryItem"></a>
156 <h4>ShortcutsDialog.__generateCategoryItem</h4>
157 <b>__generateCategoryItem</b>(<i>title</i>)
158 <p>
159 Private method to generate a category item.
160 </p><dl>
161 <dt><i>title</i></dt>
162 <dd>
163 title for the item (string)
164 </dd>
165 </dl><dl>
166 <dt>Returns:</dt>
167 <dd>
168 reference to the category item (QTreeWidgetItem)
169 </dd>
170 </dl><a NAME="ShortcutsDialog.__generateShortcutItem" ID="ShortcutsDialog.__generateShortcutItem"></a>
171 <h4>ShortcutsDialog.__generateShortcutItem</h4>
172 <b>__generateShortcutItem</b>(<i>category, action, noCheck=False, objectType=""</i>)
173 <p>
174 Private method to generate a keyboard shortcut item.
175 </p><dl>
176 <dt><i>category</i></dt>
177 <dd>
178 reference to the category item (QTreeWidgetItem)
179 </dd><dt><i>action</i></dt>
180 <dd>
181 reference to the keyboard action (E5Action)
182 </dd><dt><i>noCheck=</i></dt>
183 <dd>
184 flag indicating that no uniqueness check should
185 be performed (boolean)
186 </dd><dt><i>objectType=</i></dt>
187 <dd>
188 type of the object (string). Objects of the same
189 type are not checked for duplicate shortcuts.
190 </dd>
191 </dl><a NAME="ShortcutsDialog.__resizeColumns" ID="ShortcutsDialog.__resizeColumns"></a>
192 <h4>ShortcutsDialog.__resizeColumns</h4>
193 <b>__resizeColumns</b>(<i></i>)
194 <p>
195 Private method to resize the list columns.
196 </p><a NAME="ShortcutsDialog.__resort" ID="ShortcutsDialog.__resort"></a>
197 <h4>ShortcutsDialog.__resort</h4>
198 <b>__resort</b>(<i></i>)
199 <p>
200 Private method to resort the tree.
201 </p><a NAME="ShortcutsDialog.__saveCategoryActions" ID="ShortcutsDialog.__saveCategoryActions"></a>
202 <h4>ShortcutsDialog.__saveCategoryActions</h4>
203 <b>__saveCategoryActions</b>(<i>category, actions</i>)
204 <p>
205 Private method to save the actions for a category.
206 </p><dl>
207 <dt><i>category</i></dt>
208 <dd>
209 reference to the category item (QTreeWidgetItem)
210 </dd><dt><i>actions</i></dt>
211 <dd>
212 list of actions for the category (list of E5Action)
213 </dd>
214 </dl><a NAME="ShortcutsDialog.__shortcutChanged" ID="ShortcutsDialog.__shortcutChanged"></a>
215 <h4>ShortcutsDialog.__shortcutChanged</h4>
216 <b>__shortcutChanged</b>(<i>keysequence, altKeysequence, noCheck, objectType</i>)
217 <p>
218 Private slot to handle the shortcutChanged signal of the shortcut
219 dialog.
220 </p><dl>
221 <dt><i>keysequence</i></dt>
222 <dd>
223 the keysequence of the changed action (QKeySequence)
224 </dd><dt><i>altKeysequence</i></dt>
225 <dd>
226 the alternative keysequence of the changed
227 action (QKeySequence)
228 </dd><dt><i>noCheck</i></dt>
229 <dd>
230 flag indicating that no uniqueness check should
231 be performed (boolean)
232 </dd><dt><i>objectType</i></dt>
233 <dd>
234 type of the object (string).
235 </dd>
236 </dl><a NAME="ShortcutsDialog.on_actionButton_toggled" ID="ShortcutsDialog.on_actionButton_toggled"></a>
237 <h4>ShortcutsDialog.on_actionButton_toggled</h4>
238 <b>on_actionButton_toggled</b>(<i>checked</i>)
239 <p>
240 Private slot called, when the action radio button is toggled.
241 </p><dl>
242 <dt><i>checked</i></dt>
243 <dd>
244 state of the action radio button (boolean)
245 </dd>
246 </dl><a NAME="ShortcutsDialog.on_buttonBox_accepted" ID="ShortcutsDialog.on_buttonBox_accepted"></a>
247 <h4>ShortcutsDialog.on_buttonBox_accepted</h4>
248 <b>on_buttonBox_accepted</b>(<i></i>)
249 <p>
250 Private slot to handle the OK button press.
251 </p><a NAME="ShortcutsDialog.on_searchEdit_textChanged" ID="ShortcutsDialog.on_searchEdit_textChanged"></a>
252 <h4>ShortcutsDialog.on_searchEdit_textChanged</h4>
253 <b>on_searchEdit_textChanged</b>(<i>txt</i>)
254 <p>
255 Private slot called, when the text in the search edit changes.
256 </p><dl>
257 <dt><i>txt</i></dt>
258 <dd>
259 text of the search edit (string)
260 </dd>
261 </dl><a NAME="ShortcutsDialog.on_shortcutButton_toggled" ID="ShortcutsDialog.on_shortcutButton_toggled"></a>
262 <h4>ShortcutsDialog.on_shortcutButton_toggled</h4>
263 <b>on_shortcutButton_toggled</b>(<i>checked</i>)
264 <p>
265 Private slot called, when the shortcuts radio button is toggled.
266 </p><dl>
267 <dt><i>checked</i></dt>
268 <dd>
269 state of the shortcuts radio button (boolean)
270 </dd>
271 </dl><a NAME="ShortcutsDialog.on_shortcutsList_itemChanged" ID="ShortcutsDialog.on_shortcutsList_itemChanged"></a>
272 <h4>ShortcutsDialog.on_shortcutsList_itemChanged</h4>
273 <b>on_shortcutsList_itemChanged</b>(<i>itm, column</i>)
274 <p>
275 Private slot to handle the edit of a shortcut key.
276 </p><dl>
277 <dt><i>itm</i></dt>
278 <dd>
279 reference to the item changed (QTreeWidgetItem)
280 </dd><dt><i>column</i></dt>
281 <dd>
282 column changed (integer)
283 </dd>
284 </dl><a NAME="ShortcutsDialog.on_shortcutsList_itemClicked" ID="ShortcutsDialog.on_shortcutsList_itemClicked"></a>
285 <h4>ShortcutsDialog.on_shortcutsList_itemClicked</h4>
286 <b>on_shortcutsList_itemClicked</b>(<i>itm, column</i>)
287 <p>
288 Private slot to handle a click in the shortcuts list.
289 </p><dl>
290 <dt><i>itm</i></dt>
291 <dd>
292 the list item that was clicked (QTreeWidgetItem)
293 </dd><dt><i>column</i></dt>
294 <dd>
295 the list item was clicked in (integer)
296 </dd>
297 </dl><a NAME="ShortcutsDialog.on_shortcutsList_itemDoubleClicked" ID="ShortcutsDialog.on_shortcutsList_itemDoubleClicked"></a>
298 <h4>ShortcutsDialog.on_shortcutsList_itemDoubleClicked</h4>
299 <b>on_shortcutsList_itemDoubleClicked</b>(<i>itm, column</i>)
300 <p>
301 Private slot to handle a double click in the shortcuts list.
302 </p><dl>
303 <dt><i>itm</i></dt>
304 <dd>
305 the list item that was double clicked (QTreeWidgetItem)
306 </dd><dt><i>column</i></dt>
307 <dd>
308 the list item was double clicked in (integer)
309 </dd>
310 </dl><a NAME="ShortcutsDialog.populate" ID="ShortcutsDialog.populate"></a>
311 <h4>ShortcutsDialog.populate</h4>
312 <b>populate</b>(<i>helpViewer=None</i>)
313 <p>
314 Public method to populate the dialog.
315 </p><dl>
316 <dt><i>helpViewer</i></dt>
317 <dd>
318 reference to the help window object
319 </dd>
320 </dl>
321 <div align="right"><a href="#top">Up</a></div>
322 <hr />
323 </body></html>

Mercurial Repository: eric

eric ide

mercurial