Updated source docu. eric7

Wed, 09 Jun 2021 17:51:02 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Wed, 09 Jun 2021 17:51:02 +0200
branch
eric7
changeset 8418
756f7fb88224
parent 8417
87583a31cb8f
child 8419
32506bc52886

Updated source docu.

eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
eric7/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
eric7/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
eric7/Documentation/Source/eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardServer.html file | annotate | diff | comparison | revisions
eric7/Documentation/Source/eric7.UI.Previewer.html file | annotate | diff | comparison | revisions
eric7/Documentation/Source/eric7.UI.UserInterface.html file | annotate | diff | comparison | revisions
eric7/Documentation/Source/index-eric7.Plugins.WizardPlugins.QRegularExpressionWizard.html file | annotate | diff | comparison | revisions
--- a/eric7/APIs/Python3/eric7.api	Wed Jun 09 17:50:02 2021 +0200
+++ b/eric7/APIs/Python3/eric7.api	Wed Jun 09 17:51:02 2021 +0200
@@ -9432,9 +9432,10 @@
 eric7.UI.PixmapCache.removeSearchPath?4(path, cache=pixCache)
 eric7.UI.Previewer.Previewer.hide?4()
 eric7.UI.Previewer.Previewer.preferencesChanged?4()
+eric7.UI.Previewer.Previewer.setSplitter?4(splitter)
 eric7.UI.Previewer.Previewer.show?4()
 eric7.UI.Previewer.Previewer.shutdown?4()
-eric7.UI.Previewer.Previewer?1(viewmanager, splitter, parent=None)
+eric7.UI.Previewer.Previewer?1(viewmanager, parent=None)
 eric7.UI.Previewers.MarkdownExtensions.MermaidExtension.extendMarkdown?4(md, md_globals)
 eric7.UI.Previewers.MarkdownExtensions.MermaidPreprocessor.run?4(lines)
 eric7.UI.Previewers.MarkdownExtensions.MermaidRegex?7
Binary file eric7/Documentation/Help/source.qch has changed
--- a/eric7/Documentation/Help/source.qhp	Wed Jun 09 17:50:02 2021 +0200
+++ b/eric7/Documentation/Help/source.qhp	Wed Jun 09 17:51:02 2021 +0200
@@ -11285,6 +11285,7 @@
       <keyword name="Previewer.__splitterMoved" id="Previewer.__splitterMoved" ref="eric7.UI.Previewer.html#Previewer.__splitterMoved" />
       <keyword name="Previewer.hide" id="Previewer.hide" ref="eric7.UI.Previewer.html#Previewer.hide" />
       <keyword name="Previewer.preferencesChanged" id="Previewer.preferencesChanged" ref="eric7.UI.Previewer.html#Previewer.preferencesChanged" />
+      <keyword name="Previewer.setSplitter" id="Previewer.setSplitter" ref="eric7.UI.Previewer.html#Previewer.setSplitter" />
       <keyword name="Previewer.show" id="Previewer.show" ref="eric7.UI.Previewer.html#Previewer.show" />
       <keyword name="Previewer.shutdown" id="Previewer.shutdown" ref="eric7.UI.Previewer.html#Previewer.shutdown" />
       <keyword name="PreviewerHTML" id="PreviewerHTML" ref="eric7.UI.Previewers.PreviewerHTML.html#PreviewerHTML" />
@@ -15709,6 +15710,7 @@
       <keyword name="UserInterface.__connectToWebBrowser" id="UserInterface.__connectToWebBrowser" ref="eric7.UI.UserInterface.html#UserInterface.__connectToWebBrowser" />
       <keyword name="UserInterface.__createDockWindow" id="UserInterface.__createDockWindow" ref="eric7.UI.UserInterface.html#UserInterface.__createDockWindow" />
       <keyword name="UserInterface.__createLayout" id="UserInterface.__createLayout" ref="eric7.UI.UserInterface.html#UserInterface.__createLayout" />
+      <keyword name="UserInterface.__createObjects" id="UserInterface.__createObjects" ref="eric7.UI.UserInterface.html#UserInterface.__createObjects" />
       <keyword name="UserInterface.__createSidebarsLayout" id="UserInterface.__createSidebarsLayout" ref="eric7.UI.UserInterface.html#UserInterface.__createSidebarsLayout" />
       <keyword name="UserInterface.__createToolboxesLayout" id="UserInterface.__createToolboxesLayout" ref="eric7.UI.UserInterface.html#UserInterface.__createToolboxesLayout" />
       <keyword name="UserInterface.__createUnitTestDialog" id="UserInterface.__createUnitTestDialog" ref="eric7.UI.UserInterface.html#UserInterface.__createUnitTestDialog" />
