--- a/Documentation/Source/eric6.QScintilla.Editor.html Sat Feb 03 16:15:24 2018 +0100 +++ b/Documentation/Source/eric6.QScintilla.Editor.html Sat Feb 03 16:46:32 2018 +0100 @@ -306,6 +306,9 @@ <td><a href="#Editor.__getCodeCoverageFile">__getCodeCoverageFile</a></td> <td>Private method to get the file name of the file containing coverage info.</td> </tr><tr> +<td><a href="#Editor.__getEditorConfig">__getEditorConfig</a></td> +<td>Private method to get the requested option via EditorConfig.</td> +</tr><tr> <td><a href="#Editor.__getMacroName">__getMacroName</a></td> <td>Private method to select a macro name from the list of macros.</td> </tr><tr> @@ -396,6 +399,12 @@ <td><a href="#Editor.__loadDiagram">__loadDiagram</a></td> <td>Private slot to load a diagram from file.</td> </tr><tr> +<td><a href="#Editor.__loadEditorConfig">__loadEditorConfig</a></td> +<td>Private method to load the EditorConfig properties.</td> +</tr><tr> +<td><a href="#Editor.__loadEditorConfigObject">__loadEditorConfigObject</a></td> +<td>Private method to load the EditorConfig properties for the given file name.</td> +</tr><tr> <td><a href="#Editor.__marginClicked">__marginClicked</a></td> <td>Private slot to handle the marginClicked signal.</td> </tr><tr> @@ -543,6 +552,9 @@ <td><a href="#Editor.__setSpellingLanguage">__setSpellingLanguage</a></td> <td>Private slot to set the spell checking language.</td> </tr><tr> +<td><a href="#Editor.__setTabAndIndent">__setTabAndIndent</a></td> +<td>Private method to set indentation size and style and tab width.</td> +</tr><tr> <td><a href="#Editor.__setTextDisplay">__setTextDisplay</a></td> <td>Private method to configure the text display.</td> </tr><tr> @@ -822,6 +834,9 @@ <td><a href="#Editor.getCurrentWordBoundaries">getCurrentWordBoundaries</a></td> <td>Public method to get the word boundaries at the current position.</td> </tr><tr> +<td><a href="#Editor.getEditorConfig">getEditorConfig</a></td> +<td>Public method to get the requested option via EditorConfig.</td> +</tr><tr> <td><a href="#Editor.getEncoding">getEncoding</a></td> <td>Public method to return the current encoding.</td> </tr><tr> @@ -1746,6 +1761,39 @@ <dd> file name of the coverage file (string) </dd> +</dl><a NAME="Editor.__getEditorConfig" ID="Editor.__getEditorConfig"></a> +<h4>Editor.__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="Editor.__getMacroName" ID="Editor.__getMacroName"></a> <h4>Editor.__getMacroName</h4> <b>__getMacroName</b>(<i></i>) @@ -2028,7 +2076,38 @@ <b>__loadDiagram</b>(<i></i>) <p> Private slot to load a diagram from file. -</p><a NAME="Editor.__marginClicked" ID="Editor.__marginClicked"></a> +</p><a NAME="Editor.__loadEditorConfig" ID="Editor.__loadEditorConfig"></a> +<h4>Editor.__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="Editor.__loadEditorConfigObject" ID="Editor.__loadEditorConfigObject"></a> +<h4>Editor.__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="Editor.__marginClicked" ID="Editor.__marginClicked"></a> <h4>Editor.__marginClicked</h4> <b>__marginClicked</b>(<i>margin, line, modifiers</i>) <p> @@ -2458,7 +2537,12 @@ <dd> name of the personal/project exclude list (string) </dd> -</dl><a NAME="Editor.__setTextDisplay" ID="Editor.__setTextDisplay"></a> +</dl><a NAME="Editor.__setTabAndIndent" ID="Editor.__setTabAndIndent"></a> +<h4>Editor.__setTabAndIndent</h4> +<b>__setTabAndIndent</b>(<i></i>) +<p> + Private method to set indentation size and style and tab width. +</p><a NAME="Editor.__setTextDisplay" ID="Editor.__setTextDisplay"></a> <h4>Editor.__setTextDisplay</h4> <b>__setTextDisplay</b>(<i></i>) <p> @@ -3275,6 +3359,26 @@ tuple with start and end indexes of the current word (integer, integer) </dd> +</dl><a NAME="Editor.getEditorConfig" ID="Editor.getEditorConfig"></a> +<h4>Editor.getEditorConfig</h4> +<b>getEditorConfig</b>(<i>option</i>) +<p> + Public method to get the requested option via EditorConfig. +</p><dl> +<dt><i>option</i> (str)</dt> +<dd> +Preferences option key +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +value of requested setting +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +any +</dd> </dl><a NAME="Editor.getEncoding" ID="Editor.getEncoding"></a> <h4>Editor.getEncoding</h4> <b>getEncoding</b>(<i></i>)