Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial