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

branch
maintenance
changeset 7322
cd8ee889589f
parent 7286
7eb04391adf7
parent 7313
2373d03cd63a
child 7642
72721823d453
--- a/eric6/Documentation/Source/eric6.QScintilla.Editor.html	Thu Oct 03 11:12:50 2019 +0200
+++ b/eric6/Documentation/Source/eric6.QScintilla.Editor.html	Fri Nov 01 16:11:27 2019 +0100
@@ -156,6 +156,11 @@
         about to be shown. The name of the menu, a reference to the menu and
         a reference to the editor are given.
 </dd>
+<dt>spellLanguageChanged(str)</dt>
+<dd>
+emitted when the editor spell check
+            language was set. The language is passed as a parameter.
+</dd>
 <dt>syntaxerrorToggled(QsciScintillaCompat)</dt>
 <dd>
 emitted when a syntax error
@@ -288,6 +293,10 @@
 <td>Private method to check the selected language of the language submenu.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__checkSpellLanguage">__checkSpellLanguage</a></td>
+<td>Private slot to check the selected spell check language action.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__checkSpellingSelection">__checkSpellingSelection</a></td>
 <td>Private slot to spell check the current selection.</td>
 </tr>
@@ -492,6 +501,10 @@
 <td>Private method used to setup the Show context sub menu.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__initContextMenuSpellLanguages">__initContextMenuSpellLanguages</a></td>
+<td>Private method to setup the spell checking languages context sub menu.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__initContextMenuTools">__initContextMenuTools</a></td>
 <td>Private method used to setup the Tools context sub menu.</td>
 </tr>
@@ -720,6 +733,10 @@
 <td>Private method to configure the eol mode of the editor.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__setFileName">__setFileName</a></td>
+<td>Private method to set the file name of the current file.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__setLineMarkerColours">__setLineMarkerColours</a></td>
 <td>Private method to set the line marker colours.</td>
 </tr>
@@ -808,6 +825,10 @@
 <td>Private slot called before the show menu is shown.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__showContextMenuSpellLanguages">__showContextMenuSpellLanguages</a></td>
+<td>Private slot handling the aboutToShow signal of the spell check languages context menu.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__showContextMenuSpelling">__showContextMenuSpelling</a></td>
 <td>Private slot to set up the spelling menu before it is shown.</td>
 </tr>
@@ -840,6 +861,14 @@
 <td>Private slot called to handle the user entering a character.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__spellLanguageChanged">__spellLanguageChanged</a></td>
+<td>Private slot to handle a change of the spell check language.</td>
+</tr>
+<tr>
+<td><a href="#Editor.__spellLanguagesMenuTriggered">__spellLanguagesMenuTriggered</a></td>
+<td>Private method to handle the selection of a spell check language.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__styleNeeded">__styleNeeded</a></td>
 <td>Private slot to handle the need for more styling.</td>
 </tr>
@@ -1188,6 +1217,10 @@
 <td>Public method to get some share status info.</td>
 </tr>
 <tr>
+<td><a href="#Editor.getSpellingLanguage">getSpellingLanguage</a></td>
+<td>Public method to get the current spelling language.</td>
+</tr>
+<tr>
 <td><a href="#Editor.getSyntaxErrorLines">getSyntaxErrorLines</a></td>
 <td>Public method to get the lines containing a syntax error.</td>
 </tr>
@@ -2046,6 +2079,13 @@
 <p>
         Private method to check the selected language of the language submenu.
 </p>
+<a NAME="Editor.__checkSpellLanguage" ID="Editor.__checkSpellLanguage"></a>
+<h4>Editor.__checkSpellLanguage</h4>
+<b>__checkSpellLanguage</b>(<i></i>)
+
+<p>
+        Private slot to check the selected spell check language action.
+</p>
 <a NAME="Editor.__checkSpellingSelection" ID="Editor.__checkSpellingSelection"></a>
 <h4>Editor.__checkSpellingSelection</h4>
 <b>__checkSpellingSelection</b>(<i></i>)
@@ -2721,6 +2761,25 @@
 reference to the generated menu (QMenu)
 </dd>
 </dl>
+<a NAME="Editor.__initContextMenuSpellLanguages" ID="Editor.__initContextMenuSpellLanguages"></a>
+<h4>Editor.__initContextMenuSpellLanguages</h4>
+<b>__initContextMenuSpellLanguages</b>(<i></i>)
+
+<p>
+        Private method to setup the spell checking languages context sub menu.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+reference to the generated menu
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QMenu
+</dd>
+</dl>
 <a NAME="Editor.__initContextMenuTools" ID="Editor.__initContextMenuTools"></a>
 <h4>Editor.__initContextMenuTools</h4>
 <b>__initContextMenuTools</b>(<i></i>)
