Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Project.ProjectBrowser.html

eric7/Documentation/Source/eric7.Project.ProjectBrowser.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.Project.ProjectBrowser</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.Project.ProjectBrowser</h1>
24
25 <p>
26 Module implementing the project browser part of the eric UI.
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="#ProjectBrowser">ProjectBrowser</a></td>
39 <td>Class implementing the project browser part of the eric UI.</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="ProjectBrowser" ID="ProjectBrowser"></a>
50 <h2>ProjectBrowser</h2>
51
52 <p>
53 Class implementing the project browser part of the eric UI.
54 </p>
55 <p>
56 It generates a widget with up to seven tabs. The individual tabs contain
57 the project sources browser, the project forms browser,
58 the project resources browser, the project translations browser,
59 the project interfaces (IDL) browser and a browser for stuff,
60 that doesn't fit these categories. Optionally it contains an additional
61 tab with the file system browser.
62 </p>
63 <h3>Derived from</h3>
64 EricTabWidget
65 <h3>Class Attributes</h3>
66
67 <table>
68 <tr><td>None</td></tr>
69 </table>
70 <h3>Class Methods</h3>
71
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75 <h3>Methods</h3>
76
77 <table>
78
79 <tr>
80 <td><a href="#ProjectBrowser.__init__">ProjectBrowser</a></td>
81 <td>Constructor</td>
82 </tr>
83 <tr>
84 <td><a href="#ProjectBrowser.__currentChanged">__currentChanged</a></td>
85 <td>Private slot to handle the currentChanged(int) signal.</td>
86 </tr>
87 <tr>
88 <td><a href="#ProjectBrowser.__newProject">__newProject</a></td>
89 <td>Private slot to handle the newProject signal.</td>
90 </tr>
91 <tr>
92 <td><a href="#ProjectBrowser.__projectClosed">__projectClosed</a></td>
93 <td>Private slot to handle the projectClosed signal.</td>
94 </tr>
95 <tr>
96 <td><a href="#ProjectBrowser.__projectOpened">__projectOpened</a></td>
97 <td>Private slot to handle the projectOpened signal.</td>
98 </tr>
99 <tr>
100 <td><a href="#ProjectBrowser.__projectPropertiesChanged">__projectPropertiesChanged</a></td>
101 <td>Private slot to handle the projectPropertiesChanged signal.</td>
102 </tr>
103 <tr>
104 <td><a href="#ProjectBrowser.__setBrowsersAvailable">__setBrowsersAvailable</a></td>
105 <td>Private method to add selected browsers to the project browser.</td>
106 </tr>
107 <tr>
108 <td><a href="#ProjectBrowser.__setSourcesIcon">__setSourcesIcon</a></td>
109 <td>Private method to set the right icon for the sources browser tab.</td>
110 </tr>
111 <tr>
112 <td><a href="#ProjectBrowser.__vcsStateChanged">__vcsStateChanged</a></td>
113 <td>Private slot to handle a change in the vcs state.</td>
114 </tr>
115 <tr>
116 <td><a href="#ProjectBrowser.__vcsStatusIndicatorClicked">__vcsStatusIndicatorClicked</a></td>
117 <td>Private slot to react upon clicks on the VCS indicator LED.</td>
118 </tr>
119 <tr>
120 <td><a href="#ProjectBrowser.getProjectBrowser">getProjectBrowser</a></td>
121 <td>Public method to get a reference to the named project browser.</td>
122 </tr>
123 <tr>
124 <td><a href="#ProjectBrowser.getProjectBrowserNames">getProjectBrowserNames</a></td>
125 <td>Public method to get the names of the various project browsers.</td>
126 </tr>
127 <tr>
128 <td><a href="#ProjectBrowser.getProjectBrowsers">getProjectBrowsers</a></td>
129 <td>Public method to get references to the individual project browsers.</td>
130 </tr>
131 <tr>
132 <td><a href="#ProjectBrowser.handleEditorChanged">handleEditorChanged</a></td>
133 <td>Public slot to handle the editorChanged signal.</td>
134 </tr>
135 <tr>
136 <td><a href="#ProjectBrowser.handleEditorLineChanged">handleEditorLineChanged</a></td>
137 <td>Public slot to handle the editorLineChanged signal.</td>
138 </tr>
139 <tr>
140 <td><a href="#ProjectBrowser.handlePreferencesChanged">handlePreferencesChanged</a></td>
141 <td>Public slot used to handle the preferencesChanged signal.</td>
142 </tr>
143 </table>
144 <h3>Static Methods</h3>
145
146 <table>
147 <tr><td>None</td></tr>
148 </table>
149
150 <a NAME="ProjectBrowser.__init__" ID="ProjectBrowser.__init__"></a>
151 <h4>ProjectBrowser (Constructor)</h4>
152 <b>ProjectBrowser</b>(<i>project, parent=None</i>)
153
154 <p>
155 Constructor
156 </p>
157 <dl>
158
159 <dt><i>project</i></dt>
160 <dd>
161 reference to the project object
162 </dd>
163 <dt><i>parent</i></dt>
164 <dd>
165 parent widget (QWidget)
166 </dd>
167 </dl>
168 <a NAME="ProjectBrowser.__currentChanged" ID="ProjectBrowser.__currentChanged"></a>
169 <h4>ProjectBrowser.__currentChanged</h4>
170 <b>__currentChanged</b>(<i>index</i>)
171
172 <p>
173 Private slot to handle the currentChanged(int) signal.
174 </p>
175 <dl>
176
177 <dt><i>index</i></dt>
178 <dd>
179 index of the tab (integer)
180 </dd>
181 </dl>
182 <a NAME="ProjectBrowser.__newProject" ID="ProjectBrowser.__newProject"></a>
183 <h4>ProjectBrowser.__newProject</h4>
184 <b>__newProject</b>(<i></i>)
185
186 <p>
187 Private slot to handle the newProject signal.
188 </p>
189 <a NAME="ProjectBrowser.__projectClosed" ID="ProjectBrowser.__projectClosed"></a>
190 <h4>ProjectBrowser.__projectClosed</h4>
191 <b>__projectClosed</b>(<i></i>)
192
193 <p>
194 Private slot to handle the projectClosed signal.
195 </p>
196 <a NAME="ProjectBrowser.__projectOpened" ID="ProjectBrowser.__projectOpened"></a>
197 <h4>ProjectBrowser.__projectOpened</h4>
198 <b>__projectOpened</b>(<i></i>)
199
200 <p>
201 Private slot to handle the projectOpened signal.
202 </p>
203 <a NAME="ProjectBrowser.__projectPropertiesChanged" ID="ProjectBrowser.__projectPropertiesChanged"></a>
204 <h4>ProjectBrowser.__projectPropertiesChanged</h4>
205 <b>__projectPropertiesChanged</b>(<i></i>)
206
207 <p>
208 Private slot to handle the projectPropertiesChanged signal.
209 </p>
210 <a NAME="ProjectBrowser.__setBrowsersAvailable" ID="ProjectBrowser.__setBrowsersAvailable"></a>
211 <h4>ProjectBrowser.__setBrowsersAvailable</h4>
212 <b>__setBrowsersAvailable</b>(<i>browserFlags</i>)
213
214 <p>
215 Private method to add selected browsers to the project browser.
216 </p>
217 <dl>
218
219 <dt><i>browserFlags</i></dt>
220 <dd>
221 flags indicating the browsers to add (integer)
222 </dd>
223 </dl>
224 <a NAME="ProjectBrowser.__setSourcesIcon" ID="ProjectBrowser.__setSourcesIcon"></a>
225 <h4>ProjectBrowser.__setSourcesIcon</h4>
226 <b>__setSourcesIcon</b>(<i></i>)
227
228 <p>
229 Private method to set the right icon for the sources browser tab.
230 </p>
231 <a NAME="ProjectBrowser.__vcsStateChanged" ID="ProjectBrowser.__vcsStateChanged"></a>
232 <h4>ProjectBrowser.__vcsStateChanged</h4>
233 <b>__vcsStateChanged</b>(<i>state</i>)
234
235 <p>
236 Private slot to handle a change in the vcs state.
237 </p>
238 <dl>
239
240 <dt><i>state</i></dt>
241 <dd>
242 new vcs state (string)
243 </dd>
244 </dl>
245 <a NAME="ProjectBrowser.__vcsStatusIndicatorClicked" ID="ProjectBrowser.__vcsStatusIndicatorClicked"></a>
246 <h4>ProjectBrowser.__vcsStatusIndicatorClicked</h4>
247 <b>__vcsStatusIndicatorClicked</b>(<i>pos</i>)
248
249 <p>
250 Private slot to react upon clicks on the VCS indicator LED.
251 </p>
252 <dl>
253
254 <dt><i>pos</i></dt>
255 <dd>
256 position of the click (QPoint)
257 </dd>
258 </dl>
259 <a NAME="ProjectBrowser.getProjectBrowser" ID="ProjectBrowser.getProjectBrowser"></a>
260 <h4>ProjectBrowser.getProjectBrowser</h4>
261 <b>getProjectBrowser</b>(<i>name</i>)
262
263 <p>
264 Public method to get a reference to the named project browser.
265 </p>
266 <dl>
267
268 <dt><i>name</i></dt>
269 <dd>
270 name of the requested project browser (string).
271 Valid names are "sources, forms, resources, translations,
272 interfaces, protocols, others".
273 </dd>
274 </dl>
275 <dl>
276 <dt>Return:</dt>
277 <dd>
278 reference to the requested browser or None
279 </dd>
280 </dl>
281 <a NAME="ProjectBrowser.getProjectBrowserNames" ID="ProjectBrowser.getProjectBrowserNames"></a>
282 <h4>ProjectBrowser.getProjectBrowserNames</h4>
283 <b>getProjectBrowserNames</b>(<i></i>)
284
285 <p>
286 Public method to get the names of the various project browsers.
287 </p>
288 <dl>
289 <dt>Return:</dt>
290 <dd>
291 list of project browser names (list of string)
292 </dd>
293 </dl>
294 <a NAME="ProjectBrowser.getProjectBrowsers" ID="ProjectBrowser.getProjectBrowsers"></a>
295 <h4>ProjectBrowser.getProjectBrowsers</h4>
296 <b>getProjectBrowsers</b>(<i></i>)
297
298 <p>
299 Public method to get references to the individual project browsers.
300 </p>
301 <dl>
302 <dt>Return:</dt>
303 <dd>
304 list of references to project browsers
305 </dd>
306 </dl>
307 <a NAME="ProjectBrowser.handleEditorChanged" ID="ProjectBrowser.handleEditorChanged"></a>
308 <h4>ProjectBrowser.handleEditorChanged</h4>
309 <b>handleEditorChanged</b>(<i>fn</i>)
310
311 <p>
312 Public slot to handle the editorChanged signal.
313 </p>
314 <dl>
315
316 <dt><i>fn</i></dt>
317 <dd>
318 filename of the changed file (string)
319 </dd>
320 </dl>
321 <a NAME="ProjectBrowser.handleEditorLineChanged" ID="ProjectBrowser.handleEditorLineChanged"></a>
322 <h4>ProjectBrowser.handleEditorLineChanged</h4>
323 <b>handleEditorLineChanged</b>(<i>fn, lineno</i>)
324
325 <p>
326 Public slot to handle the editorLineChanged signal.
327 </p>
328 <dl>
329
330 <dt><i>fn</i></dt>
331 <dd>
332 filename of the changed file (string)
333 </dd>
334 <dt><i>lineno</i></dt>
335 <dd>
336 one based line number of the item (integer)
337 </dd>
338 </dl>
339 <a NAME="ProjectBrowser.handlePreferencesChanged" ID="ProjectBrowser.handlePreferencesChanged"></a>
340 <h4>ProjectBrowser.handlePreferencesChanged</h4>
341 <b>handlePreferencesChanged</b>(<i></i>)
342
343 <p>
344 Public slot used to handle the preferencesChanged signal.
345 </p>
346 <div align="right"><a href="#top">Up</a></div>
347 <hr />
348 </body></html>

Mercurial Repository: eric

eric ide

mercurial