Updated the source documentation. eric7

Mon, 23 Jan 2023 16:53:43 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Mon, 23 Jan 2023 16:53:43 +0100
branch
eric7
changeset 9721
9ce11596e2cd
parent 9720
c8ada6793e53
child 9723
2ec7ae81c04f

Updated the source documentation.

src/eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.EricWidgets.EricSpellCheckedTextEdit.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.IconEditor.IconEditorWindow.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.UI.UserInterface.html file | annotate | diff | comparison | revisions
--- a/src/eric7/APIs/Python3/eric7.api	Mon Jan 23 16:42:10 2023 +0100
+++ b/src/eric7/APIs/Python3/eric7.api	Mon Jan 23 16:53:43 2023 +0100
@@ -1696,10 +1696,10 @@
 eric7.EricWidgets.EricSpellCheckedTextEdit.EnchantHighlighter.highlightBlock?4(text)
 eric7.EricWidgets.EricSpellCheckedTextEdit.EnchantHighlighter.setChunkers?4(chunkers)
 eric7.EricWidgets.EricSpellCheckedTextEdit.EnchantHighlighter.setDict?4(spellDict)
-eric7.EricWidgets.EricSpellCheckedTextEdit.EnchantHighlighter?1(*args)
-eric7.EricWidgets.EricSpellCheckedTextEdit.EricSpellCheckedPlainTextEdit?1(*args)
+eric7.EricWidgets.EricSpellCheckedTextEdit.EnchantHighlighter?1(*args, **kwargs)
+eric7.EricWidgets.EricSpellCheckedTextEdit.EricSpellCheckedPlainTextEdit?1(*args, **kwargs)
 eric7.EricWidgets.EricSpellCheckedTextEdit.EricSpellCheckedTextEdit.setAcceptRichText?4(accept)
-eric7.EricWidgets.EricSpellCheckedTextEdit.EricSpellCheckedTextEdit?1(*args)
+eric7.EricWidgets.EricSpellCheckedTextEdit.EricSpellCheckedTextEdit?1(*args, **kwargs)
 eric7.EricWidgets.EricSpellCheckedTextEdit.SpellCheckMixin.DefaultLanguage?7
 eric7.EricWidgets.EricSpellCheckedTextEdit.SpellCheckMixin.DefaultUserExceptionList?7
 eric7.EricWidgets.EricSpellCheckedTextEdit.SpellCheckMixin.DefaultUserWordList?7
@@ -10253,7 +10253,6 @@
 eric7.UI.UserInterface.UserInterface.getMenuAction?4(menuName, actionName)
 eric7.UI.UserInterface.UserInterface.getMenuBarAction?4(menuName)
 eric7.UI.UserInterface.UserInterface.getOriginalPathString?4()
-eric7.UI.UserInterface.UserInterface.getToolBarIconSize?4()
 eric7.UI.UserInterface.UserInterface.getToolbar?4(name)
 eric7.UI.UserInterface.UserInterface.getToolbarsByCategory?4(category)
 eric7.UI.UserInterface.UserInterface.getViewProfile?4()
Binary file src/eric7/Documentation/Help/source.qch has changed
--- a/src/eric7/Documentation/Help/source.qhp	Mon Jan 23 16:42:10 2023 +0100
+++ b/src/eric7/Documentation/Help/source.qhp	Mon Jan 23 16:53:43 2023 +0100
@@ -16827,7 +16827,6 @@
       <keyword name="UserInterface.getMenuAction" id="UserInterface.getMenuAction" ref="eric7.UI.UserInterface.html#UserInterface.getMenuAction" />
       <keyword name="UserInterface.getMenuBarAction" id="UserInterface.getMenuBarAction" ref="eric7.UI.UserInterface.html#UserInterface.getMenuBarAction" />
       <keyword name="UserInterface.getOriginalPathString" id="UserInterface.getOriginalPathString" ref="eric7.UI.UserInterface.html#UserInterface.getOriginalPathString" />
-      <keyword name="UserInterface.getToolBarIconSize" id="UserInterface.getToolBarIconSize" ref="eric7.UI.UserInterface.html#UserInterface.getToolBarIconSize" />
       <keyword name="UserInterface.getToolbar" id="UserInterface.getToolbar" ref="eric7.UI.UserInterface.html#UserInterface.getToolbar" />
       <keyword name="UserInterface.getToolbarsByCategory" id="UserInterface.getToolbarsByCategory" ref="eric7.UI.UserInterface.html#UserInterface.getToolbarsByCategory" />
       <keyword name="UserInterface.getViewProfile" id="UserInterface.getViewProfile" ref="eric7.UI.UserInterface.html#UserInterface.getViewProfile" />
--- a/src/eric7/Documentation/Source/eric7.EricWidgets.EricSpellCheckedTextEdit.html	Mon Jan 23 16:42:10 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricSpellCheckedTextEdit.html	Mon Jan 23 16:53:43 2023 +0100
@@ -105,7 +105,7 @@
 
 <a NAME="EnchantHighlighter.__init__" ID="EnchantHighlighter.__init__"></a>
 <h4>EnchantHighlighter (Constructor)</h4>
