Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial