eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitSubmoduleAddDialog.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitSubmoduleAddDialog.html	Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitSubmoduleAddDialog.html	Wed Sep 25 19:42:44 2019 +0200
@@ -18,154 +18,202 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitSubmoduleAddDialog</h1>
+
 <p>
 Module implementing a dialog to enter the data to add a submodule.
 </p>
 <h3>Global Attributes</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Classes</h3>
+
 <table>
+
 <tr>
 <td><a href="#GitSubmoduleAddDialog">GitSubmoduleAddDialog</a></td>
 <td>Class implementing a dialog to enter the data to add a submodule.</td>
 </tr>
 </table>
 <h3>Functions</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="GitSubmoduleAddDialog" ID="GitSubmoduleAddDialog"></a>
 <h2>GitSubmoduleAddDialog</h2>
+
 <p>
     Class implementing a dialog to enter the data to add a submodule.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_GitSubmoduleAddDialog
 <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="#GitSubmoduleAddDialog.__init__">GitSubmoduleAddDialog</a></td>
 <td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#GitSubmoduleAddDialog.__getRelativePath">__getRelativePath</a></td>
 <td>Private method to convert a file path to a relative path.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#GitSubmoduleAddDialog.__saveHistory">__saveHistory</a></td>
 <td>Private method to save the repository URL history.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#GitSubmoduleAddDialog.getData">getData</a></td>
 <td>Public method to get the entered data.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#GitSubmoduleAddDialog.on_submoduleDirButton_clicked">on_submoduleDirButton_clicked</a></td>
 <td>Private slot to display a directory selection dialog.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#GitSubmoduleAddDialog.on_submoduleUrlButton_clicked">on_submoduleUrlButton_clicked</a></td>
 <td>Private slot to display a directory selection dialog.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked">on_submoduleUrlClearHistoryButton_clicked</a></td>
 <td>Private slot to clear the history of entered repository URLs.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged">on_submoduleUrlCombo_editTextChanged</a></td>
 <td>Private slot to handle changes of the submodule repository URL.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
+
 <a NAME="GitSubmoduleAddDialog.__init__" ID="GitSubmoduleAddDialog.__init__"></a>
 <h4>GitSubmoduleAddDialog (Constructor)</h4>
 <b>GitSubmoduleAddDialog</b>(<i>vcs, repodir, parent=None</i>)
+
 <p>
         Constructor
-</p><dl>
+</p>
+<dl>
+
 <dt><i>vcs</i> (Git)</dt>
 <dd>
 reference to the version control object
-</dd><dt><i>repodir</i> (str)</dt>
+</dd>
+<dt><i>repodir</i> (str)</dt>
 <dd>
 directory containing the superproject
-</dd><dt><i>parent</i> (QWidget)</dt>
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
 reference to the parent widget
 </dd>
-</dl><a NAME="GitSubmoduleAddDialog.__getRelativePath" ID="GitSubmoduleAddDialog.__getRelativePath"></a>
+</dl>
+<a NAME="GitSubmoduleAddDialog.__getRelativePath" ID="GitSubmoduleAddDialog.__getRelativePath"></a>
 <h4>GitSubmoduleAddDialog.__getRelativePath</h4>
 <b>__getRelativePath</b>(<i>path</i>)
+
 <p>
         Private method to convert a file path to a relative path.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>path</i> (str)</dt>
 <dd>
 file or directory name to convert
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 relative path or unchanged path, if path doesn't
             belong to the project
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 str
 </dd>
-</dl><a NAME="GitSubmoduleAddDialog.__saveHistory" ID="GitSubmoduleAddDialog.__saveHistory"></a>
+</dl>
+<a NAME="GitSubmoduleAddDialog.__saveHistory" ID="GitSubmoduleAddDialog.__saveHistory"></a>
 <h4>GitSubmoduleAddDialog.__saveHistory</h4>
 <b>__saveHistory</b>(<i></i>)
+
 <p>
         Private method to save the repository URL history.
-</p><a NAME="GitSubmoduleAddDialog.getData" ID="GitSubmoduleAddDialog.getData"></a>
+</p>
+<a NAME="GitSubmoduleAddDialog.getData" ID="GitSubmoduleAddDialog.getData"></a>
 <h4>GitSubmoduleAddDialog.getData</h4>
 <b>getData</b>(<i></i>)
+
 <p>
         Public method to get the entered data.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 tuple containing the repository URL, optional branch name,
             optional logical name, optional submodule path and a flag
             indicating to enforce the operation
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 tuple of (str, str, str, str, bool)
 </dd>
-</dl><a NAME="GitSubmoduleAddDialog.on_submoduleDirButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleDirButton_clicked"></a>
+</dl>
+<a NAME="GitSubmoduleAddDialog.on_submoduleDirButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleDirButton_clicked"></a>
 <h4>GitSubmoduleAddDialog.on_submoduleDirButton_clicked</h4>
 <b>on_submoduleDirButton_clicked</b>(<i></i>)
+
 <p>
         Private slot to display a directory selection dialog.
-</p><a NAME="GitSubmoduleAddDialog.on_submoduleUrlButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleUrlButton_clicked"></a>
+</p>
+<a NAME="GitSubmoduleAddDialog.on_submoduleUrlButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleUrlButton_clicked"></a>
 <h4>GitSubmoduleAddDialog.on_submoduleUrlButton_clicked</h4>
 <b>on_submoduleUrlButton_clicked</b>(<i></i>)
+
 <p>
         Private slot to display a directory selection dialog.
-</p><a NAME="GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked"></a>
+</p>
+<a NAME="GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked" ID="GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked"></a>
 <h4>GitSubmoduleAddDialog.on_submoduleUrlClearHistoryButton_clicked</h4>
 <b>on_submoduleUrlClearHistoryButton_clicked</b>(<i></i>)
+
 <p>
         Private slot to clear the history of entered repository URLs.
-</p><a NAME="GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged" ID="GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged"></a>
+</p>
+<a NAME="GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged" ID="GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged"></a>
 <h4>GitSubmoduleAddDialog.on_submoduleUrlCombo_editTextChanged</h4>
 <b>on_submoduleUrlCombo_editTextChanged</b>(<i>txt</i>)
+
 <p>
         Private slot to handle changes of the submodule repository URL.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>txt</i> (str)</dt>
 <dd>
 current text of the combo box

eric ide

mercurial