Documentation/Source/eric6.Plugins.PluginVcsMercurial.html

changeset 5559
072d97551334
parent 4115
0c70a8f8d54a
--- a/Documentation/Source/eric6.Plugins.PluginVcsMercurial.html	Sat Feb 25 19:41:10 2017 +0100
+++ b/Documentation/Source/eric6.Plugins.PluginVcsMercurial.html	Sat Feb 25 19:41:53 2017 +0100
@@ -37,6 +37,9 @@
 <h3>Functions</h3>
 <table>
 <tr>
+<td><a href="#clearPrivateData">clearPrivateData</a></td>
+<td>Module function to clear the private data of the plug-in.</td>
+</tr><tr>
 <td><a href="#createConfigurationPage">createConfigurationPage</a></td>
 <td>Module function to create the configuration page.</td>
 </tr><tr>
@@ -66,11 +69,17 @@
 QObject
 <h3>Class Attributes</h3>
 <table>
-<tr><td>None</td></tr>
+<tr><td>MercurialDefaults</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
-<tr><td>None</td></tr>
+<tr>
+<td><a href="#VcsMercurialPlugin.getPreferences">getPreferences</a></td>
+<td>Class method to retrieve the various settings.</td>
+</tr><tr>
+<td><a href="#VcsMercurialPlugin.setPreferences">setPreferences</a></td>
+<td>Class method to store the various settings.</td>
+</tr>
 </table>
 <h3>Methods</h3>
 <table>
@@ -90,9 +99,6 @@
 <td><a href="#VcsMercurialPlugin.getGlobalOptions">getGlobalOptions</a></td>
 <td>Public method to build a list of global options.</td>
 </tr><tr>
-<td><a href="#VcsMercurialPlugin.getPreferences">getPreferences</a></td>
-<td>Public method to retrieve the various settings.</td>
-</tr><tr>
 <td><a href="#VcsMercurialPlugin.getProjectHelper">getProjectHelper</a></td>
 <td>Public method to get a reference to the project helper object.</td>
 </tr><tr>
@@ -104,16 +110,41 @@
 </tr><tr>
 <td><a href="#VcsMercurialPlugin.prepareUnload">prepareUnload</a></td>
 <td>Public method to prepare for an unload.</td>
-</tr><tr>
-<td><a href="#VcsMercurialPlugin.setPreferences">setPreferences</a></td>
-<td>Public method to store the various settings.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
-<a NAME="VcsMercurialPlugin.__init__" ID="VcsMercurialPlugin.__init__"></a>
+<a NAME="VcsMercurialPlugin.getPreferences" ID="VcsMercurialPlugin.getPreferences"></a>
+<h4>VcsMercurialPlugin.getPreferences (class method)</h4>
+<b>getPreferences</b>(<i>key</i>)
+<p>
+        Class method to retrieve the various settings.
+</p><dl>
+<dt><i>key</i></dt>
+<dd>
+the key of the value to get
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+the requested setting
+</dd>
+</dl><a NAME="VcsMercurialPlugin.setPreferences" ID="VcsMercurialPlugin.setPreferences"></a>
+<h4>VcsMercurialPlugin.setPreferences (class method)</h4>
+<b>setPreferences</b>(<i>key, value</i>)
+<p>
+        Class method to store the various settings.
+</p><dl>
+<dt><i>key</i></dt>
+<dd>
+the key of the setting to be set
+</dd><dt><i>value</i></dt>
+<dd>
+the value to be set
+</dd>
+</dl><a NAME="VcsMercurialPlugin.__init__" ID="VcsMercurialPlugin.__init__"></a>
 <h4>VcsMercurialPlugin (Constructor)</h4>
 <b>VcsMercurialPlugin</b>(<i>ui</i>)
 <p>
@@ -159,21 +190,6 @@
 <dd>
 list of global options (list of string)
 </dd>
-</dl><a NAME="VcsMercurialPlugin.getPreferences" ID="VcsMercurialPlugin.getPreferences"></a>
-<h4>VcsMercurialPlugin.getPreferences</h4>
-<b>getPreferences</b>(<i>key</i>)
-<p>
-        Public method to retrieve the various settings.
-</p><dl>
-<dt><i>key</i></dt>
-<dd>
-the key of the value to get
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-the requested setting
-</dd>
 </dl><a NAME="VcsMercurialPlugin.getProjectHelper" ID="VcsMercurialPlugin.getProjectHelper"></a>
 <h4>VcsMercurialPlugin.getProjectHelper</h4>
 <b>getProjectHelper</b>(<i></i>)
@@ -208,20 +224,15 @@
 <b>prepareUnload</b>(<i></i>)
 <p>
         Public method to prepare for an unload.
-</p><a NAME="VcsMercurialPlugin.setPreferences" ID="VcsMercurialPlugin.setPreferences"></a>
-<h4>VcsMercurialPlugin.setPreferences</h4>
-<b>setPreferences</b>(<i>key, value</i>)
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="clearPrivateData" ID="clearPrivateData"></a>
+<h2>clearPrivateData</h2>
+<b>clearPrivateData</b>(<i></i>)
 <p>
-        Public method to store the various settings.
-</p><dl>
-<dt><i>key</i></dt>
-<dd>
-the key of the setting to be set
-</dd><dt><i>value</i></dt>
-<dd>
-the value to be set
-</dd>
-</dl>
+    Module function to clear the private data of the plug-in.
+</p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
 <a NAME="createConfigurationPage" ID="createConfigurationPage"></a>

eric ide

mercurial