Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.Project.ProjectBrowser.html
Documentation/Source/eric4.Project.ProjectBrowser.html
- changeset 17
- edde1fe80b3e
- parent 16
- 892c1787d666
- child 18
- 3b1f5d872fd7
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric4.Project.ProjectBrowser</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.Project.ProjectBrowser</h1> | |
| 24 <p> | |
| 25 Module implementing the project browser part of the eric4 UI. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#ProjectBrowser">ProjectBrowser</a></td> | |
| 35 <td>Class implementing the project browser part of the eric4 UI.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="ProjectBrowser" ID="ProjectBrowser"></a> | |
| 44 <h2>ProjectBrowser</h2> | |
| 45 <p> | |
| 46 Class implementing the project browser part of the eric4 UI. | |
| 47 </p><p> | |
| 48 It generates a widget with up to seven tabs. The individual tabs contain | |
| 49 the project sources browser, the project forms browser, | |
| 50 the project resources browser, the project translations browser, | |
| 51 the project interfaces (IDL) browser and a browser for stuff, | |
| 52 that doesn't fit these categories. Optionally it contains an additional | |
| 53 tab with the file system browser. | |
| 54 </p> | |
| 55 <h3>Derived from</h3> | |
| 56 E4TabWidget | |
| 57 <h3>Class Attributes</h3> | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Methods</h3> | |
| 62 <table> | |
| 63 <tr> | |
| 64 <td><a href="#ProjectBrowser.__init__">ProjectBrowser</a></td> | |
| 65 <td>Constructor</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#ProjectBrowser.__currentChanged">__currentChanged</a></td> | |
| 68 <td>Private slot to handle the currentChanged(int) signal.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#ProjectBrowser.__newProject">__newProject</a></td> | |
| 71 <td>Private slot to handle the newProject signal.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#ProjectBrowser.__projectClosed">__projectClosed</a></td> | |
| 74 <td>Private slot to handle the projectClosed signal.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#ProjectBrowser.__projectOpened">__projectOpened</a></td> | |
| 77 <td>Private slot to handle the projectOpened signal.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#ProjectBrowser.__projectPropertiesChanged">__projectPropertiesChanged</a></td> | |
| 80 <td>Private slot to handle the projectPropertiesChanged signal.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#ProjectBrowser.__setBrowsersAvailable">__setBrowsersAvailable</a></td> | |
| 83 <td>Private method to add selected browsers to the project browser</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#ProjectBrowser.__setSourcesIcon">__setSourcesIcon</a></td> | |
| 86 <td>Private method to set the right icon for the sources browser tab.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#ProjectBrowser.__vcsStateChanged">__vcsStateChanged</a></td> | |
| 89 <td>Private slot to handle a change in the vcs state.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#ProjectBrowser.getProjectBrowser">getProjectBrowser</a></td> | |
| 92 <td>Public method to get a reference to the named project browser.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#ProjectBrowser.getProjectBrowsers">getProjectBrowsers</a></td> | |
| 95 <td>Public method to get references to the individual project browsers.</td> | |
| 96 </tr><tr> | |
| 97 <td><a href="#ProjectBrowser.handleEditorChanged">handleEditorChanged</a></td> | |
| 98 <td>Public slot to handle the editorChanged signal.</td> | |
| 99 </tr><tr> | |
| 100 <td><a href="#ProjectBrowser.handlePreferencesChanged">handlePreferencesChanged</a></td> | |
| 101 <td>Public slot used to handle the preferencesChanged signal.</td> | |
| 102 </tr><tr> | |
| 103 <td><a href="#ProjectBrowser.showEvent">showEvent</a></td> | |
| 104 <td>Protected method handleing the show event.</td> | |
| 105 </tr> | |
| 106 </table> | |
| 107 <a NAME="ProjectBrowser.__init__" ID="ProjectBrowser.__init__"></a> | |
| 108 <h4>ProjectBrowser (Constructor)</h4> | |
| 109 <b>ProjectBrowser</b>(<i>project, parent = None, embeddedBrowser = True</i>) | |
| 110 <p> | |
| 111 Constructor | |
| 112 </p><dl> | |
| 113 <dt><i>project</i></dt> | |
| 114 <dd> | |
| 115 reference to the project object | |
| 116 </dd><dt><i>parent</i></dt> | |
| 117 <dd> | |
| 118 parent widget (QWidget) | |
| 119 </dd><dt><i>embeddedBrowser</i></dt> | |
| 120 <dd> | |
| 121 flag indicating whether the file browser should | |
| 122 be included. This flag is set to False by those layouts, that | |
| 123 have the file browser in a separate window or embedded | |
| 124 in the debeug browser instead | |
| 125 </dd> | |
| 126 </dl><a NAME="ProjectBrowser.__currentChanged" ID="ProjectBrowser.__currentChanged"></a> | |
| 127 <h4>ProjectBrowser.__currentChanged</h4> | |
| 128 <b>__currentChanged</b>(<i>index</i>) | |
| 129 <p> | |
| 130 Private slot to handle the currentChanged(int) signal. | |
| 131 </p><a NAME="ProjectBrowser.__newProject" ID="ProjectBrowser.__newProject"></a> | |
| 132 <h4>ProjectBrowser.__newProject</h4> | |
| 133 <b>__newProject</b>(<i></i>) | |
| 134 <p> | |
| 135 Private slot to handle the newProject signal. | |
| 136 </p><a NAME="ProjectBrowser.__projectClosed" ID="ProjectBrowser.__projectClosed"></a> | |
| 137 <h4>ProjectBrowser.__projectClosed</h4> | |
| 138 <b>__projectClosed</b>(<i></i>) | |
| 139 <p> | |
| 140 Private slot to handle the projectClosed signal. | |
| 141 </p><a NAME="ProjectBrowser.__projectOpened" ID="ProjectBrowser.__projectOpened"></a> | |
| 142 <h4>ProjectBrowser.__projectOpened</h4> | |
| 143 <b>__projectOpened</b>(<i></i>) | |
| 144 <p> | |
| 145 Private slot to handle the projectOpened signal. | |
| 146 </p><a NAME="ProjectBrowser.__projectPropertiesChanged" ID="ProjectBrowser.__projectPropertiesChanged"></a> | |
| 147 <h4>ProjectBrowser.__projectPropertiesChanged</h4> | |
| 148 <b>__projectPropertiesChanged</b>(<i></i>) | |
| 149 <p> | |
| 150 Private slot to handle the projectPropertiesChanged signal. | |
| 151 </p><a NAME="ProjectBrowser.__setBrowsersAvailable" ID="ProjectBrowser.__setBrowsersAvailable"></a> | |
| 152 <h4>ProjectBrowser.__setBrowsersAvailable</h4> | |
| 153 <b>__setBrowsersAvailable</b>(<i>browserFlags</i>) | |
| 154 <p> | |
| 155 Private method to add selected browsers to the project browser | |
| 156 </p><dl> | |
| 157 <dt><i>browserFlags</i></dt> | |
| 158 <dd> | |
| 159 flags indicating the browsers to add (integer) | |
| 160 </dd> | |
| 161 </dl><a NAME="ProjectBrowser.__setSourcesIcon" ID="ProjectBrowser.__setSourcesIcon"></a> | |
| 162 <h4>ProjectBrowser.__setSourcesIcon</h4> | |
| 163 <b>__setSourcesIcon</b>(<i></i>) | |
| 164 <p> | |
| 165 Private method to set the right icon for the sources browser tab. | |
| 166 </p><a NAME="ProjectBrowser.__vcsStateChanged" ID="ProjectBrowser.__vcsStateChanged"></a> | |
| 167 <h4>ProjectBrowser.__vcsStateChanged</h4> | |
| 168 <b>__vcsStateChanged</b>(<i>state</i>) | |
| 169 <p> | |
| 170 Private slot to handle a change in the vcs state. | |
| 171 </p><dl> | |
| 172 <dt><i>state</i></dt> | |
| 173 <dd> | |
| 174 new vcs state (string) | |
| 175 </dd> | |
| 176 </dl><a NAME="ProjectBrowser.getProjectBrowser" ID="ProjectBrowser.getProjectBrowser"></a> | |
| 177 <h4>ProjectBrowser.getProjectBrowser</h4> | |
| 178 <b>getProjectBrowser</b>(<i>name</i>) | |
| 179 <p> | |
| 180 Public method to get a reference to the named project browser. | |
| 181 </p><dl> | |
| 182 <dt><i>name</i></dt> | |
| 183 <dd> | |
| 184 name of the requested project browser (string). | |
| 185 Valid names are "sources, forms, resources, translations, | |
| 186 interfaces, others". | |
| 187 </dd> | |
| 188 </dl><dl> | |
| 189 <dt>Returns:</dt> | |
| 190 <dd> | |
| 191 reference to the requested browser or None | |
| 192 </dd> | |
| 193 </dl><a NAME="ProjectBrowser.getProjectBrowsers" ID="ProjectBrowser.getProjectBrowsers"></a> | |
| 194 <h4>ProjectBrowser.getProjectBrowsers</h4> | |
| 195 <b>getProjectBrowsers</b>(<i></i>) | |
| 196 <p> | |
| 197 Public method to get references to the individual project browsers. | |
| 198 </p><dl> | |
| 199 <dt>Returns:</dt> | |
| 200 <dd> | |
| 201 list of references to project browsers | |
| 202 </dd> | |
| 203 </dl><a NAME="ProjectBrowser.handleEditorChanged" ID="ProjectBrowser.handleEditorChanged"></a> | |
| 204 <h4>ProjectBrowser.handleEditorChanged</h4> | |
| 205 <b>handleEditorChanged</b>(<i>fn</i>) | |
| 206 <p> | |
| 207 Public slot to handle the editorChanged signal. | |
| 208 </p><dl> | |
| 209 <dt><i>fn</i></dt> | |
| 210 <dd> | |
| 211 filename of the changed file (string) | |
| 212 </dd> | |
| 213 </dl><a NAME="ProjectBrowser.handlePreferencesChanged" ID="ProjectBrowser.handlePreferencesChanged"></a> | |
| 214 <h4>ProjectBrowser.handlePreferencesChanged</h4> | |
| 215 <b>handlePreferencesChanged</b>(<i></i>) | |
| 216 <p> | |
| 217 Public slot used to handle the preferencesChanged signal. | |
| 218 </p><a NAME="ProjectBrowser.showEvent" ID="ProjectBrowser.showEvent"></a> | |
| 219 <h4>ProjectBrowser.showEvent</h4> | |
| 220 <b>showEvent</b>(<i>evt</i>) | |
| 221 <p> | |
| 222 Protected method handleing the show event. | |
| 223 </p><dl> | |
| 224 <dt><i>evt</i></dt> | |
| 225 <dd> | |
| 226 show event to handle (QShowEvent) | |
| 227 </dd> | |
| 228 </dl> | |
| 229 <div align="right"><a href="#top">Up</a></div> | |
| 230 <hr /> | |
| 231 </body></html> |
