Mercurial Repositories > eric / file diff

diff: Documentation/Source/eric5.VCS.ProjectHelper.html

Documentation/Source/eric5.VCS.ProjectHelper.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.VCS.ProjectHelper.html
--- a/Documentation/Source/eric5.VCS.ProjectHelper.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.VCS.ProjectHelper.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.VCS.ProjectHelper</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#97;&#115;&#101; &#99;&#108;&#97;&#115;&#115; &#111;&#102; &#116;&#104;&#101; &#86;&#67;&#83; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#104;&#101;&#108;&#112;&#101;&#114;.
+Module implementing the base class of the VCS project helper.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#VcsProjectHelper">VcsProjectHelper</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#97;&#115;&#101; &#99;&#108;&#97;&#115;&#115; &#111;&#102; &#116;&#104;&#101; &#86;&#67;&#83; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#104;&#101;&#108;&#112;&#101;&#114;.</td>
+<td>Class implementing the base class of the VCS project helper.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="VcsProjectHelper" ID="VcsProjectHelper"></a>
 <h2>VcsProjectHelper</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#97;&#115;&#101; &#99;&#108;&#97;&#115;&#115; &#111;&#102; &#116;&#104;&#101; &#86;&#67;&#83; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#104;&#101;&#108;&#112;&#101;&#114;.
+    Class implementing the base class of the VCS project helper.
 </p>
 <h3>Derived from</h3>
 QObject
@@ -55,231 +55,231 @@
 <table>
 <tr>
 <td><a href="#VcsProjectHelper.__init__">VcsProjectHelper</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#VcsProjectHelper._vcsCheckout">_vcsCheckout</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#99;&#114;&#101;&#97;&#116;&#101; &#97; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y.</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>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#99;&#108;&#101;&#97;&#110;&#117;&#112; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116;.</td>
+<td>Protected slot used to cleanup the local project.</td>
 </tr><tr>
 <td><a href="#VcsProjectHelper._vcsCommand">_vcsCommand</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#101;x&#101;&#99;&#117;&#116;&#101; &#97;&#110; &#97;&#114;&#98;&#105;&#116;&#114;&#97;&#114;y v&#99;&#115; &#99;&#111;&#109;&#109;&#97;&#110;&#100;.</td>
+<td>Protected slot used to execute an arbitrary vcs command.</td>
 </tr><tr>
 <td><a href="#VcsProjectHelper._vcsCommandOptions">_vcsCommandOptions</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#116;&#111; &#101;&#100;&#105;&#116; &#116;&#104;&#101; &#86;&#67;&#83; &#99;&#111;&#109;&#109;&#97;&#110;&#100; &#111;&#112;&#116;&#105;&#111;&#110;&#115;.</td>
+<td>Protected slot to edit the VCS command options.</td>
 </tr><tr>
 <td><a href="#VcsProjectHelper._vcsCommit">_vcsCommit</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#99;&#111;&#109;&#109;&#105;&#116; &#99;&#104;&#97;&#110;&#103;&#101;&#115; &#116;&#111; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#116;&#111; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y.</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>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#100;&#105;&#102;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#111;&#102; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#116;&#111; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y.</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>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#101;x&#112;&#111;&#114;&#116; &#97; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y.</td>
+<td>Protected slot used to export a project from the repository.</td>
 </tr><tr>
 <td><a href="#VcsProjectHelper._vcsImport">_vcsImport</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#105;&#109;&#112;&#111;&#114;&#116; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#105;&#110;&#116;&#111; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y.</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>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#115;&#104;&#111;w &#115;&#111;&#109;&#101; v&#99;&#115; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;.</td>
