src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgAddSubrepositoryDialog.html

Mon, 22 Apr 2024 18:23:20 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Mon, 22 Apr 2024 18:23:20 +0200
branch
eric7
changeset 10690
fab36645aa7d
parent 10479
856476537696
permissions
-rw-r--r--

Changed the source code and the source code documentation to improve the indication of unused method/function arguments.

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsMercurial.HgAddSubrepositoryDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgAddSubrepositoryDialog</h1>
<p>
Module implementing a dialog to add a sub-repository.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#HgAddSubrepositoryDialog">HgAddSubrepositoryDialog</a></td>
<td>Class implementing a dialog to add a sub-repository.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="HgAddSubrepositoryDialog" ID="HgAddSubrepositoryDialog"></a>
<h2>HgAddSubrepositoryDialog</h2>
<p>
    Class implementing a dialog to add a sub-repository.
</p>

<h3>Derived from</h3>
QDialog, Ui_HgAddSubrepositoryDialog
<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="#HgAddSubrepositoryDialog.__init__">HgAddSubrepositoryDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HgAddSubrepositoryDialog.__updateOk">__updateOk</a></td>
<td>Private slot to update the state of the OK button.</td>
</tr>
<tr>
<td><a href="#HgAddSubrepositoryDialog.getData">getData</a></td>
<td>Public method to get the data.</td>
</tr>
<tr>
<td><a href="#HgAddSubrepositoryDialog.on_pathPicker_pathSelected">on_pathPicker_pathSelected</a></td>
<td>Private slot handling the selection of a subrepository path.</td>
</tr>
<tr>
<td><a href="#HgAddSubrepositoryDialog.on_pathPicker_textChanged">on_pathPicker_textChanged</a></td>
<td>Private slot to handle the update of the path.</td>
</tr>
<tr>
<td><a href="#HgAddSubrepositoryDialog.on_urlEdit_textChanged">on_urlEdit_textChanged</a></td>
<td>Private slot to handle the update of the URL.</td>
</tr>
</table>

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


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

<dl>

<dt><i>projectPath</i> (str)</dt>
<dd>
project directory name
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="HgAddSubrepositoryDialog.__updateOk" ID="HgAddSubrepositoryDialog.__updateOk"></a>
<h4>HgAddSubrepositoryDialog.__updateOk</h4>
<b>__updateOk</b>(<i></i>)
<p>
        Private slot to update the state of the OK button.
</p>

<a NAME="HgAddSubrepositoryDialog.getData" ID="HgAddSubrepositoryDialog.getData"></a>
<h4>HgAddSubrepositoryDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to get the data.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple containing the relative path within the project, the
            sub-repository type and the sub-repository URL
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, str, str)
</dd>
</dl>
<a NAME="HgAddSubrepositoryDialog.on_pathPicker_pathSelected" ID="HgAddSubrepositoryDialog.on_pathPicker_pathSelected"></a>
<h4>HgAddSubrepositoryDialog.on_pathPicker_pathSelected</h4>
<b>on_pathPicker_pathSelected</b>(<i>path</i>)
<p>
        Private slot handling the selection of a subrepository path.
</p>

<dl>

<dt><i>path</i> (str)</dt>
<dd>
path of the subrepository
</dd>
</dl>
<a NAME="HgAddSubrepositoryDialog.on_pathPicker_textChanged" ID="HgAddSubrepositoryDialog.on_pathPicker_textChanged"></a>
<h4>HgAddSubrepositoryDialog.on_pathPicker_textChanged</h4>
<b>on_pathPicker_textChanged</b>(<i>_txt</i>)
<p>
        Private slot to handle the update of the path.
</p>

<dl>

<dt><i>_txt</i> (str)</dt>
<dd>
text of the path edit (unused)
</dd>
</dl>
<a NAME="HgAddSubrepositoryDialog.on_urlEdit_textChanged" ID="HgAddSubrepositoryDialog.on_urlEdit_textChanged"></a>
<h4>HgAddSubrepositoryDialog.on_urlEdit_textChanged</h4>
<b>on_urlEdit_textChanged</b>(<i>_txt</i>)
<p>
        Private slot to handle the update of the URL.
</p>

<dl>

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

eric ide

mercurial