Fri, 27 Oct 2023 14:09:40 +0200
Regenerated the source documentation with the corrected module parser.
--- a/src/eric7/Documentation/Help/source.qhp Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Help/source.qhp Fri Oct 27 14:09:40 2023 +0200 @@ -19403,6 +19403,7 @@ <keyword name="__getMainPassword" id="__getMainPassword" ref="eric7.Utilities.crypto.__init__.html#__getMainPassword" /> <keyword name="__getPygmentsLexer" id="__getPygmentsLexer" ref="eric7.QScintilla.Lexers.__init__.html#__getPygmentsLexer" /> <keyword name="__initChannelModesDict" id="__initChannelModesDict" ref="eric7.Network.IRC.IrcUtilities.html#__initChannelModesDict" /> + <keyword name="__init__" id="__init__" ref="eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html#__init__" /> <keyword name="__initializeCondaInterface" id="__initializeCondaInterface" ref="eric7.CondaInterface.__init__.html#__initializeCondaInterface" /> <keyword name="__jsonSyntaxCheck" id="__jsonSyntaxCheck" ref="eric7.Plugins.CheckerPlugins.SyntaxChecker.jsonCheckSyntax.html#__jsonSyntaxCheck" /> <keyword name="__main__ (Module)" id="__main__ (Module)" ref="eric7.__main__.html" /> @@ -19465,6 +19466,7 @@ <keyword name="aboutIsort" id="aboutIsort" ref="eric7.CodeFormatting.IsortUtilities.html#aboutIsort" /> <keyword name="absolutePath" id="absolutePath" ref="eric7.SystemUtilities.FileSystemUtilities.html#absolutePath" /> <keyword name="absoluteUniversalPath" id="absoluteUniversalPath" ref="eric7.SystemUtilities.FileSystemUtilities.html#absoluteUniversalPath" /> + <keyword name="activate" id="activate" ref="eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html#activate" /> <keyword name="addActions" id="addActions" ref="eric7.EricGui.EricAction.html#addActions" /> <keyword name="addCycloneDXDependencies" id="addCycloneDXDependencies" ref="eric7.CycloneDXInterface.CycloneDXUtilities.html#addCycloneDXDependencies" /> <keyword name="addCycloneDXVulnerabilities" id="addCycloneDXVulnerabilities" ref="eric7.CycloneDXInterface.CycloneDXUtilities.html#addCycloneDXVulnerabilities" /> @@ -19760,6 +19762,7 @@ <keyword name="dataString" id="dataString" ref="eric7.Globals.__init__.html#dataString" /> <keyword name="dataString" id="dataString" ref="eric7.WebBrowser.Download.DownloadUtilities.html#dataString" /> <keyword name="dateFromTime_t" id="dateFromTime_t" ref="eric7.Plugins.VcsPlugins.vcsPySvn.SvnUtilities.html#dateFromTime_t" /> + <keyword name="deactivate" id="deactivate" ref="eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html#deactivate" /> <keyword name="decode" id="decode" ref="eric7.Utilities.__init__.html#decode" /> <keyword name="decodeBytes" id="decodeBytes" ref="eric7.Utilities.__init__.html#decodeBytes" /> <keyword name="decodeString" id="decodeString" ref="eric7.Utilities.__init__.html#decodeString" /> @@ -20020,6 +20023,7 @@ <keyword name="getPixmap" id="getPixmap" ref="eric7.EricGui.EricPixmapCache.html#getPixmap" /> <keyword name="getPluginHeaderEntry" id="getPluginHeaderEntry" ref="eric7.PluginManager.PluginUtilities.html#getPluginHeaderEntry" /> <keyword name="getPluginManager" id="getPluginManager" ref="eric7.Preferences.__init__.html#getPluginManager" /> + <keyword name="getPreferences" id="getPreferences" ref="eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html#getPreferences" /> <keyword name="getPrinter" id="getPrinter" ref="eric7.Preferences.__init__.html#getPrinter" /> <keyword name="getProfileFileName" id="getProfileFileName" ref="eric7.Utilities.__init__.html#getProfileFileName" /> <keyword name="getProfileFileNames" id="getProfileFileNames" ref="eric7.Utilities.__init__.html#getProfileFileNames" /> @@ -20310,6 +20314,7 @@ <keyword name="prepareUninstall" id="prepareUninstall" ref="eric7.Plugins.PluginVcsMercurial.html#prepareUninstall" /> <keyword name="prepareUninstall" id="prepareUninstall" ref="eric7.Plugins.PluginVcsPySvn.html#prepareUninstall" /> <keyword name="prepareUninstall" id="prepareUninstall" ref="eric7.Plugins.PluginVcsSubversion.html#prepareUninstall" /> + <keyword name="prepareUninstall" id="prepareUninstall" ref="eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html#prepareUninstall" /> <keyword name="previewPix" id="previewPix" ref="eric7.Plugins.PluginVmListspace.html#previewPix" /> <keyword name="previewPix" id="previewPix" ref="eric7.Plugins.PluginVmTabview.html#previewPix" /> <keyword name="printerr" id="printerr" ref="eric7.DebugClients.Python.DebugBase.html#printerr" /> @@ -20426,6 +20431,7 @@ <keyword name="setPdfViewer" id="setPdfViewer" ref="eric7.Preferences.__init__.html#setPdfViewer" /> <keyword name="setPip" id="setPip" ref="eric7.Preferences.__init__.html#setPip" /> <keyword name="setPluginManager" id="setPluginManager" ref="eric7.Preferences.__init__.html#setPluginManager" /> + <keyword name="setPreferences" id="setPreferences" ref="eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html#setPreferences" /> <keyword name="setPrinter" id="setPrinter" ref="eric7.Preferences.__init__.html#setPrinter" /> <keyword name="setProject" id="setProject" ref="eric7.Preferences.__init__.html#setProject" /> <keyword name="setProjectBrowserColour" id="setProjectBrowserColour" ref="eric7.Preferences.__init__.html#setProjectBrowserColour" />
--- a/src/eric7/Documentation/Source/eric7.CodeFormatting.BlackFormattingDialog.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.CodeFormatting.BlackFormattingDialog.html Fri Oct 27 14:09:40 2023 +0200 @@ -461,7 +461,7 @@ </tr> <tr> <td><a href="#BlackMultiprocessingReport.path_ignored">path_ignored</a></td> -<td></td> +<td>Public method handling an ignored path.</td> </tr> </table> <h3>Static Methods</h3> @@ -528,6 +528,20 @@ <h4>BlackMultiprocessingReport.path_ignored</h4> <b>path_ignored</b>(<i>src, message=""</i>) +<p> + Public method handling an ignored path. +</p> +<dl> + +<dt><i>src</i> (pathlib.Path or str)</dt> +<dd> +name of the processed file +</dd> +<dt><i>message</i> (str (optional))</dt> +<dd> +ignore message (default to "") +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -612,7 +626,7 @@ </tr> <tr> <td><a href="#BlackReport.path_ignored">path_ignored</a></td> -<td></td> +<td>Public method handling an ignored path.</td> </tr> </table> <h3>Static Methods</h3> @@ -679,6 +693,20 @@ <h4>BlackReport.path_ignored</h4> <b>path_ignored</b>(<i>src, message=""</i>) +<p> + Public method handling an ignored path. +</p> +<dl> + +<dt><i>src</i> (pathlib.Path or str)</dt> +<dd> +name of the processed file +</dd> +<dt><i>message</i> (str (optional))</dt> +<dd> +ignore message (default to "") +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.CodeFormatting.FormattingDiffWidget.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.CodeFormatting.FormattingDiffWidget.html Fri Oct 27 14:09:40 2023 +0200 @@ -60,7 +60,7 @@ </tr> <tr> <td><a href="#FormattingDiffWidget.closeEvent">closeEvent</a></td> -<td></td> +<td>Protected slot implementing a close event handler.</td> </tr> <tr> <td><a href="#FormattingDiffWidget.showDiff">showDiff</a></td> @@ -91,6 +91,16 @@ <h4>FormattingDiffWidget.closeEvent</h4> <b>closeEvent</b>(<i>evt</i>) +<p> + Protected slot implementing a close event handler. +</p> +<dl> + +<dt><i>evt</i> (QCloseEvent)</dt> +<dd> +reference to the close event +</dd> +</dl> <a NAME="FormattingDiffWidget.showDiff" ID="FormattingDiffWidget.showDiff"></a> <h4>FormattingDiffWidget.showDiff</h4> <b>showDiff</b>(<i>diff</i>)
--- a/src/eric7/Documentation/Source/eric7.DebugClients.Python.AsyncFile.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.DebugClients.Python.AsyncFile.html Fri Oct 27 14:09:40 2023 +0200 @@ -117,7 +117,7 @@ </tr> <tr> <td><a href="#AsyncFile.seek">seek</a></td> -<td></td> +<td>Public method to move the filepointer.</td> </tr> <tr> <td><a href="#AsyncFile.seekable">seekable</a></td> @@ -129,7 +129,7 @@ </tr> <tr> <td><a href="#AsyncFile.truncate">truncate</a></td> -<td></td> +<td>Public method to truncate the file.</td> </tr> <tr> <td><a href="#AsyncFile.writable">writable</a></td> @@ -455,6 +455,28 @@ <h4>AsyncFile.seek</h4> <b>seek</b>(<i>offset, whence=0</i>) +<p> + Public method to move the filepointer. +</p> +<dl> + +<dt><i>offset</i> (int)</dt> +<dd> +offset to move the filepointer to +</dd> +<dt><i>whence</i> (int)</dt> +<dd> +position the offset relates to +</dd> +</dl> +<dl> + +<dt>Raises <b>OSError</b>:</dt> +<dd> +This method is not supported and always raises an + OSError. +</dd> +</dl> <a NAME="AsyncFile.seekable" ID="AsyncFile.seekable"></a> <h4>AsyncFile.seekable</h4> <b>seekable</b>(<i></i>) @@ -493,6 +515,24 @@ <h4>AsyncFile.truncate</h4> <b>truncate</b>(<i>size=-1</i>) +<p> + Public method to truncate the file. +</p> +<dl> + +<dt><i>size</i> (int)</dt> +<dd> +size to truncate to +</dd> +</dl> +<dl> + +<dt>Raises <b>OSError</b>:</dt> +<dd> +This method is not supported and always raises an + OSError. +</dd> +</dl> <a NAME="AsyncFile.writable" ID="AsyncFile.writable"></a> <h4>AsyncFile.writable</h4> <b>writable</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.DebugClients.Python.DebugBase.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.DebugClients.Python.DebugBase.html Fri Oct 27 14:09:40 2023 +0200 @@ -147,11 +147,11 @@ </tr> <tr> <td><a href="#DebugBase.profile">profile</a></td> -<td></td> +<td>Public method used to trace some stuff independent of the debugger trace function.</td> </tr> <tr> <td><a href="#DebugBase.profileWithRecursion">profileWithRecursion</a></td> -<td></td> +<td>Public method used to trace some stuff independent of the debugger trace function.</td> </tr> <tr> <td><a href="#DebugBase.run">run</a></td> @@ -680,10 +680,55 @@ <h4>DebugBase.profile</h4> <b>profile</b>(<i>frame, event, arg</i>) +<p> + Public method used to trace some stuff independent of the debugger + trace function. +</p> +<dl> + +<dt><i>frame</i> (frame object)</dt> +<dd> +current stack frame +</dd> +<dt><i>event</i> (str)</dt> +<dd> +trace event +</dd> +<dt><i>arg</i> (depends on the previous event parameter)</dt> +<dd> +arguments +</dd> +</dl> <a NAME="DebugBase.profileWithRecursion" ID="DebugBase.profileWithRecursion"></a> <h4>DebugBase.profileWithRecursion</h4> <b>profileWithRecursion</b>(<i>frame, event, arg</i>) +<p> + Public method used to trace some stuff independent of the debugger + trace function. +</p> +<dl> + +<dt><i>frame</i> (frame object)</dt> +<dd> +current stack frame +</dd> +<dt><i>event</i> (str)</dt> +<dd> +trace event +</dd> +<dt><i>arg</i> (depends on the previous event parameter)</dt> +<dd> +arguments +</dd> +</dl> +<dl> + +<dt>Raises <b>RuntimeError</b>:</dt> +<dd> +raised to indicate too many recursions +</dd> +</dl> <a NAME="DebugBase.run" ID="DebugBase.run"></a> <h4>DebugBase.run</h4> <b>run</b>(<i>cmd, globalsDict=None, localsDict=None, debug=True, closeSession=True</i>)
--- a/src/eric7/Documentation/Source/eric7.DebugClients.Python.ModuleLoader.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.DebugClients.Python.ModuleLoader.html Fri Oct 27 14:09:40 2023 +0200 @@ -72,7 +72,7 @@ </tr> <tr> <td><a href="#ModuleLoader.find_spec">find_spec</a></td> -<td></td> +<td>Public method returning the module spec.</td> </tr> </table> <h3>Static Methods</h3> @@ -165,6 +165,37 @@ <h4>ModuleLoader.find_spec</h4> <b>find_spec</b>(<i>fullname, path, target=None</i>) +<p> + Public method returning the module spec. +</p> +<dl> + +<dt><i>fullname</i> (str)</dt> +<dd> +name of the module to be loaded +</dd> +<dt><i>path</i> (str)</dt> +<dd> +path to resolve the module name +</dd> +<dt><i>target</i> (module)</dt> +<dd> +module object to use for a more educated guess + about what spec to return +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +module spec object pointing to the module loader +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +ModuleSpec +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.DebugClients.Python.getpass.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.DebugClients.Python.getpass.html Fri Oct 27 14:09:40 2023 +0200 @@ -35,7 +35,7 @@ <tr> <td><a href="#getpass">getpass</a></td> -<td></td> +<td>Function to prompt for a password, with echo turned off.</td> </tr> <tr> <td><a href="#getuser">getuser</a></td> @@ -48,6 +48,32 @@ <h2>getpass</h2> <b>getpass</b>(<i>prompt="Password: ", stream=None</i>) +<p> + Function to prompt for a password, with echo turned off. +</p> +<dl> + +<dt><i>prompt</i> (str)</dt> +<dd> +Prompt to be shown to the user +</dd> +<dt><i>stream</i> (file)</dt> +<dd> +input stream to read from (ignored) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +Password entered by the user +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Debugger.BreakPointModel.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Debugger.BreakPointModel.html Fri Oct 27 14:09:40 2023 +0200 @@ -77,7 +77,7 @@ </tr> <tr> <td><a href="#BreakPointModel.columnCount">columnCount</a></td> -<td></td> +<td>Public method to get the current column count.</td> </tr> <tr> <td><a href="#BreakPointModel.data">data</a></td> @@ -129,7 +129,7 @@ </tr> <tr> <td><a href="#BreakPointModel.parent">parent</a></td> -<td></td> +<td>Public method to get the parent index.</td> </tr> <tr> <td><a href="#BreakPointModel.rowCount">rowCount</a></td> @@ -145,7 +145,7 @@ </tr> <tr> <td><a href="#BreakPointModel.setData">setData</a></td> -<td></td> +<td>Public method to change data in the model.</td> </tr> </table> <h3>Static Methods</h3> @@ -214,6 +214,28 @@ <h4>BreakPointModel.columnCount</h4> <b>columnCount</b>(<i>parent=None</i>) +<p> + Public method to get the current column count. +</p> +<dl> + +<dt><i>parent</i> (QModelIndex)</dt> +<dd> +reference to parent index (Unused) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +column count +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int +</dd> +</dl> <a NAME="BreakPointModel.data" ID="BreakPointModel.data"></a> <h4>BreakPointModel.data</h4> <b>data</b>(<i>index, role=Qt.ItemDataRole.DisplayRole</i>) @@ -506,6 +528,28 @@ <h4>BreakPointModel.parent</h4> <b>parent</b>(<i>index</i>) +<p> + Public method to get the parent index. +</p> +<dl> + +<dt><i>index</i> (QModelIndex)</dt> +<dd> +index of item to get parent +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +index of parent +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QModelIndex +</dd> +</dl> <a NAME="BreakPointModel.rowCount" ID="BreakPointModel.rowCount"></a> <h4>BreakPointModel.rowCount</h4> <b>rowCount</b>(<i>parent=None</i>) @@ -581,6 +625,36 @@ <h4>BreakPointModel.setData</h4> <b>setData</b>(<i>index, value, role=Qt.ItemDataRole.EditRole</i>) +<p> + Public method to change data in the model. +</p> +<dl> + +<dt><i>index</i> (QModelIndex)</dt> +<dd> +index of the changed data +</dd> +<dt><i>value</i> (any)</dt> +<dd> +value of the changed data +</dd> +<dt><i>role</i> (Qt.ItemDataRole)</dt> +<dd> +role of the changed data +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Debugger.DebugUI.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Debugger.DebugUI.html Fri Oct 27 14:09:40 2023 +0200 @@ -109,7 +109,7 @@ </tr> <tr> <td><a href="#DebugUI.__clientBreakConditionError">__clientBreakConditionError</a></td> -<td></td> +<td>Private method to handle a condition error of a breakpoint.</td> </tr> <tr> <td><a href="#DebugUI.__clientDebuggerId">__clientDebuggerId</a></td> @@ -133,7 +133,7 @@ </tr> <tr> <td><a href="#DebugUI.__clientLine">__clientLine</a></td> -<td></td> +<td>Private method to handle a change to the current line.</td> </tr> <tr> <td><a href="#DebugUI.__clientSignal">__clientSignal</a></td> @@ -157,7 +157,7 @@ </tr> <tr> <td><a href="#DebugUI.__clientWatchConditionError">__clientWatchConditionError</a></td> -<td></td> +<td>Private method to handle a expression error of a watch expression.</td> </tr> <tr> <td><a href="#DebugUI.__configureExceptionsFilter">__configureExceptionsFilter</a></td> @@ -525,6 +525,24 @@ <h4>DebugUI.__clientBreakConditionError</h4> <b>__clientBreakConditionError</b>(<i>filename, lineno, debuggerId</i>) +<p> + Private method to handle a condition error of a breakpoint. +</p> +<dl> + +<dt><i>filename</i> (str)</dt> +<dd> +filename of the breakpoint +</dd> +<dt><i>lineno</i> (int)</dt> +<dd> +line umber of the breakpoint +</dd> +<dt><i>debuggerId</i> (str)</dt> +<dd> +ID of the debugger backend +</dd> +</dl> <a NAME="DebugUI.__clientDebuggerId" ID="DebugUI.__clientDebuggerId"></a> <h4>DebugUI.__clientDebuggerId</h4> <b>__clientDebuggerId</b>(<i>debuggerId</i>) @@ -628,6 +646,32 @@ <h4>DebugUI.__clientLine</h4> <b>__clientLine</b>(<i>fn, line, debuggerId, threadName, forStack</i>) +<p> + Private method to handle a change to the current line. +</p> +<dl> + +<dt><i>fn</i> (str)</dt> +<dd> +filename +</dd> +<dt><i>line</i> (int)</dt> +<dd> +linenumber +</dd> +<dt><i>debuggerId</i> (str)</dt> +<dd> +ID of the debugger backend +</dd> +<dt><i>threadName</i> (str)</dt> +<dd> +name of the thread signaling the event +</dd> +<dt><i>forStack</i> (bool)</dt> +<dd> +flag indicating this is for a stack dump +</dd> +</dl> <a NAME="DebugUI.__clientSignal" ID="DebugUI.__clientSignal"></a> <h4>DebugUI.__clientSignal</h4> <b>__clientSignal</b>(<i>message, filename, lineNo, funcName, funcArgs, debuggerId</i>) @@ -755,6 +799,23 @@ <h4>DebugUI.__clientWatchConditionError</h4> <b>__clientWatchConditionError</b>(<i>cond, debuggerId</i>) +<p> + Private method to handle a expression error of a watch expression. +</p> +<p> + Note: This can only happen for normal watch expressions +</p> +<dl> + +<dt><i>cond</i> (str)</dt> +<dd> +expression of the watch expression +</dd> +<dt><i>debuggerId</i> (str)</dt> +<dd> +ID of the debugger backend +</dd> +</dl> <a NAME="DebugUI.__configureExceptionsFilter" ID="DebugUI.__configureExceptionsFilter"></a> <h4>DebugUI.__configureExceptionsFilter</h4> <b>__configureExceptionsFilter</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Debugger.DebugViewer.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Debugger.DebugViewer.html Fri Oct 27 14:09:40 2023 +0200 @@ -117,7 +117,7 @@ </tr> <tr> <td><a href="#DebugViewer.__clientLine">__clientLine</a></td> -<td></td> +<td>Private method to handle a change to the current line.</td> </tr> <tr> <td><a href="#DebugViewer.__clientSyntaxError">__clientSyntaxError</a></td> @@ -125,7 +125,7 @@ </tr> <tr> <td><a href="#DebugViewer.__debuggerSelected">__debuggerSelected</a></td> -<td></td> +<td>Private slot to handle the selection of a debugger backend in the debuggers list.</td> </tr> <tr> <td><a href="#DebugViewer.__frameSelected">__frameSelected</a></td> @@ -389,6 +389,28 @@ <h4>DebugViewer.__clientLine</h4> <b>__clientLine</b>(<i>fn, line, debuggerId, threadName</i>) +<p> + Private method to handle a change to the current line. +</p> +<dl> + +<dt><i>fn</i> (str)</dt> +<dd> +filename +</dd> +<dt><i>line</i> (int)</dt> +<dd> +linenumber +</dd> +<dt><i>debuggerId</i> (str)</dt> +<dd> +ID of the debugger backend +</dd> +<dt><i>threadName</i> (str)</dt> +<dd> +name of the thread signaling the event +</dd> +</dl> <a NAME="DebugViewer.__clientSyntaxError" ID="DebugViewer.__clientSyntaxError"></a> <h4>DebugViewer.__clientSyntaxError</h4> <b>__clientSyntaxError</b>(<i>message, filename, lineNo, characterNo, debuggerId, threadName, </i>) @@ -427,6 +449,21 @@ <h4>DebugViewer.__debuggerSelected</h4> <b>__debuggerSelected</b>(<i>current, previous</i>) +<p> + Private slot to handle the selection of a debugger backend in the + debuggers list. +</p> +<dl> + +<dt><i>current</i> (QTreeWidgetItem)</dt> +<dd> +reference to the new current item +</dd> +<dt><i>previous</i> (QTreeWidgetItem)</dt> +<dd> +reference to the previous current item +</dd> +</dl> <a NAME="DebugViewer.__frameSelected" ID="DebugViewer.__frameSelected"></a> <h4>DebugViewer.__frameSelected</h4> <b>__frameSelected</b>(<i>frmnr</i>)
--- a/src/eric7/Documentation/Source/eric7.Debugger.DebuggerInterfacePython.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Debugger.DebuggerInterfacePython.html Fri Oct 27 14:09:40 2023 +0200 @@ -85,7 +85,7 @@ </tr> <tr> <td><a href="#DebuggerInterfacePython.__identityTranslation">__identityTranslation</a></td> -<td></td> +<td>Private method to perform the identity path translation.</td> </tr> <tr> <td><a href="#DebuggerInterfacePython.__parseClientLine">__parseClientLine</a></td> @@ -365,6 +365,33 @@ <h4>DebuggerInterfacePython.__identityTranslation</h4> <b>__identityTranslation</b>(<i>fn, remote2local=True</i>) +<p> + Private method to perform the identity path translation. +</p> +<dl> + +<dt><i>fn</i> (str)</dt> +<dd> +filename to be translated +</dd> +<dt><i>remote2local</i> (bool)</dt> +<dd> +flag indicating the direction of translation + (False = local to remote, True = remote to local [default]) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +translated filename +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> <a NAME="DebuggerInterfacePython.__parseClientLine" ID="DebuggerInterfacePython.__parseClientLine"></a> <h4>DebuggerInterfacePython.__parseClientLine</h4> <b>__parseClientLine</b>(<i>sock</i>)
--- a/src/eric7/Documentation/Source/eric7.Debugger.VariablesViewer.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Debugger.VariablesViewer.html Fri Oct 27 14:09:40 2023 +0200 @@ -251,7 +251,7 @@ </tr> <tr> <td><a href="#VariablesModel.columnCount">columnCount</a></td> -<td></td> +<td>Public method to get the column count.</td> </tr> <tr> <td><a href="#VariablesModel.data">data</a></td> @@ -446,6 +446,28 @@ <h4>VariablesModel.columnCount</h4> <b>columnCount</b>(<i>parent=QModelIndex()</i>) +<p> + Public method to get the column count. +</p> +<dl> + +<dt><i>parent</i> (QModelIndex)</dt> +<dd> +the model parent +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +number of columns +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int +</dd> +</dl> <a NAME="VariablesModel.data" ID="VariablesModel.data"></a> <h4>VariablesModel.data</h4> <b>data</b>(<i>index, role=Qt.ItemDataRole.DisplayRole</i>)
--- a/src/eric7/Documentation/Source/eric7.Debugger.WatchPointModel.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Debugger.WatchPointModel.html Fri Oct 27 14:09:40 2023 +0200 @@ -77,7 +77,7 @@ </tr> <tr> <td><a href="#WatchPointModel.columnCount">columnCount</a></td> -<td></td> +<td>Public method to get the current column count.</td> </tr> <tr> <td><a href="#WatchPointModel.data">data</a></td> @@ -125,7 +125,7 @@ </tr> <tr> <td><a href="#WatchPointModel.parent">parent</a></td> -<td></td> +<td>Public method to get the parent index.</td> </tr> <tr> <td><a href="#WatchPointModel.rowCount">rowCount</a></td> @@ -202,6 +202,22 @@ <h4>WatchPointModel.columnCount</h4> <b>columnCount</b>(<i>parent=None</i>) +<p> + Public method to get the current column count. +</p> +<dl> + +<dt><i>parent</i></dt> +<dd> +index of the parent item (QModelIndex) (Unused) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +column count (integer) +</dd> +</dl> <a NAME="WatchPointModel.data" ID="WatchPointModel.data"></a> <h4>WatchPointModel.data</h4> <b>data</b>(<i>index, role</i>) @@ -433,6 +449,22 @@ <h4>WatchPointModel.parent</h4> <b>parent</b>(<i>index</i>) +<p> + Public method to get the parent index. +</p> +<dl> + +<dt><i>index</i></dt> +<dd> +index of item to get parent (QModelIndex) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +index of parent (QModelIndex) +</dd> +</dl> <a NAME="WatchPointModel.rowCount" ID="WatchPointModel.rowCount"></a> <h4>WatchPointModel.rowCount</h4> <b>rowCount</b>(<i>parent=None</i>)
--- a/src/eric7/Documentation/Source/eric7.EricGraphics.EricArrowItem.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.EricGraphics.EricArrowItem.html Fri Oct 27 14:09:40 2023 +0200 @@ -68,7 +68,7 @@ </tr> <tr> <td><a href="#EricArrowItem.paint">paint</a></td> -<td></td> +<td>Public method to paint the item in local coordinates.</td> </tr> <tr> <td><a href="#EricArrowItem.setEndPoint">setEndPoint</a></td> @@ -140,6 +140,24 @@ <h4>EricArrowItem.paint</h4> <b>paint</b>(<i>painter, option, widget=None</i>) +<p> + Public method to paint the item in local coordinates. +</p> +<dl> + +<dt><i>painter</i></dt> +<dd> +reference to the painter object (QPainter) +</dd> +<dt><i>option</i></dt> +<dd> +style options (QStyleOptionGraphicsItem) +</dd> +<dt><i>widget</i></dt> +<dd> +optional reference to the widget painted on (QWidget) +</dd> +</dl> <a NAME="EricArrowItem.setEndPoint" ID="EricArrowItem.setEndPoint"></a> <h4>EricArrowItem.setEndPoint</h4> <b>setEndPoint</b>(<i>x, y</i>)
--- a/src/eric7/Documentation/Source/eric7.EricNetwork.EricFtp.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.EricNetwork.EricFtp.html Fri Oct 27 14:09:40 2023 +0200 @@ -74,7 +74,7 @@ </tr> <tr> <td><a href="#EricFtp.login">login</a></td> -<td></td> +<td>Public method to login to the FTP server.</td> </tr> <tr> <td><a href="#EricFtp.setProxy">setProxy</a></td> @@ -195,6 +195,125 @@ <h4>EricFtp.login</h4> <b>login</b>(<i>user="", password="", acct=""</i>) +<p> + Public method to login to the FTP server. +</p> +<p> + This extended method respects the FTP proxy configuration. There are + many different FTP proxy products available. But unfortunately there + is no standard for how o traverse a FTP proxy. The lis below shows + the sequence of commands used. +</p> +<p> + <table> + <tr><td>user</td><td>Username for remote host</td></tr> + <tr><td>pass</td><td>Password for remote host</td></tr> + <tr><td>pruser</td><td>Username for FTP proxy</td></tr> + <tr><td>prpass</td><td>Password for FTP proxy</td></tr> + <tr><td>remote.host</td><td>Hostname of the remote FTP server</td> + </tr> + </table> +</p> +<p> + <dl> + <dt>EricFtpProxyType.NO_PROXY:</dt> + <dd> + USER user<br/> + PASS pass + </dd> + <dt>EricFtpProxyType.NON_AUTHORIZING:</dt> + <dd> + USER user@remote.host<br/> + PASS pass + </dd> + <dt>EricFtpProxyType.USER_SERVER:</dt> + <dd> + USER pruser<br/> + PASS prpass<br/> + USER user@remote.host<br/> + PASS pass + </dd> + <dt>EricFtpProxyType.SITE:</dt> + <dd> + USER pruser<br/> + PASS prpass<br/> + SITE remote.site<br/> + USER user<br/> + PASS pass + </dd> + <dt>EricFtpProxyType.OPEN:</dt> + <dd> + USER pruser<br/> + PASS prpass<br/> + OPEN remote.site<br/> + USER user<br/> + PASS pass + </dd> + <dt>EricFtpProxyType.USER_PROXYUSER_SERVER:</dt> + <dd> + USER user@pruser@remote.host<br/> + PASS pass@prpass + </dd> + <dt>EricFtpProxyType.PROXYUSER_SERVER:</dt> + <dd> + USER pruser@remote.host<br/> + PASS prpass<br/> + USER user<br/> + PASS pass + </dd> + <dt>EricFtpProxyType.AUTH_RESP:</dt> + <dd> + USER user@remote.host<br/> + PASS pass<br/> + AUTH pruser<br/> + RESP prpass + </dd> + <dt>EricFtpProxyType.BLUECOAT:</dt> + <dd> + USER user@remote.host pruser<br/> + PASS pass<br/> + ACCT prpass + </dd> + </dl> +</p> +<dl> + +<dt><i>user</i> (str)</dt> +<dd> +username for the remote host +</dd> +<dt><i>password</i> (str)</dt> +<dd> +password for the remote host +</dd> +<dt><i>acct</i> (str)</dt> +<dd> +accounting information for the remote host +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +response sent by the remote host +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<dl> + +<dt>Raises <b>EricFtpProxyError</b>:</dt> +<dd> +raised to indicate a proxy related issue +</dd> +<dt>Raises <b>ftplib.error_reply</b>:</dt> +<dd> +raised to indicate an FTP error reply +</dd> +</dl> <a NAME="EricFtp.setProxy" ID="EricFtp.setProxy"></a> <h4>EricFtp.setProxy</h4> <b>setProxy</b>(<i>proxyType=EricFtpProxyType.NO_PROXY, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount="", </i>)
--- a/src/eric7/Documentation/Source/eric7.Graphics.ApplicationDiagramBuilder.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Graphics.ApplicationDiagramBuilder.html Fri Oct 27 14:09:40 2023 +0200 @@ -84,11 +84,11 @@ </tr> <tr> <td><a href="#ApplicationDiagramBuilder.fromDict">fromDict</a></td> -<td></td> +<td>Public method to populate the class with data persisted by 'toDict()'.</td> </tr> <tr> <td><a href="#ApplicationDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> -<td></td> +<td>Public method to parse persisted data.</td> </tr> <tr> <td><a href="#ApplicationDiagramBuilder.toDict">toDict</a></td> @@ -256,10 +256,63 @@ <h4>ApplicationDiagramBuilder.fromDict</h4> <b>fromDict</b>(<i>version, data</i>) +<p> + Public method to populate the class with data persisted by 'toDict()'. +</p> +<dl> + +<dt><i>version</i> (str)</dt> +<dd> +version of the data +</dd> +<dt><i>data</i> (dict)</dt> +<dd> +dictionary containing the persisted data +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a flag indicating success and an info + message in case the diagram belongs to a different project +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) +</dd> +</dl> <a NAME="ApplicationDiagramBuilder.parsePersistenceData" ID="ApplicationDiagramBuilder.parsePersistenceData"></a> <h4>ApplicationDiagramBuilder.parsePersistenceData</h4> <b>parsePersistenceData</b>(<i>version, data</i>) +<p> + Public method to parse persisted data. +</p> +<dl> + +<dt><i>version</i> (str)</dt> +<dd> +version of the data +</dd> +<dt><i>data</i> (str)</dt> +<dd> +persisted data to be parsed +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="ApplicationDiagramBuilder.toDict" ID="ApplicationDiagramBuilder.toDict"></a> <h4>ApplicationDiagramBuilder.toDict</h4> <b>toDict</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Graphics.ClassItem.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Graphics.ClassItem.html Fri Oct 27 14:09:40 2023 +0200 @@ -80,11 +80,11 @@ </tr> <tr> <td><a href="#ClassItem.paint">paint</a></td> -<td></td> +<td>Public method to paint the item in local coordinates.</td> </tr> <tr> <td><a href="#ClassItem.parseItemDataString">parseItemDataString</a></td> -<td></td> +<td>Public method to parse the given persistence data.</td> </tr> <tr> <td><a href="#ClassItem.setModel">setModel</a></td> @@ -215,10 +215,54 @@ <h4>ClassItem.paint</h4> <b>paint</b>(<i>painter, option, widget=None</i>) +<p> + Public method to paint the item in local coordinates. +</p> +<dl> + +<dt><i>painter</i> (QPainter)</dt> +<dd> +reference to the painter object +</dd> +<dt><i>option</i> (QStyleOptionGraphicsItem)</dt> +<dd> +style options +</dd> +<dt><i>widget</i> (QWidget)</dt> +<dd> +optional reference to the widget painted on +</dd> +</dl> <a NAME="ClassItem.parseItemDataString" ID="ClassItem.parseItemDataString"></a> <h4>ClassItem.parseItemDataString</h4> <b>parseItemDataString</b>(<i>version, data</i>) +<p> + Public method to parse the given persistence data. +</p> +<dl> + +<dt><i>version</i> (str)</dt> +<dd> +version of the data +</dd> +<dt><i>data</i> (str)</dt> +<dd> +persisted data to be parsed +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="ClassItem.setModel" ID="ClassItem.setModel"></a> <h4>ClassItem.setModel</h4> <b>setModel</b>(<i>model</i>)
--- a/src/eric7/Documentation/Source/eric7.Graphics.ImportsDiagramBuilder.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Graphics.ImportsDiagramBuilder.html Fri Oct 27 14:09:40 2023 +0200 @@ -84,7 +84,7 @@ </tr> <tr> <td><a href="#ImportsDiagramBuilder.fromDict">fromDict</a></td> -<td></td> +<td>Public method to populate the class with data persisted by 'toDict()'.</td> </tr> <tr> <td><a href="#ImportsDiagramBuilder.initialize">initialize</a></td> @@ -92,7 +92,7 @@ </tr> <tr> <td><a href="#ImportsDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> -<td></td> +<td>Public method to parse persisted data.</td> </tr> <tr> <td><a href="#ImportsDiagramBuilder.toDict">toDict</a></td> @@ -246,6 +246,33 @@ <h4>ImportsDiagramBuilder.fromDict</h4> <b>fromDict</b>(<i>version, data</i>) +<p> + Public method to populate the class with data persisted by 'toDict()'. +</p> +<dl> + +<dt><i>version</i> (str)</dt> +<dd> +version of the data +</dd> +<dt><i>data</i> (dict)</dt> +<dd> +dictionary containing the persisted data +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a flag indicating success and an info + message in case the diagram belongs to a different project +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) +</dd> +</dl> <a NAME="ImportsDiagramBuilder.initialize" ID="ImportsDiagramBuilder.initialize"></a> <h4>ImportsDiagramBuilder.initialize</h4> <b>initialize</b>(<i></i>) @@ -257,6 +284,32 @@ <h4>ImportsDiagramBuilder.parsePersistenceData</h4> <b>parsePersistenceData</b>(<i>version, data</i>) +<p> + Public method to parse persisted data. +</p> +<dl> + +<dt><i>version</i> (str)</dt> +<dd> +version of the data +</dd> +<dt><i>data</i> (str)</dt> +<dd> +persisted data to be parsed +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="ImportsDiagramBuilder.toDict" ID="ImportsDiagramBuilder.toDict"></a> <h4>ImportsDiagramBuilder.toDict</h4> <b>toDict</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Graphics.ModuleItem.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Graphics.ModuleItem.html Fri Oct 27 14:09:40 2023 +0200 @@ -76,11 +76,11 @@ </tr> <tr> <td><a href="#ModuleItem.paint">paint</a></td> -<td></td> +<td>Public method to paint the item in local coordinates.</td> </tr> <tr> <td><a href="#ModuleItem.parseItemDataString">parseItemDataString</a></td> -<td></td> +<td>Public method to parse the given persistence data.</td> </tr> <tr> <td><a href="#ModuleItem.setModel">setModel</a></td> @@ -184,10 +184,54 @@ <h4>ModuleItem.paint</h4> <b>paint</b>(<i>painter, option, widget=None</i>) +<p> + Public method to paint the item in local coordinates. +</p> +<dl> + +<dt><i>painter</i> (QPainter)</dt> +<dd> +reference to the painter object +</dd> +<dt><i>option</i> (QStyleOptionGraphicsItem)</dt> +<dd> +style options +</dd> +<dt><i>widget</i> (QWidget)</dt> +<dd> +optional reference to the widget painted on +</dd> +</dl> <a NAME="ModuleItem.parseItemDataString" ID="ModuleItem.parseItemDataString"></a> <h4>ModuleItem.parseItemDataString</h4> <b>parseItemDataString</b>(<i>version, data</i>) +<p> + Public method to parse the given persistence data. +</p> +<dl> + +<dt><i>version</i> (str)</dt> +<dd> +version of the data +</dd> +<dt><i>data</i> (str)</dt> +<dd> +persisted data to be parsed +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="ModuleItem.setModel" ID="ModuleItem.setModel"></a> <h4>ModuleItem.setModel</h4> <b>setModel</b>(<i>model</i>)
--- a/src/eric7/Documentation/Source/eric7.Graphics.PackageDiagramBuilder.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Graphics.PackageDiagramBuilder.html Fri Oct 27 14:09:40 2023 +0200 @@ -96,7 +96,7 @@ </tr> <tr> <td><a href="#PackageDiagramBuilder.fromDict">fromDict</a></td> -<td></td> +<td>Public method to populate the class with data persisted by 'toDict()'.</td> </tr> <tr> <td><a href="#PackageDiagramBuilder.initialize">initialize</a></td> @@ -104,7 +104,7 @@ </tr> <tr> <td><a href="#PackageDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> -<td></td> +<td>Public method to parse persisted data.</td> </tr> <tr> <td><a href="#PackageDiagramBuilder.toDict">toDict</a></td> @@ -349,6 +349,33 @@ <h4>PackageDiagramBuilder.fromDict</h4> <b>fromDict</b>(<i>version, data</i>) +<p> + Public method to populate the class with data persisted by 'toDict()'. +</p> +<dl> + +<dt><i>version</i> (str)</dt> +<dd> +version of the data +</dd> +<dt><i>data</i> (dict)</dt> +<dd> +dictionary containing the persisted data +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a flag indicating success and an info + message in case the diagram belongs to a different project +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) +</dd> +</dl> <a NAME="PackageDiagramBuilder.initialize" ID="PackageDiagramBuilder.initialize"></a> <h4>PackageDiagramBuilder.initialize</h4> <b>initialize</b>(<i></i>) @@ -360,6 +387,32 @@ <h4>PackageDiagramBuilder.parsePersistenceData</h4> <b>parsePersistenceData</b>(<i>version, data</i>) +<p> + Public method to parse persisted data. +</p> +<dl> + +<dt><i>version</i> (str)</dt> +<dd> +version of the data +</dd> +<dt><i>data</i> (str)</dt> +<dd> +persisted data to be parsed +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="PackageDiagramBuilder.toDict" ID="PackageDiagramBuilder.toDict"></a> <h4>PackageDiagramBuilder.toDict</h4> <b>toDict</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Graphics.PackageItem.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Graphics.PackageItem.html Fri Oct 27 14:09:40 2023 +0200 @@ -76,11 +76,11 @@ </tr> <tr> <td><a href="#PackageItem.paint">paint</a></td> -<td></td> +<td>Public method to paint the item in local coordinates.</td> </tr> <tr> <td><a href="#PackageItem.parseItemDataString">parseItemDataString</a></td> -<td></td> +<td>Public method to parse the given persistence data.</td> </tr> <tr> <td><a href="#PackageItem.setModel">setModel</a></td> @@ -189,10 +189,54 @@ <h4>PackageItem.paint</h4> <b>paint</b>(<i>painter, option, widget=None</i>) +<p> + Public method to paint the item in local coordinates. +</p> +<dl> + +<dt><i>painter</i> (QPainter)</dt> +<dd> +reference to the painter object +</dd> +<dt><i>option</i> (QStyleOptionGraphicsItem)</dt> +<dd> +style options +</dd> +<dt><i>widget</i> (QWidget)</dt> +<dd> +optional reference to the widget painted on +</dd> +</dl> <a NAME="PackageItem.parseItemDataString" ID="PackageItem.parseItemDataString"></a> <h4>PackageItem.parseItemDataString</h4> <b>parseItemDataString</b>(<i>version, data</i>) +<p> + Public method to parse the given persistence data. +</p> +<dl> + +<dt><i>version</i> (str)</dt> +<dd> +version of the data +</dd> +<dt><i>data</i> (str)</dt> +<dd> +persisted data to be parsed +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="PackageItem.setModel" ID="PackageItem.setModel"></a> <h4>PackageItem.setModel</h4> <b>setModel</b>(<i>model</i>)
--- a/src/eric7/Documentation/Source/eric7.Graphics.UMLClassDiagramBuilder.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Graphics.UMLClassDiagramBuilder.html Fri Oct 27 14:09:40 2023 +0200 @@ -84,7 +84,7 @@ </tr> <tr> <td><a href="#UMLClassDiagramBuilder.fromDict">fromDict</a></td> -<td></td> +<td>Public method to populate the class with data persisted by 'toDict()'.</td> </tr> <tr> <td><a href="#UMLClassDiagramBuilder.initialize">initialize</a></td> @@ -92,7 +92,7 @@ </tr> <tr> <td><a href="#UMLClassDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> -<td></td> +<td>Public method to parse persisted data.</td> </tr> <tr> <td><a href="#UMLClassDiagramBuilder.toDict">toDict</a></td> @@ -271,6 +271,33 @@ <h4>UMLClassDiagramBuilder.fromDict</h4> <b>fromDict</b>(<i>version, data</i>) +<p> + Public method to populate the class with data persisted by 'toDict()'. +</p> +<dl> + +<dt><i>version</i> (str)</dt> +<dd> +version of the data +</dd> +<dt><i>data</i> (dict)</dt> +<dd> +dictionary containing the persisted data +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a flag indicating success and an info + message in case the diagram belongs to a different project +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) +</dd> +</dl> <a NAME="UMLClassDiagramBuilder.initialize" ID="UMLClassDiagramBuilder.initialize"></a> <h4>UMLClassDiagramBuilder.initialize</h4> <b>initialize</b>(<i></i>) @@ -282,6 +309,32 @@ <h4>UMLClassDiagramBuilder.parsePersistenceData</h4> <b>parsePersistenceData</b>(<i>version, data</i>) +<p> + Public method to parse persisted data. +</p> +<dl> + +<dt><i>version</i> (str)</dt> +<dd> +version of the data +</dd> +<dt><i>data</i> (str)</dt> +<dd> +persisted data to be parsed +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="UMLClassDiagramBuilder.toDict" ID="UMLClassDiagramBuilder.toDict"></a> <h4>UMLClassDiagramBuilder.toDict</h4> <b>toDict</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Graphics.UMLDiagramBuilder.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Graphics.UMLDiagramBuilder.html Fri Oct 27 14:09:40 2023 +0200 @@ -68,7 +68,7 @@ </tr> <tr> <td><a href="#UMLDiagramBuilder.fromDict">fromDict</a></td> -<td></td> +<td>Public method to populate the class with data persisted by 'toDict()'.</td> </tr> <tr> <td><a href="#UMLDiagramBuilder.initialize">initialize</a></td> @@ -76,7 +76,7 @@ </tr> <tr> <td><a href="#UMLDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> -<td></td> +<td>Public method to parse persisted data.</td> </tr> <tr> <td><a href="#UMLDiagramBuilder.toDict">toDict</a></td> @@ -159,6 +159,33 @@ <h4>UMLDiagramBuilder.fromDict</h4> <b>fromDict</b>(<i>version, data</i>) +<p> + Public method to populate the class with data persisted by 'toDict()'. +</p> +<dl> + +<dt><i>version</i> (str)</dt> +<dd> +version of the data +</dd> +<dt><i>data</i> (dict)</dt> +<dd> +dictionary containing the persisted data +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a flag indicating success and an info + message in case the diagram belongs to a different project +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) +</dd> +</dl> <a NAME="UMLDiagramBuilder.initialize" ID="UMLDiagramBuilder.initialize"></a> <h4>UMLDiagramBuilder.initialize</h4> <b>initialize</b>(<i></i>) @@ -170,6 +197,32 @@ <h4>UMLDiagramBuilder.parsePersistenceData</h4> <b>parsePersistenceData</b>(<i>version, data</i>) +<p> + Public method to parse persisted data. +</p> +<dl> + +<dt><i>version</i> (str)</dt> +<dd> +version of the data +</dd> +<dt><i>data</i> (str)</dt> +<dd> +persisted data to be parsed +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="UMLDiagramBuilder.toDict" ID="UMLDiagramBuilder.toDict"></a> <h4>UMLDiagramBuilder.toDict</h4> <b>toDict</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Graphics.UMLGraphicsView.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Graphics.UMLGraphicsView.html Fri Oct 27 14:09:40 2023 +0200 @@ -145,7 +145,7 @@ </tr> <tr> <td><a href="#UMLGraphicsView.fromDict">fromDict</a></td> -<td></td> +<td>Public method to populate the class with data persisted by 'toDict()'.</td> </tr> <tr> <td><a href="#UMLGraphicsView.gestureEvent">gestureEvent</a></td> @@ -493,6 +493,32 @@ <h4>UMLGraphicsView.fromDict</h4> <b>fromDict</b>(<i>version, data</i>) +<p> + Public method to populate the class with data persisted by 'toDict()'. +</p> +<dl> + +<dt><i>version</i> (str)</dt> +<dd> +version of the data +</dd> +<dt><i>data</i> (dict)</dt> +<dd> +dictionary containing the persisted data +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="UMLGraphicsView.gestureEvent" ID="UMLGraphicsView.gestureEvent"></a> <h4>UMLGraphicsView.gestureEvent</h4> <b>gestureEvent</b>(<i>evt</i>)
--- a/src/eric7/Documentation/Source/eric7.Graphics.UMLItem.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Graphics.UMLItem.html Fri Oct 27 14:09:40 2023 +0200 @@ -96,11 +96,11 @@ </tr> <tr> <td><a href="#UMLItem.paint">paint</a></td> -<td></td> +<td>Public method to paint the item in local coordinates.</td> </tr> <tr> <td><a href="#UMLItem.parseItemDataString">parseItemDataString</a></td> -<td></td> +<td>Public method to parse the given persistence data.</td> </tr> <tr> <td><a href="#UMLItem.removeAssociation">removeAssociation</a></td> @@ -322,10 +322,54 @@ <h4>UMLItem.paint</h4> <b>paint</b>(<i>painter, option, widget=None</i>) +<p> + Public method to paint the item in local coordinates. +</p> +<dl> + +<dt><i>painter</i> (QPainter)</dt> +<dd> +reference to the painter object +</dd> +<dt><i>option</i> (QStyleOptionGraphicsItem)</dt> +<dd> +style options +</dd> +<dt><i>widget</i> (QWidget)</dt> +<dd> +optional reference to the widget painted on +</dd> +</dl> <a NAME="UMLItem.parseItemDataString" ID="UMLItem.parseItemDataString"></a> <h4>UMLItem.parseItemDataString</h4> <b>parseItemDataString</b>(<i>version, data</i>) +<p> + Public method to parse the given persistence data. +</p> +<dl> + +<dt><i>version</i> (str)</dt> +<dd> +version of the data +</dd> +<dt><i>data</i> (str)</dt> +<dd> +persisted data to be parsed +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="UMLItem.removeAssociation" ID="UMLItem.removeAssociation"></a> <h4>UMLItem.removeAssociation</h4> <b>removeAssociation</b>(<i>assoc</i>)
--- a/src/eric7/Documentation/Source/eric7.JediInterface.AssistantJedi.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.JediInterface.AssistantJedi.html Fri Oct 27 14:09:40 2023 +0200 @@ -92,7 +92,7 @@ </tr> <tr> <td><a href="#AssistantJedi.__editorShowMenu">__editorShowMenu</a></td> -<td></td> +<td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td> </tr> <tr> <td><a href="#AssistantJedi.__initRefactoringMenu">__initRefactoringMenu</a></td> @@ -268,6 +268,25 @@ <h4>AssistantJedi.__editorShowMenu</h4> <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) +<p> + Private slot called, when the the editor context menu or a submenu is + about to be shown. +</p> +<dl> + +<dt><i>menuName</i> (str)</dt> +<dd> +name of the menu to be shown +</dd> +<dt><i>menu</i> (QMenu)</dt> +<dd> +reference to the menu +</dd> +<dt><i>editor</i> (Editor)</dt> +<dd> +reference to the editor +</dd> +</dl> <a NAME="AssistantJedi.__initRefactoringMenu" ID="AssistantJedi.__initRefactoringMenu"></a> <h4>AssistantJedi.__initRefactoringMenu</h4> <b>__initRefactoringMenu</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.JediInterface.JediClient.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.JediInterface.JediClient.html Fri Oct 27 14:09:40 2023 +0200 @@ -68,7 +68,7 @@ </tr> <tr> <td><a href="#JediClient.__closeProject">__closeProject</a></td> -<td></td> +<td>Private method to save a jedi project's data.</td> </tr> <tr> <td><a href="#JediClient.__completionFullName">__completionFullName</a></td> @@ -196,6 +196,16 @@ <h4>JediClient.__closeProject</h4> <b>__closeProject</b>(<i>params</i>) +<p> + Private method to save a jedi project's data. +</p> +<dl> + +<dt><i>params</i> (dict)</dt> +<dd> +dictionary containing the method parameters +</dd> +</dl> <a NAME="JediClient.__completionFullName" ID="JediClient.__completionFullName"></a> <h4>JediClient.__completionFullName</h4> <b>__completionFullName</b>(<i>completion</i>)
--- a/src/eric7/Documentation/Source/eric7.JediInterface.JediServer.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.JediInterface.JediServer.html Fri Oct 27 14:09:40 2023 +0200 @@ -148,7 +148,7 @@ </tr> <tr> <td><a href="#JediServer.getCallTips">getCallTips</a></td> -<td></td> +<td>Public method to calculate calltips.</td> </tr> <tr> <td><a href="#JediServer.gotoDefinition">gotoDefinition</a></td> @@ -192,7 +192,7 @@ </tr> <tr> <td><a href="#JediServer.requestCompletions">requestCompletions</a></td> -<td></td> +<td>Public method to request a list of possible completions.</td> </tr> </table> <h3>Static Methods</h3> @@ -567,6 +567,36 @@ <h4>JediServer.getCallTips</h4> <b>getCallTips</b>(<i>editor, pos, commas</i>) +<p> + Public method to calculate calltips. +</p> +<dl> + +<dt><i>editor</i> (Editor)</dt> +<dd> +reference to the editor object, that called this method +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position in the text for the calltip +</dd> +<dt><i>commas</i> (int)</dt> +<dd> +minimum number of commas contained in the calltip +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list of possible calltips +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> <a NAME="JediServer.gotoDefinition" ID="JediServer.gotoDefinition"></a> <h4>JediServer.gotoDefinition</h4> <b>gotoDefinition</b>(<i>editor</i>) @@ -709,6 +739,24 @@ <h4>JediServer.requestCompletions</h4> <b>requestCompletions</b>(<i>editor, context, acText</i>) +<p> + Public method to request a list of possible completions. +</p> +<dl> + +<dt><i>editor</i> (Editor)</dt> +<dd> +reference to the editor object, that called this method +</dd> +<dt><i>context</i> (bool)</dt> +<dd> +flag indicating to autocomplete a context +</dd> +<dt><i>acText</i> (str)</dt> +<dd> +text to be completed +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonDevices.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonDevices.html Fri Oct 27 14:09:40 2023 +0200 @@ -320,7 +320,7 @@ </tr> <tr> <td><a href="#CircuitPythonDevice.writeCredentials">writeCredentials</a></td> -<td></td> +<td>Public method to write the given credentials to the connected device and modify the start script to connect automatically.</td> </tr> <tr> <td><a href="#CircuitPythonDevice.writeLanAutoConnect">writeLanAutoConnect</a></td> @@ -1610,6 +1610,41 @@ <h4>CircuitPythonDevice.writeCredentials</h4> <b>writeCredentials</b>(<i>ssid, password, hostname, country</i>) +<p> + Public method to write the given credentials to the connected device and modify + the start script to connect automatically. +</p> +<dl> + +<dt><i>ssid</i> (str)</dt> +<dd> +SSID of the network to connect to +</dd> +<dt><i>password</i> (str)</dt> +<dd> +password needed to authenticate +</dd> +<dt><i>hostname</i> (str)</dt> +<dd> +host name of the device +</dd> +<dt><i>country</i> (str)</dt> +<dd> +WiFi country code (unused) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a flag indicating success and an error message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) +</dd> +</dl> <a NAME="CircuitPythonDevice.writeLanAutoConnect" ID="CircuitPythonDevice.writeLanAutoConnect"></a> <h4>CircuitPythonDevice.writeLanAutoConnect</h4> <b>writeLanAutoConnect</b>(<i>config, hostname</i>)
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html Fri Oct 27 14:09:40 2023 +0200 @@ -215,11 +215,11 @@ </tr> <tr> <td><a href="#BaseDevice.connectToLan">connectToLan</a></td> -<td></td> +<td>Public method to connect the connected device to the LAN.</td> </tr> <tr> <td><a href="#BaseDevice.connectWifi">connectWifi</a></td> -<td></td> +<td>Public method to connect a device to a WiFi network.</td> </tr> <tr> <td><a href="#BaseDevice.deactivateBluetoothInterface">deactivateBluetoothInterface</a></td> @@ -231,7 +231,7 @@ </tr> <tr> <td><a href="#BaseDevice.deactivateInterface">deactivateInterface</a></td> -<td></td> +<td>Public method to deactivate a given WiFi interface of the connected device.</td> </tr> <tr> <td><a href="#BaseDevice.deviceName">deviceName</a></td> @@ -255,7 +255,7 @@ </tr> <tr> <td><a href="#BaseDevice.enableWebrepl">enableWebrepl</a></td> -<td></td> +<td>Public method to write the given WebREPL password to the connected device and modify the start script to start the WebREPL server.</td> </tr> <tr> <td><a href="#BaseDevice.ensurePath">ensurePath</a></td> @@ -303,7 +303,7 @@ </tr> <tr> <td><a href="#BaseDevice.getDeviceScan">getDeviceScan</a></td> -<td></td> +<td>Public method to perform a Bluetooth device scan.</td> </tr> <tr> <td><a href="#BaseDevice.getDeviceType">getDeviceType</a></td> @@ -515,7 +515,7 @@ </tr> <tr> <td><a href="#BaseDevice.syncTime">syncTime</a></td> -<td></td> +<td>Public method to set the time of the connected device to the local computer's time.</td> </tr> <tr> <td><a href="#BaseDevice.upipInstall">upipInstall</a></td> @@ -523,11 +523,11 @@ </tr> <tr> <td><a href="#BaseDevice.writeCredentials">writeCredentials</a></td> -<td></td> +<td>Public method to write the given credentials to the connected device and modify the start script to connect automatically.</td> </tr> <tr> <td><a href="#BaseDevice.writeLanAutoConnect">writeLanAutoConnect</a></td> -<td></td> +<td>Public method to generate a script and associated configuration to connect the device to the LAN during boot time.</td> </tr> </table> <h3>Static Methods</h3> @@ -909,10 +909,67 @@ <h4>BaseDevice.connectToLan</h4> <b>connectToLan</b>(<i>config, hostname</i>) +<p> + Public method to connect the connected device to the LAN. +</p> +<dl> + +<dt><i>config</i> (str or tuple of (str, str, str, str))</dt> +<dd> +configuration for the connection (either the string 'dhcp' + for a dynamic address or a tuple of four strings with the IPv4 parameters. +</dd> +<dt><i>hostname</i> (str)</dt> +<dd> +host name of the device +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a flag indicating success and an error message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) +</dd> +</dl> <a NAME="BaseDevice.connectWifi" ID="BaseDevice.connectWifi"></a> <h4>BaseDevice.connectWifi</h4> <b>connectWifi</b>(<i>ssid, password, hostname</i>) +<p> + Public method to connect a device to a WiFi network. +</p> +<dl> + +<dt><i>ssid</i> (str)</dt> +<dd> +name (SSID) of the WiFi network +</dd> +<dt><i>password</i> (str)</dt> +<dd> +password needed to connect +</dd> +<dt><i>hostname</i> (str)</dt> +<dd> +host name of the device +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the connection status and an error string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) +</dd> +</dl> <a NAME="BaseDevice.deactivateBluetoothInterface" ID="BaseDevice.deactivateBluetoothInterface"></a> <h4>BaseDevice.deactivateBluetoothInterface</h4> <b>deactivateBluetoothInterface</b>(<i></i>) @@ -955,6 +1012,29 @@ <h4>BaseDevice.deactivateInterface</h4> <b>deactivateInterface</b>(<i>interface</i>) +<p> + Public method to deactivate a given WiFi interface of the connected device. +</p> +<dl> + +<dt><i>interface</i> (str)</dt> +<dd> +designation of the interface to be deactivated (one of 'AP' + or 'STA') +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containg a flag indicating success and an error message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) +</dd> +</dl> <a NAME="BaseDevice.deviceName" ID="BaseDevice.deviceName"></a> <h4>BaseDevice.deviceName</h4> <b>deviceName</b>(<i></i>) @@ -1043,6 +1123,29 @@ <h4>BaseDevice.enableWebrepl</h4> <b>enableWebrepl</b>(<i>password</i>) +<p> + Public method to write the given WebREPL password to the connected device and + modify the start script to start the WebREPL server. +</p> +<dl> + +<dt><i>password</i> (str)</dt> +<dd> +password needed to authenticate +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a flag indicating success and an error message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) +</dd> +</dl> <a NAME="BaseDevice.ensurePath" ID="BaseDevice.ensurePath"></a> <h4>BaseDevice.ensurePath</h4> <b>ensurePath</b>(<i>target</i>) @@ -1345,6 +1448,30 @@ <h4>BaseDevice.getDeviceScan</h4> <b>getDeviceScan</b>(<i>timeout=10</i>) +<p> + Public method to perform a Bluetooth device scan. +</p> +<dl> + +<dt><i>timeout</i> (int (optional))</dt> +<dd> +duration of the device scan in seconds (defaults + to 10) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a dictionary with the scan results and + an error string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (dict, str) +</dd> +</dl> <a NAME="BaseDevice.getDeviceType" ID="BaseDevice.getDeviceType"></a> <h4>BaseDevice.getDeviceType</h4> <b>getDeviceType</b>(<i></i>) @@ -2497,6 +2624,29 @@ <h4>BaseDevice.syncTime</h4> <b>syncTime</b>(<i>deviceType, hasCPy=False</i>) +<p> + Public method to set the time of the connected device to the local + computer's time. +</p> +<dl> + +<dt><i>deviceType</i> (str)</dt> +<dd> +type of board to sync time to +</dd> +<dt><i>hasCPy</i> (bool)</dt> +<dd> +flag indicating that the device has CircuitPython loadede + (defaults to False) +</dd> +</dl> +<dl> + +<dt>Raises <b>OSError</b>:</dt> +<dd> +raised to indicate an issue with the device +</dd> +</dl> <a NAME="BaseDevice.upipInstall" ID="BaseDevice.upipInstall"></a> <h4>BaseDevice.upipInstall</h4> <b>upipInstall</b>(<i>packages</i>) @@ -2521,10 +2671,73 @@ <h4>BaseDevice.writeCredentials</h4> <b>writeCredentials</b>(<i>ssid, password, hostname, country</i>) +<p> + Public method to write the given credentials to the connected device and modify + the start script to connect automatically. +</p> +<dl> + +<dt><i>ssid</i> (str)</dt> +<dd> +SSID of the network to connect to +</dd> +<dt><i>password</i> (str)</dt> +<dd> +password needed to authenticate +</dd> +<dt><i>hostname</i> (str)</dt> +<dd> +host name of the device +</dd> +<dt><i>country</i> (str)</dt> +<dd> +WiFi country code +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a flag indicating success and an error message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) +</dd> +</dl> <a NAME="BaseDevice.writeLanAutoConnect" ID="BaseDevice.writeLanAutoConnect"></a> <h4>BaseDevice.writeLanAutoConnect</h4> <b>writeLanAutoConnect</b>(<i>config, hostname</i>) +<p> + Public method to generate a script and associated configuration to connect the + device to the LAN during boot time. +</p> +<dl> + +<dt><i>config</i> (str or tuple of (str, str, str, str))</dt> +<dd> +configuration for the connection (either the string 'dhcp' + for a dynamic address or a tuple of four strings with the IPv4 parameters. +</dd> +<dt><i>hostname</i> (str)</dt> +<dd> +host name of the device +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a flag indicating success and an error message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonWebreplDeviceInterface.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonWebreplDeviceInterface.html Fri Oct 27 14:09:40 2023 +0200 @@ -86,11 +86,11 @@ </tr> <tr> <td><a href="#MicroPythonWebreplDeviceInterface.execute">execute</a></td> -<td></td> +<td>Public method to send commands to the connected device and return the result.</td> </tr> <tr> <td><a href="#MicroPythonWebreplDeviceInterface.executeAsync">executeAsync</a></td> -<td></td> +<td>Public method to execute a series of commands over a period of time without returning any result (asynchronous execution).</td> </tr> <tr> <td><a href="#MicroPythonWebreplDeviceInterface.handlePreferencesChanged">handlePreferencesChanged</a></td> @@ -211,10 +211,58 @@ <h4>MicroPythonWebreplDeviceInterface.execute</h4> <b>execute</b>(<i>commands, *, mode="raw", timeout=0</i>) +<p> + Public method to send commands to the connected device and return the + result. +</p> +<dl> + +<dt><i>commands</i> (str or list of str)</dt> +<dd> +list of commands to be executed +</dd> +<dt><i>mode=</i> (str)</dt> +<dd> +submit mode to be used (one of 'raw' or 'paste') (defaults to + 'raw'). This is ignored because webrepl always uses 'paste' mode. +</dd> +<dt><i>timeout=</i> (int (optional))</dt> +<dd> +per command timeout in milliseconds (0 for configured default) + (defaults to 0) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing stdout and stderr output of the device +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bytes, bytes) +</dd> +</dl> <a NAME="MicroPythonWebreplDeviceInterface.executeAsync" ID="MicroPythonWebreplDeviceInterface.executeAsync"></a> <h4>MicroPythonWebreplDeviceInterface.executeAsync</h4> <b>executeAsync</b>(<i>commandsList, submitMode</i>) +<p> + Public method to execute a series of commands over a period of time + without returning any result (asynchronous execution). +</p> +<dl> + +<dt><i>commandsList</i> (list of str)</dt> +<dd> +list of commands to be execute on the device +</dd> +<dt><i>submitMode</i> (str (one of 'raw' or 'paste'))</dt> +<dd> +mode to be used to submit the commands +</dd> +</dl> <a NAME="MicroPythonWebreplDeviceInterface.handlePreferencesChanged" ID="MicroPythonWebreplDeviceInterface.handlePreferencesChanged"></a> <h4>MicroPythonWebreplDeviceInterface.handlePreferencesChanged</h4> <b>handlePreferencesChanged</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.PdfViewer.PdfToCWidget.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.PdfViewer.PdfToCWidget.html Fri Oct 27 14:09:40 2023 +0200 @@ -64,7 +64,7 @@ </tr> <tr> <td><a href="#PdfToCModel.columnCount">columnCount</a></td> -<td></td> +<td>Public method to define the number of columns to be shown.</td> </tr> <tr> <td><a href="#PdfToCModel.data">data</a></td> @@ -95,6 +95,28 @@ <h4>PdfToCModel.columnCount</h4> <b>columnCount</b>(<i>index</i>) +<p> + Public method to define the number of columns to be shown. +</p> +<dl> + +<dt><i>index</i> (QModelIndex)</dt> +<dd> +index of the element +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +column count (always 2) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int +</dd> +</dl> <a NAME="PdfToCModel.data" ID="PdfToCModel.data"></a> <h4>PdfToCModel.data</h4> <b>data</b>(<i>index, role</i>)
--- a/src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html Fri Oct 27 14:09:40 2023 +0200 @@ -1523,7 +1523,7 @@ </tr> <tr> <td><a href="#PypiSearchResultsParser.handle_endtag">handle_endtag</a></td> -<td></td> +<td>Public method to process the end tag.</td> </tr> <tr> <td><a href="#PypiSearchResultsParser.handle_starttag">handle_starttag</a></td> @@ -1641,6 +1641,16 @@ <h4>PypiSearchResultsParser.handle_endtag</h4> <b>handle_endtag</b>(<i>tag</i>) +<p> + Public method to process the end tag. +</p> +<dl> + +<dt><i>tag</i> (str)</dt> +<dd> +tag name (all lowercase) +</dd> +</dl> <a NAME="PypiSearchResultsParser.handle_starttag" ID="PypiSearchResultsParser.handle_starttag"></a> <h4>PypiSearchResultsParser.handle_starttag</h4> <b>handle_starttag</b>(<i>tag, attrs</i>)
--- a/src/eric7/Documentation/Source/eric7.PluginManager.PluginRepositoryDialog.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.PluginManager.PluginRepositoryDialog.html Fri Oct 27 14:09:40 2023 +0200 @@ -219,7 +219,7 @@ </tr> <tr> <td><a href="#PluginRepositoryWidget.__downloadRepositoryFileDone">__downloadRepositoryFileDone</a></td> -<td></td> +<td>Private method called after the repository file was downloaded.</td> </tr> <tr> <td><a href="#PluginRepositoryWidget.__formatDescription">__formatDescription</a></td> @@ -512,6 +512,20 @@ <h4>PluginRepositoryWidget.__downloadRepositoryFileDone</h4> <b>__downloadRepositoryFileDone</b>(<i>status, filename</i>) +<p> + Private method called after the repository file was downloaded. +</p> +<dl> + +<dt><i>status</i></dt> +<dd> +flaging indicating a successful download (boolean) +</dd> +<dt><i>filename</i></dt> +<dd> +full path of the downloaded file (string) +</dd> +</dl> <a NAME="PluginRepositoryWidget.__formatDescription" ID="PluginRepositoryWidget.__formatDescription"></a> <h4>PluginRepositoryWidget.__formatDescription</h4> <b>__formatDescription</b>(<i>lines</i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html Fri Oct 27 14:09:40 2023 +0200 @@ -63,7 +63,7 @@ </tr> <tr> <td><a href="#securityOk">securityOk</a></td> -<td></td> +<td>Function to check, if the given error code is an acknowledged security report.</td> </tr> <tr> <td><a href="#workerTask">workerTask</a></td> @@ -438,6 +438,32 @@ <h2>securityOk</h2> <b>securityOk</b>(<i>errorCode, lineFlags</i>) +<p> + Function to check, if the given error code is an acknowledged security report. +</p> +<dl> + +<dt><i>errorCode</i> (str)</dt> +<dd> +error code to be checked +</dd> +<dt><i>lineFlags</i> (list of str)</dt> +<dd> +list of line flags to check against +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating an acknowledged security report +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html Fri Oct 27 14:09:40 2023 +0200 @@ -84,11 +84,11 @@ </tr> <tr> <td><a href="#CodeStyleFixer.__fixD111">__fixD111</a></td> -<td></td> +<td>Private method to fix docstring enclosed in wrong quotes.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixD112">__fixD112</a></td> -<td></td> +<td>Private method to fix docstring 'r' in leading quotes.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixD121">__fixD121</a></td> @@ -96,7 +96,7 @@ </tr> <tr> <td><a href="#CodeStyleFixer.__fixD131">__fixD131</a></td> -<td></td> +<td>Private method to fix a docstring summary not ending with a period.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixD141">__fixD141</a></td> @@ -136,7 +136,7 @@ </tr> <tr> <td><a href="#CodeStyleFixer.__fixE101">__fixE101</a></td> -<td></td> +<td>Private method to fix obsolete tab usage and indentation errors.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixE121">__fixE121</a></td> @@ -164,27 +164,27 @@ </tr> <tr> <td><a href="#CodeStyleFixer.__fixE201">__fixE201</a></td> -<td></td> +<td>Private method to fix extraneous whitespace.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixE221">__fixE221</a></td> -<td></td> +<td>Private method to fix extraneous whitespace around operator or keyword.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixE225">__fixE225</a></td> -<td></td> +<td>Private method to fix extraneous whitespaces around operator.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixE231">__fixE231</a></td> -<td></td> +<td>Private method to fix missing whitespace after ',;:'.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixE251">__fixE251</a></td> -<td></td> +<td>Private method to fix extraneous whitespace around keyword and default parameter equals.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixE261">__fixE261</a></td> -<td></td> +<td>Private method to fix whitespace before or after inline comment.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixE304">__fixE304</a></td> @@ -200,7 +200,7 @@ </tr> <tr> <td><a href="#CodeStyleFixer.__fixE502">__fixE502</a></td> -<td></td> +<td>Private method to fix redundant backslash within brackets.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixE701">__fixE701</a></td> @@ -212,7 +212,7 @@ </tr> <tr> <td><a href="#CodeStyleFixer.__fixE711">__fixE711</a></td> -<td></td> +<td>Private method to fix comparison with None.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixN804">__fixN804</a></td> @@ -224,23 +224,23 @@ </tr> <tr> <td><a href="#CodeStyleFixer.__fixReindent">__fixReindent</a></td> -<td></td> +<td>Private method to fix a badly indented line.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixW291">__fixW291</a></td> -<td></td> +<td>Private method to fix trailing whitespace.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixW292">__fixW292</a></td> -<td></td> +<td>Private method to fix a missing newline at the end of file.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixW391">__fixW391</a></td> -<td></td> +<td>Private method to fix trailing blank lines.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixW603">__fixW603</a></td> -<td></td> +<td>Private method to fix the not equal notation.</td> </tr> <tr> <td><a href="#CodeStyleFixer.__fixWhitespace">__fixWhitespace</a></td> @@ -423,10 +423,80 @@ <h4>CodeStyleFixer.__fixD111</h4> <b>__fixD111</b>(<i>code, line, pos</i>) +<p> + Private method to fix docstring enclosed in wrong quotes. +</p> +<p> + Codes: D111 +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +code of the issue +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message code for the fix, a list of arguments for the + message and an ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, list or int, int) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixD112" ID="CodeStyleFixer.__fixD112"></a> <h4>CodeStyleFixer.__fixD112</h4> <b>__fixD112</b>(<i>code, line, pos</i>) +<p> + Private method to fix docstring 'r' in leading quotes. +</p> +<p> + Codes: D112 +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +code of the issue +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message code for the fix, a list of arguments for the + message and an ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, list or int, int) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixD121" ID="CodeStyleFixer.__fixD121"></a> <h4>CodeStyleFixer.__fixD121</h4> <b>__fixD121</b>(<i>code, line, pos, apply=False</i>) @@ -474,6 +544,42 @@ <h4>CodeStyleFixer.__fixD131</h4> <b>__fixD131</b>(<i>code, line, pos</i>) +<p> + Private method to fix a docstring summary not ending with a + period. +</p> +<p> + Codes: D131 +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +code of the issue +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message code for the fix, a list of arguments for the + message and an ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, list or int, int) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixD141" ID="CodeStyleFixer.__fixD141"></a> <h4>CodeStyleFixer.__fixD141</h4> <b>__fixD141</b>(<i>code, line, pos, apply=False</i>) @@ -874,6 +980,41 @@ <h4>CodeStyleFixer.__fixE101</h4> <b>__fixE101</b>(<i>code, line, pos</i>) +<p> + Private method to fix obsolete tab usage and indentation errors. +</p> +<p> + Codes: E101, E111, W191 +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +code of the issue +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message code for the fix, a list of arguments for the + message and an ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, list or int, int) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixE121" ID="CodeStyleFixer.__fixE121"></a> <h4>CodeStyleFixer.__fixE121</h4> <b>__fixE121</b>(<i>code, line, pos, apply=False</i>) @@ -1139,26 +1280,238 @@ <h4>CodeStyleFixer.__fixE201</h4> <b>__fixE201</b>(<i>code, line, pos</i>) +<p> + Private method to fix extraneous whitespace. +</p> +<p> + Codes: E201, E202, E203, E211 +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +code of the issue +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message code for the fix, a list of arguments for the + message and an ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, list or int, int) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixE221" ID="CodeStyleFixer.__fixE221"></a> <h4>CodeStyleFixer.__fixE221</h4> <b>__fixE221</b>(<i>code, line, pos</i>) +<p> + Private method to fix extraneous whitespace around operator or + keyword. +</p> +<p> + Codes: E221, E222, E223, E224, E241, E242, E271, E272, E273, E274 +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +code of the issue +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message code for the fix, a list of arguments for the + message and an ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, list or int, int) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixE225" ID="CodeStyleFixer.__fixE225"></a> <h4>CodeStyleFixer.__fixE225</h4> <b>__fixE225</b>(<i>code, line, pos</i>) +<p> + Private method to fix extraneous whitespaces around operator. +</p> +<p> + Codes: E225, E226, E227, E228 +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +code of the issue +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message code for the fix, a list of arguments for the + message and an ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, list or int, int) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixE231" ID="CodeStyleFixer.__fixE231"></a> <h4>CodeStyleFixer.__fixE231</h4> <b>__fixE231</b>(<i>code, line, pos</i>) +<p> + Private method to fix missing whitespace after ',;:'. +</p> +<p> + Codes: E231 +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +code of the issue +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message code for the fix, a list of arguments for the + message and an ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, list or int, int) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixE251" ID="CodeStyleFixer.__fixE251"></a> <h4>CodeStyleFixer.__fixE251</h4> <b>__fixE251</b>(<i>code, line, pos</i>) +<p> + Private method to fix extraneous whitespace around keyword and + default parameter equals. +</p> +<p> + Codes: E251 +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +code of the issue +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message code for the fix, a list of arguments for the + message and an ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, list or int, int) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixE261" ID="CodeStyleFixer.__fixE261"></a> <h4>CodeStyleFixer.__fixE261</h4> <b>__fixE261</b>(<i>code, line, pos</i>) +<p> + Private method to fix whitespace before or after inline comment. +</p> +<p> + Codes: E261, E262 +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +code of the issue +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message code for the fix, a list of arguments for the + message and an ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, list or int, int) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixE304" ID="CodeStyleFixer.__fixE304"></a> <h4>CodeStyleFixer.__fixE304</h4> <b>__fixE304</b>(<i>code, line, pos, apply=False</i>) @@ -1293,6 +1646,41 @@ <h4>CodeStyleFixer.__fixE502</h4> <b>__fixE502</b>(<i>code, line, pos</i>) +<p> + Private method to fix redundant backslash within brackets. +</p> +<p> + Codes: E502 +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +code of the issue +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message code for the fix, a list of arguments for the + message and an ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, list or int, int) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixE701" ID="CodeStyleFixer.__fixE701"></a> <h4>CodeStyleFixer.__fixE701</h4> <b>__fixE701</b>(<i>code, line, pos, apply=False</i>) @@ -1383,6 +1771,41 @@ <h4>CodeStyleFixer.__fixE711</h4> <b>__fixE711</b>(<i>code, line, pos</i>) +<p> + Private method to fix comparison with None. +</p> +<p> + Codes: E711, E712 +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +code of the issue +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message code for the fix, a list of arguments for the + message and an ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, list or int, int) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixN804" ID="CodeStyleFixer.__fixN804"></a> <h4>CodeStyleFixer.__fixN804</h4> <b>__fixN804</b>(<i>code, line, pos, apply=False</i>) @@ -1474,22 +1897,196 @@ <h4>CodeStyleFixer.__fixReindent</h4> <b>__fixReindent</b>(<i>line, pos, logical</i>) +<p> + Private method to fix a badly indented line. +</p> +<p> + This is done by adding or removing from its initial indent only. +</p> +<dl> + +<dt><i>line</i></dt> +<dd> +line number of the issue (integer) +</dd> +<dt><i>pos</i></dt> +<dd> +position inside line (integer) +</dd> +<dt><i>logical</i></dt> +<dd> +logical line structure +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a change was done (boolean) +</dd> +</dl> +<dl> + +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate a bad 'logical' parameter +</dd> +</dl> <a NAME="CodeStyleFixer.__fixW291" ID="CodeStyleFixer.__fixW291"></a> <h4>CodeStyleFixer.__fixW291</h4> <b>__fixW291</b>(<i>code, line, pos</i>) +<p> + Private method to fix trailing whitespace. +</p> +<p> + Codes: W291, W293 +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +code of the issue +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message code for the fix, a list of arguments for the + message and an ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, list or int, int) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixW292" ID="CodeStyleFixer.__fixW292"></a> <h4>CodeStyleFixer.__fixW292</h4> <b>__fixW292</b>(<i>code, line, pos</i>) +<p> + Private method to fix a missing newline at the end of file. +</p> +<p> + Codes: W292 +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +code of the issue +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message code for the fix, a list of arguments for the + message and an ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, list or int, int) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixW391" ID="CodeStyleFixer.__fixW391"></a> <h4>CodeStyleFixer.__fixW391</h4> <b>__fixW391</b>(<i>code, line, pos</i>) +<p> + Private method to fix trailing blank lines. +</p> +<p> + Codes: W391 +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +code of the issue +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message code for the fix, a list of arguments for the + message and an ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, list or int, int) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixW603" ID="CodeStyleFixer.__fixW603"></a> <h4>CodeStyleFixer.__fixW603</h4> <b>__fixW603</b>(<i>code, line, pos</i>) +<p> + Private method to fix the not equal notation. +</p> +<p> + Codes: W603 +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +code of the issue +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message code for the fix, a list of arguments for the + message and an ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, list or int, int) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixWhitespace" ID="CodeStyleFixer.__fixWhitespace"></a> <h4>CodeStyleFixer.__fixWhitespace</h4> <b>__fixWhitespace</b>(<i>line, offset, replacement</i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html Fri Oct 27 14:09:40 2023 +0200 @@ -64,15 +64,15 @@ </tr> <tr> <td><a href="#DocStyleChecker.__checkBackslashes">__checkBackslashes</a></td> -<td></td> +<td>Private method to check, that all docstrings containing backslashes are surrounded by raw triple double quotes.</td> </tr> <tr> <td><a href="#DocStyleChecker.__checkBlankAfterLastParagraph">__checkBlankAfterLastParagraph</a></td> -<td></td> +<td>Private method to check, that the last paragraph of docstrings is followed by a blank line.</td> </tr> <tr> <td><a href="#DocStyleChecker.__checkBlankAfterSummary">__checkBlankAfterSummary</a></td> -<td></td> +<td>Private method to check, that docstring summaries are followed by a blank line.</td> </tr> <tr> <td><a href="#DocStyleChecker.__checkBlankBeforeAndAfterClass">__checkBlankBeforeAndAfterClass</a></td> @@ -84,15 +84,15 @@ </tr> <tr> <td><a href="#DocStyleChecker.__checkEndsWithPeriod">__checkEndsWithPeriod</a></td> -<td></td> +<td>Private method to check, that docstring summaries end with a period.</td> </tr> <tr> <td><a href="#DocStyleChecker.__checkEricBlankAfterSummary">__checkEricBlankAfterSummary</a></td> -<td></td> +<td>Private method to check, that docstring summaries are followed by a blank line.</td> </tr> <tr> <td><a href="#DocStyleChecker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td> -<td></td> +<td>Private method to check, that docstring summaries end with a period.</td> </tr> <tr> <td><a href="#DocStyleChecker.__checkEricException">__checkEricException</a></td> @@ -112,7 +112,7 @@ </tr> <tr> <td><a href="#DocStyleChecker.__checkEricQuotesOnSeparateLines">__checkEricQuotesOnSeparateLines</a></td> -<td></td> +<td>Private method to check, that leading and trailing quotes are on a line by themselves.</td> </tr> <tr> <td><a href="#DocStyleChecker.__checkEricReturn">__checkEricReturn</a></td> @@ -136,7 +136,7 @@ </tr> <tr> <td><a href="#DocStyleChecker.__checkImperativeMood">__checkImperativeMood</a></td> -<td></td> +<td>Private method to check, that docstring summaries are in imperative mood.</td> </tr> <tr> <td><a href="#DocStyleChecker.__checkIndent">__checkIndent</a></td> @@ -164,11 +164,11 @@ </tr> <tr> <td><a href="#DocStyleChecker.__checkSummary">__checkSummary</a></td> -<td></td> +<td>Private method to check, that docstring summaries contain some text.</td> </tr> <tr> <td><a href="#DocStyleChecker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td> -<td></td> +<td>Private method to check, that all docstrings are surrounded by triple double quotes.</td> </tr> <tr> <td><a href="#DocStyleChecker.__error">__error</a></td> @@ -289,14 +289,59 @@ <h4>DocStyleChecker.__checkBackslashes</h4> <b>__checkBackslashes</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all docstrings containing + backslashes are surrounded by raw triple double quotes. +</p> +<dl> + +<dt><i>docstringContext</i></dt> +<dd> +docstring context (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> <a NAME="DocStyleChecker.__checkBlankAfterLastParagraph" ID="DocStyleChecker.__checkBlankAfterLastParagraph"></a> <h4>DocStyleChecker.__checkBlankAfterLastParagraph</h4> <b>__checkBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that the last paragraph of docstrings is + followed by a blank line. +</p> +<dl> + +<dt><i>docstringContext</i></dt> +<dd> +docstring context (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> <a NAME="DocStyleChecker.__checkBlankAfterSummary" ID="DocStyleChecker.__checkBlankAfterSummary"></a> <h4>DocStyleChecker.__checkBlankAfterSummary</h4> <b>__checkBlankAfterSummary</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries are followed + by a blank line. +</p> +<dl> + +<dt><i>docstringContext</i></dt> +<dd> +docstring context (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> <a NAME="DocStyleChecker.__checkBlankBeforeAndAfterClass" ID="DocStyleChecker.__checkBlankBeforeAndAfterClass"></a> <h4>DocStyleChecker.__checkBlankBeforeAndAfterClass</h4> <b>__checkBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>) @@ -339,14 +384,57 @@ <h4>DocStyleChecker.__checkEndsWithPeriod</h4> <b>__checkEndsWithPeriod</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries end with a period. +</p> +<dl> + +<dt><i>docstringContext</i></dt> +<dd> +docstring context (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> <a NAME="DocStyleChecker.__checkEricBlankAfterSummary" ID="DocStyleChecker.__checkEricBlankAfterSummary"></a> <h4>DocStyleChecker.__checkEricBlankAfterSummary</h4> <b>__checkEricBlankAfterSummary</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries are followed + by a blank line. +</p> +<dl> + +<dt><i>docstringContext</i></dt> +<dd> +docstring context (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> <a NAME="DocStyleChecker.__checkEricEndsWithPeriod" ID="DocStyleChecker.__checkEricEndsWithPeriod"></a> <h4>DocStyleChecker.__checkEricEndsWithPeriod</h4> <b>__checkEricEndsWithPeriod</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries end with a period. +</p> +<dl> + +<dt><i>docstringContext</i></dt> +<dd> +docstring context (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> <a NAME="DocStyleChecker.__checkEricException" ID="DocStyleChecker.__checkEricException"></a> <h4>DocStyleChecker.__checkEricException</h4> <b>__checkEricException</b>(<i>docstringContext, context</i>) @@ -432,6 +520,21 @@ <h4>DocStyleChecker.__checkEricQuotesOnSeparateLines</h4> <b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that leading and trailing quotes are on + a line by themselves. +</p> +<dl> + +<dt><i>docstringContext</i></dt> +<dd> +docstring context (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> <a NAME="DocStyleChecker.__checkEricReturn" ID="DocStyleChecker.__checkEricReturn"></a> <h4>DocStyleChecker.__checkEricReturn</h4> <b>__checkEricReturn</b>(<i>docstringContext, context</i>) @@ -536,6 +639,21 @@ <h4>DocStyleChecker.__checkImperativeMood</h4> <b>__checkImperativeMood</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries are in + imperative mood. +</p> +<dl> + +<dt><i>docstringContext</i></dt> +<dd> +docstring context (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> <a NAME="DocStyleChecker.__checkIndent" ID="DocStyleChecker.__checkIndent"></a> <h4>DocStyleChecker.__checkIndent</h4> <b>__checkIndent</b>(<i>docstringContext, context</i>) @@ -651,10 +769,39 @@ <h4>DocStyleChecker.__checkSummary</h4> <b>__checkSummary</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries contain some text. +</p> +<dl> + +<dt><i>docstringContext</i></dt> +<dd> +docstring context (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> <a NAME="DocStyleChecker.__checkTripleDoubleQuotes" ID="DocStyleChecker.__checkTripleDoubleQuotes"></a> <h4>DocStyleChecker.__checkTripleDoubleQuotes</h4> <b>__checkTripleDoubleQuotes</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all docstrings are surrounded + by triple double quotes. +</p> +<dl> + +<dt><i>docstringContext</i></dt> +<dd> +docstring context (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> <a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a> <h4>DocStyleChecker.__error</h4> <b>__error</b>(<i>lineNumber, offset, code, *args</i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html Fri Oct 27 14:09:40 2023 +0200 @@ -64,23 +64,23 @@ </tr> <tr> <td><a href="#NamingStyleChecker.__checkFunctionArgumentNames">__checkFunctionArgumentNames</a></td> -<td></td> +<td>Private class to check the argument names of functions (N803, N804, N805, N806).</td> </tr> <tr> <td><a href="#NamingStyleChecker.__checkFunctionName">__checkFunctionName</a></td> -<td></td> +<td>Private class to check the given node for function name conventions (N802, N809).</td> </tr> <tr> <td><a href="#NamingStyleChecker.__checkImportAs">__checkImportAs</a></td> -<td></td> +<td>Private method to check that imports don't change the naming convention (N811, N812, N813, N814, N815).</td> </tr> <tr> <td><a href="#NamingStyleChecker.__checkModule">__checkModule</a></td> -<td></td> +<td>Private method to check module naming conventions (N807, N808).</td> </tr> <tr> <td><a href="#NamingStyleChecker.__checkNameToBeAvoided">__checkNameToBeAvoided</a></td> -<td></td> +<td>Private class to check the given node for a name to be avoided (N831).</td> </tr> <tr> <td><a href="#NamingStyleChecker.__checkVariableNames">__checkVariableNames</a></td> @@ -222,22 +222,170 @@ <h4>NamingStyleChecker.__checkFunctionArgumentNames</h4> <b>__checkFunctionArgumentNames</b>(<i>node, parents</i>) +<p> + Private class to check the argument names of functions + (N803, N804, N805, N806). +</p> +<p> + The argument names of a function should be lowercase, with words + separated by underscores. A class method should have 'cls' as the + first argument. A method should have 'self' as the first argument. +</p> +<dl> + +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +<dt><i>parents</i></dt> +<dd> +list of parent nodes +</dd> +</dl> +<dl> +<dt>Yield:</dt> +<dd> +tuple giving line number, offset within line and error code +</dd> +</dl> +<dl> +<dt>Yield Type:</dt> +<dd> +tuple of (int, int, str) +</dd> +</dl> <a NAME="NamingStyleChecker.__checkFunctionName" ID="NamingStyleChecker.__checkFunctionName"></a> <h4>NamingStyleChecker.__checkFunctionName</h4> <b>__checkFunctionName</b>(<i>node, parents</i>) +<p> + Private class to check the given node for function name + conventions (N802, N809). +</p> +<p> + Function names should be lowercase, with words separated by underscores + as necessary to improve readability. Functions <b>not</b> being + methods '__' in front and back are not allowed. Mixed case is allowed + only in contexts where that's already the prevailing style + (e.g. threading.py), to retain backwards compatibility. +</p> +<dl> + +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +<dt><i>parents</i></dt> +<dd> +list of parent nodes +</dd> +</dl> +<dl> +<dt>Yield:</dt> +<dd> +tuple giving line number, offset within line and error code +</dd> +</dl> +<dl> +<dt>Yield Type:</dt> +<dd> +tuple of (int, int, str) +</dd> +</dl> <a NAME="NamingStyleChecker.__checkImportAs" ID="NamingStyleChecker.__checkImportAs"></a> <h4>NamingStyleChecker.__checkImportAs</h4> <b>__checkImportAs</b>(<i>node, parents</i>) +<p> + Private method to check that imports don't change the + naming convention (N811, N812, N813, N814, N815). +</p> +<dl> + +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +<dt><i>parents</i></dt> +<dd> +list of parent nodes +</dd> +</dl> +<dl> +<dt>Yield:</dt> +<dd> +tuple giving line number, offset within line and error code +</dd> +</dl> +<dl> +<dt>Yield Type:</dt> +<dd> +tuple of (int, int, str) +</dd> +</dl> <a NAME="NamingStyleChecker.__checkModule" ID="NamingStyleChecker.__checkModule"></a> <h4>NamingStyleChecker.__checkModule</h4> <b>__checkModule</b>(<i>node, parents</i>) +<p> + Private method to check module naming conventions (N807, N808). +</p> +<p> + Module and package names should be lowercase. +</p> +<dl> + +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +<dt><i>parents</i></dt> +<dd> +list of parent nodes +</dd> +</dl> +<dl> +<dt>Yield:</dt> +<dd> +tuple giving line number, offset within line and error code +</dd> +</dl> +<dl> +<dt>Yield Type:</dt> +<dd> +tuple of (int, int, str) +</dd> +</dl> <a NAME="NamingStyleChecker.__checkNameToBeAvoided" ID="NamingStyleChecker.__checkNameToBeAvoided"></a> <h4>NamingStyleChecker.__checkNameToBeAvoided</h4> <b>__checkNameToBeAvoided</b>(<i>node, parents</i>) +<p> + Private class to check the given node for a name to be avoided (N831). +</p> +<dl> + +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +<dt><i>parents</i></dt> +<dd> +list of parent nodes +</dd> +</dl> +<dl> +<dt>Yield:</dt> +<dd> +tuple giving line number, offset within line and error code +</dd> +</dl> +<dl> +<dt>Yield Type:</dt> +<dd> +tuple of (int, int, str) +</dd> +</dl> <a NAME="NamingStyleChecker.__checkVariableNames" ID="NamingStyleChecker.__checkVariableNames"></a> <h4>NamingStyleChecker.__checkVariableNames</h4> <b>__checkVariableNames</b>(<i>node, parents</i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.assert.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.assert.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,7 +27,7 @@ <tr> <td><a href="#checkAssertUsed">checkAssertUsed</a></td> -<td></td> +<td>Function to check for the use of 'assert'.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -40,6 +40,24 @@ <h2>checkAssertUsed</h2> <b>checkAssertUsed</b>(<i>reportError, context, config</i>) +<p> + Function to check for the use of 'assert'. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.awsHardcodedPassword.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.awsHardcodedPassword.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,7 +27,7 @@ <tr> <td><a href="#checkHardcodedAwsKey">checkHardcodedAwsKey</a></td> -<td></td> +<td>Function to check for potentially hardcoded AWS passwords.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -44,6 +44,24 @@ <h2>checkHardcodedAwsKey</h2> <b>checkHardcodedAwsKey</b>(<i>reportError, context, config</i>) +<p> + Function to check for potentially hardcoded AWS passwords. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.blackListCalls.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.blackListCalls.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,7 +27,7 @@ <tr> <td><a href="#checkBlacklist">checkBlacklist</a></td> -<td></td> +<td>Function to check for blacklisted method calls.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -40,6 +40,24 @@ <h2>checkBlacklist</h2> <b>checkBlacklist</b>(<i>reportError, context, config</i>) +<p> + Function to check for blacklisted method calls. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.blackListImports.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.blackListImports.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,7 +27,7 @@ <tr> <td><a href="#checkBlacklist">checkBlacklist</a></td> -<td></td> +<td>Function to check for blacklisted method calls.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -40,6 +40,24 @@ <h2>checkBlacklist</h2> <b>checkBlacklist</b>(<i>reportError, context, config</i>) +<p> + Function to check for blacklisted method calls. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.certificateValidation.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.certificateValidation.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,7 +27,7 @@ <tr> <td><a href="#checkNoCertificateValidation">checkNoCertificateValidation</a></td> -<td></td> +<td>Function to check for switched off certificate validation.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -40,6 +40,24 @@ <h2>checkNoCertificateValidation</h2> <b>checkNoCertificateValidation</b>(<i>reportError, context, config</i>) +<p> + Function to check for switched off certificate validation. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.djangoSqlInjection.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.djangoSqlInjection.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,11 +27,11 @@ <tr> <td><a href="#checkDjangoExtraUsed">checkDjangoExtraUsed</a></td> -<td></td> +<td>Function to check for potential SQL injection on extra function.</td> </tr> <tr> <td><a href="#checkDjangoRawSqlUsed">checkDjangoRawSqlUsed</a></td> -<td></td> +<td>Function to check for potential SQL injection on RawSQL function.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -48,6 +48,24 @@ <h2>checkDjangoExtraUsed</h2> <b>checkDjangoExtraUsed</b>(<i>reportError, context, config</i>) +<p> + Function to check for potential SQL injection on extra function. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -55,6 +73,24 @@ <h2>checkDjangoRawSqlUsed</h2> <b>checkDjangoRawSqlUsed</b>(<i>reportError, context, config</i>) +<p> + Function to check for potential SQL injection on RawSQL function. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.djangoXssVulnerability.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.djangoXssVulnerability.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#checkDjangoXssVulnerability">checkDjangoXssVulnerability</a></td> -<td></td> +<td>Function to check for potential XSS vulnerability.</td> </tr> <tr> <td><a href="#checkPotentialRisk">checkPotentialRisk</a></td> @@ -174,6 +174,24 @@ <h2>checkDjangoXssVulnerability</h2> <b>checkDjangoXssVulnerability</b>(<i>reportError, context, config</i>) +<p> + Function to check for potential XSS vulnerability. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.exec.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.exec.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,7 +27,7 @@ <tr> <td><a href="#checkExecUsed">checkExecUsed</a></td> -<td></td> +<td>Function to check for the use of 'exec'.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -40,6 +40,24 @@ <h2>checkExecUsed</h2> <b>checkExecUsed</b>(<i>reportError, context, config</i>) +<p> + Function to check for the use of 'exec'. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.flaskDebug.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.flaskDebug.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,7 +27,7 @@ <tr> <td><a href="#checkFlaskDebug">checkFlaskDebug</a></td> -<td></td> +<td>Function to check for a flask app being run with debug.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -40,6 +40,24 @@ <h2>checkFlaskDebug</h2> <b>checkFlaskDebug</b>(<i>reportError, context, config</i>) +<p> + Function to check for a flask app being run with debug. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.generalBindAllInterfaces.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.generalBindAllInterfaces.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,7 +27,7 @@ <tr> <td><a href="#checkBindAllInterfaces">checkBindAllInterfaces</a></td> -<td></td> +<td>Function to check for binding to all interfaces.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -40,6 +40,24 @@ <h2>checkBindAllInterfaces</h2> <b>checkBindAllInterfaces</b>(<i>reportError, context, config</i>) +<p> + Function to check for binding to all interfaces. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.generalFilePermissions.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.generalFilePermissions.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ </tr> <tr> <td><a href="#checkFilePermissions">checkFilePermissions</a></td> -<td></td> +<td>Function to check for setting too permissive file permissions.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -73,6 +73,24 @@ <h2>checkFilePermissions</h2> <b>checkFilePermissions</b>(<i>reportError, context, config</i>) +<p> + Function to check for setting too permissive file permissions. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.generalHardcodedPassword.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.generalHardcodedPassword.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,15 +27,15 @@ <tr> <td><a href="#checkHardcodedPasswordAsDefault">checkHardcodedPasswordAsDefault</a></td> -<td></td> +<td>Function to check for use of hard-coded password argument defaults.</td> </tr> <tr> <td><a href="#checkHardcodedPasswordAsFunctionArg">checkHardcodedPasswordAsFunctionArg</a></td> -<td></td> +<td>Function to check for use of hard-coded password function arguments.</td> </tr> <tr> <td><a href="#checkHardcodedPasswordAsString">checkHardcodedPasswordAsString</a></td> -<td></td> +<td>Function to check for use of hardcoded password strings.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -48,6 +48,24 @@ <h2>checkHardcodedPasswordAsDefault</h2> <b>checkHardcodedPasswordAsDefault</b>(<i>reportError, context, config</i>) +<p> + Function to check for use of hard-coded password argument defaults. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -55,6 +73,24 @@ <h2>checkHardcodedPasswordAsFunctionArg</h2> <b>checkHardcodedPasswordAsFunctionArg</b>(<i>reportError, context, config</i>) +<p> + Function to check for use of hard-coded password function arguments. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -62,6 +98,24 @@ <h2>checkHardcodedPasswordAsString</h2> <b>checkHardcodedPasswordAsString</b>(<i>reportError, context, config</i>) +<p> + Function to check for use of hardcoded password strings. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.injectionParamiko.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.injectionParamiko.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,7 +27,7 @@ <tr> <td><a href="#checkParamikoCalls">checkParamikoCalls</a></td> -<td></td> +<td>Function to check for shell injection within Paramiko.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -40,6 +40,24 @@ <h2>checkParamikoCalls</h2> <b>checkParamikoCalls</b>(<i>reportError, context, config</i>) +<p> + Function to check for shell injection within Paramiko. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.injectionSql.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.injectionSql.html Fri Oct 27 14:09:40 2023 +0200 @@ -35,7 +35,7 @@ </tr> <tr> <td><a href="#checkHardcodedSqlExpressions">checkHardcodedSqlExpressions</a></td> -<td></td> +<td>Function to check for SQL injection.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -107,6 +107,24 @@ <h2>checkHardcodedSqlExpressions</h2> <b>checkHardcodedSqlExpressions</b>(<i>reportError, context, config</i>) +<p> + Function to check for SQL injection. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.insecureSslTls.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.insecureSslTls.html Fri Oct 27 14:09:40 2023 +0200 @@ -35,7 +35,7 @@ </tr> <tr> <td><a href="#checkSslWithoutVersion">checkSslWithoutVersion</a></td> -<td></td> +<td>Function to check for SSL use with no version specified.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -98,6 +98,24 @@ <h2>checkSslWithoutVersion</h2> <b>checkSslWithoutVersion</b>(<i>reportError, context, config</i>) +<p> + Function to check for SSL use with no version specified. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.jinja2Templates.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.jinja2Templates.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,7 +27,7 @@ <tr> <td><a href="#checkJinja2Autoescape">checkJinja2Autoescape</a></td> -<td></td> +<td>Function to check for not auto escaping in jinja2.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -40,6 +40,24 @@ <h2>checkJinja2Autoescape</h2> <b>checkJinja2Autoescape</b>(<i>reportError, context, config</i>) +<p> + Function to check for not auto escaping in jinja2. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.makoTemplates.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.makoTemplates.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,7 +27,7 @@ <tr> <td><a href="#checkMakoTemplateUsage">checkMakoTemplateUsage</a></td> -<td></td> +<td>Function to check for use of mako templates.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -40,6 +40,24 @@ <h2>checkMakoTemplateUsage</h2> <b>checkMakoTemplateUsage</b>(<i>reportError, context, config</i>) +<p> + Function to check for use of mako templates. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.requestWithoutTimeout.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.requestWithoutTimeout.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,7 +27,7 @@ <tr> <td><a href="#checkRequestWithouTimeout">checkRequestWithouTimeout</a></td> -<td></td> +<td>Function to check for use of requests without timeout.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -40,6 +40,24 @@ <h2>checkRequestWithouTimeout</h2> <b>checkRequestWithouTimeout</b>(<i>reportError, context, config</i>) +<p> + Function to check for use of requests without timeout. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.snmpSecurity.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.snmpSecurity.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,11 +27,11 @@ <tr> <td><a href="#checkInsecureVersion">checkInsecureVersion</a></td> -<td></td> +<td>Function to check for the use of insecure SNMP version like v1, v2c.</td> </tr> <tr> <td><a href="#checkWeakCryptography">checkWeakCryptography</a></td> -<td></td> +<td>Function to check for the use of insecure SNMP cryptography (i.e.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -44,6 +44,25 @@ <h2>checkInsecureVersion</h2> <b>checkInsecureVersion</b>(<i>reportError, context, config</i>) +<p> + Function to check for the use of insecure SNMP version like + v1, v2c. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -51,6 +70,25 @@ <h2>checkWeakCryptography</h2> <b>checkWeakCryptography</b>(<i>reportError, context, config</i>) +<p> + Function to check for the use of insecure SNMP cryptography + (i.e. v3 using noAuthNoPriv). +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.sshNoHostKeyVerification.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.sshNoHostKeyVerification.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,7 +27,7 @@ <tr> <td><a href="#checkSshNoHostKeyVerification">checkSshNoHostKeyVerification</a></td> -<td></td> +<td>Function to check for use of mako templates.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -40,6 +40,24 @@ <h2>checkSshNoHostKeyVerification</h2> <b>checkSshNoHostKeyVerification</b>(<i>reportError, context, config</i>) +<p> + Function to check for use of mako templates. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.tarfileUnsafeMembers.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.tarfileUnsafeMembers.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ </tr> <tr> <td><a href="#checkTarfileUnsafeMembers">checkTarfileUnsafeMembers</a></td> -<td></td> +<td>Function to check for insecure use of 'tarfile.extracall()'.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -73,6 +73,24 @@ <h2>checkTarfileUnsafeMembers</h2> <b>checkTarfileUnsafeMembers</b>(<i>reportError, context, config</i>) +<p> + Function to check for insecure use of 'tarfile.extracall()'. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.yamlLoad.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.yamlLoad.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,7 +27,7 @@ <tr> <td><a href="#checkYamlLoad">checkYamlLoad</a></td> -<td></td> +<td>Function to check for the use of yaml load functions.</td> </tr> <tr> <td><a href="#getChecks">getChecks</a></td> @@ -40,6 +40,24 @@ <h2>checkYamlLoad</h2> <b>checkYamlLoad</b>(<i>reportError, context, config</i>) +<p> + Function to check for the use of yaml load functions. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginCodeStyleChecker.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginCodeStyleChecker.html Fri Oct 27 14:09:40 2023 +0200 @@ -109,7 +109,7 @@ </tr> <tr> <td><a href="#CodeStyleCheckerPlugin.__projectShowMenu">__projectShowMenu</a></td> -<td></td> +<td>Private slot called, when the the project menu or a submenu is about to be shown.</td> </tr> <tr> <td><a href="#CodeStyleCheckerPlugin.__serviceError">__serviceError</a></td> @@ -272,6 +272,21 @@ <h4>CodeStyleCheckerPlugin.__projectShowMenu</h4> <b>__projectShowMenu</b>(<i>menuName, menu</i>) +<p> + Private slot called, when the the project menu or a submenu is + about to be shown. +</p> +<dl> + +<dt><i>menuName</i></dt> +<dd> +name of the menu to be shown (string) +</dd> +<dt><i>menu</i></dt> +<dd> +reference to the menu (QMenu) +</dd> +</dl> <a NAME="CodeStyleCheckerPlugin.__serviceError" ID="CodeStyleCheckerPlugin.__serviceError"></a> <h4>CodeStyleCheckerPlugin.__serviceError</h4> <b>__serviceError</b>(<i>fn, msg</i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginEricapi.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginEricapi.html Fri Oct 27 14:09:40 2023 +0200 @@ -72,7 +72,7 @@ </tr> <tr> <td><a href="#EricapiPlugin.__projectShowMenu">__projectShowMenu</a></td> -<td></td> +<td>Private slot called, when the the project menu or a submenu is about to be shown.</td> </tr> <tr> <td><a href="#EricapiPlugin.activate">activate</a></td> @@ -121,6 +121,21 @@ <h4>EricapiPlugin.__projectShowMenu</h4> <b>__projectShowMenu</b>(<i>menuName, menu</i>) +<p> + Private slot called, when the the project menu or a submenu is + about to be shown. +</p> +<dl> + +<dt><i>menuName</i></dt> +<dd> +name of the menu to be shown (string) +</dd> +<dt><i>menu</i></dt> +<dd> +reference to the menu (QMenu) +</dd> +</dl> <a NAME="EricapiPlugin.activate" ID="EricapiPlugin.activate"></a> <h4>EricapiPlugin.activate</h4> <b>activate</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginEricdoc.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginEricdoc.html Fri Oct 27 14:09:40 2023 +0200 @@ -72,7 +72,7 @@ </tr> <tr> <td><a href="#EricdocPlugin.__projectShowMenu">__projectShowMenu</a></td> -<td></td> +<td>Private slot called, when the the project menu or a submenu is about to be shown.</td> </tr> <tr> <td><a href="#EricdocPlugin.activate">activate</a></td> @@ -121,6 +121,21 @@ <h4>EricdocPlugin.__projectShowMenu</h4> <b>__projectShowMenu</b>(<i>menuName, menu</i>) +<p> + Private slot called, when the the project menu or a submenu is + about to be shown. +</p> +<dl> + +<dt><i>menuName</i></dt> +<dd> +name of the menu to be shown (string) +</dd> +<dt><i>menu</i></dt> +<dd> +reference to the menu (QMenu) +</dd> +</dl> <a NAME="EricdocPlugin.activate" ID="EricdocPlugin.activate"></a> <h4>EricdocPlugin.activate</h4> <b>activate</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginSyntaxChecker.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginSyntaxChecker.html Fri Oct 27 14:09:40 2023 +0200 @@ -92,7 +92,7 @@ </tr> <tr> <td><a href="#SyntaxCheckerPlugin.__projectShowMenu">__projectShowMenu</a></td> -<td></td> +<td>Private slot called, when the the project menu or a submenu is about to be shown.</td> </tr> <tr> <td><a href="#SyntaxCheckerPlugin.__projectSyntaxCheck">__projectSyntaxCheck</a></td> @@ -248,6 +248,21 @@ <h4>SyntaxCheckerPlugin.__projectShowMenu</h4> <b>__projectShowMenu</b>(<i>menuName, menu</i>) +<p> + Private slot called, when the the project menu or a submenu is + about to be shown. +</p> +<dl> + +<dt><i>menuName</i></dt> +<dd> +name of the menu to be shown (string) +</dd> +<dt><i>menu</i></dt> +<dd> +reference to the menu (QMenu) +</dd> +</dl> <a NAME="SyntaxCheckerPlugin.__projectSyntaxCheck" ID="SyntaxCheckerPlugin.__projectSyntaxCheck"></a> <h4>SyntaxCheckerPlugin.__projectSyntaxCheck</h4> <b>__projectSyntaxCheck</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginTranslator.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginTranslator.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createTranslatorPage">createTranslatorPage</a></td> -<td></td> +<td>Module function to create the Translator configuration page.</td> </tr> <tr> <td><a href="#getConfigData">getConfigData</a></td> @@ -233,6 +233,28 @@ <h2>createTranslatorPage</h2> <b>createTranslatorPage</b>(<i>configDlg</i>) +<p> + Module function to create the Translator configuration page. +</p> +<dl> + +<dt><i>configDlg</i> (ConfigurationWidget)</dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the configuration page +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +TranslatorPage +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsGit.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsGit.html Fri Oct 27 14:09:40 2023 +0200 @@ -35,7 +35,7 @@ </tr> <tr> <td><a href="#createConfigurationPage">createConfigurationPage</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> <tr> <td><a href="#displayString">displayString</a></td> @@ -278,6 +278,22 @@ <h2>createConfigurationPage</h2> <b>createConfigurationPage</b>(<i>configDlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>configDlg</i></dt> +<dd> +reference to the configuration dialog (QDialog) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the configuration page +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsMercurial.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsMercurial.html Fri Oct 27 14:09:40 2023 +0200 @@ -35,7 +35,7 @@ </tr> <tr> <td><a href="#createConfigurationPage">createConfigurationPage</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> <tr> <td><a href="#displayString">displayString</a></td> @@ -295,6 +295,22 @@ <h2>createConfigurationPage</h2> <b>createConfigurationPage</b>(<i>configDlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>configDlg</i></dt> +<dd> +reference to the configuration dialog (QDialog) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the configuration page +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsPySvn.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsPySvn.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createConfigurationPage">createConfigurationPage</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> <tr> <td><a href="#displayString">displayString</a></td> @@ -281,6 +281,22 @@ <h2>createConfigurationPage</h2> <b>createConfigurationPage</b>(<i>configDlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>configDlg</i></dt> +<dd> +reference to the configuration dialog (QDialog) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the configuration page +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsSubversion.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsSubversion.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createConfigurationPage">createConfigurationPage</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> <tr> <td><a href="#displayString">displayString</a></td> @@ -281,6 +281,22 @@ <h2>createConfigurationPage</h2> <b>createConfigurationPage</b>(<i>configDlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>configDlg</i></dt> +<dd> +reference to the configuration dialog (QDialog) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the configuration page +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.TranslationEngine.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.TranslationEngine.html Fri Oct 27 14:09:40 2023 +0200 @@ -74,7 +74,7 @@ </tr> <tr> <td><a href="#TranslationEngine.getTextToSpeechData">getTextToSpeechData</a></td> -<td></td> +<td>Public method to pronounce the given text.</td> </tr> <tr> <td><a href="#TranslationEngine.getTranslation">getTranslation</a></td> @@ -140,6 +140,36 @@ <h4>TranslationEngine.getTextToSpeechData</h4> <b>getTextToSpeechData</b>(<i>requestObject, text, language</i>) +<p> + Public method to pronounce the given text. +</p> +<dl> + +<dt><i>requestObject</i> (TranslatorRequest)</dt> +<dd> +reference to the request object +</dd> +<dt><i>text</i> (str)</dt> +<dd> +text to be pronounced +</dd> +<dt><i>language</i> (str)</dt> +<dd> +language code of the text +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple with pronounce data or an error string and a success flag +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (QByteArray or str, bool) +</dd> +</dl> <a NAME="TranslationEngine.getTranslation" ID="TranslationEngine.getTranslation"></a> <h4>TranslationEngine.getTranslation</h4> <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.ProjectBrowserHelper.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.ProjectBrowserHelper.html Fri Oct 27 14:09:40 2023 +0200 @@ -132,19 +132,19 @@ </tr> <tr> <td><a href="#GitProjectBrowserHelper.showContextMenu">showContextMenu</a></td> -<td></td> +<td>Public slot called before the context menu is shown.</td> </tr> <tr> <td><a href="#GitProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td> -<td></td> +<td>Public slot called before the context menu is shown.</td> </tr> <tr> <td><a href="#GitProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td> -<td></td> +<td>Public slot called before the context menu is shown.</td> </tr> <tr> <td><a href="#GitProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td> -<td></td> +<td>Public slot called before the context menu (multiple selections) is shown.</td> </tr> </table> <h3>Static Methods</h3> @@ -378,18 +378,95 @@ <h4>GitProjectBrowserHelper.showContextMenu</h4> <b>showContextMenu</b>(<i>menu, standardItems</i>) +<p> + Public slot called before the context menu is shown. +</p> +<p> + It enables/disables the VCS menu entries depending on the overall + VCS status and the file status. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown +</dd> +<dt><i>standardItems</i></dt> +<dd> +array of standard items that need + activation/deactivation depending on the overall VCS status +</dd> +</dl> <a NAME="GitProjectBrowserHelper.showContextMenuDir" ID="GitProjectBrowserHelper.showContextMenuDir"></a> <h4>GitProjectBrowserHelper.showContextMenuDir</h4> <b>showContextMenuDir</b>(<i>menu, standardItems</i>) +<p> + Public slot called before the context menu is shown. +</p> +<p> + It enables/disables the VCS menu entries depending on the overall + VCS status and the directory status. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown +</dd> +<dt><i>standardItems</i></dt> +<dd> +array of standard items that need + activation/deactivation depending on the overall VCS status +</dd> +</dl> <a NAME="GitProjectBrowserHelper.showContextMenuDirMulti" ID="GitProjectBrowserHelper.showContextMenuDirMulti"></a> <h4>GitProjectBrowserHelper.showContextMenuDirMulti</h4> <b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>) +<p> + Public slot called before the context menu is shown. +</p> +<p> + It enables/disables the VCS menu entries depending on the overall + VCS status and the directory status. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown +</dd> +<dt><i>standardItems</i></dt> +<dd> +array of standard items that need + activation/deactivation depending on the overall VCS status +</dd> +</dl> <a NAME="GitProjectBrowserHelper.showContextMenuMulti" ID="GitProjectBrowserHelper.showContextMenuMulti"></a> <h4>GitProjectBrowserHelper.showContextMenuMulti</h4> <b>showContextMenuMulti</b>(<i>menu, standardItems</i>) +<p> + Public slot called before the context menu (multiple selections) is + shown. +</p> +<p> + It enables/disables the VCS menu entries depending on the overall + VCS status and the files status. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown +</dd> +<dt><i>standardItems</i></dt> +<dd> +array of standard items that need + activation/deactivation depending on the overall VCS status +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html Fri Oct 27 14:09:40 2023 +0200 @@ -436,7 +436,7 @@ </tr> <tr> <td><a href="#Git.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td> -<td></td> +<td>Public method used to get the registered states of a number of files in the vcs.</td> </tr> <tr> <td><a href="#Git.vcsCheckout">vcsCheckout</a></td> @@ -496,7 +496,7 @@ </tr> <tr> <td><a href="#Git.vcsInit">vcsInit</a></td> -<td></td> +<td>Public method used to initialize the Git repository.</td> </tr> <tr> <td><a href="#Git.vcsInitConfig">vcsInitConfig</a></td> @@ -2356,6 +2356,37 @@ <h4>Git.vcsAllRegisteredStates</h4> <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>) +<p> + Public method used to get the registered states of a number of files + in the vcs. +</p> +<p> + <b>Note:</b> If a shortcut is to be taken, the code will only check, + if the named directory has been scanned already. If so, it is assumed, + that the states for all files have been populated by the previous run. +</p> +<dl> + +<dt><i>names</i></dt> +<dd> +dictionary with all filenames to be checked as keys +</dd> +<dt><i>dname</i></dt> +<dd> +directory to check in (string) +</dd> +<dt><i>shortcut</i></dt> +<dd> +flag indicating a shortcut should be taken (boolean) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +the received dictionary completed with a combination of + canBeCommited and canBeAdded or None in order to signal an error +</dd> +</dl> <a NAME="Git.vcsCheckout" ID="Git.vcsCheckout"></a> <h4>Git.vcsCheckout</h4> <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) @@ -2663,6 +2694,31 @@ <h4>Git.vcsInit</h4> <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>) +<p> + Public method used to initialize the Git repository. +</p> +<p> + The initialization is done, when a project is converted into a + Git controlled project. Therefore we always return TRUE without + doing anything. +</p> +<dl> + +<dt><i>vcsDir</i></dt> +<dd> +name of the VCS directory (string) +</dd> +<dt><i>noDialog</i></dt> +<dd> +flag indicating quiet operations (boolean) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +always TRUE +</dd> +</dl> <a NAME="Git.vcsInitConfig" ID="Git.vcsInitConfig"></a> <h4>Git.vcsInitConfig</h4> <b>vcsInitConfig</b>(<i>project</i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ProjectBrowserHelper.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ProjectBrowserHelper.html Fri Oct 27 14:09:40 2023 +0200 @@ -148,19 +148,19 @@ </tr> <tr> <td><a href="#HgProjectBrowserHelper.showContextMenu">showContextMenu</a></td> -<td></td> +<td>Public slot called before the context menu is shown.</td> </tr> <tr> <td><a href="#HgProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td> -<td></td> +<td>Public slot called before the context menu is shown.</td> </tr> <tr> <td><a href="#HgProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td> -<td></td> +<td>Public slot called before the context menu is shown.</td> </tr> <tr> <td><a href="#HgProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td> -<td></td> +<td>Public slot called before the context menu (multiple selections) is shown.</td> </tr> </table> <h3>Static Methods</h3> @@ -456,18 +456,95 @@ <h4>HgProjectBrowserHelper.showContextMenu</h4> <b>showContextMenu</b>(<i>menu, standardItems</i>) +<p> + Public slot called before the context menu is shown. +</p> +<p> + It enables/disables the VCS menu entries depending on the overall + VCS status and the file status. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown +</dd> +<dt><i>standardItems</i></dt> +<dd> +array of standard items that need + activation/deactivation depending on the overall VCS status +</dd> +</dl> <a NAME="HgProjectBrowserHelper.showContextMenuDir" ID="HgProjectBrowserHelper.showContextMenuDir"></a> <h4>HgProjectBrowserHelper.showContextMenuDir</h4> <b>showContextMenuDir</b>(<i>menu, standardItems</i>) +<p> + Public slot called before the context menu is shown. +</p> +<p> + It enables/disables the VCS menu entries depending on the overall + VCS status and the directory status. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown +</dd> +<dt><i>standardItems</i></dt> +<dd> +array of standard items that need + activation/deactivation depending on the overall VCS status +</dd> +</dl> <a NAME="HgProjectBrowserHelper.showContextMenuDirMulti" ID="HgProjectBrowserHelper.showContextMenuDirMulti"></a> <h4>HgProjectBrowserHelper.showContextMenuDirMulti</h4> <b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>) +<p> + Public slot called before the context menu is shown. +</p> +<p> + It enables/disables the VCS menu entries depending on the overall + VCS status and the directory status. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown +</dd> +<dt><i>standardItems</i></dt> +<dd> +array of standard items that need + activation/deactivation depending on the overall VCS status +</dd> +</dl> <a NAME="HgProjectBrowserHelper.showContextMenuMulti" ID="HgProjectBrowserHelper.showContextMenuMulti"></a> <h4>HgProjectBrowserHelper.showContextMenuMulti</h4> <b>showContextMenuMulti</b>(<i>menu, standardItems</i>) +<p> + Public slot called before the context menu (multiple selections) is + shown. +</p> +<p> + It enables/disables the VCS menu entries depending on the overall + VCS status and the files status. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown +</dd> +<dt><i>standardItems</i></dt> +<dd> +array of standard items that need + activation/deactivation depending on the overall VCS status +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html Fri Oct 27 14:09:40 2023 +0200 @@ -394,7 +394,7 @@ </tr> <tr> <td><a href="#Hg.vcsAdd">vcsAdd</a></td> -<td></td> +<td>Public method used to add a file/directory to the Mercurial repository.</td> </tr> <tr> <td><a href="#Hg.vcsAddBinary">vcsAddBinary</a></td> @@ -410,7 +410,7 @@ </tr> <tr> <td><a href="#Hg.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td> -<td></td> +<td>Public method used to get the registered states of a number of files in the vcs.</td> </tr> <tr> <td><a href="#Hg.vcsCheckout">vcsCheckout</a></td> @@ -470,7 +470,7 @@ </tr> <tr> <td><a href="#Hg.vcsInit">vcsInit</a></td> -<td></td> +<td>Public method used to initialize the mercurial repository.</td> </tr> <tr> <td><a href="#Hg.vcsInitConfig">vcsInitConfig</a></td> @@ -482,7 +482,7 @@ </tr> <tr> <td><a href="#Hg.vcsMerge">vcsMerge</a></td> -<td></td> +<td>Public method used to merge a URL/revision into the local project.</td> </tr> <tr> <td><a href="#Hg.vcsMove">vcsMove</a></td> @@ -506,11 +506,11 @@ </tr> <tr> <td><a href="#Hg.vcsRemove">vcsRemove</a></td> -<td></td> +<td>Public method used to remove a file/directory from the Mercurial repository.</td> </tr> <tr> <td><a href="#Hg.vcsRepositoryInfos">vcsRepositoryInfos</a></td> -<td></td> +<td>Public method to retrieve information about the repository.</td> </tr> <tr> <td><a href="#Hg.vcsResolved">vcsResolved</a></td> @@ -542,11 +542,11 @@ </tr> <tr> <td><a href="#Hg.vcsTag">vcsTag</a></td> -<td></td> +<td>Public method used to set/remove a tag in the Mercurial repository.</td> </tr> <tr> <td><a href="#Hg.vcsUpdate">vcsUpdate</a></td> -<td></td> +<td>Public method used to update a file/directory with the Mercurial repository.</td> </tr> </table> <h3>Static Methods</h3> @@ -1764,6 +1764,24 @@ <h4>Hg.vcsAdd</h4> <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>) +<p> + Public method used to add a file/directory to the Mercurial repository. +</p> +<dl> + +<dt><i>name</i></dt> +<dd> +file/directory name to be added (string) +</dd> +<dt><i>isDir</i></dt> +<dd> +flag indicating name is a directory (boolean) +</dd> +<dt><i>noDialog</i></dt> +<dd> +flag indicating quiet operations +</dd> +</dl> <a NAME="Hg.vcsAddBinary" ID="Hg.vcsAddBinary"></a> <h4>Hg.vcsAddBinary</h4> <b>vcsAddBinary</b>(<i>name, isDir=False</i>) @@ -1817,6 +1835,37 @@ <h4>Hg.vcsAllRegisteredStates</h4> <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>) +<p> + Public method used to get the registered states of a number of files + in the vcs. +</p> +<p> + <b>Note:</b> If a shortcut is to be taken, the code will only check, + if the named directory has been scanned already. If so, it is assumed, + that the states for all files have been populated by the previous run. +</p> +<dl> + +<dt><i>names</i></dt> +<dd> +dictionary with all filenames to be checked as keys +</dd> +<dt><i>dname</i></dt> +<dd> +directory to check in (string) +</dd> +<dt><i>shortcut</i></dt> +<dd> +flag indicating a shortcut should be taken (boolean) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +the received dictionary completed with a combination of + canBeCommited and canBeAdded or None in order to signal an error +</dd> +</dl> <a NAME="Hg.vcsCheckout" ID="Hg.vcsCheckout"></a> <h4>Hg.vcsCheckout</h4> <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) @@ -2128,6 +2177,31 @@ <h4>Hg.vcsInit</h4> <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>) +<p> + Public method used to initialize the mercurial repository. +</p> +<p> + The initialization is done, when a project is converted into a + Mercurial controlled project. Therefore we always return TRUE without + doing anything. +</p> +<dl> + +<dt><i>vcsDir</i></dt> +<dd> +name of the VCS directory (string) +</dd> +<dt><i>noDialog</i></dt> +<dd> +flag indicating quiet operations (boolean) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +always TRUE +</dd> +</dl> <a NAME="Hg.vcsInitConfig" ID="Hg.vcsInitConfig"></a> <h4>Hg.vcsInitConfig</h4> <b>vcsInitConfig</b>(<i>project</i>) @@ -2169,6 +2243,20 @@ <h4>Hg.vcsMerge</h4> <b>vcsMerge</b>(<i>name, rev=""</i>) +<p> + Public method used to merge a URL/revision into the local project. +</p> +<dl> + +<dt><i>name</i> (str)</dt> +<dd> +file/directory name to be merged +</dd> +<dt><i>rev</i> (str)</dt> +<dd> +revision to merge with +</dd> +</dl> <a NAME="Hg.vcsMove" ID="Hg.vcsMove"></a> <h4>Hg.vcsMove</h4> <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>) @@ -2299,10 +2387,56 @@ <h4>Hg.vcsRemove</h4> <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>) +<p> + Public method used to remove a file/directory from the Mercurial + repository. +</p> +<p> + The default operation is to remove the local copy as well. +</p> +<dl> + +<dt><i>name</i></dt> +<dd> +file/directory name to be removed (string or list of + strings)) +</dd> +<dt><i>project</i></dt> +<dd> +flag indicating deletion of a project tree (boolean) + (not needed) +</dd> +<dt><i>noDialog</i></dt> +<dd> +flag indicating quiet operations +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating successfull operation (boolean) +</dd> +</dl> <a NAME="Hg.vcsRepositoryInfos" ID="Hg.vcsRepositoryInfos"></a> <h4>Hg.vcsRepositoryInfos</h4> <b>vcsRepositoryInfos</b>(<i>ppath</i>) +<p> + Public method to retrieve information about the repository. +</p> +<dl> + +<dt><i>ppath</i></dt> +<dd> +local path to get the repository infos (string) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +string with ready formated info for display (string) +</dd> +</dl> <a NAME="Hg.vcsResolved" ID="Hg.vcsResolved"></a> <h4>Hg.vcsResolved</h4> <b>vcsResolved</b>(<i>name, unresolve=False</i>) @@ -2442,10 +2576,61 @@ <h4>Hg.vcsTag</h4> <b>vcsTag</b>(<i>name=None, revision=None, tagName=None</i>) +<p> + Public method used to set/remove a tag in the Mercurial repository. +</p> +<dl> + +<dt><i>name</i></dt> +<dd> +file/directory name to determine the repo root from + (string) +</dd> +<dt><i>revision</i></dt> +<dd> +revision to set tag for (string) +</dd> +<dt><i>tagName</i></dt> +<dd> +name of the tag (string) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a performed tag action (boolean) +</dd> +</dl> <a NAME="Hg.vcsUpdate" ID="Hg.vcsUpdate"></a> <h4>Hg.vcsUpdate</h4> <b>vcsUpdate</b>(<i>name=None, noDialog=False, revision=None</i>) +<p> + Public method used to update a file/directory with the Mercurial + repository. +</p> +<dl> + +<dt><i>name</i></dt> +<dd> +file/directory name to be updated (not used) +</dd> +<dt><i>noDialog</i></dt> +<dd> +flag indicating quiet operations (boolean) +</dd> +<dt><i>revision</i></dt> +<dd> +revision to update to (string) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating, that the update contained an add + or delete (boolean) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.ProjectBrowserHelper.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.ProjectBrowserHelper.html Fri Oct 27 14:09:40 2023 +0200 @@ -160,19 +160,19 @@ </tr> <tr> <td><a href="#SvnProjectBrowserHelper.showContextMenu">showContextMenu</a></td> -<td></td> +<td>Public slot called before the context menu is shown.</td> </tr> <tr> <td><a href="#SvnProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td> -<td></td> +<td>Public slot called before the context menu is shown.</td> </tr> <tr> <td><a href="#SvnProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td> -<td></td> +<td>Public slot called before the context menu is shown.</td> </tr> <tr> <td><a href="#SvnProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td> -<td></td> +<td>Public slot called before the context menu (multiple selections) is shown.</td> </tr> </table> <h3>Static Methods</h3> @@ -466,18 +466,95 @@ <h4>SvnProjectBrowserHelper.showContextMenu</h4> <b>showContextMenu</b>(<i>menu, standardItems</i>) +<p> + Public slot called before the context menu is shown. +</p> +<p> + It enables/disables the VCS menu entries depending on the overall + VCS status and the file status. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown +</dd> +<dt><i>standardItems</i></dt> +<dd> +array of standard items that need + activation/deactivation depending on the overall VCS status +</dd> +</dl> <a NAME="SvnProjectBrowserHelper.showContextMenuDir" ID="SvnProjectBrowserHelper.showContextMenuDir"></a> <h4>SvnProjectBrowserHelper.showContextMenuDir</h4> <b>showContextMenuDir</b>(<i>menu, standardItems</i>) +<p> + Public slot called before the context menu is shown. +</p> +<p> + It enables/disables the VCS menu entries depending on the overall + VCS status and the directory status. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown +</dd> +<dt><i>standardItems</i></dt> +<dd> +array of standard items that need + activation/deactivation depending on the overall VCS status +</dd> +</dl> <a NAME="SvnProjectBrowserHelper.showContextMenuDirMulti" ID="SvnProjectBrowserHelper.showContextMenuDirMulti"></a> <h4>SvnProjectBrowserHelper.showContextMenuDirMulti</h4> <b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>) +<p> + Public slot called before the context menu is shown. +</p> +<p> + It enables/disables the VCS menu entries depending on the overall + VCS status and the directory status. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown +</dd> +<dt><i>standardItems</i></dt> +<dd> +array of standard items that need + activation/deactivation depending on the overall VCS status +</dd> +</dl> <a NAME="SvnProjectBrowserHelper.showContextMenuMulti" ID="SvnProjectBrowserHelper.showContextMenuMulti"></a> <h4>SvnProjectBrowserHelper.showContextMenuMulti</h4> <b>showContextMenuMulti</b>(<i>menu, standardItems</i>) +<p> + Public slot called before the context menu (multiple selections) is + shown. +</p> +<p> + It enables/disables the VCS menu entries depending on the overall + VCS status and the files status. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown +</dd> +<dt><i>standardItems</i></dt> +<dd> +array of standard items that need + activation/deactivation depending on the overall VCS status +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.subversion.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.subversion.html Fri Oct 27 14:09:40 2023 +0200 @@ -84,7 +84,7 @@ </tr> <tr> <td><a href="#Subversion.__vcsAllRegisteredStates_wcng">__vcsAllRegisteredStates_wcng</a></td> -<td></td> +<td>Private method used to get the registered states of a number of files in the vcs.</td> </tr> <tr> <td><a href="#Subversion.__vcsCommit_Step2">__vcsCommit_Step2</a></td> @@ -272,11 +272,11 @@ </tr> <tr> <td><a href="#Subversion.vcsInit">vcsInit</a></td> -<td></td> +<td>Public method used to initialize the subversion repository.</td> </tr> <tr> <td><a href="#Subversion.vcsInitConfig">vcsInitConfig</a></td> -<td></td> +<td>Public method to initialize the VCS configuration.</td> </tr> <tr> <td><a href="#Subversion.vcsLogBrowser">vcsLogBrowser</a></td> @@ -308,7 +308,7 @@ </tr> <tr> <td><a href="#Subversion.vcsRemove">vcsRemove</a></td> -<td></td> +<td>Public method used to remove a file/directory from the Subversion repository.</td> </tr> <tr> <td><a href="#Subversion.vcsRepositoryInfos">vcsRepositoryInfos</a></td> @@ -484,6 +484,41 @@ <h4>Subversion.__vcsAllRegisteredStates_wcng</h4> <b>__vcsAllRegisteredStates_wcng</b>(<i>names, dname, shortcut=True</i>) +<p> + Private method used to get the registered states of a number of files + in the vcs. +</p> +<p> + This is the variant for subversion installations using the new working + copy meta-data format. +</p> +<p> + <b>Note:</b> If a shortcut is to be taken, the code will only check, + if the named directory has been scanned already. If so, it is assumed, + that the states for all files has been populated by the previous run. +</p> +<dl> + +<dt><i>names</i></dt> +<dd> +dictionary with all filenames to be checked as keys +</dd> +<dt><i>dname</i></dt> +<dd> +directory to check in (string) +</dd> +<dt><i>shortcut</i></dt> +<dd> +flag indicating a shortcut should be taken (boolean) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +the received dictionary completed with a combination of + canBeCommited and canBeAdded or None in order to signal an error +</dd> +</dl> <a NAME="Subversion.__vcsCommit_Step2" ID="Subversion.__vcsCommit_Step2"></a> <h4>Subversion.__vcsCommit_Step2</h4> <b>__vcsCommit_Step2</b>(<i></i>) @@ -1378,10 +1413,49 @@ <h4>Subversion.vcsInit</h4> <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>) +<p> + Public method used to initialize the subversion repository. +</p> +<p> + The subversion repository has to be initialized from outside eric + because the respective command always works locally. Therefore we + always return TRUE without doing anything. +</p> +<dl> + +<dt><i>vcsDir</i></dt> +<dd> +name of the VCS directory (string) +</dd> +<dt><i>noDialog</i></dt> +<dd> +flag indicating quiet operations (boolean) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +always TRUE +</dd> +</dl> <a NAME="Subversion.vcsInitConfig" ID="Subversion.vcsInitConfig"></a> <h4>Subversion.vcsInitConfig</h4> <b>vcsInitConfig</b>(<i>project</i>) +<p> + Public method to initialize the VCS configuration. +</p> +<p> + This method ensures, that eric specific files and directories are + ignored. +</p> +<dl> + +<dt><i>project</i></dt> +<dd> +reference to the project (Project) +</dd> +</dl> <a NAME="Subversion.vcsLogBrowser" ID="Subversion.vcsLogBrowser"></a> <h4>Subversion.vcsLogBrowser</h4> <b>vcsLogBrowser</b>(<i>name, isFile=False</i>) @@ -1539,6 +1613,36 @@ <h4>Subversion.vcsRemove</h4> <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>) +<p> + Public method used to remove a file/directory from the Subversion + repository. +</p> +<p> + The default operation is to remove the local copy as well. +</p> +<dl> + +<dt><i>name</i></dt> +<dd> +file/directory name to be removed (string or list of + strings)) +</dd> +<dt><i>project</i></dt> +<dd> +flag indicating deletion of a project tree (boolean) + (not needed) +</dd> +<dt><i>noDialog</i></dt> +<dd> +flag indicating quiet operations +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating successfull operation (boolean) +</dd> +</dl> <a NAME="Subversion.vcsRepositoryInfos" ID="Subversion.vcsRepositoryInfos"></a> <h4>Subversion.vcsRepositoryInfos</h4> <b>vcsRepositoryInfos</b>(<i>ppath</i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.ProjectBrowserHelper.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.ProjectBrowserHelper.html Fri Oct 27 14:09:40 2023 +0200 @@ -156,19 +156,19 @@ </tr> <tr> <td><a href="#SvnProjectBrowserHelper.showContextMenu">showContextMenu</a></td> -<td></td> +<td>Public slot called before the context menu is shown.</td> </tr> <tr> <td><a href="#SvnProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td> -<td></td> +<td>Public slot called before the context menu is shown.</td> </tr> <tr> <td><a href="#SvnProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td> -<td></td> +<td>Public slot called before the context menu is shown.</td> </tr> <tr> <td><a href="#SvnProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td> -<td></td> +<td>Public slot called before the context menu (multiple selections) is shown.</td> </tr> </table> <h3>Static Methods</h3> @@ -454,18 +454,95 @@ <h4>SvnProjectBrowserHelper.showContextMenu</h4> <b>showContextMenu</b>(<i>menu, standardItems</i>) +<p> + Public slot called before the context menu is shown. +</p> +<p> + It enables/disables the VCS menu entries depending on the overall + VCS status and the file status. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown +</dd> +<dt><i>standardItems</i></dt> +<dd> +array of standard items that need + activation/deactivation depending on the overall VCS status +</dd> +</dl> <a NAME="SvnProjectBrowserHelper.showContextMenuDir" ID="SvnProjectBrowserHelper.showContextMenuDir"></a> <h4>SvnProjectBrowserHelper.showContextMenuDir</h4> <b>showContextMenuDir</b>(<i>menu, standardItems</i>) +<p> + Public slot called before the context menu is shown. +</p> +<p> + It enables/disables the VCS menu entries depending on the overall + VCS status and the directory status. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown +</dd> +<dt><i>standardItems</i></dt> +<dd> +array of standard items that need + activation/deactivation depending on the overall VCS status +</dd> +</dl> <a NAME="SvnProjectBrowserHelper.showContextMenuDirMulti" ID="SvnProjectBrowserHelper.showContextMenuDirMulti"></a> <h4>SvnProjectBrowserHelper.showContextMenuDirMulti</h4> <b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>) +<p> + Public slot called before the context menu is shown. +</p> +<p> + It enables/disables the VCS menu entries depending on the overall + VCS status and the directory status. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown +</dd> +<dt><i>standardItems</i></dt> +<dd> +array of standard items that need + activation/deactivation depending on the overall VCS status +</dd> +</dl> <a NAME="SvnProjectBrowserHelper.showContextMenuMulti" ID="SvnProjectBrowserHelper.showContextMenuMulti"></a> <h4>SvnProjectBrowserHelper.showContextMenuMulti</h4> <b>showContextMenuMulti</b>(<i>menu, standardItems</i>) +<p> + Public slot called before the context menu (multiple selections) is + shown. +</p> +<p> + It enables/disables the VCS menu entries depending on the overall + VCS status and the files status. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown +</dd> +<dt><i>standardItems</i></dt> +<dd> +array of standard items that need + activation/deactivation depending on the overall VCS status +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.subversion.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.subversion.html Fri Oct 27 14:09:40 2023 +0200 @@ -260,11 +260,11 @@ </tr> <tr> <td><a href="#Subversion.vcsInit">vcsInit</a></td> -<td></td> +<td>Public method used to initialize the subversion repository.</td> </tr> <tr> <td><a href="#Subversion.vcsInitConfig">vcsInitConfig</a></td> -<td></td> +<td>Public method to initialize the VCS configuration.</td> </tr> <tr> <td><a href="#Subversion.vcsLogBrowser">vcsLogBrowser</a></td> @@ -296,7 +296,7 @@ </tr> <tr> <td><a href="#Subversion.vcsRemove">vcsRemove</a></td> -<td></td> +<td>Public method used to remove a file/directory from the Subversion repository.</td> </tr> <tr> <td><a href="#Subversion.vcsRepositoryInfos">vcsRepositoryInfos</a></td> @@ -1345,10 +1345,48 @@ <h4>Subversion.vcsInit</h4> <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>) +<p> + Public method used to initialize the subversion repository. +</p> +<p> + The subversion repository has to be initialized from outside eric + because the respective command always works locally. Therefore we + always return TRUE without doing anything. +</p> +<dl> + +<dt><i>vcsDir</i></dt> +<dd> +name of the VCS directory (string) +</dd> +<dt><i>noDialog</i></dt> +<dd> +flag indicating quiet operations (boolean) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +always TRUE +</dd> +</dl> <a NAME="Subversion.vcsInitConfig" ID="Subversion.vcsInitConfig"></a> <h4>Subversion.vcsInitConfig</h4> <b>vcsInitConfig</b>(<i>project</i>) +<p> + Public method to initialize the VCS configuration. +</p> +<p> + This method ensures, that an ignore file exists. +</p> +<dl> + +<dt><i>project</i></dt> +<dd> +reference to the project (Project) +</dd> +</dl> <a NAME="Subversion.vcsLogBrowser" ID="Subversion.vcsLogBrowser"></a> <h4>Subversion.vcsLogBrowser</h4> <b>vcsLogBrowser</b>(<i>name, isFile=False</i>) @@ -1506,6 +1544,36 @@ <h4>Subversion.vcsRemove</h4> <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>) +<p> + Public method used to remove a file/directory from the Subversion + repository. +</p> +<p> + The default operation is to remove the local copy as well. +</p> +<dl> + +<dt><i>name</i></dt> +<dd> +file/directory name to be removed (string or list of + strings)) +</dd> +<dt><i>project</i></dt> +<dd> +flag indicating deletion of a project tree (boolean) + (not needed) +</dd> +<dt><i>noDialog</i></dt> +<dd> +flag indicating quiet operations +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating successfull operation (boolean) +</dd> +</dl> <a NAME="Subversion.vcsRepositoryInfos" ID="Subversion.vcsRepositoryInfos"></a> <h4>Subversion.vcsRepositoryInfos</h4> <b>vcsRepositoryInfos</b>(<i>ppath</i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.ViewManagerPlugins.Listspace.Listspace.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.ViewManagerPlugins.Listspace.Listspace.html Fri Oct 27 14:09:40 2023 +0200 @@ -169,7 +169,7 @@ </tr> <tr> <td><a href="#Listspace.__captionChange">__captionChange</a></td> -<td></td> +<td>Private method to handle caption change signals from the editor.</td> </tr> <tr> <td><a href="#Listspace.__contextMenuClose">__contextMenuClose</a></td> @@ -380,6 +380,23 @@ <h4>Listspace.__captionChange</h4> <b>__captionChange</b>(<i>cap, editor</i>) +<p> + Private method to handle caption change signals from the editor. +</p> +<p> + Updates the listwidget text to reflect the new caption information. +</p> +<dl> + +<dt><i>cap</i> (str)</dt> +<dd> +Caption for the editor +</dd> +<dt><i>editor</i> (Editor)</dt> +<dd> +Editor to update the caption for +</dd> +</dl> <a NAME="Listspace.__contextMenuClose" ID="Listspace.__contextMenuClose"></a> <h4>Listspace.__contextMenuClose</h4> <b>__contextMenuClose</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.ViewManagerPlugins.Tabview.Tabview.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.ViewManagerPlugins.Tabview.Tabview.html Fri Oct 27 14:09:40 2023 +0200 @@ -216,7 +216,7 @@ </tr> <tr> <td><a href="#TabWidget.__captionChange">__captionChange</a></td> -<td></td> +<td>Private slot to handle Caption change signals from the editor.</td> </tr> <tr> <td><a href="#TabWidget.__closeButtonClicked">__closeButtonClicked</a></td> @@ -395,6 +395,24 @@ <h4>TabWidget.__captionChange</h4> <b>__captionChange</b>(<i>cap, editor</i>) +<p> + Private slot to handle Caption change signals from the editor. +</p> +<p> + Updates the tab text and tooltip text to reflect the new caption + information. +</p> +<dl> + +<dt><i>cap</i> (str)</dt> +<dd> +Caption for the editor +</dd> +<dt><i>editor</i> (Editor)</dt> +<dd> +Editor to update the caption for +</dd> +</dl> <a NAME="TabWidget.__closeButtonClicked" ID="TabWidget.__closeButtonClicked"></a> <h4>TabWidget.__closeButtonClicked</h4> <b>__closeButtonClicked</b>(<i></i>) @@ -1033,7 +1051,7 @@ </tr> <tr> <td><a href="#Tabview._showView">_showView</a></td> -<td></td> +<td>Protected method to show a view (i.e.</td> </tr> <tr> <td><a href="#Tabview._syntaxErrorToggled">_syntaxErrorToggled</a></td> @@ -1263,6 +1281,20 @@ <h4>Tabview._showView</h4> <b>_showView</b>(<i>win, fn=None</i>) +<p> + Protected method to show a view (i.e. window). +</p> +<dl> + +<dt><i>win</i> (EditorAssembly)</dt> +<dd> +editor assembly to be shown +</dd> +<dt><i>fn</i> (str)</dt> +<dd> +filename of this editor +</dd> +</dl> <a NAME="Tabview._syntaxErrorToggled" ID="Tabview._syntaxErrorToggled"></a> <h4>Tabview._syntaxErrorToggled</h4> <b>_syntaxErrorToggled</b>(<i>editor</i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html Fri Oct 27 14:09:40 2023 +0200 @@ -9,12 +9,12 @@ <h1>eric7.Plugins.WizardPlugins.EricPluginWizard.Templates</h1> <p> -Module implementing the various plug-in templates. + Class documentation goes here. </p> <h3>Global Attributes</h3> <table> -<tr><td>apiFilesTemplate</td></tr><tr><td>configTemplate0</td></tr><tr><td>configTemplate1</td></tr><tr><td>configTemplate2</td></tr><tr><td>configTemplate3</td></tr><tr><td>exeDisplayDataInfoTemplate</td></tr><tr><td>exeDisplayDataListTemplate</td></tr><tr><td>exeDisplayDataTemplate</td></tr><tr><td>mainTemplate</td></tr><tr><td>moduleSetupTemplate</td></tr><tr><td>onDemandTemplate</td></tr><tr><td>previewPixmapTemplate</td></tr> +<tr><td>__header__</td></tr><tr><td>error</td></tr><tr><td>mainTemplate</td></tr> </table> <h3>Classes</h3> @@ -24,7 +24,160 @@ <h3>Functions</h3> <table> -<tr><td>None</td></tr> + +<tr> +<td><a href="#__init__">__init__</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#activate">activate</a></td> +<td>Public method to activate this plug-in.</td> +</tr> +<tr> +<td><a href="#deactivate">deactivate</a></td> +<td>Module function returning data as required by the configuration dialog.</td> +</tr> +<tr> +<td><a href="#getPreferences">getPreferences</a></td> +<td>Public method to retrieve the various settings values.</td> +</tr> +<tr> +<td><a href="#prepareUninstall">prepareUninstall</a></td> +<td>Module function to prepare for an un-installation.</td> +</tr> +<tr> +<td><a href="#setPreferences">setPreferences</a></td> +<td>Module function to return the API files made available by this plug-in.</td> +</tr> </table> <hr /> +<hr /> +<a NAME="__init__" ID="__init__"></a> +<h2>__init__</h2> +<b>__init__</b>(<i>self, ui</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>ui</i> (UI.UserInterface)</dt> +<dd> +reference to the user interface object +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="activate" ID="activate"></a> +<h2>activate</h2> +<b>activate</b>(<i>self</i>) + +<p> + Public method to activate this plug-in. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="deactivate" ID="deactivate"></a> +<h2>deactivate</h2> +<b>deactivate</b>(<i>self</i>) + +<p> + Module function returning data as required by the configuration dialog. +</p> +<dl> +<dt>Return:</dt> +<dd> +dictionary containing the relevant data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getPreferences" ID="getPreferences"></a> +<h2>getPreferences</h2> +<b>getPreferences</b>(<i>self, key</i>) + +<p> + Public method to retrieve the various settings values. +</p> +<dl> + +<dt><i>key</i> (str)</dt> +<dd> +the key of the value to get +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +the requested setting value +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +any +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="prepareUninstall" ID="prepareUninstall"></a> +<h2>prepareUninstall</h2> +<b>prepareUninstall</b>(<i></i>) + +<p> + Module function to prepare for an un-installation. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="setPreferences" ID="setPreferences"></a> +<h2>setPreferences</h2> +<b>setPreferences</b>(<i>self, key, value</i>) + +<p> + Module function to return the API files made available by this plug-in. +</p> +<dl> + +<dt><i>language</i> (str)</dt> +<dd> +language to get APIs for +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list of API filenames +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.ApplicationPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.ApplicationPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.CondaPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.CondaPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.CooperationPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.CooperationPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -146,6 +146,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.DebuggerGeneralPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.DebuggerGeneralPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -35,7 +35,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -196,7 +196,7 @@ </tr> <tr> <td><a href="#PreviewModel.columnCount">columnCount</a></td> -<td></td> +<td>Public Qt slot to get the column count.</td> </tr> <tr> <td><a href="#PreviewModel.data">data</a></td> @@ -204,7 +204,7 @@ </tr> <tr> <td><a href="#PreviewModel.flags">flags</a></td> -<td></td> +<td>Public Qt slot to get the item flags.</td> </tr> <tr> <td><a href="#PreviewModel.index">index</a></td> @@ -212,11 +212,11 @@ </tr> <tr> <td><a href="#PreviewModel.parent">parent</a></td> -<td></td> +<td>Public Qt slot to get the parent of the given child.</td> </tr> <tr> <td><a href="#PreviewModel.rowCount">rowCount</a></td> -<td></td> +<td>Public Qt slot to get the row count.</td> </tr> <tr> <td><a href="#PreviewModel.setColor">setColor</a></td> @@ -240,6 +240,28 @@ <h4>PreviewModel.columnCount</h4> <b>columnCount</b>(<i>parent=QModelIndex()</i>) +<p> + Public Qt slot to get the column count. +</p> +<dl> + +<dt><i>parent</i> (QModelIndex)</dt> +<dd> +the model parent +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +number of columns +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int +</dd> +</dl> <a NAME="PreviewModel.data" ID="PreviewModel.data"></a> <h4>PreviewModel.data</h4> <b>data</b>(<i>index, role=Qt.ItemDataRole.DisplayRole</i>) @@ -274,6 +296,28 @@ <h4>PreviewModel.flags</h4> <b>flags</b>(<i>index</i>) +<p> + Public Qt slot to get the item flags. +</p> +<dl> + +<dt><i>index</i> (QModelIndex)</dt> +<dd> +of item +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +item flags +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QtCore.Qt.ItemFlag +</dd> +</dl> <a NAME="PreviewModel.index" ID="PreviewModel.index"></a> <h4>PreviewModel.index</h4> <b>index</b>(<i>row, column, parent=QModelIndex()</i>) @@ -312,10 +356,54 @@ <h4>PreviewModel.parent</h4> <b>parent</b>(<i>child</i>) +<p> + Public Qt slot to get the parent of the given child. +</p> +<dl> + +<dt><i>child</i> (QModelIndex)</dt> +<dd> +the model child node +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +new model index for parent +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QModelIndex +</dd> +</dl> <a NAME="PreviewModel.rowCount" ID="PreviewModel.rowCount"></a> <h4>PreviewModel.rowCount</h4> <b>rowCount</b>(<i>parent=QModelIndex()</i>) +<p> + Public Qt slot to get the row count. +</p> +<dl> + +<dt><i>parent</i> (QModelIndex)</dt> +<dd> +the model parent +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +number of rows +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int +</dd> +</dl> <a NAME="PreviewModel.setColor" ID="PreviewModel.setColor"></a> <h4>PreviewModel.setColor</h4> <b>setColor</b>(<i>key, bgcolour</i>) @@ -341,6 +429,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.DebuggerPython3Page.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.DebuggerPython3Page.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -138,6 +138,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.DiffColoursPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.DiffColoursPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -200,6 +200,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorAPIsPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorAPIsPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -373,6 +373,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorAutoCompletionJediPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorAutoCompletionJediPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorAutocompletionPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorAutocompletionPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -112,6 +112,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorAutocompletionQScintillaPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorAutocompletionQScintillaPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorCallTipsJediPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorCallTipsJediPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorCalltipsPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorCalltipsPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -112,6 +112,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorCalltipsQScintillaPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorCalltipsQScintillaPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorDocViewerPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorDocViewerPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorExportersPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorExportersPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -123,6 +123,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorFilePage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorFilePage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -243,6 +243,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorGeneralPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorGeneralPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -235,6 +235,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorKeywordsPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorKeywordsPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -189,6 +189,28 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i> (ConfigurationWidget)</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
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorMouseClickHandlerJediPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorMouseClickHandlerJediPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -105,6 +105,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorMouseClickHandlerPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorMouseClickHandlerPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorSearchPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorSearchPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -112,6 +112,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorSpellCheckingPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorSpellCheckingPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorStylesPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorStylesPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -250,6 +250,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorSyntaxPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorSyntaxPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorTypingPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorTypingPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -112,6 +112,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EmailPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EmailPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -300,6 +300,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.GraphicsPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.GraphicsPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -116,6 +116,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.HelpDocumentationPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.HelpDocumentationPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.HelpViewersPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.HelpViewersPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.HexEditorPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.HexEditorPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -116,6 +116,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.IconsPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.IconsPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -220,6 +220,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.InterfaceLightPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.InterfaceLightPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -117,6 +117,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.InterfacePage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.InterfacePage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -167,6 +167,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.IrcPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.IrcPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.LogViewerPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.LogViewerPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -123,6 +123,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.MicroPythonPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.MicroPythonPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -166,6 +166,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.MimeTypesPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.MimeTypesPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -116,6 +116,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.MultiProjectPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.MultiProjectPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.NotificationsPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.NotificationsPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -215,6 +215,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.PdfViewerPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.PdfViewerPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,28 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></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
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.PipPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.PipPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.PluginManagerPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.PluginManagerPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -113,6 +113,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.PrinterPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.PrinterPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -134,6 +134,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.ProjectBrowserPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.ProjectBrowserPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -198,6 +198,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.ProjectPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.ProjectPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.PythonPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.PythonPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -105,6 +105,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.QtPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.QtPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -214,6 +214,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.ShellPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.ShellPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -128,6 +128,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.TasksPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.TasksPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -116,6 +116,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.TemplatesPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.TemplatesPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -105,6 +105,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.TrayStarterPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.TrayStarterPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.VcsPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.VcsPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -94,6 +94,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.ViewmanagerPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.ViewmanagerPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -112,6 +112,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.WebBrowserAppearancePage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.WebBrowserAppearancePage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -112,6 +112,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.WebBrowserSpellCheckingPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.WebBrowserSpellCheckingPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -157,6 +157,28 @@ <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
--- a/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.WebBrowserVirusTotalPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.WebBrowserVirusTotalPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#create">create</a></td> -<td></td> +<td>Module function to create the configuration page.</td> </tr> </table> <hr /> @@ -145,6 +145,22 @@ <h2>create</h2> <b>create</b>(<i>dlg</i>) +<p> + Module function to create the configuration page. +</p> +<dl> + +<dt><i>dlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the instantiated page (ConfigurationPageBase) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Project.ProjectBaseBrowser.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Project.ProjectBaseBrowser.html Fri Oct 27 14:09:40 2023 +0200 @@ -73,7 +73,7 @@ </tr> <tr> <td><a href="#ProjectBaseBrowser.__modelRowsInserted">__modelRowsInserted</a></td> -<td></td> +<td>Private slot called after rows have been inserted into the model.</td> </tr> <tr> <td><a href="#ProjectBaseBrowser._collapseAllDirs">_collapseAllDirs</a></td> @@ -181,7 +181,7 @@ </tr> <tr> <td><a href="#ProjectBaseBrowser._showContextMenuBack">_showContextMenuBack</a></td> -<td></td> +<td>Protected slot called before the context menu is shown.</td> </tr> <tr> <td><a href="#ProjectBaseBrowser._showContextMenuDir">_showContextMenuDir</a></td> @@ -301,6 +301,24 @@ <h4>ProjectBaseBrowser.__modelRowsInserted</h4> <b>__modelRowsInserted</b>(<i>parent, start, end</i>) +<p> + Private slot called after rows have been inserted into the model. +</p> +<dl> + +<dt><i>parent</i></dt> +<dd> +parent index of inserted rows (QModelIndex) +</dd> +<dt><i>start</i></dt> +<dd> +start row number (integer) +</dd> +<dt><i>end</i></dt> +<dd> +end row number (integer) +</dd> +</dl> <a NAME="ProjectBaseBrowser._collapseAllDirs" ID="ProjectBaseBrowser._collapseAllDirs"></a> <h4>ProjectBaseBrowser._collapseAllDirs</h4> <b>_collapseAllDirs</b>(<i></i>) @@ -589,6 +607,16 @@ <h4>ProjectBaseBrowser._showContextMenuBack</h4> <b>_showContextMenuBack</b>(<i>menu</i>) +<p> + Protected slot called before the context menu is shown. +</p> +<dl> + +<dt><i>menu</i></dt> +<dd> +reference to the menu to be shown (QMenu) +</dd> +</dl> <a NAME="ProjectBaseBrowser._showContextMenuDir" ID="ProjectBaseBrowser._showContextMenuDir"></a> <h4>ProjectBaseBrowser._showContextMenuDir</h4> <b>_showContextMenuDir</b>(<i>menu</i>)
--- a/src/eric7/Documentation/Source/eric7.Project.ProjectBrowser.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Project.ProjectBrowser.html Fri Oct 27 14:09:40 2023 +0200 @@ -203,7 +203,7 @@ </tr> <tr> <td><a href="#ProjectBrowser.__vcsStatusIndicatorClicked">__vcsStatusIndicatorClicked</a></td> -<td></td> +<td>Private slot to react upon clicks on the VCS indicator LED.</td> </tr> <tr> <td><a href="#ProjectBrowser.addTypedProjectBrowser">addTypedProjectBrowser</a></td> @@ -359,6 +359,16 @@ <h4>ProjectBrowser.__vcsStatusIndicatorClicked</h4> <b>__vcsStatusIndicatorClicked</b>(<i>pos</i>) +<p> + Private slot to react upon clicks on the VCS indicator LED. +</p> +<dl> + +<dt><i>pos</i></dt> +<dd> +position of the click (QPoint) +</dd> +</dl> <a NAME="ProjectBrowser.addTypedProjectBrowser" ID="ProjectBrowser.addTypedProjectBrowser"></a> <h4>ProjectBrowser.addTypedProjectBrowser</h4> <b>addTypedProjectBrowser</b>(<i>browserType, projectBrowserItem</i>)
--- a/src/eric7/Documentation/Source/eric7.Project.ProjectBrowserModel.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Project.ProjectBrowserModel.html Fri Oct 27 14:09:40 2023 +0200 @@ -972,7 +972,7 @@ </tr> <tr> <td><a href="#ProjectBrowserSimpleDirectoryItem.setName">setName</a></td> -<td></td> +<td>Public method to set the directory name.</td> </tr> </table> <h3>Static Methods</h3> @@ -1065,6 +1065,20 @@ <h4>ProjectBrowserSimpleDirectoryItem.setName</h4> <b>setName</b>(<i>dinfo, full=True</i>) +<p> + Public method to set the directory name. +</p> +<dl> + +<dt><i>dinfo</i></dt> +<dd> +dinfo is the string for the directory (string) +</dd> +<dt><i>full</i></dt> +<dd> +flag indicating full path name should be displayed (boolean) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.BaseDocstringGenerator.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.BaseDocstringGenerator.html Fri Oct 27 14:09:40 2023 +0200 @@ -80,23 +80,23 @@ </tr> <tr> <td><a href="#BaseDocstringGenerator.hasFunctionDefinition">hasFunctionDefinition</a></td> -<td></td> +<td>Public method to test, if the cursor is right below a function definition.</td> </tr> <tr> <td><a href="#BaseDocstringGenerator.insertDocstring">insertDocstring</a></td> -<td></td> +<td>Public method to insert a docstring for the function at the cursor position.</td> </tr> <tr> <td><a href="#BaseDocstringGenerator.insertDocstringFromShortcut">insertDocstringFromShortcut</a></td> -<td></td> +<td>Public method to insert a docstring for the function at the cursor position initiated via a keyboard shortcut.</td> </tr> <tr> <td><a href="#BaseDocstringGenerator.isDocstringIntro">isDocstringIntro</a></td> -<td></td> +<td>Public function to test, if the line up to the cursor position might be introducing a docstring.</td> </tr> <tr> <td><a href="#BaseDocstringGenerator.isFunctionStart">isFunctionStart</a></td> -<td></td> +<td>Public method to test, if a text is the start of a function or method definition.</td> </tr> </table> <h3>Static Methods</h3> @@ -174,22 +174,119 @@ <h4>BaseDocstringGenerator.hasFunctionDefinition</h4> <b>hasFunctionDefinition</b>(<i>cursorPosition</i>) +<p> + Public method to test, if the cursor is right below a function + definition. +</p> +<dl> + +<dt><i>cursorPosition</i> (tuple of (int, int))</dt> +<dd> +current cursor position (line and column) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating cursor is right below a function definition +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="BaseDocstringGenerator.insertDocstring" ID="BaseDocstringGenerator.insertDocstring"></a> <h4>BaseDocstringGenerator.insertDocstring</h4> <b>insertDocstring</b>(<i>cursorPosition, fromStart=True</i>) +<p> + Public method to insert a docstring for the function at the cursor + position. +</p> +<dl> + +<dt><i>cursorPosition</i> (tuple of (int, int))</dt> +<dd> +position of the cursor (line and index) +</dd> +<dt><i>fromStart</i> (bool)</dt> +<dd> +flag indicating that the editor text cursor is placed + on the line starting the function definition +</dd> +</dl> <a NAME="BaseDocstringGenerator.insertDocstringFromShortcut" ID="BaseDocstringGenerator.insertDocstringFromShortcut"></a> <h4>BaseDocstringGenerator.insertDocstringFromShortcut</h4> <b>insertDocstringFromShortcut</b>(<i>cursorPosition</i>) +<p> + Public method to insert a docstring for the function at the cursor + position initiated via a keyboard shortcut. +</p> +<dl> + +<dt><i>cursorPosition</i> (tuple of (int, int))</dt> +<dd> +position of the cursor (line and index) +</dd> +</dl> <a NAME="BaseDocstringGenerator.isDocstringIntro" ID="BaseDocstringGenerator.isDocstringIntro"></a> <h4>BaseDocstringGenerator.isDocstringIntro</h4> <b>isDocstringIntro</b>(<i>cursorPosition</i>) +<p> + Public function to test, if the line up to the cursor position might be + introducing a docstring. +</p> +<dl> + +<dt><i>cursorPosition</i> (tuple of (int, int))</dt> +<dd> +current cursor position (line and column) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a potential start of a docstring +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="BaseDocstringGenerator.isFunctionStart" ID="BaseDocstringGenerator.isFunctionStart"></a> <h4>BaseDocstringGenerator.isFunctionStart</h4> <b>isFunctionStart</b>(<i>text</i>) +<p> + Public method to test, if a text is the start of a function or method + definition. +</p> +<dl> + +<dt><i>text</i> (str)</dt> +<dd> +line of text to be tested +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating that the given text starts a function or + method definition (always False) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.EricdocGenerator.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.EricdocGenerator.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,7 +27,7 @@ <tr> <td><a href="#generateDoc">generateDoc</a></td> -<td></td> +<td>Function to generate the docstring line list iaw.</td> </tr> </table> <hr /> @@ -36,6 +36,38 @@ <h2>generateDoc</h2> <b>generateDoc</b>(<i>functionInfo, editor</i>) +<p> + Function to generate the docstring line list iaw. eric documentation + style. +</p> +<p> + Note: Text is created with DESCRIPTION placeholders for descriptions and + TYPE placeholders for type information +</p> +<dl> + +<dt><i>functionInfo</i> (FunctionInfo)</dt> +<dd> +object containing the function information to base + the docstring on +</dd> +<dt><i>editor</i> (Editor)</dt> +<dd> +reference to the editor +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list of docstring lines +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.SphinxdocGenerator.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.SphinxdocGenerator.html Fri Oct 27 14:09:40 2023 +0200 @@ -27,7 +27,7 @@ <tr> <td><a href="#generateDoc">generateDoc</a></td> -<td></td> +<td>Function to generate the docstring line list iaw.</td> </tr> </table> <hr /> @@ -36,6 +36,38 @@ <h2>generateDoc</h2> <b>generateDoc</b>(<i>functionInfo, editor</i>) +<p> + Function to generate the docstring line list iaw. Sphinx documentation + style. +</p> +<p> + Note: Text is created with DESCRIPTION placeholders for descriptions and + TYPE placeholders for type information +</p> +<dl> + +<dt><i>functionInfo</i> (FunctionInfo)</dt> +<dd> +object containing the function information to base + the docstring on +</dd> +<dt><i>editor</i> (Editor)</dt> +<dd> +reference to the editor +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list of docstring lines +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Editor.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Editor.html Fri Oct 27 14:09:40 2023 +0200 @@ -552,7 +552,7 @@ </tr> <tr> <td><a href="#Editor.__marginClicked">__marginClicked</a></td> -<td></td> +<td>Private slot to handle the marginClicked signal.</td> </tr> <tr> <td><a href="#Editor.__marginNumber">__marginNumber</a></td> @@ -1360,7 +1360,7 @@ </tr> <tr> <td><a href="#Editor.highlight">highlight</a></td> -<td></td> +<td>Public method to highlight [or de-highlight] a particular line.</td> </tr> <tr> <td><a href="#Editor.highlightSearchSelection">highlightSearchSelection</a></td> @@ -3138,6 +3138,24 @@ <h4>Editor.__marginClicked</h4> <b>__marginClicked</b>(<i>margin, line, modifiers</i>) +<p> + Private slot to handle the marginClicked signal. +</p> +<dl> + +<dt><i>margin</i></dt> +<dd> +id of the clicked margin (integer) +</dd> +<dt><i>line</i></dt> +<dd> +line number of the click (integer) +</dd> +<dt><i>modifiers</i></dt> +<dd> +keyboard modifiers (Qt.KeyboardModifiers) +</dd> +</dl> <a NAME="Editor.__marginNumber" ID="Editor.__marginNumber"></a> <h4>Editor.__marginNumber</h4> <b>__marginNumber</b>(<i>xPos</i>) @@ -5833,6 +5851,25 @@ <h4>Editor.highlight</h4> <b>highlight</b>(<i>line=None, error=False, syntaxError=False</i>) +<p> + Public method to highlight [or de-highlight] a particular line. +</p> +<dl> + +<dt><i>line</i></dt> +<dd> +line number to highlight (integer) +</dd> +<dt><i>error</i></dt> +<dd> +flag indicating whether the error highlight should be + used (boolean) +</dd> +<dt><i>syntaxError</i></dt> +<dd> +flag indicating a syntax error (boolean) +</dd> +</dl> <a NAME="Editor.highlightSearchSelection" ID="Editor.highlightSearchSelection"></a> <h4>Editor.highlightSearchSelection</h4> <b>highlightSearchSelection</b>(<i>startLine, startIndex, endLine, endIndex</i>)
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.Lexer.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.Lexer.html Fri Oct 27 14:09:40 2023 +0200 @@ -88,7 +88,7 @@ </tr> <tr> <td><a href="#Lexer.defaultKeywords">defaultKeywords</a></td> -<td></td> +<td>Public method to get the default keywords.</td> </tr> <tr> <td><a href="#Lexer.hasSmartIndent">hasSmartIndent</a></td> @@ -104,11 +104,11 @@ </tr> <tr> <td><a href="#Lexer.isCommentStyle">isCommentStyle</a></td> -<td></td> +<td>Public method to check, if a style is a comment style.</td> </tr> <tr> <td><a href="#Lexer.isStringStyle">isStringStyle</a></td> -<td></td> +<td>Public method to check, if a style is a string style.</td> </tr> <tr> <td><a href="#Lexer.keywords">keywords</a></td> @@ -280,6 +280,28 @@ <h4>Lexer.defaultKeywords</h4> <b>defaultKeywords</b>(<i>kwSet</i>) +<p> + Public method to get the default keywords. +</p> +<dl> + +<dt><i>kwSet</i> (int)</dt> +<dd> +number of the keyword set +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +space separated list of keywords +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str or None +</dd> +</dl> <a NAME="Lexer.hasSmartIndent" ID="Lexer.hasSmartIndent"></a> <h4>Lexer.hasSmartIndent</h4> <b>hasSmartIndent</b>(<i></i>) @@ -324,10 +346,42 @@ <h4>Lexer.isCommentStyle</h4> <b>isCommentStyle</b>(<i>style</i>) +<p> + Public method to check, if a style is a comment style. +</p> +<dl> + +<dt><i>style</i></dt> +<dd> +style to check (integer) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a comment style (boolean) +</dd> +</dl> <a NAME="Lexer.isStringStyle" ID="Lexer.isStringStyle"></a> <h4>Lexer.isStringStyle</h4> <b>isStringStyle</b>(<i>style</i>) +<p> + Public method to check, if a style is a string style. +</p> +<dl> + +<dt><i>style</i></dt> +<dd> +style to check (integer) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a string style (boolean) +</dd> +</dl> <a NAME="Lexer.keywords" ID="Lexer.keywords"></a> <h4>Lexer.keywords</h4> <b>keywords</b>(<i>kwSet</i>)
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerBash.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerBash.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -173,6 +173,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerBash +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerBatch.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerBatch.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -72,7 +72,7 @@ </tr> <tr> <td><a href="#LexerBatch.isStringStyle">isStringStyle</a></td> -<td></td> +<td>Public method to check, if a style is a string style.</td> </tr> </table> <h3>Static Methods</h3> @@ -139,6 +139,22 @@ <h4>LexerBatch.isStringStyle</h4> <b>isStringStyle</b>(<i>style</i>) +<p> + Public method to check, if a style is a string style. +</p> +<dl> + +<dt><i>style</i></dt> +<dd> +style to check (integer) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a string style (boolean) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -146,6 +162,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerBatch +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerCMake.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerCMake.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -173,6 +173,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerCMake +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerCPP.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerCPP.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -207,6 +207,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerCPP +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerCSS.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerCSS.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -173,6 +173,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerCSS +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerCSharp.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerCSharp.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -190,6 +190,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerCSharp +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerCoffeeScript.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerCoffeeScript.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -190,6 +190,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerCoffeeScript +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerContainer.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerContainer.html Fri Oct 27 14:09:40 2023 +0200 @@ -60,7 +60,7 @@ </tr> <tr> <td><a href="#LexerContainer.description">description</a></td> -<td></td> +<td>Public method returning the descriptions of the styles supported by the lexer.</td> </tr> <tr> <td><a href="#LexerContainer.keywords">keywords</a></td> @@ -103,6 +103,26 @@ <h4>LexerContainer.description</h4> <b>description</b>(<i>style</i>) +<p> + Public method returning the descriptions of the styles supported + by the lexer. +</p> +<p> + <b>Note</b>: This methods needs to be overridden by the lexer class. +</p> +<dl> + +<dt><i>style</i></dt> +<dd> +style number (integer) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +description for the given style (string) +</dd> +</dl> <a NAME="LexerContainer.keywords" ID="LexerContainer.keywords"></a> <h4>LexerContainer.keywords</h4> <b>keywords</b>(<i>kwSet</i>)
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerD.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerD.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -207,6 +207,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerD +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerDiff.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerDiff.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -72,7 +72,7 @@ </tr> <tr> <td><a href="#LexerDiff.isStringStyle">isStringStyle</a></td> -<td></td> +<td>Public method to check, if a style is a string style.</td> </tr> </table> <h3>Static Methods</h3> @@ -139,6 +139,22 @@ <h4>LexerDiff.isStringStyle</h4> <b>isStringStyle</b>(<i>style</i>) +<p> + Public method to check, if a style is a string style. +</p> +<dl> + +<dt><i>style</i></dt> +<dd> +style to check (integer) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a string style (boolean) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -146,6 +162,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerDiff +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerFortran.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerFortran.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -190,6 +190,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerFortran +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerFortran77.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerFortran77.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -190,6 +190,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerFortran77 +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerHTML.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerHTML.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -173,6 +173,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerHTML +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerJSON.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerJSON.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -190,6 +190,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerJSON +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerJava.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerJava.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -190,6 +190,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerJava +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerJavaScript.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerJavaScript.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -190,6 +190,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerJavaScript +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerLua.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerLua.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -207,6 +207,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerLua +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerMakefile.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerMakefile.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -72,7 +72,7 @@ </tr> <tr> <td><a href="#LexerMakefile.isStringStyle">isStringStyle</a></td> -<td></td> +<td>Public method to check, if a style is a string style.</td> </tr> </table> <h3>Static Methods</h3> @@ -139,6 +139,22 @@ <h4>LexerMakefile.isStringStyle</h4> <b>isStringStyle</b>(<i>style</i>) +<p> + Public method to check, if a style is a string style. +</p> +<dl> + +<dt><i>style</i></dt> +<dd> +style to check (integer) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a string style (boolean) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -146,6 +162,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerMakefile +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerMarkdown.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerMarkdown.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -114,6 +114,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerMarkdown +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerMatlab.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerMatlab.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -162,6 +162,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerMatlab +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerOctave.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerOctave.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -162,6 +162,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerOctave +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPO.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPO.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -173,6 +173,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerPO +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPOV.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPOV.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -173,6 +173,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerPOV +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPascal.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPascal.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -190,6 +190,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerPascal +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPerl.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPerl.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -190,6 +190,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerPerl +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPostScript.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPostScript.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -76,7 +76,7 @@ </tr> <tr> <td><a href="#LexerPostScript.isStringStyle">isStringStyle</a></td> -<td></td> +<td>Public method to check, if a style is a string style.</td> </tr> <tr> <td><a href="#LexerPostScript.maximumKeywordSet">maximumKeywordSet</a></td> @@ -154,6 +154,22 @@ <h4>LexerPostScript.isStringStyle</h4> <b>isStringStyle</b>(<i>style</i>) +<p> + Public method to check, if a style is a string style. +</p> +<dl> + +<dt><i>style</i></dt> +<dd> +style to check (integer) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a string style (boolean) +</dd> +</dl> <a NAME="LexerPostScript.maximumKeywordSet" ID="LexerPostScript.maximumKeywordSet"></a> <h4>LexerPostScript.maximumKeywordSet</h4> <b>maximumKeywordSet</b>(<i></i>) @@ -174,6 +190,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerPostScript +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerProperties.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerProperties.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -76,7 +76,7 @@ </tr> <tr> <td><a href="#LexerProperties.isStringStyle">isStringStyle</a></td> -<td></td> +<td>Public method to check, if a style is a string style.</td> </tr> </table> <h3>Static Methods</h3> @@ -150,6 +150,22 @@ <h4>LexerProperties.isStringStyle</h4> <b>isStringStyle</b>(<i>style</i>) +<p> + Public method to check, if a style is a string style. +</p> +<dl> + +<dt><i>style</i></dt> +<dd> +style to check (integer) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a string style (boolean) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -157,6 +173,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerProperties +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPygments.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPygments.html Fri Oct 27 14:09:40 2023 +0200 @@ -100,7 +100,7 @@ </tr> <tr> <td><a href="#LexerPygments.defaultKeywords">defaultKeywords</a></td> -<td></td> +<td>Public method to get the default keywords.</td> </tr> <tr> <td><a href="#LexerPygments.defaultPaper">defaultPaper</a></td> @@ -136,7 +136,7 @@ </tr> <tr> <td><a href="#LexerPygments.styleText">styleText</a></td> -<td></td> +<td>Public method to perform the styling.</td> </tr> </table> <h3>Static Methods</h3> @@ -358,6 +358,22 @@ <h4>LexerPygments.defaultKeywords</h4> <b>defaultKeywords</b>(<i>kwSet</i>) +<p> + Public method to get the default keywords. +</p> +<dl> + +<dt><i>kwSet</i></dt> +<dd> +number of the keyword set (integer) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +string giving the keywords (string) or None +</dd> +</dl> <a NAME="LexerPygments.defaultPaper" ID="LexerPygments.defaultPaper"></a> <h4>LexerPygments.defaultPaper</h4> <b>defaultPaper</b>(<i>style</i>) @@ -509,6 +525,20 @@ <h4>LexerPygments.styleText</h4> <b>styleText</b>(<i>start, end</i>) +<p> + Public method to perform the styling. +</p> +<dl> + +<dt><i>start</i></dt> +<dd> +position of first character to be styled (integer) +</dd> +<dt><i>end</i></dt> +<dd> +position of last character to be styled (integer) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerQSS.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerQSS.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -207,6 +207,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerQSS +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerRuby.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerRuby.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -190,6 +190,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerRuby +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerSQL.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerSQL.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -190,6 +190,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerSQL +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerTCL.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerTCL.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -190,6 +190,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerTCL +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerTeX.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerTeX.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -72,7 +72,7 @@ </tr> <tr> <td><a href="#LexerTeX.isCommentStyle">isCommentStyle</a></td> -<td></td> +<td>Public method to check, if a style is a comment style.</td> </tr> <tr> <td><a href="#LexerTeX.isStringStyle">isStringStyle</a></td> @@ -130,6 +130,22 @@ <h4>LexerTeX.isCommentStyle</h4> <b>isCommentStyle</b>(<i>style</i>) +<p> + Public method to check, if a style is a comment style. +</p> +<dl> + +<dt><i>style</i></dt> +<dd> +style to check (integer) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a comment style (boolean) +</dd> +</dl> <a NAME="LexerTeX.isStringStyle" ID="LexerTeX.isStringStyle"></a> <h4>LexerTeX.isStringStyle</h4> <b>isStringStyle</b>(<i>style</i>) @@ -157,6 +173,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerTeX +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerVHDL.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerVHDL.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -190,6 +190,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerVHDL +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerXML.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerXML.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -173,6 +173,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerXML +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerYAML.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerYAML.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createLexer">createLexer</a></td> -<td></td> +<td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> @@ -76,7 +76,7 @@ </tr> <tr> <td><a href="#LexerYAML.isStringStyle">isStringStyle</a></td> -<td></td> +<td>Public method to check, if a style is a string style.</td> </tr> </table> <h3>Static Methods</h3> @@ -150,6 +150,22 @@ <h4>LexerYAML.isStringStyle</h4> <b>isStringStyle</b>(<i>style</i>) +<p> + Public method to check, if a style is a string style. +</p> +<dl> + +<dt><i>style</i></dt> +<dd> +style to check (integer) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a string style (boolean) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -157,6 +173,32 @@ <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) +<p> + Function to instantiate a lexer object. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +name of the language variant +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent widget of this lexer +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +instantiated lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +LexerYAML +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Shell.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Shell.html Fri Oct 27 14:09:40 2023 +0200 @@ -147,11 +147,11 @@ </tr> <tr> <td><a href="#Shell.__QScintillaHistoryDown">__QScintillaHistoryDown</a></td> -<td></td> +<td>Private method to handle the history down command.</td> </tr> <tr> <td><a href="#Shell.__QScintillaHistoryUp">__QScintillaHistoryUp</a></td> -<td></td> +<td>Private method to handle the history up command.</td> </tr> <tr> <td><a href="#Shell.__QScintillaLeftCommand">__QScintillaLeftCommand</a></td> @@ -163,7 +163,7 @@ </tr> <tr> <td><a href="#Shell.__QScintillaLineDown">__QScintillaLineDown</a></td> -<td></td> +<td>Private method to handle the cursor down command.</td> </tr> <tr> <td><a href="#Shell.__QScintillaLineEnd">__QScintillaLineEnd</a></td> @@ -171,7 +171,7 @@ </tr> <tr> <td><a href="#Shell.__QScintillaLineUp">__QScintillaLineUp</a></td> -<td></td> +<td>Private method to handle the cursor up command.</td> </tr> <tr> <td><a href="#Shell.__QScintillaNewline">__QScintillaNewline</a></td> @@ -718,10 +718,30 @@ <h4>Shell.__QScintillaHistoryDown</h4> <b>__QScintillaHistoryDown</b>(<i>cmd</i>) +<p> + Private method to handle the history down command. +</p> +<dl> + +<dt><i>cmd</i></dt> +<dd> +QScintilla command +</dd> +</dl> <a NAME="Shell.__QScintillaHistoryUp" ID="Shell.__QScintillaHistoryUp"></a> <h4>Shell.__QScintillaHistoryUp</h4> <b>__QScintillaHistoryUp</b>(<i>cmd</i>) +<p> + Private method to handle the history up command. +</p> +<dl> + +<dt><i>cmd</i></dt> +<dd> +QScintilla command +</dd> +</dl> <a NAME="Shell.__QScintillaLeftCommand" ID="Shell.__QScintillaLeftCommand"></a> <h4>Shell.__QScintillaLeftCommand</h4> <b>__QScintillaLeftCommand</b>(<i>method, allLinesAllowed=False</i>) @@ -760,6 +780,16 @@ <h4>Shell.__QScintillaLineDown</h4> <b>__QScintillaLineDown</b>(<i>cmd</i>) +<p> + Private method to handle the cursor down command. +</p> +<dl> + +<dt><i>cmd</i></dt> +<dd> +QScintilla command +</dd> +</dl> <a NAME="Shell.__QScintillaLineEnd" ID="Shell.__QScintillaLineEnd"></a> <h4>Shell.__QScintillaLineEnd</h4> <b>__QScintillaLineEnd</b>(<i>cmd</i>) @@ -778,6 +808,16 @@ <h4>Shell.__QScintillaLineUp</h4> <b>__QScintillaLineUp</b>(<i>cmd</i>) +<p> + Private method to handle the cursor up command. +</p> +<dl> + +<dt><i>cmd</i></dt> +<dd> +QScintilla command +</dd> +</dl> <a NAME="Shell.__QScintillaNewline" ID="Shell.__QScintillaNewline"></a> <h4>Shell.__QScintillaNewline</h4> <b>__QScintillaNewline</b>(<i>cmd</i>)
--- a/src/eric7/Documentation/Source/eric7.Testing.Interfaces.PytestExecutor.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Testing.Interfaces.PytestExecutor.html Fri Oct 27 14:09:40 2023 +0200 @@ -96,11 +96,11 @@ </tr> <tr> <td><a href="#PytestExecutor.supportsMarkers">supportsMarkers</a></td> -<td></td> +<td>Public method to indicate the support for test filtering using markers and/or marker expressions.</td> </tr> <tr> <td><a href="#PytestExecutor.supportsPatterns">supportsPatterns</a></td> -<td></td> +<td>Public method to indicate the support for test filtering using test name patterns or a test name pattern expression.</td> </tr> </table> <h3>Static Methods</h3> @@ -339,10 +339,56 @@ <h4>PytestExecutor.supportsMarkers</h4> <b>supportsMarkers</b>(<i>interpreter</i>) +<p> + Public method to indicate the support for test filtering using markers and/or + marker expressions. +</p> +<dl> + +<dt><i>interpreter</i> (str)</dt> +<dd> +interpreter to be used for the test +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating support of markers +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="PytestExecutor.supportsPatterns" ID="PytestExecutor.supportsPatterns"></a> <h4>PytestExecutor.supportsPatterns</h4> <b>supportsPatterns</b>(<i>interpreter</i>) +<p> + Public method to indicate the support for test filtering using test name + patterns or a test name pattern expression. +</p> +<dl> + +<dt><i>interpreter</i> (str)</dt> +<dd> +interpreter to be used for the test +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating support of markers +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Testing.Interfaces.PytestRunner.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Testing.Interfaces.PytestRunner.html Fri Oct 27 14:09:40 2023 +0200 @@ -89,7 +89,7 @@ </tr> <tr> <td><a href="#EricPlugin.pytest_report_header">pytest_report_header</a></td> -<td></td> +<td>Public method called by pytest before any reporting.</td> </tr> <tr> <td><a href="#EricPlugin.pytest_runtest_logfinish">pytest_runtest_logfinish</a></td> @@ -101,15 +101,15 @@ </tr> <tr> <td><a href="#EricPlugin.pytest_runtest_logstart">pytest_runtest_logstart</a></td> -<td></td> +<td>Public method called by pytest before running a test.</td> </tr> <tr> <td><a href="#EricPlugin.pytest_sessionfinish">pytest_sessionfinish</a></td> -<td></td> +<td>Public method called by pytest after the whole test run finished.</td> </tr> <tr> <td><a href="#EricPlugin.pytest_sessionstart">pytest_sessionstart</a></td> -<td></td> +<td>Public method called by pytest before performing collection and entering the run test loop.</td> </tr> </table> <h3>Static Methods</h3> @@ -171,6 +171,20 @@ <h4>EricPlugin.pytest_report_header</h4> <b>pytest_report_header</b>(<i>config, startdir</i>) +<p> + Public method called by pytest before any reporting. +</p> +<dl> + +<dt><i>config</i> (Config)</dt> +<dd> +reference to the configuration object +</dd> +<dt><i>startdir</i> (LocalPath)</dt> +<dd> +starting directory +</dd> +</dl> <a NAME="EricPlugin.pytest_runtest_logfinish" ID="EricPlugin.pytest_runtest_logfinish"></a> <h4>EricPlugin.pytest_runtest_logfinish</h4> <b>pytest_runtest_logfinish</b>(<i>nodeid, location</i>) @@ -209,14 +223,54 @@ <h4>EricPlugin.pytest_runtest_logstart</h4> <b>pytest_runtest_logstart</b>(<i>nodeid, location</i>) +<p> + Public method called by pytest before running a test. +</p> +<dl> + +<dt><i>nodeid</i> (str)</dt> +<dd> +node id of the test item +</dd> +<dt><i>location</i> (tuple of (str, int, str))</dt> +<dd> +tuple containing the file name, the line number and + the test name +</dd> +</dl> <a NAME="EricPlugin.pytest_sessionfinish" ID="EricPlugin.pytest_sessionfinish"></a> <h4>EricPlugin.pytest_sessionfinish</h4> <b>pytest_sessionfinish</b>(<i>session, exitstatus</i>) +<p> + Public method called by pytest after the whole test run finished. +</p> +<dl> + +<dt><i>session</i> (Session)</dt> +<dd> +reference to the session object +</dd> +<dt><i>exitstatus</i> (int or ExitCode)</dt> +<dd> +exit status +</dd> +</dl> <a NAME="EricPlugin.pytest_sessionstart" ID="EricPlugin.pytest_sessionstart"></a> <h4>EricPlugin.pytest_sessionstart</h4> <b>pytest_sessionstart</b>(<i>session</i>) +<p> + Public method called by pytest before performing collection and + entering the run test loop. +</p> +<dl> + +<dt><i>session</i> (Session)</dt> +<dd> +reference to the session object +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Testing.Interfaces.TestExecutorBase.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Testing.Interfaces.TestExecutorBase.html Fri Oct 27 14:09:40 2023 +0200 @@ -171,15 +171,15 @@ </tr> <tr> <td><a href="#TestExecutorBase.getMarkers">getMarkers</a></td> -<td></td> +<td>Public method to get the list of defined markers.</td> </tr> <tr> <td><a href="#TestExecutorBase.getVersions">getVersions</a></td> -<td></td> +<td>Public method to get the test framework version and version information of its installed plugins.</td> </tr> <tr> <td><a href="#TestExecutorBase.hasCoverage">hasCoverage</a></td> -<td></td> +<td>Public method to get the test framework version and version information of its installed plugins.</td> </tr> <tr> <td><a href="#TestExecutorBase.readAllOutput">readAllOutput</a></td> @@ -195,11 +195,11 @@ </tr> <tr> <td><a href="#TestExecutorBase.supportsMarkers">supportsMarkers</a></td> -<td></td> +<td>Public method to indicate the support for test filtering using markers and/or marker expressions.</td> </tr> <tr> <td><a href="#TestExecutorBase.supportsPatterns">supportsPatterns</a></td> -<td></td> +<td>Public method to indicate the support for test filtering using test name patterns or a test name pattern expression.</td> </tr> </table> <h3>Static Methods</h3> @@ -338,14 +338,88 @@ <h4>TestExecutorBase.getMarkers</h4> <b>getMarkers</b>(<i>interpreter, workdir</i>) +<p> + Public method to get the list of defined markers. +</p> +<dl> + +<dt><i>interpreter</i> (str)</dt> +<dd> +interpreter to be used for the test +</dd> +<dt><i>workdir</i> (str)</dt> +<dd> +name of the working directory +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +dictionary containing the marker as key and the associated description + as value +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <a NAME="TestExecutorBase.getVersions" ID="TestExecutorBase.getVersions"></a> <h4>TestExecutorBase.getVersions</h4> <b>getVersions</b>(<i>interpreter</i>) +<p> + Public method to get the test framework version and version information + of its installed plugins. +</p> +<dl> + +<dt><i>interpreter</i> (str)</dt> +<dd> +interpreter to be used for the test +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +dictionary containing the framework name and version and the + list of available plugins with name and version each +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <a NAME="TestExecutorBase.hasCoverage" ID="TestExecutorBase.hasCoverage"></a> <h4>TestExecutorBase.hasCoverage</h4> <b>hasCoverage</b>(<i>interpreter</i>) +<p> + Public method to get the test framework version and version information + of its installed plugins. +</p> +<dl> + +<dt><i>interpreter</i> (str)</dt> +<dd> +interpreter to be used for the test +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating the availability of coverage functionality +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="TestExecutorBase.readAllOutput" ID="TestExecutorBase.readAllOutput"></a> <h4>TestExecutorBase.readAllOutput</h4> <b>readAllOutput</b>(<i>process=None</i>) @@ -408,10 +482,56 @@ <h4>TestExecutorBase.supportsMarkers</h4> <b>supportsMarkers</b>(<i>interpreter</i>) +<p> + Public method to indicate the support for test filtering using markers and/or + marker expressions. +</p> +<dl> + +<dt><i>interpreter</i> (str)</dt> +<dd> +interpreter to be used for the test +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating support of markers +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="TestExecutorBase.supportsPatterns" ID="TestExecutorBase.supportsPatterns"></a> <h4>TestExecutorBase.supportsPatterns</h4> <b>supportsPatterns</b>(<i>interpreter</i>) +<p> + Public method to indicate the support for test filtering using test name + patterns or a test name pattern expression. +</p> +<dl> + +<dt><i>interpreter</i> (str)</dt> +<dd> +interpreter to be used for the test +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating support of markers +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.Testing.Interfaces.UnittestExecutor.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Testing.Interfaces.UnittestExecutor.html Fri Oct 27 14:09:40 2023 +0200 @@ -76,7 +76,7 @@ </tr> <tr> <td><a href="#UnittestExecutor.hasCoverage">hasCoverage</a></td> -<td></td> +<td>Public method to get the test framework version and version information of its installed plugins.</td> </tr> <tr> <td><a href="#UnittestExecutor.start">start</a></td> @@ -84,7 +84,7 @@ </tr> <tr> <td><a href="#UnittestExecutor.supportsPatterns">supportsPatterns</a></td> -<td></td> +<td>Public method to indicate the support for test filtering using test name patterns or a test name pattern expression.</td> </tr> </table> <h3>Static Methods</h3> @@ -190,6 +190,29 @@ <h4>UnittestExecutor.hasCoverage</h4> <b>hasCoverage</b>(<i>interpreter</i>) +<p> + Public method to get the test framework version and version information + of its installed plugins. +</p> +<dl> + +<dt><i>interpreter</i> (str)</dt> +<dd> +interpreter to be used for the test +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating the availability of coverage functionality +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="UnittestExecutor.start" ID="UnittestExecutor.start"></a> <h4>UnittestExecutor.start</h4> <b>start</b>(<i>config, pythonpath</i>) @@ -212,6 +235,29 @@ <h4>UnittestExecutor.supportsPatterns</h4> <b>supportsPatterns</b>(<i>interpreter</i>) +<p> + Public method to indicate the support for test filtering using test name + patterns or a test name pattern expression. +</p> +<dl> + +<dt><i>interpreter</i> (str)</dt> +<dd> +interpreter to be used for the test +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating support of markers +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.UI.BrowserModel.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.UI.BrowserModel.html Fri Oct 27 14:09:40 2023 +0200 @@ -963,7 +963,7 @@ </tr> <tr> <td><a href="#BrowserFileItem.setName">setName</a></td> -<td></td> +<td>Public method to set the directory name.</td> </tr> </table> <h3>Static Methods</h3> @@ -1374,6 +1374,20 @@ <h4>BrowserFileItem.setName</h4> <b>setName</b>(<i>finfo, full=True</i>) +<p> + Public method to set the directory name. +</p> +<dl> + +<dt><i>finfo</i></dt> +<dd> +the string for the file (string) +</dd> +<dt><i>full</i></dt> +<dd> +flag indicating full pathname should be displayed (boolean) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -1744,7 +1758,7 @@ </tr> <tr> <td><a href="#BrowserItem.lessThan">lessThan</a></td> -<td></td> +<td>Public method to check, if the item is less than the other one.</td> </tr> <tr> <td><a href="#BrowserItem.parent">parent</a></td> @@ -1953,6 +1967,30 @@ <h4>BrowserItem.lessThan</h4> <b>lessThan</b>(<i>other, column, order</i>) +<p> + Public method to check, if the item is less than the other one. +</p> +<dl> + +<dt><i>other</i></dt> +<dd> +reference to item to compare against (BrowserItem) +</dd> +<dt><i>column</i></dt> +<dd> +column number to use for the comparison (integer) +</dd> +<dt><i>order</i></dt> +<dd> +sort order (Qt.SortOrder) (for special sorting) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +true, if this item is less than other (boolean) +</dd> +</dl> <a NAME="BrowserItem.parent" ID="BrowserItem.parent"></a> <h4>BrowserItem.parent</h4> <b>parent</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.UI.NumbersWidget.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.UI.NumbersWidget.html Fri Oct 27 14:09:40 2023 +0200 @@ -64,7 +64,7 @@ </tr> <tr> <td><a href="#BinaryModel.columnCount">columnCount</a></td> -<td></td> +<td>Public method to get the number of columns of the model.</td> </tr> <tr> <td><a href="#BinaryModel.data">data</a></td> @@ -72,7 +72,7 @@ </tr> <tr> <td><a href="#BinaryModel.flags">flags</a></td> -<td></td> +<td>Public method to get flags from the model.</td> </tr> <tr> <td><a href="#BinaryModel.getValue">getValue</a></td> @@ -84,7 +84,7 @@ </tr> <tr> <td><a href="#BinaryModel.rowCount">rowCount</a></td> -<td></td> +<td>Public method to get the number of rows of the model.</td> </tr> <tr> <td><a href="#BinaryModel.setBits">setBits</a></td> @@ -127,6 +127,22 @@ <h4>BinaryModel.columnCount</h4> <b>columnCount</b>(<i>parent</i>) +<p> + Public method to get the number of columns of the model. +</p> +<dl> + +<dt><i>parent</i></dt> +<dd> +parent index (QModelIndex) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +number of columns (integer) +</dd> +</dl> <a NAME="BinaryModel.data" ID="BinaryModel.data"></a> <h4>BinaryModel.data</h4> <b>data</b>(<i>index, role=Qt.ItemDataRole.DisplayRole</i>) @@ -155,6 +171,22 @@ <h4>BinaryModel.flags</h4> <b>flags</b>(<i>index</i>) +<p> + Public method to get flags from the model. +</p> +<dl> + +<dt><i>index</i></dt> +<dd> +index to get flags for (QModelIndex) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flags (Qt.ItemFlags) +</dd> +</dl> <a NAME="BinaryModel.getValue" ID="BinaryModel.getValue"></a> <h4>BinaryModel.getValue</h4> <b>getValue</b>(<i></i>) @@ -200,6 +232,22 @@ <h4>BinaryModel.rowCount</h4> <b>rowCount</b>(<i>parent</i>) +<p> + Public method to get the number of rows of the model. +</p> +<dl> + +<dt><i>parent</i></dt> +<dd> +parent index (QModelIndex) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +number of columns (integer) +</dd> +</dl> <a NAME="BinaryModel.setBits" ID="BinaryModel.setBits"></a> <h4>BinaryModel.setBits</h4> <b>setBits</b>(<i>bits</i>)
--- a/src/eric7/Documentation/Source/eric7.UI.Previewer.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.UI.Previewer.html Fri Oct 27 14:09:40 2023 +0200 @@ -69,7 +69,7 @@ </tr> <tr> <td><a href="#Previewer.__editorTextChanged">__editorTextChanged</a></td> -<td></td> +<td>Private slot to handle changes of an editor's text.</td> </tr> <tr> <td><a href="#Previewer.__isPreviewable">__isPreviewable</a></td> @@ -164,6 +164,16 @@ <h4>Previewer.__editorTextChanged</h4> <b>__editorTextChanged</b>(<i>editor</i>) +<p> + Private slot to handle changes of an editor's text. +</p> +<dl> + +<dt><i>editor</i> (Editor)</dt> +<dd> +reference to the editor +</dd> +</dl> <a NAME="Previewer.__isPreviewable" ID="Previewer.__isPreviewable"></a> <h4>Previewer.__isPreviewable</h4> <b>__isPreviewable</b>(<i>editor</i>)
--- a/src/eric7/Documentation/Source/eric7.UI.Previewers.MarkdownExtensions.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.UI.Previewers.MarkdownExtensions.html Fri Oct 27 14:09:40 2023 +0200 @@ -64,7 +64,7 @@ <tr> <td><a href="#MermaidExtension.extendMarkdown">extendMarkdown</a></td> -<td></td> +<td>Public method to register the extension.</td> </tr> </table> <h3>Static Methods</h3> @@ -77,6 +77,20 @@ <h4>MermaidExtension.extendMarkdown</h4> <b>extendMarkdown</b>(<i>md, md_globals</i>) +<p> + Public method to register the extension. +</p> +<dl> + +<dt><i>md</i></dt> +<dd> +reference to markdown +</dd> +<dt><i>md_globals</i></dt> +<dd> +global config parameters +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.UI.PythonAstViewer.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.UI.PythonAstViewer.html Fri Oct 27 14:09:40 2023 +0200 @@ -82,7 +82,7 @@ </tr> <tr> <td><a href="#PythonAstViewer.__editorDoubleClicked">__editorDoubleClicked</a></td> -<td></td> +<td>Private slot to handle a mouse button double click in the editor.</td> </tr> <tr> <td><a href="#PythonAstViewer.__editorLanguageChanged">__editorLanguageChanged</a></td> @@ -264,6 +264,24 @@ <h4>PythonAstViewer.__editorDoubleClicked</h4> <b>__editorDoubleClicked</b>(<i>editor, pos, buttons</i>) +<p> + Private slot to handle a mouse button double click in the editor. +</p> +<dl> + +<dt><i>editor</i> (Editor)</dt> +<dd> +reference to the editor, that emitted the signal +</dd> +<dt><i>pos</i> (QPoint)</dt> +<dd> +position of the double click +</dd> +<dt><i>buttons</i> (Qt.MouseButton)</dt> +<dd> +mouse buttons that were double clicked +</dd> +</dl> <a NAME="PythonAstViewer.__editorLanguageChanged" ID="PythonAstViewer.__editorLanguageChanged"></a> <h4>PythonAstViewer.__editorLanguageChanged</h4> <b>__editorLanguageChanged</b>(<i>editor</i>)
--- a/src/eric7/Documentation/Source/eric7.UI.PythonDisViewer.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.UI.PythonDisViewer.html Fri Oct 27 14:09:40 2023 +0200 @@ -134,7 +134,7 @@ </tr> <tr> <td><a href="#PythonDisViewer.__editorLineChanged">__editorLineChanged</a></td> -<td></td> +<td>Private slot to handle a mouse button double click in the editor.</td> </tr> <tr> <td><a href="#PythonDisViewer.__editorSaved">__editorSaved</a></td> @@ -515,6 +515,20 @@ <h4>PythonDisViewer.__editorLineChanged</h4> <b>__editorLineChanged</b>(<i>editor, lineno</i>) +<p> + Private slot to handle a mouse button double click in the editor. +</p> +<dl> + +<dt><i>editor</i> (Editor)</dt> +<dd> +reference to the editor, that emitted the signal +</dd> +<dt><i>lineno</i> (int)</dt> +<dd> +line number of the editor's cursor (zero based) +</dd> +</dl> <a NAME="PythonDisViewer.__editorSaved" ID="PythonDisViewer.__editorSaved"></a> <h4>PythonDisViewer.__editorSaved</h4> <b>__editorSaved</b>(<i>editor</i>)
--- a/src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.rbclbr.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.rbclbr.html Fri Oct 27 14:09:40 2023 +0200 @@ -54,7 +54,7 @@ <tr> <td><a href="#readmodule_ex">readmodule_ex</a></td> -<td></td> +<td>Read a Ruby file and return a dictionary of classes, functions and modules.</td> </tr> <tr> <td><a href="#scan">scan</a></td> @@ -370,6 +370,36 @@ <h2>readmodule_ex</h2> <b>readmodule_ex</b>(<i>module, path=None, isTypeFile=False</i>) +<p> + Read a Ruby file and return a dictionary of classes, functions and modules. +</p> +<dl> + +<dt><i>module</i> (str)</dt> +<dd> +name of the Ruby file +</dd> +<dt><i>path</i> (list of str)</dt> +<dd> +path the file should be searched in +</dd> +<dt><i>isTypeFile</i> (bool)</dt> +<dd> +flag indicating a file of this type +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +the resulting dictionary +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.VCS.ProjectHelper.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.VCS.ProjectHelper.html Fri Oct 27 14:09:40 2023 +0200 @@ -140,7 +140,7 @@ </tr> <tr> <td><a href="#VcsProjectHelper.initToolbar">initToolbar</a></td> -<td></td> +<td>Public slot to initialize the VCS toolbar.</td> </tr> <tr> <td><a href="#VcsProjectHelper.revertChanges">revertChanges</a></td> @@ -378,6 +378,27 @@ <h4>VcsProjectHelper.initToolbar</h4> <b>initToolbar</b>(<i>ui, toolbarManager</i>) +<p> + Public slot to initialize the VCS toolbar. +</p> +<dl> + +<dt><i>ui</i></dt> +<dd> +reference to the main window (UserInterface) +</dd> +<dt><i>toolbarManager</i></dt> +<dd> +reference to a toolbar manager object + (EricToolBarManager) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +the toolbar generated (QToolBar) +</dd> +</dl> <a NAME="VcsProjectHelper.revertChanges" ID="VcsProjectHelper.revertChanges"></a> <h4>VcsProjectHelper.revertChanges</h4> <b>revertChanges</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.VCS.StatusMonitorLed.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.VCS.StatusMonitorLed.html Fri Oct 27 14:09:40 2023 +0200 @@ -74,7 +74,7 @@ </tr> <tr> <td><a href="#StatusMonitorLed.__ledClicked">__ledClicked</a></td> -<td></td> +<td>Private slot to react upon clicks on the LED.</td> </tr> <tr> <td><a href="#StatusMonitorLed.__projectVcsMonitorStatus">__projectVcsMonitorStatus</a></td> @@ -143,6 +143,16 @@ <h4>StatusMonitorLed.__ledClicked</h4> <b>__ledClicked</b>(<i>pos</i>) +<p> + Private slot to react upon clicks on the LED. +</p> +<dl> + +<dt><i>pos</i></dt> +<dd> +position of the click (QPoint) +</dd> +</dl> <a NAME="StatusMonitorLed.__projectVcsMonitorStatus" ID="StatusMonitorLed.__projectVcsMonitorStatus"></a> <h4>StatusMonitorLed.__projectVcsMonitorStatus</h4> <b>__projectVcsMonitorStatus</b>(<i>status, statusMsg</i>)
--- a/src/eric7/Documentation/Source/eric7.VCS.VersionControl.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.VCS.VersionControl.html Fri Oct 27 14:09:40 2023 +0200 @@ -114,7 +114,7 @@ </tr> <tr> <td><a href="#VersionControl._createStatusMonitorThread">_createStatusMonitorThread</a></td> -<td></td> +<td>Protected method to create an instance of the VCS status monitor thread.</td> </tr> <tr> <td><a href="#VersionControl._vcsAddProjectCommitMessage">_vcsAddProjectCommitMessage</a></td> @@ -310,7 +310,7 @@ </tr> <tr> <td><a href="#VersionControl.vcsResolved">vcsResolved</a></td> -<td></td> +<td>Public method used to resolve conflicts of a file/directory.</td> </tr> <tr> <td><a href="#VersionControl.vcsRevert">vcsRevert</a></td> @@ -461,6 +461,32 @@ <h4>VersionControl._createStatusMonitorThread</h4> <b>_createStatusMonitorThread</b>(<i>interval, project</i>) +<p> + Protected method to create an instance of the VCS status monitor + thread. +</p> +<p> + Note: This method should be overwritten in subclasses in order to + support VCS status monitoring. +</p> +<dl> + +<dt><i>interval</i></dt> +<dd> +check interval for the monitor thread in seconds + (integer) +</dd> +<dt><i>project</i></dt> +<dd> +reference to the project object +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the monitor thread (QThread) +</dd> +</dl> <a NAME="VersionControl._vcsAddProjectCommitMessage" ID="VersionControl._vcsAddProjectCommitMessage"></a> <h4>VersionControl._vcsAddProjectCommitMessage</h4> <b>_vcsAddProjectCommitMessage</b>(<i>message</i>) @@ -1613,6 +1639,16 @@ <h4>VersionControl.vcsResolved</h4> <b>vcsResolved</b>(<i>name</i>) +<p> + Public method used to resolve conflicts of a file/directory. +</p> +<dl> + +<dt><i>name</i> (str)</dt> +<dd> +file/directory name to be resolved +</dd> +</dl> <a NAME="VersionControl.vcsRevert" ID="VersionControl.vcsRevert"></a> <h4>VersionControl.vcsRevert</h4> <b>vcsRevert</b>(<i>name</i>)
--- a/src/eric7/Documentation/Source/eric7.WebBrowser.AdBlock.AdBlockIcon.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.AdBlock.AdBlockIcon.html Fri Oct 27 14:09:40 2023 +0200 @@ -92,7 +92,7 @@ </tr> <tr> <td><a href="#AdBlockIcon.sourceChanged">sourceChanged</a></td> -<td></td> +<td>Public slot to handle URL changes.</td> </tr> </table> <h3>Static Methods</h3> @@ -229,6 +229,20 @@ <h4>AdBlockIcon.sourceChanged</h4> <b>sourceChanged</b>(<i>browser, url</i>) +<p> + Public slot to handle URL changes. +</p> +<dl> + +<dt><i>browser</i> (WebBrowserView)</dt> +<dd> +reference to the browser +</dd> +<dt><i>url</i> (QUrl)</dt> +<dd> +new URL +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.AddBookmarkDialog.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.AddBookmarkDialog.html Fri Oct 27 14:09:40 2023 +0200 @@ -326,7 +326,7 @@ </tr> <tr> <td><a href="#AddBookmarkProxyModel.filterAcceptsColumn">filterAcceptsColumn</a></td> -<td></td> +<td>Public method to determine, if the column is acceptable.</td> </tr> <tr> <td><a href="#AddBookmarkProxyModel.filterAcceptsRow">filterAcceptsRow</a></td> @@ -381,6 +381,26 @@ <h4>AddBookmarkProxyModel.filterAcceptsColumn</h4> <b>filterAcceptsColumn</b>(<i>sourceColumn, sourceParent</i>) +<p> + Public method to determine, if the column is acceptable. +</p> +<dl> + +<dt><i>sourceColumn</i></dt> +<dd> +column number in the source model (integer) +</dd> +<dt><i>sourceParent</i></dt> +<dd> +index of the source item (QModelIndex) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating acceptance (boolean) +</dd> +</dl> <a NAME="AddBookmarkProxyModel.filterAcceptsRow" ID="AddBookmarkProxyModel.filterAcceptsRow"></a> <h4>AddBookmarkProxyModel.filterAcceptsRow</h4> <b>filterAcceptsRow</b>(<i>sourceRow, sourceParent</i>)
--- a/src/eric7/Documentation/Source/eric7.WebBrowser.Feeds.FeedsManager.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.Feeds.FeedsManager.html Fri Oct 27 14:09:40 2023 +0200 @@ -94,7 +94,7 @@ </tr> <tr> <td><a href="#FeedsManager.__customContextMenuRequested">__customContextMenuRequested</a></td> -<td></td> +<td>Private slot to handle the context menu request for the feeds tree.</td> </tr> <tr> <td><a href="#FeedsManager.__enableButtons">__enableButtons</a></td> @@ -223,6 +223,16 @@ <h4>FeedsManager.__customContextMenuRequested</h4> <b>__customContextMenuRequested</b>(<i>pos</i>) +<p> + Private slot to handle the context menu request for the feeds tree. +</p> +<dl> + +<dt><i>pos</i></dt> +<dd> +position the context menu was requested (QPoint) +</dd> +</dl> <a NAME="FeedsManager.__enableButtons" ID="FeedsManager.__enableButtons"></a> <h4>FeedsManager.__enableButtons</h4> <b>__enableButtons</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.WebBrowser.History.HistoryCompleter.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.History.HistoryCompleter.html Fri Oct 27 14:09:40 2023 +0200 @@ -405,7 +405,7 @@ </tr> <tr> <td><a href="#HistoryCompletionView.sizeHintForRow">sizeHintForRow</a></td> -<td></td> +<td>Public method to give a size hint for rows.</td> </tr> </table> <h3>Static Methods</h3> @@ -446,6 +446,22 @@ <h4>HistoryCompletionView.sizeHintForRow</h4> <b>sizeHintForRow</b>(<i>row</i>) +<p> + Public method to give a size hint for rows. +</p> +<dl> + +<dt><i>row</i></dt> +<dd> +row number (integer) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +desired row height (integer) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.WebBrowser.History.HistoryFilterModel.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.History.HistoryFilterModel.html Fri Oct 27 14:09:40 2023 +0200 @@ -227,7 +227,7 @@ </tr> <tr> <td><a href="#HistoryFilterModel.parent">parent</a></td> -<td></td> +<td>Public method to get the parent index.</td> </tr> <tr> <td><a href="#HistoryFilterModel.recalculateFrequencies">recalculateFrequencies</a></td> @@ -550,6 +550,22 @@ <h4>HistoryFilterModel.parent</h4> <b>parent</b>(<i>index</i>) +<p> + Public method to get the parent index. +</p> +<dl> + +<dt><i>index</i></dt> +<dd> +index of item to get parent (QModelIndex) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +index of parent (QModelIndex) +</dd> +</dl> <a NAME="HistoryFilterModel.recalculateFrequencies" ID="HistoryFilterModel.recalculateFrequencies"></a> <h4>HistoryFilterModel.recalculateFrequencies</h4> <b>recalculateFrequencies</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.WebBrowser.Network.NetworkManager.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.Network.NetworkManager.html Fri Oct 27 14:09:40 2023 +0200 @@ -116,7 +116,7 @@ </tr> <tr> <td><a href="#NetworkManager.proxyAuthentication">proxyAuthentication</a></td> -<td></td> +<td>Public slot to handle a proxy authentication request.</td> </tr> <tr> <td><a href="#NetworkManager.removeUrlInterceptor">removeUrlInterceptor</a></td> @@ -356,6 +356,24 @@ <h4>NetworkManager.proxyAuthentication</h4> <b>proxyAuthentication</b>(<i>requestUrl, auth, proxyHost</i>) +<p> + Public slot to handle a proxy authentication request. +</p> +<dl> + +<dt><i>requestUrl</i> (QUrl)</dt> +<dd> +requested URL +</dd> +<dt><i>auth</i> (QAuthenticator)</dt> +<dd> +reference to the authenticator object +</dd> +<dt><i>proxyHost</i> (str)</dt> +<dd> +name of the proxy host +</dd> +</dl> <a NAME="NetworkManager.removeUrlInterceptor" ID="NetworkManager.removeUrlInterceptor"></a> <h4>NetworkManager.removeUrlInterceptor</h4> <b>removeUrlInterceptor</b>(<i>interceptor</i>)
--- a/src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchEngineModel.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchEngineModel.html Fri Oct 27 14:09:40 2023 +0200 @@ -64,7 +64,7 @@ </tr> <tr> <td><a href="#OpenSearchEngineModel.columnCount">columnCount</a></td> -<td></td> +<td>Public method to get the number of columns of the model.</td> </tr> <tr> <td><a href="#OpenSearchEngineModel.data">data</a></td> @@ -127,6 +127,22 @@ <h4>OpenSearchEngineModel.columnCount</h4> <b>columnCount</b>(<i>parent=None</i>) +<p> + Public method to get the number of columns of the model. +</p> +<dl> + +<dt><i>parent</i></dt> +<dd> +parent index (QModelIndex) (Unused) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +number of columns (integer) +</dd> +</dl> <a NAME="OpenSearchEngineModel.data" ID="OpenSearchEngineModel.data"></a> <h4>OpenSearchEngineModel.data</h4> <b>data</b>(<i>index, role</i>)
--- a/src/eric7/Documentation/Source/eric7.WebBrowser.Passwords.PasswordModel.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.Passwords.PasswordModel.html Fri Oct 27 14:09:40 2023 +0200 @@ -64,7 +64,7 @@ </tr> <tr> <td><a href="#PasswordModel.columnCount">columnCount</a></td> -<td></td> +<td>Public method to get the number of columns of the model.</td> </tr> <tr> <td><a href="#PasswordModel.data">data</a></td> @@ -126,6 +126,22 @@ <h4>PasswordModel.columnCount</h4> <b>columnCount</b>(<i>parent=None</i>) +<p> + Public method to get the number of columns of the model. +</p> +<dl> + +<dt><i>parent</i></dt> +<dd> +parent index (QModelIndex) (Unused) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +number of columns (integer) +</dd> +</dl> <a NAME="PasswordModel.data" ID="PasswordModel.data"></a> <h4>PasswordModel.data</h4> <b>data</b>(<i>index, role</i>)
--- a/src/eric7/Documentation/Source/eric7.WebBrowser.UserAgent.UserAgentModel.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.UserAgent.UserAgentModel.html Fri Oct 27 14:09:40 2023 +0200 @@ -64,7 +64,7 @@ </tr> <tr> <td><a href="#UserAgentModel.columnCount">columnCount</a></td> -<td></td> +<td>Public method to get the number of columns of the model.</td> </tr> <tr> <td><a href="#UserAgentModel.data">data</a></td> @@ -118,6 +118,22 @@ <h4>UserAgentModel.columnCount</h4> <b>columnCount</b>(<i>parent=None</i>) +<p> + Public method to get the number of columns of the model. +</p> +<dl> + +<dt><i>parent</i></dt> +<dd> +parent index (QModelIndex) (Unused) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +number of columns (integer) +</dd> +</dl> <a NAME="UserAgentModel.data" ID="UserAgentModel.data"></a> <h4>UserAgentModel.data</h4> <b>data</b>(<i>index, role</i>)
--- a/src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserPage.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserPage.html Fri Oct 27 14:09:40 2023 +0200 @@ -101,7 +101,7 @@ </tr> <tr> <td><a href="#WebBrowserPage.__contentsSizeChanged">__contentsSizeChanged</a></td> -<td></td> +<td>Private slot to work around QWebEnginePage not scrolling to anchors when opened in a background tab.</td> </tr> <tr> <td><a href="#WebBrowserPage.__featurePermissionRequested">__featurePermissionRequested</a></td> @@ -291,6 +291,17 @@ <h4>WebBrowserPage.__contentsSizeChanged</h4> <b>__contentsSizeChanged</b>(<i>size</i>) +<p> + Private slot to work around QWebEnginePage not scrolling to anchors + when opened in a background tab. +</p> +<dl> + +<dt><i>size</i> (QSizeF)</dt> +<dd> +changed contents size (unused) +</dd> +</dl> <a NAME="WebBrowserPage.__featurePermissionRequested" ID="WebBrowserPage.__featurePermissionRequested"></a> <h4>WebBrowserPage.__featurePermissionRequested</h4> <b>__featurePermissionRequested</b>(<i>url, feature</i>)
--- a/src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserTabBar.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserTabBar.html Fri Oct 27 14:09:40 2023 +0200 @@ -84,7 +84,7 @@ </tr> <tr> <td><a href="#WebBrowserTabBar.tabRemoved">tabRemoved</a></td> -<td></td> +<td>Public slot to handle the removal of a tab.</td> </tr> </table> <h3>Static Methods</h3> @@ -198,6 +198,16 @@ <h4>WebBrowserTabBar.tabRemoved</h4> <b>tabRemoved</b>(<i>index</i>) +<p> + Public slot to handle the removal of a tab. +</p> +<dl> + +<dt><i>index</i></dt> +<dd> +index of the removed tab (integer) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserTabWidget.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserTabWidget.html Fri Oct 27 14:09:40 2023 +0200 @@ -129,7 +129,7 @@ </tr> <tr> <td><a href="#WebBrowserTabWidget.__loadFinished">__loadFinished</a></td> -<td></td> +<td>Private method to handle the loadFinished signal.</td> </tr> <tr> <td><a href="#WebBrowserTabWidget.__loadProgress">__loadProgress</a></td> @@ -454,6 +454,20 @@ <h4>WebBrowserTabWidget.__loadFinished</h4> <b>__loadFinished</b>(<i>ok, browser</i>) +<p> + Private method to handle the loadFinished signal. +</p> +<dl> + +<dt><i>ok</i> (bool)</dt> +<dd> +flag indicating the result +</dd> +<dt><i>browser</i> (WebBrowserView)</dt> +<dd> +reference to the web browser +</dd> +</dl> <a NAME="WebBrowserTabWidget.__loadProgress" ID="WebBrowserTabWidget.__loadProgress"></a> <h4>WebBrowserTabWidget.__loadProgress</h4> <b>__loadProgress</b>(<i>progress, browser</i>)
--- a/src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserView.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserView.html Fri Oct 27 14:09:40 2023 +0200 @@ -179,7 +179,7 @@ </tr> <tr> <td><a href="#WebBrowserView.__createSelectedTextContextMenu">__createSelectedTextContextMenu</a></td> -<td></td> +<td>Private method to populate the context menu for selected text.</td> </tr> <tr> <td><a href="#WebBrowserView.__currentEngineChanged">__currentEngineChanged</a></td> @@ -287,7 +287,7 @@ </tr> <tr> <td><a href="#WebBrowserView.__renderProcessTerminated">__renderProcessTerminated</a></td> -<td></td> +<td>Private slot handling a crash of the web page render process.</td> </tr> <tr> <td><a href="#WebBrowserView.__replaceMisspelledWord">__replaceMisspelledWord</a></td> @@ -878,6 +878,20 @@ <h4>WebBrowserView.__createSelectedTextContextMenu</h4> <b>__createSelectedTextContextMenu</b>(<i>menu, hitTest</i>) +<p> + Private method to populate the context menu for selected text. +</p> +<dl> + +<dt><i>menu</i> (QMenu)</dt> +<dd> +reference to the menu to be populated +</dd> +<dt><i>hitTest</i> (WebHitTestResult)</dt> +<dd> +reference to the hit test object +</dd> +</dl> <a NAME="WebBrowserView.__currentEngineChanged" ID="WebBrowserView.__currentEngineChanged"></a> <h4>WebBrowserView.__currentEngineChanged</h4> <b>__currentEngineChanged</b>(<i></i>) @@ -1209,6 +1223,20 @@ <h4>WebBrowserView.__renderProcessTerminated</h4> <b>__renderProcessTerminated</b>(<i>status, exitCode</i>) +<p> + Private slot handling a crash of the web page render process. +</p> +<dl> + +<dt><i>status</i> (QWebEnginePage.RenderProcessTerminationStatus)</dt> +<dd> +termination status +</dd> +<dt><i>exitCode</i> (int)</dt> +<dd> +exit code of the process +</dd> +</dl> <a NAME="WebBrowserView.__replaceMisspelledWord" ID="WebBrowserView.__replaceMisspelledWord"></a> <h4>WebBrowserView.__replaceMisspelledWord</h4> <b>__replaceMisspelledWord</b>(<i>act</i>)
--- a/src/eric7/Documentation/Source/eric7.WebBrowser.ZoomManager.ZoomValuesModel.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.ZoomManager.ZoomValuesModel.html Fri Oct 27 14:09:40 2023 +0200 @@ -64,7 +64,7 @@ </tr> <tr> <td><a href="#ZoomValuesModel.columnCount">columnCount</a></td> -<td></td> +<td>Public method to get the number of columns of the model.</td> </tr> <tr> <td><a href="#ZoomValuesModel.data">data</a></td> @@ -118,6 +118,22 @@ <h4>ZoomValuesModel.columnCount</h4> <b>columnCount</b>(<i>parent=None</i>) +<p> + Public method to get the number of columns of the model. +</p> +<dl> + +<dt><i>parent</i></dt> +<dd> +parent index (QModelIndex) (Unused) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +number of columns (integer) +</dd> +</dl> <a NAME="ZoomValuesModel.data" ID="ZoomValuesModel.data"></a> <h4>ZoomValuesModel.data</h4> <b>data</b>(<i>index, role</i>)
--- a/src/eric7/Documentation/Source/eric7.eric7_configure.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.eric7_configure.html Fri Oct 27 14:09:40 2023 +0200 @@ -30,7 +30,7 @@ <tr> <td><a href="#createMainWidget">createMainWidget</a></td> -<td></td> +<td>Function to create the main widget.</td> </tr> <tr> <td><a href="#main">main</a></td> @@ -43,6 +43,22 @@ <h2>createMainWidget</h2> <b>createMainWidget</b>(<i>argv</i>) +<p> + Function to create the main widget. +</p> +<dl> + +<dt><i>argv</i></dt> +<dd> +list of commandline parameters (list of strings) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the main widget (QWidget) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.eric7_diff.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.eric7_diff.html Fri Oct 27 14:09:40 2023 +0200 @@ -32,7 +32,7 @@ <tr> <td><a href="#createMainWidget">createMainWidget</a></td> -<td></td> +<td>Function to create the main widget.</td> </tr> <tr> <td><a href="#main">main</a></td> @@ -45,6 +45,22 @@ <h2>createMainWidget</h2> <b>createMainWidget</b>(<i>argv</i>) +<p> + Function to create the main widget. +</p> +<dl> + +<dt><i>argv</i></dt> +<dd> +list of commandline parameters (list of strings) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the main widget (QWidget) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.eric7_pip.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.eric7_pip.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createMainWidget">createMainWidget</a></td> -<td></td> +<td>Function to create the main widget.</td> </tr> <tr> <td><a href="#main">main</a></td> @@ -44,6 +44,28 @@ <h2>createMainWidget</h2> <b>createMainWidget</b>(<i>argv</i>) +<p> + Function to create the main widget. +</p> +<dl> + +<dt><i>argv</i> (list of str)</dt> +<dd> +list of commandline parameters +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the main widget +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QWidget +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.eric7_pluginrepository.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.eric7_pluginrepository.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createMainWidget">createMainWidget</a></td> -<td></td> +<td>Function to create the main widget.</td> </tr> <tr> <td><a href="#main">main</a></td> @@ -44,6 +44,22 @@ <h2>createMainWidget</h2> <b>createMainWidget</b>(<i>argv</i>) +<p> + Function to create the main widget. +</p> +<dl> + +<dt><i>argv</i></dt> +<dd> +list of commandline parameters (list of strings) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the main widget (QWidget) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.eric7_pluginuninstall.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.eric7_pluginuninstall.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createMainWidget">createMainWidget</a></td> -<td></td> +<td>Function to create the main widget.</td> </tr> <tr> <td><a href="#main">main</a></td> @@ -44,6 +44,22 @@ <h2>createMainWidget</h2> <b>createMainWidget</b>(<i>argv</i>) +<p> + Function to create the main widget. +</p> +<dl> + +<dt><i>argv</i></dt> +<dd> +list of commandline parameters (list of strings) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the main widget (QWidget) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.eric7_qregularexpression.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.eric7_qregularexpression.html Fri Oct 27 14:09:40 2023 +0200 @@ -32,7 +32,7 @@ <tr> <td><a href="#createMainWidget">createMainWidget</a></td> -<td></td> +<td>Function to create the main widget.</td> </tr> <tr> <td><a href="#main">main</a></td> @@ -45,6 +45,22 @@ <h2>createMainWidget</h2> <b>createMainWidget</b>(<i>argv</i>) +<p> + Function to create the main widget. +</p> +<dl> + +<dt><i>argv</i></dt> +<dd> +list of commandline parameters (list of strings) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the main widget (QWidget) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.eric7_re.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.eric7_re.html Fri Oct 27 14:09:40 2023 +0200 @@ -32,7 +32,7 @@ <tr> <td><a href="#createMainWidget">createMainWidget</a></td> -<td></td> +<td>Function to create the main widget.</td> </tr> <tr> <td><a href="#main">main</a></td> @@ -45,6 +45,22 @@ <h2>createMainWidget</h2> <b>createMainWidget</b>(<i>argv</i>) +<p> + Function to create the main widget. +</p> +<dl> + +<dt><i>argv</i></dt> +<dd> +list of commandline parameters (list of strings) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the main widget (QWidget) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.eric7_shell.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.eric7_shell.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createMainWidget">createMainWidget</a></td> -<td></td> +<td>Function to create the main widget.</td> </tr> <tr> <td><a href="#main">main</a></td> @@ -44,6 +44,22 @@ <h2>createMainWidget</h2> <b>createMainWidget</b>(<i>argv</i>) +<p> + Function to create the main widget. +</p> +<dl> + +<dt><i>argv</i></dt> +<dd> +list of commandline parameters (list of strings) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the main widget (QWidget) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.eric7_snap.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.eric7_snap.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createMainWidget">createMainWidget</a></td> -<td></td> +<td>Function to create the main widget.</td> </tr> <tr> <td><a href="#main">main</a></td> @@ -44,6 +44,22 @@ <h2>createMainWidget</h2> <b>createMainWidget</b>(<i>argv</i>) +<p> + Function to create the main widget. +</p> +<dl> + +<dt><i>argv</i></dt> +<dd> +list of commandline parameters (list of strings) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the main widget (QWidget) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.eric7_tray.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.eric7_tray.html Fri Oct 27 14:09:40 2023 +0200 @@ -32,7 +32,7 @@ <tr> <td><a href="#createMainWidget">createMainWidget</a></td> -<td></td> +<td>Function to create the main widget.</td> </tr> <tr> <td><a href="#main">main</a></td> @@ -45,6 +45,22 @@ <h2>createMainWidget</h2> <b>createMainWidget</b>(<i>argv</i>) +<p> + Function to create the main widget. +</p> +<dl> + +<dt><i>argv</i></dt> +<dd> +list of commandline parameters (list of strings) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the main widget (QWidget) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/eric7.eric7_virtualenv.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.eric7_virtualenv.html Fri Oct 27 14:09:40 2023 +0200 @@ -31,7 +31,7 @@ <tr> <td><a href="#createMainWidget">createMainWidget</a></td> -<td></td> +<td>Function to create the main widget.</td> </tr> <tr> <td><a href="#main">main</a></td> @@ -44,6 +44,28 @@ <h2>createMainWidget</h2> <b>createMainWidget</b>(<i>argv</i>) +<p> + Function to create the main widget. +</p> +<dl> + +<dt><i>argv</i> (list of str)</dt> +<dd> +list of commandline parameters +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the main widget +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QWidget +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/src/eric7/Documentation/Source/index-eric7.Plugins.WizardPlugins.EricPluginWizard.html Fri Oct 27 14:07:03 2023 +0200 +++ b/src/eric7/Documentation/Source/index-eric7.Plugins.WizardPlugins.EricPluginWizard.html Fri Oct 27 14:09:40 2023 +0200 @@ -21,7 +21,7 @@ </tr> <tr> <td><a href="eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html">Templates</a></td> -<td>Module implementing the various plug-in templates.</td> +<td>Class documentation goes here.</td> </tr> </table> </body></html> \ No newline at end of file