Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.UI.FindFileNameDialog.html

eric6/Documentation/Source/eric6.UI.FindFileNameDialog.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.UI.FindFileNameDialog</h1> 23 <h1>eric6.UI.FindFileNameDialog</h1>
24
23 <p> 25 <p>
24 Module implementing a dialog to search for files. 26 Module implementing a dialog to search for files.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#FindFileNameDialog">FindFileNameDialog</a></td> 38 <td><a href="#FindFileNameDialog">FindFileNameDialog</a></td>
34 <td>Class implementing a dialog to search for files.</td> 39 <td>Class implementing a dialog to search for files.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
39 <tr><td>None</td></tr> 44 <table>
40 </table> 45 <tr><td>None</td></tr>
41 <hr /><hr /> 46 </table>
47 <hr />
48 <hr />
42 <a NAME="FindFileNameDialog" ID="FindFileNameDialog"></a> 49 <a NAME="FindFileNameDialog" ID="FindFileNameDialog"></a>
43 <h2>FindFileNameDialog</h2> 50 <h2>FindFileNameDialog</h2>
51
44 <p> 52 <p>
45 Class implementing a dialog to search for files. 53 Class implementing a dialog to search for files.
46 </p><p> 54 </p>
55 <p>
47 The occurrences found are displayed in a QTreeWidget showing the 56 The occurrences found are displayed in a QTreeWidget showing the
48 filename and the pathname. The file will be opened upon a double click 57 filename and the pathname. The file will be opened upon a double click
49 onto the respective entry of the list. 58 onto the respective entry of the list.
50 </p><h3>Signals</h3> 59 </p>
51 <dl> 60 <h3>Signals</h3>
61 <dl>
62
52 <dt>designerFile(str)</dt> 63 <dt>designerFile(str)</dt>
53 <dd> 64 <dd>
54 emitted to open a Qt-Designer file 65 emitted to open a Qt-Designer file
55 </dd><dt>sourceFile(str)</dt> 66 </dd>
67 <dt>sourceFile(str)</dt>
56 <dd> 68 <dd>
57 emitted to open a file in the editor 69 emitted to open a file in the editor
58 </dd> 70 </dd>
59 </dl> 71 </dl>
60 <h3>Derived from</h3> 72 <h3>Derived from</h3>
61 QWidget, Ui_FindFileNameDialog 73 QWidget, Ui_FindFileNameDialog
62 <h3>Class Attributes</h3> 74 <h3>Class Attributes</h3>
75
63 <table> 76 <table>
64 <tr><td>None</td></tr> 77 <tr><td>None</td></tr>
65 </table> 78 </table>
66 <h3>Class Methods</h3> 79 <h3>Class Methods</h3>
80
67 <table> 81 <table>
68 <tr><td>None</td></tr> 82 <tr><td>None</td></tr>
69 </table> 83 </table>
70 <h3>Methods</h3> 84 <h3>Methods</h3>
71 <table> 85
86 <table>
87
72 <tr> 88 <tr>
73 <td><a href="#FindFileNameDialog.__init__">FindFileNameDialog</a></td> 89 <td><a href="#FindFileNameDialog.__init__">FindFileNameDialog</a></td>
74 <td>Constructor</td> 90 <td>Constructor</td>
75 </tr><tr> 91 </tr>
92 <tr>
76 <td><a href="#FindFileNameDialog.__openFile">__openFile</a></td> 93 <td><a href="#FindFileNameDialog.__openFile">__openFile</a></td>
77 <td>Private slot to open a file.</td> 94 <td>Private slot to open a file.</td>
78 </tr><tr> 95 </tr>
96 <tr>
79 <td><a href="#FindFileNameDialog.__searchFile">__searchFile</a></td> 97 <td><a href="#FindFileNameDialog.__searchFile">__searchFile</a></td>
80 <td>Private slot to handle the search.</td> 98 <td>Private slot to handle the search.</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#FindFileNameDialog.checkStop">checkStop</a></td> 101 <td><a href="#FindFileNameDialog.checkStop">checkStop</a></td>
83 <td>Public method to check, if the search should be stopped.</td> 102 <td>Public method to check, if the search should be stopped.</td>
84 </tr><tr> 103 </tr>
104 <tr>
85 <td><a href="#FindFileNameDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 105 <td><a href="#FindFileNameDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
86 <td>Private slot called by a button of the button box clicked.</td> 106 <td>Private slot called by a button of the button box clicked.</td>
87 </tr><tr> 107 </tr>
108 <tr>
88 <td><a href="#FindFileNameDialog.on_fileExtEdit_textChanged">on_fileExtEdit_textChanged</a></td> 109 <td><a href="#FindFileNameDialog.on_fileExtEdit_textChanged">on_fileExtEdit_textChanged</a></td>
89 <td>Private slot to handle the textChanged signal of the file extension edit.</td> 110 <td>Private slot to handle the textChanged signal of the file extension edit.</td>
90 </tr><tr> 111 </tr>
112 <tr>
91 <td><a href="#FindFileNameDialog.on_fileList_currentItemChanged">on_fileList_currentItemChanged</a></td> 113 <td><a href="#FindFileNameDialog.on_fileList_currentItemChanged">on_fileList_currentItemChanged</a></td>
92 <td>Private slot handling a change of the current item.</td> 114 <td>Private slot handling a change of the current item.</td>
93 </tr><tr> 115 </tr>
116 <tr>
94 <td><a href="#FindFileNameDialog.on_fileList_itemActivated">on_fileList_itemActivated</a></td> 117 <td><a href="#FindFileNameDialog.on_fileList_itemActivated">on_fileList_itemActivated</a></td>
95 <td>Private slot to handle the double click on a file item.</td> 118 <td>Private slot to handle the double click on a file item.</td>
96 </tr><tr> 119 </tr>
120 <tr>
97 <td><a href="#FindFileNameDialog.on_fileNameEdit_textChanged">on_fileNameEdit_textChanged</a></td> 121 <td><a href="#FindFileNameDialog.on_fileNameEdit_textChanged">on_fileNameEdit_textChanged</a></td>
98 <td>Private slot to handle the textChanged signal of the file name edit.</td> 122 <td>Private slot to handle the textChanged signal of the file name edit.</td>
99 </tr><tr> 123 </tr>
124 <tr>
100 <td><a href="#FindFileNameDialog.on_projectCheckBox_toggled">on_projectCheckBox_toggled</a></td> 125 <td><a href="#FindFileNameDialog.on_projectCheckBox_toggled">on_projectCheckBox_toggled</a></td>
101 <td>Private slot to handle the toggled signal of the project checkbox.</td> 126 <td>Private slot to handle the toggled signal of the project checkbox.</td>
102 </tr><tr> 127 </tr>
128 <tr>
103 <td><a href="#FindFileNameDialog.on_searchDirCheckBox_toggled">on_searchDirCheckBox_toggled</a></td> 129 <td><a href="#FindFileNameDialog.on_searchDirCheckBox_toggled">on_searchDirCheckBox_toggled</a></td>
104 <td>Private slot to handle the toggled signal of the search directory checkbox.</td> 130 <td>Private slot to handle the toggled signal of the search directory checkbox.</td>
105 </tr><tr> 131 </tr>
132 <tr>
106 <td><a href="#FindFileNameDialog.on_searchDirPicker_textChanged">on_searchDirPicker_textChanged</a></td> 133 <td><a href="#FindFileNameDialog.on_searchDirPicker_textChanged">on_searchDirPicker_textChanged</a></td>
107 <td>Private slot to handle the textChanged signal of the search directory edit.</td> 134 <td>Private slot to handle the textChanged signal of the search directory edit.</td>
108 </tr><tr> 135 </tr>
136 <tr>
109 <td><a href="#FindFileNameDialog.on_syspathCheckBox_toggled">on_syspathCheckBox_toggled</a></td> 137 <td><a href="#FindFileNameDialog.on_syspathCheckBox_toggled">on_syspathCheckBox_toggled</a></td>
110 <td>Private slot to handle the toggled signal of the sys.path checkbox.</td> 138 <td>Private slot to handle the toggled signal of the sys.path checkbox.</td>
111 </tr><tr> 139 </tr>
140 <tr>
112 <td><a href="#FindFileNameDialog.show">show</a></td> 141 <td><a href="#FindFileNameDialog.show">show</a></td>
113 <td>Public method to enable/disable the project checkbox.</td> 142 <td>Public method to enable/disable the project checkbox.</td>
114 </tr> 143 </tr>
115 </table> 144 </table>
116 <h3>Static Methods</h3> 145 <h3>Static Methods</h3>
117 <table> 146
118 <tr><td>None</td></tr> 147 <table>
119 </table> 148 <tr><td>None</td></tr>
149 </table>
150
120 <a NAME="FindFileNameDialog.__init__" ID="FindFileNameDialog.__init__"></a> 151 <a NAME="FindFileNameDialog.__init__" ID="FindFileNameDialog.__init__"></a>
121 <h4>FindFileNameDialog (Constructor)</h4> 152 <h4>FindFileNameDialog (Constructor)</h4>
122 <b>FindFileNameDialog</b>(<i>project, parent=None</i>) 153 <b>FindFileNameDialog</b>(<i>project, parent=None</i>)
154
123 <p> 155 <p>
124 Constructor 156 Constructor
125 </p><dl> 157 </p>
158 <dl>
159
126 <dt><i>project</i></dt> 160 <dt><i>project</i></dt>
127 <dd> 161 <dd>
128 reference to the project object 162 reference to the project object
129 </dd><dt><i>parent</i></dt> 163 </dd>
164 <dt><i>parent</i></dt>
130 <dd> 165 <dd>
131 parent widget of this dialog (QWidget) 166 parent widget of this dialog (QWidget)
132 </dd> 167 </dd>
133 </dl><a NAME="FindFileNameDialog.__openFile" ID="FindFileNameDialog.__openFile"></a> 168 </dl>
169 <a NAME="FindFileNameDialog.__openFile" ID="FindFileNameDialog.__openFile"></a>
134 <h4>FindFileNameDialog.__openFile</h4> 170 <h4>FindFileNameDialog.__openFile</h4>
135 <b>__openFile</b>(<i>itm=None</i>) 171 <b>__openFile</b>(<i>itm=None</i>)
172
136 <p> 173 <p>
137 Private slot to open a file. 174 Private slot to open a file.
138 </p><p> 175 </p>
176 <p>
139 It emits the signal sourceFile or designerFile depending on the 177 It emits the signal sourceFile or designerFile depending on the
140 file extension. 178 file extension.
141 </p><dl> 179 </p>
180 <dl>
181
142 <dt><i>itm</i></dt> 182 <dt><i>itm</i></dt>
143 <dd> 183 <dd>
144 item to be opened (QTreeWidgetItem) 184 item to be opened (QTreeWidgetItem)
145 </dd> 185 </dd>
146 </dl><a NAME="FindFileNameDialog.__searchFile" ID="FindFileNameDialog.__searchFile"></a> 186 </dl>
187 <a NAME="FindFileNameDialog.__searchFile" ID="FindFileNameDialog.__searchFile"></a>
147 <h4>FindFileNameDialog.__searchFile</h4> 188 <h4>FindFileNameDialog.__searchFile</h4>
148 <b>__searchFile</b>(<i></i>) 189 <b>__searchFile</b>(<i></i>)
190
149 <p> 191 <p>
150 Private slot to handle the search. 192 Private slot to handle the search.
151 </p><a NAME="FindFileNameDialog.checkStop" ID="FindFileNameDialog.checkStop"></a> 193 </p>
194 <a NAME="FindFileNameDialog.checkStop" ID="FindFileNameDialog.checkStop"></a>
152 <h4>FindFileNameDialog.checkStop</h4> 195 <h4>FindFileNameDialog.checkStop</h4>
153 <b>checkStop</b>(<i></i>) 196 <b>checkStop</b>(<i></i>)
197
154 <p> 198 <p>
155 Public method to check, if the search should be stopped. 199 Public method to check, if the search should be stopped.
156 </p><dl> 200 </p>
201 <dl>
157 <dt>Returns:</dt> 202 <dt>Returns:</dt>
158 <dd> 203 <dd>
159 flag indicating the search should be stopped (boolean) 204 flag indicating the search should be stopped (boolean)
160 </dd> 205 </dd>
161 </dl><a NAME="FindFileNameDialog.on_buttonBox_clicked" ID="FindFileNameDialog.on_buttonBox_clicked"></a> 206 </dl>
207 <a NAME="FindFileNameDialog.on_buttonBox_clicked" ID="FindFileNameDialog.on_buttonBox_clicked"></a>
162 <h4>FindFileNameDialog.on_buttonBox_clicked</h4> 208 <h4>FindFileNameDialog.on_buttonBox_clicked</h4>
163 <b>on_buttonBox_clicked</b>(<i>button</i>) 209 <b>on_buttonBox_clicked</b>(<i>button</i>)
210
164 <p> 211 <p>
165 Private slot called by a button of the button box clicked. 212 Private slot called by a button of the button box clicked.
166 </p><dl> 213 </p>
214 <dl>
215
167 <dt><i>button</i></dt> 216 <dt><i>button</i></dt>
168 <dd> 217 <dd>
169 button that was clicked (QAbstractButton) 218 button that was clicked (QAbstractButton)
170 </dd> 219 </dd>
171 </dl><a NAME="FindFileNameDialog.on_fileExtEdit_textChanged" ID="FindFileNameDialog.on_fileExtEdit_textChanged"></a> 220 </dl>
221 <a NAME="FindFileNameDialog.on_fileExtEdit_textChanged" ID="FindFileNameDialog.on_fileExtEdit_textChanged"></a>
172 <h4>FindFileNameDialog.on_fileExtEdit_textChanged</h4> 222 <h4>FindFileNameDialog.on_fileExtEdit_textChanged</h4>
173 <b>on_fileExtEdit_textChanged</b>(<i>text</i>) 223 <b>on_fileExtEdit_textChanged</b>(<i>text</i>)
224
174 <p> 225 <p>
175 Private slot to handle the textChanged signal of the file extension 226 Private slot to handle the textChanged signal of the file extension
176 edit. 227 edit.
177 </p><dl> 228 </p>
229 <dl>
230
178 <dt><i>text</i></dt> 231 <dt><i>text</i></dt>
179 <dd> 232 <dd>
180 (ignored) 233 (ignored)
181 </dd> 234 </dd>
182 </dl><a NAME="FindFileNameDialog.on_fileList_currentItemChanged" ID="FindFileNameDialog.on_fileList_currentItemChanged"></a> 235 </dl>
236 <a NAME="FindFileNameDialog.on_fileList_currentItemChanged" ID="FindFileNameDialog.on_fileList_currentItemChanged"></a>
183 <h4>FindFileNameDialog.on_fileList_currentItemChanged</h4> 237 <h4>FindFileNameDialog.on_fileList_currentItemChanged</h4>
184 <b>on_fileList_currentItemChanged</b>(<i>current, previous</i>) 238 <b>on_fileList_currentItemChanged</b>(<i>current, previous</i>)
239
185 <p> 240 <p>
186 Private slot handling a change of the current item. 241 Private slot handling a change of the current item.
187 </p><dl> 242 </p>
243 <dl>
244
188 <dt><i>current</i></dt> 245 <dt><i>current</i></dt>
189 <dd> 246 <dd>
190 current item (QTreeWidgetItem) 247 current item (QTreeWidgetItem)
191 </dd><dt><i>previous</i></dt> 248 </dd>
249 <dt><i>previous</i></dt>
192 <dd> 250 <dd>
193 prevoius current item (QTreeWidgetItem) 251 prevoius current item (QTreeWidgetItem)
194 </dd> 252 </dd>
195 </dl><a NAME="FindFileNameDialog.on_fileList_itemActivated" ID="FindFileNameDialog.on_fileList_itemActivated"></a> 253 </dl>
254 <a NAME="FindFileNameDialog.on_fileList_itemActivated" ID="FindFileNameDialog.on_fileList_itemActivated"></a>
196 <h4>FindFileNameDialog.on_fileList_itemActivated</h4> 255 <h4>FindFileNameDialog.on_fileList_itemActivated</h4>
197 <b>on_fileList_itemActivated</b>(<i>itm, column</i>) 256 <b>on_fileList_itemActivated</b>(<i>itm, column</i>)
257
198 <p> 258 <p>
199 Private slot to handle the double click on a file item. 259 Private slot to handle the double click on a file item.
200 </p><p> 260 </p>
261 <p>
201 It emits the signal sourceFile or designerFile depending on the 262 It emits the signal sourceFile or designerFile depending on the
202 file extension. 263 file extension.
203 </p><dl> 264 </p>
265 <dl>
266
204 <dt><i>itm</i></dt> 267 <dt><i>itm</i></dt>
205 <dd> 268 <dd>
206 the double clicked listview item (QTreeWidgetItem) 269 the double clicked listview item (QTreeWidgetItem)
207 </dd><dt><i>column</i></dt> 270 </dd>
271 <dt><i>column</i></dt>
208 <dd> 272 <dd>
209 column that was double clicked (integer) (ignored) 273 column that was double clicked (integer) (ignored)
210 </dd> 274 </dd>
211 </dl><a NAME="FindFileNameDialog.on_fileNameEdit_textChanged" ID="FindFileNameDialog.on_fileNameEdit_textChanged"></a> 275 </dl>
276 <a NAME="FindFileNameDialog.on_fileNameEdit_textChanged" ID="FindFileNameDialog.on_fileNameEdit_textChanged"></a>
212 <h4>FindFileNameDialog.on_fileNameEdit_textChanged</h4> 277 <h4>FindFileNameDialog.on_fileNameEdit_textChanged</h4>
213 <b>on_fileNameEdit_textChanged</b>(<i>text</i>) 278 <b>on_fileNameEdit_textChanged</b>(<i>text</i>)
279
214 <p> 280 <p>
215 Private slot to handle the textChanged signal of the file name edit. 281 Private slot to handle the textChanged signal of the file name edit.
216 </p><dl> 282 </p>
283 <dl>
284
217 <dt><i>text</i></dt> 285 <dt><i>text</i></dt>
218 <dd> 286 <dd>
219 (ignored) 287 (ignored)
220 </dd> 288 </dd>
221 </dl><a NAME="FindFileNameDialog.on_projectCheckBox_toggled" ID="FindFileNameDialog.on_projectCheckBox_toggled"></a> 289 </dl>
290 <a NAME="FindFileNameDialog.on_projectCheckBox_toggled" ID="FindFileNameDialog.on_projectCheckBox_toggled"></a>
222 <h4>FindFileNameDialog.on_projectCheckBox_toggled</h4> 291 <h4>FindFileNameDialog.on_projectCheckBox_toggled</h4>
223 <b>on_projectCheckBox_toggled</b>(<i>checked</i>) 292 <b>on_projectCheckBox_toggled</b>(<i>checked</i>)
293
224 <p> 294 <p>
225 Private slot to handle the toggled signal of the project checkbox. 295 Private slot to handle the toggled signal of the project checkbox.
226 </p><dl> 296 </p>
297 <dl>
298
227 <dt><i>checked</i></dt> 299 <dt><i>checked</i></dt>
228 <dd> 300 <dd>
229 flag indicating the state of the checkbox (boolean) 301 flag indicating the state of the checkbox (boolean)
230 </dd> 302 </dd>
231 </dl><a NAME="FindFileNameDialog.on_searchDirCheckBox_toggled" ID="FindFileNameDialog.on_searchDirCheckBox_toggled"></a> 303 </dl>
304 <a NAME="FindFileNameDialog.on_searchDirCheckBox_toggled" ID="FindFileNameDialog.on_searchDirCheckBox_toggled"></a>
232 <h4>FindFileNameDialog.on_searchDirCheckBox_toggled</h4> 305 <h4>FindFileNameDialog.on_searchDirCheckBox_toggled</h4>
233 <b>on_searchDirCheckBox_toggled</b>(<i>checked</i>) 306 <b>on_searchDirCheckBox_toggled</b>(<i>checked</i>)
307
234 <p> 308 <p>
235 Private slot to handle the toggled signal of the search directory 309 Private slot to handle the toggled signal of the search directory
236 checkbox. 310 checkbox.
237 </p><dl> 311 </p>
312 <dl>
313
238 <dt><i>checked</i></dt> 314 <dt><i>checked</i></dt>
239 <dd> 315 <dd>
240 flag indicating the state of the checkbox (boolean) 316 flag indicating the state of the checkbox (boolean)
241 </dd> 317 </dd>
242 </dl><a NAME="FindFileNameDialog.on_searchDirPicker_textChanged" ID="FindFileNameDialog.on_searchDirPicker_textChanged"></a> 318 </dl>
319 <a NAME="FindFileNameDialog.on_searchDirPicker_textChanged" ID="FindFileNameDialog.on_searchDirPicker_textChanged"></a>
243 <h4>FindFileNameDialog.on_searchDirPicker_textChanged</h4> 320 <h4>FindFileNameDialog.on_searchDirPicker_textChanged</h4>
244 <b>on_searchDirPicker_textChanged</b>(<i>text</i>) 321 <b>on_searchDirPicker_textChanged</b>(<i>text</i>)
322
245 <p> 323 <p>
246 Private slot to handle the textChanged signal of the search directory 324 Private slot to handle the textChanged signal of the search directory
247 edit. 325 edit.
248 </p><dl> 326 </p>
327 <dl>
328
249 <dt><i>text</i></dt> 329 <dt><i>text</i></dt>
250 <dd> 330 <dd>
251 text of the search dir edit (string) 331 text of the search dir edit (string)
252 </dd> 332 </dd>
253 </dl><a NAME="FindFileNameDialog.on_syspathCheckBox_toggled" ID="FindFileNameDialog.on_syspathCheckBox_toggled"></a> 333 </dl>
334 <a NAME="FindFileNameDialog.on_syspathCheckBox_toggled" ID="FindFileNameDialog.on_syspathCheckBox_toggled"></a>
254 <h4>FindFileNameDialog.on_syspathCheckBox_toggled</h4> 335 <h4>FindFileNameDialog.on_syspathCheckBox_toggled</h4>
255 <b>on_syspathCheckBox_toggled</b>(<i>checked</i>) 336 <b>on_syspathCheckBox_toggled</b>(<i>checked</i>)
337
256 <p> 338 <p>
257 Private slot to handle the toggled signal of the sys.path checkbox. 339 Private slot to handle the toggled signal of the sys.path checkbox.
258 </p><dl> 340 </p>
341 <dl>
342
259 <dt><i>checked</i></dt> 343 <dt><i>checked</i></dt>
260 <dd> 344 <dd>
261 flag indicating the state of the checkbox (boolean) 345 flag indicating the state of the checkbox (boolean)
262 </dd> 346 </dd>
263 </dl><a NAME="FindFileNameDialog.show" ID="FindFileNameDialog.show"></a> 347 </dl>
348 <a NAME="FindFileNameDialog.show" ID="FindFileNameDialog.show"></a>
264 <h4>FindFileNameDialog.show</h4> 349 <h4>FindFileNameDialog.show</h4>
265 <b>show</b>(<i></i>) 350 <b>show</b>(<i></i>)
351
266 <p> 352 <p>
267 Public method to enable/disable the project checkbox. 353 Public method to enable/disable the project checkbox.
268 </p> 354 </p>
269 <div align="right"><a href="#top">Up</a></div> 355 <div align="right"><a href="#top">Up</a></div>
270 <hr /> 356 <hr />

Mercurial Repository: eric

eric ide

mercurial