Updated source documentation. eric7

Mon, 05 Dec 2022 11:58:39 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Mon, 05 Dec 2022 11:58:39 +0100
branch
eric7
changeset 9565
ed264631ab1e
parent 9564
f413aee05c4d
child 9566
d4986df5d2e4

Updated 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.EricStringListEditWidget.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.MimeTypesPage.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.Project.UicLoadUi5.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.Project.UicLoadUi6.html file | annotate | diff | comparison | revisions
--- a/src/eric7/APIs/Python3/eric7.api	Mon Dec 05 11:57:53 2022 +0100
+++ b/src/eric7/APIs/Python3/eric7.api	Mon Dec 05 11:58:39 2022 +0100
@@ -1730,10 +1730,12 @@
 eric7.EricWidgets.EricStringListEditWidget.EricStringListEditWidget.getList?4()
 eric7.EricWidgets.EricStringListEditWidget.EricStringListEditWidget.isListEmpty?4()
 eric7.EricWidgets.EricStringListEditWidget.EricStringListEditWidget.on_addButton_clicked?4()
+eric7.EricWidgets.EricStringListEditWidget.EricStringListEditWidget.on_resetButton_clicked?4()
 eric7.EricWidgets.EricStringListEditWidget.EricStringListEditWidget.setAddVisible?4(visible)
 eric7.EricWidgets.EricStringListEditWidget.EricStringListEditWidget.setDefaultVisible?4(visible)
 eric7.EricWidgets.EricStringListEditWidget.EricStringListEditWidget.setList?4(stringList)
 eric7.EricWidgets.EricStringListEditWidget.EricStringListEditWidget.setListWhatsThis?4(txt)
+eric7.EricWidgets.EricStringListEditWidget.EricStringListEditWidget.setResetVisible?4(visible)
 eric7.EricWidgets.EricStringListEditWidget.EricStringListEditWidget.setToDefault?7
 eric7.EricWidgets.EricStringListEditWidget.EricStringListEditWidget?1(parent=None)
 eric7.EricWidgets.EricTabWidget.EricDnDTabBar.dragEnterEvent?4(event)
@@ -7955,9 +7957,11 @@
 eric7.Project.TranslationPropertiesDialog.TranslationPropertiesDialog?1(project, new, parent)
 eric7.Project.UicCompilerOptionsDialog.UicCompilerOptionsDialog.getData?4()
 eric7.Project.UicCompilerOptionsDialog.UicCompilerOptionsDialog?1(compilerOptions, compiler, parent=None)
+eric7.Project.UicLoadUi5._printout?5(dataString)
 eric7.Project.UicLoadUi5.className?4(formFile, projectPath)
 eric7.Project.UicLoadUi5.objectName?4(formFile, projectPath)
 eric7.Project.UicLoadUi5.signatures?4(formFile, projectPath)
+eric7.Project.UicLoadUi6._printout?5(dataString)
 eric7.Project.UicLoadUi6.className?4(formFile, projectPath)
 eric7.Project.UicLoadUi6.objectName?4(formFile, projectPath)
 eric7.Project.UicLoadUi6.signatures?4(formFile, projectPath)
Binary file src/eric7/Documentation/Help/source.qch has changed
--- a/src/eric7/Documentation/Help/source.qhp	Mon Dec 05 11:57:53 2022 +0100
+++ b/src/eric7/Documentation/Help/source.qhp	Mon Dec 05 11:58:39 2022 +0100
@@ -5619,10 +5619,12 @@
       <keyword name="EricStringListEditWidget.getList" id="EricStringListEditWidget.getList" ref="eric7.EricWidgets.EricStringListEditWidget.html#EricStringListEditWidget.getList" />
       <keyword name="EricStringListEditWidget.isListEmpty" id="EricStringListEditWidget.isListEmpty" ref="eric7.EricWidgets.EricStringListEditWidget.html#EricStringListEditWidget.isListEmpty" />
       <keyword name="EricStringListEditWidget.on_addButton_clicked" id="EricStringListEditWidget.on_addButton_clicked" ref="eric7.EricWidgets.EricStringListEditWidget.html#EricStringListEditWidget.on_addButton_clicked" />
