Updated source documentation. eric7

Fri, 29 Apr 2022 17:58:57 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 29 Apr 2022 17:58:57 +0200
branch
eric7
changeset 9042
d08cf11928a4
parent 9041
4f598360a94a
child 9043
592e5feecf83

Updated source documentation.

eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
eric7/APIs/Python3/eric7.bas file | annotate | diff | comparison | revisions
eric7/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
eric7/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
eric7/Documentation/Source/eric7.UI.FindFileWidget.html file | annotate | diff | comparison | revisions
eric7/Documentation/Source/eric7.UI.FindLocationWidget.html file | annotate | diff | comparison | revisions
--- a/eric7/APIs/Python3/eric7.api	Fri Apr 29 17:53:51 2022 +0200
+++ b/eric7/APIs/Python3/eric7.api	Fri Apr 29 17:58:57 2022 +0200
@@ -9555,6 +9555,15 @@
 eric7.UI.ErrorLogDialog.ErrorLogDialog.on_emailButton_clicked?4()
 eric7.UI.ErrorLogDialog.ErrorLogDialog.on_keepButton_clicked?4()
 eric7.UI.ErrorLogDialog.ErrorLogDialog?1(logFile, showMode, parent=None)
+eric7.UI.FindFileWidget.FindFileDialog.activate?4(replaceMode=False, txt="", searchDir="", openFiles=False)
+eric7.UI.FindFileWidget.FindFileDialog.designerFile?7
+eric7.UI.FindFileWidget.FindFileDialog.linguistFile?7
+eric7.UI.FindFileWidget.FindFileDialog.pixmapFile?7
+eric7.UI.FindFileWidget.FindFileDialog.sourceFile?7
+eric7.UI.FindFileWidget.FindFileDialog.svgFile?7
+eric7.UI.FindFileWidget.FindFileDialog.trpreview?7
+eric7.UI.FindFileWidget.FindFileDialog.umlFile?7
+eric7.UI.FindFileWidget.FindFileDialog?1(project, parent=None)
 eric7.UI.FindFileWidget.FindFileWidget.activate?4(replaceMode=False, txt="", searchDir="", openFiles=False)
 eric7.UI.FindFileWidget.FindFileWidget.designerFile?7
 eric7.UI.FindFileWidget.FindFileWidget.endRole?7
@@ -9573,14 +9582,21 @@
 eric7.UI.FindFileWidget.FindFileWidget.on_replacetextCombo_editTextChanged?4(text)
 eric7.UI.FindFileWidget.FindFileWidget.pixmapFile?7
 eric7.UI.FindFileWidget.FindFileWidget.replaceRole?7
-eric7.UI.FindFileWidget.FindFileWidget.setOpenFiles?4()
-eric7.UI.FindFileWidget.FindFileWidget.setSearchDirectory?4(searchDir)
 eric7.UI.FindFileWidget.FindFileWidget.sourceFile?7
 eric7.UI.FindFileWidget.FindFileWidget.startRole?7
 eric7.UI.FindFileWidget.FindFileWidget.svgFile?7
 eric7.UI.FindFileWidget.FindFileWidget.trpreview?7
 eric7.UI.FindFileWidget.FindFileWidget.umlFile?7
 eric7.UI.FindFileWidget.FindFileWidget?1(project, parent=None)
+eric7.UI.FindLocationWidget.FindLocationDialog.activate?4()
+eric7.UI.FindLocationWidget.FindLocationDialog.designerFile?7
+eric7.UI.FindLocationWidget.FindLocationDialog.linguistFile?7
+eric7.UI.FindLocationWidget.FindLocationDialog.pixmapFile?7
+eric7.UI.FindLocationWidget.FindLocationDialog.sourceFile?7
+eric7.UI.FindLocationWidget.FindLocationDialog.svgFile?7
+eric7.UI.FindLocationWidget.FindLocationDialog.trpreview?7
+eric7.UI.FindLocationWidget.FindLocationDialog.umlFile?7
+eric7.UI.FindLocationWidget.FindLocationDialog?1(project, parent=None)
 eric7.UI.FindLocationWidget.FindLocationWidget.activate?4()
 eric7.UI.FindLocationWidget.FindLocationWidget.checkStop?4()
 eric7.UI.FindLocationWidget.FindLocationWidget.designerFile?7
