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