+      <keyword name="EricStringListEditWidget.on_resetButton_clicked" id="EricStringListEditWidget.on_resetButton_clicked" ref="eric7.EricWidgets.EricStringListEditWidget.html#EricStringListEditWidget.on_resetButton_clicked" />
       <keyword name="EricStringListEditWidget.setAddVisible" id="EricStringListEditWidget.setAddVisible" ref="eric7.EricWidgets.EricStringListEditWidget.html#EricStringListEditWidget.setAddVisible" />
       <keyword name="EricStringListEditWidget.setDefaultVisible" id="EricStringListEditWidget.setDefaultVisible" ref="eric7.EricWidgets.EricStringListEditWidget.html#EricStringListEditWidget.setDefaultVisible" />
       <keyword name="EricStringListEditWidget.setList" id="EricStringListEditWidget.setList" ref="eric7.EricWidgets.EricStringListEditWidget.html#EricStringListEditWidget.setList" />
       <keyword name="EricStringListEditWidget.setListWhatsThis" id="EricStringListEditWidget.setListWhatsThis" ref="eric7.EricWidgets.EricStringListEditWidget.html#EricStringListEditWidget.setListWhatsThis" />
+      <keyword name="EricStringListEditWidget.setResetVisible" id="EricStringListEditWidget.setResetVisible" ref="eric7.EricWidgets.EricStringListEditWidget.html#EricStringListEditWidget.setResetVisible" />
       <keyword name="EricTabWidget" id="EricTabWidget" ref="eric7.EricWidgets.EricTabWidget.html#EricTabWidget" />
       <keyword name="EricTabWidget (Constructor)" id="EricTabWidget (Constructor)" ref="eric7.EricWidgets.EricTabWidget.html#EricTabWidget.__init__" />
       <keyword name="EricTabWidget (Module)" id="EricTabWidget (Module)" ref="eric7.EricWidgets.EricTabWidget.html" />
@@ -10616,7 +10618,8 @@
       <keyword name="MimeTypesPage" id="MimeTypesPage" ref="eric7.Preferences.ConfigurationPages.MimeTypesPage.html#MimeTypesPage" />
       <keyword name="MimeTypesPage (Constructor)" id="MimeTypesPage (Constructor)" ref="eric7.Preferences.ConfigurationPages.MimeTypesPage.html#MimeTypesPage.__init__" />
       <keyword name="MimeTypesPage (Module)" id="MimeTypesPage (Module)" ref="eric7.Preferences.ConfigurationPages.MimeTypesPage.html" />
-      <keyword name="MimeTypesPage.__setToDefault" id="MimeTypesPage.__setToDefault" ref="eric7.Preferences.ConfigurationPages.MimeTypesPage.html#MimeTypesPage.__setToDefault" />
+      <keyword name="MimeTypesPage.__setFilePatternsToDefault" id="MimeTypesPage.__setFilePatternsToDefault" ref="eric7.Preferences.ConfigurationPages.MimeTypesPage.html#MimeTypesPage.__setFilePatternsToDefault" />
+      <keyword name="MimeTypesPage.__setMimeTypesToDefault" id="MimeTypesPage.__setMimeTypesToDefault" ref="eric7.Preferences.ConfigurationPages.MimeTypesPage.html#MimeTypesPage.__setMimeTypesToDefault" />
       <keyword name="MimeTypesPage.save" id="MimeTypesPage.save" ref="eric7.Preferences.ConfigurationPages.MimeTypesPage.html#MimeTypesPage.save" />
       <keyword name="MiniEditor" id="MiniEditor" ref="eric7.QScintilla.MiniEditor.html#MiniEditor" />
       <keyword name="MiniEditor (Constructor)" id="MiniEditor (Constructor)" ref="eric7.QScintilla.MiniEditor.html#MiniEditor.__init__" />
@@ -18423,6 +18426,8 @@
       <keyword name="_percentReplacementFunc" id="_percentReplacementFunc" ref="eric7.Utilities.__init__.html#_percentReplacementFunc" />
       <keyword name="_prettifyJSON" id="_prettifyJSON" ref="eric7.CycloneDXInterface.CycloneDXUtilities.html#_prettifyJSON" />
       <keyword name="_prettifyXML" id="_prettifyXML" ref="eric7.CycloneDXInterface.CycloneDXUtilities.html#_prettifyXML" />
