Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.QScintilla.Editor.html
Documentation/Source/eric5.QScintilla.Editor.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.QScintilla.Editor</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.QScintilla.Editor</h1> | |
| 12 <p> | |
| 13 Module implementing the editor component of the eric5 IDE. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>EditorAutoCompletionListID</td></tr><tr><td>TemplateCompletionListID</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#Editor">Editor</a></td> | |
| 23 <td>Class implementing the editor component of the eric5 IDE.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="Editor" ID="Editor"></a> | |
| 32 <h2>Editor</h2> | |
| 33 <p> | |
| 34 Class implementing the editor component of the eric5 IDE. | |
| 35 </p><h4>Signals</h4> | |
| 36 <dl> | |
| 37 <dt>autoCompletionAPIsAvailable(avail)</dt> | |
| 38 <dd> | |
| 39 emitted after the autocompletion | |
| 40 function has been configured | |
| 41 </dd><dt>bookmarkToggled(editor)</dt> | |
| 42 <dd> | |
| 43 emitted when a bookmark is toggled | |
| 44 </dd><dt>breakpointToggled(editor)</dt> | |
| 45 <dd> | |
| 46 emitted when a breakpoint is toggled | |
| 47 </dd><dt>captionChanged(string, editor)</dt> | |
| 48 <dd> | |
| 49 emitted when the caption is | |
| 50 updated. Typically due to a readOnly attribute change. | |
| 51 </dd><dt>coverageMarkersShown(boolean)</dt> | |
| 52 <dd> | |
| 53 emitted after the coverage markers have been | |
| 54 shown or cleared | |
| 55 </dd><dt>cursorChanged(string, int, int)</dt> | |
| 56 <dd> | |
| 57 emitted when the cursor position | |
| 58 was changed | |
| 59 </dd><dt>editorAboutToBeSaved(string)</dt> | |
| 60 <dd> | |
| 61 emitted before the editor is saved | |
| 62 </dd><dt>editorRenamed(string)</dt> | |
| 63 <dd> | |
| 64 emitted after the editor got a new name | |
| 65 (i.e. after a 'Save As') | |
| 66 </dd><dt>editorSaved(string)</dt> | |
| 67 <dd> | |
| 68 emitted after the editor has been saved | |
| 69 </dd><dt>encodingChanged(encoding)</dt> | |
| 70 <dd> | |
| 71 emitted when the editors encoding was set. The | |
| 72 encoding name is passed as a parameter. | |
| 73 </dd><dt>eolChanged(eol)</dt> | |
| 74 <dd> | |
| 75 emitted when the editors eol type was set. The eol string | |
| 76 is passed as a parameter. | |
| 77 </dd><dt>languageChanged(language)</dt> | |
| 78 <dd> | |
| 79 emitted when the editors language was set. The | |
| 80 language is passed as a parameter. | |
| 81 </dd><dt>modificationStatusChanged(boolean, editor)</dt> | |
| 82 <dd> | |
| 83 emitted when the | |
| 84 modification status has changed | |
| 85 </dd><dt>redoAvailable(boolean)</dt> | |
| 86 <dd> | |
| 87 emitted to signal the redo availability | |
| 88 </dd><dt>showMenu(string, QMenu, editor)</dt> | |
| 89 <dd> | |
| 90 emitted when a menu is about to be shown. | |
| 91 The name of the menu, a reference to the menu and a reference to the | |
| 92 editor are given. | |
| 93 </dd><dt>syntaxerrorToggled(editor)</dt> | |
| 94 <dd> | |
| 95 emitted when a syntax error was discovered | |
| 96 </dd><dt>taskMarkersUpdated(editor)</dt> | |
| 97 <dd> | |
| 98 emitted when the task markers were updated | |
| 99 </dd><dt>undoAvailable(boolean)</dt> | |
| 100 <dd> | |
| 101 emitted to signal the undo availability | |
| 102 </dd> | |
| 103 </dl> | |
| 104 <h3>Derived from</h3> | |
| 105 QsciScintillaCompat | |
| 106 <h3>Class Attributes</h3> | |
| 107 <table> | |
| 108 <tr><td>AttributeID</td></tr><tr><td>AttributePrivateID</td></tr><tr><td>AttributeProtectedID</td></tr><tr><td>ClassID</td></tr><tr><td>ClassPrivateID</td></tr><tr><td>ClassProtectedID</td></tr><tr><td>EnumID</td></tr><tr><td>FromDocumentID</td></tr><tr><td>MethodID</td></tr><tr><td>MethodPrivateID</td></tr><tr><td>MethodProtectedID</td></tr><tr><td>TemplateImageID</td></tr> | |
| 109 </table> | |
| 110 <h3>Methods</h3> | |
| 111 <table> | |
| 112 <tr> | |
| 113 <td><a href="#Editor.__init__">Editor</a></td> | |
| 114 <td>Constructor</td> | |
| 115 </tr><tr> | |
| 116 <td><a href="#Editor.__addBreakPoint">__addBreakPoint</a></td> | |
| 117 <td>Private method to add a new breakpoint.</td> | |
| 118 </tr><tr> | |
| 119 <td><a href="#Editor.__addBreakPoints">__addBreakPoints</a></td> | |
| 120 <td>Private slot to add breakpoints.</td> | |
| 121 </tr><tr> | |
| 122 <td><a href="#Editor.__addFileAliasResource">__addFileAliasResource</a></td> | |
| 123 <td>Private method to handle the Add aliased file context menu action.</td> | |
| 124 </tr><tr> | |
| 125 <td><a href="#Editor.__addFileResource">__addFileResource</a></td> | |
| 126 <td>Private method to handle the Add file context menu action.</td> | |
| 127 </tr><tr> | |
| 128 <td><a href="#Editor.__addFileResources">__addFileResources</a></td> | |
| 129 <td>Private method to handle the Add files context menu action.</td> | |
| 130 </tr><tr> | |
| 131 <td><a href="#Editor.__addLocalizedResource">__addLocalizedResource</a></td> | |
| 132 <td>Private method to handle the Add localized resource context menu action.</td> | |
| 133 </tr><tr> | |
| 134 <td><a href="#Editor.__addResourceFrame">__addResourceFrame</a></td> | |
| 135 <td>Private method to handle the Add resource frame context menu action.</td> | |
| 136 </tr><tr> | |
| 137 <td><a href="#Editor.__addToSpellingDictionary">__addToSpellingDictionary</a></td> | |
| 138 <td>Private slot to add the word below the spelling context menu to the dictionary.</td> | |
| 139 </tr><tr> | |
| 140 <td><a href="#Editor.__adjustedCallTipPosition">__adjustedCallTipPosition</a></td> | |
| 141 <td>Private method to calculate an adjusted position for showing calltips.</td> | |
| 142 </tr><tr> | |
| 143 <td><a href="#Editor.__applyTemplate">__applyTemplate</a></td> | |
| 144 <td>Private method to apply a template by name.</td> | |
| 145 </tr><tr> | |
| 146 <td><a href="#Editor.__autoSyntaxCheck">__autoSyntaxCheck</a></td> | |
| 147 <td>Private method to perform an automatic syntax check of the file.</td> | |
| 148 </tr><tr> | |
| 149 <td><a href="#Editor.__autosaveEnable">__autosaveEnable</a></td> | |
| 150 <td>Private slot handling the autosave enable context menu action.</td> | |
| 151 </tr><tr> | |
| 152 <td><a href="#Editor.__bindCompleter">__bindCompleter</a></td> | |
| 153 <td>Private slot to set the correct typing completer depending on language.</td> | |
| 154 </tr><tr> | |
| 155 <td><a href="#Editor.__bindLexer">__bindLexer</a></td> | |
| 156 <td>Private slot to set the correct lexer depending on language.</td> | |
| 157 </tr><tr> | |
| 158 <td><a href="#Editor.__bindName">__bindName</a></td> | |
| 159 <td>Private method to generate a dummy filename for binding a lexer.</td> | |
| 160 </tr><tr> | |
| 161 <td><a href="#Editor.__breakPointDataAboutToBeChanged">__breakPointDataAboutToBeChanged</a></td> | |
| 162 <td>Private slot to handle the dataAboutToBeChanged signal of the breakpoint model.</td> | |
| 163 </tr><tr> | |
| 164 <td><a href="#Editor.__callTip">__callTip</a></td> | |
| 165 <td>Private method to show call tips provided by a plugin.</td> | |
| 166 </tr><tr> | |
| 167 <td><a href="#Editor.__changeBreakPoints">__changeBreakPoints</a></td> | |
| 168 <td>Private slot to set changed breakpoints.</td> | |
| 169 </tr><tr> | |
| 170 <td><a href="#Editor.__charAdded">__charAdded</a></td> | |
| 171 <td>Public slot called to handle the user entering a character.</td> | |
| 172 </tr><tr> | |
| 173 <td><a href="#Editor.__checkEncoding">__checkEncoding</a></td> | |
| 174 <td>Private method to check the selected encoding of the encodings submenu.</td> | |
| 175 </tr><tr> | |
| 176 <td><a href="#Editor.__checkEol">__checkEol</a></td> | |
| 177 <td>Private method to check the selected eol type of the eol submenu.</td> | |
| 178 </tr><tr> | |
| 179 <td><a href="#Editor.__checkLanguage">__checkLanguage</a></td> | |
| 180 <td>Private method to check the selected language of the language submenu.</td> | |
| 181 </tr><tr> | |
| 182 <td><a href="#Editor.__checkSpellingSelection">__checkSpellingSelection</a></td> | |
| 183 <td>Private slot to spell check the current selection.</td> | |
| 184 </tr><tr> | |
| 185 <td><a href="#Editor.__checkSpellingWord">__checkSpellingWord</a></td> | |
| 186 <td>Private slot to check the word below the spelling context menu.</td> | |
| 187 </tr><tr> | |
| 188 <td><a href="#Editor.__clearBreakpoints">__clearBreakpoints</a></td> | |
| 189 <td>Private slot to clear all breakpoints.</td> | |
| 190 </tr><tr> | |
| 191 <td><a href="#Editor.__codeCoverageHideAnnotations">__codeCoverageHideAnnotations</a></td> | |
| 192 <td>Private method to handle the hide code coverage annotations context menu action.</td> | |
| 193 </tr><tr> | |
| 194 <td><a href="#Editor.__codeCoverageShowAnnotations">__codeCoverageShowAnnotations</a></td> | |
| 195 <td>Private method to handle the show code coverage annotations context menu action.</td> | |
| 196 </tr><tr> | |
| 197 <td><a href="#Editor.__completionListSelected">__completionListSelected</a></td> | |
| 198 <td>Private slot to handle the selection from the completion list.</td> | |
| 199 </tr><tr> | |
| 200 <td><a href="#Editor.__contextClose">__contextClose</a></td> | |
| 201 <td>Private slot handling the close context menu entry.</td> | |
| 202 </tr><tr> | |
| 203 <td><a href="#Editor.__contextMenuSpellingTriggered">__contextMenuSpellingTriggered</a></td> | |
| 204 <td>Private slot to handle the selection of a suggestion of the spelling context menu.</td> | |
| 205 </tr><tr> | |
| 206 <td><a href="#Editor.__contextSave">__contextSave</a></td> | |
| 207 <td>Private slot handling the save context menu entry.</td> | |
| 208 </tr><tr> | |
| 209 <td><a href="#Editor.__contextSaveAs">__contextSaveAs</a></td> | |
| 210 <td>Private slot handling the save as context menu entry.</td> | |
| 211 </tr><tr> | |
| 212 <td><a href="#Editor.__cursorPositionChanged">__cursorPositionChanged</a></td> | |
| 213 <td>Private slot to handle the cursorPositionChanged signal.</td> | |
| 214 </tr><tr> | |
| 215 <td><a href="#Editor.__deleteBreakPoints">__deleteBreakPoints</a></td> | |
| 216 <td>Private slot to delete breakpoints.</td> | |
| 217 </tr><tr> | |
| 218 <td><a href="#Editor.__deselectAll">__deselectAll</a></td> | |
| 219 <td>Private slot handling the deselect all context menu action.</td> | |
| 220 </tr><tr> | |
| 221 <td><a href="#Editor.__encodingChanged">__encodingChanged</a></td> | |
| 222 <td>Private slot to handle a change of the encoding.</td> | |
| 223 </tr><tr> | |
| 224 <td><a href="#Editor.__encodingsMenuTriggered">__encodingsMenuTriggered</a></td> | |
| 225 <td>Private method to handle the selection of an encoding.</td> | |
| 226 </tr><tr> | |
| 227 <td><a href="#Editor.__eolChanged">__eolChanged</a></td> | |
| 228 <td>Private slot to handle a change of the eol mode.</td> | |
| 229 </tr><tr> | |
| 230 <td><a href="#Editor.__eolMenuTriggered">__eolMenuTriggered</a></td> | |
| 231 <td>Private method to handle the selection of an eol type.</td> | |
| 232 </tr><tr> | |
| 233 <td><a href="#Editor.__exportMenuTriggered">__exportMenuTriggered</a></td> | |
| 234 <td>Private method to handle the selection of an export format.</td> | |
| 235 </tr><tr> | |
| 236 <td><a href="#Editor.__getCharacter">__getCharacter</a></td> | |
| 237 <td>Private method to get the character to the left of the current position in the current line.</td> | |
| 238 </tr><tr> | |
| 239 <td><a href="#Editor.__getCodeCoverageFile">__getCodeCoverageFile</a></td> | |
| 240 <td>Private method to get the filename of the file containing coverage info.</td> | |
| 241 </tr><tr> | |
| 242 <td><a href="#Editor.__getMacroName">__getMacroName</a></td> | |
| 243 <td>Private method to select a macro name from the list of macros.</td> | |
| 244 </tr><tr> | |
| 245 <td><a href="#Editor.__ignoreSpellingAlways">__ignoreSpellingAlways</a></td> | |
| 246 <td>Private to always ignore the word below the spelling context menu.</td> | |
| 247 </tr><tr> | |
| 248 <td><a href="#Editor.__indentLine">__indentLine</a></td> | |
| 249 <td>Private method to indent or unindent the current line.</td> | |
| 250 </tr><tr> | |
| 251 <td><a href="#Editor.__indentSelection">__indentSelection</a></td> | |
| 252 <td>Private method to indent or unindent the current selection.</td> | |
| 253 </tr><tr> | |
| 254 <td><a href="#Editor.__initContextMenu">__initContextMenu</a></td> | |
| 255 <td>Private method used to setup the context menu</td> | |
| 256 </tr><tr> | |
| 257 <td><a href="#Editor.__initContextMenuAutocompletion">__initContextMenuAutocompletion</a></td> | |
| 258 <td>Private method used to setup the Checks context sub menu.</td> | |
| 259 </tr><tr> | |
| 260 <td><a href="#Editor.__initContextMenuChecks">__initContextMenuChecks</a></td> | |
| 261 <td>Private method used to setup the Checks context sub menu.</td> | |
| 262 </tr><tr> | |
| 263 <td><a href="#Editor.__initContextMenuEncodings">__initContextMenuEncodings</a></td> | |
| 264 <td>Private method used to setup the Encodings context sub menu.</td> | |
| 265 </tr><tr> | |
| 266 <td><a href="#Editor.__initContextMenuEol">__initContextMenuEol</a></td> | |
| 267 <td>Private method to setup the eol context sub menu.</td> | |
| 268 </tr><tr> | |
| 269 <td><a href="#Editor.__initContextMenuExporters">__initContextMenuExporters</a></td> | |
| 270 <td>Private method used to setup the Exporters context sub menu.</td> | |
| 271 </tr><tr> | |
| 272 <td><a href="#Editor.__initContextMenuGraphics">__initContextMenuGraphics</a></td> | |
| 273 <td>Private method used to setup the diagrams context sub menu.</td> | |
| 274 </tr><tr> | |
| 275 <td><a href="#Editor.__initContextMenuLanguages">__initContextMenuLanguages</a></td> | |
| 276 <td>Private method used to setup the Languages context sub menu.</td> | |
| 277 </tr><tr> | |
| 278 <td><a href="#Editor.__initContextMenuMargins">__initContextMenuMargins</a></td> | |
| 279 <td>Private method used to setup the context menu for the margins</td> | |
| 280 </tr><tr> | |
| 281 <td><a href="#Editor.__initContextMenuResources">__initContextMenuResources</a></td> | |
| 282 <td>Private method used to setup the Resources context sub menu.</td> | |
| 283 </tr><tr> | |
| 284 <td><a href="#Editor.__initContextMenuSeparateMargins">__initContextMenuSeparateMargins</a></td> | |
| 285 <td>Private method used to setup the context menu for the separated margins</td> | |
| 286 </tr><tr> | |
| 287 <td><a href="#Editor.__initContextMenuShow">__initContextMenuShow</a></td> | |
| 288 <td>Private method used to setup the Show context sub menu.</td> | |
| 289 </tr><tr> | |
| 290 <td><a href="#Editor.__initContextMenuUnifiedMargins">__initContextMenuUnifiedMargins</a></td> | |
| 291 <td>Private method used to setup the context menu for the unified margins</td> | |
| 292 </tr><tr> | |
| 293 <td><a href="#Editor.__isStartChar">__isStartChar</a></td> | |
| 294 <td>Private method to check, if a character is an autocompletion start character.</td> | |
| 295 </tr><tr> | |
| 296 <td><a href="#Editor.__languageMenuTriggered">__languageMenuTriggered</a></td> | |
| 297 <td>Private method to handle the selection of a lexer language.</td> | |
| 298 </tr><tr> | |
| 299 <td><a href="#Editor.__linesChanged">__linesChanged</a></td> | |
| 300 <td>Private method to track text changes.</td> | |
| 301 </tr><tr> | |
| 302 <td><a href="#Editor.__lmBbookmarks">__lmBbookmarks</a></td> | |
| 303 <td>Private method to handle the 'LMB toggles bookmark' context menu action.</td> | |
| 304 </tr><tr> | |
| 305 <td><a href="#Editor.__lmBbreakpoints">__lmBbreakpoints</a></td> | |
| 306 <td>Private method to handle the 'LMB toggles breakpoint' context menu action.</td> | |
| 307 </tr><tr> | |
| 308 <td><a href="#Editor.__marginClicked">__marginClicked</a></td> | |
| 309 <td>Private slot to handle the marginClicked signal.</td> | |
| 310 </tr><tr> | |
| 311 <td><a href="#Editor.__marginNumber">__marginNumber</a></td> | |
| 312 <td>Private method to calculate the margin number based on a x position.</td> | |
| 313 </tr><tr> | |
| 314 <td><a href="#Editor.__markOccurrences">__markOccurrences</a></td> | |
| 315 <td>Private method to mark all occurrences of the current word.</td> | |
| 316 </tr><tr> | |
| 317 <td><a href="#Editor.__menuClearBreakpoints">__menuClearBreakpoints</a></td> | |
| 318 <td>Private slot to handle the 'Clear all breakpoints' context menu action.</td> | |
| 319 </tr><tr> | |
| 320 <td><a href="#Editor.__menuToggleBreakpointEnabled">__menuToggleBreakpointEnabled</a></td> | |
| 321 <td>Private slot to handle the 'Enable/Disable breakpoint' context menu action.</td> | |
| 322 </tr><tr> | |
| 323 <td><a href="#Editor.__menuToggleTemporaryBreakpoint">__menuToggleTemporaryBreakpoint</a></td> | |
| 324 <td>Private slot to handle the 'Toggle temporary breakpoint' context menu action.</td> | |
| 325 </tr><tr> | |
| 326 <td><a href="#Editor.__modificationChanged">__modificationChanged</a></td> | |
| 327 <td>Private slot to handle the modificationChanged signal.</td> | |
| 328 </tr><tr> | |
| 329 <td><a href="#Editor.__modificationReadOnly">__modificationReadOnly</a></td> | |
| 330 <td>Private slot to handle the modificationAttempted signal.</td> | |
| 331 </tr><tr> | |
| 332 <td><a href="#Editor.__newView">__newView</a></td> | |
| 333 <td>Private slot to create a new view to an open document.</td> | |
| 334 </tr><tr> | |
| 335 <td><a href="#Editor.__newViewNewSplit">__newViewNewSplit</a></td> | |
| 336 <td>Private slot to create a new view to an open document.</td> | |
| 337 </tr><tr> | |
| 338 <td><a href="#Editor.__normalizedEncoding">__normalizedEncoding</a></td> | |
| 339 <td>Private method to calculate the normalized encoding string.</td> | |
| 340 </tr><tr> | |
| 341 <td><a href="#Editor.__printPreview">__printPreview</a></td> | |
| 342 <td>Private slot to generate a print preview.</td> | |
| 343 </tr><tr> | |
| 344 <td><a href="#Editor.__projectPropertiesChanged">__projectPropertiesChanged</a></td> | |
| 345 <td>Private slot to handle changes of the project properties.</td> | |
| 346 </tr><tr> | |
| 347 <td><a href="#Editor.__registerImages">__registerImages</a></td> | |
| 348 <td>Private method to register images for autocompletion lists.</td> | |
| 349 </tr><tr> | |
| 350 <td><a href="#Editor.__removeFromSpellingDictionary">__removeFromSpellingDictionary</a></td> | |
| 351 <td>Private slot to remove the word below the context menu to the dictionary.</td> | |
| 352 </tr><tr> | |
| 353 <td><a href="#Editor.__removeTrailingWhitespace">__removeTrailingWhitespace</a></td> | |
| 354 <td>Private method to remove trailing whitespace.</td> | |
| 355 </tr><tr> | |
| 356 <td><a href="#Editor.__resetLanguage">__resetLanguage</a></td> | |
| 357 <td>Private method used to reset the language selection.</td> | |
| 358 </tr><tr> | |
| 359 <td><a href="#Editor.__restoreBreakpoints">__restoreBreakpoints</a></td> | |
| 360 <td>Private method to restore the breakpoints.</td> | |
| 361 </tr><tr> | |
| 362 <td><a href="#Editor.__selectAll">__selectAll</a></td> | |
| 363 <td>Private slot handling the select all context menu action.</td> | |
| 364 </tr><tr> | |
| 365 <td><a href="#Editor.__selectPygmentsLexer">__selectPygmentsLexer</a></td> | |
| 366 <td>Private method to select a specific pygments lexer.</td> | |
| 367 </tr><tr> | |
| 368 <td><a href="#Editor.__setAutoCompletion">__setAutoCompletion</a></td> | |
| 369 <td>Private method to configure the autocompletion function.</td> | |
| 370 </tr><tr> | |
| 371 <td><a href="#Editor.__setCallTips">__setCallTips</a></td> | |
| 372 <td>Private method to configure the calltips function.</td> | |
| 373 </tr><tr> | |
| 374 <td><a href="#Editor.__setEolMode">__setEolMode</a></td> | |
| 375 <td>Private method to configure the eol mode of the editor.</td> | |
| 376 </tr><tr> | |
| 377 <td><a href="#Editor.__setLineMarkerColours">__setLineMarkerColours</a></td> | |
| 378 <td>Private method to set the line marker colours.</td> | |
| 379 </tr><tr> | |
| 380 <td><a href="#Editor.__setMarginsDisplay">__setMarginsDisplay</a></td> | |
| 381 <td>Private method to configure margins 0 and 2.</td> | |
| 382 </tr><tr> | |
| 383 <td><a href="#Editor.__setSpelling">__setSpelling</a></td> | |
| 384 <td>Private method to initialize the spell checking functionality.</td> | |
| 385 </tr><tr> | |
| 386 <td><a href="#Editor.__setSpellingLanguage">__setSpellingLanguage</a></td> | |
| 387 <td>Private slot to set the spell checking language.</td> | |
| 388 </tr><tr> | |
| 389 <td><a href="#Editor.__setTextDisplay">__setTextDisplay</a></td> | |
| 390 <td>Private method to configure the text display.</td> | |
| 391 </tr><tr> | |
| 392 <td><a href="#Editor.__showApplicationDiagram">__showApplicationDiagram</a></td> | |
| 393 <td>Private method to handle the Imports Diagram context menu action.</td> | |
| 394 </tr><tr> | |
| 395 <td><a href="#Editor.__showClassDiagram">__showClassDiagram</a></td> | |
| 396 <td>Private method to handle the Class Diagram context menu action.</td> | |
| 397 </tr><tr> | |
| 398 <td><a href="#Editor.__showCodeCoverage">__showCodeCoverage</a></td> | |
| 399 <td>Private method to handle the code coverage context menu action.</td> | |
| 400 </tr><tr> | |
| 401 <td><a href="#Editor.__showCodeMetrics">__showCodeMetrics</a></td> | |
| 402 <td>Private method to handle the code metrics context menu action.</td> | |
| 403 </tr><tr> | |
| 404 <td><a href="#Editor.__showContextMenu">__showContextMenu</a></td> | |
| 405 <td>Private slot handling the aboutToShow signal of the context menu.</td> | |
| 406 </tr><tr> | |
| 407 <td><a href="#Editor.__showContextMenuAutocompletion">__showContextMenuAutocompletion</a></td> | |
| 408 <td>Private slot called before the autocompletion menu is shown.</td> | |
| 409 </tr><tr> | |
| 410 <td><a href="#Editor.__showContextMenuChecks">__showContextMenuChecks</a></td> | |
| 411 <td>Private slot handling the aboutToShow signal of the checks context menu.</td> | |
| 412 </tr><tr> | |
| 413 <td><a href="#Editor.__showContextMenuEncodings">__showContextMenuEncodings</a></td> | |
| 414 <td>Private slot handling the aboutToShow signal of the encodings context menu.</td> | |
| 415 </tr><tr> | |
| 416 <td><a href="#Editor.__showContextMenuEol">__showContextMenuEol</a></td> | |
| 417 <td>Private slot handling the aboutToShow signal of the eol context menu.</td> | |
| 418 </tr><tr> | |
| 419 <td><a href="#Editor.__showContextMenuGraphics">__showContextMenuGraphics</a></td> | |
| 420 <td>Private slot handling the aboutToShow signal of the diagrams context menu.</td> | |
| 421 </tr><tr> | |
| 422 <td><a href="#Editor.__showContextMenuLanguages">__showContextMenuLanguages</a></td> | |
| 423 <td>Private slot handling the aboutToShow signal of the languages context menu.</td> | |
| 424 </tr><tr> | |
| 425 <td><a href="#Editor.__showContextMenuMargin">__showContextMenuMargin</a></td> | |
| 426 <td>Private slot handling the aboutToShow signal of the margins context menu.</td> | |
| 427 </tr><tr> | |
| 428 <td><a href="#Editor.__showContextMenuResources">__showContextMenuResources</a></td> | |
| 429 <td>Private slot handling the aboutToShow signal of the resources context menu.</td> | |
| 430 </tr><tr> | |
| 431 <td><a href="#Editor.__showContextMenuShow">__showContextMenuShow</a></td> | |
| 432 <td>Private slot called before the show menu is shown.</td> | |
| 433 </tr><tr> | |
| 434 <td><a href="#Editor.__showContextMenuSpelling">__showContextMenuSpelling</a></td> | |
| 435 <td>Private slot to set up the spelling menu before it is shown.</td> | |
| 436 </tr><tr> | |
| 437 <td><a href="#Editor.__showImportsDiagram">__showImportsDiagram</a></td> | |
| 438 <td>Private method to handle the Imports Diagram context menu action.</td> | |
| 439 </tr><tr> | |
| 440 <td><a href="#Editor.__showPackageDiagram">__showPackageDiagram</a></td> | |
| 441 <td>Private method to handle the Package Diagram context menu action.</td> | |
| 442 </tr><tr> | |
| 443 <td><a href="#Editor.__showProfileData">__showProfileData</a></td> | |
| 444 <td>Private method to handle the show profile data context menu action.</td> | |
| 445 </tr><tr> | |
| 446 <td><a href="#Editor.__showSyntaxError">__showSyntaxError</a></td> | |
| 447 <td>Private slot to handle the 'Show syntax error message' context menu action.</td> | |
| 448 </tr><tr> | |
| 449 <td><a href="#Editor.__spellCharAdded">__spellCharAdded</a></td> | |
| 450 <td>Public slot called to handle the user entering a character.</td> | |
| 451 </tr><tr> | |
| 452 <td><a href="#Editor.__styleNeeded">__styleNeeded</a></td> | |
| 453 <td>Private slot to handle the need for more styling.</td> | |
| 454 </tr><tr> | |
| 455 <td><a href="#Editor.__toggleAutoCompletionEnable">__toggleAutoCompletionEnable</a></td> | |
| 456 <td>Private slot to handle the Enable Autocompletion context menu entry.</td> | |
| 457 </tr><tr> | |
| 458 <td><a href="#Editor.__toggleBreakpoint">__toggleBreakpoint</a></td> | |
| 459 <td>Private method to toggle a breakpoint.</td> | |
| 460 </tr><tr> | |
| 461 <td><a href="#Editor.__toggleBreakpointEnabled">__toggleBreakpointEnabled</a></td> | |
| 462 <td>Private method to toggle a breakpoints enabled status.</td> | |
| 463 </tr><tr> | |
| 464 <td><a href="#Editor.__toggleTypingAids">__toggleTypingAids</a></td> | |
| 465 <td>Private slot to toggle the typing aids.</td> | |
| 466 </tr><tr> | |
| 467 <td><a href="#Editor.__updateReadOnly">__updateReadOnly</a></td> | |
| 468 <td>Private method to update the readOnly information for this editor.</td> | |
| 469 </tr><tr> | |
| 470 <td><a href="#Editor.addClone">addClone</a></td> | |
| 471 <td>Public method to add a clone to our list.</td> | |
| 472 </tr><tr> | |
| 473 <td><a href="#Editor.addedToProject">addedToProject</a></td> | |
| 474 <td>Public method to signal, that this editor has been added to a project.</td> | |
| 475 </tr><tr> | |
| 476 <td><a href="#Editor.autoComplete">autoComplete</a></td> | |
| 477 <td>Public method to start autocompletion.</td> | |
| 478 </tr><tr> | |
| 479 <td><a href="#Editor.autoCompleteQScintilla">autoCompleteQScintilla</a></td> | |
| 480 <td>Public method to perform an autocompletion using QScintilla methods.</td> | |
| 481 </tr><tr> | |
| 482 <td><a href="#Editor.autoCompletionHook">autoCompletionHook</a></td> | |
| 483 <td>Public method to get the autocompletion hook function.</td> | |
| 484 </tr><tr> | |
| 485 <td><a href="#Editor.boxCommentLine">boxCommentLine</a></td> | |
| 486 <td>Public slot to box comment the current line.</td> | |
| 487 </tr><tr> | |
| 488 <td><a href="#Editor.boxCommentLineOrSelection">boxCommentLineOrSelection</a></td> | |
| 489 <td>Public slot to box comment the current line or current selection.</td> | |
| 490 </tr><tr> | |
| 491 <td><a href="#Editor.boxCommentSelection">boxCommentSelection</a></td> | |
| 492 <td>Public slot to box comment the current selection.</td> | |
| 493 </tr><tr> | |
| 494 <td><a href="#Editor.callTip">callTip</a></td> | |
| 495 <td>Public method to show calltips.</td> | |
| 496 </tr><tr> | |
| 497 <td><a href="#Editor.callTipHook">callTipHook</a></td> | |
| 498 <td>Public method to get the calltip hook function.</td> | |
| 499 </tr><tr> | |
| 500 <td><a href="#Editor.canAutoCompleteFromAPIs">canAutoCompleteFromAPIs</a></td> | |
| 501 <td>Public method to check for API availablity.</td> | |
| 502 </tr><tr> | |
| 503 <td><a href="#Editor.changeEvent">changeEvent</a></td> | |
| 504 <td>Protected method called to process an event.</td> | |
| 505 </tr><tr> | |
| 506 <td><a href="#Editor.checkDirty">checkDirty</a></td> | |
| 507 <td>Public method to check dirty status and open a message window.</td> | |
| 508 </tr><tr> | |
| 509 <td><a href="#Editor.checkSpelling">checkSpelling</a></td> | |
| 510 <td>Public slot to perform an interactive spell check of the document.</td> | |
| 511 </tr><tr> | |
| 512 <td><a href="#Editor.clearBookmarks">clearBookmarks</a></td> | |
| 513 <td>Public slot to handle the 'Clear all bookmarks' context menu action.</td> | |
| 514 </tr><tr> | |
| 515 <td><a href="#Editor.clearBreakpoint">clearBreakpoint</a></td> | |
| 516 <td>Public method to clear a breakpoint.</td> | |
| 517 </tr><tr> | |
| 518 <td><a href="#Editor.clearSearchIndicators">clearSearchIndicators</a></td> | |
| 519 <td>Public method to clear all search indicators.</td> | |
| 520 </tr><tr> | |
| 521 <td><a href="#Editor.clearSyntaxError">clearSyntaxError</a></td> | |
| 522 <td>Public slot to handle the 'Clear all syntax error' context menu action.</td> | |
| 523 </tr><tr> | |
| 524 <td><a href="#Editor.close">close</a></td> | |
| 525 <td>Public method called when the window gets closed.</td> | |
| 526 </tr><tr> | |
| 527 <td><a href="#Editor.closeIt">closeIt</a></td> | |
| 528 <td>Public method called by the viewmanager to finally get rid of us.</td> | |
| 529 </tr><tr> | |
| 530 <td><a href="#Editor.commentLine">commentLine</a></td> | |
| 531 <td>Public slot to comment the current line.</td> | |
| 532 </tr><tr> | |
| 533 <td><a href="#Editor.commentLineOrSelection">commentLineOrSelection</a></td> | |
| 534 <td>Public slot to comment the current line or current selection.</td> | |
| 535 </tr><tr> | |
| 536 <td><a href="#Editor.commentSelection">commentSelection</a></td> | |
| 537 <td>Public slot to comment the current selection.</td> | |
| 538 </tr><tr> | |
| 539 <td><a href="#Editor.contextMenuEvent">contextMenuEvent</a></td> | |
| 540 <td>Private method implementing the context menu event.</td> | |
| 541 </tr><tr> | |
| 542 <td><a href="#Editor.curLineHasBreakpoint">curLineHasBreakpoint</a></td> | |
| 543 <td>Public method to check for the presence of a breakpoint at the current line.</td> | |
| 544 </tr><tr> | |
| 545 <td><a href="#Editor.dragEnterEvent">dragEnterEvent</a></td> | |
| 546 <td>Protected method to handle the drag enter event.</td> | |
| 547 </tr><tr> | |
| 548 <td><a href="#Editor.dragLeaveEvent">dragLeaveEvent</a></td> | |
| 549 <td>Protected method to handle the drag leave event.</td> | |
| 550 </tr><tr> | |
| 551 <td><a href="#Editor.dragMoveEvent">dragMoveEvent</a></td> | |
| 552 <td>Protected method to handle the drag move event.</td> | |
| 553 </tr><tr> | |
| 554 <td><a href="#Editor.dropEvent">dropEvent</a></td> | |
| 555 <td>Protected method to handle the drop event.</td> | |
| 556 </tr><tr> | |
| 557 <td><a href="#Editor.editorCommand">editorCommand</a></td> | |
| 558 <td>Public method to perform a simple editor command.</td> | |
| 559 </tr><tr> | |
| 560 <td><a href="#Editor.ensureVisible">ensureVisible</a></td> | |
| 561 <td>Public slot to ensure, that the specified line is visible.</td> | |
| 562 </tr><tr> | |
| 563 <td><a href="#Editor.ensureVisibleTop">ensureVisibleTop</a></td> | |
| 564 <td>Public slot to ensure, that the specified line is visible at the top of the editor.</td> | |
| 565 </tr><tr> | |
| 566 <td><a href="#Editor.exportFile">exportFile</a></td> | |
| 567 <td>Public method to export the file.</td> | |
| 568 </tr><tr> | |
| 569 <td><a href="#Editor.extractTasks">extractTasks</a></td> | |
| 570 <td>Public slot to extract all tasks.</td> | |
| 571 </tr><tr> | |
| 572 <td><a href="#Editor.fileRenamed">fileRenamed</a></td> | |
| 573 <td>Public slot to handle the editorRenamed signal.</td> | |
| 574 </tr><tr> | |
| 575 <td><a href="#Editor.focusInEvent">focusInEvent</a></td> | |
| 576 <td>Protected method called when the editor receives focus.</td> | |
| 577 </tr><tr> | |
| 578 <td><a href="#Editor.focusOutEvent">focusOutEvent</a></td> | |
| 579 <td>Public method called when the editor loses focus.</td> | |
| 580 </tr><tr> | |
| 581 <td><a href="#Editor.getBookmarks">getBookmarks</a></td> | |
| 582 <td>Public method to retrieve the bookmarks.</td> | |
| 583 </tr><tr> | |
| 584 <td><a href="#Editor.getCompleter">getCompleter</a></td> | |
| 585 <td>Public method to retrieve a reference to the completer object.</td> | |
| 586 </tr><tr> | |
| 587 <td><a href="#Editor.getCurrentWord">getCurrentWord</a></td> | |
| 588 <td>Public method to get the word at the current position.</td> | |
| 589 </tr><tr> | |
| 590 <td><a href="#Editor.getEncoding">getEncoding</a></td> | |
| 591 <td>Public method to return the current encoding.</td> | |
| 592 </tr><tr> | |
| 593 <td><a href="#Editor.getFileName">getFileName</a></td> | |
| 594 <td>Public method to return the name of the file being displayed.</td> | |
| 595 </tr><tr> | |
| 596 <td><a href="#Editor.getFileType">getFileType</a></td> | |
| 597 <td>Public method to return the type of the file being displayed.</td> | |
| 598 </tr><tr> | |
| 599 <td><a href="#Editor.getFolds">getFolds</a></td> | |
| 600 <td>Public method to get a list line numbers of collapsed folds.</td> | |
| 601 </tr><tr> | |
| 602 <td><a href="#Editor.getHighlightPosition">getHighlightPosition</a></td> | |
| 603 <td>Public method to return the position of the highlight bar.</td> | |
| 604 </tr><tr> | |
| 605 <td><a href="#Editor.getLanguage">getLanguage</a></td> | |
| 606 <td>Public method to retrieve the language of the editor.</td> | |
| 607 </tr><tr> | |
| 608 <td><a href="#Editor.getLexer">getLexer</a></td> | |
| 609 <td>Public method to retrieve a reference to the lexer object.</td> | |
| 610 </tr><tr> | |
| 611 <td><a href="#Editor.getMenu">getMenu</a></td> | |
| 612 <td>Public method to get a reference to the main context menu or a submenu.</td> | |
| 613 </tr><tr> | |
| 614 <td><a href="#Editor.getNoName">getNoName</a></td> | |
| 615 <td>Public method to get the display string for an unnamed editor.</td> | |
| 616 </tr><tr> | |
| 617 <td><a href="#Editor.getSearchText">getSearchText</a></td> | |
| 618 <td>Public method to determine the selection or the current word for the next search operation.</td> | |
| 619 </tr><tr> | |
| 620 <td><a href="#Editor.getSyntaxErrors">getSyntaxErrors</a></td> | |
| 621 <td>Public method to retrieve the syntax error markers.</td> | |
| 622 </tr><tr> | |
| 623 <td><a href="#Editor.getWord">getWord</a></td> | |
| 624 <td>Public method to get the word at a position.</td> | |
| 625 </tr><tr> | |
| 626 <td><a href="#Editor.getWordBoundaries">getWordBoundaries</a></td> | |
| 627 <td>Public method to get the word boundaries at a position.</td> | |
| 628 </tr><tr> | |
| 629 <td><a href="#Editor.getWordLeft">getWordLeft</a></td> | |
| 630 <td>Public method to get the word to the left of a position.</td> | |
| 631 </tr><tr> | |
| 632 <td><a href="#Editor.getWordRight">getWordRight</a></td> | |
| 633 <td>Public method to get the word to the right of a position.</td> | |
| 634 </tr><tr> | |
| 635 <td><a href="#Editor.gotoLine">gotoLine</a></td> | |
| 636 <td>Public slot to jump to the beginning of a line.</td> | |
| 637 </tr><tr> | |
| 638 <td><a href="#Editor.gotoSyntaxError">gotoSyntaxError</a></td> | |
| 639 <td>Public slot to handle the 'Goto syntax error' context menu action.</td> | |
| 640 </tr><tr> | |
| 641 <td><a href="#Editor.handleMonospacedEnable">handleMonospacedEnable</a></td> | |
| 642 <td>Private slot to handle the Use Monospaced Font context menu entry.</td> | |
| 643 </tr><tr> | |
| 644 <td><a href="#Editor.handleRenamed">handleRenamed</a></td> | |
| 645 <td>Public slot to handle the editorRenamed signal.</td> | |
| 646 </tr><tr> | |
| 647 <td><a href="#Editor.hasBookmarks">hasBookmarks</a></td> | |
| 648 <td>Public method to check for the presence of bookmarks.</td> | |
| 649 </tr><tr> | |
| 650 <td><a href="#Editor.hasBreakpoints">hasBreakpoints</a></td> | |
| 651 <td>Public method to check for the presence of breakpoints.</td> | |
| 652 </tr><tr> | |
| 653 <td><a href="#Editor.hasCoverageMarkers">hasCoverageMarkers</a></td> | |
| 654 <td>Public method to test, if there are coverage markers.</td> | |
| 655 </tr><tr> | |
| 656 <td><a href="#Editor.hasMiniMenu">hasMiniMenu</a></td> | |
| 657 <td>Public method to check the miniMenu flag.</td> | |
| 658 </tr><tr> | |
| 659 <td><a href="#Editor.hasSyntaxErrors">hasSyntaxErrors</a></td> | |
| 660 <td>Public method to check for the presence of bookmarks.</td> | |
| 661 </tr><tr> | |
| 662 <td><a href="#Editor.hasTaskMarkers">hasTaskMarkers</a></td> | |
| 663 <td>Public method to determine, if this editor contains any task markers.</td> | |
| 664 </tr><tr> | |
| 665 <td><a href="#Editor.highlight">highlight</a></td> | |
| 666 <td>Public method to highlight (or de-highlight) a particular line.</td> | |
| 667 </tr><tr> | |
| 668 <td><a href="#Editor.highlightVisible">highlightVisible</a></td> | |
| 669 <td>Public method to make sure that the highlight is visible.</td> | |
| 670 </tr><tr> | |
| 671 <td><a href="#Editor.indentLineOrSelection">indentLineOrSelection</a></td> | |
| 672 <td>Public slot to indent the current line or current selection</td> | |
| 673 </tr><tr> | |
| 674 <td><a href="#Editor.isPy3File">isPy3File</a></td> | |
| 675 <td>Public method to return a flag indicating a Python3 file.</td> | |
| 676 </tr><tr> | |
| 677 <td><a href="#Editor.isPyFile">isPyFile</a></td> | |
| 678 <td>Public method to return a flag indicating a Python file.</td> | |
| 679 </tr><tr> | |
| 680 <td><a href="#Editor.isRubyFile">isRubyFile</a></td> | |
| 681 <td>Public method to return a flag indicating a Ruby file.</td> | |
| 682 </tr><tr> | |
| 683 <td><a href="#Editor.isSpellCheckRegion">isSpellCheckRegion</a></td> | |
| 684 <td>Public method to check, if the given position is within a region, that should be spell checked.</td> | |
| 685 </tr><tr> | |
| 686 <td><a href="#Editor.keyPressEvent">keyPressEvent</a></td> | |
| 687 <td>Re-implemented to handle the user input a key at a time.</td> | |
| 688 </tr><tr> | |
| 689 <td><a href="#Editor.languageChanged">languageChanged</a></td> | |
| 690 <td>Public slot handling a change of a connected editor's language.</td> | |
| 691 </tr><tr> | |
| 692 <td><a href="#Editor.macroDelete">macroDelete</a></td> | |
| 693 <td>Public method to delete a macro.</td> | |
| 694 </tr><tr> | |
| 695 <td><a href="#Editor.macroLoad">macroLoad</a></td> | |
| 696 <td>Public method to load a macro from a file.</td> | |
| 697 </tr><tr> | |
| 698 <td><a href="#Editor.macroRecordingStart">macroRecordingStart</a></td> | |
| 699 <td>Public method to start macro recording.</td> | |
| 700 </tr><tr> | |
| 701 <td><a href="#Editor.macroRecordingStop">macroRecordingStop</a></td> | |
| 702 <td>Public method to stop macro recording.</td> | |
| 703 </tr><tr> | |
| 704 <td><a href="#Editor.macroRun">macroRun</a></td> | |
| 705 <td>Public method to execute a macro.</td> | |
| 706 </tr><tr> | |
| 707 <td><a href="#Editor.macroSave">macroSave</a></td> | |
| 708 <td>Public method to save a macro to a file.</td> | |
| 709 </tr><tr> | |
| 710 <td><a href="#Editor.menuEditBreakpoint">menuEditBreakpoint</a></td> | |
| 711 <td>Public slot to handle the 'Edit breakpoint' context menu action.</td> | |
| 712 </tr><tr> | |
| 713 <td><a href="#Editor.menuNextBreakpoint">menuNextBreakpoint</a></td> | |
| 714 <td>Public slot to handle the 'Next breakpoint' context menu action.</td> | |
| 715 </tr><tr> | |
| 716 <td><a href="#Editor.menuPreviousBreakpoint">menuPreviousBreakpoint</a></td> | |
| 717 <td>Public slot to handle the 'Previous breakpoint' context menu action.</td> | |
| 718 </tr><tr> | |
| 719 <td><a href="#Editor.menuToggleBookmark">menuToggleBookmark</a></td> | |
| 720 <td>Public slot to handle the 'Toggle bookmark' context menu action.</td> | |
| 721 </tr><tr> | |
| 722 <td><a href="#Editor.menuToggleBreakpoint">menuToggleBreakpoint</a></td> | |
| 723 <td>Public slot to handle the 'Toggle breakpoint' context menu action.</td> | |
| 724 </tr><tr> | |
| 725 <td><a href="#Editor.mousePressEvent">mousePressEvent</a></td> | |
| 726 <td>Protected method to handle the mouse press event.</td> | |
| 727 </tr><tr> | |
| 728 <td><a href="#Editor.newBreakpointWithProperties">newBreakpointWithProperties</a></td> | |
| 729 <td>Private method to set a new breakpoint and its properties.</td> | |
| 730 </tr><tr> | |
| 731 <td><a href="#Editor.nextBookmark">nextBookmark</a></td> | |
| 732 <td>Public slot to handle the 'Next bookmark' context menu action.</td> | |
| 733 </tr><tr> | |
| 734 <td><a href="#Editor.nextTask">nextTask</a></td> | |
| 735 <td>Public slot to handle the 'Next task' context menu action.</td> | |
| 736 </tr><tr> | |
| 737 <td><a href="#Editor.nextUncovered">nextUncovered</a></td> | |
| 738 <td>Public slot to handle the 'Next uncovered' context menu action.</td> | |
| 739 </tr><tr> | |
| 740 <td><a href="#Editor.previousBookmark">previousBookmark</a></td> | |
| 741 <td>Public slot to handle the 'Previous bookmark' context menu action.</td> | |
| 742 </tr><tr> | |
| 743 <td><a href="#Editor.previousTask">previousTask</a></td> | |
| 744 <td>Public slot to handle the 'Previous task' context menu action.</td> | |
| 745 </tr><tr> | |
| 746 <td><a href="#Editor.previousUncovered">previousUncovered</a></td> | |
| 747 <td>Public slot to handle the 'Previous uncovered' context menu action.</td> | |
| 748 </tr><tr> | |
| 749 <td><a href="#Editor.printFile">printFile</a></td> | |
| 750 <td>Public slot to print the text.</td> | |
| 751 </tr><tr> | |
| 752 <td><a href="#Editor.printPreviewFile">printPreviewFile</a></td> | |
| 753 <td>Public slot to show a print preview of the text.</td> | |
| 754 </tr><tr> | |
| 755 <td><a href="#Editor.projectLexerAssociationsChanged">projectLexerAssociationsChanged</a></td> | |
| 756 <td>Public slot to handle changes of the project lexer associations.</td> | |
| 757 </tr><tr> | |
| 758 <td><a href="#Editor.readFile">readFile</a></td> | |
| 759 <td>Public slot to read the text from a file.</td> | |
| 760 </tr><tr> | |
| 761 <td><a href="#Editor.readLine0">readLine0</a></td> | |
| 762 <td>Public slot to read the first line from a file.</td> | |
| 763 </tr><tr> | |
| 764 <td><a href="#Editor.readSettings">readSettings</a></td> | |
| 765 <td>Public slot to read the settings into our lexer.</td> | |
| 766 </tr><tr> | |
| 767 <td><a href="#Editor.redo">redo</a></td> | |
| 768 <td>Public method to redo the last recorded change.</td> | |
| 769 </tr><tr> | |
| 770 <td><a href="#Editor.refresh">refresh</a></td> | |
| 771 <td>Public slot to refresh the editor contents.</td> | |
| 772 </tr><tr> | |
| 773 <td><a href="#Editor.removeClone">removeClone</a></td> | |
| 774 <td>Public method to remove a clone from our list.</td> | |
| 775 </tr><tr> | |
| 776 <td><a href="#Editor.revertToUnmodified">revertToUnmodified</a></td> | |
| 777 <td>Public method to revert back to the last saved state.</td> | |
| 778 </tr><tr> | |
| 779 <td><a href="#Editor.saveFile">saveFile</a></td> | |
| 780 <td>Public slot to save the text to a file.</td> | |
| 781 </tr><tr> | |
| 782 <td><a href="#Editor.saveFileAs">saveFileAs</a></td> | |
| 783 <td>Public slot to save a file with a new name.</td> | |
| 784 </tr><tr> | |
| 785 <td><a href="#Editor.selectCurrentWord">selectCurrentWord</a></td> | |
| 786 <td>Public method to select the current word.</td> | |
| 787 </tr><tr> | |
| 788 <td><a href="#Editor.selectWord">selectWord</a></td> | |
| 789 <td>Public method to select the word at a position.</td> | |
| 790 </tr><tr> | |
| 791 <td><a href="#Editor.setAutoCompletionEnabled">setAutoCompletionEnabled</a></td> | |
| 792 <td>Public method to enable/disable autocompletion.</td> | |
| 793 </tr><tr> | |
| 794 <td><a href="#Editor.setAutoCompletionHook">setAutoCompletionHook</a></td> | |
| 795 <td>Public method to set an autocompletion hook.</td> | |
| 796 </tr><tr> | |
| 797 <td><a href="#Editor.setAutoSpellChecking">setAutoSpellChecking</a></td> | |
| 798 <td>Public method to set the automatic spell checking.</td> | |
| 799 </tr><tr> | |
| 800 <td><a href="#Editor.setCallTipHook">setCallTipHook</a></td> | |
| 801 <td>Public method to set a calltip hook.</td> | |
| 802 </tr><tr> | |
| 803 <td><a href="#Editor.setEolModeByEolString">setEolModeByEolString</a></td> | |
| 804 <td>Public method to set the eol mode given the eol string.</td> | |
| 805 </tr><tr> | |
| 806 <td><a href="#Editor.setLanguage">setLanguage</a></td> | |
| 807 <td>Public method to set a lexer language.</td> | |
| 808 </tr><tr> | |
| 809 <td><a href="#Editor.setMonospaced">setMonospaced</a></td> | |
| 810 <td>Public method to set/reset a monospaced font.</td> | |
| 811 </tr><tr> | |
| 812 <td><a href="#Editor.setNoName">setNoName</a></td> | |
| 813 <td>Public method to set the display string for an unnamed editor.</td> | |
| 814 </tr><tr> | |
| 815 <td><a href="#Editor.setSearchIndicator">setSearchIndicator</a></td> | |
| 816 <td>Public method to set a search indicator for the given range.</td> | |
| 817 </tr><tr> | |
| 818 <td><a href="#Editor.setSpellingForProject">setSpellingForProject</a></td> | |
| 819 <td>Public method to set the spell checking options for files belonging to the current project.</td> | |
| 820 </tr><tr> | |
| 821 <td><a href="#Editor.shortenEmptyLines">shortenEmptyLines</a></td> | |
| 822 <td>Public slot to compress lines consisting solely of whitespace characters.</td> | |
| 823 </tr><tr> | |
| 824 <td><a href="#Editor.shouldAutosave">shouldAutosave</a></td> | |
| 825 <td>Public slot to check the autosave flags.</td> | |
| 826 </tr><tr> | |
| 827 <td><a href="#Editor.smartIndentLineOrSelection">smartIndentLineOrSelection</a></td> | |
| 828 <td>Public slot to indent current line smartly.</td> | |
| 829 </tr><tr> | |
| 830 <td><a href="#Editor.streamCommentLine">streamCommentLine</a></td> | |
| 831 <td>Public slot to stream comment the current line.</td> | |
| 832 </tr><tr> | |
| 833 <td><a href="#Editor.streamCommentLineOrSelection">streamCommentLineOrSelection</a></td> | |
| 834 <td>Public slot to stream comment the current line or current selection.</td> | |
| 835 </tr><tr> | |
| 836 <td><a href="#Editor.streamCommentSelection">streamCommentSelection</a></td> | |
| 837 <td>Public slot to comment the current selection.</td> | |
| 838 </tr><tr> | |
| 839 <td><a href="#Editor.toggleBookmark">toggleBookmark</a></td> | |
| 840 <td>Public method to toggle a bookmark.</td> | |
| 841 </tr><tr> | |
| 842 <td><a href="#Editor.toggleSyntaxError">toggleSyntaxError</a></td> | |
| 843 <td>Public method to toggle a syntax error indicator.</td> | |
| 844 </tr><tr> | |
| 845 <td><a href="#Editor.uncommentLine">uncommentLine</a></td> | |
| 846 <td>Public slot to uncomment the current line.</td> | |
| 847 </tr><tr> | |
| 848 <td><a href="#Editor.uncommentLineOrSelection">uncommentLineOrSelection</a></td> | |
| 849 <td>Public slot to uncomment the current line or current selection.</td> | |
| 850 </tr><tr> | |
| 851 <td><a href="#Editor.uncommentSelection">uncommentSelection</a></td> | |
| 852 <td>Public slot to uncomment the current selection.</td> | |
| 853 </tr><tr> | |
| 854 <td><a href="#Editor.undo">undo</a></td> | |
| 855 <td>Public method to undo the last recorded change.</td> | |
| 856 </tr><tr> | |
| 857 <td><a href="#Editor.unindentLineOrSelection">unindentLineOrSelection</a></td> | |
| 858 <td>Public slot to unindent the current line or current selection.</td> | |
| 859 </tr><tr> | |
| 860 <td><a href="#Editor.unsetAutoCompletionHook">unsetAutoCompletionHook</a></td> | |
| 861 <td>Public method to unset a previously installed autocompletion hook.</td> | |
| 862 </tr><tr> | |
| 863 <td><a href="#Editor.unsetCallTipHook">unsetCallTipHook</a></td> | |
| 864 <td>Public method to unset a calltip hook.</td> | |
| 865 </tr><tr> | |
| 866 <td><a href="#Editor.writeFile">writeFile</a></td> | |
| 867 <td>Public slot to write the text to a file.</td> | |
| 868 </tr> | |
| 869 </table> | |
| 870 <a NAME="Editor.__init__" ID="Editor.__init__"></a> | |
| 871 <h4>Editor (Constructor)</h4> | |
| 872 <b>Editor</b>(<i>dbs, fn = None, vm = None, filetype = "", editor = None, tv = None</i>) | |
| 873 <p> | |
| 874 Constructor | |
| 875 </p><dl> | |
| 876 <dt><i>dbs</i></dt> | |
| 877 <dd> | |
| 878 reference to the debug server object | |
| 879 </dd><dt><i>fn</i></dt> | |
| 880 <dd> | |
| 881 name of the file to be opened (string). If it is None, | |
| 882 a new (empty) editor is opened | |
| 883 </dd><dt><i>vm</i></dt> | |
| 884 <dd> | |
| 885 reference to the view manager object (ViewManager.ViewManager) | |
| 886 </dd><dt><i>filetype</i></dt> | |
| 887 <dd> | |
| 888 type of the source file (string) | |
| 889 </dd><dt><i>editor</i></dt> | |
| 890 <dd> | |
| 891 reference to an Editor object, if this is a cloned view | |
| 892 </dd><dt><i>tv</i></dt> | |
| 893 <dd> | |
| 894 reference to the task viewer object | |
| 895 </dd> | |
| 896 </dl><a NAME="Editor.__addBreakPoint" ID="Editor.__addBreakPoint"></a> | |
| 897 <h4>Editor.__addBreakPoint</h4> | |
| 898 <b>__addBreakPoint</b>(<i>line, temporary</i>) | |
| 899 <p> | |
| 900 Private method to add a new breakpoint. | |
| 901 </p><dl> | |
| 902 <dt><i>line</i></dt> | |
| 903 <dd> | |
| 904 line number of the breakpoint (integer) | |
| 905 </dd><dt><i>temporary</i></dt> | |
| 906 <dd> | |
| 907 flag indicating a temporary breakpoint (boolean) | |
| 908 </dd> | |
| 909 </dl><a NAME="Editor.__addBreakPoints" ID="Editor.__addBreakPoints"></a> | |
| 910 <h4>Editor.__addBreakPoints</h4> | |
| 911 <b>__addBreakPoints</b>(<i>parentIndex, start, end</i>) | |
| 912 <p> | |
| 913 Private slot to add breakpoints. | |
| 914 </p><dl> | |
| 915 <dt><i>parentIndex</i></dt> | |
| 916 <dd> | |
| 917 index of parent item (QModelIndex) | |
| 918 </dd><dt><i>start</i></dt> | |
| 919 <dd> | |
| 920 start row (integer) | |
| 921 </dd><dt><i>end</i></dt> | |
| 922 <dd> | |
| 923 end row (integer) | |
| 924 </dd> | |
| 925 </dl><a NAME="Editor.__addFileAliasResource" ID="Editor.__addFileAliasResource"></a> | |
| 926 <h4>Editor.__addFileAliasResource</h4> | |
| 927 <b>__addFileAliasResource</b>(<i></i>) | |
| 928 <p> | |
| 929 Private method to handle the Add aliased file context menu action. | |
| 930 </p><a NAME="Editor.__addFileResource" ID="Editor.__addFileResource"></a> | |
| 931 <h4>Editor.__addFileResource</h4> | |
| 932 <b>__addFileResource</b>(<i></i>) | |
| 933 <p> | |
| 934 Private method to handle the Add file context menu action. | |
| 935 </p><a NAME="Editor.__addFileResources" ID="Editor.__addFileResources"></a> | |
| 936 <h4>Editor.__addFileResources</h4> | |
| 937 <b>__addFileResources</b>(<i></i>) | |
| 938 <p> | |
| 939 Private method to handle the Add files context menu action. | |
| 940 </p><a NAME="Editor.__addLocalizedResource" ID="Editor.__addLocalizedResource"></a> | |
| 941 <h4>Editor.__addLocalizedResource</h4> | |
| 942 <b>__addLocalizedResource</b>(<i></i>) | |
| 943 <p> | |
| 944 Private method to handle the Add localized resource context menu action. | |
| 945 </p><a NAME="Editor.__addResourceFrame" ID="Editor.__addResourceFrame"></a> | |
| 946 <h4>Editor.__addResourceFrame</h4> | |
| 947 <b>__addResourceFrame</b>(<i></i>) | |
| 948 <p> | |
| 949 Private method to handle the Add resource frame context menu action. | |
| 950 </p><a NAME="Editor.__addToSpellingDictionary" ID="Editor.__addToSpellingDictionary"></a> | |
| 951 <h4>Editor.__addToSpellingDictionary</h4> | |
| 952 <b>__addToSpellingDictionary</b>(<i></i>) | |
| 953 <p> | |
| 954 Private slot to add the word below the spelling context menu to the dictionary. | |
| 955 </p><a NAME="Editor.__adjustedCallTipPosition" ID="Editor.__adjustedCallTipPosition"></a> | |
| 956 <h4>Editor.__adjustedCallTipPosition</h4> | |
| 957 <b>__adjustedCallTipPosition</b>(<i>ctshift, pos</i>) | |
| 958 <p> | |
| 959 Private method to calculate an adjusted position for showing calltips. | |
| 960 </p><dl> | |
| 961 <dt><i>ctshift</i></dt> | |
| 962 <dd> | |
| 963 amount the calltip shall be shifted (integer) | |
| 964 </dd><dt><i>pos</i></dt> | |
| 965 <dd> | |
| 966 position into the text (integer) | |
| 967 </dd> | |
| 968 </dl><dl> | |
| 969 <dt>Returns:</dt> | |
| 970 <dd> | |
| 971 new position for the calltip (integer) | |
| 972 </dd> | |
| 973 </dl><a NAME="Editor.__applyTemplate" ID="Editor.__applyTemplate"></a> | |
| 974 <h4>Editor.__applyTemplate</h4> | |
| 975 <b>__applyTemplate</b>(<i>templateName</i>) | |
| 976 <p> | |
| 977 Private method to apply a template by name. | |
| 978 </p><dl> | |
| 979 <dt><i>templateName</i></dt> | |
| 980 <dd> | |
| 981 name of the template to apply (string) | |
| 982 </dd> | |
| 983 </dl><a NAME="Editor.__autoSyntaxCheck" ID="Editor.__autoSyntaxCheck"></a> | |
| 984 <h4>Editor.__autoSyntaxCheck</h4> | |
| 985 <b>__autoSyntaxCheck</b>(<i></i>) | |
| 986 <p> | |
| 987 Private method to perform an automatic syntax check of the file. | |
| 988 </p><a NAME="Editor.__autosaveEnable" ID="Editor.__autosaveEnable"></a> | |
| 989 <h4>Editor.__autosaveEnable</h4> | |
| 990 <b>__autosaveEnable</b>(<i></i>) | |
| 991 <p> | |
| 992 Private slot handling the autosave enable context menu action. | |
| 993 </p><a NAME="Editor.__bindCompleter" ID="Editor.__bindCompleter"></a> | |
| 994 <h4>Editor.__bindCompleter</h4> | |
| 995 <b>__bindCompleter</b>(<i>filename</i>) | |
| 996 <p> | |
| 997 Private slot to set the correct typing completer depending on language. | |
| 998 </p><dl> | |
| 999 <dt><i>filename</i></dt> | |
| 1000 <dd> | |
| 1001 filename used to determine the associated typing | |
| 1002 completer language (string) | |
| 1003 </dd> | |
| 1004 </dl><a NAME="Editor.__bindLexer" ID="Editor.__bindLexer"></a> | |
| 1005 <h4>Editor.__bindLexer</h4> | |
| 1006 <b>__bindLexer</b>(<i>filename, pyname = ""</i>) | |
| 1007 <p> | |
| 1008 Private slot to set the correct lexer depending on language. | |
| 1009 </p><dl> | |
| 1010 <dt><i>filename</i></dt> | |
| 1011 <dd> | |
| 1012 filename used to determine the associated lexer language (string) | |
| 1013 </dd><dt><i>pyname=</i></dt> | |
| 1014 <dd> | |
| 1015 name of the pygments lexer to use (string) | |
| 1016 </dd> | |
| 1017 </dl><a NAME="Editor.__bindName" ID="Editor.__bindName"></a> | |
| 1018 <h4>Editor.__bindName</h4> | |
| 1019 <b>__bindName</b>(<i>line0</i>) | |
| 1020 <p> | |
| 1021 Private method to generate a dummy filename for binding a lexer. | |
| 1022 </p><dl> | |
| 1023 <dt><i>line0</i></dt> | |
| 1024 <dd> | |
| 1025 first line of text to use in the generation process (string) | |
| 1026 </dd> | |
| 1027 </dl><a NAME="Editor.__breakPointDataAboutToBeChanged" ID="Editor.__breakPointDataAboutToBeChanged"></a> | |
| 1028 <h4>Editor.__breakPointDataAboutToBeChanged</h4> | |
| 1029 <b>__breakPointDataAboutToBeChanged</b>(<i>startIndex, endIndex</i>) | |
| 1030 <p> | |
| 1031 Private slot to handle the dataAboutToBeChanged signal of the breakpoint model. | |
| 1032 </p><dl> | |
| 1033 <dt><i>startIndex</i></dt> | |
| 1034 <dd> | |
| 1035 start index of the rows to be changed (QModelIndex) | |
| 1036 </dd><dt><i>endIndex</i></dt> | |
| 1037 <dd> | |
| 1038 end index of the rows to be changed (QModelIndex) | |
| 1039 </dd> | |
| 1040 </dl><a NAME="Editor.__callTip" ID="Editor.__callTip"></a> | |
| 1041 <h4>Editor.__callTip</h4> | |
| 1042 <b>__callTip</b>(<i></i>) | |
| 1043 <p> | |
| 1044 Private method to show call tips provided by a plugin. | |
| 1045 </p><a NAME="Editor.__changeBreakPoints" ID="Editor.__changeBreakPoints"></a> | |
| 1046 <h4>Editor.__changeBreakPoints</h4> | |
| 1047 <b>__changeBreakPoints</b>(<i>startIndex, endIndex</i>) | |
| 1048 <p> | |
| 1049 Private slot to set changed breakpoints. | |
| 1050 </p><dl> | |
| 1051 <dt><i>indexes</i></dt> | |
| 1052 <dd> | |
| 1053 indexes of changed breakpoints. | |
| 1054 </dd> | |
| 1055 </dl><a NAME="Editor.__charAdded" ID="Editor.__charAdded"></a> | |
| 1056 <h4>Editor.__charAdded</h4> | |
| 1057 <b>__charAdded</b>(<i>charNumber</i>) | |
| 1058 <p> | |
| 1059 Public slot called to handle the user entering a character. | |
| 1060 </p><dl> | |
| 1061 <dt><i>charNumber</i></dt> | |
| 1062 <dd> | |
| 1063 value of the character entered (integer) | |
| 1064 </dd> | |
| 1065 </dl><a NAME="Editor.__checkEncoding" ID="Editor.__checkEncoding"></a> | |
| 1066 <h4>Editor.__checkEncoding</h4> | |
| 1067 <b>__checkEncoding</b>(<i></i>) | |
| 1068 <p> | |
| 1069 Private method to check the selected encoding of the encodings submenu. | |
| 1070 </p><a NAME="Editor.__checkEol" ID="Editor.__checkEol"></a> | |
| 1071 <h4>Editor.__checkEol</h4> | |
| 1072 <b>__checkEol</b>(<i></i>) | |
| 1073 <p> | |
| 1074 Private method to check the selected eol type of the eol submenu. | |
| 1075 </p><a NAME="Editor.__checkLanguage" ID="Editor.__checkLanguage"></a> | |
| 1076 <h4>Editor.__checkLanguage</h4> | |
| 1077 <b>__checkLanguage</b>(<i></i>) | |
| 1078 <p> | |
| 1079 Private method to check the selected language of the language submenu. | |
| 1080 </p><a NAME="Editor.__checkSpellingSelection" ID="Editor.__checkSpellingSelection"></a> | |
| 1081 <h4>Editor.__checkSpellingSelection</h4> | |
| 1082 <b>__checkSpellingSelection</b>(<i></i>) | |
| 1083 <p> | |
| 1084 Private slot to spell check the current selection. | |
| 1085 </p><a NAME="Editor.__checkSpellingWord" ID="Editor.__checkSpellingWord"></a> | |
| 1086 <h4>Editor.__checkSpellingWord</h4> | |
| 1087 <b>__checkSpellingWord</b>(<i></i>) | |
| 1088 <p> | |
| 1089 Private slot to check the word below the spelling context menu. | |
| 1090 </p><a NAME="Editor.__clearBreakpoints" ID="Editor.__clearBreakpoints"></a> | |
| 1091 <h4>Editor.__clearBreakpoints</h4> | |
| 1092 <b>__clearBreakpoints</b>(<i>fileName</i>) | |
| 1093 <p> | |
| 1094 Private slot to clear all breakpoints. | |
| 1095 </p><a NAME="Editor.__codeCoverageHideAnnotations" ID="Editor.__codeCoverageHideAnnotations"></a> | |
| 1096 <h4>Editor.__codeCoverageHideAnnotations</h4> | |
| 1097 <b>__codeCoverageHideAnnotations</b>(<i></i>) | |
| 1098 <p> | |
| 1099 Private method to handle the hide code coverage annotations context menu action. | |
| 1100 </p><a NAME="Editor.__codeCoverageShowAnnotations" ID="Editor.__codeCoverageShowAnnotations"></a> | |
| 1101 <h4>Editor.__codeCoverageShowAnnotations</h4> | |
| 1102 <b>__codeCoverageShowAnnotations</b>(<i></i>) | |
| 1103 <p> | |
| 1104 Private method to handle the show code coverage annotations context menu action. | |
| 1105 </p><a NAME="Editor.__completionListSelected" ID="Editor.__completionListSelected"></a> | |
| 1106 <h4>Editor.__completionListSelected</h4> | |
| 1107 <b>__completionListSelected</b>(<i>id, txt</i>) | |
| 1108 <p> | |
| 1109 Private slot to handle the selection from the completion list. | |
| 1110 </p><dl> | |
| 1111 <dt><i>id</i></dt> | |
| 1112 <dd> | |
| 1113 the ID of the user list (should be 1) (integer) | |
| 1114 </dd><dt><i>txt</i></dt> | |
| 1115 <dd> | |
| 1116 the selected text (string) | |
| 1117 </dd> | |
| 1118 </dl><a NAME="Editor.__contextClose" ID="Editor.__contextClose"></a> | |
| 1119 <h4>Editor.__contextClose</h4> | |
| 1120 <b>__contextClose</b>(<i></i>) | |
| 1121 <p> | |
| 1122 Private slot handling the close context menu entry. | |
| 1123 </p><a NAME="Editor.__contextMenuSpellingTriggered" ID="Editor.__contextMenuSpellingTriggered"></a> | |
| 1124 <h4>Editor.__contextMenuSpellingTriggered</h4> | |
| 1125 <b>__contextMenuSpellingTriggered</b>(<i>action</i>) | |
| 1126 <p> | |
| 1127 Private slot to handle the selection of a suggestion of the spelling context menu. | |
| 1128 </p><dl> | |
| 1129 <dt><i>action</i></dt> | |
| 1130 <dd> | |
| 1131 reference to the action that was selected (QAction) | |
| 1132 </dd> | |
| 1133 </dl><a NAME="Editor.__contextSave" ID="Editor.__contextSave"></a> | |
| 1134 <h4>Editor.__contextSave</h4> | |
| 1135 <b>__contextSave</b>(<i></i>) | |
| 1136 <p> | |
| 1137 Private slot handling the save context menu entry. | |
| 1138 </p><a NAME="Editor.__contextSaveAs" ID="Editor.__contextSaveAs"></a> | |
| 1139 <h4>Editor.__contextSaveAs</h4> | |
| 1140 <b>__contextSaveAs</b>(<i></i>) | |
| 1141 <p> | |
| 1142 Private slot handling the save as context menu entry. | |
| 1143 </p><a NAME="Editor.__cursorPositionChanged" ID="Editor.__cursorPositionChanged"></a> | |
| 1144 <h4>Editor.__cursorPositionChanged</h4> | |
| 1145 <b>__cursorPositionChanged</b>(<i>line, index</i>) | |
| 1146 <p> | |
| 1147 Private slot to handle the cursorPositionChanged signal. | |
| 1148 </p><p> | |
| 1149 It emits the signal cursorChanged with parameters fileName, | |
| 1150 line and pos. | |
| 1151 </p><dl> | |
| 1152 <dt><i>line</i></dt> | |
| 1153 <dd> | |
| 1154 line number of the cursor | |
| 1155 </dd><dt><i>index</i></dt> | |
| 1156 <dd> | |
| 1157 position in line of the cursor | |
| 1158 </dd> | |
| 1159 </dl><a NAME="Editor.__deleteBreakPoints" ID="Editor.__deleteBreakPoints"></a> | |
| 1160 <h4>Editor.__deleteBreakPoints</h4> | |
| 1161 <b>__deleteBreakPoints</b>(<i>parentIndex, start, end</i>) | |
| 1162 <p> | |
| 1163 Private slot to delete breakpoints. | |
| 1164 </p><dl> | |
| 1165 <dt><i>parentIndex</i></dt> | |
| 1166 <dd> | |
| 1167 index of parent item (QModelIndex) | |
| 1168 </dd><dt><i>start</i></dt> | |
| 1169 <dd> | |
| 1170 start row (integer) | |
| 1171 </dd><dt><i>end</i></dt> | |
| 1172 <dd> | |
| 1173 end row (integer) | |
| 1174 </dd> | |
| 1175 </dl><a NAME="Editor.__deselectAll" ID="Editor.__deselectAll"></a> | |
| 1176 <h4>Editor.__deselectAll</h4> | |
| 1177 <b>__deselectAll</b>(<i></i>) | |
| 1178 <p> | |
| 1179 Private slot handling the deselect all context menu action. | |
| 1180 </p><a NAME="Editor.__encodingChanged" ID="Editor.__encodingChanged"></a> | |
| 1181 <h4>Editor.__encodingChanged</h4> | |
| 1182 <b>__encodingChanged</b>(<i>encoding, propagate = True</i>) | |
| 1183 <p> | |
| 1184 Private slot to handle a change of the encoding. | |
| 1185 </p><dl> | |
| 1186 <dt><i>propagate=</i></dt> | |
| 1187 <dd> | |
| 1188 flag indicating to propagate the change (boolean) | |
| 1189 </dd> | |
| 1190 </dl><a NAME="Editor.__encodingsMenuTriggered" ID="Editor.__encodingsMenuTriggered"></a> | |
| 1191 <h4>Editor.__encodingsMenuTriggered</h4> | |
| 1192 <b>__encodingsMenuTriggered</b>(<i>act</i>) | |
| 1193 <p> | |
| 1194 Private method to handle the selection of an encoding. | |
| 1195 </p><dl> | |
| 1196 <dt><i>act</i></dt> | |
| 1197 <dd> | |
| 1198 reference to the action that was triggered (QAction) | |
| 1199 </dd> | |
| 1200 </dl><a NAME="Editor.__eolChanged" ID="Editor.__eolChanged"></a> | |
| 1201 <h4>Editor.__eolChanged</h4> | |
| 1202 <b>__eolChanged</b>(<i></i>) | |
| 1203 <p> | |
| 1204 Private slot to handle a change of the eol mode. | |
| 1205 </p><a NAME="Editor.__eolMenuTriggered" ID="Editor.__eolMenuTriggered"></a> | |
| 1206 <h4>Editor.__eolMenuTriggered</h4> | |
| 1207 <b>__eolMenuTriggered</b>(<i>act</i>) | |
| 1208 <p> | |
| 1209 Private method to handle the selection of an eol type. | |
| 1210 </p><dl> | |
| 1211 <dt><i>act</i></dt> | |
| 1212 <dd> | |
| 1213 reference to the action that was triggered (QAction) | |
| 1214 </dd> | |
| 1215 </dl><a NAME="Editor.__exportMenuTriggered" ID="Editor.__exportMenuTriggered"></a> | |
| 1216 <h4>Editor.__exportMenuTriggered</h4> | |
| 1217 <b>__exportMenuTriggered</b>(<i>act</i>) | |
| 1218 <p> | |
| 1219 Private method to handle the selection of an export format. | |
| 1220 </p><dl> | |
| 1221 <dt><i>act</i></dt> | |
| 1222 <dd> | |
| 1223 reference to the action that was triggered (QAction) | |
| 1224 </dd> | |
| 1225 </dl><a NAME="Editor.__getCharacter" ID="Editor.__getCharacter"></a> | |
| 1226 <h4>Editor.__getCharacter</h4> | |
| 1227 <b>__getCharacter</b>(<i>pos</i>) | |
| 1228 <p> | |
| 1229 Private method to get the character to the left of the current position | |
| 1230 in the current line. | |
| 1231 </p><dl> | |
| 1232 <dt><i>pos</i></dt> | |
| 1233 <dd> | |
| 1234 position to get character at (integer) | |
| 1235 </dd> | |
| 1236 </dl><dl> | |
| 1237 <dt>Returns:</dt> | |
| 1238 <dd> | |
| 1239 requested character or "", if there are no more (string) and | |
| 1240 the next position (i.e. pos - 1) | |
| 1241 </dd> | |
| 1242 </dl><a NAME="Editor.__getCodeCoverageFile" ID="Editor.__getCodeCoverageFile"></a> | |
| 1243 <h4>Editor.__getCodeCoverageFile</h4> | |
| 1244 <b>__getCodeCoverageFile</b>(<i></i>) | |
| 1245 <p> | |
| 1246 Private method to get the filename of the file containing coverage info. | |
| 1247 </p><dl> | |
| 1248 <dt>Returns:</dt> | |
| 1249 <dd> | |
| 1250 filename of the coverage file (string) | |
| 1251 </dd> | |
| 1252 </dl><a NAME="Editor.__getMacroName" ID="Editor.__getMacroName"></a> | |
| 1253 <h4>Editor.__getMacroName</h4> | |
| 1254 <b>__getMacroName</b>(<i></i>) | |
| 1255 <p> | |
| 1256 Private method to select a macro name from the list of macros. | |
| 1257 </p><dl> | |
| 1258 <dt>Returns:</dt> | |
| 1259 <dd> | |
| 1260 Tuple of macro name and a flag, indicating, if the user pressed ok or | |
| 1261 canceled the operation. (string, boolean) | |
| 1262 </dd> | |
| 1263 </dl><a NAME="Editor.__ignoreSpellingAlways" ID="Editor.__ignoreSpellingAlways"></a> | |
| 1264 <h4>Editor.__ignoreSpellingAlways</h4> | |
| 1265 <b>__ignoreSpellingAlways</b>(<i></i>) | |
| 1266 <p> | |
| 1267 Private to always ignore the word below the spelling context menu. | |
| 1268 </p><a NAME="Editor.__indentLine" ID="Editor.__indentLine"></a> | |
| 1269 <h4>Editor.__indentLine</h4> | |
| 1270 <b>__indentLine</b>(<i>indent = True</i>) | |
| 1271 <p> | |
| 1272 Private method to indent or unindent the current line. | |
| 1273 </p><dl> | |
| 1274 <dt><i>indent</i></dt> | |
| 1275 <dd> | |
| 1276 flag indicating an indent operation (boolean) | |
| 1277 <br />If the flag is true, an indent operation is performed. | |
| 1278 Otherwise the current line is unindented. | |
| 1279 </dd> | |
| 1280 </dl><a NAME="Editor.__indentSelection" ID="Editor.__indentSelection"></a> | |
| 1281 <h4>Editor.__indentSelection</h4> | |
| 1282 <b>__indentSelection</b>(<i>indent = True</i>) | |
| 1283 <p> | |
| 1284 Private method to indent or unindent the current selection. | |
| 1285 </p><dl> | |
| 1286 <dt><i>indent</i></dt> | |
| 1287 <dd> | |
| 1288 flag indicating an indent operation (boolean) | |
| 1289 <br />If the flag is true, an indent operation is performed. | |
| 1290 Otherwise the current line is unindented. | |
| 1291 </dd> | |
| 1292 </dl><a NAME="Editor.__initContextMenu" ID="Editor.__initContextMenu"></a> | |
| 1293 <h4>Editor.__initContextMenu</h4> | |
| 1294 <b>__initContextMenu</b>(<i></i>) | |
| 1295 <p> | |
| 1296 Private method used to setup the context menu | |
| 1297 </p><a NAME="Editor.__initContextMenuAutocompletion" ID="Editor.__initContextMenuAutocompletion"></a> | |
| 1298 <h4>Editor.__initContextMenuAutocompletion</h4> | |
| 1299 <b>__initContextMenuAutocompletion</b>(<i></i>) | |
| 1300 <p> | |
| 1301 Private method used to setup the Checks context sub menu. | |
| 1302 </p><a NAME="Editor.__initContextMenuChecks" ID="Editor.__initContextMenuChecks"></a> | |
| 1303 <h4>Editor.__initContextMenuChecks</h4> | |
| 1304 <b>__initContextMenuChecks</b>(<i></i>) | |
| 1305 <p> | |
| 1306 Private method used to setup the Checks context sub menu. | |
| 1307 </p><a NAME="Editor.__initContextMenuEncodings" ID="Editor.__initContextMenuEncodings"></a> | |
| 1308 <h4>Editor.__initContextMenuEncodings</h4> | |
| 1309 <b>__initContextMenuEncodings</b>(<i></i>) | |
| 1310 <p> | |
| 1311 Private method used to setup the Encodings context sub menu. | |
| 1312 </p><a NAME="Editor.__initContextMenuEol" ID="Editor.__initContextMenuEol"></a> | |
| 1313 <h4>Editor.__initContextMenuEol</h4> | |
| 1314 <b>__initContextMenuEol</b>(<i></i>) | |
| 1315 <p> | |
| 1316 Private method to setup the eol context sub menu. | |
| 1317 </p><a NAME="Editor.__initContextMenuExporters" ID="Editor.__initContextMenuExporters"></a> | |
| 1318 <h4>Editor.__initContextMenuExporters</h4> | |
| 1319 <b>__initContextMenuExporters</b>(<i></i>) | |
| 1320 <p> | |
| 1321 Private method used to setup the Exporters context sub menu. | |
| 1322 </p><a NAME="Editor.__initContextMenuGraphics" ID="Editor.__initContextMenuGraphics"></a> | |
| 1323 <h4>Editor.__initContextMenuGraphics</h4> | |
| 1324 <b>__initContextMenuGraphics</b>(<i></i>) | |
| 1325 <p> | |
| 1326 Private method used to setup the diagrams context sub menu. | |
| 1327 </p><a NAME="Editor.__initContextMenuLanguages" ID="Editor.__initContextMenuLanguages"></a> | |
| 1328 <h4>Editor.__initContextMenuLanguages</h4> | |
| 1329 <b>__initContextMenuLanguages</b>(<i></i>) | |
| 1330 <p> | |
| 1331 Private method used to setup the Languages context sub menu. | |
| 1332 </p><a NAME="Editor.__initContextMenuMargins" ID="Editor.__initContextMenuMargins"></a> | |
| 1333 <h4>Editor.__initContextMenuMargins</h4> | |
| 1334 <b>__initContextMenuMargins</b>(<i></i>) | |
| 1335 <p> | |
| 1336 Private method used to setup the context menu for the margins | |
| 1337 </p><a NAME="Editor.__initContextMenuResources" ID="Editor.__initContextMenuResources"></a> | |
| 1338 <h4>Editor.__initContextMenuResources</h4> | |
| 1339 <b>__initContextMenuResources</b>(<i></i>) | |
| 1340 <p> | |
| 1341 Private method used to setup the Resources context sub menu. | |
| 1342 </p><a NAME="Editor.__initContextMenuSeparateMargins" ID="Editor.__initContextMenuSeparateMargins"></a> | |
| 1343 <h4>Editor.__initContextMenuSeparateMargins</h4> | |
| 1344 <b>__initContextMenuSeparateMargins</b>(<i></i>) | |
| 1345 <p> | |
| 1346 Private method used to setup the context menu for the separated margins | |
| 1347 </p><a NAME="Editor.__initContextMenuShow" ID="Editor.__initContextMenuShow"></a> | |
| 1348 <h4>Editor.__initContextMenuShow</h4> | |
| 1349 <b>__initContextMenuShow</b>(<i></i>) | |
| 1350 <p> | |
| 1351 Private method used to setup the Show context sub menu. | |
| 1352 </p><a NAME="Editor.__initContextMenuUnifiedMargins" ID="Editor.__initContextMenuUnifiedMargins"></a> | |
| 1353 <h4>Editor.__initContextMenuUnifiedMargins</h4> | |
| 1354 <b>__initContextMenuUnifiedMargins</b>(<i></i>) | |
| 1355 <p> | |
| 1356 Private method used to setup the context menu for the unified margins | |
| 1357 </p><a NAME="Editor.__isStartChar" ID="Editor.__isStartChar"></a> | |
| 1358 <h4>Editor.__isStartChar</h4> | |
| 1359 <b>__isStartChar</b>(<i>ch</i>) | |
| 1360 <p> | |
| 1361 Private method to check, if a character is an autocompletion start character. | |
| 1362 </p><dl> | |
| 1363 <dt><i>ch</i></dt> | |
| 1364 <dd> | |
| 1365 character to be checked (one character string) | |
| 1366 </dd> | |
| 1367 </dl><dl> | |
| 1368 <dt>Returns:</dt> | |
| 1369 <dd> | |
| 1370 flag indicating the result (boolean) | |
| 1371 </dd> | |
| 1372 </dl><a NAME="Editor.__languageMenuTriggered" ID="Editor.__languageMenuTriggered"></a> | |
| 1373 <h4>Editor.__languageMenuTriggered</h4> | |
| 1374 <b>__languageMenuTriggered</b>(<i>act</i>) | |
| 1375 <p> | |
| 1376 Private method to handle the selection of a lexer language. | |
| 1377 </p><dl> | |
| 1378 <dt><i>act</i></dt> | |
| 1379 <dd> | |
| 1380 reference to the action that was triggered (QAction) | |
| 1381 </dd> | |
| 1382 </dl><a NAME="Editor.__linesChanged" ID="Editor.__linesChanged"></a> | |
| 1383 <h4>Editor.__linesChanged</h4> | |
| 1384 <b>__linesChanged</b>(<i></i>) | |
| 1385 <p> | |
| 1386 Private method to track text changes. | |
| 1387 </p><p> | |
| 1388 This method checks, if lines have been inserted or removed in order to | |
| 1389 update the breakpoints. | |
| 1390 </p><a NAME="Editor.__lmBbookmarks" ID="Editor.__lmBbookmarks"></a> | |
| 1391 <h4>Editor.__lmBbookmarks</h4> | |
| 1392 <b>__lmBbookmarks</b>(<i></i>) | |
| 1393 <p> | |
| 1394 Private method to handle the 'LMB toggles bookmark' context menu action. | |
| 1395 </p><a NAME="Editor.__lmBbreakpoints" ID="Editor.__lmBbreakpoints"></a> | |
| 1396 <h4>Editor.__lmBbreakpoints</h4> | |
| 1397 <b>__lmBbreakpoints</b>(<i></i>) | |
| 1398 <p> | |
| 1399 Private method to handle the 'LMB toggles breakpoint' context menu action. | |
| 1400 </p><a NAME="Editor.__marginClicked" ID="Editor.__marginClicked"></a> | |
| 1401 <h4>Editor.__marginClicked</h4> | |
| 1402 <b>__marginClicked</b>(<i>margin, line, modifiers</i>) | |
| 1403 <p> | |
| 1404 Private slot to handle the marginClicked signal. | |
| 1405 </p><dl> | |
| 1406 <dt><i>margin</i></dt> | |
| 1407 <dd> | |
| 1408 id of the clicked margin (integer) | |
| 1409 </dd><dt><i>line</i></dt> | |
| 1410 <dd> | |
| 1411 line number of the click (integer) | |
| 1412 </dd><dt><i>modifiers</i></dt> | |
| 1413 <dd> | |
| 1414 keyboard modifiers (Qt.KeyboardModifiers) | |
| 1415 </dd> | |
| 1416 </dl><a NAME="Editor.__marginNumber" ID="Editor.__marginNumber"></a> | |
| 1417 <h4>Editor.__marginNumber</h4> | |
| 1418 <b>__marginNumber</b>(<i>xPos</i>) | |
| 1419 <p> | |
| 1420 Private method to calculate the margin number based on a x position. | |
| 1421 </p><dl> | |
| 1422 <dt><i>xPos</i></dt> | |
| 1423 <dd> | |
| 1424 x position (integer) | |
| 1425 </dd> | |
| 1426 </dl><dl> | |
| 1427 <dt>Returns:</dt> | |
| 1428 <dd> | |
| 1429 margin number (integer, -1 for no margin) | |
| 1430 </dd> | |
| 1431 </dl><a NAME="Editor.__markOccurrences" ID="Editor.__markOccurrences"></a> | |
| 1432 <h4>Editor.__markOccurrences</h4> | |
| 1433 <b>__markOccurrences</b>(<i></i>) | |
| 1434 <p> | |
| 1435 Private method to mark all occurrences of the current word. | |
| 1436 </p><a NAME="Editor.__menuClearBreakpoints" ID="Editor.__menuClearBreakpoints"></a> | |
| 1437 <h4>Editor.__menuClearBreakpoints</h4> | |
| 1438 <b>__menuClearBreakpoints</b>(<i></i>) | |
| 1439 <p> | |
| 1440 Private slot to handle the 'Clear all breakpoints' context menu action. | |
| 1441 </p><a NAME="Editor.__menuToggleBreakpointEnabled" ID="Editor.__menuToggleBreakpointEnabled"></a> | |
| 1442 <h4>Editor.__menuToggleBreakpointEnabled</h4> | |
| 1443 <b>__menuToggleBreakpointEnabled</b>(<i></i>) | |
| 1444 <p> | |
| 1445 Private slot to handle the 'Enable/Disable breakpoint' context menu action. | |
| 1446 </p><a NAME="Editor.__menuToggleTemporaryBreakpoint" ID="Editor.__menuToggleTemporaryBreakpoint"></a> | |
| 1447 <h4>Editor.__menuToggleTemporaryBreakpoint</h4> | |
| 1448 <b>__menuToggleTemporaryBreakpoint</b>(<i></i>) | |
| 1449 <p> | |
| 1450 Private slot to handle the 'Toggle temporary breakpoint' context menu action. | |
| 1451 </p><a NAME="Editor.__modificationChanged" ID="Editor.__modificationChanged"></a> | |
| 1452 <h4>Editor.__modificationChanged</h4> | |
| 1453 <b>__modificationChanged</b>(<i>m</i>) | |
| 1454 <p> | |
| 1455 Private slot to handle the modificationChanged signal. | |
| 1456 </p><p> | |
| 1457 It emits the signal modificationStatusChanged with parameters | |
| 1458 m and self. | |
| 1459 </p><dl> | |
| 1460 <dt><i>m</i></dt> | |
| 1461 <dd> | |
| 1462 modification status | |
| 1463 </dd> | |
| 1464 </dl><a NAME="Editor.__modificationReadOnly" ID="Editor.__modificationReadOnly"></a> | |
| 1465 <h4>Editor.__modificationReadOnly</h4> | |
| 1466 <b>__modificationReadOnly</b>(<i></i>) | |
| 1467 <p> | |
| 1468 Private slot to handle the modificationAttempted signal. | |
| 1469 </p><a NAME="Editor.__newView" ID="Editor.__newView"></a> | |
| 1470 <h4>Editor.__newView</h4> | |
| 1471 <b>__newView</b>(<i></i>) | |
| 1472 <p> | |
| 1473 Private slot to create a new view to an open document. | |
| 1474 </p><a NAME="Editor.__newViewNewSplit" ID="Editor.__newViewNewSplit"></a> | |
| 1475 <h4>Editor.__newViewNewSplit</h4> | |
| 1476 <b>__newViewNewSplit</b>(<i></i>) | |
| 1477 <p> | |
| 1478 Private slot to create a new view to an open document. | |
| 1479 </p><a NAME="Editor.__normalizedEncoding" ID="Editor.__normalizedEncoding"></a> | |
| 1480 <h4>Editor.__normalizedEncoding</h4> | |
| 1481 <b>__normalizedEncoding</b>(<i></i>) | |
| 1482 <p> | |
| 1483 Private method to calculate the normalized encoding string. | |
| 1484 </p><dl> | |
| 1485 <dt>Returns:</dt> | |
| 1486 <dd> | |
| 1487 normalized encoding (string) | |
| 1488 </dd> | |
| 1489 </dl><a NAME="Editor.__printPreview" ID="Editor.__printPreview"></a> | |
| 1490 <h4>Editor.__printPreview</h4> | |
| 1491 <b>__printPreview</b>(<i>printer</i>) | |
| 1492 <p> | |
| 1493 Private slot to generate a print preview. | |
| 1494 </p><dl> | |
| 1495 <dt><i>printer</i></dt> | |
| 1496 <dd> | |
| 1497 reference to the printer object (QScintilla.Printer.Printer) | |
| 1498 </dd> | |
| 1499 </dl><a NAME="Editor.__projectPropertiesChanged" ID="Editor.__projectPropertiesChanged"></a> | |
| 1500 <h4>Editor.__projectPropertiesChanged</h4> | |
| 1501 <b>__projectPropertiesChanged</b>(<i></i>) | |
| 1502 <p> | |
| 1503 Private slot to handle changes of the project properties. | |
| 1504 </p><a NAME="Editor.__registerImages" ID="Editor.__registerImages"></a> | |
| 1505 <h4>Editor.__registerImages</h4> | |
| 1506 <b>__registerImages</b>(<i></i>) | |
| 1507 <p> | |
| 1508 Private method to register images for autocompletion lists. | |
| 1509 </p><a NAME="Editor.__removeFromSpellingDictionary" ID="Editor.__removeFromSpellingDictionary"></a> | |
| 1510 <h4>Editor.__removeFromSpellingDictionary</h4> | |
| 1511 <b>__removeFromSpellingDictionary</b>(<i></i>) | |
| 1512 <p> | |
| 1513 Private slot to remove the word below the context menu to the dictionary. | |
| 1514 </p><a NAME="Editor.__removeTrailingWhitespace" ID="Editor.__removeTrailingWhitespace"></a> | |
| 1515 <h4>Editor.__removeTrailingWhitespace</h4> | |
| 1516 <b>__removeTrailingWhitespace</b>(<i></i>) | |
| 1517 <p> | |
| 1518 Private method to remove trailing whitespace. | |
| 1519 </p><a NAME="Editor.__resetLanguage" ID="Editor.__resetLanguage"></a> | |
| 1520 <h4>Editor.__resetLanguage</h4> | |
| 1521 <b>__resetLanguage</b>(<i>propagate = True</i>) | |
| 1522 <p> | |
| 1523 Private method used to reset the language selection. | |
| 1524 </p><dl> | |
| 1525 <dt><i>propagate=</i></dt> | |
| 1526 <dd> | |
| 1527 flag indicating to propagate the change (boolean) | |
| 1528 </dd> | |
| 1529 </dl><a NAME="Editor.__restoreBreakpoints" ID="Editor.__restoreBreakpoints"></a> | |
| 1530 <h4>Editor.__restoreBreakpoints</h4> | |
| 1531 <b>__restoreBreakpoints</b>(<i></i>) | |
| 1532 <p> | |
| 1533 Private method to restore the breakpoints. | |
| 1534 </p><a NAME="Editor.__selectAll" ID="Editor.__selectAll"></a> | |
| 1535 <h4>Editor.__selectAll</h4> | |
| 1536 <b>__selectAll</b>(<i></i>) | |
| 1537 <p> | |
| 1538 Private slot handling the select all context menu action. | |
| 1539 </p><a NAME="Editor.__selectPygmentsLexer" ID="Editor.__selectPygmentsLexer"></a> | |
| 1540 <h4>Editor.__selectPygmentsLexer</h4> | |
| 1541 <b>__selectPygmentsLexer</b>(<i></i>) | |
| 1542 <p> | |
| 1543 Private method to select a specific pygments lexer. | |
| 1544 </p><dl> | |
| 1545 <dt>Returns:</dt> | |
| 1546 <dd> | |
| 1547 name of the selected pygments lexer (string) | |
| 1548 </dd> | |
| 1549 </dl><a NAME="Editor.__setAutoCompletion" ID="Editor.__setAutoCompletion"></a> | |
| 1550 <h4>Editor.__setAutoCompletion</h4> | |
| 1551 <b>__setAutoCompletion</b>(<i></i>) | |
| 1552 <p> | |
| 1553 Private method to configure the autocompletion function. | |
| 1554 </p><a NAME="Editor.__setCallTips" ID="Editor.__setCallTips"></a> | |
| 1555 <h4>Editor.__setCallTips</h4> | |
| 1556 <b>__setCallTips</b>(<i></i>) | |
| 1557 <p> | |
| 1558 Private method to configure the calltips function. | |
| 1559 </p><a NAME="Editor.__setEolMode" ID="Editor.__setEolMode"></a> | |
| 1560 <h4>Editor.__setEolMode</h4> | |
| 1561 <b>__setEolMode</b>(<i></i>) | |
| 1562 <p> | |
| 1563 Private method to configure the eol mode of the editor. | |
| 1564 </p><a NAME="Editor.__setLineMarkerColours" ID="Editor.__setLineMarkerColours"></a> | |
| 1565 <h4>Editor.__setLineMarkerColours</h4> | |
| 1566 <b>__setLineMarkerColours</b>(<i></i>) | |
| 1567 <p> | |
| 1568 Private method to set the line marker colours. | |
| 1569 </p><a NAME="Editor.__setMarginsDisplay" ID="Editor.__setMarginsDisplay"></a> | |
| 1570 <h4>Editor.__setMarginsDisplay</h4> | |
| 1571 <b>__setMarginsDisplay</b>(<i></i>) | |
| 1572 <p> | |
| 1573 Private method to configure margins 0 and 2. | |
| 1574 </p><a NAME="Editor.__setSpelling" ID="Editor.__setSpelling"></a> | |
| 1575 <h4>Editor.__setSpelling</h4> | |
| 1576 <b>__setSpelling</b>(<i></i>) | |
| 1577 <p> | |
| 1578 Private method to initialize the spell checking functionality. | |
| 1579 </p><a NAME="Editor.__setSpellingLanguage" ID="Editor.__setSpellingLanguage"></a> | |
| 1580 <h4>Editor.__setSpellingLanguage</h4> | |
| 1581 <b>__setSpellingLanguage</b>(<i>language, pwl = "", pel = ""</i>) | |
| 1582 <p> | |
| 1583 Private slot to set the spell checking language. | |
| 1584 </p><dl> | |
| 1585 <dt><i>language</i></dt> | |
| 1586 <dd> | |
| 1587 spell checking language to be set (string) | |
| 1588 </dd><dt><i>pwl=</i></dt> | |
| 1589 <dd> | |
| 1590 name of the personal/project word list (string) | |
| 1591 </dd><dt><i>pel=</i></dt> | |
| 1592 <dd> | |
| 1593 name of the personal/project exclude list (string) | |
| 1594 </dd> | |
| 1595 </dl><a NAME="Editor.__setTextDisplay" ID="Editor.__setTextDisplay"></a> | |
| 1596 <h4>Editor.__setTextDisplay</h4> | |
| 1597 <b>__setTextDisplay</b>(<i></i>) | |
| 1598 <p> | |
| 1599 Private method to configure the text display. | |
| 1600 </p><a NAME="Editor.__showApplicationDiagram" ID="Editor.__showApplicationDiagram"></a> | |
| 1601 <h4>Editor.__showApplicationDiagram</h4> | |
| 1602 <b>__showApplicationDiagram</b>(<i></i>) | |
| 1603 <p> | |
| 1604 Private method to handle the Imports Diagram context menu action. | |
| 1605 </p><a NAME="Editor.__showClassDiagram" ID="Editor.__showClassDiagram"></a> | |
| 1606 <h4>Editor.__showClassDiagram</h4> | |
| 1607 <b>__showClassDiagram</b>(<i></i>) | |
| 1608 <p> | |
| 1609 Private method to handle the Class Diagram context menu action. | |
| 1610 </p><a NAME="Editor.__showCodeCoverage" ID="Editor.__showCodeCoverage"></a> | |
| 1611 <h4>Editor.__showCodeCoverage</h4> | |
| 1612 <b>__showCodeCoverage</b>(<i></i>) | |
| 1613 <p> | |
| 1614 Private method to handle the code coverage context menu action. | |
| 1615 </p><a NAME="Editor.__showCodeMetrics" ID="Editor.__showCodeMetrics"></a> | |
| 1616 <h4>Editor.__showCodeMetrics</h4> | |
| 1617 <b>__showCodeMetrics</b>(<i></i>) | |
| 1618 <p> | |
| 1619 Private method to handle the code metrics context menu action. | |
| 1620 </p><a NAME="Editor.__showContextMenu" ID="Editor.__showContextMenu"></a> | |
| 1621 <h4>Editor.__showContextMenu</h4> | |
| 1622 <b>__showContextMenu</b>(<i></i>) | |
| 1623 <p> | |
| 1624 Private slot handling the aboutToShow signal of the context menu. | |
| 1625 </p><a NAME="Editor.__showContextMenuAutocompletion" ID="Editor.__showContextMenuAutocompletion"></a> | |
| 1626 <h4>Editor.__showContextMenuAutocompletion</h4> | |
| 1627 <b>__showContextMenuAutocompletion</b>(<i></i>) | |
| 1628 <p> | |
| 1629 Private slot called before the autocompletion menu is shown. | |
| 1630 </p><a NAME="Editor.__showContextMenuChecks" ID="Editor.__showContextMenuChecks"></a> | |
| 1631 <h4>Editor.__showContextMenuChecks</h4> | |
| 1632 <b>__showContextMenuChecks</b>(<i></i>) | |
| 1633 <p> | |
| 1634 Private slot handling the aboutToShow signal of the checks context menu. | |
| 1635 </p><a NAME="Editor.__showContextMenuEncodings" ID="Editor.__showContextMenuEncodings"></a> | |
| 1636 <h4>Editor.__showContextMenuEncodings</h4> | |
| 1637 <b>__showContextMenuEncodings</b>(<i></i>) | |
| 1638 <p> | |
| 1639 Private slot handling the aboutToShow signal of the encodings context menu. | |
| 1640 </p><a NAME="Editor.__showContextMenuEol" ID="Editor.__showContextMenuEol"></a> | |
| 1641 <h4>Editor.__showContextMenuEol</h4> | |
| 1642 <b>__showContextMenuEol</b>(<i></i>) | |
| 1643 <p> | |
| 1644 Private slot handling the aboutToShow signal of the eol context menu. | |
| 1645 </p><a NAME="Editor.__showContextMenuGraphics" ID="Editor.__showContextMenuGraphics"></a> | |
| 1646 <h4>Editor.__showContextMenuGraphics</h4> | |
| 1647 <b>__showContextMenuGraphics</b>(<i></i>) | |
| 1648 <p> | |
| 1649 Private slot handling the aboutToShow signal of the diagrams context menu. | |
| 1650 </p><a NAME="Editor.__showContextMenuLanguages" ID="Editor.__showContextMenuLanguages"></a> | |
| 1651 <h4>Editor.__showContextMenuLanguages</h4> | |
| 1652 <b>__showContextMenuLanguages</b>(<i></i>) | |
| 1653 <p> | |
| 1654 Private slot handling the aboutToShow signal of the languages context menu. | |
| 1655 </p><a NAME="Editor.__showContextMenuMargin" ID="Editor.__showContextMenuMargin"></a> | |
| 1656 <h4>Editor.__showContextMenuMargin</h4> | |
| 1657 <b>__showContextMenuMargin</b>(<i></i>) | |
| 1658 <p> | |
| 1659 Private slot handling the aboutToShow signal of the margins context menu. | |
| 1660 </p><a NAME="Editor.__showContextMenuResources" ID="Editor.__showContextMenuResources"></a> | |
| 1661 <h4>Editor.__showContextMenuResources</h4> | |
| 1662 <b>__showContextMenuResources</b>(<i></i>) | |
| 1663 <p> | |
| 1664 Private slot handling the aboutToShow signal of the resources context menu. | |
| 1665 </p><a NAME="Editor.__showContextMenuShow" ID="Editor.__showContextMenuShow"></a> | |
| 1666 <h4>Editor.__showContextMenuShow</h4> | |
| 1667 <b>__showContextMenuShow</b>(<i></i>) | |
| 1668 <p> | |
| 1669 Private slot called before the show menu is shown. | |
| 1670 </p><a NAME="Editor.__showContextMenuSpelling" ID="Editor.__showContextMenuSpelling"></a> | |
| 1671 <h4>Editor.__showContextMenuSpelling</h4> | |
| 1672 <b>__showContextMenuSpelling</b>(<i></i>) | |
| 1673 <p> | |
| 1674 Private slot to set up the spelling menu before it is shown. | |
| 1675 </p><a NAME="Editor.__showImportsDiagram" ID="Editor.__showImportsDiagram"></a> | |
| 1676 <h4>Editor.__showImportsDiagram</h4> | |
| 1677 <b>__showImportsDiagram</b>(<i></i>) | |
| 1678 <p> | |
| 1679 Private method to handle the Imports Diagram context menu action. | |
| 1680 </p><a NAME="Editor.__showPackageDiagram" ID="Editor.__showPackageDiagram"></a> | |
| 1681 <h4>Editor.__showPackageDiagram</h4> | |
| 1682 <b>__showPackageDiagram</b>(<i></i>) | |
| 1683 <p> | |
| 1684 Private method to handle the Package Diagram context menu action. | |
| 1685 </p><a NAME="Editor.__showProfileData" ID="Editor.__showProfileData"></a> | |
| 1686 <h4>Editor.__showProfileData</h4> | |
| 1687 <b>__showProfileData</b>(<i></i>) | |
| 1688 <p> | |
| 1689 Private method to handle the show profile data context menu action. | |
| 1690 </p><a NAME="Editor.__showSyntaxError" ID="Editor.__showSyntaxError"></a> | |
| 1691 <h4>Editor.__showSyntaxError</h4> | |
| 1692 <b>__showSyntaxError</b>(<i>line = -1</i>) | |
| 1693 <p> | |
| 1694 Private slot to handle the 'Show syntax error message' context menu action. | |
| 1695 </p><dl> | |
| 1696 <dt><i>line</i></dt> | |
| 1697 <dd> | |
| 1698 line number to show the syntax error for (integer) | |
| 1699 </dd> | |
| 1700 </dl><a NAME="Editor.__spellCharAdded" ID="Editor.__spellCharAdded"></a> | |
| 1701 <h4>Editor.__spellCharAdded</h4> | |
| 1702 <b>__spellCharAdded</b>(<i>charNumber</i>) | |
| 1703 <p> | |
| 1704 Public slot called to handle the user entering a character. | |
| 1705 </p><dl> | |
| 1706 <dt><i>charNumber</i></dt> | |
| 1707 <dd> | |
| 1708 value of the character entered (integer) | |
| 1709 </dd> | |
| 1710 </dl><a NAME="Editor.__styleNeeded" ID="Editor.__styleNeeded"></a> | |
| 1711 <h4>Editor.__styleNeeded</h4> | |
| 1712 <b>__styleNeeded</b>(<i>position</i>) | |
| 1713 <p> | |
| 1714 Private slot to handle the need for more styling. | |
| 1715 </p><dl> | |
| 1716 <dt><i>position</i></dt> | |
| 1717 <dd> | |
| 1718 end position, that needs styling (integer) | |
| 1719 </dd> | |
| 1720 </dl><a NAME="Editor.__toggleAutoCompletionEnable" ID="Editor.__toggleAutoCompletionEnable"></a> | |
| 1721 <h4>Editor.__toggleAutoCompletionEnable</h4> | |
| 1722 <b>__toggleAutoCompletionEnable</b>(<i></i>) | |
| 1723 <p> | |
| 1724 Private slot to handle the Enable Autocompletion context menu entry. | |
| 1725 </p><a NAME="Editor.__toggleBreakpoint" ID="Editor.__toggleBreakpoint"></a> | |
| 1726 <h4>Editor.__toggleBreakpoint</h4> | |
| 1727 <b>__toggleBreakpoint</b>(<i>line, temporary = False</i>) | |
| 1728 <p> | |
| 1729 Private method to toggle a breakpoint. | |
| 1730 </p><dl> | |
| 1731 <dt><i>line</i></dt> | |
| 1732 <dd> | |
| 1733 line number of the breakpoint (integer) | |
| 1734 </dd><dt><i>temporary</i></dt> | |
| 1735 <dd> | |
| 1736 flag indicating a temporary breakpoint (boolean) | |
| 1737 </dd> | |
| 1738 </dl><a NAME="Editor.__toggleBreakpointEnabled" ID="Editor.__toggleBreakpointEnabled"></a> | |
| 1739 <h4>Editor.__toggleBreakpointEnabled</h4> | |
| 1740 <b>__toggleBreakpointEnabled</b>(<i>line</i>) | |
| 1741 <p> | |
| 1742 Private method to toggle a breakpoints enabled status. | |
| 1743 </p><dl> | |
| 1744 <dt><i>line</i></dt> | |
| 1745 <dd> | |
| 1746 line number of the breakpoint (integer) | |
| 1747 </dd> | |
| 1748 </dl><a NAME="Editor.__toggleTypingAids" ID="Editor.__toggleTypingAids"></a> | |
| 1749 <h4>Editor.__toggleTypingAids</h4> | |
| 1750 <b>__toggleTypingAids</b>(<i></i>) | |
| 1751 <p> | |
| 1752 Private slot to toggle the typing aids. | |
| 1753 </p><a NAME="Editor.__updateReadOnly" ID="Editor.__updateReadOnly"></a> | |
| 1754 <h4>Editor.__updateReadOnly</h4> | |
| 1755 <b>__updateReadOnly</b>(<i>bForce = True</i>) | |
| 1756 <p> | |
| 1757 Private method to update the readOnly information for this editor. | |
| 1758 </p><p> | |
| 1759 If bForce is True, then updates everything regardless if | |
| 1760 the attributes have actually changed, such as during | |
| 1761 initialization time. A signal is emitted after the | |
| 1762 caption change. | |
| 1763 </p><dl> | |
| 1764 <dt><i>bForce</i></dt> | |
| 1765 <dd> | |
| 1766 True to force change, False to only update and emit | |
| 1767 signal if there was an attribute change. | |
| 1768 </dd> | |
| 1769 </dl><a NAME="Editor.addClone" ID="Editor.addClone"></a> | |
| 1770 <h4>Editor.addClone</h4> | |
| 1771 <b>addClone</b>(<i>editor</i>) | |
| 1772 <p> | |
| 1773 Public method to add a clone to our list. | |
| 1774 </p><dl> | |
| 1775 <dt><i>clone</i></dt> | |
| 1776 <dd> | |
| 1777 reference to the cloned editor (Editor) | |
| 1778 </dd> | |
| 1779 </dl><a NAME="Editor.addedToProject" ID="Editor.addedToProject"></a> | |
| 1780 <h4>Editor.addedToProject</h4> | |
| 1781 <b>addedToProject</b>(<i></i>) | |
| 1782 <p> | |
| 1783 Public method to signal, that this editor has been added to a project. | |
| 1784 </p><a NAME="Editor.autoComplete" ID="Editor.autoComplete"></a> | |
| 1785 <h4>Editor.autoComplete</h4> | |
| 1786 <b>autoComplete</b>(<i>auto = False, context = True</i>) | |
| 1787 <p> | |
| 1788 Public method to start autocompletion. | |
| 1789 </p><dl> | |
| 1790 <dt><i>auto=</i></dt> | |
| 1791 <dd> | |
| 1792 flag indicating a call from the __charAdded method (boolean) | |
| 1793 </dd><dt><i>context=</i></dt> | |
| 1794 <dd> | |
| 1795 flag indicating to complete a context (boolean) | |
| 1796 </dd> | |
| 1797 </dl><a NAME="Editor.autoCompleteQScintilla" ID="Editor.autoCompleteQScintilla"></a> | |
| 1798 <h4>Editor.autoCompleteQScintilla</h4> | |
| 1799 <b>autoCompleteQScintilla</b>(<i></i>) | |
| 1800 <p> | |
| 1801 Public method to perform an autocompletion using QScintilla methods. | |
| 1802 </p><a NAME="Editor.autoCompletionHook" ID="Editor.autoCompletionHook"></a> | |
| 1803 <h4>Editor.autoCompletionHook</h4> | |
| 1804 <b>autoCompletionHook</b>(<i></i>) | |
| 1805 <p> | |
| 1806 Public method to get the autocompletion hook function. | |
| 1807 </p><dl> | |
| 1808 <dt>Returns:</dt> | |
| 1809 <dd> | |
| 1810 function set by setAutoCompletionHook() | |
| 1811 </dd> | |
| 1812 </dl><a NAME="Editor.boxCommentLine" ID="Editor.boxCommentLine"></a> | |
| 1813 <h4>Editor.boxCommentLine</h4> | |
| 1814 <b>boxCommentLine</b>(<i></i>) | |
| 1815 <p> | |
| 1816 Public slot to box comment the current line. | |
| 1817 </p><a NAME="Editor.boxCommentLineOrSelection" ID="Editor.boxCommentLineOrSelection"></a> | |
| 1818 <h4>Editor.boxCommentLineOrSelection</h4> | |
| 1819 <b>boxCommentLineOrSelection</b>(<i></i>) | |
| 1820 <p> | |
| 1821 Public slot to box comment the current line or current selection. | |
| 1822 </p><a NAME="Editor.boxCommentSelection" ID="Editor.boxCommentSelection"></a> | |
| 1823 <h4>Editor.boxCommentSelection</h4> | |
| 1824 <b>boxCommentSelection</b>(<i></i>) | |
| 1825 <p> | |
| 1826 Public slot to box comment the current selection. | |
| 1827 </p><a NAME="Editor.callTip" ID="Editor.callTip"></a> | |
| 1828 <h4>Editor.callTip</h4> | |
| 1829 <b>callTip</b>(<i></i>) | |
| 1830 <p> | |
| 1831 Public method to show calltips. | |
| 1832 </p><a NAME="Editor.callTipHook" ID="Editor.callTipHook"></a> | |
| 1833 <h4>Editor.callTipHook</h4> | |
| 1834 <b>callTipHook</b>(<i></i>) | |
| 1835 <p> | |
| 1836 Public method to get the calltip hook function. | |
| 1837 </p><dl> | |
| 1838 <dt>Returns:</dt> | |
| 1839 <dd> | |
| 1840 function set by setCallTipHook() | |
| 1841 </dd> | |
| 1842 </dl><a NAME="Editor.canAutoCompleteFromAPIs" ID="Editor.canAutoCompleteFromAPIs"></a> | |
| 1843 <h4>Editor.canAutoCompleteFromAPIs</h4> | |
| 1844 <b>canAutoCompleteFromAPIs</b>(<i></i>) | |
| 1845 <p> | |
| 1846 Public method to check for API availablity. | |
| 1847 </p><dl> | |
| 1848 <dt>Returns:</dt> | |
| 1849 <dd> | |
| 1850 flag indicating autocompletion from APIs is available (boolean) | |
| 1851 </dd> | |
| 1852 </dl><a NAME="Editor.changeEvent" ID="Editor.changeEvent"></a> | |
| 1853 <h4>Editor.changeEvent</h4> | |
| 1854 <b>changeEvent</b>(<i>evt</i>) | |
| 1855 <p> | |
| 1856 Protected method called to process an event. | |
| 1857 </p><p> | |
| 1858 This implements special handling for the events showMaximized, | |
| 1859 showMinimized and showNormal. The windows caption is shortened | |
| 1860 for the minimized mode and reset to the full filename for the | |
| 1861 other modes. This is to make the editor windows work nicer | |
| 1862 with the QWorkspace. | |
| 1863 </p><dl> | |
| 1864 <dt><i>evt</i></dt> | |
| 1865 <dd> | |
| 1866 the event, that was generated (QEvent) | |
| 1867 </dd> | |
| 1868 </dl><dl> | |
| 1869 <dt>Returns:</dt> | |
| 1870 <dd> | |
| 1871 flag indicating if the event could be processed (bool) | |
| 1872 </dd> | |
| 1873 </dl><a NAME="Editor.checkDirty" ID="Editor.checkDirty"></a> | |
| 1874 <h4>Editor.checkDirty</h4> | |
| 1875 <b>checkDirty</b>(<i></i>) | |
| 1876 <p> | |
| 1877 Public method to check dirty status and open a message window. | |
| 1878 </p><dl> | |
| 1879 <dt>Returns:</dt> | |
| 1880 <dd> | |
| 1881 flag indicating successful reset of the dirty flag (boolean) | |
| 1882 </dd> | |
| 1883 </dl><a NAME="Editor.checkSpelling" ID="Editor.checkSpelling"></a> | |
| 1884 <h4>Editor.checkSpelling</h4> | |
| 1885 <b>checkSpelling</b>(<i></i>) | |
| 1886 <p> | |
| 1887 Public slot to perform an interactive spell check of the document. | |
| 1888 </p><a NAME="Editor.clearBookmarks" ID="Editor.clearBookmarks"></a> | |
| 1889 <h4>Editor.clearBookmarks</h4> | |
| 1890 <b>clearBookmarks</b>(<i></i>) | |
| 1891 <p> | |
| 1892 Public slot to handle the 'Clear all bookmarks' context menu action. | |
| 1893 </p><a NAME="Editor.clearBreakpoint" ID="Editor.clearBreakpoint"></a> | |
| 1894 <h4>Editor.clearBreakpoint</h4> | |
| 1895 <b>clearBreakpoint</b>(<i>line</i>) | |
| 1896 <p> | |
| 1897 Public method to clear a breakpoint. | |
| 1898 </p><p> | |
| 1899 Note: This doesn't clear the breakpoint in the debugger, | |
| 1900 it just deletes it from the editor internal list of breakpoints. | |
| 1901 </p><dl> | |
| 1902 <dt><i>line</i></dt> | |
| 1903 <dd> | |
| 1904 linenumber of the breakpoint (integer) | |
| 1905 </dd> | |
| 1906 </dl><a NAME="Editor.clearSearchIndicators" ID="Editor.clearSearchIndicators"></a> | |
| 1907 <h4>Editor.clearSearchIndicators</h4> | |
| 1908 <b>clearSearchIndicators</b>(<i></i>) | |
| 1909 <p> | |
| 1910 Public method to clear all search indicators. | |
| 1911 </p><a NAME="Editor.clearSyntaxError" ID="Editor.clearSyntaxError"></a> | |
| 1912 <h4>Editor.clearSyntaxError</h4> | |
| 1913 <b>clearSyntaxError</b>(<i></i>) | |
| 1914 <p> | |
| 1915 Public slot to handle the 'Clear all syntax error' context menu action. | |
| 1916 </p><a NAME="Editor.close" ID="Editor.close"></a> | |
| 1917 <h4>Editor.close</h4> | |
| 1918 <b>close</b>(<i>alsoDelete = False</i>) | |
| 1919 <p> | |
| 1920 Public method called when the window gets closed. | |
| 1921 </p><p> | |
| 1922 This overwritten method redirects the action to our | |
| 1923 ViewManager.closeEditor, which in turn calls our closeIt | |
| 1924 method. | |
| 1925 </p><dl> | |
| 1926 <dt><i>alsoDelete</i></dt> | |
| 1927 <dd> | |
| 1928 ignored | |
| 1929 </dd> | |
| 1930 </dl><a NAME="Editor.closeIt" ID="Editor.closeIt"></a> | |
| 1931 <h4>Editor.closeIt</h4> | |
| 1932 <b>closeIt</b>(<i></i>) | |
| 1933 <p> | |
| 1934 Public method called by the viewmanager to finally get rid of us. | |
| 1935 </p><a NAME="Editor.commentLine" ID="Editor.commentLine"></a> | |
| 1936 <h4>Editor.commentLine</h4> | |
| 1937 <b>commentLine</b>(<i></i>) | |
| 1938 <p> | |
| 1939 Public slot to comment the current line. | |
| 1940 </p><a NAME="Editor.commentLineOrSelection" ID="Editor.commentLineOrSelection"></a> | |
| 1941 <h4>Editor.commentLineOrSelection</h4> | |
| 1942 <b>commentLineOrSelection</b>(<i></i>) | |
| 1943 <p> | |
| 1944 Public slot to comment the current line or current selection. | |
| 1945 </p><a NAME="Editor.commentSelection" ID="Editor.commentSelection"></a> | |
| 1946 <h4>Editor.commentSelection</h4> | |
| 1947 <b>commentSelection</b>(<i></i>) | |
| 1948 <p> | |
| 1949 Public slot to comment the current selection. | |
| 1950 </p><a NAME="Editor.contextMenuEvent" ID="Editor.contextMenuEvent"></a> | |
| 1951 <h4>Editor.contextMenuEvent</h4> | |
| 1952 <b>contextMenuEvent</b>(<i>evt</i>) | |
| 1953 <p> | |
| 1954 Private method implementing the context menu event. | |
| 1955 </p><dl> | |
| 1956 <dt><i>evt</i></dt> | |
| 1957 <dd> | |
| 1958 the context menu event (QContextMenuEvent) | |
| 1959 </dd> | |
| 1960 </dl><a NAME="Editor.curLineHasBreakpoint" ID="Editor.curLineHasBreakpoint"></a> | |
| 1961 <h4>Editor.curLineHasBreakpoint</h4> | |
| 1962 <b>curLineHasBreakpoint</b>(<i></i>) | |
| 1963 <p> | |
| 1964 Public method to check for the presence of a breakpoint at the current line. | |
| 1965 </p><dl> | |
| 1966 <dt>Returns:</dt> | |
| 1967 <dd> | |
| 1968 flag indicating the presence of a breakpoint (boolean) | |
| 1969 </dd> | |
| 1970 </dl><a NAME="Editor.dragEnterEvent" ID="Editor.dragEnterEvent"></a> | |
| 1971 <h4>Editor.dragEnterEvent</h4> | |
| 1972 <b>dragEnterEvent</b>(<i>event</i>) | |
| 1973 <p> | |
| 1974 Protected method to handle the drag enter event. | |
| 1975 </p><dl> | |
| 1976 <dt><i>event</i></dt> | |
| 1977 <dd> | |
| 1978 the drag enter event (QDragEnterEvent) | |
| 1979 </dd> | |
| 1980 </dl><a NAME="Editor.dragLeaveEvent" ID="Editor.dragLeaveEvent"></a> | |
| 1981 <h4>Editor.dragLeaveEvent</h4> | |
| 1982 <b>dragLeaveEvent</b>(<i>event</i>) | |
| 1983 <p> | |
| 1984 Protected method to handle the drag leave event. | |
| 1985 </p><dl> | |
| 1986 <dt><i>event</i></dt> | |
| 1987 <dd> | |
| 1988 the drag leave event (QDragLeaveEvent) | |
| 1989 </dd> | |
| 1990 </dl><a NAME="Editor.dragMoveEvent" ID="Editor.dragMoveEvent"></a> | |
| 1991 <h4>Editor.dragMoveEvent</h4> | |
| 1992 <b>dragMoveEvent</b>(<i>event</i>) | |
| 1993 <p> | |
| 1994 Protected method to handle the drag move event. | |
| 1995 </p><dl> | |
| 1996 <dt><i>event</i></dt> | |
| 1997 <dd> | |
| 1998 the drag move event (QDragMoveEvent) | |
| 1999 </dd> | |
| 2000 </dl><a NAME="Editor.dropEvent" ID="Editor.dropEvent"></a> | |
| 2001 <h4>Editor.dropEvent</h4> | |
| 2002 <b>dropEvent</b>(<i>event</i>) | |
| 2003 <p> | |
| 2004 Protected method to handle the drop event. | |
| 2005 </p><dl> | |
| 2006 <dt><i>event</i></dt> | |
| 2007 <dd> | |
| 2008 the drop event (QDropEvent) | |
| 2009 </dd> | |
| 2010 </dl><a NAME="Editor.editorCommand" ID="Editor.editorCommand"></a> | |
| 2011 <h4>Editor.editorCommand</h4> | |
| 2012 <b>editorCommand</b>(<i>cmd</i>) | |
| 2013 <p> | |
| 2014 Public method to perform a simple editor command. | |
| 2015 </p><dl> | |
| 2016 <dt><i>cmd</i></dt> | |
| 2017 <dd> | |
| 2018 the scintilla command to be performed | |
| 2019 </dd> | |
| 2020 </dl><a NAME="Editor.ensureVisible" ID="Editor.ensureVisible"></a> | |
| 2021 <h4>Editor.ensureVisible</h4> | |
| 2022 <b>ensureVisible</b>(<i>line</i>) | |
| 2023 <p> | |
| 2024 Public slot to ensure, that the specified line is visible. | |
| 2025 </p><dl> | |
| 2026 <dt><i>line</i></dt> | |
| 2027 <dd> | |
| 2028 line number to make visible | |
| 2029 </dd> | |
| 2030 </dl><a NAME="Editor.ensureVisibleTop" ID="Editor.ensureVisibleTop"></a> | |
| 2031 <h4>Editor.ensureVisibleTop</h4> | |
| 2032 <b>ensureVisibleTop</b>(<i>line</i>) | |
| 2033 <p> | |
| 2034 Public slot to ensure, that the specified line is visible at the top | |
| 2035 of the editor. | |
| 2036 </p><dl> | |
| 2037 <dt><i>line</i></dt> | |
| 2038 <dd> | |
| 2039 line number to make visible | |
| 2040 </dd> | |
| 2041 </dl><a NAME="Editor.exportFile" ID="Editor.exportFile"></a> | |
| 2042 <h4>Editor.exportFile</h4> | |
| 2043 <b>exportFile</b>(<i>exporterFormat</i>) | |
| 2044 <p> | |
| 2045 Public method to export the file. | |
| 2046 </p><dl> | |
| 2047 <dt><i>exporterFormat</i></dt> | |
| 2048 <dd> | |
| 2049 format the file should be exported into (string) | |
| 2050 </dd> | |
| 2051 </dl><a NAME="Editor.extractTasks" ID="Editor.extractTasks"></a> | |
| 2052 <h4>Editor.extractTasks</h4> | |
| 2053 <b>extractTasks</b>(<i></i>) | |
| 2054 <p> | |
| 2055 Public slot to extract all tasks. | |
| 2056 </p><a NAME="Editor.fileRenamed" ID="Editor.fileRenamed"></a> | |
| 2057 <h4>Editor.fileRenamed</h4> | |
| 2058 <b>fileRenamed</b>(<i>fn</i>) | |
| 2059 <p> | |
| 2060 Public slot to handle the editorRenamed signal. | |
| 2061 </p><dl> | |
| 2062 <dt><i>fn</i></dt> | |
| 2063 <dd> | |
| 2064 filename to be set for the editor (string). | |
| 2065 </dd> | |
| 2066 </dl><a NAME="Editor.focusInEvent" ID="Editor.focusInEvent"></a> | |
| 2067 <h4>Editor.focusInEvent</h4> | |
| 2068 <b>focusInEvent</b>(<i>event</i>) | |
| 2069 <p> | |
| 2070 Protected method called when the editor receives focus. | |
| 2071 </p><p> | |
| 2072 This method checks for modifications of the current file and | |
| 2073 rereads it upon request. The cursor is placed at the current position | |
| 2074 assuming, that it is in the vicinity of the old position after the reread. | |
| 2075 </p><dl> | |
| 2076 <dt><i>event</i></dt> | |
| 2077 <dd> | |
| 2078 the event object (QFocusEvent) | |
| 2079 </dd> | |
| 2080 </dl><a NAME="Editor.focusOutEvent" ID="Editor.focusOutEvent"></a> | |
| 2081 <h4>Editor.focusOutEvent</h4> | |
| 2082 <b>focusOutEvent</b>(<i>event</i>) | |
| 2083 <p> | |
| 2084 Public method called when the editor loses focus. | |
| 2085 </p><dl> | |
| 2086 <dt><i>event</i></dt> | |
| 2087 <dd> | |
| 2088 the event object (QFocusEvent) | |
| 2089 </dd> | |
| 2090 </dl><a NAME="Editor.getBookmarks" ID="Editor.getBookmarks"></a> | |
| 2091 <h4>Editor.getBookmarks</h4> | |
| 2092 <b>getBookmarks</b>(<i></i>) | |
| 2093 <p> | |
| 2094 Public method to retrieve the bookmarks. | |
| 2095 </p><dl> | |
| 2096 <dt>Returns:</dt> | |
| 2097 <dd> | |
| 2098 sorted list of all lines containing a bookmark | |
| 2099 (list of integer) | |
| 2100 </dd> | |
| 2101 </dl><a NAME="Editor.getCompleter" ID="Editor.getCompleter"></a> | |
| 2102 <h4>Editor.getCompleter</h4> | |
| 2103 <b>getCompleter</b>(<i></i>) | |
| 2104 <p> | |
| 2105 Public method to retrieve a reference to the completer object. | |
| 2106 </p><dl> | |
| 2107 <dt>Returns:</dt> | |
| 2108 <dd> | |
| 2109 the completer object (CompleterBase) | |
| 2110 </dd> | |
| 2111 </dl><a NAME="Editor.getCurrentWord" ID="Editor.getCurrentWord"></a> | |
| 2112 <h4>Editor.getCurrentWord</h4> | |
| 2113 <b>getCurrentWord</b>(<i></i>) | |
| 2114 <p> | |
| 2115 Public method to get the word at the current position. | |
| 2116 </p><dl> | |
| 2117 <dt>Returns:</dt> | |
| 2118 <dd> | |
| 2119 the word at that current position (string) | |
| 2120 </dd> | |
| 2121 </dl><a NAME="Editor.getEncoding" ID="Editor.getEncoding"></a> | |
| 2122 <h4>Editor.getEncoding</h4> | |
| 2123 <b>getEncoding</b>(<i></i>) | |
| 2124 <p> | |
| 2125 Public method to return the current encoding. | |
| 2126 </p><dl> | |
| 2127 <dt>Returns:</dt> | |
| 2128 <dd> | |
| 2129 current encoding (string) | |
| 2130 </dd> | |
| 2131 </dl><a NAME="Editor.getFileName" ID="Editor.getFileName"></a> | |
| 2132 <h4>Editor.getFileName</h4> | |
| 2133 <b>getFileName</b>(<i></i>) | |
| 2134 <p> | |
| 2135 Public method to return the name of the file being displayed. | |
| 2136 </p><dl> | |
| 2137 <dt>Returns:</dt> | |
| 2138 <dd> | |
| 2139 filename of the displayed file (string) | |
| 2140 </dd> | |
| 2141 </dl><a NAME="Editor.getFileType" ID="Editor.getFileType"></a> | |
| 2142 <h4>Editor.getFileType</h4> | |
| 2143 <b>getFileType</b>(<i></i>) | |
| 2144 <p> | |
| 2145 Public method to return the type of the file being displayed. | |
| 2146 </p><dl> | |
| 2147 <dt>Returns:</dt> | |
| 2148 <dd> | |
| 2149 type of the displayed file (string) | |
| 2150 </dd> | |
| 2151 </dl><a NAME="Editor.getFolds" ID="Editor.getFolds"></a> | |
| 2152 <h4>Editor.getFolds</h4> | |
| 2153 <b>getFolds</b>(<i></i>) | |
| 2154 <p> | |
| 2155 Public method to get a list line numbers of collapsed folds. | |
| 2156 </p><dl> | |
| 2157 <dt>Returns:</dt> | |
| 2158 <dd> | |
| 2159 list of line numbers of folded lines (list of integer) | |
| 2160 </dd> | |
| 2161 </dl><a NAME="Editor.getHighlightPosition" ID="Editor.getHighlightPosition"></a> | |
| 2162 <h4>Editor.getHighlightPosition</h4> | |
| 2163 <b>getHighlightPosition</b>(<i></i>) | |
| 2164 <p> | |
| 2165 Public method to return the position of the highlight bar. | |
| 2166 </p><dl> | |
| 2167 <dt>Returns:</dt> | |
| 2168 <dd> | |
| 2169 line number of the highlight bar (integer) | |
| 2170 </dd> | |
| 2171 </dl><a NAME="Editor.getLanguage" ID="Editor.getLanguage"></a> | |
| 2172 <h4>Editor.getLanguage</h4> | |
| 2173 <b>getLanguage</b>(<i></i>) | |
| 2174 <p> | |
| 2175 Public method to retrieve the language of the editor. | |
| 2176 </p><dl> | |
| 2177 <dt>Returns:</dt> | |
| 2178 <dd> | |
| 2179 language of the editor (string) | |
| 2180 </dd> | |
| 2181 </dl><a NAME="Editor.getLexer" ID="Editor.getLexer"></a> | |
| 2182 <h4>Editor.getLexer</h4> | |
| 2183 <b>getLexer</b>(<i></i>) | |
| 2184 <p> | |
| 2185 Public method to retrieve a reference to the lexer object. | |
| 2186 </p><dl> | |
| 2187 <dt>Returns:</dt> | |
| 2188 <dd> | |
| 2189 the lexer object (Lexer) | |
| 2190 </dd> | |
| 2191 </dl><a NAME="Editor.getMenu" ID="Editor.getMenu"></a> | |
| 2192 <h4>Editor.getMenu</h4> | |
| 2193 <b>getMenu</b>(<i>menuName</i>) | |
| 2194 <p> | |
| 2195 Public method to get a reference to the main context menu or a submenu. | |
| 2196 </p><dl> | |
| 2197 <dt><i>menuName</i></dt> | |
| 2198 <dd> | |
| 2199 name of the menu (string) | |
| 2200 </dd> | |
| 2201 </dl><dl> | |
| 2202 <dt>Returns:</dt> | |
| 2203 <dd> | |
| 2204 reference to the requested menu (QMenu) or None | |
| 2205 </dd> | |
| 2206 </dl><a NAME="Editor.getNoName" ID="Editor.getNoName"></a> | |
| 2207 <h4>Editor.getNoName</h4> | |
| 2208 <b>getNoName</b>(<i></i>) | |
| 2209 <p> | |
| 2210 Public method to get the display string for an unnamed editor. | |
| 2211 </p><dl> | |
| 2212 <dt>Returns:</dt> | |
| 2213 <dd> | |
| 2214 display string for this unnamed editor (string) | |
| 2215 </dd> | |
| 2216 </dl><a NAME="Editor.getSearchText" ID="Editor.getSearchText"></a> | |
| 2217 <h4>Editor.getSearchText</h4> | |
| 2218 <b>getSearchText</b>(<i>selectionOnly = False</i>) | |
| 2219 <p> | |
| 2220 Public method to determine the selection or the current word for the next | |
| 2221 search operation. | |
| 2222 </p><dl> | |
| 2223 <dt><i>selectionOnly</i></dt> | |
| 2224 <dd> | |
| 2225 flag indicating that only selected text should be | |
| 2226 returned (boolean) | |
| 2227 </dd> | |
| 2228 </dl><dl> | |
| 2229 <dt>Returns:</dt> | |
| 2230 <dd> | |
| 2231 selection or current word (string) | |
| 2232 </dd> | |
| 2233 </dl><a NAME="Editor.getSyntaxErrors" ID="Editor.getSyntaxErrors"></a> | |
| 2234 <h4>Editor.getSyntaxErrors</h4> | |
| 2235 <b>getSyntaxErrors</b>(<i></i>) | |
| 2236 <p> | |
| 2237 Public method to retrieve the syntax error markers. | |
| 2238 </p><dl> | |
| 2239 <dt>Returns:</dt> | |
| 2240 <dd> | |
| 2241 sorted list of all lines containing a syntax error | |
| 2242 (list of integer) | |
| 2243 </dd> | |
| 2244 </dl><a NAME="Editor.getWord" ID="Editor.getWord"></a> | |
| 2245 <h4>Editor.getWord</h4> | |
| 2246 <b>getWord</b>(<i>line, index, direction = 0, useWordChars = True</i>) | |
| 2247 <p> | |
| 2248 Public method to get the word at a position. | |
| 2249 </p><dl> | |
| 2250 <dt><i>line</i></dt> | |
| 2251 <dd> | |
| 2252 number of line to look at (int) | |
| 2253 </dd><dt><i>index</i></dt> | |
| 2254 <dd> | |
| 2255 position to look at (int) | |
| 2256 </dd><dt><i>direction</i></dt> | |
| 2257 <dd> | |
| 2258 direction to look in (0 = whole word, 1 = left, 2 = right) | |
| 2259 </dd><dt><i>useWordChars=</i></dt> | |
| 2260 <dd> | |
| 2261 flag indicating to use the wordCharacters | |
| 2262 method (boolean) | |
| 2263 </dd> | |
| 2264 </dl><dl> | |
| 2265 <dt>Returns:</dt> | |
| 2266 <dd> | |
| 2267 the word at that position (string) | |
| 2268 </dd> | |
| 2269 </dl><a NAME="Editor.getWordBoundaries" ID="Editor.getWordBoundaries"></a> | |
| 2270 <h4>Editor.getWordBoundaries</h4> | |
| 2271 <b>getWordBoundaries</b>(<i>line, index, useWordChars = True</i>) | |
| 2272 <p> | |
| 2273 Public method to get the word boundaries at a position. | |
| 2274 </p><dl> | |
| 2275 <dt><i>line</i></dt> | |
| 2276 <dd> | |
| 2277 number of line to look at (int) | |
| 2278 </dd><dt><i>index</i></dt> | |
| 2279 <dd> | |
| 2280 position to look at (int) | |
| 2281 </dd><dt><i>useWordChars=</i></dt> | |
| 2282 <dd> | |
| 2283 flag indicating to use the wordCharacters | |
| 2284 method (boolean) | |
| 2285 </dd> | |
| 2286 </dl><dl> | |
| 2287 <dt>Returns:</dt> | |
| 2288 <dd> | |
| 2289 tuple with start and end indices of the word at the position | |
| 2290 (integer, integer) | |
| 2291 </dd> | |
| 2292 </dl><a NAME="Editor.getWordLeft" ID="Editor.getWordLeft"></a> | |
| 2293 <h4>Editor.getWordLeft</h4> | |
| 2294 <b>getWordLeft</b>(<i>line, index</i>) | |
| 2295 <p> | |
| 2296 Public method to get the word to the left of a position. | |
| 2297 </p><dl> | |
| 2298 <dt><i>line</i></dt> | |
| 2299 <dd> | |
| 2300 number of line to look at (int) | |
| 2301 </dd><dt><i>index</i></dt> | |
| 2302 <dd> | |
| 2303 position to look at (int) | |
| 2304 </dd> | |
| 2305 </dl><dl> | |
| 2306 <dt>Returns:</dt> | |
| 2307 <dd> | |
| 2308 the word to the left of that position (string) | |
| 2309 </dd> | |
| 2310 </dl><a NAME="Editor.getWordRight" ID="Editor.getWordRight"></a> | |
| 2311 <h4>Editor.getWordRight</h4> | |
| 2312 <b>getWordRight</b>(<i>line, index</i>) | |
| 2313 <p> | |
| 2314 Public method to get the word to the right of a position. | |
| 2315 </p><dl> | |
| 2316 <dt><i>line</i></dt> | |
| 2317 <dd> | |
| 2318 number of line to look at (int) | |
| 2319 </dd><dt><i>index</i></dt> | |
| 2320 <dd> | |
| 2321 position to look at (int) | |
| 2322 </dd> | |
| 2323 </dl><dl> | |
| 2324 <dt>Returns:</dt> | |
| 2325 <dd> | |
| 2326 the word to the right of that position (string) | |
| 2327 </dd> | |
| 2328 </dl><a NAME="Editor.gotoLine" ID="Editor.gotoLine"></a> | |
| 2329 <h4>Editor.gotoLine</h4> | |
| 2330 <b>gotoLine</b>(<i>line</i>) | |
| 2331 <p> | |
| 2332 Public slot to jump to the beginning of a line. | |
| 2333 </p><dl> | |
| 2334 <dt><i>line</i></dt> | |
| 2335 <dd> | |
| 2336 line number to go to (integer) | |
| 2337 </dd> | |
| 2338 </dl><a NAME="Editor.gotoSyntaxError" ID="Editor.gotoSyntaxError"></a> | |
| 2339 <h4>Editor.gotoSyntaxError</h4> | |
| 2340 <b>gotoSyntaxError</b>(<i></i>) | |
| 2341 <p> | |
| 2342 Public slot to handle the 'Goto syntax error' context menu action. | |
| 2343 </p><a NAME="Editor.handleMonospacedEnable" ID="Editor.handleMonospacedEnable"></a> | |
| 2344 <h4>Editor.handleMonospacedEnable</h4> | |
| 2345 <b>handleMonospacedEnable</b>(<i></i>) | |
| 2346 <p> | |
| 2347 Private slot to handle the Use Monospaced Font context menu entry. | |
| 2348 </p><a NAME="Editor.handleRenamed" ID="Editor.handleRenamed"></a> | |
| 2349 <h4>Editor.handleRenamed</h4> | |
| 2350 <b>handleRenamed</b>(<i>fn</i>) | |
| 2351 <p> | |
| 2352 Public slot to handle the editorRenamed signal. | |
| 2353 </p><dl> | |
| 2354 <dt><i>fn</i></dt> | |
| 2355 <dd> | |
| 2356 filename to be set for the editor (string). | |
| 2357 </dd> | |
| 2358 </dl><a NAME="Editor.hasBookmarks" ID="Editor.hasBookmarks"></a> | |
| 2359 <h4>Editor.hasBookmarks</h4> | |
| 2360 <b>hasBookmarks</b>(<i></i>) | |
| 2361 <p> | |
| 2362 Public method to check for the presence of bookmarks. | |
| 2363 </p><dl> | |
| 2364 <dt>Returns:</dt> | |
| 2365 <dd> | |
| 2366 flag indicating the presence of bookmarks (boolean) | |
| 2367 </dd> | |
| 2368 </dl><a NAME="Editor.hasBreakpoints" ID="Editor.hasBreakpoints"></a> | |
| 2369 <h4>Editor.hasBreakpoints</h4> | |
| 2370 <b>hasBreakpoints</b>(<i></i>) | |
| 2371 <p> | |
| 2372 Public method to check for the presence of breakpoints. | |
| 2373 </p><dl> | |
| 2374 <dt>Returns:</dt> | |
| 2375 <dd> | |
| 2376 flag indicating the presence of breakpoints (boolean) | |
| 2377 </dd> | |
| 2378 </dl><a NAME="Editor.hasCoverageMarkers" ID="Editor.hasCoverageMarkers"></a> | |
| 2379 <h4>Editor.hasCoverageMarkers</h4> | |
| 2380 <b>hasCoverageMarkers</b>(<i></i>) | |
| 2381 <p> | |
| 2382 Public method to test, if there are coverage markers. | |
| 2383 </p><a NAME="Editor.hasMiniMenu" ID="Editor.hasMiniMenu"></a> | |
| 2384 <h4>Editor.hasMiniMenu</h4> | |
| 2385 <b>hasMiniMenu</b>(<i></i>) | |
| 2386 <p> | |
| 2387 Public method to check the miniMenu flag. | |
| 2388 </p><dl> | |
| 2389 <dt>Returns:</dt> | |
| 2390 <dd> | |
| 2391 flag indicating a minimized context menu (boolean) | |
| 2392 </dd> | |
| 2393 </dl><a NAME="Editor.hasSyntaxErrors" ID="Editor.hasSyntaxErrors"></a> | |
| 2394 <h4>Editor.hasSyntaxErrors</h4> | |
| 2395 <b>hasSyntaxErrors</b>(<i></i>) | |
| 2396 <p> | |
| 2397 Public method to check for the presence of bookmarks. | |
| 2398 </p><dl> | |
| 2399 <dt>Returns:</dt> | |
| 2400 <dd> | |
| 2401 flag indicating the presence of bookmarks (boolean) | |
| 2402 </dd> | |
| 2403 </dl><a NAME="Editor.hasTaskMarkers" ID="Editor.hasTaskMarkers"></a> | |
| 2404 <h4>Editor.hasTaskMarkers</h4> | |
| 2405 <b>hasTaskMarkers</b>(<i></i>) | |
| 2406 <p> | |
| 2407 Public method to determine, if this editor contains any task markers. | |
| 2408 </p><dl> | |
| 2409 <dt>Returns:</dt> | |
| 2410 <dd> | |
| 2411 flag indicating the presence of task markers (boolean) | |
| 2412 </dd> | |
| 2413 </dl><a NAME="Editor.highlight" ID="Editor.highlight"></a> | |
| 2414 <h4>Editor.highlight</h4> | |
| 2415 <b>highlight</b>(<i>line = None, error = False, syntaxError = False</i>) | |
| 2416 <p> | |
| 2417 Public method to highlight (or de-highlight) a particular line. | |
| 2418 </p><dl> | |
| 2419 <dt><i>line</i></dt> | |
| 2420 <dd> | |
| 2421 line number to highlight (integer) | |
| 2422 </dd><dt><i>error</i></dt> | |
| 2423 <dd> | |
| 2424 flag indicating whether the error highlight should be used (boolean) | |
| 2425 </dd><dt><i>syntaxError</i></dt> | |
| 2426 <dd> | |
| 2427 flag indicating a syntax error (boolean) | |
| 2428 </dd> | |
| 2429 </dl><a NAME="Editor.highlightVisible" ID="Editor.highlightVisible"></a> | |
| 2430 <h4>Editor.highlightVisible</h4> | |
| 2431 <b>highlightVisible</b>(<i></i>) | |
| 2432 <p> | |
| 2433 Public method to make sure that the highlight is visible. | |
| 2434 </p><a NAME="Editor.indentLineOrSelection" ID="Editor.indentLineOrSelection"></a> | |
| 2435 <h4>Editor.indentLineOrSelection</h4> | |
| 2436 <b>indentLineOrSelection</b>(<i></i>) | |
| 2437 <p> | |
| 2438 Public slot to indent the current line or current selection | |
| 2439 </p><a NAME="Editor.isPy3File" ID="Editor.isPy3File"></a> | |
| 2440 <h4>Editor.isPy3File</h4> | |
| 2441 <b>isPy3File</b>(<i></i>) | |
| 2442 <p> | |
| 2443 Public method to return a flag indicating a Python3 file. | |
| 2444 </p><dl> | |
| 2445 <dt>Returns:</dt> | |
| 2446 <dd> | |
| 2447 flag indicating a Python3 file (boolean) | |
| 2448 </dd> | |
| 2449 </dl><a NAME="Editor.isPyFile" ID="Editor.isPyFile"></a> | |
| 2450 <h4>Editor.isPyFile</h4> | |
| 2451 <b>isPyFile</b>(<i></i>) | |
| 2452 <p> | |
| 2453 Public method to return a flag indicating a Python file. | |
| 2454 </p><dl> | |
| 2455 <dt>Returns:</dt> | |
| 2456 <dd> | |
| 2457 flag indicating a Python file (boolean) | |
| 2458 </dd> | |
| 2459 </dl><a NAME="Editor.isRubyFile" ID="Editor.isRubyFile"></a> | |
| 2460 <h4>Editor.isRubyFile</h4> | |
| 2461 <b>isRubyFile</b>(<i></i>) | |
| 2462 <p> | |
| 2463 Public method to return a flag indicating a Ruby file. | |
| 2464 </p><dl> | |
| 2465 <dt>Returns:</dt> | |
| 2466 <dd> | |
| 2467 flag indicating a Ruby file (boolean) | |
| 2468 </dd> | |
| 2469 </dl><a NAME="Editor.isSpellCheckRegion" ID="Editor.isSpellCheckRegion"></a> | |
| 2470 <h4>Editor.isSpellCheckRegion</h4> | |
| 2471 <b>isSpellCheckRegion</b>(<i>pos</i>) | |
| 2472 <p> | |
| 2473 Public method to check, if the given position is within a region, that should | |
| 2474 be spell checked. | |
| 2475 </p><dl> | |
| 2476 <dt><i>pos</i></dt> | |
| 2477 <dd> | |
| 2478 position to be checked (integer) | |
| 2479 </dd> | |
| 2480 </dl><dl> | |
| 2481 <dt>Returns:</dt> | |
| 2482 <dd> | |
| 2483 flag indicating pos is in a spell check region (boolean) | |
| 2484 </dd> | |
| 2485 </dl><a NAME="Editor.keyPressEvent" ID="Editor.keyPressEvent"></a> | |
| 2486 <h4>Editor.keyPressEvent</h4> | |
| 2487 <b>keyPressEvent</b>(<i>ev</i>) | |
| 2488 <p> | |
| 2489 Re-implemented to handle the user input a key at a time. | |
| 2490 </p><dl> | |
| 2491 <dt><i>ev</i></dt> | |
| 2492 <dd> | |
| 2493 key event (QKeyEvent) | |
| 2494 </dd> | |
| 2495 </dl><a NAME="Editor.languageChanged" ID="Editor.languageChanged"></a> | |
| 2496 <h4>Editor.languageChanged</h4> | |
| 2497 <b>languageChanged</b>(<i>language, propagate = True</i>) | |
| 2498 <p> | |
| 2499 Public slot handling a change of a connected editor's language. | |
| 2500 </p><dl> | |
| 2501 <dt><i>language</i></dt> | |
| 2502 <dd> | |
| 2503 language to be set (string) | |
| 2504 </dd><dt><i>propagate=</i></dt> | |
| 2505 <dd> | |
| 2506 flag indicating to propagate the change (boolean) | |
| 2507 </dd> | |
| 2508 </dl><a NAME="Editor.macroDelete" ID="Editor.macroDelete"></a> | |
| 2509 <h4>Editor.macroDelete</h4> | |
| 2510 <b>macroDelete</b>(<i></i>) | |
| 2511 <p> | |
| 2512 Public method to delete a macro. | |
| 2513 </p><a NAME="Editor.macroLoad" ID="Editor.macroLoad"></a> | |
| 2514 <h4>Editor.macroLoad</h4> | |
| 2515 <b>macroLoad</b>(<i></i>) | |
| 2516 <p> | |
| 2517 Public method to load a macro from a file. | |
| 2518 </p><a NAME="Editor.macroRecordingStart" ID="Editor.macroRecordingStart"></a> | |
| 2519 <h4>Editor.macroRecordingStart</h4> | |
| 2520 <b>macroRecordingStart</b>(<i></i>) | |
| 2521 <p> | |
| 2522 Public method to start macro recording. | |
| 2523 </p><a NAME="Editor.macroRecordingStop" ID="Editor.macroRecordingStop"></a> | |
| 2524 <h4>Editor.macroRecordingStop</h4> | |
| 2525 <b>macroRecordingStop</b>(<i></i>) | |
| 2526 <p> | |
| 2527 Public method to stop macro recording. | |
| 2528 </p><a NAME="Editor.macroRun" ID="Editor.macroRun"></a> | |
| 2529 <h4>Editor.macroRun</h4> | |
| 2530 <b>macroRun</b>(<i></i>) | |
| 2531 <p> | |
| 2532 Public method to execute a macro. | |
| 2533 </p><a NAME="Editor.macroSave" ID="Editor.macroSave"></a> | |
| 2534 <h4>Editor.macroSave</h4> | |
| 2535 <b>macroSave</b>(<i></i>) | |
| 2536 <p> | |
| 2537 Public method to save a macro to a file. | |
| 2538 </p><a NAME="Editor.menuEditBreakpoint" ID="Editor.menuEditBreakpoint"></a> | |
| 2539 <h4>Editor.menuEditBreakpoint</h4> | |
| 2540 <b>menuEditBreakpoint</b>(<i>line = None</i>) | |
| 2541 <p> | |
| 2542 Public slot to handle the 'Edit breakpoint' context menu action. | |
| 2543 </p><dl> | |
| 2544 <dt><i>line</i></dt> | |
| 2545 <dd> | |
| 2546 linenumber of the breakpoint to edit | |
| 2547 </dd> | |
| 2548 </dl><a NAME="Editor.menuNextBreakpoint" ID="Editor.menuNextBreakpoint"></a> | |
| 2549 <h4>Editor.menuNextBreakpoint</h4> | |
| 2550 <b>menuNextBreakpoint</b>(<i></i>) | |
| 2551 <p> | |
| 2552 Public slot to handle the 'Next breakpoint' context menu action. | |
| 2553 </p><a NAME="Editor.menuPreviousBreakpoint" ID="Editor.menuPreviousBreakpoint"></a> | |
| 2554 <h4>Editor.menuPreviousBreakpoint</h4> | |
| 2555 <b>menuPreviousBreakpoint</b>(<i></i>) | |
| 2556 <p> | |
| 2557 Public slot to handle the 'Previous breakpoint' context menu action. | |
| 2558 </p><a NAME="Editor.menuToggleBookmark" ID="Editor.menuToggleBookmark"></a> | |
| 2559 <h4>Editor.menuToggleBookmark</h4> | |
| 2560 <b>menuToggleBookmark</b>(<i></i>) | |
| 2561 <p> | |
| 2562 Public slot to handle the 'Toggle bookmark' context menu action. | |
| 2563 </p><a NAME="Editor.menuToggleBreakpoint" ID="Editor.menuToggleBreakpoint"></a> | |
| 2564 <h4>Editor.menuToggleBreakpoint</h4> | |
| 2565 <b>menuToggleBreakpoint</b>(<i></i>) | |
| 2566 <p> | |
| 2567 Public slot to handle the 'Toggle breakpoint' context menu action. | |
| 2568 </p><a NAME="Editor.mousePressEvent" ID="Editor.mousePressEvent"></a> | |
| 2569 <h4>Editor.mousePressEvent</h4> | |
| 2570 <b>mousePressEvent</b>(<i>event</i>) | |
| 2571 <p> | |
| 2572 Protected method to handle the mouse press event. | |
| 2573 </p><dl> | |
| 2574 <dt><i>event</i></dt> | |
| 2575 <dd> | |
| 2576 the mouse press event (QMouseEvent) | |
| 2577 </dd> | |
| 2578 </dl><a NAME="Editor.newBreakpointWithProperties" ID="Editor.newBreakpointWithProperties"></a> | |
| 2579 <h4>Editor.newBreakpointWithProperties</h4> | |
| 2580 <b>newBreakpointWithProperties</b>(<i>line, properties</i>) | |
| 2581 <p> | |
| 2582 Private method to set a new breakpoint and its properties. | |
| 2583 </p><dl> | |
| 2584 <dt><i>line</i></dt> | |
| 2585 <dd> | |
| 2586 line number of the breakpoint (integer) | |
| 2587 </dd><dt><i>properties</i></dt> | |
| 2588 <dd> | |
| 2589 properties for the breakpoint (tuple) | |
| 2590 (condition, temporary flag, enabled flag, ignore count) | |
| 2591 </dd> | |
| 2592 </dl><a NAME="Editor.nextBookmark" ID="Editor.nextBookmark"></a> | |
| 2593 <h4>Editor.nextBookmark</h4> | |
| 2594 <b>nextBookmark</b>(<i></i>) | |
| 2595 <p> | |
| 2596 Public slot to handle the 'Next bookmark' context menu action. | |
| 2597 </p><a NAME="Editor.nextTask" ID="Editor.nextTask"></a> | |
| 2598 <h4>Editor.nextTask</h4> | |
| 2599 <b>nextTask</b>(<i></i>) | |
| 2600 <p> | |
| 2601 Public slot to handle the 'Next task' context menu action. | |
| 2602 </p><a NAME="Editor.nextUncovered" ID="Editor.nextUncovered"></a> | |
| 2603 <h4>Editor.nextUncovered</h4> | |
| 2604 <b>nextUncovered</b>(<i></i>) | |
| 2605 <p> | |
| 2606 Public slot to handle the 'Next uncovered' context menu action. | |
| 2607 </p><a NAME="Editor.previousBookmark" ID="Editor.previousBookmark"></a> | |
| 2608 <h4>Editor.previousBookmark</h4> | |
| 2609 <b>previousBookmark</b>(<i></i>) | |
| 2610 <p> | |
| 2611 Public slot to handle the 'Previous bookmark' context menu action. | |
| 2612 </p><a NAME="Editor.previousTask" ID="Editor.previousTask"></a> | |
| 2613 <h4>Editor.previousTask</h4> | |
| 2614 <b>previousTask</b>(<i></i>) | |
| 2615 <p> | |
| 2616 Public slot to handle the 'Previous task' context menu action. | |
| 2617 </p><a NAME="Editor.previousUncovered" ID="Editor.previousUncovered"></a> | |
| 2618 <h4>Editor.previousUncovered</h4> | |
| 2619 <b>previousUncovered</b>(<i></i>) | |
| 2620 <p> | |
| 2621 Public slot to handle the 'Previous uncovered' context menu action. | |
| 2622 </p><a NAME="Editor.printFile" ID="Editor.printFile"></a> | |
| 2623 <h4>Editor.printFile</h4> | |
| 2624 <b>printFile</b>(<i></i>) | |
| 2625 <p> | |
| 2626 Public slot to print the text. | |
| 2627 </p><a NAME="Editor.printPreviewFile" ID="Editor.printPreviewFile"></a> | |
| 2628 <h4>Editor.printPreviewFile</h4> | |
| 2629 <b>printPreviewFile</b>(<i></i>) | |
| 2630 <p> | |
| 2631 Public slot to show a print preview of the text. | |
| 2632 </p><a NAME="Editor.projectLexerAssociationsChanged" ID="Editor.projectLexerAssociationsChanged"></a> | |
| 2633 <h4>Editor.projectLexerAssociationsChanged</h4> | |
| 2634 <b>projectLexerAssociationsChanged</b>(<i></i>) | |
| 2635 <p> | |
| 2636 Public slot to handle changes of the project lexer associations. | |
| 2637 </p><a NAME="Editor.readFile" ID="Editor.readFile"></a> | |
| 2638 <h4>Editor.readFile</h4> | |
| 2639 <b>readFile</b>(<i>fn, createIt = False</i>) | |
| 2640 <p> | |
| 2641 Public slot to read the text from a file. | |
| 2642 </p><dl> | |
| 2643 <dt><i>fn</i></dt> | |
| 2644 <dd> | |
| 2645 filename to read from (string) | |
| 2646 </dd><dt><i>createIt</i></dt> | |
| 2647 <dd> | |
| 2648 flag indicating the creation of a new file, if the given | |
| 2649 one doesn't exist (boolean) | |
| 2650 </dd> | |
| 2651 </dl><a NAME="Editor.readLine0" ID="Editor.readLine0"></a> | |
| 2652 <h4>Editor.readLine0</h4> | |
| 2653 <b>readLine0</b>(<i>fn, createIt = False</i>) | |
| 2654 <p> | |
| 2655 Public slot to read the first line from a file. | |
| 2656 </p><dl> | |
| 2657 <dt><i>fn</i></dt> | |
| 2658 <dd> | |
| 2659 filename to read from (string) | |
| 2660 </dd><dt><i>createIt</i></dt> | |
| 2661 <dd> | |
| 2662 flag indicating the creation of a new file, if the given | |
| 2663 one doesn't exist (boolean) | |
| 2664 </dd> | |
| 2665 </dl><dl> | |
| 2666 <dt>Returns:</dt> | |
| 2667 <dd> | |
| 2668 first line of the file (string) | |
| 2669 </dd> | |
| 2670 </dl><a NAME="Editor.readSettings" ID="Editor.readSettings"></a> | |
| 2671 <h4>Editor.readSettings</h4> | |
| 2672 <b>readSettings</b>(<i></i>) | |
| 2673 <p> | |
| 2674 Public slot to read the settings into our lexer. | |
| 2675 </p><a NAME="Editor.redo" ID="Editor.redo"></a> | |
| 2676 <h4>Editor.redo</h4> | |
| 2677 <b>redo</b>(<i></i>) | |
| 2678 <p> | |
| 2679 Public method to redo the last recorded change. | |
| 2680 </p><a NAME="Editor.refresh" ID="Editor.refresh"></a> | |
| 2681 <h4>Editor.refresh</h4> | |
| 2682 <b>refresh</b>(<i></i>) | |
| 2683 <p> | |
| 2684 Public slot to refresh the editor contents. | |
| 2685 </p><a NAME="Editor.removeClone" ID="Editor.removeClone"></a> | |
| 2686 <h4>Editor.removeClone</h4> | |
| 2687 <b>removeClone</b>(<i>editor</i>) | |
| 2688 <p> | |
| 2689 Public method to remove a clone from our list. | |
| 2690 </p><dl> | |
| 2691 <dt><i>clone</i></dt> | |
| 2692 <dd> | |
| 2693 reference to the cloned editor (Editor) | |
| 2694 </dd> | |
| 2695 </dl><a NAME="Editor.revertToUnmodified" ID="Editor.revertToUnmodified"></a> | |
| 2696 <h4>Editor.revertToUnmodified</h4> | |
| 2697 <b>revertToUnmodified</b>(<i></i>) | |
| 2698 <p> | |
| 2699 Public method to revert back to the last saved state. | |
| 2700 </p><a NAME="Editor.saveFile" ID="Editor.saveFile"></a> | |
| 2701 <h4>Editor.saveFile</h4> | |
| 2702 <b>saveFile</b>(<i>saveas = False, path = None</i>) | |
| 2703 <p> | |
| 2704 Public slot to save the text to a file. | |
| 2705 </p><dl> | |
| 2706 <dt><i>saveas</i></dt> | |
| 2707 <dd> | |
| 2708 flag indicating a 'save as' action (boolean) | |
| 2709 </dd><dt><i>path</i></dt> | |
| 2710 <dd> | |
| 2711 directory to save the file in (string) | |
| 2712 </dd> | |
| 2713 </dl><dl> | |
| 2714 <dt>Returns:</dt> | |
| 2715 <dd> | |
| 2716 tuple of two values (boolean, string) giving a success indicator and | |
| 2717 the name of the saved file | |
| 2718 </dd> | |
| 2719 </dl><a NAME="Editor.saveFileAs" ID="Editor.saveFileAs"></a> | |
| 2720 <h4>Editor.saveFileAs</h4> | |
| 2721 <b>saveFileAs</b>(<i>path = None</i>) | |
| 2722 <p> | |
| 2723 Public slot to save a file with a new name. | |
| 2724 </p><dl> | |
| 2725 <dt><i>path</i></dt> | |
| 2726 <dd> | |
| 2727 directory to save the file in (string) | |
| 2728 </dd> | |
| 2729 </dl><dl> | |
| 2730 <dt>Returns:</dt> | |
| 2731 <dd> | |
| 2732 tuple of two values (boolean, string) giving a success indicator and | |
| 2733 the name of the saved file | |
| 2734 </dd> | |
| 2735 </dl><a NAME="Editor.selectCurrentWord" ID="Editor.selectCurrentWord"></a> | |
| 2736 <h4>Editor.selectCurrentWord</h4> | |
| 2737 <b>selectCurrentWord</b>(<i></i>) | |
| 2738 <p> | |
| 2739 Public method to select the current word. | |
| 2740 </p><a NAME="Editor.selectWord" ID="Editor.selectWord"></a> | |
| 2741 <h4>Editor.selectWord</h4> | |
| 2742 <b>selectWord</b>(<i>line, index</i>) | |
| 2743 <p> | |
| 2744 Public method to select the word at a position. | |
| 2745 </p><dl> | |
| 2746 <dt><i>line</i></dt> | |
| 2747 <dd> | |
| 2748 number of line to look at (int) | |
| 2749 </dd><dt><i>index</i></dt> | |
| 2750 <dd> | |
| 2751 position to look at (int) | |
| 2752 </dd> | |
| 2753 </dl><a NAME="Editor.setAutoCompletionEnabled" ID="Editor.setAutoCompletionEnabled"></a> | |
| 2754 <h4>Editor.setAutoCompletionEnabled</h4> | |
| 2755 <b>setAutoCompletionEnabled</b>(<i>enable</i>) | |
| 2756 <p> | |
| 2757 Public method to enable/disable autocompletion. | |
| 2758 </p><dl> | |
| 2759 <dt><i>enable</i></dt> | |
| 2760 <dd> | |
| 2761 flag indicating the desired autocompletion status (boolean) | |
| 2762 </dd> | |
| 2763 </dl><a NAME="Editor.setAutoCompletionHook" ID="Editor.setAutoCompletionHook"></a> | |
| 2764 <h4>Editor.setAutoCompletionHook</h4> | |
| 2765 <b>setAutoCompletionHook</b>(<i>func</i>) | |
| 2766 <p> | |
| 2767 Public method to set an autocompletion hook. | |
| 2768 </p><dl> | |
| 2769 <dt><i>func</i></dt> | |
| 2770 <dd> | |
| 2771 Function to be set to handle autocompletion. func | |
| 2772 should be a function taking a reference to the editor and | |
| 2773 a boolean indicating to complete a context. | |
| 2774 </dd> | |
| 2775 </dl><a NAME="Editor.setAutoSpellChecking" ID="Editor.setAutoSpellChecking"></a> | |
| 2776 <h4>Editor.setAutoSpellChecking</h4> | |
| 2777 <b>setAutoSpellChecking</b>(<i></i>) | |
| 2778 <p> | |
| 2779 Public method to set the automatic spell checking. | |
| 2780 </p><a NAME="Editor.setCallTipHook" ID="Editor.setCallTipHook"></a> | |
| 2781 <h4>Editor.setCallTipHook</h4> | |
| 2782 <b>setCallTipHook</b>(<i>func</i>) | |
| 2783 <p> | |
| 2784 Public method to set a calltip hook. | |
| 2785 </p><dl> | |
| 2786 <dt><i>func</i></dt> | |
| 2787 <dd> | |
| 2788 Function to be set to determine calltips. func | |
| 2789 should be a function taking a reference to the editor, | |
| 2790 a position into the text and the amount of commas to the | |
| 2791 left of the cursor. It should return the possible | |
| 2792 calltips as a list of strings. | |
| 2793 </dd> | |
| 2794 </dl><a NAME="Editor.setEolModeByEolString" ID="Editor.setEolModeByEolString"></a> | |
| 2795 <h4>Editor.setEolModeByEolString</h4> | |
| 2796 <b>setEolModeByEolString</b>(<i>eolStr</i>) | |
| 2797 <p> | |
| 2798 Public method to set the eol mode given the eol string. | |
| 2799 </p><dl> | |
| 2800 <dt><i>eolStr</i></dt> | |
| 2801 <dd> | |
| 2802 eol string (string) | |
| 2803 </dd> | |
| 2804 </dl><a NAME="Editor.setLanguage" ID="Editor.setLanguage"></a> | |
| 2805 <h4>Editor.setLanguage</h4> | |
| 2806 <b>setLanguage</b>(<i>filename, initTextDisplay = True, propagate = True, pyname = ""</i>) | |
| 2807 <p> | |
| 2808 Public method to set a lexer language. | |
| 2809 </p><dl> | |
| 2810 <dt><i>filename</i></dt> | |
| 2811 <dd> | |
| 2812 filename used to determine the associated lexer language (string) | |
| 2813 </dd><dt><i>initTextDisplay</i></dt> | |
| 2814 <dd> | |
| 2815 flag indicating an initialization of the text display | |
| 2816 is required as well (boolean) | |
| 2817 </dd><dt><i>propagate=</i></dt> | |
| 2818 <dd> | |
| 2819 flag indicating to propagate the change (boolean) | |
| 2820 </dd><dt><i>pyname=</i></dt> | |
| 2821 <dd> | |
| 2822 name of the pygments lexer to use (string) | |
| 2823 </dd> | |
| 2824 </dl><a NAME="Editor.setMonospaced" ID="Editor.setMonospaced"></a> | |
| 2825 <h4>Editor.setMonospaced</h4> | |
| 2826 <b>setMonospaced</b>(<i>on</i>) | |
| 2827 <p> | |
| 2828 Public method to set/reset a monospaced font. | |
| 2829 </p><dl> | |
| 2830 <dt><i>on</i></dt> | |
| 2831 <dd> | |
| 2832 flag to indicate usage of a monospace font (boolean) | |
| 2833 </dd> | |
| 2834 </dl><a NAME="Editor.setNoName" ID="Editor.setNoName"></a> | |
| 2835 <h4>Editor.setNoName</h4> | |
| 2836 <b>setNoName</b>(<i>noName</i>) | |
| 2837 <p> | |
| 2838 Public method to set the display string for an unnamed editor. | |
| 2839 </p><dl> | |
| 2840 <dt><i>noName</i></dt> | |
| 2841 <dd> | |
| 2842 display string for this unnamed editor (string) | |
| 2843 </dd> | |
| 2844 </dl><a NAME="Editor.setSearchIndicator" ID="Editor.setSearchIndicator"></a> | |
| 2845 <h4>Editor.setSearchIndicator</h4> | |
| 2846 <b>setSearchIndicator</b>(<i>startPos, indicLength</i>) | |
| 2847 <p> | |
| 2848 Public method to set a search indicator for the given range. | |
| 2849 </p><dl> | |
| 2850 <dt><i>startPos</i></dt> | |
| 2851 <dd> | |
| 2852 start position of the indicator (integer) | |
| 2853 </dd><dt><i>indicLength</i></dt> | |
| 2854 <dd> | |
| 2855 length of the indicator (integer) | |
| 2856 </dd> | |
| 2857 </dl><a NAME="Editor.setSpellingForProject" ID="Editor.setSpellingForProject"></a> | |
| 2858 <h4>Editor.setSpellingForProject</h4> | |
| 2859 <b>setSpellingForProject</b>(<i></i>) | |
| 2860 <p> | |
| 2861 Public method to set the spell checking options for files belonging | |
| 2862 to the current project. | |
| 2863 </p><a NAME="Editor.shortenEmptyLines" ID="Editor.shortenEmptyLines"></a> | |
| 2864 <h4>Editor.shortenEmptyLines</h4> | |
| 2865 <b>shortenEmptyLines</b>(<i></i>) | |
| 2866 <p> | |
| 2867 Public slot to compress lines consisting solely of whitespace characters. | |
| 2868 </p><a NAME="Editor.shouldAutosave" ID="Editor.shouldAutosave"></a> | |
| 2869 <h4>Editor.shouldAutosave</h4> | |
| 2870 <b>shouldAutosave</b>(<i></i>) | |
| 2871 <p> | |
| 2872 Public slot to check the autosave flags. | |
| 2873 </p><dl> | |
| 2874 <dt>Returns:</dt> | |
| 2875 <dd> | |
| 2876 flag indicating this editor should be saved (boolean) | |
| 2877 </dd> | |
| 2878 </dl><a NAME="Editor.smartIndentLineOrSelection" ID="Editor.smartIndentLineOrSelection"></a> | |
| 2879 <h4>Editor.smartIndentLineOrSelection</h4> | |
| 2880 <b>smartIndentLineOrSelection</b>(<i></i>) | |
| 2881 <p> | |
| 2882 Public slot to indent current line smartly. | |
| 2883 </p><a NAME="Editor.streamCommentLine" ID="Editor.streamCommentLine"></a> | |
| 2884 <h4>Editor.streamCommentLine</h4> | |
| 2885 <b>streamCommentLine</b>(<i></i>) | |
| 2886 <p> | |
| 2887 Public slot to stream comment the current line. | |
| 2888 </p><a NAME="Editor.streamCommentLineOrSelection" ID="Editor.streamCommentLineOrSelection"></a> | |
| 2889 <h4>Editor.streamCommentLineOrSelection</h4> | |
| 2890 <b>streamCommentLineOrSelection</b>(<i></i>) | |
| 2891 <p> | |
| 2892 Public slot to stream comment the current line or current selection. | |
| 2893 </p><a NAME="Editor.streamCommentSelection" ID="Editor.streamCommentSelection"></a> | |
| 2894 <h4>Editor.streamCommentSelection</h4> | |
| 2895 <b>streamCommentSelection</b>(<i></i>) | |
| 2896 <p> | |
| 2897 Public slot to comment the current selection. | |
| 2898 </p><a NAME="Editor.toggleBookmark" ID="Editor.toggleBookmark"></a> | |
| 2899 <h4>Editor.toggleBookmark</h4> | |
| 2900 <b>toggleBookmark</b>(<i>line</i>) | |
| 2901 <p> | |
| 2902 Public method to toggle a bookmark. | |
| 2903 </p><dl> | |
| 2904 <dt><i>line</i></dt> | |
| 2905 <dd> | |
| 2906 line number of the bookmark (integer) | |
| 2907 </dd> | |
| 2908 </dl><a NAME="Editor.toggleSyntaxError" ID="Editor.toggleSyntaxError"></a> | |
| 2909 <h4>Editor.toggleSyntaxError</h4> | |
| 2910 <b>toggleSyntaxError</b>(<i>line, error, msg = ""</i>) | |
| 2911 <p> | |
| 2912 Public method to toggle a syntax error indicator. | |
| 2913 </p><dl> | |
| 2914 <dt><i>line</i></dt> | |
| 2915 <dd> | |
| 2916 line number of the syntax error | |
| 2917 </dd><dt><i>error</i></dt> | |
| 2918 <dd> | |
| 2919 flag indicating if the error marker should be | |
| 2920 set or deleted (boolean) | |
| 2921 </dd><dt><i>msg</i></dt> | |
| 2922 <dd> | |
| 2923 error message (string) | |
| 2924 </dd> | |
| 2925 </dl><a NAME="Editor.uncommentLine" ID="Editor.uncommentLine"></a> | |
| 2926 <h4>Editor.uncommentLine</h4> | |
| 2927 <b>uncommentLine</b>(<i></i>) | |
| 2928 <p> | |
| 2929 Public slot to uncomment the current line. | |
| 2930 </p><a NAME="Editor.uncommentLineOrSelection" ID="Editor.uncommentLineOrSelection"></a> | |
| 2931 <h4>Editor.uncommentLineOrSelection</h4> | |
| 2932 <b>uncommentLineOrSelection</b>(<i></i>) | |
| 2933 <p> | |
| 2934 Public slot to uncomment the current line or current selection. | |
| 2935 </p><a NAME="Editor.uncommentSelection" ID="Editor.uncommentSelection"></a> | |
| 2936 <h4>Editor.uncommentSelection</h4> | |
| 2937 <b>uncommentSelection</b>(<i></i>) | |
| 2938 <p> | |
| 2939 Public slot to uncomment the current selection. | |
| 2940 </p><a NAME="Editor.undo" ID="Editor.undo"></a> | |
| 2941 <h4>Editor.undo</h4> | |
| 2942 <b>undo</b>(<i></i>) | |
| 2943 <p> | |
| 2944 Public method to undo the last recorded change. | |
| 2945 </p><a NAME="Editor.unindentLineOrSelection" ID="Editor.unindentLineOrSelection"></a> | |
| 2946 <h4>Editor.unindentLineOrSelection</h4> | |
| 2947 <b>unindentLineOrSelection</b>(<i></i>) | |
| 2948 <p> | |
| 2949 Public slot to unindent the current line or current selection. | |
| 2950 </p><a NAME="Editor.unsetAutoCompletionHook" ID="Editor.unsetAutoCompletionHook"></a> | |
| 2951 <h4>Editor.unsetAutoCompletionHook</h4> | |
| 2952 <b>unsetAutoCompletionHook</b>(<i></i>) | |
| 2953 <p> | |
| 2954 Public method to unset a previously installed autocompletion hook. | |
| 2955 </p><a NAME="Editor.unsetCallTipHook" ID="Editor.unsetCallTipHook"></a> | |
| 2956 <h4>Editor.unsetCallTipHook</h4> | |
| 2957 <b>unsetCallTipHook</b>(<i></i>) | |
| 2958 <p> | |
| 2959 Public method to unset a calltip hook. | |
| 2960 </p><a NAME="Editor.writeFile" ID="Editor.writeFile"></a> | |
| 2961 <h4>Editor.writeFile</h4> | |
| 2962 <b>writeFile</b>(<i>fn</i>) | |
| 2963 <p> | |
| 2964 Public slot to write the text to a file. | |
| 2965 </p><dl> | |
| 2966 <dt><i>fn</i></dt> | |
| 2967 <dd> | |
| 2968 filename to write to (string) | |
| 2969 </dd> | |
| 2970 </dl><dl> | |
| 2971 <dt>Returns:</dt> | |
| 2972 <dd> | |
| 2973 flag indicating success | |
| 2974 </dd> | |
| 2975 </dl> | |
| 2976 <div align="right"><a href="#top">Up</a></div> | |
| 2977 <hr /> | |
| 2978 </body></html> |
