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