Mercurial Repositories > eric / file diff

diff: Documentation/Source/eric6.QScintilla.MiniEditor.html

Documentation/Source/eric6.QScintilla.MiniEditor.html

changeset 6106
921d070cec82
parent 5742
dc9cd8059221
child 6194
05df94843dd5
--- a/Documentation/Source/eric6.QScintilla.MiniEditor.html	Sat Feb 03 16:15:24 2018 +0100
+++ b/Documentation/Source/eric6.QScintilla.MiniEditor.html	Sat Feb 03 16:46:32 2018 +0100
@@ -126,6 +126,9 @@
 <td><a href="#MiniEditor.__getCurrentWord">__getCurrentWord</a></td>
 <td>Private method to get the word at the current position.</td>
 </tr><tr>
+<td><a href="#MiniEditor.__getEditorConfig">__getEditorConfig</a></td>
+<td>Private method to get the requested option via EditorConfig.</td>
+</tr><tr>
 <td><a href="#MiniEditor.__getWord">__getWord</a></td>
 <td>Private method to get the word at a position.</td>
 </tr><tr>
@@ -141,6 +144,12 @@
 <td><a href="#MiniEditor.__languageMenuTriggered">__languageMenuTriggered</a></td>
 <td>Private method to handle the selection of a lexer language.</td>
 </tr><tr>
+<td><a href="#MiniEditor.__loadEditorConfig">__loadEditorConfig</a></td>
+<td>Private method to load the EditorConfig properties.</td>
+</tr><tr>
+<td><a href="#MiniEditor.__loadEditorConfigObject">__loadEditorConfigObject</a></td>
+<td>Private method to load the EditorConfig properties for the given file name.</td>
+</tr><tr>
 <td><a href="#MiniEditor.__loadFile">__loadFile</a></td>
 <td>Private method to load the given file.</td>
 </tr><tr>
@@ -225,6 +234,9 @@
 <td><a href="#MiniEditor.__setSbFile">__setSbFile</a></td>
 <td>Private method to set the file info in the status bar.</td>
 </tr><tr>
+<td><a href="#MiniEditor.__setTabAndIndent">__setTabAndIndent</a></td>
+<td>Private method to set indentation size and style and tab width.</td>
+</tr><tr>
 <td><a href="#MiniEditor.__setTextDisplay">__setTextDisplay</a></td>
 <td>Private method to configure the text display.</td>
 </tr><tr>
@@ -243,6 +255,9 @@
 <td><a href="#MiniEditor.__whatsThis">__whatsThis</a></td>
 <td>Private slot called in to enter Whats This mode.</td>
 </tr><tr>
+<td><a href="#MiniEditor.__writeFile">__writeFile</a></td>
+<td>Private method to write the current editor text to a file.</td>
+</tr><tr>
 <td><a href="#MiniEditor.__writeSettings">__writeSettings</a></td>
 <td>Private method to write the settings for reuse.</td>
 </tr><tr>
@@ -447,6 +462,39 @@
 <dd>
 the word at that current position
 </dd>
