--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitSubmodulesDeinitDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitSubmodulesDeinitDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,29 +18,37 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsGit.GitSubmodulesDeinitDialog</h1> + <p> Module implementing a dialog to get the data for a submodule deinit operation. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#GitSubmodulesDeinitDialog">GitSubmodulesDeinitDialog</a></td> <td>Class implementing a dialog to get the data for a submodule deinit operation.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="GitSubmodulesDeinitDialog" ID="GitSubmodulesDeinitDialog"></a> <h2>GitSubmodulesDeinitDialog</h2> + <p> Class implementing a dialog to get the data for a submodule deinit operation. @@ -48,83 +56,109 @@ <h3>Derived from</h3> QDialog, Ui_GitSubmodulesDeinitDialog <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="#GitSubmodulesDeinitDialog.__init__">GitSubmodulesDeinitDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitSubmodulesDeinitDialog.__updateOK">__updateOK</a></td> <td>Private slot to update the state of the OK button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitSubmodulesDeinitDialog.getData">getData</a></td> <td>Public method to get the entered data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitSubmodulesDeinitDialog.on_allCheckBox_toggled">on_allCheckBox_toggled</a></td> <td>Private slot to react on changes of the all checkbox.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitSubmodulesDeinitDialog.on_submodulesList_itemSelectionChanged">on_submodulesList_itemSelectionChanged</a></td> <td>Private slot to react on changes of the submodule selection.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="GitSubmodulesDeinitDialog.__init__" ID="GitSubmodulesDeinitDialog.__init__"></a> <h4>GitSubmodulesDeinitDialog (Constructor)</h4> <b>GitSubmodulesDeinitDialog</b>(<i>submodulePaths, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>submodulePaths</i> (list of str)</dt> <dd> list of submodule paths -</dd><dt><i>parent</i> (QWidget)</dt> +</dd> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget </dd> -</dl><a NAME="GitSubmodulesDeinitDialog.__updateOK" ID="GitSubmodulesDeinitDialog.__updateOK"></a> +</dl> +<a NAME="GitSubmodulesDeinitDialog.__updateOK" ID="GitSubmodulesDeinitDialog.__updateOK"></a> <h4>GitSubmodulesDeinitDialog.__updateOK</h4> <b>__updateOK</b>(<i></i>) + <p> Private slot to update the state of the OK button. -</p><a NAME="GitSubmodulesDeinitDialog.getData" ID="GitSubmodulesDeinitDialog.getData"></a> +</p> +<a NAME="GitSubmodulesDeinitDialog.getData" ID="GitSubmodulesDeinitDialog.getData"></a> <h4>GitSubmodulesDeinitDialog.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 a flag to indicate all submodules, a list of selected submodules and a flag indicating an enforced operation </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> tuple of (bool, list of str, bool) </dd> -</dl><a NAME="GitSubmodulesDeinitDialog.on_allCheckBox_toggled" ID="GitSubmodulesDeinitDialog.on_allCheckBox_toggled"></a> +</dl> +<a NAME="GitSubmodulesDeinitDialog.on_allCheckBox_toggled" ID="GitSubmodulesDeinitDialog.on_allCheckBox_toggled"></a> <h4>GitSubmodulesDeinitDialog.on_allCheckBox_toggled</h4> <b>on_allCheckBox_toggled</b>(<i>checked</i>) + <p> Private slot to react on changes of the all checkbox. -</p><dl> +</p> +<dl> + <dt><i>checked</i> (bool)</dt> <dd> state of the checkbox </dd> -</dl><a NAME="GitSubmodulesDeinitDialog.on_submodulesList_itemSelectionChanged" ID="GitSubmodulesDeinitDialog.on_submodulesList_itemSelectionChanged"></a> +</dl> +<a NAME="GitSubmodulesDeinitDialog.on_submodulesList_itemSelectionChanged" ID="GitSubmodulesDeinitDialog.on_submodulesList_itemSelectionChanged"></a> <h4>GitSubmodulesDeinitDialog.on_submodulesList_itemSelectionChanged</h4> <b>on_submodulesList_itemSelectionChanged</b>(<i></i>) + <p> Private slot to react on changes of the submodule selection. </p>