+      <keyword name="_printout" id="_printout" ref="eric7.Project.UicLoadUi5.html#_printout" />
+      <keyword name="_printout" id="_printout" ref="eric7.Project.UicLoadUi6.html#_printout" />
       <keyword name="_shallPatch" id="_shallPatch" ref="eric7.DebugClients.Python.MultiProcessDebugExtension.html#_shallPatch" />
       <keyword name="_statIsDangerous" id="_statIsDangerous" ref="eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.generalFilePermissions.html#_statIsDangerous" />
       <keyword name="_stylesheet" id="_stylesheet" ref="eric7.UI.CodeDocumentationViewerTemplate.html#_stylesheet" />
--- a/src/eric7/Documentation/Source/eric7.EricWidgets.EricStringListEditWidget.html	Mon Dec 05 11:57:53 2022 +0100
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricStringListEditWidget.html	Mon Dec 05 11:58:39 2022 +0100
@@ -83,6 +83,10 @@
 <td>Private slot to add an entry to the list.</td>
 </tr>
 <tr>
+<td><a href="#EricStringListEditWidget.on_resetButton_clicked">on_resetButton_clicked</a></td>
+<td>Public slot to reset the list to its initial value.</td>
+</tr>
+<tr>
 <td><a href="#EricStringListEditWidget.setAddVisible">setAddVisible</a></td>
 <td>Public method to show or hide the add button.</td>
 </tr>
@@ -98,6 +102,10 @@
 <td><a href="#EricStringListEditWidget.setListWhatsThis">setListWhatsThis</a></td>
 <td>Public method to set a what's that help text for the string list.</td>
 </tr>
+<tr>
+<td><a href="#EricStringListEditWidget.setResetVisible">setResetVisible</a></td>
+<td>Public method to show or hide the reset button.</td>
+</tr>
 </table>
 <h3>Static Methods</h3>
 
@@ -114,9 +122,9 @@
 </p>
 <dl>
 
-<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="EricStringListEditWidget.count" ID="EricStringListEditWidget.count"></a>
@@ -148,7 +156,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-edited list of string (list of string)
+edited list of string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="EricStringListEditWidget.isListEmpty" ID="EricStringListEditWidget.isListEmpty"></a>
@@ -177,6 +191,13 @@
 <p>
         Private slot to add an entry to the list.
 </p>
+<a NAME="EricStringListEditWidget.on_resetButton_clicked" ID="EricStringListEditWidget.on_resetButton_clicked"></a>
+<h4>EricStringListEditWidget.on_resetButton_clicked</h4>
+<b>on_resetButton_clicked</b>(<i></i>)
+
+<p>
+        Public slot to reset the list to its initial value.
+</p>
 <a NAME="EricStringListEditWidget.setAddVisible" ID="EricStringListEditWidget.setAddVisible"></a>
 <h4>EricStringListEditWidget.setAddVisible</h4>
 <b>setAddVisible</b>(<i>visible</i>)
@@ -214,9 +235,9 @@
 </p>
 <dl>
 
-<dt><i>stringList</i></dt>
+<dt><i>stringList</i> (list of str)</dt>
 <dd>
-list of strings to be edited (list of string)
+list of strings to be edited
 </dd>
 </dl>
 <a NAME="EricStringListEditWidget.setListWhatsThis" ID="EricStringListEditWidget.setListWhatsThis"></a>
@@ -228,9 +249,23 @@
 </p>
 <dl>
 
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
 <dd>
-help text to be set (string)
+help text to be set
+</dd>
+</dl>
+<a NAME="EricStringListEditWidget.setResetVisible" ID="EricStringListEditWidget.setResetVisible"></a>
+<h4>EricStringListEditWidget.setResetVisible</h4>
+<b>setResetVisible</b>(<i>visible</i>)
+
+<p>
+        Public method to show or hide the reset button.
+</p>
+<dl>
+
+<dt><i>visible</i> (bool)</dt>
+<dd>
+flag indicating the visibility of the reset button
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.MimeTypesPage.html	Mon Dec 05 11:57:53 2022 +0100
+++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.MimeTypesPage.html	Mon Dec 05 11:58:39 2022 +0100
@@ -63,8 +63,12 @@
 <td>Constructor</td>
 </tr>
 <tr>
