Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QScintilla.Editor.html
src/eric7/Documentation/Source/eric7.QScintilla.Editor.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 9097
- 213951c41dcd
- child 9215
- 30d7f7fd2b4a
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.QScintilla.Editor</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.QScintilla.Editor</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the editor component of the eric IDE. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>EditorAutoCompletionListID</td></tr><tr><td>ReferenceItem</td></tr><tr><td>ReferencesListID</td></tr><tr><td>TemplateCompletionListID</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#Editor">Editor</a></td> | |
| 25 <td>Class implementing the editor component of the eric IDE.</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="Editor" ID="Editor"></a> | |
| 36 <h2>Editor</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the editor component of the eric IDE. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>autoCompletionAPIsAvailable(bool)</dt> | |
| 45 <dd> | |
| 46 emitted after the autocompletion | |
| 47 function has been configured | |
| 48 </dd> | |
| 49 <dt>bookmarkToggled(QsciScintillaCompat)</dt> | |
| 50 <dd> | |
| 51 emitted when a bookmark is | |
| 52 toggled | |
| 53 </dd> | |
| 54 <dt>breakpointToggled(QsciScintillaCompat)</dt> | |
| 55 <dd> | |
| 56 emitted when a breakpoint | |
| 57 is toggled | |
| 58 </dd> | |
| 59 <dt>captionChanged(str, QsciScintillaCompat)</dt> | |
| 60 <dd> | |
| 61 emitted when the caption | |
| 62 is updated. Typically due to a readOnly attribute change. | |
| 63 </dd> | |
| 64 <dt>changeMarkersUpdated(QsciScintillaCompat)</dt> | |
| 65 <dd> | |
| 66 emitted when the change | |
| 67 markers were updated | |
| 68 </dd> | |
| 69 <dt>coverageMarkersShown(bool)</dt> | |
| 70 <dd> | |
| 71 emitted after the coverage markers have | |
| 72 been shown or cleared | |
| 73 </dd> | |
| 74 <dt>cursorChanged(str, int, int)</dt> | |
| 75 <dd> | |
| 76 emitted when the cursor position | |
| 77 was changed | |
| 78 </dd> | |
| 79 <dt>cursorLineChanged(int)</dt> | |
| 80 <dd> | |
| 81 emitted when the cursor line was changed | |
| 82 </dd> | |
| 83 <dt>editorAboutToBeSaved(str)</dt> | |
| 84 <dd> | |
| 85 emitted before the editor is saved | |
| 86 </dd> | |
| 87 <dt>editorRenamed(str)</dt> | |
| 88 <dd> | |
| 89 emitted after the editor got a new name | |
| 90 (i.e. after a 'Save As') | |
| 91 </dd> | |
| 92 <dt>editorSaved(str)</dt> | |
| 93 <dd> | |
| 94 emitted after the editor has been saved | |
| 95 </dd> | |
| 96 <dt>encodingChanged(str)</dt> | |
| 97 <dd> | |
| 98 emitted when the editors encoding was set. The | |
| 99 encoding name is passed as a parameter. | |
| 100 </dd> | |
| 101 <dt>eolChanged(str)</dt> | |
| 102 <dd> | |
| 103 emitted when the editors eol type was set. The eol | |
| 104 string is passed as a parameter. | |
| 105 </dd> | |
| 106 <dt>languageChanged(str)</dt> | |
| 107 <dd> | |
| 108 emitted when the editors language was set. The | |
| 109 language is passed as a parameter. | |
| 110 </dd> | |
| 111 <dt>lastEditPositionAvailable()</dt> | |
| 112 <dd> | |
| 113 emitted when a last edit position is | |
| 114 available | |
| 115 </dd> | |
| 116 <dt>modificationStatusChanged(bool, QsciScintillaCompat)</dt> | |
| 117 <dd> | |
| 118 emitted when | |
| 119 the modification status has changed | |
| 120 </dd> | |
| 121 <dt>mouseDoubleClick(position, buttons)</dt> | |
| 122 <dd> | |
| 123 emitted to signal a mouse | |
| 124 double click somewhere in the editor area | |
| 125 </dd> | |
| 126 <dt>redoAvailable(bool)</dt> | |
| 127 <dd> | |
| 128 emitted to signal the redo availability | |
| 129 </dd> | |
| 130 <dt>refreshed()</dt> | |
| 131 <dd> | |
| 132 emitted to signal a refresh of the editor contents | |
| 133 </dd> | |
| 134 <dt>settingsRead()</dt> | |
| 135 <dd> | |
| 136 emitted to signal, that the settings have been read | |
| 137 and set | |
| 138 </dd> | |
| 139 <dt>showMenu(str, QMenu, QsciScintillaCompat)</dt> | |
| 140 <dd> | |
| 141 emitted when a menu is | |
| 142 about to be shown. The name of the menu, a reference to the menu and | |
| 143 a reference to the editor are given. | |
| 144 </dd> | |
| 145 <dt>spellLanguageChanged(str)</dt> | |
| 146 <dd> | |
| 147 emitted when the editor spell check | |
| 148 language was set. The language is passed as a parameter. | |
| 149 </dd> | |
| 150 <dt>syntaxerrorToggled(QsciScintillaCompat)</dt> | |
| 151 <dd> | |
| 152 emitted when a syntax error | |
| 153 was discovered | |
| 154 </dd> | |
| 155 <dt>taskMarkersUpdated(QsciScintillaCompat)</dt> | |
| 156 <dd> | |
| 157 emitted when the task | |
| 158 markers were updated | |
| 159 </dd> | |
| 160 <dt>undoAvailable(bool)</dt> | |
| 161 <dd> | |
| 162 emitted to signal the undo availability | |
| 163 </dd> | |
| 164 </dl> | |
| 165 <h3>Derived from</h3> | |
| 166 QsciScintillaCompat | |
| 167 <h3>Class Attributes</h3> | |
| 168 | |
| 169 <table> | |
| 170 <tr><td>AttributeID</td></tr><tr><td>AttributePrivateID</td></tr><tr><td>AttributeProtectedID</td></tr><tr><td>CancelEditToken</td></tr><tr><td>ClassID</td></tr><tr><td>ClassPrivateID</td></tr><tr><td>ClassProtectedID</td></tr><tr><td>EncloseChars</td></tr><tr><td>EndEditToken</td></tr><tr><td>EnumID</td></tr><tr><td>FromDocumentID</td></tr><tr><td>KeywordsID</td></tr><tr><td>MethodID</td></tr><tr><td>MethodPrivateID</td></tr><tr><td>MethodProtectedID</td></tr><tr><td>ModuleID</td></tr><tr><td>RequestSyncToken</td></tr><tr><td>Separator</td></tr><tr><td>StartEditToken</td></tr><tr><td>SyncToken</td></tr><tr><td>TemplateImageID</td></tr><tr><td>VcsConflictMarkerLineRegExpList</td></tr><tr><td>WarningCode</td></tr><tr><td>WarningStyle</td></tr> | |
| 171 </table> | |
| 172 <h3>Class Methods</h3> | |
| 173 | |
| 174 <table> | |
| 175 <tr><td>None</td></tr> | |
| 176 </table> | |
| 177 <h3>Methods</h3> | |
| 178 | |
| 179 <table> | |
| 180 | |
| 181 <tr> | |
| 182 <td><a href="#Editor.__init__">Editor</a></td> | |
| 183 <td>Constructor</td> | |
| 184 </tr> | |
| 185 <tr> | |
| 186 <td><a href="#Editor.__addBreakPoint">__addBreakPoint</a></td> | |
| 187 <td>Private method to add a new breakpoint.</td> | |
| 188 </tr> | |
| 189 <tr> | |
| 190 <td><a href="#Editor.__addBreakPoints">__addBreakPoints</a></td> | |
| 191 <td>Private slot to add breakpoints.</td> | |
| 192 </tr> | |
| 193 <tr> | |
| 194 <td><a href="#Editor.__addFileAliasResource">__addFileAliasResource</a></td> | |
| 195 <td>Private method to handle the Add aliased file context menu action.</td> | |
| 196 </tr> | |
| 197 <tr> | |
| 198 <td><a href="#Editor.__addFileResource">__addFileResource</a></td> | |
| 199 <td>Private method to handle the Add file context menu action.</td> | |
| 200 </tr> | |
| 201 <tr> | |
| 202 <td><a href="#Editor.__addFileResources">__addFileResources</a></td> | |
| 203 <td>Private method to handle the Add files context menu action.</td> | |
| 204 </tr> | |
| 205 <tr> | |
| 206 <td><a href="#Editor.__addLocalizedResource">__addLocalizedResource</a></td> | |
| 207 <td>Private method to handle the Add localized resource context menu action.</td> | |
| 208 </tr> | |
| 209 <tr> | |
| 210 <td><a href="#Editor.__addResourceFrame">__addResourceFrame</a></td> | |
| 211 <td>Private method to handle the Add resource frame context menu action.</td> | |
| 212 </tr> | |
| 213 <tr> | |
| 214 <td><a href="#Editor.__addToSpellingDictionary">__addToSpellingDictionary</a></td> | |
| 215 <td>Private slot to add the word below the spelling context menu to the dictionary.</td> | |
| 216 </tr> | |
| 217 <tr> | |
| 218 <td><a href="#Editor.__adjustedCallTipPosition">__adjustedCallTipPosition</a></td> | |
| 219 <td>Private method to calculate an adjusted position for showing calltips.</td> | |
| 220 </tr> | |
| 221 <tr> | |
| 222 <td><a href="#Editor.__applyTemplate">__applyTemplate</a></td> | |
| 223 <td>Private method to apply a template by name.</td> | |
| 224 </tr> | |
| 225 <tr> | |
| 226 <td><a href="#Editor.__autoComplete">__autoComplete</a></td> | |
| 227 <td>Private method to start auto-completion via plug-ins.</td> | |
| 228 </tr> | |
| 229 <tr> | |
| 230 <td><a href="#Editor.__autocompletionCancelled">__autocompletionCancelled</a></td> | |
| 231 <td>Private slot to handle the cancellation of an auto-completion list.</td> | |
| 232 </tr> | |
| 233 <tr> | |
| 234 <td><a href="#Editor.__autosaveEnable">__autosaveEnable</a></td> | |
| 235 <td>Private slot handling the autosave enable context menu action.</td> | |
| 236 </tr> | |
| 237 <tr> | |
| 238 <td><a href="#Editor.__bindCompleter">__bindCompleter</a></td> | |
| 239 <td>Private slot to set the correct typing completer depending on language.</td> | |
| 240 </tr> | |
| 241 <tr> | |
| 242 <td><a href="#Editor.__bindLexer">__bindLexer</a></td> | |
| 243 <td>Private slot to set the correct lexer depending on language.</td> | |
| 244 </tr> | |
| 245 <tr> | |
| 246 <td><a href="#Editor.__bindName">__bindName</a></td> | |
| 247 <td>Private method to generate a dummy filename for binding a lexer.</td> | |
| 248 </tr> | |
| 249 <tr> | |
| 250 <td><a href="#Editor.__breakPointDataAboutToBeChanged">__breakPointDataAboutToBeChanged</a></td> | |
| 251 <td>Private slot to handle the dataAboutToBeChanged signal of the breakpoint model.</td> | |
| 252 </tr> | |
| 253 <tr> | |
| 254 <td><a href="#Editor.__calculateChanges">__calculateChanges</a></td> | |
| 255 <td>Private method to determine change commands to convert old text into new text.</td> | |
| 256 </tr> | |
| 257 <tr> | |
| 258 <td><a href="#Editor.__callTip">__callTip</a></td> | |
| 259 <td>Private method to show call tips provided by a plugin.</td> | |
| 260 </tr> | |
| 261 <tr> | |
| 262 <td><a href="#Editor.__cancelMouseHoverHelp">__cancelMouseHoverHelp</a></td> | |
| 263 <td>Private slot cancelling the display of mouse hover help.</td> | |
| 264 </tr> | |
| 265 <tr> | |
| 266 <td><a href="#Editor.__changeBreakPoints">__changeBreakPoints</a></td> | |
| 267 <td>Private slot to set changed breakpoints.</td> | |
| 268 </tr> | |
| 269 <tr> | |
| 270 <td><a href="#Editor.__charAdded">__charAdded</a></td> | |
| 271 <td>Private slot called to handle the user entering a character.</td> | |
| 272 </tr> | |
| 273 <tr> | |
| 274 <td><a href="#Editor.__checkEncoding">__checkEncoding</a></td> | |
| 275 <td>Private method to check the selected encoding of the encodings submenu.</td> | |
| 276 </tr> | |
| 277 <tr> | |
| 278 <td><a href="#Editor.__checkEol">__checkEol</a></td> | |
| 279 <td>Private method to check the selected eol type of the eol submenu.</td> | |
| 280 </tr> | |
| 281 <tr> | |
| 282 <td><a href="#Editor.__checkLanguage">__checkLanguage</a></td> | |
| 283 <td>Private method to check the selected language of the language submenu.</td> | |
| 284 </tr> | |
| 285 <tr> | |
| 286 <td><a href="#Editor.__checkSpellLanguage">__checkSpellLanguage</a></td> | |
| 287 <td>Private slot to check the selected spell check language action.</td> | |
| 288 </tr> | |
| 289 <tr> | |
| 290 <td><a href="#Editor.__checkSpellingSelection">__checkSpellingSelection</a></td> | |
| 291 <td>Private slot to spell check the current selection.</td> | |
| 292 </tr> | |
| 293 <tr> | |
| 294 <td><a href="#Editor.__checkSpellingWord">__checkSpellingWord</a></td> | |
| 295 <td>Private slot to check the word below the spelling context menu.</td> | |
| 296 </tr> | |
| 297 <tr> | |
| 298 <td><a href="#Editor.__clearBreakpoints">__clearBreakpoints</a></td> | |
| 299 <td>Private slot to clear all breakpoints.</td> | |
| 300 </tr> | |
| 301 <tr> | |
| 302 <td><a href="#Editor.__clearCompletionsCache">__clearCompletionsCache</a></td> | |
| 303 <td>Private method to clear the auto-completions cache.</td> | |
| 304 </tr> | |
| 305 <tr> | |
| 306 <td><a href="#Editor.__clearTypedWarning">__clearTypedWarning</a></td> | |
| 307 <td>Private method to clear warnings of a specific kind.</td> | |
| 308 </tr> | |
| 309 <tr> | |
| 310 <td><a href="#Editor.__codeCoverageHideAnnotations">__codeCoverageHideAnnotations</a></td> | |
| 311 <td>Private method to handle the hide code coverage annotations context menu action.</td> | |
| 312 </tr> | |
| 313 <tr> | |
| 314 <td><a href="#Editor.__completionListSelected">__completionListSelected</a></td> | |
| 315 <td>Private slot to handle the selection from the completion list.</td> | |
| 316 </tr> | |
| 317 <tr> | |
| 318 <td><a href="#Editor.__contextClose">__contextClose</a></td> | |
| 319 <td>Private slot handling the close context menu entry.</td> | |
| 320 </tr> | |
| 321 <tr> | |
| 322 <td><a href="#Editor.__contextMenuCollapseFoldWithChildren">__contextMenuCollapseFoldWithChildren</a></td> | |
| 323 <td>Private slot to handle the context menu collapse with children action.</td> | |
| 324 </tr> | |
| 325 <tr> | |
| 326 <td><a href="#Editor.__contextMenuExpandFoldWithChildren">__contextMenuExpandFoldWithChildren</a></td> | |
| 327 <td>Private slot to handle the context menu expand with children action.</td> | |
| 328 </tr> | |
| 329 <tr> | |
| 330 <td><a href="#Editor.__contextMenuSpellingTriggered">__contextMenuSpellingTriggered</a></td> | |
| 331 <td>Private slot to handle the selection of a suggestion of the spelling context menu.</td> | |
| 332 </tr> | |
| 333 <tr> | |
| 334 <td><a href="#Editor.__contextSave">__contextSave</a></td> | |
| 335 <td>Private slot handling the save context menu entry.</td> | |
| 336 </tr> | |
| 337 <tr> | |
| 338 <td><a href="#Editor.__contextSaveAs">__contextSaveAs</a></td> | |
| 339 <td>Private slot handling the save as context menu entry.</td> | |
| 340 </tr> | |
| 341 <tr> | |
| 342 <td><a href="#Editor.__contextSaveCopy">__contextSaveCopy</a></td> | |
| 343 <td>Private slot handling the save copy context menu entry.</td> | |
| 344 </tr> | |
| 345 <tr> | |
| 346 <td><a href="#Editor.__convertTabs">__convertTabs</a></td> | |
| 347 <td>Private slot to convert tabulators to spaces.</td> | |
| 348 </tr> | |
| 349 <tr> | |
| 350 <td><a href="#Editor.__createChangeMarkerPixmap">__createChangeMarkerPixmap</a></td> | |
| 351 <td>Private method to create a pixmap for the change markers.</td> | |
| 352 </tr> | |
| 353 <tr> | |
| 354 <td><a href="#Editor.__cursorPositionChanged">__cursorPositionChanged</a></td> | |
| 355 <td>Private slot to handle the cursorPositionChanged signal.</td> | |
| 356 </tr> | |
| 357 <tr> | |
| 358 <td><a href="#Editor.__delayedDocstringMenuPopup">__delayedDocstringMenuPopup</a></td> | |
| 359 <td>Private method to test, if the user might want to insert a docstring.</td> | |
| 360 </tr> | |
| 361 <tr> | |
| 362 <td><a href="#Editor.__deleteAllChangeMarkers">__deleteAllChangeMarkers</a></td> | |
| 363 <td>Private slot to delete all change markers.</td> | |
| 364 </tr> | |
| 365 <tr> | |
| 366 <td><a href="#Editor.__deleteBreakPoints">__deleteBreakPoints</a></td> | |
| 367 <td>Private slot to delete breakpoints.</td> | |
| 368 </tr> | |
| 369 <tr> | |
| 370 <td><a href="#Editor.__deselectAll">__deselectAll</a></td> | |
| 371 <td>Private slot handling the deselect all context menu action.</td> | |
| 372 </tr> | |
| 373 <tr> | |
| 374 <td><a href="#Editor.__dispatchCommand">__dispatchCommand</a></td> | |
| 375 <td>Private method to dispatch received commands.</td> | |
| 376 </tr> | |
| 377 <tr> | |
| 378 <td><a href="#Editor.__encodingChanged">__encodingChanged</a></td> | |
| 379 <td>Private slot to handle a change of the encoding.</td> | |
| 380 </tr> | |
| 381 <tr> | |
| 382 <td><a href="#Editor.__encodingsMenuTriggered">__encodingsMenuTriggered</a></td> | |
| 383 <td>Private method to handle the selection of an encoding.</td> | |
| 384 </tr> | |
| 385 <tr> | |
| 386 <td><a href="#Editor.__eolChanged">__eolChanged</a></td> | |
| 387 <td>Private slot to handle a change of the eol mode.</td> | |
| 388 </tr> | |
| 389 <tr> | |
| 390 <td><a href="#Editor.__eolMenuTriggered">__eolMenuTriggered</a></td> | |
| 391 <td>Private method to handle the selection of an eol type.</td> | |
| 392 </tr> | |
| 393 <tr> | |
| 394 <td><a href="#Editor.__executeSelection">__executeSelection</a></td> | |
| 395 <td>Private slot to execute the selected text in the shell window.</td> | |
| 396 </tr> | |
| 397 <tr> | |
| 398 <td><a href="#Editor.__getAcText">__getAcText</a></td> | |
| 399 <td>Private method to get the text from cursor position for autocompleting.</td> | |
| 400 </tr> | |
| 401 <tr> | |
| 402 <td><a href="#Editor.__getCharacter">__getCharacter</a></td> | |
| 403 <td>Private method to get the character to the left of the current position in the current line.</td> | |
| 404 </tr> | |
| 405 <tr> | |
| 406 <td><a href="#Editor.__getCodeCoverageFile">__getCodeCoverageFile</a></td> | |
| 407 <td>Private method to get the file name of the file containing coverage info.</td> | |
| 408 </tr> | |
| 409 <tr> | |
| 410 <td><a href="#Editor.__getEditorConfig">__getEditorConfig</a></td> | |
| 411 <td>Private method to get the requested option via EditorConfig.</td> | |
| 412 </tr> | |
| 413 <tr> | |
| 414 <td><a href="#Editor.__getMacroName">__getMacroName</a></td> | |
| 415 <td>Private method to select a macro name from the list of macros.</td> | |
| 416 </tr> | |
| 417 <tr> | |
| 418 <td><a href="#Editor.__getOverrideValue">__getOverrideValue</a></td> | |
| 419 <td>Private method to get an override value for the current file type.</td> | |
| 420 </tr> | |
| 421 <tr> | |
| 422 <td><a href="#Editor.__getPyVersion">__getPyVersion</a></td> | |
| 423 <td>Private method to return the Python main version or 0 if it's not a Python file at all.</td> | |
| 424 </tr> | |
| 425 <tr> | |
| 426 <td><a href="#Editor.__getSaveFileName">__getSaveFileName</a></td> | |
| 427 <td>Private method to get the name of the file to be saved.</td> | |
| 428 </tr> | |
| 429 <tr> | |
| 430 <td><a href="#Editor.__ignoreSpellingAlways">__ignoreSpellingAlways</a></td> | |
| 431 <td>Private to always ignore the word below the spelling context menu.</td> | |
| 432 </tr> | |
| 433 <tr> | |
| 434 <td><a href="#Editor.__indentLine">__indentLine</a></td> | |
| 435 <td>Private method to indent or unindent the current line.</td> | |
| 436 </tr> | |
| 437 <tr> | |
| 438 <td><a href="#Editor.__indentSelection">__indentSelection</a></td> | |
| 439 <td>Private method to indent or unindent the current selection.</td> | |
| 440 </tr> | |
| 441 <tr> | |
| 442 <td><a href="#Editor.__initContextMenu">__initContextMenu</a></td> | |
| 443 <td>Private method used to setup the context menu.</td> | |
| 444 </tr> | |
| 445 <tr> | |
| 446 <td><a href="#Editor.__initContextMenuAutocompletion">__initContextMenuAutocompletion</a></td> | |
| 447 <td>Private method used to setup the Checks context sub menu.</td> | |
| 448 </tr> | |
| 449 <tr> | |
| 450 <td><a href="#Editor.__initContextMenuChecks">__initContextMenuChecks</a></td> | |
| 451 <td>Private method used to setup the Checks context sub menu.</td> | |
| 452 </tr> | |
| 453 <tr> | |
| 454 <td><a href="#Editor.__initContextMenuEncodings">__initContextMenuEncodings</a></td> | |
| 455 <td>Private method used to setup the Encodings context sub menu.</td> | |
| 456 </tr> | |
| 457 <tr> | |
| 458 <td><a href="#Editor.__initContextMenuEol">__initContextMenuEol</a></td> | |
| 459 <td>Private method to setup the eol context sub menu.</td> | |
| 460 </tr> | |
| 461 <tr> | |
| 462 <td><a href="#Editor.__initContextMenuGraphics">__initContextMenuGraphics</a></td> | |
| 463 <td>Private method used to setup the diagrams context sub menu.</td> | |
| 464 </tr> | |
| 465 <tr> | |
| 466 <td><a href="#Editor.__initContextMenuLanguages">__initContextMenuLanguages</a></td> | |
| 467 <td>Private method used to setup the Languages context sub menu.</td> | |
| 468 </tr> | |
| 469 <tr> | |
| 470 <td><a href="#Editor.__initContextMenuMargins">__initContextMenuMargins</a></td> | |
| 471 <td>Private method used to setup the context menu for the margins.</td> | |
| 472 </tr> | |
| 473 <tr> | |
| 474 <td><a href="#Editor.__initContextMenuReopenWithEncoding">__initContextMenuReopenWithEncoding</a></td> | |
| 475 <td>Private method used to setup the Reopen With Encoding context sub menu.</td> | |
| 476 </tr> | |
| 477 <tr> | |
| 478 <td><a href="#Editor.__initContextMenuResources">__initContextMenuResources</a></td> | |
| 479 <td>Private method used to setup the Resources context sub menu.</td> | |
| 480 </tr> | |
| 481 <tr> | |
| 482 <td><a href="#Editor.__initContextMenuShow">__initContextMenuShow</a></td> | |
| 483 <td>Private method used to setup the Show context sub menu.</td> | |
| 484 </tr> | |
| 485 <tr> | |
| 486 <td><a href="#Editor.__initContextMenuSpellCheck">__initContextMenuSpellCheck</a></td> | |
| 487 <td>Private method used to setup the spell checking context sub menu.</td> | |
| 488 </tr> | |
| 489 <tr> | |
| 490 <td><a href="#Editor.__initContextMenuSpellLanguages">__initContextMenuSpellLanguages</a></td> | |
| 491 <td>Private method to setup the spell checking languages context sub menu.</td> | |
| 492 </tr> | |
| 493 <tr> | |
| 494 <td><a href="#Editor.__initContextMenuTools">__initContextMenuTools</a></td> | |
| 495 <td>Private method used to setup the Tools context sub menu.</td> | |
| 496 </tr> | |
| 497 <tr> | |
| 498 <td><a href="#Editor.__initOnlineChangeTrace">__initOnlineChangeTrace</a></td> | |
| 499 <td>Private slot to initialize the online change trace.</td> | |
| 500 </tr> | |
| 501 <tr> | |
| 502 <td><a href="#Editor.__initOnlineSyntaxCheck">__initOnlineSyntaxCheck</a></td> | |
| 503 <td>Private slot to initialize the online syntax check.</td> | |
| 504 </tr> | |
| 505 <tr> | |
| 506 <td><a href="#Editor.__insertDocstring">__insertDocstring</a></td> | |
| 507 <td>Private slot to generate and insert a docstring for the function under the cursor.</td> | |
| 508 </tr> | |
| 509 <tr> | |
| 510 <td><a href="#Editor.__isCommentedLine">__isCommentedLine</a></td> | |
| 511 <td>Private method to check, if the given line is a comment line as produced by the configured comment rules.</td> | |
| 512 </tr> | |
| 513 <tr> | |
| 514 <td><a href="#Editor.__isStartChar">__isStartChar</a></td> | |
| 515 <td>Private method to check, if a character is an autocompletion start character.</td> | |
| 516 </tr> | |
| 517 <tr> | |
| 518 <td><a href="#Editor.__languageChanged">__languageChanged</a></td> | |
| 519 <td>Private slot handling a change of a connected editor's language.</td> | |
| 520 </tr> | |
| 521 <tr> | |
| 522 <td><a href="#Editor.__languageMenuTriggered">__languageMenuTriggered</a></td> | |
| 523 <td>Private method to handle the selection of a lexer language.</td> | |
| 524 </tr> | |
| 525 <tr> | |
| 526 <td><a href="#Editor.__lmBbookmarks">__lmBbookmarks</a></td> | |
| 527 <td>Private method to handle the 'LMB toggles bookmark' context menu action.</td> | |
| 528 </tr> | |
| 529 <tr> | |
| 530 <td><a href="#Editor.__lmBbreakpoints">__lmBbreakpoints</a></td> | |
| 531 <td>Private method to handle the 'LMB toggles breakpoint' context menu action.</td> | |
| 532 </tr> | |
| 533 <tr> | |
| 534 <td><a href="#Editor.__loadDiagram">__loadDiagram</a></td> | |
| 535 <td>Private slot to load a diagram from file.</td> | |
| 536 </tr> | |
| 537 <tr> | |
| 538 <td><a href="#Editor.__loadEditorConfig">__loadEditorConfig</a></td> | |
| 539 <td>Private method to load the EditorConfig properties.</td> | |
| 540 </tr> | |
| 541 <tr> | |
| 542 <td><a href="#Editor.__loadEditorConfigObject">__loadEditorConfigObject</a></td> | |
| 543 <td>Private method to load the EditorConfig properties for the given file name.</td> | |
| 544 </tr> | |
| 545 <tr> | |
| 546 <td><a href="#Editor.__marginClicked">__marginClicked</a></td> | |
| 547 <td>Private slot to handle the marginClicked signal.</td> | |
| 548 </tr> | |
| 549 <tr> | |
| 550 <td><a href="#Editor.__marginNumber">__marginNumber</a></td> | |
| 551 <td>Private method to calculate the margin number based on a x position.</td> | |
| 552 </tr> | |
| 553 <tr> | |
| 554 <td><a href="#Editor.__markOccurrences">__markOccurrences</a></td> | |
| 555 <td>Private method to mark all occurrences of the current word.</td> | |
| 556 </tr> | |
| 557 <tr> | |
| 558 <td><a href="#Editor.__menuClearBreakpoints">__menuClearBreakpoints</a></td> | |
| 559 <td>Private slot to handle the 'Clear all breakpoints' context menu action.</td> | |
| 560 </tr> | |
| 561 <tr> | |
| 562 <td><a href="#Editor.__menuToggleBreakpointEnabled">__menuToggleBreakpointEnabled</a></td> | |
| 563 <td>Private slot to handle the 'Enable/Disable breakpoint' context menu action.</td> | |
| 564 </tr> | |
| 565 <tr> | |
| 566 <td><a href="#Editor.__menuToggleTemporaryBreakpoint">__menuToggleTemporaryBreakpoint</a></td> | |
| 567 <td>Private slot to handle the 'Toggle temporary breakpoint' context menu action.</td> | |
| 568 </tr> | |
| 569 <tr> | |
| 570 <td><a href="#Editor.__modificationChanged">__modificationChanged</a></td> | |
| 571 <td>Private slot to handle the modificationChanged signal.</td> | |
| 572 </tr> | |
| 573 <tr> | |
| 574 <td><a href="#Editor.__modificationReadOnly">__modificationReadOnly</a></td> | |
| 575 <td>Private slot to handle the modificationAttempted signal.</td> | |
| 576 </tr> | |
| 577 <tr> | |
| 578 <td><a href="#Editor.__modified">__modified</a></td> | |
| 579 <td>Private method to handle changes of the number of lines.</td> | |
| 580 </tr> | |
| 581 <tr> | |
| 582 <td><a href="#Editor.__newView">__newView</a></td> | |
| 583 <td>Private slot to create a new view to an open document.</td> | |
| 584 </tr> | |
| 585 <tr> | |
| 586 <td><a href="#Editor.__newViewNewSplit">__newViewNewSplit</a></td> | |
| 587 <td>Private slot to create a new view to an open document.</td> | |
| 588 </tr> | |
| 589 <tr> | |
| 590 <td><a href="#Editor.__normalizedEncoding">__normalizedEncoding</a></td> | |
| 591 <td>Private method to calculate the normalized encoding string.</td> | |
| 592 </tr> | |
| 593 <tr> | |
| 594 <td><a href="#Editor.__onlineChangeTraceTimerTimeout">__onlineChangeTraceTimerTimeout</a></td> | |
| 595 <td>Private slot to mark added and changed lines.</td> | |
| 596 </tr> | |
| 597 <tr> | |
| 598 <td><a href="#Editor.__popupDocstringMenu">__popupDocstringMenu</a></td> | |
| 599 <td>Private slot to pop up a menu asking the user, if a docstring should be inserted.</td> | |
| 600 </tr> | |
| 601 <tr> | |
| 602 <td><a href="#Editor.__printPreview">__printPreview</a></td> | |
| 603 <td>Private slot to generate a print preview.</td> | |
| 604 </tr> | |
| 605 <tr> | |
| 606 <td><a href="#Editor.__processEndEditCommand">__processEndEditCommand</a></td> | |
| 607 <td>Private slot to process a remote EndEdit command.</td> | |
| 608 </tr> | |
| 609 <tr> | |
| 610 <td><a href="#Editor.__processFlags">__processFlags</a></td> | |
| 611 <td>Private method to extract flags and process them.</td> | |
| 612 </tr> | |
| 613 <tr> | |
| 614 <td><a href="#Editor.__processRequestSyncCommand">__processRequestSyncCommand</a></td> | |
| 615 <td>Private slot to process a remote RequestSync command.</td> | |
| 616 </tr> | |
| 617 <tr> | |
| 618 <td><a href="#Editor.__processStartEditCommand">__processStartEditCommand</a></td> | |
| 619 <td>Private slot to process a remote StartEdit command.</td> | |
| 620 </tr> | |
| 621 <tr> | |
| 622 <td><a href="#Editor.__processSyncCommand">__processSyncCommand</a></td> | |
| 623 <td>Private slot to process a remote Sync command.</td> | |
| 624 </tr> | |
| 625 <tr> | |
| 626 <td><a href="#Editor.__processSyntaxCheckError">__processSyntaxCheckError</a></td> | |
| 627 <td>Private slot to report an error message of a syntax check.</td> | |
| 628 </tr> | |
| 629 <tr> | |
| 630 <td><a href="#Editor.__processSyntaxCheckResult">__processSyntaxCheckResult</a></td> | |
| 631 <td>Private slot to report the resulting messages of a syntax check.</td> | |
| 632 </tr> | |
| 633 <tr> | |
| 634 <td><a href="#Editor.__projectPropertiesChanged">__projectPropertiesChanged</a></td> | |
| 635 <td>Private slot to handle changes of the project properties.</td> | |
| 636 </tr> | |
| 637 <tr> | |
| 638 <td><a href="#Editor.__refreshAnnotations">__refreshAnnotations</a></td> | |
| 639 <td>Private method to refresh the annotations.</td> | |
| 640 </tr> | |
| 641 <tr> | |
| 642 <td><a href="#Editor.__registerImages">__registerImages</a></td> | |
| 643 <td>Private method to register images for autocompletion lists.</td> | |
| 644 </tr> | |
| 645 <tr> | |
| 646 <td><a href="#Editor.__reinitOnlineChangeTrace">__reinitOnlineChangeTrace</a></td> | |
| 647 <td>Private slot to re-initialize the online change trace.</td> | |
| 648 </tr> | |
| 649 <tr> | |
| 650 <td><a href="#Editor.__removeFromSpellingDictionary">__removeFromSpellingDictionary</a></td> | |
| 651 <td>Private slot to remove the word below the context menu to the dictionary.</td> | |
| 652 </tr> | |
| 653 <tr> | |
| 654 <td><a href="#Editor.__removeTrailingWhitespace">__removeTrailingWhitespace</a></td> | |
| 655 <td>Private method to remove trailing whitespace.</td> | |
| 656 </tr> | |
| 657 <tr> | |
| 658 <td><a href="#Editor.__reopenWithEncodingMenuTriggered">__reopenWithEncodingMenuTriggered</a></td> | |
| 659 <td>Private method to handle the rereading of the file with a selected encoding.</td> | |
| 660 </tr> | |
| 661 <tr> | |
| 662 <td><a href="#Editor.__replaceLeadingUnderscores">__replaceLeadingUnderscores</a></td> | |
| 663 <td>Private method to replace the first two underlines for invers sorting.</td> | |
| 664 </tr> | |
| 665 <tr> | |
| 666 <td><a href="#Editor.__resetLanguage">__resetLanguage</a></td> | |
| 667 <td>Private method used to reset the language selection.</td> | |
| 668 </tr> | |
| 669 <tr> | |
| 670 <td><a href="#Editor.__resetOnlineChangeTraceInfo">__resetOnlineChangeTraceInfo</a></td> | |
| 671 <td>Private slot to reset the online change trace info.</td> | |
| 672 </tr> | |
| 673 <tr> | |
| 674 <td><a href="#Editor.__resetOnlineChangeTraceTimer">__resetOnlineChangeTraceTimer</a></td> | |
| 675 <td>Private method to reset the online syntax check timer.</td> | |
| 676 </tr> | |
| 677 <tr> | |
| 678 <td><a href="#Editor.__resetOnlineSyntaxCheckTimer">__resetOnlineSyntaxCheckTimer</a></td> | |
| 679 <td>Private method to reset the online syntax check timer.</td> | |
| 680 </tr> | |
| 681 <tr> | |
| 682 <td><a href="#Editor.__resizeLinenoMargin">__resizeLinenoMargin</a></td> | |
| 683 <td>Private slot to resize the line numbers margin.</td> | |
| 684 </tr> | |
| 685 <tr> | |
| 686 <td><a href="#Editor.__restoreBreakpoints">__restoreBreakpoints</a></td> | |
| 687 <td>Private method to restore the breakpoints.</td> | |
| 688 </tr> | |
| 689 <tr> | |
| 690 <td><a href="#Editor.__saveLastEditPosition">__saveLastEditPosition</a></td> | |
| 691 <td>Private slot to record the last edit position.</td> | |
| 692 </tr> | |
| 693 <tr> | |
| 694 <td><a href="#Editor.__searchCurrentWord">__searchCurrentWord</a></td> | |
| 695 <td>Private slot to search the next occurrence of the current word.</td> | |
| 696 </tr> | |
| 697 <tr> | |
| 698 <td><a href="#Editor.__selectAll">__selectAll</a></td> | |
| 699 <td>Private slot handling the select all context menu action.</td> | |
| 700 </tr> | |
| 701 <tr> | |
| 702 <td><a href="#Editor.__selectPygmentsLexer">__selectPygmentsLexer</a></td> | |
| 703 <td>Private method to select a specific pygments lexer.</td> | |
| 704 </tr> | |
| 705 <tr> | |
| 706 <td><a href="#Editor.__send">__send</a></td> | |
| 707 <td>Private method to send an editor command to remote editors.</td> | |
| 708 </tr> | |
| 709 <tr> | |
| 710 <td><a href="#Editor.__setAnnotation">__setAnnotation</a></td> | |
| 711 <td>Private method to set the annotations for the given line.</td> | |
| 712 </tr> | |
| 713 <tr> | |
| 714 <td><a href="#Editor.__setAnnotationStyles">__setAnnotationStyles</a></td> | |
| 715 <td>Private slot to define the style used by inline annotations.</td> | |
| 716 </tr> | |
| 717 <tr> | |
| 718 <td><a href="#Editor.__setAutoCompletion">__setAutoCompletion</a></td> | |
| 719 <td>Private method to configure the autocompletion function.</td> | |
| 720 </tr> | |
| 721 <tr> | |
| 722 <td><a href="#Editor.__setCallTips">__setCallTips</a></td> | |
| 723 <td>Private method to configure the calltips function.</td> | |
| 724 </tr> | |
| 725 <tr> | |
| 726 <td><a href="#Editor.__setEolMode">__setEolMode</a></td> | |
| 727 <td>Private method to configure the eol mode of the editor.</td> | |
| 728 </tr> | |
| 729 <tr> | |
| 730 <td><a href="#Editor.__setFileName">__setFileName</a></td> | |
| 731 <td>Private method to set the file name of the current file.</td> | |
| 732 </tr> | |
| 733 <tr> | |
| 734 <td><a href="#Editor.__setLineMarkerColours">__setLineMarkerColours</a></td> | |
| 735 <td>Private method to set the line marker colours.</td> | |
| 736 </tr> | |
| 737 <tr> | |
| 738 <td><a href="#Editor.__setMarginsDisplay">__setMarginsDisplay</a></td> | |
| 739 <td>Private method to configure margins 0 and 2.</td> | |
| 740 </tr> | |
| 741 <tr> | |
| 742 <td><a href="#Editor.__setSpelling">__setSpelling</a></td> | |
| 743 <td>Private method to initialize the spell checking functionality.</td> | |
| 744 </tr> | |
| 745 <tr> | |
| 746 <td><a href="#Editor.__setSpellingLanguage">__setSpellingLanguage</a></td> | |
| 747 <td>Private slot to set the spell checking language.</td> | |
| 748 </tr> | |
| 749 <tr> | |
| 750 <td><a href="#Editor.__setTabAndIndent">__setTabAndIndent</a></td> | |
| 751 <td>Private method to set indentation size and style and tab width.</td> | |
| 752 </tr> | |
| 753 <tr> | |
| 754 <td><a href="#Editor.__setTextDisplay">__setTextDisplay</a></td> | |
| 755 <td>Private method to configure the text display.</td> | |
| 756 </tr> | |
| 757 <tr> | |
| 758 <td><a href="#Editor.__showApplicationDiagram">__showApplicationDiagram</a></td> | |
| 759 <td>Private method to handle the Imports Diagram context menu action.</td> | |
| 760 </tr> | |
| 761 <tr> | |
| 762 <td><a href="#Editor.__showClassDiagram">__showClassDiagram</a></td> | |
| 763 <td>Private method to handle the Class Diagram context menu action.</td> | |
| 764 </tr> | |
| 765 <tr> | |
| 766 <td><a href="#Editor.__showCodeCoverage">__showCodeCoverage</a></td> | |
| 767 <td>Private method to handle the code coverage context menu action.</td> | |
| 768 </tr> | |
| 769 <tr> | |
| 770 <td><a href="#Editor.__showCodeInfo">__showCodeInfo</a></td> | |
| 771 <td>Private slot to handle the context menu action to show code info.</td> | |
| 772 </tr> | |
| 773 <tr> | |
| 774 <td><a href="#Editor.__showCodeMetrics">__showCodeMetrics</a></td> | |
| 775 <td>Private method to handle the code metrics context menu action.</td> | |
| 776 </tr> | |
| 777 <tr> | |
| 778 <td><a href="#Editor.__showCompletionsList">__showCompletionsList</a></td> | |
| 779 <td>Private method to show the completions list.</td> | |
| 780 </tr> | |
| 781 <tr> | |
| 782 <td><a href="#Editor.__showContextMenu">__showContextMenu</a></td> | |
| 783 <td>Private slot handling the aboutToShow signal of the context menu.</td> | |
| 784 </tr> | |
| 785 <tr> | |
| 786 <td><a href="#Editor.__showContextMenuAutocompletion">__showContextMenuAutocompletion</a></td> | |
| 787 <td>Private slot called before the autocompletion menu is shown.</td> | |
| 788 </tr> | |
| 789 <tr> | |
| 790 <td><a href="#Editor.__showContextMenuChecks">__showContextMenuChecks</a></td> | |
| 791 <td>Private slot handling the aboutToShow signal of the checks context menu.</td> | |
| 792 </tr> | |
| 793 <tr> | |
| 794 <td><a href="#Editor.__showContextMenuEncodings">__showContextMenuEncodings</a></td> | |
| 795 <td>Private slot handling the aboutToShow signal of the encodings context menu.</td> | |
| 796 </tr> | |
| 797 <tr> | |
| 798 <td><a href="#Editor.__showContextMenuEol">__showContextMenuEol</a></td> | |
| 799 <td>Private slot handling the aboutToShow signal of the eol context menu.</td> | |
| 800 </tr> | |
| 801 <tr> | |
| 802 <td><a href="#Editor.__showContextMenuGraphics">__showContextMenuGraphics</a></td> | |
| 803 <td>Private slot handling the aboutToShow signal of the diagrams context menu.</td> | |
| 804 </tr> | |
| 805 <tr> | |
| 806 <td><a href="#Editor.__showContextMenuLanguages">__showContextMenuLanguages</a></td> | |
| 807 <td>Private slot handling the aboutToShow signal of the languages context menu.</td> | |
| 808 </tr> | |
| 809 <tr> | |
| 810 <td><a href="#Editor.__showContextMenuMargin">__showContextMenuMargin</a></td> | |
| 811 <td>Private slot handling the aboutToShow signal of the margins context menu.</td> | |
| 812 </tr> | |
| 813 <tr> | |
| 814 <td><a href="#Editor.__showContextMenuResources">__showContextMenuResources</a></td> | |
| 815 <td>Private slot handling the aboutToShow signal of the resources context menu.</td> | |
| 816 </tr> | |
| 817 <tr> | |
| 818 <td><a href="#Editor.__showContextMenuShow">__showContextMenuShow</a></td> | |
| 819 <td>Private slot called before the show menu is shown.</td> | |
| 820 </tr> | |
| 821 <tr> | |
| 822 <td><a href="#Editor.__showContextMenuSpellCheck">__showContextMenuSpellCheck</a></td> | |
| 823 <td>Private slot handling the aboutToShow signal of the spell check context menu.</td> | |
| 824 </tr> | |
| 825 <tr> | |
| 826 <td><a href="#Editor.__showContextMenuSpellLanguages">__showContextMenuSpellLanguages</a></td> | |
| 827 <td>Private slot handling the aboutToShow signal of the spell check languages context menu.</td> | |
| 828 </tr> | |
| 829 <tr> | |
| 830 <td><a href="#Editor.__showContextMenuSpelling">__showContextMenuSpelling</a></td> | |
| 831 <td>Private slot to set up the spelling menu before it is shown.</td> | |
| 832 </tr> | |
| 833 <tr> | |
| 834 <td><a href="#Editor.__showContextMenuTools">__showContextMenuTools</a></td> | |
| 835 <td>Private slot handling the aboutToShow signal of the tools context menu.</td> | |
| 836 </tr> | |
| 837 <tr> | |
| 838 <td><a href="#Editor.__showImportsDiagram">__showImportsDiagram</a></td> | |
| 839 <td>Private method to handle the Imports Diagram context menu action.</td> | |
| 840 </tr> | |
| 841 <tr> | |
| 842 <td><a href="#Editor.__showMouseHoverHelp">__showMouseHoverHelp</a></td> | |
| 843 <td>Private slot showing code information about the symbol under the cursor.</td> | |
| 844 </tr> | |
| 845 <tr> | |
| 846 <td><a href="#Editor.__showPackageDiagram">__showPackageDiagram</a></td> | |
| 847 <td>Private method to handle the Package Diagram context menu action.</td> | |
| 848 </tr> | |
| 849 <tr> | |
| 850 <td><a href="#Editor.__showProfileData">__showProfileData</a></td> | |
| 851 <td>Private method to handle the show profile data context menu action.</td> | |
| 852 </tr> | |
| 853 <tr> | |
| 854 <td><a href="#Editor.__showSyntaxError">__showSyntaxError</a></td> | |
| 855 <td>Private slot to handle the 'Show syntax error message' context menu action.</td> | |
| 856 </tr> | |
| 857 <tr> | |
| 858 <td><a href="#Editor.__showWarning">__showWarning</a></td> | |
| 859 <td>Private slot to handle the 'Show warning' context menu action.</td> | |
| 860 </tr> | |
| 861 <tr> | |
| 862 <td><a href="#Editor.__spellCharAdded">__spellCharAdded</a></td> | |
| 863 <td>Private slot called to handle the user entering a character.</td> | |
| 864 </tr> | |
| 865 <tr> | |
| 866 <td><a href="#Editor.__spellLanguageChanged">__spellLanguageChanged</a></td> | |
| 867 <td>Private slot to handle a change of the spell check language.</td> | |
| 868 </tr> | |
| 869 <tr> | |
| 870 <td><a href="#Editor.__spellLanguagesMenuTriggered">__spellLanguagesMenuTriggered</a></td> | |
| 871 <td>Private method to handle the selection of a spell check language.</td> | |
| 872 </tr> | |
| 873 <tr> | |
| 874 <td><a href="#Editor.__styleNeeded">__styleNeeded</a></td> | |
| 875 <td>Private slot to handle the need for more styling.</td> | |
| 876 </tr> | |
| 877 <tr> | |
| 878 <td><a href="#Editor.__textChanged">__textChanged</a></td> | |
| 879 <td>Private slot to handle a change of the editor text.</td> | |
| 880 </tr> | |
| 881 <tr> | |
| 882 <td><a href="#Editor.__toggleAutoCompletionEnable">__toggleAutoCompletionEnable</a></td> | |
| 883 <td>Private slot to handle the Enable Autocompletion context menu entry.</td> | |
| 884 </tr> | |
| 885 <tr> | |
| 886 <td><a href="#Editor.__toggleBreakpoint">__toggleBreakpoint</a></td> | |
| 887 <td>Private method to toggle a breakpoint.</td> | |
| 888 </tr> | |
| 889 <tr> | |
| 890 <td><a href="#Editor.__toggleBreakpointEnabled">__toggleBreakpointEnabled</a></td> | |
| 891 <td>Private method to toggle a breakpoints enabled status.</td> | |
| 892 </tr> | |
| 893 <tr> | |
| 894 <td><a href="#Editor.__toggleTypingAids">__toggleTypingAids</a></td> | |
| 895 <td>Private slot to toggle the typing aids.</td> | |
| 896 </tr> | |
| 897 <tr> | |
| 898 <td><a href="#Editor.__updateReadOnly">__updateReadOnly</a></td> | |
| 899 <td>Private method to update the readOnly information for this editor.</td> | |
| 900 </tr> | |
| 901 <tr> | |
| 902 <td><a href="#Editor.addCallTipHook">addCallTipHook</a></td> | |
| 903 <td>Public method to set a calltip provider.</td> | |
| 904 </tr> | |
| 905 <tr> | |
| 906 <td><a href="#Editor.addClone">addClone</a></td> | |
| 907 <td>Public method to add a clone to our list.</td> | |
| 908 </tr> | |
| 909 <tr> | |
| 910 <td><a href="#Editor.addCompletionListHook">addCompletionListHook</a></td> | |
| 911 <td>Public method to set an auto-completion list provider.</td> | |
| 912 </tr> | |
| 913 <tr> | |
| 914 <td><a href="#Editor.addedToProject">addedToProject</a></td> | |
| 915 <td>Public method to signal, that this editor has been added to a project.</td> | |
| 916 </tr> | |
| 917 <tr> | |
| 918 <td><a href="#Editor.autoComplete">autoComplete</a></td> | |
| 919 <td>Public method to start auto-completion.</td> | |
| 920 </tr> | |
| 921 <tr> | |
| 922 <td><a href="#Editor.autoCompleteQScintilla">autoCompleteQScintilla</a></td> | |
| 923 <td>Public method to perform an autocompletion using QScintilla methods.</td> | |
| 924 </tr> | |
| 925 <tr> | |
| 926 <td><a href="#Editor.boxCommentLine">boxCommentLine</a></td> | |
| 927 <td>Public slot to box comment the current line.</td> | |
| 928 </tr> | |
| 929 <tr> | |
| 930 <td><a href="#Editor.boxCommentLineOrSelection">boxCommentLineOrSelection</a></td> | |
| 931 <td>Public slot to box comment the current line or current selection.</td> | |
| 932 </tr> | |
| 933 <tr> | |
| 934 <td><a href="#Editor.boxCommentSelection">boxCommentSelection</a></td> | |
| 935 <td>Public slot to box comment the current selection.</td> | |
| 936 </tr> | |
| 937 <tr> | |
| 938 <td><a href="#Editor.callTip">callTip</a></td> | |
| 939 <td>Public method to show calltips.</td> | |
| 940 </tr> | |
| 941 <tr> | |
| 942 <td><a href="#Editor.canAutoCompleteFromAPIs">canAutoCompleteFromAPIs</a></td> | |
| 943 <td>Public method to check for API availablity.</td> | |
| 944 </tr> | |
| 945 <tr> | |
| 946 <td><a href="#Editor.canProvideCallTipps">canProvideCallTipps</a></td> | |
| 947 <td>Public method to test the calltips availability.</td> | |
| 948 </tr> | |
| 949 <tr> | |
| 950 <td><a href="#Editor.canProvideDynamicAutoCompletion">canProvideDynamicAutoCompletion</a></td> | |
| 951 <td>Public method to test the dynamic auto-completion availability.</td> | |
| 952 </tr> | |
| 953 <tr> | |
| 954 <td><a href="#Editor.cancelSharedEdit">cancelSharedEdit</a></td> | |
| 955 <td>Public slot to cancel a shared edit session for the editor.</td> | |
| 956 </tr> | |
| 957 <tr> | |
| 958 <td><a href="#Editor.changeEvent">changeEvent</a></td> | |
| 959 <td>Protected method called to process an event.</td> | |
| 960 </tr> | |
| 961 <tr> | |
| 962 <td><a href="#Editor.checkDirty">checkDirty</a></td> | |
| 963 <td>Public method to check dirty status and open a message window.</td> | |
| 964 </tr> | |
| 965 <tr> | |
| 966 <td><a href="#Editor.checkSpelling">checkSpelling</a></td> | |
| 967 <td>Public slot to perform an interactive spell check of the document.</td> | |
| 968 </tr> | |
| 969 <tr> | |
| 970 <td><a href="#Editor.checkSyntax">checkSyntax</a></td> | |
| 971 <td>Public method to perform an automatic syntax check of the file.</td> | |
| 972 </tr> | |
| 973 <tr> | |
| 974 <td><a href="#Editor.clearAllHighlights">clearAllHighlights</a></td> | |
| 975 <td>Public method to clear all highlights.</td> | |
| 976 </tr> | |
| 977 <tr> | |
| 978 <td><a href="#Editor.clearBookmarks">clearBookmarks</a></td> | |
| 979 <td>Public slot to handle the 'Clear all bookmarks' context menu action.</td> | |
| 980 </tr> | |
| 981 <tr> | |
| 982 <td><a href="#Editor.clearBreakpoint">clearBreakpoint</a></td> | |
| 983 <td>Public method to clear a breakpoint.</td> | |
| 984 </tr> | |
| 985 <tr> | |
| 986 <td><a href="#Editor.clearFlakesWarnings">clearFlakesWarnings</a></td> | |
| 987 <td>Public slot to clear all pyflakes warnings.</td> | |
| 988 </tr> | |
| 989 <tr> | |
| 990 <td><a href="#Editor.clearHighlight">clearHighlight</a></td> | |
| 991 <td>Public method to clear a text highlight.</td> | |
| 992 </tr> | |
| 993 <tr> | |
| 994 <td><a href="#Editor.clearSearchIndicators">clearSearchIndicators</a></td> | |
| 995 <td>Public method to clear all search indicators.</td> | |
| 996 </tr> | |
| 997 <tr> | |
| 998 <td><a href="#Editor.clearStyleWarnings">clearStyleWarnings</a></td> | |
| 999 <td>Public slot to clear all style warnings.</td> | |
| 1000 </tr> | |
| 1001 <tr> | |
| 1002 <td><a href="#Editor.clearStyles">clearStyles</a></td> | |
| 1003 <td>Public method to set the styles according the selected Qt style or the selected editor colours.</td> | |
| 1004 </tr> | |
| 1005 <tr> | |
| 1006 <td><a href="#Editor.clearSyntaxError">clearSyntaxError</a></td> | |
| 1007 <td>Public slot to handle the 'Clear all syntax error' context menu action.</td> | |
| 1008 </tr> | |
| 1009 <tr> | |
| 1010 <td><a href="#Editor.clearWarnings">clearWarnings</a></td> | |
| 1011 <td>Public slot to clear all warnings.</td> | |
| 1012 </tr> | |
| 1013 <tr> | |
| 1014 <td><a href="#Editor.close">close</a></td> | |
| 1015 <td>Public method called when the window gets closed.</td> | |
| 1016 </tr> | |
| 1017 <tr> | |
| 1018 <td><a href="#Editor.closeIt">closeIt</a></td> | |
| 1019 <td>Public method called by the viewmanager to finally get rid of us.</td> | |
| 1020 </tr> | |
| 1021 <tr> | |
| 1022 <td><a href="#Editor.codeCoverageShowAnnotations">codeCoverageShowAnnotations</a></td> | |
| 1023 <td>Public method to handle the show code coverage annotations context menu action.</td> | |
| 1024 </tr> | |
| 1025 <tr> | |
| 1026 <td><a href="#Editor.collapseFoldWithChildren">collapseFoldWithChildren</a></td> | |
| 1027 <td>Public slot to collapse the current fold including its children.</td> | |
| 1028 </tr> | |
| 1029 <tr> | |
| 1030 <td><a href="#Editor.commentLine">commentLine</a></td> | |
| 1031 <td>Public slot to comment the current line.</td> | |
| 1032 </tr> | |
| 1033 <tr> | |
| 1034 <td><a href="#Editor.commentLineOrSelection">commentLineOrSelection</a></td> | |
| 1035 <td>Public slot to comment the current line or current selection.</td> | |
| 1036 </tr> | |
| 1037 <tr> | |
| 1038 <td><a href="#Editor.commentSelection">commentSelection</a></td> | |
| 1039 <td>Public slot to comment the current selection.</td> | |
| 1040 </tr> | |
| 1041 <tr> | |
| 1042 <td><a href="#Editor.completionsListReady">completionsListReady</a></td> | |
| 1043 <td>Public method to show the completions determined by a completions provider.</td> | |
| 1044 </tr> | |
| 1045 <tr> | |
| 1046 <td><a href="#Editor.contextMenuEvent">contextMenuEvent</a></td> | |
| 1047 <td>Protected method implementing the context menu event.</td> | |
| 1048 </tr> | |
| 1049 <tr> | |
| 1050 <td><a href="#Editor.curLineHasBreakpoint">curLineHasBreakpoint</a></td> | |
| 1051 <td>Public method to check for the presence of a breakpoint at the current line.</td> | |
| 1052 </tr> | |
| 1053 <tr> | |
| 1054 <td><a href="#Editor.determineFileType">determineFileType</a></td> | |
| 1055 <td>Public method to determine the file type using various tests.</td> | |
| 1056 </tr> | |
| 1057 <tr> | |
| 1058 <td><a href="#Editor.dragEnterEvent">dragEnterEvent</a></td> | |
| 1059 <td>Protected method to handle the drag enter event.</td> | |
| 1060 </tr> | |
| 1061 <tr> | |
| 1062 <td><a href="#Editor.dragLeaveEvent">dragLeaveEvent</a></td> | |
| 1063 <td>Protected method to handle the drag leave event.</td> | |
| 1064 </tr> | |
| 1065 <tr> | |
| 1066 <td><a href="#Editor.dragMoveEvent">dragMoveEvent</a></td> | |
| 1067 <td>Protected method to handle the drag move event.</td> | |
| 1068 </tr> | |
| 1069 <tr> | |
| 1070 <td><a href="#Editor.dropEvent">dropEvent</a></td> | |
| 1071 <td>Protected method to handle the drop event.</td> | |
| 1072 </tr> | |
| 1073 <tr> | |
| 1074 <td><a href="#Editor.editorCommand">editorCommand</a></td> | |
| 1075 <td>Public method to perform a simple editor command.</td> | |
| 1076 </tr> | |
| 1077 <tr> | |
| 1078 <td><a href="#Editor.encloseSelectedText">encloseSelectedText</a></td> | |
| 1079 <td>Local function to enclose the current selection with some characters.</td> | |
| 1080 </tr> | |
| 1081 <tr> | |
| 1082 <td><a href="#Editor.ensureVisible">ensureVisible</a></td> | |
| 1083 <td>Public slot to ensure, that the specified line is visible.</td> | |
| 1084 </tr> | |
| 1085 <tr> | |
| 1086 <td><a href="#Editor.ensureVisibleTop">ensureVisibleTop</a></td> | |
| 1087 <td>Public slot to ensure, that the specified line is visible at the top of the editor.</td> | |
| 1088 </tr> | |
| 1089 <tr> | |
| 1090 <td><a href="#Editor.event">event</a></td> | |
| 1091 <td>Public method handling events.</td> | |
| 1092 </tr> | |
| 1093 <tr> | |
| 1094 <td><a href="#Editor.expandFoldWithChildren">expandFoldWithChildren</a></td> | |
| 1095 <td>Public slot to expand the current fold including its children.</td> | |
| 1096 </tr> | |
| 1097 <tr> | |
| 1098 <td><a href="#Editor.exportFile">exportFile</a></td> | |
| 1099 <td>Public method to export the file.</td> | |
| 1100 </tr> | |
| 1101 <tr> | |
| 1102 <td><a href="#Editor.extractTasks">extractTasks</a></td> | |
| 1103 <td>Public slot to extract all tasks.</td> | |
| 1104 </tr> | |
| 1105 <tr> | |
| 1106 <td><a href="#Editor.fileRenamed">fileRenamed</a></td> | |
| 1107 <td>Public slot to handle the editorRenamed signal.</td> | |
| 1108 </tr> | |
| 1109 <tr> | |
| 1110 <td><a href="#Editor.focusInEvent">focusInEvent</a></td> | |
| 1111 <td>Protected method called when the editor receives focus.</td> | |
| 1112 </tr> | |
| 1113 <tr> | |
| 1114 <td><a href="#Editor.focusOutEvent">focusOutEvent</a></td> | |
| 1115 <td>Protected method called when the editor loses focus.</td> | |
| 1116 </tr> | |
| 1117 <tr> | |
| 1118 <td><a href="#Editor.gestureEvent">gestureEvent</a></td> | |
| 1119 <td>Protected method handling gesture events.</td> | |
| 1120 </tr> | |
| 1121 <tr> | |
| 1122 <td><a href="#Editor.getApiLanguage">getApiLanguage</a></td> | |
| 1123 <td>Public method to get the API language of the editor.</td> | |
| 1124 </tr> | |
| 1125 <tr> | |
| 1126 <td><a href="#Editor.getBookmarkLines">getBookmarkLines</a></td> | |
| 1127 <td>Public method to get the lines containing a bookmark.</td> | |
| 1128 </tr> | |
| 1129 <tr> | |
| 1130 <td><a href="#Editor.getBookmarks">getBookmarks</a></td> | |
| 1131 <td>Public method to retrieve the bookmarks.</td> | |
| 1132 </tr> | |
| 1133 <tr> | |
| 1134 <td><a href="#Editor.getBreakpointLines">getBreakpointLines</a></td> | |
| 1135 <td>Public method to get the lines containing a breakpoint.</td> | |
| 1136 </tr> | |
| 1137 <tr> | |
| 1138 <td><a href="#Editor.getCallTipHook">getCallTipHook</a></td> | |
| 1139 <td>Public method to get the registered calltip provider.</td> | |
| 1140 </tr> | |
| 1141 <tr> | |
| 1142 <td><a href="#Editor.getChangeLines">getChangeLines</a></td> | |
| 1143 <td>Public method to get the lines containing a change.</td> | |
| 1144 </tr> | |
| 1145 <tr> | |
| 1146 <td><a href="#Editor.getCompleter">getCompleter</a></td> | |
| 1147 <td>Public method to retrieve a reference to the completer object.</td> | |
| 1148 </tr> | |
| 1149 <tr> | |
| 1150 <td><a href="#Editor.getCompletionListHook">getCompletionListHook</a></td> | |
| 1151 <td>Public method to get the registered completion list provider.</td> | |
| 1152 </tr> | |
| 1153 <tr> | |
| 1154 <td><a href="#Editor.getCoverageLines">getCoverageLines</a></td> | |
| 1155 <td>Public method to get the lines containing a coverage marker.</td> | |
| 1156 </tr> | |
| 1157 <tr> | |
| 1158 <td><a href="#Editor.getCurrentWord">getCurrentWord</a></td> | |
| 1159 <td>Public method to get the word at the current position.</td> | |
| 1160 </tr> | |
| 1161 <tr> | |
| 1162 <td><a href="#Editor.getCurrentWordBoundaries">getCurrentWordBoundaries</a></td> | |
| 1163 <td>Public method to get the word boundaries at the current position.</td> | |
| 1164 </tr> | |
| 1165 <tr> | |
| 1166 <td><a href="#Editor.getDocstringGenerator">getDocstringGenerator</a></td> | |
| 1167 <td>Public method to get a reference to the docstring generator.</td> | |
| 1168 </tr> | |
| 1169 <tr> | |
| 1170 <td><a href="#Editor.getEditorConfig">getEditorConfig</a></td> | |
| 1171 <td>Public method to get the requested option via EditorConfig.</td> | |
| 1172 </tr> | |
| 1173 <tr> | |
| 1174 <td><a href="#Editor.getEncoding">getEncoding</a></td> | |
| 1175 <td>Public method to return the current encoding.</td> | |
| 1176 </tr> | |
| 1177 <tr> | |
| 1178 <td><a href="#Editor.getFileName">getFileName</a></td> | |
| 1179 <td>Public method to return the name of the file being displayed.</td> | |
| 1180 </tr> | |
| 1181 <tr> | |
| 1182 <td><a href="#Editor.getFileType">getFileType</a></td> | |
| 1183 <td>Public method to return the type of the file being displayed.</td> | |
| 1184 </tr> | |
| 1185 <tr> | |
| 1186 <td><a href="#Editor.getFileTypeByFlag">getFileTypeByFlag</a></td> | |
| 1187 <td>Public method to return the type of the file, if it was set by an eflag: marker.</td> | |
| 1188 </tr> | |
| 1189 <tr> | |
| 1190 <td><a href="#Editor.getHighlightPosition">getHighlightPosition</a></td> | |
| 1191 <td>Public method to return the position of the highlight bar.</td> | |
| 1192 </tr> | |
| 1193 <tr> | |
| 1194 <td><a href="#Editor.getLanguage">getLanguage</a></td> | |
| 1195 <td>Public method to retrieve the language of the editor.</td> | |
| 1196 </tr> | |
| 1197 <tr> | |
| 1198 <td><a href="#Editor.getLexer">getLexer</a></td> | |
| 1199 <td>Public method to retrieve a reference to the lexer object.</td> | |
| 1200 </tr> | |
| 1201 <tr> | |
| 1202 <td><a href="#Editor.getMenu">getMenu</a></td> | |
| 1203 <td>Public method to get a reference to the main context menu or a submenu.</td> | |
| 1204 </tr> | |
| 1205 <tr> | |
| 1206 <td><a href="#Editor.getMouseClickHandler">getMouseClickHandler</a></td> | |
| 1207 <td>Public method to get a registered mouse click handler.</td> | |
| 1208 </tr> | |
| 1209 <tr> | |
| 1210 <td><a href="#Editor.getMouseClickHandlers">getMouseClickHandlers</a></td> | |
| 1211 <td>Public method to get all registered mouse click handlers of a plug-in.</td> | |
| 1212 </tr> | |
| 1213 <tr> | |
| 1214 <td><a href="#Editor.getNoName">getNoName</a></td> | |
| 1215 <td>Public method to get the display string for an unnamed editor.</td> | |
| 1216 </tr> | |
| 1217 <tr> | |
| 1218 <td><a href="#Editor.getSearchIndicatorLines">getSearchIndicatorLines</a></td> | |
| 1219 <td>Public method to get the lines containing a search indicator.</td> | |
| 1220 </tr> | |
| 1221 <tr> | |
| 1222 <td><a href="#Editor.getSearchText">getSearchText</a></td> | |
| 1223 <td>Public method to determine the selection or the current word for the next search operation.</td> | |
| 1224 </tr> | |
| 1225 <tr> | |
| 1226 <td><a href="#Editor.getSharingStatus">getSharingStatus</a></td> | |
| 1227 <td>Public method to get some share status info.</td> | |
| 1228 </tr> | |
| 1229 <tr> | |
| 1230 <td><a href="#Editor.getSpellingLanguage">getSpellingLanguage</a></td> | |
| 1231 <td>Public method to get the current spelling language.</td> | |
| 1232 </tr> | |
| 1233 <tr> | |
| 1234 <td><a href="#Editor.getSyntaxErrorLines">getSyntaxErrorLines</a></td> | |
| 1235 <td>Public method to get the lines containing a syntax error.</td> | |
| 1236 </tr> | |
| 1237 <tr> | |
| 1238 <td><a href="#Editor.getSyntaxErrors">getSyntaxErrors</a></td> | |
| 1239 <td>Public method to retrieve the syntax error markers.</td> | |
| 1240 </tr> | |
| 1241 <tr> | |
| 1242 <td><a href="#Editor.getTaskLines">getTaskLines</a></td> | |
| 1243 <td>Public method to get the lines containing a task.</td> | |
| 1244 </tr> | |
| 1245 <tr> | |
| 1246 <td><a href="#Editor.getVcsConflictMarkerLines">getVcsConflictMarkerLines</a></td> | |
| 1247 <td>Public method to determine the lines containing a VCS conflict marker.</td> | |
| 1248 </tr> | |
| 1249 <tr> | |
| 1250 <td><a href="#Editor.getWarningLines">getWarningLines</a></td> | |
| 1251 <td>Public method to get the lines containing a warning.</td> | |
| 1252 </tr> | |
| 1253 <tr> | |
| 1254 <td><a href="#Editor.getWarnings">getWarnings</a></td> | |
| 1255 <td>Public method to retrieve the warning markers.</td> | |
| 1256 </tr> | |
| 1257 <tr> | |
| 1258 <td><a href="#Editor.getWord">getWord</a></td> | |
| 1259 <td>Public method to get the word at a position.</td> | |
| 1260 </tr> | |
| 1261 <tr> | |
| 1262 <td><a href="#Editor.getWordBoundaries">getWordBoundaries</a></td> | |
| 1263 <td>Public method to get the word boundaries at a position.</td> | |
| 1264 </tr> | |
| 1265 <tr> | |
| 1266 <td><a href="#Editor.getWordLeft">getWordLeft</a></td> | |
| 1267 <td>Public method to get the word to the left of a position.</td> | |
| 1268 </tr> | |
| 1269 <tr> | |
| 1270 <td><a href="#Editor.getWordRight">getWordRight</a></td> | |
| 1271 <td>Public method to get the word to the right of a position.</td> | |
| 1272 </tr> | |
| 1273 <tr> | |
| 1274 <td><a href="#Editor.gotoLastEditPosition">gotoLastEditPosition</a></td> | |
| 1275 <td>Public method to move the cursor to the last edit position.</td> | |
| 1276 </tr> | |
| 1277 <tr> | |
| 1278 <td><a href="#Editor.gotoLine">gotoLine</a></td> | |
| 1279 <td>Public slot to jump to the beginning of a line.</td> | |
| 1280 </tr> | |
| 1281 <tr> | |
| 1282 <td><a href="#Editor.gotoMethodClass">gotoMethodClass</a></td> | |
| 1283 <td>Public method to go to the next Python method or class definition.</td> | |
| 1284 </tr> | |
| 1285 <tr> | |
| 1286 <td><a href="#Editor.gotoReferenceHandler">gotoReferenceHandler</a></td> | |
| 1287 <td>Public method to handle a list of references to perform a goto.</td> | |
| 1288 </tr> | |
| 1289 <tr> | |
| 1290 <td><a href="#Editor.gotoSyntaxError">gotoSyntaxError</a></td> | |
| 1291 <td>Public slot to handle the 'Goto syntax error' context menu action.</td> | |
| 1292 </tr> | |
| 1293 <tr> | |
| 1294 <td><a href="#Editor.handleMonospacedEnable">handleMonospacedEnable</a></td> | |
| 1295 <td>Public slot to handle the Use Monospaced Font context menu entry.</td> | |
| 1296 </tr> | |
| 1297 <tr> | |
| 1298 <td><a href="#Editor.handleRenamed">handleRenamed</a></td> | |
| 1299 <td>Public slot to handle the editorRenamed signal.</td> | |
| 1300 </tr> | |
| 1301 <tr> | |
| 1302 <td><a href="#Editor.hasBookmarks">hasBookmarks</a></td> | |
| 1303 <td>Public method to check for the presence of bookmarks.</td> | |
| 1304 </tr> | |
| 1305 <tr> | |
| 1306 <td><a href="#Editor.hasBreakpoints">hasBreakpoints</a></td> | |
| 1307 <td>Public method to check for the presence of breakpoints.</td> | |
| 1308 </tr> | |
| 1309 <tr> | |
| 1310 <td><a href="#Editor.hasChangeMarkers">hasChangeMarkers</a></td> | |
| 1311 <td>Public method to determine, if this editor contains any change markers.</td> | |
| 1312 </tr> | |
| 1313 <tr> | |
| 1314 <td><a href="#Editor.hasCoverageMarkers">hasCoverageMarkers</a></td> | |
| 1315 <td>Public method to test, if there are coverage markers.</td> | |
| 1316 </tr> | |
| 1317 <tr> | |
| 1318 <td><a href="#Editor.hasMiniMenu">hasMiniMenu</a></td> | |
| 1319 <td>Public method to check the miniMenu flag.</td> | |
| 1320 </tr> | |
| 1321 <tr> | |
| 1322 <td><a href="#Editor.hasSyntaxErrors">hasSyntaxErrors</a></td> | |
| 1323 <td>Public method to check for the presence of syntax errors.</td> | |
| 1324 </tr> | |
| 1325 <tr> | |
| 1326 <td><a href="#Editor.hasTaskMarkers">hasTaskMarkers</a></td> | |
| 1327 <td>Public method to determine, if this editor contains any task markers.</td> | |
| 1328 </tr> | |
| 1329 <tr> | |
| 1330 <td><a href="#Editor.hasWarnings">hasWarnings</a></td> | |
| 1331 <td>Public method to check for the presence of warnings.</td> | |
| 1332 </tr> | |
| 1333 <tr> | |
| 1334 <td><a href="#Editor.highlight">highlight</a></td> | |
| 1335 <td>Public method to highlight [or de-highlight] a particular line.</td> | |
| 1336 </tr> | |
| 1337 <tr> | |
| 1338 <td><a href="#Editor.highlightVisible">highlightVisible</a></td> | |
| 1339 <td>Public method to make sure that the highlight is visible.</td> | |
| 1340 </tr> | |
| 1341 <tr> | |
| 1342 <td><a href="#Editor.indentLineOrSelection">indentLineOrSelection</a></td> | |
| 1343 <td>Public slot to indent the current line or current selection.</td> | |
| 1344 </tr> | |
| 1345 <tr> | |
| 1346 <td><a href="#Editor.insertDocstring">insertDocstring</a></td> | |
| 1347 <td>Public method to generate and insert a docstring for the function under the cursor.</td> | |
| 1348 </tr> | |
| 1349 <tr> | |
| 1350 <td><a href="#Editor.isClone">isClone</a></td> | |
| 1351 <td>Public method to test, if the given editor is a clone.</td> | |
| 1352 </tr> | |
| 1353 <tr> | |
| 1354 <td><a href="#Editor.isCythonFile">isCythonFile</a></td> | |
| 1355 <td>Public method to return a flag indicating a Cython file.</td> | |
| 1356 </tr> | |
| 1357 <tr> | |
| 1358 <td><a href="#Editor.isJavascriptFile">isJavascriptFile</a></td> | |
| 1359 <td>Public method to return a flag indicating a Javascript file.</td> | |
| 1360 </tr> | |
| 1361 <tr> | |
| 1362 <td><a href="#Editor.isLastEditPositionAvailable">isLastEditPositionAvailable</a></td> | |
| 1363 <td>Public method to check, if a last edit position is available.</td> | |
| 1364 </tr> | |
| 1365 <tr> | |
| 1366 <td><a href="#Editor.isMicroPythonFile">isMicroPythonFile</a></td> | |
| 1367 <td>Public method to return a flag indicating a MicroPython file.</td> | |
| 1368 </tr> | |
| 1369 <tr> | |
| 1370 <td><a href="#Editor.isPy3File">isPy3File</a></td> | |
| 1371 <td>Public method to return a flag indicating a Python3 file.</td> | |
| 1372 </tr> | |
| 1373 <tr> | |
| 1374 <td><a href="#Editor.isPyFile">isPyFile</a></td> | |
| 1375 <td>Public method to return a flag indicating a Python (2 or 3) file.</td> | |
| 1376 </tr> | |
| 1377 <tr> | |
| 1378 <td><a href="#Editor.isRubyFile">isRubyFile</a></td> | |
| 1379 <td>Public method to return a flag indicating a Ruby file.</td> | |
| 1380 </tr> | |
| 1381 <tr> | |
| 1382 <td><a href="#Editor.isSpellCheckRegion">isSpellCheckRegion</a></td> | |
| 1383 <td>Public method to check, if the given position is within a region, that should be spell checked.</td> | |
| 1384 </tr> | |
| 1385 <tr> | |
| 1386 <td><a href="#Editor.joinLines">joinLines</a></td> | |
| 1387 <td>Public slot to join the current line with the next one.</td> | |
| 1388 </tr> | |
| 1389 <tr> | |
| 1390 <td><a href="#Editor.keyPressEvent">keyPressEvent</a></td> | |
| 1391 <td>Protected method to handle the user input a key at a time.</td> | |
| 1392 </tr> | |
| 1393 <tr> | |
| 1394 <td><a href="#Editor.macroDelete">macroDelete</a></td> | |
| 1395 <td>Public method to delete a macro.</td> | |
| 1396 </tr> | |
| 1397 <tr> | |
| 1398 <td><a href="#Editor.macroLoad">macroLoad</a></td> | |
| 1399 <td>Public method to load a macro from a file.</td> | |
| 1400 </tr> | |
| 1401 <tr> | |
| 1402 <td><a href="#Editor.macroRecordingStart">macroRecordingStart</a></td> | |
| 1403 <td>Public method to start macro recording.</td> | |
| 1404 </tr> | |
| 1405 <tr> | |
| 1406 <td><a href="#Editor.macroRecordingStop">macroRecordingStop</a></td> | |
| 1407 <td>Public method to stop macro recording.</td> | |
| 1408 </tr> | |
| 1409 <tr> | |
| 1410 <td><a href="#Editor.macroRun">macroRun</a></td> | |
| 1411 <td>Public method to execute a macro.</td> | |
| 1412 </tr> | |
| 1413 <tr> | |
| 1414 <td><a href="#Editor.macroSave">macroSave</a></td> | |
| 1415 <td>Public method to save a macro to a file.</td> | |
| 1416 </tr> | |
| 1417 <tr> | |
| 1418 <td><a href="#Editor.menuEditBreakpoint">menuEditBreakpoint</a></td> | |
| 1419 <td>Public slot to handle the 'Edit breakpoint' context menu action.</td> | |
| 1420 </tr> | |
| 1421 <tr> | |
| 1422 <td><a href="#Editor.menuNextBreakpoint">menuNextBreakpoint</a></td> | |
| 1423 <td>Public slot to handle the 'Next breakpoint' context menu action.</td> | |
| 1424 </tr> | |
| 1425 <tr> | |
| 1426 <td><a href="#Editor.menuPreviousBreakpoint">menuPreviousBreakpoint</a></td> | |
| 1427 <td>Public slot to handle the 'Previous breakpoint' context menu action.</td> | |
| 1428 </tr> | |
| 1429 <tr> | |
| 1430 <td><a href="#Editor.menuToggleBookmark">menuToggleBookmark</a></td> | |
| 1431 <td>Public slot to handle the 'Toggle bookmark' context menu action.</td> | |
| 1432 </tr> | |
| 1433 <tr> | |
| 1434 <td><a href="#Editor.menuToggleBreakpoint">menuToggleBreakpoint</a></td> | |
| 1435 <td>Public slot to handle the 'Toggle breakpoint' context menu action.</td> | |
| 1436 </tr> | |
| 1437 <tr> | |
| 1438 <td><a href="#Editor.mouseDoubleClickEvent">mouseDoubleClickEvent</a></td> | |
| 1439 <td>Protected method to handle mouse double click events.</td> | |
| 1440 </tr> | |
| 1441 <tr> | |
| 1442 <td><a href="#Editor.mousePressEvent">mousePressEvent</a></td> | |
| 1443 <td>Protected method to handle the mouse press event.</td> | |
| 1444 </tr> | |
| 1445 <tr> | |
| 1446 <td><a href="#Editor.mouseReleaseEvent">mouseReleaseEvent</a></td> | |
| 1447 <td>Protected method calling a registered mouse click handler function.</td> | |
| 1448 </tr> | |
| 1449 <tr> | |
| 1450 <td><a href="#Editor.newBreakpointWithProperties">newBreakpointWithProperties</a></td> | |
| 1451 <td>Public method to set a new breakpoint and its properties.</td> | |
| 1452 </tr> | |
| 1453 <tr> | |
| 1454 <td><a href="#Editor.nextBookmark">nextBookmark</a></td> | |
| 1455 <td>Public slot to handle the 'Next bookmark' context menu action.</td> | |
| 1456 </tr> | |
| 1457 <tr> | |
| 1458 <td><a href="#Editor.nextChange">nextChange</a></td> | |
| 1459 <td>Public slot to handle the 'Next change' context menu action.</td> | |
| 1460 </tr> | |
| 1461 <tr> | |
| 1462 <td><a href="#Editor.nextTask">nextTask</a></td> | |
| 1463 <td>Public slot to handle the 'Next task' context menu action.</td> | |
| 1464 </tr> | |
| 1465 <tr> | |
| 1466 <td><a href="#Editor.nextUncovered">nextUncovered</a></td> | |
| 1467 <td>Public slot to handle the 'Next uncovered' context menu action.</td> | |
| 1468 </tr> | |
| 1469 <tr> | |
| 1470 <td><a href="#Editor.nextWarning">nextWarning</a></td> | |
| 1471 <td>Public slot to handle the 'Next warning' context menu action.</td> | |
| 1472 </tr> | |
| 1473 <tr> | |
| 1474 <td><a href="#Editor.previousBookmark">previousBookmark</a></td> | |
| 1475 <td>Public slot to handle the 'Previous bookmark' context menu action.</td> | |
| 1476 </tr> | |
| 1477 <tr> | |
| 1478 <td><a href="#Editor.previousChange">previousChange</a></td> | |
| 1479 <td>Public slot to handle the 'Previous change' context menu action.</td> | |
| 1480 </tr> | |
| 1481 <tr> | |
| 1482 <td><a href="#Editor.previousTask">previousTask</a></td> | |
| 1483 <td>Public slot to handle the 'Previous task' context menu action.</td> | |
| 1484 </tr> | |
| 1485 <tr> | |
| 1486 <td><a href="#Editor.previousUncovered">previousUncovered</a></td> | |
| 1487 <td>Public slot to handle the 'Previous uncovered' context menu action.</td> | |
| 1488 </tr> | |
| 1489 <tr> | |
| 1490 <td><a href="#Editor.previousWarning">previousWarning</a></td> | |
| 1491 <td>Public slot to handle the 'Previous warning' context menu action.</td> | |
| 1492 </tr> | |
| 1493 <tr> | |
| 1494 <td><a href="#Editor.printFile">printFile</a></td> | |
| 1495 <td>Public slot to print the text.</td> | |
| 1496 </tr> | |
| 1497 <tr> | |
| 1498 <td><a href="#Editor.printPreviewFile">printPreviewFile</a></td> | |
| 1499 <td>Public slot to show a print preview of the text.</td> | |
| 1500 </tr> | |
| 1501 <tr> | |
| 1502 <td><a href="#Editor.projectClosed">projectClosed</a></td> | |
| 1503 <td>Public slot to handle the closing of a project.</td> | |
| 1504 </tr> | |
| 1505 <tr> | |
| 1506 <td><a href="#Editor.projectLexerAssociationsChanged">projectLexerAssociationsChanged</a></td> | |
| 1507 <td>Public slot to handle changes of the project lexer associations.</td> | |
| 1508 </tr> | |
| 1509 <tr> | |
| 1510 <td><a href="#Editor.projectOpened">projectOpened</a></td> | |
| 1511 <td>Public slot to handle the opening of a project.</td> | |
| 1512 </tr> | |
| 1513 <tr> | |
| 1514 <td><a href="#Editor.readFile">readFile</a></td> | |
| 1515 <td>Public slot to read the text from a file.</td> | |
| 1516 </tr> | |
| 1517 <tr> | |
| 1518 <td><a href="#Editor.readSettings">readSettings</a></td> | |
| 1519 <td>Public slot to read the settings into our lexer.</td> | |
| 1520 </tr> | |
| 1521 <tr> | |
| 1522 <td><a href="#Editor.receive">receive</a></td> | |
| 1523 <td>Public slot to handle received editor commands.</td> | |
| 1524 </tr> | |
| 1525 <tr> | |
| 1526 <td><a href="#Editor.redo">redo</a></td> | |
| 1527 <td>Public method to redo the last recorded change.</td> | |
| 1528 </tr> | |
| 1529 <tr> | |
| 1530 <td><a href="#Editor.refresh">refresh</a></td> | |
| 1531 <td>Public slot to refresh the editor contents.</td> | |
| 1532 </tr> | |
| 1533 <tr> | |
| 1534 <td><a href="#Editor.refreshCoverageAnnotations">refreshCoverageAnnotations</a></td> | |
| 1535 <td>Public method to refresh the code coverage annotations.</td> | |
| 1536 </tr> | |
| 1537 <tr> | |
| 1538 <td><a href="#Editor.registerMouseHoverHelpFunction">registerMouseHoverHelpFunction</a></td> | |
| 1539 <td>Public method to register a mouse hover help function.</td> | |
| 1540 </tr> | |
| 1541 <tr> | |
| 1542 <td><a href="#Editor.removeCallTipHook">removeCallTipHook</a></td> | |
| 1543 <td>Public method to remove a previously registered calltip provider.</td> | |
| 1544 </tr> | |
| 1545 <tr> | |
| 1546 <td><a href="#Editor.removeClone">removeClone</a></td> | |
| 1547 <td>Public method to remove a clone from our list.</td> | |
| 1548 </tr> | |
| 1549 <tr> | |
| 1550 <td><a href="#Editor.removeCompletionListHook">removeCompletionListHook</a></td> | |
| 1551 <td>Public method to remove a previously registered completion list provider.</td> | |
| 1552 </tr> | |
| 1553 <tr> | |
| 1554 <td><a href="#Editor.removeMouseClickHandler">removeMouseClickHandler</a></td> | |
| 1555 <td>Public method to un-registered a mouse click handler.</td> | |
| 1556 </tr> | |
| 1557 <tr> | |
| 1558 <td><a href="#Editor.removeMouseClickHandlers">removeMouseClickHandlers</a></td> | |
| 1559 <td>Public method to un-registered all mouse click handlers of a plug-in.</td> | |
| 1560 </tr> | |
| 1561 <tr> | |
| 1562 <td><a href="#Editor.resizeEvent">resizeEvent</a></td> | |
| 1563 <td>Protected method handling resize events.</td> | |
| 1564 </tr> | |
| 1565 <tr> | |
| 1566 <td><a href="#Editor.revertToUnmodified">revertToUnmodified</a></td> | |
| 1567 <td>Public method to revert back to the last saved state.</td> | |
| 1568 </tr> | |
| 1569 <tr> | |
| 1570 <td><a href="#Editor.saveFile">saveFile</a></td> | |
| 1571 <td>Public method to save the text to a file.</td> | |
| 1572 </tr> | |
| 1573 <tr> | |
| 1574 <td><a href="#Editor.saveFileAs">saveFileAs</a></td> | |
| 1575 <td>Public slot to save a file with a new name.</td> | |
| 1576 </tr> | |
| 1577 <tr> | |
| 1578 <td><a href="#Editor.saveFileCopy">saveFileCopy</a></td> | |
| 1579 <td>Public method to save a copy of the file.</td> | |
| 1580 </tr> | |
| 1581 <tr> | |
| 1582 <td><a href="#Editor.searchCurrentWordBackward">searchCurrentWordBackward</a></td> | |
| 1583 <td>Public slot to search the current word backward.</td> | |
| 1584 </tr> | |
| 1585 <tr> | |
| 1586 <td><a href="#Editor.searchCurrentWordForward">searchCurrentWordForward</a></td> | |
| 1587 <td>Public slot to search the current word forward.</td> | |
| 1588 </tr> | |
| 1589 <tr> | |
| 1590 <td><a href="#Editor.selectCurrentWord">selectCurrentWord</a></td> | |
| 1591 <td>Public method to select the current word.</td> | |
| 1592 </tr> | |
| 1593 <tr> | |
| 1594 <td><a href="#Editor.selectWord">selectWord</a></td> | |
| 1595 <td>Public method to select the word at a position.</td> | |
| 1596 </tr> | |
| 1597 <tr> | |
| 1598 <td><a href="#Editor.sendSharedEdit">sendSharedEdit</a></td> | |
| 1599 <td>Public slot to end a shared edit session for the editor and send the changes.</td> | |
| 1600 </tr> | |
| 1601 <tr> | |
| 1602 <td><a href="#Editor.setAutoCompletionEnabled">setAutoCompletionEnabled</a></td> | |
| 1603 <td>Public method to enable/disable autocompletion.</td> | |
| 1604 </tr> | |
| 1605 <tr> | |
| 1606 <td><a href="#Editor.setAutoSpellChecking">setAutoSpellChecking</a></td> | |
| 1607 <td>Public method to set the automatic spell checking.</td> | |
| 1608 </tr> | |
| 1609 <tr> | |
| 1610 <td><a href="#Editor.setHighlight">setHighlight</a></td> | |
| 1611 <td>Public method to set a text highlight.</td> | |
| 1612 </tr> | |
| 1613 <tr> | |
| 1614 <td><a href="#Editor.setLanguage">setLanguage</a></td> | |
| 1615 <td>Public method to set a lexer language.</td> | |
| 1616 </tr> | |
| 1617 <tr> | |
| 1618 <td><a href="#Editor.setMonospaced">setMonospaced</a></td> | |
| 1619 <td>Public method to set/reset a monospaced font.</td> | |
| 1620 </tr> | |
| 1621 <tr> | |
| 1622 <td><a href="#Editor.setMouseClickHandler">setMouseClickHandler</a></td> | |
| 1623 <td>Public method to set a mouse click handler.</td> | |
| 1624 </tr> | |
| 1625 <tr> | |
| 1626 <td><a href="#Editor.setNoName">setNoName</a></td> | |
| 1627 <td>Public method to set the display string for an unnamed editor.</td> | |
| 1628 </tr> | |
| 1629 <tr> | |
| 1630 <td><a href="#Editor.setSearchIndicator">setSearchIndicator</a></td> | |
| 1631 <td>Public method to set a search indicator for the given range.</td> | |
| 1632 </tr> | |
| 1633 <tr> | |
| 1634 <td><a href="#Editor.setSpellingForProject">setSpellingForProject</a></td> | |
| 1635 <td>Public method to set the spell checking options for files belonging to the current project.</td> | |
| 1636 </tr> | |
| 1637 <tr> | |
| 1638 <td><a href="#Editor.shareConnected">shareConnected</a></td> | |
| 1639 <td>Public slot to handle a change of the connected state.</td> | |
| 1640 </tr> | |
| 1641 <tr> | |
| 1642 <td><a href="#Editor.shareEditor">shareEditor</a></td> | |
| 1643 <td>Public slot to set the shared status of the editor.</td> | |
| 1644 </tr> | |
| 1645 <tr> | |
| 1646 <td><a href="#Editor.shortenEmptyLines">shortenEmptyLines</a></td> | |
| 1647 <td>Public slot to compress lines consisting solely of whitespace characters.</td> | |
| 1648 </tr> | |
| 1649 <tr> | |
| 1650 <td><a href="#Editor.shouldAutosave">shouldAutosave</a></td> | |
| 1651 <td>Public slot to check the autosave flags.</td> | |
| 1652 </tr> | |
| 1653 <tr> | |
| 1654 <td><a href="#Editor.showMouseHoverHelpData">showMouseHoverHelpData</a></td> | |
| 1655 <td>Public method to show the mouse hover help data.</td> | |
| 1656 </tr> | |
| 1657 <tr> | |
| 1658 <td><a href="#Editor.smartIndentLineOrSelection">smartIndentLineOrSelection</a></td> | |
| 1659 <td>Public slot to indent current line smartly.</td> | |
| 1660 </tr> | |
| 1661 <tr> | |
| 1662 <td><a href="#Editor.sortLines">sortLines</a></td> | |
| 1663 <td>Public slot to sort the lines spanned by a rectangular selection.</td> | |
| 1664 </tr> | |
| 1665 <tr> | |
| 1666 <td><a href="#Editor.startSharedEdit">startSharedEdit</a></td> | |
| 1667 <td>Public slot to start a shared edit session for the editor.</td> | |
| 1668 </tr> | |
| 1669 <tr> | |
| 1670 <td><a href="#Editor.streamCommentLine">streamCommentLine</a></td> | |
| 1671 <td>Public slot to stream comment the current line.</td> | |
| 1672 </tr> | |
| 1673 <tr> | |
| 1674 <td><a href="#Editor.streamCommentLineOrSelection">streamCommentLineOrSelection</a></td> | |
| 1675 <td>Public slot to stream comment the current line or current selection.</td> | |
| 1676 </tr> | |
| 1677 <tr> | |
| 1678 <td><a href="#Editor.streamCommentSelection">streamCommentSelection</a></td> | |
| 1679 <td>Public slot to comment the current selection.</td> | |
| 1680 </tr> | |
| 1681 <tr> | |
| 1682 <td><a href="#Editor.toggleBookmark">toggleBookmark</a></td> | |
| 1683 <td>Public method to toggle a bookmark.</td> | |
| 1684 </tr> | |
| 1685 <tr> | |
| 1686 <td><a href="#Editor.toggleCommentBlock">toggleCommentBlock</a></td> | |
| 1687 <td>Public slot to toggle the comment of a block.</td> | |
| 1688 </tr> | |
| 1689 <tr> | |
| 1690 <td><a href="#Editor.toggleCurrentFold">toggleCurrentFold</a></td> | |
| 1691 <td>Public slot to toggle the fold containing the current line.</td> | |
| 1692 </tr> | |
| 1693 <tr> | |
| 1694 <td><a href="#Editor.toggleSyntaxError">toggleSyntaxError</a></td> | |
| 1695 <td>Public method to toggle a syntax error indicator.</td> | |
| 1696 </tr> | |
| 1697 <tr> | |
| 1698 <td><a href="#Editor.toggleWarning">toggleWarning</a></td> | |
| 1699 <td>Public method to toggle a warning indicator.</td> | |
| 1700 </tr> | |
| 1701 <tr> | |
| 1702 <td><a href="#Editor.uncommentLine">uncommentLine</a></td> | |
| 1703 <td>Public slot to uncomment the current line.</td> | |
| 1704 </tr> | |
| 1705 <tr> | |
| 1706 <td><a href="#Editor.uncommentLineOrSelection">uncommentLineOrSelection</a></td> | |
| 1707 <td>Public slot to uncomment the current line or current selection.</td> | |
| 1708 </tr> | |
| 1709 <tr> | |
| 1710 <td><a href="#Editor.uncommentSelection">uncommentSelection</a></td> | |
| 1711 <td>Public slot to uncomment the current selection.</td> | |
| 1712 </tr> | |
| 1713 <tr> | |
| 1714 <td><a href="#Editor.undo">undo</a></td> | |
| 1715 <td>Public method to undo the last recorded change.</td> | |
| 1716 </tr> | |
| 1717 <tr> | |
| 1718 <td><a href="#Editor.unindentLineOrSelection">unindentLineOrSelection</a></td> | |
| 1719 <td>Public slot to unindent the current line or current selection.</td> | |
| 1720 </tr> | |
| 1721 <tr> | |
| 1722 <td><a href="#Editor.unregisterMouseHoverHelpFunction">unregisterMouseHoverHelpFunction</a></td> | |
| 1723 <td>Public method to unregister a mouse hover help function.</td> | |
| 1724 </tr> | |
| 1725 <tr> | |
| 1726 <td><a href="#Editor.updateMarkerMap">updateMarkerMap</a></td> | |
| 1727 <td>Public method to initiate an update of the marker map.</td> | |
| 1728 </tr> | |
| 1729 <tr> | |
| 1730 <td><a href="#Editor.viewportEvent">viewportEvent</a></td> | |
| 1731 <td>Protected method handling event of the viewport.</td> | |
| 1732 </tr> | |
| 1733 <tr> | |
| 1734 <td><a href="#Editor.wheelEvent">wheelEvent</a></td> | |
| 1735 <td>Protected method to handle wheel events.</td> | |
| 1736 </tr> | |
| 1737 <tr> | |
| 1738 <td><a href="#Editor.writeFile">writeFile</a></td> | |
| 1739 <td>Public slot to write the text to a file.</td> | |
| 1740 </tr> | |
| 1741 </table> | |
| 1742 <h3>Static Methods</h3> | |
| 1743 | |
| 1744 <table> | |
| 1745 <tr><td>None</td></tr> | |
| 1746 </table> | |
| 1747 | |
| 1748 <a NAME="Editor.__init__" ID="Editor.__init__"></a> | |
| 1749 <h4>Editor (Constructor)</h4> | |
| 1750 <b>Editor</b>(<i>dbs, fn="", vm=None, filetype="", editor=None, tv=None, parent=None</i>) | |
| 1751 | |
| 1752 <p> | |
| 1753 Constructor | |
| 1754 </p> | |
| 1755 <dl> | |
| 1756 | |
| 1757 <dt><i>dbs</i> (DebugServer)</dt> | |
| 1758 <dd> | |
| 1759 reference to the debug server object | |
| 1760 </dd> | |
| 1761 <dt><i>fn</i> (str)</dt> | |
| 1762 <dd> | |
| 1763 name of the file to be opened. If it is None, a new (empty) | |
| 1764 editor is opened. | |
| 1765 </dd> | |
| 1766 <dt><i>vm</i> (ViewManager)</dt> | |
| 1767 <dd> | |
| 1768 reference to the view manager object | |
| 1769 </dd> | |
| 1770 <dt><i>filetype</i> (str)</dt> | |
| 1771 <dd> | |
| 1772 type of the source file | |
| 1773 </dd> | |
| 1774 <dt><i>editor</i> (Editor)</dt> | |
| 1775 <dd> | |
| 1776 reference to an Editor object, if this is a cloned view | |
| 1777 </dd> | |
| 1778 <dt><i>tv</i> (TaskViewer)</dt> | |
| 1779 <dd> | |
| 1780 reference to the task viewer object | |
| 1781 </dd> | |
| 1782 <dt><i>parent</i> (QWidget)</dt> | |
| 1783 <dd> | |
| 1784 reference to the parent widget | |
| 1785 </dd> | |
| 1786 </dl> | |
| 1787 <dl> | |
| 1788 | |
| 1789 <dt>Raises <b>OSError</b>:</dt> | |
| 1790 <dd> | |
| 1791 raised to indicate an issue accessing the file | |
| 1792 </dd> | |
| 1793 </dl> | |
| 1794 <a NAME="Editor.__addBreakPoint" ID="Editor.__addBreakPoint"></a> | |
| 1795 <h4>Editor.__addBreakPoint</h4> | |
| 1796 <b>__addBreakPoint</b>(<i>line, temporary</i>) | |
| 1797 | |
| 1798 <p> | |
| 1799 Private method to add a new breakpoint. | |
| 1800 </p> | |
| 1801 <dl> | |
| 1802 | |
| 1803 <dt><i>line</i></dt> | |
| 1804 <dd> | |
| 1805 line number of the breakpoint (integer) | |
| 1806 </dd> | |
| 1807 <dt><i>temporary</i></dt> | |
| 1808 <dd> | |
| 1809 flag indicating a temporary breakpoint (boolean) | |
| 1810 </dd> | |
| 1811 </dl> | |
| 1812 <a NAME="Editor.__addBreakPoints" ID="Editor.__addBreakPoints"></a> | |
| 1813 <h4>Editor.__addBreakPoints</h4> | |
| 1814 <b>__addBreakPoints</b>(<i>parentIndex, start, end</i>) | |
| 1815 | |
| 1816 <p> | |
| 1817 Private slot to add breakpoints. | |
| 1818 </p> | |
| 1819 <dl> | |
| 1820 | |
| 1821 <dt><i>parentIndex</i></dt> | |
| 1822 <dd> | |
| 1823 index of parent item (QModelIndex) | |
| 1824 </dd> | |
| 1825 <dt><i>start</i></dt> | |
| 1826 <dd> | |
| 1827 start row (integer) | |
| 1828 </dd> | |
| 1829 <dt><i>end</i></dt> | |
| 1830 <dd> | |
| 1831 end row (integer) | |
| 1832 </dd> | |
| 1833 </dl> | |
| 1834 <a NAME="Editor.__addFileAliasResource" ID="Editor.__addFileAliasResource"></a> | |
| 1835 <h4>Editor.__addFileAliasResource</h4> | |
| 1836 <b>__addFileAliasResource</b>(<i></i>) | |
| 1837 | |
| 1838 <p> | |
| 1839 Private method to handle the Add aliased file context menu action. | |
| 1840 </p> | |
| 1841 <a NAME="Editor.__addFileResource" ID="Editor.__addFileResource"></a> | |
| 1842 <h4>Editor.__addFileResource</h4> | |
| 1843 <b>__addFileResource</b>(<i></i>) | |
| 1844 | |
| 1845 <p> | |
| 1846 Private method to handle the Add file context menu action. | |
| 1847 </p> | |
| 1848 <a NAME="Editor.__addFileResources" ID="Editor.__addFileResources"></a> | |
| 1849 <h4>Editor.__addFileResources</h4> | |
| 1850 <b>__addFileResources</b>(<i></i>) | |
| 1851 | |
| 1852 <p> | |
| 1853 Private method to handle the Add files context menu action. | |
| 1854 </p> | |
| 1855 <a NAME="Editor.__addLocalizedResource" ID="Editor.__addLocalizedResource"></a> | |
| 1856 <h4>Editor.__addLocalizedResource</h4> | |
| 1857 <b>__addLocalizedResource</b>(<i></i>) | |
| 1858 | |
| 1859 <p> | |
| 1860 Private method to handle the Add localized resource context menu | |
| 1861 action. | |
| 1862 </p> | |
| 1863 <a NAME="Editor.__addResourceFrame" ID="Editor.__addResourceFrame"></a> | |
| 1864 <h4>Editor.__addResourceFrame</h4> | |
| 1865 <b>__addResourceFrame</b>(<i></i>) | |
| 1866 | |
| 1867 <p> | |
| 1868 Private method to handle the Add resource frame context menu action. | |
| 1869 </p> | |
| 1870 <a NAME="Editor.__addToSpellingDictionary" ID="Editor.__addToSpellingDictionary"></a> | |
| 1871 <h4>Editor.__addToSpellingDictionary</h4> | |
| 1872 <b>__addToSpellingDictionary</b>(<i></i>) | |
| 1873 | |
| 1874 <p> | |
| 1875 Private slot to add the word below the spelling context menu to the | |
| 1876 dictionary. | |
| 1877 </p> | |
| 1878 <a NAME="Editor.__adjustedCallTipPosition" ID="Editor.__adjustedCallTipPosition"></a> | |
| 1879 <h4>Editor.__adjustedCallTipPosition</h4> | |
| 1880 <b>__adjustedCallTipPosition</b>(<i>ctshift, pos</i>) | |
| 1881 | |
| 1882 <p> | |
| 1883 Private method to calculate an adjusted position for showing calltips. | |
| 1884 </p> | |
| 1885 <dl> | |
| 1886 | |
| 1887 <dt><i>ctshift</i></dt> | |
| 1888 <dd> | |
| 1889 amount the calltip shall be shifted (integer) | |
| 1890 </dd> | |
| 1891 <dt><i>pos</i></dt> | |
| 1892 <dd> | |
| 1893 position into the text (integer) | |
| 1894 </dd> | |
| 1895 </dl> | |
| 1896 <dl> | |
| 1897 <dt>Return:</dt> | |
| 1898 <dd> | |
| 1899 new position for the calltip (integer) | |
| 1900 </dd> | |
| 1901 </dl> | |
| 1902 <a NAME="Editor.__applyTemplate" ID="Editor.__applyTemplate"></a> | |
| 1903 <h4>Editor.__applyTemplate</h4> | |
| 1904 <b>__applyTemplate</b>(<i>templateName, language</i>) | |
| 1905 | |
| 1906 <p> | |
| 1907 Private method to apply a template by name. | |
| 1908 </p> | |
| 1909 <dl> | |
| 1910 | |
| 1911 <dt><i>templateName</i></dt> | |
| 1912 <dd> | |
| 1913 name of the template to apply (string) | |
| 1914 </dd> | |
| 1915 <dt><i>language</i></dt> | |
| 1916 <dd> | |
| 1917 name of the language (group) to get the template | |
| 1918 from (string) | |
| 1919 </dd> | |
| 1920 </dl> | |
| 1921 <a NAME="Editor.__autoComplete" ID="Editor.__autoComplete"></a> | |
| 1922 <h4>Editor.__autoComplete</h4> | |
| 1923 <b>__autoComplete</b>(<i>auto=True, context=None</i>) | |
| 1924 | |
| 1925 <p> | |
| 1926 Private method to start auto-completion via plug-ins. | |
| 1927 </p> | |
| 1928 <dl> | |
| 1929 | |
| 1930 <dt><i>auto</i></dt> | |
| 1931 <dd> | |
| 1932 flag indicating a call from the __charAdded method | |
| 1933 (boolean) | |
| 1934 </dd> | |
| 1935 <dt><i>context</i> (bool or None)</dt> | |
| 1936 <dd> | |
| 1937 flag indicating to complete a context | |
| 1938 </dd> | |
| 1939 </dl> | |
| 1940 <a NAME="Editor.__autocompletionCancelled" ID="Editor.__autocompletionCancelled"></a> | |
| 1941 <h4>Editor.__autocompletionCancelled</h4> | |
| 1942 <b>__autocompletionCancelled</b>(<i></i>) | |
| 1943 | |
| 1944 <p> | |
| 1945 Private slot to handle the cancellation of an auto-completion list. | |
| 1946 </p> | |
| 1947 <a NAME="Editor.__autosaveEnable" ID="Editor.__autosaveEnable"></a> | |
| 1948 <h4>Editor.__autosaveEnable</h4> | |
| 1949 <b>__autosaveEnable</b>(<i></i>) | |
| 1950 | |
| 1951 <p> | |
| 1952 Private slot handling the autosave enable context menu action. | |
| 1953 </p> | |
| 1954 <a NAME="Editor.__bindCompleter" ID="Editor.__bindCompleter"></a> | |
| 1955 <h4>Editor.__bindCompleter</h4> | |
| 1956 <b>__bindCompleter</b>(<i>filename</i>) | |
| 1957 | |
| 1958 <p> | |
| 1959 Private slot to set the correct typing completer depending on language. | |
| 1960 </p> | |
| 1961 <dl> | |
| 1962 | |
| 1963 <dt><i>filename</i></dt> | |
| 1964 <dd> | |
| 1965 filename used to determine the associated typing | |
| 1966 completer language (string) | |
| 1967 </dd> | |
| 1968 </dl> | |
| 1969 <a NAME="Editor.__bindLexer" ID="Editor.__bindLexer"></a> | |
| 1970 <h4>Editor.__bindLexer</h4> | |
| 1971 <b>__bindLexer</b>(<i>filename, pyname=""</i>) | |
| 1972 | |
| 1973 <p> | |
| 1974 Private slot to set the correct lexer depending on language. | |
| 1975 </p> | |
| 1976 <dl> | |
| 1977 | |
| 1978 <dt><i>filename</i></dt> | |
| 1979 <dd> | |
| 1980 filename used to determine the associated lexer | |
| 1981 language (string) | |
| 1982 </dd> | |
| 1983 <dt><i>pyname</i></dt> | |
| 1984 <dd> | |
| 1985 name of the pygments lexer to use (string) | |
| 1986 </dd> | |
| 1987 </dl> | |
| 1988 <a NAME="Editor.__bindName" ID="Editor.__bindName"></a> | |
| 1989 <h4>Editor.__bindName</h4> | |
| 1990 <b>__bindName</b>(<i>line0</i>) | |
| 1991 | |
| 1992 <p> | |
| 1993 Private method to generate a dummy filename for binding a lexer. | |
| 1994 </p> | |
| 1995 <dl> | |
| 1996 | |
| 1997 <dt><i>line0</i></dt> | |
| 1998 <dd> | |
| 1999 first line of text to use in the generation process | |
| 2000 (string) | |
| 2001 </dd> | |
| 2002 </dl> | |
| 2003 <dl> | |
| 2004 <dt>Return:</dt> | |
| 2005 <dd> | |
| 2006 dummy file name to be used for binding a lexer (string) | |
| 2007 </dd> | |
| 2008 </dl> | |
| 2009 <a NAME="Editor.__breakPointDataAboutToBeChanged" ID="Editor.__breakPointDataAboutToBeChanged"></a> | |
| 2010 <h4>Editor.__breakPointDataAboutToBeChanged</h4> | |
| 2011 <b>__breakPointDataAboutToBeChanged</b>(<i>startIndex, endIndex</i>) | |
| 2012 | |
| 2013 <p> | |
| 2014 Private slot to handle the dataAboutToBeChanged signal of the | |
| 2015 breakpoint model. | |
| 2016 </p> | |
| 2017 <dl> | |
| 2018 | |
| 2019 <dt><i>startIndex</i></dt> | |
| 2020 <dd> | |
| 2021 start index of the rows to be changed (QModelIndex) | |
| 2022 </dd> | |
| 2023 <dt><i>endIndex</i></dt> | |
| 2024 <dd> | |
| 2025 end index of the rows to be changed (QModelIndex) | |
| 2026 </dd> | |
| 2027 </dl> | |
| 2028 <a NAME="Editor.__calculateChanges" ID="Editor.__calculateChanges"></a> | |
| 2029 <h4>Editor.__calculateChanges</h4> | |
| 2030 <b>__calculateChanges</b>(<i>old, new</i>) | |
| 2031 | |
| 2032 <p> | |
| 2033 Private method to determine change commands to convert old text into | |
| 2034 new text. | |
| 2035 </p> | |
| 2036 <dl> | |
| 2037 | |
| 2038 <dt><i>old</i></dt> | |
| 2039 <dd> | |
| 2040 old text (string) | |
| 2041 </dd> | |
| 2042 <dt><i>new</i></dt> | |
| 2043 <dd> | |
| 2044 new text (string) | |
| 2045 </dd> | |
| 2046 </dl> | |
| 2047 <dl> | |
| 2048 <dt>Return:</dt> | |
| 2049 <dd> | |
| 2050 commands to change old into new (string) | |
| 2051 </dd> | |
| 2052 </dl> | |
| 2053 <a NAME="Editor.__callTip" ID="Editor.__callTip"></a> | |
| 2054 <h4>Editor.__callTip</h4> | |
| 2055 <b>__callTip</b>(<i></i>) | |
| 2056 | |
| 2057 <p> | |
| 2058 Private method to show call tips provided by a plugin. | |
| 2059 </p> | |
| 2060 <a NAME="Editor.__cancelMouseHoverHelp" ID="Editor.__cancelMouseHoverHelp"></a> | |
| 2061 <h4>Editor.__cancelMouseHoverHelp</h4> | |
| 2062 <b>__cancelMouseHoverHelp</b>(<i></i>) | |
| 2063 | |
| 2064 <p> | |
| 2065 Private slot cancelling the display of mouse hover help. | |
| 2066 </p> | |
| 2067 <a NAME="Editor.__changeBreakPoints" ID="Editor.__changeBreakPoints"></a> | |
| 2068 <h4>Editor.__changeBreakPoints</h4> | |
| 2069 <b>__changeBreakPoints</b>(<i>startIndex, endIndex</i>) | |
| 2070 | |
| 2071 <p> | |
| 2072 Private slot to set changed breakpoints. | |
| 2073 </p> | |
| 2074 <dl> | |
| 2075 | |
| 2076 <dt><i>startIndex</i></dt> | |
| 2077 <dd> | |
| 2078 start index of the breakpoints being changed | |
| 2079 (QModelIndex) | |
| 2080 </dd> | |
| 2081 <dt><i>endIndex</i></dt> | |
| 2082 <dd> | |
| 2083 end index of the breakpoints being changed | |
| 2084 (QModelIndex) | |
| 2085 </dd> | |
| 2086 </dl> | |
| 2087 <a NAME="Editor.__charAdded" ID="Editor.__charAdded"></a> | |
| 2088 <h4>Editor.__charAdded</h4> | |
| 2089 <b>__charAdded</b>(<i>charNumber</i>) | |
| 2090 | |
| 2091 <p> | |
| 2092 Private slot called to handle the user entering a character. | |
| 2093 </p> | |
| 2094 <dl> | |
| 2095 | |
| 2096 <dt><i>charNumber</i></dt> | |
| 2097 <dd> | |
| 2098 value of the character entered (integer) | |
| 2099 </dd> | |
| 2100 </dl> | |
| 2101 <a NAME="Editor.__checkEncoding" ID="Editor.__checkEncoding"></a> | |
| 2102 <h4>Editor.__checkEncoding</h4> | |
| 2103 <b>__checkEncoding</b>(<i></i>) | |
| 2104 | |
| 2105 <p> | |
| 2106 Private method to check the selected encoding of the encodings submenu. | |
| 2107 </p> | |
| 2108 <a NAME="Editor.__checkEol" ID="Editor.__checkEol"></a> | |
| 2109 <h4>Editor.__checkEol</h4> | |
| 2110 <b>__checkEol</b>(<i></i>) | |
| 2111 | |
| 2112 <p> | |
| 2113 Private method to check the selected eol type of the eol submenu. | |
| 2114 </p> | |
| 2115 <a NAME="Editor.__checkLanguage" ID="Editor.__checkLanguage"></a> | |
| 2116 <h4>Editor.__checkLanguage</h4> | |
| 2117 <b>__checkLanguage</b>(<i></i>) | |
| 2118 | |
| 2119 <p> | |
| 2120 Private method to check the selected language of the language submenu. | |
| 2121 </p> | |
| 2122 <a NAME="Editor.__checkSpellLanguage" ID="Editor.__checkSpellLanguage"></a> | |
| 2123 <h4>Editor.__checkSpellLanguage</h4> | |
| 2124 <b>__checkSpellLanguage</b>(<i></i>) | |
| 2125 | |
| 2126 <p> | |
| 2127 Private slot to check the selected spell check language action. | |
| 2128 </p> | |
| 2129 <a NAME="Editor.__checkSpellingSelection" ID="Editor.__checkSpellingSelection"></a> | |
| 2130 <h4>Editor.__checkSpellingSelection</h4> | |
| 2131 <b>__checkSpellingSelection</b>(<i></i>) | |
| 2132 | |
| 2133 <p> | |
| 2134 Private slot to spell check the current selection. | |
| 2135 </p> | |
| 2136 <a NAME="Editor.__checkSpellingWord" ID="Editor.__checkSpellingWord"></a> | |
| 2137 <h4>Editor.__checkSpellingWord</h4> | |
| 2138 <b>__checkSpellingWord</b>(<i></i>) | |
| 2139 | |
| 2140 <p> | |
| 2141 Private slot to check the word below the spelling context menu. | |
| 2142 </p> | |
| 2143 <a NAME="Editor.__clearBreakpoints" ID="Editor.__clearBreakpoints"></a> | |
| 2144 <h4>Editor.__clearBreakpoints</h4> | |
| 2145 <b>__clearBreakpoints</b>(<i>fileName</i>) | |
| 2146 | |
| 2147 <p> | |
| 2148 Private slot to clear all breakpoints. | |
| 2149 </p> | |
| 2150 <dl> | |
| 2151 | |
| 2152 <dt><i>fileName</i></dt> | |
| 2153 <dd> | |
| 2154 name of the file (string) | |
| 2155 </dd> | |
| 2156 </dl> | |
| 2157 <a NAME="Editor.__clearCompletionsCache" ID="Editor.__clearCompletionsCache"></a> | |
| 2158 <h4>Editor.__clearCompletionsCache</h4> | |
| 2159 <b>__clearCompletionsCache</b>(<i></i>) | |
| 2160 | |
| 2161 <p> | |
| 2162 Private method to clear the auto-completions cache. | |
| 2163 </p> | |
| 2164 <a NAME="Editor.__clearTypedWarning" ID="Editor.__clearTypedWarning"></a> | |
| 2165 <h4>Editor.__clearTypedWarning</h4> | |
| 2166 <b>__clearTypedWarning</b>(<i>warningKind</i>) | |
| 2167 | |
| 2168 <p> | |
| 2169 Private method to clear warnings of a specific kind. | |
| 2170 </p> | |
| 2171 <dl> | |
| 2172 | |
| 2173 <dt><i>warningKind</i></dt> | |
| 2174 <dd> | |
| 2175 kind of warning to clear (Editor.WarningCode, | |
| 2176 Editor.WarningStyle) | |
| 2177 </dd> | |
| 2178 </dl> | |
| 2179 <a NAME="Editor.__codeCoverageHideAnnotations" ID="Editor.__codeCoverageHideAnnotations"></a> | |
| 2180 <h4>Editor.__codeCoverageHideAnnotations</h4> | |
| 2181 <b>__codeCoverageHideAnnotations</b>(<i></i>) | |
| 2182 | |
| 2183 <p> | |
| 2184 Private method to handle the hide code coverage annotations context | |
| 2185 menu action. | |
| 2186 </p> | |
| 2187 <a NAME="Editor.__completionListSelected" ID="Editor.__completionListSelected"></a> | |
| 2188 <h4>Editor.__completionListSelected</h4> | |
| 2189 <b>__completionListSelected</b>(<i>listId, txt</i>) | |
| 2190 | |
| 2191 <p> | |
| 2192 Private slot to handle the selection from the completion list. | |
| 2193 </p> | |
| 2194 <dl> | |
| 2195 | |
| 2196 <dt><i>listId</i></dt> | |
| 2197 <dd> | |
| 2198 the ID of the user list (should be 1 or 2) (integer) | |
| 2199 </dd> | |
| 2200 <dt><i>txt</i></dt> | |
| 2201 <dd> | |
| 2202 the selected text (string) | |
| 2203 </dd> | |
| 2204 </dl> | |
| 2205 <a NAME="Editor.__contextClose" ID="Editor.__contextClose"></a> | |
| 2206 <h4>Editor.__contextClose</h4> | |
| 2207 <b>__contextClose</b>(<i></i>) | |
| 2208 | |
| 2209 <p> | |
| 2210 Private slot handling the close context menu entry. | |
| 2211 </p> | |
| 2212 <a NAME="Editor.__contextMenuCollapseFoldWithChildren" ID="Editor.__contextMenuCollapseFoldWithChildren"></a> | |
| 2213 <h4>Editor.__contextMenuCollapseFoldWithChildren</h4> | |
| 2214 <b>__contextMenuCollapseFoldWithChildren</b>(<i></i>) | |
| 2215 | |
| 2216 <p> | |
| 2217 Private slot to handle the context menu collapse with children action. | |
| 2218 </p> | |
| 2219 <a NAME="Editor.__contextMenuExpandFoldWithChildren" ID="Editor.__contextMenuExpandFoldWithChildren"></a> | |
| 2220 <h4>Editor.__contextMenuExpandFoldWithChildren</h4> | |
| 2221 <b>__contextMenuExpandFoldWithChildren</b>(<i></i>) | |
| 2222 | |
| 2223 <p> | |
| 2224 Private slot to handle the context menu expand with children action. | |
| 2225 </p> | |
| 2226 <a NAME="Editor.__contextMenuSpellingTriggered" ID="Editor.__contextMenuSpellingTriggered"></a> | |
| 2227 <h4>Editor.__contextMenuSpellingTriggered</h4> | |
| 2228 <b>__contextMenuSpellingTriggered</b>(<i>action</i>) | |
| 2229 | |
| 2230 <p> | |
| 2231 Private slot to handle the selection of a suggestion of the spelling | |
| 2232 context menu. | |
| 2233 </p> | |
| 2234 <dl> | |
| 2235 | |
| 2236 <dt><i>action</i></dt> | |
| 2237 <dd> | |
| 2238 reference to the action that was selected (QAction) | |
| 2239 </dd> | |
| 2240 </dl> | |
| 2241 <a NAME="Editor.__contextSave" ID="Editor.__contextSave"></a> | |
| 2242 <h4>Editor.__contextSave</h4> | |
| 2243 <b>__contextSave</b>(<i></i>) | |
| 2244 | |
| 2245 <p> | |
| 2246 Private slot handling the save context menu entry. | |
| 2247 </p> | |
| 2248 <a NAME="Editor.__contextSaveAs" ID="Editor.__contextSaveAs"></a> | |
| 2249 <h4>Editor.__contextSaveAs</h4> | |
| 2250 <b>__contextSaveAs</b>(<i></i>) | |
| 2251 | |
| 2252 <p> | |
| 2253 Private slot handling the save as context menu entry. | |
| 2254 </p> | |
| 2255 <a NAME="Editor.__contextSaveCopy" ID="Editor.__contextSaveCopy"></a> | |
| 2256 <h4>Editor.__contextSaveCopy</h4> | |
| 2257 <b>__contextSaveCopy</b>(<i></i>) | |
| 2258 | |
| 2259 <p> | |
| 2260 Private slot handling the save copy context menu entry. | |
| 2261 </p> | |
| 2262 <a NAME="Editor.__convertTabs" ID="Editor.__convertTabs"></a> | |
| 2263 <h4>Editor.__convertTabs</h4> | |
| 2264 <b>__convertTabs</b>(<i></i>) | |
| 2265 | |
| 2266 <p> | |
| 2267 Private slot to convert tabulators to spaces. | |
| 2268 </p> | |
| 2269 <a NAME="Editor.__createChangeMarkerPixmap" ID="Editor.__createChangeMarkerPixmap"></a> | |
| 2270 <h4>Editor.__createChangeMarkerPixmap</h4> | |
| 2271 <b>__createChangeMarkerPixmap</b>(<i>key, size=16, width=4</i>) | |
| 2272 | |
| 2273 <p> | |
| 2274 Private method to create a pixmap for the change markers. | |
| 2275 </p> | |
| 2276 <dl> | |
| 2277 | |
| 2278 <dt><i>key</i></dt> | |
| 2279 <dd> | |
| 2280 key of the color to use (string) | |
| 2281 </dd> | |
| 2282 <dt><i>size</i></dt> | |
| 2283 <dd> | |
| 2284 size of the pixmap (integer) | |
| 2285 </dd> | |
| 2286 <dt><i>width</i></dt> | |
| 2287 <dd> | |
| 2288 width of the marker line (integer) | |
| 2289 </dd> | |
| 2290 </dl> | |
| 2291 <dl> | |
| 2292 <dt>Return:</dt> | |
| 2293 <dd> | |
| 2294 create pixmap (QPixmap) | |
| 2295 </dd> | |
| 2296 </dl> | |
| 2297 <a NAME="Editor.__cursorPositionChanged" ID="Editor.__cursorPositionChanged"></a> | |
| 2298 <h4>Editor.__cursorPositionChanged</h4> | |
| 2299 <b>__cursorPositionChanged</b>(<i>line, index</i>) | |
| 2300 | |
| 2301 <p> | |
| 2302 Private slot to handle the cursorPositionChanged signal. | |
| 2303 </p> | |
| 2304 <p> | |
| 2305 It emits the signal cursorChanged with parameters fileName, | |
| 2306 line and pos. | |
| 2307 </p> | |
| 2308 <dl> | |
| 2309 | |
| 2310 <dt><i>line</i></dt> | |
| 2311 <dd> | |
| 2312 line number of the cursor | |
| 2313 </dd> | |
| 2314 <dt><i>index</i></dt> | |
| 2315 <dd> | |
| 2316 position in line of the cursor | |
| 2317 </dd> | |
| 2318 </dl> | |
| 2319 <a NAME="Editor.__delayedDocstringMenuPopup" ID="Editor.__delayedDocstringMenuPopup"></a> | |
| 2320 <h4>Editor.__delayedDocstringMenuPopup</h4> | |
| 2321 <b>__delayedDocstringMenuPopup</b>(<i>cursorPosition</i>) | |
| 2322 | |
| 2323 <p> | |
| 2324 Private method to test, if the user might want to insert a docstring. | |
| 2325 </p> | |
| 2326 <dl> | |
| 2327 | |
| 2328 <dt><i>cursorPosition</i> (tuple of (int, int))</dt> | |
| 2329 <dd> | |
| 2330 current cursor position (line and column) | |
| 2331 </dd> | |
| 2332 </dl> | |
| 2333 <a NAME="Editor.__deleteAllChangeMarkers" ID="Editor.__deleteAllChangeMarkers"></a> | |
| 2334 <h4>Editor.__deleteAllChangeMarkers</h4> | |
| 2335 <b>__deleteAllChangeMarkers</b>(<i></i>) | |
| 2336 | |
| 2337 <p> | |
| 2338 Private slot to delete all change markers. | |
| 2339 </p> | |
| 2340 <a NAME="Editor.__deleteBreakPoints" ID="Editor.__deleteBreakPoints"></a> | |
| 2341 <h4>Editor.__deleteBreakPoints</h4> | |
| 2342 <b>__deleteBreakPoints</b>(<i>parentIndex, start, end</i>) | |
| 2343 | |
| 2344 <p> | |
| 2345 Private slot to delete breakpoints. | |
| 2346 </p> | |
| 2347 <dl> | |
| 2348 | |
| 2349 <dt><i>parentIndex</i></dt> | |
| 2350 <dd> | |
| 2351 index of parent item (QModelIndex) | |
| 2352 </dd> | |
| 2353 <dt><i>start</i></dt> | |
| 2354 <dd> | |
| 2355 start row (integer) | |
| 2356 </dd> | |
| 2357 <dt><i>end</i></dt> | |
| 2358 <dd> | |
| 2359 end row (integer) | |
| 2360 </dd> | |
| 2361 </dl> | |
| 2362 <a NAME="Editor.__deselectAll" ID="Editor.__deselectAll"></a> | |
| 2363 <h4>Editor.__deselectAll</h4> | |
| 2364 <b>__deselectAll</b>(<i></i>) | |
| 2365 | |
| 2366 <p> | |
| 2367 Private slot handling the deselect all context menu action. | |
| 2368 </p> | |
| 2369 <a NAME="Editor.__dispatchCommand" ID="Editor.__dispatchCommand"></a> | |
| 2370 <h4>Editor.__dispatchCommand</h4> | |
| 2371 <b>__dispatchCommand</b>(<i>command</i>) | |
| 2372 | |
| 2373 <p> | |
| 2374 Private method to dispatch received commands. | |
| 2375 </p> | |
| 2376 <dl> | |
| 2377 | |
| 2378 <dt><i>command</i></dt> | |
| 2379 <dd> | |
| 2380 command to be processed (string) | |
| 2381 </dd> | |
| 2382 </dl> | |
| 2383 <a NAME="Editor.__encodingChanged" ID="Editor.__encodingChanged"></a> | |
| 2384 <h4>Editor.__encodingChanged</h4> | |
| 2385 <b>__encodingChanged</b>(<i>encoding, propagate=True</i>) | |
| 2386 | |
| 2387 <p> | |
| 2388 Private slot to handle a change of the encoding. | |
| 2389 </p> | |
| 2390 <dl> | |
| 2391 | |
| 2392 <dt><i>encoding</i></dt> | |
| 2393 <dd> | |
| 2394 changed encoding (string) | |
| 2395 </dd> | |
| 2396 <dt><i>propagate</i></dt> | |
| 2397 <dd> | |
| 2398 flag indicating to propagate the change (boolean) | |
| 2399 </dd> | |
| 2400 </dl> | |
| 2401 <a NAME="Editor.__encodingsMenuTriggered" ID="Editor.__encodingsMenuTriggered"></a> | |
| 2402 <h4>Editor.__encodingsMenuTriggered</h4> | |
| 2403 <b>__encodingsMenuTriggered</b>(<i>act</i>) | |
| 2404 | |
| 2405 <p> | |
| 2406 Private method to handle the selection of an encoding. | |
| 2407 </p> | |
| 2408 <dl> | |
| 2409 | |
| 2410 <dt><i>act</i></dt> | |
| 2411 <dd> | |
| 2412 reference to the action that was triggered (QAction) | |
| 2413 </dd> | |
| 2414 </dl> | |
| 2415 <a NAME="Editor.__eolChanged" ID="Editor.__eolChanged"></a> | |
| 2416 <h4>Editor.__eolChanged</h4> | |
| 2417 <b>__eolChanged</b>(<i></i>) | |
| 2418 | |
| 2419 <p> | |
| 2420 Private slot to handle a change of the eol mode. | |
| 2421 </p> | |
| 2422 <a NAME="Editor.__eolMenuTriggered" ID="Editor.__eolMenuTriggered"></a> | |
| 2423 <h4>Editor.__eolMenuTriggered</h4> | |
| 2424 <b>__eolMenuTriggered</b>(<i>act</i>) | |
| 2425 | |
| 2426 <p> | |
| 2427 Private method to handle the selection of an eol type. | |
| 2428 </p> | |
| 2429 <dl> | |
| 2430 | |
| 2431 <dt><i>act</i></dt> | |
| 2432 <dd> | |
| 2433 reference to the action that was triggered (QAction) | |
| 2434 </dd> | |
| 2435 </dl> | |
| 2436 <a NAME="Editor.__executeSelection" ID="Editor.__executeSelection"></a> | |
| 2437 <h4>Editor.__executeSelection</h4> | |
| 2438 <b>__executeSelection</b>(<i></i>) | |
| 2439 | |
| 2440 <p> | |
| 2441 Private slot to execute the selected text in the shell window. | |
| 2442 </p> | |
| 2443 <a NAME="Editor.__getAcText" ID="Editor.__getAcText"></a> | |
| 2444 <h4>Editor.__getAcText</h4> | |
| 2445 <b>__getAcText</b>(<i></i>) | |
| 2446 | |
| 2447 <p> | |
| 2448 Private method to get the text from cursor position for autocompleting. | |
| 2449 </p> | |
| 2450 <dl> | |
| 2451 <dt>Return:</dt> | |
| 2452 <dd> | |
| 2453 text left of cursor position | |
| 2454 </dd> | |
| 2455 </dl> | |
| 2456 <dl> | |
| 2457 <dt>Return Type:</dt> | |
| 2458 <dd> | |
| 2459 str | |
| 2460 </dd> | |
| 2461 </dl> | |
| 2462 <a NAME="Editor.__getCharacter" ID="Editor.__getCharacter"></a> | |
| 2463 <h4>Editor.__getCharacter</h4> | |
| 2464 <b>__getCharacter</b>(<i>pos</i>) | |
| 2465 | |
| 2466 <p> | |
| 2467 Private method to get the character to the left of the current position | |
| 2468 in the current line. | |
| 2469 </p> | |
| 2470 <dl> | |
| 2471 | |
| 2472 <dt><i>pos</i></dt> | |
| 2473 <dd> | |
| 2474 position to get character at (integer) | |
| 2475 </dd> | |
| 2476 </dl> | |
| 2477 <dl> | |
| 2478 <dt>Return:</dt> | |
| 2479 <dd> | |
| 2480 requested character or "", if there are no more (string) and | |
| 2481 the next position (i.e. pos - 1) | |
| 2482 </dd> | |
| 2483 </dl> | |
| 2484 <a NAME="Editor.__getCodeCoverageFile" ID="Editor.__getCodeCoverageFile"></a> | |
| 2485 <h4>Editor.__getCodeCoverageFile</h4> | |
| 2486 <b>__getCodeCoverageFile</b>(<i></i>) | |
| 2487 | |
| 2488 <p> | |
| 2489 Private method to get the file name of the file containing coverage | |
| 2490 info. | |
| 2491 </p> | |
| 2492 <dl> | |
| 2493 <dt>Return:</dt> | |
| 2494 <dd> | |
| 2495 file name of the coverage file | |
| 2496 </dd> | |
| 2497 </dl> | |
| 2498 <dl> | |
| 2499 <dt>Return Type:</dt> | |
| 2500 <dd> | |
| 2501 str | |
| 2502 </dd> | |
| 2503 </dl> | |
| 2504 <a NAME="Editor.__getEditorConfig" ID="Editor.__getEditorConfig"></a> | |
| 2505 <h4>Editor.__getEditorConfig</h4> | |
| 2506 <b>__getEditorConfig</b>(<i>option, nodefault=False, config=None</i>) | |
| 2507 | |
| 2508 <p> | |
| 2509 Private method to get the requested option via EditorConfig. | |
| 2510 </p> | |
| 2511 <p> | |
| 2512 If there is no EditorConfig defined, the equivalent built-in option | |
| 2513 will be used (Preferences.getEditor() ). The option must be given as | |
| 2514 the Preferences option key. The mapping to the EditorConfig option name | |
| 2515 will be done within this method. | |
| 2516 </p> | |
| 2517 <dl> | |
| 2518 | |
| 2519 <dt><i>option</i> (str)</dt> | |
| 2520 <dd> | |
| 2521 Preferences option key | |
| 2522 </dd> | |
| 2523 <dt><i>nodefault</i> (bool)</dt> | |
| 2524 <dd> | |
| 2525 flag indicating to not get the default value from | |
| 2526 Preferences but return None instead | |
| 2527 </dd> | |
| 2528 <dt><i>config</i> (dict)</dt> | |
| 2529 <dd> | |
| 2530 reference to an EditorConfig object or None | |
| 2531 </dd> | |
| 2532 </dl> | |
| 2533 <dl> | |
| 2534 <dt>Return:</dt> | |
| 2535 <dd> | |
| 2536 value of requested setting or None if nothing was found and | |
| 2537 nodefault parameter was True | |
| 2538 </dd> | |
| 2539 </dl> | |
| 2540 <dl> | |
| 2541 <dt>Return Type:</dt> | |
| 2542 <dd> | |
| 2543 any | |
| 2544 </dd> | |
| 2545 </dl> | |
| 2546 <a NAME="Editor.__getMacroName" ID="Editor.__getMacroName"></a> | |
| 2547 <h4>Editor.__getMacroName</h4> | |
| 2548 <b>__getMacroName</b>(<i></i>) | |
| 2549 | |
| 2550 <p> | |
| 2551 Private method to select a macro name from the list of macros. | |
| 2552 </p> | |
| 2553 <dl> | |
| 2554 <dt>Return:</dt> | |
| 2555 <dd> | |
| 2556 Tuple of macro name and a flag, indicating, if the user | |
| 2557 pressed ok or canceled the operation. (string, boolean) | |
| 2558 </dd> | |
| 2559 </dl> | |
| 2560 <a NAME="Editor.__getOverrideValue" ID="Editor.__getOverrideValue"></a> | |
| 2561 <h4>Editor.__getOverrideValue</h4> | |
| 2562 <b>__getOverrideValue</b>(<i>option</i>) | |
| 2563 | |
| 2564 <p> | |
| 2565 Private method to get an override value for the current file type. | |
| 2566 </p> | |
| 2567 <dl> | |
| 2568 | |
| 2569 <dt><i>option</i> (str)</dt> | |
| 2570 <dd> | |
| 2571 Preferences option key | |
| 2572 </dd> | |
| 2573 </dl> | |
| 2574 <dl> | |
| 2575 <dt>Return:</dt> | |
| 2576 <dd> | |
| 2577 override value; None in case nothing is defined | |
| 2578 </dd> | |
| 2579 </dl> | |
| 2580 <dl> | |
| 2581 <dt>Return Type:</dt> | |
| 2582 <dd> | |
| 2583 any | |
| 2584 </dd> | |
| 2585 </dl> | |
| 2586 <a NAME="Editor.__getPyVersion" ID="Editor.__getPyVersion"></a> | |
| 2587 <h4>Editor.__getPyVersion</h4> | |
| 2588 <b>__getPyVersion</b>(<i></i>) | |
| 2589 | |
| 2590 <p> | |
| 2591 Private method to return the Python main version or 0 if it's | |
| 2592 not a Python file at all. | |
| 2593 </p> | |
| 2594 <dl> | |
| 2595 <dt>Return:</dt> | |
| 2596 <dd> | |
| 2597 Python version or 0 if it's not a Python file (int) | |
| 2598 </dd> | |
| 2599 </dl> | |
| 2600 <a NAME="Editor.__getSaveFileName" ID="Editor.__getSaveFileName"></a> | |
| 2601 <h4>Editor.__getSaveFileName</h4> | |
| 2602 <b>__getSaveFileName</b>(<i>path=None</i>) | |
| 2603 | |
| 2604 <p> | |
| 2605 Private method to get the name of the file to be saved. | |
| 2606 </p> | |
| 2607 <dl> | |
| 2608 | |
| 2609 <dt><i>path</i></dt> | |
| 2610 <dd> | |
| 2611 directory to save the file in (string) | |
| 2612 </dd> | |
| 2613 </dl> | |
| 2614 <dl> | |
| 2615 <dt>Return:</dt> | |
| 2616 <dd> | |
| 2617 file name (string) | |
| 2618 </dd> | |
| 2619 </dl> | |
| 2620 <a NAME="Editor.__ignoreSpellingAlways" ID="Editor.__ignoreSpellingAlways"></a> | |
| 2621 <h4>Editor.__ignoreSpellingAlways</h4> | |
| 2622 <b>__ignoreSpellingAlways</b>(<i></i>) | |
| 2623 | |
| 2624 <p> | |
| 2625 Private to always ignore the word below the spelling context menu. | |
| 2626 </p> | |
| 2627 <a NAME="Editor.__indentLine" ID="Editor.__indentLine"></a> | |
| 2628 <h4>Editor.__indentLine</h4> | |
| 2629 <b>__indentLine</b>(<i>indent=True</i>) | |
| 2630 | |
| 2631 <p> | |
| 2632 Private method to indent or unindent the current line. | |
| 2633 </p> | |
| 2634 <dl> | |
| 2635 | |
| 2636 <dt><i>indent</i></dt> | |
| 2637 <dd> | |
| 2638 flag indicating an indent operation (boolean) | |
| 2639 <br />If the flag is true, an indent operation is performed. | |
| 2640 Otherwise the current line is unindented. | |
| 2641 </dd> | |
| 2642 </dl> | |
| 2643 <a NAME="Editor.__indentSelection" ID="Editor.__indentSelection"></a> | |
| 2644 <h4>Editor.__indentSelection</h4> | |
| 2645 <b>__indentSelection</b>(<i>indent=True</i>) | |
| 2646 | |
| 2647 <p> | |
| 2648 Private method to indent or unindent the current selection. | |
| 2649 </p> | |
| 2650 <dl> | |
| 2651 | |
| 2652 <dt><i>indent</i></dt> | |
| 2653 <dd> | |
| 2654 flag indicating an indent operation (boolean) | |
| 2655 <br />If the flag is true, an indent operation is performed. | |
| 2656 Otherwise the current line is unindented. | |
| 2657 </dd> | |
| 2658 </dl> | |
| 2659 <a NAME="Editor.__initContextMenu" ID="Editor.__initContextMenu"></a> | |
| 2660 <h4>Editor.__initContextMenu</h4> | |
| 2661 <b>__initContextMenu</b>(<i></i>) | |
| 2662 | |
| 2663 <p> | |
| 2664 Private method used to setup the context menu. | |
| 2665 </p> | |
| 2666 <a NAME="Editor.__initContextMenuAutocompletion" ID="Editor.__initContextMenuAutocompletion"></a> | |
| 2667 <h4>Editor.__initContextMenuAutocompletion</h4> | |
| 2668 <b>__initContextMenuAutocompletion</b>(<i></i>) | |
| 2669 | |
| 2670 <p> | |
| 2671 Private method used to setup the Checks context sub menu. | |
| 2672 </p> | |
| 2673 <dl> | |
| 2674 <dt>Return:</dt> | |
| 2675 <dd> | |
| 2676 reference to the generated menu | |
| 2677 </dd> | |
| 2678 </dl> | |
| 2679 <dl> | |
| 2680 <dt>Return Type:</dt> | |
| 2681 <dd> | |
| 2682 QMenu | |
| 2683 </dd> | |
| 2684 </dl> | |
| 2685 <a NAME="Editor.__initContextMenuChecks" ID="Editor.__initContextMenuChecks"></a> | |
| 2686 <h4>Editor.__initContextMenuChecks</h4> | |
| 2687 <b>__initContextMenuChecks</b>(<i></i>) | |
| 2688 | |
| 2689 <p> | |
| 2690 Private method used to setup the Checks context sub menu. | |
| 2691 </p> | |
| 2692 <dl> | |
| 2693 <dt>Return:</dt> | |
| 2694 <dd> | |
| 2695 reference to the generated menu | |
| 2696 </dd> | |
| 2697 </dl> | |
| 2698 <dl> | |
| 2699 <dt>Return Type:</dt> | |
| 2700 <dd> | |
| 2701 QMenu | |
| 2702 </dd> | |
| 2703 </dl> | |
| 2704 <a NAME="Editor.__initContextMenuEncodings" ID="Editor.__initContextMenuEncodings"></a> | |
| 2705 <h4>Editor.__initContextMenuEncodings</h4> | |
| 2706 <b>__initContextMenuEncodings</b>(<i></i>) | |
| 2707 | |
| 2708 <p> | |
| 2709 Private method used to setup the Encodings context sub menu. | |
| 2710 </p> | |
| 2711 <dl> | |
| 2712 <dt>Return:</dt> | |
| 2713 <dd> | |
| 2714 reference to the generated menu | |
| 2715 </dd> | |
| 2716 </dl> | |
| 2717 <dl> | |
| 2718 <dt>Return Type:</dt> | |
| 2719 <dd> | |
| 2720 QMenu | |
| 2721 </dd> | |
| 2722 </dl> | |
| 2723 <a NAME="Editor.__initContextMenuEol" ID="Editor.__initContextMenuEol"></a> | |
| 2724 <h4>Editor.__initContextMenuEol</h4> | |
| 2725 <b>__initContextMenuEol</b>(<i></i>) | |
| 2726 | |
| 2727 <p> | |
| 2728 Private method to setup the eol context sub menu. | |
| 2729 </p> | |
| 2730 <dl> | |
| 2731 <dt>Return:</dt> | |
| 2732 <dd> | |
| 2733 reference to the generated menu | |
| 2734 </dd> | |
| 2735 </dl> | |
| 2736 <dl> | |
| 2737 <dt>Return Type:</dt> | |
| 2738 <dd> | |
| 2739 QMenu | |
| 2740 </dd> | |
| 2741 </dl> | |
| 2742 <a NAME="Editor.__initContextMenuGraphics" ID="Editor.__initContextMenuGraphics"></a> | |
| 2743 <h4>Editor.__initContextMenuGraphics</h4> | |
| 2744 <b>__initContextMenuGraphics</b>(<i></i>) | |
| 2745 | |
| 2746 <p> | |
| 2747 Private method used to setup the diagrams context sub menu. | |
| 2748 </p> | |
| 2749 <dl> | |
| 2750 <dt>Return:</dt> | |
| 2751 <dd> | |
| 2752 reference to the generated menu | |
| 2753 </dd> | |
| 2754 </dl> | |
| 2755 <dl> | |
| 2756 <dt>Return Type:</dt> | |
| 2757 <dd> | |
| 2758 QMenu | |
| 2759 </dd> | |
| 2760 </dl> | |
| 2761 <a NAME="Editor.__initContextMenuLanguages" ID="Editor.__initContextMenuLanguages"></a> | |
| 2762 <h4>Editor.__initContextMenuLanguages</h4> | |
| 2763 <b>__initContextMenuLanguages</b>(<i></i>) | |
| 2764 | |
| 2765 <p> | |
| 2766 Private method used to setup the Languages context sub menu. | |
| 2767 </p> | |
| 2768 <dl> | |
| 2769 <dt>Return:</dt> | |
| 2770 <dd> | |
| 2771 reference to the generated menu | |
| 2772 </dd> | |
| 2773 </dl> | |
| 2774 <dl> | |
| 2775 <dt>Return Type:</dt> | |
| 2776 <dd> | |
| 2777 QMenu | |
| 2778 </dd> | |
| 2779 </dl> | |
| 2780 <a NAME="Editor.__initContextMenuMargins" ID="Editor.__initContextMenuMargins"></a> | |
| 2781 <h4>Editor.__initContextMenuMargins</h4> | |
| 2782 <b>__initContextMenuMargins</b>(<i></i>) | |
| 2783 | |
| 2784 <p> | |
| 2785 Private method used to setup the context menu for the margins. | |
| 2786 </p> | |
| 2787 <a NAME="Editor.__initContextMenuReopenWithEncoding" ID="Editor.__initContextMenuReopenWithEncoding"></a> | |
| 2788 <h4>Editor.__initContextMenuReopenWithEncoding</h4> | |
| 2789 <b>__initContextMenuReopenWithEncoding</b>(<i></i>) | |
| 2790 | |
| 2791 <p> | |
| 2792 Private method used to setup the Reopen With Encoding context sub menu. | |
| 2793 </p> | |
| 2794 <dl> | |
| 2795 <dt>Return:</dt> | |
| 2796 <dd> | |
| 2797 reference to the generated menu | |
| 2798 </dd> | |
| 2799 </dl> | |
| 2800 <dl> | |
| 2801 <dt>Return Type:</dt> | |
| 2802 <dd> | |
| 2803 QMenu | |
| 2804 </dd> | |
| 2805 </dl> | |
| 2806 <a NAME="Editor.__initContextMenuResources" ID="Editor.__initContextMenuResources"></a> | |
| 2807 <h4>Editor.__initContextMenuResources</h4> | |
| 2808 <b>__initContextMenuResources</b>(<i></i>) | |
| 2809 | |
| 2810 <p> | |
| 2811 Private method used to setup the Resources context sub menu. | |
| 2812 </p> | |
| 2813 <dl> | |
| 2814 <dt>Return:</dt> | |
| 2815 <dd> | |
| 2816 reference to the generated menu (QMenu) | |
| 2817 </dd> | |
| 2818 </dl> | |
| 2819 <a NAME="Editor.__initContextMenuShow" ID="Editor.__initContextMenuShow"></a> | |
| 2820 <h4>Editor.__initContextMenuShow</h4> | |
| 2821 <b>__initContextMenuShow</b>(<i></i>) | |
| 2822 | |
| 2823 <p> | |
| 2824 Private method used to setup the Show context sub menu. | |
| 2825 </p> | |
| 2826 <dl> | |
| 2827 <dt>Return:</dt> | |
| 2828 <dd> | |
| 2829 reference to the generated menu | |
| 2830 </dd> | |
| 2831 </dl> | |
| 2832 <dl> | |
| 2833 <dt>Return Type:</dt> | |
| 2834 <dd> | |
| 2835 QMenu | |
| 2836 </dd> | |
| 2837 </dl> | |
| 2838 <a NAME="Editor.__initContextMenuSpellCheck" ID="Editor.__initContextMenuSpellCheck"></a> | |
| 2839 <h4>Editor.__initContextMenuSpellCheck</h4> | |
| 2840 <b>__initContextMenuSpellCheck</b>(<i></i>) | |
| 2841 | |
| 2842 <p> | |
| 2843 Private method used to setup the spell checking context sub menu. | |
| 2844 </p> | |
| 2845 <dl> | |
| 2846 <dt>Return:</dt> | |
| 2847 <dd> | |
| 2848 reference to the generated menu | |
| 2849 </dd> | |
| 2850 </dl> | |
| 2851 <dl> | |
| 2852 <dt>Return Type:</dt> | |
| 2853 <dd> | |
| 2854 QMenu | |
| 2855 </dd> | |
| 2856 </dl> | |
| 2857 <a NAME="Editor.__initContextMenuSpellLanguages" ID="Editor.__initContextMenuSpellLanguages"></a> | |
| 2858 <h4>Editor.__initContextMenuSpellLanguages</h4> | |
| 2859 <b>__initContextMenuSpellLanguages</b>(<i></i>) | |
| 2860 | |
| 2861 <p> | |
| 2862 Private method to setup the spell checking languages context sub menu. | |
| 2863 </p> | |
| 2864 <dl> | |
| 2865 <dt>Return:</dt> | |
| 2866 <dd> | |
| 2867 reference to the generated menu | |
| 2868 </dd> | |
| 2869 </dl> | |
| 2870 <dl> | |
| 2871 <dt>Return Type:</dt> | |
| 2872 <dd> | |
| 2873 QMenu | |
| 2874 </dd> | |
| 2875 </dl> | |
| 2876 <a NAME="Editor.__initContextMenuTools" ID="Editor.__initContextMenuTools"></a> | |
| 2877 <h4>Editor.__initContextMenuTools</h4> | |
| 2878 <b>__initContextMenuTools</b>(<i></i>) | |
| 2879 | |
| 2880 <p> | |
| 2881 Private method used to setup the Tools context sub menu. | |
| 2882 </p> | |
| 2883 <dl> | |
| 2884 <dt>Return:</dt> | |
| 2885 <dd> | |
| 2886 reference to the generated menu | |
| 2887 </dd> | |
| 2888 </dl> | |
| 2889 <dl> | |
| 2890 <dt>Return Type:</dt> | |
| 2891 <dd> | |
| 2892 QMenu | |
| 2893 </dd> | |
| 2894 </dl> | |
| 2895 <a NAME="Editor.__initOnlineChangeTrace" ID="Editor.__initOnlineChangeTrace"></a> | |
| 2896 <h4>Editor.__initOnlineChangeTrace</h4> | |
| 2897 <b>__initOnlineChangeTrace</b>(<i></i>) | |
| 2898 | |
| 2899 <p> | |
| 2900 Private slot to initialize the online change trace. | |
| 2901 </p> | |
| 2902 <a NAME="Editor.__initOnlineSyntaxCheck" ID="Editor.__initOnlineSyntaxCheck"></a> | |
| 2903 <h4>Editor.__initOnlineSyntaxCheck</h4> | |
| 2904 <b>__initOnlineSyntaxCheck</b>(<i></i>) | |
| 2905 | |
| 2906 <p> | |
| 2907 Private slot to initialize the online syntax check. | |
| 2908 </p> | |
| 2909 <a NAME="Editor.__insertDocstring" ID="Editor.__insertDocstring"></a> | |
| 2910 <h4>Editor.__insertDocstring</h4> | |
| 2911 <b>__insertDocstring</b>(<i></i>) | |
| 2912 | |
| 2913 <p> | |
| 2914 Private slot to generate and insert a docstring for the function under | |
| 2915 the cursor. | |
| 2916 </p> | |
| 2917 <a NAME="Editor.__isCommentedLine" ID="Editor.__isCommentedLine"></a> | |
| 2918 <h4>Editor.__isCommentedLine</h4> | |
| 2919 <b>__isCommentedLine</b>(<i>line, commentStr</i>) | |
| 2920 | |
| 2921 <p> | |
| 2922 Private method to check, if the given line is a comment line as | |
| 2923 produced by the configured comment rules. | |
| 2924 </p> | |
| 2925 <dl> | |
| 2926 | |
| 2927 <dt><i>line</i></dt> | |
| 2928 <dd> | |
| 2929 text of the line to check (string) | |
| 2930 </dd> | |
| 2931 <dt><i>commentStr</i></dt> | |
| 2932 <dd> | |
| 2933 comment string to check against (string) | |
| 2934 </dd> | |
| 2935 </dl> | |
| 2936 <dl> | |
| 2937 <dt>Return:</dt> | |
| 2938 <dd> | |
| 2939 flag indicating a commented line (boolean) | |
| 2940 </dd> | |
| 2941 </dl> | |
| 2942 <a NAME="Editor.__isStartChar" ID="Editor.__isStartChar"></a> | |
| 2943 <h4>Editor.__isStartChar</h4> | |
| 2944 <b>__isStartChar</b>(<i>ch</i>) | |
| 2945 | |
| 2946 <p> | |
| 2947 Private method to check, if a character is an autocompletion start | |
| 2948 character. | |
| 2949 </p> | |
| 2950 <dl> | |
| 2951 | |
| 2952 <dt><i>ch</i></dt> | |
| 2953 <dd> | |
| 2954 character to be checked (one character string) | |
| 2955 </dd> | |
| 2956 </dl> | |
| 2957 <dl> | |
| 2958 <dt>Return:</dt> | |
| 2959 <dd> | |
| 2960 flag indicating the result (boolean) | |
| 2961 </dd> | |
| 2962 </dl> | |
| 2963 <a NAME="Editor.__languageChanged" ID="Editor.__languageChanged"></a> | |
| 2964 <h4>Editor.__languageChanged</h4> | |
| 2965 <b>__languageChanged</b>(<i>language, propagate=True</i>) | |
| 2966 | |
| 2967 <p> | |
| 2968 Private slot handling a change of a connected editor's language. | |
| 2969 </p> | |
| 2970 <dl> | |
| 2971 | |
| 2972 <dt><i>language</i></dt> | |
| 2973 <dd> | |
| 2974 language to be set (string) | |
| 2975 </dd> | |
| 2976 <dt><i>propagate</i></dt> | |
| 2977 <dd> | |
| 2978 flag indicating to propagate the change (boolean) | |
| 2979 </dd> | |
| 2980 </dl> | |
| 2981 <a NAME="Editor.__languageMenuTriggered" ID="Editor.__languageMenuTriggered"></a> | |
| 2982 <h4>Editor.__languageMenuTriggered</h4> | |
| 2983 <b>__languageMenuTriggered</b>(<i>act</i>) | |
| 2984 | |
| 2985 <p> | |
| 2986 Private method to handle the selection of a lexer language. | |
| 2987 </p> | |
| 2988 <dl> | |
| 2989 | |
| 2990 <dt><i>act</i></dt> | |
| 2991 <dd> | |
| 2992 reference to the action that was triggered (QAction) | |
| 2993 </dd> | |
| 2994 </dl> | |
| 2995 <a NAME="Editor.__lmBbookmarks" ID="Editor.__lmBbookmarks"></a> | |
| 2996 <h4>Editor.__lmBbookmarks</h4> | |
| 2997 <b>__lmBbookmarks</b>(<i></i>) | |
| 2998 | |
| 2999 <p> | |
| 3000 Private method to handle the 'LMB toggles bookmark' context menu | |
| 3001 action. | |
| 3002 </p> | |
| 3003 <a NAME="Editor.__lmBbreakpoints" ID="Editor.__lmBbreakpoints"></a> | |
| 3004 <h4>Editor.__lmBbreakpoints</h4> | |
| 3005 <b>__lmBbreakpoints</b>(<i></i>) | |
| 3006 | |
| 3007 <p> | |
| 3008 Private method to handle the 'LMB toggles breakpoint' context menu | |
| 3009 action. | |
| 3010 </p> | |
| 3011 <a NAME="Editor.__loadDiagram" ID="Editor.__loadDiagram"></a> | |
| 3012 <h4>Editor.__loadDiagram</h4> | |
| 3013 <b>__loadDiagram</b>(<i></i>) | |
| 3014 | |
| 3015 <p> | |
| 3016 Private slot to load a diagram from file. | |
| 3017 </p> | |
| 3018 <a NAME="Editor.__loadEditorConfig" ID="Editor.__loadEditorConfig"></a> | |
| 3019 <h4>Editor.__loadEditorConfig</h4> | |
| 3020 <b>__loadEditorConfig</b>(<i>fileName=""</i>) | |
| 3021 | |
| 3022 <p> | |
| 3023 Private method to load the EditorConfig properties. | |
| 3024 </p> | |
| 3025 <dl> | |
| 3026 | |
| 3027 <dt><i>fileName</i> (str)</dt> | |
| 3028 <dd> | |
| 3029 name of the file | |
| 3030 </dd> | |
| 3031 </dl> | |
| 3032 <a NAME="Editor.__loadEditorConfigObject" ID="Editor.__loadEditorConfigObject"></a> | |
| 3033 <h4>Editor.__loadEditorConfigObject</h4> | |
| 3034 <b>__loadEditorConfigObject</b>(<i>fileName</i>) | |
| 3035 | |
| 3036 <p> | |
| 3037 Private method to load the EditorConfig properties for the given | |
| 3038 file name. | |
| 3039 </p> | |
| 3040 <dl> | |
| 3041 | |
| 3042 <dt><i>fileName</i> (str)</dt> | |
| 3043 <dd> | |
| 3044 name of the file | |
| 3045 </dd> | |
| 3046 </dl> | |
| 3047 <dl> | |
| 3048 <dt>Return:</dt> | |
| 3049 <dd> | |
| 3050 EditorConfig dictionary | |
| 3051 </dd> | |
| 3052 </dl> | |
| 3053 <dl> | |
| 3054 <dt>Return Type:</dt> | |
| 3055 <dd> | |
| 3056 dict | |
| 3057 </dd> | |
| 3058 </dl> | |
| 3059 <a NAME="Editor.__marginClicked" ID="Editor.__marginClicked"></a> | |
| 3060 <h4>Editor.__marginClicked</h4> | |
| 3061 <b>__marginClicked</b>(<i>margin, line, modifiers</i>) | |
| 3062 | |
| 3063 <p> | |
| 3064 Private slot to handle the marginClicked signal. | |
| 3065 </p> | |
| 3066 <dl> | |
| 3067 | |
| 3068 <dt><i>margin</i></dt> | |
| 3069 <dd> | |
| 3070 id of the clicked margin (integer) | |
| 3071 </dd> | |
| 3072 <dt><i>line</i></dt> | |
| 3073 <dd> | |
| 3074 line number of the click (integer) | |
| 3075 </dd> | |
| 3076 <dt><i>modifiers</i></dt> | |
| 3077 <dd> | |
| 3078 keyboard modifiers (Qt.KeyboardModifiers) | |
| 3079 </dd> | |
| 3080 </dl> | |
| 3081 <a NAME="Editor.__marginNumber" ID="Editor.__marginNumber"></a> | |
| 3082 <h4>Editor.__marginNumber</h4> | |
| 3083 <b>__marginNumber</b>(<i>xPos</i>) | |
| 3084 | |
| 3085 <p> | |
| 3086 Private method to calculate the margin number based on a x position. | |
| 3087 </p> | |
| 3088 <dl> | |
| 3089 | |
| 3090 <dt><i>xPos</i></dt> | |
| 3091 <dd> | |
| 3092 x position (integer) | |
| 3093 </dd> | |
| 3094 </dl> | |
| 3095 <dl> | |
| 3096 <dt>Return:</dt> | |
| 3097 <dd> | |
| 3098 margin number (integer, -1 for no margin) | |
| 3099 </dd> | |
| 3100 </dl> | |
| 3101 <a NAME="Editor.__markOccurrences" ID="Editor.__markOccurrences"></a> | |
| 3102 <h4>Editor.__markOccurrences</h4> | |
| 3103 <b>__markOccurrences</b>(<i></i>) | |
| 3104 | |
| 3105 <p> | |
| 3106 Private method to mark all occurrences of the current word. | |
| 3107 </p> | |
| 3108 <a NAME="Editor.__menuClearBreakpoints" ID="Editor.__menuClearBreakpoints"></a> | |
| 3109 <h4>Editor.__menuClearBreakpoints</h4> | |
| 3110 <b>__menuClearBreakpoints</b>(<i></i>) | |
| 3111 | |
| 3112 <p> | |
| 3113 Private slot to handle the 'Clear all breakpoints' context menu action. | |
| 3114 </p> | |
| 3115 <a NAME="Editor.__menuToggleBreakpointEnabled" ID="Editor.__menuToggleBreakpointEnabled"></a> | |
| 3116 <h4>Editor.__menuToggleBreakpointEnabled</h4> | |
| 3117 <b>__menuToggleBreakpointEnabled</b>(<i></i>) | |
| 3118 | |
| 3119 <p> | |
| 3120 Private slot to handle the 'Enable/Disable breakpoint' context menu | |
| 3121 action. | |
| 3122 </p> | |
| 3123 <a NAME="Editor.__menuToggleTemporaryBreakpoint" ID="Editor.__menuToggleTemporaryBreakpoint"></a> | |
| 3124 <h4>Editor.__menuToggleTemporaryBreakpoint</h4> | |
| 3125 <b>__menuToggleTemporaryBreakpoint</b>(<i></i>) | |
| 3126 | |
| 3127 <p> | |
| 3128 Private slot to handle the 'Toggle temporary breakpoint' context menu | |
| 3129 action. | |
| 3130 </p> | |
| 3131 <a NAME="Editor.__modificationChanged" ID="Editor.__modificationChanged"></a> | |
| 3132 <h4>Editor.__modificationChanged</h4> | |
| 3133 <b>__modificationChanged</b>(<i>m</i>) | |
| 3134 | |
| 3135 <p> | |
| 3136 Private slot to handle the modificationChanged signal. | |
| 3137 </p> | |
| 3138 <p> | |
| 3139 It emits the signal modificationStatusChanged with parameters | |
| 3140 m and self. | |
| 3141 </p> | |
| 3142 <dl> | |
| 3143 | |
| 3144 <dt><i>m</i></dt> | |
| 3145 <dd> | |
| 3146 modification status | |
| 3147 </dd> | |
| 3148 </dl> | |
| 3149 <a NAME="Editor.__modificationReadOnly" ID="Editor.__modificationReadOnly"></a> | |
| 3150 <h4>Editor.__modificationReadOnly</h4> | |
| 3151 <b>__modificationReadOnly</b>(<i></i>) | |
| 3152 | |
| 3153 <p> | |
| 3154 Private slot to handle the modificationAttempted signal. | |
| 3155 </p> | |
| 3156 <a NAME="Editor.__modified" ID="Editor.__modified"></a> | |
| 3157 <h4>Editor.__modified</h4> | |
| 3158 <b>__modified</b>(<i>pos, mtype, text, length, linesAdded, line, foldNow, foldPrev, token, annotationLinesAdded</i>) | |
| 3159 | |
| 3160 <p> | |
| 3161 Private method to handle changes of the number of lines. | |
| 3162 </p> | |
| 3163 <dl> | |
| 3164 | |
| 3165 <dt><i>pos</i></dt> | |
| 3166 <dd> | |
| 3167 start position of change (integer) | |
| 3168 </dd> | |
| 3169 <dt><i>mtype</i></dt> | |
| 3170 <dd> | |
| 3171 flags identifying the change (integer) | |
| 3172 </dd> | |
| 3173 <dt><i>text</i></dt> | |
| 3174 <dd> | |
| 3175 text that is given to the Undo system (string) | |
| 3176 </dd> | |
| 3177 <dt><i>length</i></dt> | |
| 3178 <dd> | |
| 3179 length of the change (integer) | |
| 3180 </dd> | |
| 3181 <dt><i>linesAdded</i></dt> | |
| 3182 <dd> | |
| 3183 number of added/deleted lines (integer) | |
| 3184 </dd> | |
| 3185 <dt><i>line</i></dt> | |
| 3186 <dd> | |
| 3187 line number of a fold level or marker change (integer) | |
| 3188 </dd> | |
| 3189 <dt><i>foldNow</i></dt> | |
| 3190 <dd> | |
| 3191 new fold level (integer) | |
| 3192 </dd> | |
| 3193 <dt><i>foldPrev</i></dt> | |
| 3194 <dd> | |
| 3195 previous fold level (integer) | |
| 3196 </dd> | |
| 3197 <dt><i>token</i></dt> | |
| 3198 <dd> | |
| 3199 ??? | |
| 3200 </dd> | |
| 3201 <dt><i>annotationLinesAdded</i></dt> | |
| 3202 <dd> | |
| 3203 number of added/deleted annotation lines | |
| 3204 (integer) | |
| 3205 </dd> | |
| 3206 </dl> | |
| 3207 <a NAME="Editor.__newView" ID="Editor.__newView"></a> | |
| 3208 <h4>Editor.__newView</h4> | |
| 3209 <b>__newView</b>(<i></i>) | |
| 3210 | |
| 3211 <p> | |
| 3212 Private slot to create a new view to an open document. | |
| 3213 </p> | |
| 3214 <a NAME="Editor.__newViewNewSplit" ID="Editor.__newViewNewSplit"></a> | |
| 3215 <h4>Editor.__newViewNewSplit</h4> | |
| 3216 <b>__newViewNewSplit</b>(<i></i>) | |
| 3217 | |
| 3218 <p> | |
| 3219 Private slot to create a new view to an open document. | |
| 3220 </p> | |
| 3221 <a NAME="Editor.__normalizedEncoding" ID="Editor.__normalizedEncoding"></a> | |
| 3222 <h4>Editor.__normalizedEncoding</h4> | |
| 3223 <b>__normalizedEncoding</b>(<i>encoding=""</i>) | |
| 3224 | |
| 3225 <p> | |
| 3226 Private method to calculate the normalized encoding string. | |
| 3227 </p> | |
| 3228 <dl> | |
| 3229 | |
| 3230 <dt><i>encoding</i></dt> | |
| 3231 <dd> | |
| 3232 encoding to be normalized (string) | |
| 3233 </dd> | |
| 3234 </dl> | |
| 3235 <dl> | |
| 3236 <dt>Return:</dt> | |
| 3237 <dd> | |
| 3238 normalized encoding (string) | |
| 3239 </dd> | |
| 3240 </dl> | |
| 3241 <a NAME="Editor.__onlineChangeTraceTimerTimeout" ID="Editor.__onlineChangeTraceTimerTimeout"></a> | |
| 3242 <h4>Editor.__onlineChangeTraceTimerTimeout</h4> | |
| 3243 <b>__onlineChangeTraceTimerTimeout</b>(<i></i>) | |
| 3244 | |
| 3245 <p> | |
| 3246 Private slot to mark added and changed lines. | |
| 3247 </p> | |
| 3248 <a NAME="Editor.__popupDocstringMenu" ID="Editor.__popupDocstringMenu"></a> | |
| 3249 <h4>Editor.__popupDocstringMenu</h4> | |
| 3250 <b>__popupDocstringMenu</b>(<i>lastLineText, lastCursorPosition</i>) | |
| 3251 | |
| 3252 <p> | |
| 3253 Private slot to pop up a menu asking the user, if a docstring should be | |
| 3254 inserted. | |
| 3255 </p> | |
| 3256 <dl> | |
| 3257 | |
| 3258 <dt><i>lastLineText</i> (str)</dt> | |
| 3259 <dd> | |
| 3260 line contents when the delay timer was started | |
| 3261 </dd> | |
| 3262 <dt><i>lastCursorPosition</i> (tuple of (int, int))</dt> | |
| 3263 <dd> | |
| 3264 position of the cursor when the delay timer | |
| 3265 was started (line and index) | |
| 3266 </dd> | |
| 3267 </dl> | |
| 3268 <a NAME="Editor.__printPreview" ID="Editor.__printPreview"></a> | |
| 3269 <h4>Editor.__printPreview</h4> | |
| 3270 <b>__printPreview</b>(<i>printer</i>) | |
| 3271 | |
| 3272 <p> | |
| 3273 Private slot to generate a print preview. | |
| 3274 </p> | |
| 3275 <dl> | |
| 3276 | |
| 3277 <dt><i>printer</i></dt> | |
| 3278 <dd> | |
| 3279 reference to the printer object | |
| 3280 (QScintilla.Printer.Printer) | |
| 3281 </dd> | |
| 3282 </dl> | |
| 3283 <a NAME="Editor.__processEndEditCommand" ID="Editor.__processEndEditCommand"></a> | |
| 3284 <h4>Editor.__processEndEditCommand</h4> | |
| 3285 <b>__processEndEditCommand</b>(<i>argsString</i>) | |
| 3286 | |
| 3287 <p> | |
| 3288 Private slot to process a remote EndEdit command. | |
| 3289 </p> | |
| 3290 <dl> | |
| 3291 | |
| 3292 <dt><i>argsString</i></dt> | |
| 3293 <dd> | |
| 3294 string containing the command parameters (string) | |
| 3295 </dd> | |
| 3296 </dl> | |
| 3297 <a NAME="Editor.__processFlags" ID="Editor.__processFlags"></a> | |
| 3298 <h4>Editor.__processFlags</h4> | |
| 3299 <b>__processFlags</b>(<i></i>) | |
| 3300 | |
| 3301 <p> | |
| 3302 Private method to extract flags and process them. | |
| 3303 </p> | |
| 3304 <dl> | |
| 3305 <dt>Return:</dt> | |
| 3306 <dd> | |
| 3307 list of change flags (list of string) | |
| 3308 </dd> | |
| 3309 </dl> | |
| 3310 <a NAME="Editor.__processRequestSyncCommand" ID="Editor.__processRequestSyncCommand"></a> | |
| 3311 <h4>Editor.__processRequestSyncCommand</h4> | |
| 3312 <b>__processRequestSyncCommand</b>(<i>argsString</i>) | |
| 3313 | |
| 3314 <p> | |
| 3315 Private slot to process a remote RequestSync command. | |
| 3316 </p> | |
| 3317 <dl> | |
| 3318 | |
| 3319 <dt><i>argsString</i></dt> | |
| 3320 <dd> | |
| 3321 string containing the command parameters (string) | |
| 3322 </dd> | |
| 3323 </dl> | |
| 3324 <a NAME="Editor.__processStartEditCommand" ID="Editor.__processStartEditCommand"></a> | |
| 3325 <h4>Editor.__processStartEditCommand</h4> | |
| 3326 <b>__processStartEditCommand</b>(<i>argsString</i>) | |
| 3327 | |
| 3328 <p> | |
| 3329 Private slot to process a remote StartEdit command. | |
| 3330 </p> | |
| 3331 <dl> | |
| 3332 | |
| 3333 <dt><i>argsString</i></dt> | |
| 3334 <dd> | |
| 3335 string containing the command parameters (string) | |
| 3336 </dd> | |
| 3337 </dl> | |
| 3338 <a NAME="Editor.__processSyncCommand" ID="Editor.__processSyncCommand"></a> | |
| 3339 <h4>Editor.__processSyncCommand</h4> | |
| 3340 <b>__processSyncCommand</b>(<i>argsString</i>) | |
| 3341 | |
| 3342 <p> | |
| 3343 Private slot to process a remote Sync command. | |
| 3344 </p> | |
| 3345 <dl> | |
| 3346 | |
| 3347 <dt><i>argsString</i></dt> | |
| 3348 <dd> | |
| 3349 string containing the command parameters (string) | |
| 3350 </dd> | |
| 3351 </dl> | |
| 3352 <a NAME="Editor.__processSyntaxCheckError" ID="Editor.__processSyntaxCheckError"></a> | |
| 3353 <h4>Editor.__processSyntaxCheckError</h4> | |
| 3354 <b>__processSyntaxCheckError</b>(<i>fn, msg</i>) | |
| 3355 | |
| 3356 <p> | |
| 3357 Private slot to report an error message of a syntax check. | |
| 3358 </p> | |
| 3359 <dl> | |
| 3360 | |
| 3361 <dt><i>fn</i> (str)</dt> | |
| 3362 <dd> | |
| 3363 filename of the file | |
| 3364 </dd> | |
| 3365 <dt><i>msg</i> (str)</dt> | |
| 3366 <dd> | |
| 3367 error message | |
| 3368 </dd> | |
| 3369 </dl> | |
| 3370 <a NAME="Editor.__processSyntaxCheckResult" ID="Editor.__processSyntaxCheckResult"></a> | |
| 3371 <h4>Editor.__processSyntaxCheckResult</h4> | |
| 3372 <b>__processSyntaxCheckResult</b>(<i>fn, problems</i>) | |
| 3373 | |
| 3374 <p> | |
| 3375 Private slot to report the resulting messages of a syntax check. | |
| 3376 </p> | |
| 3377 <dl> | |
| 3378 | |
| 3379 <dt><i>fn</i></dt> | |
| 3380 <dd> | |
| 3381 filename of the checked file (str) | |
| 3382 </dd> | |
| 3383 <dt><i>problems</i></dt> | |
| 3384 <dd> | |
| 3385 dictionary with the keys 'error' and 'warnings' which | |
| 3386 hold a list containing details about the error/ warnings | |
| 3387 (file name, line number, column, codestring (only at syntax | |
| 3388 errors), the message) (dict) | |
| 3389 </dd> | |
| 3390 </dl> | |
| 3391 <a NAME="Editor.__projectPropertiesChanged" ID="Editor.__projectPropertiesChanged"></a> | |
| 3392 <h4>Editor.__projectPropertiesChanged</h4> | |
| 3393 <b>__projectPropertiesChanged</b>(<i></i>) | |
| 3394 | |
| 3395 <p> | |
| 3396 Private slot to handle changes of the project properties. | |
| 3397 </p> | |
| 3398 <a NAME="Editor.__refreshAnnotations" ID="Editor.__refreshAnnotations"></a> | |
| 3399 <h4>Editor.__refreshAnnotations</h4> | |
| 3400 <b>__refreshAnnotations</b>(<i></i>) | |
| 3401 | |
| 3402 <p> | |
| 3403 Private method to refresh the annotations. | |
| 3404 </p> | |
| 3405 <a NAME="Editor.__registerImages" ID="Editor.__registerImages"></a> | |
| 3406 <h4>Editor.__registerImages</h4> | |
| 3407 <b>__registerImages</b>(<i></i>) | |
| 3408 | |
| 3409 <p> | |
| 3410 Private method to register images for autocompletion lists. | |
| 3411 </p> | |
| 3412 <a NAME="Editor.__reinitOnlineChangeTrace" ID="Editor.__reinitOnlineChangeTrace"></a> | |
| 3413 <h4>Editor.__reinitOnlineChangeTrace</h4> | |
| 3414 <b>__reinitOnlineChangeTrace</b>(<i></i>) | |
| 3415 | |
| 3416 <p> | |
| 3417 Private slot to re-initialize the online change trace. | |
| 3418 </p> | |
| 3419 <a NAME="Editor.__removeFromSpellingDictionary" ID="Editor.__removeFromSpellingDictionary"></a> | |
| 3420 <h4>Editor.__removeFromSpellingDictionary</h4> | |
| 3421 <b>__removeFromSpellingDictionary</b>(<i></i>) | |
| 3422 | |
| 3423 <p> | |
| 3424 Private slot to remove the word below the context menu to the | |
| 3425 dictionary. | |
| 3426 </p> | |
| 3427 <a NAME="Editor.__removeTrailingWhitespace" ID="Editor.__removeTrailingWhitespace"></a> | |
| 3428 <h4>Editor.__removeTrailingWhitespace</h4> | |
| 3429 <b>__removeTrailingWhitespace</b>(<i></i>) | |
| 3430 | |
| 3431 <p> | |
| 3432 Private method to remove trailing whitespace. | |
| 3433 </p> | |
| 3434 <a NAME="Editor.__reopenWithEncodingMenuTriggered" ID="Editor.__reopenWithEncodingMenuTriggered"></a> | |
| 3435 <h4>Editor.__reopenWithEncodingMenuTriggered</h4> | |
| 3436 <b>__reopenWithEncodingMenuTriggered</b>(<i>act</i>) | |
| 3437 | |
| 3438 <p> | |
| 3439 Private method to handle the rereading of the file with a selected | |
| 3440 encoding. | |
| 3441 </p> | |
| 3442 <dl> | |
| 3443 | |
| 3444 <dt><i>act</i></dt> | |
| 3445 <dd> | |
| 3446 reference to the action that was triggered (QAction) | |
| 3447 </dd> | |
| 3448 </dl> | |
| 3449 <a NAME="Editor.__replaceLeadingUnderscores" ID="Editor.__replaceLeadingUnderscores"></a> | |
| 3450 <h4>Editor.__replaceLeadingUnderscores</h4> | |
| 3451 <b>__replaceLeadingUnderscores</b>(<i>txt</i>) | |
| 3452 | |
| 3453 <p> | |
| 3454 Private method to replace the first two underlines for invers sorting. | |
| 3455 </p> | |
| 3456 <dl> | |
| 3457 | |
| 3458 <dt><i>txt</i> (str)</dt> | |
| 3459 <dd> | |
| 3460 completion text | |
| 3461 </dd> | |
| 3462 </dl> | |
| 3463 <dl> | |
| 3464 <dt>Return:</dt> | |
| 3465 <dd> | |
| 3466 modified completion text | |
| 3467 </dd> | |
| 3468 </dl> | |
| 3469 <dl> | |
| 3470 <dt>Return Type:</dt> | |
| 3471 <dd> | |
| 3472 str | |
| 3473 </dd> | |
| 3474 </dl> | |
| 3475 <a NAME="Editor.__resetLanguage" ID="Editor.__resetLanguage"></a> | |
| 3476 <h4>Editor.__resetLanguage</h4> | |
| 3477 <b>__resetLanguage</b>(<i>propagate=True</i>) | |
| 3478 | |
| 3479 <p> | |
| 3480 Private method used to reset the language selection. | |
| 3481 </p> | |
| 3482 <dl> | |
| 3483 | |
| 3484 <dt><i>propagate</i></dt> | |
| 3485 <dd> | |
| 3486 flag indicating to propagate the change (boolean) | |
| 3487 </dd> | |
| 3488 </dl> | |
| 3489 <a NAME="Editor.__resetOnlineChangeTraceInfo" ID="Editor.__resetOnlineChangeTraceInfo"></a> | |
| 3490 <h4>Editor.__resetOnlineChangeTraceInfo</h4> | |
| 3491 <b>__resetOnlineChangeTraceInfo</b>(<i></i>) | |
| 3492 | |
| 3493 <p> | |
| 3494 Private slot to reset the online change trace info. | |
| 3495 </p> | |
| 3496 <a NAME="Editor.__resetOnlineChangeTraceTimer" ID="Editor.__resetOnlineChangeTraceTimer"></a> | |
| 3497 <h4>Editor.__resetOnlineChangeTraceTimer</h4> | |
| 3498 <b>__resetOnlineChangeTraceTimer</b>(<i></i>) | |
| 3499 | |
| 3500 <p> | |
| 3501 Private method to reset the online syntax check timer. | |
| 3502 </p> | |
| 3503 <a NAME="Editor.__resetOnlineSyntaxCheckTimer" ID="Editor.__resetOnlineSyntaxCheckTimer"></a> | |
| 3504 <h4>Editor.__resetOnlineSyntaxCheckTimer</h4> | |
| 3505 <b>__resetOnlineSyntaxCheckTimer</b>(<i></i>) | |
| 3506 | |
| 3507 <p> | |
| 3508 Private method to reset the online syntax check timer. | |
| 3509 </p> | |
| 3510 <a NAME="Editor.__resizeLinenoMargin" ID="Editor.__resizeLinenoMargin"></a> | |
| 3511 <h4>Editor.__resizeLinenoMargin</h4> | |
| 3512 <b>__resizeLinenoMargin</b>(<i></i>) | |
| 3513 | |
| 3514 <p> | |
| 3515 Private slot to resize the line numbers margin. | |
| 3516 </p> | |
| 3517 <a NAME="Editor.__restoreBreakpoints" ID="Editor.__restoreBreakpoints"></a> | |
| 3518 <h4>Editor.__restoreBreakpoints</h4> | |
| 3519 <b>__restoreBreakpoints</b>(<i></i>) | |
| 3520 | |
| 3521 <p> | |
| 3522 Private method to restore the breakpoints. | |
| 3523 </p> | |
| 3524 <a NAME="Editor.__saveLastEditPosition" ID="Editor.__saveLastEditPosition"></a> | |
| 3525 <h4>Editor.__saveLastEditPosition</h4> | |
| 3526 <b>__saveLastEditPosition</b>(<i></i>) | |
| 3527 | |
| 3528 <p> | |
| 3529 Private slot to record the last edit position. | |
| 3530 </p> | |
| 3531 <a NAME="Editor.__searchCurrentWord" ID="Editor.__searchCurrentWord"></a> | |
| 3532 <h4>Editor.__searchCurrentWord</h4> | |
| 3533 <b>__searchCurrentWord</b>(<i>forward=True</i>) | |
| 3534 | |
| 3535 <p> | |
| 3536 Private slot to search the next occurrence of the current word. | |
| 3537 </p> | |
| 3538 <dl> | |
| 3539 | |
| 3540 <dt><i>forward</i></dt> | |
| 3541 <dd> | |
| 3542 flag indicating the search direction (boolean) | |
| 3543 </dd> | |
| 3544 </dl> | |
| 3545 <a NAME="Editor.__selectAll" ID="Editor.__selectAll"></a> | |
| 3546 <h4>Editor.__selectAll</h4> | |
| 3547 <b>__selectAll</b>(<i></i>) | |
| 3548 | |
| 3549 <p> | |
| 3550 Private slot handling the select all context menu action. | |
| 3551 </p> | |
| 3552 <a NAME="Editor.__selectPygmentsLexer" ID="Editor.__selectPygmentsLexer"></a> | |
| 3553 <h4>Editor.__selectPygmentsLexer</h4> | |
| 3554 <b>__selectPygmentsLexer</b>(<i></i>) | |
| 3555 | |
| 3556 <p> | |
| 3557 Private method to select a specific pygments lexer. | |
| 3558 </p> | |
| 3559 <dl> | |
| 3560 <dt>Return:</dt> | |
| 3561 <dd> | |
| 3562 name of the selected pygments lexer (string) | |
| 3563 </dd> | |
| 3564 </dl> | |
| 3565 <a NAME="Editor.__send" ID="Editor.__send"></a> | |
| 3566 <h4>Editor.__send</h4> | |
| 3567 <b>__send</b>(<i>token, args=None</i>) | |
| 3568 | |
| 3569 <p> | |
| 3570 Private method to send an editor command to remote editors. | |
| 3571 </p> | |
| 3572 <dl> | |
| 3573 | |
| 3574 <dt><i>token</i></dt> | |
| 3575 <dd> | |
| 3576 command token (string) | |
| 3577 </dd> | |
| 3578 <dt><i>args</i></dt> | |
| 3579 <dd> | |
| 3580 arguments for the command (string) | |
| 3581 </dd> | |
| 3582 </dl> | |
| 3583 <a NAME="Editor.__setAnnotation" ID="Editor.__setAnnotation"></a> | |
| 3584 <h4>Editor.__setAnnotation</h4> | |
| 3585 <b>__setAnnotation</b>(<i>line</i>) | |
| 3586 | |
| 3587 <p> | |
| 3588 Private method to set the annotations for the given line. | |
| 3589 </p> | |
| 3590 <dl> | |
| 3591 | |
| 3592 <dt><i>line</i></dt> | |
| 3593 <dd> | |
| 3594 number of the line that needs annotation (integer) | |
| 3595 </dd> | |
| 3596 </dl> | |
| 3597 <a NAME="Editor.__setAnnotationStyles" ID="Editor.__setAnnotationStyles"></a> | |
| 3598 <h4>Editor.__setAnnotationStyles</h4> | |
| 3599 <b>__setAnnotationStyles</b>(<i></i>) | |
| 3600 | |
| 3601 <p> | |
| 3602 Private slot to define the style used by inline annotations. | |
| 3603 </p> | |
| 3604 <a NAME="Editor.__setAutoCompletion" ID="Editor.__setAutoCompletion"></a> | |
| 3605 <h4>Editor.__setAutoCompletion</h4> | |
| 3606 <b>__setAutoCompletion</b>(<i></i>) | |
| 3607 | |
| 3608 <p> | |
| 3609 Private method to configure the autocompletion function. | |
| 3610 </p> | |
| 3611 <a NAME="Editor.__setCallTips" ID="Editor.__setCallTips"></a> | |
| 3612 <h4>Editor.__setCallTips</h4> | |
| 3613 <b>__setCallTips</b>(<i></i>) | |
| 3614 | |
| 3615 <p> | |
| 3616 Private method to configure the calltips function. | |
| 3617 </p> | |
| 3618 <a NAME="Editor.__setEolMode" ID="Editor.__setEolMode"></a> | |
| 3619 <h4>Editor.__setEolMode</h4> | |
| 3620 <b>__setEolMode</b>(<i></i>) | |
| 3621 | |
| 3622 <p> | |
| 3623 Private method to configure the eol mode of the editor. | |
| 3624 </p> | |
| 3625 <a NAME="Editor.__setFileName" ID="Editor.__setFileName"></a> | |
| 3626 <h4>Editor.__setFileName</h4> | |
| 3627 <b>__setFileName</b>(<i>name</i>) | |
| 3628 | |
| 3629 <p> | |
| 3630 Private method to set the file name of the current file. | |
| 3631 </p> | |
| 3632 <dl> | |
| 3633 | |
| 3634 <dt><i>name</i> (str)</dt> | |
| 3635 <dd> | |
| 3636 name of the current file | |
| 3637 </dd> | |
| 3638 </dl> | |
| 3639 <a NAME="Editor.__setLineMarkerColours" ID="Editor.__setLineMarkerColours"></a> | |
| 3640 <h4>Editor.__setLineMarkerColours</h4> | |
| 3641 <b>__setLineMarkerColours</b>(<i></i>) | |
| 3642 | |
| 3643 <p> | |
| 3644 Private method to set the line marker colours. | |
| 3645 </p> | |
| 3646 <a NAME="Editor.__setMarginsDisplay" ID="Editor.__setMarginsDisplay"></a> | |
| 3647 <h4>Editor.__setMarginsDisplay</h4> | |
| 3648 <b>__setMarginsDisplay</b>(<i></i>) | |
| 3649 | |
| 3650 <p> | |
| 3651 Private method to configure margins 0 and 2. | |
| 3652 </p> | |
| 3653 <a NAME="Editor.__setSpelling" ID="Editor.__setSpelling"></a> | |
| 3654 <h4>Editor.__setSpelling</h4> | |
| 3655 <b>__setSpelling</b>(<i></i>) | |
| 3656 | |
| 3657 <p> | |
| 3658 Private method to initialize the spell checking functionality. | |
| 3659 </p> | |
| 3660 <a NAME="Editor.__setSpellingLanguage" ID="Editor.__setSpellingLanguage"></a> | |
| 3661 <h4>Editor.__setSpellingLanguage</h4> | |
| 3662 <b>__setSpellingLanguage</b>(<i>language, pwl="", pel=""</i>) | |
| 3663 | |
| 3664 <p> | |
| 3665 Private slot to set the spell checking language. | |
| 3666 </p> | |
| 3667 <dl> | |
| 3668 | |
| 3669 <dt><i>language</i></dt> | |
| 3670 <dd> | |
| 3671 spell checking language to be set (string) | |
| 3672 </dd> | |
| 3673 <dt><i>pwl</i></dt> | |
| 3674 <dd> | |
| 3675 name of the personal/project word list (string) | |
| 3676 </dd> | |
| 3677 <dt><i>pel</i></dt> | |
| 3678 <dd> | |
| 3679 name of the personal/project exclude list (string) | |
| 3680 </dd> | |
| 3681 </dl> | |
| 3682 <a NAME="Editor.__setTabAndIndent" ID="Editor.__setTabAndIndent"></a> | |
| 3683 <h4>Editor.__setTabAndIndent</h4> | |
| 3684 <b>__setTabAndIndent</b>(<i></i>) | |
| 3685 | |
| 3686 <p> | |
| 3687 Private method to set indentation size and style and tab width. | |
| 3688 </p> | |
| 3689 <a NAME="Editor.__setTextDisplay" ID="Editor.__setTextDisplay"></a> | |
| 3690 <h4>Editor.__setTextDisplay</h4> | |
| 3691 <b>__setTextDisplay</b>(<i></i>) | |
| 3692 | |
| 3693 <p> | |
| 3694 Private method to configure the text display. | |
| 3695 </p> | |
| 3696 <a NAME="Editor.__showApplicationDiagram" ID="Editor.__showApplicationDiagram"></a> | |
| 3697 <h4>Editor.__showApplicationDiagram</h4> | |
| 3698 <b>__showApplicationDiagram</b>(<i></i>) | |
| 3699 | |
| 3700 <p> | |
| 3701 Private method to handle the Imports Diagram context menu action. | |
| 3702 </p> | |
| 3703 <a NAME="Editor.__showClassDiagram" ID="Editor.__showClassDiagram"></a> | |
| 3704 <h4>Editor.__showClassDiagram</h4> | |
| 3705 <b>__showClassDiagram</b>(<i></i>) | |
| 3706 | |
| 3707 <p> | |
| 3708 Private method to handle the Class Diagram context menu action. | |
| 3709 </p> | |
| 3710 <a NAME="Editor.__showCodeCoverage" ID="Editor.__showCodeCoverage"></a> | |
| 3711 <h4>Editor.__showCodeCoverage</h4> | |
| 3712 <b>__showCodeCoverage</b>(<i></i>) | |
| 3713 | |
| 3714 <p> | |
| 3715 Private method to handle the code coverage context menu action. | |
| 3716 </p> | |
| 3717 <a NAME="Editor.__showCodeInfo" ID="Editor.__showCodeInfo"></a> | |
| 3718 <h4>Editor.__showCodeInfo</h4> | |
| 3719 <b>__showCodeInfo</b>(<i></i>) | |
| 3720 | |
| 3721 <p> | |
| 3722 Private slot to handle the context menu action to show code info. | |
| 3723 </p> | |
| 3724 <a NAME="Editor.__showCodeMetrics" ID="Editor.__showCodeMetrics"></a> | |
| 3725 <h4>Editor.__showCodeMetrics</h4> | |
| 3726 <b>__showCodeMetrics</b>(<i></i>) | |
| 3727 | |
| 3728 <p> | |
| 3729 Private method to handle the code metrics context menu action. | |
| 3730 </p> | |
| 3731 <a NAME="Editor.__showCompletionsList" ID="Editor.__showCompletionsList"></a> | |
| 3732 <h4>Editor.__showCompletionsList</h4> | |
| 3733 <b>__showCompletionsList</b>(<i>completions</i>) | |
| 3734 | |
| 3735 <p> | |
| 3736 Private method to show the completions list. | |
| 3737 </p> | |
| 3738 <dl> | |
| 3739 | |
| 3740 <dt><i>completions</i> (list of str or set of str)</dt> | |
| 3741 <dd> | |
| 3742 completions to be shown | |
| 3743 </dd> | |
| 3744 </dl> | |
| 3745 <a NAME="Editor.__showContextMenu" ID="Editor.__showContextMenu"></a> | |
| 3746 <h4>Editor.__showContextMenu</h4> | |
| 3747 <b>__showContextMenu</b>(<i></i>) | |
| 3748 | |
| 3749 <p> | |
| 3750 Private slot handling the aboutToShow signal of the context menu. | |
| 3751 </p> | |
| 3752 <a NAME="Editor.__showContextMenuAutocompletion" ID="Editor.__showContextMenuAutocompletion"></a> | |
| 3753 <h4>Editor.__showContextMenuAutocompletion</h4> | |
| 3754 <b>__showContextMenuAutocompletion</b>(<i></i>) | |
| 3755 | |
| 3756 <p> | |
| 3757 Private slot called before the autocompletion menu is shown. | |
| 3758 </p> | |
| 3759 <a NAME="Editor.__showContextMenuChecks" ID="Editor.__showContextMenuChecks"></a> | |
| 3760 <h4>Editor.__showContextMenuChecks</h4> | |
| 3761 <b>__showContextMenuChecks</b>(<i></i>) | |
| 3762 | |
| 3763 <p> | |
| 3764 Private slot handling the aboutToShow signal of the checks context | |
| 3765 menu. | |
| 3766 </p> | |
| 3767 <a NAME="Editor.__showContextMenuEncodings" ID="Editor.__showContextMenuEncodings"></a> | |
| 3768 <h4>Editor.__showContextMenuEncodings</h4> | |
| 3769 <b>__showContextMenuEncodings</b>(<i></i>) | |
| 3770 | |
| 3771 <p> | |
| 3772 Private slot handling the aboutToShow signal of the encodings context | |
| 3773 menu. | |
| 3774 </p> | |
| 3775 <a NAME="Editor.__showContextMenuEol" ID="Editor.__showContextMenuEol"></a> | |
| 3776 <h4>Editor.__showContextMenuEol</h4> | |
| 3777 <b>__showContextMenuEol</b>(<i></i>) | |
| 3778 | |
| 3779 <p> | |
| 3780 Private slot handling the aboutToShow signal of the eol context menu. | |
| 3781 </p> | |
| 3782 <a NAME="Editor.__showContextMenuGraphics" ID="Editor.__showContextMenuGraphics"></a> | |
| 3783 <h4>Editor.__showContextMenuGraphics</h4> | |
| 3784 <b>__showContextMenuGraphics</b>(<i></i>) | |
| 3785 | |
| 3786 <p> | |
| 3787 Private slot handling the aboutToShow signal of the diagrams context | |
| 3788 menu. | |
| 3789 </p> | |
| 3790 <a NAME="Editor.__showContextMenuLanguages" ID="Editor.__showContextMenuLanguages"></a> | |
| 3791 <h4>Editor.__showContextMenuLanguages</h4> | |
| 3792 <b>__showContextMenuLanguages</b>(<i></i>) | |
| 3793 | |
| 3794 <p> | |
| 3795 Private slot handling the aboutToShow signal of the languages context | |
| 3796 menu. | |
| 3797 </p> | |
| 3798 <a NAME="Editor.__showContextMenuMargin" ID="Editor.__showContextMenuMargin"></a> | |
| 3799 <h4>Editor.__showContextMenuMargin</h4> | |
| 3800 <b>__showContextMenuMargin</b>(<i>menu</i>) | |
| 3801 | |
| 3802 <p> | |
| 3803 Private slot handling the aboutToShow signal of the margins context | |
| 3804 menu. | |
| 3805 </p> | |
| 3806 <dl> | |
| 3807 | |
| 3808 <dt><i>menu</i> (QMenu)</dt> | |
| 3809 <dd> | |
| 3810 reference to the menu to be shown | |
| 3811 </dd> | |
| 3812 </dl> | |
| 3813 <a NAME="Editor.__showContextMenuResources" ID="Editor.__showContextMenuResources"></a> | |
| 3814 <h4>Editor.__showContextMenuResources</h4> | |
| 3815 <b>__showContextMenuResources</b>(<i></i>) | |
| 3816 | |
| 3817 <p> | |
| 3818 Private slot handling the aboutToShow signal of the resources context | |
| 3819 menu. | |
| 3820 </p> | |
| 3821 <a NAME="Editor.__showContextMenuShow" ID="Editor.__showContextMenuShow"></a> | |
| 3822 <h4>Editor.__showContextMenuShow</h4> | |
| 3823 <b>__showContextMenuShow</b>(<i></i>) | |
| 3824 | |
| 3825 <p> | |
| 3826 Private slot called before the show menu is shown. | |
| 3827 </p> | |
| 3828 <a NAME="Editor.__showContextMenuSpellCheck" ID="Editor.__showContextMenuSpellCheck"></a> | |
| 3829 <h4>Editor.__showContextMenuSpellCheck</h4> | |
| 3830 <b>__showContextMenuSpellCheck</b>(<i></i>) | |
| 3831 | |
| 3832 <p> | |
| 3833 Private slot handling the aboutToShow signal of the spell check | |
| 3834 context menu. | |
| 3835 </p> | |
| 3836 <a NAME="Editor.__showContextMenuSpellLanguages" ID="Editor.__showContextMenuSpellLanguages"></a> | |
| 3837 <h4>Editor.__showContextMenuSpellLanguages</h4> | |
| 3838 <b>__showContextMenuSpellLanguages</b>(<i></i>) | |
| 3839 | |
| 3840 <p> | |
| 3841 Private slot handling the aboutToShow signal of the spell check | |
| 3842 languages context menu. | |
| 3843 </p> | |
| 3844 <a NAME="Editor.__showContextMenuSpelling" ID="Editor.__showContextMenuSpelling"></a> | |
| 3845 <h4>Editor.__showContextMenuSpelling</h4> | |
| 3846 <b>__showContextMenuSpelling</b>(<i></i>) | |
| 3847 | |
| 3848 <p> | |
| 3849 Private slot to set up the spelling menu before it is shown. | |
| 3850 </p> | |
| 3851 <a NAME="Editor.__showContextMenuTools" ID="Editor.__showContextMenuTools"></a> | |
| 3852 <h4>Editor.__showContextMenuTools</h4> | |
| 3853 <b>__showContextMenuTools</b>(<i></i>) | |
| 3854 | |
| 3855 <p> | |
| 3856 Private slot handling the aboutToShow signal of the tools context | |
| 3857 menu. | |
| 3858 </p> | |
| 3859 <a NAME="Editor.__showImportsDiagram" ID="Editor.__showImportsDiagram"></a> | |
| 3860 <h4>Editor.__showImportsDiagram</h4> | |
| 3861 <b>__showImportsDiagram</b>(<i></i>) | |
| 3862 | |
| 3863 <p> | |
| 3864 Private method to handle the Imports Diagram context menu action. | |
| 3865 </p> | |
| 3866 <a NAME="Editor.__showMouseHoverHelp" ID="Editor.__showMouseHoverHelp"></a> | |
| 3867 <h4>Editor.__showMouseHoverHelp</h4> | |
| 3868 <b>__showMouseHoverHelp</b>(<i>pos, x, y</i>) | |
| 3869 | |
| 3870 <p> | |
| 3871 Private slot showing code information about the symbol under the | |
| 3872 cursor. | |
| 3873 </p> | |
| 3874 <dl> | |
| 3875 | |
| 3876 <dt><i>pos</i> (int)</dt> | |
| 3877 <dd> | |
| 3878 mouse position into the document | |
| 3879 </dd> | |
| 3880 <dt><i>x</i> (int)</dt> | |
| 3881 <dd> | |
| 3882 x-value of mouse screen position | |
| 3883 </dd> | |
| 3884 <dt><i>y</i> (int)</dt> | |
| 3885 <dd> | |
| 3886 y-value of mouse screen position | |
| 3887 </dd> | |
| 3888 </dl> | |
| 3889 <a NAME="Editor.__showPackageDiagram" ID="Editor.__showPackageDiagram"></a> | |
| 3890 <h4>Editor.__showPackageDiagram</h4> | |
| 3891 <b>__showPackageDiagram</b>(<i></i>) | |
| 3892 | |
| 3893 <p> | |
| 3894 Private method to handle the Package Diagram context menu action. | |
| 3895 </p> | |
| 3896 <a NAME="Editor.__showProfileData" ID="Editor.__showProfileData"></a> | |
| 3897 <h4>Editor.__showProfileData</h4> | |
| 3898 <b>__showProfileData</b>(<i></i>) | |
| 3899 | |
| 3900 <p> | |
| 3901 Private method to handle the show profile data context menu action. | |
| 3902 </p> | |
| 3903 <a NAME="Editor.__showSyntaxError" ID="Editor.__showSyntaxError"></a> | |
| 3904 <h4>Editor.__showSyntaxError</h4> | |
| 3905 <b>__showSyntaxError</b>(<i>line=-1</i>) | |
| 3906 | |
| 3907 <p> | |
| 3908 Private slot to handle the 'Show syntax error message' | |
| 3909 context menu action. | |
| 3910 </p> | |
| 3911 <dl> | |
| 3912 | |
| 3913 <dt><i>line</i></dt> | |
| 3914 <dd> | |
| 3915 line number to show the syntax error for (integer) | |
| 3916 </dd> | |
| 3917 </dl> | |
| 3918 <a NAME="Editor.__showWarning" ID="Editor.__showWarning"></a> | |
| 3919 <h4>Editor.__showWarning</h4> | |
| 3920 <b>__showWarning</b>(<i>line=-1</i>) | |
| 3921 | |
| 3922 <p> | |
| 3923 Private slot to handle the 'Show warning' context menu action. | |
| 3924 </p> | |
| 3925 <dl> | |
| 3926 | |
| 3927 <dt><i>line</i></dt> | |
| 3928 <dd> | |
| 3929 line number to show the warning for (integer) | |
| 3930 </dd> | |
| 3931 </dl> | |
| 3932 <a NAME="Editor.__spellCharAdded" ID="Editor.__spellCharAdded"></a> | |
| 3933 <h4>Editor.__spellCharAdded</h4> | |
| 3934 <b>__spellCharAdded</b>(<i>charNumber</i>) | |
| 3935 | |
| 3936 <p> | |
| 3937 Private slot called to handle the user entering a character. | |
| 3938 </p> | |
| 3939 <dl> | |
| 3940 | |
| 3941 <dt><i>charNumber</i></dt> | |
| 3942 <dd> | |
| 3943 value of the character entered (integer) | |
| 3944 </dd> | |
| 3945 </dl> | |
| 3946 <a NAME="Editor.__spellLanguageChanged" ID="Editor.__spellLanguageChanged"></a> | |
| 3947 <h4>Editor.__spellLanguageChanged</h4> | |
| 3948 <b>__spellLanguageChanged</b>(<i>language, propagate=True</i>) | |
| 3949 | |
| 3950 <p> | |
| 3951 Private slot to handle a change of the spell check language. | |
| 3952 </p> | |
| 3953 <dl> | |
| 3954 | |
| 3955 <dt><i>language</i> (str)</dt> | |
| 3956 <dd> | |
| 3957 new spell check language | |
| 3958 </dd> | |
| 3959 <dt><i>propagate</i> (bool)</dt> | |
| 3960 <dd> | |
| 3961 flag indicating to propagate the change | |
| 3962 </dd> | |
| 3963 </dl> | |
| 3964 <a NAME="Editor.__spellLanguagesMenuTriggered" ID="Editor.__spellLanguagesMenuTriggered"></a> | |
| 3965 <h4>Editor.__spellLanguagesMenuTriggered</h4> | |
| 3966 <b>__spellLanguagesMenuTriggered</b>(<i>act</i>) | |
| 3967 | |
| 3968 <p> | |
| 3969 Private method to handle the selection of a spell check language. | |
| 3970 </p> | |
| 3971 <dl> | |
| 3972 | |
| 3973 <dt><i>act</i> (QAction)</dt> | |
| 3974 <dd> | |
| 3975 reference to the action that was triggered | |
| 3976 </dd> | |
| 3977 </dl> | |
| 3978 <a NAME="Editor.__styleNeeded" ID="Editor.__styleNeeded"></a> | |
| 3979 <h4>Editor.__styleNeeded</h4> | |
| 3980 <b>__styleNeeded</b>(<i>position</i>) | |
| 3981 | |
| 3982 <p> | |
| 3983 Private slot to handle the need for more styling. | |
| 3984 </p> | |
| 3985 <dl> | |
| 3986 | |
| 3987 <dt><i>position</i></dt> | |
| 3988 <dd> | |
| 3989 end position, that needs styling (integer) | |
| 3990 </dd> | |
| 3991 </dl> | |
| 3992 <a NAME="Editor.__textChanged" ID="Editor.__textChanged"></a> | |
| 3993 <h4>Editor.__textChanged</h4> | |
| 3994 <b>__textChanged</b>(<i></i>) | |
| 3995 | |
| 3996 <p> | |
| 3997 Private slot to handle a change of the editor text. | |
| 3998 </p> | |
| 3999 <p> | |
| 4000 This slot defers the handling to the next time the event loop | |
| 4001 is run in order to ensure, that cursor position has been updated | |
| 4002 by the underlying Scintilla editor. | |
| 4003 </p> | |
| 4004 <a NAME="Editor.__toggleAutoCompletionEnable" ID="Editor.__toggleAutoCompletionEnable"></a> | |
| 4005 <h4>Editor.__toggleAutoCompletionEnable</h4> | |
| 4006 <b>__toggleAutoCompletionEnable</b>(<i></i>) | |
| 4007 | |
| 4008 <p> | |
| 4009 Private slot to handle the Enable Autocompletion context menu entry. | |
| 4010 </p> | |
| 4011 <a NAME="Editor.__toggleBreakpoint" ID="Editor.__toggleBreakpoint"></a> | |
| 4012 <h4>Editor.__toggleBreakpoint</h4> | |
| 4013 <b>__toggleBreakpoint</b>(<i>line, temporary=False</i>) | |
| 4014 | |
| 4015 <p> | |
| 4016 Private method to toggle a breakpoint. | |
| 4017 </p> | |
| 4018 <dl> | |
| 4019 | |
| 4020 <dt><i>line</i></dt> | |
| 4021 <dd> | |
| 4022 line number of the breakpoint (integer) | |
| 4023 </dd> | |
| 4024 <dt><i>temporary</i></dt> | |
| 4025 <dd> | |
| 4026 flag indicating a temporary breakpoint (boolean) | |
| 4027 </dd> | |
| 4028 </dl> | |
| 4029 <a NAME="Editor.__toggleBreakpointEnabled" ID="Editor.__toggleBreakpointEnabled"></a> | |
| 4030 <h4>Editor.__toggleBreakpointEnabled</h4> | |
| 4031 <b>__toggleBreakpointEnabled</b>(<i>line</i>) | |
| 4032 | |
| 4033 <p> | |
| 4034 Private method to toggle a breakpoints enabled status. | |
| 4035 </p> | |
| 4036 <dl> | |
| 4037 | |
| 4038 <dt><i>line</i></dt> | |
| 4039 <dd> | |
| 4040 line number of the breakpoint (integer) | |
| 4041 </dd> | |
| 4042 </dl> | |
| 4043 <a NAME="Editor.__toggleTypingAids" ID="Editor.__toggleTypingAids"></a> | |
| 4044 <h4>Editor.__toggleTypingAids</h4> | |
| 4045 <b>__toggleTypingAids</b>(<i></i>) | |
| 4046 | |
| 4047 <p> | |
| 4048 Private slot to toggle the typing aids. | |
| 4049 </p> | |
| 4050 <a NAME="Editor.__updateReadOnly" ID="Editor.__updateReadOnly"></a> | |
| 4051 <h4>Editor.__updateReadOnly</h4> | |
| 4052 <b>__updateReadOnly</b>(<i>bForce=True</i>) | |
| 4053 | |
| 4054 <p> | |
| 4055 Private method to update the readOnly information for this editor. | |
| 4056 </p> | |
| 4057 <p> | |
| 4058 If bForce is True, then updates everything regardless if | |
| 4059 the attributes have actually changed, such as during | |
| 4060 initialization time. A signal is emitted after the | |
| 4061 caption change. | |
| 4062 </p> | |
| 4063 <dl> | |
| 4064 | |
| 4065 <dt><i>bForce</i></dt> | |
| 4066 <dd> | |
| 4067 True to force change, False to only update and emit | |
| 4068 signal if there was an attribute change. | |
| 4069 </dd> | |
| 4070 </dl> | |
| 4071 <a NAME="Editor.addCallTipHook" ID="Editor.addCallTipHook"></a> | |
| 4072 <h4>Editor.addCallTipHook</h4> | |
| 4073 <b>addCallTipHook</b>(<i>key, func</i>) | |
| 4074 | |
| 4075 <p> | |
| 4076 Public method to set a calltip provider. | |
| 4077 </p> | |
| 4078 <dl> | |
| 4079 | |
| 4080 <dt><i>key</i> (str)</dt> | |
| 4081 <dd> | |
| 4082 name of the provider | |
| 4083 </dd> | |
| 4084 <dt><i>func</i> (function(editor, int, int) -> list of str)</dt> | |
| 4085 <dd> | |
| 4086 function providing calltips. func | |
| 4087 should be a function taking a reference to the editor, | |
| 4088 a position into the text and the amount of commas to the | |
| 4089 left of the cursor. It should return the possible | |
| 4090 calltips as a list of strings. | |
| 4091 </dd> | |
| 4092 </dl> | |
| 4093 <a NAME="Editor.addClone" ID="Editor.addClone"></a> | |
| 4094 <h4>Editor.addClone</h4> | |
| 4095 <b>addClone</b>(<i>editor</i>) | |
| 4096 | |
| 4097 <p> | |
| 4098 Public method to add a clone to our list. | |
| 4099 </p> | |
| 4100 <dl> | |
| 4101 | |
| 4102 <dt><i>editor</i> (Editor)</dt> | |
| 4103 <dd> | |
| 4104 reference to the cloned editor | |
| 4105 </dd> | |
| 4106 </dl> | |
| 4107 <a NAME="Editor.addCompletionListHook" ID="Editor.addCompletionListHook"></a> | |
| 4108 <h4>Editor.addCompletionListHook</h4> | |
| 4109 <b>addCompletionListHook</b>(<i>key, func, asynchroneous=False</i>) | |
| 4110 | |
| 4111 <p> | |
| 4112 Public method to set an auto-completion list provider. | |
| 4113 </p> | |
| 4114 <dl> | |
| 4115 | |
| 4116 <dt><i>key</i> (str)</dt> | |
| 4117 <dd> | |
| 4118 name of the provider | |
| 4119 </dd> | |
| 4120 <dt><i>func</i> (function(editor, bool) -> list of str in case async is False)</dt> | |
| 4121 <dd> | |
| 4122 function providing completion list. func | |
| 4123 should be a function taking a reference to the editor and | |
| 4124 a boolean indicating to complete a context. It should return | |
| 4125 the possible completions as a list of strings. | |
| 4126 and function(editor, bool, str) returning nothing in case async | |
| 4127 is True | |
| 4128 </dd> | |
| 4129 <dt><i>asynchroneous</i> (bool)</dt> | |
| 4130 <dd> | |
| 4131 flag indicating an asynchroneous function | |
| 4132 </dd> | |
| 4133 </dl> | |
| 4134 <a NAME="Editor.addedToProject" ID="Editor.addedToProject"></a> | |
| 4135 <h4>Editor.addedToProject</h4> | |
| 4136 <b>addedToProject</b>(<i></i>) | |
| 4137 | |
| 4138 <p> | |
| 4139 Public method to signal, that this editor has been added to a project. | |
| 4140 </p> | |
| 4141 <a NAME="Editor.autoComplete" ID="Editor.autoComplete"></a> | |
| 4142 <h4>Editor.autoComplete</h4> | |
| 4143 <b>autoComplete</b>(<i>auto=False, context=True</i>) | |
| 4144 | |
| 4145 <p> | |
| 4146 Public method to start auto-completion. | |
| 4147 </p> | |
| 4148 <dl> | |
| 4149 | |
| 4150 <dt><i>auto</i></dt> | |
| 4151 <dd> | |
| 4152 flag indicating a call from the __charAdded method | |
| 4153 (boolean) | |
| 4154 </dd> | |
| 4155 <dt><i>context</i></dt> | |
| 4156 <dd> | |
| 4157 flag indicating to complete a context (boolean) | |
| 4158 </dd> | |
| 4159 </dl> | |
| 4160 <a NAME="Editor.autoCompleteQScintilla" ID="Editor.autoCompleteQScintilla"></a> | |
| 4161 <h4>Editor.autoCompleteQScintilla</h4> | |
| 4162 <b>autoCompleteQScintilla</b>(<i></i>) | |
| 4163 | |
| 4164 <p> | |
| 4165 Public method to perform an autocompletion using QScintilla methods. | |
| 4166 </p> | |
| 4167 <a NAME="Editor.boxCommentLine" ID="Editor.boxCommentLine"></a> | |
| 4168 <h4>Editor.boxCommentLine</h4> | |
| 4169 <b>boxCommentLine</b>(<i></i>) | |
| 4170 | |
| 4171 <p> | |
| 4172 Public slot to box comment the current line. | |
| 4173 </p> | |
| 4174 <a NAME="Editor.boxCommentLineOrSelection" ID="Editor.boxCommentLineOrSelection"></a> | |
| 4175 <h4>Editor.boxCommentLineOrSelection</h4> | |
| 4176 <b>boxCommentLineOrSelection</b>(<i></i>) | |
| 4177 | |
| 4178 <p> | |
| 4179 Public slot to box comment the current line or current selection. | |
| 4180 </p> | |
| 4181 <a NAME="Editor.boxCommentSelection" ID="Editor.boxCommentSelection"></a> | |
| 4182 <h4>Editor.boxCommentSelection</h4> | |
| 4183 <b>boxCommentSelection</b>(<i></i>) | |
| 4184 | |
| 4185 <p> | |
| 4186 Public slot to box comment the current selection. | |
| 4187 </p> | |
| 4188 <a NAME="Editor.callTip" ID="Editor.callTip"></a> | |
| 4189 <h4>Editor.callTip</h4> | |
| 4190 <b>callTip</b>(<i></i>) | |
| 4191 | |
| 4192 <p> | |
| 4193 Public method to show calltips. | |
| 4194 </p> | |
| 4195 <a NAME="Editor.canAutoCompleteFromAPIs" ID="Editor.canAutoCompleteFromAPIs"></a> | |
| 4196 <h4>Editor.canAutoCompleteFromAPIs</h4> | |
| 4197 <b>canAutoCompleteFromAPIs</b>(<i></i>) | |
| 4198 | |
| 4199 <p> | |
| 4200 Public method to check for API availablity. | |
| 4201 </p> | |
| 4202 <dl> | |
| 4203 <dt>Return:</dt> | |
| 4204 <dd> | |
| 4205 flag indicating autocompletion from APIs is available (boolean) | |
| 4206 </dd> | |
| 4207 </dl> | |
| 4208 <a NAME="Editor.canProvideCallTipps" ID="Editor.canProvideCallTipps"></a> | |
| 4209 <h4>Editor.canProvideCallTipps</h4> | |
| 4210 <b>canProvideCallTipps</b>(<i></i>) | |
| 4211 | |
| 4212 <p> | |
| 4213 Public method to test the calltips availability. | |
| 4214 </p> | |
| 4215 <dl> | |
| 4216 <dt>Return:</dt> | |
| 4217 <dd> | |
| 4218 flag indicating the availability of calltips (boolean) | |
| 4219 </dd> | |
| 4220 </dl> | |
| 4221 <a NAME="Editor.canProvideDynamicAutoCompletion" ID="Editor.canProvideDynamicAutoCompletion"></a> | |
| 4222 <h4>Editor.canProvideDynamicAutoCompletion</h4> | |
| 4223 <b>canProvideDynamicAutoCompletion</b>(<i></i>) | |
| 4224 | |
| 4225 <p> | |
| 4226 Public method to test the dynamic auto-completion availability. | |
| 4227 </p> | |
| 4228 <dl> | |
| 4229 <dt>Return:</dt> | |
| 4230 <dd> | |
| 4231 flag indicating the availability of dynamic auto-completion | |
| 4232 (boolean) | |
| 4233 </dd> | |
| 4234 </dl> | |
| 4235 <a NAME="Editor.cancelSharedEdit" ID="Editor.cancelSharedEdit"></a> | |
| 4236 <h4>Editor.cancelSharedEdit</h4> | |
| 4237 <b>cancelSharedEdit</b>(<i>send=True</i>) | |
| 4238 | |
| 4239 <p> | |
| 4240 Public slot to cancel a shared edit session for the editor. | |
| 4241 </p> | |
| 4242 <dl> | |
| 4243 | |
| 4244 <dt><i>send</i></dt> | |
| 4245 <dd> | |
| 4246 flag indicating to send the CancelEdit command (boolean) | |
| 4247 </dd> | |
| 4248 </dl> | |
| 4249 <a NAME="Editor.changeEvent" ID="Editor.changeEvent"></a> | |
| 4250 <h4>Editor.changeEvent</h4> | |
| 4251 <b>changeEvent</b>(<i>evt</i>) | |
| 4252 | |
| 4253 <p> | |
| 4254 Protected method called to process an event. | |
| 4255 </p> | |
| 4256 <p> | |
| 4257 This implements special handling for the events showMaximized, | |
| 4258 showMinimized and showNormal. The windows caption is shortened | |
| 4259 for the minimized mode and reset to the full filename for the | |
| 4260 other modes. This is to make the editor windows work nicer | |
| 4261 with the QWorkspace. | |
| 4262 </p> | |
| 4263 <dl> | |
| 4264 | |
| 4265 <dt><i>evt</i> (QEvent)</dt> | |
| 4266 <dd> | |
| 4267 the event, that was generated | |
| 4268 </dd> | |
| 4269 </dl> | |
| 4270 <a NAME="Editor.checkDirty" ID="Editor.checkDirty"></a> | |
| 4271 <h4>Editor.checkDirty</h4> | |
| 4272 <b>checkDirty</b>(<i></i>) | |
| 4273 | |
| 4274 <p> | |
| 4275 Public method to check dirty status and open a message window. | |
| 4276 </p> | |
| 4277 <dl> | |
| 4278 <dt>Return:</dt> | |
| 4279 <dd> | |
| 4280 flag indicating successful reset of the dirty flag (boolean) | |
| 4281 </dd> | |
| 4282 </dl> | |
| 4283 <a NAME="Editor.checkSpelling" ID="Editor.checkSpelling"></a> | |
| 4284 <h4>Editor.checkSpelling</h4> | |
| 4285 <b>checkSpelling</b>(<i></i>) | |
| 4286 | |
| 4287 <p> | |
| 4288 Public slot to perform an interactive spell check of the document. | |
| 4289 </p> | |
| 4290 <a NAME="Editor.checkSyntax" ID="Editor.checkSyntax"></a> | |
| 4291 <h4>Editor.checkSyntax</h4> | |
| 4292 <b>checkSyntax</b>(<i></i>) | |
| 4293 | |
| 4294 <p> | |
| 4295 Public method to perform an automatic syntax check of the file. | |
| 4296 </p> | |
| 4297 <a NAME="Editor.clearAllHighlights" ID="Editor.clearAllHighlights"></a> | |
| 4298 <h4>Editor.clearAllHighlights</h4> | |
| 4299 <b>clearAllHighlights</b>(<i></i>) | |
| 4300 | |
| 4301 <p> | |
| 4302 Public method to clear all highlights. | |
| 4303 </p> | |
| 4304 <a NAME="Editor.clearBookmarks" ID="Editor.clearBookmarks"></a> | |
| 4305 <h4>Editor.clearBookmarks</h4> | |
| 4306 <b>clearBookmarks</b>(<i></i>) | |
| 4307 | |
| 4308 <p> | |
| 4309 Public slot to handle the 'Clear all bookmarks' context menu action. | |
| 4310 </p> | |
| 4311 <a NAME="Editor.clearBreakpoint" ID="Editor.clearBreakpoint"></a> | |
| 4312 <h4>Editor.clearBreakpoint</h4> | |
| 4313 <b>clearBreakpoint</b>(<i>line</i>) | |
| 4314 | |
| 4315 <p> | |
| 4316 Public method to clear a breakpoint. | |
| 4317 </p> | |
| 4318 <p> | |
| 4319 Note: This doesn't clear the breakpoint in the debugger, | |
| 4320 it just deletes it from the editor internal list of breakpoints. | |
| 4321 </p> | |
| 4322 <dl> | |
| 4323 | |
| 4324 <dt><i>line</i></dt> | |
| 4325 <dd> | |
| 4326 line number of the breakpoint (integer) | |
| 4327 </dd> | |
| 4328 </dl> | |
| 4329 <a NAME="Editor.clearFlakesWarnings" ID="Editor.clearFlakesWarnings"></a> | |
| 4330 <h4>Editor.clearFlakesWarnings</h4> | |
| 4331 <b>clearFlakesWarnings</b>(<i></i>) | |
| 4332 | |
| 4333 <p> | |
| 4334 Public slot to clear all pyflakes warnings. | |
| 4335 </p> | |
| 4336 <a NAME="Editor.clearHighlight" ID="Editor.clearHighlight"></a> | |
| 4337 <h4>Editor.clearHighlight</h4> | |
| 4338 <b>clearHighlight</b>(<i>startLine, startIndex, endLine, endIndex</i>) | |
| 4339 | |
| 4340 <p> | |
| 4341 Public method to clear a text highlight. | |
| 4342 </p> | |
| 4343 <dl> | |
| 4344 | |
| 4345 <dt><i>startLine</i> (int)</dt> | |
| 4346 <dd> | |
| 4347 line of the highlight start | |
| 4348 </dd> | |
| 4349 <dt><i>startIndex</i> (int)</dt> | |
| 4350 <dd> | |
| 4351 index of the highlight start | |
| 4352 </dd> | |
| 4353 <dt><i>endLine</i> (int)</dt> | |
| 4354 <dd> | |
| 4355 line of the highlight end | |
| 4356 </dd> | |
| 4357 <dt><i>endIndex</i> (int)</dt> | |
| 4358 <dd> | |
| 4359 index of the highlight end | |
| 4360 </dd> | |
| 4361 </dl> | |
| 4362 <a NAME="Editor.clearSearchIndicators" ID="Editor.clearSearchIndicators"></a> | |
| 4363 <h4>Editor.clearSearchIndicators</h4> | |
| 4364 <b>clearSearchIndicators</b>(<i></i>) | |
| 4365 | |
| 4366 <p> | |
| 4367 Public method to clear all search indicators. | |
| 4368 </p> | |
| 4369 <a NAME="Editor.clearStyleWarnings" ID="Editor.clearStyleWarnings"></a> | |
| 4370 <h4>Editor.clearStyleWarnings</h4> | |
| 4371 <b>clearStyleWarnings</b>(<i></i>) | |
| 4372 | |
| 4373 <p> | |
| 4374 Public slot to clear all style warnings. | |
| 4375 </p> | |
| 4376 <a NAME="Editor.clearStyles" ID="Editor.clearStyles"></a> | |
| 4377 <h4>Editor.clearStyles</h4> | |
| 4378 <b>clearStyles</b>(<i></i>) | |
| 4379 | |
| 4380 <p> | |
| 4381 Public method to set the styles according the selected Qt style | |
| 4382 or the selected editor colours. | |
| 4383 </p> | |
| 4384 <a NAME="Editor.clearSyntaxError" ID="Editor.clearSyntaxError"></a> | |
| 4385 <h4>Editor.clearSyntaxError</h4> | |
| 4386 <b>clearSyntaxError</b>(<i></i>) | |
| 4387 | |
| 4388 <p> | |
| 4389 Public slot to handle the 'Clear all syntax error' context menu action. | |
| 4390 </p> | |
| 4391 <a NAME="Editor.clearWarnings" ID="Editor.clearWarnings"></a> | |
| 4392 <h4>Editor.clearWarnings</h4> | |
| 4393 <b>clearWarnings</b>(<i></i>) | |
| 4394 | |
| 4395 <p> | |
| 4396 Public slot to clear all warnings. | |
| 4397 </p> | |
| 4398 <a NAME="Editor.close" ID="Editor.close"></a> | |
| 4399 <h4>Editor.close</h4> | |
| 4400 <b>close</b>(<i>alsoDelete=False</i>) | |
| 4401 | |
| 4402 <p> | |
| 4403 Public method called when the window gets closed. | |
| 4404 </p> | |
| 4405 <p> | |
| 4406 This overwritten method redirects the action to our | |
| 4407 ViewManager.closeEditor, which in turn calls our closeIt | |
| 4408 method. | |
| 4409 </p> | |
| 4410 <dl> | |
| 4411 | |
| 4412 <dt><i>alsoDelete</i></dt> | |
| 4413 <dd> | |
| 4414 ignored | |
| 4415 </dd> | |
| 4416 </dl> | |
| 4417 <dl> | |
| 4418 <dt>Return:</dt> | |
| 4419 <dd> | |
| 4420 flag indicating a successful close of the editor (boolean) | |
| 4421 </dd> | |
| 4422 </dl> | |
| 4423 <a NAME="Editor.closeIt" ID="Editor.closeIt"></a> | |
| 4424 <h4>Editor.closeIt</h4> | |
| 4425 <b>closeIt</b>(<i></i>) | |
| 4426 | |
| 4427 <p> | |
| 4428 Public method called by the viewmanager to finally get rid of us. | |
| 4429 </p> | |
| 4430 <a NAME="Editor.codeCoverageShowAnnotations" ID="Editor.codeCoverageShowAnnotations"></a> | |
| 4431 <h4>Editor.codeCoverageShowAnnotations</h4> | |
| 4432 <b>codeCoverageShowAnnotations</b>(<i>silent=False, coverageFile=None</i>) | |
| 4433 | |
| 4434 <p> | |
| 4435 Public method to handle the show code coverage annotations context | |
| 4436 menu action. | |
| 4437 </p> | |
| 4438 <dl> | |
| 4439 | |
| 4440 <dt><i>silent</i> (bool (optional))</dt> | |
| 4441 <dd> | |
| 4442 flag indicating to not show any dialog (defaults to | |
| 4443 False) | |
| 4444 </dd> | |
| 4445 <dt><i>coverageFile</i> (str (optional))</dt> | |
| 4446 <dd> | |
| 4447 path of the file containing the code coverage data | |
| 4448 (defaults to None) | |
| 4449 </dd> | |
| 4450 </dl> | |
| 4451 <a NAME="Editor.collapseFoldWithChildren" ID="Editor.collapseFoldWithChildren"></a> | |
| 4452 <h4>Editor.collapseFoldWithChildren</h4> | |
| 4453 <b>collapseFoldWithChildren</b>(<i>line=-1</i>) | |
| 4454 | |
| 4455 <p> | |
| 4456 Public slot to collapse the current fold including its children. | |
| 4457 </p> | |
| 4458 <dl> | |
| 4459 | |
| 4460 <dt><i>line</i> (int)</dt> | |
| 4461 <dd> | |
| 4462 number of line to be expanded | |
| 4463 </dd> | |
| 4464 </dl> | |
| 4465 <a NAME="Editor.commentLine" ID="Editor.commentLine"></a> | |
| 4466 <h4>Editor.commentLine</h4> | |
| 4467 <b>commentLine</b>(<i></i>) | |
| 4468 | |
| 4469 <p> | |
| 4470 Public slot to comment the current line. | |
| 4471 </p> | |
| 4472 <a NAME="Editor.commentLineOrSelection" ID="Editor.commentLineOrSelection"></a> | |
| 4473 <h4>Editor.commentLineOrSelection</h4> | |
| 4474 <b>commentLineOrSelection</b>(<i></i>) | |
| 4475 | |
| 4476 <p> | |
| 4477 Public slot to comment the current line or current selection. | |
| 4478 </p> | |
| 4479 <a NAME="Editor.commentSelection" ID="Editor.commentSelection"></a> | |
| 4480 <h4>Editor.commentSelection</h4> | |
| 4481 <b>commentSelection</b>(<i></i>) | |
| 4482 | |
| 4483 <p> | |
| 4484 Public slot to comment the current selection. | |
| 4485 </p> | |
| 4486 <a NAME="Editor.completionsListReady" ID="Editor.completionsListReady"></a> | |
| 4487 <h4>Editor.completionsListReady</h4> | |
| 4488 <b>completionsListReady</b>(<i>completions, acText</i>) | |
| 4489 | |
| 4490 <p> | |
| 4491 Public method to show the completions determined by a completions | |
| 4492 provider. | |
| 4493 </p> | |
| 4494 <dl> | |
| 4495 | |
| 4496 <dt><i>completions</i> (list of str or set of str)</dt> | |
| 4497 <dd> | |
| 4498 list of possible completions | |
| 4499 </dd> | |
| 4500 <dt><i>acText</i> (str)</dt> | |
| 4501 <dd> | |
| 4502 text to be completed | |
| 4503 </dd> | |
| 4504 </dl> | |
| 4505 <a NAME="Editor.contextMenuEvent" ID="Editor.contextMenuEvent"></a> | |
| 4506 <h4>Editor.contextMenuEvent</h4> | |
| 4507 <b>contextMenuEvent</b>(<i>evt</i>) | |
| 4508 | |
| 4509 <p> | |
| 4510 Protected method implementing the context menu event. | |
| 4511 </p> | |
| 4512 <dl> | |
| 4513 | |
| 4514 <dt><i>evt</i></dt> | |
| 4515 <dd> | |
| 4516 the context menu event (QContextMenuEvent) | |
| 4517 </dd> | |
| 4518 </dl> | |
| 4519 <a NAME="Editor.curLineHasBreakpoint" ID="Editor.curLineHasBreakpoint"></a> | |
| 4520 <h4>Editor.curLineHasBreakpoint</h4> | |
| 4521 <b>curLineHasBreakpoint</b>(<i></i>) | |
| 4522 | |
| 4523 <p> | |
| 4524 Public method to check for the presence of a breakpoint at the current | |
| 4525 line. | |
| 4526 </p> | |
| 4527 <dl> | |
| 4528 <dt>Return:</dt> | |
| 4529 <dd> | |
| 4530 flag indicating the presence of a breakpoint (boolean) | |
| 4531 </dd> | |
| 4532 </dl> | |
| 4533 <a NAME="Editor.determineFileType" ID="Editor.determineFileType"></a> | |
| 4534 <h4>Editor.determineFileType</h4> | |
| 4535 <b>determineFileType</b>(<i></i>) | |
| 4536 | |
| 4537 <p> | |
| 4538 Public method to determine the file type using various tests. | |
| 4539 </p> | |
| 4540 <dl> | |
| 4541 <dt>Return:</dt> | |
| 4542 <dd> | |
| 4543 type of the displayed file or an empty string (string) | |
| 4544 </dd> | |
| 4545 </dl> | |
| 4546 <a NAME="Editor.dragEnterEvent" ID="Editor.dragEnterEvent"></a> | |
| 4547 <h4>Editor.dragEnterEvent</h4> | |
| 4548 <b>dragEnterEvent</b>(<i>event</i>) | |
| 4549 | |
| 4550 <p> | |
| 4551 Protected method to handle the drag enter event. | |
| 4552 </p> | |
| 4553 <dl> | |
| 4554 | |
| 4555 <dt><i>event</i></dt> | |
| 4556 <dd> | |
| 4557 the drag enter event (QDragEnterEvent) | |
| 4558 </dd> | |
| 4559 </dl> | |
| 4560 <a NAME="Editor.dragLeaveEvent" ID="Editor.dragLeaveEvent"></a> | |
| 4561 <h4>Editor.dragLeaveEvent</h4> | |
| 4562 <b>dragLeaveEvent</b>(<i>event</i>) | |
| 4563 | |
| 4564 <p> | |
| 4565 Protected method to handle the drag leave event. | |
| 4566 </p> | |
| 4567 <dl> | |
| 4568 | |
| 4569 <dt><i>event</i></dt> | |
| 4570 <dd> | |
| 4571 the drag leave event (QDragLeaveEvent) | |
| 4572 </dd> | |
| 4573 </dl> | |
| 4574 <a NAME="Editor.dragMoveEvent" ID="Editor.dragMoveEvent"></a> | |
| 4575 <h4>Editor.dragMoveEvent</h4> | |
| 4576 <b>dragMoveEvent</b>(<i>event</i>) | |
| 4577 | |
| 4578 <p> | |
| 4579 Protected method to handle the drag move event. | |
| 4580 </p> | |
| 4581 <dl> | |
| 4582 | |
| 4583 <dt><i>event</i></dt> | |
| 4584 <dd> | |
| 4585 the drag move event (QDragMoveEvent) | |
| 4586 </dd> | |
| 4587 </dl> | |
| 4588 <a NAME="Editor.dropEvent" ID="Editor.dropEvent"></a> | |
| 4589 <h4>Editor.dropEvent</h4> | |
| 4590 <b>dropEvent</b>(<i>event</i>) | |
| 4591 | |
| 4592 <p> | |
| 4593 Protected method to handle the drop event. | |
| 4594 </p> | |
| 4595 <dl> | |
| 4596 | |
| 4597 <dt><i>event</i></dt> | |
| 4598 <dd> | |
| 4599 the drop event (QDropEvent) | |
| 4600 </dd> | |
| 4601 </dl> | |
| 4602 <a NAME="Editor.editorCommand" ID="Editor.editorCommand"></a> | |
| 4603 <h4>Editor.editorCommand</h4> | |
| 4604 <b>editorCommand</b>(<i>cmd</i>) | |
| 4605 | |
| 4606 <p> | |
| 4607 Public method to perform a simple editor command. | |
| 4608 </p> | |
| 4609 <dl> | |
| 4610 | |
| 4611 <dt><i>cmd</i></dt> | |
| 4612 <dd> | |
| 4613 the scintilla command to be performed | |
| 4614 </dd> | |
| 4615 </dl> | |
| 4616 <a NAME="Editor.encloseSelectedText" ID="Editor.encloseSelectedText"></a> | |
| 4617 <h4>Editor.encloseSelectedText</h4> | |
| 4618 <b>encloseSelectedText</b>(<i></i>) | |
| 4619 | |
| 4620 <p> | |
| 4621 Local function to enclose the current selection with some | |
| 4622 characters. | |
| 4623 </p> | |
| 4624 <dl> | |
| 4625 | |
| 4626 <dt><i>encString</i> (str)</dt> | |
| 4627 <dd> | |
| 4628 string to use to enclose the selection | |
| 4629 (one or two characters) | |
| 4630 </dd> | |
| 4631 </dl> | |
| 4632 <a NAME="Editor.ensureVisible" ID="Editor.ensureVisible"></a> | |
| 4633 <h4>Editor.ensureVisible</h4> | |
| 4634 <b>ensureVisible</b>(<i>line, expand=False</i>) | |
| 4635 | |
| 4636 <p> | |
| 4637 Public slot to ensure, that the specified line is visible. | |
| 4638 </p> | |
| 4639 <dl> | |
| 4640 | |
| 4641 <dt><i>line</i> (int)</dt> | |
| 4642 <dd> | |
| 4643 line number to make visible | |
| 4644 </dd> | |
| 4645 <dt><i>expand</i> (bool)</dt> | |
| 4646 <dd> | |
| 4647 flag indicating to expand all folds | |
| 4648 </dd> | |
| 4649 </dl> | |
| 4650 <a NAME="Editor.ensureVisibleTop" ID="Editor.ensureVisibleTop"></a> | |
| 4651 <h4>Editor.ensureVisibleTop</h4> | |
| 4652 <b>ensureVisibleTop</b>(<i>line, expand=False</i>) | |
| 4653 | |
| 4654 <p> | |
| 4655 Public slot to ensure, that the specified line is visible at the top | |
| 4656 of the editor. | |
| 4657 </p> | |
| 4658 <dl> | |
| 4659 | |
| 4660 <dt><i>line</i> (int)</dt> | |
| 4661 <dd> | |
| 4662 line number to make visible | |
| 4663 </dd> | |
| 4664 <dt><i>expand</i> (bool)</dt> | |
| 4665 <dd> | |
| 4666 flag indicating to expand all folds | |
| 4667 </dd> | |
| 4668 </dl> | |
| 4669 <a NAME="Editor.event" ID="Editor.event"></a> | |
| 4670 <h4>Editor.event</h4> | |
| 4671 <b>event</b>(<i>evt</i>) | |
| 4672 | |
| 4673 <p> | |
| 4674 Public method handling events. | |
| 4675 </p> | |
| 4676 <dl> | |
| 4677 | |
| 4678 <dt><i>evt</i> (QEvent)</dt> | |
| 4679 <dd> | |
| 4680 reference to the event | |
| 4681 </dd> | |
| 4682 </dl> | |
| 4683 <dl> | |
| 4684 <dt>Return:</dt> | |
| 4685 <dd> | |
| 4686 flag indicating, if the event was handled | |
| 4687 </dd> | |
| 4688 </dl> | |
| 4689 <dl> | |
| 4690 <dt>Return Type:</dt> | |
| 4691 <dd> | |
| 4692 bool | |
| 4693 </dd> | |
| 4694 </dl> | |
| 4695 <a NAME="Editor.expandFoldWithChildren" ID="Editor.expandFoldWithChildren"></a> | |
| 4696 <h4>Editor.expandFoldWithChildren</h4> | |
| 4697 <b>expandFoldWithChildren</b>(<i>line=-1</i>) | |
| 4698 | |
| 4699 <p> | |
| 4700 Public slot to expand the current fold including its children. | |
| 4701 </p> | |
| 4702 <dl> | |
| 4703 | |
| 4704 <dt><i>line</i> (int)</dt> | |
| 4705 <dd> | |
| 4706 number of line to be expanded | |
| 4707 </dd> | |
| 4708 </dl> | |
| 4709 <a NAME="Editor.exportFile" ID="Editor.exportFile"></a> | |
| 4710 <h4>Editor.exportFile</h4> | |
| 4711 <b>exportFile</b>(<i>exporterFormat</i>) | |
| 4712 | |
| 4713 <p> | |
| 4714 Public method to export the file. | |
| 4715 </p> | |
| 4716 <dl> | |
| 4717 | |
| 4718 <dt><i>exporterFormat</i></dt> | |
| 4719 <dd> | |
| 4720 format the file should be exported into (string) | |
| 4721 </dd> | |
| 4722 </dl> | |
| 4723 <a NAME="Editor.extractTasks" ID="Editor.extractTasks"></a> | |
| 4724 <h4>Editor.extractTasks</h4> | |
| 4725 <b>extractTasks</b>(<i></i>) | |
| 4726 | |
| 4727 <p> | |
| 4728 Public slot to extract all tasks. | |
| 4729 </p> | |
| 4730 <a NAME="Editor.fileRenamed" ID="Editor.fileRenamed"></a> | |
| 4731 <h4>Editor.fileRenamed</h4> | |
| 4732 <b>fileRenamed</b>(<i>fn</i>) | |
| 4733 | |
| 4734 <p> | |
| 4735 Public slot to handle the editorRenamed signal. | |
| 4736 </p> | |
| 4737 <dl> | |
| 4738 | |
| 4739 <dt><i>fn</i></dt> | |
| 4740 <dd> | |
| 4741 filename to be set for the editor (string). | |
| 4742 </dd> | |
| 4743 </dl> | |
| 4744 <a NAME="Editor.focusInEvent" ID="Editor.focusInEvent"></a> | |
| 4745 <h4>Editor.focusInEvent</h4> | |
| 4746 <b>focusInEvent</b>(<i>event</i>) | |
| 4747 | |
| 4748 <p> | |
| 4749 Protected method called when the editor receives focus. | |
| 4750 </p> | |
| 4751 <p> | |
| 4752 This method checks for modifications of the current file and | |
| 4753 rereads it upon request. The cursor is placed at the current position | |
| 4754 assuming, that it is in the vicinity of the old position after the | |
| 4755 reread. | |
| 4756 </p> | |
| 4757 <dl> | |
| 4758 | |
| 4759 <dt><i>event</i> (QFocusEvent)</dt> | |
| 4760 <dd> | |
| 4761 the event object | |
| 4762 </dd> | |
| 4763 </dl> | |
| 4764 <a NAME="Editor.focusOutEvent" ID="Editor.focusOutEvent"></a> | |
| 4765 <h4>Editor.focusOutEvent</h4> | |
| 4766 <b>focusOutEvent</b>(<i>event</i>) | |
| 4767 | |
| 4768 <p> | |
| 4769 Protected method called when the editor loses focus. | |
| 4770 </p> | |
| 4771 <dl> | |
| 4772 | |
| 4773 <dt><i>event</i> (QFocusEvent)</dt> | |
| 4774 <dd> | |
| 4775 the event object | |
| 4776 </dd> | |
| 4777 </dl> | |
| 4778 <a NAME="Editor.gestureEvent" ID="Editor.gestureEvent"></a> | |
| 4779 <h4>Editor.gestureEvent</h4> | |
| 4780 <b>gestureEvent</b>(<i>evt</i>) | |
| 4781 | |
| 4782 <p> | |
| 4783 Protected method handling gesture events. | |
| 4784 </p> | |
| 4785 <dl> | |
| 4786 | |
| 4787 <dt><i>evt</i> (QGestureEvent)</dt> | |
| 4788 <dd> | |
| 4789 reference to the gesture event | |
| 4790 </dd> | |
| 4791 </dl> | |
| 4792 <a NAME="Editor.getApiLanguage" ID="Editor.getApiLanguage"></a> | |
| 4793 <h4>Editor.getApiLanguage</h4> | |
| 4794 <b>getApiLanguage</b>(<i></i>) | |
| 4795 | |
| 4796 <p> | |
| 4797 Public method to get the API language of the editor. | |
| 4798 </p> | |
| 4799 <dl> | |
| 4800 <dt>Return:</dt> | |
| 4801 <dd> | |
| 4802 API language | |
| 4803 </dd> | |
| 4804 </dl> | |
| 4805 <dl> | |
| 4806 <dt>Return Type:</dt> | |
| 4807 <dd> | |
| 4808 str | |
| 4809 </dd> | |
| 4810 </dl> | |
| 4811 <a NAME="Editor.getBookmarkLines" ID="Editor.getBookmarkLines"></a> | |
| 4812 <h4>Editor.getBookmarkLines</h4> | |
| 4813 <b>getBookmarkLines</b>(<i></i>) | |
| 4814 | |
| 4815 <p> | |
| 4816 Public method to get the lines containing a bookmark. | |
| 4817 </p> | |
| 4818 <dl> | |
| 4819 <dt>Return:</dt> | |
| 4820 <dd> | |
| 4821 list of lines containing a bookmark (list of integer) | |
| 4822 </dd> | |
| 4823 </dl> | |
| 4824 <a NAME="Editor.getBookmarks" ID="Editor.getBookmarks"></a> | |
| 4825 <h4>Editor.getBookmarks</h4> | |
| 4826 <b>getBookmarks</b>(<i></i>) | |
| 4827 | |
| 4828 <p> | |
| 4829 Public method to retrieve the bookmarks. | |
| 4830 </p> | |
| 4831 <dl> | |
| 4832 <dt>Return:</dt> | |
| 4833 <dd> | |
| 4834 sorted list of all lines containing a bookmark | |
| 4835 (list of integer) | |
| 4836 </dd> | |
| 4837 </dl> | |
| 4838 <a NAME="Editor.getBreakpointLines" ID="Editor.getBreakpointLines"></a> | |
| 4839 <h4>Editor.getBreakpointLines</h4> | |
| 4840 <b>getBreakpointLines</b>(<i></i>) | |
| 4841 | |
| 4842 <p> | |
| 4843 Public method to get the lines containing a breakpoint. | |
| 4844 </p> | |
| 4845 <dl> | |
| 4846 <dt>Return:</dt> | |
| 4847 <dd> | |
| 4848 list of lines containing a breakpoint (list of integer) | |
| 4849 </dd> | |
| 4850 </dl> | |
| 4851 <a NAME="Editor.getCallTipHook" ID="Editor.getCallTipHook"></a> | |
| 4852 <h4>Editor.getCallTipHook</h4> | |
| 4853 <b>getCallTipHook</b>(<i>key</i>) | |
| 4854 | |
| 4855 <p> | |
| 4856 Public method to get the registered calltip provider. | |
| 4857 </p> | |
| 4858 <dl> | |
| 4859 | |
| 4860 <dt><i>key</i> (str)</dt> | |
| 4861 <dd> | |
| 4862 name of the provider | |
| 4863 </dd> | |
| 4864 </dl> | |
| 4865 <dl> | |
| 4866 <dt>Return:</dt> | |
| 4867 <dd> | |
| 4868 function providing calltips | |
| 4869 </dd> | |
| 4870 </dl> | |
| 4871 <dl> | |
| 4872 <dt>Return Type:</dt> | |
| 4873 <dd> | |
| 4874 function or None | |
| 4875 </dd> | |
| 4876 </dl> | |
| 4877 <a NAME="Editor.getChangeLines" ID="Editor.getChangeLines"></a> | |
| 4878 <h4>Editor.getChangeLines</h4> | |
| 4879 <b>getChangeLines</b>(<i></i>) | |
| 4880 | |
| 4881 <p> | |
| 4882 Public method to get the lines containing a change. | |
| 4883 </p> | |
| 4884 <dl> | |
| 4885 <dt>Return:</dt> | |
| 4886 <dd> | |
| 4887 list of lines containing a change (list of integer) | |
| 4888 </dd> | |
| 4889 </dl> | |
| 4890 <a NAME="Editor.getCompleter" ID="Editor.getCompleter"></a> | |
| 4891 <h4>Editor.getCompleter</h4> | |
| 4892 <b>getCompleter</b>(<i></i>) | |
| 4893 | |
| 4894 <p> | |
| 4895 Public method to retrieve a reference to the completer object. | |
| 4896 </p> | |
| 4897 <dl> | |
| 4898 <dt>Return:</dt> | |
| 4899 <dd> | |
| 4900 the completer object (CompleterBase) | |
| 4901 </dd> | |
| 4902 </dl> | |
| 4903 <a NAME="Editor.getCompletionListHook" ID="Editor.getCompletionListHook"></a> | |
| 4904 <h4>Editor.getCompletionListHook</h4> | |
| 4905 <b>getCompletionListHook</b>(<i>key</i>) | |
| 4906 | |
| 4907 <p> | |
| 4908 Public method to get the registered completion list provider. | |
| 4909 </p> | |
| 4910 <dl> | |
| 4911 | |
| 4912 <dt><i>key</i> (str)</dt> | |
| 4913 <dd> | |
| 4914 name of the provider | |
| 4915 </dd> | |
| 4916 </dl> | |
| 4917 <dl> | |
| 4918 <dt>Return:</dt> | |
| 4919 <dd> | |
| 4920 function providing completion list | |
| 4921 </dd> | |
| 4922 </dl> | |
| 4923 <dl> | |
| 4924 <dt>Return Type:</dt> | |
| 4925 <dd> | |
| 4926 function or None | |
| 4927 </dd> | |
| 4928 </dl> | |
| 4929 <a NAME="Editor.getCoverageLines" ID="Editor.getCoverageLines"></a> | |
| 4930 <h4>Editor.getCoverageLines</h4> | |
| 4931 <b>getCoverageLines</b>(<i></i>) | |
| 4932 | |
| 4933 <p> | |
| 4934 Public method to get the lines containing a coverage marker. | |
| 4935 </p> | |
| 4936 <dl> | |
| 4937 <dt>Return:</dt> | |
| 4938 <dd> | |
| 4939 list of lines containing a coverage marker (list of integer) | |
| 4940 </dd> | |
| 4941 </dl> | |
| 4942 <a NAME="Editor.getCurrentWord" ID="Editor.getCurrentWord"></a> | |
| 4943 <h4>Editor.getCurrentWord</h4> | |
| 4944 <b>getCurrentWord</b>(<i></i>) | |
| 4945 | |
| 4946 <p> | |
| 4947 Public method to get the word at the current position. | |
| 4948 </p> | |
| 4949 <dl> | |
| 4950 <dt>Return:</dt> | |
| 4951 <dd> | |
| 4952 the word at that current position (string) | |
| 4953 </dd> | |
| 4954 </dl> | |
| 4955 <a NAME="Editor.getCurrentWordBoundaries" ID="Editor.getCurrentWordBoundaries"></a> | |
| 4956 <h4>Editor.getCurrentWordBoundaries</h4> | |
| 4957 <b>getCurrentWordBoundaries</b>(<i></i>) | |
| 4958 | |
| 4959 <p> | |
| 4960 Public method to get the word boundaries at the current position. | |
| 4961 </p> | |
| 4962 <dl> | |
| 4963 <dt>Return:</dt> | |
| 4964 <dd> | |
| 4965 tuple with start and end indexes of the current word | |
| 4966 (integer, integer) | |
| 4967 </dd> | |
| 4968 </dl> | |
| 4969 <a NAME="Editor.getDocstringGenerator" ID="Editor.getDocstringGenerator"></a> | |
| 4970 <h4>Editor.getDocstringGenerator</h4> | |
| 4971 <b>getDocstringGenerator</b>(<i></i>) | |
| 4972 | |
| 4973 <p> | |
| 4974 Public method to get a reference to the docstring generator. | |
| 4975 </p> | |
| 4976 <dl> | |
| 4977 <dt>Return:</dt> | |
| 4978 <dd> | |
| 4979 reference to the docstring generator | |
| 4980 </dd> | |
| 4981 </dl> | |
| 4982 <dl> | |
| 4983 <dt>Return Type:</dt> | |
| 4984 <dd> | |
| 4985 BaseDocstringGenerator | |
| 4986 </dd> | |
| 4987 </dl> | |
| 4988 <a NAME="Editor.getEditorConfig" ID="Editor.getEditorConfig"></a> | |
| 4989 <h4>Editor.getEditorConfig</h4> | |
| 4990 <b>getEditorConfig</b>(<i>option</i>) | |
| 4991 | |
| 4992 <p> | |
| 4993 Public method to get the requested option via EditorConfig. | |
| 4994 </p> | |
| 4995 <dl> | |
| 4996 | |
| 4997 <dt><i>option</i> (str)</dt> | |
| 4998 <dd> | |
| 4999 Preferences option key | |
| 5000 </dd> | |
| 5001 </dl> | |
| 5002 <dl> | |
| 5003 <dt>Return:</dt> | |
| 5004 <dd> | |
| 5005 value of requested setting | |
| 5006 </dd> | |
| 5007 </dl> | |
| 5008 <dl> | |
| 5009 <dt>Return Type:</dt> | |
| 5010 <dd> | |
| 5011 any | |
| 5012 </dd> | |
| 5013 </dl> | |
| 5014 <a NAME="Editor.getEncoding" ID="Editor.getEncoding"></a> | |
| 5015 <h4>Editor.getEncoding</h4> | |
| 5016 <b>getEncoding</b>(<i></i>) | |
| 5017 | |
| 5018 <p> | |
| 5019 Public method to return the current encoding. | |
| 5020 </p> | |
| 5021 <dl> | |
| 5022 <dt>Return:</dt> | |
| 5023 <dd> | |
| 5024 current encoding (string) | |
| 5025 </dd> | |
| 5026 </dl> | |
| 5027 <a NAME="Editor.getFileName" ID="Editor.getFileName"></a> | |
| 5028 <h4>Editor.getFileName</h4> | |
| 5029 <b>getFileName</b>(<i></i>) | |
| 5030 | |
| 5031 <p> | |
| 5032 Public method to return the name of the file being displayed. | |
| 5033 </p> | |
| 5034 <dl> | |
| 5035 <dt>Return:</dt> | |
| 5036 <dd> | |
| 5037 filename of the displayed file (string) | |
| 5038 </dd> | |
| 5039 </dl> | |
| 5040 <a NAME="Editor.getFileType" ID="Editor.getFileType"></a> | |
| 5041 <h4>Editor.getFileType</h4> | |
| 5042 <b>getFileType</b>(<i></i>) | |
| 5043 | |
| 5044 <p> | |
| 5045 Public method to return the type of the file being displayed. | |
| 5046 </p> | |
| 5047 <dl> | |
| 5048 <dt>Return:</dt> | |
| 5049 <dd> | |
| 5050 type of the displayed file (string) | |
| 5051 </dd> | |
| 5052 </dl> | |
| 5053 <a NAME="Editor.getFileTypeByFlag" ID="Editor.getFileTypeByFlag"></a> | |
| 5054 <h4>Editor.getFileTypeByFlag</h4> | |
| 5055 <b>getFileTypeByFlag</b>(<i></i>) | |
| 5056 | |
| 5057 <p> | |
| 5058 Public method to return the type of the file, if it was set by an | |
| 5059 eflag: marker. | |
| 5060 </p> | |
| 5061 <dl> | |
| 5062 <dt>Return:</dt> | |
| 5063 <dd> | |
| 5064 type of the displayed file, if set by an eflag: marker or an | |
| 5065 empty string (string) | |
| 5066 </dd> | |
| 5067 </dl> | |
| 5068 <a NAME="Editor.getHighlightPosition" ID="Editor.getHighlightPosition"></a> | |
| 5069 <h4>Editor.getHighlightPosition</h4> | |
| 5070 <b>getHighlightPosition</b>(<i></i>) | |
| 5071 | |
| 5072 <p> | |
| 5073 Public method to return the position of the highlight bar. | |
| 5074 </p> | |
| 5075 <dl> | |
| 5076 <dt>Return:</dt> | |
| 5077 <dd> | |
| 5078 line number of the highlight bar (integer) | |
| 5079 </dd> | |
| 5080 </dl> | |
| 5081 <a NAME="Editor.getLanguage" ID="Editor.getLanguage"></a> | |
| 5082 <h4>Editor.getLanguage</h4> | |
| 5083 <b>getLanguage</b>(<i>normalized=True, forPygments=False</i>) | |
| 5084 | |
| 5085 <p> | |
| 5086 Public method to retrieve the language of the editor. | |
| 5087 </p> | |
| 5088 <dl> | |
| 5089 | |
| 5090 <dt><i>normalized</i></dt> | |
| 5091 <dd> | |
| 5092 flag indicating to normalize some Pygments | |
| 5093 lexer names (boolean) | |
| 5094 </dd> | |
| 5095 <dt><i>forPygments</i></dt> | |
| 5096 <dd> | |
| 5097 flag indicating to normalize some lexer | |
| 5098 names for Pygments (boolean) | |
| 5099 </dd> | |
| 5100 </dl> | |
| 5101 <dl> | |
| 5102 <dt>Return:</dt> | |
| 5103 <dd> | |
| 5104 language of the editor (string) | |
| 5105 </dd> | |
| 5106 </dl> | |
| 5107 <a NAME="Editor.getLexer" ID="Editor.getLexer"></a> | |
| 5108 <h4>Editor.getLexer</h4> | |
| 5109 <b>getLexer</b>(<i></i>) | |
| 5110 | |
| 5111 <p> | |
| 5112 Public method to retrieve a reference to the lexer object. | |
| 5113 </p> | |
| 5114 <dl> | |
| 5115 <dt>Return:</dt> | |
| 5116 <dd> | |
| 5117 the lexer object (Lexer) | |
| 5118 </dd> | |
| 5119 </dl> | |
| 5120 <a NAME="Editor.getMenu" ID="Editor.getMenu"></a> | |
| 5121 <h4>Editor.getMenu</h4> | |
| 5122 <b>getMenu</b>(<i>menuName</i>) | |
| 5123 | |
| 5124 <p> | |
| 5125 Public method to get a reference to the main context menu or a submenu. | |
| 5126 </p> | |
| 5127 <dl> | |
| 5128 | |
| 5129 <dt><i>menuName</i></dt> | |
| 5130 <dd> | |
| 5131 name of the menu (string) | |
| 5132 </dd> | |
| 5133 </dl> | |
| 5134 <dl> | |
| 5135 <dt>Return:</dt> | |
| 5136 <dd> | |
| 5137 reference to the requested menu (QMenu) or None | |
| 5138 </dd> | |
| 5139 </dl> | |
| 5140 <a NAME="Editor.getMouseClickHandler" ID="Editor.getMouseClickHandler"></a> | |
| 5141 <h4>Editor.getMouseClickHandler</h4> | |
| 5142 <b>getMouseClickHandler</b>(<i>modifiers, button</i>) | |
| 5143 | |
| 5144 <p> | |
| 5145 Public method to get a registered mouse click handler. | |
| 5146 </p> | |
| 5147 <dl> | |
| 5148 | |
| 5149 <dt><i>modifiers</i> (Qt.KeyboardModifiers)</dt> | |
| 5150 <dd> | |
| 5151 keyboard modifiers of the handler | |
| 5152 </dd> | |
| 5153 <dt><i>button</i> (Qt.MouseButton)</dt> | |
| 5154 <dd> | |
| 5155 mouse button of the handler | |
| 5156 </dd> | |
| 5157 </dl> | |
| 5158 <dl> | |
| 5159 <dt>Return:</dt> | |
| 5160 <dd> | |
| 5161 plug-in name and registered function | |
| 5162 </dd> | |
| 5163 </dl> | |
| 5164 <dl> | |
| 5165 <dt>Return Type:</dt> | |
| 5166 <dd> | |
| 5167 tuple of str and func | |
| 5168 </dd> | |
| 5169 </dl> | |
| 5170 <a NAME="Editor.getMouseClickHandlers" ID="Editor.getMouseClickHandlers"></a> | |
| 5171 <h4>Editor.getMouseClickHandlers</h4> | |
| 5172 <b>getMouseClickHandlers</b>(<i>name</i>) | |
| 5173 | |
| 5174 <p> | |
| 5175 Public method to get all registered mouse click handlers of | |
| 5176 a plug-in. | |
| 5177 </p> | |
| 5178 <dl> | |
| 5179 | |
| 5180 <dt><i>name</i> (str)</dt> | |
| 5181 <dd> | |
| 5182 name of the plug-in | |
| 5183 </dd> | |
| 5184 </dl> | |
| 5185 <dl> | |
| 5186 <dt>Return:</dt> | |
| 5187 <dd> | |
| 5188 registered mouse click handlers as list of modifiers, | |
| 5189 mouse button and function | |
| 5190 </dd> | |
| 5191 </dl> | |
| 5192 <dl> | |
| 5193 <dt>Return Type:</dt> | |
| 5194 <dd> | |
| 5195 list of tuple of (Qt.KeyboardModifiers, Qt.MouseButton, func) | |
| 5196 </dd> | |
| 5197 </dl> | |
| 5198 <a NAME="Editor.getNoName" ID="Editor.getNoName"></a> | |
| 5199 <h4>Editor.getNoName</h4> | |
| 5200 <b>getNoName</b>(<i></i>) | |
| 5201 | |
| 5202 <p> | |
| 5203 Public method to get the display string for an unnamed editor. | |
| 5204 </p> | |
| 5205 <dl> | |
| 5206 <dt>Return:</dt> | |
| 5207 <dd> | |
| 5208 display string for this unnamed editor (string) | |
| 5209 </dd> | |
| 5210 </dl> | |
| 5211 <a NAME="Editor.getSearchIndicatorLines" ID="Editor.getSearchIndicatorLines"></a> | |
| 5212 <h4>Editor.getSearchIndicatorLines</h4> | |
| 5213 <b>getSearchIndicatorLines</b>(<i></i>) | |
| 5214 | |
| 5215 <p> | |
| 5216 Public method to get the lines containing a search indicator. | |
| 5217 </p> | |
| 5218 <dl> | |
| 5219 <dt>Return:</dt> | |
| 5220 <dd> | |
| 5221 list of lines containing a search indicator (list of integer) | |
| 5222 </dd> | |
| 5223 </dl> | |
| 5224 <a NAME="Editor.getSearchText" ID="Editor.getSearchText"></a> | |
| 5225 <h4>Editor.getSearchText</h4> | |
| 5226 <b>getSearchText</b>(<i>selectionOnly=False</i>) | |
| 5227 | |
| 5228 <p> | |
| 5229 Public method to determine the selection or the current word for the | |
| 5230 next search operation. | |
| 5231 </p> | |
| 5232 <dl> | |
| 5233 | |
| 5234 <dt><i>selectionOnly</i></dt> | |
| 5235 <dd> | |
| 5236 flag indicating that only selected text should be | |
| 5237 returned (boolean) | |
| 5238 </dd> | |
| 5239 </dl> | |
| 5240 <dl> | |
| 5241 <dt>Return:</dt> | |
| 5242 <dd> | |
| 5243 selection or current word (string) | |
| 5244 </dd> | |
| 5245 </dl> | |
| 5246 <a NAME="Editor.getSharingStatus" ID="Editor.getSharingStatus"></a> | |
| 5247 <h4>Editor.getSharingStatus</h4> | |
| 5248 <b>getSharingStatus</b>(<i></i>) | |
| 5249 | |
| 5250 <p> | |
| 5251 Public method to get some share status info. | |
| 5252 </p> | |
| 5253 <dl> | |
| 5254 <dt>Return:</dt> | |
| 5255 <dd> | |
| 5256 tuple indicating, if the editor is sharable, the sharing | |
| 5257 status, if it is inside a locally initiated shared edit session | |
| 5258 and if it is inside a remotely initiated shared edit session | |
| 5259 (boolean, boolean, boolean, boolean) | |
| 5260 </dd> | |
| 5261 </dl> | |
| 5262 <a NAME="Editor.getSpellingLanguage" ID="Editor.getSpellingLanguage"></a> | |
| 5263 <h4>Editor.getSpellingLanguage</h4> | |
| 5264 <b>getSpellingLanguage</b>(<i></i>) | |
| 5265 | |
| 5266 <p> | |
| 5267 Public method to get the current spelling language. | |
| 5268 </p> | |
| 5269 <dl> | |
| 5270 <dt>Return:</dt> | |
| 5271 <dd> | |
| 5272 current spelling language | |
| 5273 </dd> | |
| 5274 </dl> | |
| 5275 <dl> | |
| 5276 <dt>Return Type:</dt> | |
| 5277 <dd> | |
| 5278 str | |
| 5279 </dd> | |
| 5280 </dl> | |
| 5281 <a NAME="Editor.getSyntaxErrorLines" ID="Editor.getSyntaxErrorLines"></a> | |
| 5282 <h4>Editor.getSyntaxErrorLines</h4> | |
| 5283 <b>getSyntaxErrorLines</b>(<i></i>) | |
| 5284 | |
| 5285 <p> | |
| 5286 Public method to get the lines containing a syntax error. | |
| 5287 </p> | |
| 5288 <dl> | |
| 5289 <dt>Return:</dt> | |
| 5290 <dd> | |
| 5291 list of lines containing a syntax error (list of integer) | |
| 5292 </dd> | |
| 5293 </dl> | |
| 5294 <a NAME="Editor.getSyntaxErrors" ID="Editor.getSyntaxErrors"></a> | |
| 5295 <h4>Editor.getSyntaxErrors</h4> | |
| 5296 <b>getSyntaxErrors</b>(<i></i>) | |
| 5297 | |
| 5298 <p> | |
| 5299 Public method to retrieve the syntax error markers. | |
| 5300 </p> | |
| 5301 <dl> | |
| 5302 <dt>Return:</dt> | |
| 5303 <dd> | |
| 5304 sorted list of all lines containing a syntax error | |
| 5305 (list of integer) | |
| 5306 </dd> | |
| 5307 </dl> | |
| 5308 <a NAME="Editor.getTaskLines" ID="Editor.getTaskLines"></a> | |
| 5309 <h4>Editor.getTaskLines</h4> | |
| 5310 <b>getTaskLines</b>(<i></i>) | |
| 5311 | |
| 5312 <p> | |
| 5313 Public method to get the lines containing a task. | |
| 5314 </p> | |
| 5315 <dl> | |
| 5316 <dt>Return:</dt> | |
| 5317 <dd> | |
| 5318 list of lines containing a task (list of integer) | |
| 5319 </dd> | |
| 5320 </dl> | |
| 5321 <a NAME="Editor.getVcsConflictMarkerLines" ID="Editor.getVcsConflictMarkerLines"></a> | |
| 5322 <h4>Editor.getVcsConflictMarkerLines</h4> | |
| 5323 <b>getVcsConflictMarkerLines</b>(<i></i>) | |
| 5324 | |
| 5325 <p> | |
| 5326 Public method to determine the lines containing a VCS conflict marker. | |
| 5327 </p> | |
| 5328 <dl> | |
| 5329 <dt>Return:</dt> | |
| 5330 <dd> | |
| 5331 list of line numbers containg a VCS conflict marker | |
| 5332 </dd> | |
| 5333 </dl> | |
| 5334 <dl> | |
| 5335 <dt>Return Type:</dt> | |
| 5336 <dd> | |
| 5337 list of int | |
| 5338 </dd> | |
| 5339 </dl> | |
| 5340 <a NAME="Editor.getWarningLines" ID="Editor.getWarningLines"></a> | |
| 5341 <h4>Editor.getWarningLines</h4> | |
| 5342 <b>getWarningLines</b>(<i></i>) | |
| 5343 | |
| 5344 <p> | |
| 5345 Public method to get the lines containing a warning. | |
| 5346 </p> | |
| 5347 <dl> | |
| 5348 <dt>Return:</dt> | |
| 5349 <dd> | |
| 5350 list of lines containing a warning (list of integer) | |
| 5351 </dd> | |
| 5352 </dl> | |
| 5353 <a NAME="Editor.getWarnings" ID="Editor.getWarnings"></a> | |
| 5354 <h4>Editor.getWarnings</h4> | |
| 5355 <b>getWarnings</b>(<i></i>) | |
| 5356 | |
| 5357 <p> | |
| 5358 Public method to retrieve the warning markers. | |
| 5359 </p> | |
| 5360 <dl> | |
| 5361 <dt>Return:</dt> | |
| 5362 <dd> | |
| 5363 sorted list of all lines containing a warning | |
| 5364 (list of integer) | |
| 5365 </dd> | |
| 5366 </dl> | |
| 5367 <a NAME="Editor.getWord" ID="Editor.getWord"></a> | |
| 5368 <h4>Editor.getWord</h4> | |
| 5369 <b>getWord</b>(<i>line, index, direction=0, useWordChars=True</i>) | |
| 5370 | |
| 5371 <p> | |
| 5372 Public method to get the word at a position. | |
| 5373 </p> | |
| 5374 <dl> | |
| 5375 | |
| 5376 <dt><i>line</i></dt> | |
| 5377 <dd> | |
| 5378 number of line to look at (int) | |
| 5379 </dd> | |
| 5380 <dt><i>index</i></dt> | |
| 5381 <dd> | |
| 5382 position to look at (int) | |
| 5383 </dd> | |
| 5384 <dt><i>direction</i></dt> | |
| 5385 <dd> | |
| 5386 direction to look in (0 = whole word, 1 = left, | |
| 5387 2 = right) | |
| 5388 </dd> | |
| 5389 <dt><i>useWordChars</i></dt> | |
| 5390 <dd> | |
| 5391 flag indicating to use the wordCharacters | |
| 5392 method (boolean) | |
| 5393 </dd> | |
| 5394 </dl> | |
| 5395 <dl> | |
| 5396 <dt>Return:</dt> | |
| 5397 <dd> | |
| 5398 the word at that position (string) | |
| 5399 </dd> | |
| 5400 </dl> | |
| 5401 <a NAME="Editor.getWordBoundaries" ID="Editor.getWordBoundaries"></a> | |
| 5402 <h4>Editor.getWordBoundaries</h4> | |
| 5403 <b>getWordBoundaries</b>(<i>line, index, useWordChars=True</i>) | |
| 5404 | |
| 5405 <p> | |
| 5406 Public method to get the word boundaries at a position. | |
| 5407 </p> | |
| 5408 <dl> | |
| 5409 | |
| 5410 <dt><i>line</i></dt> | |
| 5411 <dd> | |
| 5412 number of line to look at (int) | |
| 5413 </dd> | |
| 5414 <dt><i>index</i></dt> | |
| 5415 <dd> | |
| 5416 position to look at (int) | |
| 5417 </dd> | |
| 5418 <dt><i>useWordChars</i></dt> | |
| 5419 <dd> | |
| 5420 flag indicating to use the wordCharacters | |
| 5421 method (boolean) | |
| 5422 </dd> | |
| 5423 </dl> | |
| 5424 <dl> | |
| 5425 <dt>Return:</dt> | |
| 5426 <dd> | |
| 5427 tuple with start and end indexes of the word at the position | |
| 5428 (integer, integer) | |
| 5429 </dd> | |
| 5430 </dl> | |
| 5431 <a NAME="Editor.getWordLeft" ID="Editor.getWordLeft"></a> | |
| 5432 <h4>Editor.getWordLeft</h4> | |
| 5433 <b>getWordLeft</b>(<i>line, index</i>) | |
| 5434 | |
| 5435 <p> | |
| 5436 Public method to get the word to the left of a position. | |
| 5437 </p> | |
| 5438 <dl> | |
| 5439 | |
| 5440 <dt><i>line</i></dt> | |
| 5441 <dd> | |
| 5442 number of line to look at (int) | |
| 5443 </dd> | |
| 5444 <dt><i>index</i></dt> | |
| 5445 <dd> | |
| 5446 position to look at (int) | |
| 5447 </dd> | |
| 5448 </dl> | |
| 5449 <dl> | |
| 5450 <dt>Return:</dt> | |
| 5451 <dd> | |
| 5452 the word to the left of that position (string) | |
| 5453 </dd> | |
| 5454 </dl> | |
| 5455 <a NAME="Editor.getWordRight" ID="Editor.getWordRight"></a> | |
| 5456 <h4>Editor.getWordRight</h4> | |
| 5457 <b>getWordRight</b>(<i>line, index</i>) | |
| 5458 | |
| 5459 <p> | |
| 5460 Public method to get the word to the right of a position. | |
| 5461 </p> | |
| 5462 <dl> | |
| 5463 | |
| 5464 <dt><i>line</i></dt> | |
| 5465 <dd> | |
| 5466 number of line to look at (int) | |
| 5467 </dd> | |
| 5468 <dt><i>index</i></dt> | |
| 5469 <dd> | |
| 5470 position to look at (int) | |
| 5471 </dd> | |
| 5472 </dl> | |
| 5473 <dl> | |
| 5474 <dt>Return:</dt> | |
| 5475 <dd> | |
| 5476 the word to the right of that position (string) | |
| 5477 </dd> | |
| 5478 </dl> | |
| 5479 <a NAME="Editor.gotoLastEditPosition" ID="Editor.gotoLastEditPosition"></a> | |
| 5480 <h4>Editor.gotoLastEditPosition</h4> | |
| 5481 <b>gotoLastEditPosition</b>(<i></i>) | |
| 5482 | |
| 5483 <p> | |
| 5484 Public method to move the cursor to the last edit position. | |
| 5485 </p> | |
| 5486 <a NAME="Editor.gotoLine" ID="Editor.gotoLine"></a> | |
| 5487 <h4>Editor.gotoLine</h4> | |
| 5488 <b>gotoLine</b>(<i>line, pos=1, firstVisible=False, expand=False</i>) | |
| 5489 | |
| 5490 <p> | |
| 5491 Public slot to jump to the beginning of a line. | |
| 5492 </p> | |
| 5493 <dl> | |
| 5494 | |
| 5495 <dt><i>line</i> (int)</dt> | |
| 5496 <dd> | |
| 5497 line number to go to | |
| 5498 </dd> | |
| 5499 <dt><i>pos</i> (int)</dt> | |
| 5500 <dd> | |
| 5501 position in line to go to | |
| 5502 </dd> | |
| 5503 <dt><i>firstVisible</i> (bool)</dt> | |
| 5504 <dd> | |
| 5505 flag indicating to make the line the first | |
| 5506 visible line | |
| 5507 </dd> | |
| 5508 <dt><i>expand</i> (bool)</dt> | |
| 5509 <dd> | |
| 5510 flag indicating to expand all folds | |
| 5511 </dd> | |
| 5512 </dl> | |
| 5513 <a NAME="Editor.gotoMethodClass" ID="Editor.gotoMethodClass"></a> | |
| 5514 <h4>Editor.gotoMethodClass</h4> | |
| 5515 <b>gotoMethodClass</b>(<i>goUp=False</i>) | |
| 5516 | |
| 5517 <p> | |
| 5518 Public method to go to the next Python method or class definition. | |
| 5519 </p> | |
| 5520 <dl> | |
| 5521 | |
| 5522 <dt><i>goUp</i></dt> | |
| 5523 <dd> | |
| 5524 flag indicating the move direction (boolean) | |
| 5525 </dd> | |
| 5526 </dl> | |
| 5527 <a NAME="Editor.gotoReferenceHandler" ID="Editor.gotoReferenceHandler"></a> | |
| 5528 <h4>Editor.gotoReferenceHandler</h4> | |
| 5529 <b>gotoReferenceHandler</b>(<i>referencesList</i>) | |
| 5530 | |
| 5531 <p> | |
| 5532 Public method to handle a list of references to perform a goto. | |
| 5533 </p> | |
| 5534 <dl> | |
| 5535 | |
| 5536 <dt><i>referencesList</i> (ReferenceItem)</dt> | |
| 5537 <dd> | |
| 5538 list of references for a 'goto' action | |
| 5539 </dd> | |
| 5540 </dl> | |
| 5541 <a NAME="Editor.gotoSyntaxError" ID="Editor.gotoSyntaxError"></a> | |
| 5542 <h4>Editor.gotoSyntaxError</h4> | |
| 5543 <b>gotoSyntaxError</b>(<i></i>) | |
| 5544 | |
| 5545 <p> | |
| 5546 Public slot to handle the 'Goto syntax error' context menu action. | |
| 5547 </p> | |
| 5548 <a NAME="Editor.handleMonospacedEnable" ID="Editor.handleMonospacedEnable"></a> | |
| 5549 <h4>Editor.handleMonospacedEnable</h4> | |
| 5550 <b>handleMonospacedEnable</b>(<i></i>) | |
| 5551 | |
| 5552 <p> | |
| 5553 Public slot to handle the Use Monospaced Font context menu entry. | |
| 5554 </p> | |
| 5555 <a NAME="Editor.handleRenamed" ID="Editor.handleRenamed"></a> | |
| 5556 <h4>Editor.handleRenamed</h4> | |
| 5557 <b>handleRenamed</b>(<i>fn</i>) | |
| 5558 | |
| 5559 <p> | |
| 5560 Public slot to handle the editorRenamed signal. | |
| 5561 </p> | |
| 5562 <dl> | |
| 5563 | |
| 5564 <dt><i>fn</i></dt> | |
| 5565 <dd> | |
| 5566 filename to be set for the editor (string). | |
| 5567 </dd> | |
| 5568 </dl> | |
| 5569 <a NAME="Editor.hasBookmarks" ID="Editor.hasBookmarks"></a> | |
| 5570 <h4>Editor.hasBookmarks</h4> | |
| 5571 <b>hasBookmarks</b>(<i></i>) | |
| 5572 | |
| 5573 <p> | |
| 5574 Public method to check for the presence of bookmarks. | |
| 5575 </p> | |
| 5576 <dl> | |
| 5577 <dt>Return:</dt> | |
| 5578 <dd> | |
| 5579 flag indicating the presence of bookmarks (boolean) | |
| 5580 </dd> | |
| 5581 </dl> | |
| 5582 <a NAME="Editor.hasBreakpoints" ID="Editor.hasBreakpoints"></a> | |
| 5583 <h4>Editor.hasBreakpoints</h4> | |
| 5584 <b>hasBreakpoints</b>(<i></i>) | |
| 5585 | |
| 5586 <p> | |
| 5587 Public method to check for the presence of breakpoints. | |
| 5588 </p> | |
| 5589 <dl> | |
| 5590 <dt>Return:</dt> | |
| 5591 <dd> | |
| 5592 flag indicating the presence of breakpoints (boolean) | |
| 5593 </dd> | |
| 5594 </dl> | |
| 5595 <a NAME="Editor.hasChangeMarkers" ID="Editor.hasChangeMarkers"></a> | |
| 5596 <h4>Editor.hasChangeMarkers</h4> | |
| 5597 <b>hasChangeMarkers</b>(<i></i>) | |
| 5598 | |
| 5599 <p> | |
| 5600 Public method to determine, if this editor contains any change markers. | |
| 5601 </p> | |
| 5602 <dl> | |
| 5603 <dt>Return:</dt> | |
| 5604 <dd> | |
| 5605 flag indicating the presence of change markers (boolean) | |
| 5606 </dd> | |
| 5607 </dl> | |
| 5608 <a NAME="Editor.hasCoverageMarkers" ID="Editor.hasCoverageMarkers"></a> | |
| 5609 <h4>Editor.hasCoverageMarkers</h4> | |
| 5610 <b>hasCoverageMarkers</b>(<i></i>) | |
| 5611 | |
| 5612 <p> | |
| 5613 Public method to test, if there are coverage markers. | |
| 5614 </p> | |
| 5615 <dl> | |
| 5616 <dt>Return:</dt> | |
| 5617 <dd> | |
| 5618 flag indicating the presence of coverage markers (boolean) | |
| 5619 </dd> | |
| 5620 </dl> | |
| 5621 <a NAME="Editor.hasMiniMenu" ID="Editor.hasMiniMenu"></a> | |
| 5622 <h4>Editor.hasMiniMenu</h4> | |
| 5623 <b>hasMiniMenu</b>(<i></i>) | |
| 5624 | |
| 5625 <p> | |
| 5626 Public method to check the miniMenu flag. | |
| 5627 </p> | |
| 5628 <dl> | |
| 5629 <dt>Return:</dt> | |
| 5630 <dd> | |
| 5631 flag indicating a minimized context menu (boolean) | |
| 5632 </dd> | |
| 5633 </dl> | |
| 5634 <a NAME="Editor.hasSyntaxErrors" ID="Editor.hasSyntaxErrors"></a> | |
| 5635 <h4>Editor.hasSyntaxErrors</h4> | |
| 5636 <b>hasSyntaxErrors</b>(<i></i>) | |
| 5637 | |
| 5638 <p> | |
| 5639 Public method to check for the presence of syntax errors. | |
| 5640 </p> | |
| 5641 <dl> | |
| 5642 <dt>Return:</dt> | |
| 5643 <dd> | |
| 5644 flag indicating the presence of syntax errors (boolean) | |
| 5645 </dd> | |
| 5646 </dl> | |
| 5647 <a NAME="Editor.hasTaskMarkers" ID="Editor.hasTaskMarkers"></a> | |
| 5648 <h4>Editor.hasTaskMarkers</h4> | |
| 5649 <b>hasTaskMarkers</b>(<i></i>) | |
| 5650 | |
| 5651 <p> | |
| 5652 Public method to determine, if this editor contains any task markers. | |
| 5653 </p> | |
| 5654 <dl> | |
| 5655 <dt>Return:</dt> | |
| 5656 <dd> | |
| 5657 flag indicating the presence of task markers (boolean) | |
| 5658 </dd> | |
| 5659 </dl> | |
| 5660 <a NAME="Editor.hasWarnings" ID="Editor.hasWarnings"></a> | |
| 5661 <h4>Editor.hasWarnings</h4> | |
| 5662 <b>hasWarnings</b>(<i></i>) | |
| 5663 | |
| 5664 <p> | |
| 5665 Public method to check for the presence of warnings. | |
| 5666 </p> | |
| 5667 <dl> | |
| 5668 <dt>Return:</dt> | |
| 5669 <dd> | |
| 5670 flag indicating the presence of warnings (boolean) | |
| 5671 </dd> | |
| 5672 </dl> | |
| 5673 <a NAME="Editor.highlight" ID="Editor.highlight"></a> | |
| 5674 <h4>Editor.highlight</h4> | |
| 5675 <b>highlight</b>(<i>line=None, error=False, syntaxError=False</i>) | |
| 5676 | |
| 5677 <p> | |
| 5678 Public method to highlight [or de-highlight] a particular line. | |
| 5679 </p> | |
| 5680 <dl> | |
| 5681 | |
| 5682 <dt><i>line</i></dt> | |
| 5683 <dd> | |
| 5684 line number to highlight (integer) | |
| 5685 </dd> | |
| 5686 <dt><i>error</i></dt> | |
| 5687 <dd> | |
| 5688 flag indicating whether the error highlight should be | |
| 5689 used (boolean) | |
| 5690 </dd> | |
| 5691 <dt><i>syntaxError</i></dt> | |
| 5692 <dd> | |
| 5693 flag indicating a syntax error (boolean) | |
| 5694 </dd> | |
| 5695 </dl> | |
| 5696 <a NAME="Editor.highlightVisible" ID="Editor.highlightVisible"></a> | |
| 5697 <h4>Editor.highlightVisible</h4> | |
| 5698 <b>highlightVisible</b>(<i></i>) | |
| 5699 | |
| 5700 <p> | |
| 5701 Public method to make sure that the highlight is visible. | |
| 5702 </p> | |
| 5703 <a NAME="Editor.indentLineOrSelection" ID="Editor.indentLineOrSelection"></a> | |
| 5704 <h4>Editor.indentLineOrSelection</h4> | |
| 5705 <b>indentLineOrSelection</b>(<i></i>) | |
| 5706 | |
| 5707 <p> | |
| 5708 Public slot to indent the current line or current selection. | |
| 5709 </p> | |
| 5710 <a NAME="Editor.insertDocstring" ID="Editor.insertDocstring"></a> | |
| 5711 <h4>Editor.insertDocstring</h4> | |
| 5712 <b>insertDocstring</b>(<i></i>) | |
| 5713 | |
| 5714 <p> | |
| 5715 Public method to generate and insert a docstring for the function under | |
| 5716 the cursor. | |
| 5717 </p> | |
| 5718 <p> | |
| 5719 Note: This method is called via a keyboard shortcut or through the | |
| 5720 global 'Edit' menu. | |
| 5721 </p> | |
| 5722 <a NAME="Editor.isClone" ID="Editor.isClone"></a> | |
| 5723 <h4>Editor.isClone</h4> | |
| 5724 <b>isClone</b>(<i>editor</i>) | |
| 5725 | |
| 5726 <p> | |
| 5727 Public method to test, if the given editor is a clone. | |
| 5728 </p> | |
| 5729 <dl> | |
| 5730 | |
| 5731 <dt><i>editor</i> (Editor)</dt> | |
| 5732 <dd> | |
| 5733 reference to the cloned editor | |
| 5734 </dd> | |
| 5735 </dl> | |
| 5736 <dl> | |
| 5737 <dt>Return:</dt> | |
| 5738 <dd> | |
| 5739 flag indicating a clone | |
| 5740 </dd> | |
| 5741 </dl> | |
| 5742 <dl> | |
| 5743 <dt>Return Type:</dt> | |
| 5744 <dd> | |
| 5745 bool | |
| 5746 </dd> | |
| 5747 </dl> | |
| 5748 <a NAME="Editor.isCythonFile" ID="Editor.isCythonFile"></a> | |
| 5749 <h4>Editor.isCythonFile</h4> | |
| 5750 <b>isCythonFile</b>(<i></i>) | |
| 5751 | |
| 5752 <p> | |
| 5753 Public method to return a flag indicating a Cython file. | |
| 5754 </p> | |
| 5755 <dl> | |
| 5756 <dt>Return:</dt> | |
| 5757 <dd> | |
| 5758 flag indicating a Cython file | |
| 5759 </dd> | |
| 5760 </dl> | |
| 5761 <dl> | |
| 5762 <dt>Return Type:</dt> | |
| 5763 <dd> | |
| 5764 bool | |
| 5765 </dd> | |
| 5766 </dl> | |
| 5767 <a NAME="Editor.isJavascriptFile" ID="Editor.isJavascriptFile"></a> | |
| 5768 <h4>Editor.isJavascriptFile</h4> | |
| 5769 <b>isJavascriptFile</b>(<i></i>) | |
| 5770 | |
| 5771 <p> | |
| 5772 Public method to return a flag indicating a Javascript file. | |
| 5773 </p> | |
| 5774 <dl> | |
| 5775 <dt>Return:</dt> | |
| 5776 <dd> | |
| 5777 flag indicating a Javascript file (boolean) | |
| 5778 </dd> | |
| 5779 </dl> | |
| 5780 <a NAME="Editor.isLastEditPositionAvailable" ID="Editor.isLastEditPositionAvailable"></a> | |
| 5781 <h4>Editor.isLastEditPositionAvailable</h4> | |
| 5782 <b>isLastEditPositionAvailable</b>(<i></i>) | |
| 5783 | |
| 5784 <p> | |
| 5785 Public method to check, if a last edit position is available. | |
| 5786 </p> | |
| 5787 <dl> | |
| 5788 <dt>Return:</dt> | |
| 5789 <dd> | |
| 5790 flag indicating availability (boolean) | |
| 5791 </dd> | |
| 5792 </dl> | |
| 5793 <a NAME="Editor.isMicroPythonFile" ID="Editor.isMicroPythonFile"></a> | |
| 5794 <h4>Editor.isMicroPythonFile</h4> | |
| 5795 <b>isMicroPythonFile</b>(<i></i>) | |
| 5796 | |
| 5797 <p> | |
| 5798 Public method to return a flag indicating a MicroPython file. | |
| 5799 </p> | |
| 5800 <dl> | |
| 5801 <dt>Return:</dt> | |
| 5802 <dd> | |
| 5803 flag indicating a MicroPython file | |
| 5804 </dd> | |
| 5805 </dl> | |
| 5806 <dl> | |
| 5807 <dt>Return Type:</dt> | |
| 5808 <dd> | |
| 5809 bool | |
| 5810 </dd> | |
| 5811 </dl> | |
| 5812 <a NAME="Editor.isPy3File" ID="Editor.isPy3File"></a> | |
| 5813 <h4>Editor.isPy3File</h4> | |
| 5814 <b>isPy3File</b>(<i></i>) | |
| 5815 | |
| 5816 <p> | |
| 5817 Public method to return a flag indicating a Python3 file. | |
| 5818 </p> | |
| 5819 <dl> | |
| 5820 <dt>Return:</dt> | |
| 5821 <dd> | |
| 5822 flag indicating a Python3 file (boolean) | |
| 5823 </dd> | |
| 5824 </dl> | |
| 5825 <a NAME="Editor.isPyFile" ID="Editor.isPyFile"></a> | |
| 5826 <h4>Editor.isPyFile</h4> | |
| 5827 <b>isPyFile</b>(<i></i>) | |
| 5828 | |
| 5829 <p> | |
| 5830 Public method to return a flag indicating a Python (2 or 3) file. | |
| 5831 </p> | |
| 5832 <dl> | |
| 5833 <dt>Return:</dt> | |
| 5834 <dd> | |
| 5835 flag indicating a Python3 file (boolean) | |
| 5836 </dd> | |
| 5837 </dl> | |
| 5838 <a NAME="Editor.isRubyFile" ID="Editor.isRubyFile"></a> | |
| 5839 <h4>Editor.isRubyFile</h4> | |
| 5840 <b>isRubyFile</b>(<i></i>) | |
| 5841 | |
| 5842 <p> | |
| 5843 Public method to return a flag indicating a Ruby file. | |
| 5844 </p> | |
| 5845 <dl> | |
| 5846 <dt>Return:</dt> | |
| 5847 <dd> | |
| 5848 flag indicating a Ruby file (boolean) | |
| 5849 </dd> | |
| 5850 </dl> | |
| 5851 <a NAME="Editor.isSpellCheckRegion" ID="Editor.isSpellCheckRegion"></a> | |
| 5852 <h4>Editor.isSpellCheckRegion</h4> | |
| 5853 <b>isSpellCheckRegion</b>(<i>pos</i>) | |
| 5854 | |
| 5855 <p> | |
| 5856 Public method to check, if the given position is within a region, that | |
| 5857 should be spell checked. | |
| 5858 </p> | |
| 5859 <p> | |
| 5860 For files with a configured full text file extension all regions will | |
| 5861 be regarded as to be checked. Depending on configuration, all unknown | |
| 5862 files (i.e. those without a file extension) will be checked fully as | |
| 5863 well. | |
| 5864 </p> | |
| 5865 <dl> | |
| 5866 | |
| 5867 <dt><i>pos</i> (int)</dt> | |
| 5868 <dd> | |
| 5869 position to be checked | |
| 5870 </dd> | |
| 5871 </dl> | |
| 5872 <dl> | |
| 5873 <dt>Return:</dt> | |
| 5874 <dd> | |
| 5875 flag indicating pos is in a spell check region | |
| 5876 </dd> | |
| 5877 </dl> | |
| 5878 <dl> | |
| 5879 <dt>Return Type:</dt> | |
| 5880 <dd> | |
| 5881 bool | |
| 5882 </dd> | |
| 5883 </dl> | |
| 5884 <a NAME="Editor.joinLines" ID="Editor.joinLines"></a> | |
| 5885 <h4>Editor.joinLines</h4> | |
| 5886 <b>joinLines</b>(<i></i>) | |
| 5887 | |
| 5888 <p> | |
| 5889 Public slot to join the current line with the next one. | |
| 5890 </p> | |
| 5891 <a NAME="Editor.keyPressEvent" ID="Editor.keyPressEvent"></a> | |
| 5892 <h4>Editor.keyPressEvent</h4> | |
| 5893 <b>keyPressEvent</b>(<i>ev</i>) | |
| 5894 | |
| 5895 <p> | |
| 5896 Protected method to handle the user input a key at a time. | |
| 5897 </p> | |
| 5898 <dl> | |
| 5899 | |
| 5900 <dt><i>ev</i> (QKeyEvent)</dt> | |
| 5901 <dd> | |
| 5902 key event | |
| 5903 </dd> | |
| 5904 </dl> | |
| 5905 <a NAME="Editor.macroDelete" ID="Editor.macroDelete"></a> | |
| 5906 <h4>Editor.macroDelete</h4> | |
| 5907 <b>macroDelete</b>(<i></i>) | |
| 5908 | |
| 5909 <p> | |
| 5910 Public method to delete a macro. | |
| 5911 </p> | |
| 5912 <a NAME="Editor.macroLoad" ID="Editor.macroLoad"></a> | |
| 5913 <h4>Editor.macroLoad</h4> | |
| 5914 <b>macroLoad</b>(<i></i>) | |
| 5915 | |
| 5916 <p> | |
| 5917 Public method to load a macro from a file. | |
| 5918 </p> | |
| 5919 <a NAME="Editor.macroRecordingStart" ID="Editor.macroRecordingStart"></a> | |
| 5920 <h4>Editor.macroRecordingStart</h4> | |
| 5921 <b>macroRecordingStart</b>(<i></i>) | |
| 5922 | |
| 5923 <p> | |
| 5924 Public method to start macro recording. | |
| 5925 </p> | |
| 5926 <a NAME="Editor.macroRecordingStop" ID="Editor.macroRecordingStop"></a> | |
| 5927 <h4>Editor.macroRecordingStop</h4> | |
| 5928 <b>macroRecordingStop</b>(<i></i>) | |
| 5929 | |
| 5930 <p> | |
| 5931 Public method to stop macro recording. | |
| 5932 </p> | |
| 5933 <a NAME="Editor.macroRun" ID="Editor.macroRun"></a> | |
| 5934 <h4>Editor.macroRun</h4> | |
| 5935 <b>macroRun</b>(<i></i>) | |
| 5936 | |
| 5937 <p> | |
| 5938 Public method to execute a macro. | |
| 5939 </p> | |
| 5940 <a NAME="Editor.macroSave" ID="Editor.macroSave"></a> | |
| 5941 <h4>Editor.macroSave</h4> | |
| 5942 <b>macroSave</b>(<i></i>) | |
| 5943 | |
| 5944 <p> | |
| 5945 Public method to save a macro to a file. | |
| 5946 </p> | |
| 5947 <a NAME="Editor.menuEditBreakpoint" ID="Editor.menuEditBreakpoint"></a> | |
| 5948 <h4>Editor.menuEditBreakpoint</h4> | |
| 5949 <b>menuEditBreakpoint</b>(<i>line=None</i>) | |
| 5950 | |
| 5951 <p> | |
| 5952 Public slot to handle the 'Edit breakpoint' context menu action. | |
| 5953 </p> | |
| 5954 <dl> | |
| 5955 | |
| 5956 <dt><i>line</i></dt> | |
| 5957 <dd> | |
| 5958 linenumber of the breakpoint to edit | |
| 5959 </dd> | |
| 5960 </dl> | |
| 5961 <a NAME="Editor.menuNextBreakpoint" ID="Editor.menuNextBreakpoint"></a> | |
| 5962 <h4>Editor.menuNextBreakpoint</h4> | |
| 5963 <b>menuNextBreakpoint</b>(<i></i>) | |
| 5964 | |
| 5965 <p> | |
| 5966 Public slot to handle the 'Next breakpoint' context menu action. | |
| 5967 </p> | |
| 5968 <a NAME="Editor.menuPreviousBreakpoint" ID="Editor.menuPreviousBreakpoint"></a> | |
| 5969 <h4>Editor.menuPreviousBreakpoint</h4> | |
| 5970 <b>menuPreviousBreakpoint</b>(<i></i>) | |
| 5971 | |
| 5972 <p> | |
| 5973 Public slot to handle the 'Previous breakpoint' context menu action. | |
| 5974 </p> | |
| 5975 <a NAME="Editor.menuToggleBookmark" ID="Editor.menuToggleBookmark"></a> | |
| 5976 <h4>Editor.menuToggleBookmark</h4> | |
| 5977 <b>menuToggleBookmark</b>(<i></i>) | |
| 5978 | |
| 5979 <p> | |
| 5980 Public slot to handle the 'Toggle bookmark' context menu action. | |
| 5981 </p> | |
| 5982 <a NAME="Editor.menuToggleBreakpoint" ID="Editor.menuToggleBreakpoint"></a> | |
| 5983 <h4>Editor.menuToggleBreakpoint</h4> | |
| 5984 <b>menuToggleBreakpoint</b>(<i></i>) | |
| 5985 | |
| 5986 <p> | |
| 5987 Public slot to handle the 'Toggle breakpoint' context menu action. | |
| 5988 </p> | |
| 5989 <a NAME="Editor.mouseDoubleClickEvent" ID="Editor.mouseDoubleClickEvent"></a> | |
| 5990 <h4>Editor.mouseDoubleClickEvent</h4> | |
| 5991 <b>mouseDoubleClickEvent</b>(<i>evt</i>) | |
| 5992 | |
| 5993 <p> | |
| 5994 Protected method to handle mouse double click events. | |
| 5995 </p> | |
| 5996 <dl> | |
| 5997 | |
| 5998 <dt><i>evt</i> (QMouseEvent)</dt> | |
| 5999 <dd> | |
| 6000 reference to the mouse event | |
| 6001 </dd> | |
| 6002 </dl> | |
| 6003 <a NAME="Editor.mousePressEvent" ID="Editor.mousePressEvent"></a> | |
| 6004 <h4>Editor.mousePressEvent</h4> | |
| 6005 <b>mousePressEvent</b>(<i>event</i>) | |
| 6006 | |
| 6007 <p> | |
| 6008 Protected method to handle the mouse press event. | |
| 6009 </p> | |
| 6010 <dl> | |
| 6011 | |
| 6012 <dt><i>event</i> (QMouseEvent)</dt> | |
| 6013 <dd> | |
| 6014 the mouse press event | |
| 6015 </dd> | |
| 6016 </dl> | |
| 6017 <a NAME="Editor.mouseReleaseEvent" ID="Editor.mouseReleaseEvent"></a> | |
| 6018 <h4>Editor.mouseReleaseEvent</h4> | |
| 6019 <b>mouseReleaseEvent</b>(<i>evt</i>) | |
| 6020 | |
| 6021 <p> | |
| 6022 Protected method calling a registered mouse click handler function. | |
| 6023 </p> | |
| 6024 <dl> | |
| 6025 | |
| 6026 <dt><i>evt</i> (QMouseEvent)</dt> | |
| 6027 <dd> | |
| 6028 event object | |
| 6029 </dd> | |
| 6030 </dl> | |
| 6031 <a NAME="Editor.newBreakpointWithProperties" ID="Editor.newBreakpointWithProperties"></a> | |
| 6032 <h4>Editor.newBreakpointWithProperties</h4> | |
| 6033 <b>newBreakpointWithProperties</b>(<i>line, properties</i>) | |
| 6034 | |
| 6035 <p> | |
| 6036 Public method to set a new breakpoint and its properties. | |
| 6037 </p> | |
| 6038 <dl> | |
| 6039 | |
| 6040 <dt><i>line</i></dt> | |
| 6041 <dd> | |
| 6042 line number of the breakpoint (integer) | |
| 6043 </dd> | |
| 6044 <dt><i>properties</i></dt> | |
| 6045 <dd> | |
| 6046 properties for the breakpoint (tuple) | |
| 6047 (condition, temporary flag, enabled flag, ignore count) | |
| 6048 </dd> | |
| 6049 </dl> | |
| 6050 <a NAME="Editor.nextBookmark" ID="Editor.nextBookmark"></a> | |
| 6051 <h4>Editor.nextBookmark</h4> | |
| 6052 <b>nextBookmark</b>(<i></i>) | |
| 6053 | |
| 6054 <p> | |
| 6055 Public slot to handle the 'Next bookmark' context menu action. | |
| 6056 </p> | |
| 6057 <a NAME="Editor.nextChange" ID="Editor.nextChange"></a> | |
| 6058 <h4>Editor.nextChange</h4> | |
| 6059 <b>nextChange</b>(<i></i>) | |
| 6060 | |
| 6061 <p> | |
| 6062 Public slot to handle the 'Next change' context menu action. | |
| 6063 </p> | |
| 6064 <a NAME="Editor.nextTask" ID="Editor.nextTask"></a> | |
| 6065 <h4>Editor.nextTask</h4> | |
| 6066 <b>nextTask</b>(<i></i>) | |
| 6067 | |
| 6068 <p> | |
| 6069 Public slot to handle the 'Next task' context menu action. | |
| 6070 </p> | |
| 6071 <a NAME="Editor.nextUncovered" ID="Editor.nextUncovered"></a> | |
| 6072 <h4>Editor.nextUncovered</h4> | |
| 6073 <b>nextUncovered</b>(<i></i>) | |
| 6074 | |
| 6075 <p> | |
| 6076 Public slot to handle the 'Next uncovered' context menu action. | |
| 6077 </p> | |
| 6078 <a NAME="Editor.nextWarning" ID="Editor.nextWarning"></a> | |
| 6079 <h4>Editor.nextWarning</h4> | |
| 6080 <b>nextWarning</b>(<i></i>) | |
| 6081 | |
| 6082 <p> | |
| 6083 Public slot to handle the 'Next warning' context menu action. | |
| 6084 </p> | |
| 6085 <a NAME="Editor.previousBookmark" ID="Editor.previousBookmark"></a> | |
| 6086 <h4>Editor.previousBookmark</h4> | |
| 6087 <b>previousBookmark</b>(<i></i>) | |
| 6088 | |
| 6089 <p> | |
| 6090 Public slot to handle the 'Previous bookmark' context menu action. | |
| 6091 </p> | |
| 6092 <a NAME="Editor.previousChange" ID="Editor.previousChange"></a> | |
| 6093 <h4>Editor.previousChange</h4> | |
| 6094 <b>previousChange</b>(<i></i>) | |
| 6095 | |
| 6096 <p> | |
| 6097 Public slot to handle the 'Previous change' context menu action. | |
| 6098 </p> | |
| 6099 <a NAME="Editor.previousTask" ID="Editor.previousTask"></a> | |
| 6100 <h4>Editor.previousTask</h4> | |
| 6101 <b>previousTask</b>(<i></i>) | |
| 6102 | |
| 6103 <p> | |
| 6104 Public slot to handle the 'Previous task' context menu action. | |
| 6105 </p> | |
| 6106 <a NAME="Editor.previousUncovered" ID="Editor.previousUncovered"></a> | |
| 6107 <h4>Editor.previousUncovered</h4> | |
| 6108 <b>previousUncovered</b>(<i></i>) | |
| 6109 | |
| 6110 <p> | |
| 6111 Public slot to handle the 'Previous uncovered' context menu action. | |
| 6112 </p> | |
| 6113 <a NAME="Editor.previousWarning" ID="Editor.previousWarning"></a> | |
| 6114 <h4>Editor.previousWarning</h4> | |
| 6115 <b>previousWarning</b>(<i></i>) | |
| 6116 | |
| 6117 <p> | |
| 6118 Public slot to handle the 'Previous warning' context menu action. | |
| 6119 </p> | |
| 6120 <a NAME="Editor.printFile" ID="Editor.printFile"></a> | |
| 6121 <h4>Editor.printFile</h4> | |
| 6122 <b>printFile</b>(<i></i>) | |
| 6123 | |
| 6124 <p> | |
| 6125 Public slot to print the text. | |
| 6126 </p> | |
| 6127 <a NAME="Editor.printPreviewFile" ID="Editor.printPreviewFile"></a> | |
| 6128 <h4>Editor.printPreviewFile</h4> | |
| 6129 <b>printPreviewFile</b>(<i></i>) | |
| 6130 | |
| 6131 <p> | |
| 6132 Public slot to show a print preview of the text. | |
| 6133 </p> | |
| 6134 <a NAME="Editor.projectClosed" ID="Editor.projectClosed"></a> | |
| 6135 <h4>Editor.projectClosed</h4> | |
| 6136 <b>projectClosed</b>(<i></i>) | |
| 6137 | |
| 6138 <p> | |
| 6139 Public slot to handle the closing of a project. | |
| 6140 </p> | |
| 6141 <a NAME="Editor.projectLexerAssociationsChanged" ID="Editor.projectLexerAssociationsChanged"></a> | |
| 6142 <h4>Editor.projectLexerAssociationsChanged</h4> | |
| 6143 <b>projectLexerAssociationsChanged</b>(<i></i>) | |
| 6144 | |
| 6145 <p> | |
| 6146 Public slot to handle changes of the project lexer associations. | |
| 6147 </p> | |
| 6148 <a NAME="Editor.projectOpened" ID="Editor.projectOpened"></a> | |
| 6149 <h4>Editor.projectOpened</h4> | |
| 6150 <b>projectOpened</b>(<i></i>) | |
| 6151 | |
| 6152 <p> | |
| 6153 Public slot to handle the opening of a project. | |
| 6154 </p> | |
| 6155 <a NAME="Editor.readFile" ID="Editor.readFile"></a> | |
| 6156 <h4>Editor.readFile</h4> | |
| 6157 <b>readFile</b>(<i>fn, createIt=False, encoding=""</i>) | |
| 6158 | |
| 6159 <p> | |
| 6160 Public slot to read the text from a file. | |
| 6161 </p> | |
| 6162 <dl> | |
| 6163 | |
| 6164 <dt><i>fn</i></dt> | |
| 6165 <dd> | |
| 6166 filename to read from (string) | |
| 6167 </dd> | |
| 6168 <dt><i>createIt</i></dt> | |
| 6169 <dd> | |
| 6170 flag indicating the creation of a new file, if the | |
| 6171 given one doesn't exist (boolean) | |
| 6172 </dd> | |
| 6173 <dt><i>encoding</i></dt> | |
| 6174 <dd> | |
| 6175 encoding to be used to read the file (string) | |
| 6176 (Note: this parameter overrides encoding detection) | |
| 6177 </dd> | |
| 6178 </dl> | |
| 6179 <a NAME="Editor.readSettings" ID="Editor.readSettings"></a> | |
| 6180 <h4>Editor.readSettings</h4> | |
| 6181 <b>readSettings</b>(<i></i>) | |
| 6182 | |
| 6183 <p> | |
| 6184 Public slot to read the settings into our lexer. | |
| 6185 </p> | |
| 6186 <a NAME="Editor.receive" ID="Editor.receive"></a> | |
| 6187 <h4>Editor.receive</h4> | |
| 6188 <b>receive</b>(<i>command</i>) | |
| 6189 | |
| 6190 <p> | |
| 6191 Public slot to handle received editor commands. | |
| 6192 </p> | |
| 6193 <dl> | |
| 6194 | |
| 6195 <dt><i>command</i></dt> | |
| 6196 <dd> | |
| 6197 command string (string) | |
| 6198 </dd> | |
| 6199 </dl> | |
| 6200 <a NAME="Editor.redo" ID="Editor.redo"></a> | |
| 6201 <h4>Editor.redo</h4> | |
| 6202 <b>redo</b>(<i></i>) | |
| 6203 | |
| 6204 <p> | |
| 6205 Public method to redo the last recorded change. | |
| 6206 </p> | |
| 6207 <a NAME="Editor.refresh" ID="Editor.refresh"></a> | |
| 6208 <h4>Editor.refresh</h4> | |
| 6209 <b>refresh</b>(<i></i>) | |
| 6210 | |
| 6211 <p> | |
| 6212 Public slot to refresh the editor contents. | |
| 6213 </p> | |
| 6214 <a NAME="Editor.refreshCoverageAnnotations" ID="Editor.refreshCoverageAnnotations"></a> | |
| 6215 <h4>Editor.refreshCoverageAnnotations</h4> | |
| 6216 <b>refreshCoverageAnnotations</b>(<i></i>) | |
| 6217 | |
| 6218 <p> | |
| 6219 Public method to refresh the code coverage annotations. | |
| 6220 </p> | |
| 6221 <a NAME="Editor.registerMouseHoverHelpFunction" ID="Editor.registerMouseHoverHelpFunction"></a> | |
| 6222 <h4>Editor.registerMouseHoverHelpFunction</h4> | |
| 6223 <b>registerMouseHoverHelpFunction</b>(<i>func</i>) | |
| 6224 | |
| 6225 <p> | |
| 6226 Public method to register a mouse hover help function. | |
| 6227 </p> | |
| 6228 <p> | |
| 6229 Note: Only one plugin should provide this function. Otherwise | |
| 6230 the last one wins. | |
| 6231 </p> | |
| 6232 <dl> | |
| 6233 | |
| 6234 <dt><i>func</i> (func)</dt> | |
| 6235 <dd> | |
| 6236 function accepting a reference to the calling editor and | |
| 6237 the line and column position (zero based each) | |
| 6238 </dd> | |
| 6239 </dl> | |
| 6240 <a NAME="Editor.removeCallTipHook" ID="Editor.removeCallTipHook"></a> | |
| 6241 <h4>Editor.removeCallTipHook</h4> | |
| 6242 <b>removeCallTipHook</b>(<i>key</i>) | |
| 6243 | |
| 6244 <p> | |
| 6245 Public method to remove a previously registered calltip provider. | |
| 6246 </p> | |
| 6247 <dl> | |
| 6248 | |
| 6249 <dt><i>key</i> (str)</dt> | |
| 6250 <dd> | |
| 6251 name of the provider | |
| 6252 </dd> | |
| 6253 </dl> | |
| 6254 <a NAME="Editor.removeClone" ID="Editor.removeClone"></a> | |
| 6255 <h4>Editor.removeClone</h4> | |
| 6256 <b>removeClone</b>(<i>editor</i>) | |
| 6257 | |
| 6258 <p> | |
| 6259 Public method to remove a clone from our list. | |
| 6260 </p> | |
| 6261 <dl> | |
| 6262 | |
| 6263 <dt><i>editor</i> (Editor)</dt> | |
| 6264 <dd> | |
| 6265 reference to the cloned editor | |
| 6266 </dd> | |
| 6267 </dl> | |
| 6268 <a NAME="Editor.removeCompletionListHook" ID="Editor.removeCompletionListHook"></a> | |
| 6269 <h4>Editor.removeCompletionListHook</h4> | |
| 6270 <b>removeCompletionListHook</b>(<i>key</i>) | |
| 6271 | |
| 6272 <p> | |
| 6273 Public method to remove a previously registered completion list | |
| 6274 provider. | |
| 6275 </p> | |
| 6276 <dl> | |
| 6277 | |
| 6278 <dt><i>key</i> (str)</dt> | |
| 6279 <dd> | |
| 6280 name of the provider | |
| 6281 </dd> | |
| 6282 </dl> | |
| 6283 <a NAME="Editor.removeMouseClickHandler" ID="Editor.removeMouseClickHandler"></a> | |
| 6284 <h4>Editor.removeMouseClickHandler</h4> | |
| 6285 <b>removeMouseClickHandler</b>(<i>modifiers, button</i>) | |
| 6286 | |
| 6287 <p> | |
| 6288 Public method to un-registered a mouse click handler. | |
| 6289 </p> | |
| 6290 <dl> | |
| 6291 | |
| 6292 <dt><i>modifiers</i> (Qt.KeyboardModifiers)</dt> | |
| 6293 <dd> | |
| 6294 keyboard modifiers of the handler | |
| 6295 </dd> | |
| 6296 <dt><i>button</i> (Qt.MouseButton)</dt> | |
| 6297 <dd> | |
| 6298 mouse button of the handler | |
| 6299 </dd> | |
| 6300 </dl> | |
| 6301 <a NAME="Editor.removeMouseClickHandlers" ID="Editor.removeMouseClickHandlers"></a> | |
| 6302 <h4>Editor.removeMouseClickHandlers</h4> | |
| 6303 <b>removeMouseClickHandlers</b>(<i>name</i>) | |
| 6304 | |
| 6305 <p> | |
| 6306 Public method to un-registered all mouse click handlers of | |
| 6307 a plug-in. | |
| 6308 </p> | |
| 6309 <dl> | |
| 6310 | |
| 6311 <dt><i>name</i> (str)</dt> | |
| 6312 <dd> | |
| 6313 name of the plug-in | |
| 6314 </dd> | |
| 6315 </dl> | |
| 6316 <a NAME="Editor.resizeEvent" ID="Editor.resizeEvent"></a> | |
| 6317 <h4>Editor.resizeEvent</h4> | |
| 6318 <b>resizeEvent</b>(<i>evt</i>) | |
| 6319 | |
| 6320 <p> | |
| 6321 Protected method handling resize events. | |
| 6322 </p> | |
| 6323 <dl> | |
| 6324 | |
| 6325 <dt><i>evt</i> (QResizeEvent)</dt> | |
| 6326 <dd> | |
| 6327 reference to the resize event | |
| 6328 </dd> | |
| 6329 </dl> | |
| 6330 <a NAME="Editor.revertToUnmodified" ID="Editor.revertToUnmodified"></a> | |
| 6331 <h4>Editor.revertToUnmodified</h4> | |
| 6332 <b>revertToUnmodified</b>(<i></i>) | |
| 6333 | |
| 6334 <p> | |
| 6335 Public method to revert back to the last saved state. | |
| 6336 </p> | |
| 6337 <a NAME="Editor.saveFile" ID="Editor.saveFile"></a> | |
| 6338 <h4>Editor.saveFile</h4> | |
| 6339 <b>saveFile</b>(<i>saveas=False, path=None</i>) | |
| 6340 | |
| 6341 <p> | |
| 6342 Public method to save the text to a file. | |
| 6343 </p> | |
| 6344 <dl> | |
| 6345 | |
| 6346 <dt><i>saveas</i></dt> | |
| 6347 <dd> | |
| 6348 flag indicating a 'save as' action (boolean) | |
| 6349 </dd> | |
| 6350 <dt><i>path</i></dt> | |
| 6351 <dd> | |
| 6352 directory to save the file in (string) | |
| 6353 </dd> | |
| 6354 </dl> | |
| 6355 <dl> | |
| 6356 <dt>Return:</dt> | |
| 6357 <dd> | |
| 6358 flag indicating success (boolean) | |
| 6359 </dd> | |
| 6360 </dl> | |
| 6361 <a NAME="Editor.saveFileAs" ID="Editor.saveFileAs"></a> | |
| 6362 <h4>Editor.saveFileAs</h4> | |
| 6363 <b>saveFileAs</b>(<i>path=None, toProject=False</i>) | |
| 6364 | |
| 6365 <p> | |
| 6366 Public slot to save a file with a new name. | |
| 6367 </p> | |
| 6368 <dl> | |
| 6369 | |
| 6370 <dt><i>path</i></dt> | |
| 6371 <dd> | |
| 6372 directory to save the file in (string) | |
| 6373 </dd> | |
| 6374 <dt><i>toProject</i></dt> | |
| 6375 <dd> | |
| 6376 flag indicating a save to project operation | |
| 6377 (boolean) | |
| 6378 </dd> | |
| 6379 </dl> | |
| 6380 <dl> | |
| 6381 <dt>Return:</dt> | |
| 6382 <dd> | |
| 6383 tuple of two values (boolean, string) giving a success | |
| 6384 indicator and the name of the saved file | |
| 6385 </dd> | |
| 6386 </dl> | |
| 6387 <a NAME="Editor.saveFileCopy" ID="Editor.saveFileCopy"></a> | |
| 6388 <h4>Editor.saveFileCopy</h4> | |
| 6389 <b>saveFileCopy</b>(<i>path=None</i>) | |
| 6390 | |
| 6391 <p> | |
| 6392 Public method to save a copy of the file. | |
| 6393 </p> | |
| 6394 <dl> | |
| 6395 | |
| 6396 <dt><i>path</i></dt> | |
| 6397 <dd> | |
| 6398 directory to save the file in (string) | |
| 6399 </dd> | |
| 6400 </dl> | |
| 6401 <dl> | |
| 6402 <dt>Return:</dt> | |
| 6403 <dd> | |
| 6404 flag indicating success (boolean) | |
| 6405 </dd> | |
| 6406 </dl> | |
| 6407 <a NAME="Editor.searchCurrentWordBackward" ID="Editor.searchCurrentWordBackward"></a> | |
| 6408 <h4>Editor.searchCurrentWordBackward</h4> | |
| 6409 <b>searchCurrentWordBackward</b>(<i></i>) | |
| 6410 | |
| 6411 <p> | |
| 6412 Public slot to search the current word backward. | |
| 6413 </p> | |
| 6414 <a NAME="Editor.searchCurrentWordForward" ID="Editor.searchCurrentWordForward"></a> | |
| 6415 <h4>Editor.searchCurrentWordForward</h4> | |
| 6416 <b>searchCurrentWordForward</b>(<i></i>) | |
| 6417 | |
| 6418 <p> | |
| 6419 Public slot to search the current word forward. | |
| 6420 </p> | |
| 6421 <a NAME="Editor.selectCurrentWord" ID="Editor.selectCurrentWord"></a> | |
| 6422 <h4>Editor.selectCurrentWord</h4> | |
| 6423 <b>selectCurrentWord</b>(<i></i>) | |
| 6424 | |
| 6425 <p> | |
| 6426 Public method to select the current word. | |
| 6427 </p> | |
| 6428 <a NAME="Editor.selectWord" ID="Editor.selectWord"></a> | |
| 6429 <h4>Editor.selectWord</h4> | |
| 6430 <b>selectWord</b>(<i>line, index</i>) | |
| 6431 | |
| 6432 <p> | |
| 6433 Public method to select the word at a position. | |
| 6434 </p> | |
| 6435 <dl> | |
| 6436 | |
| 6437 <dt><i>line</i></dt> | |
| 6438 <dd> | |
| 6439 number of line to look at (int) | |
| 6440 </dd> | |
| 6441 <dt><i>index</i></dt> | |
| 6442 <dd> | |
| 6443 position to look at (int) | |
| 6444 </dd> | |
| 6445 </dl> | |
| 6446 <a NAME="Editor.sendSharedEdit" ID="Editor.sendSharedEdit"></a> | |
| 6447 <h4>Editor.sendSharedEdit</h4> | |
| 6448 <b>sendSharedEdit</b>(<i></i>) | |
| 6449 | |
| 6450 <p> | |
| 6451 Public slot to end a shared edit session for the editor and | |
| 6452 send the changes. | |
| 6453 </p> | |
| 6454 <a NAME="Editor.setAutoCompletionEnabled" ID="Editor.setAutoCompletionEnabled"></a> | |
| 6455 <h4>Editor.setAutoCompletionEnabled</h4> | |
| 6456 <b>setAutoCompletionEnabled</b>(<i>enable</i>) | |
| 6457 | |
| 6458 <p> | |
| 6459 Public method to enable/disable autocompletion. | |
| 6460 </p> | |
| 6461 <dl> | |
| 6462 | |
| 6463 <dt><i>enable</i></dt> | |
| 6464 <dd> | |
| 6465 flag indicating the desired autocompletion status | |
| 6466 (boolean) | |
| 6467 </dd> | |
| 6468 </dl> | |
| 6469 <a NAME="Editor.setAutoSpellChecking" ID="Editor.setAutoSpellChecking"></a> | |
| 6470 <h4>Editor.setAutoSpellChecking</h4> | |
| 6471 <b>setAutoSpellChecking</b>(<i></i>) | |
| 6472 | |
| 6473 <p> | |
| 6474 Public method to set the automatic spell checking. | |
| 6475 </p> | |
| 6476 <a NAME="Editor.setHighlight" ID="Editor.setHighlight"></a> | |
| 6477 <h4>Editor.setHighlight</h4> | |
| 6478 <b>setHighlight</b>(<i>startLine, startIndex, endLine, endIndex</i>) | |
| 6479 | |
| 6480 <p> | |
| 6481 Public method to set a text highlight. | |
| 6482 </p> | |
| 6483 <dl> | |
| 6484 | |
| 6485 <dt><i>startLine</i> (int)</dt> | |
| 6486 <dd> | |
| 6487 line of the highlight start | |
| 6488 </dd> | |
| 6489 <dt><i>startIndex</i> (int)</dt> | |
| 6490 <dd> | |
| 6491 index of the highlight start | |
| 6492 </dd> | |
| 6493 <dt><i>endLine</i> (int)</dt> | |
| 6494 <dd> | |
| 6495 line of the highlight end | |
| 6496 </dd> | |
| 6497 <dt><i>endIndex</i> (int)</dt> | |
| 6498 <dd> | |
| 6499 index of the highlight end | |
| 6500 </dd> | |
| 6501 </dl> | |
| 6502 <a NAME="Editor.setLanguage" ID="Editor.setLanguage"></a> | |
| 6503 <h4>Editor.setLanguage</h4> | |
| 6504 <b>setLanguage</b>(<i>filename, initTextDisplay=True, propagate=True, pyname=""</i>) | |
| 6505 | |
| 6506 <p> | |
| 6507 Public method to set a lexer language. | |
| 6508 </p> | |
| 6509 <dl> | |
| 6510 | |
| 6511 <dt><i>filename</i></dt> | |
| 6512 <dd> | |
| 6513 filename used to determine the associated lexer | |
| 6514 language (string) | |
| 6515 </dd> | |
| 6516 <dt><i>initTextDisplay</i></dt> | |
| 6517 <dd> | |
| 6518 flag indicating an initialization of the text | |
| 6519 display is required as well (boolean) | |
| 6520 </dd> | |
| 6521 <dt><i>propagate</i></dt> | |
| 6522 <dd> | |
| 6523 flag indicating to propagate the change (boolean) | |
| 6524 </dd> | |
| 6525 <dt><i>pyname</i></dt> | |
| 6526 <dd> | |
| 6527 name of the pygments lexer to use (string) | |
| 6528 </dd> | |
| 6529 </dl> | |
| 6530 <a NAME="Editor.setMonospaced" ID="Editor.setMonospaced"></a> | |
| 6531 <h4>Editor.setMonospaced</h4> | |
| 6532 <b>setMonospaced</b>(<i>on</i>) | |
| 6533 | |
| 6534 <p> | |
| 6535 Public method to set/reset a monospaced font. | |
| 6536 </p> | |
| 6537 <dl> | |
| 6538 | |
| 6539 <dt><i>on</i></dt> | |
| 6540 <dd> | |
| 6541 flag to indicate usage of a monospace font (boolean) | |
| 6542 </dd> | |
| 6543 </dl> | |
| 6544 <a NAME="Editor.setMouseClickHandler" ID="Editor.setMouseClickHandler"></a> | |
| 6545 <h4>Editor.setMouseClickHandler</h4> | |
| 6546 <b>setMouseClickHandler</b>(<i>name, modifiers, button, function</i>) | |
| 6547 | |
| 6548 <p> | |
| 6549 Public method to set a mouse click handler. | |
| 6550 </p> | |
| 6551 <dl> | |
| 6552 | |
| 6553 <dt><i>name</i> (str)</dt> | |
| 6554 <dd> | |
| 6555 name of the plug-in (or 'internal') setting this handler | |
| 6556 </dd> | |
| 6557 <dt><i>modifiers</i> (Qt.KeyboardModifiers or int)</dt> | |
| 6558 <dd> | |
| 6559 keyboard modifiers of the handler | |
| 6560 </dd> | |
| 6561 <dt><i>button</i> (Qt.MouseButton or int)</dt> | |
| 6562 <dd> | |
| 6563 mouse button of the handler | |
| 6564 </dd> | |
| 6565 <dt><i>function</i> (func)</dt> | |
| 6566 <dd> | |
| 6567 handler function | |
| 6568 </dd> | |
| 6569 </dl> | |
| 6570 <dl> | |
| 6571 <dt>Return:</dt> | |
| 6572 <dd> | |
| 6573 flag indicating success | |
| 6574 </dd> | |
| 6575 </dl> | |
| 6576 <dl> | |
| 6577 <dt>Return Type:</dt> | |
| 6578 <dd> | |
| 6579 bool | |
| 6580 </dd> | |
| 6581 </dl> | |
| 6582 <a NAME="Editor.setNoName" ID="Editor.setNoName"></a> | |
| 6583 <h4>Editor.setNoName</h4> | |
| 6584 <b>setNoName</b>(<i>noName</i>) | |
| 6585 | |
| 6586 <p> | |
| 6587 Public method to set the display string for an unnamed editor. | |
| 6588 </p> | |
| 6589 <dl> | |
| 6590 | |
| 6591 <dt><i>noName</i></dt> | |
| 6592 <dd> | |
| 6593 display string for this unnamed editor (string) | |
| 6594 </dd> | |
| 6595 </dl> | |
| 6596 <a NAME="Editor.setSearchIndicator" ID="Editor.setSearchIndicator"></a> | |
| 6597 <h4>Editor.setSearchIndicator</h4> | |
| 6598 <b>setSearchIndicator</b>(<i>startPos, indicLength</i>) | |
| 6599 | |
| 6600 <p> | |
| 6601 Public method to set a search indicator for the given range. | |
| 6602 </p> | |
| 6603 <dl> | |
| 6604 | |
| 6605 <dt><i>startPos</i></dt> | |
| 6606 <dd> | |
| 6607 start position of the indicator (integer) | |
| 6608 </dd> | |
| 6609 <dt><i>indicLength</i></dt> | |
| 6610 <dd> | |
| 6611 length of the indicator (integer) | |
| 6612 </dd> | |
| 6613 </dl> | |
| 6614 <a NAME="Editor.setSpellingForProject" ID="Editor.setSpellingForProject"></a> | |
| 6615 <h4>Editor.setSpellingForProject</h4> | |
| 6616 <b>setSpellingForProject</b>(<i></i>) | |
| 6617 | |
| 6618 <p> | |
| 6619 Public method to set the spell checking options for files belonging | |
| 6620 to the current project. | |
| 6621 </p> | |
| 6622 <a NAME="Editor.shareConnected" ID="Editor.shareConnected"></a> | |
| 6623 <h4>Editor.shareConnected</h4> | |
| 6624 <b>shareConnected</b>(<i>connected</i>) | |
| 6625 | |
| 6626 <p> | |
| 6627 Public slot to handle a change of the connected state. | |
| 6628 </p> | |
| 6629 <dl> | |
| 6630 | |
| 6631 <dt><i>connected</i></dt> | |
| 6632 <dd> | |
| 6633 flag indicating the connected state (boolean) | |
| 6634 </dd> | |
| 6635 </dl> | |
| 6636 <a NAME="Editor.shareEditor" ID="Editor.shareEditor"></a> | |
| 6637 <h4>Editor.shareEditor</h4> | |
| 6638 <b>shareEditor</b>(<i>share</i>) | |
| 6639 | |
| 6640 <p> | |
| 6641 Public slot to set the shared status of the editor. | |
| 6642 </p> | |
| 6643 <dl> | |
| 6644 | |
| 6645 <dt><i>share</i></dt> | |
| 6646 <dd> | |
| 6647 flag indicating the share status (boolean) | |
| 6648 </dd> | |
| 6649 </dl> | |
| 6650 <a NAME="Editor.shortenEmptyLines" ID="Editor.shortenEmptyLines"></a> | |
| 6651 <h4>Editor.shortenEmptyLines</h4> | |
| 6652 <b>shortenEmptyLines</b>(<i></i>) | |
| 6653 | |
| 6654 <p> | |
| 6655 Public slot to compress lines consisting solely of whitespace | |
| 6656 characters. | |
| 6657 </p> | |
| 6658 <a NAME="Editor.shouldAutosave" ID="Editor.shouldAutosave"></a> | |
| 6659 <h4>Editor.shouldAutosave</h4> | |
| 6660 <b>shouldAutosave</b>(<i></i>) | |
| 6661 | |
| 6662 <p> | |
| 6663 Public slot to check the autosave flags. | |
| 6664 </p> | |
| 6665 <dl> | |
| 6666 <dt>Return:</dt> | |
| 6667 <dd> | |
| 6668 flag indicating this editor should be saved (boolean) | |
| 6669 </dd> | |
| 6670 </dl> | |
| 6671 <a NAME="Editor.showMouseHoverHelpData" ID="Editor.showMouseHoverHelpData"></a> | |
| 6672 <h4>Editor.showMouseHoverHelpData</h4> | |
| 6673 <b>showMouseHoverHelpData</b>(<i>line, index, data</i>) | |
| 6674 | |
| 6675 <p> | |
| 6676 Public method to show the mouse hover help data. | |
| 6677 </p> | |
| 6678 <dl> | |
| 6679 | |
| 6680 <dt><i>line</i> (int)</dt> | |
| 6681 <dd> | |
| 6682 line of mouse cursor position | |
| 6683 </dd> | |
| 6684 <dt><i>index</i> (int)</dt> | |
| 6685 <dd> | |
| 6686 column of mouse cursor position | |
| 6687 </dd> | |
| 6688 <dt><i>data</i> (str)</dt> | |
| 6689 <dd> | |
| 6690 information text to be shown | |
| 6691 </dd> | |
| 6692 </dl> | |
| 6693 <a NAME="Editor.smartIndentLineOrSelection" ID="Editor.smartIndentLineOrSelection"></a> | |
| 6694 <h4>Editor.smartIndentLineOrSelection</h4> | |
| 6695 <b>smartIndentLineOrSelection</b>(<i></i>) | |
| 6696 | |
| 6697 <p> | |
| 6698 Public slot to indent current line smartly. | |
| 6699 </p> | |
| 6700 <a NAME="Editor.sortLines" ID="Editor.sortLines"></a> | |
| 6701 <h4>Editor.sortLines</h4> | |
| 6702 <b>sortLines</b>(<i></i>) | |
| 6703 | |
| 6704 <p> | |
| 6705 Public slot to sort the lines spanned by a rectangular selection. | |
| 6706 </p> | |
| 6707 <a NAME="Editor.startSharedEdit" ID="Editor.startSharedEdit"></a> | |
| 6708 <h4>Editor.startSharedEdit</h4> | |
| 6709 <b>startSharedEdit</b>(<i></i>) | |
| 6710 | |
| 6711 <p> | |
| 6712 Public slot to start a shared edit session for the editor. | |
| 6713 </p> | |
| 6714 <a NAME="Editor.streamCommentLine" ID="Editor.streamCommentLine"></a> | |
| 6715 <h4>Editor.streamCommentLine</h4> | |
| 6716 <b>streamCommentLine</b>(<i></i>) | |
| 6717 | |
| 6718 <p> | |
| 6719 Public slot to stream comment the current line. | |
| 6720 </p> | |
| 6721 <a NAME="Editor.streamCommentLineOrSelection" ID="Editor.streamCommentLineOrSelection"></a> | |
| 6722 <h4>Editor.streamCommentLineOrSelection</h4> | |
| 6723 <b>streamCommentLineOrSelection</b>(<i></i>) | |
| 6724 | |
| 6725 <p> | |
| 6726 Public slot to stream comment the current line or current selection. | |
| 6727 </p> | |
| 6728 <a NAME="Editor.streamCommentSelection" ID="Editor.streamCommentSelection"></a> | |
| 6729 <h4>Editor.streamCommentSelection</h4> | |
| 6730 <b>streamCommentSelection</b>(<i></i>) | |
| 6731 | |
| 6732 <p> | |
| 6733 Public slot to comment the current selection. | |
| 6734 </p> | |
| 6735 <a NAME="Editor.toggleBookmark" ID="Editor.toggleBookmark"></a> | |
| 6736 <h4>Editor.toggleBookmark</h4> | |
| 6737 <b>toggleBookmark</b>(<i>line</i>) | |
| 6738 | |
| 6739 <p> | |
| 6740 Public method to toggle a bookmark. | |
| 6741 </p> | |
| 6742 <dl> | |
| 6743 | |
| 6744 <dt><i>line</i></dt> | |
| 6745 <dd> | |
| 6746 line number of the bookmark (integer) | |
| 6747 </dd> | |
| 6748 </dl> | |
| 6749 <a NAME="Editor.toggleCommentBlock" ID="Editor.toggleCommentBlock"></a> | |
| 6750 <h4>Editor.toggleCommentBlock</h4> | |
| 6751 <b>toggleCommentBlock</b>(<i></i>) | |
| 6752 | |
| 6753 <p> | |
| 6754 Public slot to toggle the comment of a block. | |
| 6755 </p> | |
| 6756 <p> | |
| 6757 If the line of the cursor or the selection is not commented, it will | |
| 6758 be commented. If it is commented, the comment block will be removed. | |
| 6759 The later works independent of the current selection. | |
| 6760 </p> | |
| 6761 <a NAME="Editor.toggleCurrentFold" ID="Editor.toggleCurrentFold"></a> | |
| 6762 <h4>Editor.toggleCurrentFold</h4> | |
| 6763 <b>toggleCurrentFold</b>(<i></i>) | |
| 6764 | |
| 6765 <p> | |
| 6766 Public slot to toggle the fold containing the current line. | |
| 6767 </p> | |
| 6768 <a NAME="Editor.toggleSyntaxError" ID="Editor.toggleSyntaxError"></a> | |
| 6769 <h4>Editor.toggleSyntaxError</h4> | |
| 6770 <b>toggleSyntaxError</b>(<i>line, index, error, msg="", show=False</i>) | |
| 6771 | |
| 6772 <p> | |
| 6773 Public method to toggle a syntax error indicator. | |
| 6774 </p> | |
| 6775 <dl> | |
| 6776 | |
| 6777 <dt><i>line</i></dt> | |
| 6778 <dd> | |
| 6779 line number of the syntax error (integer) | |
| 6780 </dd> | |
| 6781 <dt><i>index</i></dt> | |
| 6782 <dd> | |
| 6783 index number of the syntax error (integer) | |
| 6784 </dd> | |
| 6785 <dt><i>error</i></dt> | |
| 6786 <dd> | |
| 6787 flag indicating if the error marker should be | |
| 6788 set or deleted (boolean) | |
| 6789 </dd> | |
| 6790 <dt><i>msg</i></dt> | |
| 6791 <dd> | |
| 6792 error message (string) | |
| 6793 </dd> | |
| 6794 <dt><i>show</i></dt> | |
| 6795 <dd> | |
| 6796 flag indicating to set the cursor to the error position | |
| 6797 (boolean) | |
| 6798 </dd> | |
| 6799 </dl> | |
| 6800 <a NAME="Editor.toggleWarning" ID="Editor.toggleWarning"></a> | |
| 6801 <h4>Editor.toggleWarning</h4> | |
| 6802 <b>toggleWarning</b>(<i>line, col, warning, msg="", warningType=WarningCode</i>) | |
| 6803 | |
| 6804 <p> | |
| 6805 Public method to toggle a warning indicator. | |
| 6806 </p> | |
| 6807 <p> | |
| 6808 Note: This method is used to set pyflakes and code style warnings. | |
| 6809 </p> | |
| 6810 <dl> | |
| 6811 | |
| 6812 <dt><i>line</i></dt> | |
| 6813 <dd> | |
| 6814 line number of the warning | |
| 6815 </dd> | |
| 6816 <dt><i>col</i></dt> | |
| 6817 <dd> | |
| 6818 column of the warning | |
| 6819 </dd> | |
| 6820 <dt><i>warning</i></dt> | |
| 6821 <dd> | |
| 6822 flag indicating if the warning marker should be | |
| 6823 set or deleted (boolean) | |
| 6824 </dd> | |
| 6825 <dt><i>msg</i></dt> | |
| 6826 <dd> | |
| 6827 warning message (string) | |
| 6828 </dd> | |
| 6829 <dt><i>warningType</i></dt> | |
| 6830 <dd> | |
| 6831 type of warning message (integer) | |
| 6832 </dd> | |
| 6833 </dl> | |
| 6834 <a NAME="Editor.uncommentLine" ID="Editor.uncommentLine"></a> | |
| 6835 <h4>Editor.uncommentLine</h4> | |
| 6836 <b>uncommentLine</b>(<i></i>) | |
| 6837 | |
| 6838 <p> | |
| 6839 Public slot to uncomment the current line. | |
| 6840 </p> | |
| 6841 <a NAME="Editor.uncommentLineOrSelection" ID="Editor.uncommentLineOrSelection"></a> | |
| 6842 <h4>Editor.uncommentLineOrSelection</h4> | |
| 6843 <b>uncommentLineOrSelection</b>(<i></i>) | |
| 6844 | |
| 6845 <p> | |
| 6846 Public slot to uncomment the current line or current selection. | |
| 6847 </p> | |
| 6848 <a NAME="Editor.uncommentSelection" ID="Editor.uncommentSelection"></a> | |
| 6849 <h4>Editor.uncommentSelection</h4> | |
| 6850 <b>uncommentSelection</b>(<i></i>) | |
| 6851 | |
| 6852 <p> | |
| 6853 Public slot to uncomment the current selection. | |
| 6854 </p> | |
| 6855 <a NAME="Editor.undo" ID="Editor.undo"></a> | |
| 6856 <h4>Editor.undo</h4> | |
| 6857 <b>undo</b>(<i></i>) | |
| 6858 | |
| 6859 <p> | |
| 6860 Public method to undo the last recorded change. | |
| 6861 </p> | |
| 6862 <a NAME="Editor.unindentLineOrSelection" ID="Editor.unindentLineOrSelection"></a> | |
| 6863 <h4>Editor.unindentLineOrSelection</h4> | |
| 6864 <b>unindentLineOrSelection</b>(<i></i>) | |
| 6865 | |
| 6866 <p> | |
| 6867 Public slot to unindent the current line or current selection. | |
| 6868 </p> | |
| 6869 <a NAME="Editor.unregisterMouseHoverHelpFunction" ID="Editor.unregisterMouseHoverHelpFunction"></a> | |
| 6870 <h4>Editor.unregisterMouseHoverHelpFunction</h4> | |
| 6871 <b>unregisterMouseHoverHelpFunction</b>(<i>func</i>) | |
| 6872 | |
| 6873 <p> | |
| 6874 Public method to unregister a mouse hover help function. | |
| 6875 </p> | |
| 6876 <dl> | |
| 6877 | |
| 6878 <dt><i>func</i> (func)</dt> | |
| 6879 <dd> | |
| 6880 function accepting a reference to the calling editor and | |
| 6881 the line and column position (zero based each) | |
| 6882 </dd> | |
| 6883 </dl> | |
| 6884 <a NAME="Editor.updateMarkerMap" ID="Editor.updateMarkerMap"></a> | |
| 6885 <h4>Editor.updateMarkerMap</h4> | |
| 6886 <b>updateMarkerMap</b>(<i></i>) | |
| 6887 | |
| 6888 <p> | |
| 6889 Public method to initiate an update of the marker map. | |
| 6890 </p> | |
| 6891 <a NAME="Editor.viewportEvent" ID="Editor.viewportEvent"></a> | |
| 6892 <h4>Editor.viewportEvent</h4> | |
| 6893 <b>viewportEvent</b>(<i>evt</i>) | |
| 6894 | |
| 6895 <p> | |
| 6896 Protected method handling event of the viewport. | |
| 6897 </p> | |
| 6898 <dl> | |
| 6899 | |
| 6900 <dt><i>evt</i> (QEvent)</dt> | |
| 6901 <dd> | |
| 6902 reference to the event | |
| 6903 </dd> | |
| 6904 </dl> | |
| 6905 <dl> | |
| 6906 <dt>Return:</dt> | |
| 6907 <dd> | |
| 6908 flag indiating that the event was handled | |
| 6909 </dd> | |
| 6910 </dl> | |
| 6911 <dl> | |
| 6912 <dt>Return Type:</dt> | |
| 6913 <dd> | |
| 6914 bool | |
| 6915 </dd> | |
| 6916 </dl> | |
| 6917 <a NAME="Editor.wheelEvent" ID="Editor.wheelEvent"></a> | |
| 6918 <h4>Editor.wheelEvent</h4> | |
| 6919 <b>wheelEvent</b>(<i>evt</i>) | |
| 6920 | |
| 6921 <p> | |
| 6922 Protected method to handle wheel events. | |
| 6923 </p> | |
| 6924 <dl> | |
| 6925 | |
| 6926 <dt><i>evt</i> (QWheelEvent)</dt> | |
| 6927 <dd> | |
| 6928 reference to the wheel event | |
| 6929 </dd> | |
| 6930 </dl> | |
| 6931 <a NAME="Editor.writeFile" ID="Editor.writeFile"></a> | |
| 6932 <h4>Editor.writeFile</h4> | |
| 6933 <b>writeFile</b>(<i>fn, backup=True</i>) | |
| 6934 | |
| 6935 <p> | |
| 6936 Public slot to write the text to a file. | |
| 6937 </p> | |
| 6938 <dl> | |
| 6939 | |
| 6940 <dt><i>fn</i></dt> | |
| 6941 <dd> | |
| 6942 filename to write to (string) | |
| 6943 </dd> | |
| 6944 <dt><i>backup</i></dt> | |
| 6945 <dd> | |
| 6946 flag indicating to save a backup (boolean) | |
| 6947 </dd> | |
| 6948 </dl> | |
| 6949 <dl> | |
| 6950 <dt>Return:</dt> | |
| 6951 <dd> | |
| 6952 flag indicating success (boolean) | |
| 6953 </dd> | |
| 6954 </dl> | |
| 6955 <div align="right"><a href="#top">Up</a></div> | |
| 6956 <hr /> | |
| 6957 </body></html> |
