eric7/Documentation/Source/eric7.UI.FindLocationWidget.html

branch
eric7
changeset 8652
8cacde11f4fd
parent 8632
f25cd4b94eb0
child 8877
548d45c3f571
diff -r ce4c3c401482 -r 8cacde11f4fd eric7/Documentation/Source/eric7.UI.FindLocationWidget.html
--- a/eric7/Documentation/Source/eric7.UI.FindLocationWidget.html	Mon Sep 27 16:41:31 2021 +0200
+++ b/eric7/Documentation/Source/eric7.UI.FindLocationWidget.html	Mon Sep 27 16:44:54 2021 +0200
@@ -1,12 +1,12 @@
 <!DOCTYPE html>
 <html><head>
-<title>eric7.UI.FindFileNameDialog</title>
+<title>eric7.UI.FindLocationWidget</title>
 <meta charset="UTF-8">
 <link rel="stylesheet" href="styles.css">
 </head>
 <body>
 <a NAME="top" ID="top"></a>
-<h1>eric7.UI.FindFileNameDialog</h1>
+<h1>eric7.UI.FindLocationWidget</h1>
 
 <p>
 Module implementing a dialog to search for files.
@@ -21,8 +21,8 @@
 <table>
 
 <tr>
-<td><a href="#FindFileNameDialog">FindFileNameDialog</a></td>
-<td>Class implementing a dialog to search for files.</td>
+<td><a href="#FindLocationWidget">FindLocationWidget</a></td>
+<td>Class implementing a widget to search for files.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -32,16 +32,16 @@
 </table>
 <hr />
 <hr />
-<a NAME="FindFileNameDialog" ID="FindFileNameDialog"></a>
-<h2>FindFileNameDialog</h2>
+<a NAME="FindLocationWidget" ID="FindLocationWidget"></a>
+<h2>FindLocationWidget</h2>
 
 <p>
-    Class implementing a dialog to search for files.
+    Class implementing a widget 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.
+    onto the respective entry of the list or by pressing the open button.
 </p>
 <h3>Signals</h3>
 <dl>
@@ -50,13 +50,33 @@
 <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>
-QWidget, Ui_FindFileNameDialog
+QWidget, Ui_FindLocationWidget
 <h3>Class Attributes</h3>
 
 <table>
@@ -72,61 +92,53 @@
 <table>
 
 <tr>
-<td><a href="#FindFileNameDialog.__init__">FindFileNameDialog</a></td>
+<td><a href="#FindLocationWidget.__init__">FindLocationWidget</a></td>
 <td>Constructor</td>
 </tr>
 <tr>
-<td><a href="#FindFileNameDialog.__openFile">__openFile</a></td>
+<td><a href="#FindLocationWidget.__openFile">__openFile</a></td>
 <td>Private slot to open a file.</td>
 </tr>
 <tr>
-<td><a href="#FindFileNameDialog.__searchFile">__searchFile</a></td>
+<td><a href="#FindLocationWidget.__projectClosed">__projectClosed</a></td>
+<td>Private slot to handle a project being closed.</td>
+</tr>
+<tr>
+<td><a href="#FindLocationWidget.__projectOpened">__projectOpened</a></td>
+<td>Private slot to handle a project being opened.</td>
+</tr>
+<tr>
+<td><a href="#FindLocationWidget.__searchFile">__searchFile</a></td>
 <td>Private slot to handle the search.</td>
 </tr>
 <tr>
-<td><a href="#FindFileNameDialog.checkStop">checkStop</a></td>
+<td><a href="#FindLocationWidget.__stopSearch">__stopSearch</a></td>
+<td>Private slot to handle the stop button being pressed.</td>
+</tr>
+<tr>
+<td><a href="#FindLocationWidget.activate">activate</a></td>
+<td>Public slot to enable/disable the project checkbox.</td>
+</tr>
+<tr>
+<td><a href="#FindLocationWidget.checkStop">checkStop</a></td>
 <td>Public method to check, if the search should be stopped.</td>
 </tr>
 <tr>
