Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.QScintilla.Editor.html

eric6/Documentation/Source/eric6.QScintilla.Editor.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6826
c6dda2cbe081
parent 6942
2602857055c5
child 7035
d2036d7f5ef6
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.QScintilla.Editor</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.QScintilla.Editor</h1>
23 <p>
24 Module implementing the editor component of the eric6 IDE.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>EditorAutoCompletionListID</td></tr><tr><td>TemplateCompletionListID</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#Editor">Editor</a></td>
34 <td>Class implementing the editor component of the eric6 IDE.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="Editor" ID="Editor"></a>
43 <h2>Editor</h2>
44 <p>
45 Class implementing the editor component of the eric6 IDE.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>autoCompletionAPIsAvailable(bool)</dt>
49 <dd>
50 emitted after the autocompletion
51 function has been configured
52 </dd><dt>bookmarkToggled(QsciScintillaCompat)</dt>
53 <dd>
54 emitted when a bookmark is
55 toggled
56 </dd><dt>breakpointToggled(QsciScintillaCompat)</dt>
57 <dd>
58 emitted when a breakpoint
59 is toggled
60 </dd><dt>captionChanged(str, QsciScintillaCompat)</dt>
61 <dd>
62 emitted when the caption
63 is updated. Typically due to a readOnly attribute change.
64 </dd><dt>changeMarkersUpdated(QsciScintillaCompat)</dt>
65 <dd>
66 emitted when the change
67 markers were updated
68 </dd><dt>coverageMarkersShown(bool)</dt>
69 <dd>
70 emitted after the coverage markers have
71 been shown or cleared
72 </dd><dt>cursorChanged(str, int, int)</dt>
73 <dd>
74 emitted when the cursor position
75 was changed
76 </dd><dt>cursorLineChanged(int)</dt>
77 <dd>
78 emitted when the cursor line was changed
79 </dd><dt>editorAboutToBeSaved(str)</dt>
80 <dd>
81 emitted before the editor is saved
82 </dd><dt>editorRenamed(str)</dt>
83 <dd>
84 emitted after the editor got a new name
85 (i.e. after a 'Save As')
86 </dd><dt>editorSaved(str)</dt>
87 <dd>
88 emitted after the editor has been saved
89 </dd><dt>encodingChanged(str)</dt>
90 <dd>
91 emitted when the editors encoding was set. The
92 encoding name is passed as a parameter.
93 </dd><dt>eolChanged(str)</dt>
94 <dd>
95 emitted when the editors eol type was set. The eol
96 string is passed as a parameter.
97 </dd><dt>languageChanged(str)</dt>
98 <dd>
99 emitted when the editors language was set. The
100 language is passed as a parameter.
101 </dd><dt>lastEditPositionAvailable()</dt>
102 <dd>
103 emitted when a last edit position is
104 available
105 </dd><dt>modificationStatusChanged(bool, QsciScintillaCompat)</dt>
106 <dd>
107 emitted when
108 the modification status has changed
109 </dd><dt>mouseDoubleClick(position, buttons)</dt>
110 <dd>
111 emitted to signal a mouse
112 double click somewhere in the editor area
113 </dd><dt>redoAvailable(bool)</dt>
114 <dd>
115 emitted to signal the redo availability
116 </dd><dt>refreshed()</dt>
117 <dd>
118 emitted to signal a refresh of the editor contents
119 </dd><dt>settingsRead()</dt>
120 <dd>
121 emitted to signal, that the settings have been read
122 and set
123 </dd><dt>showMenu(str, QMenu, QsciScintillaCompat)</dt>
124 <dd>
125 emitted when a menu is
126 about to be shown. The name of the menu, a reference to the menu and
127 a reference to the editor are given.
128 </dd><dt>syntaxerrorToggled(QsciScintillaCompat)</dt>
129 <dd>
130 emitted when a syntax error
131 was discovered
132 </dd><dt>taskMarkersUpdated(QsciScintillaCompat)</dt>
133 <dd>
134 emitted when the task
135 markers were updated
136 </dd><dt>undoAvailable(bool)</dt>
137 <dd>
138 emitted to signal the undo availability
139 </dd>
140 </dl>
141 <h3>Derived from</h3>
142 QsciScintillaCompat
143 <h3>Class Attributes</h3>
144 <table>
145 <tr><td>AttributeID</td></tr><tr><td>AttributePrivateID</td></tr><tr><td>AttributeProtectedID</td></tr><tr><td>CancelEditToken</td></tr><tr><td>ClassID</td></tr><tr><td>ClassPrivateID</td></tr><tr><td>ClassProtectedID</td></tr><tr><td>EndEditToken</td></tr><tr><td>EnumID</td></tr><tr><td>FromDocumentID</td></tr><tr><td>KeywordsID</td></tr><tr><td>MethodID</td></tr><tr><td>MethodPrivateID</td></tr><tr><td>MethodProtectedID</td></tr><tr><td>ModuleID</td></tr><tr><td>RequestSyncToken</td></tr><tr><td>Separator</td></tr><tr><td>StartEditToken</td></tr><tr><td>SyncToken</td></tr><tr><td>TemplateImageID</td></tr><tr><td>VcsConflictMarkerLineRegExpList</td></tr><tr><td>WarningCode</td></tr><tr><td>WarningStyle</td></tr>
146 </table>
147 <h3>Class Methods</h3>
148 <table>
149 <tr><td>None</td></tr>
150 </table>
151 <h3>Methods</h3>
152 <table>
153 <tr>
154 <td><a href="#Editor.__init__">Editor</a></td>
155 <td>Constructor</td>
156 </tr><tr>
157 <td><a href="#Editor.__addBreakPoint">__addBreakPoint</a></td>
158 <td>Private method to add a new breakpoint.</td>
159 </tr><tr>
160 <td><a href="#Editor.__addBreakPoints">__addBreakPoints</a></td>
161 <td>Private slot to add breakpoints.</td>
162 </tr><tr>
163 <td><a href="#Editor.__addFileAliasResource">__addFileAliasResource</a></td>
164 <td>Private method to handle the Add aliased file context menu action.</td>
165 </tr><tr>
166 <td><a href="#Editor.__addFileResource">__addFileResource</a></td>
167 <td>Private method to handle the Add file context menu action.</td>
168 </tr><tr>
169 <td><a href="#Editor.__addFileResources">__addFileResources</a></td>
170 <td>Private method to handle the Add files context menu action.</td>
171 </tr><tr>
172 <td><a href="#Editor.__addLocalizedResource">__addLocalizedResource</a></td>
173 <td>Private method to handle the Add localized resource context menu action.</td>
174 </tr><tr>
175 <td><a href="#Editor.__addResourceFrame">__addResourceFrame</a></td>
176 <td>Private method to handle the Add resource frame context menu action.</td>
177 </tr><tr>
178 <td><a href="#Editor.__addToSpellingDictionary">__addToSpellingDictionary</a></td>
179 <td>Private slot to add the word below the spelling context menu to the dictionary.</td>
180 </tr><tr>
181 <td><a href="#Editor.__adjustedCallTipPosition">__adjustedCallTipPosition</a></td>
182 <td>Private method to calculate an adjusted position for showing calltips.</td>
183 </tr><tr>
184 <td><a href="#Editor.__applyTemplate">__applyTemplate</a></td>
185 <td>Private method to apply a template by name.</td>
186 </tr><tr>
187 <td><a href="#Editor.__autoComplete">__autoComplete</a></td>
188 <td>Private method to start auto-completion via plug-ins.</td>
189 </tr><tr>
190 <td><a href="#Editor.__autocompletionCancelled">__autocompletionCancelled</a></td>
191 <td>Private slot to handle the cancellation of an auto-completion list.</td>
192 </tr><tr>
193 <td><a href="#Editor.__autosaveEnable">__autosaveEnable</a></td>
194 <td>Private slot handling the autosave enable context menu action.</td>
195 </tr><tr>
196 <td><a href="#Editor.__bindCompleter">__bindCompleter</a></td>
197 <td>Private slot to set the correct typing completer depending on language.</td>
198 </tr><tr>
199 <td><a href="#Editor.__bindLexer">__bindLexer</a></td>
200 <td>Private slot to set the correct lexer depending on language.</td>
201 </tr><tr>
202 <td><a href="#Editor.__bindName">__bindName</a></td>
203 <td>Private method to generate a dummy filename for binding a lexer.</td>
204 </tr><tr>
205 <td><a href="#Editor.__breakPointDataAboutToBeChanged">__breakPointDataAboutToBeChanged</a></td>
206 <td>Private slot to handle the dataAboutToBeChanged signal of the breakpoint model.</td>
207 </tr><tr>
208 <td><a href="#Editor.__calculateChanges">__calculateChanges</a></td>
209 <td>Private method to determine change commands to convert old text into new text.</td>
210 </tr><tr>
211 <td><a href="#Editor.__callTip">__callTip</a></td>
212 <td>Private method to show call tips provided by a plugin.</td>
213 </tr><tr>
214 <td><a href="#Editor.__changeBreakPoints">__changeBreakPoints</a></td>
215 <td>Private slot to set changed breakpoints.</td>
216 </tr><tr>
217 <td><a href="#Editor.__charAdded">__charAdded</a></td>
218 <td>Private slot called to handle the user entering a character.</td>
219 </tr><tr>
220 <td><a href="#Editor.__checkEncoding">__checkEncoding</a></td>
221 <td>Private method to check the selected encoding of the encodings submenu.</td>
222 </tr><tr>
223 <td><a href="#Editor.__checkEol">__checkEol</a></td>
224 <td>Private method to check the selected eol type of the eol submenu.</td>
225 </tr><tr>
226 <td><a href="#Editor.__checkLanguage">__checkLanguage</a></td>
227 <td>Private method to check the selected language of the language submenu.</td>
228 </tr><tr>
229 <td><a href="#Editor.__checkSpellingSelection">__checkSpellingSelection</a></td>
230 <td>Private slot to spell check the current selection.</td>
231 </tr><tr>
232 <td><a href="#Editor.__checkSpellingWord">__checkSpellingWord</a></td>
233 <td>Private slot to check the word below the spelling context menu.</td>
234 </tr><tr>
235 <td><a href="#Editor.__clearBreakpoints">__clearBreakpoints</a></td>
236 <td>Private slot to clear all breakpoints.</td>
237 </tr><tr>
238 <td><a href="#Editor.__clearCompletionsCache">__clearCompletionsCache</a></td>
239 <td>Private method to clear the auto-completions cache.</td>
240 </tr><tr>
241 <td><a href="#Editor.__clearTypedWarning">__clearTypedWarning</a></td>
242 <td>Private method to clear warnings of a specific kind.</td>
243 </tr><tr>
244 <td><a href="#Editor.__codeCoverageHideAnnotations">__codeCoverageHideAnnotations</a></td>
245 <td>Private method to handle the hide code coverage annotations context menu action.</td>
246 </tr><tr>
247 <td><a href="#Editor.__completionListSelected">__completionListSelected</a></td>
248 <td>Private slot to handle the selection from the completion list.</td>
249 </tr><tr>
250 <td><a href="#Editor.__contextClose">__contextClose</a></td>
251 <td>Private slot handling the close context menu entry.</td>
252 </tr><tr>
253 <td><a href="#Editor.__contextMenuCollapseFoldWithChildren">__contextMenuCollapseFoldWithChildren</a></td>
254 <td>Private slot to handle the context menu collapse with children action.</td>
255 </tr><tr>
256 <td><a href="#Editor.__contextMenuExpandFoldWithChildren">__contextMenuExpandFoldWithChildren</a></td>
257 <td>Private slot to handle the context menu expand with children action.</td>
258 </tr><tr>
259 <td><a href="#Editor.__contextMenuSpellingTriggered">__contextMenuSpellingTriggered</a></td>
260 <td>Private slot to handle the selection of a suggestion of the spelling context menu.</td>
261 </tr><tr>
262 <td><a href="#Editor.__contextOpenRejections">__contextOpenRejections</a></td>
263 <td>Private slot handling the open rejections file context menu entry.</td>
264 </tr><tr>
265 <td><a href="#Editor.__contextSave">__contextSave</a></td>
266 <td>Private slot handling the save context menu entry.</td>
267 </tr><tr>
268 <td><a href="#Editor.__contextSaveAs">__contextSaveAs</a></td>
269 <td>Private slot handling the save as context menu entry.</td>
270 </tr><tr>
271 <td><a href="#Editor.__contextSaveCopy">__contextSaveCopy</a></td>
272 <td>Private slot handling the save copy context menu entry.</td>
273 </tr><tr>
274 <td><a href="#Editor.__createChangeMarkerPixmap">__createChangeMarkerPixmap</a></td>
275 <td>Private method to create a pixmap for the change markers.</td>
276 </tr><tr>
277 <td><a href="#Editor.__cursorPositionChanged">__cursorPositionChanged</a></td>
278 <td>Private slot to handle the cursorPositionChanged signal.</td>
279 </tr><tr>
280 <td><a href="#Editor.__deleteAllChangeMarkers">__deleteAllChangeMarkers</a></td>
281 <td>Private slot to delete all change markers.</td>
282 </tr><tr>
283 <td><a href="#Editor.__deleteBreakPoints">__deleteBreakPoints</a></td>
284 <td>Private slot to delete breakpoints.</td>
285 </tr><tr>
286 <td><a href="#Editor.__deselectAll">__deselectAll</a></td>
287 <td>Private slot handling the deselect all context menu action.</td>
288 </tr><tr>
289 <td><a href="#Editor.__dispatchCommand">__dispatchCommand</a></td>
290 <td>Private method to dispatch received commands.</td>
291 </tr><tr>
292 <td><a href="#Editor.__encodingChanged">__encodingChanged</a></td>
293 <td>Private slot to handle a change of the encoding.</td>
294 </tr><tr>
295 <td><a href="#Editor.__encodingsMenuTriggered">__encodingsMenuTriggered</a></td>
296 <td>Private method to handle the selection of an encoding.</td>
297 </tr><tr>
298 <td><a href="#Editor.__eolChanged">__eolChanged</a></td>
299 <td>Private slot to handle a change of the eol mode.</td>
300 </tr><tr>
301 <td><a href="#Editor.__eolMenuTriggered">__eolMenuTriggered</a></td>
302 <td>Private method to handle the selection of an eol type.</td>
303 </tr><tr>
304 <td><a href="#Editor.__executeSelection">__executeSelection</a></td>
305 <td>Private slot to execute the selected text in the shell window.</td>
306 </tr><tr>
307 <td><a href="#Editor.__exportMenuTriggered">__exportMenuTriggered</a></td>
308 <td>Private method to handle the selection of an export format.</td>
309 </tr><tr>
310 <td><a href="#Editor.__getAcText">__getAcText</a></td>
311 <td>Private method to get the text from cursor position for autocompleting.</td>
312 </tr><tr>
313 <td><a href="#Editor.__getCharacter">__getCharacter</a></td>
314 <td>Private method to get the character to the left of the current position in the current line.</td>
315 </tr><tr>
316 <td><a href="#Editor.__getCodeCoverageFile">__getCodeCoverageFile</a></td>
317 <td>Private method to get the file name of the file containing coverage info.</td>
318 </tr><tr>
319 <td><a href="#Editor.__getEditorConfig">__getEditorConfig</a></td>
320 <td>Private method to get the requested option via EditorConfig.</td>
321 </tr><tr>
322 <td><a href="#Editor.__getMacroName">__getMacroName</a></td>
323 <td>Private method to select a macro name from the list of macros.</td>
324 </tr><tr>
325 <td><a href="#Editor.__getPyVersion">__getPyVersion</a></td>
326 <td>Private method to return the Python main version (2 or 3) or 0 if it's not a Python file at all.</td>
327 </tr><tr>
328 <td><a href="#Editor.__getSaveFileName">__getSaveFileName</a></td>
329 <td>Private method to get the name of the file to be saved.</td>
330 </tr><tr>
331 <td><a href="#Editor.__ignoreSpellingAlways">__ignoreSpellingAlways</a></td>
332 <td>Private to always ignore the word below the spelling context menu.</td>
333 </tr><tr>
334 <td><a href="#Editor.__indentLine">__indentLine</a></td>
335 <td>Private method to indent or unindent the current line.</td>
336 </tr><tr>
337 <td><a href="#Editor.__indentSelection">__indentSelection</a></td>
338 <td>Private method to indent or unindent the current selection.</td>
339 </tr><tr>
340 <td><a href="#Editor.__initContextMenu">__initContextMenu</a></td>
341 <td>Private method used to setup the context menu.</td>
342 </tr><tr>
343 <td><a href="#Editor.__initContextMenuAutocompletion">__initContextMenuAutocompletion</a></td>
344 <td>Private method used to setup the Checks context sub menu.</td>
345 </tr><tr>
346 <td><a href="#Editor.__initContextMenuChecks">__initContextMenuChecks</a></td>
347 <td>Private method used to setup the Checks context sub menu.</td>
348 </tr><tr>
349 <td><a href="#Editor.__initContextMenuEncodings">__initContextMenuEncodings</a></td>
350 <td>Private method used to setup the Encodings context sub menu.</td>
351 </tr><tr>
352 <td><a href="#Editor.__initContextMenuEol">__initContextMenuEol</a></td>
353 <td>Private method to setup the eol context sub menu.</td>
354 </tr><tr>
355 <td><a href="#Editor.__initContextMenuExporters">__initContextMenuExporters</a></td>
356 <td>Private method used to setup the Exporters context sub menu.</td>
357 </tr><tr>
358 <td><a href="#Editor.__initContextMenuGraphics">__initContextMenuGraphics</a></td>
359 <td>Private method used to setup the diagrams context sub menu.</td>
360 </tr><tr>
361 <td><a href="#Editor.__initContextMenuLanguages">__initContextMenuLanguages</a></td>
362 <td>Private method used to setup the Languages context sub menu.</td>
363 </tr><tr>
364 <td><a href="#Editor.__initContextMenuMargins">__initContextMenuMargins</a></td>
365 <td>Private method used to setup the context menu for the margins.</td>
366 </tr><tr>
367 <td><a href="#Editor.__initContextMenuReopenWithEncoding">__initContextMenuReopenWithEncoding</a></td>
368 <td>Private method used to setup the Reopen With Encoding context sub menu.</td>
369 </tr><tr>
370 <td><a href="#Editor.__initContextMenuResources">__initContextMenuResources</a></td>
371 <td>Private method used to setup the Resources context sub menu.</td>
372 </tr><tr>
373 <td><a href="#Editor.__initContextMenuShow">__initContextMenuShow</a></td>
374 <td>Private method used to setup the Show context sub menu.</td>
375 </tr><tr>
376 <td><a href="#Editor.__initContextMenuTools">__initContextMenuTools</a></td>
377 <td>Private method used to setup the Tools context sub menu.</td>
378 </tr><tr>
379 <td><a href="#Editor.__initOnlineChangeTrace">__initOnlineChangeTrace</a></td>
380 <td>Private slot to initialize the online change trace.</td>
381 </tr><tr>
382 <td><a href="#Editor.__initOnlineSyntaxCheck">__initOnlineSyntaxCheck</a></td>
383 <td>Private slot to initialize the online syntax check.</td>
384 </tr><tr>
385 <td><a href="#Editor.__isCommentedLine">__isCommentedLine</a></td>
386 <td>Private method to check, if the given line is a comment line as produced by the configured comment rules.</td>
387 </tr><tr>
388 <td><a href="#Editor.__isStartChar">__isStartChar</a></td>
389 <td>Private method to check, if a character is an autocompletion start character.</td>
390 </tr><tr>
391 <td><a href="#Editor.__languageChanged">__languageChanged</a></td>
392 <td>Private slot handling a change of a connected editor's language.</td>
393 </tr><tr>
394 <td><a href="#Editor.__languageMenuTriggered">__languageMenuTriggered</a></td>
395 <td>Private method to handle the selection of a lexer language.</td>
396 </tr><tr>
397 <td><a href="#Editor.__lmBbookmarks">__lmBbookmarks</a></td>
398 <td>Private method to handle the 'LMB toggles bookmark' context menu action.</td>
399 </tr><tr>
400 <td><a href="#Editor.__lmBbreakpoints">__lmBbreakpoints</a></td>
401 <td>Private method to handle the 'LMB toggles breakpoint' context menu action.</td>
402 </tr><tr>
403 <td><a href="#Editor.__loadDiagram">__loadDiagram</a></td>
404 <td>Private slot to load a diagram from file.</td>
405 </tr><tr>
406 <td><a href="#Editor.__loadEditorConfig">__loadEditorConfig</a></td>
407 <td>Private method to load the EditorConfig properties.</td>
408 </tr><tr>
409 <td><a href="#Editor.__loadEditorConfigObject">__loadEditorConfigObject</a></td>
410 <td>Private method to load the EditorConfig properties for the given file name.</td>
411 </tr><tr>
412 <td><a href="#Editor.__marginClicked">__marginClicked</a></td>
413 <td>Private slot to handle the marginClicked signal.</td>
414 </tr><tr>
415 <td><a href="#Editor.__marginNumber">__marginNumber</a></td>
416 <td>Private method to calculate the margin number based on a x position.</td>
417 </tr><tr>
418 <td><a href="#Editor.__markOccurrences">__markOccurrences</a></td>
419 <td>Private method to mark all occurrences of the current word.</td>
420 </tr><tr>
421 <td><a href="#Editor.__menuClearBreakpoints">__menuClearBreakpoints</a></td>
422 <td>Private slot to handle the 'Clear all breakpoints' context menu action.</td>
423 </tr><tr>
424 <td><a href="#Editor.__menuToggleBreakpointEnabled">__menuToggleBreakpointEnabled</a></td>
425 <td>Private slot to handle the 'Enable/Disable breakpoint' context menu action.</td>
426 </tr><tr>
427 <td><a href="#Editor.__menuToggleTemporaryBreakpoint">__menuToggleTemporaryBreakpoint</a></td>
428 <td>Private slot to handle the 'Toggle temporary breakpoint' context menu action.</td>
429 </tr><tr>
430 <td><a href="#Editor.__modificationChanged">__modificationChanged</a></td>
431 <td>Private slot to handle the modificationChanged signal.</td>
432 </tr><tr>
433 <td><a href="#Editor.__modificationReadOnly">__modificationReadOnly</a></td>
434 <td>Private slot to handle the modificationAttempted signal.</td>
435 </tr><tr>
436 <td><a href="#Editor.__modified">__modified</a></td>
437 <td>Private method to handle changes of the number of lines.</td>
438 </tr><tr>
439 <td><a href="#Editor.__newView">__newView</a></td>
440 <td>Private slot to create a new view to an open document.</td>
441 </tr><tr>
442 <td><a href="#Editor.__newViewNewSplit">__newViewNewSplit</a></td>
443 <td>Private slot to create a new view to an open document.</td>
444 </tr><tr>
445 <td><a href="#Editor.__normalizedEncoding">__normalizedEncoding</a></td>
446 <td>Private method to calculate the normalized encoding string.</td>
447 </tr><tr>
448 <td><a href="#Editor.__onlineChangeTraceTimerTimeout">__onlineChangeTraceTimerTimeout</a></td>
449 <td>Private slot to mark added and changed lines.</td>
450 </tr><tr>
451 <td><a href="#Editor.__printPreview">__printPreview</a></td>
452 <td>Private slot to generate a print preview.</td>
453 </tr><tr>
454 <td><a href="#Editor.__processEndEditCommand">__processEndEditCommand</a></td>
455 <td>Private slot to process a remote EndEdit command.</td>
456 </tr><tr>
457 <td><a href="#Editor.__processFlags">__processFlags</a></td>
458 <td>Private method to extract flags and process them.</td>
459 </tr><tr>
460 <td><a href="#Editor.__processRequestSyncCommand">__processRequestSyncCommand</a></td>
461 <td>Private slot to process a remote RequestSync command.</td>
462 </tr><tr>
463 <td><a href="#Editor.__processStartEditCommand">__processStartEditCommand</a></td>
464 <td>Private slot to process a remote StartEdit command.</td>
465 </tr><tr>
466 <td><a href="#Editor.__processSyncCommand">__processSyncCommand</a></td>
467 <td>Private slot to process a remote Sync command.</td>
468 </tr><tr>
469 <td><a href="#Editor.__processSyntaxCheckError">__processSyntaxCheckError</a></td>
470 <td>Private slot to report an error message of a syntax check.</td>
471 </tr><tr>
472 <td><a href="#Editor.__processSyntaxCheckResult">__processSyntaxCheckResult</a></td>
473 <td>Private slot to report the resulting messages of a syntax check.</td>
474 </tr><tr>
475 <td><a href="#Editor.__projectPropertiesChanged">__projectPropertiesChanged</a></td>
476 <td>Private slot to handle changes of the project properties.</td>
477 </tr><tr>
478 <td><a href="#Editor.__refreshAnnotations">__refreshAnnotations</a></td>
479 <td>Private method to refresh the annotations.</td>
480 </tr><tr>
481 <td><a href="#Editor.__registerImages">__registerImages</a></td>
482 <td>Private method to register images for autocompletion lists.</td>
483 </tr><tr>
484 <td><a href="#Editor.__reinitOnlineChangeTrace">__reinitOnlineChangeTrace</a></td>
485 <td>Private slot to re-initialize the online change trace.</td>
486 </tr><tr>
487 <td><a href="#Editor.__removeFromSpellingDictionary">__removeFromSpellingDictionary</a></td>
488 <td>Private slot to remove the word below the context menu to the dictionary.</td>
489 </tr><tr>
490 <td><a href="#Editor.__removeTrailingWhitespace">__removeTrailingWhitespace</a></td>
491 <td>Private method to remove trailing whitespace.</td>
492 </tr><tr>
493 <td><a href="#Editor.__reopenWithEncodingMenuTriggered">__reopenWithEncodingMenuTriggered</a></td>
494 <td>Private method to handle the rereading of the file with a selected encoding.</td>
495 </tr><tr>
496 <td><a href="#Editor.__replaceLeadingUnderscores">__replaceLeadingUnderscores</a></td>
497 <td>Private method to replace the first two underlines for invers sorting.</td>
498 </tr><tr>
499 <td><a href="#Editor.__resetLanguage">__resetLanguage</a></td>
500 <td>Private method used to reset the language selection.</td>
501 </tr><tr>
502 <td><a href="#Editor.__resetOnlineChangeTraceInfo">__resetOnlineChangeTraceInfo</a></td>
503 <td>Private slot to reset the online change trace info.</td>
504 </tr><tr>
505 <td><a href="#Editor.__resetOnlineChangeTraceTimer">__resetOnlineChangeTraceTimer</a></td>
506 <td>Private method to reset the online syntax check timer.</td>
507 </tr><tr>
508 <td><a href="#Editor.__resetOnlineSyntaxCheckTimer">__resetOnlineSyntaxCheckTimer</a></td>
509 <td>Private method to reset the online syntax check timer.</td>
510 </tr><tr>
511 <td><a href="#Editor.__resizeLinenoMargin">__resizeLinenoMargin</a></td>
512 <td>Private slot to resize the line numbers margin.</td>
513 </tr><tr>
514 <td><a href="#Editor.__restoreBreakpoints">__restoreBreakpoints</a></td>
515 <td>Private method to restore the breakpoints.</td>
516 </tr><tr>
517 <td><a href="#Editor.__saveLastEditPosition">__saveLastEditPosition</a></td>
518 <td>Private slot to record the last edit position.</td>
519 </tr><tr>
520 <td><a href="#Editor.__searchCurrentWord">__searchCurrentWord</a></td>
521 <td>Private slot to search the next occurrence of the current word.</td>
522 </tr><tr>
523 <td><a href="#Editor.__selectAll">__selectAll</a></td>
524 <td>Private slot handling the select all context menu action.</td>
525 </tr><tr>
526 <td><a href="#Editor.__selectPygmentsLexer">__selectPygmentsLexer</a></td>
527 <td>Private method to select a specific pygments lexer.</td>
528 </tr><tr>
529 <td><a href="#Editor.__send">__send</a></td>
530 <td>Private method to send an editor command to remote editors.</td>
531 </tr><tr>
532 <td><a href="#Editor.__setAnnotation">__setAnnotation</a></td>
533 <td>Private method to set the annotations for the given line.</td>
534 </tr><tr>
535 <td><a href="#Editor.__setAnnotationStyles">__setAnnotationStyles</a></td>
536 <td>Private slot to define the style used by inline annotations.</td>
537 </tr><tr>
538 <td><a href="#Editor.__setAutoCompletion">__setAutoCompletion</a></td>
539 <td>Private method to configure the autocompletion function.</td>
540 </tr><tr>
541 <td><a href="#Editor.__setCallTips">__setCallTips</a></td>
542 <td>Private method to configure the calltips function.</td>
543 </tr><tr>
544 <td><a href="#Editor.__setEolMode">__setEolMode</a></td>
545 <td>Private method to configure the eol mode of the editor.</td>
546 </tr><tr>
547 <td><a href="#Editor.__setLineMarkerColours">__setLineMarkerColours</a></td>
548 <td>Private method to set the line marker colours.</td>
549 </tr><tr>
550 <td><a href="#Editor.__setMarginsDisplay">__setMarginsDisplay</a></td>
551 <td>Private method to configure margins 0 and 2.</td>
552 </tr><tr>
553 <td><a href="#Editor.__setSpelling">__setSpelling</a></td>
554 <td>Private method to initialize the spell checking functionality.</td>
555 </tr><tr>
556 <td><a href="#Editor.__setSpellingLanguage">__setSpellingLanguage</a></td>
557 <td>Private slot to set the spell checking language.</td>
558 </tr><tr>
559 <td><a href="#Editor.__setTabAndIndent">__setTabAndIndent</a></td>
560 <td>Private method to set indentation size and style and tab width.</td>
561 </tr><tr>
562 <td><a href="#Editor.__setTextDisplay">__setTextDisplay</a></td>
563 <td>Private method to configure the text display.</td>
564 </tr><tr>
565 <td><a href="#Editor.__showApplicationDiagram">__showApplicationDiagram</a></td>
566 <td>Private method to handle the Imports Diagram context menu action.</td>
567 </tr><tr>
568 <td><a href="#Editor.__showClassDiagram">__showClassDiagram</a></td>
569 <td>Private method to handle the Class Diagram context menu action.</td>
570 </tr><tr>
571 <td><a href="#Editor.__showCodeCoverage">__showCodeCoverage</a></td>
572 <td>Private method to handle the code coverage context menu action.</td>
573 </tr><tr>
574 <td><a href="#Editor.__showCodeInfo">__showCodeInfo</a></td>
575 <td>Private slot to handle the context menu action to show code info.</td>
576 </tr><tr>
577 <td><a href="#Editor.__showCodeMetrics">__showCodeMetrics</a></td>
578 <td>Private method to handle the code metrics context menu action.</td>
579 </tr><tr>
580 <td><a href="#Editor.__showCompletionsList">__showCompletionsList</a></td>
581 <td>Private method to show the completions list.</td>
582 </tr><tr>
583 <td><a href="#Editor.__showContextMenu">__showContextMenu</a></td>
584 <td>Private slot handling the aboutToShow signal of the context menu.</td>
585 </tr><tr>
586 <td><a href="#Editor.__showContextMenuAutocompletion">__showContextMenuAutocompletion</a></td>
587 <td>Private slot called before the autocompletion menu is shown.</td>
588 </tr><tr>
589 <td><a href="#Editor.__showContextMenuChecks">__showContextMenuChecks</a></td>
590 <td>Private slot handling the aboutToShow signal of the checks context menu.</td>
591 </tr><tr>
592 <td><a href="#Editor.__showContextMenuEncodings">__showContextMenuEncodings</a></td>
593 <td>Private slot handling the aboutToShow signal of the encodings context menu.</td>
594 </tr><tr>
595 <td><a href="#Editor.__showContextMenuEol">__showContextMenuEol</a></td>
596 <td>Private slot handling the aboutToShow signal of the eol context menu.</td>
597 </tr><tr>
598 <td><a href="#Editor.__showContextMenuGraphics">__showContextMenuGraphics</a></td>
599 <td>Private slot handling the aboutToShow signal of the diagrams context menu.</td>
600 </tr><tr>
601 <td><a href="#Editor.__showContextMenuLanguages">__showContextMenuLanguages</a></td>
602 <td>Private slot handling the aboutToShow signal of the languages context menu.</td>
603 </tr><tr>
604 <td><a href="#Editor.__showContextMenuMargin">__showContextMenuMargin</a></td>
605 <td>Private slot handling the aboutToShow signal of the margins context menu.</td>
606 </tr><tr>
607 <td><a href="#Editor.__showContextMenuResources">__showContextMenuResources</a></td>
608 <td>Private slot handling the aboutToShow signal of the resources context menu.</td>
609 </tr><tr>
610 <td><a href="#Editor.__showContextMenuShow">__showContextMenuShow</a></td>
611 <td>Private slot called before the show menu is shown.</td>
612 </tr><tr>
613 <td><a href="#Editor.__showContextMenuSpelling">__showContextMenuSpelling</a></td>
614 <td>Private slot to set up the spelling menu before it is shown.</td>
615 </tr><tr>
616 <td><a href="#Editor.__showContextMenuTools">__showContextMenuTools</a></td>
617 <td>Private slot handling the aboutToShow signal of the tools context menu.</td>
618 </tr><tr>
619 <td><a href="#Editor.__showImportsDiagram">__showImportsDiagram</a></td>
620 <td>Private method to handle the Imports Diagram context menu action.</td>
621 </tr><tr>
622 <td><a href="#Editor.__showPackageDiagram">__showPackageDiagram</a></td>
623 <td>Private method to handle the Package Diagram context menu action.</td>
624 </tr><tr>
625 <td><a href="#Editor.__showProfileData">__showProfileData</a></td>
626 <td>Private method to handle the show profile data context menu action.</td>
627 </tr><tr>
628 <td><a href="#Editor.__showSyntaxError">__showSyntaxError</a></td>
629 <td>Private slot to handle the 'Show syntax error message' context menu action.</td>
630 </tr><tr>
631 <td><a href="#Editor.__showWarning">__showWarning</a></td>
632 <td>Private slot to handle the 'Show warning' context menu action.</td>
633 </tr><tr>
634 <td><a href="#Editor.__spellCharAdded">__spellCharAdded</a></td>
635 <td>Private slot called to handle the user entering a character.</td>
636 </tr><tr>
637 <td><a href="#Editor.__styleNeeded">__styleNeeded</a></td>
638 <td>Private slot to handle the need for more styling.</td>
639 </tr><tr>
640 <td><a href="#Editor.__textChanged">__textChanged</a></td>
641 <td>Private slot to handle a change of the editor text.</td>
642 </tr><tr>
643 <td><a href="#Editor.__toggleAutoCompletionEnable">__toggleAutoCompletionEnable</a></td>
644 <td>Private slot to handle the Enable Autocompletion context menu entry.</td>
645 </tr><tr>
646 <td><a href="#Editor.__toggleBreakpoint">__toggleBreakpoint</a></td>
647 <td>Private method to toggle a breakpoint.</td>
648 </tr><tr>
649 <td><a href="#Editor.__toggleBreakpointEnabled">__toggleBreakpointEnabled</a></td>
650 <td>Private method to toggle a breakpoints enabled status.</td>
651 </tr><tr>
652 <td><a href="#Editor.__toggleTypingAids">__toggleTypingAids</a></td>
653 <td>Private slot to toggle the typing aids.</td>
654 </tr><tr>
655 <td><a href="#Editor.__updateReadOnly">__updateReadOnly</a></td>
656 <td>Private method to update the readOnly information for this editor.</td>
657 </tr><tr>
658 <td><a href="#Editor.addCallTipHook">addCallTipHook</a></td>
659 <td>Public method to set a calltip provider.</td>
660 </tr><tr>
661 <td><a href="#Editor.addClone">addClone</a></td>
662 <td>Public method to add a clone to our list.</td>
663 </tr><tr>
664 <td><a href="#Editor.addCompletionListHook">addCompletionListHook</a></td>
665 <td>Public method to set an auto-completion list provider.</td>
666 </tr><tr>
667 <td><a href="#Editor.addedToProject">addedToProject</a></td>
668 <td>Public method to signal, that this editor has been added to a project.</td>
669 </tr><tr>
670 <td><a href="#Editor.autoComplete">autoComplete</a></td>
671 <td>Public method to start auto-completion.</td>
672 </tr><tr>
673 <td><a href="#Editor.autoCompleteQScintilla">autoCompleteQScintilla</a></td>
674 <td>Public method to perform an autocompletion using QScintilla methods.</td>
675 </tr><tr>
676 <td><a href="#Editor.boxCommentLine">boxCommentLine</a></td>
677 <td>Public slot to box comment the current line.</td>
678 </tr><tr>
679 <td><a href="#Editor.boxCommentLineOrSelection">boxCommentLineOrSelection</a></td>
680 <td>Public slot to box comment the current line or current selection.</td>
681 </tr><tr>
682 <td><a href="#Editor.boxCommentSelection">boxCommentSelection</a></td>
683 <td>Public slot to box comment the current selection.</td>
684 </tr><tr>
685 <td><a href="#Editor.callTip">callTip</a></td>
686 <td>Public method to show calltips.</td>
687 </tr><tr>
688 <td><a href="#Editor.canAutoCompleteFromAPIs">canAutoCompleteFromAPIs</a></td>
689 <td>Public method to check for API availablity.</td>
690 </tr><tr>
691 <td><a href="#Editor.canProvideCallTipps">canProvideCallTipps</a></td>
692 <td>Public method to test the calltips availability.</td>
693 </tr><tr>
694 <td><a href="#Editor.canProvideDynamicAutoCompletion">canProvideDynamicAutoCompletion</a></td>
695 <td>Public method to test the dynamic auto-completion availability.</td>
696 </tr><tr>
697 <td><a href="#Editor.cancelSharedEdit">cancelSharedEdit</a></td>
698 <td>Public slot to cancel a shared edit session for the editor.</td>
699 </tr><tr>
700 <td><a href="#Editor.changeEvent">changeEvent</a></td>
701 <td>Protected method called to process an event.</td>
702 </tr><tr>
703 <td><a href="#Editor.checkDirty">checkDirty</a></td>
704 <td>Public method to check dirty status and open a message window.</td>
705 </tr><tr>
706 <td><a href="#Editor.checkSpelling">checkSpelling</a></td>
707 <td>Public slot to perform an interactive spell check of the document.</td>
708 </tr><tr>
709 <td><a href="#Editor.checkSyntax">checkSyntax</a></td>
710 <td>Public method to perform an automatic syntax check of the file.</td>
711 </tr><tr>
712 <td><a href="#Editor.clearAllHighlights">clearAllHighlights</a></td>
713 <td>Public method to clear all highlights.</td>
714 </tr><tr>
715 <td><a href="#Editor.clearBookmarks">clearBookmarks</a></td>
716 <td>Public slot to handle the 'Clear all bookmarks' context menu action.</td>
717 </tr><tr>
718 <td><a href="#Editor.clearBreakpoint">clearBreakpoint</a></td>
719 <td>Public method to clear a breakpoint.</td>
720 </tr><tr>
721 <td><a href="#Editor.clearFlakesWarnings">clearFlakesWarnings</a></td>
722 <td>Public slot to clear all pyflakes warnings.</td>
723 </tr><tr>
724 <td><a href="#Editor.clearHighlight">clearHighlight</a></td>
725 <td>Public method to clear a text highlight.</td>
726 </tr><tr>
727 <td><a href="#Editor.clearSearchIndicators">clearSearchIndicators</a></td>
728 <td>Public method to clear all search indicators.</td>
729 </tr><tr>
730 <td><a href="#Editor.clearStyleWarnings">clearStyleWarnings</a></td>
731 <td>Public slot to clear all style warnings.</td>
732 </tr><tr>
733 <td><a href="#Editor.clearStyles">clearStyles</a></td>
734 <td>Public method to set the styles according the selected Qt style or the selected editor colours.</td>
735 </tr><tr>
736 <td><a href="#Editor.clearSyntaxError">clearSyntaxError</a></td>
737 <td>Public slot to handle the 'Clear all syntax error' context menu action.</td>
738 </tr><tr>
739 <td><a href="#Editor.clearWarnings">clearWarnings</a></td>
740 <td>Public slot to clear all warnings.</td>
741 </tr><tr>
742 <td><a href="#Editor.close">close</a></td>
743 <td>Public method called when the window gets closed.</td>
744 </tr><tr>
745 <td><a href="#Editor.closeIt">closeIt</a></td>
746 <td>Public method called by the viewmanager to finally get rid of us.</td>
747 </tr><tr>
748 <td><a href="#Editor.codeCoverageShowAnnotations">codeCoverageShowAnnotations</a></td>
749 <td>Public method to handle the show code coverage annotations context menu action.</td>
750 </tr><tr>
751 <td><a href="#Editor.collapseFoldWithChildren">collapseFoldWithChildren</a></td>
752 <td>Public slot to collapse the current fold including its children.</td>
753 </tr><tr>
754 <td><a href="#Editor.commentLine">commentLine</a></td>
755 <td>Public slot to comment the current line.</td>
756 </tr><tr>
757 <td><a href="#Editor.commentLineOrSelection">commentLineOrSelection</a></td>
758 <td>Public slot to comment the current line or current selection.</td>
759 </tr><tr>
760 <td><a href="#Editor.commentSelection">commentSelection</a></td>
761 <td>Public slot to comment the current selection.</td>
762 </tr><tr>
763 <td><a href="#Editor.completionsListReady">completionsListReady</a></td>
764 <td>Public method to show the completions determined by a completions provider.</td>
765 </tr><tr>
766 <td><a href="#Editor.contextMenuEvent">contextMenuEvent</a></td>
767 <td>Protected method implementing the context menu event.</td>
768 </tr><tr>
769 <td><a href="#Editor.curLineHasBreakpoint">curLineHasBreakpoint</a></td>
770 <td>Public method to check for the presence of a breakpoint at the current line.</td>
771 </tr><tr>
772 <td><a href="#Editor.determineFileType">determineFileType</a></td>
773 <td>Public method to determine the file type using various tests.</td>
774 </tr><tr>
775 <td><a href="#Editor.dragEnterEvent">dragEnterEvent</a></td>
776 <td>Protected method to handle the drag enter event.</td>
777 </tr><tr>
778 <td><a href="#Editor.dragLeaveEvent">dragLeaveEvent</a></td>
779 <td>Protected method to handle the drag leave event.</td>
780 </tr><tr>
781 <td><a href="#Editor.dragMoveEvent">dragMoveEvent</a></td>
782 <td>Protected method to handle the drag move event.</td>
783 </tr><tr>
784 <td><a href="#Editor.dropEvent">dropEvent</a></td>
785 <td>Protected method to handle the drop event.</td>
786 </tr><tr>
787 <td><a href="#Editor.editorCommand">editorCommand</a></td>
788 <td>Public method to perform a simple editor command.</td>
789 </tr><tr>
790 <td><a href="#Editor.ensureVisible">ensureVisible</a></td>
791 <td>Public slot to ensure, that the specified line is visible.</td>
792 </tr><tr>
793 <td><a href="#Editor.ensureVisibleTop">ensureVisibleTop</a></td>
794 <td>Public slot to ensure, that the specified line is visible at the top of the editor.</td>
795 </tr><tr>
796 <td><a href="#Editor.event">event</a></td>
797 <td>Public method handling events.</td>
798 </tr><tr>
799 <td><a href="#Editor.expandFoldWithChildren">expandFoldWithChildren</a></td>
800 <td>Public slot to expand the current fold including its children.</td>
801 </tr><tr>
802 <td><a href="#Editor.exportFile">exportFile</a></td>
803 <td>Public method to export the file.</td>
804 </tr><tr>
805 <td><a href="#Editor.extractTasks">extractTasks</a></td>
806 <td>Public slot to extract all tasks.</td>
807 </tr><tr>
808 <td><a href="#Editor.fileRenamed">fileRenamed</a></td>
809 <td>Public slot to handle the editorRenamed signal.</td>
810 </tr><tr>
811 <td><a href="#Editor.focusInEvent">focusInEvent</a></td>
812 <td>Protected method called when the editor receives focus.</td>
813 </tr><tr>
814 <td><a href="#Editor.focusOutEvent">focusOutEvent</a></td>
815 <td>Protected method called when the editor loses focus.</td>
816 </tr><tr>
817 <td><a href="#Editor.gestureEvent">gestureEvent</a></td>
818 <td>Protected method handling gesture events.</td>
819 </tr><tr>
820 <td><a href="#Editor.getApiLanguage">getApiLanguage</a></td>
821 <td>Public method to get the API language of the editor.</td>
822 </tr><tr>
823 <td><a href="#Editor.getBookmarkLines">getBookmarkLines</a></td>
824 <td>Public method to get the lines containing a bookmark.</td>
825 </tr><tr>
826 <td><a href="#Editor.getBookmarks">getBookmarks</a></td>
827 <td>Public method to retrieve the bookmarks.</td>
828 </tr><tr>
829 <td><a href="#Editor.getBreakpointLines">getBreakpointLines</a></td>
830 <td>Public method to get the lines containing a breakpoint.</td>
831 </tr><tr>
832 <td><a href="#Editor.getCallTipHook">getCallTipHook</a></td>
833 <td>Public method to get the registered calltip provider.</td>
834 </tr><tr>
835 <td><a href="#Editor.getChangeLines">getChangeLines</a></td>
836 <td>Public method to get the lines containing a change.</td>
837 </tr><tr>
838 <td><a href="#Editor.getCompleter">getCompleter</a></td>
839 <td>Public method to retrieve a reference to the completer object.</td>
840 </tr><tr>
841 <td><a href="#Editor.getCompletionListHook">getCompletionListHook</a></td>
842 <td>Public method to get the registered completion list provider.</td>
843 </tr><tr>
844 <td><a href="#Editor.getCoverageLines">getCoverageLines</a></td>
845 <td>Public method to get the lines containing a coverage marker.</td>
846 </tr><tr>
847 <td><a href="#Editor.getCurrentWord">getCurrentWord</a></td>
848 <td>Public method to get the word at the current position.</td>
849 </tr><tr>
850 <td><a href="#Editor.getCurrentWordBoundaries">getCurrentWordBoundaries</a></td>
851 <td>Public method to get the word boundaries at the current position.</td>
852 </tr><tr>
853 <td><a href="#Editor.getEditorConfig">getEditorConfig</a></td>
854 <td>Public method to get the requested option via EditorConfig.</td>
855 </tr><tr>
856 <td><a href="#Editor.getEncoding">getEncoding</a></td>
857 <td>Public method to return the current encoding.</td>
858 </tr><tr>
859 <td><a href="#Editor.getFileName">getFileName</a></td>
860 <td>Public method to return the name of the file being displayed.</td>
861 </tr><tr>
862 <td><a href="#Editor.getFileType">getFileType</a></td>
863 <td>Public method to return the type of the file being displayed.</td>
864 </tr><tr>
865 <td><a href="#Editor.getFileTypeByFlag">getFileTypeByFlag</a></td>
866 <td>Public method to return the type of the file, if it was set by an eflag: marker.</td>
867 </tr><tr>
868 <td><a href="#Editor.getHighlightPosition">getHighlightPosition</a></td>
869 <td>Public method to return the position of the highlight bar.</td>
870 </tr><tr>
871 <td><a href="#Editor.getLanguage">getLanguage</a></td>
872 <td>Public method to retrieve the language of the editor.</td>
873 </tr><tr>
874 <td><a href="#Editor.getLexer">getLexer</a></td>
875 <td>Public method to retrieve a reference to the lexer object.</td>
876 </tr><tr>
877 <td><a href="#Editor.getMenu">getMenu</a></td>
878 <td>Public method to get a reference to the main context menu or a submenu.</td>
879 </tr><tr>
880 <td><a href="#Editor.getMouseClickHandler">getMouseClickHandler</a></td>
881 <td>Public method to get a registered mouse click handler.</td>
882 </tr><tr>
883 <td><a href="#Editor.getMouseClickHandlers">getMouseClickHandlers</a></td>
884 <td>Public method to get all registered mouse click handlers of a plug-in.</td>
885 </tr><tr>
886 <td><a href="#Editor.getNoName">getNoName</a></td>
887 <td>Public method to get the display string for an unnamed editor.</td>
888 </tr><tr>
889 <td><a href="#Editor.getSearchIndicatorLines">getSearchIndicatorLines</a></td>
890 <td>Public method to get the lines containing a search indicator.</td>
891 </tr><tr>
892 <td><a href="#Editor.getSearchText">getSearchText</a></td>
893 <td>Public method to determine the selection or the current word for the next search operation.</td>
894 </tr><tr>
895 <td><a href="#Editor.getSharingStatus">getSharingStatus</a></td>
896 <td>Public method to get some share status info.</td>
897 </tr><tr>
898 <td><a href="#Editor.getSyntaxErrorLines">getSyntaxErrorLines</a></td>
899 <td>Public method to get the lines containing a syntax error.</td>
900 </tr><tr>
901 <td><a href="#Editor.getSyntaxErrors">getSyntaxErrors</a></td>
902 <td>Public method to retrieve the syntax error markers.</td>
903 </tr><tr>
904 <td><a href="#Editor.getTaskLines">getTaskLines</a></td>
905 <td>Public method to get the lines containing a task.</td>
906 </tr><tr>
907 <td><a href="#Editor.getVcsConflictMarkerLines">getVcsConflictMarkerLines</a></td>
908 <td>Public method to determine the lines containing a VCS conflict marker.</td>
909 </tr><tr>
910 <td><a href="#Editor.getWarningLines">getWarningLines</a></td>
911 <td>Public method to get the lines containing a warning.</td>
912 </tr><tr>
913 <td><a href="#Editor.getWarnings">getWarnings</a></td>
914 <td>Public method to retrieve the warning markers.</td>
915 </tr><tr>
916 <td><a href="#Editor.getWord">getWord</a></td>
917 <td>Public method to get the word at a position.</td>
918 </tr><tr>
919 <td><a href="#Editor.getWordBoundaries">getWordBoundaries</a></td>
920 <td>Public method to get the word boundaries at a position.</td>
921 </tr><tr>
922 <td><a href="#Editor.getWordLeft">getWordLeft</a></td>
923 <td>Public method to get the word to the left of a position.</td>
924 </tr><tr>
925 <td><a href="#Editor.getWordRight">getWordRight</a></td>
926 <td>Public method to get the word to the right of a position.</td>
927 </tr><tr>
928 <td><a href="#Editor.gotoLastEditPosition">gotoLastEditPosition</a></td>
929 <td>Public method to move the cursor to the last edit position.</td>
930 </tr><tr>
931 <td><a href="#Editor.gotoLine">gotoLine</a></td>
932 <td>Public slot to jump to the beginning of a line.</td>
933 </tr><tr>
934 <td><a href="#Editor.gotoMethodClass">gotoMethodClass</a></td>
935 <td>Public method to go to the next Python method or class definition.</td>
936 </tr><tr>
937 <td><a href="#Editor.gotoSyntaxError">gotoSyntaxError</a></td>
938 <td>Public slot to handle the 'Goto syntax error' context menu action.</td>
939 </tr><tr>
940 <td><a href="#Editor.handleMonospacedEnable">handleMonospacedEnable</a></td>
941 <td>Public slot to handle the Use Monospaced Font context menu entry.</td>
942 </tr><tr>
943 <td><a href="#Editor.handleRenamed">handleRenamed</a></td>
944 <td>Public slot to handle the editorRenamed signal.</td>
945 </tr><tr>
946 <td><a href="#Editor.hasBookmarks">hasBookmarks</a></td>
947 <td>Public method to check for the presence of bookmarks.</td>
948 </tr><tr>
949 <td><a href="#Editor.hasBreakpoints">hasBreakpoints</a></td>
950 <td>Public method to check for the presence of breakpoints.</td>
951 </tr><tr>
952 <td><a href="#Editor.hasChangeMarkers">hasChangeMarkers</a></td>
953 <td>Public method to determine, if this editor contains any change markers.</td>
954 </tr><tr>
955 <td><a href="#Editor.hasCoverageMarkers">hasCoverageMarkers</a></td>
956 <td>Public method to test, if there are coverage markers.</td>
957 </tr><tr>
958 <td><a href="#Editor.hasMiniMenu">hasMiniMenu</a></td>
959 <td>Public method to check the miniMenu flag.</td>
960 </tr><tr>
961 <td><a href="#Editor.hasSyntaxErrors">hasSyntaxErrors</a></td>
962 <td>Public method to check for the presence of syntax errors.</td>
963 </tr><tr>
964 <td><a href="#Editor.hasTaskMarkers">hasTaskMarkers</a></td>
965 <td>Public method to determine, if this editor contains any task markers.</td>
966 </tr><tr>
967 <td><a href="#Editor.hasWarnings">hasWarnings</a></td>
968 <td>Public method to check for the presence of warnings.</td>
969 </tr><tr>
970 <td><a href="#Editor.highlight">highlight</a></td>
971 <td>Public method to highlight [or de-highlight] a particular line.</td>
972 </tr><tr>
973 <td><a href="#Editor.highlightVisible">highlightVisible</a></td>
974 <td>Public method to make sure that the highlight is visible.</td>
975 </tr><tr>
976 <td><a href="#Editor.indentLineOrSelection">indentLineOrSelection</a></td>
977 <td>Public slot to indent the current line or current selection.</td>
978 </tr><tr>
979 <td><a href="#Editor.isClone">isClone</a></td>
980 <td>Public method to test, if the given editor is a clone.</td>
981 </tr><tr>
982 <td><a href="#Editor.isJavascriptFile">isJavascriptFile</a></td>
983 <td>Public method to return a flag indicating a Javascript file.</td>
984 </tr><tr>
985 <td><a href="#Editor.isLastEditPositionAvailable">isLastEditPositionAvailable</a></td>
986 <td>Public method to check, if a last edit position is available.</td>
987 </tr><tr>
988 <td><a href="#Editor.isPy2File">isPy2File</a></td>
989 <td>Public method to return a flag indicating a Python2 file.</td>
990 </tr><tr>
991 <td><a href="#Editor.isPy3File">isPy3File</a></td>
992 <td>Public method to return a flag indicating a Python3 file.</td>
993 </tr><tr>
994 <td><a href="#Editor.isPyFile">isPyFile</a></td>
995 <td>Public method to return a flag indicating a Python (2 or 3) file.</td>
996 </tr><tr>
997 <td><a href="#Editor.isRubyFile">isRubyFile</a></td>
998 <td>Public method to return a flag indicating a Ruby file.</td>
999 </tr><tr>
1000 <td><a href="#Editor.isSpellCheckRegion">isSpellCheckRegion</a></td>
1001 <td>Public method to check, if the given position is within a region, that should be spell checked.</td>
1002 </tr><tr>
1003 <td><a href="#Editor.joinLines">joinLines</a></td>
1004 <td>Public slot to join the current line with the next one.</td>
1005 </tr><tr>
1006 <td><a href="#Editor.keyPressEvent">keyPressEvent</a></td>
1007 <td>Protected method to handle the user input a key at a time.</td>
1008 </tr><tr>
1009 <td><a href="#Editor.macroDelete">macroDelete</a></td>
1010 <td>Public method to delete a macro.</td>
1011 </tr><tr>
1012 <td><a href="#Editor.macroLoad">macroLoad</a></td>
1013 <td>Public method to load a macro from a file.</td>
1014 </tr><tr>
1015 <td><a href="#Editor.macroRecordingStart">macroRecordingStart</a></td>
1016 <td>Public method to start macro recording.</td>
1017 </tr><tr>
1018 <td><a href="#Editor.macroRecordingStop">macroRecordingStop</a></td>
1019 <td>Public method to stop macro recording.</td>
1020 </tr><tr>
1021 <td><a href="#Editor.macroRun">macroRun</a></td>
1022 <td>Public method to execute a macro.</td>
1023 </tr><tr>
1024 <td><a href="#Editor.macroSave">macroSave</a></td>
1025 <td>Public method to save a macro to a file.</td>
1026 </tr><tr>
1027 <td><a href="#Editor.menuEditBreakpoint">menuEditBreakpoint</a></td>
1028 <td>Public slot to handle the 'Edit breakpoint' context menu action.</td>
1029 </tr><tr>
1030 <td><a href="#Editor.menuNextBreakpoint">menuNextBreakpoint</a></td>
1031 <td>Public slot to handle the 'Next breakpoint' context menu action.</td>
1032 </tr><tr>
1033 <td><a href="#Editor.menuPreviousBreakpoint">menuPreviousBreakpoint</a></td>
1034 <td>Public slot to handle the 'Previous breakpoint' context menu action.</td>
1035 </tr><tr>
1036 <td><a href="#Editor.menuToggleBookmark">menuToggleBookmark</a></td>
1037 <td>Public slot to handle the 'Toggle bookmark' context menu action.</td>
1038 </tr><tr>
1039 <td><a href="#Editor.menuToggleBreakpoint">menuToggleBreakpoint</a></td>
1040 <td>Public slot to handle the 'Toggle breakpoint' context menu action.</td>
1041 </tr><tr>
1042 <td><a href="#Editor.mouseDoubleClickEvent">mouseDoubleClickEvent</a></td>
1043 <td>Protected method to handle mouse double click events.</td>
1044 </tr><tr>
1045 <td><a href="#Editor.mousePressEvent">mousePressEvent</a></td>
1046 <td>Protected method to handle the mouse press event.</td>
1047 </tr><tr>
1048 <td><a href="#Editor.mouseReleaseEvent">mouseReleaseEvent</a></td>
1049 <td>Protected method calling a registered mouse click handler function.</td>
1050 </tr><tr>
1051 <td><a href="#Editor.newBreakpointWithProperties">newBreakpointWithProperties</a></td>
1052 <td>Public method to set a new breakpoint and its properties.</td>
1053 </tr><tr>
1054 <td><a href="#Editor.nextBookmark">nextBookmark</a></td>
1055 <td>Public slot to handle the 'Next bookmark' context menu action.</td>
1056 </tr><tr>
1057 <td><a href="#Editor.nextChange">nextChange</a></td>
1058 <td>Public slot to handle the 'Next change' context menu action.</td>
1059 </tr><tr>
1060 <td><a href="#Editor.nextTask">nextTask</a></td>
1061 <td>Public slot to handle the 'Next task' context menu action.</td>
1062 </tr><tr>
1063 <td><a href="#Editor.nextUncovered">nextUncovered</a></td>
1064 <td>Public slot to handle the 'Next uncovered' context menu action.</td>
1065 </tr><tr>
1066 <td><a href="#Editor.nextWarning">nextWarning</a></td>
1067 <td>Public slot to handle the 'Next warning' context menu action.</td>
1068 </tr><tr>
1069 <td><a href="#Editor.previousBookmark">previousBookmark</a></td>
1070 <td>Public slot to handle the 'Previous bookmark' context menu action.</td>
1071 </tr><tr>
1072 <td><a href="#Editor.previousChange">previousChange</a></td>
1073 <td>Public slot to handle the 'Previous change' context menu action.</td>
1074 </tr><tr>
1075 <td><a href="#Editor.previousTask">previousTask</a></td>
1076 <td>Public slot to handle the 'Previous task' context menu action.</td>
1077 </tr><tr>
1078 <td><a href="#Editor.previousUncovered">previousUncovered</a></td>
1079 <td>Public slot to handle the 'Previous uncovered' context menu action.</td>
1080 </tr><tr>
1081 <td><a href="#Editor.previousWarning">previousWarning</a></td>
1082 <td>Public slot to handle the 'Previous warning' context menu action.</td>
1083 </tr><tr>
1084 <td><a href="#Editor.printFile">printFile</a></td>
1085 <td>Public slot to print the text.</td>
1086 </tr><tr>
1087 <td><a href="#Editor.printPreviewFile">printPreviewFile</a></td>
1088 <td>Public slot to show a print preview of the text.</td>
1089 </tr><tr>
1090 <td><a href="#Editor.projectClosed">projectClosed</a></td>
1091 <td>Public slot to handle the closing of a project.</td>
1092 </tr><tr>
1093 <td><a href="#Editor.projectLexerAssociationsChanged">projectLexerAssociationsChanged</a></td>
1094 <td>Public slot to handle changes of the project lexer associations.</td>
1095 </tr><tr>
1096 <td><a href="#Editor.projectOpened">projectOpened</a></td>
1097 <td>Public slot to handle the opening of a project.</td>
1098 </tr><tr>
1099 <td><a href="#Editor.readFile">readFile</a></td>
1100 <td>Public slot to read the text from a file.</td>
1101 </tr><tr>
1102 <td><a href="#Editor.readSettings">readSettings</a></td>
1103 <td>Public slot to read the settings into our lexer.</td>
1104 </tr><tr>
1105 <td><a href="#Editor.receive">receive</a></td>
1106 <td>Public slot to handle received editor commands.</td>
1107 </tr><tr>
1108 <td><a href="#Editor.redo">redo</a></td>
1109 <td>Public method to redo the last recorded change.</td>
1110 </tr><tr>
1111 <td><a href="#Editor.refresh">refresh</a></td>
1112 <td>Public slot to refresh the editor contents.</td>
1113 </tr><tr>
1114 <td><a href="#Editor.refreshCoverageAnnotations">refreshCoverageAnnotations</a></td>
1115 <td>Public method to refresh the code coverage annotations.</td>
1116 </tr><tr>
1117 <td><a href="#Editor.removeCallTipHook">removeCallTipHook</a></td>
1118 <td>Public method to remove a previously registered calltip provider.</td>
1119 </tr><tr>
1120 <td><a href="#Editor.removeClone">removeClone</a></td>
1121 <td>Public method to remove a clone from our list.</td>
1122 </tr><tr>
1123 <td><a href="#Editor.removeCompletionListHook">removeCompletionListHook</a></td>
1124 <td>Public method to remove a previously registered completion list provider.</td>
1125 </tr><tr>
1126 <td><a href="#Editor.removeMouseClickHandler">removeMouseClickHandler</a></td>
1127 <td>Public method to un-registered a mouse click handler.</td>
1128 </tr><tr>
1129 <td><a href="#Editor.removeMouseClickHandlers">removeMouseClickHandlers</a></td>
1130 <td>Public method to un-registered all mouse click handlers of a plug-in.</td>
1131 </tr><tr>
1132 <td><a href="#Editor.resizeEvent">resizeEvent</a></td>
1133 <td>Protected method handling resize events.</td>
1134 </tr><tr>
1135 <td><a href="#Editor.revertToUnmodified">revertToUnmodified</a></td>
1136 <td>Public method to revert back to the last saved state.</td>
1137 </tr><tr>
1138 <td><a href="#Editor.saveFile">saveFile</a></td>
1139 <td>Public method to save the text to a file.</td>
1140 </tr><tr>
1141 <td><a href="#Editor.saveFileAs">saveFileAs</a></td>
1142 <td>Public slot to save a file with a new name.</td>
1143 </tr><tr>
1144 <td><a href="#Editor.saveFileCopy">saveFileCopy</a></td>
1145 <td>Public method to save a copy of the file.</td>
1146 </tr><tr>
1147 <td><a href="#Editor.searchCurrentWordBackward">searchCurrentWordBackward</a></td>
1148 <td>Public slot to search the current word backward.</td>
1149 </tr><tr>
1150 <td><a href="#Editor.searchCurrentWordForward">searchCurrentWordForward</a></td>
1151 <td>Public slot to search the current word forward.</td>
1152 </tr><tr>
1153 <td><a href="#Editor.selectCurrentWord">selectCurrentWord</a></td>
1154 <td>Public method to select the current word.</td>
1155 </tr><tr>
1156 <td><a href="#Editor.selectWord">selectWord</a></td>
1157 <td>Public method to select the word at a position.</td>
1158 </tr><tr>
1159 <td><a href="#Editor.sendSharedEdit">sendSharedEdit</a></td>
1160 <td>Public slot to end a shared edit session for the editor and send the changes.</td>
1161 </tr><tr>
1162 <td><a href="#Editor.setAutoCompletionEnabled">setAutoCompletionEnabled</a></td>
1163 <td>Public method to enable/disable autocompletion.</td>
1164 </tr><tr>
1165 <td><a href="#Editor.setAutoSpellChecking">setAutoSpellChecking</a></td>
1166 <td>Public method to set the automatic spell checking.</td>
1167 </tr><tr>
1168 <td><a href="#Editor.setHighlight">setHighlight</a></td>
1169 <td>Public method to set a text highlight.</td>
1170 </tr><tr>
1171 <td><a href="#Editor.setLanguage">setLanguage</a></td>
1172 <td>Public method to set a lexer language.</td>
1173 </tr><tr>
1174 <td><a href="#Editor.setMonospaced">setMonospaced</a></td>
1175 <td>Public method to set/reset a monospaced font.</td>
1176 </tr><tr>
1177 <td><a href="#Editor.setMouseClickHandler">setMouseClickHandler</a></td>
1178 <td>Public method to set a mouse click handler.</td>
1179 </tr><tr>
1180 <td><a href="#Editor.setNoName">setNoName</a></td>
1181 <td>Public method to set the display string for an unnamed editor.</td>
1182 </tr><tr>
1183 <td><a href="#Editor.setSearchIndicator">setSearchIndicator</a></td>
1184 <td>Public method to set a search indicator for the given range.</td>
1185 </tr><tr>
1186 <td><a href="#Editor.setSpellingForProject">setSpellingForProject</a></td>
1187 <td>Public method to set the spell checking options for files belonging to the current project.</td>
1188 </tr><tr>
1189 <td><a href="#Editor.shareConnected">shareConnected</a></td>
1190 <td>Public slot to handle a change of the connected state.</td>
1191 </tr><tr>
1192 <td><a href="#Editor.shareEditor">shareEditor</a></td>
1193 <td>Public slot to set the shared status of the editor.</td>
1194 </tr><tr>
1195 <td><a href="#Editor.shortenEmptyLines">shortenEmptyLines</a></td>
1196 <td>Public slot to compress lines consisting solely of whitespace characters.</td>
1197 </tr><tr>
1198 <td><a href="#Editor.shouldAutosave">shouldAutosave</a></td>
1199 <td>Public slot to check the autosave flags.</td>
1200 </tr><tr>
1201 <td><a href="#Editor.smartIndentLineOrSelection">smartIndentLineOrSelection</a></td>
1202 <td>Public slot to indent current line smartly.</td>
1203 </tr><tr>
1204 <td><a href="#Editor.sortLines">sortLines</a></td>
1205 <td>Public slot to sort the lines spanned by a rectangular selection.</td>
1206 </tr><tr>
1207 <td><a href="#Editor.startSharedEdit">startSharedEdit</a></td>
1208 <td>Public slot to start a shared edit session for the editor.</td>
1209 </tr><tr>
1210 <td><a href="#Editor.streamCommentLine">streamCommentLine</a></td>
1211 <td>Public slot to stream comment the current line.</td>
1212 </tr><tr>
1213 <td><a href="#Editor.streamCommentLineOrSelection">streamCommentLineOrSelection</a></td>
1214 <td>Public slot to stream comment the current line or current selection.</td>
1215 </tr><tr>
1216 <td><a href="#Editor.streamCommentSelection">streamCommentSelection</a></td>
1217 <td>Public slot to comment the current selection.</td>
1218 </tr><tr>
1219 <td><a href="#Editor.toggleBookmark">toggleBookmark</a></td>
1220 <td>Public method to toggle a bookmark.</td>
1221 </tr><tr>
1222 <td><a href="#Editor.toggleCommentBlock">toggleCommentBlock</a></td>
1223 <td>Public slot to toggle the comment of a block.</td>
1224 </tr><tr>
1225 <td><a href="#Editor.toggleCurrentFold">toggleCurrentFold</a></td>
1226 <td>Public slot to toggle the fold containing the current line.</td>
1227 </tr><tr>
1228 <td><a href="#Editor.toggleSyntaxError">toggleSyntaxError</a></td>
1229 <td>Public method to toggle a syntax error indicator.</td>
1230 </tr><tr>
1231 <td><a href="#Editor.toggleWarning">toggleWarning</a></td>
1232 <td>Public method to toggle a warning indicator.</td>
1233 </tr><tr>
1234 <td><a href="#Editor.uncommentLine">uncommentLine</a></td>
1235 <td>Public slot to uncomment the current line.</td>
1236 </tr><tr>
1237 <td><a href="#Editor.uncommentLineOrSelection">uncommentLineOrSelection</a></td>
1238 <td>Public slot to uncomment the current line or current selection.</td>
1239 </tr><tr>
1240 <td><a href="#Editor.uncommentSelection">uncommentSelection</a></td>
1241 <td>Public slot to uncomment the current selection.</td>
1242 </tr><tr>
1243 <td><a href="#Editor.undo">undo</a></td>
1244 <td>Public method to undo the last recorded change.</td>
1245 </tr><tr>
1246 <td><a href="#Editor.unindentLineOrSelection">unindentLineOrSelection</a></td>
1247 <td>Public slot to unindent the current line or current selection.</td>
1248 </tr><tr>
1249 <td><a href="#Editor.updateMarkerMap">updateMarkerMap</a></td>
1250 <td>Public method to initiate an update of the marker map.</td>
1251 </tr><tr>
1252 <td><a href="#Editor.viewportEvent">viewportEvent</a></td>
1253 <td>Protected method handling event of the viewport.</td>
1254 </tr><tr>
1255 <td><a href="#Editor.wheelEvent">wheelEvent</a></td>
1256 <td>Protected method to handle wheel events.</td>
1257 </tr><tr>
1258 <td><a href="#Editor.writeFile">writeFile</a></td>
1259 <td>Public slot to write the text to a file.</td>
1260 </tr>
1261 </table>
1262 <h3>Static Methods</h3>
1263 <table>
1264 <tr><td>None</td></tr>
1265 </table>
1266 <a NAME="Editor.__init__" ID="Editor.__init__"></a>
1267 <h4>Editor (Constructor)</h4>
1268 <b>Editor</b>(<i>dbs, fn="", vm=None, filetype="", editor=None, tv=None</i>)
1269 <p>
1270 Constructor
1271 </p><dl>
1272 <dt><i>dbs</i></dt>
1273 <dd>
1274 reference to the debug server object
1275 </dd><dt><i>fn</i></dt>
1276 <dd>
1277 name of the file to be opened (string). If it is None,
1278 a new (empty) editor is opened
1279 </dd><dt><i>vm</i></dt>
1280 <dd>
1281 reference to the view manager object
1282 (ViewManager.ViewManager)
1283 </dd><dt><i>filetype</i></dt>
1284 <dd>
1285 type of the source file (string)
1286 </dd><dt><i>editor</i></dt>
1287 <dd>
1288 reference to an Editor object, if this is a cloned view
1289 </dd><dt><i>tv</i></dt>
1290 <dd>
1291 reference to the task viewer object
1292 </dd>
1293 </dl><dl>
1294 <dt>Raises <b>IOError</b>:</dt>
1295 <dd>
1296 raised to indicate an issue accessing the file
1297 </dd>
1298 </dl><a NAME="Editor.__addBreakPoint" ID="Editor.__addBreakPoint"></a>
1299 <h4>Editor.__addBreakPoint</h4>
1300 <b>__addBreakPoint</b>(<i>line, temporary</i>)
1301 <p>
1302 Private method to add a new breakpoint.
1303 </p><dl>
1304 <dt><i>line</i></dt>
1305 <dd>
1306 line number of the breakpoint (integer)
1307 </dd><dt><i>temporary</i></dt>
1308 <dd>
1309 flag indicating a temporary breakpoint (boolean)
1310 </dd>
1311 </dl><a NAME="Editor.__addBreakPoints" ID="Editor.__addBreakPoints"></a>
1312 <h4>Editor.__addBreakPoints</h4>
1313 <b>__addBreakPoints</b>(<i>parentIndex, start, end</i>)
1314 <p>
1315 Private slot to add breakpoints.
1316 </p><dl>
1317 <dt><i>parentIndex</i></dt>
1318 <dd>
1319 index of parent item (QModelIndex)
1320 </dd><dt><i>start</i></dt>
1321 <dd>
1322 start row (integer)
1323 </dd><dt><i>end</i></dt>
1324 <dd>
1325 end row (integer)
1326 </dd>
1327 </dl><a NAME="Editor.__addFileAliasResource" ID="Editor.__addFileAliasResource"></a>
1328 <h4>Editor.__addFileAliasResource</h4>
1329 <b>__addFileAliasResource</b>(<i></i>)
1330 <p>
1331 Private method to handle the Add aliased file context menu action.
1332 </p><a NAME="Editor.__addFileResource" ID="Editor.__addFileResource"></a>
1333 <h4>Editor.__addFileResource</h4>
1334 <b>__addFileResource</b>(<i></i>)
1335 <p>
1336 Private method to handle the Add file context menu action.
1337 </p><a NAME="Editor.__addFileResources" ID="Editor.__addFileResources"></a>
1338 <h4>Editor.__addFileResources</h4>
1339 <b>__addFileResources</b>(<i></i>)
1340 <p>
1341 Private method to handle the Add files context menu action.
1342 </p><a NAME="Editor.__addLocalizedResource" ID="Editor.__addLocalizedResource"></a>
1343 <h4>Editor.__addLocalizedResource</h4>
1344 <b>__addLocalizedResource</b>(<i></i>)
1345 <p>
1346 Private method to handle the Add localized resource context menu
1347 action.
1348 </p><a NAME="Editor.__addResourceFrame" ID="Editor.__addResourceFrame"></a>
1349 <h4>Editor.__addResourceFrame</h4>
1350 <b>__addResourceFrame</b>(<i></i>)
1351 <p>
1352 Private method to handle the Add resource frame context menu action.
1353 </p><a NAME="Editor.__addToSpellingDictionary" ID="Editor.__addToSpellingDictionary"></a>
1354 <h4>Editor.__addToSpellingDictionary</h4>
1355 <b>__addToSpellingDictionary</b>(<i></i>)
1356 <p>
1357 Private slot to add the word below the spelling context menu to the
1358 dictionary.
1359 </p><a NAME="Editor.__adjustedCallTipPosition" ID="Editor.__adjustedCallTipPosition"></a>
1360 <h4>Editor.__adjustedCallTipPosition</h4>
1361 <b>__adjustedCallTipPosition</b>(<i>ctshift, pos</i>)
1362 <p>
1363 Private method to calculate an adjusted position for showing calltips.
1364 </p><dl>
1365 <dt><i>ctshift</i></dt>
1366 <dd>
1367 amount the calltip shall be shifted (integer)
1368 </dd><dt><i>pos</i></dt>
1369 <dd>
1370 position into the text (integer)
1371 </dd>
1372 </dl><dl>
1373 <dt>Returns:</dt>
1374 <dd>
1375 new position for the calltip (integer)
1376 </dd>
1377 </dl><a NAME="Editor.__applyTemplate" ID="Editor.__applyTemplate"></a>
1378 <h4>Editor.__applyTemplate</h4>
1379 <b>__applyTemplate</b>(<i>templateName, language</i>)
1380 <p>
1381 Private method to apply a template by name.
1382 </p><dl>
1383 <dt><i>templateName</i></dt>
1384 <dd>
1385 name of the template to apply (string)
1386 </dd><dt><i>language</i></dt>
1387 <dd>
1388 name of the language (group) to get the template
1389 from (string)
1390 </dd>
1391 </dl><a NAME="Editor.__autoComplete" ID="Editor.__autoComplete"></a>
1392 <h4>Editor.__autoComplete</h4>
1393 <b>__autoComplete</b>(<i>auto=True, context=None</i>)
1394 <p>
1395 Private method to start auto-completion via plug-ins.
1396 </p><dl>
1397 <dt><i>auto=</i></dt>
1398 <dd>
1399 flag indicating a call from the __charAdded method
1400 (boolean)
1401 </dd><dt><i>context=</i> (bool or None)</dt>
1402 <dd>
1403 flag indicating to complete a context
1404 </dd>
1405 </dl><a NAME="Editor.__autocompletionCancelled" ID="Editor.__autocompletionCancelled"></a>
1406 <h4>Editor.__autocompletionCancelled</h4>
1407 <b>__autocompletionCancelled</b>(<i></i>)
1408 <p>
1409 Private slot to handle the cancellation of an auto-completion list.
1410 </p><a NAME="Editor.__autosaveEnable" ID="Editor.__autosaveEnable"></a>
1411 <h4>Editor.__autosaveEnable</h4>
1412 <b>__autosaveEnable</b>(<i></i>)
1413 <p>
1414 Private slot handling the autosave enable context menu action.
1415 </p><a NAME="Editor.__bindCompleter" ID="Editor.__bindCompleter"></a>
1416 <h4>Editor.__bindCompleter</h4>
1417 <b>__bindCompleter</b>(<i>filename</i>)
1418 <p>
1419 Private slot to set the correct typing completer depending on language.
1420 </p><dl>
1421 <dt><i>filename</i></dt>
1422 <dd>
1423 filename used to determine the associated typing
1424 completer language (string)
1425 </dd>
1426 </dl><a NAME="Editor.__bindLexer" ID="Editor.__bindLexer"></a>
1427 <h4>Editor.__bindLexer</h4>
1428 <b>__bindLexer</b>(<i>filename, pyname=""</i>)
1429 <p>
1430 Private slot to set the correct lexer depending on language.
1431 </p><dl>
1432 <dt><i>filename</i></dt>
1433 <dd>
1434 filename used to determine the associated lexer
1435 language (string)
1436 </dd><dt><i>pyname=</i></dt>
1437 <dd>
1438 name of the pygments lexer to use (string)
1439 </dd>
1440 </dl><a NAME="Editor.__bindName" ID="Editor.__bindName"></a>
1441 <h4>Editor.__bindName</h4>
1442 <b>__bindName</b>(<i>line0</i>)
1443 <p>
1444 Private method to generate a dummy filename for binding a lexer.
1445 </p><dl>
1446 <dt><i>line0</i></dt>
1447 <dd>
1448 first line of text to use in the generation process
1449 (string)
1450 </dd>
1451 </dl><dl>
1452 <dt>Returns:</dt>
1453 <dd>
1454 dummy file name to be used for binding a lexer (string)
1455 </dd>
1456 </dl><a NAME="Editor.__breakPointDataAboutToBeChanged" ID="Editor.__breakPointDataAboutToBeChanged"></a>
1457 <h4>Editor.__breakPointDataAboutToBeChanged</h4>
1458 <b>__breakPointDataAboutToBeChanged</b>(<i>startIndex, endIndex</i>)
1459 <p>
1460 Private slot to handle the dataAboutToBeChanged signal of the
1461 breakpoint model.
1462 </p><dl>
1463 <dt><i>startIndex</i></dt>
1464 <dd>
1465 start index of the rows to be changed (QModelIndex)
1466 </dd><dt><i>endIndex</i></dt>
1467 <dd>
1468 end index of the rows to be changed (QModelIndex)
1469 </dd>
1470 </dl><a NAME="Editor.__calculateChanges" ID="Editor.__calculateChanges"></a>
1471 <h4>Editor.__calculateChanges</h4>
1472 <b>__calculateChanges</b>(<i>old, new</i>)
1473 <p>
1474 Private method to determine change commands to convert old text into
1475 new text.
1476 </p><dl>
1477 <dt><i>old</i></dt>
1478 <dd>
1479 old text (string)
1480 </dd><dt><i>new</i></dt>
1481 <dd>
1482 new text (string)
1483 </dd>
1484 </dl><dl>
1485 <dt>Returns:</dt>
1486 <dd>
1487 commands to change old into new (string)
1488 </dd>
1489 </dl><a NAME="Editor.__callTip" ID="Editor.__callTip"></a>
1490 <h4>Editor.__callTip</h4>
1491 <b>__callTip</b>(<i></i>)
1492 <p>
1493 Private method to show call tips provided by a plugin.
1494 </p><a NAME="Editor.__changeBreakPoints" ID="Editor.__changeBreakPoints"></a>
1495 <h4>Editor.__changeBreakPoints</h4>
1496 <b>__changeBreakPoints</b>(<i>startIndex, endIndex</i>)
1497 <p>
1498 Private slot to set changed breakpoints.
1499 </p><dl>
1500 <dt><i>startIndex</i></dt>
1501 <dd>
1502 start index of the breakpoints being changed
1503 (QModelIndex)
1504 </dd><dt><i>endIndex</i></dt>
1505 <dd>
1506 end index of the breakpoints being changed
1507 (QModelIndex)
1508 </dd>
1509 </dl><a NAME="Editor.__charAdded" ID="Editor.__charAdded"></a>
1510 <h4>Editor.__charAdded</h4>
1511 <b>__charAdded</b>(<i>charNumber</i>)
1512 <p>
1513 Private slot called to handle the user entering a character.
1514 </p><dl>
1515 <dt><i>charNumber</i></dt>
1516 <dd>
1517 value of the character entered (integer)
1518 </dd>
1519 </dl><a NAME="Editor.__checkEncoding" ID="Editor.__checkEncoding"></a>
1520 <h4>Editor.__checkEncoding</h4>
1521 <b>__checkEncoding</b>(<i></i>)
1522 <p>
1523 Private method to check the selected encoding of the encodings submenu.
1524 </p><a NAME="Editor.__checkEol" ID="Editor.__checkEol"></a>
1525 <h4>Editor.__checkEol</h4>
1526 <b>__checkEol</b>(<i></i>)
1527 <p>
1528 Private method to check the selected eol type of the eol submenu.
1529 </p><a NAME="Editor.__checkLanguage" ID="Editor.__checkLanguage"></a>
1530 <h4>Editor.__checkLanguage</h4>
1531 <b>__checkLanguage</b>(<i></i>)
1532 <p>
1533 Private method to check the selected language of the language submenu.
1534 </p><a NAME="Editor.__checkSpellingSelection" ID="Editor.__checkSpellingSelection"></a>
1535 <h4>Editor.__checkSpellingSelection</h4>
1536 <b>__checkSpellingSelection</b>(<i></i>)
1537 <p>
1538 Private slot to spell check the current selection.
1539 </p><a NAME="Editor.__checkSpellingWord" ID="Editor.__checkSpellingWord"></a>
1540 <h4>Editor.__checkSpellingWord</h4>
1541 <b>__checkSpellingWord</b>(<i></i>)
1542 <p>
1543 Private slot to check the word below the spelling context menu.
1544 </p><a NAME="Editor.__clearBreakpoints" ID="Editor.__clearBreakpoints"></a>
1545 <h4>Editor.__clearBreakpoints</h4>
1546 <b>__clearBreakpoints</b>(<i>fileName</i>)
1547 <p>
1548 Private slot to clear all breakpoints.
1549 </p><dl>
1550 <dt><i>fileName</i></dt>
1551 <dd>
1552 name of the file (string)
1553 </dd>
1554 </dl><a NAME="Editor.__clearCompletionsCache" ID="Editor.__clearCompletionsCache"></a>
1555 <h4>Editor.__clearCompletionsCache</h4>
1556 <b>__clearCompletionsCache</b>(<i></i>)
1557 <p>
1558 Private method to clear the auto-completions cache.
1559 </p><a NAME="Editor.__clearTypedWarning" ID="Editor.__clearTypedWarning"></a>
1560 <h4>Editor.__clearTypedWarning</h4>
1561 <b>__clearTypedWarning</b>(<i>warningKind</i>)
1562 <p>
1563 Private method to clear warnings of a specific kind.
1564 </p><dl>
1565 <dt><i>warningKind</i></dt>
1566 <dd>
1567 kind of warning to clear (Editor.WarningCode,
1568 Editor.WarningStyle)
1569 </dd>
1570 </dl><a NAME="Editor.__codeCoverageHideAnnotations" ID="Editor.__codeCoverageHideAnnotations"></a>
1571 <h4>Editor.__codeCoverageHideAnnotations</h4>
1572 <b>__codeCoverageHideAnnotations</b>(<i></i>)
1573 <p>
1574 Private method to handle the hide code coverage annotations context
1575 menu action.
1576 </p><a NAME="Editor.__completionListSelected" ID="Editor.__completionListSelected"></a>
1577 <h4>Editor.__completionListSelected</h4>
1578 <b>__completionListSelected</b>(<i>listId, txt</i>)
1579 <p>
1580 Private slot to handle the selection from the completion list.
1581 </p><dl>
1582 <dt><i>listId</i></dt>
1583 <dd>
1584 the ID of the user list (should be 1 or 2) (integer)
1585 </dd><dt><i>txt</i></dt>
1586 <dd>
1587 the selected text (string)
1588 </dd>
1589 </dl><a NAME="Editor.__contextClose" ID="Editor.__contextClose"></a>
1590 <h4>Editor.__contextClose</h4>
1591 <b>__contextClose</b>(<i></i>)
1592 <p>
1593 Private slot handling the close context menu entry.
1594 </p><a NAME="Editor.__contextMenuCollapseFoldWithChildren" ID="Editor.__contextMenuCollapseFoldWithChildren"></a>
1595 <h4>Editor.__contextMenuCollapseFoldWithChildren</h4>
1596 <b>__contextMenuCollapseFoldWithChildren</b>(<i></i>)
1597 <p>
1598 Private slot to handle the context menu collapse with children action.
1599 </p><a NAME="Editor.__contextMenuExpandFoldWithChildren" ID="Editor.__contextMenuExpandFoldWithChildren"></a>
1600 <h4>Editor.__contextMenuExpandFoldWithChildren</h4>
1601 <b>__contextMenuExpandFoldWithChildren</b>(<i></i>)
1602 <p>
1603 Private slot to handle the context menu expand with children action.
1604 </p><a NAME="Editor.__contextMenuSpellingTriggered" ID="Editor.__contextMenuSpellingTriggered"></a>
1605 <h4>Editor.__contextMenuSpellingTriggered</h4>
1606 <b>__contextMenuSpellingTriggered</b>(<i>action</i>)
1607 <p>
1608 Private slot to handle the selection of a suggestion of the spelling
1609 context menu.
1610 </p><dl>
1611 <dt><i>action</i></dt>
1612 <dd>
1613 reference to the action that was selected (QAction)
1614 </dd>
1615 </dl><a NAME="Editor.__contextOpenRejections" ID="Editor.__contextOpenRejections"></a>
1616 <h4>Editor.__contextOpenRejections</h4>
1617 <b>__contextOpenRejections</b>(<i></i>)
1618 <p>
1619 Private slot handling the open rejections file context menu entry.
1620 </p><a NAME="Editor.__contextSave" ID="Editor.__contextSave"></a>
1621 <h4>Editor.__contextSave</h4>
1622 <b>__contextSave</b>(<i></i>)
1623 <p>
1624 Private slot handling the save context menu entry.
1625 </p><a NAME="Editor.__contextSaveAs" ID="Editor.__contextSaveAs"></a>
1626 <h4>Editor.__contextSaveAs</h4>
1627 <b>__contextSaveAs</b>(<i></i>)
1628 <p>
1629 Private slot handling the save as context menu entry.
1630 </p><a NAME="Editor.__contextSaveCopy" ID="Editor.__contextSaveCopy"></a>
1631 <h4>Editor.__contextSaveCopy</h4>
1632 <b>__contextSaveCopy</b>(<i></i>)
1633 <p>
1634 Private slot handling the save copy context menu entry.
1635 </p><a NAME="Editor.__createChangeMarkerPixmap" ID="Editor.__createChangeMarkerPixmap"></a>
1636 <h4>Editor.__createChangeMarkerPixmap</h4>
1637 <b>__createChangeMarkerPixmap</b>(<i>key, size=16, width=4</i>)
1638 <p>
1639 Private method to create a pixmap for the change markers.
1640 </p><dl>
1641 <dt><i>key</i></dt>
1642 <dd>
1643 key of the color to use (string)
1644 </dd><dt><i>size</i></dt>
1645 <dd>
1646 size of the pixmap (integer)
1647 </dd><dt><i>width</i></dt>
1648 <dd>
1649 width of the marker line (integer)
1650 </dd>
1651 </dl><dl>
1652 <dt>Returns:</dt>
1653 <dd>
1654 create pixmap (QPixmap)
1655 </dd>
1656 </dl><a NAME="Editor.__cursorPositionChanged" ID="Editor.__cursorPositionChanged"></a>
1657 <h4>Editor.__cursorPositionChanged</h4>
1658 <b>__cursorPositionChanged</b>(<i>line, index</i>)
1659 <p>
1660 Private slot to handle the cursorPositionChanged signal.
1661 </p><p>
1662 It emits the signal cursorChanged with parameters fileName,
1663 line and pos.
1664 </p><dl>
1665 <dt><i>line</i></dt>
1666 <dd>
1667 line number of the cursor
1668 </dd><dt><i>index</i></dt>
1669 <dd>
1670 position in line of the cursor
1671 </dd>
1672 </dl><a NAME="Editor.__deleteAllChangeMarkers" ID="Editor.__deleteAllChangeMarkers"></a>
1673 <h4>Editor.__deleteAllChangeMarkers</h4>
1674 <b>__deleteAllChangeMarkers</b>(<i></i>)
1675 <p>
1676 Private slot to delete all change markers.
1677 </p><a NAME="Editor.__deleteBreakPoints" ID="Editor.__deleteBreakPoints"></a>
1678 <h4>Editor.__deleteBreakPoints</h4>
1679 <b>__deleteBreakPoints</b>(<i>parentIndex, start, end</i>)
1680 <p>
1681 Private slot to delete breakpoints.
1682 </p><dl>
1683 <dt><i>parentIndex</i></dt>
1684 <dd>
1685 index of parent item (QModelIndex)
1686 </dd><dt><i>start</i></dt>
1687 <dd>
1688 start row (integer)
1689 </dd><dt><i>end</i></dt>
1690 <dd>
1691 end row (integer)
1692 </dd>
1693 </dl><a NAME="Editor.__deselectAll" ID="Editor.__deselectAll"></a>
1694 <h4>Editor.__deselectAll</h4>
1695 <b>__deselectAll</b>(<i></i>)
1696 <p>
1697 Private slot handling the deselect all context menu action.
1698 </p><a NAME="Editor.__dispatchCommand" ID="Editor.__dispatchCommand"></a>
1699 <h4>Editor.__dispatchCommand</h4>
1700 <b>__dispatchCommand</b>(<i>command</i>)
1701 <p>
1702 Private method to dispatch received commands.
1703 </p><dl>
1704 <dt><i>command</i></dt>
1705 <dd>
1706 command to be processed (string)
1707 </dd>
1708 </dl><a NAME="Editor.__encodingChanged" ID="Editor.__encodingChanged"></a>
1709 <h4>Editor.__encodingChanged</h4>
1710 <b>__encodingChanged</b>(<i>encoding, propagate=True</i>)
1711 <p>
1712 Private slot to handle a change of the encoding.
1713 </p><dl>
1714 <dt><i>encoding</i></dt>
1715 <dd>
1716 changed encoding (string)
1717 </dd><dt><i>propagate=</i></dt>
1718 <dd>
1719 flag indicating to propagate the change (boolean)
1720 </dd>
1721 </dl><a NAME="Editor.__encodingsMenuTriggered" ID="Editor.__encodingsMenuTriggered"></a>
1722 <h4>Editor.__encodingsMenuTriggered</h4>
1723 <b>__encodingsMenuTriggered</b>(<i>act</i>)
1724 <p>
1725 Private method to handle the selection of an encoding.
1726 </p><dl>
1727 <dt><i>act</i></dt>
1728 <dd>
1729 reference to the action that was triggered (QAction)
1730 </dd>
1731 </dl><a NAME="Editor.__eolChanged" ID="Editor.__eolChanged"></a>
1732 <h4>Editor.__eolChanged</h4>
1733 <b>__eolChanged</b>(<i></i>)
1734 <p>
1735 Private slot to handle a change of the eol mode.
1736 </p><a NAME="Editor.__eolMenuTriggered" ID="Editor.__eolMenuTriggered"></a>
1737 <h4>Editor.__eolMenuTriggered</h4>
1738 <b>__eolMenuTriggered</b>(<i>act</i>)
1739 <p>
1740 Private method to handle the selection of an eol type.
1741 </p><dl>
1742 <dt><i>act</i></dt>
1743 <dd>
1744 reference to the action that was triggered (QAction)
1745 </dd>
1746 </dl><a NAME="Editor.__executeSelection" ID="Editor.__executeSelection"></a>
1747 <h4>Editor.__executeSelection</h4>
1748 <b>__executeSelection</b>(<i></i>)
1749 <p>
1750 Private slot to execute the selected text in the shell window.
1751 </p><a NAME="Editor.__exportMenuTriggered" ID="Editor.__exportMenuTriggered"></a>
1752 <h4>Editor.__exportMenuTriggered</h4>
1753 <b>__exportMenuTriggered</b>(<i>act</i>)
1754 <p>
1755 Private method to handle the selection of an export format.
1756 </p><dl>
1757 <dt><i>act</i></dt>
1758 <dd>
1759 reference to the action that was triggered (QAction)
1760 </dd>
1761 </dl><a NAME="Editor.__getAcText" ID="Editor.__getAcText"></a>
1762 <h4>Editor.__getAcText</h4>
1763 <b>__getAcText</b>(<i></i>)
1764 <p>
1765 Private method to get the text from cursor position for autocompleting.
1766 </p><dl>
1767 <dt>Returns:</dt>
1768 <dd>
1769 text left of cursor position
1770 </dd>
1771 </dl><dl>
1772 <dt>Return Type:</dt>
1773 <dd>
1774 str
1775 </dd>
1776 </dl><a NAME="Editor.__getCharacter" ID="Editor.__getCharacter"></a>
1777 <h4>Editor.__getCharacter</h4>
1778 <b>__getCharacter</b>(<i>pos</i>)
1779 <p>
1780 Private method to get the character to the left of the current position
1781 in the current line.
1782 </p><dl>
1783 <dt><i>pos</i></dt>
1784 <dd>
1785 position to get character at (integer)
1786 </dd>
1787 </dl><dl>
1788 <dt>Returns:</dt>
1789 <dd>
1790 requested character or "", if there are no more (string) and
1791 the next position (i.e. pos - 1)
1792 </dd>
1793 </dl><a NAME="Editor.__getCodeCoverageFile" ID="Editor.__getCodeCoverageFile"></a>
1794 <h4>Editor.__getCodeCoverageFile</h4>
1795 <b>__getCodeCoverageFile</b>(<i></i>)
1796 <p>
1797 Private method to get the file name of the file containing coverage
1798 info.
1799 </p><dl>
1800 <dt>Returns:</dt>
1801 <dd>
1802 file name of the coverage file (string)
1803 </dd>
1804 </dl><a NAME="Editor.__getEditorConfig" ID="Editor.__getEditorConfig"></a>
1805 <h4>Editor.__getEditorConfig</h4>
1806 <b>__getEditorConfig</b>(<i>option, nodefault=False, config=None</i>)
1807 <p>
1808 Private method to get the requested option via EditorConfig.
1809 </p><p>
1810 If there is no EditorConfig defined, the equivalent built-in option
1811 will be used (Preferences.getEditor(). The option must be given as the
1812 Preferences option key. The mapping to the EditorConfig option name
1813 will be done within this method.
1814 </p><dl>
1815 <dt><i>option</i> (str)</dt>
1816 <dd>
1817 Preferences option key
1818 </dd><dt><i>nodefault</i> (bool)</dt>
1819 <dd>
1820 flag indicating to not get the default value from
1821 Preferences but return None instead
1822 </dd><dt><i>config</i> (dict)</dt>
1823 <dd>
1824 reference to an EditorConfig object or None
1825 </dd>
1826 </dl><dl>
1827 <dt>Returns:</dt>
1828 <dd>
1829 value of requested setting or None if nothing was found and
1830 nodefault parameter was True
1831 </dd>
1832 </dl><dl>
1833 <dt>Return Type:</dt>
1834 <dd>
1835 any
1836 </dd>
1837 </dl><a NAME="Editor.__getMacroName" ID="Editor.__getMacroName"></a>
1838 <h4>Editor.__getMacroName</h4>
1839 <b>__getMacroName</b>(<i></i>)
1840 <p>
1841 Private method to select a macro name from the list of macros.
1842 </p><dl>
1843 <dt>Returns:</dt>
1844 <dd>
1845 Tuple of macro name and a flag, indicating, if the user
1846 pressed ok or canceled the operation. (string, boolean)
1847 </dd>
1848 </dl><a NAME="Editor.__getPyVersion" ID="Editor.__getPyVersion"></a>
1849 <h4>Editor.__getPyVersion</h4>
1850 <b>__getPyVersion</b>(<i></i>)
1851 <p>
1852 Private method to return the Python main version (2 or 3) or 0 if it's
1853 not a Python file at all.
1854 </p><dl>
1855 <dt>Returns:</dt>
1856 <dd>
1857 Python version (2 or 3) or 0 if it's not a Python file (int)
1858 </dd>
1859 </dl><a NAME="Editor.__getSaveFileName" ID="Editor.__getSaveFileName"></a>
1860 <h4>Editor.__getSaveFileName</h4>
1861 <b>__getSaveFileName</b>(<i>path=None</i>)
1862 <p>
1863 Private method to get the name of the file to be saved.
1864 </p><dl>
1865 <dt><i>path</i></dt>
1866 <dd>
1867 directory to save the file in (string)
1868 </dd>
1869 </dl><dl>
1870 <dt>Returns:</dt>
1871 <dd>
1872 file name (string)
1873 </dd>
1874 </dl><a NAME="Editor.__ignoreSpellingAlways" ID="Editor.__ignoreSpellingAlways"></a>
1875 <h4>Editor.__ignoreSpellingAlways</h4>
1876 <b>__ignoreSpellingAlways</b>(<i></i>)
1877 <p>
1878 Private to always ignore the word below the spelling context menu.
1879 </p><a NAME="Editor.__indentLine" ID="Editor.__indentLine"></a>
1880 <h4>Editor.__indentLine</h4>
1881 <b>__indentLine</b>(<i>indent=True</i>)
1882 <p>
1883 Private method to indent or unindent the current line.
1884 </p><dl>
1885 <dt><i>indent</i></dt>
1886 <dd>
1887 flag indicating an indent operation (boolean)
1888 <br />If the flag is true, an indent operation is performed.
1889 Otherwise the current line is unindented.
1890 </dd>
1891 </dl><a NAME="Editor.__indentSelection" ID="Editor.__indentSelection"></a>
1892 <h4>Editor.__indentSelection</h4>
1893 <b>__indentSelection</b>(<i>indent=True</i>)
1894 <p>
1895 Private method to indent or unindent the current selection.
1896 </p><dl>
1897 <dt><i>indent</i></dt>
1898 <dd>
1899 flag indicating an indent operation (boolean)
1900 <br />If the flag is true, an indent operation is performed.
1901 Otherwise the current line is unindented.
1902 </dd>
1903 </dl><a NAME="Editor.__initContextMenu" ID="Editor.__initContextMenu"></a>
1904 <h4>Editor.__initContextMenu</h4>
1905 <b>__initContextMenu</b>(<i></i>)
1906 <p>
1907 Private method used to setup the context menu.
1908 </p><a NAME="Editor.__initContextMenuAutocompletion" ID="Editor.__initContextMenuAutocompletion"></a>
1909 <h4>Editor.__initContextMenuAutocompletion</h4>
1910 <b>__initContextMenuAutocompletion</b>(<i></i>)
1911 <p>
1912 Private method used to setup the Checks context sub menu.
1913 </p><dl>
1914 <dt>Returns:</dt>
1915 <dd>
1916 reference to the generated menu (QMenu)
1917 </dd>
1918 </dl><a NAME="Editor.__initContextMenuChecks" ID="Editor.__initContextMenuChecks"></a>
1919 <h4>Editor.__initContextMenuChecks</h4>
1920 <b>__initContextMenuChecks</b>(<i></i>)
1921 <p>
1922 Private method used to setup the Checks context sub menu.
1923 </p><dl>
1924 <dt>Returns:</dt>
1925 <dd>
1926 reference to the generated menu (QMenu)
1927 </dd>
1928 </dl><a NAME="Editor.__initContextMenuEncodings" ID="Editor.__initContextMenuEncodings"></a>
1929 <h4>Editor.__initContextMenuEncodings</h4>
1930 <b>__initContextMenuEncodings</b>(<i></i>)
1931 <p>
1932 Private method used to setup the Encodings context sub menu.
1933 </p><dl>
1934 <dt>Returns:</dt>
1935 <dd>
1936 reference to the generated menu (QMenu)
1937 </dd>
1938 </dl><a NAME="Editor.__initContextMenuEol" ID="Editor.__initContextMenuEol"></a>
1939 <h4>Editor.__initContextMenuEol</h4>
1940 <b>__initContextMenuEol</b>(<i></i>)
1941 <p>
1942 Private method to setup the eol context sub menu.
1943 </p><dl>
1944 <dt>Returns:</dt>
1945 <dd>
1946 reference to the generated menu (QMenu)
1947 </dd>
1948 </dl><a NAME="Editor.__initContextMenuExporters" ID="Editor.__initContextMenuExporters"></a>
1949 <h4>Editor.__initContextMenuExporters</h4>
1950 <b>__initContextMenuExporters</b>(<i></i>)
1951 <p>
1952 Private method used to setup the Exporters context sub menu.
1953 </p><dl>
1954 <dt>Returns:</dt>
1955 <dd>
1956 reference to the generated menu (QMenu)
1957 </dd>
1958 </dl><a NAME="Editor.__initContextMenuGraphics" ID="Editor.__initContextMenuGraphics"></a>
1959 <h4>Editor.__initContextMenuGraphics</h4>
1960 <b>__initContextMenuGraphics</b>(<i></i>)
1961 <p>
1962 Private method used to setup the diagrams context sub menu.
1963 </p><dl>
1964 <dt>Returns:</dt>
1965 <dd>
1966 reference to the generated menu (QMenu)
1967 </dd>
1968 </dl><a NAME="Editor.__initContextMenuLanguages" ID="Editor.__initContextMenuLanguages"></a>
1969 <h4>Editor.__initContextMenuLanguages</h4>
1970 <b>__initContextMenuLanguages</b>(<i></i>)
1971 <p>
1972 Private method used to setup the Languages context sub menu.
1973 </p><dl>
1974 <dt>Returns:</dt>
1975 <dd>
1976 reference to the generated menu (QMenu)
1977 </dd>
1978 </dl><a NAME="Editor.__initContextMenuMargins" ID="Editor.__initContextMenuMargins"></a>
1979 <h4>Editor.__initContextMenuMargins</h4>
1980 <b>__initContextMenuMargins</b>(<i></i>)
1981 <p>
1982 Private method used to setup the context menu for the margins.
1983 </p><a NAME="Editor.__initContextMenuReopenWithEncoding" ID="Editor.__initContextMenuReopenWithEncoding"></a>
1984 <h4>Editor.__initContextMenuReopenWithEncoding</h4>
1985 <b>__initContextMenuReopenWithEncoding</b>(<i></i>)
1986 <p>
1987 Private method used to setup the Reopen With Encoding context sub menu.
1988 </p><dl>
1989 <dt>Returns:</dt>
1990 <dd>
1991 reference to the generated menu (QMenu)
1992 </dd>
1993 </dl><a NAME="Editor.__initContextMenuResources" ID="Editor.__initContextMenuResources"></a>
1994 <h4>Editor.__initContextMenuResources</h4>
1995 <b>__initContextMenuResources</b>(<i></i>)
1996 <p>
1997 Private method used to setup the Resources context sub menu.
1998 </p><dl>
1999 <dt>Returns:</dt>
2000 <dd>
2001 reference to the generated menu (QMenu)
2002 </dd>
2003 </dl><a NAME="Editor.__initContextMenuShow" ID="Editor.__initContextMenuShow"></a>
2004 <h4>Editor.__initContextMenuShow</h4>
2005 <b>__initContextMenuShow</b>(<i></i>)
2006 <p>
2007 Private method used to setup the Show context sub menu.
2008 </p><dl>
2009 <dt>Returns:</dt>
2010 <dd>
2011 reference to the generated menu (QMenu)
2012 </dd>
2013 </dl><a NAME="Editor.__initContextMenuTools" ID="Editor.__initContextMenuTools"></a>
2014 <h4>Editor.__initContextMenuTools</h4>
2015 <b>__initContextMenuTools</b>(<i></i>)
2016 <p>
2017 Private method used to setup the Tools context sub menu.
2018 </p><dl>
2019 <dt>Returns:</dt>
2020 <dd>
2021 reference to the generated menu (QMenu)
2022 </dd>
2023 </dl><a NAME="Editor.__initOnlineChangeTrace" ID="Editor.__initOnlineChangeTrace"></a>
2024 <h4>Editor.__initOnlineChangeTrace</h4>
2025 <b>__initOnlineChangeTrace</b>(<i></i>)
2026 <p>
2027 Private slot to initialize the online change trace.
2028 </p><a NAME="Editor.__initOnlineSyntaxCheck" ID="Editor.__initOnlineSyntaxCheck"></a>
2029 <h4>Editor.__initOnlineSyntaxCheck</h4>
2030 <b>__initOnlineSyntaxCheck</b>(<i></i>)
2031 <p>
2032 Private slot to initialize the online syntax check.
2033 </p><a NAME="Editor.__isCommentedLine" ID="Editor.__isCommentedLine"></a>
2034 <h4>Editor.__isCommentedLine</h4>
2035 <b>__isCommentedLine</b>(<i>line, commentStr</i>)
2036 <p>
2037 Private method to check, if the given line is a comment line as
2038 produced by the configured comment rules.
2039 </p><dl>
2040 <dt><i>line</i></dt>
2041 <dd>
2042 text of the line to check (string)
2043 </dd><dt><i>commentStr</i></dt>
2044 <dd>
2045 comment string to check against (string)
2046 </dd>
2047 </dl><dl>
2048 <dt>Returns:</dt>
2049 <dd>
2050 flag indicating a commented line (boolean)
2051 </dd>
2052 </dl><a NAME="Editor.__isStartChar" ID="Editor.__isStartChar"></a>
2053 <h4>Editor.__isStartChar</h4>
2054 <b>__isStartChar</b>(<i>ch</i>)
2055 <p>
2056 Private method to check, if a character is an autocompletion start
2057 character.
2058 </p><dl>
2059 <dt><i>ch</i></dt>
2060 <dd>
2061 character to be checked (one character string)
2062 </dd>
2063 </dl><dl>
2064 <dt>Returns:</dt>
2065 <dd>
2066 flag indicating the result (boolean)
2067 </dd>
2068 </dl><a NAME="Editor.__languageChanged" ID="Editor.__languageChanged"></a>
2069 <h4>Editor.__languageChanged</h4>
2070 <b>__languageChanged</b>(<i>language, propagate=True</i>)
2071 <p>
2072 Private slot handling a change of a connected editor's language.
2073 </p><dl>
2074 <dt><i>language</i></dt>
2075 <dd>
2076 language to be set (string)
2077 </dd><dt><i>propagate=</i></dt>
2078 <dd>
2079 flag indicating to propagate the change (boolean)
2080 </dd>
2081 </dl><a NAME="Editor.__languageMenuTriggered" ID="Editor.__languageMenuTriggered"></a>
2082 <h4>Editor.__languageMenuTriggered</h4>
2083 <b>__languageMenuTriggered</b>(<i>act</i>)
2084 <p>
2085 Private method to handle the selection of a lexer language.
2086 </p><dl>
2087 <dt><i>act</i></dt>
2088 <dd>
2089 reference to the action that was triggered (QAction)
2090 </dd>
2091 </dl><a NAME="Editor.__lmBbookmarks" ID="Editor.__lmBbookmarks"></a>
2092 <h4>Editor.__lmBbookmarks</h4>
2093 <b>__lmBbookmarks</b>(<i></i>)
2094 <p>
2095 Private method to handle the 'LMB toggles bookmark' context menu
2096 action.
2097 </p><a NAME="Editor.__lmBbreakpoints" ID="Editor.__lmBbreakpoints"></a>
2098 <h4>Editor.__lmBbreakpoints</h4>
2099 <b>__lmBbreakpoints</b>(<i></i>)
2100 <p>
2101 Private method to handle the 'LMB toggles breakpoint' context menu
2102 action.
2103 </p><a NAME="Editor.__loadDiagram" ID="Editor.__loadDiagram"></a>
2104 <h4>Editor.__loadDiagram</h4>
2105 <b>__loadDiagram</b>(<i></i>)
2106 <p>
2107 Private slot to load a diagram from file.
2108 </p><a NAME="Editor.__loadEditorConfig" ID="Editor.__loadEditorConfig"></a>
2109 <h4>Editor.__loadEditorConfig</h4>
2110 <b>__loadEditorConfig</b>(<i>fileName=""</i>)
2111 <p>
2112 Private method to load the EditorConfig properties.
2113 </p><dl>
2114 <dt><i>fileName</i> (str)</dt>
2115 <dd>
2116 name of the file
2117 </dd>
2118 </dl><a NAME="Editor.__loadEditorConfigObject" ID="Editor.__loadEditorConfigObject"></a>
2119 <h4>Editor.__loadEditorConfigObject</h4>
2120 <b>__loadEditorConfigObject</b>(<i>fileName</i>)
2121 <p>
2122 Private method to load the EditorConfig properties for the given
2123 file name.
2124 </p><dl>
2125 <dt><i>fileName</i> (str)</dt>
2126 <dd>
2127 name of the file
2128 </dd>
2129 </dl><dl>
2130 <dt>Returns:</dt>
2131 <dd>
2132 EditorConfig dictionary
2133 </dd>
2134 </dl><dl>
2135 <dt>Return Type:</dt>
2136 <dd>
2137 dict
2138 </dd>
2139 </dl><a NAME="Editor.__marginClicked" ID="Editor.__marginClicked"></a>
2140 <h4>Editor.__marginClicked</h4>
2141 <b>__marginClicked</b>(<i>margin, line, modifiers</i>)
2142 <p>
2143 Private slot to handle the marginClicked signal.
2144 </p><dl>
2145 <dt><i>margin</i></dt>
2146 <dd>
2147 id of the clicked margin (integer)
2148 </dd><dt><i>line</i></dt>
2149 <dd>
2150 line number of the click (integer)
2151 </dd><dt><i>modifiers</i></dt>
2152 <dd>
2153 keyboard modifiers (Qt.KeyboardModifiers)
2154 </dd>
2155 </dl><a NAME="Editor.__marginNumber" ID="Editor.__marginNumber"></a>
2156 <h4>Editor.__marginNumber</h4>
2157 <b>__marginNumber</b>(<i>xPos</i>)
2158 <p>
2159 Private method to calculate the margin number based on a x position.
2160 </p><dl>
2161 <dt><i>xPos</i></dt>
2162 <dd>
2163 x position (integer)
2164 </dd>
2165 </dl><dl>
2166 <dt>Returns:</dt>
2167 <dd>
2168 margin number (integer, -1 for no margin)
2169 </dd>
2170 </dl><a NAME="Editor.__markOccurrences" ID="Editor.__markOccurrences"></a>
2171 <h4>Editor.__markOccurrences</h4>
2172 <b>__markOccurrences</b>(<i></i>)
2173 <p>
2174 Private method to mark all occurrences of the current word.
2175 </p><a NAME="Editor.__menuClearBreakpoints" ID="Editor.__menuClearBreakpoints"></a>
2176 <h4>Editor.__menuClearBreakpoints</h4>
2177 <b>__menuClearBreakpoints</b>(<i></i>)
2178 <p>
2179 Private slot to handle the 'Clear all breakpoints' context menu action.
2180 </p><a NAME="Editor.__menuToggleBreakpointEnabled" ID="Editor.__menuToggleBreakpointEnabled"></a>
2181 <h4>Editor.__menuToggleBreakpointEnabled</h4>
2182 <b>__menuToggleBreakpointEnabled</b>(<i></i>)
2183 <p>
2184 Private slot to handle the 'Enable/Disable breakpoint' context menu
2185 action.
2186 </p><a NAME="Editor.__menuToggleTemporaryBreakpoint" ID="Editor.__menuToggleTemporaryBreakpoint"></a>
2187 <h4>Editor.__menuToggleTemporaryBreakpoint</h4>
2188 <b>__menuToggleTemporaryBreakpoint</b>(<i></i>)
2189 <p>
2190 Private slot to handle the 'Toggle temporary breakpoint' context menu
2191 action.
2192 </p><a NAME="Editor.__modificationChanged" ID="Editor.__modificationChanged"></a>
2193 <h4>Editor.__modificationChanged</h4>
2194 <b>__modificationChanged</b>(<i>m</i>)
2195 <p>
2196 Private slot to handle the modificationChanged signal.
2197 </p><p>
2198 It emits the signal modificationStatusChanged with parameters
2199 m and self.
2200 </p><dl>
2201 <dt><i>m</i></dt>
2202 <dd>
2203 modification status
2204 </dd>
2205 </dl><a NAME="Editor.__modificationReadOnly" ID="Editor.__modificationReadOnly"></a>
2206 <h4>Editor.__modificationReadOnly</h4>
2207 <b>__modificationReadOnly</b>(<i></i>)
2208 <p>
2209 Private slot to handle the modificationAttempted signal.
2210 </p><a NAME="Editor.__modified" ID="Editor.__modified"></a>
2211 <h4>Editor.__modified</h4>
2212 <b>__modified</b>(<i>pos, mtype, text, length, linesAdded, line, foldNow, foldPrev, token, annotationLinesAdded</i>)
2213 <p>
2214 Private method to handle changes of the number of lines.
2215 </p><dl>
2216 <dt><i>pos</i></dt>
2217 <dd>
2218 start position of change (integer)
2219 </dd><dt><i>mtype</i></dt>
2220 <dd>
2221 flags identifying the change (integer)
2222 </dd><dt><i>text</i></dt>
2223 <dd>
2224 text that is given to the Undo system (string)
2225 </dd><dt><i>length</i></dt>
2226 <dd>
2227 length of the change (integer)
2228 </dd><dt><i>linesAdded</i></dt>
2229 <dd>
2230 number of added/deleted lines (integer)
2231 </dd><dt><i>line</i></dt>
2232 <dd>
2233 line number of a fold level or marker change (integer)
2234 </dd><dt><i>foldNow</i></dt>
2235 <dd>
2236 new fold level (integer)
2237 </dd><dt><i>foldPrev</i></dt>
2238 <dd>
2239 previous fold level (integer)
2240 </dd><dt><i>token</i></dt>
2241 <dd>
2242 ???
2243 </dd><dt><i>annotationLinesAdded</i></dt>
2244 <dd>
2245 number of added/deleted annotation lines
2246 (integer)
2247 </dd>
2248 </dl><a NAME="Editor.__newView" ID="Editor.__newView"></a>
2249 <h4>Editor.__newView</h4>
2250 <b>__newView</b>(<i></i>)
2251 <p>
2252 Private slot to create a new view to an open document.
2253 </p><a NAME="Editor.__newViewNewSplit" ID="Editor.__newViewNewSplit"></a>
2254 <h4>Editor.__newViewNewSplit</h4>
2255 <b>__newViewNewSplit</b>(<i></i>)
2256 <p>
2257 Private slot to create a new view to an open document.
2258 </p><a NAME="Editor.__normalizedEncoding" ID="Editor.__normalizedEncoding"></a>
2259 <h4>Editor.__normalizedEncoding</h4>
2260 <b>__normalizedEncoding</b>(<i>encoding=""</i>)
2261 <p>
2262 Private method to calculate the normalized encoding string.
2263 </p><dl>
2264 <dt><i>encoding</i></dt>
2265 <dd>
2266 encoding to be normalized (string)
2267 </dd>
2268 </dl><dl>
2269 <dt>Returns:</dt>
2270 <dd>
2271 normalized encoding (string)
2272 </dd>
2273 </dl><a NAME="Editor.__onlineChangeTraceTimerTimeout" ID="Editor.__onlineChangeTraceTimerTimeout"></a>
2274 <h4>Editor.__onlineChangeTraceTimerTimeout</h4>
2275 <b>__onlineChangeTraceTimerTimeout</b>(<i></i>)
2276 <p>
2277 Private slot to mark added and changed lines.
2278 </p><a NAME="Editor.__printPreview" ID="Editor.__printPreview"></a>
2279 <h4>Editor.__printPreview</h4>
2280 <b>__printPreview</b>(<i>printer</i>)
2281 <p>
2282 Private slot to generate a print preview.
2283 </p><dl>
2284 <dt><i>printer</i></dt>
2285 <dd>
2286 reference to the printer object
2287 (QScintilla.Printer.Printer)
2288 </dd>
2289 </dl><a NAME="Editor.__processEndEditCommand" ID="Editor.__processEndEditCommand"></a>
2290 <h4>Editor.__processEndEditCommand</h4>
2291 <b>__processEndEditCommand</b>(<i>argsString</i>)
2292 <p>
2293 Private slot to process a remote EndEdit command.
2294 </p><dl>
2295 <dt><i>argsString</i></dt>
2296 <dd>
2297 string containing the command parameters (string)
2298 </dd>
2299 </dl><a NAME="Editor.__processFlags" ID="Editor.__processFlags"></a>
2300 <h4>Editor.__processFlags</h4>
2301 <b>__processFlags</b>(<i></i>)
2302 <p>
2303 Private method to extract flags and process them.
2304 </p><dl>
2305 <dt>Returns:</dt>
2306 <dd>
2307 list of change flags (list of string)
2308 </dd>
2309 </dl><a NAME="Editor.__processRequestSyncCommand" ID="Editor.__processRequestSyncCommand"></a>
2310 <h4>Editor.__processRequestSyncCommand</h4>
2311 <b>__processRequestSyncCommand</b>(<i>argsString</i>)
2312 <p>
2313 Private slot to process a remote RequestSync command.
2314 </p><dl>
2315 <dt><i>argsString</i></dt>
2316 <dd>
2317 string containing the command parameters (string)
2318 </dd>
2319 </dl><a NAME="Editor.__processStartEditCommand" ID="Editor.__processStartEditCommand"></a>
2320 <h4>Editor.__processStartEditCommand</h4>
2321 <b>__processStartEditCommand</b>(<i>argsString</i>)
2322 <p>
2323 Private slot to process a remote StartEdit command.
2324 </p><dl>
2325 <dt><i>argsString</i></dt>
2326 <dd>
2327 string containing the command parameters (string)
2328 </dd>
2329 </dl><a NAME="Editor.__processSyncCommand" ID="Editor.__processSyncCommand"></a>
2330 <h4>Editor.__processSyncCommand</h4>
2331 <b>__processSyncCommand</b>(<i>argsString</i>)
2332 <p>
2333 Private slot to process a remote Sync command.
2334 </p><dl>
2335 <dt><i>argsString</i></dt>
2336 <dd>
2337 string containing the command parameters (string)
2338 </dd>
2339 </dl><a NAME="Editor.__processSyntaxCheckError" ID="Editor.__processSyntaxCheckError"></a>
2340 <h4>Editor.__processSyntaxCheckError</h4>
2341 <b>__processSyntaxCheckError</b>(<i>fn, msg</i>)
2342 <p>
2343 Private slot to report an error message of a syntax check.
2344 </p><dl>
2345 <dt><i>fn</i> (str)</dt>
2346 <dd>
2347 filename of the file
2348 </dd><dt><i>msg</i> (str)</dt>
2349 <dd>
2350 error message
2351 </dd>
2352 </dl><a NAME="Editor.__processSyntaxCheckResult" ID="Editor.__processSyntaxCheckResult"></a>
2353 <h4>Editor.__processSyntaxCheckResult</h4>
2354 <b>__processSyntaxCheckResult</b>(<i>fn, problems</i>)
2355 <p>
2356 Private slot to report the resulting messages of a syntax check.
2357 </p><dl>
2358 <dt><i>fn</i></dt>
2359 <dd>
2360 filename of the checked file (str)
2361 </dd><dt><i>problems</i></dt>
2362 <dd>
2363 dictionary with the keys 'error' and 'warnings' which
2364 hold a list containing details about the error/ warnings
2365 (file name, line number, column, codestring (only at syntax
2366 errors), the message) (dict)
2367 </dd>
2368 </dl><a NAME="Editor.__projectPropertiesChanged" ID="Editor.__projectPropertiesChanged"></a>
2369 <h4>Editor.__projectPropertiesChanged</h4>
2370 <b>__projectPropertiesChanged</b>(<i></i>)
2371 <p>
2372 Private slot to handle changes of the project properties.
2373 </p><a NAME="Editor.__refreshAnnotations" ID="Editor.__refreshAnnotations"></a>
2374 <h4>Editor.__refreshAnnotations</h4>
2375 <b>__refreshAnnotations</b>(<i></i>)
2376 <p>
2377 Private method to refresh the annotations.
2378 </p><a NAME="Editor.__registerImages" ID="Editor.__registerImages"></a>
2379 <h4>Editor.__registerImages</h4>
2380 <b>__registerImages</b>(<i></i>)
2381 <p>
2382 Private method to register images for autocompletion lists.
2383 </p><a NAME="Editor.__reinitOnlineChangeTrace" ID="Editor.__reinitOnlineChangeTrace"></a>
2384 <h4>Editor.__reinitOnlineChangeTrace</h4>
2385 <b>__reinitOnlineChangeTrace</b>(<i></i>)
2386 <p>
2387 Private slot to re-initialize the online change trace.
2388 </p><a NAME="Editor.__removeFromSpellingDictionary" ID="Editor.__removeFromSpellingDictionary"></a>
2389 <h4>Editor.__removeFromSpellingDictionary</h4>
2390 <b>__removeFromSpellingDictionary</b>(<i></i>)
2391 <p>
2392 Private slot to remove the word below the context menu to the
2393 dictionary.
2394 </p><a NAME="Editor.__removeTrailingWhitespace" ID="Editor.__removeTrailingWhitespace"></a>
2395 <h4>Editor.__removeTrailingWhitespace</h4>
2396 <b>__removeTrailingWhitespace</b>(<i></i>)
2397 <p>
2398 Private method to remove trailing whitespace.
2399 </p><a NAME="Editor.__reopenWithEncodingMenuTriggered" ID="Editor.__reopenWithEncodingMenuTriggered"></a>
2400 <h4>Editor.__reopenWithEncodingMenuTriggered</h4>
2401 <b>__reopenWithEncodingMenuTriggered</b>(<i>act</i>)
2402 <p>
2403 Private method to handle the rereading of the file with a selected
2404 encoding.
2405 </p><dl>
2406 <dt><i>act</i></dt>
2407 <dd>
2408 reference to the action that was triggered (QAction)
2409 </dd>
2410 </dl><a NAME="Editor.__replaceLeadingUnderscores" ID="Editor.__replaceLeadingUnderscores"></a>
2411 <h4>Editor.__replaceLeadingUnderscores</h4>
2412 <b>__replaceLeadingUnderscores</b>(<i>txt</i>)
2413 <p>
2414 Private method to replace the first two underlines for invers sorting.
2415 </p><dl>
2416 <dt><i>txt</i> (str)</dt>
2417 <dd>
2418 completion text
2419 </dd>
2420 </dl><dl>
2421 <dt>Returns:</dt>
2422 <dd>
2423 modified completion text
2424 </dd>
2425 </dl><dl>
2426 <dt>Return Type:</dt>
2427 <dd>
2428 str
2429 </dd>
2430 </dl><a NAME="Editor.__resetLanguage" ID="Editor.__resetLanguage"></a>
2431 <h4>Editor.__resetLanguage</h4>
2432 <b>__resetLanguage</b>(<i>propagate=True</i>)
2433 <p>
2434 Private method used to reset the language selection.
2435 </p><dl>
2436 <dt><i>propagate=</i></dt>
2437 <dd>
2438 flag indicating to propagate the change (boolean)
2439 </dd>
2440 </dl><a NAME="Editor.__resetOnlineChangeTraceInfo" ID="Editor.__resetOnlineChangeTraceInfo"></a>
2441 <h4>Editor.__resetOnlineChangeTraceInfo</h4>
2442 <b>__resetOnlineChangeTraceInfo</b>(<i></i>)
2443 <p>
2444 Private slot to reset the online change trace info.
2445 </p><a NAME="Editor.__resetOnlineChangeTraceTimer" ID="Editor.__resetOnlineChangeTraceTimer"></a>
2446 <h4>Editor.__resetOnlineChangeTraceTimer</h4>
2447 <b>__resetOnlineChangeTraceTimer</b>(<i></i>)
2448 <p>
2449 Private method to reset the online syntax check timer.
2450 </p><a NAME="Editor.__resetOnlineSyntaxCheckTimer" ID="Editor.__resetOnlineSyntaxCheckTimer"></a>
2451 <h4>Editor.__resetOnlineSyntaxCheckTimer</h4>
2452 <b>__resetOnlineSyntaxCheckTimer</b>(<i></i>)
2453 <p>
2454 Private method to reset the online syntax check timer.
2455 </p><a NAME="Editor.__resizeLinenoMargin" ID="Editor.__resizeLinenoMargin"></a>
2456 <h4>Editor.__resizeLinenoMargin</h4>
2457 <b>__resizeLinenoMargin</b>(<i></i>)
2458 <p>
2459 Private slot to resize the line numbers margin.
2460 </p><a NAME="Editor.__restoreBreakpoints" ID="Editor.__restoreBreakpoints"></a>
2461 <h4>Editor.__restoreBreakpoints</h4>
2462 <b>__restoreBreakpoints</b>(<i></i>)
2463 <p>
2464 Private method to restore the breakpoints.
2465 </p><a NAME="Editor.__saveLastEditPosition" ID="Editor.__saveLastEditPosition"></a>
2466 <h4>Editor.__saveLastEditPosition</h4>
2467 <b>__saveLastEditPosition</b>(<i></i>)
2468 <p>
2469 Private slot to record the last edit position.
2470 </p><a NAME="Editor.__searchCurrentWord" ID="Editor.__searchCurrentWord"></a>
2471 <h4>Editor.__searchCurrentWord</h4>
2472 <b>__searchCurrentWord</b>(<i>forward=True</i>)
2473 <p>
2474 Private slot to search the next occurrence of the current word.
2475 </p><dl>
2476 <dt><i>forward</i></dt>
2477 <dd>
2478 flag indicating the search direction (boolean)
2479 </dd>
2480 </dl><a NAME="Editor.__selectAll" ID="Editor.__selectAll"></a>
2481 <h4>Editor.__selectAll</h4>
2482 <b>__selectAll</b>(<i></i>)
2483 <p>
2484 Private slot handling the select all context menu action.
2485 </p><a NAME="Editor.__selectPygmentsLexer" ID="Editor.__selectPygmentsLexer"></a>
2486 <h4>Editor.__selectPygmentsLexer</h4>
2487 <b>__selectPygmentsLexer</b>(<i></i>)
2488 <p>
2489 Private method to select a specific pygments lexer.
2490 </p><dl>
2491 <dt>Returns:</dt>
2492 <dd>
2493 name of the selected pygments lexer (string)
2494 </dd>
2495 </dl><a NAME="Editor.__send" ID="Editor.__send"></a>
2496 <h4>Editor.__send</h4>
2497 <b>__send</b>(<i>token, args=None</i>)
2498 <p>
2499 Private method to send an editor command to remote editors.
2500 </p><dl>
2501 <dt><i>token</i></dt>
2502 <dd>
2503 command token (string)
2504 </dd><dt><i>args</i></dt>
2505 <dd>
2506 arguments for the command (string)
2507 </dd>
2508 </dl><a NAME="Editor.__setAnnotation" ID="Editor.__setAnnotation"></a>
2509 <h4>Editor.__setAnnotation</h4>
2510 <b>__setAnnotation</b>(<i>line</i>)
2511 <p>
2512 Private method to set the annotations for the given line.
2513 </p><dl>
2514 <dt><i>line</i></dt>
2515 <dd>
2516 number of the line that needs annotation (integer)
2517 </dd>
2518 </dl><a NAME="Editor.__setAnnotationStyles" ID="Editor.__setAnnotationStyles"></a>
2519 <h4>Editor.__setAnnotationStyles</h4>
2520 <b>__setAnnotationStyles</b>(<i></i>)
2521 <p>
2522 Private slot to define the style used by inline annotations.
2523 </p><a NAME="Editor.__setAutoCompletion" ID="Editor.__setAutoCompletion"></a>
2524 <h4>Editor.__setAutoCompletion</h4>
2525 <b>__setAutoCompletion</b>(<i></i>)
2526 <p>
2527 Private method to configure the autocompletion function.
2528 </p><a NAME="Editor.__setCallTips" ID="Editor.__setCallTips"></a>
2529 <h4>Editor.__setCallTips</h4>
2530 <b>__setCallTips</b>(<i></i>)
2531 <p>
2532 Private method to configure the calltips function.
2533 </p><a NAME="Editor.__setEolMode" ID="Editor.__setEolMode"></a>
2534 <h4>Editor.__setEolMode</h4>
2535 <b>__setEolMode</b>(<i></i>)
2536 <p>
2537 Private method to configure the eol mode of the editor.
2538 </p><a NAME="Editor.__setLineMarkerColours" ID="Editor.__setLineMarkerColours"></a>
2539 <h4>Editor.__setLineMarkerColours</h4>
2540 <b>__setLineMarkerColours</b>(<i></i>)
2541 <p>
2542 Private method to set the line marker colours.
2543 </p><a NAME="Editor.__setMarginsDisplay" ID="Editor.__setMarginsDisplay"></a>
2544 <h4>Editor.__setMarginsDisplay</h4>
2545 <b>__setMarginsDisplay</b>(<i></i>)
2546 <p>
2547 Private method to configure margins 0 and 2.
2548 </p><a NAME="Editor.__setSpelling" ID="Editor.__setSpelling"></a>
2549 <h4>Editor.__setSpelling</h4>
2550 <b>__setSpelling</b>(<i></i>)
2551 <p>
2552 Private method to initialize the spell checking functionality.
2553 </p><a NAME="Editor.__setSpellingLanguage" ID="Editor.__setSpellingLanguage"></a>
2554 <h4>Editor.__setSpellingLanguage</h4>
2555 <b>__setSpellingLanguage</b>(<i>language, pwl="", pel=""</i>)
2556 <p>
2557 Private slot to set the spell checking language.
2558 </p><dl>
2559 <dt><i>language</i></dt>
2560 <dd>
2561 spell checking language to be set (string)
2562 </dd><dt><i>pwl=</i></dt>
2563 <dd>
2564 name of the personal/project word list (string)
2565 </dd><dt><i>pel=</i></dt>
2566 <dd>
2567 name of the personal/project exclude list (string)
2568 </dd>
2569 </dl><a NAME="Editor.__setTabAndIndent" ID="Editor.__setTabAndIndent"></a>
2570 <h4>Editor.__setTabAndIndent</h4>
2571 <b>__setTabAndIndent</b>(<i></i>)
2572 <p>
2573 Private method to set indentation size and style and tab width.
2574 </p><a NAME="Editor.__setTextDisplay" ID="Editor.__setTextDisplay"></a>
2575 <h4>Editor.__setTextDisplay</h4>
2576 <b>__setTextDisplay</b>(<i></i>)
2577 <p>
2578 Private method to configure the text display.
2579 </p><a NAME="Editor.__showApplicationDiagram" ID="Editor.__showApplicationDiagram"></a>
2580 <h4>Editor.__showApplicationDiagram</h4>
2581 <b>__showApplicationDiagram</b>(<i></i>)
2582 <p>
2583 Private method to handle the Imports Diagram context menu action.
2584 </p><a NAME="Editor.__showClassDiagram" ID="Editor.__showClassDiagram"></a>
2585 <h4>Editor.__showClassDiagram</h4>
2586 <b>__showClassDiagram</b>(<i></i>)
2587 <p>
2588 Private method to handle the Class Diagram context menu action.
2589 </p><a NAME="Editor.__showCodeCoverage" ID="Editor.__showCodeCoverage"></a>
2590 <h4>Editor.__showCodeCoverage</h4>
2591 <b>__showCodeCoverage</b>(<i></i>)
2592 <p>
2593 Private method to handle the code coverage context menu action.
2594 </p><a NAME="Editor.__showCodeInfo" ID="Editor.__showCodeInfo"></a>
2595 <h4>Editor.__showCodeInfo</h4>
2596 <b>__showCodeInfo</b>(<i></i>)
2597 <p>
2598 Private slot to handle the context menu action to show code info.
2599 </p><a NAME="Editor.__showCodeMetrics" ID="Editor.__showCodeMetrics"></a>
2600 <h4>Editor.__showCodeMetrics</h4>
2601 <b>__showCodeMetrics</b>(<i></i>)
2602 <p>
2603 Private method to handle the code metrics context menu action.
2604 </p><a NAME="Editor.__showCompletionsList" ID="Editor.__showCompletionsList"></a>
2605 <h4>Editor.__showCompletionsList</h4>
2606 <b>__showCompletionsList</b>(<i>completions</i>)
2607 <p>
2608 Private method to show the completions list.
2609 </p><dl>
2610 <dt><i>completions</i> (list of str or set of str)</dt>
2611 <dd>
2612 completions to be shown
2613 </dd>
2614 </dl><a NAME="Editor.__showContextMenu" ID="Editor.__showContextMenu"></a>
2615 <h4>Editor.__showContextMenu</h4>
2616 <b>__showContextMenu</b>(<i></i>)
2617 <p>
2618 Private slot handling the aboutToShow signal of the context menu.
2619 </p><a NAME="Editor.__showContextMenuAutocompletion" ID="Editor.__showContextMenuAutocompletion"></a>
2620 <h4>Editor.__showContextMenuAutocompletion</h4>
2621 <b>__showContextMenuAutocompletion</b>(<i></i>)
2622 <p>
2623 Private slot called before the autocompletion menu is shown.
2624 </p><a NAME="Editor.__showContextMenuChecks" ID="Editor.__showContextMenuChecks"></a>
2625 <h4>Editor.__showContextMenuChecks</h4>
2626 <b>__showContextMenuChecks</b>(<i></i>)
2627 <p>
2628 Private slot handling the aboutToShow signal of the checks context
2629 menu.
2630 </p><a NAME="Editor.__showContextMenuEncodings" ID="Editor.__showContextMenuEncodings"></a>
2631 <h4>Editor.__showContextMenuEncodings</h4>
2632 <b>__showContextMenuEncodings</b>(<i></i>)
2633 <p>
2634 Private slot handling the aboutToShow signal of the encodings context
2635 menu.
2636 </p><a NAME="Editor.__showContextMenuEol" ID="Editor.__showContextMenuEol"></a>
2637 <h4>Editor.__showContextMenuEol</h4>
2638 <b>__showContextMenuEol</b>(<i></i>)
2639 <p>
2640 Private slot handling the aboutToShow signal of the eol context menu.
2641 </p><a NAME="Editor.__showContextMenuGraphics" ID="Editor.__showContextMenuGraphics"></a>
2642 <h4>Editor.__showContextMenuGraphics</h4>
2643 <b>__showContextMenuGraphics</b>(<i></i>)
2644 <p>
2645 Private slot handling the aboutToShow signal of the diagrams context
2646 menu.
2647 </p><a NAME="Editor.__showContextMenuLanguages" ID="Editor.__showContextMenuLanguages"></a>
2648 <h4>Editor.__showContextMenuLanguages</h4>
2649 <b>__showContextMenuLanguages</b>(<i></i>)
2650 <p>
2651 Private slot handling the aboutToShow signal of the languages context
2652 menu.
2653 </p><a NAME="Editor.__showContextMenuMargin" ID="Editor.__showContextMenuMargin"></a>
2654 <h4>Editor.__showContextMenuMargin</h4>
2655 <b>__showContextMenuMargin</b>(<i>menu</i>)
2656 <p>
2657 Private slot handling the aboutToShow signal of the margins context
2658 menu.
2659 </p><dl>
2660 <dt><i>menu</i> (QMenu)</dt>
2661 <dd>
2662 reference to the menu to be shown
2663 </dd>
2664 </dl><a NAME="Editor.__showContextMenuResources" ID="Editor.__showContextMenuResources"></a>
2665 <h4>Editor.__showContextMenuResources</h4>
2666 <b>__showContextMenuResources</b>(<i></i>)
2667 <p>
2668 Private slot handling the aboutToShow signal of the resources context
2669 menu.
2670 </p><a NAME="Editor.__showContextMenuShow" ID="Editor.__showContextMenuShow"></a>
2671 <h4>Editor.__showContextMenuShow</h4>
2672 <b>__showContextMenuShow</b>(<i></i>)
2673 <p>
2674 Private slot called before the show menu is shown.
2675 </p><a NAME="Editor.__showContextMenuSpelling" ID="Editor.__showContextMenuSpelling"></a>
2676 <h4>Editor.__showContextMenuSpelling</h4>
2677 <b>__showContextMenuSpelling</b>(<i></i>)
2678 <p>
2679 Private slot to set up the spelling menu before it is shown.
2680 </p><a NAME="Editor.__showContextMenuTools" ID="Editor.__showContextMenuTools"></a>
2681 <h4>Editor.__showContextMenuTools</h4>
2682 <b>__showContextMenuTools</b>(<i></i>)
2683 <p>
2684 Private slot handling the aboutToShow signal of the tools context
2685 menu.
2686 </p><a NAME="Editor.__showImportsDiagram" ID="Editor.__showImportsDiagram"></a>
2687 <h4>Editor.__showImportsDiagram</h4>
2688 <b>__showImportsDiagram</b>(<i></i>)
2689 <p>
2690 Private method to handle the Imports Diagram context menu action.
2691 </p><a NAME="Editor.__showPackageDiagram" ID="Editor.__showPackageDiagram"></a>
2692 <h4>Editor.__showPackageDiagram</h4>
2693 <b>__showPackageDiagram</b>(<i></i>)
2694 <p>
2695 Private method to handle the Package Diagram context menu action.
2696 </p><a NAME="Editor.__showProfileData" ID="Editor.__showProfileData"></a>
2697 <h4>Editor.__showProfileData</h4>
2698 <b>__showProfileData</b>(<i></i>)
2699 <p>
2700 Private method to handle the show profile data context menu action.
2701 </p><a NAME="Editor.__showSyntaxError" ID="Editor.__showSyntaxError"></a>
2702 <h4>Editor.__showSyntaxError</h4>
2703 <b>__showSyntaxError</b>(<i>line=-1</i>)
2704 <p>
2705 Private slot to handle the 'Show syntax error message'
2706 context menu action.
2707 </p><dl>
2708 <dt><i>line</i></dt>
2709 <dd>
2710 line number to show the syntax error for (integer)
2711 </dd>
2712 </dl><a NAME="Editor.__showWarning" ID="Editor.__showWarning"></a>
2713 <h4>Editor.__showWarning</h4>
2714 <b>__showWarning</b>(<i>line=-1</i>)
2715 <p>
2716 Private slot to handle the 'Show warning' context menu action.
2717 </p><dl>
2718 <dt><i>line</i></dt>
2719 <dd>
2720 line number to show the warning for (integer)
2721 </dd>
2722 </dl><a NAME="Editor.__spellCharAdded" ID="Editor.__spellCharAdded"></a>
2723 <h4>Editor.__spellCharAdded</h4>
2724 <b>__spellCharAdded</b>(<i>charNumber</i>)
2725 <p>
2726 Private slot called to handle the user entering a character.
2727 </p><dl>
2728 <dt><i>charNumber</i></dt>
2729 <dd>
2730 value of the character entered (integer)
2731 </dd>
2732 </dl><a NAME="Editor.__styleNeeded" ID="Editor.__styleNeeded"></a>
2733 <h4>Editor.__styleNeeded</h4>
2734 <b>__styleNeeded</b>(<i>position</i>)
2735 <p>
2736 Private slot to handle the need for more styling.
2737 </p><dl>
2738 <dt><i>position</i></dt>
2739 <dd>
2740 end position, that needs styling (integer)
2741 </dd>
2742 </dl><a NAME="Editor.__textChanged" ID="Editor.__textChanged"></a>
2743 <h4>Editor.__textChanged</h4>
2744 <b>__textChanged</b>(<i></i>)
2745 <p>
2746 Private slot to handle a change of the editor text.
2747 </p><p>
2748 This slot defers the handling to the next time the event loop
2749 is run in order to ensure, that cursor position has been updated
2750 by the underlying Scintilla editor.
2751 </p><a NAME="Editor.__toggleAutoCompletionEnable" ID="Editor.__toggleAutoCompletionEnable"></a>
2752 <h4>Editor.__toggleAutoCompletionEnable</h4>
2753 <b>__toggleAutoCompletionEnable</b>(<i></i>)
2754 <p>
2755 Private slot to handle the Enable Autocompletion context menu entry.
2756 </p><a NAME="Editor.__toggleBreakpoint" ID="Editor.__toggleBreakpoint"></a>
2757 <h4>Editor.__toggleBreakpoint</h4>
2758 <b>__toggleBreakpoint</b>(<i>line, temporary=False</i>)
2759 <p>
2760 Private method to toggle a breakpoint.
2761 </p><dl>
2762 <dt><i>line</i></dt>
2763 <dd>
2764 line number of the breakpoint (integer)
2765 </dd><dt><i>temporary</i></dt>
2766 <dd>
2767 flag indicating a temporary breakpoint (boolean)
2768 </dd>
2769 </dl><a NAME="Editor.__toggleBreakpointEnabled" ID="Editor.__toggleBreakpointEnabled"></a>
2770 <h4>Editor.__toggleBreakpointEnabled</h4>
2771 <b>__toggleBreakpointEnabled</b>(<i>line</i>)
2772 <p>
2773 Private method to toggle a breakpoints enabled status.
2774 </p><dl>
2775 <dt><i>line</i></dt>
2776 <dd>
2777 line number of the breakpoint (integer)
2778 </dd>
2779 </dl><a NAME="Editor.__toggleTypingAids" ID="Editor.__toggleTypingAids"></a>
2780 <h4>Editor.__toggleTypingAids</h4>
2781 <b>__toggleTypingAids</b>(<i></i>)
2782 <p>
2783 Private slot to toggle the typing aids.
2784 </p><a NAME="Editor.__updateReadOnly" ID="Editor.__updateReadOnly"></a>
2785 <h4>Editor.__updateReadOnly</h4>
2786 <b>__updateReadOnly</b>(<i>bForce=True</i>)
2787 <p>
2788 Private method to update the readOnly information for this editor.
2789 </p><p>
2790 If bForce is True, then updates everything regardless if
2791 the attributes have actually changed, such as during
2792 initialization time. A signal is emitted after the
2793 caption change.
2794 </p><dl>
2795 <dt><i>bForce</i></dt>
2796 <dd>
2797 True to force change, False to only update and emit
2798 signal if there was an attribute change.
2799 </dd>
2800 </dl><a NAME="Editor.addCallTipHook" ID="Editor.addCallTipHook"></a>
2801 <h4>Editor.addCallTipHook</h4>
2802 <b>addCallTipHook</b>(<i>key, func</i>)
2803 <p>
2804 Public method to set a calltip provider.
2805 </p><dl>
2806 <dt><i>key</i> (str)</dt>
2807 <dd>
2808 name of the provider
2809 </dd><dt><i>func</i> (function(editor, int, int) -> list of str)</dt>
2810 <dd>
2811 function providing calltips. func
2812 should be a function taking a reference to the editor,
2813 a position into the text and the amount of commas to the
2814 left of the cursor. It should return the possible
2815 calltips as a list of strings.
2816 </dd>
2817 </dl><a NAME="Editor.addClone" ID="Editor.addClone"></a>
2818 <h4>Editor.addClone</h4>
2819 <b>addClone</b>(<i>editor</i>)
2820 <p>
2821 Public method to add a clone to our list.
2822 </p><dl>
2823 <dt><i>editor</i> (Editor)</dt>
2824 <dd>
2825 reference to the cloned editor
2826 </dd>
2827 </dl><a NAME="Editor.addCompletionListHook" ID="Editor.addCompletionListHook"></a>
2828 <h4>Editor.addCompletionListHook</h4>
2829 <b>addCompletionListHook</b>(<i>key, func, asynchroneous=False</i>)
2830 <p>
2831 Public method to set an auto-completion list provider.
2832 </p><dl>
2833 <dt><i>key</i> (str)</dt>
2834 <dd>
2835 name of the provider
2836 </dd><dt><i>func</i> (function(editor, bool) -> list of str in case async is False)</dt>
2837 <dd>
2838 function providing completion list. func
2839 should be a function taking a reference to the editor and
2840 a boolean indicating to complete a context. It should return
2841 the possible completions as a list of strings.
2842 and function(editor, bool, str) returning nothing in case async
2843 is True
2844 </dd><dt><i>asynchroneous</i> (bool)</dt>
2845 <dd>
2846 flag indicating an asynchroneous function
2847 </dd>
2848 </dl><a NAME="Editor.addedToProject" ID="Editor.addedToProject"></a>
2849 <h4>Editor.addedToProject</h4>
2850 <b>addedToProject</b>(<i></i>)
2851 <p>
2852 Public method to signal, that this editor has been added to a project.
2853 </p><a NAME="Editor.autoComplete" ID="Editor.autoComplete"></a>
2854 <h4>Editor.autoComplete</h4>
2855 <b>autoComplete</b>(<i>auto=False, context=True</i>)
2856 <p>
2857 Public method to start auto-completion.
2858 </p><dl>
2859 <dt><i>auto=</i></dt>
2860 <dd>
2861 flag indicating a call from the __charAdded method
2862 (boolean)
2863 </dd><dt><i>context=</i></dt>
2864 <dd>
2865 flag indicating to complete a context (boolean)
2866 </dd>
2867 </dl><a NAME="Editor.autoCompleteQScintilla" ID="Editor.autoCompleteQScintilla"></a>
2868 <h4>Editor.autoCompleteQScintilla</h4>
2869 <b>autoCompleteQScintilla</b>(<i></i>)
2870 <p>
2871 Public method to perform an autocompletion using QScintilla methods.
2872 </p><a NAME="Editor.boxCommentLine" ID="Editor.boxCommentLine"></a>
2873 <h4>Editor.boxCommentLine</h4>
2874 <b>boxCommentLine</b>(<i></i>)
2875 <p>
2876 Public slot to box comment the current line.
2877 </p><a NAME="Editor.boxCommentLineOrSelection" ID="Editor.boxCommentLineOrSelection"></a>
2878 <h4>Editor.boxCommentLineOrSelection</h4>
2879 <b>boxCommentLineOrSelection</b>(<i></i>)
2880 <p>
2881 Public slot to box comment the current line or current selection.
2882 </p><a NAME="Editor.boxCommentSelection" ID="Editor.boxCommentSelection"></a>
2883 <h4>Editor.boxCommentSelection</h4>
2884 <b>boxCommentSelection</b>(<i></i>)
2885 <p>
2886 Public slot to box comment the current selection.
2887 </p><a NAME="Editor.callTip" ID="Editor.callTip"></a>
2888 <h4>Editor.callTip</h4>
2889 <b>callTip</b>(<i></i>)
2890 <p>
2891 Public method to show calltips.
2892 </p><a NAME="Editor.canAutoCompleteFromAPIs" ID="Editor.canAutoCompleteFromAPIs"></a>
2893 <h4>Editor.canAutoCompleteFromAPIs</h4>
2894 <b>canAutoCompleteFromAPIs</b>(<i></i>)
2895 <p>
2896 Public method to check for API availablity.
2897 </p><dl>
2898 <dt>Returns:</dt>
2899 <dd>
2900 flag indicating autocompletion from APIs is available (boolean)
2901 </dd>
2902 </dl><a NAME="Editor.canProvideCallTipps" ID="Editor.canProvideCallTipps"></a>
2903 <h4>Editor.canProvideCallTipps</h4>
2904 <b>canProvideCallTipps</b>(<i></i>)
2905 <p>
2906 Public method to test the calltips availability.
2907 </p><dl>
2908 <dt>Returns:</dt>
2909 <dd>
2910 flag indicating the availability of calltips (boolean)
2911 </dd>
2912 </dl><a NAME="Editor.canProvideDynamicAutoCompletion" ID="Editor.canProvideDynamicAutoCompletion"></a>
2913 <h4>Editor.canProvideDynamicAutoCompletion</h4>
2914 <b>canProvideDynamicAutoCompletion</b>(<i></i>)
2915 <p>
2916 Public method to test the dynamic auto-completion availability.
2917 </p><dl>
2918 <dt>Returns:</dt>
2919 <dd>
2920 flag indicating the availability of dynamic auto-completion
2921 (boolean)
2922 </dd>
2923 </dl><a NAME="Editor.cancelSharedEdit" ID="Editor.cancelSharedEdit"></a>
2924 <h4>Editor.cancelSharedEdit</h4>
2925 <b>cancelSharedEdit</b>(<i>send=True</i>)
2926 <p>
2927 Public slot to cancel a shared edit session for the editor.
2928 </p><dl>
2929 <dt><i>send=</i></dt>
2930 <dd>
2931 flag indicating to send the CancelEdit command (boolean)
2932 </dd>
2933 </dl><a NAME="Editor.changeEvent" ID="Editor.changeEvent"></a>
2934 <h4>Editor.changeEvent</h4>
2935 <b>changeEvent</b>(<i>evt</i>)
2936 <p>
2937 Protected method called to process an event.
2938 </p><p>
2939 This implements special handling for the events showMaximized,
2940 showMinimized and showNormal. The windows caption is shortened
2941 for the minimized mode and reset to the full filename for the
2942 other modes. This is to make the editor windows work nicer
2943 with the QWorkspace.
2944 </p><dl>
2945 <dt><i>evt</i></dt>
2946 <dd>
2947 the event, that was generated (QEvent)
2948 </dd>
2949 </dl><a NAME="Editor.checkDirty" ID="Editor.checkDirty"></a>
2950 <h4>Editor.checkDirty</h4>
2951 <b>checkDirty</b>(<i></i>)
2952 <p>
2953 Public method to check dirty status and open a message window.
2954 </p><dl>
2955 <dt>Returns:</dt>
2956 <dd>
2957 flag indicating successful reset of the dirty flag (boolean)
2958 </dd>
2959 </dl><a NAME="Editor.checkSpelling" ID="Editor.checkSpelling"></a>
2960 <h4>Editor.checkSpelling</h4>
2961 <b>checkSpelling</b>(<i></i>)
2962 <p>
2963 Public slot to perform an interactive spell check of the document.
2964 </p><a NAME="Editor.checkSyntax" ID="Editor.checkSyntax"></a>
2965 <h4>Editor.checkSyntax</h4>
2966 <b>checkSyntax</b>(<i></i>)
2967 <p>
2968 Public method to perform an automatic syntax check of the file.
2969 </p><a NAME="Editor.clearAllHighlights" ID="Editor.clearAllHighlights"></a>
2970 <h4>Editor.clearAllHighlights</h4>
2971 <b>clearAllHighlights</b>(<i></i>)
2972 <p>
2973 Public method to clear all highlights.
2974 </p><a NAME="Editor.clearBookmarks" ID="Editor.clearBookmarks"></a>
2975 <h4>Editor.clearBookmarks</h4>
2976 <b>clearBookmarks</b>(<i></i>)
2977 <p>
2978 Public slot to handle the 'Clear all bookmarks' context menu action.
2979 </p><a NAME="Editor.clearBreakpoint" ID="Editor.clearBreakpoint"></a>
2980 <h4>Editor.clearBreakpoint</h4>
2981 <b>clearBreakpoint</b>(<i>line</i>)
2982 <p>
2983 Public method to clear a breakpoint.
2984 </p><p>
2985 Note: This doesn't clear the breakpoint in the debugger,
2986 it just deletes it from the editor internal list of breakpoints.
2987 </p><dl>
2988 <dt><i>line</i></dt>
2989 <dd>
2990 line number of the breakpoint (integer)
2991 </dd>
2992 </dl><a NAME="Editor.clearFlakesWarnings" ID="Editor.clearFlakesWarnings"></a>
2993 <h4>Editor.clearFlakesWarnings</h4>
2994 <b>clearFlakesWarnings</b>(<i></i>)
2995 <p>
2996 Public slot to clear all pyflakes warnings.
2997 </p><a NAME="Editor.clearHighlight" ID="Editor.clearHighlight"></a>
2998 <h4>Editor.clearHighlight</h4>
2999 <b>clearHighlight</b>(<i>startLine, startIndex, endLine, endIndex</i>)
3000 <p>
3001 Public method to clear a text highlight.
3002 </p><dl>
3003 <dt><i>startLine</i> (int)</dt>
3004 <dd>
3005 line of the highlight start
3006 </dd><dt><i>startIndex</i> (int)</dt>
3007 <dd>
3008 index of the highlight start
3009 </dd><dt><i>endLine</i> (int)</dt>
3010 <dd>
3011 line of the highlight end
3012 </dd><dt><i>endIndex</i> (int)</dt>
3013 <dd>
3014 index of the highlight end
3015 </dd>
3016 </dl><a NAME="Editor.clearSearchIndicators" ID="Editor.clearSearchIndicators"></a>
3017 <h4>Editor.clearSearchIndicators</h4>
3018 <b>clearSearchIndicators</b>(<i></i>)
3019 <p>
3020 Public method to clear all search indicators.
3021 </p><a NAME="Editor.clearStyleWarnings" ID="Editor.clearStyleWarnings"></a>
3022 <h4>Editor.clearStyleWarnings</h4>
3023 <b>clearStyleWarnings</b>(<i></i>)
3024 <p>
3025 Public slot to clear all style warnings.
3026 </p><a NAME="Editor.clearStyles" ID="Editor.clearStyles"></a>
3027 <h4>Editor.clearStyles</h4>
3028 <b>clearStyles</b>(<i></i>)
3029 <p>
3030 Public method to set the styles according the selected Qt style
3031 or the selected editor colours.
3032 </p><a NAME="Editor.clearSyntaxError" ID="Editor.clearSyntaxError"></a>
3033 <h4>Editor.clearSyntaxError</h4>
3034 <b>clearSyntaxError</b>(<i></i>)
3035 <p>
3036 Public slot to handle the 'Clear all syntax error' context menu action.
3037 </p><a NAME="Editor.clearWarnings" ID="Editor.clearWarnings"></a>
3038 <h4>Editor.clearWarnings</h4>
3039 <b>clearWarnings</b>(<i></i>)
3040 <p>
3041 Public slot to clear all warnings.
3042 </p><a NAME="Editor.close" ID="Editor.close"></a>
3043 <h4>Editor.close</h4>
3044 <b>close</b>(<i>alsoDelete=False</i>)
3045 <p>
3046 Public method called when the window gets closed.
3047 </p><p>
3048 This overwritten method redirects the action to our
3049 ViewManager.closeEditor, which in turn calls our closeIt
3050 method.
3051 </p><dl>
3052 <dt><i>alsoDelete</i></dt>
3053 <dd>
3054 ignored
3055 </dd>
3056 </dl><dl>
3057 <dt>Returns:</dt>
3058 <dd>
3059 flag indicating a successful close of the editor (boolean)
3060 </dd>
3061 </dl><a NAME="Editor.closeIt" ID="Editor.closeIt"></a>
3062 <h4>Editor.closeIt</h4>
3063 <b>closeIt</b>(<i></i>)
3064 <p>
3065 Public method called by the viewmanager to finally get rid of us.
3066 </p><a NAME="Editor.codeCoverageShowAnnotations" ID="Editor.codeCoverageShowAnnotations"></a>
3067 <h4>Editor.codeCoverageShowAnnotations</h4>
3068 <b>codeCoverageShowAnnotations</b>(<i>silent=False</i>)
3069 <p>
3070 Public method to handle the show code coverage annotations context
3071 menu action.
3072 </p><dl>
3073 <dt><i>silent</i></dt>
3074 <dd>
3075 flag indicating to not show any dialog (boolean)
3076 </dd>
3077 </dl><a NAME="Editor.collapseFoldWithChildren" ID="Editor.collapseFoldWithChildren"></a>
3078 <h4>Editor.collapseFoldWithChildren</h4>
3079 <b>collapseFoldWithChildren</b>(<i>line=-1</i>)
3080 <p>
3081 Public slot to collapse the current fold including its children.
3082 </p><dl>
3083 <dt><i>line</i> (int)</dt>
3084 <dd>
3085 number of line to be expanded
3086 </dd>
3087 </dl><a NAME="Editor.commentLine" ID="Editor.commentLine"></a>
3088 <h4>Editor.commentLine</h4>
3089 <b>commentLine</b>(<i></i>)
3090 <p>
3091 Public slot to comment the current line.
3092 </p><a NAME="Editor.commentLineOrSelection" ID="Editor.commentLineOrSelection"></a>
3093 <h4>Editor.commentLineOrSelection</h4>
3094 <b>commentLineOrSelection</b>(<i></i>)
3095 <p>
3096 Public slot to comment the current line or current selection.
3097 </p><a NAME="Editor.commentSelection" ID="Editor.commentSelection"></a>
3098 <h4>Editor.commentSelection</h4>
3099 <b>commentSelection</b>(<i></i>)
3100 <p>
3101 Public slot to comment the current selection.
3102 </p><a NAME="Editor.completionsListReady" ID="Editor.completionsListReady"></a>
3103 <h4>Editor.completionsListReady</h4>
3104 <b>completionsListReady</b>(<i>completions, acText</i>)
3105 <p>
3106 Public method to show the completions determined by a completions
3107 provider.
3108 </p><dl>
3109 <dt><i>completions</i> (list of str or set of str)</dt>
3110 <dd>
3111 list of possible completions
3112 </dd><dt><i>acText</i> (str)</dt>
3113 <dd>
3114 text to be completed
3115 </dd>
3116 </dl><a NAME="Editor.contextMenuEvent" ID="Editor.contextMenuEvent"></a>
3117 <h4>Editor.contextMenuEvent</h4>
3118 <b>contextMenuEvent</b>(<i>evt</i>)
3119 <p>
3120 Protected method implementing the context menu event.
3121 </p><dl>
3122 <dt><i>evt</i></dt>
3123 <dd>
3124 the context menu event (QContextMenuEvent)
3125 </dd>
3126 </dl><a NAME="Editor.curLineHasBreakpoint" ID="Editor.curLineHasBreakpoint"></a>
3127 <h4>Editor.curLineHasBreakpoint</h4>
3128 <b>curLineHasBreakpoint</b>(<i></i>)
3129 <p>
3130 Public method to check for the presence of a breakpoint at the current
3131 line.
3132 </p><dl>
3133 <dt>Returns:</dt>
3134 <dd>
3135 flag indicating the presence of a breakpoint (boolean)
3136 </dd>
3137 </dl><a NAME="Editor.determineFileType" ID="Editor.determineFileType"></a>
3138 <h4>Editor.determineFileType</h4>
3139 <b>determineFileType</b>(<i></i>)
3140 <p>
3141 Public method to determine the file type using various tests.
3142 </p><dl>
3143 <dt>Returns:</dt>
3144 <dd>
3145 type of the displayed file or an empty string (string)
3146 </dd>
3147 </dl><a NAME="Editor.dragEnterEvent" ID="Editor.dragEnterEvent"></a>
3148 <h4>Editor.dragEnterEvent</h4>
3149 <b>dragEnterEvent</b>(<i>event</i>)
3150 <p>
3151 Protected method to handle the drag enter event.
3152 </p><dl>
3153 <dt><i>event</i></dt>
3154 <dd>
3155 the drag enter event (QDragEnterEvent)
3156 </dd>
3157 </dl><a NAME="Editor.dragLeaveEvent" ID="Editor.dragLeaveEvent"></a>
3158 <h4>Editor.dragLeaveEvent</h4>
3159 <b>dragLeaveEvent</b>(<i>event</i>)
3160 <p>
3161 Protected method to handle the drag leave event.
3162 </p><dl>
3163 <dt><i>event</i></dt>
3164 <dd>
3165 the drag leave event (QDragLeaveEvent)
3166 </dd>
3167 </dl><a NAME="Editor.dragMoveEvent" ID="Editor.dragMoveEvent"></a>
3168 <h4>Editor.dragMoveEvent</h4>
3169 <b>dragMoveEvent</b>(<i>event</i>)
3170 <p>
3171 Protected method to handle the drag move event.
3172 </p><dl>
3173 <dt><i>event</i></dt>
3174 <dd>
3175 the drag move event (QDragMoveEvent)
3176 </dd>
3177 </dl><a NAME="Editor.dropEvent" ID="Editor.dropEvent"></a>
3178 <h4>Editor.dropEvent</h4>
3179 <b>dropEvent</b>(<i>event</i>)
3180 <p>
3181 Protected method to handle the drop event.
3182 </p><dl>
3183 <dt><i>event</i></dt>
3184 <dd>
3185 the drop event (QDropEvent)
3186 </dd>
3187 </dl><a NAME="Editor.editorCommand" ID="Editor.editorCommand"></a>
3188 <h4>Editor.editorCommand</h4>
3189 <b>editorCommand</b>(<i>cmd</i>)
3190 <p>
3191 Public method to perform a simple editor command.
3192 </p><dl>
3193 <dt><i>cmd</i></dt>
3194 <dd>
3195 the scintilla command to be performed
3196 </dd>
3197 </dl><a NAME="Editor.ensureVisible" ID="Editor.ensureVisible"></a>
3198 <h4>Editor.ensureVisible</h4>
3199 <b>ensureVisible</b>(<i>line, expand=False</i>)
3200 <p>
3201 Public slot to ensure, that the specified line is visible.
3202 </p><dl>
3203 <dt><i>line</i> (int)</dt>
3204 <dd>
3205 line number to make visible
3206 </dd><dt><i>expand=</i> (bool)</dt>
3207 <dd>
3208 flag indicating to expand all folds
3209 </dd>
3210 </dl><a NAME="Editor.ensureVisibleTop" ID="Editor.ensureVisibleTop"></a>
3211 <h4>Editor.ensureVisibleTop</h4>
3212 <b>ensureVisibleTop</b>(<i>line, expand=False</i>)
3213 <p>
3214 Public slot to ensure, that the specified line is visible at the top
3215 of the editor.
3216 </p><dl>
3217 <dt><i>line</i> (int)</dt>
3218 <dd>
3219 line number to make visible
3220 </dd><dt><i>expand=</i> (bool)</dt>
3221 <dd>
3222 flag indicating to expand all folds
3223 </dd>
3224 </dl><a NAME="Editor.event" ID="Editor.event"></a>
3225 <h4>Editor.event</h4>
3226 <b>event</b>(<i>evt</i>)
3227 <p>
3228 Public method handling events.
3229 </p><dl>
3230 <dt><i>evt</i></dt>
3231 <dd>
3232 reference to the event (QEvent)
3233 </dd>
3234 </dl><dl>
3235 <dt>Returns:</dt>
3236 <dd>
3237 flag indicating, if the event was handled (boolean)
3238 </dd>
3239 </dl><a NAME="Editor.expandFoldWithChildren" ID="Editor.expandFoldWithChildren"></a>
3240 <h4>Editor.expandFoldWithChildren</h4>
3241 <b>expandFoldWithChildren</b>(<i>line=-1</i>)
3242 <p>
3243 Public slot to expand the current fold including its children.
3244 </p><dl>
3245 <dt><i>line</i> (int)</dt>
3246 <dd>
3247 number of line to be expanded
3248 </dd>
3249 </dl><a NAME="Editor.exportFile" ID="Editor.exportFile"></a>
3250 <h4>Editor.exportFile</h4>
3251 <b>exportFile</b>(<i>exporterFormat</i>)
3252 <p>
3253 Public method to export the file.
3254 </p><dl>
3255 <dt><i>exporterFormat</i></dt>
3256 <dd>
3257 format the file should be exported into (string)
3258 </dd>
3259 </dl><a NAME="Editor.extractTasks" ID="Editor.extractTasks"></a>
3260 <h4>Editor.extractTasks</h4>
3261 <b>extractTasks</b>(<i></i>)
3262 <p>
3263 Public slot to extract all tasks.
3264 </p><a NAME="Editor.fileRenamed" ID="Editor.fileRenamed"></a>
3265 <h4>Editor.fileRenamed</h4>
3266 <b>fileRenamed</b>(<i>fn</i>)
3267 <p>
3268 Public slot to handle the editorRenamed signal.
3269 </p><dl>
3270 <dt><i>fn</i></dt>
3271 <dd>
3272 filename to be set for the editor (string).
3273 </dd>
3274 </dl><a NAME="Editor.focusInEvent" ID="Editor.focusInEvent"></a>
3275 <h4>Editor.focusInEvent</h4>
3276 <b>focusInEvent</b>(<i>event</i>)
3277 <p>
3278 Protected method called when the editor receives focus.
3279 </p><p>
3280 This method checks for modifications of the current file and
3281 rereads it upon request. The cursor is placed at the current position
3282 assuming, that it is in the vicinity of the old position after the
3283 reread.
3284 </p><dl>
3285 <dt><i>event</i></dt>
3286 <dd>
3287 the event object (QFocusEvent)
3288 </dd>
3289 </dl><a NAME="Editor.focusOutEvent" ID="Editor.focusOutEvent"></a>
3290 <h4>Editor.focusOutEvent</h4>
3291 <b>focusOutEvent</b>(<i>event</i>)
3292 <p>
3293 Protected method called when the editor loses focus.
3294 </p><dl>
3295 <dt><i>event</i></dt>
3296 <dd>
3297 the event object (QFocusEvent)
3298 </dd>
3299 </dl><a NAME="Editor.gestureEvent" ID="Editor.gestureEvent"></a>
3300 <h4>Editor.gestureEvent</h4>
3301 <b>gestureEvent</b>(<i>evt</i>)
3302 <p>
3303 Protected method handling gesture events.
3304 </p><dl>
3305 <dt><i>evt</i></dt>
3306 <dd>
3307 reference to the gesture event (QGestureEvent
3308 </dd>
3309 </dl><a NAME="Editor.getApiLanguage" ID="Editor.getApiLanguage"></a>
3310 <h4>Editor.getApiLanguage</h4>
3311 <b>getApiLanguage</b>(<i></i>)
3312 <p>
3313 Public method to get the API language of the editor.
3314 </p><dl>
3315 <dt>Returns:</dt>
3316 <dd>
3317 API language
3318 </dd>
3319 </dl><dl>
3320 <dt>Return Type:</dt>
3321 <dd>
3322 str
3323 </dd>
3324 </dl><a NAME="Editor.getBookmarkLines" ID="Editor.getBookmarkLines"></a>
3325 <h4>Editor.getBookmarkLines</h4>
3326 <b>getBookmarkLines</b>(<i></i>)
3327 <p>
3328 Public method to get the lines containing a bookmark.
3329 </p><dl>
3330 <dt>Returns:</dt>
3331 <dd>
3332 list of lines containing a bookmark (list of integer)
3333 </dd>
3334 </dl><a NAME="Editor.getBookmarks" ID="Editor.getBookmarks"></a>
3335 <h4>Editor.getBookmarks</h4>
3336 <b>getBookmarks</b>(<i></i>)
3337 <p>
3338 Public method to retrieve the bookmarks.
3339 </p><dl>
3340 <dt>Returns:</dt>
3341 <dd>
3342 sorted list of all lines containing a bookmark
3343 (list of integer)
3344 </dd>
3345 </dl><a NAME="Editor.getBreakpointLines" ID="Editor.getBreakpointLines"></a>
3346 <h4>Editor.getBreakpointLines</h4>
3347 <b>getBreakpointLines</b>(<i></i>)
3348 <p>
3349 Public method to get the lines containing a breakpoint.
3350 </p><dl>
3351 <dt>Returns:</dt>
3352 <dd>
3353 list of lines containing a breakpoint (list of integer)
3354 </dd>
3355 </dl><a NAME="Editor.getCallTipHook" ID="Editor.getCallTipHook"></a>
3356 <h4>Editor.getCallTipHook</h4>
3357 <b>getCallTipHook</b>(<i>key</i>)
3358 <p>
3359 Public method to get the registered calltip provider.
3360 </p><dl>
3361 <dt><i>key</i> (str)</dt>
3362 <dd>
3363 name of the provider
3364 </dd>
3365 </dl><dl>
3366 <dt>Returns:</dt>
3367 <dd>
3368 function providing calltips
3369 </dd>
3370 </dl><dl>
3371 <dt>Return Type:</dt>
3372 <dd>
3373 function or None
3374 </dd>
3375 </dl><a NAME="Editor.getChangeLines" ID="Editor.getChangeLines"></a>
3376 <h4>Editor.getChangeLines</h4>
3377 <b>getChangeLines</b>(<i></i>)
3378 <p>
3379 Public method to get the lines containing a change.
3380 </p><dl>
3381 <dt>Returns:</dt>
3382 <dd>
3383 list of lines containing a change (list of integer)
3384 </dd>
3385 </dl><a NAME="Editor.getCompleter" ID="Editor.getCompleter"></a>
3386 <h4>Editor.getCompleter</h4>
3387 <b>getCompleter</b>(<i></i>)
3388 <p>
3389 Public method to retrieve a reference to the completer object.
3390 </p><dl>
3391 <dt>Returns:</dt>
3392 <dd>
3393 the completer object (CompleterBase)
3394 </dd>
3395 </dl><a NAME="Editor.getCompletionListHook" ID="Editor.getCompletionListHook"></a>
3396 <h4>Editor.getCompletionListHook</h4>
3397 <b>getCompletionListHook</b>(<i>key</i>)
3398 <p>
3399 Public method to get the registered completion list provider.
3400 </p><dl>
3401 <dt><i>key</i> (str)</dt>
3402 <dd>
3403 name of the provider
3404 </dd>
3405 </dl><dl>
3406 <dt>Returns:</dt>
3407 <dd>
3408 function providing completion list
3409 </dd>
3410 </dl><dl>
3411 <dt>Return Type:</dt>
3412 <dd>
3413 function or None
3414 </dd>
3415 </dl><a NAME="Editor.getCoverageLines" ID="Editor.getCoverageLines"></a>
3416 <h4>Editor.getCoverageLines</h4>
3417 <b>getCoverageLines</b>(<i></i>)
3418 <p>
3419 Public method to get the lines containing a coverage marker.
3420 </p><dl>
3421 <dt>Returns:</dt>
3422 <dd>
3423 list of lines containing a coverage marker (list of integer)
3424 </dd>
3425 </dl><a NAME="Editor.getCurrentWord" ID="Editor.getCurrentWord"></a>
3426 <h4>Editor.getCurrentWord</h4>
3427 <b>getCurrentWord</b>(<i></i>)
3428 <p>
3429 Public method to get the word at the current position.
3430 </p><dl>
3431 <dt>Returns:</dt>
3432 <dd>
3433 the word at that current position (string)
3434 </dd>
3435 </dl><a NAME="Editor.getCurrentWordBoundaries" ID="Editor.getCurrentWordBoundaries"></a>
3436 <h4>Editor.getCurrentWordBoundaries</h4>
3437 <b>getCurrentWordBoundaries</b>(<i></i>)
3438 <p>
3439 Public method to get the word boundaries at the current position.
3440 </p><dl>
3441 <dt>Returns:</dt>
3442 <dd>
3443 tuple with start and end indexes of the current word
3444 (integer, integer)
3445 </dd>
3446 </dl><a NAME="Editor.getEditorConfig" ID="Editor.getEditorConfig"></a>
3447 <h4>Editor.getEditorConfig</h4>
3448 <b>getEditorConfig</b>(<i>option</i>)
3449 <p>
3450 Public method to get the requested option via EditorConfig.
3451 </p><dl>
3452 <dt><i>option</i> (str)</dt>
3453 <dd>
3454 Preferences option key
3455 </dd>
3456 </dl><dl>
3457 <dt>Returns:</dt>
3458 <dd>
3459 value of requested setting
3460 </dd>
3461 </dl><dl>
3462 <dt>Return Type:</dt>
3463 <dd>
3464 any
3465 </dd>
3466 </dl><a NAME="Editor.getEncoding" ID="Editor.getEncoding"></a>
3467 <h4>Editor.getEncoding</h4>
3468 <b>getEncoding</b>(<i></i>)
3469 <p>
3470 Public method to return the current encoding.
3471 </p><dl>
3472 <dt>Returns:</dt>
3473 <dd>
3474 current encoding (string)
3475 </dd>
3476 </dl><a NAME="Editor.getFileName" ID="Editor.getFileName"></a>
3477 <h4>Editor.getFileName</h4>
3478 <b>getFileName</b>(<i></i>)
3479 <p>
3480 Public method to return the name of the file being displayed.
3481 </p><dl>
3482 <dt>Returns:</dt>
3483 <dd>
3484 filename of the displayed file (string)
3485 </dd>
3486 </dl><a NAME="Editor.getFileType" ID="Editor.getFileType"></a>
3487 <h4>Editor.getFileType</h4>
3488 <b>getFileType</b>(<i></i>)
3489 <p>
3490 Public method to return the type of the file being displayed.
3491 </p><dl>
3492 <dt>Returns:</dt>
3493 <dd>
3494 type of the displayed file (string)
3495 </dd>
3496 </dl><a NAME="Editor.getFileTypeByFlag" ID="Editor.getFileTypeByFlag"></a>
3497 <h4>Editor.getFileTypeByFlag</h4>
3498 <b>getFileTypeByFlag</b>(<i></i>)
3499 <p>
3500 Public method to return the type of the file, if it was set by an
3501 eflag: marker.
3502 </p><dl>
3503 <dt>Returns:</dt>
3504 <dd>
3505 type of the displayed file, if set by an eflag: marker or an
3506 empty string (string)
3507 </dd>
3508 </dl><a NAME="Editor.getHighlightPosition" ID="Editor.getHighlightPosition"></a>
3509 <h4>Editor.getHighlightPosition</h4>
3510 <b>getHighlightPosition</b>(<i></i>)
3511 <p>
3512 Public method to return the position of the highlight bar.
3513 </p><dl>
3514 <dt>Returns:</dt>
3515 <dd>
3516 line number of the highlight bar (integer)
3517 </dd>
3518 </dl><a NAME="Editor.getLanguage" ID="Editor.getLanguage"></a>
3519 <h4>Editor.getLanguage</h4>
3520 <b>getLanguage</b>(<i>normalized=True, forPygments=False</i>)
3521 <p>
3522 Public method to retrieve the language of the editor.
3523 </p><dl>
3524 <dt><i>normalized=</i></dt>
3525 <dd>
3526 flag indicating to normalize some Pygments
3527 lexer names (boolean)
3528 </dd><dt><i>forPygments=</i></dt>
3529 <dd>
3530 flag indicating to normalize some lexer
3531 names for Pygments (boolean)
3532 </dd>
3533 </dl><dl>
3534 <dt>Returns:</dt>
3535 <dd>
3536 language of the editor (string)
3537 </dd>
3538 </dl><a NAME="Editor.getLexer" ID="Editor.getLexer"></a>
3539 <h4>Editor.getLexer</h4>
3540 <b>getLexer</b>(<i></i>)
3541 <p>
3542 Public method to retrieve a reference to the lexer object.
3543 </p><dl>
3544 <dt>Returns:</dt>
3545 <dd>
3546 the lexer object (Lexer)
3547 </dd>
3548 </dl><a NAME="Editor.getMenu" ID="Editor.getMenu"></a>
3549 <h4>Editor.getMenu</h4>
3550 <b>getMenu</b>(<i>menuName</i>)
3551 <p>
3552 Public method to get a reference to the main context menu or a submenu.
3553 </p><dl>
3554 <dt><i>menuName</i></dt>
3555 <dd>
3556 name of the menu (string)
3557 </dd>
3558 </dl><dl>
3559 <dt>Returns:</dt>
3560 <dd>
3561 reference to the requested menu (QMenu) or None
3562 </dd>
3563 </dl><a NAME="Editor.getMouseClickHandler" ID="Editor.getMouseClickHandler"></a>
3564 <h4>Editor.getMouseClickHandler</h4>
3565 <b>getMouseClickHandler</b>(<i>modifiers, button</i>)
3566 <p>
3567 Public method to get a registered mouse click handler.
3568 </p><dl>
3569 <dt><i>modifiers</i> (Qt.KeyboardModifiers)</dt>
3570 <dd>
3571 keyboard modifiers of the handler
3572 </dd><dt><i>button</i> (Qt.MouseButton)</dt>
3573 <dd>
3574 mouse button of the handler
3575 </dd>
3576 </dl><dl>
3577 <dt>Returns:</dt>
3578 <dd>
3579 plug-in name and registered function
3580 </dd>
3581 </dl><dl>
3582 <dt>Return Type:</dt>
3583 <dd>
3584 tuple of str and func
3585 </dd>
3586 </dl><a NAME="Editor.getMouseClickHandlers" ID="Editor.getMouseClickHandlers"></a>
3587 <h4>Editor.getMouseClickHandlers</h4>
3588 <b>getMouseClickHandlers</b>(<i>name</i>)
3589 <p>
3590 Public method to get all registered mouse click handlers of
3591 a plug-in.
3592 </p><dl>
3593 <dt><i>name</i> (str)</dt>
3594 <dd>
3595 name of the plug-in
3596 </dd>
3597 </dl><dl>
3598 <dt>Returns:</dt>
3599 <dd>
3600 registered mouse click handlers as list of modifiers,
3601 mouse button and function
3602 </dd>
3603 </dl><dl>
3604 <dt>Return Type:</dt>
3605 <dd>
3606 list of tuple of (Qt.KeyboardModifiers, Qt.MouseButton,func)
3607 </dd>
3608 </dl><a NAME="Editor.getNoName" ID="Editor.getNoName"></a>
3609 <h4>Editor.getNoName</h4>
3610 <b>getNoName</b>(<i></i>)
3611 <p>
3612 Public method to get the display string for an unnamed editor.
3613 </p><dl>
3614 <dt>Returns:</dt>
3615 <dd>
3616 display string for this unnamed editor (string)
3617 </dd>
3618 </dl><a NAME="Editor.getSearchIndicatorLines" ID="Editor.getSearchIndicatorLines"></a>
3619 <h4>Editor.getSearchIndicatorLines</h4>
3620 <b>getSearchIndicatorLines</b>(<i></i>)
3621 <p>
3622 Public method to get the lines containing a search indicator.
3623 </p><dl>
3624 <dt>Returns:</dt>
3625 <dd>
3626 list of lines containing a search indicator (list of integer)
3627 </dd>
3628 </dl><a NAME="Editor.getSearchText" ID="Editor.getSearchText"></a>
3629 <h4>Editor.getSearchText</h4>
3630 <b>getSearchText</b>(<i>selectionOnly=False</i>)
3631 <p>
3632 Public method to determine the selection or the current word for the
3633 next search operation.
3634 </p><dl>
3635 <dt><i>selectionOnly</i></dt>
3636 <dd>
3637 flag indicating that only selected text should be
3638 returned (boolean)
3639 </dd>
3640 </dl><dl>
3641 <dt>Returns:</dt>
3642 <dd>
3643 selection or current word (string)
3644 </dd>
3645 </dl><a NAME="Editor.getSharingStatus" ID="Editor.getSharingStatus"></a>
3646 <h4>Editor.getSharingStatus</h4>
3647 <b>getSharingStatus</b>(<i></i>)
3648 <p>
3649 Public method to get some share status info.
3650 </p><dl>
3651 <dt>Returns:</dt>
3652 <dd>
3653 tuple indicating, if the editor is sharable, the sharing
3654 status, if it is inside a locally initiated shared edit session
3655 and if it is inside a remotely initiated shared edit session
3656 (boolean, boolean, boolean, boolean)
3657 </dd>
3658 </dl><a NAME="Editor.getSyntaxErrorLines" ID="Editor.getSyntaxErrorLines"></a>
3659 <h4>Editor.getSyntaxErrorLines</h4>
3660 <b>getSyntaxErrorLines</b>(<i></i>)
3661 <p>
3662 Public method to get the lines containing a syntax error.
3663 </p><dl>
3664 <dt>Returns:</dt>
3665 <dd>
3666 list of lines containing a syntax error (list of integer)
3667 </dd>
3668 </dl><a NAME="Editor.getSyntaxErrors" ID="Editor.getSyntaxErrors"></a>
3669 <h4>Editor.getSyntaxErrors</h4>
3670 <b>getSyntaxErrors</b>(<i></i>)
3671 <p>
3672 Public method to retrieve the syntax error markers.
3673 </p><dl>
3674 <dt>Returns:</dt>
3675 <dd>
3676 sorted list of all lines containing a syntax error
3677 (list of integer)
3678 </dd>
3679 </dl><a NAME="Editor.getTaskLines" ID="Editor.getTaskLines"></a>
3680 <h4>Editor.getTaskLines</h4>
3681 <b>getTaskLines</b>(<i></i>)
3682 <p>
3683 Public method to get the lines containing a task.
3684 </p><dl>
3685 <dt>Returns:</dt>
3686 <dd>
3687 list of lines containing a task (list of integer)
3688 </dd>
3689 </dl><a NAME="Editor.getVcsConflictMarkerLines" ID="Editor.getVcsConflictMarkerLines"></a>
3690 <h4>Editor.getVcsConflictMarkerLines</h4>
3691 <b>getVcsConflictMarkerLines</b>(<i></i>)
3692 <p>
3693 Public method to determine the lines containing a VCS conflict marker.
3694 </p><dl>
3695 <dt>Returns:</dt>
3696 <dd>
3697 list of line numbers containg a VCS conflict marker
3698 </dd>
3699 </dl><dl>
3700 <dt>Return Type:</dt>
3701 <dd>
3702 list of int
3703 </dd>
3704 </dl><a NAME="Editor.getWarningLines" ID="Editor.getWarningLines"></a>
3705 <h4>Editor.getWarningLines</h4>
3706 <b>getWarningLines</b>(<i></i>)
3707 <p>
3708 Public method to get the lines containing a warning.
3709 </p><dl>
3710 <dt>Returns:</dt>
3711 <dd>
3712 list of lines containing a warning (list of integer)
3713 </dd>
3714 </dl><a NAME="Editor.getWarnings" ID="Editor.getWarnings"></a>
3715 <h4>Editor.getWarnings</h4>
3716 <b>getWarnings</b>(<i></i>)
3717 <p>
3718 Public method to retrieve the warning markers.
3719 </p><dl>
3720 <dt>Returns:</dt>
3721 <dd>
3722 sorted list of all lines containing a warning
3723 (list of integer)
3724 </dd>
3725 </dl><a NAME="Editor.getWord" ID="Editor.getWord"></a>
3726 <h4>Editor.getWord</h4>
3727 <b>getWord</b>(<i>line, index, direction=0, useWordChars=True</i>)
3728 <p>
3729 Public method to get the word at a position.
3730 </p><dl>
3731 <dt><i>line</i></dt>
3732 <dd>
3733 number of line to look at (int)
3734 </dd><dt><i>index</i></dt>
3735 <dd>
3736 position to look at (int)
3737 </dd><dt><i>direction</i></dt>
3738 <dd>
3739 direction to look in (0 = whole word, 1 = left,
3740 2 = right)
3741 </dd><dt><i>useWordChars=</i></dt>
3742 <dd>
3743 flag indicating to use the wordCharacters
3744 method (boolean)
3745 </dd>
3746 </dl><dl>
3747 <dt>Returns:</dt>
3748 <dd>
3749 the word at that position (string)
3750 </dd>
3751 </dl><a NAME="Editor.getWordBoundaries" ID="Editor.getWordBoundaries"></a>
3752 <h4>Editor.getWordBoundaries</h4>
3753 <b>getWordBoundaries</b>(<i>line, index, useWordChars=True</i>)
3754 <p>
3755 Public method to get the word boundaries at a position.
3756 </p><dl>
3757 <dt><i>line</i></dt>
3758 <dd>
3759 number of line to look at (int)
3760 </dd><dt><i>index</i></dt>
3761 <dd>
3762 position to look at (int)
3763 </dd><dt><i>useWordChars=</i></dt>
3764 <dd>
3765 flag indicating to use the wordCharacters
3766 method (boolean)
3767 </dd>
3768 </dl><dl>
3769 <dt>Returns:</dt>
3770 <dd>
3771 tuple with start and end indexes of the word at the position
3772 (integer, integer)
3773 </dd>
3774 </dl><a NAME="Editor.getWordLeft" ID="Editor.getWordLeft"></a>
3775 <h4>Editor.getWordLeft</h4>
3776 <b>getWordLeft</b>(<i>line, index</i>)
3777 <p>
3778 Public method to get the word to the left of a position.
3779 </p><dl>
3780 <dt><i>line</i></dt>
3781 <dd>
3782 number of line to look at (int)
3783 </dd><dt><i>index</i></dt>
3784 <dd>
3785 position to look at (int)
3786 </dd>
3787 </dl><dl>
3788 <dt>Returns:</dt>
3789 <dd>
3790 the word to the left of that position (string)
3791 </dd>
3792 </dl><a NAME="Editor.getWordRight" ID="Editor.getWordRight"></a>
3793 <h4>Editor.getWordRight</h4>
3794 <b>getWordRight</b>(<i>line, index</i>)
3795 <p>
3796 Public method to get the word to the right of a position.
3797 </p><dl>
3798 <dt><i>line</i></dt>
3799 <dd>
3800 number of line to look at (int)
3801 </dd><dt><i>index</i></dt>
3802 <dd>
3803 position to look at (int)
3804 </dd>
3805 </dl><dl>
3806 <dt>Returns:</dt>
3807 <dd>
3808 the word to the right of that position (string)
3809 </dd>
3810 </dl><a NAME="Editor.gotoLastEditPosition" ID="Editor.gotoLastEditPosition"></a>
3811 <h4>Editor.gotoLastEditPosition</h4>
3812 <b>gotoLastEditPosition</b>(<i></i>)
3813 <p>
3814 Public method to move the cursor to the last edit position.
3815 </p><a NAME="Editor.gotoLine" ID="Editor.gotoLine"></a>
3816 <h4>Editor.gotoLine</h4>
3817 <b>gotoLine</b>(<i>line, pos=1, firstVisible=False, expand=False</i>)
3818 <p>
3819 Public slot to jump to the beginning of a line.
3820 </p><dl>
3821 <dt><i>line</i> (int)</dt>
3822 <dd>
3823 line number to go to
3824 </dd><dt><i>pos=</i> (int)</dt>
3825 <dd>
3826 position in line to go to
3827 </dd><dt><i>firstVisible=</i> (bool)</dt>
3828 <dd>
3829 flag indicating to make the line the first
3830 visible line
3831 </dd><dt><i>expand=</i> (bool)</dt>
3832 <dd>
3833 flag indicating to expand all folds
3834 </dd>
3835 </dl><a NAME="Editor.gotoMethodClass" ID="Editor.gotoMethodClass"></a>
3836 <h4>Editor.gotoMethodClass</h4>
3837 <b>gotoMethodClass</b>(<i>goUp=False</i>)
3838 <p>
3839 Public method to go to the next Python method or class definition.
3840 </p><dl>
3841 <dt><i>goUp</i></dt>
3842 <dd>
3843 flag indicating the move direction (boolean)
3844 </dd>
3845 </dl><a NAME="Editor.gotoSyntaxError" ID="Editor.gotoSyntaxError"></a>
3846 <h4>Editor.gotoSyntaxError</h4>
3847 <b>gotoSyntaxError</b>(<i></i>)
3848 <p>
3849 Public slot to handle the 'Goto syntax error' context menu action.
3850 </p><a NAME="Editor.handleMonospacedEnable" ID="Editor.handleMonospacedEnable"></a>
3851 <h4>Editor.handleMonospacedEnable</h4>
3852 <b>handleMonospacedEnable</b>(<i></i>)
3853 <p>
3854 Public slot to handle the Use Monospaced Font context menu entry.
3855 </p><a NAME="Editor.handleRenamed" ID="Editor.handleRenamed"></a>
3856 <h4>Editor.handleRenamed</h4>
3857 <b>handleRenamed</b>(<i>fn</i>)
3858 <p>
3859 Public slot to handle the editorRenamed signal.
3860 </p><dl>
3861 <dt><i>fn</i></dt>
3862 <dd>
3863 filename to be set for the editor (string).
3864 </dd>
3865 </dl><a NAME="Editor.hasBookmarks" ID="Editor.hasBookmarks"></a>
3866 <h4>Editor.hasBookmarks</h4>
3867 <b>hasBookmarks</b>(<i></i>)
3868 <p>
3869 Public method to check for the presence of bookmarks.
3870 </p><dl>
3871 <dt>Returns:</dt>
3872 <dd>
3873 flag indicating the presence of bookmarks (boolean)
3874 </dd>
3875 </dl><a NAME="Editor.hasBreakpoints" ID="Editor.hasBreakpoints"></a>
3876 <h4>Editor.hasBreakpoints</h4>
3877 <b>hasBreakpoints</b>(<i></i>)
3878 <p>
3879 Public method to check for the presence of breakpoints.
3880 </p><dl>
3881 <dt>Returns:</dt>
3882 <dd>
3883 flag indicating the presence of breakpoints (boolean)
3884 </dd>
3885 </dl><a NAME="Editor.hasChangeMarkers" ID="Editor.hasChangeMarkers"></a>
3886 <h4>Editor.hasChangeMarkers</h4>
3887 <b>hasChangeMarkers</b>(<i></i>)
3888 <p>
3889 Public method to determine, if this editor contains any change markers.
3890 </p><dl>
3891 <dt>Returns:</dt>
3892 <dd>
3893 flag indicating the presence of change markers (boolean)
3894 </dd>
3895 </dl><a NAME="Editor.hasCoverageMarkers" ID="Editor.hasCoverageMarkers"></a>
3896 <h4>Editor.hasCoverageMarkers</h4>
3897 <b>hasCoverageMarkers</b>(<i></i>)
3898 <p>
3899 Public method to test, if there are coverage markers.
3900 </p><dl>
3901 <dt>Returns:</dt>
3902 <dd>
3903 flag indicating the presence of coverage markers (boolean)
3904 </dd>
3905 </dl><a NAME="Editor.hasMiniMenu" ID="Editor.hasMiniMenu"></a>
3906 <h4>Editor.hasMiniMenu</h4>
3907 <b>hasMiniMenu</b>(<i></i>)
3908 <p>
3909 Public method to check the miniMenu flag.
3910 </p><dl>
3911 <dt>Returns:</dt>
3912 <dd>
3913 flag indicating a minimized context menu (boolean)
3914 </dd>
3915 </dl><a NAME="Editor.hasSyntaxErrors" ID="Editor.hasSyntaxErrors"></a>
3916 <h4>Editor.hasSyntaxErrors</h4>
3917 <b>hasSyntaxErrors</b>(<i></i>)
3918 <p>
3919 Public method to check for the presence of syntax errors.
3920 </p><dl>
3921 <dt>Returns:</dt>
3922 <dd>
3923 flag indicating the presence of syntax errors (boolean)
3924 </dd>
3925 </dl><a NAME="Editor.hasTaskMarkers" ID="Editor.hasTaskMarkers"></a>
3926 <h4>Editor.hasTaskMarkers</h4>
3927 <b>hasTaskMarkers</b>(<i></i>)
3928 <p>
3929 Public method to determine, if this editor contains any task markers.
3930 </p><dl>
3931 <dt>Returns:</dt>
3932 <dd>
3933 flag indicating the presence of task markers (boolean)
3934 </dd>
3935 </dl><a NAME="Editor.hasWarnings" ID="Editor.hasWarnings"></a>
3936 <h4>Editor.hasWarnings</h4>
3937 <b>hasWarnings</b>(<i></i>)
3938 <p>
3939 Public method to check for the presence of warnings.
3940 </p><dl>
3941 <dt>Returns:</dt>
3942 <dd>
3943 flag indicating the presence of warnings (boolean)
3944 </dd>
3945 </dl><a NAME="Editor.highlight" ID="Editor.highlight"></a>
3946 <h4>Editor.highlight</h4>
3947 <b>highlight</b>(<i>line=None, error=False, syntaxError=False</i>)
3948 <p>
3949 Public method to highlight [or de-highlight] a particular line.
3950 </p><dl>
3951 <dt><i>line</i></dt>
3952 <dd>
3953 line number to highlight (integer)
3954 </dd><dt><i>error</i></dt>
3955 <dd>
3956 flag indicating whether the error highlight should be
3957 used (boolean)
3958 </dd><dt><i>syntaxError</i></dt>
3959 <dd>
3960 flag indicating a syntax error (boolean)
3961 </dd>
3962 </dl><a NAME="Editor.highlightVisible" ID="Editor.highlightVisible"></a>
3963 <h4>Editor.highlightVisible</h4>
3964 <b>highlightVisible</b>(<i></i>)
3965 <p>
3966 Public method to make sure that the highlight is visible.
3967 </p><a NAME="Editor.indentLineOrSelection" ID="Editor.indentLineOrSelection"></a>
3968 <h4>Editor.indentLineOrSelection</h4>
3969 <b>indentLineOrSelection</b>(<i></i>)
3970 <p>
3971 Public slot to indent the current line or current selection.
3972 </p><a NAME="Editor.isClone" ID="Editor.isClone"></a>
3973 <h4>Editor.isClone</h4>
3974 <b>isClone</b>(<i>editor</i>)
3975 <p>
3976 Public method to test, if the given editor is a clone.
3977 </p><dl>
3978 <dt><i>editor</i> (Editor)</dt>
3979 <dd>
3980 reference to the cloned editor
3981 </dd>
3982 </dl><dl>
3983 <dt>Returns:</dt>
3984 <dd>
3985 flag indicating a clone
3986 </dd>
3987 </dl><dl>
3988 <dt>Return Type:</dt>
3989 <dd>
3990 bool
3991 </dd>
3992 </dl><a NAME="Editor.isJavascriptFile" ID="Editor.isJavascriptFile"></a>
3993 <h4>Editor.isJavascriptFile</h4>
3994 <b>isJavascriptFile</b>(<i></i>)
3995 <p>
3996 Public method to return a flag indicating a Javascript file.
3997 </p><dl>
3998 <dt>Returns:</dt>
3999 <dd>
4000 flag indicating a Javascript file (boolean)
4001 </dd>
4002 </dl><a NAME="Editor.isLastEditPositionAvailable" ID="Editor.isLastEditPositionAvailable"></a>
4003 <h4>Editor.isLastEditPositionAvailable</h4>
4004 <b>isLastEditPositionAvailable</b>(<i></i>)
4005 <p>
4006 Public method to check, if a last edit position is available.
4007 </p><dl>
4008 <dt>Returns:</dt>
4009 <dd>
4010 flag indicating availability (boolean)
4011 </dd>
4012 </dl><a NAME="Editor.isPy2File" ID="Editor.isPy2File"></a>
4013 <h4>Editor.isPy2File</h4>
4014 <b>isPy2File</b>(<i></i>)
4015 <p>
4016 Public method to return a flag indicating a Python2 file.
4017 </p><dl>
4018 <dt>Returns:</dt>
4019 <dd>
4020 flag indicating a Python2 file (boolean)
4021 </dd>
4022 </dl><a NAME="Editor.isPy3File" ID="Editor.isPy3File"></a>
4023 <h4>Editor.isPy3File</h4>
4024 <b>isPy3File</b>(<i></i>)
4025 <p>
4026 Public method to return a flag indicating a Python3 file.
4027 </p><dl>
4028 <dt>Returns:</dt>
4029 <dd>
4030 flag indicating a Python3 file (boolean)
4031 </dd>
4032 </dl><a NAME="Editor.isPyFile" ID="Editor.isPyFile"></a>
4033 <h4>Editor.isPyFile</h4>
4034 <b>isPyFile</b>(<i></i>)
4035 <p>
4036 Public method to return a flag indicating a Python (2 or 3) file.
4037 </p><dl>
4038 <dt>Returns:</dt>
4039 <dd>
4040 flag indicating a Python (2 or 3) file (boolean)
4041 </dd>
4042 </dl><a NAME="Editor.isRubyFile" ID="Editor.isRubyFile"></a>
4043 <h4>Editor.isRubyFile</h4>
4044 <b>isRubyFile</b>(<i></i>)
4045 <p>
4046 Public method to return a flag indicating a Ruby file.
4047 </p><dl>
4048 <dt>Returns:</dt>
4049 <dd>
4050 flag indicating a Ruby file (boolean)
4051 </dd>
4052 </dl><a NAME="Editor.isSpellCheckRegion" ID="Editor.isSpellCheckRegion"></a>
4053 <h4>Editor.isSpellCheckRegion</h4>
4054 <b>isSpellCheckRegion</b>(<i>pos</i>)
4055 <p>
4056 Public method to check, if the given position is within a region, that
4057 should be spell checked.
4058 </p><dl>
4059 <dt><i>pos</i></dt>
4060 <dd>
4061 position to be checked (integer)
4062 </dd>
4063 </dl><dl>
4064 <dt>Returns:</dt>
4065 <dd>
4066 flag indicating pos is in a spell check region (boolean)
4067 </dd>
4068 </dl><a NAME="Editor.joinLines" ID="Editor.joinLines"></a>
4069 <h4>Editor.joinLines</h4>
4070 <b>joinLines</b>(<i></i>)
4071 <p>
4072 Public slot to join the current line with the next one.
4073 </p><a NAME="Editor.keyPressEvent" ID="Editor.keyPressEvent"></a>
4074 <h4>Editor.keyPressEvent</h4>
4075 <b>keyPressEvent</b>(<i>ev</i>)
4076 <p>
4077 Protected method to handle the user input a key at a time.
4078 </p><dl>
4079 <dt><i>ev</i></dt>
4080 <dd>
4081 key event (QKeyEvent)
4082 </dd>
4083 </dl><a NAME="Editor.macroDelete" ID="Editor.macroDelete"></a>
4084 <h4>Editor.macroDelete</h4>
4085 <b>macroDelete</b>(<i></i>)
4086 <p>
4087 Public method to delete a macro.
4088 </p><a NAME="Editor.macroLoad" ID="Editor.macroLoad"></a>
4089 <h4>Editor.macroLoad</h4>
4090 <b>macroLoad</b>(<i></i>)
4091 <p>
4092 Public method to load a macro from a file.
4093 </p><a NAME="Editor.macroRecordingStart" ID="Editor.macroRecordingStart"></a>
4094 <h4>Editor.macroRecordingStart</h4>
4095 <b>macroRecordingStart</b>(<i></i>)
4096 <p>
4097 Public method to start macro recording.
4098 </p><a NAME="Editor.macroRecordingStop" ID="Editor.macroRecordingStop"></a>
4099 <h4>Editor.macroRecordingStop</h4>
4100 <b>macroRecordingStop</b>(<i></i>)
4101 <p>
4102 Public method to stop macro recording.
4103 </p><a NAME="Editor.macroRun" ID="Editor.macroRun"></a>
4104 <h4>Editor.macroRun</h4>
4105 <b>macroRun</b>(<i></i>)
4106 <p>
4107 Public method to execute a macro.
4108 </p><a NAME="Editor.macroSave" ID="Editor.macroSave"></a>
4109 <h4>Editor.macroSave</h4>
4110 <b>macroSave</b>(<i></i>)
4111 <p>
4112 Public method to save a macro to a file.
4113 </p><a NAME="Editor.menuEditBreakpoint" ID="Editor.menuEditBreakpoint"></a>
4114 <h4>Editor.menuEditBreakpoint</h4>
4115 <b>menuEditBreakpoint</b>(<i>line=None</i>)
4116 <p>
4117 Public slot to handle the 'Edit breakpoint' context menu action.
4118 </p><dl>
4119 <dt><i>line</i></dt>
4120 <dd>
4121 linenumber of the breakpoint to edit
4122 </dd>
4123 </dl><a NAME="Editor.menuNextBreakpoint" ID="Editor.menuNextBreakpoint"></a>
4124 <h4>Editor.menuNextBreakpoint</h4>
4125 <b>menuNextBreakpoint</b>(<i></i>)
4126 <p>
4127 Public slot to handle the 'Next breakpoint' context menu action.
4128 </p><a NAME="Editor.menuPreviousBreakpoint" ID="Editor.menuPreviousBreakpoint"></a>
4129 <h4>Editor.menuPreviousBreakpoint</h4>
4130 <b>menuPreviousBreakpoint</b>(<i></i>)
4131 <p>
4132 Public slot to handle the 'Previous breakpoint' context menu action.
4133 </p><a NAME="Editor.menuToggleBookmark" ID="Editor.menuToggleBookmark"></a>
4134 <h4>Editor.menuToggleBookmark</h4>
4135 <b>menuToggleBookmark</b>(<i></i>)
4136 <p>
4137 Public slot to handle the 'Toggle bookmark' context menu action.
4138 </p><a NAME="Editor.menuToggleBreakpoint" ID="Editor.menuToggleBreakpoint"></a>
4139 <h4>Editor.menuToggleBreakpoint</h4>
4140 <b>menuToggleBreakpoint</b>(<i></i>)
4141 <p>
4142 Public slot to handle the 'Toggle breakpoint' context menu action.
4143 </p><a NAME="Editor.mouseDoubleClickEvent" ID="Editor.mouseDoubleClickEvent"></a>
4144 <h4>Editor.mouseDoubleClickEvent</h4>
4145 <b>mouseDoubleClickEvent</b>(<i>evt</i>)
4146 <p>
4147 Protected method to handle mouse double click events.
4148 </p><dl>
4149 <dt><i>evt</i> (QMouseEvent)</dt>
4150 <dd>
4151 reference to the mouse event
4152 </dd>
4153 </dl><a NAME="Editor.mousePressEvent" ID="Editor.mousePressEvent"></a>
4154 <h4>Editor.mousePressEvent</h4>
4155 <b>mousePressEvent</b>(<i>event</i>)
4156 <p>
4157 Protected method to handle the mouse press event.
4158 </p><dl>
4159 <dt><i>event</i></dt>
4160 <dd>
4161 the mouse press event (QMouseEvent)
4162 </dd>
4163 </dl><a NAME="Editor.mouseReleaseEvent" ID="Editor.mouseReleaseEvent"></a>
4164 <h4>Editor.mouseReleaseEvent</h4>
4165 <b>mouseReleaseEvent</b>(<i>evt</i>)
4166 <p>
4167 Protected method calling a registered mouse click handler function.
4168 </p><dl>
4169 <dt><i>evt</i> (QMouseEvent)</dt>
4170 <dd>
4171 event object
4172 </dd>
4173 </dl><a NAME="Editor.newBreakpointWithProperties" ID="Editor.newBreakpointWithProperties"></a>
4174 <h4>Editor.newBreakpointWithProperties</h4>
4175 <b>newBreakpointWithProperties</b>(<i>line, properties</i>)
4176 <p>
4177 Public method to set a new breakpoint and its properties.
4178 </p><dl>
4179 <dt><i>line</i></dt>
4180 <dd>
4181 line number of the breakpoint (integer)
4182 </dd><dt><i>properties</i></dt>
4183 <dd>
4184 properties for the breakpoint (tuple)
4185 (condition, temporary flag, enabled flag, ignore count)
4186 </dd>
4187 </dl><a NAME="Editor.nextBookmark" ID="Editor.nextBookmark"></a>
4188 <h4>Editor.nextBookmark</h4>
4189 <b>nextBookmark</b>(<i></i>)
4190 <p>
4191 Public slot to handle the 'Next bookmark' context menu action.
4192 </p><a NAME="Editor.nextChange" ID="Editor.nextChange"></a>
4193 <h4>Editor.nextChange</h4>
4194 <b>nextChange</b>(<i></i>)
4195 <p>
4196 Public slot to handle the 'Next change' context menu action.
4197 </p><a NAME="Editor.nextTask" ID="Editor.nextTask"></a>
4198 <h4>Editor.nextTask</h4>
4199 <b>nextTask</b>(<i></i>)
4200 <p>
4201 Public slot to handle the 'Next task' context menu action.
4202 </p><a NAME="Editor.nextUncovered" ID="Editor.nextUncovered"></a>
4203 <h4>Editor.nextUncovered</h4>
4204 <b>nextUncovered</b>(<i></i>)
4205 <p>
4206 Public slot to handle the 'Next uncovered' context menu action.
4207 </p><a NAME="Editor.nextWarning" ID="Editor.nextWarning"></a>
4208 <h4>Editor.nextWarning</h4>
4209 <b>nextWarning</b>(<i></i>)
4210 <p>
4211 Public slot to handle the 'Next warning' context menu action.
4212 </p><a NAME="Editor.previousBookmark" ID="Editor.previousBookmark"></a>
4213 <h4>Editor.previousBookmark</h4>
4214 <b>previousBookmark</b>(<i></i>)
4215 <p>
4216 Public slot to handle the 'Previous bookmark' context menu action.
4217 </p><a NAME="Editor.previousChange" ID="Editor.previousChange"></a>
4218 <h4>Editor.previousChange</h4>
4219 <b>previousChange</b>(<i></i>)
4220 <p>
4221 Public slot to handle the 'Previous change' context menu action.
4222 </p><a NAME="Editor.previousTask" ID="Editor.previousTask"></a>
4223 <h4>Editor.previousTask</h4>
4224 <b>previousTask</b>(<i></i>)
4225 <p>
4226 Public slot to handle the 'Previous task' context menu action.
4227 </p><a NAME="Editor.previousUncovered" ID="Editor.previousUncovered"></a>
4228 <h4>Editor.previousUncovered</h4>
4229 <b>previousUncovered</b>(<i></i>)
4230 <p>
4231 Public slot to handle the 'Previous uncovered' context menu action.
4232 </p><a NAME="Editor.previousWarning" ID="Editor.previousWarning"></a>
4233 <h4>Editor.previousWarning</h4>
4234 <b>previousWarning</b>(<i></i>)
4235 <p>
4236 Public slot to handle the 'Previous warning' context menu action.
4237 </p><a NAME="Editor.printFile" ID="Editor.printFile"></a>
4238 <h4>Editor.printFile</h4>
4239 <b>printFile</b>(<i></i>)
4240 <p>
4241 Public slot to print the text.
4242 </p><a NAME="Editor.printPreviewFile" ID="Editor.printPreviewFile"></a>
4243 <h4>Editor.printPreviewFile</h4>
4244 <b>printPreviewFile</b>(<i></i>)
4245 <p>
4246 Public slot to show a print preview of the text.
4247 </p><a NAME="Editor.projectClosed" ID="Editor.projectClosed"></a>
4248 <h4>Editor.projectClosed</h4>
4249 <b>projectClosed</b>(<i></i>)
4250 <p>
4251 Public slot to handle the closing of a project.
4252 </p><a NAME="Editor.projectLexerAssociationsChanged" ID="Editor.projectLexerAssociationsChanged"></a>
4253 <h4>Editor.projectLexerAssociationsChanged</h4>
4254 <b>projectLexerAssociationsChanged</b>(<i></i>)
4255 <p>
4256 Public slot to handle changes of the project lexer associations.
4257 </p><a NAME="Editor.projectOpened" ID="Editor.projectOpened"></a>
4258 <h4>Editor.projectOpened</h4>
4259 <b>projectOpened</b>(<i></i>)
4260 <p>
4261 Public slot to handle the opening of a project.
4262 </p><a NAME="Editor.readFile" ID="Editor.readFile"></a>
4263 <h4>Editor.readFile</h4>
4264 <b>readFile</b>(<i>fn, createIt=False, encoding=""</i>)
4265 <p>
4266 Public slot to read the text from a file.
4267 </p><dl>
4268 <dt><i>fn</i></dt>
4269 <dd>
4270 filename to read from (string)
4271 </dd><dt><i>createIt=</i></dt>
4272 <dd>
4273 flag indicating the creation of a new file, if the
4274 given one doesn't exist (boolean)
4275 </dd><dt><i>encoding=</i></dt>
4276 <dd>
4277 encoding to be used to read the file (string)
4278 (Note: this parameter overrides encoding detection)
4279 </dd>
4280 </dl><a NAME="Editor.readSettings" ID="Editor.readSettings"></a>
4281 <h4>Editor.readSettings</h4>
4282 <b>readSettings</b>(<i></i>)
4283 <p>
4284 Public slot to read the settings into our lexer.
4285 </p><a NAME="Editor.receive" ID="Editor.receive"></a>
4286 <h4>Editor.receive</h4>
4287 <b>receive</b>(<i>command</i>)
4288 <p>
4289 Public slot to handle received editor commands.
4290 </p><dl>
4291 <dt><i>command</i></dt>
4292 <dd>
4293 command string (string)
4294 </dd>
4295 </dl><a NAME="Editor.redo" ID="Editor.redo"></a>
4296 <h4>Editor.redo</h4>
4297 <b>redo</b>(<i></i>)
4298 <p>
4299 Public method to redo the last recorded change.
4300 </p><a NAME="Editor.refresh" ID="Editor.refresh"></a>
4301 <h4>Editor.refresh</h4>
4302 <b>refresh</b>(<i></i>)
4303 <p>
4304 Public slot to refresh the editor contents.
4305 </p><a NAME="Editor.refreshCoverageAnnotations" ID="Editor.refreshCoverageAnnotations"></a>
4306 <h4>Editor.refreshCoverageAnnotations</h4>
4307 <b>refreshCoverageAnnotations</b>(<i></i>)
4308 <p>
4309 Public method to refresh the code coverage annotations.
4310 </p><a NAME="Editor.removeCallTipHook" ID="Editor.removeCallTipHook"></a>
4311 <h4>Editor.removeCallTipHook</h4>
4312 <b>removeCallTipHook</b>(<i>key</i>)
4313 <p>
4314 Public method to remove a previously registered calltip provider.
4315 </p><dl>
4316 <dt><i>key</i> (str)</dt>
4317 <dd>
4318 name of the provider
4319 </dd>
4320 </dl><a NAME="Editor.removeClone" ID="Editor.removeClone"></a>
4321 <h4>Editor.removeClone</h4>
4322 <b>removeClone</b>(<i>editor</i>)
4323 <p>
4324 Public method to remove a clone from our list.
4325 </p><dl>
4326 <dt><i>editor</i> (Editor)</dt>
4327 <dd>
4328 reference to the cloned editor
4329 </dd>
4330 </dl><a NAME="Editor.removeCompletionListHook" ID="Editor.removeCompletionListHook"></a>
4331 <h4>Editor.removeCompletionListHook</h4>
4332 <b>removeCompletionListHook</b>(<i>key</i>)
4333 <p>
4334 Public method to remove a previously registered completion list
4335 provider.
4336 </p><dl>
4337 <dt><i>key</i> (str)</dt>
4338 <dd>
4339 name of the provider
4340 </dd>
4341 </dl><a NAME="Editor.removeMouseClickHandler" ID="Editor.removeMouseClickHandler"></a>
4342 <h4>Editor.removeMouseClickHandler</h4>
4343 <b>removeMouseClickHandler</b>(<i>modifiers, button</i>)
4344 <p>
4345 Public method to un-registered a mouse click handler.
4346 </p><dl>
4347 <dt><i>modifiers</i> (Qt.KeyboardModifiers)</dt>
4348 <dd>
4349 keyboard modifiers of the handler
4350 </dd><dt><i>button</i> (Qt.MouseButton)</dt>
4351 <dd>
4352 mouse button of the handler
4353 </dd>
4354 </dl><a NAME="Editor.removeMouseClickHandlers" ID="Editor.removeMouseClickHandlers"></a>
4355 <h4>Editor.removeMouseClickHandlers</h4>
4356 <b>removeMouseClickHandlers</b>(<i>name</i>)
4357 <p>
4358 Public method to un-registered all mouse click handlers of
4359 a plug-in.
4360 </p><dl>
4361 <dt><i>name</i> (str)</dt>
4362 <dd>
4363 name of the plug-in
4364 </dd>
4365 </dl><a NAME="Editor.resizeEvent" ID="Editor.resizeEvent"></a>
4366 <h4>Editor.resizeEvent</h4>
4367 <b>resizeEvent</b>(<i>evt</i>)
4368 <p>
4369 Protected method handling resize events.
4370 </p><dl>
4371 <dt><i>evt</i></dt>
4372 <dd>
4373 reference to the resize event (QResizeEvent)
4374 </dd>
4375 </dl><a NAME="Editor.revertToUnmodified" ID="Editor.revertToUnmodified"></a>
4376 <h4>Editor.revertToUnmodified</h4>
4377 <b>revertToUnmodified</b>(<i></i>)
4378 <p>
4379 Public method to revert back to the last saved state.
4380 </p><a NAME="Editor.saveFile" ID="Editor.saveFile"></a>
4381 <h4>Editor.saveFile</h4>
4382 <b>saveFile</b>(<i>saveas=False, path=None</i>)
4383 <p>
4384 Public method to save the text to a file.
4385 </p><dl>
4386 <dt><i>saveas</i></dt>
4387 <dd>
4388 flag indicating a 'save as' action (boolean)
4389 </dd><dt><i>path</i></dt>
4390 <dd>
4391 directory to save the file in (string)
4392 </dd>
4393 </dl><dl>
4394 <dt>Returns:</dt>
4395 <dd>
4396 flag indicating success (boolean)
4397 </dd>
4398 </dl><a NAME="Editor.saveFileAs" ID="Editor.saveFileAs"></a>
4399 <h4>Editor.saveFileAs</h4>
4400 <b>saveFileAs</b>(<i>path=None, toProject=False</i>)
4401 <p>
4402 Public slot to save a file with a new name.
4403 </p><dl>
4404 <dt><i>path</i></dt>
4405 <dd>
4406 directory to save the file in (string)
4407 </dd><dt><i>toProject=</i></dt>
4408 <dd>
4409 flag indicating a save to project operation
4410 (boolean)
4411 </dd>
4412 </dl><dl>
4413 <dt>Returns:</dt>
4414 <dd>
4415 tuple of two values (boolean, string) giving a success
4416 indicator and the name of the saved file
4417 </dd>
4418 </dl><a NAME="Editor.saveFileCopy" ID="Editor.saveFileCopy"></a>
4419 <h4>Editor.saveFileCopy</h4>
4420 <b>saveFileCopy</b>(<i>path=None</i>)
4421 <p>
4422 Public method to save a copy of the file.
4423 </p><dl>
4424 <dt><i>path</i></dt>
4425 <dd>
4426 directory to save the file in (string)
4427 </dd>
4428 </dl><dl>
4429 <dt>Returns:</dt>
4430 <dd>
4431 flag indicating success (boolean)
4432 </dd>
4433 </dl><a NAME="Editor.searchCurrentWordBackward" ID="Editor.searchCurrentWordBackward"></a>
4434 <h4>Editor.searchCurrentWordBackward</h4>
4435 <b>searchCurrentWordBackward</b>(<i></i>)
4436 <p>
4437 Public slot to search the current word backward.
4438 </p><a NAME="Editor.searchCurrentWordForward" ID="Editor.searchCurrentWordForward"></a>
4439 <h4>Editor.searchCurrentWordForward</h4>
4440 <b>searchCurrentWordForward</b>(<i></i>)
4441 <p>
4442 Public slot to search the current word forward.
4443 </p><a NAME="Editor.selectCurrentWord" ID="Editor.selectCurrentWord"></a>
4444 <h4>Editor.selectCurrentWord</h4>
4445 <b>selectCurrentWord</b>(<i></i>)
4446 <p>
4447 Public method to select the current word.
4448 </p><a NAME="Editor.selectWord" ID="Editor.selectWord"></a>
4449 <h4>Editor.selectWord</h4>
4450 <b>selectWord</b>(<i>line, index</i>)
4451 <p>
4452 Public method to select the word at a position.
4453 </p><dl>
4454 <dt><i>line</i></dt>
4455 <dd>
4456 number of line to look at (int)
4457 </dd><dt><i>index</i></dt>
4458 <dd>
4459 position to look at (int)
4460 </dd>
4461 </dl><a NAME="Editor.sendSharedEdit" ID="Editor.sendSharedEdit"></a>
4462 <h4>Editor.sendSharedEdit</h4>
4463 <b>sendSharedEdit</b>(<i></i>)
4464 <p>
4465 Public slot to end a shared edit session for the editor and
4466 send the changes.
4467 </p><a NAME="Editor.setAutoCompletionEnabled" ID="Editor.setAutoCompletionEnabled"></a>
4468 <h4>Editor.setAutoCompletionEnabled</h4>
4469 <b>setAutoCompletionEnabled</b>(<i>enable</i>)
4470 <p>
4471 Public method to enable/disable autocompletion.
4472 </p><dl>
4473 <dt><i>enable</i></dt>
4474 <dd>
4475 flag indicating the desired autocompletion status
4476 (boolean)
4477 </dd>
4478 </dl><a NAME="Editor.setAutoSpellChecking" ID="Editor.setAutoSpellChecking"></a>
4479 <h4>Editor.setAutoSpellChecking</h4>
4480 <b>setAutoSpellChecking</b>(<i></i>)
4481 <p>
4482 Public method to set the automatic spell checking.
4483 </p><a NAME="Editor.setHighlight" ID="Editor.setHighlight"></a>
4484 <h4>Editor.setHighlight</h4>
4485 <b>setHighlight</b>(<i>startLine, startIndex, endLine, endIndex</i>)
4486 <p>
4487 Public method to set a text highlight.
4488 </p><dl>
4489 <dt><i>startLine</i> (int)</dt>
4490 <dd>
4491 line of the highlight start
4492 </dd><dt><i>startIndex</i> (int)</dt>
4493 <dd>
4494 index of the highlight start
4495 </dd><dt><i>endLine</i> (int)</dt>
4496 <dd>
4497 line of the highlight end
4498 </dd><dt><i>endIndex</i> (int)</dt>
4499 <dd>
4500 index of the highlight end
4501 </dd>
4502 </dl><a NAME="Editor.setLanguage" ID="Editor.setLanguage"></a>
4503 <h4>Editor.setLanguage</h4>
4504 <b>setLanguage</b>(<i>filename, initTextDisplay=True, propagate=True, pyname=""</i>)
4505 <p>
4506 Public method to set a lexer language.
4507 </p><dl>
4508 <dt><i>filename</i></dt>
4509 <dd>
4510 filename used to determine the associated lexer
4511 language (string)
4512 </dd><dt><i>initTextDisplay</i></dt>
4513 <dd>
4514 flag indicating an initialization of the text
4515 display is required as well (boolean)
4516 </dd><dt><i>propagate=</i></dt>
4517 <dd>
4518 flag indicating to propagate the change (boolean)
4519 </dd><dt><i>pyname=</i></dt>
4520 <dd>
4521 name of the pygments lexer to use (string)
4522 </dd>
4523 </dl><a NAME="Editor.setMonospaced" ID="Editor.setMonospaced"></a>
4524 <h4>Editor.setMonospaced</h4>
4525 <b>setMonospaced</b>(<i>on</i>)
4526 <p>
4527 Public method to set/reset a monospaced font.
4528 </p><dl>
4529 <dt><i>on</i></dt>
4530 <dd>
4531 flag to indicate usage of a monospace font (boolean)
4532 </dd>
4533 </dl><a NAME="Editor.setMouseClickHandler" ID="Editor.setMouseClickHandler"></a>
4534 <h4>Editor.setMouseClickHandler</h4>
4535 <b>setMouseClickHandler</b>(<i>name, modifiers, button, function</i>)
4536 <p>
4537 Public method to set a mouse click handler.
4538 </p><dl>
4539 <dt><i>name</i> (str)</dt>
4540 <dd>
4541 name of the plug-in (or 'internal') setting this handler
4542 </dd><dt><i>modifiers</i> (Qt.KeyboardModifiers or int)</dt>
4543 <dd>
4544 keyboard modifiers of the handler
4545 </dd><dt><i>button</i> (Qt.MouseButton or int)</dt>
4546 <dd>
4547 mouse button of the handler
4548 </dd><dt><i>function</i> (func)</dt>
4549 <dd>
4550 handler function
4551 </dd>
4552 </dl><dl>
4553 <dt>Returns:</dt>
4554 <dd>
4555 flag indicating success
4556 </dd>
4557 </dl><dl>
4558 <dt>Return Type:</dt>
4559 <dd>
4560 bool
4561 </dd>
4562 </dl><a NAME="Editor.setNoName" ID="Editor.setNoName"></a>
4563 <h4>Editor.setNoName</h4>
4564 <b>setNoName</b>(<i>noName</i>)
4565 <p>
4566 Public method to set the display string for an unnamed editor.
4567 </p><dl>
4568 <dt><i>noName</i></dt>
4569 <dd>
4570 display string for this unnamed editor (string)
4571 </dd>
4572 </dl><a NAME="Editor.setSearchIndicator" ID="Editor.setSearchIndicator"></a>
4573 <h4>Editor.setSearchIndicator</h4>
4574 <b>setSearchIndicator</b>(<i>startPos, indicLength</i>)
4575 <p>
4576 Public method to set a search indicator for the given range.
4577 </p><dl>
4578 <dt><i>startPos</i></dt>
4579 <dd>
4580 start position of the indicator (integer)
4581 </dd><dt><i>indicLength</i></dt>
4582 <dd>
4583 length of the indicator (integer)
4584 </dd>
4585 </dl><a NAME="Editor.setSpellingForProject" ID="Editor.setSpellingForProject"></a>
4586 <h4>Editor.setSpellingForProject</h4>
4587 <b>setSpellingForProject</b>(<i></i>)
4588 <p>
4589 Public method to set the spell checking options for files belonging
4590 to the current project.
4591 </p><a NAME="Editor.shareConnected" ID="Editor.shareConnected"></a>
4592 <h4>Editor.shareConnected</h4>
4593 <b>shareConnected</b>(<i>connected</i>)
4594 <p>
4595 Public slot to handle a change of the connected state.
4596 </p><dl>
4597 <dt><i>connected</i></dt>
4598 <dd>
4599 flag indicating the connected state (boolean)
4600 </dd>
4601 </dl><a NAME="Editor.shareEditor" ID="Editor.shareEditor"></a>
4602 <h4>Editor.shareEditor</h4>
4603 <b>shareEditor</b>(<i>share</i>)
4604 <p>
4605 Public slot to set the shared status of the editor.
4606 </p><dl>
4607 <dt><i>share</i></dt>
4608 <dd>
4609 flag indicating the share status (boolean)
4610 </dd>
4611 </dl><a NAME="Editor.shortenEmptyLines" ID="Editor.shortenEmptyLines"></a>
4612 <h4>Editor.shortenEmptyLines</h4>
4613 <b>shortenEmptyLines</b>(<i></i>)
4614 <p>
4615 Public slot to compress lines consisting solely of whitespace
4616 characters.
4617 </p><a NAME="Editor.shouldAutosave" ID="Editor.shouldAutosave"></a>
4618 <h4>Editor.shouldAutosave</h4>
4619 <b>shouldAutosave</b>(<i></i>)
4620 <p>
4621 Public slot to check the autosave flags.
4622 </p><dl>
4623 <dt>Returns:</dt>
4624 <dd>
4625 flag indicating this editor should be saved (boolean)
4626 </dd>
4627 </dl><a NAME="Editor.smartIndentLineOrSelection" ID="Editor.smartIndentLineOrSelection"></a>
4628 <h4>Editor.smartIndentLineOrSelection</h4>
4629 <b>smartIndentLineOrSelection</b>(<i></i>)
4630 <p>
4631 Public slot to indent current line smartly.
4632 </p><a NAME="Editor.sortLines" ID="Editor.sortLines"></a>
4633 <h4>Editor.sortLines</h4>
4634 <b>sortLines</b>(<i></i>)
4635 <p>
4636 Public slot to sort the lines spanned by a rectangular selection.
4637 </p><a NAME="Editor.startSharedEdit" ID="Editor.startSharedEdit"></a>
4638 <h4>Editor.startSharedEdit</h4>
4639 <b>startSharedEdit</b>(<i></i>)
4640 <p>
4641 Public slot to start a shared edit session for the editor.
4642 </p><a NAME="Editor.streamCommentLine" ID="Editor.streamCommentLine"></a>
4643 <h4>Editor.streamCommentLine</h4>
4644 <b>streamCommentLine</b>(<i></i>)
4645 <p>
4646 Public slot to stream comment the current line.
4647 </p><a NAME="Editor.streamCommentLineOrSelection" ID="Editor.streamCommentLineOrSelection"></a>
4648 <h4>Editor.streamCommentLineOrSelection</h4>
4649 <b>streamCommentLineOrSelection</b>(<i></i>)
4650 <p>
4651 Public slot to stream comment the current line or current selection.
4652 </p><a NAME="Editor.streamCommentSelection" ID="Editor.streamCommentSelection"></a>
4653 <h4>Editor.streamCommentSelection</h4>
4654 <b>streamCommentSelection</b>(<i></i>)
4655 <p>
4656 Public slot to comment the current selection.
4657 </p><a NAME="Editor.toggleBookmark" ID="Editor.toggleBookmark"></a>
4658 <h4>Editor.toggleBookmark</h4>
4659 <b>toggleBookmark</b>(<i>line</i>)
4660 <p>
4661 Public method to toggle a bookmark.
4662 </p><dl>
4663 <dt><i>line</i></dt>
4664 <dd>
4665 line number of the bookmark (integer)
4666 </dd>
4667 </dl><a NAME="Editor.toggleCommentBlock" ID="Editor.toggleCommentBlock"></a>
4668 <h4>Editor.toggleCommentBlock</h4>
4669 <b>toggleCommentBlock</b>(<i></i>)
4670 <p>
4671 Public slot to toggle the comment of a block.
4672 </p><p>
4673 If the line of the cursor or the selection is not commented, it will
4674 be commented. If it is commented, the comment block will be removed.
4675 The later works independent of the current selection.
4676 </p><a NAME="Editor.toggleCurrentFold" ID="Editor.toggleCurrentFold"></a>
4677 <h4>Editor.toggleCurrentFold</h4>
4678 <b>toggleCurrentFold</b>(<i></i>)
4679 <p>
4680 Public slot to toggle the fold containing the current line.
4681 </p><a NAME="Editor.toggleSyntaxError" ID="Editor.toggleSyntaxError"></a>
4682 <h4>Editor.toggleSyntaxError</h4>
4683 <b>toggleSyntaxError</b>(<i>line, index, error, msg="", show=False</i>)
4684 <p>
4685 Public method to toggle a syntax error indicator.
4686 </p><dl>
4687 <dt><i>line</i></dt>
4688 <dd>
4689 line number of the syntax error (integer)
4690 </dd><dt><i>index</i></dt>
4691 <dd>
4692 index number of the syntax error (integer)
4693 </dd><dt><i>error</i></dt>
4694 <dd>
4695 flag indicating if the error marker should be
4696 set or deleted (boolean)
4697 </dd><dt><i>msg</i></dt>
4698 <dd>
4699 error message (string)
4700 </dd><dt><i>show=</i></dt>
4701 <dd>
4702 flag indicating to set the cursor to the error position
4703 (boolean)
4704 </dd>
4705 </dl><a NAME="Editor.toggleWarning" ID="Editor.toggleWarning"></a>
4706 <h4>Editor.toggleWarning</h4>
4707 <b>toggleWarning</b>(<i>line, col, warning, msg="", warningType=WarningCode</i>)
4708 <p>
4709 Public method to toggle a warning indicator.
4710 </p><p>
4711 Note: This method is used to set pyflakes and code style warnings.
4712 </p><dl>
4713 <dt><i>line</i></dt>
4714 <dd>
4715 line number of the warning
4716 </dd><dt><i>col</i></dt>
4717 <dd>
4718 column of the warning
4719 </dd><dt><i>warning</i></dt>
4720 <dd>
4721 flag indicating if the warning marker should be
4722 set or deleted (boolean)
4723 </dd><dt><i>msg</i></dt>
4724 <dd>
4725 warning message (string)
4726 </dd><dt><i>warningType=</i></dt>
4727 <dd>
4728 type of warning message (integer)
4729 </dd>
4730 </dl><a NAME="Editor.uncommentLine" ID="Editor.uncommentLine"></a>
4731 <h4>Editor.uncommentLine</h4>
4732 <b>uncommentLine</b>(<i></i>)
4733 <p>
4734 Public slot to uncomment the current line.
4735 </p><a NAME="Editor.uncommentLineOrSelection" ID="Editor.uncommentLineOrSelection"></a>
4736 <h4>Editor.uncommentLineOrSelection</h4>
4737 <b>uncommentLineOrSelection</b>(<i></i>)
4738 <p>
4739 Public slot to uncomment the current line or current selection.
4740 </p><a NAME="Editor.uncommentSelection" ID="Editor.uncommentSelection"></a>
4741 <h4>Editor.uncommentSelection</h4>
4742 <b>uncommentSelection</b>(<i></i>)
4743 <p>
4744 Public slot to uncomment the current selection.
4745 </p><a NAME="Editor.undo" ID="Editor.undo"></a>
4746 <h4>Editor.undo</h4>
4747 <b>undo</b>(<i></i>)
4748 <p>
4749 Public method to undo the last recorded change.
4750 </p><a NAME="Editor.unindentLineOrSelection" ID="Editor.unindentLineOrSelection"></a>
4751 <h4>Editor.unindentLineOrSelection</h4>
4752 <b>unindentLineOrSelection</b>(<i></i>)
4753 <p>
4754 Public slot to unindent the current line or current selection.
4755 </p><a NAME="Editor.updateMarkerMap" ID="Editor.updateMarkerMap"></a>
4756 <h4>Editor.updateMarkerMap</h4>
4757 <b>updateMarkerMap</b>(<i></i>)
4758 <p>
4759 Public method to initiate an update of the marker map.
4760 </p><a NAME="Editor.viewportEvent" ID="Editor.viewportEvent"></a>
4761 <h4>Editor.viewportEvent</h4>
4762 <b>viewportEvent</b>(<i>evt</i>)
4763 <p>
4764 Protected method handling event of the viewport.
4765 </p><dl>
4766 <dt><i>evt</i></dt>
4767 <dd>
4768 reference to the event (QEvent)
4769 </dd>
4770 </dl><dl>
4771 <dt>Returns:</dt>
4772 <dd>
4773 flag indiating that the event was handled (boolean)
4774 </dd>
4775 </dl><a NAME="Editor.wheelEvent" ID="Editor.wheelEvent"></a>
4776 <h4>Editor.wheelEvent</h4>
4777 <b>wheelEvent</b>(<i>evt</i>)
4778 <p>
4779 Protected method to handle wheel events.
4780 </p><dl>
4781 <dt><i>evt</i></dt>
4782 <dd>
4783 reference to the wheel event (QWheelEvent)
4784 </dd>
4785 </dl><a NAME="Editor.writeFile" ID="Editor.writeFile"></a>
4786 <h4>Editor.writeFile</h4>
4787 <b>writeFile</b>(<i>fn, backup=True</i>)
4788 <p>
4789 Public slot to write the text to a file.
4790 </p><dl>
4791 <dt><i>fn</i></dt>
4792 <dd>
4793 filename to write to (string)
4794 </dd><dt><i>backup</i></dt>
4795 <dd>
4796 flag indicating to save a backup (boolean)
4797 </dd>
4798 </dl><dl>
4799 <dt>Returns:</dt>
4800 <dd>
4801 flag indicating success (boolean)
4802 </dd>
4803 </dl>
4804 <div align="right"><a href="#top">Up</a></div>
4805 <hr />
4806 </body></html>

Mercurial Repository: eric

eric ide

mercurial