src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitSubmodulesUpdateOptionsDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsGit.GitSubmodulesUpdateOptionsDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsGit.GitSubmodulesUpdateOptionsDialog</h1>
<p>
Module implementing a dialog to enter options for a submodule update command.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#GitSubmodulesUpdateOptionsDialog">GitSubmodulesUpdateOptionsDialog</a></td>
<td>Class implementing a dialog to enter options for a submodule update command.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="GitSubmodulesUpdateOptionsDialog" ID="GitSubmodulesUpdateOptionsDialog"></a>
<h2>GitSubmodulesUpdateOptionsDialog</h2>
<p>
    Class implementing a dialog to enter options for a submodule update
    command.
</p>

<h3>Derived from</h3>
QDialog, Ui_GitSubmodulesUpdateOptionsDialog
<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="#GitSubmodulesUpdateOptionsDialog.__init__">GitSubmodulesUpdateOptionsDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#GitSubmodulesUpdateOptionsDialog.getData">getData</a></td>
<td>Public method to get the entered data.</td>
</tr>
</table>

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


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

<dl>

<dt><i>submodulePaths</i> (list of str)</dt>
<dd>
list of submodule paths
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="GitSubmodulesUpdateOptionsDialog.getData" ID="GitSubmodulesUpdateOptionsDialog.getData"></a>
<h4>GitSubmodulesUpdateOptionsDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to get the entered data.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple containing the update procedure, a flag indicating an
            init, a flag indicating an update with remote, a flag indicating
            not to fetch the remote, a flag indicating an enforced operation
            and a list of selected submodules.
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (int, bool, bool, bool, bool, list of str)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>