Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial