Mercurial Repositories > eric / file comparison

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

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

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
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>
115 </table>
116 <h3>Static Methods</h3>
117 <table>
118 <tr><td>None</td></tr>
119 </table>
120 <a NAME="ProjectBrowser.__init__" ID="ProjectBrowser.__init__"></a>
121 <h4>ProjectBrowser (Constructor)</h4>
122 <b>ProjectBrowser</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 (QWidget)
132 </dd>
133 </dl><a NAME="ProjectBrowser.__currentChanged" ID="ProjectBrowser.__currentChanged"></a>
134 <h4>ProjectBrowser.__currentChanged</h4>
135 <b>__currentChanged</b>(<i>index</i>)
136 <p>
137 Private slot to handle the currentChanged(int) signal.
138 </p><dl>
139 <dt><i>index</i></dt>
140 <dd>
141 index of the tab (integer)
142 </dd>
143 </dl><a NAME="ProjectBrowser.__newProject" ID="ProjectBrowser.__newProject"></a>
144 <h4>ProjectBrowser.__newProject</h4>
145 <b>__newProject</b>(<i></i>)
146 <p>
147 Private slot to handle the newProject signal.
148 </p><a NAME="ProjectBrowser.__projectClosed" ID="ProjectBrowser.__projectClosed"></a>
149 <h4>ProjectBrowser.__projectClosed</h4>
150 <b>__projectClosed</b>(<i></i>)
151 <p>
152 Private slot to handle the projectClosed signal.
153 </p><a NAME="ProjectBrowser.__projectOpened" ID="ProjectBrowser.__projectOpened"></a>
154 <h4>ProjectBrowser.__projectOpened</h4>
155 <b>__projectOpened</b>(<i></i>)
156 <p>
157 Private slot to handle the projectOpened signal.
158 </p><a NAME="ProjectBrowser.__projectPropertiesChanged" ID="ProjectBrowser.__projectPropertiesChanged"></a>
159 <h4>ProjectBrowser.__projectPropertiesChanged</h4>
160 <b>__projectPropertiesChanged</b>(<i></i>)
161 <p>
162 Private slot to handle the projectPropertiesChanged signal.
163 </p><a NAME="ProjectBrowser.__setBrowsersAvailable" ID="ProjectBrowser.__setBrowsersAvailable"></a>
164 <h4>ProjectBrowser.__setBrowsersAvailable</h4>
165 <b>__setBrowsersAvailable</b>(<i>browserFlags</i>)
166 <p>
167 Private method to add selected browsers to the project browser.
168 </p><dl>
169 <dt><i>browserFlags</i></dt>
170 <dd>
171 flags indicating the browsers to add (integer)
172 </dd>
173 </dl><a NAME="ProjectBrowser.__setSourcesIcon" ID="ProjectBrowser.__setSourcesIcon"></a>
174 <h4>ProjectBrowser.__setSourcesIcon</h4>
175 <b>__setSourcesIcon</b>(<i></i>)
176 <p>
177 Private method to set the right icon for the sources browser tab.
178 </p><a NAME="ProjectBrowser.__vcsStateChanged" ID="ProjectBrowser.__vcsStateChanged"></a>
179 <h4>ProjectBrowser.__vcsStateChanged</h4>
180 <b>__vcsStateChanged</b>(<i>state</i>)
181 <p>
182 Private slot to handle a change in the vcs state.
183 </p><dl>
184 <dt><i>state</i></dt>
185 <dd>
186 new vcs state (string)
187 </dd>
188 </dl><a NAME="ProjectBrowser.__vcsStatusIndicatorClicked" ID="ProjectBrowser.__vcsStatusIndicatorClicked"></a>
189 <h4>ProjectBrowser.__vcsStatusIndicatorClicked</h4>
190 <b>__vcsStatusIndicatorClicked</b>(<i>pos</i>)
191 <p>
192 Private slot to react upon clicks on the VCS indicator LED.
193 </p><dl>
194 <dt><i>pos</i></dt>
195 <dd>
196 position of the click (QPoint)
197 </dd>
198 </dl><a NAME="ProjectBrowser.getProjectBrowser" ID="ProjectBrowser.getProjectBrowser"></a>
199 <h4>ProjectBrowser.getProjectBrowser</h4>
200 <b>getProjectBrowser</b>(<i>name</i>)
201 <p>
202 Public method to get a reference to the named project browser.
203 </p><dl>
204 <dt><i>name</i></dt>
205 <dd>
206 name of the requested project browser (string).
207 Valid names are "sources, forms, resources, translations,
208 interfaces, protocols, others".
209 </dd>
210 </dl><dl>
211 <dt>Returns:</dt>
212 <dd>
213 reference to the requested browser or None
214 </dd>
215 </dl><a NAME="ProjectBrowser.getProjectBrowserNames" ID="ProjectBrowser.getProjectBrowserNames"></a>
216 <h4>ProjectBrowser.getProjectBrowserNames</h4>
217 <b>getProjectBrowserNames</b>(<i></i>)
218 <p>
219 Public method to get the names of the various project browsers.
220 </p><dl>
221 <dt>Returns:</dt>
222 <dd>
223 list of project browser names (list of string)
224 </dd>
225 </dl><a NAME="ProjectBrowser.getProjectBrowsers" ID="ProjectBrowser.getProjectBrowsers"></a>
226 <h4>ProjectBrowser.getProjectBrowsers</h4>
227 <b>getProjectBrowsers</b>(<i></i>)
228 <p>
229 Public method to get references to the individual project browsers.
230 </p><dl>
231 <dt>Returns:</dt>
232 <dd>
233 list of references to project browsers
234 </dd>
235 </dl><a NAME="ProjectBrowser.handleEditorChanged" ID="ProjectBrowser.handleEditorChanged"></a>
236 <h4>ProjectBrowser.handleEditorChanged</h4>
237 <b>handleEditorChanged</b>(<i>fn</i>)
238 <p>
239 Public slot to handle the editorChanged signal.
240 </p><dl>
241 <dt><i>fn</i></dt>
242 <dd>
243 filename of the changed file (string)
244 </dd>
245 </dl><a NAME="ProjectBrowser.handleEditorLineChanged" ID="ProjectBrowser.handleEditorLineChanged"></a>
246 <h4>ProjectBrowser.handleEditorLineChanged</h4>
247 <b>handleEditorLineChanged</b>(<i>fn, lineno</i>)
248 <p>
249 Public slot to handle the editorLineChanged signal.
250 </p><dl>
251 <dt><i>fn</i></dt>
252 <dd>
253 filename of the changed file (string)
254 </dd><dt><i>lineno</i></dt>
255 <dd>
256 one based line number of the item (integer)
257 </dd>
258 </dl><a NAME="ProjectBrowser.handlePreferencesChanged" ID="ProjectBrowser.handlePreferencesChanged"></a>
259 <h4>ProjectBrowser.handlePreferencesChanged</h4>
260 <b>handlePreferencesChanged</b>(<i></i>)
261 <p>
262 Public slot used to handle the preferencesChanged signal.
263 </p>
264 <div align="right"><a href="#top">Up</a></div>
265 <hr />
266 </body></html>

Mercurial Repository: eric

eric ide

mercurial