diff -r 892c1787d666 -r edde1fe80b3e Documentation/Source/eric5.VCS.ProjectHelper.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.VCS.ProjectHelper.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,274 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>eric5.VCS.ProjectHelper</title> +<style> +b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.VCS.ProjectHelper</h1> +<p> +Module implementing the base class of the VCS project helper. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#VcsProjectHelper">VcsProjectHelper</a></td> +<td>Class implementing the base class of the VCS project helper.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="VcsProjectHelper" ID="VcsProjectHelper"></a> +<h2>VcsProjectHelper</h2> +<p> + Class implementing the base class of the VCS project helper. +</p> +<h3>Derived from</h3> +QObject +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#VcsProjectHelper.__init__">VcsProjectHelper</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsCheckout">_vcsCheckout</a></td> +<td>Protected slot used to create a local project from the repository.</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsCleanup">_vcsCleanup</a></td> +<td>Protected slot used to cleanup the local project.</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsCommand">_vcsCommand</a></td> +<td>Protected slot used to execute an arbitrary vcs command.</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsCommandOptions">_vcsCommandOptions</a></td> +<td>Protected slot to edit the VCS command options.</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsCommit">_vcsCommit</a></td> +<td>Protected slot used to commit changes to the local project to the repository.</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsDiff">_vcsDiff</a></td> +<td>Protected slot used to show the difference of the local project to the repository.</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsExport">_vcsExport</a></td> +<td>Protected slot used to export a project from the repository.</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsImport">_vcsImport</a></td> +<td>Protected slot used to import the local project into the repository.</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsInfoDisplay">_vcsInfoDisplay</a></td> +<td>Protected slot called to show some vcs information.</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsLog">_vcsLog</a></td> +<td>Protected slot used to show the log of the local project.</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsMerge">_vcsMerge</a></td> +<td>Protected slot used to merge changes of a tag/revision into the local project.</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsRemove">_vcsRemove</a></td> +<td>Protected slot used to remove the local project from the repository.</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsRevert">_vcsRevert</a></td> +<td>Protected slot used to revert changes made to the local project.</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsStatus">_vcsStatus</a></td> +<td>Protected slot used to show the status of the local project.</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsSwitch">_vcsSwitch</a></td> +<td>Protected slot used to switch the local project to another tag/branch.</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsTag">_vcsTag</a></td> +<td>Protected slot used to tag the local project in the repository.</td> +</tr><tr> +<td><a href="#VcsProjectHelper._vcsUpdate">_vcsUpdate</a></td> +<td>Protected slot used to update the local project from the repository.</td> +</tr><tr> +<td><a href="#VcsProjectHelper.initActions">initActions</a></td> +<td>Public method to generate the action objects.</td> +</tr><tr> +<td><a href="#VcsProjectHelper.initMenu">initMenu</a></td> +<td>Public method to generate the VCS menu.</td> +</tr><tr> +<td><a href="#VcsProjectHelper.revertChanges">revertChanges</a></td> +<td>Local function to revert the changes made to the project object.</td> +</tr><tr> +<td><a href="#VcsProjectHelper.setObjects">setObjects</a></td> +<td>Public method to set references to the vcs and project objects.</td> +</tr><tr> +<td><a href="#VcsProjectHelper.showMenu">showMenu</a></td> +<td>Public slot called before the vcs menu is shown.</td> +</tr> +</table> +<a NAME="VcsProjectHelper.__init__" ID="VcsProjectHelper.__init__"></a> +<h4>VcsProjectHelper (Constructor)</h4> +<b>VcsProjectHelper</b>(<i>vcsObject, projectObject, parent = None, name = None</i>) +<p> + Constructor +</p><dl> +<dt><i>vcsObject</i></dt> +<dd> +reference to the vcs object +</dd><dt><i>projectObject</i></dt> +<dd> +reference to the project object +</dd><dt><i>parent</i></dt> +<dd> +parent widget (QWidget) +</dd><dt><i>name</i></dt> +<dd> +name of this object (string) +</dd> +</dl><a NAME="VcsProjectHelper._vcsCheckout" ID="VcsProjectHelper._vcsCheckout"></a> +<h4>VcsProjectHelper._vcsCheckout</h4> +<b>_vcsCheckout</b>(<i>export = False</i>) +<p> + Protected slot used to create a local project from the repository. +</p><dl> +<dt><i>export</i></dt> +<dd> +flag indicating whether an export or a checkout + should be performed +</dd> +</dl><a NAME="VcsProjectHelper._vcsCleanup" ID="VcsProjectHelper._vcsCleanup"></a> +<h4>VcsProjectHelper._vcsCleanup</h4> +<b>_vcsCleanup</b>(<i></i>) +<p> + Protected slot used to cleanup the local project. +</p><a NAME="VcsProjectHelper._vcsCommand" ID="VcsProjectHelper._vcsCommand"></a> +<h4>VcsProjectHelper._vcsCommand</h4> +<b>_vcsCommand</b>(<i></i>) +<p> + Protected slot used to execute an arbitrary vcs command. +</p><a NAME="VcsProjectHelper._vcsCommandOptions" ID="VcsProjectHelper._vcsCommandOptions"></a> +<h4>VcsProjectHelper._vcsCommandOptions</h4> +<b>_vcsCommandOptions</b>(<i></i>) +<p> + Protected slot to edit the VCS command options. +</p><a NAME="VcsProjectHelper._vcsCommit" ID="VcsProjectHelper._vcsCommit"></a> +<h4>VcsProjectHelper._vcsCommit</h4> +<b>_vcsCommit</b>(<i></i>) +<p> + Protected slot used to commit changes to the local project to the repository. +</p><a NAME="VcsProjectHelper._vcsDiff" ID="VcsProjectHelper._vcsDiff"></a> +<h4>VcsProjectHelper._vcsDiff</h4> +<b>_vcsDiff</b>(<i></i>) +<p> + Protected slot used to show the difference of the local project to the repository. +</p><a NAME="VcsProjectHelper._vcsExport" ID="VcsProjectHelper._vcsExport"></a> +<h4>VcsProjectHelper._vcsExport</h4> +<b>_vcsExport</b>(<i></i>) +<p> + Protected slot used to export a project from the repository. +</p><a NAME="VcsProjectHelper._vcsImport" ID="VcsProjectHelper._vcsImport"></a> +<h4>VcsProjectHelper._vcsImport</h4> +<b>_vcsImport</b>(<i></i>) +<p> + Protected slot used to import the local project into the repository. +</p><p> + <b>NOTE</b>: + This does not necessarily make the local project a vcs controlled + project. You may have to checkout the project from the repository in + order to accomplish that. +</p><a NAME="VcsProjectHelper._vcsInfoDisplay" ID="VcsProjectHelper._vcsInfoDisplay"></a> +<h4>VcsProjectHelper._vcsInfoDisplay</h4> +<b>_vcsInfoDisplay</b>(<i></i>) +<p> + Protected slot called to show some vcs information. +</p><a NAME="VcsProjectHelper._vcsLog" ID="VcsProjectHelper._vcsLog"></a> +<h4>VcsProjectHelper._vcsLog</h4> +<b>_vcsLog</b>(<i></i>) +<p> + Protected slot used to show the log of the local project. +</p><a NAME="VcsProjectHelper._vcsMerge" ID="VcsProjectHelper._vcsMerge"></a> +<h4>VcsProjectHelper._vcsMerge</h4> +<b>_vcsMerge</b>(<i></i>) +<p> + Protected slot used to merge changes of a tag/revision into the local project. +</p><a NAME="VcsProjectHelper._vcsRemove" ID="VcsProjectHelper._vcsRemove"></a> +<h4>VcsProjectHelper._vcsRemove</h4> +<b>_vcsRemove</b>(<i></i>) +<p> + Protected slot used to remove the local project from the repository. +</p><p> + Depending on the parameters set in the vcs object the project + may be removed from the local disk as well. +</p><a NAME="VcsProjectHelper._vcsRevert" ID="VcsProjectHelper._vcsRevert"></a> +<h4>VcsProjectHelper._vcsRevert</h4> +<b>_vcsRevert</b>(<i></i>) +<p> + Protected slot used to revert changes made to the local project. +</p><a NAME="VcsProjectHelper._vcsStatus" ID="VcsProjectHelper._vcsStatus"></a> +<h4>VcsProjectHelper._vcsStatus</h4> +<b>_vcsStatus</b>(<i></i>) +<p> + Protected slot used to show the status of the local project. +</p><a NAME="VcsProjectHelper._vcsSwitch" ID="VcsProjectHelper._vcsSwitch"></a> +<h4>VcsProjectHelper._vcsSwitch</h4> +<b>_vcsSwitch</b>(<i></i>) +<p> + Protected slot used to switch the local project to another tag/branch. +</p><a NAME="VcsProjectHelper._vcsTag" ID="VcsProjectHelper._vcsTag"></a> +<h4>VcsProjectHelper._vcsTag</h4> +<b>_vcsTag</b>(<i></i>) +<p> + Protected slot used to tag the local project in the repository. +</p><a NAME="VcsProjectHelper._vcsUpdate" ID="VcsProjectHelper._vcsUpdate"></a> +<h4>VcsProjectHelper._vcsUpdate</h4> +<b>_vcsUpdate</b>(<i></i>) +<p> + Protected slot used to update the local project from the repository. +</p><a NAME="VcsProjectHelper.initActions" ID="VcsProjectHelper.initActions"></a> +<h4>VcsProjectHelper.initActions</h4> +<b>initActions</b>(<i></i>) +<p> + Public method to generate the action objects. +</p><a NAME="VcsProjectHelper.initMenu" ID="VcsProjectHelper.initMenu"></a> +<h4>VcsProjectHelper.initMenu</h4> +<b>initMenu</b>(<i>menu</i>) +<p> + Public method to generate the VCS menu. +</p><dl> +<dt><i>menu</i></dt> +<dd> +reference to the menu to be populated (QMenu) +</dd> +</dl><a NAME="VcsProjectHelper.revertChanges" ID="VcsProjectHelper.revertChanges"></a> +<h4>VcsProjectHelper.revertChanges</h4> +<b>revertChanges</b>(<i></i>) +<p> + Local function to revert the changes made to the project object. +</p><a NAME="VcsProjectHelper.setObjects" ID="VcsProjectHelper.setObjects"></a> +<h4>VcsProjectHelper.setObjects</h4> +<b>setObjects</b>(<i>vcsObject, projectObject</i>) +<p> + Public method to set references to the vcs and project objects. +</p><dl> +<dt><i>vcsObject</i></dt> +<dd> +reference to the vcs object +</dd><dt><i>projectObject</i></dt> +<dd> +reference to the project object +</dd> +</dl><a NAME="VcsProjectHelper.showMenu" ID="VcsProjectHelper.showMenu"></a> +<h4>VcsProjectHelper.showMenu</h4> +<b>showMenu</b>(<i></i>) +<p> + Public slot called before the vcs menu is shown. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file