Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.UI.FindFileNameDialog.html
Documentation/Source/eric5.UI.FindFileNameDialog.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.UI.FindFileNameDialog</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.UI.FindFileNameDialog</h1> | |
| 12 <p> | |
| 13 Module implementing a dialog to search for files. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#FindFileNameDialog">FindFileNameDialog</a></td> | |
| 23 <td>Class implementing a dialog to search for files.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="FindFileNameDialog" ID="FindFileNameDialog"></a> | |
| 32 <h2>FindFileNameDialog</h2> | |
| 33 <p> | |
| 34 Class implementing a dialog to search for files. | |
| 35 </p><p> | |
| 36 The occurrences found are displayed in a QTreeWidget showing the | |
| 37 filename and the pathname. The file will be opened upon a double click | |
| 38 onto the respective entry of the list. | |
| 39 </p><h4>Signals</h4> | |
| 40 <dl> | |
| 41 <dt>designerFile(string)</dt> | |
| 42 <dd> | |
| 43 emitted to open a Qt-Designer file | |
| 44 </dd><dt>sourceFile(string)</dt> | |
| 45 <dd> | |
| 46 emitted to open a file in the editor | |
| 47 </dd> | |
| 48 </dl> | |
| 49 <h3>Derived from</h3> | |
| 50 QWidget, Ui_FindFileNameDialog | |
| 51 <h3>Class Attributes</h3> | |
| 52 <table> | |
| 53 <tr><td>None</td></tr> | |
| 54 </table> | |
| 55 <h3>Methods</h3> | |
| 56 <table> | |
| 57 <tr> | |
| 58 <td><a href="#FindFileNameDialog.__init__">FindFileNameDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr><tr> | |
| 61 <td><a href="#FindFileNameDialog.__openFile">__openFile</a></td> | |
| 62 <td>Private slot to open a file.</td> | |
| 63 </tr><tr> | |
| 64 <td><a href="#FindFileNameDialog.__searchFile">__searchFile</a></td> | |
| 65 <td>Private slot to handle the search.</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#FindFileNameDialog.checkStop">checkStop</a></td> | |
| 68 <td>Public method to check, if the search should be stopped.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#FindFileNameDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 71 <td>Private slot called by a button of the button box clicked.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#FindFileNameDialog.on_fileExtEdit_textChanged">on_fileExtEdit_textChanged</a></td> | |
| 74 <td>Private slot to handle the textChanged signal of the file extension edit.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#FindFileNameDialog.on_fileList_itemActivated">on_fileList_itemActivated</a></td> | |
| 77 <td>Private slot to handle the double click on a file item.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#FindFileNameDialog.on_fileNameEdit_textChanged">on_fileNameEdit_textChanged</a></td> | |
| 80 <td>Private slot to handle the textChanged signal of the file name edit.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#FindFileNameDialog.on_projectCheckBox_toggled">on_projectCheckBox_toggled</a></td> | |
| 83 <td>Private slot to handle the toggled signal of the project checkbox.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#FindFileNameDialog.on_searchDirButton_clicked">on_searchDirButton_clicked</a></td> | |
| 86 <td>Private slot to handle the clicked signal of the search directory selection button.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#FindFileNameDialog.on_searchDirCheckBox_toggled">on_searchDirCheckBox_toggled</a></td> | |
| 89 <td>Private slot to handle the toggled signal of the search directory checkbox.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#FindFileNameDialog.on_searchDirEdit_textChanged">on_searchDirEdit_textChanged</a></td> | |
| 92 <td>Private slot to handle the textChanged signal of the search directory edit.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#FindFileNameDialog.on_syspathCheckBox_toggled">on_syspathCheckBox_toggled</a></td> | |
| 95 <td>Private slot to handle the toggled signal of the sys.path checkbox.</td> | |
| 96 </tr><tr> | |
| 97 <td><a href="#FindFileNameDialog.show">show</a></td> | |
| 98 <td>Overwritten method to enable/disable the project checkbox.</td> | |
| 99 </tr> | |
| 100 </table> | |
| 101 <a NAME="FindFileNameDialog.__init__" ID="FindFileNameDialog.__init__"></a> | |
| 102 <h4>FindFileNameDialog (Constructor)</h4> | |
| 103 <b>FindFileNameDialog</b>(<i>project, parent = None</i>) | |
| 104 <p> | |
| 105 Constructor | |
| 106 </p><dl> | |
| 107 <dt><i>project</i></dt> | |
| 108 <dd> | |
| 109 reference to the project object | |
| 110 </dd><dt><i>parent</i></dt> | |
| 111 <dd> | |
| 112 parent widget of this dialog (QWidget) | |
| 113 </dd> | |
| 114 </dl><a NAME="FindFileNameDialog.__openFile" ID="FindFileNameDialog.__openFile"></a> | |
| 115 <h4>FindFileNameDialog.__openFile</h4> | |
| 116 <b>__openFile</b>(<i></i>) | |
| 117 <p> | |
| 118 Private slot to open a file. | |
| 119 </p><p> | |
| 120 It emits the signal | |
| 121 sourceFile or designerFile depending on the file extension. | |
| 122 </p><a NAME="FindFileNameDialog.__searchFile" ID="FindFileNameDialog.__searchFile"></a> | |
| 123 <h4>FindFileNameDialog.__searchFile</h4> | |
| 124 <b>__searchFile</b>(<i></i>) | |
| 125 <p> | |
| 126 Private slot to handle the search. | |
| 127 </p><a NAME="FindFileNameDialog.checkStop" ID="FindFileNameDialog.checkStop"></a> | |
| 128 <h4>FindFileNameDialog.checkStop</h4> | |
| 129 <b>checkStop</b>(<i></i>) | |
| 130 <p> | |
| 131 Public method to check, if the search should be stopped. | |
| 132 </p><dl> | |
| 133 <dt>Returns:</dt> | |
| 134 <dd> | |
| 135 flag indicating the search should be stopped (boolean) | |
| 136 </dd> | |
| 137 </dl><a NAME="FindFileNameDialog.on_buttonBox_clicked" ID="FindFileNameDialog.on_buttonBox_clicked"></a> | |
| 138 <h4>FindFileNameDialog.on_buttonBox_clicked</h4> | |
| 139 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 140 <p> | |
| 141 Private slot called by a button of the button box clicked. | |
| 142 </p><dl> | |
| 143 <dt><i>button</i></dt> | |
| 144 <dd> | |
| 145 button that was clicked (QAbstractButton) | |
| 146 </dd> | |
| 147 </dl><a NAME="FindFileNameDialog.on_fileExtEdit_textChanged" ID="FindFileNameDialog.on_fileExtEdit_textChanged"></a> | |
| 148 <h4>FindFileNameDialog.on_fileExtEdit_textChanged</h4> | |
| 149 <b>on_fileExtEdit_textChanged</b>(<i>text</i>) | |
| 150 <p> | |
| 151 Private slot to handle the textChanged signal of the file extension edit. | |
| 152 </p><dl> | |
| 153 <dt><i>text</i></dt> | |
| 154 <dd> | |
| 155 (ignored) | |
| 156 </dd> | |
| 157 </dl><a NAME="FindFileNameDialog.on_fileList_itemActivated" ID="FindFileNameDialog.on_fileList_itemActivated"></a> | |
| 158 <h4>FindFileNameDialog.on_fileList_itemActivated</h4> | |
| 159 <b>on_fileList_itemActivated</b>(<i>itm, column</i>) | |
| 160 <p> | |
| 161 Private slot to handle the double click on a file item. | |
| 162 </p><p> | |
| 163 It emits the signal | |
| 164 sourceFile or designerFile depending on the file extension. | |
| 165 </p><dl> | |
| 166 <dt><i>itm</i></dt> | |
| 167 <dd> | |
| 168 the double clicked listview item (QTreeWidgetItem) | |
| 169 </dd><dt><i>column</i></dt> | |
| 170 <dd> | |
| 171 column that was double clicked (integer) (ignored) | |
| 172 </dd> | |
| 173 </dl><a NAME="FindFileNameDialog.on_fileNameEdit_textChanged" ID="FindFileNameDialog.on_fileNameEdit_textChanged"></a> | |
| 174 <h4>FindFileNameDialog.on_fileNameEdit_textChanged</h4> | |
| 175 <b>on_fileNameEdit_textChanged</b>(<i>text</i>) | |
| 176 <p> | |
| 177 Private slot to handle the textChanged signal of the file name edit. | |
| 178 </p><dl> | |
| 179 <dt><i>text</i></dt> | |
| 180 <dd> | |
| 181 (ignored) | |
| 182 </dd> | |
| 183 </dl><a NAME="FindFileNameDialog.on_projectCheckBox_toggled" ID="FindFileNameDialog.on_projectCheckBox_toggled"></a> | |
| 184 <h4>FindFileNameDialog.on_projectCheckBox_toggled</h4> | |
| 185 <b>on_projectCheckBox_toggled</b>(<i>checked</i>) | |
| 186 <p> | |
| 187 Private slot to handle the toggled signal of the project checkbox. | |
| 188 </p><dl> | |
| 189 <dt><i>checked</i></dt> | |
| 190 <dd> | |
| 191 flag indicating the state of the checkbox (boolean) | |
| 192 </dd> | |
| 193 </dl><a NAME="FindFileNameDialog.on_searchDirButton_clicked" ID="FindFileNameDialog.on_searchDirButton_clicked"></a> | |
| 194 <h4>FindFileNameDialog.on_searchDirButton_clicked</h4> | |
| 195 <b>on_searchDirButton_clicked</b>(<i></i>) | |
| 196 <p> | |
| 197 Private slot to handle the clicked signal of the search directory selection | |
| 198 button. | |
| 199 </p><a NAME="FindFileNameDialog.on_searchDirCheckBox_toggled" ID="FindFileNameDialog.on_searchDirCheckBox_toggled"></a> | |
| 200 <h4>FindFileNameDialog.on_searchDirCheckBox_toggled</h4> | |
| 201 <b>on_searchDirCheckBox_toggled</b>(<i>checked</i>) | |
| 202 <p> | |
| 203 Private slot to handle the toggled signal of the search directory checkbox. | |
| 204 </p><dl> | |
| 205 <dt><i>checked</i></dt> | |
| 206 <dd> | |
| 207 flag indicating the state of the checkbox (boolean) | |
| 208 </dd> | |
| 209 </dl><a NAME="FindFileNameDialog.on_searchDirEdit_textChanged" ID="FindFileNameDialog.on_searchDirEdit_textChanged"></a> | |
| 210 <h4>FindFileNameDialog.on_searchDirEdit_textChanged</h4> | |
| 211 <b>on_searchDirEdit_textChanged</b>(<i>text</i>) | |
| 212 <p> | |
| 213 Private slot to handle the textChanged signal of the search directory edit. | |
| 214 </p><dl> | |
| 215 <dt><i>text</i></dt> | |
| 216 <dd> | |
| 217 text of the search dir edit (string) | |
| 218 </dd> | |
| 219 </dl><a NAME="FindFileNameDialog.on_syspathCheckBox_toggled" ID="FindFileNameDialog.on_syspathCheckBox_toggled"></a> | |
| 220 <h4>FindFileNameDialog.on_syspathCheckBox_toggled</h4> | |
| 221 <b>on_syspathCheckBox_toggled</b>(<i>checked</i>) | |
| 222 <p> | |
| 223 Private slot to handle the toggled signal of the sys.path checkbox. | |
| 224 </p><dl> | |
| 225 <dt><i>checked</i></dt> | |
| 226 <dd> | |
| 227 flag indicating the state of the checkbox (boolean) | |
| 228 </dd> | |
| 229 </dl><a NAME="FindFileNameDialog.show" ID="FindFileNameDialog.show"></a> | |
| 230 <h4>FindFileNameDialog.show</h4> | |
| 231 <b>show</b>(<i></i>) | |
| 232 <p> | |
| 233 Overwritten method to enable/disable the project checkbox. | |
| 234 </p> | |
| 235 <div align="right"><a href="#top">Up</a></div> | |
| 236 <hr /> | |
| 237 </body></html> |