-<b>EnchantHighlighter</b>(<i>*args</i>)
+<b>EnchantHighlighter</b>(<i>*args, **kwargs</i>)
 
 <p>
             Constructor
@@ -116,6 +116,11 @@
 <dd>
 list of arguments for the QSyntaxHighlighter
 </dd>
+<dt><i>**kwargs=</i> (dict)</dt>
+<dd>
+dictionary of keyword arguments for the
+                QSyntaxHighlighter
+</dd>
 </dl>
 <a NAME="EnchantHighlighter.chunkers" ID="EnchantHighlighter.chunkers"></a>
 <h4>EnchantHighlighter.chunkers</h4>
@@ -235,7 +240,7 @@
 
 <a NAME="EricSpellCheckedPlainTextEdit.__init__" ID="EricSpellCheckedPlainTextEdit.__init__"></a>
 <h4>EricSpellCheckedPlainTextEdit (Constructor)</h4>
-<b>EricSpellCheckedPlainTextEdit</b>(<i>*args</i>)
+<b>EricSpellCheckedPlainTextEdit</b>(<i>*args, **kwargs</i>)
 
 <p>
         Constructor
@@ -246,6 +251,10 @@
 <dd>
 list of arguments for the QPlainTextEdit constructor.
 </dd>
+<dt><i>**kwargs=</i> (dict)</dt>
+<dd>
+dictionary of keyword arguments for the QSyntaxHighlighter
+</dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
@@ -289,7 +298,7 @@
 
 <a NAME="EricSpellCheckedTextEdit.__init__" ID="EricSpellCheckedTextEdit.__init__"></a>
 <h4>EricSpellCheckedTextEdit (Constructor)</h4>
-<b>EricSpellCheckedTextEdit</b>(<i>*args</i>)
+<b>EricSpellCheckedTextEdit</b>(<i>*args, **kwargs</i>)
 
 <p>
         Constructor
@@ -300,6 +309,10 @@
 <dd>
 list of arguments for the QPlainTextEdit constructor.
 </dd>
+<dt><i>**kwargs=</i> (dict)</dt>
+<dd>
+dictionary of keyword arguments for the QSyntaxHighlighter
+</dd>
 </dl>
 <a NAME="EricSpellCheckedTextEdit.setAcceptRichText" ID="EricSpellCheckedTextEdit.setAcceptRichText"></a>
 <h4>EricSpellCheckedTextEdit.setAcceptRichText</h4>
--- a/src/eric7/Documentation/Source/eric7.IconEditor.IconEditorWindow.html	Mon Jan 23 16:42:10 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.IconEditor.IconEditorWindow.html	Mon Jan 23 16:53:43 2023 +0100
@@ -631,9 +631,9 @@
 </p>
 <dl>
 
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QGestureEvent)</dt>
 <dd>
-reference to the gesture event (QGestureEvent
+reference to the gesture event
 </dd>
 </dl>
 <a NAME="IconEditorWindow.setRecentPaths" ID="IconEditorWindow.setRecentPaths"></a>
--- a/src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html	Mon Jan 23 16:42:10 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html	Mon Jan 23 16:53:43 2023 +0100
@@ -797,7 +797,7 @@
 </p>
 <a NAME="PipPackagesWidget.__showPackageDetails" ID="PipPackagesWidget.__showPackageDetails"></a>
 <h4>PipPackagesWidget.__showPackageDetails</h4>
-<b>__showPackageDetails</b>(<i>packageName, packageVersion, vulnerabilities=None, upgradable=False, installable=False</i>)
+<b>__showPackageDetails</b>(<i>packageName, packageVersion, vulnerabilities=None, upgradable=False, installable=False, </i>)
 
 <p>
         Private method to populate the package details dialog.
--- a/src/eric7/Documentation/Source/eric7.UI.UserInterface.html	Mon Jan 23 16:42:10 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.UI.UserInterface.html	Mon Jan 23 16:53:43 2023 +0100
@@ -1017,10 +1017,6 @@
 <td>Public method to get the original PATH environment variable (i.e.</td>
 </tr>
 <tr>
-<td><a href="#UserInterface.getToolBarIconSize">getToolBarIconSize</a></td>
-<td>Public method to get the toolbar icon size.</td>
-</tr>
-<tr>
 <td><a href="#UserInterface.getToolbar">getToolbar</a></td>
 <td>Public method to get a reference to a specific toolbar.</td>
 </tr>
@@ -3338,19 +3334,6 @@
 str
 </dd>
 </dl>
-<a NAME="UserInterface.getToolBarIconSize" ID="UserInterface.getToolBarIconSize"></a>
-<h4>UserInterface.getToolBarIconSize</h4>
-<b>getToolBarIconSize</b>(<i></i>)
-
-<p>
-        Public method to get the toolbar icon size.
-</p>
-<dl>
-<dt>Return:</dt>
-<dd>
-toolbar icon size (QSize)
-</dd>
-</dl>
 <a NAME="UserInterface.getToolbar" ID="UserInterface.getToolbar"></a>
 <h4>UserInterface.getToolbar</h4>
 <b>getToolbar</b>(<i>name</i>)

eric ide

mercurial