Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.PluginVcsSubversion.html

eric6/Documentation/Source/eric6.Plugins.PluginVcsSubversion.html

changeset 6942
2602857055c5
parent 4115
0c70a8f8d54a
child 7204
cbf6d88004ce
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.PluginVcsSubversion</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.PluginVcsSubversion</h1>
23 <p>
24 Module implementing the Subversion version control plugin.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <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>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>subversionCfgPluginObject</td></tr><tr><td>version</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#VcsSubversionPlugin">VcsSubversionPlugin</a></td>
34 <td>Class implementing the Subversion version control plugin.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr>
40 <td><a href="#createConfigurationPage">createConfigurationPage</a></td>
41 <td>Module function to create the configuration page.</td>
42 </tr><tr>
43 <td><a href="#displayString">displayString</a></td>
44 <td>Public function to get the display string.</td>
45 </tr><tr>
46 <td><a href="#exeDisplayData">exeDisplayData</a></td>
47 <td>Public method to support the display of some executable info.</td>
48 </tr><tr>
49 <td><a href="#getConfigData">getConfigData</a></td>
50 <td>Module function returning data as required by the configuration dialog.</td>
51 </tr><tr>
52 <td><a href="#getVcsSystemIndicator">getVcsSystemIndicator</a></td>
53 <td>Public function to get the indicators for this version control system.</td>
54 </tr><tr>
55 <td><a href="#prepareUninstall">prepareUninstall</a></td>
56 <td>Module function to prepare for an uninstallation.</td>
57 </tr>
58 </table>
59 <hr /><hr />
60 <a NAME="VcsSubversionPlugin" ID="VcsSubversionPlugin"></a>
61 <h2>VcsSubversionPlugin</h2>
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 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Class Methods</h3>
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75 <h3>Methods</h3>
76 <table>
77 <tr>
78 <td><a href="#VcsSubversionPlugin.__init__">VcsSubversionPlugin</a></td>
79 <td>Constructor</td>
80 </tr><tr>
81 <td><a href="#VcsSubversionPlugin.activate">activate</a></td>
82 <td>Public method to activate this plugin.</td>
83 </tr><tr>
84 <td><a href="#VcsSubversionPlugin.deactivate">deactivate</a></td>
85 <td>Public method to deactivate this plugin.</td>
86 </tr><tr>
87 <td><a href="#VcsSubversionPlugin.getConfigPath">getConfigPath</a></td>
88 <td>Public method to get the filename of the config file.</td>
89 </tr><tr>
90 <td><a href="#VcsSubversionPlugin.getPreferences">getPreferences</a></td>
91 <td>Public method to retrieve the various settings.</td>
92 </tr><tr>
93 <td><a href="#VcsSubversionPlugin.getProjectHelper">getProjectHelper</a></td>
94 <td>Public method to get a reference to the project helper object.</td>
95 </tr><tr>
96 <td><a href="#VcsSubversionPlugin.getServersPath">getServersPath</a></td>
97 <td>Public method to get the filename of the servers file.</td>
98 </tr><tr>
99 <td><a href="#VcsSubversionPlugin.initToolbar">initToolbar</a></td>
100 <td>Public slot to initialize the VCS toolbar.</td>
101 </tr><tr>
102 <td><a href="#VcsSubversionPlugin.prepareUninstall">prepareUninstall</a></td>
103 <td>Public method to prepare for an uninstallation.</td>
104 </tr><tr>
105 <td><a href="#VcsSubversionPlugin.prepareUnload">prepareUnload</a></td>
106 <td>Public method to prepare for an unload.</td>
107 </tr><tr>
108 <td><a href="#VcsSubversionPlugin.setPreferences">setPreferences</a></td>
109 <td>Public method to store the various settings.</td>
110 </tr>
111 </table>
112 <h3>Static Methods</h3>
113 <table>
114 <tr><td>None</td></tr>
115 </table>
116 <a NAME="VcsSubversionPlugin.__init__" ID="VcsSubversionPlugin.__init__"></a>
117 <h4>VcsSubversionPlugin (Constructor)</h4>
118 <b>VcsSubversionPlugin</b>(<i>ui</i>)
119 <p>
120 Constructor
121 </p><dl>
122 <dt><i>ui</i></dt>
123 <dd>
124 reference to the user interface object (UI.UserInterface)
125 </dd>
126 </dl><a NAME="VcsSubversionPlugin.activate" ID="VcsSubversionPlugin.activate"></a>
127 <h4>VcsSubversionPlugin.activate</h4>
128 <b>activate</b>(<i></i>)
129 <p>
130 Public method to activate this plugin.
131 </p><dl>
132 <dt>Returns:</dt>
133 <dd>
134 tuple of reference to instantiated viewmanager and
135 activation status (boolean)
136 </dd>
137 </dl><a NAME="VcsSubversionPlugin.deactivate" ID="VcsSubversionPlugin.deactivate"></a>
138 <h4>VcsSubversionPlugin.deactivate</h4>
139 <b>deactivate</b>(<i></i>)
140 <p>
141 Public method to deactivate this plugin.
142 </p><a NAME="VcsSubversionPlugin.getConfigPath" ID="VcsSubversionPlugin.getConfigPath"></a>
143 <h4>VcsSubversionPlugin.getConfigPath</h4>
144 <b>getConfigPath</b>(<i></i>)
145 <p>
146 Public method to get the filename of the config file.
147 </p><dl>
148 <dt>Returns:</dt>
149 <dd>
150 filename of the config file (string)
151 </dd>
152 </dl><a NAME="VcsSubversionPlugin.getPreferences" ID="VcsSubversionPlugin.getPreferences"></a>
153 <h4>VcsSubversionPlugin.getPreferences</h4>
154 <b>getPreferences</b>(<i>key</i>)
155 <p>
156 Public method to retrieve the various settings.
157 </p><dl>
158 <dt><i>key</i></dt>
159 <dd>
160 the key of the value to get
161 </dd>
162 </dl><dl>
163 <dt>Returns:</dt>
164 <dd>
165 the requested setting
166 </dd>
167 </dl><a NAME="VcsSubversionPlugin.getProjectHelper" ID="VcsSubversionPlugin.getProjectHelper"></a>
168 <h4>VcsSubversionPlugin.getProjectHelper</h4>
169 <b>getProjectHelper</b>(<i></i>)
170 <p>
171 Public method to get a reference to the project helper object.
172 </p><dl>
173 <dt>Returns:</dt>
174 <dd>
175 reference to the project helper object
176 </dd>
177 </dl><a NAME="VcsSubversionPlugin.getServersPath" ID="VcsSubversionPlugin.getServersPath"></a>
178 <h4>VcsSubversionPlugin.getServersPath</h4>
179 <b>getServersPath</b>(<i></i>)
180 <p>
181 Public method to get the filename of the servers file.
182 </p><dl>
183 <dt>Returns:</dt>
184 <dd>
185 filename of the servers file (string)
186 </dd>
187 </dl><a NAME="VcsSubversionPlugin.initToolbar" ID="VcsSubversionPlugin.initToolbar"></a>
188 <h4>VcsSubversionPlugin.initToolbar</h4>
189 <b>initToolbar</b>(<i>ui, toolbarManager</i>)
190 <p>
191 Public slot to initialize the VCS toolbar.
192 </p><dl>
193 <dt><i>ui</i></dt>
194 <dd>
195 reference to the main window (UserInterface)
196 </dd><dt><i>toolbarManager</i></dt>
197 <dd>
198 reference to a toolbar manager object
199 (E5ToolBarManager)
200 </dd>
201 </dl><a NAME="VcsSubversionPlugin.prepareUninstall" ID="VcsSubversionPlugin.prepareUninstall"></a>
202 <h4>VcsSubversionPlugin.prepareUninstall</h4>
203 <b>prepareUninstall</b>(<i></i>)
204 <p>
205 Public method to prepare for an uninstallation.
206 </p><a NAME="VcsSubversionPlugin.prepareUnload" ID="VcsSubversionPlugin.prepareUnload"></a>
207 <h4>VcsSubversionPlugin.prepareUnload</h4>
208 <b>prepareUnload</b>(<i></i>)
209 <p>
210 Public method to prepare for an unload.
211 </p><a NAME="VcsSubversionPlugin.setPreferences" ID="VcsSubversionPlugin.setPreferences"></a>
212 <h4>VcsSubversionPlugin.setPreferences</h4>
213 <b>setPreferences</b>(<i>key, value</i>)
214 <p>
215 Public method to store the various settings.
216 </p><dl>
217 <dt><i>key</i></dt>
218 <dd>
219 the key of the setting to be set
220 </dd><dt><i>value</i></dt>
221 <dd>
222 the value to be set
223 </dd>
224 </dl>
225 <div align="right"><a href="#top">Up</a></div>
226 <hr /><hr />
227 <a NAME="createConfigurationPage" ID="createConfigurationPage"></a>
228 <h2>createConfigurationPage</h2>
229 <b>createConfigurationPage</b>(<i>configDlg</i>)
230 <p>
231 Module function to create the configuration page.
232 </p><dl>
233 <dt><i>configDlg</i></dt>
234 <dd>
235 reference to the configuration dialog (QDialog)
236 </dd>
237 </dl><dl>
238 <dt>Returns:</dt>
239 <dd>
240 reference to the configuration page
241 </dd>
242 </dl>
243 <div align="right"><a href="#top">Up</a></div>
244 <hr /><hr />
245 <a NAME="displayString" ID="displayString"></a>
246 <h2>displayString</h2>
247 <b>displayString</b>(<i></i>)
248 <p>
249 Public function to get the display string.
250 </p><dl>
251 <dt>Returns:</dt>
252 <dd>
253 display string (string)
254 </dd>
255 </dl>
256 <div align="right"><a href="#top">Up</a></div>
257 <hr /><hr />
258 <a NAME="exeDisplayData" ID="exeDisplayData"></a>
259 <h2>exeDisplayData</h2>
260 <b>exeDisplayData</b>(<i></i>)
261 <p>
262 Public method to support the display of some executable info.
263 </p><dl>
264 <dt>Returns:</dt>
265 <dd>
266 dictionary containing the data to query the presence of
267 the executable
268 </dd>
269 </dl>
270 <div align="right"><a href="#top">Up</a></div>
271 <hr /><hr />
272 <a NAME="getConfigData" ID="getConfigData"></a>
273 <h2>getConfigData</h2>
274 <b>getConfigData</b>(<i></i>)
275 <p>
276 Module function returning data as required by the configuration dialog.
277 </p><dl>
278 <dt>Returns:</dt>
279 <dd>
280 dictionary with key "zzz_subversionPage" containing the relevant
281 data
282 </dd>
283 </dl>
284 <div align="right"><a href="#top">Up</a></div>
285 <hr /><hr />
286 <a NAME="getVcsSystemIndicator" ID="getVcsSystemIndicator"></a>
287 <h2>getVcsSystemIndicator</h2>
288 <b>getVcsSystemIndicator</b>(<i></i>)
289 <p>
290 Public function to get the indicators for this version control system.
291 </p><dl>
292 <dt>Returns:</dt>
293 <dd>
294 dictionary with indicator as key and a tuple with the vcs name
295 (string) and vcs display string (string)
296 </dd>
297 </dl>
298 <div align="right"><a href="#top">Up</a></div>
299 <hr /><hr />
300 <a NAME="prepareUninstall" ID="prepareUninstall"></a>
301 <h2>prepareUninstall</h2>
302 <b>prepareUninstall</b>(<i></i>)
303 <p>
304 Module function to prepare for an uninstallation.
305 </p>
306 <div align="right"><a href="#top">Up</a></div>
307 <hr />
308 </body></html>

Mercurial Repository: eric

eric ide

mercurial