+<td>Protected slot called to show some vcs information.</td>
 </tr><tr>
 <td><a href="#VcsProjectHelper._vcsLog">_vcsLog</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#108;&#111;&#103; &#111;&#102; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116;.</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>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#109;&#101;&#114;&#103;&#101; &#99;&#104;&#97;&#110;&#103;&#101;&#115; &#111;&#102; &#97; &#116;&#97;&#103;/&#114;&#101;v&#105;&#115;&#105;&#111;&#110; &#105;&#110;&#116;&#111; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116;.</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>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#114;&#101;&#109;&#111;v&#101; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y.</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>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#114;&#101;v&#101;&#114;&#116; &#99;&#104;&#97;&#110;&#103;&#101;&#115; &#109;&#97;&#100;&#101; &#116;&#111; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116;.</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>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#117;&#115; &#111;&#102; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116;.</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>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#115;w&#105;&#116;&#99;&#104; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#116;&#111; &#97;&#110;&#111;&#116;&#104;&#101;&#114; &#116;&#97;&#103;/&#98;&#114;&#97;&#110;&#99;&#104;.</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>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#116;&#97;&#103; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#105;&#110; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y.</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>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#117;&#112;&#100;&#97;&#116;&#101; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y.</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>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#97;&#99;&#116;&#105;&#111;&#110; &#111;&#98;&#106;&#101;&#99;&#116;&#115;.</td>
+<td>Public method to generate the action objects.</td>
 </tr><tr>
 <td><a href="#VcsProjectHelper.initMenu">initMenu</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#86;&#67;&#83; &#109;&#101;&#110;&#117;.</td>
+<td>Public method to generate the VCS menu.</td>
 </tr><tr>
 <td><a href="#VcsProjectHelper.revertChanges">revertChanges</a></td>
-<td>&#76;&#111;&#99;&#97;&#108; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#114;&#101;v&#101;&#114;&#116; &#116;&#104;&#101; &#99;&#104;&#97;&#110;&#103;&#101;&#115; &#109;&#97;&#100;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#111;&#98;&#106;&#101;&#99;&#116;.</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>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#116;&#111; &#116;&#104;&#101; v&#99;&#115; &#97;&#110;&#100; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#111;&#98;&#106;&#101;&#99;&#116;&#115;.</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>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#98;&#101;&#102;&#111;&#114;&#101; &#116;&#104;&#101; v&#99;&#115; &#109;&#101;&#110;&#117; &#105;&#115; &#115;&#104;&#111;w&#110;.</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>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>vcsObject</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; v&#99;&#115; &#111;&#98;&#106;&#101;&#99;&#116;
+reference to the vcs object
 </dd><dt><i>projectObject</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#111;&#98;&#106;&#101;&#99;&#116;
+reference to the project object
 </dd><dt><i>parent</i></dt>
 <dd>
-&#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+parent widget (QWidget)
 </dd><dt><i>name</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#105;&#115; &#111;&#98;&#106;&#101;&#99;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#99;&#114;&#101;&#97;&#116;&#101; &#97; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y.
+        Protected slot used to create a local project from the repository.
 </p><dl>
 <dt><i>export</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; w&#104;&#101;&#116;&#104;&#101;&#114; &#97;&#110; &#101;x&#112;&#111;&#114;&#116; &#111;&#114; &#97; &#99;&#104;&#101;&#99;&#107;&#111;&#117;&#116;
-                &#115;&#104;&#111;&#117;&#108;&#100; &#98;&#101; &#112;&#101;&#114;&#102;&#111;&#114;&#109;&#101;&#100;
+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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#99;&#108;&#101;&#97;&#110;&#117;&#112; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116;.
+        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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#101;x&#101;&#99;&#117;&#116;&#101; &#97;&#110; &#97;&#114;&#98;&#105;&#116;&#114;&#97;&#114;y v&#99;&#115; &#99;&#111;&#109;&#109;&#97;&#110;&#100;.
+        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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#116;&#111; &#101;&#100;&#105;&#116; &#116;&#104;&#101; &#86;&#67;&#83; &#99;&#111;&#109;&#109;&#97;&#110;&#100; &#111;&#112;&#116;&#105;&#111;&#110;&#115;.
+        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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#99;&#111;&#109;&#109;&#105;&#116; &#99;&#104;&#97;&#110;&#103;&#101;&#115; &#116;&#111; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#116;&#111; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y.
+        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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#100;&#105;&#102;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#111;&#102; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#116;&#111; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y.
+        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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#101;x&#112;&#111;&#114;&#116; &#97; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y.
+        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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#105;&#109;&#112;&#111;&#114;&#116; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#105;&#110;&#116;&#111; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y.
+        Protected slot used to import the local project into the repository.
 </p><p>