--- a/eric7/APIs/Python3/eric7.bas	Fri Apr 29 17:53:51 2022 +0200
+++ b/eric7/APIs/Python3/eric7.bas	Fri Apr 29 17:58:57 2022 +0200
@@ -332,7 +332,9 @@
 FileDialogWizardDialog QDialog Ui_FileDialogWizardDialog
 FileReport BaseReport
 FiletypeAssociationDialog QDialog Ui_FiletypeAssociationDialog
+FindFileDialog QDialog
 FindFileWidget QWidget Ui_FindFileWidget
+FindLocationDialog QDialog
 FindLocationWidget QWidget Ui_FindLocationWidget
 FirefoxImporter BookmarksImporter
 FontDialogOptionsDialog QDialog Ui_FontDialogOptionsDialog
Binary file eric7/Documentation/Help/source.qch has changed
--- a/eric7/Documentation/Help/source.qhp	Fri Apr 29 17:53:51 2022 +0200
+++ b/eric7/Documentation/Help/source.qhp	Fri Apr 29 17:58:57 2022 +0200
@@ -6023,6 +6023,9 @@
       <keyword name="FiletypeAssociationDialog.on_filePatternEdit_textChanged" id="FiletypeAssociationDialog.on_filePatternEdit_textChanged" ref="eric7.Project.FiletypeAssociationDialog.html#FiletypeAssociationDialog.on_filePatternEdit_textChanged" />
       <keyword name="FiletypeAssociationDialog.on_filetypeAssociationList_currentItemChanged" id="FiletypeAssociationDialog.on_filetypeAssociationList_currentItemChanged" ref="eric7.Project.FiletypeAssociationDialog.html#FiletypeAssociationDialog.on_filetypeAssociationList_currentItemChanged" />
       <keyword name="FiletypeAssociationDialog.transferData" id="FiletypeAssociationDialog.transferData" ref="eric7.Project.FiletypeAssociationDialog.html#FiletypeAssociationDialog.transferData" />
+      <keyword name="FindFileDialog" id="FindFileDialog" ref="eric7.UI.FindFileWidget.html#FindFileDialog" />
+      <keyword name="FindFileDialog (Constructor)" id="FindFileDialog (Constructor)" ref="eric7.UI.FindFileWidget.html#FindFileDialog.__init__" />
+      <keyword name="FindFileDialog.activate" id="FindFileDialog.activate" ref="eric7.UI.FindFileWidget.html#FindFileDialog.activate" />
       <keyword name="FindFileWidget" id="FindFileWidget" ref="eric7.UI.FindFileWidget.html#FindFileWidget" />
       <keyword name="FindFileWidget (Constructor)" id="FindFileWidget (Constructor)" ref="eric7.UI.FindFileWidget.html#FindFileWidget.__init__" />
       <keyword name="FindFileWidget (Module)" id="FindFileWidget (Module)" ref="eric7.UI.FindFileWidget.html" />
@@ -6036,6 +6039,8 @@
       <keyword name="FindFileWidget.__openFile" id="FindFileWidget.__openFile" ref="eric7.UI.FindFileWidget.html#FindFileWidget.__openFile" />
       <keyword name="FindFileWidget.__projectClosed" id="FindFileWidget.__projectClosed" ref="eric7.UI.FindFileWidget.html#FindFileWidget.__projectClosed" />
       <keyword name="FindFileWidget.__projectOpened" id="FindFileWidget.__projectOpened" ref="eric7.UI.FindFileWidget.html#FindFileWidget.__projectOpened" />
+      <keyword name="FindFileWidget.__setOpenFiles" id="FindFileWidget.__setOpenFiles" ref="eric7.UI.FindFileWidget.html#FindFileWidget.__setOpenFiles" />
+      <keyword name="FindFileWidget.__setSearchDirectory" id="FindFileWidget.__setSearchDirectory" ref="eric7.UI.FindFileWidget.html#FindFileWidget.__setSearchDirectory" />
       <keyword name="FindFileWidget.__stopSearch" id="FindFileWidget.__stopSearch" ref="eric7.UI.FindFileWidget.html#FindFileWidget.__stopSearch" />
       <keyword name="FindFileWidget.__stripEol" id="FindFileWidget.__stripEol" ref="eric7.UI.FindFileWidget.html#FindFileWidget.__stripEol" />
       <keyword name="FindFileWidget.__toggleReplaceMode" id="FindFileWidget.__toggleReplaceMode" ref="eric7.UI.FindFileWidget.html#FindFileWidget.__toggleReplaceMode" />
