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