diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.UI.FindFileWidget.html
--- a/src/eric7/Documentation/Source/eric7.UI.FindFileWidget.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.UI.FindFileWidget.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.UI.FindFileWidget</h1>
-
<p>
Module implementing a dialog to search for text in files.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<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>
@@ -29,16 +27,16 @@
<td>Class implementing a widget to search for text in files and replace it with some other text.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</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.
@@ -51,6 +49,7 @@
be authorized by ticking them on. Pressing the replace button performs
all ticked replacement operations.
</p>
+
<h3>Signals</h3>
<dl>
@@ -87,19 +86,17 @@
<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>
@@ -113,19 +110,20 @@
<td>Public method to populate the search file categories list.</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>
@@ -140,11 +138,11 @@
<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>
@@ -168,16 +166,15 @@
<a NAME="FindFileDialog.populateFileCategories" ID="FindFileDialog.populateFileCategories"></a>
<h4>FindFileDialog.populateFileCategories</h4>
<b>populateFileCategories</b>(<i></i>)
-
<p>
Public method to populate the search file categories list.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="FindFileWidget" ID="FindFileWidget"></a>
<h2>FindFileWidget</h2>
-
<p>
Class implementing a widget to search for text in files and replace it
with some other text.
@@ -190,6 +187,7 @@
be authorized by ticking them on. Pressing the replace button performs
all ticked replacement operations.
</p>
+
<h3>Signals</h3>
<dl>
@@ -226,19 +224,21 @@
<h3>Derived from</h3>
QWidget, Ui_FindFileWidget
<h3>Class Attributes</h3>
+<table>
+<tr><td>endRole</td></tr>
+<tr><td>lineRole</td></tr>
+<tr><td>md5Role</td></tr>
+<tr><td>replaceRole</td></tr>
+<tr><td>startRole</td></tr>
+</table>
-<table>
-<tr><td>endRole</td></tr><tr><td>lineRole</td></tr><tr><td>md5Role</td></tr><tr><td>replaceRole</td></tr><tr><td>startRole</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#FindFileWidget.__init__">FindFileWidget</a></td>
<td>Constructor</td>
@@ -368,19 +368,20 @@
<td>Public method to populate the search file categories list.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="FindFileWidget.__init__" ID="FindFileWidget.__init__"></a>
<h4>FindFileWidget (Constructor)</h4>
<b>FindFileWidget</b>(<i>project, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>project</i> (Project)</dt>
@@ -395,17 +396,17 @@
<a NAME="FindFileWidget.__clearResults" ID="FindFileWidget.__clearResults"></a>
<h4>FindFileWidget.__clearResults</h4>
<b>__clearResults</b>(<i></i>)
-
<p>
Private slot to clear the current search results.
</p>
+
<a NAME="FindFileWidget.__contextMenuRequested" ID="FindFileWidget.__contextMenuRequested"></a>
<h4>FindFileWidget.__contextMenuRequested</h4>
<b>__contextMenuRequested</b>(<i>pos</i>)
-
<p>
Private slot to handle the context menu request.
</p>
+
<dl>
<dt><i>pos</i> (QPoint)</dt>
@@ -416,17 +417,17 @@
<a NAME="FindFileWidget.__copyToClipboard" ID="FindFileWidget.__copyToClipboard"></a>
<h4>FindFileWidget.__copyToClipboard</h4>
<b>__copyToClipboard</b>(<i></i>)
-
<p>
Private slot to copy the path of an entry to the clipboard.
</p>
+
<a NAME="FindFileWidget.__createItem" ID="FindFileWidget.__createItem"></a>
<h4>FindFileWidget.__createItem</h4>
<b>__createItem</b>(<i>file, line, text, start, end, replTxt="", md5=""</i>)
-
<p>
Private method to create an entry in the file list.
</p>
+
<dl>
<dt><i>file</i> (str)</dt>
@@ -461,31 +462,31 @@
<a NAME="FindFileWidget.__deselectAll" ID="FindFileWidget.__deselectAll"></a>
<h4>FindFileWidget.__deselectAll</h4>
<b>__deselectAll</b>(<i></i>)
-
<p>
Private slot to deselect all entries.
</p>
+
<a NAME="FindFileWidget.__doSearch" ID="FindFileWidget.__doSearch"></a>
<h4>FindFileWidget.__doSearch</h4>
<b>__doSearch</b>(<i></i>)
-
<p>
Private slot to handle the find button being pressed.
</p>
+
<a NAME="FindFileWidget.__enableFindButton" ID="FindFileWidget.__enableFindButton"></a>
<h4>FindFileWidget.__enableFindButton</h4>
<b>__enableFindButton</b>(<i></i>)
-
<p>
Private slot called to enable the find button.
</p>
+
<a NAME="FindFileWidget.__getFileList" ID="FindFileWidget.__getFileList"></a>
<h4>FindFileWidget.__getFileList</h4>
<b>__getFileList</b>(<i>path, filterRe, excludeHiddenDirs=False, excludeHiddenFiles=False</i>)
-
<p>
Private method to get a list of files to search.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -521,31 +522,31 @@
<a NAME="FindFileWidget.__openFile" ID="FindFileWidget.__openFile"></a>
<h4>FindFileWidget.__openFile</h4>
<b>__openFile</b>(<i></i>)
-
<p>
Private slot to open the currently selected entry.
</p>
+
<a NAME="FindFileWidget.__projectClosed" ID="FindFileWidget.__projectClosed"></a>
<h4>FindFileWidget.__projectClosed</h4>
<b>__projectClosed</b>(<i></i>)
-
<p>
Private slot to react to the closing of a project.
</p>
+
<a NAME="FindFileWidget.__projectOpened" ID="FindFileWidget.__projectOpened"></a>
<h4>FindFileWidget.__projectOpened</h4>
<b>__projectOpened</b>(<i></i>)
-
<p>
Private slot to react to the opening of a project.
</p>
+
<a NAME="FindFileWidget.__selectAll" ID="FindFileWidget.__selectAll"></a>
<h4>FindFileWidget.__selectAll</h4>
<b>__selectAll</b>(<i>check=True</i>)
-
<p>
Private slot to select all entries.
</p>
+
<dl>
<dt><i>check</i> (bool (optional))</dt>
@@ -556,17 +557,17 @@
<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>
@@ -577,17 +578,17 @@
<a NAME="FindFileWidget.__stopSearch" ID="FindFileWidget.__stopSearch"></a>
<h4>FindFileWidget.__stopSearch</h4>
<b>__stopSearch</b>(<i></i>)
-
<p>
Private slot to handle the stop button being pressed.
</p>
+
<a NAME="FindFileWidget.__stripEol" ID="FindFileWidget.__stripEol"></a>
<h4>FindFileWidget.__stripEol</h4>
<b>__stripEol</b>(<i>txt</i>)
-
<p>
Private method to strip the eol part.
</p>
+
<dl>
<dt><i>txt</i> (str)</dt>
@@ -610,18 +611,18 @@
<a NAME="FindFileWidget.__toggleReplaceMode" ID="FindFileWidget.__toggleReplaceMode"></a>
<h4>FindFileWidget.__toggleReplaceMode</h4>
<b>__toggleReplaceMode</b>(<i></i>)
-
<p>
Private slot to toggle the dialog mode.
</p>
+
<a NAME="FindFileWidget.activate" ID="FindFileWidget.activate"></a>
<h4>FindFileWidget.activate</h4>
<b>activate</b>(<i>replaceMode=False, txt="", searchDir="", openFiles=False</i>)
-
<p>
Public method to activate the widget with a given mode, a text
to search for and some search parameters.
</p>
+
<dl>
<dt><i>replaceMode</i> (bool (optional))</dt>
@@ -645,18 +646,18 @@
<a NAME="FindFileWidget.on_dirButton_clicked" ID="FindFileWidget.on_dirButton_clicked"></a>
<h4>FindFileWidget.on_dirButton_clicked</h4>
<b>on_dirButton_clicked</b>(<i></i>)
-
<p>
Private slot to handle the selection of the 'Directory' radio button.
</p>
+
<a NAME="FindFileWidget.on_dirPicker_editTextChanged" ID="FindFileWidget.on_dirPicker_editTextChanged"></a>
<h4>FindFileWidget.on_dirPicker_editTextChanged</h4>
<b>on_dirPicker_editTextChanged</b>(<i>text</i>)
-
<p>
Private slot to handle the textChanged signal of the directory
picker.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -667,10 +668,10 @@
<a NAME="FindFileWidget.on_escapeToolButton_toggled" ID="FindFileWidget.on_escapeToolButton_toggled"></a>
<h4>FindFileWidget.on_escapeToolButton_toggled</h4>
<b>on_escapeToolButton_toggled</b>(<i>checked</i>)
-
<p>
Private slot handling a change of the escape selector.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -681,17 +682,17 @@
<a NAME="FindFileWidget.on_filterCheckBox_clicked" ID="FindFileWidget.on_filterCheckBox_clicked"></a>
<h4>FindFileWidget.on_filterCheckBox_clicked</h4>
<b>on_filterCheckBox_clicked</b>(<i></i>)
-
<p>
Private slot to handle the selection of the file filter check box.
</p>
+
<a NAME="FindFileWidget.on_filterEdit_textEdited" ID="FindFileWidget.on_filterEdit_textEdited"></a>
<h4>FindFileWidget.on_filterEdit_textEdited</h4>
<b>on_filterEdit_textEdited</b>(<i>text</i>)
-
<p>
Private slot to handle the textChanged signal of the file filter edit.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -702,13 +703,13 @@
<a NAME="FindFileWidget.on_findList_itemDoubleClicked" ID="FindFileWidget.on_findList_itemDoubleClicked"></a>
<h4>FindFileWidget.on_findList_itemDoubleClicked</h4>
<b>on_findList_itemDoubleClicked</b>(<i>itm, column</i>)
-
<p>
Private slot to handle the double click on a file item.
</p>
<p>
It emits a signal depending on the file extension.
</p>
+
<dl>
<dt><i>itm</i> (QTreeWidgetItem)</dt>
@@ -723,11 +724,11 @@
<a NAME="FindFileWidget.on_findtextCombo_editTextChanged" ID="FindFileWidget.on_findtextCombo_editTextChanged"></a>
<h4>FindFileWidget.on_findtextCombo_editTextChanged</h4>
<b>on_findtextCombo_editTextChanged</b>(<i>text</i>)
-
<p>
Private slot to handle the editTextChanged signal of the find
text combo.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -738,24 +739,24 @@
<a NAME="FindFileWidget.on_openFilesButton_clicked" ID="FindFileWidget.on_openFilesButton_clicked"></a>
<h4>FindFileWidget.on_openFilesButton_clicked</h4>
<b>on_openFilesButton_clicked</b>(<i></i>)
-
<p>
Private slot to handle the selection of the 'Open Files' radio button.
</p>
+
<a NAME="FindFileWidget.on_projectButton_clicked" ID="FindFileWidget.on_projectButton_clicked"></a>
<h4>FindFileWidget.on_projectButton_clicked</h4>
<b>on_projectButton_clicked</b>(<i></i>)
-
<p>
Private slot to handle the selection of the 'Project' radio button.
</p>
+
<a NAME="FindFileWidget.on_regexpToolButton_toggled" ID="FindFileWidget.on_regexpToolButton_toggled"></a>
<h4>FindFileWidget.on_regexpToolButton_toggled</h4>
<b>on_regexpToolButton_toggled</b>(<i>checked</i>)
-
<p>
Private slot handling a change of the regexp selector.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -766,18 +767,18 @@
<a NAME="FindFileWidget.on_replaceButton_clicked" ID="FindFileWidget.on_replaceButton_clicked"></a>
<h4>FindFileWidget.on_replaceButton_clicked</h4>
<b>on_replaceButton_clicked</b>(<i></i>)
-
<p>
Private slot to perform the requested replace actions.
</p>
+
<a NAME="FindFileWidget.on_replacetextCombo_editTextChanged" ID="FindFileWidget.on_replacetextCombo_editTextChanged"></a>
<h4>FindFileWidget.on_replacetextCombo_editTextChanged</h4>
<b>on_replacetextCombo_editTextChanged</b>(<i>text</i>)
-
<p>
Private slot to handle the editTextChanged signal of the replace
text combo.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -788,10 +789,10 @@
<a NAME="FindFileWidget.populateFileCategories" ID="FindFileWidget.populateFileCategories"></a>
<h4>FindFileWidget.populateFileCategories</h4>
<b>populateFileCategories</b>(<i></i>)
-
<p>
Public method to populate the search file categories list.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
