Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.UI.FindFileNameDialog.html

changeset 3673
e26d7d0c1088
child 4602
48cc4820e2c2
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
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_searchDirButton_clicked">on_searchDirButton_clicked</a></td>
104 <td>Private slot to handle the clicked signal of the search directory selection button.</td>
105 </tr><tr>
106 <td><a href="#FindFileNameDialog.on_searchDirCheckBox_toggled">on_searchDirCheckBox_toggled</a></td>
107 <td>Private slot to handle the toggled signal of the search directory checkbox.</td>
108 </tr><tr>
109 <td><a href="#FindFileNameDialog.on_searchDirEdit_textChanged">on_searchDirEdit_textChanged</a></td>
110 <td>Private slot to handle the textChanged signal of the search directory edit.</td>
111 </tr><tr>
112 <td><a href="#FindFileNameDialog.on_syspathCheckBox_toggled">on_syspathCheckBox_toggled</a></td>
113 <td>Private slot to handle the toggled signal of the sys.path checkbox.</td>
114 </tr><tr>
115 <td><a href="#FindFileNameDialog.show">show</a></td>
116 <td>Public method to enable/disable the project checkbox.</td>
117 </tr>
118 </table>
119 <h3>Static Methods</h3>
120 <table>
121 <tr><td>None</td></tr>
122 </table>
123 <a NAME="FindFileNameDialog.__init__" ID="FindFileNameDialog.__init__"></a>
124 <h4>FindFileNameDialog (Constructor)</h4>
125 <b>FindFileNameDialog</b>(<i>project, parent=None</i>)
126 <p>
127 Constructor
128 </p><dl>
129 <dt><i>project</i></dt>
130 <dd>
131 reference to the project object
132 </dd><dt><i>parent</i></dt>
133 <dd>
134 parent widget of this dialog (QWidget)
135 </dd>
136 </dl><a NAME="FindFileNameDialog.__openFile" ID="FindFileNameDialog.__openFile"></a>
137 <h4>FindFileNameDialog.__openFile</h4>
138 <b>__openFile</b>(<i>itm=None</i>)
139 <p>
140 Private slot to open a file.
141 </p><p>
142 It emits the signal sourceFile or designerFile depending on the
143 file extension.
144 </p><dl>
145 <dt><i>itm</i></dt>
146 <dd>
147 item to be opened (QTreeWidgetItem)
148 </dd>
149 </dl><a NAME="FindFileNameDialog.__searchFile" ID="FindFileNameDialog.__searchFile"></a>
150 <h4>FindFileNameDialog.__searchFile</h4>
151 <b>__searchFile</b>(<i></i>)
152 <p>
153 Private slot to handle the search.
154 </p><a NAME="FindFileNameDialog.checkStop" ID="FindFileNameDialog.checkStop"></a>
155 <h4>FindFileNameDialog.checkStop</h4>
156 <b>checkStop</b>(<i></i>)
157 <p>
158 Public method to check, if the search should be stopped.
159 </p><dl>
160 <dt>Returns:</dt>
161 <dd>
162 flag indicating the search should be stopped (boolean)
163 </dd>
164 </dl><a NAME="FindFileNameDialog.on_buttonBox_clicked" ID="FindFileNameDialog.on_buttonBox_clicked"></a>
165 <h4>FindFileNameDialog.on_buttonBox_clicked</h4>
166 <b>on_buttonBox_clicked</b>(<i>button</i>)
167 <p>
168 Private slot called by a button of the button box clicked.
169 </p><dl>
170 <dt><i>button</i></dt>
171 <dd>
172 button that was clicked (QAbstractButton)
173 </dd>
174 </dl><a NAME="FindFileNameDialog.on_fileExtEdit_textChanged" ID="FindFileNameDialog.on_fileExtEdit_textChanged"></a>
175 <h4>FindFileNameDialog.on_fileExtEdit_textChanged</h4>
176 <b>on_fileExtEdit_textChanged</b>(<i>text</i>)
177 <p>
178 Private slot to handle the textChanged signal of the file extension
179 edit.
180 </p><dl>
181 <dt><i>text</i></dt>
182 <dd>
183 (ignored)
184 </dd>
185 </dl><a NAME="FindFileNameDialog.on_fileList_currentItemChanged" ID="FindFileNameDialog.on_fileList_currentItemChanged"></a>
186 <h4>FindFileNameDialog.on_fileList_currentItemChanged</h4>
187 <b>on_fileList_currentItemChanged</b>(<i>current, previous</i>)
188 <p>
189 Private slot handling a change of the current item.
190 </p><dl>
191 <dt><i>current</i></dt>
192 <dd>
193 current item (QTreeWidgetItem)
194 </dd><dt><i>previous</i></dt>
195 <dd>
196 prevoius current item (QTreeWidgetItem)
197 </dd>
198 </dl><a NAME="FindFileNameDialog.on_fileList_itemActivated" ID="FindFileNameDialog.on_fileList_itemActivated"></a>
199 <h4>FindFileNameDialog.on_fileList_itemActivated</h4>
200 <b>on_fileList_itemActivated</b>(<i>itm, column</i>)
201 <p>
202 Private slot to handle the double click on a file item.
203 </p><p>
204 It emits the signal sourceFile or designerFile depending on the
205 file extension.
206 </p><dl>
207 <dt><i>itm</i></dt>
208 <dd>
209 the double clicked listview item (QTreeWidgetItem)
210 </dd><dt><i>column</i></dt>
211 <dd>
212 column that was double clicked (integer) (ignored)
213 </dd>
214 </dl><a NAME="FindFileNameDialog.on_fileNameEdit_textChanged" ID="FindFileNameDialog.on_fileNameEdit_textChanged"></a>
215 <h4>FindFileNameDialog.on_fileNameEdit_textChanged</h4>
216 <b>on_fileNameEdit_textChanged</b>(<i>text</i>)
217 <p>
218 Private slot to handle the textChanged signal of the file name edit.
219 </p><dl>
220 <dt><i>text</i></dt>
221 <dd>
222 (ignored)
223 </dd>
224 </dl><a NAME="FindFileNameDialog.on_projectCheckBox_toggled" ID="FindFileNameDialog.on_projectCheckBox_toggled"></a>
225 <h4>FindFileNameDialog.on_projectCheckBox_toggled</h4>
226 <b>on_projectCheckBox_toggled</b>(<i>checked</i>)
227 <p>
228 Private slot to handle the toggled signal of the project checkbox.
229 </p><dl>
230 <dt><i>checked</i></dt>
231 <dd>
232 flag indicating the state of the checkbox (boolean)
233 </dd>
234 </dl><a NAME="FindFileNameDialog.on_searchDirButton_clicked" ID="FindFileNameDialog.on_searchDirButton_clicked"></a>
235 <h4>FindFileNameDialog.on_searchDirButton_clicked</h4>
236 <b>on_searchDirButton_clicked</b>(<i></i>)
237 <p>
238 Private slot to handle the clicked signal of the search directory
239 selection button.
240 </p><a NAME="FindFileNameDialog.on_searchDirCheckBox_toggled" ID="FindFileNameDialog.on_searchDirCheckBox_toggled"></a>
241 <h4>FindFileNameDialog.on_searchDirCheckBox_toggled</h4>
242 <b>on_searchDirCheckBox_toggled</b>(<i>checked</i>)
243 <p>
244 Private slot to handle the toggled signal of the search directory
245 checkbox.
246 </p><dl>
247 <dt><i>checked</i></dt>
248 <dd>
249 flag indicating the state of the checkbox (boolean)
250 </dd>
251 </dl><a NAME="FindFileNameDialog.on_searchDirEdit_textChanged" ID="FindFileNameDialog.on_searchDirEdit_textChanged"></a>
252 <h4>FindFileNameDialog.on_searchDirEdit_textChanged</h4>
253 <b>on_searchDirEdit_textChanged</b>(<i>text</i>)
254 <p>
255 Private slot to handle the textChanged signal of the search directory
256 edit.
257 </p><dl>
258 <dt><i>text</i></dt>
259 <dd>
260 text of the search dir edit (string)
261 </dd>
262 </dl><a NAME="FindFileNameDialog.on_syspathCheckBox_toggled" ID="FindFileNameDialog.on_syspathCheckBox_toggled"></a>
263 <h4>FindFileNameDialog.on_syspathCheckBox_toggled</h4>
264 <b>on_syspathCheckBox_toggled</b>(<i>checked</i>)
265 <p>
266 Private slot to handle the toggled signal of the sys.path checkbox.
267 </p><dl>
268 <dt><i>checked</i></dt>
269 <dd>
270 flag indicating the state of the checkbox (boolean)
271 </dd>
272 </dl><a NAME="FindFileNameDialog.show" ID="FindFileNameDialog.show"></a>
273 <h4>FindFileNameDialog.show</h4>
274 <b>show</b>(<i></i>)
275 <p>
276 Public method to enable/disable the project checkbox.
277 </p>
278 <div align="right"><a href="#top">Up</a></div>
279 <hr />
280 </body></html>

Mercurial Repository: eric

eric ide

mercurial