Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Preferences.ShortcutsDialog.html
src/eric7/Documentation/Source/eric7.Preferences.ShortcutsDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10428
- a071d4065202
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Preferences.ShortcutsDialog</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.ShortcutsDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog for the configuration of eric's keyboard | |
| 13 shortcuts. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 | |
| 17 <table> | |
| 18 <tr><td>None</td></tr> | |
| 19 </table> | |
| 20 <h3>Classes</h3> | |
| 21 | |
| 22 <table> | |
| 23 | |
| 24 <tr> | |
| 25 <td><a href="#ShortcutsDialog">ShortcutsDialog</a></td> | |
| 26 <td>Class implementing a dialog for the configuration of eric's keyboard shortcuts.</td> | |
| 27 </tr> | |
| 28 </table> | |
| 29 <h3>Functions</h3> | |
| 30 | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <hr /> | |
| 35 <hr /> | |
| 36 <a NAME="ShortcutsDialog" ID="ShortcutsDialog"></a> | |
| 37 <h2>ShortcutsDialog</h2> | |
| 38 | |
| 39 <p> | |
| 40 Class implementing a dialog for the configuration of eric's keyboard | |
| 41 shortcuts. | |
| 42 </p> | |
| 43 <h3>Signals</h3> | |
| 44 <dl> | |
| 45 | |
| 46 <dt>updateShortcuts()</dt> | |
| 47 <dd> | |
| 48 emitted when the user pressed the dialogs OK | |
| 49 button | |
| 50 </dd> | |
| 51 </dl> | |
| 52 <h3>Derived from</h3> | |
| 53 QDialog, Ui_ShortcutsDialog | |
| 54 <h3>Class Attributes</h3> | |
| 55 | |
| 56 <table> | |
| 57 <tr><td>noCheckRole</td></tr><tr><td>objectNameRole</td></tr><tr><td>objectTypeRole</td></tr> | |
| 58 </table> | |
| 59 <h3>Class Methods</h3> | |
| 60 | |
| 61 <table> | |
| 62 <tr><td>None</td></tr> | |
| 63 </table> | |
| 64 <h3>Methods</h3> | |
| 65 | |
| 66 <table> | |
| 67 | |
| 68 <tr> | |
| 69 <td><a href="#ShortcutsDialog.__init__">ShortcutsDialog</a></td> | |
| 70 <td>Constructor</td> | |
| 71 </tr> | |
| 72 <tr> | |
| 73 <td><a href="#ShortcutsDialog.__checkShortcut">__checkShortcut</a></td> | |
| 74 <td>Private method to check a keysequence for uniqueness.</td> | |
| 75 </tr> | |
| 76 <tr> | |
| 77 <td><a href="#ShortcutsDialog.__generateCategoryItem">__generateCategoryItem</a></td> | |
| 78 <td>Private method to generate a category item.</td> | |
| 79 </tr> | |
| 80 <tr> | |
| 81 <td><a href="#ShortcutsDialog.__generateShortcutItem">__generateShortcutItem</a></td> | |
| 82 <td>Private method to generate a keyboard shortcut item.</td> | |
| 83 </tr> | |
| 84 <tr> | |
| 85 <td><a href="#ShortcutsDialog.__resizeColumns">__resizeColumns</a></td> | |
| 86 <td>Private method to resize the list columns.</td> | |
| 87 </tr> | |
| 88 <tr> | |
| 89 <td><a href="#ShortcutsDialog.__resort">__resort</a></td> | |
| 90 <td>Private method to resort the tree.</td> | |
| 91 </tr> | |
| 92 <tr> | |
| 93 <td><a href="#ShortcutsDialog.__saveCategoryActions">__saveCategoryActions</a></td> | |
| 94 <td>Private method to save the actions for a category.</td> | |
| 95 </tr> | |
| 96 <tr> | |
| 97 <td><a href="#ShortcutsDialog.__shortcutChanged">__shortcutChanged</a></td> | |
| 98 <td>Private slot to handle the shortcutChanged signal of the shortcut dialog.</td> | |
| 99 </tr> | |
| 100 <tr> | |
| 101 <td><a href="#ShortcutsDialog.on_actionButton_toggled">on_actionButton_toggled</a></td> | |
| 102 <td>Private slot called, when the action radio button is toggled.</td> | |
| 103 </tr> | |
| 104 <tr> | |
| 105 <td><a href="#ShortcutsDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td> | |
| 106 <td>Private slot to handle the OK button press.</td> | |
| 107 </tr> | |
| 108 <tr> | |
| 109 <td><a href="#ShortcutsDialog.on_searchEdit_textChanged">on_searchEdit_textChanged</a></td> | |
| 110 <td>Private slot called, when the text in the search edit changes.</td> | |
| 111 </tr> | |
| 112 <tr> | |
| 113 <td><a href="#ShortcutsDialog.on_shortcutButton_toggled">on_shortcutButton_toggled</a></td> | |
| 114 <td>Private slot called, when the shortcuts radio button is toggled.</td> | |
| 115 </tr> | |
| 116 <tr> | |
| 117 <td><a href="#ShortcutsDialog.on_shortcutsList_itemChanged">on_shortcutsList_itemChanged</a></td> | |
| 118 <td>Private slot to handle the edit of a shortcut key.</td> | |
| 119 </tr> | |
| 120 <tr> | |
| 121 <td><a href="#ShortcutsDialog.on_shortcutsList_itemClicked">on_shortcutsList_itemClicked</a></td> | |
| 122 <td>Private slot to handle a click in the shortcuts list.</td> | |
| 123 </tr> | |
| 124 <tr> | |
| 125 <td><a href="#ShortcutsDialog.on_shortcutsList_itemDoubleClicked">on_shortcutsList_itemDoubleClicked</a></td> | |
| 126 <td>Private slot to handle a double click in the shortcuts list.</td> | |
| 127 </tr> | |
| 128 <tr> | |
| 129 <td><a href="#ShortcutsDialog.populate">populate</a></td> | |
| 130 <td>Public method to populate the dialog.</td> | |
| 131 </tr> | |
| 132 </table> | |
| 133 <h3>Static Methods</h3> | |
| 134 | |
| 135 <table> | |
| 136 <tr><td>None</td></tr> | |
| 137 </table> | |
| 138 | |
| 139 <a NAME="ShortcutsDialog.__init__" ID="ShortcutsDialog.__init__"></a> | |
| 140 <h4>ShortcutsDialog (Constructor)</h4> | |
| 141 <b>ShortcutsDialog</b>(<i>parent=None</i>) | |
| 142 | |
| 143 <p> | |
| 144 Constructor | |
| 145 </p> | |
| 146 <dl> | |
| 147 | |
| 148 <dt><i>parent</i> (QWidget)</dt> | |
| 149 <dd> | |
| 150 parent widget of this dialog | |
| 151 </dd> | |
| 152 </dl> | |
| 153 <a NAME="ShortcutsDialog.__checkShortcut" ID="ShortcutsDialog.__checkShortcut"></a> | |
| 154 <h4>ShortcutsDialog.__checkShortcut</h4> | |
| 155 <b>__checkShortcut</b>(<i>keysequence, objectType, origTopItem</i>) | |
| 156 | |
| 157 <p> | |
| 158 Private method to check a keysequence for uniqueness. | |
| 159 </p> | |
| 160 <dl> | |
| 161 | |
| 162 <dt><i>keysequence</i></dt> | |
| 163 <dd> | |
| 164 the keysequence to check (QKeySequence) | |
| 165 </dd> | |
| 166 <dt><i>objectType</i></dt> | |
| 167 <dd> | |
| 168 type of the object (string). Entries with the same | |
| 169 object type are not checked for uniqueness. | |
| 170 </dd> | |
| 171 <dt><i>origTopItem</i></dt> | |
| 172 <dd> | |
| 173 refrence to the parent of the item to be checked | |
| 174 (QTreeWidgetItem) | |
| 175 </dd> | |
| 176 </dl> | |
| 177 <dl> | |
| 178 <dt>Return:</dt> | |
| 179 <dd> | |
| 180 flag indicating uniqueness (boolean) | |
| 181 </dd> | |
| 182 </dl> | |
| 183 <a NAME="ShortcutsDialog.__generateCategoryItem" ID="ShortcutsDialog.__generateCategoryItem"></a> | |
| 184 <h4>ShortcutsDialog.__generateCategoryItem</h4> | |
| 185 <b>__generateCategoryItem</b>(<i>title</i>) | |
| 186 | |
| 187 <p> | |
| 188 Private method to generate a category item. | |
| 189 </p> | |
| 190 <dl> | |
| 191 | |
| 192 <dt><i>title</i></dt> | |
| 193 <dd> | |
| 194 title for the item (string) | |
| 195 </dd> | |
| 196 </dl> | |
| 197 <dl> | |
| 198 <dt>Return:</dt> | |
| 199 <dd> | |
| 200 reference to the category item (QTreeWidgetItem) | |
| 201 </dd> | |
| 202 </dl> | |
| 203 <a NAME="ShortcutsDialog.__generateShortcutItem" ID="ShortcutsDialog.__generateShortcutItem"></a> | |
| 204 <h4>ShortcutsDialog.__generateShortcutItem</h4> | |
| 205 <b>__generateShortcutItem</b>(<i>category, action, noCheck=False, objectType=""</i>) | |
| 206 | |
| 207 <p> | |
| 208 Private method to generate a keyboard shortcut item. | |
| 209 </p> | |
| 210 <dl> | |
| 211 | |
| 212 <dt><i>category</i></dt> | |
| 213 <dd> | |
| 214 reference to the category item (QTreeWidgetItem) | |
| 215 </dd> | |
| 216 <dt><i>action</i></dt> | |
| 217 <dd> | |
| 218 reference to the keyboard action (EricAction) | |
| 219 </dd> | |
| 220 <dt><i>noCheck</i></dt> | |
| 221 <dd> | |
| 222 flag indicating that no uniqueness check should | |
| 223 be performed (boolean) | |
| 224 </dd> | |
| 225 <dt><i>objectType</i></dt> | |
| 226 <dd> | |
| 227 type of the object (string). Objects of the same | |
| 228 type are not checked for duplicate shortcuts. | |
| 229 </dd> | |
| 230 </dl> | |
| 231 <a NAME="ShortcutsDialog.__resizeColumns" ID="ShortcutsDialog.__resizeColumns"></a> | |
| 232 <h4>ShortcutsDialog.__resizeColumns</h4> | |
| 233 <b>__resizeColumns</b>(<i></i>) | |
| 234 | |
| 235 <p> | |
| 236 Private method to resize the list columns. | |
| 237 </p> | |
| 238 <a NAME="ShortcutsDialog.__resort" ID="ShortcutsDialog.__resort"></a> | |
| 239 <h4>ShortcutsDialog.__resort</h4> | |
| 240 <b>__resort</b>(<i></i>) | |
| 241 | |
| 242 <p> | |
| 243 Private method to resort the tree. | |
| 244 </p> | |
| 245 <a NAME="ShortcutsDialog.__saveCategoryActions" ID="ShortcutsDialog.__saveCategoryActions"></a> | |
| 246 <h4>ShortcutsDialog.__saveCategoryActions</h4> | |
| 247 <b>__saveCategoryActions</b>(<i>category, actions</i>) | |
| 248 | |
| 249 <p> | |
| 250 Private method to save the actions for a category. | |
| 251 </p> | |
| 252 <dl> | |
| 253 | |
| 254 <dt><i>category</i></dt> | |
| 255 <dd> | |
| 256 reference to the category item (QTreeWidgetItem) | |
| 257 </dd> | |
| 258 <dt><i>actions</i></dt> | |
| 259 <dd> | |
| 260 list of actions for the category (list of EricAction) | |
| 261 </dd> | |
| 262 </dl> | |
| 263 <a NAME="ShortcutsDialog.__shortcutChanged" ID="ShortcutsDialog.__shortcutChanged"></a> | |
| 264 <h4>ShortcutsDialog.__shortcutChanged</h4> | |
| 265 <b>__shortcutChanged</b>(<i>keysequence, altKeysequence, noCheck, objectType</i>) | |
| 266 | |
| 267 <p> | |
| 268 Private slot to handle the shortcutChanged signal of the shortcut | |
| 269 dialog. | |
| 270 </p> | |
| 271 <dl> | |
| 272 | |
| 273 <dt><i>keysequence</i></dt> | |
| 274 <dd> | |
| 275 the keysequence of the changed action (QKeySequence) | |
| 276 </dd> | |
| 277 <dt><i>altKeysequence</i></dt> | |
| 278 <dd> | |
| 279 the alternative keysequence of the changed | |
| 280 action (QKeySequence) | |
| 281 </dd> | |
| 282 <dt><i>noCheck</i></dt> | |
| 283 <dd> | |
| 284 flag indicating that no uniqueness check should | |
| 285 be performed (boolean) | |
| 286 </dd> | |
| 287 <dt><i>objectType</i></dt> | |
| 288 <dd> | |
| 289 type of the object (string). | |
| 290 </dd> | |
| 291 </dl> | |
| 292 <a NAME="ShortcutsDialog.on_actionButton_toggled" ID="ShortcutsDialog.on_actionButton_toggled"></a> | |
| 293 <h4>ShortcutsDialog.on_actionButton_toggled</h4> | |
| 294 <b>on_actionButton_toggled</b>(<i>checked</i>) | |
| 295 | |
| 296 <p> | |
| 297 Private slot called, when the action radio button is toggled. | |
| 298 </p> | |
| 299 <dl> | |
| 300 | |
| 301 <dt><i>checked</i></dt> | |
| 302 <dd> | |
| 303 state of the action radio button (boolean) | |
| 304 </dd> | |
| 305 </dl> | |
| 306 <a NAME="ShortcutsDialog.on_buttonBox_accepted" ID="ShortcutsDialog.on_buttonBox_accepted"></a> | |
| 307 <h4>ShortcutsDialog.on_buttonBox_accepted</h4> | |
| 308 <b>on_buttonBox_accepted</b>(<i></i>) | |
| 309 | |
| 310 <p> | |
| 311 Private slot to handle the OK button press. | |
| 312 </p> | |
| 313 <a NAME="ShortcutsDialog.on_searchEdit_textChanged" ID="ShortcutsDialog.on_searchEdit_textChanged"></a> | |
| 314 <h4>ShortcutsDialog.on_searchEdit_textChanged</h4> | |
| 315 <b>on_searchEdit_textChanged</b>(<i>txt</i>) | |
| 316 | |
| 317 <p> | |
| 318 Private slot called, when the text in the search edit changes. | |
| 319 </p> | |
| 320 <dl> | |
| 321 | |
| 322 <dt><i>txt</i></dt> | |
| 323 <dd> | |
| 324 text of the search edit (string) | |
| 325 </dd> | |
| 326 </dl> | |
| 327 <a NAME="ShortcutsDialog.on_shortcutButton_toggled" ID="ShortcutsDialog.on_shortcutButton_toggled"></a> | |
| 328 <h4>ShortcutsDialog.on_shortcutButton_toggled</h4> | |
| 329 <b>on_shortcutButton_toggled</b>(<i>checked</i>) | |
| 330 | |
| 331 <p> | |
| 332 Private slot called, when the shortcuts radio button is toggled. | |
| 333 </p> | |
| 334 <dl> | |
| 335 | |
| 336 <dt><i>checked</i></dt> | |
| 337 <dd> | |
| 338 state of the shortcuts radio button (boolean) | |
| 339 </dd> | |
| 340 </dl> | |
| 341 <a NAME="ShortcutsDialog.on_shortcutsList_itemChanged" ID="ShortcutsDialog.on_shortcutsList_itemChanged"></a> | |
| 342 <h4>ShortcutsDialog.on_shortcutsList_itemChanged</h4> | |
| 343 <b>on_shortcutsList_itemChanged</b>(<i>itm, column</i>) | |
| 344 | |
| 345 <p> | |
| 346 Private slot to handle the edit of a shortcut key. | |
| 347 </p> | |
| 348 <dl> | |
| 349 | |
| 350 <dt><i>itm</i></dt> | |
| 351 <dd> | |
| 352 reference to the item changed (QTreeWidgetItem) | |
| 353 </dd> | |
| 354 <dt><i>column</i></dt> | |
| 355 <dd> | |
| 356 column changed (integer) | |
| 357 </dd> | |
| 358 </dl> | |
| 359 <a NAME="ShortcutsDialog.on_shortcutsList_itemClicked" ID="ShortcutsDialog.on_shortcutsList_itemClicked"></a> | |
| 360 <h4>ShortcutsDialog.on_shortcutsList_itemClicked</h4> | |
| 361 <b>on_shortcutsList_itemClicked</b>(<i>itm, column</i>) | |
| 362 | |
| 363 <p> | |
| 364 Private slot to handle a click in the shortcuts list. | |
| 365 </p> | |
| 366 <dl> | |
| 367 | |
| 368 <dt><i>itm</i></dt> | |
| 369 <dd> | |
| 370 the list item that was clicked (QTreeWidgetItem) | |
| 371 </dd> | |
| 372 <dt><i>column</i></dt> | |
| 373 <dd> | |
| 374 the list item was clicked in (integer) | |
| 375 </dd> | |
| 376 </dl> | |
| 377 <a NAME="ShortcutsDialog.on_shortcutsList_itemDoubleClicked" ID="ShortcutsDialog.on_shortcutsList_itemDoubleClicked"></a> | |
| 378 <h4>ShortcutsDialog.on_shortcutsList_itemDoubleClicked</h4> | |
| 379 <b>on_shortcutsList_itemDoubleClicked</b>(<i>itm, column</i>) | |
| 380 | |
| 381 <p> | |
| 382 Private slot to handle a double click in the shortcuts list. | |
| 383 </p> | |
| 384 <dl> | |
| 385 | |
| 386 <dt><i>itm</i></dt> | |
| 387 <dd> | |
| 388 the list item that was double clicked (QTreeWidgetItem) | |
| 389 </dd> | |
| 390 <dt><i>column</i></dt> | |
| 391 <dd> | |
| 392 the list item was double clicked in (integer) | |
| 393 </dd> | |
| 394 </dl> | |
| 395 <a NAME="ShortcutsDialog.populate" ID="ShortcutsDialog.populate"></a> | |
| 396 <h4>ShortcutsDialog.populate</h4> | |
| 397 <b>populate</b>(<i>helpViewer=None</i>) | |
| 398 | |
| 399 <p> | |
| 400 Public method to populate the dialog. | |
| 401 </p> | |
| 402 <dl> | |
| 403 | |
| 404 <dt><i>helpViewer</i></dt> | |
| 405 <dd> | |
| 406 reference to the help window object | |
| 407 </dd> | |
| 408 </dl> | |
| 409 <div align="right"><a href="#top">Up</a></div> | |
| 410 <hr /> | |
| 411 </body></html> |
