--- 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