@@ -6050,8 +6055,9 @@
       <keyword name="FindFileWidget.on_projectButton_clicked" id="FindFileWidget.on_projectButton_clicked" ref="eric7.UI.FindFileWidget.html#FindFileWidget.on_projectButton_clicked" />
       <keyword name="FindFileWidget.on_replaceButton_clicked" id="FindFileWidget.on_replaceButton_clicked" ref="eric7.UI.FindFileWidget.html#FindFileWidget.on_replaceButton_clicked" />
       <keyword name="FindFileWidget.on_replacetextCombo_editTextChanged" id="FindFileWidget.on_replacetextCombo_editTextChanged" ref="eric7.UI.FindFileWidget.html#FindFileWidget.on_replacetextCombo_editTextChanged" />
-      <keyword name="FindFileWidget.setOpenFiles" id="FindFileWidget.setOpenFiles" ref="eric7.UI.FindFileWidget.html#FindFileWidget.setOpenFiles" />
-      <keyword name="FindFileWidget.setSearchDirectory" id="FindFileWidget.setSearchDirectory" ref="eric7.UI.FindFileWidget.html#FindFileWidget.setSearchDirectory" />
+      <keyword name="FindLocationDialog" id="FindLocationDialog" ref="eric7.UI.FindLocationWidget.html#FindLocationDialog" />
+      <keyword name="FindLocationDialog (Constructor)" id="FindLocationDialog (Constructor)" ref="eric7.UI.FindLocationWidget.html#FindLocationDialog.__init__" />
+      <keyword name="FindLocationDialog.activate" id="FindLocationDialog.activate" ref="eric7.UI.FindLocationWidget.html#FindLocationDialog.activate" />
       <keyword name="FindLocationWidget" id="FindLocationWidget" ref="eric7.UI.FindLocationWidget.html#FindLocationWidget" />
       <keyword name="FindLocationWidget (Constructor)" id="FindLocationWidget (Constructor)" ref="eric7.UI.FindLocationWidget.html#FindLocationWidget.__init__" />
       <keyword name="FindLocationWidget (Module)" id="FindLocationWidget (Module)" ref="eric7.UI.FindLocationWidget.html" />
--- a/eric7/Documentation/Source/eric7.UI.FindFileWidget.html	Fri Apr 29 17:53:51 2022 +0200
+++ b/eric7/Documentation/Source/eric7.UI.FindFileWidget.html	Fri Apr 29 17:58:57 2022 +0200
@@ -21,6 +21,10 @@
 <table>
 
 <tr>
+<td><a href="#FindFileDialog">FindFileDialog</a></td>
+<td>Class implementing a dialog to search for text in files and replace it with some other text.</td>
+</tr>
+<tr>
 <td><a href="#FindFileWidget">FindFileWidget</a></td>
 <td>Class implementing a widget to search for text in files and replace it with some other text.</td>
 </tr>
@@ -32,6 +36,134 @@
 </table>
 <hr />
 <hr />
