eric6/Documentation/Source/eric6.VCS.__init__.html

<!DOCTYPE html>
<html><head>
<title>eric6.VCS.__init__</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric6.VCS.__init__</h1>

<p>
Module implementing the general part of the interface to version control
systems.
</p>
<p>
The general part of the VCS interface defines classes to implement common
dialogs. These are a dialog to enter command options, a dialog to display
some repository information and an abstract base class. The individual
interfaces have to be subclasses of this base class.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>VcsBasicHelperSingleton</td></tr>
</table>
<h3>Classes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Functions</h3>

<table>

<tr>
<td><a href="#factory">factory</a></td>
<td>Modul factory function to generate the right vcs object.</td>
</tr>
<tr>
<td><a href="#getBasicHelper">getBasicHelper</a></td>
<td>Module function to get a reference to the basic project helper singleton.</td>
</tr>
</table>
<hr />
<hr />
<a NAME="factory" ID="factory"></a>
<h2>factory</h2>
<b>factory</b>(<i>vcs</i>)

<p>
    Modul factory function to generate the right vcs object.
</p>
<dl>

<dt><i>vcs</i></dt>
<dd>
name of the VCS system to be used (string)
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
the instantiated VCS object
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="getBasicHelper" ID="getBasicHelper"></a>
<h2>getBasicHelper</h2>
<b>getBasicHelper</b>(<i>project</i>)

<p>
    Module function to get a reference to the basic project helper singleton.
</p>
<dl>

<dt><i>project</i></dt>
<dd>
reference to the project object (Project)
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
reference to the basic VCS project helper singleton
        (VcsProjectHelper)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>