-<td><a href="#FindFileNameDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
-<td>Private slot called by a button of the button box clicked.</td>
-</tr>
-<tr>
-<td><a href="#FindFileNameDialog.on_fileExtEdit_textChanged">on_fileExtEdit_textChanged</a></td>
-<td>Private slot to handle the textChanged signal of the file extension edit.</td>
-</tr>
-<tr>
-<td><a href="#FindFileNameDialog.on_fileList_currentItemChanged">on_fileList_currentItemChanged</a></td>
+<td><a href="#FindLocationWidget.on_fileList_currentItemChanged">on_fileList_currentItemChanged</a></td>
 <td>Private slot handling a change of the current item.</td>
 </tr>
 <tr>
-<td><a href="#FindFileNameDialog.on_fileList_itemActivated">on_fileList_itemActivated</a></td>
+<td><a href="#FindLocationWidget.on_fileList_itemActivated">on_fileList_itemActivated</a></td>
 <td>Private slot to handle the double click on a file item.</td>
 </tr>
 <tr>
-<td><a href="#FindFileNameDialog.on_fileNameEdit_textChanged">on_fileNameEdit_textChanged</a></td>
+<td><a href="#FindLocationWidget.on_fileNameEdit_textChanged">on_fileNameEdit_textChanged</a></td>
 <td>Private slot to handle the textChanged signal of the file name edit.</td>
 </tr>
 <tr>
-<td><a href="#FindFileNameDialog.on_projectCheckBox_toggled">on_projectCheckBox_toggled</a></td>
-<td>Private slot to handle the toggled signal of the project checkbox.</td>
-</tr>
-<tr>
-<td><a href="#FindFileNameDialog.on_searchDirCheckBox_toggled">on_searchDirCheckBox_toggled</a></td>
-<td>Private slot to handle the toggled signal of the search directory checkbox.</td>
-</tr>
-<tr>
-<td><a href="#FindFileNameDialog.on_searchDirPicker_textChanged">on_searchDirPicker_textChanged</a></td>
+<td><a href="#FindLocationWidget.on_searchDirPicker_textChanged">on_searchDirPicker_textChanged</a></td>
 <td>Private slot to handle the textChanged signal of the search directory edit.</td>
 </tr>
-<tr>
-<td><a href="#FindFileNameDialog.on_syspathCheckBox_toggled">on_syspathCheckBox_toggled</a></td>
-<td>Private slot to handle the toggled signal of the sys.path checkbox.</td>
-</tr>
-<tr>
-<td><a href="#FindFileNameDialog.show">show</a></td>
-<td>Public method to enable/disable the project checkbox.</td>
-</tr>
 </table>
 <h3>Static Methods</h3>
 
@@ -134,51 +146,78 @@
 <tr><td>None</td></tr>
 </table>
 
-<a NAME="FindFileNameDialog.__init__" ID="FindFileNameDialog.__init__"></a>
-<h4>FindFileNameDialog (Constructor)</h4>
-<b>FindFileNameDialog</b>(<i>project, parent=None</i>)
+<a NAME="FindLocationWidget.__init__" ID="FindLocationWidget.__init__"></a>
+<h4>FindLocationWidget (Constructor)</h4>
+<b>FindLocationWidget</b>(<i>project, parent=None</i>)
 
 <p>
         Constructor
 </p>
 <dl>
 
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
 reference to the project object
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget of this dialog (QWidget)
+parent widget of this dialog
 </dd>
 </dl>
-<a NAME="FindFileNameDialog.__openFile" ID="FindFileNameDialog.__openFile"></a>
-<h4>FindFileNameDialog.__openFile</h4>
+<a NAME="FindLocationWidget.__openFile" ID="FindLocationWidget.__openFile"></a>
+<h4>FindLocationWidget.__openFile</h4>
 <b>__openFile</b>(<i>itm=None</i>)
 
 <p>
         Private slot to open a file.
 </p>
 <p>
-        It emits the signal sourceFile or designerFile depending on the
-        file extension.
+        It emits a signal depending on the file extension.
 </p>
 <dl>
 
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (QTreeWidgetItem)</dt>
 <dd>
-item to be opened (QTreeWidgetItem)
+item to be opened
 </dd>
 </dl>
