Mercurial Repositories > eric / file comparison

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

eric7/Documentation/Source/eric7.UI.FindFileNameDialog.html

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

Mercurial Repository: eric

eric ide

mercurial