--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgAddSubrepositoryDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgAddSubrepositoryDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,124 +18,164 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.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 /> +<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> +</tr> +<tr> <td><a href="#HgAddSubrepositoryDialog.__updateOk">__updateOk</a></td> <td>Private slot to update the state of the OK button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgAddSubrepositoryDialog.getData">getData</a></td> <td>Public method to get the data.</td> -</tr><tr> +</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> +</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> +</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> +</p> +<dl> + <dt><i>projectPath</i></dt> <dd> project directory name (string) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="HgAddSubrepositoryDialog.__updateOk" ID="HgAddSubrepositoryDialog.__updateOk"></a> +</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> +</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> +</p> +<dl> <dt>Returns:</dt> <dd> tuple containing the relative path within the project, the sub-repository type and the sub-repository URL (string, string, string) </dd> -</dl><a NAME="HgAddSubrepositoryDialog.on_pathPicker_pathSelected" ID="HgAddSubrepositoryDialog.on_pathPicker_pathSelected"></a> +</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> +</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> +</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>p0</i>) + <p> Private slot to handle the update of the path. -</p><dl> +</p> +<dl> + <dt><i>p0</i></dt> <dd> text of the path edit (string) </dd> -</dl><a NAME="HgAddSubrepositoryDialog.on_urlEdit_textChanged" ID="HgAddSubrepositoryDialog.on_urlEdit_textChanged"></a> +</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>p0</i>) + <p> Private slot to handle the update of the URL. -</p><dl> +</p> +<dl> + <dt><i>p0</i></dt> <dd> text of the URL edit (string)