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