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 10479
- 856476537696
- parent 10437
- 2f70ca07f0af
- child 10684
- 58c7f23ae1cb
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.Plugins.PluginVcsGit</h1> | 9 <h1>eric7.Plugins.PluginVcsGit</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 This plugin provides the Git version control interface. | 11 This plugin provides the Git version control interface. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | 15 <table> |
| 16 <table> | 16 <tr><td>__header__</td></tr> |
| 17 <tr><td>__header__</td></tr><tr><td>error</td></tr><tr><td>gitCfgPluginObject</td></tr> | 17 <tr><td>error</td></tr> |
| 18 </table> | 18 <tr><td>gitCfgPluginObject</td></tr> |
| 19 </table> | |
| 20 | |
| 19 <h3>Classes</h3> | 21 <h3>Classes</h3> |
| 20 | 22 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 23 <tr> |
| 24 <td><a href="#VcsGitPlugin">VcsGitPlugin</a></td> | 24 <td><a href="#VcsGitPlugin">VcsGitPlugin</a></td> |
| 25 <td>Class implementing the Git version control plugin.</td> | 25 <td>Class implementing the Git version control plugin.</td> |
| 26 </tr> | 26 </tr> |
| 27 </table> | 27 </table> |
| 28 | |
| 28 <h3>Functions</h3> | 29 <h3>Functions</h3> |
| 29 | 30 <table> |
| 30 <table> | |
| 31 | |
| 32 <tr> | 31 <tr> |
| 33 <td><a href="#clearPrivateData">clearPrivateData</a></td> | 32 <td><a href="#clearPrivateData">clearPrivateData</a></td> |
| 34 <td>Module function to clear the private data of the plug-in.</td> | 33 <td>Module function to clear the private data of the plug-in.</td> |
| 35 </tr> | 34 </tr> |
| 36 <tr> | 35 <tr> |
| 56 <tr> | 55 <tr> |
| 57 <td><a href="#prepareUninstall">prepareUninstall</a></td> | 56 <td><a href="#prepareUninstall">prepareUninstall</a></td> |
| 58 <td>Module function to prepare for an uninstallation.</td> | 57 <td>Module function to prepare for an uninstallation.</td> |
| 59 </tr> | 58 </tr> |
| 60 </table> | 59 </table> |
| 60 | |
| 61 <hr /> | 61 <hr /> |
| 62 <hr /> | 62 <hr /> |
| 63 <a NAME="VcsGitPlugin" ID="VcsGitPlugin"></a> | 63 <a NAME="VcsGitPlugin" ID="VcsGitPlugin"></a> |
| 64 <h2>VcsGitPlugin</h2> | 64 <h2>VcsGitPlugin</h2> |
| 65 | |
| 66 <p> | 65 <p> |
| 67 Class implementing the Git version control plugin. | 66 Class implementing the Git version control plugin. |
| 68 </p> | 67 </p> |
| 68 | |
| 69 <h3>Derived from</h3> | 69 <h3>Derived from</h3> |
| 70 QObject | 70 QObject |
| 71 <h3>Class Attributes</h3> | 71 <h3>Class Attributes</h3> |
| 72 | |
| 73 <table> | 72 <table> |
| 74 <tr><td>GitDefaults</td></tr> | 73 <tr><td>GitDefaults</td></tr> |
| 75 </table> | 74 </table> |
| 75 | |
| 76 <h3>Class Methods</h3> | 76 <h3>Class Methods</h3> |
| 77 | 77 <table> |
| 78 <table> | |
| 79 | |
| 80 <tr> | 78 <tr> |
| 81 <td><a href="#VcsGitPlugin.getPreferences">getPreferences</a></td> | 79 <td><a href="#VcsGitPlugin.getPreferences">getPreferences</a></td> |
| 82 <td>Class method to retrieve the various settings.</td> | 80 <td>Class method to retrieve the various settings.</td> |
| 83 </tr> | 81 </tr> |
| 84 <tr> | 82 <tr> |
| 85 <td><a href="#VcsGitPlugin.setPreferences">setPreferences</a></td> | 83 <td><a href="#VcsGitPlugin.setPreferences">setPreferences</a></td> |
| 86 <td>Class method to store the various settings.</td> | 84 <td>Class method to store the various settings.</td> |
| 87 </tr> | 85 </tr> |
| 88 </table> | 86 </table> |
| 87 | |
| 89 <h3>Methods</h3> | 88 <h3>Methods</h3> |
| 90 | 89 <table> |
| 91 <table> | |
| 92 | |
| 93 <tr> | 90 <tr> |
| 94 <td><a href="#VcsGitPlugin.__init__">VcsGitPlugin</a></td> | 91 <td><a href="#VcsGitPlugin.__init__">VcsGitPlugin</a></td> |
| 95 <td>Constructor</td> | 92 <td>Constructor</td> |
| 96 </tr> | 93 </tr> |
| 97 <tr> | 94 <tr> |
| 121 <tr> | 118 <tr> |
| 122 <td><a href="#VcsGitPlugin.prepareUnload">prepareUnload</a></td> | 119 <td><a href="#VcsGitPlugin.prepareUnload">prepareUnload</a></td> |
| 123 <td>Public method to prepare for an unload.</td> | 120 <td>Public method to prepare for an unload.</td> |
| 124 </tr> | 121 </tr> |
| 125 </table> | 122 </table> |
| 123 | |
| 126 <h3>Static Methods</h3> | 124 <h3>Static Methods</h3> |
| 127 | |
| 128 <table> | 125 <table> |
| 129 <tr><td>None</td></tr> | 126 <tr><td>None</td></tr> |
| 130 </table> | 127 </table> |
| 128 | |
| 131 | 129 |
| 132 <a NAME="VcsGitPlugin.getPreferences" ID="VcsGitPlugin.getPreferences"></a> | 130 <a NAME="VcsGitPlugin.getPreferences" ID="VcsGitPlugin.getPreferences"></a> |
| 133 <h4>VcsGitPlugin.getPreferences (class method)</h4> | 131 <h4>VcsGitPlugin.getPreferences (class method)</h4> |
| 134 <b>getPreferences</b>(<i>key</i>) | 132 <b>getPreferences</b>(<i>key</i>) |
| 135 | |
| 136 <p> | 133 <p> |
| 137 Class method to retrieve the various settings. | 134 Class method to retrieve the various settings. |
| 138 </p> | 135 </p> |
| 136 | |
| 139 <dl> | 137 <dl> |
| 140 | 138 |
| 141 <dt><i>key</i> (str)</dt> | 139 <dt><i>key</i> (str)</dt> |
| 142 <dd> | 140 <dd> |
| 143 the key of the value to get | 141 the key of the value to get |
| 156 </dd> | 154 </dd> |
| 157 </dl> | 155 </dl> |
| 158 <a NAME="VcsGitPlugin.setPreferences" ID="VcsGitPlugin.setPreferences"></a> | 156 <a NAME="VcsGitPlugin.setPreferences" ID="VcsGitPlugin.setPreferences"></a> |
| 159 <h4>VcsGitPlugin.setPreferences (class method)</h4> | 157 <h4>VcsGitPlugin.setPreferences (class method)</h4> |
| 160 <b>setPreferences</b>(<i>key, value</i>) | 158 <b>setPreferences</b>(<i>key, value</i>) |
| 161 | |
| 162 <p> | 159 <p> |
| 163 Class method to store the various settings. | 160 Class method to store the various settings. |
| 164 </p> | 161 </p> |
| 162 | |
| 165 <dl> | 163 <dl> |
| 166 | 164 |
| 167 <dt><i>key</i> (str)</dt> | 165 <dt><i>key</i> (str)</dt> |
| 168 <dd> | 166 <dd> |
| 169 the key of the setting to be set | 167 the key of the setting to be set |
| 174 </dd> | 172 </dd> |
| 175 </dl> | 173 </dl> |
| 176 <a NAME="VcsGitPlugin.__init__" ID="VcsGitPlugin.__init__"></a> | 174 <a NAME="VcsGitPlugin.__init__" ID="VcsGitPlugin.__init__"></a> |
| 177 <h4>VcsGitPlugin (Constructor)</h4> | 175 <h4>VcsGitPlugin (Constructor)</h4> |
| 178 <b>VcsGitPlugin</b>(<i>ui</i>) | 176 <b>VcsGitPlugin</b>(<i>ui</i>) |
| 179 | |
| 180 <p> | 177 <p> |
| 181 Constructor | 178 Constructor |
| 182 </p> | 179 </p> |
| 180 | |
| 183 <dl> | 181 <dl> |
| 184 | 182 |
| 185 <dt><i>ui</i> (UserInterface)</dt> | 183 <dt><i>ui</i> (UserInterface)</dt> |
| 186 <dd> | 184 <dd> |
| 187 reference to the user interface object | 185 reference to the user interface object |
| 188 </dd> | 186 </dd> |
| 189 </dl> | 187 </dl> |
| 190 <a NAME="VcsGitPlugin.activate" ID="VcsGitPlugin.activate"></a> | 188 <a NAME="VcsGitPlugin.activate" ID="VcsGitPlugin.activate"></a> |
| 191 <h4>VcsGitPlugin.activate</h4> | 189 <h4>VcsGitPlugin.activate</h4> |
| 192 <b>activate</b>(<i></i>) | 190 <b>activate</b>(<i></i>) |
| 193 | |
| 194 <p> | 191 <p> |
| 195 Public method to activate this plugin. | 192 Public method to activate this plugin. |
| 196 </p> | 193 </p> |
| 194 | |
| 197 <dl> | 195 <dl> |
| 198 <dt>Return:</dt> | 196 <dt>Return:</dt> |
| 199 <dd> | 197 <dd> |
| 200 tuple of reference to instantiated version control and | 198 tuple of reference to instantiated version control and |
| 201 activation status | 199 activation status |
| 208 </dd> | 206 </dd> |
| 209 </dl> | 207 </dl> |
| 210 <a NAME="VcsGitPlugin.deactivate" ID="VcsGitPlugin.deactivate"></a> | 208 <a NAME="VcsGitPlugin.deactivate" ID="VcsGitPlugin.deactivate"></a> |
| 211 <h4>VcsGitPlugin.deactivate</h4> | 209 <h4>VcsGitPlugin.deactivate</h4> |
| 212 <b>deactivate</b>(<i></i>) | 210 <b>deactivate</b>(<i></i>) |
| 213 | |
| 214 <p> | 211 <p> |
| 215 Public method to deactivate this plugin. | 212 Public method to deactivate this plugin. |
| 216 </p> | 213 </p> |
| 214 | |
| 217 <a NAME="VcsGitPlugin.getConfigPath" ID="VcsGitPlugin.getConfigPath"></a> | 215 <a NAME="VcsGitPlugin.getConfigPath" ID="VcsGitPlugin.getConfigPath"></a> |
| 218 <h4>VcsGitPlugin.getConfigPath</h4> | 216 <h4>VcsGitPlugin.getConfigPath</h4> |
| 219 <b>getConfigPath</b>(<i></i>) | 217 <b>getConfigPath</b>(<i></i>) |
| 220 | |
| 221 <p> | 218 <p> |
| 222 Public method to get the filename of the config file. | 219 Public method to get the filename of the config file. |
| 223 </p> | 220 </p> |
| 221 | |
| 224 <dl> | 222 <dl> |
| 225 <dt>Return:</dt> | 223 <dt>Return:</dt> |
| 226 <dd> | 224 <dd> |
| 227 filename of the config file | 225 filename of the config file |
| 228 </dd> | 226 </dd> |
| 234 </dd> | 232 </dd> |
| 235 </dl> | 233 </dl> |
| 236 <a NAME="VcsGitPlugin.getProjectHelper" ID="VcsGitPlugin.getProjectHelper"></a> | 234 <a NAME="VcsGitPlugin.getProjectHelper" ID="VcsGitPlugin.getProjectHelper"></a> |
| 237 <h4>VcsGitPlugin.getProjectHelper</h4> | 235 <h4>VcsGitPlugin.getProjectHelper</h4> |
| 238 <b>getProjectHelper</b>(<i></i>) | 236 <b>getProjectHelper</b>(<i></i>) |
| 239 | |
| 240 <p> | 237 <p> |
| 241 Public method to get a reference to the project helper object. | 238 Public method to get a reference to the project helper object. |
| 242 </p> | 239 </p> |
| 240 | |
| 243 <dl> | 241 <dl> |
| 244 <dt>Return:</dt> | 242 <dt>Return:</dt> |
| 245 <dd> | 243 <dd> |
| 246 reference to the project helper object | 244 reference to the project helper object |
| 247 </dd> | 245 </dd> |
| 253 </dd> | 251 </dd> |
| 254 </dl> | 252 </dl> |
| 255 <a NAME="VcsGitPlugin.initToolbar" ID="VcsGitPlugin.initToolbar"></a> | 253 <a NAME="VcsGitPlugin.initToolbar" ID="VcsGitPlugin.initToolbar"></a> |
| 256 <h4>VcsGitPlugin.initToolbar</h4> | 254 <h4>VcsGitPlugin.initToolbar</h4> |
| 257 <b>initToolbar</b>(<i>ui, toolbarManager</i>) | 255 <b>initToolbar</b>(<i>ui, toolbarManager</i>) |
| 258 | |
| 259 <p> | 256 <p> |
| 260 Public slot to initialize the VCS toolbar. | 257 Public slot to initialize the VCS toolbar. |
| 261 </p> | 258 </p> |
| 259 | |
| 262 <dl> | 260 <dl> |
| 263 | 261 |
| 264 <dt><i>ui</i> (UserInterface)</dt> | 262 <dt><i>ui</i> (UserInterface)</dt> |
| 265 <dd> | 263 <dd> |
| 266 reference to the main window | 264 reference to the main window |
| 271 </dd> | 269 </dd> |
| 272 </dl> | 270 </dl> |
| 273 <a NAME="VcsGitPlugin.prepareUninstall" ID="VcsGitPlugin.prepareUninstall"></a> | 271 <a NAME="VcsGitPlugin.prepareUninstall" ID="VcsGitPlugin.prepareUninstall"></a> |
| 274 <h4>VcsGitPlugin.prepareUninstall</h4> | 272 <h4>VcsGitPlugin.prepareUninstall</h4> |
| 275 <b>prepareUninstall</b>(<i></i>) | 273 <b>prepareUninstall</b>(<i></i>) |
| 276 | |
| 277 <p> | 274 <p> |
| 278 Public method to prepare for an uninstallation. | 275 Public method to prepare for an uninstallation. |
| 279 </p> | 276 </p> |
| 277 | |
| 280 <a NAME="VcsGitPlugin.prepareUnload" ID="VcsGitPlugin.prepareUnload"></a> | 278 <a NAME="VcsGitPlugin.prepareUnload" ID="VcsGitPlugin.prepareUnload"></a> |
| 281 <h4>VcsGitPlugin.prepareUnload</h4> | 279 <h4>VcsGitPlugin.prepareUnload</h4> |
| 282 <b>prepareUnload</b>(<i></i>) | 280 <b>prepareUnload</b>(<i></i>) |
| 283 | |
| 284 <p> | 281 <p> |
| 285 Public method to prepare for an unload. | 282 Public method to prepare for an unload. |
| 286 </p> | 283 </p> |
| 284 | |
| 287 <div align="right"><a href="#top">Up</a></div> | 285 <div align="right"><a href="#top">Up</a></div> |
| 288 <hr /> | 286 <hr /> |
| 289 <hr /> | 287 <hr /> |
| 290 <a NAME="clearPrivateData" ID="clearPrivateData"></a> | 288 <a NAME="clearPrivateData" ID="clearPrivateData"></a> |
| 291 <h2>clearPrivateData</h2> | 289 <h2>clearPrivateData</h2> |
| 292 <b>clearPrivateData</b>(<i></i>) | 290 <b>clearPrivateData</b>(<i></i>) |
| 293 | |
| 294 <p> | 291 <p> |
| 295 Module function to clear the private data of the plug-in. | 292 Module function to clear the private data of the plug-in. |
| 296 </p> | 293 </p> |
| 294 | |
| 297 <div align="right"><a href="#top">Up</a></div> | 295 <div align="right"><a href="#top">Up</a></div> |
| 298 <hr /> | 296 <hr /> |
| 299 <hr /> | 297 <hr /> |
| 300 <a NAME="createConfigurationPage" ID="createConfigurationPage"></a> | 298 <a NAME="createConfigurationPage" ID="createConfigurationPage"></a> |
| 301 <h2>createConfigurationPage</h2> | 299 <h2>createConfigurationPage</h2> |
| 302 <b>createConfigurationPage</b>(<i>configDlg</i>) | 300 <b>createConfigurationPage</b>(<i>configDlg</i>) |
| 303 | |
| 304 <p> | 301 <p> |
| 305 Module function to create the configuration page. | 302 Module function to create the configuration page. |
| 306 </p> | 303 </p> |
| 304 | |
| 307 <dl> | 305 <dl> |
| 308 | 306 |
| 309 <dt><i>configDlg</i> (QDialog)</dt> | 307 <dt><i>configDlg</i> (QDialog)</dt> |
| 310 <dd> | 308 <dd> |
| 311 reference to the configuration dialog | 309 reference to the configuration dialog |
| 327 <hr /> | 325 <hr /> |
| 328 <hr /> | 326 <hr /> |
| 329 <a NAME="displayString" ID="displayString"></a> | 327 <a NAME="displayString" ID="displayString"></a> |
| 330 <h2>displayString</h2> | 328 <h2>displayString</h2> |
| 331 <b>displayString</b>(<i></i>) | 329 <b>displayString</b>(<i></i>) |
| 332 | |
| 333 <p> | 330 <p> |
| 334 Public function to get the display string. | 331 Public function to get the display string. |
| 335 </p> | 332 </p> |
| 333 | |
| 336 <dl> | 334 <dl> |
| 337 <dt>Return:</dt> | 335 <dt>Return:</dt> |
| 338 <dd> | 336 <dd> |
| 339 display string | 337 display string |
| 340 </dd> | 338 </dd> |
| 349 <hr /> | 347 <hr /> |
| 350 <hr /> | 348 <hr /> |
| 351 <a NAME="exeDisplayData" ID="exeDisplayData"></a> | 349 <a NAME="exeDisplayData" ID="exeDisplayData"></a> |
| 352 <h2>exeDisplayData</h2> | 350 <h2>exeDisplayData</h2> |
| 353 <b>exeDisplayData</b>(<i></i>) | 351 <b>exeDisplayData</b>(<i></i>) |
| 354 | |
| 355 <p> | 352 <p> |
| 356 Public method to support the display of some executable info. | 353 Public method to support the display of some executable info. |
| 357 </p> | 354 </p> |
| 355 | |
| 358 <dl> | 356 <dl> |
| 359 <dt>Return:</dt> | 357 <dt>Return:</dt> |
| 360 <dd> | 358 <dd> |
| 361 dictionary containing the data to query the presence of | 359 dictionary containing the data to query the presence of |
| 362 the executable | 360 the executable |
| 372 <hr /> | 370 <hr /> |
| 373 <hr /> | 371 <hr /> |
| 374 <a NAME="getConfigData" ID="getConfigData"></a> | 372 <a NAME="getConfigData" ID="getConfigData"></a> |
| 375 <h2>getConfigData</h2> | 373 <h2>getConfigData</h2> |
| 376 <b>getConfigData</b>(<i></i>) | 374 <b>getConfigData</b>(<i></i>) |
| 377 | |
| 378 <p> | 375 <p> |
| 379 Module function returning data as required by the configuration dialog. | 376 Module function returning data as required by the configuration dialog. |
| 380 </p> | 377 </p> |
| 378 | |
| 381 <dl> | 379 <dl> |
| 382 <dt>Return:</dt> | 380 <dt>Return:</dt> |
| 383 <dd> | 381 <dd> |
| 384 dictionary with key "zzz_gitPage" containing the relevant data | 382 dictionary with key "zzz_gitPage" containing the relevant data |
| 385 </dd> | 383 </dd> |
| 394 <hr /> | 392 <hr /> |
| 395 <hr /> | 393 <hr /> |
| 396 <a NAME="getVcsSystemIndicator" ID="getVcsSystemIndicator"></a> | 394 <a NAME="getVcsSystemIndicator" ID="getVcsSystemIndicator"></a> |
| 397 <h2>getVcsSystemIndicator</h2> | 395 <h2>getVcsSystemIndicator</h2> |
| 398 <b>getVcsSystemIndicator</b>(<i></i>) | 396 <b>getVcsSystemIndicator</b>(<i></i>) |
| 399 | |
| 400 <p> | 397 <p> |
| 401 Public function to get the indicators for this version control system. | 398 Public function to get the indicators for this version control system. |
| 402 </p> | 399 </p> |
| 400 | |
| 403 <dl> | 401 <dl> |
| 404 <dt>Return:</dt> | 402 <dt>Return:</dt> |
| 405 <dd> | 403 <dd> |
| 406 dictionary with indicator as key and a tuple with the vcs name | 404 dictionary with indicator as key and a tuple with the vcs name |
| 407 and vcs display string | 405 and vcs display string |
| 417 <hr /> | 415 <hr /> |
| 418 <hr /> | 416 <hr /> |
| 419 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | 417 <a NAME="prepareUninstall" ID="prepareUninstall"></a> |
| 420 <h2>prepareUninstall</h2> | 418 <h2>prepareUninstall</h2> |
| 421 <b>prepareUninstall</b>(<i></i>) | 419 <b>prepareUninstall</b>(<i></i>) |
| 422 | |
| 423 <p> | 420 <p> |
| 424 Module function to prepare for an uninstallation. | 421 Module function to prepare for an uninstallation. |
| 425 </p> | 422 </p> |
| 423 | |
| 426 <div align="right"><a href="#top">Up</a></div> | 424 <div align="right"><a href="#top">Up</a></div> |
| 427 <hr /> | 425 <hr /> |
| 428 </body></html> | 426 </body></html> |