-<a NAME="FindFileNameDialog.__searchFile" ID="FindFileNameDialog.__searchFile"></a>
-<h4>FindFileNameDialog.__searchFile</h4>
+<a NAME="FindLocationWidget.__projectClosed" ID="FindLocationWidget.__projectClosed"></a>
+<h4>FindLocationWidget.__projectClosed</h4>
+<b>__projectClosed</b>(<i></i>)
+
+<p>
+        Private slot to handle a project being closed.
+</p>
+<a NAME="FindLocationWidget.__projectOpened" ID="FindLocationWidget.__projectOpened"></a>
+<h4>FindLocationWidget.__projectOpened</h4>
+<b>__projectOpened</b>(<i></i>)
+
+<p>
+        Private slot to handle a project being opened.
+</p>
+<a NAME="FindLocationWidget.__searchFile" ID="FindLocationWidget.__searchFile"></a>
+<h4>FindLocationWidget.__searchFile</h4>
 <b>__searchFile</b>(<i></i>)
 
 <p>
         Private slot to handle the search.
 </p>
-<a NAME="FindFileNameDialog.checkStop" ID="FindFileNameDialog.checkStop"></a>
-<h4>FindFileNameDialog.checkStop</h4>
+<a NAME="FindLocationWidget.__stopSearch" ID="FindLocationWidget.__stopSearch"></a>
+<h4>FindLocationWidget.__stopSearch</h4>
+<b>__stopSearch</b>(<i></i>)
+
+<p>
+        Private slot to handle the stop button being pressed.
+</p>
+<a NAME="FindLocationWidget.activate" ID="FindLocationWidget.activate"></a>
+<h4>FindLocationWidget.activate</h4>
+<b>activate</b>(<i></i>)
+
+<p>
+        Public slot to enable/disable the project checkbox.
+</p>
+<a NAME="FindLocationWidget.checkStop" ID="FindLocationWidget.checkStop"></a>
+<h4>FindLocationWidget.checkStop</h4>
 <b>checkStop</b>(<i></i>)
 
 <p>
@@ -187,40 +226,17 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating the search should be stopped (boolean)
-</dd>
-</dl>
-<a NAME="FindFileNameDialog.on_buttonBox_clicked" ID="FindFileNameDialog.on_buttonBox_clicked"></a>
-<h4>FindFileNameDialog.on_buttonBox_clicked</h4>
-<b>on_buttonBox_clicked</b>(<i>button</i>)
-
-<p>
-        Private slot called by a button of the button box clicked.
-</p>
-<dl>
-
-<dt><i>button</i></dt>
-<dd>
-button that was clicked (QAbstractButton)
+flag indicating the search should be stopped
 </dd>
 </dl>
-<a NAME="FindFileNameDialog.on_fileExtEdit_textChanged" ID="FindFileNameDialog.on_fileExtEdit_textChanged"></a>
-<h4>FindFileNameDialog.on_fileExtEdit_textChanged</h4>
-<b>on_fileExtEdit_textChanged</b>(<i>text</i>)
-
-<p>
-        Private slot to handle the textChanged signal of the file extension
-        edit.
-</p>
 <dl>
-
-<dt><i>text</i></dt>
+<dt>Return Type:</dt>
 <dd>
-(ignored)
+bool
 </dd>
 </dl>
-<a NAME="FindFileNameDialog.on_fileList_currentItemChanged" ID="FindFileNameDialog.on_fileList_currentItemChanged"></a>
-<h4>FindFileNameDialog.on_fileList_currentItemChanged</h4>
+<a NAME="FindLocationWidget.on_fileList_currentItemChanged" ID="FindLocationWidget.on_fileList_currentItemChanged"></a>
+<h4>FindLocationWidget.on_fileList_currentItemChanged</h4>
 <b>on_fileList_currentItemChanged</b>(<i>current, previous</i>)
 
 <p>
@@ -228,17 +244,17 @@
 </p>
 <dl>
 
-<dt><i>current</i></dt>
+<dt><i>current</i> (QTreeWidgetItem)</dt>
 <dd>
-current item (QTreeWidgetItem)
+current item
 </dd>
-<dt><i>previous</i></dt>
+<dt><i>previous</i> (QTreeWidgetItem)</dt>
 <dd>
-prevoius current item (QTreeWidgetItem)
+prevoius current item
 </dd>
 </dl>