-<td><a href="#MimeTypesPage.__setToDefault">__setToDefault</a></td>
-<td>Private slot to set the message list to the default values.</td>
+<td><a href="#MimeTypesPage.__setFilePatternsToDefault">__setFilePatternsToDefault</a></td>
+<td>Private slot to set the file patterns list to the default values.</td>
+</tr>
+<tr>
+<td><a href="#MimeTypesPage.__setMimeTypesToDefault">__setMimeTypesToDefault</a></td>
+<td>Private slot to set the mimetypes list to the default values.</td>
 </tr>
 <tr>
 <td><a href="#MimeTypesPage.save">save</a></td>
@@ -84,12 +88,19 @@
 <p>
         Constructor
 </p>
-<a NAME="MimeTypesPage.__setToDefault" ID="MimeTypesPage.__setToDefault"></a>
-<h4>MimeTypesPage.__setToDefault</h4>
-<b>__setToDefault</b>(<i></i>)
+<a NAME="MimeTypesPage.__setFilePatternsToDefault" ID="MimeTypesPage.__setFilePatternsToDefault"></a>
+<h4>MimeTypesPage.__setFilePatternsToDefault</h4>
+<b>__setFilePatternsToDefault</b>(<i></i>)
 
 <p>
-        Private slot to set the message list to the default values.
+        Private slot to set the file patterns list to the default values.
+</p>
+<a NAME="MimeTypesPage.__setMimeTypesToDefault" ID="MimeTypesPage.__setMimeTypesToDefault"></a>
+<h4>MimeTypesPage.__setMimeTypesToDefault</h4>
+<b>__setMimeTypesToDefault</b>(<i></i>)
+
+<p>
+        Private slot to set the mimetypes list to the default values.
 </p>
 <a NAME="MimeTypesPage.save" ID="MimeTypesPage.save"></a>
 <h4>MimeTypesPage.save</h4>
--- a/src/eric7/Documentation/Source/eric7.Project.UicLoadUi5.html	Mon Dec 05 11:57:53 2022 +0100
+++ b/src/eric7/Documentation/Source/eric7.Project.UicLoadUi5.html	Mon Dec 05 11:58:39 2022 +0100
@@ -30,6 +30,10 @@
 <td>Private function to map a type as reported by Qt's meta object to the correct Python type.</td>
 </tr>
 <tr>
+<td><a href="#_printout">_printout</a></td>
+<td>Function to print the given string to sys.stdout with a guard string.</td>
+</tr>
+<tr>
 <td><a href="#className">className</a></td>
 <td>Function to get the class name of a form.</td>
 </tr>
@@ -74,6 +78,23 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
+<a NAME="_printout" ID="_printout"></a>
+<h2>_printout</h2>
+<b>_printout</b>(<i>dataString</i>)
+
+<p>
+    Function to print the given string to sys.stdout with a guard string.
+</p>
+<dl>
+
+<dt><i>dataString</i> (str)</dt>
+<dd>
+string to be printed
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
 <a NAME="className" ID="className"></a>
 <h2>className</h2>
 <b>className</b>(<i>formFile, projectPath</i>)
--- a/src/eric7/Documentation/Source/eric7.Project.UicLoadUi6.html	Mon Dec 05 11:57:53 2022 +0100
+++ b/src/eric7/Documentation/Source/eric7.Project.UicLoadUi6.html	Mon Dec 05 11:58:39 2022 +0100
@@ -30,6 +30,10 @@
 <td>Private function to map a type as reported by Qt's meta object to the correct Python type.</td>
 </tr>
 <tr>
+<td><a href="#_printout">_printout</a></td>
+<td>Function to print the given string to sys.stdout with a guard string.</td>
+</tr>
+<tr>
 <td><a href="#className">className</a></td>
 <td>Function to get the class name of a form.</td>
 </tr>
@@ -74,6 +78,23 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
+<a NAME="_printout" ID="_printout"></a>
+<h2>_printout</h2>
+<b>_printout</b>(<i>dataString</i>)
+
+<p>
+    Function to print the given string to sys.stdout with a guard string.
+</p>
+<dl>
+
+<dt><i>dataString</i> (str)</dt>
+<dd>
+string to be printed
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
 <a NAME="className" ID="className"></a>
 <h2>className</h2>
 <b>className</b>(<i>formFile, projectPath</i>)

eric ide

mercurial