src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnOptionsDialog.html

Thu, 04 Jan 2024 18:02:25 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Thu, 04 Jan 2024 18:02:25 +0100
branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
permissions
-rw-r--r--

Fine tuned the source code documentation template and regenerated the source code documentation.

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsSubversion.SvnOptionsDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsSubversion.SvnOptionsDialog</h1>
<p>
Module implementing a dialog to enter options used to start a project in
the VCS.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#SvnOptionsDialog">SvnOptionsDialog</a></td>
<td>Class implementing a dialog to enter options used to start a project in the repository.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="SvnOptionsDialog" ID="SvnOptionsDialog"></a>
<h2>SvnOptionsDialog</h2>
<p>
    Class implementing a dialog to enter options used to start a project in the
    repository.
</p>

<h3>Derived from</h3>
QDialog, Ui_SvnOptionsDialog
<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="#SvnOptionsDialog.__init__">SvnOptionsDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#SvnOptionsDialog.getData">getData</a></td>
<td>Public slot to retrieve the data entered into the dialog.</td>
</tr>
<tr>
<td><a href="#SvnOptionsDialog.on_protocolCombo_activated">on_protocolCombo_activated</a></td>
<td>Private slot to switch the status of the directory selection button.</td>
</tr>
<tr>
<td><a href="#SvnOptionsDialog.on_vcsUrlPicker_pickerButtonClicked">on_vcsUrlPicker_pickerButtonClicked</a></td>
<td>Private slot to display a repository browser dialog.</td>
</tr>
<tr>
<td><a href="#SvnOptionsDialog.on_vcsUrlPicker_textChanged">on_vcsUrlPicker_textChanged</a></td>
<td>Private slot to handle changes of the URL.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="SvnOptionsDialog.__init__" ID="SvnOptionsDialog.__init__"></a>
<h4>SvnOptionsDialog (Constructor)</h4>
<b>SvnOptionsDialog</b>(<i>vcs, project, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>vcs</i> (Subversion)</dt>
<dd>
reference to the version control object
</dd>
<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
parent widget
</dd>
</dl>
<a NAME="SvnOptionsDialog.getData" ID="SvnOptionsDialog.getData"></a>
<h4>SvnOptionsDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public slot to retrieve the data entered into the dialog.
</p>

<dl>
<dt>Return:</dt>
<dd>
a dictionary containing the data entered
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<a NAME="SvnOptionsDialog.on_protocolCombo_activated" ID="SvnOptionsDialog.on_protocolCombo_activated"></a>
<h4>SvnOptionsDialog.on_protocolCombo_activated</h4>
<b>on_protocolCombo_activated</b>(<i>index</i>)
<p>
        Private slot to switch the status of the directory selection button.
</p>

<dl>

<dt><i>index</i> (int)</dt>
<dd>
index of the selected entry
</dd>
</dl>
<a NAME="SvnOptionsDialog.on_vcsUrlPicker_pickerButtonClicked" ID="SvnOptionsDialog.on_vcsUrlPicker_pickerButtonClicked"></a>
<h4>SvnOptionsDialog.on_vcsUrlPicker_pickerButtonClicked</h4>
<b>on_vcsUrlPicker_pickerButtonClicked</b>(<i></i>)
<p>
        Private slot to display a repository browser dialog.
</p>

<a NAME="SvnOptionsDialog.on_vcsUrlPicker_textChanged" ID="SvnOptionsDialog.on_vcsUrlPicker_textChanged"></a>
<h4>SvnOptionsDialog.on_vcsUrlPicker_textChanged</h4>
<b>on_vcsUrlPicker_textChanged</b>(<i>txt</i>)
<p>
        Private slot to handle changes of the URL.
</p>

<dl>

<dt><i>txt</i> (str)</dt>
<dd>
current text of the line edit
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial