--- a/Documentation/Source/eric5.Plugins.PluginVcsPySvn.html Thu Jan 14 17:27:31 2010 +0000 +++ b/Documentation/Source/eric5.Plugins.PluginVcsPySvn.html Thu Jan 14 18:35:52 2010 +0000 @@ -22,7 +22,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.Plugins.PluginVcsPySvn</h1> <p> -Module implementing the PySvn version control plugin. +Module implementing the PySvn version control plugin. </p> <h3>Global Attributes</h3> <table> @@ -32,36 +32,36 @@ <table> <tr> <td><a href="#VcsPySvnPlugin">VcsPySvnPlugin</a></td> -<td>Class implementing the PySvn version control plugin.</td> +<td>Class implementing the PySvn version control plugin.</td> </tr> </table> <h3>Functions</h3> <table> <tr> <td><a href="#createConfigurationPage">createConfigurationPage</a></td> -<td>Module function to create the configuration page.</td> +<td>Module function to create the configuration page.</td> </tr><tr> <td><a href="#displayString">displayString</a></td> -<td>Public function to get the display string.</td> +<td>Public function to get the display string.</td> </tr><tr> <td><a href="#exeDisplayData">exeDisplayData</a></td> -<td>Public method to support the display of some executable info.</td> +<td>Public method to support the display of some executable info.</td> </tr><tr> <td><a href="#getConfigData">getConfigData</a></td> -<td>Module function returning data as required by the configuration dialog.</td> +<td>Module function returning data as required by the configuration dialog.</td> </tr><tr> <td><a href="#getVcsSystemIndicator">getVcsSystemIndicator</a></td> -<td>Public function to get the indicators for this version control system.</td> +<td>Public function to get the indicators for this version control system.</td> </tr><tr> <td><a href="#prepareUninstall">prepareUninstall</a></td> -<td>Module function to prepare for an uninstallation.</td> +<td>Module function to prepare for an uninstallation.</td> </tr> </table> <hr /><hr /> <a NAME="VcsPySvnPlugin" ID="VcsPySvnPlugin"></a> <h2>VcsPySvnPlugin</h2> <p> - Class implementing the PySvn version control plugin. + Class implementing the PySvn version control plugin. </p> <h3>Derived from</h3> object @@ -73,127 +73,127 @@ <table> <tr> <td><a href="#VcsPySvnPlugin.__init__">VcsPySvnPlugin</a></td> -<td>Constructor</td> +<td>Constructor</td> </tr><tr> <td><a href="#VcsPySvnPlugin.activate">activate</a></td> -<td>Public method to activate this plugin.</td> +<td>Public method to activate this plugin.</td> </tr><tr> <td><a href="#VcsPySvnPlugin.deactivate">deactivate</a></td> -<td>Public method to deactivate this plugin.</td> +<td>Public method to deactivate this plugin.</td> </tr><tr> <td><a href="#VcsPySvnPlugin.getConfigPath">getConfigPath</a></td> -<td>Public method to get the filename of the config file.</td> +<td>Public method to get the filename of the config file.</td> </tr><tr> <td><a href="#VcsPySvnPlugin.getPreferences">getPreferences</a></td> -<td>Public method to retrieve the various refactoring settings.</td> +<td>Public method to retrieve the various refactoring settings.</td> </tr><tr> <td><a href="#VcsPySvnPlugin.getProjectHelper">getProjectHelper</a></td> -<td>Public method to get a reference to the project helper object.</td> +<td>Public method to get a reference to the project helper object.</td> </tr><tr> <td><a href="#VcsPySvnPlugin.getServersPath">getServersPath</a></td> -<td>Public method to get the filename of the servers file.</td> +<td>Public method to get the filename of the servers file.</td> </tr><tr> <td><a href="#VcsPySvnPlugin.prepareUninstall">prepareUninstall</a></td> -<td>Public method to prepare for an uninstallation.</td> +<td>Public method to prepare for an uninstallation.</td> </tr><tr> <td><a href="#VcsPySvnPlugin.setPreferences">setPreferences</a></td> -<td>Public method to store the various refactoring settings.</td> +<td>Public method to store the various refactoring settings.</td> </tr> </table> <a NAME="VcsPySvnPlugin.__init__" ID="VcsPySvnPlugin.__init__"></a> <h4>VcsPySvnPlugin (Constructor)</h4> <b>VcsPySvnPlugin</b>(<i>ui</i>) <p> - Constructor + Constructor </p><dl> <dt><i>ui</i></dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object (UI.UserInterface) </dd> </dl><a NAME="VcsPySvnPlugin.activate" ID="VcsPySvnPlugin.activate"></a> <h4>VcsPySvnPlugin.activate</h4> <b>activate</b>(<i></i>) <p> - Public method to activate this plugin. + Public method to activate this plugin. </p><dl> <dt>Returns:</dt> <dd> -tuple of reference to instantiated viewmanager and - activation status (boolean) +tuple of reference to instantiated viewmanager and + activation status (boolean) </dd> </dl><a NAME="VcsPySvnPlugin.deactivate" ID="VcsPySvnPlugin.deactivate"></a> <h4>VcsPySvnPlugin.deactivate</h4> <b>deactivate</b>(<i></i>) <p> - Public method to deactivate this plugin. + Public method to deactivate this plugin. </p><a NAME="VcsPySvnPlugin.getConfigPath" ID="VcsPySvnPlugin.getConfigPath"></a> <h4>VcsPySvnPlugin.getConfigPath</h4> <b>getConfigPath</b>(<i></i>) <p> - Public method to get the filename of the config file. + Public method to get the filename of the config file. </p><dl> <dt>Returns:</dt> <dd> -filename of the config file (string) +filename of the config file (string) </dd> </dl><a NAME="VcsPySvnPlugin.getPreferences" ID="VcsPySvnPlugin.getPreferences"></a> <h4>VcsPySvnPlugin.getPreferences</h4> <b>getPreferences</b>(<i>key</i>) <p> - Public method to retrieve the various refactoring settings. + Public method to retrieve the various refactoring settings. </p><dl> <dt><i>key</i></dt> <dd> -the key of the value to get +the key of the value to get </dd><dt><i>prefClass</i></dt> <dd> -preferences class used as the storage area +preferences class used as the storage area </dd> </dl><dl> <dt>Returns:</dt> <dd> -the requested refactoring setting +the requested refactoring setting </dd> </dl><a NAME="VcsPySvnPlugin.getProjectHelper" ID="VcsPySvnPlugin.getProjectHelper"></a> <h4>VcsPySvnPlugin.getProjectHelper</h4> <b>getProjectHelper</b>(<i></i>) <p> - Public method to get a reference to the project helper object. + Public method to get a reference to the project helper object. </p><dl> <dt>Returns:</dt> <dd> -reference to the project helper object +reference to the project helper object </dd> </dl><a NAME="VcsPySvnPlugin.getServersPath" ID="VcsPySvnPlugin.getServersPath"></a> <h4>VcsPySvnPlugin.getServersPath</h4> <b>getServersPath</b>(<i></i>) <p> - Public method to get the filename of the servers file. + Public method to get the filename of the servers file. </p><dl> <dt>Returns:</dt> <dd> -filename of the servers file (string) +filename of the servers file (string) </dd> </dl><a NAME="VcsPySvnPlugin.prepareUninstall" ID="VcsPySvnPlugin.prepareUninstall"></a> <h4>VcsPySvnPlugin.prepareUninstall</h4> <b>prepareUninstall</b>(<i></i>) <p> - Public method to prepare for an uninstallation. + Public method to prepare for an uninstallation. </p><a NAME="VcsPySvnPlugin.setPreferences" ID="VcsPySvnPlugin.setPreferences"></a> <h4>VcsPySvnPlugin.setPreferences</h4> <b>setPreferences</b>(<i>key, value</i>) <p> - Public method to store the various refactoring settings. + Public method to store the various refactoring settings. </p><dl> <dt><i>key</i></dt> <dd> -the key of the setting to be set +the key of the setting to be set </dd><dt><i>value</i></dt> <dd> -the value to be set +the value to be set </dd><dt><i>prefClass</i></dt> <dd> -preferences class used as the storage area +preferences class used as the storage area </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -202,11 +202,11 @@ <h2>createConfigurationPage</h2> <b>createConfigurationPage</b>(<i>configDlg</i>) <p> - Module function to create the configuration page. + Module function to create the configuration page. </p><dl> <dt>Returns:</dt> <dd> -reference to the configuration page +reference to the configuration page </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -215,11 +215,11 @@ <h2>displayString</h2> <b>displayString</b>(<i></i>) <p> - Public function to get the display string. + Public function to get the display string. </p><dl> <dt>Returns:</dt> <dd> -display string (string) +display string (string) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -228,11 +228,11 @@ <h2>exeDisplayData</h2> <b>exeDisplayData</b>(<i></i>) <p> - Public method to support the display of some executable info. + Public method to support the display of some executable info. </p><dl> <dt>Returns:</dt> <dd> -dictionary containing the data to be shown +dictionary containing the data to be shown </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -241,11 +241,11 @@ <h2>getConfigData</h2> <b>getConfigData</b>(<i></i>) <p> - Module function returning data as required by the configuration dialog. + Module function returning data as required by the configuration dialog. </p><dl> <dt>Returns:</dt> <dd> -dictionary with key "zzz_subversionPage" containing the relevant data +dictionary with key "zzz_subversionPage" containing the relevant data </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -254,12 +254,12 @@ <h2>getVcsSystemIndicator</h2> <b>getVcsSystemIndicator</b>(<i></i>) <p> - Public function to get the indicators for this version control system. + Public function to get the indicators for this version control system. </p><dl> <dt>Returns:</dt> <dd> -dictionary with indicator as key and a tuple with the vcs name (string) - and vcs display string (string) +dictionary with indicator as key and a tuple with the vcs name (string) + and vcs display string (string) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -268,7 +268,7 @@ <h2>prepareUninstall</h2> <b>prepareUninstall</b>(<i></i>) <p> - Module function to prepare for an uninstallation. + Module function to prepare for an uninstallation. </p> <div align="right"><a href="#top">Up</a></div> <hr />