--- a/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardServer.html	Wed Jun 09 17:50:02 2021 +0200
+++ b/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardServer.html	Wed Jun 09 17:51:02 2021 +0200
@@ -23,7 +23,7 @@
 <h1>eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardServer</h1>
 
 <p>
-Module implementing the PyQt5 server part of the QRegularExpression wizzard.
+Module implementing the PyQt6 server part of the QRegularExpression wizzard.
 </p>
 <h3>Global Attributes</h3>
 
--- a/eric7/Documentation/Source/eric7.UI.Previewer.html	Wed Jun 09 17:50:02 2021 +0200
+++ b/eric7/Documentation/Source/eric7.UI.Previewer.html	Wed Jun 09 17:51:02 2021 +0200
@@ -110,6 +110,10 @@
 <td>Public slot handling a change of preferences.</td>
 </tr>
 <tr>
+<td><a href="#Previewer.setSplitter">setSplitter</a></td>
+<td>Public method to set the splitter.</td>
+</tr>
+<tr>
 <td><a href="#Previewer.show">show</a></td>
 <td>Public method to show the preview widget.</td>
 </tr>
@@ -126,24 +130,20 @@
 
 <a NAME="Previewer.__init__" ID="Previewer.__init__"></a>
 <h4>Previewer (Constructor)</h4>
-<b>Previewer</b>(<i>viewmanager, splitter, parent=None</i>)
+<b>Previewer</b>(<i>viewmanager, parent=None</i>)
 
 <p>
         Constructor
 </p>
 <dl>
 
-<dt><i>viewmanager</i></dt>
-<dd>
-reference to the viewmanager object (ViewManager)
-</dd>
-<dt><i>splitter</i></dt>
+<dt><i>viewmanager</i> (ViewManager)</dt>
 <dd>
-reference to the embedding splitter (QSplitter)
+reference to the viewmanager object
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
 </dd>
 </dl>
 <a NAME="Previewer.__editorChanged" ID="Previewer.__editorChanged"></a>
@@ -155,9 +155,9 @@
 </p>
 <dl>
 
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
-reference to the editor (Editor)
+reference to the editor
 </dd>
 </dl>
 <a NAME="Previewer.__editorLanguageChanged" ID="Previewer.__editorLanguageChanged"></a>
@@ -169,9 +169,9 @@
 </p>
 <dl>
 
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
-reference to the editor (Editor)
+reference to the editor
 </dd>
 </dl>
 <a NAME="Previewer.__editorTextChanged" ID="Previewer.__editorTextChanged"></a>
@@ -183,9 +183,9 @@
 </p>
 <dl>
 
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
-reference to the editor (Editor)
+reference to the editor
 </dd>
 </dl>
 <a NAME="Previewer.__isPreviewable" ID="Previewer.__isPreviewable"></a>
@@ -198,15 +198,21 @@
 </p>
 <dl>
 
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
-reference to an editor (Editor)
+reference to an editor
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating if a preview can be shown (boolean)
+flag indicating if a preview can be shown
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Previewer.__previewStateChanged" ID="Previewer.__previewStateChanged"></a>
@@ -218,9 +224,9 @@
 </p>
 <dl>
 
-<dt><i>on</i></dt>
+<dt><i>on</i> (bool)</dt>
 <dd>
-flag indicating to show a preview (boolean)
+flag indicating to show a preview
 </dd>
 </dl>
 <a NAME="Previewer.__processEditor" ID="Previewer.__processEditor"></a>
@@ -251,6 +257,20 @@
 <p>
         Public slot handling a change of preferences.
 </p>
+<a NAME="Previewer.setSplitter" ID="Previewer.setSplitter"></a>
+<h4>Previewer.setSplitter</h4>
+<b>setSplitter</b>(<i>splitter</i>)
+
+<p>
+        Public method to set the splitter.
+</p>
+<dl>
+
+<dt><i>splitter</i> (QSplitter)</dt>
+<dd>
+reference to the embedding splitter
+</dd>
+</dl>
 <a NAME="Previewer.show" ID="Previewer.show"></a>
 <h4>Previewer.show</h4>
 <b>show</b>(<i></i>)
