Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.Project.ProjectBrowser.html

changeset 3673
e26d7d0c1088
child 5988
3cd2d5b75cdb
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Project.ProjectBrowser</h1>
23 <p>
24 Module implementing the project browser part of the eric6 UI.
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="#ProjectBrowser">ProjectBrowser</a></td>
34 <td>Class implementing the project browser part of the eric6 UI.</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="ProjectBrowser" ID="ProjectBrowser"></a>
43 <h2>ProjectBrowser</h2>
44 <p>
45 Class implementing the project browser part of the eric6 UI.
46 </p><p>
47 It generates a widget with up to seven tabs. The individual tabs contain
48 the project sources browser, the project forms browser,
49 the project resources browser, the project translations browser,
50 the project interfaces (IDL) browser and a browser for stuff,
51 that doesn't fit these categories. Optionally it contains an additional
52 tab with the file system browser.
53 </p>
54 <h3>Derived from</h3>
55 E5TabWidget
56 <h3>Class Attributes</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Class Methods</h3>
61 <table>
62 <tr><td>None</td></tr>
63 </table>
64 <h3>Methods</h3>
65 <table>
66 <tr>
67 <td><a href="#ProjectBrowser.__init__">ProjectBrowser</a></td>
68 <td>Constructor</td>
69 </tr><tr>
70 <td><a href="#ProjectBrowser.__currentChanged">__currentChanged</a></td>
71 <td>Private slot to handle the currentChanged(int) signal.</td>
72 </tr><tr>
73 <td><a href="#ProjectBrowser.__newProject">__newProject</a></td>
74 <td>Private slot to handle the newProject signal.</td>
75 </tr><tr>
76 <td><a href="#ProjectBrowser.__projectClosed">__projectClosed</a></td>
77 <td>Private slot to handle the projectClosed signal.</td>
78 </tr><tr>
79 <td><a href="#ProjectBrowser.__projectOpened">__projectOpened</a></td>
80 <td>Private slot to handle the projectOpened signal.</td>
81 </tr><tr>
82 <td><a href="#ProjectBrowser.__projectPropertiesChanged">__projectPropertiesChanged</a></td>
83 <td>Private slot to handle the projectPropertiesChanged signal.</td>
84 </tr><tr>
85 <td><a href="#ProjectBrowser.__setBrowsersAvailable">__setBrowsersAvailable</a></td>
86 <td>Private method to add selected browsers to the project browser.</td>
87 </tr><tr>
88 <td><a href="#ProjectBrowser.__setSourcesIcon">__setSourcesIcon</a></td>
89 <td>Private method to set the right icon for the sources browser tab.</td>
90 </tr><tr>
91 <td><a href="#ProjectBrowser.__vcsStateChanged">__vcsStateChanged</a></td>
92 <td>Private slot to handle a change in the vcs state.</td>
93 </tr><tr>
94 <td><a href="#ProjectBrowser.__vcsStatusIndicatorClicked">__vcsStatusIndicatorClicked</a></td>
95 <td>Private slot to react upon clicks on the VCS indicator LED.</td>
96 </tr><tr>
97 <td><a href="#ProjectBrowser.getProjectBrowser">getProjectBrowser</a></td>
98 <td>Public method to get a reference to the named project browser.</td>
99 </tr><tr>
100 <td><a href="#ProjectBrowser.getProjectBrowserNames">getProjectBrowserNames</a></td>
101 <td>Public method to get the names of the various project browsers.</td>
102 </tr><tr>
103 <td><a href="#ProjectBrowser.getProjectBrowsers">getProjectBrowsers</a></td>
104 <td>Public method to get references to the individual project browsers.</td>
105 </tr><tr>
106 <td><a href="#ProjectBrowser.handleEditorChanged">handleEditorChanged</a></td>
107 <td>Public slot to handle the editorChanged signal.</td>
108 </tr><tr>
109 <td><a href="#ProjectBrowser.handleEditorLineChanged">handleEditorLineChanged</a></td>
110 <td>Public slot to handle the editorLineChanged signal.</td>
111 </tr><tr>
112 <td><a href="#ProjectBrowser.handlePreferencesChanged">handlePreferencesChanged</a></td>
113 <td>Public slot used to handle the preferencesChanged signal.</td>
114 </tr><tr>
115 <td><a href="#ProjectBrowser.showEvent">showEvent</a></td>
116 <td>Protected method handleing the show event.</td>
117 </tr>
118 </table>
119 <h3>Static Methods</h3>
120 <table>
121 <tr><td>None</td></tr>
122 </table>
123 <a NAME="ProjectBrowser.__init__" ID="ProjectBrowser.__init__"></a>
124 <h4>ProjectBrowser (Constructor)</h4>
125 <b>ProjectBrowser</b>(<i>project, parent=None, embeddedBrowser=True</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 (QWidget)
135 </dd><dt><i>embeddedBrowser</i></dt>
136 <dd>
137 flag indicating whether the file browser should
138 be included. This flag is set to False by those layouts, that
139 have the file browser in a separate window or embedded
140 in the debeug browser instead
141 </dd>
142 </dl><a NAME="ProjectBrowser.__currentChanged" ID="ProjectBrowser.__currentChanged"></a>
143 <h4>ProjectBrowser.__currentChanged</h4>
144 <b>__currentChanged</b>(<i>index</i>)
145 <p>
146 Private slot to handle the currentChanged(int) signal.
147 </p><dl>
148 <dt><i>index</i></dt>
149 <dd>
150 index of the tab (integer)
151 </dd>
152 </dl><a NAME="ProjectBrowser.__newProject" ID="ProjectBrowser.__newProject"></a>
153 <h4>ProjectBrowser.__newProject</h4>
154 <b>__newProject</b>(<i></i>)
155 <p>
156 Private slot to handle the newProject signal.
157 </p><a NAME="ProjectBrowser.__projectClosed" ID="ProjectBrowser.__projectClosed"></a>
158 <h4>ProjectBrowser.__projectClosed</h4>
159 <b>__projectClosed</b>(<i></i>)
160 <p>
161 Private slot to handle the projectClosed signal.
162 </p><a NAME="ProjectBrowser.__projectOpened" ID="ProjectBrowser.__projectOpened"></a>
163 <h4>ProjectBrowser.__projectOpened</h4>
164 <b>__projectOpened</b>(<i></i>)
165 <p>
166 Private slot to handle the projectOpened signal.
167 </p><a NAME="ProjectBrowser.__projectPropertiesChanged" ID="ProjectBrowser.__projectPropertiesChanged"></a>
168 <h4>ProjectBrowser.__projectPropertiesChanged</h4>
169 <b>__projectPropertiesChanged</b>(<i></i>)
170 <p>
171 Private slot to handle the projectPropertiesChanged signal.
172 </p><a NAME="ProjectBrowser.__setBrowsersAvailable" ID="ProjectBrowser.__setBrowsersAvailable"></a>
173 <h4>ProjectBrowser.__setBrowsersAvailable</h4>
174 <b>__setBrowsersAvailable</b>(<i>browserFlags</i>)
175 <p>
176 Private method to add selected browsers to the project browser.
177 </p><dl>
178 <dt><i>browserFlags</i></dt>
179 <dd>
180 flags indicating the browsers to add (integer)
181 </dd>
182 </dl><a NAME="ProjectBrowser.__setSourcesIcon" ID="ProjectBrowser.__setSourcesIcon"></a>
183 <h4>ProjectBrowser.__setSourcesIcon</h4>
184 <b>__setSourcesIcon</b>(<i></i>)
185 <p>
186 Private method to set the right icon for the sources browser tab.
187 </p><a NAME="ProjectBrowser.__vcsStateChanged" ID="ProjectBrowser.__vcsStateChanged"></a>
188 <h4>ProjectBrowser.__vcsStateChanged</h4>
189 <b>__vcsStateChanged</b>(<i>state</i>)
190 <p>
191 Private slot to handle a change in the vcs state.
192 </p><dl>
193 <dt><i>state</i></dt>
194 <dd>
195 new vcs state (string)
196 </dd>
197 </dl><a NAME="ProjectBrowser.__vcsStatusIndicatorClicked" ID="ProjectBrowser.__vcsStatusIndicatorClicked"></a>
198 <h4>ProjectBrowser.__vcsStatusIndicatorClicked</h4>
199 <b>__vcsStatusIndicatorClicked</b>(<i>pos</i>)
200 <p>
201 Private slot to react upon clicks on the VCS indicator LED.
202 </p><dl>
203 <dt><i>pos</i></dt>
204 <dd>
205 position of the click (QPoint)
206 </dd>
207 </dl><a NAME="ProjectBrowser.getProjectBrowser" ID="ProjectBrowser.getProjectBrowser"></a>
208 <h4>ProjectBrowser.getProjectBrowser</h4>
209 <b>getProjectBrowser</b>(<i>name</i>)
210 <p>
211 Public method to get a reference to the named project browser.
212 </p><dl>
213 <dt><i>name</i></dt>
214 <dd>
215 name of the requested project browser (string).
216 Valid names are "sources, forms, resources, translations,
217 interfaces, others".
218 </dd>
219 </dl><dl>
220 <dt>Returns:</dt>
221 <dd>
222 reference to the requested browser or None
223 </dd>
224 </dl><a NAME="ProjectBrowser.getProjectBrowserNames" ID="ProjectBrowser.getProjectBrowserNames"></a>
225 <h4>ProjectBrowser.getProjectBrowserNames</h4>
226 <b>getProjectBrowserNames</b>(<i></i>)
227 <p>
228 Public method to get the names of the various project browsers.
229 </p><dl>
230 <dt>Returns:</dt>
231 <dd>
232 list of project browser names (list of string)
233 </dd>
234 </dl><a NAME="ProjectBrowser.getProjectBrowsers" ID="ProjectBrowser.getProjectBrowsers"></a>
235 <h4>ProjectBrowser.getProjectBrowsers</h4>
236 <b>getProjectBrowsers</b>(<i></i>)
237 <p>
238 Public method to get references to the individual project browsers.
239 </p><dl>
240 <dt>Returns:</dt>
241 <dd>
242 list of references to project browsers
243 </dd>
244 </dl><a NAME="ProjectBrowser.handleEditorChanged" ID="ProjectBrowser.handleEditorChanged"></a>
245 <h4>ProjectBrowser.handleEditorChanged</h4>
246 <b>handleEditorChanged</b>(<i>fn</i>)
247 <p>
248 Public slot to handle the editorChanged signal.
249 </p><dl>
250 <dt><i>fn</i></dt>
251 <dd>
252 filename of the changed file (string)
253 </dd>
254 </dl><a NAME="ProjectBrowser.handleEditorLineChanged" ID="ProjectBrowser.handleEditorLineChanged"></a>
255 <h4>ProjectBrowser.handleEditorLineChanged</h4>
256 <b>handleEditorLineChanged</b>(<i>fn, lineno</i>)
257 <p>
258 Public slot to handle the editorLineChanged signal.
259 </p><dl>
260 <dt><i>fn</i></dt>
261 <dd>
262 filename of the changed file (string)
263 </dd><dt><i>lineno</i></dt>
264 <dd>
265 one based line number of the item (integer)
266 </dd>
267 </dl><a NAME="ProjectBrowser.handlePreferencesChanged" ID="ProjectBrowser.handlePreferencesChanged"></a>
268 <h4>ProjectBrowser.handlePreferencesChanged</h4>
269 <b>handlePreferencesChanged</b>(<i></i>)
270 <p>
271 Public slot used to handle the preferencesChanged signal.
272 </p><a NAME="ProjectBrowser.showEvent" ID="ProjectBrowser.showEvent"></a>
273 <h4>ProjectBrowser.showEvent</h4>
274 <b>showEvent</b>(<i>evt</i>)
275 <p>
276 Protected method handleing the show event.
277 </p><dl>
278 <dt><i>evt</i></dt>
279 <dd>
280 show event to handle (QShowEvent)
281 </dd>
282 </dl>
283 <div align="right"><a href="#top">Up</a></div>
284 <hr />
285 </body></html>

Mercurial Repository: eric

eric ide

mercurial