Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.PluginVcsGit.html
src/eric7/Documentation/Source/eric7.Plugins.PluginVcsGit.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10064
- 8c3207703dac
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.PluginVcsGit</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.Plugins.PluginVcsGit</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the Git version control plugin. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>gitCfgPluginObject</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pluginType</td></tr><tr><td>pluginTypename</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#VcsGitPlugin">VcsGitPlugin</a></td> | |
| 25 <td>Class implementing the Git version control plugin.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 | |
| 32 <tr> | |
| 33 <td><a href="#clearPrivateData">clearPrivateData</a></td> | |
| 34 <td>Module function to clear the private data of the plug-in.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#createConfigurationPage">createConfigurationPage</a></td> | |
| 38 <td>Module function to create the configuration page.</td> | |
| 39 </tr> | |
| 40 <tr> | |
| 41 <td><a href="#displayString">displayString</a></td> | |
| 42 <td>Public function to get the display string.</td> | |
| 43 </tr> | |
| 44 <tr> | |
| 45 <td><a href="#exeDisplayData">exeDisplayData</a></td> | |
| 46 <td>Public method to support the display of some executable info.</td> | |
| 47 </tr> | |
| 48 <tr> | |
| 49 <td><a href="#getConfigData">getConfigData</a></td> | |
| 50 <td>Module function returning data as required by the configuration dialog.</td> | |
| 51 </tr> | |
| 52 <tr> | |
| 53 <td><a href="#getVcsSystemIndicator">getVcsSystemIndicator</a></td> | |
| 54 <td>Public function to get the indicators for this version control system.</td> | |
| 55 </tr> | |
| 56 <tr> | |
| 57 <td><a href="#prepareUninstall">prepareUninstall</a></td> | |
| 58 <td>Module function to prepare for an uninstallation.</td> | |
| 59 </tr> | |
| 60 </table> | |
| 61 <hr /> | |
| 62 <hr /> | |
| 63 <a NAME="VcsGitPlugin" ID="VcsGitPlugin"></a> | |
| 64 <h2>VcsGitPlugin</h2> | |
| 65 | |
| 66 <p> | |
| 67 Class implementing the Git version control plugin. | |
| 68 </p> | |
| 69 <h3>Derived from</h3> | |
| 70 QObject | |
| 71 <h3>Class Attributes</h3> | |
| 72 | |
| 73 <table> | |
| 74 <tr><td>GitDefaults</td></tr> | |
| 75 </table> | |
| 76 <h3>Class Methods</h3> | |
| 77 | |
| 78 <table> | |
| 79 | |
| 80 <tr> | |
| 81 <td><a href="#VcsGitPlugin.getPreferences">getPreferences</a></td> | |
| 82 <td>Class method to retrieve the various settings.</td> | |
| 83 </tr> | |
| 84 <tr> | |
| 85 <td><a href="#VcsGitPlugin.setPreferences">setPreferences</a></td> | |
| 86 <td>Class method to store the various settings.</td> | |
| 87 </tr> | |
| 88 </table> | |
| 89 <h3>Methods</h3> | |
| 90 | |
| 91 <table> | |
| 92 | |
| 93 <tr> | |
| 94 <td><a href="#VcsGitPlugin.__init__">VcsGitPlugin</a></td> | |
| 95 <td>Constructor</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#VcsGitPlugin.activate">activate</a></td> | |
| 99 <td>Public method to activate this plugin.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#VcsGitPlugin.deactivate">deactivate</a></td> | |
| 103 <td>Public method to deactivate this plugin.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#VcsGitPlugin.getConfigPath">getConfigPath</a></td> | |
| 107 <td>Public method to get the filename of the config file.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#VcsGitPlugin.getProjectHelper">getProjectHelper</a></td> | |
| 111 <td>Public method to get a reference to the project helper object.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#VcsGitPlugin.initToolbar">initToolbar</a></td> | |
| 115 <td>Public slot to initialize the VCS toolbar.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#VcsGitPlugin.prepareUninstall">prepareUninstall</a></td> | |
| 119 <td>Public method to prepare for an uninstallation.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#VcsGitPlugin.prepareUnload">prepareUnload</a></td> | |
| 123 <td>Public method to prepare for an unload.</td> | |
| 124 </tr> | |
| 125 </table> | |
| 126 <h3>Static Methods</h3> | |
| 127 | |
| 128 <table> | |
| 129 <tr><td>None</td></tr> | |
| 130 </table> | |
| 131 | |
| 132 <a NAME="VcsGitPlugin.getPreferences" ID="VcsGitPlugin.getPreferences"></a> | |
| 133 <h4>VcsGitPlugin.getPreferences (class method)</h4> | |
| 134 <b>getPreferences</b>(<i>key</i>) | |
| 135 | |
| 136 <p> | |
| 137 Class method to retrieve the various settings. | |
| 138 </p> | |
| 139 <dl> | |
| 140 | |
| 141 <dt><i>key</i></dt> | |
| 142 <dd> | |
| 143 the key of the value to get | |
| 144 </dd> | |
| 145 </dl> | |
| 146 <dl> | |
| 147 <dt>Return:</dt> | |
| 148 <dd> | |
| 149 the requested setting | |
| 150 </dd> | |
| 151 </dl> | |
| 152 <a NAME="VcsGitPlugin.setPreferences" ID="VcsGitPlugin.setPreferences"></a> | |
| 153 <h4>VcsGitPlugin.setPreferences (class method)</h4> | |
| 154 <b>setPreferences</b>(<i>key, value</i>) | |
| 155 | |
| 156 <p> | |
| 157 Class method to store the various settings. | |
| 158 </p> | |
| 159 <dl> | |
| 160 | |
| 161 <dt><i>key</i></dt> | |
| 162 <dd> | |
| 163 the key of the setting to be set | |
| 164 </dd> | |
| 165 <dt><i>value</i></dt> | |
| 166 <dd> | |
| 167 the value to be set | |
| 168 </dd> | |
| 169 </dl> | |
| 170 <a NAME="VcsGitPlugin.__init__" ID="VcsGitPlugin.__init__"></a> | |
| 171 <h4>VcsGitPlugin (Constructor)</h4> | |
| 172 <b>VcsGitPlugin</b>(<i>ui</i>) | |
| 173 | |
| 174 <p> | |
| 175 Constructor | |
| 176 </p> | |
| 177 <dl> | |
| 178 | |
| 179 <dt><i>ui</i></dt> | |
| 180 <dd> | |
| 181 reference to the user interface object (UI.UserInterface) | |
| 182 </dd> | |
| 183 </dl> | |
| 184 <a NAME="VcsGitPlugin.activate" ID="VcsGitPlugin.activate"></a> | |
| 185 <h4>VcsGitPlugin.activate</h4> | |
| 186 <b>activate</b>(<i></i>) | |
| 187 | |
| 188 <p> | |
| 189 Public method to activate this plugin. | |
| 190 </p> | |
| 191 <dl> | |
| 192 <dt>Return:</dt> | |
| 193 <dd> | |
| 194 tuple of reference to instantiated viewmanager and | |
| 195 activation status (boolean) | |
| 196 </dd> | |
| 197 </dl> | |
| 198 <a NAME="VcsGitPlugin.deactivate" ID="VcsGitPlugin.deactivate"></a> | |
| 199 <h4>VcsGitPlugin.deactivate</h4> | |
| 200 <b>deactivate</b>(<i></i>) | |
| 201 | |
| 202 <p> | |
| 203 Public method to deactivate this plugin. | |
| 204 </p> | |
| 205 <a NAME="VcsGitPlugin.getConfigPath" ID="VcsGitPlugin.getConfigPath"></a> | |
| 206 <h4>VcsGitPlugin.getConfigPath</h4> | |
| 207 <b>getConfigPath</b>(<i></i>) | |
| 208 | |
| 209 <p> | |
| 210 Public method to get the filename of the config file. | |
| 211 </p> | |
| 212 <dl> | |
| 213 <dt>Return:</dt> | |
| 214 <dd> | |
| 215 filename of the config file (string) | |
| 216 </dd> | |
| 217 </dl> | |
| 218 <a NAME="VcsGitPlugin.getProjectHelper" ID="VcsGitPlugin.getProjectHelper"></a> | |
| 219 <h4>VcsGitPlugin.getProjectHelper</h4> | |
| 220 <b>getProjectHelper</b>(<i></i>) | |
| 221 | |
| 222 <p> | |
| 223 Public method to get a reference to the project helper object. | |
| 224 </p> | |
| 225 <dl> | |
| 226 <dt>Return:</dt> | |
| 227 <dd> | |
| 228 reference to the project helper object | |
| 229 </dd> | |
| 230 </dl> | |
| 231 <a NAME="VcsGitPlugin.initToolbar" ID="VcsGitPlugin.initToolbar"></a> | |
| 232 <h4>VcsGitPlugin.initToolbar</h4> | |
| 233 <b>initToolbar</b>(<i>ui, toolbarManager</i>) | |
| 234 | |
| 235 <p> | |
| 236 Public slot to initialize the VCS toolbar. | |
| 237 </p> | |
| 238 <dl> | |
| 239 | |
| 240 <dt><i>ui</i></dt> | |
| 241 <dd> | |
| 242 reference to the main window (UserInterface) | |
| 243 </dd> | |
| 244 <dt><i>toolbarManager</i></dt> | |
| 245 <dd> | |
| 246 reference to a toolbar manager object | |
| 247 (EricToolBarManager) | |
| 248 </dd> | |
| 249 </dl> | |
| 250 <a NAME="VcsGitPlugin.prepareUninstall" ID="VcsGitPlugin.prepareUninstall"></a> | |
| 251 <h4>VcsGitPlugin.prepareUninstall</h4> | |
| 252 <b>prepareUninstall</b>(<i></i>) | |
| 253 | |
| 254 <p> | |
| 255 Public method to prepare for an uninstallation. | |
| 256 </p> | |
| 257 <a NAME="VcsGitPlugin.prepareUnload" ID="VcsGitPlugin.prepareUnload"></a> | |
| 258 <h4>VcsGitPlugin.prepareUnload</h4> | |
| 259 <b>prepareUnload</b>(<i></i>) | |
| 260 | |
| 261 <p> | |
| 262 Public method to prepare for an unload. | |
| 263 </p> | |
| 264 <div align="right"><a href="#top">Up</a></div> | |
| 265 <hr /> | |
| 266 <hr /> | |
| 267 <a NAME="clearPrivateData" ID="clearPrivateData"></a> | |
| 268 <h2>clearPrivateData</h2> | |
| 269 <b>clearPrivateData</b>(<i></i>) | |
| 270 | |
| 271 <p> | |
| 272 Module function to clear the private data of the plug-in. | |
| 273 </p> | |
| 274 <div align="right"><a href="#top">Up</a></div> | |
| 275 <hr /> | |
| 276 <hr /> | |
| 277 <a NAME="createConfigurationPage" ID="createConfigurationPage"></a> | |
| 278 <h2>createConfigurationPage</h2> | |
| 279 <b>createConfigurationPage</b>(<i>configDlg</i>) | |
| 280 | |
| 281 <p> | |
| 282 Module function to create the configuration page. | |
| 283 </p> | |
| 284 <dl> | |
| 285 | |
| 286 <dt><i>configDlg</i></dt> | |
| 287 <dd> | |
| 288 reference to the configuration dialog (QDialog) | |
| 289 </dd> | |
| 290 </dl> | |
| 291 <dl> | |
| 292 <dt>Return:</dt> | |
| 293 <dd> | |
| 294 reference to the configuration page | |
| 295 </dd> | |
| 296 </dl> | |
| 297 <div align="right"><a href="#top">Up</a></div> | |
| 298 <hr /> | |
| 299 <hr /> | |
| 300 <a NAME="displayString" ID="displayString"></a> | |
| 301 <h2>displayString</h2> | |
| 302 <b>displayString</b>(<i></i>) | |
| 303 | |
| 304 <p> | |
| 305 Public function to get the display string. | |
| 306 </p> | |
| 307 <dl> | |
| 308 <dt>Return:</dt> | |
| 309 <dd> | |
| 310 display string (string) | |
| 311 </dd> | |
| 312 </dl> | |
| 313 <div align="right"><a href="#top">Up</a></div> | |
| 314 <hr /> | |
| 315 <hr /> | |
| 316 <a NAME="exeDisplayData" ID="exeDisplayData"></a> | |
| 317 <h2>exeDisplayData</h2> | |
| 318 <b>exeDisplayData</b>(<i></i>) | |
| 319 | |
| 320 <p> | |
| 321 Public method to support the display of some executable info. | |
| 322 </p> | |
| 323 <dl> | |
| 324 <dt>Return:</dt> | |
| 325 <dd> | |
| 326 dictionary containing the data to query the presence of | |
| 327 the executable | |
| 328 </dd> | |
| 329 </dl> | |
| 330 <div align="right"><a href="#top">Up</a></div> | |
| 331 <hr /> | |
| 332 <hr /> | |
| 333 <a NAME="getConfigData" ID="getConfigData"></a> | |
| 334 <h2>getConfigData</h2> | |
| 335 <b>getConfigData</b>(<i></i>) | |
| 336 | |
| 337 <p> | |
| 338 Module function returning data as required by the configuration dialog. | |
| 339 </p> | |
| 340 <dl> | |
| 341 <dt>Return:</dt> | |
| 342 <dd> | |
| 343 dictionary with key "zzz_gitPage" containing the relevant | |
| 344 data | |
| 345 </dd> | |
| 346 </dl> | |
| 347 <div align="right"><a href="#top">Up</a></div> | |
| 348 <hr /> | |
| 349 <hr /> | |
| 350 <a NAME="getVcsSystemIndicator" ID="getVcsSystemIndicator"></a> | |
| 351 <h2>getVcsSystemIndicator</h2> | |
| 352 <b>getVcsSystemIndicator</b>(<i></i>) | |
| 353 | |
| 354 <p> | |
| 355 Public function to get the indicators for this version control system. | |
| 356 </p> | |
| 357 <dl> | |
| 358 <dt>Return:</dt> | |
| 359 <dd> | |
| 360 dictionary with indicator as key and a tuple with the vcs name | |
| 361 (string) and vcs display string (string) | |
| 362 </dd> | |
| 363 </dl> | |
| 364 <div align="right"><a href="#top">Up</a></div> | |
| 365 <hr /> | |
| 366 <hr /> | |
| 367 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | |
| 368 <h2>prepareUninstall</h2> | |
| 369 <b>prepareUninstall</b>(<i></i>) | |
| 370 | |
| 371 <p> | |
| 372 Module function to prepare for an uninstallation. | |
| 373 </p> | |
| 374 <div align="right"><a href="#top">Up</a></div> | |
| 375 <hr /> | |
| 376 </body></html> |