@@ -3436,6 +3495,20 @@
 <p>
         Private method to configure the eol mode of the editor.
 </p>
+<a NAME="Editor.__setFileName" ID="Editor.__setFileName"></a>
+<h4>Editor.__setFileName</h4>
+<b>__setFileName</b>(<i>name</i>)
+
+<p>
+        Private method to set the file name of the current file.
+</p>
+<dl>
+
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the current file
+</dd>
+</dl>
 <a NAME="Editor.__setLineMarkerColours" ID="Editor.__setLineMarkerColours"></a>
 <h4>Editor.__setLineMarkerColours</h4>
 <b>__setLineMarkerColours</b>(<i></i>)
@@ -3625,6 +3698,14 @@
 <p>
         Private slot called before the show menu is shown.
 </p>
+<a NAME="Editor.__showContextMenuSpellLanguages" ID="Editor.__showContextMenuSpellLanguages"></a>
+<h4>Editor.__showContextMenuSpellLanguages</h4>
+<b>__showContextMenuSpellLanguages</b>(<i></i>)
+
+<p>
+        Private slot handling the aboutToShow signal of the spell check
+        languages context menu.
+</p>
 <a NAME="Editor.__showContextMenuSpelling" ID="Editor.__showContextMenuSpelling"></a>
 <h4>Editor.__showContextMenuSpelling</h4>
 <b>__showContextMenuSpelling</b>(<i></i>)
@@ -3704,6 +3785,38 @@
 value of the character entered (integer)
 </dd>
 </dl>
+<a NAME="Editor.__spellLanguageChanged" ID="Editor.__spellLanguageChanged"></a>
+<h4>Editor.__spellLanguageChanged</h4>
+<b>__spellLanguageChanged</b>(<i>language, propagate=True</i>)
+
+<p>
+        Private slot to handle a change of the spell check language.
+</p>
+<dl>
+
+<dt><i>language</i> (str)</dt>
+<dd>
+new spell check language
+</dd>
+<dt><i>propagate</i> (bool)</dt>
+<dd>
+flag indicating to propagate the change
+</dd>
+</dl>
+<a NAME="Editor.__spellLanguagesMenuTriggered" ID="Editor.__spellLanguagesMenuTriggered"></a>
+<h4>Editor.__spellLanguagesMenuTriggered</h4>
+<b>__spellLanguagesMenuTriggered</b>(<i>act</i>)
+
+<p>
+        Private method to handle the selection of a spell check language.
+</p>
+<dl>
+
+<dt><i>act</i> (QAction)</dt>
+<dd>
+reference to the action that was triggered
+</dd>
+</dl>
 <a NAME="Editor.__styleNeeded" ID="Editor.__styleNeeded"></a>
 <h4>Editor.__styleNeeded</h4>
 <b>__styleNeeded</b>(<i>position</i>)
@@ -4941,6 +5054,25 @@
             (boolean, boolean, boolean, boolean)
 </dd>
 </dl>
+<a NAME="Editor.getSpellingLanguage" ID="Editor.getSpellingLanguage"></a>
+<h4>Editor.getSpellingLanguage</h4>
+<b>getSpellingLanguage</b>(<i></i>)
+
+<p>
+        Public method to get the current spelling language.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+current spelling language
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="Editor.getSyntaxErrorLines" ID="Editor.getSyntaxErrorLines"></a>
 <h4>Editor.getSyntaxErrorLines</h4>
 <b>getSyntaxErrorLines</b>(<i></i>)
@@ -5487,17 +5619,29 @@
         Public method to check, if the given position is within a region, that
         should be spell checked.
 </p>
-<dl>
-
-<dt><i>pos</i></dt>
-<dd>
-position to be checked (integer)
+<p>
+        For files with a configured full text file extension all regions will
+        be regarded as to be checked. Depending on configuration, all unknown
+        files (i.e. those without a file extension) will be checked fully as
+        well.
+</p>
+<dl>
+
+<dt><i>pos</i> (int)</dt>
+<dd>
+position to be checked
 </dd>
 </dl>
 <dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating pos is in a spell check region (boolean)
+flag indicating pos is in a spell check region
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Editor.joinLines" ID="Editor.joinLines"></a>

eric ide

mercurial