Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Plugins.PluginVcsPySvn.html

src/eric7/Documentation/Source/eric7.Plugins.PluginVcsPySvn.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.PluginVcsPySvn</h1> 9 <h1>eric7.Plugins.PluginVcsPySvn</h1>
10
11 <p> 10 <p>
12 This plugin provides the PySvn version control interface. 11 This plugin provides the PySvn 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>subversionCfgPluginObject</td></tr> 17 <tr><td>error</td></tr>
18 </table> 18 <tr><td>subversionCfgPluginObject</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="#VcsPySvnPlugin">VcsPySvnPlugin</a></td> 24 <td><a href="#VcsPySvnPlugin">VcsPySvnPlugin</a></td>
25 <td>Class implementing the PySvn version control plugin.</td> 25 <td>Class implementing the PySvn 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="#createConfigurationPage">createConfigurationPage</a></td> 32 <td><a href="#createConfigurationPage">createConfigurationPage</a></td>
34 <td>Module function to create the configuration page.</td> 33 <td>Module function to create the configuration page.</td>
35 </tr> 34 </tr>
36 <tr> 35 <tr>
52 <tr> 51 <tr>
53 <td><a href="#prepareUninstall">prepareUninstall</a></td> 52 <td><a href="#prepareUninstall">prepareUninstall</a></td>
54 <td>Module function to prepare for an uninstallation.</td> 53 <td>Module function to prepare for an uninstallation.</td>
55 </tr> 54 </tr>
56 </table> 55 </table>
56
57 <hr /> 57 <hr />
58 <hr /> 58 <hr />
59 <a NAME="VcsPySvnPlugin" ID="VcsPySvnPlugin"></a> 59 <a NAME="VcsPySvnPlugin" ID="VcsPySvnPlugin"></a>
60 <h2>VcsPySvnPlugin</h2> 60 <h2>VcsPySvnPlugin</h2>
61
62 <p> 61 <p>
63 Class implementing the PySvn version control plugin. 62 Class implementing the PySvn version control plugin.
64 </p> 63 </p>
64
65 <h3>Derived from</h3> 65 <h3>Derived from</h3>
66 QObject 66 QObject
67 <h3>Class Attributes</h3> 67 <h3>Class Attributes</h3>
68
69 <table> 68 <table>
70 <tr><td>None</td></tr> 69 <tr><td>None</td></tr>
71 </table> 70 </table>
71
72 <h3>Class Methods</h3> 72 <h3>Class Methods</h3>
73
74 <table> 73 <table>
75 <tr><td>None</td></tr> 74 <tr><td>None</td></tr>
76 </table> 75 </table>
76
77 <h3>Methods</h3> 77 <h3>Methods</h3>
78 78 <table>
79 <table>
80
81 <tr> 79 <tr>
82 <td><a href="#VcsPySvnPlugin.__init__">VcsPySvnPlugin</a></td> 80 <td><a href="#VcsPySvnPlugin.__init__">VcsPySvnPlugin</a></td>
83 <td>Constructor</td> 81 <td>Constructor</td>
84 </tr> 82 </tr>
85 <tr> 83 <tr>
121 <tr> 119 <tr>
122 <td><a href="#VcsPySvnPlugin.setPreferences">setPreferences</a></td> 120 <td><a href="#VcsPySvnPlugin.setPreferences">setPreferences</a></td>
123 <td>Public method to store the various settings.</td> 121 <td>Public method to store the various settings.</td>
124 </tr> 122 </tr>
125 </table> 123 </table>
124
126 <h3>Static Methods</h3> 125 <h3>Static Methods</h3>
127
128 <table> 126 <table>
129 <tr><td>None</td></tr> 127 <tr><td>None</td></tr>
130 </table> 128 </table>
129
131 130
132 <a NAME="VcsPySvnPlugin.__init__" ID="VcsPySvnPlugin.__init__"></a> 131 <a NAME="VcsPySvnPlugin.__init__" ID="VcsPySvnPlugin.__init__"></a>
133 <h4>VcsPySvnPlugin (Constructor)</h4> 132 <h4>VcsPySvnPlugin (Constructor)</h4>
134 <b>VcsPySvnPlugin</b>(<i>ui</i>) 133 <b>VcsPySvnPlugin</b>(<i>ui</i>)
135
136 <p> 134 <p>
137 Constructor 135 Constructor
138 </p> 136 </p>
137
139 <dl> 138 <dl>
140 139
141 <dt><i>ui</i> (UserInterface)</dt> 140 <dt><i>ui</i> (UserInterface)</dt>
142 <dd> 141 <dd>
143 reference to the user interface object 142 reference to the user interface object
144 </dd> 143 </dd>
145 </dl> 144 </dl>
146 <a NAME="VcsPySvnPlugin.activate" ID="VcsPySvnPlugin.activate"></a> 145 <a NAME="VcsPySvnPlugin.activate" ID="VcsPySvnPlugin.activate"></a>
147 <h4>VcsPySvnPlugin.activate</h4> 146 <h4>VcsPySvnPlugin.activate</h4>
148 <b>activate</b>(<i></i>) 147 <b>activate</b>(<i></i>)
149
150 <p> 148 <p>
151 Public method to activate this plugin. 149 Public method to activate this plugin.
152 </p> 150 </p>
151
153 <dl> 152 <dl>
154 <dt>Return:</dt> 153 <dt>Return:</dt>
155 <dd> 154 <dd>
156 tuple of reference to instantiated viewmanager and 155 tuple of reference to instantiated viewmanager and
157 activation status 156 activation status
164 </dd> 163 </dd>
165 </dl> 164 </dl>
166 <a NAME="VcsPySvnPlugin.deactivate" ID="VcsPySvnPlugin.deactivate"></a> 165 <a NAME="VcsPySvnPlugin.deactivate" ID="VcsPySvnPlugin.deactivate"></a>
167 <h4>VcsPySvnPlugin.deactivate</h4> 166 <h4>VcsPySvnPlugin.deactivate</h4>
168 <b>deactivate</b>(<i></i>) 167 <b>deactivate</b>(<i></i>)
169
170 <p> 168 <p>
171 Public method to deactivate this plugin. 169 Public method to deactivate this plugin.
172 </p> 170 </p>
171
173 <a NAME="VcsPySvnPlugin.getConfigPath" ID="VcsPySvnPlugin.getConfigPath"></a> 172 <a NAME="VcsPySvnPlugin.getConfigPath" ID="VcsPySvnPlugin.getConfigPath"></a>
174 <h4>VcsPySvnPlugin.getConfigPath</h4> 173 <h4>VcsPySvnPlugin.getConfigPath</h4>
175 <b>getConfigPath</b>(<i></i>) 174 <b>getConfigPath</b>(<i></i>)
176
177 <p> 175 <p>
178 Public method to get the filename of the config file. 176 Public method to get the filename of the config file.
179 </p> 177 </p>
178
180 <dl> 179 <dl>
181 <dt>Return:</dt> 180 <dt>Return:</dt>
182 <dd> 181 <dd>
183 filename of the config file 182 filename of the config file
184 </dd> 183 </dd>
190 </dd> 189 </dd>
191 </dl> 190 </dl>
192 <a NAME="VcsPySvnPlugin.getPreferences" ID="VcsPySvnPlugin.getPreferences"></a> 191 <a NAME="VcsPySvnPlugin.getPreferences" ID="VcsPySvnPlugin.getPreferences"></a>
193 <h4>VcsPySvnPlugin.getPreferences</h4> 192 <h4>VcsPySvnPlugin.getPreferences</h4>
194 <b>getPreferences</b>(<i>key</i>) 193 <b>getPreferences</b>(<i>key</i>)
195
196 <p> 194 <p>
197 Public method to retrieve the various settings. 195 Public method to retrieve the various settings.
198 </p> 196 </p>
197
199 <dl> 198 <dl>
200 199
201 <dt><i>key</i> (str)</dt> 200 <dt><i>key</i> (str)</dt>
202 <dd> 201 <dd>
203 the key of the value to get 202 the key of the value to get
216 </dd> 215 </dd>
217 </dl> 216 </dl>
218 <a NAME="VcsPySvnPlugin.getProjectHelper" ID="VcsPySvnPlugin.getProjectHelper"></a> 217 <a NAME="VcsPySvnPlugin.getProjectHelper" ID="VcsPySvnPlugin.getProjectHelper"></a>
219 <h4>VcsPySvnPlugin.getProjectHelper</h4> 218 <h4>VcsPySvnPlugin.getProjectHelper</h4>
220 <b>getProjectHelper</b>(<i></i>) 219 <b>getProjectHelper</b>(<i></i>)
221
222 <p> 220 <p>
223 Public method to get a reference to the project helper object. 221 Public method to get a reference to the project helper object.
224 </p> 222 </p>
223
225 <dl> 224 <dl>
226 <dt>Return:</dt> 225 <dt>Return:</dt>
227 <dd> 226 <dd>
228 reference to the project helper object 227 reference to the project helper object
229 </dd> 228 </dd>
235 </dd> 234 </dd>
236 </dl> 235 </dl>
237 <a NAME="VcsPySvnPlugin.getServersPath" ID="VcsPySvnPlugin.getServersPath"></a> 236 <a NAME="VcsPySvnPlugin.getServersPath" ID="VcsPySvnPlugin.getServersPath"></a>
238 <h4>VcsPySvnPlugin.getServersPath</h4> 237 <h4>VcsPySvnPlugin.getServersPath</h4>
239 <b>getServersPath</b>(<i></i>) 238 <b>getServersPath</b>(<i></i>)
240
241 <p> 239 <p>
242 Public method to get the filename of the servers file. 240 Public method to get the filename of the servers file.
243 </p> 241 </p>
242
244 <dl> 243 <dl>
245 <dt>Return:</dt> 244 <dt>Return:</dt>
246 <dd> 245 <dd>
247 filename of the servers file 246 filename of the servers file
248 </dd> 247 </dd>
254 </dd> 253 </dd>
255 </dl> 254 </dl>
256 <a NAME="VcsPySvnPlugin.initToolbar" ID="VcsPySvnPlugin.initToolbar"></a> 255 <a NAME="VcsPySvnPlugin.initToolbar" ID="VcsPySvnPlugin.initToolbar"></a>
257 <h4>VcsPySvnPlugin.initToolbar</h4> 256 <h4>VcsPySvnPlugin.initToolbar</h4>
258 <b>initToolbar</b>(<i>ui, toolbarManager</i>) 257 <b>initToolbar</b>(<i>ui, toolbarManager</i>)
259
260 <p> 258 <p>
261 Public slot to initialize the VCS toolbar. 259 Public slot to initialize the VCS toolbar.
262 </p> 260 </p>
261
263 <dl> 262 <dl>
264 263
265 <dt><i>ui</i> (UserInterface)</dt> 264 <dt><i>ui</i> (UserInterface)</dt>
266 <dd> 265 <dd>
267 reference to the main window 266 reference to the main window
272 </dd> 271 </dd>
273 </dl> 272 </dl>
274 <a NAME="VcsPySvnPlugin.prepareUninstall" ID="VcsPySvnPlugin.prepareUninstall"></a> 273 <a NAME="VcsPySvnPlugin.prepareUninstall" ID="VcsPySvnPlugin.prepareUninstall"></a>
275 <h4>VcsPySvnPlugin.prepareUninstall</h4> 274 <h4>VcsPySvnPlugin.prepareUninstall</h4>
276 <b>prepareUninstall</b>(<i></i>) 275 <b>prepareUninstall</b>(<i></i>)
277
278 <p> 276 <p>
279 Public method to prepare for an uninstallation. 277 Public method to prepare for an uninstallation.
280 </p> 278 </p>
279
281 <a NAME="VcsPySvnPlugin.prepareUnload" ID="VcsPySvnPlugin.prepareUnload"></a> 280 <a NAME="VcsPySvnPlugin.prepareUnload" ID="VcsPySvnPlugin.prepareUnload"></a>
282 <h4>VcsPySvnPlugin.prepareUnload</h4> 281 <h4>VcsPySvnPlugin.prepareUnload</h4>
283 <b>prepareUnload</b>(<i></i>) 282 <b>prepareUnload</b>(<i></i>)
284
285 <p> 283 <p>
286 Public method to prepare for an unload. 284 Public method to prepare for an unload.
287 </p> 285 </p>
286
288 <a NAME="VcsPySvnPlugin.setPreferences" ID="VcsPySvnPlugin.setPreferences"></a> 287 <a NAME="VcsPySvnPlugin.setPreferences" ID="VcsPySvnPlugin.setPreferences"></a>
289 <h4>VcsPySvnPlugin.setPreferences</h4> 288 <h4>VcsPySvnPlugin.setPreferences</h4>
290 <b>setPreferences</b>(<i>key, value</i>) 289 <b>setPreferences</b>(<i>key, value</i>)
291
292 <p> 290 <p>
293 Public method to store the various settings. 291 Public method to store the various settings.
294 </p> 292 </p>
293
295 <dl> 294 <dl>
296 295
297 <dt><i>key</i> (str)</dt> 296 <dt><i>key</i> (str)</dt>
298 <dd> 297 <dd>
299 the key of the setting to be set 298 the key of the setting to be set
307 <hr /> 306 <hr />
308 <hr /> 307 <hr />
309 <a NAME="createConfigurationPage" ID="createConfigurationPage"></a> 308 <a NAME="createConfigurationPage" ID="createConfigurationPage"></a>
310 <h2>createConfigurationPage</h2> 309 <h2>createConfigurationPage</h2>
311 <b>createConfigurationPage</b>(<i>configDlg</i>) 310 <b>createConfigurationPage</b>(<i>configDlg</i>)
312
313 <p> 311 <p>
314 Module function to create the configuration page. 312 Module function to create the configuration page.
315 </p> 313 </p>
314
316 <dl> 315 <dl>
317 316
318 <dt><i>configDlg</i> (QDialog)</dt> 317 <dt><i>configDlg</i> (QDialog)</dt>
319 <dd> 318 <dd>
320 reference to the configuration dialog 319 reference to the configuration dialog
336 <hr /> 335 <hr />
337 <hr /> 336 <hr />
338 <a NAME="displayString" ID="displayString"></a> 337 <a NAME="displayString" ID="displayString"></a>
339 <h2>displayString</h2> 338 <h2>displayString</h2>
340 <b>displayString</b>(<i></i>) 339 <b>displayString</b>(<i></i>)
341
342 <p> 340 <p>
343 Public function to get the display string. 341 Public function to get the display string.
344 </p> 342 </p>
343
345 <dl> 344 <dl>
346 <dt>Return:</dt> 345 <dt>Return:</dt>
347 <dd> 346 <dd>
348 display string 347 display string
349 </dd> 348 </dd>
358 <hr /> 357 <hr />
359 <hr /> 358 <hr />
360 <a NAME="exeDisplayData" ID="exeDisplayData"></a> 359 <a NAME="exeDisplayData" ID="exeDisplayData"></a>
361 <h2>exeDisplayData</h2> 360 <h2>exeDisplayData</h2>
362 <b>exeDisplayData</b>(<i></i>) 361 <b>exeDisplayData</b>(<i></i>)
363
364 <p> 362 <p>
365 Public method to support the display of some executable info. 363 Public method to support the display of some executable info.
366 </p> 364 </p>
365
367 <dl> 366 <dl>
368 <dt>Return:</dt> 367 <dt>Return:</dt>
369 <dd> 368 <dd>
370 dictionary containing the data to be shown 369 dictionary containing the data to be shown
371 </dd> 370 </dd>
380 <hr /> 379 <hr />
381 <hr /> 380 <hr />
382 <a NAME="getConfigData" ID="getConfigData"></a> 381 <a NAME="getConfigData" ID="getConfigData"></a>
383 <h2>getConfigData</h2> 382 <h2>getConfigData</h2>
384 <b>getConfigData</b>(<i></i>) 383 <b>getConfigData</b>(<i></i>)
385
386 <p> 384 <p>
387 Module function returning data as required by the configuration dialog. 385 Module function returning data as required by the configuration dialog.
388 </p> 386 </p>
387
389 <dl> 388 <dl>
390 <dt>Return:</dt> 389 <dt>Return:</dt>
391 <dd> 390 <dd>
392 dictionary with key "zzz_subversionPage" containing the relevant 391 dictionary with key "zzz_subversionPage" containing the relevant
393 data 392 data
403 <hr /> 402 <hr />
404 <hr /> 403 <hr />
405 <a NAME="getVcsSystemIndicator" ID="getVcsSystemIndicator"></a> 404 <a NAME="getVcsSystemIndicator" ID="getVcsSystemIndicator"></a>
406 <h2>getVcsSystemIndicator</h2> 405 <h2>getVcsSystemIndicator</h2>
407 <b>getVcsSystemIndicator</b>(<i></i>) 406 <b>getVcsSystemIndicator</b>(<i></i>)
408
409 <p> 407 <p>
410 Public function to get the indicators for this version control system. 408 Public function to get the indicators for this version control system.
411 </p> 409 </p>
410
412 <dl> 411 <dl>
413 <dt>Return:</dt> 412 <dt>Return:</dt>
414 <dd> 413 <dd>
415 dictionary with indicator as key and a tuple with the vcs name 414 dictionary with indicator as key and a tuple with the vcs name
416 and vcs display string 415 and vcs display string
426 <hr /> 425 <hr />
427 <hr /> 426 <hr />
428 <a NAME="prepareUninstall" ID="prepareUninstall"></a> 427 <a NAME="prepareUninstall" ID="prepareUninstall"></a>
429 <h2>prepareUninstall</h2> 428 <h2>prepareUninstall</h2>
430 <b>prepareUninstall</b>(<i></i>) 429 <b>prepareUninstall</b>(<i></i>)
431
432 <p> 430 <p>
433 Module function to prepare for an uninstallation. 431 Module function to prepare for an uninstallation.
434 </p> 432 </p>
433
435 <div align="right"><a href="#top">Up</a></div> 434 <div align="right"><a href="#top">Up</a></div>
436 <hr /> 435 <hr />
437 </body></html> 436 </body></html>

Mercurial Repository: eric

eric ide

mercurial