Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.Plugins.PluginVcsMercurial.html

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

Mercurial Repository: eric

eric ide

mercurial