--- a/eric7/Documentation/Source/eric7.UI.UserInterface.html	Wed Jun 09 17:50:02 2021 +0200
+++ b/eric7/Documentation/Source/eric7.UI.UserInterface.html	Wed Jun 09 17:51:02 2021 +0200
@@ -366,6 +366,10 @@
 <td>Private method to create the layout of the various windows.</td>
 </tr>
 <tr>
+<td><a href="#UserInterface.__createObjects">__createObjects</a></td>
+<td>Private method to create the various objects of the application.</td>
+</tr>
+<tr>
 <td><a href="#UserInterface.__createSidebarsLayout">__createSidebarsLayout</a></td>
 <td>Private method to create the Sidebars layout.</td>
 </tr>
@@ -1501,53 +1505,46 @@
 </dl>
 <a NAME="UserInterface.__createLayout" ID="UserInterface.__createLayout"></a>
 <h4>UserInterface.__createLayout</h4>
-<b>__createLayout</b>(<i>debugServer</i>)
+<b>__createLayout</b>(<i></i>)
 
 <p>
         Private method to create the layout of the various windows.
 </p>
 <dl>
 
-<dt><i>debugServer</i></dt>
-<dd>
-reference to the debug server object
-</dd>
-</dl>
-<dl>
-
 <dt>Raises <b>ValueError</b>:</dt>
 <dd>
 raised to indicate an invalid layout type
 </dd>
 </dl>
-<a NAME="UserInterface.__createSidebarsLayout" ID="UserInterface.__createSidebarsLayout"></a>
-<h4>UserInterface.__createSidebarsLayout</h4>
-<b>__createSidebarsLayout</b>(<i>debugServer</i>)
+<a NAME="UserInterface.__createObjects" ID="UserInterface.__createObjects"></a>
+<h4>UserInterface.__createObjects</h4>
+<b>__createObjects</b>(<i>debugServer</i>)
 
 <p>
-        Private method to create the Sidebars layout.
+        Private method to create the various objects of the application.
 </p>
 <dl>
 
-<dt><i>debugServer</i></dt>
+<dt><i>debugServer</i> (DebugServer)</dt>
 <dd>
 reference to the debug server object
 </dd>
 </dl>
+<a NAME="UserInterface.__createSidebarsLayout" ID="UserInterface.__createSidebarsLayout"></a>
+<h4>UserInterface.__createSidebarsLayout</h4>
+<b>__createSidebarsLayout</b>(<i></i>)
+
+<p>
+        Private method to create the Sidebars layout.
+</p>
 <a NAME="UserInterface.__createToolboxesLayout" ID="UserInterface.__createToolboxesLayout"></a>
 <h4>UserInterface.__createToolboxesLayout</h4>
-<b>__createToolboxesLayout</b>(<i>debugServer</i>)
+<b>__createToolboxesLayout</b>(<i></i>)
 
 <p>
         Private method to create the Toolboxes layout.
 </p>
-<dl>
-
-<dt><i>debugServer</i></dt>
-<dd>
-reference to the debug server object
-</dd>
-</dl>
 <a NAME="UserInterface.__createUnitTestDialog" ID="UserInterface.__createUnitTestDialog"></a>
 <h4>UserInterface.__createUnitTestDialog</h4>
 <b>__createUnitTestDialog</b>(<i></i>)
--- a/eric7/Documentation/Source/index-eric7.Plugins.WizardPlugins.QRegularExpressionWizard.html	Wed Jun 09 17:50:02 2021 +0200
+++ b/eric7/Documentation/Source/index-eric7.Plugins.WizardPlugins.QRegularExpressionWizard.html	Wed Jun 09 17:51:02 2021 +0200
@@ -43,7 +43,7 @@
 </tr>
 <tr>
 <td><a href="eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardServer.html">QRegularExpressionWizardServer</a></td>
-<td>Module implementing the PyQt5 server part of the QRegularExpression wizzard.</td>
+<td>Module implementing the PyQt6 server part of the QRegularExpression wizzard.</td>
 </tr>
 </table>
 </body></html>
\ No newline at end of file

eric ide

mercurial