-        &#60;&#98;&#62;&#78;&#79;&#84;&#69;&#60;/&#98;&#62;&#58; 
-            &#84;&#104;&#105;&#115; &#100;&#111;&#101;&#115; &#110;&#111;&#116; &#110;&#101;&#99;&#101;&#115;&#115;&#97;&#114;&#105;&#108;y &#109;&#97;&#107;&#101; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#97; v&#99;&#115; &#99;&#111;&#110;&#116;&#114;&#111;&#108;&#108;&#101;&#100;
-            &#112;&#114;&#111;&#106;&#101;&#99;&#116;. &#89;&#111;&#117; &#109;&#97;y &#104;&#97;v&#101; &#116;&#111; &#99;&#104;&#101;&#99;&#107;&#111;&#117;&#116; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y &#105;&#110; 
-            &#111;&#114;&#100;&#101;&#114; &#116;&#111; &#97;&#99;&#99;&#111;&#109;&#112;&#108;&#105;&#115;&#104; &#116;&#104;&#97;&#116;.
+        <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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#115;&#104;&#111;w &#115;&#111;&#109;&#101; v&#99;&#115; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;.
+        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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#108;&#111;&#103; &#111;&#102; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116;.
+        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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#109;&#101;&#114;&#103;&#101; &#99;&#104;&#97;&#110;&#103;&#101;&#115; &#111;&#102; &#97; &#116;&#97;&#103;/&#114;&#101;v&#105;&#115;&#105;&#111;&#110; &#105;&#110;&#116;&#111; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116;.
+        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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#114;&#101;&#109;&#111;v&#101; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y.
+        Protected slot used to remove the local project from the repository.
 </p><p>
-        &#68;&#101;&#112;&#101;&#110;&#100;&#105;&#110;&#103; &#111;&#110; &#116;&#104;&#101; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115; &#115;&#101;&#116; &#105;&#110; &#116;&#104;&#101; v&#99;&#115; &#111;&#98;&#106;&#101;&#99;&#116; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116;
-        &#109;&#97;y &#98;&#101; &#114;&#101;&#109;&#111;v&#101;&#100; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#100;&#105;&#115;&#107; &#97;&#115; w&#101;&#108;&#108;.
+        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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#114;&#101;v&#101;&#114;&#116; &#99;&#104;&#97;&#110;&#103;&#101;&#115; &#109;&#97;&#100;&#101; &#116;&#111; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116;.
+        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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#117;&#115; &#111;&#102; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116;.
+        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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#115;w&#105;&#116;&#99;&#104; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#116;&#111; &#97;&#110;&#111;&#116;&#104;&#101;&#114; &#116;&#97;&#103;/&#98;&#114;&#97;&#110;&#99;&#104;.
+        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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#116;&#97;&#103; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#105;&#110; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y.
+        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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#117;&#112;&#100;&#97;&#116;&#101; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y.
+        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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#97;&#99;&#116;&#105;&#111;&#110; &#111;&#98;&#106;&#101;&#99;&#116;&#115;.
+        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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#86;&#67;&#83; &#109;&#101;&#110;&#117;.
+        Public method to generate the VCS menu.
 </p><dl>
 <dt><i>menu</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#109;&#101;&#110;&#117; &#116;&#111; &#98;&#101; &#112;&#111;&#112;&#117;&#108;&#97;&#116;&#101;&#100; (&#81;&#77;&#101;&#110;&#117;)
+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>
-            &#76;&#111;&#99;&#97;&#108; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#114;&#101;v&#101;&#114;&#116; &#116;&#104;&#101; &#99;&#104;&#97;&#110;&#103;&#101;&#115; &#109;&#97;&#100;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#111;&#98;&#106;&#101;&#99;&#116;.
+            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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#116;&#111; &#116;&#104;&#101; v&#99;&#115; &#97;&#110;&#100; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#111;&#98;&#106;&#101;&#99;&#116;&#115;.
+        Public method to set references to the vcs and project objects.
 </p><dl>
 <dt><i>vcsObject</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; v&#99;&#115; &#111;&#98;&#106;&#101;&#99;&#116;
+reference to the vcs object
 </dd><dt><i>projectObject</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#111;&#98;&#106;&#101;&#99;&#116;
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#98;&#101;&#102;&#111;&#114;&#101; &#116;&#104;&#101; v&#99;&#115; &#109;&#101;&#110;&#117; &#105;&#115; &#115;&#104;&#111;w&#110;.
+        Public slot called before the vcs menu is shown.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />

Mercurial Repository: eric

eric ide

mercurial