+<a NAME="FindFileDialog" ID="FindFileDialog"></a>
+<h2>FindFileDialog</h2>
+
+<p>
+    Class implementing a dialog to search for text in files and replace it
+    with some other text.
+</p>
+<p>
+    The occurrences found are displayed in a tree showing the file name,
+    the line number and the text found. The file will be opened upon a double
+    click onto the respective entry of the list. If the widget is in replace
+    mode the line below shows the text after replacement. Replacements can
+    be authorized by ticking them on. Pressing the replace button performs
+    all ticked replacement operations.
+</p>
+<h3>Signals</h3>
+<dl>
+
+<dt>designerFile(str)</dt>
+<dd>
+emitted to open a Qt-Designer file
+</dd>
+<dt>linguistFile(str)</dt>
+<dd>
+emitted to open a Qt-Linguist (*.ts) file
+</dd>
+<dt>pixmapFile(str)</dt>
+<dd>
+emitted to open a pixmap file
+</dd>
+<dt>sourceFile(str, int, str, int, int)</dt>
+<dd>
+emitted to open a source file
+        at a specificline
+</dd>
+<dt>svgFile(str)</dt>
+<dd>
+emitted to open a SVG file
+</dd>
+<dt>trpreview([str])</dt>
+<dd>
+emitted to preview Qt-Linguist (*.qm) files
+</dd>
+<dt>umlFile(str)</dt>
+<dd>
+emitted to open an eric UML file
+</dd>
+</dl>
+<h3>Derived from</h3>
+QDialog
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#FindFileDialog.__init__">FindFileDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#FindFileDialog.activate">activate</a></td>
+<td>Public method to activate the dialog with a given mode, a text to search for and some search parameters.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="FindFileDialog.__init__" ID="FindFileDialog.__init__"></a>
+<h4>FindFileDialog (Constructor)</h4>
+<b>FindFileDialog</b>(<i>project, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>project</i> (Project)</dt>
+<dd>
+reference to the project object
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+parent widget of this dialog (defaults to None)
+</dd>
+</dl>
+<a NAME="FindFileDialog.activate" ID="FindFileDialog.activate"></a>
+<h4>FindFileDialog.activate</h4>
+<b>activate</b>(<i>replaceMode=False, txt="", searchDir="", openFiles=False</i>)
+
+<p>
+        Public method to activate the dialog with a given mode, a text
+        to search for and some search parameters.
+</p>
+<dl>
+
+<dt><i>replaceMode</i> (bool (optional))</dt>
+<dd>
+flag indicating replacement mode (defaults to False)
+</dd>
+<dt><i>txt</i> (str (optional))</dt>
+<dd>
+text to be searched for (defaults to "")
+</dd>
+<dt><i>searchDir</i> (str (optional))</dt>
+<dd>
+directory to search in (defaults to "")
+</dd>
+<dt><i>openFiles</i> (bool (optional))</dt>
+<dd>
+flag indicating to operate on open files only
+            (defaults to False)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
 <a NAME="FindFileWidget" ID="FindFileWidget"></a>
 <h2>FindFileWidget</h2>
 
@@ -141,6 +273,14 @@
 <td>Private slot to react to the opening of a project.</td>
 </tr>
 <tr>
+<td><a href="#FindFileWidget.__setOpenFiles">__setOpenFiles</a></td>
+<td>Private slot to set the mode to search in open files.</td>
+</tr>
+<tr>
+<td><a href="#FindFileWidget.__setSearchDirectory">__setSearchDirectory</a></td>
+<td>Private slot to set the name of the directory to search in.</td>
+</tr>
+<tr>
 <td><a href="#FindFileWidget.__stopSearch">__stopSearch</a></td>
 <td>Private slot to handle the stop button being pressed.</td>
 </tr>
@@ -196,14 +336,6 @@
 <td><a href="#FindFileWidget.on_replacetextCombo_editTextChanged">on_replacetextCombo_editTextChanged</a></td>
 <td>Private slot to handle the editTextChanged signal of the replace text combo.</td>
 </tr>
-<tr>
-<td><a href="#FindFileWidget.setOpenFiles">setOpenFiles</a></td>
-<td>Public slot to set the mode to search in open files.</td>
-</tr>
-<tr>
-<td><a href="#FindFileWidget.setSearchDirectory">setSearchDirectory</a></td>
-<td>Public slot to set the name of the directory to search in.</td>
-</tr>
 </table>
 <h3>Static Methods</h3>
 
@@ -369,6 +501,27 @@
 <p>
         Private slot to react to the opening of a project.
 </p>
+<a NAME="FindFileWidget.__setOpenFiles" ID="FindFileWidget.__setOpenFiles"></a>
+<h4>FindFileWidget.__setOpenFiles</h4>
+<b>__setOpenFiles</b>(<i></i>)
+
+<p>
+        Private slot to set the mode to search in open files.
+</p>
+<a NAME="FindFileWidget.__setSearchDirectory" ID="FindFileWidget.__setSearchDirectory"></a>
+<h4>FindFileWidget.__setSearchDirectory</h4>
+<b>__setSearchDirectory</b>(<i>searchDir</i>)
+
+<p>
+        Private slot to set the name of the directory to search in.
+</p>
+<dl>
+
+<dt><i>searchDir</i> (str)</dt>
+<dd>
+name of the directory to search in
+</dd>
+</dl>
 <a NAME="FindFileWidget.__stopSearch" ID="FindFileWidget.__stopSearch"></a>
 <h4>FindFileWidget.__stopSearch</h4>
 <b>__stopSearch</b>(<i></i>)
@@ -552,27 +705,6 @@
 (ignored)
 </dd>
 </dl>
-<a NAME="FindFileWidget.setOpenFiles" ID="FindFileWidget.setOpenFiles"></a>
-<h4>FindFileWidget.setOpenFiles</h4>
-<b>setOpenFiles</b>(<i></i>)
-
-<p>
-        Public slot to set the mode to search in open files.
-</p>
-<a NAME="FindFileWidget.setSearchDirectory" ID="FindFileWidget.setSearchDirectory"></a>
-<h4>FindFileWidget.setSearchDirectory</h4>
-<b>setSearchDirectory</b>(<i>searchDir</i>)
-
-<p>
-        Public slot to set the name of the directory to search in.
-</p>
-<dl>
-
-<dt><i>searchDir</i> (str)</dt>
-<dd>
-name of the directory to search in
-</dd>
-</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file
--- a/eric7/Documentation/Source/eric7.UI.FindLocationWidget.html	Fri Apr 29 17:53:51 2022 +0200
+++ b/eric7/Documentation/Source/eric7.UI.FindLocationWidget.html	Fri Apr 29 17:58:57 2022 +0200
@@ -21,6 +21,10 @@
 <table>
 
 <tr>
+<td><a href="#FindLocationDialog">FindLocationDialog</a></td>
+<td>Class implementing a dialog to search for files.</td>
+</tr>
+<tr>
 <td><a href="#FindLocationWidget">FindLocationWidget</a></td>
 <td>Class implementing a widget to search for files.</td>
 </tr>
@@ -32,6 +36,108 @@
 </table>
 <hr />
 <hr />
+<a NAME="FindLocationDialog" ID="FindLocationDialog"></a>
+<h2>FindLocationDialog</h2>
+
+<p>
+    Class implementing a dialog to search for files.
+</p>
+<p>
+    The occurrences found are displayed in a QTreeWidget showing the
+    filename and the pathname. The file will be opened upon a double click
+    onto the respective entry of the list or by pressing the open button.
+</p>
+<h3>Signals</h3>
+<dl>
+
+<dt>designerFile(str)</dt>
+<dd>
+emitted to open a Qt-Designer file
+</dd>
+<dt>linguistFile(str)</dt>
+<dd>
+emitted to open a Qt-Linguist (*.ts) file
+</dd>
+<dt>pixmapFile(str)</dt>
+<dd>
+emitted to open a pixmap file
+</dd>
+<dt>sourceFile(str)</dt>
+<dd>
+emitted to open a file in the editor
+</dd>
+<dt>svgFile(str)</dt>
+<dd>
+emitted to open a SVG file
+</dd>
+<dt>trpreview([str])</dt>
+<dd>
+emitted to preview Qt-Linguist (*.qm) files
+</dd>
+<dt>umlFile(str)</dt>
+<dd>
+emitted to open an eric UML file
+</dd>
+</dl>
+<h3>Derived from</h3>
+QDialog
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#FindLocationDialog.__init__">FindLocationDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#FindLocationDialog.activate">activate</a></td>
+<td>Public method to activate the dialog.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="FindLocationDialog.__init__" ID="FindLocationDialog.__init__"></a>
+<h4>FindLocationDialog (Constructor)</h4>
+<b>FindLocationDialog</b>(<i>project, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>project</i> (Project)</dt>
+<dd>
+reference to the project object
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+parent widget of this dialog (defaults to None)
+</dd>
+</dl>
+<a NAME="FindLocationDialog.activate" ID="FindLocationDialog.activate"></a>
+<h4>FindLocationDialog.activate</h4>
+<b>activate</b>(<i></i>)
+
+<p>
+        Public method to activate the dialog.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
 <a NAME="FindLocationWidget" ID="FindLocationWidget"></a>
 <h2>FindLocationWidget</h2>
 
@@ -121,7 +227,7 @@
 </tr>
 <tr>
 <td><a href="#FindLocationWidget.activate">activate</a></td>
-<td>Public slot to enable/disable the project checkbox.</td>
+<td>Public slot to activate this widget.</td>
 </tr>
 <tr>
 <td><a href="#FindLocationWidget.checkStop">checkStop</a></td>
@@ -221,7 +327,7 @@
 <b>activate</b>(<i></i>)
 
 <p>
-        Public slot to enable/disable the project checkbox.
+        Public slot to activate this widget.
 </p>
 <a NAME="FindLocationWidget.checkStop" ID="FindLocationWidget.checkStop"></a>
 <h4>FindLocationWidget.checkStop</h4>

eric ide

mercurial