|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.QScintilla.MiniEditor</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.MiniEditor</h1> |
|
23 <p> |
|
24 Module implementing a minimalistic editor for simple editing tasks. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#MiniEditor">MiniEditor</a></td> |
|
34 <td>Class implementing a minimalistic editor for simple editing tasks.</td> |
|
35 </tr><tr> |
|
36 <td><a href="#MiniScintilla">MiniScintilla</a></td> |
|
37 <td>Class implementing a QsciScintillaCompat subclass for handling focus events.</td> |
|
38 </tr> |
|
39 </table> |
|
40 <h3>Functions</h3> |
|
41 <table> |
|
42 <tr><td>None</td></tr> |
|
43 </table> |
|
44 <hr /><hr /> |
|
45 <a NAME="MiniEditor" ID="MiniEditor"></a> |
|
46 <h2>MiniEditor</h2> |
|
47 <p> |
|
48 Class implementing a minimalistic editor for simple editing tasks. |
|
49 </p><h3>Signals</h3> |
|
50 <dl> |
|
51 <dt>editorSaved()</dt> |
|
52 <dd> |
|
53 emitted after the file has been saved |
|
54 </dd> |
|
55 </dl> |
|
56 <h3>Derived from</h3> |
|
57 E5MainWindow |
|
58 <h3>Class Attributes</h3> |
|
59 <table> |
|
60 <tr><td>None</td></tr> |
|
61 </table> |
|
62 <h3>Class Methods</h3> |
|
63 <table> |
|
64 <tr><td>None</td></tr> |
|
65 </table> |
|
66 <h3>Methods</h3> |
|
67 <table> |
|
68 <tr> |
|
69 <td><a href="#MiniEditor.__init__">MiniEditor</a></td> |
|
70 <td>Constructor</td> |
|
71 </tr><tr> |
|
72 <td><a href="#MiniEditor.__about">__about</a></td> |
|
73 <td>Private slot to show a little About message.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#MiniEditor.__aboutQt">__aboutQt</a></td> |
|
76 <td>Private slot to handle the About Qt dialog.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#MiniEditor.__bindLexer">__bindLexer</a></td> |
|
79 <td>Private slot to set the correct lexer depending on language.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#MiniEditor.__bindName">__bindName</a></td> |
|
82 <td>Private method to generate a dummy filename for binding a lexer.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#MiniEditor.__checkActions">__checkActions</a></td> |
|
85 <td>Private slot to check some actions for their enable/disable status and set the statusbar info.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#MiniEditor.__checkLanguage">__checkLanguage</a></td> |
|
88 <td>Private method to check the selected language of the language submenu.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#MiniEditor.__contextMenuRequested">__contextMenuRequested</a></td> |
|
91 <td>Private slot to show the context menu.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#MiniEditor.__createActions">__createActions</a></td> |
|
94 <td>Private method to create the actions.</td> |
|
95 </tr><tr> |
|
96 <td><a href="#MiniEditor.__createEditActions">__createEditActions</a></td> |
|
97 <td>Private method to create the Edit actions.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#MiniEditor.__createFileActions">__createFileActions</a></td> |
|
100 <td>Private method to create the File actions.</td> |
|
101 </tr><tr> |
|
102 <td><a href="#MiniEditor.__createHelpActions">__createHelpActions</a></td> |
|
103 <td>Private method to create the Help actions.</td> |
|
104 </tr><tr> |
|
105 <td><a href="#MiniEditor.__createMenus">__createMenus</a></td> |
|
106 <td>Private method to create the menus of the menu bar.</td> |
|
107 </tr><tr> |
|
108 <td><a href="#MiniEditor.__createSearchActions">__createSearchActions</a></td> |
|
109 <td>Private method defining the user interface actions for the search commands.</td> |
|
110 </tr><tr> |
|
111 <td><a href="#MiniEditor.__createStatusBar">__createStatusBar</a></td> |
|
112 <td>Private method to initialize the status bar.</td> |
|
113 </tr><tr> |
|
114 <td><a href="#MiniEditor.__createToolBars">__createToolBars</a></td> |
|
115 <td>Private method to create the various toolbars.</td> |
|
116 </tr><tr> |
|
117 <td><a href="#MiniEditor.__cursorPositionChanged">__cursorPositionChanged</a></td> |
|
118 <td>Private slot to handle the cursorPositionChanged signal.</td> |
|
119 </tr><tr> |
|
120 <td><a href="#MiniEditor.__deselectAll">__deselectAll</a></td> |
|
121 <td>Private slot handling the deselect all context menu action.</td> |
|
122 </tr><tr> |
|
123 <td><a href="#MiniEditor.__documentWasModified">__documentWasModified</a></td> |
|
124 <td>Private slot to handle a change in the documents modification status.</td> |
|
125 </tr><tr> |
|
126 <td><a href="#MiniEditor.__getCurrentWord">__getCurrentWord</a></td> |
|
127 <td>Private method to get the word at the current position.</td> |
|
128 </tr><tr> |
|
129 <td><a href="#MiniEditor.__getEditorConfig">__getEditorConfig</a></td> |
|
130 <td>Private method to get the requested option via EditorConfig.</td> |
|
131 </tr><tr> |
|
132 <td><a href="#MiniEditor.__getWord">__getWord</a></td> |
|
133 <td>Private method to get the word at a position.</td> |
|
134 </tr><tr> |
|
135 <td><a href="#MiniEditor.__initContextMenu">__initContextMenu</a></td> |
|
136 <td>Private method used to setup the context menu.</td> |
|
137 </tr><tr> |
|
138 <td><a href="#MiniEditor.__initContextMenuLanguages">__initContextMenuLanguages</a></td> |
|
139 <td>Private method used to setup the Languages context sub menu.</td> |
|
140 </tr><tr> |
|
141 <td><a href="#MiniEditor.__isPy2File">__isPy2File</a></td> |
|
142 <td>Private method to return a flag indicating a Python 2 file.</td> |
|
143 </tr><tr> |
|
144 <td><a href="#MiniEditor.__languageMenuTriggered">__languageMenuTriggered</a></td> |
|
145 <td>Private method to handle the selection of a lexer language.</td> |
|
146 </tr><tr> |
|
147 <td><a href="#MiniEditor.__loadEditorConfig">__loadEditorConfig</a></td> |
|
148 <td>Private method to load the EditorConfig properties.</td> |
|
149 </tr><tr> |
|
150 <td><a href="#MiniEditor.__loadEditorConfigObject">__loadEditorConfigObject</a></td> |
|
151 <td>Private method to load the EditorConfig properties for the given file name.</td> |
|
152 </tr><tr> |
|
153 <td><a href="#MiniEditor.__loadFile">__loadFile</a></td> |
|
154 <td>Private method to load the given file.</td> |
|
155 </tr><tr> |
|
156 <td><a href="#MiniEditor.__markOccurrences">__markOccurrences</a></td> |
|
157 <td>Private method to mark all occurrences of the current word.</td> |
|
158 </tr><tr> |
|
159 <td><a href="#MiniEditor.__maybeSave">__maybeSave</a></td> |
|
160 <td>Private method to ask the user to save the file, if it was modified.</td> |
|
161 </tr><tr> |
|
162 <td><a href="#MiniEditor.__modificationChanged">__modificationChanged</a></td> |
|
163 <td>Private slot to handle the modificationChanged signal.</td> |
|
164 </tr><tr> |
|
165 <td><a href="#MiniEditor.__newFile">__newFile</a></td> |
|
166 <td>Private slot to create a new file.</td> |
|
167 </tr><tr> |
|
168 <td><a href="#MiniEditor.__open">__open</a></td> |
|
169 <td>Private slot to open a file.</td> |
|
170 </tr><tr> |
|
171 <td><a href="#MiniEditor.__printFile">__printFile</a></td> |
|
172 <td>Private slot to print the text.</td> |
|
173 </tr><tr> |
|
174 <td><a href="#MiniEditor.__printPreview">__printPreview</a></td> |
|
175 <td>Private slot to generate a print preview.</td> |
|
176 </tr><tr> |
|
177 <td><a href="#MiniEditor.__printPreviewFile">__printPreviewFile</a></td> |
|
178 <td>Private slot to show a print preview of the text.</td> |
|
179 </tr><tr> |
|
180 <td><a href="#MiniEditor.__readSettings">__readSettings</a></td> |
|
181 <td>Private method to read the settings remembered last time.</td> |
|
182 </tr><tr> |
|
183 <td><a href="#MiniEditor.__readShortcut">__readShortcut</a></td> |
|
184 <td>Private function to read a single keyboard shortcut from the settings.</td> |
|
185 </tr><tr> |
|
186 <td><a href="#MiniEditor.__redo">__redo</a></td> |
|
187 <td>Private method to redo the last recorded change.</td> |
|
188 </tr><tr> |
|
189 <td><a href="#MiniEditor.__resetLanguage">__resetLanguage</a></td> |
|
190 <td>Private method used to reset the language selection.</td> |
|
191 </tr><tr> |
|
192 <td><a href="#MiniEditor.__resizeLinenoMargin">__resizeLinenoMargin</a></td> |
|
193 <td>Private slot to resize the line numbers margin.</td> |
|
194 </tr><tr> |
|
195 <td><a href="#MiniEditor.__save">__save</a></td> |
|
196 <td>Private slot to save a file.</td> |
|
197 </tr><tr> |
|
198 <td><a href="#MiniEditor.__saveAs">__saveAs</a></td> |
|
199 <td>Private slot to save a file with a new name.</td> |
|
200 </tr><tr> |
|
201 <td><a href="#MiniEditor.__saveCopy">__saveCopy</a></td> |
|
202 <td>Private slot to save a copy of the file with a new name.</td> |
|
203 </tr><tr> |
|
204 <td><a href="#MiniEditor.__saveFile">__saveFile</a></td> |
|
205 <td>Private method to save to the given file.</td> |
|
206 </tr><tr> |
|
207 <td><a href="#MiniEditor.__searchClearMarkers">__searchClearMarkers</a></td> |
|
208 <td>Private method to clear the search markers of the active window.</td> |
|
209 </tr><tr> |
|
210 <td><a href="#MiniEditor.__searchNext">__searchNext</a></td> |
|
211 <td>Private slot to handle the search next action.</td> |
|
212 </tr><tr> |
|
213 <td><a href="#MiniEditor.__searchPrev">__searchPrev</a></td> |
|
214 <td>Private slot to handle the search previous action.</td> |
|
215 </tr><tr> |
|
216 <td><a href="#MiniEditor.__selectAll">__selectAll</a></td> |
|
217 <td>Private slot handling the select all context menu action.</td> |
|
218 </tr><tr> |
|
219 <td><a href="#MiniEditor.__selectPygmentsLexer">__selectPygmentsLexer</a></td> |
|
220 <td>Private method to select a specific pygments lexer.</td> |
|
221 </tr><tr> |
|
222 <td><a href="#MiniEditor.__setCurrentFile">__setCurrentFile</a></td> |
|
223 <td>Private method to register the file name of the current file.</td> |
|
224 </tr><tr> |
|
225 <td><a href="#MiniEditor.__setEolMode">__setEolMode</a></td> |
|
226 <td>Private method to configure the eol mode of the editor.</td> |
|
227 </tr><tr> |
|
228 <td><a href="#MiniEditor.__setMargins">__setMargins</a></td> |
|
229 <td>Private method to configure the margins.</td> |
|
230 </tr><tr> |
|
231 <td><a href="#MiniEditor.__setMonospaced">__setMonospaced</a></td> |
|
232 <td>Private method to set/reset a monospaced font.</td> |
|
233 </tr><tr> |
|
234 <td><a href="#MiniEditor.__setSbFile">__setSbFile</a></td> |
|
235 <td>Private method to set the file info in the status bar.</td> |
|
236 </tr><tr> |
|
237 <td><a href="#MiniEditor.__setTabAndIndent">__setTabAndIndent</a></td> |
|
238 <td>Private method to set indentation size and style and tab width.</td> |
|
239 </tr><tr> |
|
240 <td><a href="#MiniEditor.__setTextDisplay">__setTextDisplay</a></td> |
|
241 <td>Private method to configure the text display.</td> |
|
242 </tr><tr> |
|
243 <td><a href="#MiniEditor.__showContextMenuLanguages">__showContextMenuLanguages</a></td> |
|
244 <td>Private slot handling the aboutToShow signal of the languages context menu.</td> |
|
245 </tr><tr> |
|
246 <td><a href="#MiniEditor.__strippedName">__strippedName</a></td> |
|
247 <td>Private method to return the filename part of the given path.</td> |
|
248 </tr><tr> |
|
249 <td><a href="#MiniEditor.__styleNeeded">__styleNeeded</a></td> |
|
250 <td>Private slot to handle the need for more styling.</td> |
|
251 </tr><tr> |
|
252 <td><a href="#MiniEditor.__undo">__undo</a></td> |
|
253 <td>Private method to undo the last recorded change.</td> |
|
254 </tr><tr> |
|
255 <td><a href="#MiniEditor.__whatsThis">__whatsThis</a></td> |
|
256 <td>Private slot called in to enter Whats This mode.</td> |
|
257 </tr><tr> |
|
258 <td><a href="#MiniEditor.__writeFile">__writeFile</a></td> |
|
259 <td>Private method to write the current editor text to a file.</td> |
|
260 </tr><tr> |
|
261 <td><a href="#MiniEditor.__writeSettings">__writeSettings</a></td> |
|
262 <td>Private method to write the settings for reuse.</td> |
|
263 </tr><tr> |
|
264 <td><a href="#MiniEditor.activeWindow">activeWindow</a></td> |
|
265 <td>Public method to fulfill the ViewManager interface.</td> |
|
266 </tr><tr> |
|
267 <td><a href="#MiniEditor.clearSearchIndicators">clearSearchIndicators</a></td> |
|
268 <td>Public method to clear all search indicators.</td> |
|
269 </tr><tr> |
|
270 <td><a href="#MiniEditor.closeEvent">closeEvent</a></td> |
|
271 <td>Protected method to handle the close event.</td> |
|
272 </tr><tr> |
|
273 <td><a href="#MiniEditor.getFileName">getFileName</a></td> |
|
274 <td>Public method to return the name of the file being displayed.</td> |
|
275 </tr><tr> |
|
276 <td><a href="#MiniEditor.getLanguage">getLanguage</a></td> |
|
277 <td>Public method to retrieve the language of the editor.</td> |
|
278 </tr><tr> |
|
279 <td><a href="#MiniEditor.getSRHistory">getSRHistory</a></td> |
|
280 <td>Public method to get the search or replace history list.</td> |
|
281 </tr><tr> |
|
282 <td><a href="#MiniEditor.gotoLine">gotoLine</a></td> |
|
283 <td>Public slot to jump to the beginning of a line.</td> |
|
284 </tr><tr> |
|
285 <td><a href="#MiniEditor.setLanguage">setLanguage</a></td> |
|
286 <td>Public method to set a lexer language.</td> |
|
287 </tr><tr> |
|
288 <td><a href="#MiniEditor.setSearchIndicator">setSearchIndicator</a></td> |
|
289 <td>Public method to set a search indicator for the given range.</td> |
|
290 </tr><tr> |
|
291 <td><a href="#MiniEditor.setText">setText</a></td> |
|
292 <td>Public method to set the text programatically.</td> |
|
293 </tr><tr> |
|
294 <td><a href="#MiniEditor.setWindowModified">setWindowModified</a></td> |
|
295 <td>Public method to set the window modification status.</td> |
|
296 </tr><tr> |
|
297 <td><a href="#MiniEditor.showReplaceWidget">showReplaceWidget</a></td> |
|
298 <td>Public method to show the replace widget.</td> |
|
299 </tr><tr> |
|
300 <td><a href="#MiniEditor.showSearchWidget">showSearchWidget</a></td> |
|
301 <td>Public method to show the search widget.</td> |
|
302 </tr><tr> |
|
303 <td><a href="#MiniEditor.textForFind">textForFind</a></td> |
|
304 <td>Public method to determine the selection or the current word for the next find operation.</td> |
|
305 </tr> |
|
306 </table> |
|
307 <h3>Static Methods</h3> |
|
308 <table> |
|
309 <tr><td>None</td></tr> |
|
310 </table> |
|
311 <a NAME="MiniEditor.__init__" ID="MiniEditor.__init__"></a> |
|
312 <h4>MiniEditor (Constructor)</h4> |
|
313 <b>MiniEditor</b>(<i>filename="", filetype="", parent=None, name=None</i>) |
|
314 <p> |
|
315 Constructor |
|
316 </p><dl> |
|
317 <dt><i>filename</i></dt> |
|
318 <dd> |
|
319 name of the file to open (string) |
|
320 </dd><dt><i>filetype</i></dt> |
|
321 <dd> |
|
322 type of the source file (string) |
|
323 </dd><dt><i>parent</i></dt> |
|
324 <dd> |
|
325 reference to the parent widget (QWidget) |
|
326 </dd><dt><i>name</i></dt> |
|
327 <dd> |
|
328 object name of the window (string) |
|
329 </dd> |
|
330 </dl><a NAME="MiniEditor.__about" ID="MiniEditor.__about"></a> |
|
331 <h4>MiniEditor.__about</h4> |
|
332 <b>__about</b>(<i></i>) |
|
333 <p> |
|
334 Private slot to show a little About message. |
|
335 </p><a NAME="MiniEditor.__aboutQt" ID="MiniEditor.__aboutQt"></a> |
|
336 <h4>MiniEditor.__aboutQt</h4> |
|
337 <b>__aboutQt</b>(<i></i>) |
|
338 <p> |
|
339 Private slot to handle the About Qt dialog. |
|
340 </p><a NAME="MiniEditor.__bindLexer" ID="MiniEditor.__bindLexer"></a> |
|
341 <h4>MiniEditor.__bindLexer</h4> |
|
342 <b>__bindLexer</b>(<i>filename, pyname=""</i>) |
|
343 <p> |
|
344 Private slot to set the correct lexer depending on language. |
|
345 </p><dl> |
|
346 <dt><i>filename</i></dt> |
|
347 <dd> |
|
348 filename used to determine the associated lexer |
|
349 language (string) |
|
350 </dd><dt><i>pyname=</i></dt> |
|
351 <dd> |
|
352 name of the pygments lexer to use (string) |
|
353 </dd> |
|
354 </dl><a NAME="MiniEditor.__bindName" ID="MiniEditor.__bindName"></a> |
|
355 <h4>MiniEditor.__bindName</h4> |
|
356 <b>__bindName</b>(<i>line0</i>) |
|
357 <p> |
|
358 Private method to generate a dummy filename for binding a lexer. |
|
359 </p><dl> |
|
360 <dt><i>line0</i></dt> |
|
361 <dd> |
|
362 first line of text to use in the generation process |
|
363 (string) |
|
364 </dd> |
|
365 </dl><dl> |
|
366 <dt>Returns:</dt> |
|
367 <dd> |
|
368 dummy file name to be used for binding a lexer (string) |
|
369 </dd> |
|
370 </dl><a NAME="MiniEditor.__checkActions" ID="MiniEditor.__checkActions"></a> |
|
371 <h4>MiniEditor.__checkActions</h4> |
|
372 <b>__checkActions</b>(<i>setSb=True</i>) |
|
373 <p> |
|
374 Private slot to check some actions for their enable/disable status |
|
375 and set the statusbar info. |
|
376 </p><dl> |
|
377 <dt><i>setSb</i></dt> |
|
378 <dd> |
|
379 flag indicating an update of the status bar is wanted |
|
380 (boolean) |
|
381 </dd> |
|
382 </dl><a NAME="MiniEditor.__checkLanguage" ID="MiniEditor.__checkLanguage"></a> |
|
383 <h4>MiniEditor.__checkLanguage</h4> |
|
384 <b>__checkLanguage</b>(<i></i>) |
|
385 <p> |
|
386 Private method to check the selected language of the language submenu. |
|
387 </p><a NAME="MiniEditor.__contextMenuRequested" ID="MiniEditor.__contextMenuRequested"></a> |
|
388 <h4>MiniEditor.__contextMenuRequested</h4> |
|
389 <b>__contextMenuRequested</b>(<i>coord</i>) |
|
390 <p> |
|
391 Private slot to show the context menu. |
|
392 </p><dl> |
|
393 <dt><i>coord</i></dt> |
|
394 <dd> |
|
395 the position of the mouse pointer (QPoint) |
|
396 </dd> |
|
397 </dl><a NAME="MiniEditor.__createActions" ID="MiniEditor.__createActions"></a> |
|
398 <h4>MiniEditor.__createActions</h4> |
|
399 <b>__createActions</b>(<i></i>) |
|
400 <p> |
|
401 Private method to create the actions. |
|
402 </p><a NAME="MiniEditor.__createEditActions" ID="MiniEditor.__createEditActions"></a> |
|
403 <h4>MiniEditor.__createEditActions</h4> |
|
404 <b>__createEditActions</b>(<i></i>) |
|
405 <p> |
|
406 Private method to create the Edit actions. |
|
407 </p><a NAME="MiniEditor.__createFileActions" ID="MiniEditor.__createFileActions"></a> |
|
408 <h4>MiniEditor.__createFileActions</h4> |
|
409 <b>__createFileActions</b>(<i></i>) |
|
410 <p> |
|
411 Private method to create the File actions. |
|
412 </p><a NAME="MiniEditor.__createHelpActions" ID="MiniEditor.__createHelpActions"></a> |
|
413 <h4>MiniEditor.__createHelpActions</h4> |
|
414 <b>__createHelpActions</b>(<i></i>) |
|
415 <p> |
|
416 Private method to create the Help actions. |
|
417 </p><a NAME="MiniEditor.__createMenus" ID="MiniEditor.__createMenus"></a> |
|
418 <h4>MiniEditor.__createMenus</h4> |
|
419 <b>__createMenus</b>(<i></i>) |
|
420 <p> |
|
421 Private method to create the menus of the menu bar. |
|
422 </p><a NAME="MiniEditor.__createSearchActions" ID="MiniEditor.__createSearchActions"></a> |
|
423 <h4>MiniEditor.__createSearchActions</h4> |
|
424 <b>__createSearchActions</b>(<i></i>) |
|
425 <p> |
|
426 Private method defining the user interface actions for the search |
|
427 commands. |
|
428 </p><a NAME="MiniEditor.__createStatusBar" ID="MiniEditor.__createStatusBar"></a> |
|
429 <h4>MiniEditor.__createStatusBar</h4> |
|
430 <b>__createStatusBar</b>(<i></i>) |
|
431 <p> |
|
432 Private method to initialize the status bar. |
|
433 </p><a NAME="MiniEditor.__createToolBars" ID="MiniEditor.__createToolBars"></a> |
|
434 <h4>MiniEditor.__createToolBars</h4> |
|
435 <b>__createToolBars</b>(<i></i>) |
|
436 <p> |
|
437 Private method to create the various toolbars. |
|
438 </p><a NAME="MiniEditor.__cursorPositionChanged" ID="MiniEditor.__cursorPositionChanged"></a> |
|
439 <h4>MiniEditor.__cursorPositionChanged</h4> |
|
440 <b>__cursorPositionChanged</b>(<i>line, pos</i>) |
|
441 <p> |
|
442 Private slot to handle the cursorPositionChanged signal. |
|
443 </p><dl> |
|
444 <dt><i>line</i></dt> |
|
445 <dd> |
|
446 line number of the cursor |
|
447 </dd><dt><i>pos</i></dt> |
|
448 <dd> |
|
449 position in line of the cursor |
|
450 </dd> |
|
451 </dl><a NAME="MiniEditor.__deselectAll" ID="MiniEditor.__deselectAll"></a> |
|
452 <h4>MiniEditor.__deselectAll</h4> |
|
453 <b>__deselectAll</b>(<i></i>) |
|
454 <p> |
|
455 Private slot handling the deselect all context menu action. |
|
456 </p><a NAME="MiniEditor.__documentWasModified" ID="MiniEditor.__documentWasModified"></a> |
|
457 <h4>MiniEditor.__documentWasModified</h4> |
|
458 <b>__documentWasModified</b>(<i></i>) |
|
459 <p> |
|
460 Private slot to handle a change in the documents modification status. |
|
461 </p><a NAME="MiniEditor.__getCurrentWord" ID="MiniEditor.__getCurrentWord"></a> |
|
462 <h4>MiniEditor.__getCurrentWord</h4> |
|
463 <b>__getCurrentWord</b>(<i></i>) |
|
464 <p> |
|
465 Private method to get the word at the current position. |
|
466 </p><dl> |
|
467 <dt>Returns:</dt> |
|
468 <dd> |
|
469 the word at that current position |
|
470 </dd> |
|
471 </dl><a NAME="MiniEditor.__getEditorConfig" ID="MiniEditor.__getEditorConfig"></a> |
|
472 <h4>MiniEditor.__getEditorConfig</h4> |
|
473 <b>__getEditorConfig</b>(<i>option, nodefault=False, config=None</i>) |
|
474 <p> |
|
475 Private method to get the requested option via EditorConfig. |
|
476 </p><p> |
|
477 If there is no EditorConfig defined, the equivalent built-in option |
|
478 will be used (Preferences.getEditor(). The option must be given as the |
|
479 Preferences option key. The mapping to the EditorConfig option name |
|
480 will be done within this method. |
|
481 </p><dl> |
|
482 <dt><i>option</i> (str)</dt> |
|
483 <dd> |
|
484 Preferences option key |
|
485 </dd><dt><i>nodefault</i> (bool)</dt> |
|
486 <dd> |
|
487 flag indicating to not get the default value from |
|
488 Preferences but return None instead |
|
489 </dd><dt><i>config</i> (dict)</dt> |
|
490 <dd> |
|
491 reference to an EditorConfig object or None |
|
492 </dd> |
|
493 </dl><dl> |
|
494 <dt>Returns:</dt> |
|
495 <dd> |
|
496 value of requested setting or None if nothing was found and |
|
497 nodefault parameter was True |
|
498 </dd> |
|
499 </dl><dl> |
|
500 <dt>Return Type:</dt> |
|
501 <dd> |
|
502 any |
|
503 </dd> |
|
504 </dl><a NAME="MiniEditor.__getWord" ID="MiniEditor.__getWord"></a> |
|
505 <h4>MiniEditor.__getWord</h4> |
|
506 <b>__getWord</b>(<i>line, index</i>) |
|
507 <p> |
|
508 Private method to get the word at a position. |
|
509 </p><dl> |
|
510 <dt><i>line</i></dt> |
|
511 <dd> |
|
512 number of line to look at (int) |
|
513 </dd><dt><i>index</i></dt> |
|
514 <dd> |
|
515 position to look at (int) |
|
516 </dd> |
|
517 </dl><dl> |
|
518 <dt>Returns:</dt> |
|
519 <dd> |
|
520 the word at that position (string) |
|
521 </dd> |
|
522 </dl><a NAME="MiniEditor.__initContextMenu" ID="MiniEditor.__initContextMenu"></a> |
|
523 <h4>MiniEditor.__initContextMenu</h4> |
|
524 <b>__initContextMenu</b>(<i></i>) |
|
525 <p> |
|
526 Private method used to setup the context menu. |
|
527 </p><a NAME="MiniEditor.__initContextMenuLanguages" ID="MiniEditor.__initContextMenuLanguages"></a> |
|
528 <h4>MiniEditor.__initContextMenuLanguages</h4> |
|
529 <b>__initContextMenuLanguages</b>(<i></i>) |
|
530 <p> |
|
531 Private method used to setup the Languages context sub menu. |
|
532 </p><dl> |
|
533 <dt>Returns:</dt> |
|
534 <dd> |
|
535 reference to the generated menu (QMenu) |
|
536 </dd> |
|
537 </dl><a NAME="MiniEditor.__isPy2File" ID="MiniEditor.__isPy2File"></a> |
|
538 <h4>MiniEditor.__isPy2File</h4> |
|
539 <b>__isPy2File</b>(<i></i>) |
|
540 <p> |
|
541 Private method to return a flag indicating a Python 2 file. |
|
542 </p><dl> |
|
543 <dt>Returns:</dt> |
|
544 <dd> |
|
545 flag indicating a Python 2 file (boolean) |
|
546 </dd> |
|
547 </dl><a NAME="MiniEditor.__languageMenuTriggered" ID="MiniEditor.__languageMenuTriggered"></a> |
|
548 <h4>MiniEditor.__languageMenuTriggered</h4> |
|
549 <b>__languageMenuTriggered</b>(<i>act</i>) |
|
550 <p> |
|
551 Private method to handle the selection of a lexer language. |
|
552 </p><dl> |
|
553 <dt><i>act</i></dt> |
|
554 <dd> |
|
555 reference to the action that was triggered (QAction) |
|
556 </dd> |
|
557 </dl><a NAME="MiniEditor.__loadEditorConfig" ID="MiniEditor.__loadEditorConfig"></a> |
|
558 <h4>MiniEditor.__loadEditorConfig</h4> |
|
559 <b>__loadEditorConfig</b>(<i>fileName=""</i>) |
|
560 <p> |
|
561 Private method to load the EditorConfig properties. |
|
562 </p><dl> |
|
563 <dt><i>fileName</i> (str)</dt> |
|
564 <dd> |
|
565 name of the file |
|
566 </dd> |
|
567 </dl><a NAME="MiniEditor.__loadEditorConfigObject" ID="MiniEditor.__loadEditorConfigObject"></a> |
|
568 <h4>MiniEditor.__loadEditorConfigObject</h4> |
|
569 <b>__loadEditorConfigObject</b>(<i>fileName</i>) |
|
570 <p> |
|
571 Private method to load the EditorConfig properties for the given |
|
572 file name. |
|
573 </p><dl> |
|
574 <dt><i>fileName</i> (str)</dt> |
|
575 <dd> |
|
576 name of the file |
|
577 </dd> |
|
578 </dl><dl> |
|
579 <dt>Returns:</dt> |
|
580 <dd> |
|
581 EditorConfig dictionary |
|
582 </dd> |
|
583 </dl><dl> |
|
584 <dt>Return Type:</dt> |
|
585 <dd> |
|
586 dict |
|
587 </dd> |
|
588 </dl><a NAME="MiniEditor.__loadFile" ID="MiniEditor.__loadFile"></a> |
|
589 <h4>MiniEditor.__loadFile</h4> |
|
590 <b>__loadFile</b>(<i>fileName, filetype=None</i>) |
|
591 <p> |
|
592 Private method to load the given file. |
|
593 </p><dl> |
|
594 <dt><i>fileName</i></dt> |
|
595 <dd> |
|
596 name of the file to load (string) |
|
597 </dd><dt><i>filetype</i></dt> |
|
598 <dd> |
|
599 type of the source file (string) |
|
600 </dd> |
|
601 </dl><a NAME="MiniEditor.__markOccurrences" ID="MiniEditor.__markOccurrences"></a> |
|
602 <h4>MiniEditor.__markOccurrences</h4> |
|
603 <b>__markOccurrences</b>(<i></i>) |
|
604 <p> |
|
605 Private method to mark all occurrences of the current word. |
|
606 </p><a NAME="MiniEditor.__maybeSave" ID="MiniEditor.__maybeSave"></a> |
|
607 <h4>MiniEditor.__maybeSave</h4> |
|
608 <b>__maybeSave</b>(<i></i>) |
|
609 <p> |
|
610 Private method to ask the user to save the file, if it was modified. |
|
611 </p><dl> |
|
612 <dt>Returns:</dt> |
|
613 <dd> |
|
614 flag indicating, if it is ok to continue (boolean) |
|
615 </dd> |
|
616 </dl><a NAME="MiniEditor.__modificationChanged" ID="MiniEditor.__modificationChanged"></a> |
|
617 <h4>MiniEditor.__modificationChanged</h4> |
|
618 <b>__modificationChanged</b>(<i>m</i>) |
|
619 <p> |
|
620 Private slot to handle the modificationChanged signal. |
|
621 </p><dl> |
|
622 <dt><i>m</i></dt> |
|
623 <dd> |
|
624 modification status |
|
625 </dd> |
|
626 </dl><a NAME="MiniEditor.__newFile" ID="MiniEditor.__newFile"></a> |
|
627 <h4>MiniEditor.__newFile</h4> |
|
628 <b>__newFile</b>(<i></i>) |
|
629 <p> |
|
630 Private slot to create a new file. |
|
631 </p><a NAME="MiniEditor.__open" ID="MiniEditor.__open"></a> |
|
632 <h4>MiniEditor.__open</h4> |
|
633 <b>__open</b>(<i></i>) |
|
634 <p> |
|
635 Private slot to open a file. |
|
636 </p><a NAME="MiniEditor.__printFile" ID="MiniEditor.__printFile"></a> |
|
637 <h4>MiniEditor.__printFile</h4> |
|
638 <b>__printFile</b>(<i></i>) |
|
639 <p> |
|
640 Private slot to print the text. |
|
641 </p><a NAME="MiniEditor.__printPreview" ID="MiniEditor.__printPreview"></a> |
|
642 <h4>MiniEditor.__printPreview</h4> |
|
643 <b>__printPreview</b>(<i>printer</i>) |
|
644 <p> |
|
645 Private slot to generate a print preview. |
|
646 </p><dl> |
|
647 <dt><i>printer</i></dt> |
|
648 <dd> |
|
649 reference to the printer object |
|
650 (QScintilla.Printer.Printer) |
|
651 </dd> |
|
652 </dl><a NAME="MiniEditor.__printPreviewFile" ID="MiniEditor.__printPreviewFile"></a> |
|
653 <h4>MiniEditor.__printPreviewFile</h4> |
|
654 <b>__printPreviewFile</b>(<i></i>) |
|
655 <p> |
|
656 Private slot to show a print preview of the text. |
|
657 </p><a NAME="MiniEditor.__readSettings" ID="MiniEditor.__readSettings"></a> |
|
658 <h4>MiniEditor.__readSettings</h4> |
|
659 <b>__readSettings</b>(<i></i>) |
|
660 <p> |
|
661 Private method to read the settings remembered last time. |
|
662 </p><a NAME="MiniEditor.__readShortcut" ID="MiniEditor.__readShortcut"></a> |
|
663 <h4>MiniEditor.__readShortcut</h4> |
|
664 <b>__readShortcut</b>(<i>act, category</i>) |
|
665 <p> |
|
666 Private function to read a single keyboard shortcut from the settings. |
|
667 </p><dl> |
|
668 <dt><i>act</i></dt> |
|
669 <dd> |
|
670 reference to the action object (E5Action) |
|
671 </dd><dt><i>category</i></dt> |
|
672 <dd> |
|
673 category the action belongs to (string) |
|
674 </dd> |
|
675 </dl><a NAME="MiniEditor.__redo" ID="MiniEditor.__redo"></a> |
|
676 <h4>MiniEditor.__redo</h4> |
|
677 <b>__redo</b>(<i></i>) |
|
678 <p> |
|
679 Private method to redo the last recorded change. |
|
680 </p><a NAME="MiniEditor.__resetLanguage" ID="MiniEditor.__resetLanguage"></a> |
|
681 <h4>MiniEditor.__resetLanguage</h4> |
|
682 <b>__resetLanguage</b>(<i></i>) |
|
683 <p> |
|
684 Private method used to reset the language selection. |
|
685 </p><a NAME="MiniEditor.__resizeLinenoMargin" ID="MiniEditor.__resizeLinenoMargin"></a> |
|
686 <h4>MiniEditor.__resizeLinenoMargin</h4> |
|
687 <b>__resizeLinenoMargin</b>(<i></i>) |
|
688 <p> |
|
689 Private slot to resize the line numbers margin. |
|
690 </p><a NAME="MiniEditor.__save" ID="MiniEditor.__save"></a> |
|
691 <h4>MiniEditor.__save</h4> |
|
692 <b>__save</b>(<i></i>) |
|
693 <p> |
|
694 Private slot to save a file. |
|
695 </p><dl> |
|
696 <dt>Returns:</dt> |
|
697 <dd> |
|
698 flag indicating success (boolean) |
|
699 </dd> |
|
700 </dl><a NAME="MiniEditor.__saveAs" ID="MiniEditor.__saveAs"></a> |
|
701 <h4>MiniEditor.__saveAs</h4> |
|
702 <b>__saveAs</b>(<i></i>) |
|
703 <p> |
|
704 Private slot to save a file with a new name. |
|
705 </p><dl> |
|
706 <dt>Returns:</dt> |
|
707 <dd> |
|
708 flag indicating success (boolean) |
|
709 </dd> |
|
710 </dl><a NAME="MiniEditor.__saveCopy" ID="MiniEditor.__saveCopy"></a> |
|
711 <h4>MiniEditor.__saveCopy</h4> |
|
712 <b>__saveCopy</b>(<i></i>) |
|
713 <p> |
|
714 Private slot to save a copy of the file with a new name. |
|
715 </p><a NAME="MiniEditor.__saveFile" ID="MiniEditor.__saveFile"></a> |
|
716 <h4>MiniEditor.__saveFile</h4> |
|
717 <b>__saveFile</b>(<i>fileName</i>) |
|
718 <p> |
|
719 Private method to save to the given file. |
|
720 </p><dl> |
|
721 <dt><i>fileName</i> (str)</dt> |
|
722 <dd> |
|
723 name of the file to save to |
|
724 </dd> |
|
725 </dl><dl> |
|
726 <dt>Returns:</dt> |
|
727 <dd> |
|
728 flag indicating success |
|
729 </dd> |
|
730 </dl><dl> |
|
731 <dt>Return Type:</dt> |
|
732 <dd> |
|
733 bool |
|
734 </dd> |
|
735 </dl><a NAME="MiniEditor.__searchClearMarkers" ID="MiniEditor.__searchClearMarkers"></a> |
|
736 <h4>MiniEditor.__searchClearMarkers</h4> |
|
737 <b>__searchClearMarkers</b>(<i></i>) |
|
738 <p> |
|
739 Private method to clear the search markers of the active window. |
|
740 </p><a NAME="MiniEditor.__searchNext" ID="MiniEditor.__searchNext"></a> |
|
741 <h4>MiniEditor.__searchNext</h4> |
|
742 <b>__searchNext</b>(<i></i>) |
|
743 <p> |
|
744 Private slot to handle the search next action. |
|
745 </p><a NAME="MiniEditor.__searchPrev" ID="MiniEditor.__searchPrev"></a> |
|
746 <h4>MiniEditor.__searchPrev</h4> |
|
747 <b>__searchPrev</b>(<i></i>) |
|
748 <p> |
|
749 Private slot to handle the search previous action. |
|
750 </p><a NAME="MiniEditor.__selectAll" ID="MiniEditor.__selectAll"></a> |
|
751 <h4>MiniEditor.__selectAll</h4> |
|
752 <b>__selectAll</b>(<i></i>) |
|
753 <p> |
|
754 Private slot handling the select all context menu action. |
|
755 </p><a NAME="MiniEditor.__selectPygmentsLexer" ID="MiniEditor.__selectPygmentsLexer"></a> |
|
756 <h4>MiniEditor.__selectPygmentsLexer</h4> |
|
757 <b>__selectPygmentsLexer</b>(<i></i>) |
|
758 <p> |
|
759 Private method to select a specific pygments lexer. |
|
760 </p><dl> |
|
761 <dt>Returns:</dt> |
|
762 <dd> |
|
763 name of the selected pygments lexer (string) |
|
764 </dd> |
|
765 </dl><a NAME="MiniEditor.__setCurrentFile" ID="MiniEditor.__setCurrentFile"></a> |
|
766 <h4>MiniEditor.__setCurrentFile</h4> |
|
767 <b>__setCurrentFile</b>(<i>fileName</i>) |
|
768 <p> |
|
769 Private method to register the file name of the current file. |
|
770 </p><dl> |
|
771 <dt><i>fileName</i></dt> |
|
772 <dd> |
|
773 name of the file to register (string) |
|
774 </dd> |
|
775 </dl><a NAME="MiniEditor.__setEolMode" ID="MiniEditor.__setEolMode"></a> |
|
776 <h4>MiniEditor.__setEolMode</h4> |
|
777 <b>__setEolMode</b>(<i></i>) |
|
778 <p> |
|
779 Private method to configure the eol mode of the editor. |
|
780 </p><a NAME="MiniEditor.__setMargins" ID="MiniEditor.__setMargins"></a> |
|
781 <h4>MiniEditor.__setMargins</h4> |
|
782 <b>__setMargins</b>(<i></i>) |
|
783 <p> |
|
784 Private method to configure the margins. |
|
785 </p><a NAME="MiniEditor.__setMonospaced" ID="MiniEditor.__setMonospaced"></a> |
|
786 <h4>MiniEditor.__setMonospaced</h4> |
|
787 <b>__setMonospaced</b>(<i>on</i>) |
|
788 <p> |
|
789 Private method to set/reset a monospaced font. |
|
790 </p><dl> |
|
791 <dt><i>on</i></dt> |
|
792 <dd> |
|
793 flag to indicate usage of a monospace font (boolean) |
|
794 </dd> |
|
795 </dl><a NAME="MiniEditor.__setSbFile" ID="MiniEditor.__setSbFile"></a> |
|
796 <h4>MiniEditor.__setSbFile</h4> |
|
797 <b>__setSbFile</b>(<i>line=None, pos=None</i>) |
|
798 <p> |
|
799 Private method to set the file info in the status bar. |
|
800 </p><dl> |
|
801 <dt><i>line</i></dt> |
|
802 <dd> |
|
803 line number to display (int) |
|
804 </dd><dt><i>pos</i></dt> |
|
805 <dd> |
|
806 character position to display (int) |
|
807 </dd> |
|
808 </dl><a NAME="MiniEditor.__setTabAndIndent" ID="MiniEditor.__setTabAndIndent"></a> |
|
809 <h4>MiniEditor.__setTabAndIndent</h4> |
|
810 <b>__setTabAndIndent</b>(<i></i>) |
|
811 <p> |
|
812 Private method to set indentation size and style and tab width. |
|
813 </p><a NAME="MiniEditor.__setTextDisplay" ID="MiniEditor.__setTextDisplay"></a> |
|
814 <h4>MiniEditor.__setTextDisplay</h4> |
|
815 <b>__setTextDisplay</b>(<i></i>) |
|
816 <p> |
|
817 Private method to configure the text display. |
|
818 </p><a NAME="MiniEditor.__showContextMenuLanguages" ID="MiniEditor.__showContextMenuLanguages"></a> |
|
819 <h4>MiniEditor.__showContextMenuLanguages</h4> |
|
820 <b>__showContextMenuLanguages</b>(<i></i>) |
|
821 <p> |
|
822 Private slot handling the aboutToShow signal of the languages context |
|
823 menu. |
|
824 </p><a NAME="MiniEditor.__strippedName" ID="MiniEditor.__strippedName"></a> |
|
825 <h4>MiniEditor.__strippedName</h4> |
|
826 <b>__strippedName</b>(<i>fullFileName</i>) |
|
827 <p> |
|
828 Private method to return the filename part of the given path. |
|
829 </p><dl> |
|
830 <dt><i>fullFileName</i></dt> |
|
831 <dd> |
|
832 full pathname of the given file (string) |
|
833 </dd> |
|
834 </dl><dl> |
|
835 <dt>Returns:</dt> |
|
836 <dd> |
|
837 filename part (string) |
|
838 </dd> |
|
839 </dl><a NAME="MiniEditor.__styleNeeded" ID="MiniEditor.__styleNeeded"></a> |
|
840 <h4>MiniEditor.__styleNeeded</h4> |
|
841 <b>__styleNeeded</b>(<i>position</i>) |
|
842 <p> |
|
843 Private slot to handle the need for more styling. |
|
844 </p><dl> |
|
845 <dt><i>position</i></dt> |
|
846 <dd> |
|
847 end position, that needs styling (integer) |
|
848 </dd> |
|
849 </dl><a NAME="MiniEditor.__undo" ID="MiniEditor.__undo"></a> |
|
850 <h4>MiniEditor.__undo</h4> |
|
851 <b>__undo</b>(<i></i>) |
|
852 <p> |
|
853 Private method to undo the last recorded change. |
|
854 </p><a NAME="MiniEditor.__whatsThis" ID="MiniEditor.__whatsThis"></a> |
|
855 <h4>MiniEditor.__whatsThis</h4> |
|
856 <b>__whatsThis</b>(<i></i>) |
|
857 <p> |
|
858 Private slot called in to enter Whats This mode. |
|
859 </p><a NAME="MiniEditor.__writeFile" ID="MiniEditor.__writeFile"></a> |
|
860 <h4>MiniEditor.__writeFile</h4> |
|
861 <b>__writeFile</b>(<i>fileName</i>) |
|
862 <p> |
|
863 Private method to write the current editor text to a file. |
|
864 </p><dl> |
|
865 <dt><i>fileName</i> (str)</dt> |
|
866 <dd> |
|
867 name of the file to be written to |
|
868 </dd> |
|
869 </dl><dl> |
|
870 <dt>Returns:</dt> |
|
871 <dd> |
|
872 flag indicating success |
|
873 </dd> |
|
874 </dl><dl> |
|
875 <dt>Return Type:</dt> |
|
876 <dd> |
|
877 bool |
|
878 </dd> |
|
879 </dl><a NAME="MiniEditor.__writeSettings" ID="MiniEditor.__writeSettings"></a> |
|
880 <h4>MiniEditor.__writeSettings</h4> |
|
881 <b>__writeSettings</b>(<i></i>) |
|
882 <p> |
|
883 Private method to write the settings for reuse. |
|
884 </p><a NAME="MiniEditor.activeWindow" ID="MiniEditor.activeWindow"></a> |
|
885 <h4>MiniEditor.activeWindow</h4> |
|
886 <b>activeWindow</b>(<i></i>) |
|
887 <p> |
|
888 Public method to fulfill the ViewManager interface. |
|
889 </p><dl> |
|
890 <dt>Returns:</dt> |
|
891 <dd> |
|
892 reference to the text edit component (QsciScintillaCompat) |
|
893 </dd> |
|
894 </dl><a NAME="MiniEditor.clearSearchIndicators" ID="MiniEditor.clearSearchIndicators"></a> |
|
895 <h4>MiniEditor.clearSearchIndicators</h4> |
|
896 <b>clearSearchIndicators</b>(<i></i>) |
|
897 <p> |
|
898 Public method to clear all search indicators. |
|
899 </p><a NAME="MiniEditor.closeEvent" ID="MiniEditor.closeEvent"></a> |
|
900 <h4>MiniEditor.closeEvent</h4> |
|
901 <b>closeEvent</b>(<i>event</i>) |
|
902 <p> |
|
903 Protected method to handle the close event. |
|
904 </p><dl> |
|
905 <dt><i>event</i></dt> |
|
906 <dd> |
|
907 close event (QCloseEvent) |
|
908 </dd> |
|
909 </dl><a NAME="MiniEditor.getFileName" ID="MiniEditor.getFileName"></a> |
|
910 <h4>MiniEditor.getFileName</h4> |
|
911 <b>getFileName</b>(<i></i>) |
|
912 <p> |
|
913 Public method to return the name of the file being displayed. |
|
914 </p><dl> |
|
915 <dt>Returns:</dt> |
|
916 <dd> |
|
917 filename of the displayed file (string) |
|
918 </dd> |
|
919 </dl><a NAME="MiniEditor.getLanguage" ID="MiniEditor.getLanguage"></a> |
|
920 <h4>MiniEditor.getLanguage</h4> |
|
921 <b>getLanguage</b>(<i></i>) |
|
922 <p> |
|
923 Public method to retrieve the language of the editor. |
|
924 </p><dl> |
|
925 <dt>Returns:</dt> |
|
926 <dd> |
|
927 language of the editor (string) |
|
928 </dd> |
|
929 </dl><a NAME="MiniEditor.getSRHistory" ID="MiniEditor.getSRHistory"></a> |
|
930 <h4>MiniEditor.getSRHistory</h4> |
|
931 <b>getSRHistory</b>(<i>key</i>) |
|
932 <p> |
|
933 Public method to get the search or replace history list. |
|
934 </p><dl> |
|
935 <dt><i>key</i></dt> |
|
936 <dd> |
|
937 list to return (must be 'search' or 'replace') |
|
938 </dd> |
|
939 </dl><dl> |
|
940 <dt>Returns:</dt> |
|
941 <dd> |
|
942 the requested history list (list of strings) |
|
943 </dd> |
|
944 </dl><a NAME="MiniEditor.gotoLine" ID="MiniEditor.gotoLine"></a> |
|
945 <h4>MiniEditor.gotoLine</h4> |
|
946 <b>gotoLine</b>(<i>line, pos=1</i>) |
|
947 <p> |
|
948 Public slot to jump to the beginning of a line. |
|
949 </p><dl> |
|
950 <dt><i>line</i> (int)</dt> |
|
951 <dd> |
|
952 line number to go to |
|
953 </dd><dt><i>pos=</i> (int)</dt> |
|
954 <dd> |
|
955 position in line to go to |
|
956 </dd> |
|
957 </dl><a NAME="MiniEditor.setLanguage" ID="MiniEditor.setLanguage"></a> |
|
958 <h4>MiniEditor.setLanguage</h4> |
|
959 <b>setLanguage</b>(<i>filename, initTextDisplay=True, pyname=""</i>) |
|
960 <p> |
|
961 Public method to set a lexer language. |
|
962 </p><dl> |
|
963 <dt><i>filename</i></dt> |
|
964 <dd> |
|
965 filename used to determine the associated lexer |
|
966 language (string) |
|
967 </dd><dt><i>initTextDisplay</i></dt> |
|
968 <dd> |
|
969 flag indicating an initialization of the text |
|
970 display is required as well (boolean) |
|
971 </dd><dt><i>pyname=</i></dt> |
|
972 <dd> |
|
973 name of the pygments lexer to use (string) |
|
974 </dd> |
|
975 </dl><a NAME="MiniEditor.setSearchIndicator" ID="MiniEditor.setSearchIndicator"></a> |
|
976 <h4>MiniEditor.setSearchIndicator</h4> |
|
977 <b>setSearchIndicator</b>(<i>startPos, indicLength</i>) |
|
978 <p> |
|
979 Public method to set a search indicator for the given range. |
|
980 </p><dl> |
|
981 <dt><i>startPos</i></dt> |
|
982 <dd> |
|
983 start position of the indicator (integer) |
|
984 </dd><dt><i>indicLength</i></dt> |
|
985 <dd> |
|
986 length of the indicator (integer) |
|
987 </dd> |
|
988 </dl><a NAME="MiniEditor.setText" ID="MiniEditor.setText"></a> |
|
989 <h4>MiniEditor.setText</h4> |
|
990 <b>setText</b>(<i>txt, filetype=None</i>) |
|
991 <p> |
|
992 Public method to set the text programatically. |
|
993 </p><dl> |
|
994 <dt><i>txt</i></dt> |
|
995 <dd> |
|
996 text to be set (string) |
|
997 </dd><dt><i>filetype</i></dt> |
|
998 <dd> |
|
999 type of the source file (string) |
|
1000 </dd> |
|
1001 </dl><a NAME="MiniEditor.setWindowModified" ID="MiniEditor.setWindowModified"></a> |
|
1002 <h4>MiniEditor.setWindowModified</h4> |
|
1003 <b>setWindowModified</b>(<i>modified</i>) |
|
1004 <p> |
|
1005 Public method to set the window modification status. |
|
1006 </p><dl> |
|
1007 <dt><i>modified</i> (bool)</dt> |
|
1008 <dd> |
|
1009 flag indicating the modification status |
|
1010 </dd> |
|
1011 </dl><a NAME="MiniEditor.showReplaceWidget" ID="MiniEditor.showReplaceWidget"></a> |
|
1012 <h4>MiniEditor.showReplaceWidget</h4> |
|
1013 <b>showReplaceWidget</b>(<i></i>) |
|
1014 <p> |
|
1015 Public method to show the replace widget. |
|
1016 </p><a NAME="MiniEditor.showSearchWidget" ID="MiniEditor.showSearchWidget"></a> |
|
1017 <h4>MiniEditor.showSearchWidget</h4> |
|
1018 <b>showSearchWidget</b>(<i></i>) |
|
1019 <p> |
|
1020 Public method to show the search widget. |
|
1021 </p><a NAME="MiniEditor.textForFind" ID="MiniEditor.textForFind"></a> |
|
1022 <h4>MiniEditor.textForFind</h4> |
|
1023 <b>textForFind</b>(<i></i>) |
|
1024 <p> |
|
1025 Public method to determine the selection or the current word for the |
|
1026 next find operation. |
|
1027 </p><dl> |
|
1028 <dt>Returns:</dt> |
|
1029 <dd> |
|
1030 selection or current word (string) |
|
1031 </dd> |
|
1032 </dl> |
|
1033 <div align="right"><a href="#top">Up</a></div> |
|
1034 <hr /><hr /> |
|
1035 <a NAME="MiniScintilla" ID="MiniScintilla"></a> |
|
1036 <h2>MiniScintilla</h2> |
|
1037 <p> |
|
1038 Class implementing a QsciScintillaCompat subclass for handling focus |
|
1039 events. |
|
1040 </p> |
|
1041 <h3>Derived from</h3> |
|
1042 QsciScintillaCompat |
|
1043 <h3>Class Attributes</h3> |
|
1044 <table> |
|
1045 <tr><td>None</td></tr> |
|
1046 </table> |
|
1047 <h3>Class Methods</h3> |
|
1048 <table> |
|
1049 <tr><td>None</td></tr> |
|
1050 </table> |
|
1051 <h3>Methods</h3> |
|
1052 <table> |
|
1053 <tr> |
|
1054 <td><a href="#MiniScintilla.__init__">MiniScintilla</a></td> |
|
1055 <td>Constructor</td> |
|
1056 </tr><tr> |
|
1057 <td><a href="#MiniScintilla.focusInEvent">focusInEvent</a></td> |
|
1058 <td>Protected method called when the editor receives focus.</td> |
|
1059 </tr><tr> |
|
1060 <td><a href="#MiniScintilla.focusOutEvent">focusOutEvent</a></td> |
|
1061 <td>Protected method called when the editor loses focus.</td> |
|
1062 </tr><tr> |
|
1063 <td><a href="#MiniScintilla.getFileName">getFileName</a></td> |
|
1064 <td>Public method to return the name of the file being displayed.</td> |
|
1065 </tr><tr> |
|
1066 <td><a href="#MiniScintilla.removeTrailingWhitespace">removeTrailingWhitespace</a></td> |
|
1067 <td>Public method to remove trailing whitespace.</td> |
|
1068 </tr> |
|
1069 </table> |
|
1070 <h3>Static Methods</h3> |
|
1071 <table> |
|
1072 <tr><td>None</td></tr> |
|
1073 </table> |
|
1074 <a NAME="MiniScintilla.__init__" ID="MiniScintilla.__init__"></a> |
|
1075 <h4>MiniScintilla (Constructor)</h4> |
|
1076 <b>MiniScintilla</b>(<i>parent=None</i>) |
|
1077 <p> |
|
1078 Constructor |
|
1079 </p><dl> |
|
1080 <dt><i>parent</i></dt> |
|
1081 <dd> |
|
1082 parent widget (QWidget) |
|
1083 </dd> |
|
1084 </dl><a NAME="MiniScintilla.focusInEvent" ID="MiniScintilla.focusInEvent"></a> |
|
1085 <h4>MiniScintilla.focusInEvent</h4> |
|
1086 <b>focusInEvent</b>(<i>event</i>) |
|
1087 <p> |
|
1088 Protected method called when the editor receives focus. |
|
1089 </p><p> |
|
1090 This method checks for modifications of the current file and |
|
1091 rereads it upon request. The cursor is placed at the current position |
|
1092 assuming, that it is in the vicinity of the old position after the |
|
1093 reread. |
|
1094 </p><dl> |
|
1095 <dt><i>event</i></dt> |
|
1096 <dd> |
|
1097 the event object (QFocusEvent) |
|
1098 </dd> |
|
1099 </dl><a NAME="MiniScintilla.focusOutEvent" ID="MiniScintilla.focusOutEvent"></a> |
|
1100 <h4>MiniScintilla.focusOutEvent</h4> |
|
1101 <b>focusOutEvent</b>(<i>event</i>) |
|
1102 <p> |
|
1103 Protected method called when the editor loses focus. |
|
1104 </p><dl> |
|
1105 <dt><i>event</i></dt> |
|
1106 <dd> |
|
1107 the event object (QFocusEvent) |
|
1108 </dd> |
|
1109 </dl><a NAME="MiniScintilla.getFileName" ID="MiniScintilla.getFileName"></a> |
|
1110 <h4>MiniScintilla.getFileName</h4> |
|
1111 <b>getFileName</b>(<i></i>) |
|
1112 <p> |
|
1113 Public method to return the name of the file being displayed. |
|
1114 </p><dl> |
|
1115 <dt>Returns:</dt> |
|
1116 <dd> |
|
1117 filename of the displayed file (string) |
|
1118 </dd> |
|
1119 </dl><a NAME="MiniScintilla.removeTrailingWhitespace" ID="MiniScintilla.removeTrailingWhitespace"></a> |
|
1120 <h4>MiniScintilla.removeTrailingWhitespace</h4> |
|
1121 <b>removeTrailingWhitespace</b>(<i></i>) |
|
1122 <p> |
|
1123 Public method to remove trailing whitespace. |
|
1124 </p> |
|
1125 <div align="right"><a href="#top">Up</a></div> |
|
1126 <hr /> |
|
1127 </body></html> |