+</dl><a NAME="MiniEditor.__getEditorConfig" ID="MiniEditor.__getEditorConfig"></a>
+<h4>MiniEditor.__getEditorConfig</h4>
+<b>__getEditorConfig</b>(<i>option, nodefault=False, config=None</i>)
+<p>
+        Private method to get the requested option via EditorConfig.
+</p><p>
+        If there is no EditorConfig defined, the equivalent built-in option
+        will be used (Preferences.getEditor(). The option must be given as the
+        Preferences option key. The mapping to the EditorConfig option name
+        will be done within this method.
+</p><dl>
+<dt><i>option</i> (str)</dt>
+<dd>
+Preferences option key
+</dd><dt><i>nodefault</i> (bool)</dt>
+<dd>
+flag indicating to not get the default value from
+            Preferences but return None instead
+</dd><dt><i>config</i> (dict)</dt>
+<dd>
+reference to an EditorConfig object or None
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+value of requested setting or None if nothing was found and
+            nodefault parameter was True
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+any
+</dd>
 </dl><a NAME="MiniEditor.__getWord" ID="MiniEditor.__getWord"></a>
 <h4>MiniEditor.__getWord</h4>
 <b>__getWord</b>(<i>line, index</i>)
@@ -500,6 +548,37 @@
 <dd>
 reference to the action that was triggered (QAction)
 </dd>
+</dl><a NAME="MiniEditor.__loadEditorConfig" ID="MiniEditor.__loadEditorConfig"></a>
+<h4>MiniEditor.__loadEditorConfig</h4>
+<b>__loadEditorConfig</b>(<i>fileName=""</i>)
+<p>
+        Private method to load the EditorConfig properties.
+</p><dl>
+<dt><i>fileName</i> (str)</dt>
+<dd>
+name of the file
+</dd>
+</dl><a NAME="MiniEditor.__loadEditorConfigObject" ID="MiniEditor.__loadEditorConfigObject"></a>
+<h4>MiniEditor.__loadEditorConfigObject</h4>
+<b>__loadEditorConfigObject</b>(<i>fileName</i>)
+<p>
+        Private method to load the EditorConfig properties for the given
+        file name.
+</p><dl>
+<dt><i>fileName</i> (str)</dt>
+<dd>
+name of the file
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+EditorConfig dictionary
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
 </dl><a NAME="MiniEditor.__loadFile" ID="MiniEditor.__loadFile"></a>
 <h4>MiniEditor.__loadFile</h4>
 <b>__loadFile</b>(<i>fileName, filetype=None</i>)
@@ -633,14 +712,19 @@
 <p>
         Private method to save to the given file.
 </p><dl>
-<dt><i>fileName</i></dt>
+<dt><i>fileName</i> (str)</dt>
 <dd>
-name of the file to save to (string)
+name of the file to save to
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="MiniEditor.__searchClearMarkers" ID="MiniEditor.__searchClearMarkers"></a>
 <h4>MiniEditor.__searchClearMarkers</h4>
@@ -715,7 +799,12 @@
 <dd>
 character position to display (int)
 </dd>
-</dl><a NAME="MiniEditor.__setTextDisplay" ID="MiniEditor.__setTextDisplay"></a>
+</dl><a NAME="MiniEditor.__setTabAndIndent" ID="MiniEditor.__setTabAndIndent"></a>
+<h4>MiniEditor.__setTabAndIndent</h4>
+<b>__setTabAndIndent</b>(<i></i>)
+<p>
+        Private method to set indentation size and style and tab width.
+</p><a NAME="MiniEditor.__setTextDisplay" ID="MiniEditor.__setTextDisplay"></a>
 <h4>MiniEditor.__setTextDisplay</h4>
 <b>__setTextDisplay</b>(<i></i>)
 <p>
@@ -761,7 +850,27 @@
 <b>__whatsThis</b>(<i></i>)
 <p>
         Private slot called in to enter Whats This mode.
-</p><a NAME="MiniEditor.__writeSettings" ID="MiniEditor.__writeSettings"></a>
+</p><a NAME="MiniEditor.__writeFile" ID="MiniEditor.__writeFile"></a>
+<h4>MiniEditor.__writeFile</h4>
+<b>__writeFile</b>(<i>fileName</i>)
+<p>
+        Private method to write the current editor text to a file.
+</p><dl>
+<dt><i>fileName</i> (str)</dt>
+<dd>
+name of the file to be written to
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating success
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl><a NAME="MiniEditor.__writeSettings" ID="MiniEditor.__writeSettings"></a>
 <h4>MiniEditor.__writeSettings</h4>
 <b>__writeSettings</b>(<i></i>)
 <p>
@@ -924,6 +1033,9 @@
 </tr><tr>
 <td><a href="#MiniScintilla.getFileName">getFileName</a></td>
 <td>Public method to return the name of the file being displayed.</td>
+</tr><tr>
+<td><a href="#MiniScintilla.removeTrailingWhitespace">removeTrailingWhitespace</a></td>
+<td>Public method to remove trailing whitespace.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
@@ -975,7 +1087,12 @@
 <dd>
 filename of the displayed file (string)
 </dd>
-</dl>
+</dl><a NAME="MiniScintilla.removeTrailingWhitespace" ID="MiniScintilla.removeTrailingWhitespace"></a>
+<h4>MiniScintilla.removeTrailingWhitespace</h4>
+<b>removeTrailingWhitespace</b>(<i></i>)
+<p>
+        Public method to remove trailing whitespace.
+</p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file

Mercurial Repository: eric

eric ide

mercurial