Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.PluginVcsPySvn.html
Documentation/Source/eric5.Plugins.PluginVcsPySvn.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Plugins.PluginVcsPySvn</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.Plugins.PluginVcsPySvn</h1> | |
| 12 <p> | |
| 13 Module implementing the PySvn version control plugin. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 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 <table> | |
| 21 <tr> | |
| 22 <td><a href="#VcsPySvnPlugin">VcsPySvnPlugin</a></td> | |
| 23 <td>Class implementing the PySvn version control plugin.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr> | |
| 29 <td><a href="#createConfigurationPage">createConfigurationPage</a></td> | |
| 30 <td>Module function to create the configuration page.</td> | |
| 31 </tr><tr> | |
| 32 <td><a href="#displayString">displayString</a></td> | |
| 33 <td>Public function to get the display string.</td> | |
| 34 </tr><tr> | |
| 35 <td><a href="#exeDisplayData">exeDisplayData</a></td> | |
| 36 <td>Public method to support the display of some executable info.</td> | |
| 37 </tr><tr> | |
| 38 <td><a href="#getConfigData">getConfigData</a></td> | |
| 39 <td>Module function returning data as required by the configuration dialog.</td> | |
| 40 </tr><tr> | |
| 41 <td><a href="#getVcsSystemIndicator">getVcsSystemIndicator</a></td> | |
| 42 <td>Public function to get the indicators for this version control system.</td> | |
| 43 </tr><tr> | |
| 44 <td><a href="#prepareUninstall">prepareUninstall</a></td> | |
| 45 <td>Module function to prepare for an uninstallation.</td> | |
| 46 </tr> | |
| 47 </table> | |
| 48 <hr /><hr /> | |
| 49 <a NAME="VcsPySvnPlugin" ID="VcsPySvnPlugin"></a> | |
| 50 <h2>VcsPySvnPlugin</h2> | |
| 51 <p> | |
| 52 Class implementing the PySvn version control plugin. | |
| 53 </p> | |
| 54 <h3>Derived from</h3> | |
| 55 object | |
| 56 <h3>Class Attributes</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Methods</h3> | |
| 61 <table> | |
| 62 <tr> | |
| 63 <td><a href="#VcsPySvnPlugin.__init__">VcsPySvnPlugin</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#VcsPySvnPlugin.activate">activate</a></td> | |
| 67 <td>Public method to activate this plugin.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#VcsPySvnPlugin.deactivate">deactivate</a></td> | |
| 70 <td>Public method to deactivate this plugin.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#VcsPySvnPlugin.getConfigPath">getConfigPath</a></td> | |
| 73 <td>Public method to get the filename of the config file.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#VcsPySvnPlugin.getPreferences">getPreferences</a></td> | |
| 76 <td>Public method to retrieve the various refactoring settings.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#VcsPySvnPlugin.getProjectHelper">getProjectHelper</a></td> | |
| 79 <td>Public method to get a reference to the project helper object.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#VcsPySvnPlugin.getServersPath">getServersPath</a></td> | |
| 82 <td>Public method to get the filename of the servers file.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#VcsPySvnPlugin.prepareUninstall">prepareUninstall</a></td> | |
| 85 <td>Public method to prepare for an uninstallation.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#VcsPySvnPlugin.setPreferences">setPreferences</a></td> | |
| 88 <td>Public method to store the various refactoring settings.</td> | |
| 89 </tr> | |
| 90 </table> | |
| 91 <a NAME="VcsPySvnPlugin.__init__" ID="VcsPySvnPlugin.__init__"></a> | |
| 92 <h4>VcsPySvnPlugin (Constructor)</h4> | |
| 93 <b>VcsPySvnPlugin</b>(<i>ui</i>) | |
| 94 <p> | |
| 95 Constructor | |
| 96 </p><dl> | |
| 97 <dt><i>ui</i></dt> | |
| 98 <dd> | |
| 99 reference to the user interface object (UI.UserInterface) | |
| 100 </dd> | |
| 101 </dl><a NAME="VcsPySvnPlugin.activate" ID="VcsPySvnPlugin.activate"></a> | |
| 102 <h4>VcsPySvnPlugin.activate</h4> | |
| 103 <b>activate</b>(<i></i>) | |
| 104 <p> | |
| 105 Public method to activate this plugin. | |
| 106 </p><dl> | |
| 107 <dt>Returns:</dt> | |
| 108 <dd> | |
| 109 tuple of reference to instantiated viewmanager and | |
| 110 activation status (boolean) | |
| 111 </dd> | |
| 112 </dl><a NAME="VcsPySvnPlugin.deactivate" ID="VcsPySvnPlugin.deactivate"></a> | |
| 113 <h4>VcsPySvnPlugin.deactivate</h4> | |
| 114 <b>deactivate</b>(<i></i>) | |
| 115 <p> | |
| 116 Public method to deactivate this plugin. | |
| 117 </p><a NAME="VcsPySvnPlugin.getConfigPath" ID="VcsPySvnPlugin.getConfigPath"></a> | |
| 118 <h4>VcsPySvnPlugin.getConfigPath</h4> | |
| 119 <b>getConfigPath</b>(<i></i>) | |
| 120 <p> | |
| 121 Public method to get the filename of the config file. | |
| 122 </p><dl> | |
| 123 <dt>Returns:</dt> | |
| 124 <dd> | |
| 125 filename of the config file (string) | |
| 126 </dd> | |
| 127 </dl><a NAME="VcsPySvnPlugin.getPreferences" ID="VcsPySvnPlugin.getPreferences"></a> | |
| 128 <h4>VcsPySvnPlugin.getPreferences</h4> | |
| 129 <b>getPreferences</b>(<i>key</i>) | |
| 130 <p> | |
| 131 Public method to retrieve the various refactoring settings. | |
| 132 </p><dl> | |
| 133 <dt><i>key</i></dt> | |
| 134 <dd> | |
| 135 the key of the value to get | |
| 136 </dd><dt><i>prefClass</i></dt> | |
| 137 <dd> | |
| 138 preferences class used as the storage area | |
| 139 </dd> | |
| 140 </dl><dl> | |
| 141 <dt>Returns:</dt> | |
| 142 <dd> | |
| 143 the requested refactoring setting | |
| 144 </dd> | |
| 145 </dl><a NAME="VcsPySvnPlugin.getProjectHelper" ID="VcsPySvnPlugin.getProjectHelper"></a> | |
| 146 <h4>VcsPySvnPlugin.getProjectHelper</h4> | |
| 147 <b>getProjectHelper</b>(<i></i>) | |
| 148 <p> | |
| 149 Public method to get a reference to the project helper object. | |
| 150 </p><dl> | |
| 151 <dt>Returns:</dt> | |
| 152 <dd> | |
| 153 reference to the project helper object | |
| 154 </dd> | |
| 155 </dl><a NAME="VcsPySvnPlugin.getServersPath" ID="VcsPySvnPlugin.getServersPath"></a> | |
| 156 <h4>VcsPySvnPlugin.getServersPath</h4> | |
| 157 <b>getServersPath</b>(<i></i>) | |
| 158 <p> | |
| 159 Public method to get the filename of the servers file. | |
| 160 </p><dl> | |
| 161 <dt>Returns:</dt> | |
| 162 <dd> | |
| 163 filename of the servers file (string) | |
| 164 </dd> | |
| 165 </dl><a NAME="VcsPySvnPlugin.prepareUninstall" ID="VcsPySvnPlugin.prepareUninstall"></a> | |
| 166 <h4>VcsPySvnPlugin.prepareUninstall</h4> | |
| 167 <b>prepareUninstall</b>(<i></i>) | |
| 168 <p> | |
| 169 Public method to prepare for an uninstallation. | |
| 170 </p><a NAME="VcsPySvnPlugin.setPreferences" ID="VcsPySvnPlugin.setPreferences"></a> | |
| 171 <h4>VcsPySvnPlugin.setPreferences</h4> | |
| 172 <b>setPreferences</b>(<i>key, value</i>) | |
| 173 <p> | |
| 174 Public method to store the various refactoring settings. | |
| 175 </p><dl> | |
| 176 <dt><i>key</i></dt> | |
| 177 <dd> | |
| 178 the key of the setting to be set | |
| 179 </dd><dt><i>value</i></dt> | |
| 180 <dd> | |
| 181 the value to be set | |
| 182 </dd><dt><i>prefClass</i></dt> | |
| 183 <dd> | |
| 184 preferences class used as the storage area | |
| 185 </dd> | |
| 186 </dl> | |
| 187 <div align="right"><a href="#top">Up</a></div> | |
| 188 <hr /><hr /> | |
| 189 <a NAME="createConfigurationPage" ID="createConfigurationPage"></a> | |
| 190 <h2>createConfigurationPage</h2> | |
| 191 <b>createConfigurationPage</b>(<i>configDlg</i>) | |
| 192 <p> | |
| 193 Module function to create the configuration page. | |
| 194 </p><dl> | |
| 195 <dt>Returns:</dt> | |
| 196 <dd> | |
| 197 reference to the configuration page | |
| 198 </dd> | |
| 199 </dl> | |
| 200 <div align="right"><a href="#top">Up</a></div> | |
| 201 <hr /><hr /> | |
| 202 <a NAME="displayString" ID="displayString"></a> | |
| 203 <h2>displayString</h2> | |
| 204 <b>displayString</b>(<i></i>) | |
| 205 <p> | |
| 206 Public function to get the display string. | |
| 207 </p><dl> | |
| 208 <dt>Returns:</dt> | |
| 209 <dd> | |
| 210 display string (string) | |
| 211 </dd> | |
| 212 </dl> | |
| 213 <div align="right"><a href="#top">Up</a></div> | |
| 214 <hr /><hr /> | |
| 215 <a NAME="exeDisplayData" ID="exeDisplayData"></a> | |
| 216 <h2>exeDisplayData</h2> | |
| 217 <b>exeDisplayData</b>(<i></i>) | |
| 218 <p> | |
| 219 Public method to support the display of some executable info. | |
| 220 </p><dl> | |
| 221 <dt>Returns:</dt> | |
| 222 <dd> | |
| 223 dictionary containing the data to be shown | |
| 224 </dd> | |
| 225 </dl> | |
| 226 <div align="right"><a href="#top">Up</a></div> | |
| 227 <hr /><hr /> | |
| 228 <a NAME="getConfigData" ID="getConfigData"></a> | |
| 229 <h2>getConfigData</h2> | |
| 230 <b>getConfigData</b>(<i></i>) | |
| 231 <p> | |
| 232 Module function returning data as required by the configuration dialog. | |
| 233 </p><dl> | |
| 234 <dt>Returns:</dt> | |
| 235 <dd> | |
| 236 dictionary with key "zzz_subversionPage" containing the relevant data | |
| 237 </dd> | |
| 238 </dl> | |
| 239 <div align="right"><a href="#top">Up</a></div> | |
| 240 <hr /><hr /> | |
| 241 <a NAME="getVcsSystemIndicator" ID="getVcsSystemIndicator"></a> | |
| 242 <h2>getVcsSystemIndicator</h2> | |
| 243 <b>getVcsSystemIndicator</b>(<i></i>) | |
| 244 <p> | |
| 245 Public function to get the indicators for this version control system. | |
| 246 </p><dl> | |
| 247 <dt>Returns:</dt> | |
| 248 <dd> | |
| 249 dictionary with indicator as key and a tuple with the vcs name (string) | |
| 250 and vcs display string (string) | |
| 251 </dd> | |
| 252 </dl> | |
| 253 <div align="right"><a href="#top">Up</a></div> | |
| 254 <hr /><hr /> | |
| 255 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | |
| 256 <h2>prepareUninstall</h2> | |
| 257 <b>prepareUninstall</b>(<i></i>) | |
| 258 <p> | |
| 259 Module function to prepare for an uninstallation. | |
| 260 </p> | |
| 261 <div align="right"><a href="#top">Up</a></div> | |
| 262 <hr /> | |
| 263 </body></html> |
