--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsPySvn.ProjectHelper.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsPySvn.ProjectHelper.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,250 +18,336 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsPySvn.ProjectHelper</h1> + <p> Module implementing the VCS project helper for Subversion. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#PySvnProjectHelper">PySvnProjectHelper</a></td> <td>Class implementing the VCS project helper for Subversion.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="PySvnProjectHelper" ID="PySvnProjectHelper"></a> <h2>PySvnProjectHelper</h2> + <p> Class implementing the VCS project helper for Subversion. </p> <h3>Derived from</h3> VcsProjectHelper <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#PySvnProjectHelper.__init__">PySvnProjectHelper</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.__svnBranchList">__svnBranchList</a></td> <td>Private slot used to list the branches of the project.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.__svnChangeLists">__svnChangeLists</a></td> <td>Private slot used to show a list of change lists.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.__svnConfigure">__svnConfigure</a></td> <td>Private slot to open the configuration dialog.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.__svnExtendedDiff">__svnExtendedDiff</a></td> <td>Private slot used to perform a svn diff with the selection of revisions.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.__svnInfo">__svnInfo</a></td> <td>Private slot used to show repository information for the local project.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.__svnPropDel">__svnPropDel</a></td> <td>Private slot used to delete a property for the project files.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.__svnPropList">__svnPropList</a></td> <td>Private slot used to list the properties of the project files.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.__svnPropSet">__svnPropSet</a></td> <td>Private slot used to set a property for the project files.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.__svnRelocate">__svnRelocate</a></td> <td>Private slot used to relocate the working copy to a new repository URL.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.__svnRepoBrowser">__svnRepoBrowser</a></td> <td>Private slot to open the repository browser.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.__svnResolve">__svnResolve</a></td> <td>Private slot used to resolve conflicts of the local project.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.__svnTagList">__svnTagList</a></td> <td>Private slot used to list the tags of the project.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.__svnUpgrade">__svnUpgrade</a></td> <td>Private slot used to upgrade the working copy format.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.__svnUrlDiff">__svnUrlDiff</a></td> <td>Private slot used to perform a svn diff with the selection of repository URLs.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.getActions">getActions</a></td> <td>Public method to get a list of all actions.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.initActions">initActions</a></td> <td>Public method to generate the action objects.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.initMenu">initMenu</a></td> <td>Public method to generate the VCS menu.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.initToolbar">initToolbar</a></td> <td>Public slot to initialize the VCS toolbar.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PySvnProjectHelper.removeToolbar">removeToolbar</a></td> <td>Public method to remove a toolbar created by initToolbar().</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="PySvnProjectHelper.__init__" ID="PySvnProjectHelper.__init__"></a> <h4>PySvnProjectHelper (Constructor)</h4> <b>PySvnProjectHelper</b>(<i>vcsObject, projectObject, parent=None, name=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>vcsObject</i></dt> <dd> reference to the vcs object -</dd><dt><i>projectObject</i></dt> +</dd> +<dt><i>projectObject</i></dt> <dd> reference to the project object -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> parent widget (QWidget) -</dd><dt><i>name</i></dt> +</dd> +<dt><i>name</i></dt> <dd> name of this object (string) </dd> -</dl><a NAME="PySvnProjectHelper.__svnBranchList" ID="PySvnProjectHelper.__svnBranchList"></a> +</dl> +<a NAME="PySvnProjectHelper.__svnBranchList" ID="PySvnProjectHelper.__svnBranchList"></a> <h4>PySvnProjectHelper.__svnBranchList</h4> <b>__svnBranchList</b>(<i></i>) + <p> Private slot used to list the branches of the project. -</p><a NAME="PySvnProjectHelper.__svnChangeLists" ID="PySvnProjectHelper.__svnChangeLists"></a> +</p> +<a NAME="PySvnProjectHelper.__svnChangeLists" ID="PySvnProjectHelper.__svnChangeLists"></a> <h4>PySvnProjectHelper.__svnChangeLists</h4> <b>__svnChangeLists</b>(<i></i>) + <p> Private slot used to show a list of change lists. -</p><a NAME="PySvnProjectHelper.__svnConfigure" ID="PySvnProjectHelper.__svnConfigure"></a> +</p> +<a NAME="PySvnProjectHelper.__svnConfigure" ID="PySvnProjectHelper.__svnConfigure"></a> <h4>PySvnProjectHelper.__svnConfigure</h4> <b>__svnConfigure</b>(<i></i>) + <p> Private slot to open the configuration dialog. -</p><a NAME="PySvnProjectHelper.__svnExtendedDiff" ID="PySvnProjectHelper.__svnExtendedDiff"></a> +</p> +<a NAME="PySvnProjectHelper.__svnExtendedDiff" ID="PySvnProjectHelper.__svnExtendedDiff"></a> <h4>PySvnProjectHelper.__svnExtendedDiff</h4> <b>__svnExtendedDiff</b>(<i></i>) + <p> Private slot used to perform a svn diff with the selection of revisions. -</p><a NAME="PySvnProjectHelper.__svnInfo" ID="PySvnProjectHelper.__svnInfo"></a> +</p> +<a NAME="PySvnProjectHelper.__svnInfo" ID="PySvnProjectHelper.__svnInfo"></a> <h4>PySvnProjectHelper.__svnInfo</h4> <b>__svnInfo</b>(<i></i>) + <p> Private slot used to show repository information for the local project. -</p><a NAME="PySvnProjectHelper.__svnPropDel" ID="PySvnProjectHelper.__svnPropDel"></a> +</p> +<a NAME="PySvnProjectHelper.__svnPropDel" ID="PySvnProjectHelper.__svnPropDel"></a> <h4>PySvnProjectHelper.__svnPropDel</h4> <b>__svnPropDel</b>(<i></i>) + <p> Private slot used to delete a property for the project files. -</p><a NAME="PySvnProjectHelper.__svnPropList" ID="PySvnProjectHelper.__svnPropList"></a> +</p> +<a NAME="PySvnProjectHelper.__svnPropList" ID="PySvnProjectHelper.__svnPropList"></a> <h4>PySvnProjectHelper.__svnPropList</h4> <b>__svnPropList</b>(<i></i>) + <p> Private slot used to list the properties of the project files. -</p><a NAME="PySvnProjectHelper.__svnPropSet" ID="PySvnProjectHelper.__svnPropSet"></a> +</p> +<a NAME="PySvnProjectHelper.__svnPropSet" ID="PySvnProjectHelper.__svnPropSet"></a> <h4>PySvnProjectHelper.__svnPropSet</h4> <b>__svnPropSet</b>(<i></i>) + <p> Private slot used to set a property for the project files. -</p><a NAME="PySvnProjectHelper.__svnRelocate" ID="PySvnProjectHelper.__svnRelocate"></a> +</p> +<a NAME="PySvnProjectHelper.__svnRelocate" ID="PySvnProjectHelper.__svnRelocate"></a> <h4>PySvnProjectHelper.__svnRelocate</h4> <b>__svnRelocate</b>(<i></i>) + <p> Private slot used to relocate the working copy to a new repository URL. -</p><a NAME="PySvnProjectHelper.__svnRepoBrowser" ID="PySvnProjectHelper.__svnRepoBrowser"></a> +</p> +<a NAME="PySvnProjectHelper.__svnRepoBrowser" ID="PySvnProjectHelper.__svnRepoBrowser"></a> <h4>PySvnProjectHelper.__svnRepoBrowser</h4> <b>__svnRepoBrowser</b>(<i></i>) + <p> Private slot to open the repository browser. -</p><a NAME="PySvnProjectHelper.__svnResolve" ID="PySvnProjectHelper.__svnResolve"></a> +</p> +<a NAME="PySvnProjectHelper.__svnResolve" ID="PySvnProjectHelper.__svnResolve"></a> <h4>PySvnProjectHelper.__svnResolve</h4> <b>__svnResolve</b>(<i></i>) + <p> Private slot used to resolve conflicts of the local project. -</p><a NAME="PySvnProjectHelper.__svnTagList" ID="PySvnProjectHelper.__svnTagList"></a> +</p> +<a NAME="PySvnProjectHelper.__svnTagList" ID="PySvnProjectHelper.__svnTagList"></a> <h4>PySvnProjectHelper.__svnTagList</h4> <b>__svnTagList</b>(<i></i>) + <p> Private slot used to list the tags of the project. -</p><a NAME="PySvnProjectHelper.__svnUpgrade" ID="PySvnProjectHelper.__svnUpgrade"></a> +</p> +<a NAME="PySvnProjectHelper.__svnUpgrade" ID="PySvnProjectHelper.__svnUpgrade"></a> <h4>PySvnProjectHelper.__svnUpgrade</h4> <b>__svnUpgrade</b>(<i></i>) + <p> Private slot used to upgrade the working copy format. -</p><a NAME="PySvnProjectHelper.__svnUrlDiff" ID="PySvnProjectHelper.__svnUrlDiff"></a> +</p> +<a NAME="PySvnProjectHelper.__svnUrlDiff" ID="PySvnProjectHelper.__svnUrlDiff"></a> <h4>PySvnProjectHelper.__svnUrlDiff</h4> <b>__svnUrlDiff</b>(<i></i>) + <p> Private slot used to perform a svn diff with the selection of repository URLs. -</p><a NAME="PySvnProjectHelper.getActions" ID="PySvnProjectHelper.getActions"></a> +</p> +<a NAME="PySvnProjectHelper.getActions" ID="PySvnProjectHelper.getActions"></a> <h4>PySvnProjectHelper.getActions</h4> <b>getActions</b>(<i></i>) + <p> Public method to get a list of all actions. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> list of all actions (list of E5Action) </dd> -</dl><a NAME="PySvnProjectHelper.initActions" ID="PySvnProjectHelper.initActions"></a> +</dl> +<a NAME="PySvnProjectHelper.initActions" ID="PySvnProjectHelper.initActions"></a> <h4>PySvnProjectHelper.initActions</h4> <b>initActions</b>(<i></i>) + <p> Public method to generate the action objects. -</p><a NAME="PySvnProjectHelper.initMenu" ID="PySvnProjectHelper.initMenu"></a> +</p> +<a NAME="PySvnProjectHelper.initMenu" ID="PySvnProjectHelper.initMenu"></a> <h4>PySvnProjectHelper.initMenu</h4> <b>initMenu</b>(<i>menu</i>) + <p> Public method to generate the VCS menu. -</p><dl> +</p> +<dl> + <dt><i>menu</i></dt> <dd> reference to the menu to be populated (QMenu) </dd> -</dl><a NAME="PySvnProjectHelper.initToolbar" ID="PySvnProjectHelper.initToolbar"></a> +</dl> +<a NAME="PySvnProjectHelper.initToolbar" ID="PySvnProjectHelper.initToolbar"></a> <h4>PySvnProjectHelper.initToolbar</h4> <b>initToolbar</b>(<i>ui, toolbarManager</i>) + <p> Public slot to initialize the VCS toolbar. -</p><dl> +</p> +<dl> + <dt><i>ui</i></dt> <dd> reference to the main window (UserInterface) -</dd><dt><i>toolbarManager</i></dt> +</dd> +<dt><i>toolbarManager</i></dt> <dd> reference to a toolbar manager object (E5ToolBarManager) </dd> -</dl><a NAME="PySvnProjectHelper.removeToolbar" ID="PySvnProjectHelper.removeToolbar"></a> +</dl> +<a NAME="PySvnProjectHelper.removeToolbar" ID="PySvnProjectHelper.removeToolbar"></a> <h4>PySvnProjectHelper.removeToolbar</h4> <b>removeToolbar</b>(<i>ui, toolbarManager</i>) + <p> Public method to remove a toolbar created by initToolbar(). -</p><dl> +</p> +<dl> + <dt><i>ui</i></dt> <dd> reference to the main window (UserInterface) -</dd><dt><i>toolbarManager</i></dt> +</dd> +<dt><i>toolbarManager</i></dt> <dd> reference to a toolbar manager object (E5ToolBarManager)