diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitNewProjectOptionsDialog.html --- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitNewProjectOptionsDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitNewProjectOptionsDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,30 +18,38 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsGit.GitNewProjectOptionsDialog</h1> + <p> Module implementing the Git Options Dialog for a new project from the repository. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#GitNewProjectOptionsDialog">GitNewProjectOptionsDialog</a></td> <td>Class implementing the Options Dialog for a new project from the repository.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="GitNewProjectOptionsDialog" ID="GitNewProjectOptionsDialog"></a> <h2>GitNewProjectOptionsDialog</h2> + <p> Class implementing the Options Dialog for a new project from the repository. @@ -49,105 +57,141 @@ <h3>Derived from</h3> QDialog, Ui_GitNewProjectOptionsDialog <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="#GitNewProjectOptionsDialog.__init__">GitNewProjectOptionsDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitNewProjectOptionsDialog.__saveHistory">__saveHistory</a></td> <td>Private method to save the repository URL history.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitNewProjectOptionsDialog.getData">getData</a></td> <td>Public slot to retrieve the data entered into the dialog.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitNewProjectOptionsDialog.on_projectDirButton_clicked">on_projectDirButton_clicked</a></td> <td>Private slot to display a directory selection dialog.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitNewProjectOptionsDialog.on_vcsProjectDirEdit_textChanged">on_vcsProjectDirEdit_textChanged</a></td> <td>Private slot to handle a change of the project directory.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitNewProjectOptionsDialog.on_vcsUrlButton_clicked">on_vcsUrlButton_clicked</a></td> <td>Private slot to display a selection dialog.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitNewProjectOptionsDialog.on_vcsUrlClearHistoryButton_clicked">on_vcsUrlClearHistoryButton_clicked</a></td> <td>Private slot to clear the history of entered repository URLs.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitNewProjectOptionsDialog.on_vcsUrlCombo_editTextChanged">on_vcsUrlCombo_editTextChanged</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="GitNewProjectOptionsDialog.__init__" ID="GitNewProjectOptionsDialog.__init__"></a> <h4>GitNewProjectOptionsDialog (Constructor)</h4> <b>GitNewProjectOptionsDialog</b>(<i>vcs, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>vcs</i></dt> <dd> reference to the version control object -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> parent widget (QWidget) </dd> -</dl><a NAME="GitNewProjectOptionsDialog.__saveHistory" ID="GitNewProjectOptionsDialog.__saveHistory"></a> +</dl> +<a NAME="GitNewProjectOptionsDialog.__saveHistory" ID="GitNewProjectOptionsDialog.__saveHistory"></a> <h4>GitNewProjectOptionsDialog.__saveHistory</h4> <b>__saveHistory</b>(<i></i>) + <p> Private method to save the repository URL history. -</p><a NAME="GitNewProjectOptionsDialog.getData" ID="GitNewProjectOptionsDialog.getData"></a> +</p> +<a NAME="GitNewProjectOptionsDialog.getData" ID="GitNewProjectOptionsDialog.getData"></a> <h4>GitNewProjectOptionsDialog.getData</h4> <b>getData</b>(<i></i>) + <p> Public slot to retrieve the data entered into the dialog. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> a tuple of a string (project directory) and a dictionary containing the data entered. </dd> -</dl><a NAME="GitNewProjectOptionsDialog.on_projectDirButton_clicked" ID="GitNewProjectOptionsDialog.on_projectDirButton_clicked"></a> +</dl> +<a NAME="GitNewProjectOptionsDialog.on_projectDirButton_clicked" ID="GitNewProjectOptionsDialog.on_projectDirButton_clicked"></a> <h4>GitNewProjectOptionsDialog.on_projectDirButton_clicked</h4> <b>on_projectDirButton_clicked</b>(<i></i>) + <p> Private slot to display a directory selection dialog. -</p><a NAME="GitNewProjectOptionsDialog.on_vcsProjectDirEdit_textChanged" ID="GitNewProjectOptionsDialog.on_vcsProjectDirEdit_textChanged"></a> +</p> +<a NAME="GitNewProjectOptionsDialog.on_vcsProjectDirEdit_textChanged" ID="GitNewProjectOptionsDialog.on_vcsProjectDirEdit_textChanged"></a> <h4>GitNewProjectOptionsDialog.on_vcsProjectDirEdit_textChanged</h4> <b>on_vcsProjectDirEdit_textChanged</b>(<i>txt</i>) + <p> Private slot to handle a change of the project directory. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> name of the project directory (string) </dd> -</dl><a NAME="GitNewProjectOptionsDialog.on_vcsUrlButton_clicked" ID="GitNewProjectOptionsDialog.on_vcsUrlButton_clicked"></a> +</dl> +<a NAME="GitNewProjectOptionsDialog.on_vcsUrlButton_clicked" ID="GitNewProjectOptionsDialog.on_vcsUrlButton_clicked"></a> <h4>GitNewProjectOptionsDialog.on_vcsUrlButton_clicked</h4> <b>on_vcsUrlButton_clicked</b>(<i></i>) + <p> Private slot to display a selection dialog. -</p><a NAME="GitNewProjectOptionsDialog.on_vcsUrlClearHistoryButton_clicked" ID="GitNewProjectOptionsDialog.on_vcsUrlClearHistoryButton_clicked"></a> +</p> +<a NAME="GitNewProjectOptionsDialog.on_vcsUrlClearHistoryButton_clicked" ID="GitNewProjectOptionsDialog.on_vcsUrlClearHistoryButton_clicked"></a> <h4>GitNewProjectOptionsDialog.on_vcsUrlClearHistoryButton_clicked</h4> <b>on_vcsUrlClearHistoryButton_clicked</b>(<i></i>) + <p> Private slot to clear the history of entered repository URLs. -</p><a NAME="GitNewProjectOptionsDialog.on_vcsUrlCombo_editTextChanged" ID="GitNewProjectOptionsDialog.on_vcsUrlCombo_editTextChanged"></a> +</p> +<a NAME="GitNewProjectOptionsDialog.on_vcsUrlCombo_editTextChanged" ID="GitNewProjectOptionsDialog.on_vcsUrlCombo_editTextChanged"></a> <h4>GitNewProjectOptionsDialog.on_vcsUrlCombo_editTextChanged</h4> <b>on_vcsUrlCombo_editTextChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the URL. -</p><dl> +</p> +<dl> + <dt><i>txt</i> (str)</dt> <dd> current text of the combo box