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