-<a NAME="FindFileNameDialog.on_fileList_itemActivated" ID="FindFileNameDialog.on_fileList_itemActivated"></a>
-<h4>FindFileNameDialog.on_fileList_itemActivated</h4>
+<a NAME="FindLocationWidget.on_fileList_itemActivated" ID="FindLocationWidget.on_fileList_itemActivated"></a>
+<h4>FindLocationWidget.on_fileList_itemActivated</h4>
 <b>on_fileList_itemActivated</b>(<i>itm, column</i>)
 
 <p>
@@ -250,17 +266,17 @@
 </p>
 <dl>
 
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (QTreeWidgetItem)</dt>
 <dd>
-the double clicked listview item (QTreeWidgetItem)
+the double clicked listview item
 </dd>
-<dt><i>column</i></dt>
+<dt><i>column</i> (int)</dt>
 <dd>
-column that was double clicked (integer) (ignored)
+column that was double clicked (ignored)
 </dd>
 </dl>
-<a NAME="FindFileNameDialog.on_fileNameEdit_textChanged" ID="FindFileNameDialog.on_fileNameEdit_textChanged"></a>
-<h4>FindFileNameDialog.on_fileNameEdit_textChanged</h4>
+<a NAME="FindLocationWidget.on_fileNameEdit_textChanged" ID="FindLocationWidget.on_fileNameEdit_textChanged"></a>
+<h4>FindLocationWidget.on_fileNameEdit_textChanged</h4>
 <b>on_fileNameEdit_textChanged</b>(<i>text</i>)
 
 <p>
@@ -268,42 +284,13 @@
 </p>
 <dl>
 
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
 (ignored)
 </dd>
 </dl>
-<a NAME="FindFileNameDialog.on_projectCheckBox_toggled" ID="FindFileNameDialog.on_projectCheckBox_toggled"></a>
-<h4>FindFileNameDialog.on_projectCheckBox_toggled</h4>
-<b>on_projectCheckBox_toggled</b>(<i>checked</i>)
-
-<p>
-        Private slot to handle the toggled signal of the project checkbox.
-</p>
-<dl>
-
-<dt><i>checked</i></dt>
-<dd>
-flag indicating the state of the checkbox (boolean)
-</dd>
-</dl>
-<a NAME="FindFileNameDialog.on_searchDirCheckBox_toggled" ID="FindFileNameDialog.on_searchDirCheckBox_toggled"></a>
-<h4>FindFileNameDialog.on_searchDirCheckBox_toggled</h4>
-<b>on_searchDirCheckBox_toggled</b>(<i>checked</i>)
-
-<p>
-        Private slot to handle the toggled signal of the search directory
-        checkbox.
-</p>
-<dl>
-
-<dt><i>checked</i></dt>
-<dd>
-flag indicating the state of the checkbox (boolean)
-</dd>
-</dl>
-<a NAME="FindFileNameDialog.on_searchDirPicker_textChanged" ID="FindFileNameDialog.on_searchDirPicker_textChanged"></a>
-<h4>FindFileNameDialog.on_searchDirPicker_textChanged</h4>
+<a NAME="FindLocationWidget.on_searchDirPicker_textChanged" ID="FindLocationWidget.on_searchDirPicker_textChanged"></a>
+<h4>FindLocationWidget.on_searchDirPicker_textChanged</h4>
 <b>on_searchDirPicker_textChanged</b>(<i>text</i>)
 
 <p>
@@ -312,32 +299,11 @@
 </p>
 <dl>
 
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-text of the search dir edit (string)
+text of the search dir edit
 </dd>
 </dl>
-<a NAME="FindFileNameDialog.on_syspathCheckBox_toggled" ID="FindFileNameDialog.on_syspathCheckBox_toggled"></a>
-<h4>FindFileNameDialog.on_syspathCheckBox_toggled</h4>
-<b>on_syspathCheckBox_toggled</b>(<i>checked</i>)
-
-<p>
-        Private slot to handle the toggled signal of the sys.path checkbox.
-</p>
-<dl>
-
-<dt><i>checked</i></dt>
-<dd>
-flag indicating the state of the checkbox (boolean)
-</dd>
-</dl>
-<a NAME="FindFileNameDialog.show" ID="FindFileNameDialog.show"></a>
-<h4>FindFileNameDialog.show</h4>
-<b>show</b>(<i></i>)
-
-<p>
-        Public method to enable/disable the project checkbox.
-</p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file

eric ide

mercurial