eric7/Documentation/Source/eric7.UI.FindFileWidget.html

branch
eric7
changeset 9042
d08cf11928a4
parent 8877
548d45c3f571
equal deleted inserted replaced
9041:4f598360a94a 9042:d08cf11928a4
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20
21 <table> 21 <table>
22 22
23 <tr> 23 <tr>
24 <td><a href="#FindFileDialog">FindFileDialog</a></td>
25 <td>Class implementing a dialog to search for text in files and replace it with some other text.</td>
26 </tr>
27 <tr>
24 <td><a href="#FindFileWidget">FindFileWidget</a></td> 28 <td><a href="#FindFileWidget">FindFileWidget</a></td>
25 <td>Class implementing a widget to search for text in files and replace it with some other text.</td> 29 <td>Class implementing a widget to search for text in files and replace it with some other text.</td>
26 </tr> 30 </tr>
27 </table> 31 </table>
28 <h3>Functions</h3> 32 <h3>Functions</h3>
30 <table> 34 <table>
31 <tr><td>None</td></tr> 35 <tr><td>None</td></tr>
32 </table> 36 </table>
33 <hr /> 37 <hr />
34 <hr /> 38 <hr />
35 <a NAME="FindFileWidget" ID="FindFileWidget"></a> 39 <a NAME="FindFileDialog" ID="FindFileDialog"></a>
36 <h2>FindFileWidget</h2> 40 <h2>FindFileDialog</h2>
37 41
38 <p> 42 <p>
39 Class implementing a widget to search for text in files and replace it 43 Class implementing a dialog to search for text in files and replace it
40 with some other text. 44 with some other text.
41 </p> 45 </p>
42 <p> 46 <p>
43 The occurrences found are displayed in a tree showing the file name, 47 The occurrences found are displayed in a tree showing the file name,
44 the line number and the text found. The file will be opened upon a double 48 the line number and the text found. The file will be opened upon a double
79 <dd> 83 <dd>
80 emitted to open an eric UML file 84 emitted to open an eric UML file
81 </dd> 85 </dd>
82 </dl> 86 </dl>
83 <h3>Derived from</h3> 87 <h3>Derived from</h3>
88 QDialog
89 <h3>Class Attributes</h3>
90
91 <table>
92 <tr><td>None</td></tr>
93 </table>
94 <h3>Class Methods</h3>
95
96 <table>
97 <tr><td>None</td></tr>
98 </table>
99 <h3>Methods</h3>
100
101 <table>
102
103 <tr>
104 <td><a href="#FindFileDialog.__init__">FindFileDialog</a></td>
105 <td>Constructor</td>
106 </tr>
107 <tr>
108 <td><a href="#FindFileDialog.activate">activate</a></td>
109 <td>Public method to activate the dialog with a given mode, a text to search for and some search parameters.</td>
110 </tr>
111 </table>
112 <h3>Static Methods</h3>
113
114 <table>
115 <tr><td>None</td></tr>
116 </table>
117
118 <a NAME="FindFileDialog.__init__" ID="FindFileDialog.__init__"></a>
119 <h4>FindFileDialog (Constructor)</h4>
120 <b>FindFileDialog</b>(<i>project, parent=None</i>)
121
122 <p>
123 Constructor
124 </p>
125 <dl>
126
127 <dt><i>project</i> (Project)</dt>
128 <dd>
129 reference to the project object
130 </dd>
131 <dt><i>parent</i> (QWidget (optional))</dt>
132 <dd>
133 parent widget of this dialog (defaults to None)
134 </dd>
135 </dl>
136 <a NAME="FindFileDialog.activate" ID="FindFileDialog.activate"></a>
137 <h4>FindFileDialog.activate</h4>
138 <b>activate</b>(<i>replaceMode=False, txt="", searchDir="", openFiles=False</i>)
139
140 <p>
141 Public method to activate the dialog with a given mode, a text
142 to search for and some search parameters.
143 </p>
144 <dl>
145
146 <dt><i>replaceMode</i> (bool (optional))</dt>
147 <dd>
148 flag indicating replacement mode (defaults to False)
149 </dd>
150 <dt><i>txt</i> (str (optional))</dt>
151 <dd>
152 text to be searched for (defaults to "")
153 </dd>
154 <dt><i>searchDir</i> (str (optional))</dt>
155 <dd>
156 directory to search in (defaults to "")
157 </dd>
158 <dt><i>openFiles</i> (bool (optional))</dt>
159 <dd>
160 flag indicating to operate on open files only
161 (defaults to False)
162 </dd>
163 </dl>
164 <div align="right"><a href="#top">Up</a></div>
165 <hr />
166 <hr />
167 <a NAME="FindFileWidget" ID="FindFileWidget"></a>
168 <h2>FindFileWidget</h2>
169
170 <p>
171 Class implementing a widget to search for text in files and replace it
172 with some other text.
173 </p>
174 <p>
175 The occurrences found are displayed in a tree showing the file name,
176 the line number and the text found. The file will be opened upon a double
177 click onto the respective entry of the list. If the widget is in replace
178 mode the line below shows the text after replacement. Replacements can
179 be authorized by ticking them on. Pressing the replace button performs
180 all ticked replacement operations.
181 </p>
182 <h3>Signals</h3>
183 <dl>
184
185 <dt>designerFile(str)</dt>
186 <dd>
187 emitted to open a Qt-Designer file
188 </dd>
189 <dt>linguistFile(str)</dt>
190 <dd>
191 emitted to open a Qt-Linguist (*.ts) file
192 </dd>
193 <dt>pixmapFile(str)</dt>
194 <dd>
195 emitted to open a pixmap file
196 </dd>
197 <dt>sourceFile(str, int, str, int, int)</dt>
198 <dd>
199 emitted to open a source file
200 at a specificline
201 </dd>
202 <dt>svgFile(str)</dt>
203 <dd>
204 emitted to open a SVG file
205 </dd>
206 <dt>trpreview([str])</dt>
207 <dd>
208 emitted to preview Qt-Linguist (*.qm) files
209 </dd>
210 <dt>umlFile(str)</dt>
211 <dd>
212 emitted to open an eric UML file
213 </dd>
214 </dl>
215 <h3>Derived from</h3>
84 QWidget, Ui_FindFileWidget 216 QWidget, Ui_FindFileWidget
85 <h3>Class Attributes</h3> 217 <h3>Class Attributes</h3>
86 218
87 <table> 219 <table>
88 <tr><td>endRole</td></tr><tr><td>lineRole</td></tr><tr><td>md5Role</td></tr><tr><td>replaceRole</td></tr><tr><td>startRole</td></tr> 220 <tr><td>endRole</td></tr><tr><td>lineRole</td></tr><tr><td>md5Role</td></tr><tr><td>replaceRole</td></tr><tr><td>startRole</td></tr>
139 <tr> 271 <tr>
140 <td><a href="#FindFileWidget.__projectOpened">__projectOpened</a></td> 272 <td><a href="#FindFileWidget.__projectOpened">__projectOpened</a></td>
141 <td>Private slot to react to the opening of a project.</td> 273 <td>Private slot to react to the opening of a project.</td>
142 </tr> 274 </tr>
143 <tr> 275 <tr>
276 <td><a href="#FindFileWidget.__setOpenFiles">__setOpenFiles</a></td>
277 <td>Private slot to set the mode to search in open files.</td>
278 </tr>
279 <tr>
280 <td><a href="#FindFileWidget.__setSearchDirectory">__setSearchDirectory</a></td>
281 <td>Private slot to set the name of the directory to search in.</td>
282 </tr>
283 <tr>
144 <td><a href="#FindFileWidget.__stopSearch">__stopSearch</a></td> 284 <td><a href="#FindFileWidget.__stopSearch">__stopSearch</a></td>
145 <td>Private slot to handle the stop button being pressed.</td> 285 <td>Private slot to handle the stop button being pressed.</td>
146 </tr> 286 </tr>
147 <tr> 287 <tr>
148 <td><a href="#FindFileWidget.__stripEol">__stripEol</a></td> 288 <td><a href="#FindFileWidget.__stripEol">__stripEol</a></td>
193 <td>Private slot to perform the requested replace actions.</td> 333 <td>Private slot to perform the requested replace actions.</td>
194 </tr> 334 </tr>
195 <tr> 335 <tr>
196 <td><a href="#FindFileWidget.on_replacetextCombo_editTextChanged">on_replacetextCombo_editTextChanged</a></td> 336 <td><a href="#FindFileWidget.on_replacetextCombo_editTextChanged">on_replacetextCombo_editTextChanged</a></td>
197 <td>Private slot to handle the editTextChanged signal of the replace text combo.</td> 337 <td>Private slot to handle the editTextChanged signal of the replace text combo.</td>
198 </tr>
199 <tr>
200 <td><a href="#FindFileWidget.setOpenFiles">setOpenFiles</a></td>
201 <td>Public slot to set the mode to search in open files.</td>
202 </tr>
203 <tr>
204 <td><a href="#FindFileWidget.setSearchDirectory">setSearchDirectory</a></td>
205 <td>Public slot to set the name of the directory to search in.</td>
206 </tr> 338 </tr>
207 </table> 339 </table>
208 <h3>Static Methods</h3> 340 <h3>Static Methods</h3>
209 341
210 <table> 342 <table>
367 <b>__projectOpened</b>(<i></i>) 499 <b>__projectOpened</b>(<i></i>)
368 500
369 <p> 501 <p>
370 Private slot to react to the opening of a project. 502 Private slot to react to the opening of a project.
371 </p> 503 </p>
504 <a NAME="FindFileWidget.__setOpenFiles" ID="FindFileWidget.__setOpenFiles"></a>
505 <h4>FindFileWidget.__setOpenFiles</h4>
506 <b>__setOpenFiles</b>(<i></i>)
507
508 <p>
509 Private slot to set the mode to search in open files.
510 </p>
511 <a NAME="FindFileWidget.__setSearchDirectory" ID="FindFileWidget.__setSearchDirectory"></a>
512 <h4>FindFileWidget.__setSearchDirectory</h4>
513 <b>__setSearchDirectory</b>(<i>searchDir</i>)
514
515 <p>
516 Private slot to set the name of the directory to search in.
517 </p>
518 <dl>
519
520 <dt><i>searchDir</i> (str)</dt>
521 <dd>
522 name of the directory to search in
523 </dd>
524 </dl>
372 <a NAME="FindFileWidget.__stopSearch" ID="FindFileWidget.__stopSearch"></a> 525 <a NAME="FindFileWidget.__stopSearch" ID="FindFileWidget.__stopSearch"></a>
373 <h4>FindFileWidget.__stopSearch</h4> 526 <h4>FindFileWidget.__stopSearch</h4>
374 <b>__stopSearch</b>(<i></i>) 527 <b>__stopSearch</b>(<i></i>)
375 528
376 <p> 529 <p>
550 <dt><i>text</i></dt> 703 <dt><i>text</i></dt>
551 <dd> 704 <dd>
552 (ignored) 705 (ignored)
553 </dd> 706 </dd>
554 </dl> 707 </dl>
555 <a NAME="FindFileWidget.setOpenFiles" ID="FindFileWidget.setOpenFiles"></a>
556 <h4>FindFileWidget.setOpenFiles</h4>
557 <b>setOpenFiles</b>(<i></i>)
558
559 <p>
560 Public slot to set the mode to search in open files.
561 </p>
562 <a NAME="FindFileWidget.setSearchDirectory" ID="FindFileWidget.setSearchDirectory"></a>
563 <h4>FindFileWidget.setSearchDirectory</h4>
564 <b>setSearchDirectory</b>(<i>searchDir</i>)
565
566 <p>
567 Public slot to set the name of the directory to search in.
568 </p>
569 <dl>
570
571 <dt><i>searchDir</i> (str)</dt>
572 <dd>
573 name of the directory to search in
574 </dd>
575 </dl>
576 <div align="right"><a href="#top">Up</a></div> 708 <div align="right"><a href="#top">Up</a></div>
577 <hr /> 709 <hr />
578 </body></html> 710 </body></html>

eric ide

mercurial