Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.PluginVcsMercurial.html
src/eric7/Documentation/Source/eric7.Plugins.PluginVcsMercurial.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.PluginVcsMercurial</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.PluginVcsMercurial</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the Mercurial 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>longDescription</td></tr><tr><td>mercurialCfgPluginObject</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="#VcsMercurialPlugin">VcsMercurialPlugin</a></td> | |
| 25 <td>Class implementing the Mercurial 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="VcsMercurialPlugin" ID="VcsMercurialPlugin"></a> | |
| 64 <h2>VcsMercurialPlugin</h2> | |
| 65 | |
| 66 <p> | |
| 67 Class implementing the Mercurial version control plugin. | |
| 68 </p> | |
| 69 <h3>Derived from</h3> | |
| 70 QObject | |
| 71 <h3>Class Attributes</h3> | |
| 72 | |
| 73 <table> | |
| 74 <tr><td>MercurialDefaults</td></tr> | |
| 75 </table> | |
| 76 <h3>Class Methods</h3> | |
| 77 | |
| 78 <table> | |
| 79 | |
| 80 <tr> | |
| 81 <td><a href="#VcsMercurialPlugin.getPreferences">getPreferences</a></td> | |
| 82 <td>Class method to retrieve the various settings.</td> | |
| 83 </tr> | |
| 84 <tr> | |
| 85 <td><a href="#VcsMercurialPlugin.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="#VcsMercurialPlugin.__init__">VcsMercurialPlugin</a></td> | |
| 95 <td>Constructor</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#VcsMercurialPlugin.activate">activate</a></td> | |
| 99 <td>Public method to activate this plugin.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#VcsMercurialPlugin.deactivate">deactivate</a></td> | |
| 103 <td>Public method to deactivate this plugin.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#VcsMercurialPlugin.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="#VcsMercurialPlugin.getGlobalOptions">getGlobalOptions</a></td> | |
| 111 <td>Public method to build a list of global options.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#VcsMercurialPlugin.getProjectHelper">getProjectHelper</a></td> | |
| 115 <td>Public method to get a reference to the project helper object.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#VcsMercurialPlugin.initToolbar">initToolbar</a></td> | |
| 119 <td>Public slot to initialize the VCS toolbar.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#VcsMercurialPlugin.prepareUninstall">prepareUninstall</a></td> | |
| 123 <td>Public method to prepare for an uninstallation.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#VcsMercurialPlugin.prepareUnload">prepareUnload</a></td> | |
| 127 <td>Public method to prepare for an unload.</td> | |
| 128 </tr> | |
| 129 </table> | |
| 130 <h3>Static Methods</h3> | |
| 131 | |
| 132 <table> | |
| 133 <tr><td>None</td></tr> | |
| 134 </table> | |
| 135 | |
| 136 <a NAME="VcsMercurialPlugin.getPreferences" ID="VcsMercurialPlugin.getPreferences"></a> | |
| 137 <h4>VcsMercurialPlugin.getPreferences (class method)</h4> | |
| 138 <b>getPreferences</b>(<i>key</i>) | |
| 139 | |
| 140 <p> | |
| 141 Class method to retrieve the various settings. | |
| 142 </p> | |
| 143 <dl> | |
| 144 | |
| 145 <dt><i>key</i></dt> | |
| 146 <dd> | |
| 147 the key of the value to get | |
| 148 </dd> | |
| 149 </dl> | |
| 150 <dl> | |
| 151 <dt>Return:</dt> | |
| 152 <dd> | |
| 153 the requested setting | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <a NAME="VcsMercurialPlugin.setPreferences" ID="VcsMercurialPlugin.setPreferences"></a> | |
| 157 <h4>VcsMercurialPlugin.setPreferences (class method)</h4> | |
| 158 <b>setPreferences</b>(<i>key, value</i>) | |
| 159 | |
| 160 <p> | |
| 161 Class method to store the various settings. | |
| 162 </p> | |
| 163 <dl> | |
| 164 | |
| 165 <dt><i>key</i></dt> | |
| 166 <dd> | |
| 167 the key of the setting to be set | |
| 168 </dd> | |
| 169 <dt><i>value</i></dt> | |
| 170 <dd> | |
| 171 the value to be set | |
| 172 </dd> | |
| 173 </dl> | |
| 174 <a NAME="VcsMercurialPlugin.__init__" ID="VcsMercurialPlugin.__init__"></a> | |
| 175 <h4>VcsMercurialPlugin (Constructor)</h4> | |
| 176 <b>VcsMercurialPlugin</b>(<i>ui</i>) | |
| 177 | |
| 178 <p> | |
| 179 Constructor | |
| 180 </p> | |
| 181 <dl> | |
| 182 | |
| 183 <dt><i>ui</i></dt> | |
| 184 <dd> | |
| 185 reference to the user interface object (UI.UserInterface) | |
| 186 </dd> | |
| 187 </dl> | |
| 188 <a NAME="VcsMercurialPlugin.activate" ID="VcsMercurialPlugin.activate"></a> | |
| 189 <h4>VcsMercurialPlugin.activate</h4> | |
| 190 <b>activate</b>(<i></i>) | |
| 191 | |
| 192 <p> | |
| 193 Public method to activate this plugin. | |
| 194 </p> | |
| 195 <dl> | |
| 196 <dt>Return:</dt> | |
| 197 <dd> | |
| 198 tuple of reference to instantiated viewmanager and | |
| 199 activation status (boolean) | |
| 200 </dd> | |
| 201 </dl> | |
| 202 <a NAME="VcsMercurialPlugin.deactivate" ID="VcsMercurialPlugin.deactivate"></a> | |
| 203 <h4>VcsMercurialPlugin.deactivate</h4> | |
| 204 <b>deactivate</b>(<i></i>) | |
| 205 | |
| 206 <p> | |
| 207 Public method to deactivate this plugin. | |
| 208 </p> | |
| 209 <a NAME="VcsMercurialPlugin.getConfigPath" ID="VcsMercurialPlugin.getConfigPath"></a> | |
| 210 <h4>VcsMercurialPlugin.getConfigPath</h4> | |
| 211 <b>getConfigPath</b>(<i></i>) | |
| 212 | |
| 213 <p> | |
| 214 Public method to get the filename of the config file. | |
| 215 </p> | |
| 216 <dl> | |
| 217 <dt>Return:</dt> | |
| 218 <dd> | |
| 219 filename of the config file (string) | |
| 220 </dd> | |
| 221 </dl> | |
| 222 <a NAME="VcsMercurialPlugin.getGlobalOptions" ID="VcsMercurialPlugin.getGlobalOptions"></a> | |
| 223 <h4>VcsMercurialPlugin.getGlobalOptions</h4> | |
| 224 <b>getGlobalOptions</b>(<i></i>) | |
| 225 | |
| 226 <p> | |
| 227 Public method to build a list of global options. | |
| 228 </p> | |
| 229 <dl> | |
| 230 <dt>Return:</dt> | |
| 231 <dd> | |
| 232 list of global options (list of string) | |
| 233 </dd> | |
| 234 </dl> | |
| 235 <a NAME="VcsMercurialPlugin.getProjectHelper" ID="VcsMercurialPlugin.getProjectHelper"></a> | |
| 236 <h4>VcsMercurialPlugin.getProjectHelper</h4> | |
| 237 <b>getProjectHelper</b>(<i></i>) | |
| 238 | |
| 239 <p> | |
| 240 Public method to get a reference to the project helper object. | |
| 241 </p> | |
| 242 <dl> | |
| 243 <dt>Return:</dt> | |
| 244 <dd> | |
| 245 reference to the project helper object | |
| 246 </dd> | |
| 247 </dl> | |
| 248 <a NAME="VcsMercurialPlugin.initToolbar" ID="VcsMercurialPlugin.initToolbar"></a> | |
| 249 <h4>VcsMercurialPlugin.initToolbar</h4> | |
| 250 <b>initToolbar</b>(<i>ui, toolbarManager</i>) | |
| 251 | |
| 252 <p> | |
| 253 Public slot to initialize the VCS toolbar. | |
| 254 </p> | |
| 255 <dl> | |
| 256 | |
| 257 <dt><i>ui</i></dt> | |
| 258 <dd> | |
| 259 reference to the main window (UserInterface) | |
| 260 </dd> | |
| 261 <dt><i>toolbarManager</i></dt> | |
| 262 <dd> | |
| 263 reference to a toolbar manager object | |
| 264 (EricToolBarManager) | |
| 265 </dd> | |
| 266 </dl> | |
| 267 <a NAME="VcsMercurialPlugin.prepareUninstall" ID="VcsMercurialPlugin.prepareUninstall"></a> | |
| 268 <h4>VcsMercurialPlugin.prepareUninstall</h4> | |
| 269 <b>prepareUninstall</b>(<i></i>) | |
| 270 | |
| 271 <p> | |
| 272 Public method to prepare for an uninstallation. | |
| 273 </p> | |
| 274 <a NAME="VcsMercurialPlugin.prepareUnload" ID="VcsMercurialPlugin.prepareUnload"></a> | |
| 275 <h4>VcsMercurialPlugin.prepareUnload</h4> | |
| 276 <b>prepareUnload</b>(<i></i>) | |
| 277 | |
| 278 <p> | |
| 279 Public method to prepare for an unload. | |
| 280 </p> | |
| 281 <div align="right"><a href="#top">Up</a></div> | |
| 282 <hr /> | |
| 283 <hr /> | |
| 284 <a NAME="clearPrivateData" ID="clearPrivateData"></a> | |
| 285 <h2>clearPrivateData</h2> | |
| 286 <b>clearPrivateData</b>(<i></i>) | |
| 287 | |
| 288 <p> | |
| 289 Module function to clear the private data of the plug-in. | |
| 290 </p> | |
| 291 <div align="right"><a href="#top">Up</a></div> | |
| 292 <hr /> | |
| 293 <hr /> | |
| 294 <a NAME="createConfigurationPage" ID="createConfigurationPage"></a> | |
| 295 <h2>createConfigurationPage</h2> | |
| 296 <b>createConfigurationPage</b>(<i>configDlg</i>) | |
| 297 | |
| 298 <p> | |
| 299 Module function to create the configuration page. | |
| 300 </p> | |
| 301 <dl> | |
| 302 | |
| 303 <dt><i>configDlg</i></dt> | |
| 304 <dd> | |
| 305 reference to the configuration dialog (QDialog) | |
| 306 </dd> | |
| 307 </dl> | |
| 308 <dl> | |
| 309 <dt>Return:</dt> | |
| 310 <dd> | |
| 311 reference to the configuration page | |
| 312 </dd> | |
| 313 </dl> | |
| 314 <div align="right"><a href="#top">Up</a></div> | |
| 315 <hr /> | |
| 316 <hr /> | |
| 317 <a NAME="displayString" ID="displayString"></a> | |
| 318 <h2>displayString</h2> | |
| 319 <b>displayString</b>(<i></i>) | |
| 320 | |
| 321 <p> | |
| 322 Public function to get the display string. | |
| 323 </p> | |
| 324 <dl> | |
| 325 <dt>Return:</dt> | |
| 326 <dd> | |
| 327 display string (string) | |
| 328 </dd> | |
| 329 </dl> | |
| 330 <div align="right"><a href="#top">Up</a></div> | |
| 331 <hr /> | |
| 332 <hr /> | |
| 333 <a NAME="exeDisplayData" ID="exeDisplayData"></a> | |
| 334 <h2>exeDisplayData</h2> | |
| 335 <b>exeDisplayData</b>(<i></i>) | |
| 336 | |
| 337 <p> | |
| 338 Public method to support the display of some executable info. | |
| 339 </p> | |
| 340 <dl> | |
| 341 <dt>Return:</dt> | |
| 342 <dd> | |
| 343 dictionary containing the data to query the presence of | |
| 344 the executable | |
| 345 </dd> | |
| 346 </dl> | |
| 347 <div align="right"><a href="#top">Up</a></div> | |
| 348 <hr /> | |
| 349 <hr /> | |
| 350 <a NAME="getConfigData" ID="getConfigData"></a> | |
| 351 <h2>getConfigData</h2> | |
| 352 <b>getConfigData</b>(<i></i>) | |
| 353 | |
| 354 <p> | |
| 355 Module function returning data as required by the configuration dialog. | |
| 356 </p> | |
| 357 <dl> | |
| 358 <dt>Return:</dt> | |
| 359 <dd> | |
| 360 dictionary with key "zzz_mercurialPage" containing the relevant | |
| 361 data | |
| 362 </dd> | |
| 363 </dl> | |
| 364 <div align="right"><a href="#top">Up</a></div> | |
| 365 <hr /> | |
| 366 <hr /> | |
| 367 <a NAME="getVcsSystemIndicator" ID="getVcsSystemIndicator"></a> | |
| 368 <h2>getVcsSystemIndicator</h2> | |
| 369 <b>getVcsSystemIndicator</b>(<i></i>) | |
| 370 | |
| 371 <p> | |
| 372 Public function to get the indicators for this version control system. | |
| 373 </p> | |
| 374 <dl> | |
| 375 <dt>Return:</dt> | |
| 376 <dd> | |
| 377 dictionary with indicator as key and a tuple with the vcs name | |
| 378 (string) and vcs display string (string) | |
| 379 </dd> | |
| 380 </dl> | |
| 381 <div align="right"><a href="#top">Up</a></div> | |
| 382 <hr /> | |
| 383 <hr /> | |
| 384 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | |
| 385 <h2>prepareUninstall</h2> | |
| 386 <b>prepareUninstall</b>(<i></i>) | |
| 387 | |
| 388 <p> | |
| 389 Module function to prepare for an uninstallation. | |
| 390 </p> | |
| 391 <div align="right"><a href="#top">Up</a></div> | |
| 392 <hr /> | |
| 393 </body></html> |
