eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.WebBrowserSpellCheckingPage.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.WebBrowserSpellCheckingPage.html	Mon May 24 11:19:57 2021 +0200
@@ -0,0 +1,198 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Preferences.ConfigurationPages.WebBrowserSpellCheckingPage</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Preferences.ConfigurationPages.WebBrowserSpellCheckingPage</h1>
+
+<p>
+Module implementing the Web Browser Spell Checking configuration page.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#WebBrowserSpellCheckingPage">WebBrowserSpellCheckingPage</a></td>
+<td>Class implementing the Web Browser Spell Checking page.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+
+<tr>
+<td><a href="#create">create</a></td>
+<td>Module function to create the configuration page.</td>
+</tr>
+</table>
+<hr />
+<hr />
+<a NAME="WebBrowserSpellCheckingPage" ID="WebBrowserSpellCheckingPage"></a>
+<h2>WebBrowserSpellCheckingPage</h2>
+
+<p>
+    Class implementing the Web Browser Spell Checking page.
+</p>
+<h3>Derived from</h3>
+ConfigurationPageBase, Ui_WebBrowserSpellCheckingPage
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#WebBrowserSpellCheckingPage.__init__">WebBrowserSpellCheckingPage</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#WebBrowserSpellCheckingPage.__createLanguageString">__createLanguageString</a></td>
+<td>Private method to create a language string given a language identifier.</td>
+</tr>
+<tr>
+<td><a href="#WebBrowserSpellCheckingPage.__populateDictionariesList">__populateDictionariesList</a></td>
+<td>Private method to populate the spell checking dictionaries list.</td>
+</tr>
+<tr>
+<td><a href="#WebBrowserSpellCheckingPage.on_manageDictionariesButton_clicked">on_manageDictionariesButton_clicked</a></td>
+<td>Private slot to manage spell checking dictionaries.</td>
+</tr>
+<tr>
+<td><a href="#WebBrowserSpellCheckingPage.on_spellCheckEnabledCheckBox_clicked">on_spellCheckEnabledCheckBox_clicked</a></td>
+<td>Private slot handling a change of the spell checking enabled state.</td>
+</tr>
+<tr>
+<td><a href="#WebBrowserSpellCheckingPage.save">save</a></td>
+<td>Public slot to save the Help Viewers configuration.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="WebBrowserSpellCheckingPage.__init__" ID="WebBrowserSpellCheckingPage.__init__"></a>
+<h4>WebBrowserSpellCheckingPage (Constructor)</h4>
+<b>WebBrowserSpellCheckingPage</b>(<i></i>)
+
+<p>
+        Constructor
+</p>
+<a NAME="WebBrowserSpellCheckingPage.__createLanguageString" ID="WebBrowserSpellCheckingPage.__createLanguageString"></a>
+<h4>WebBrowserSpellCheckingPage.__createLanguageString</h4>
+<b>__createLanguageString</b>(<i>language</i>)
+
+<p>
+        Private method to create a language string given a language identifier.
+</p>
+<dl>
+
+<dt><i>language</i> (str)</dt>
+<dd>
+language identifier
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+language string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="WebBrowserSpellCheckingPage.__populateDictionariesList" ID="WebBrowserSpellCheckingPage.__populateDictionariesList"></a>
+<h4>WebBrowserSpellCheckingPage.__populateDictionariesList</h4>
+<b>__populateDictionariesList</b>(<i></i>)
+
+<p>
+        Private method to populate the spell checking dictionaries list.
+</p>
+<a NAME="WebBrowserSpellCheckingPage.on_manageDictionariesButton_clicked" ID="WebBrowserSpellCheckingPage.on_manageDictionariesButton_clicked"></a>
+<h4>WebBrowserSpellCheckingPage.on_manageDictionariesButton_clicked</h4>
+<b>on_manageDictionariesButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to manage spell checking dictionaries.
+</p>
+<a NAME="WebBrowserSpellCheckingPage.on_spellCheckEnabledCheckBox_clicked" ID="WebBrowserSpellCheckingPage.on_spellCheckEnabledCheckBox_clicked"></a>
+<h4>WebBrowserSpellCheckingPage.on_spellCheckEnabledCheckBox_clicked</h4>
+<b>on_spellCheckEnabledCheckBox_clicked</b>(<i></i>)
+
+<p>
+        Private slot handling a change of the spell checking enabled state.
+</p>
+<a NAME="WebBrowserSpellCheckingPage.save" ID="WebBrowserSpellCheckingPage.save"></a>
+<h4>WebBrowserSpellCheckingPage.save</h4>
+<b>save</b>(<i></i>)
+
+<p>
+        Public slot to save the Help Viewers configuration.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="create" ID="create"></a>
+<h2>create</h2>
+<b>create</b>(<i>dlg</i>)
+
+<p>
+    Module function to create the configuration page.
+</p>
+<dl>
+
+<dt><i>dlg</i> (Configuration)</dt>
+<dd>
+reference to the configuration dialog
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the instantiated page
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+ConfigurationPageBase
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial