--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitSubmodulesStatusDialog.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,205 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.VcsPlugins.vcsGit.GitSubmodulesStatusDialog</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Plugins.VcsPlugins.vcsGit.GitSubmodulesStatusDialog</h1> + +<p> +Module implementing a dialog to show the status of the submodules of the +project. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#GitSubmodulesStatusDialog">GitSubmodulesStatusDialog</a></td> +<td>Class implementing a dialog to show the status of the submodules of the project.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="GitSubmodulesStatusDialog" ID="GitSubmodulesStatusDialog"></a> +<h2>GitSubmodulesStatusDialog</h2> + +<p> + Class implementing a dialog to show the status of the submodules of the + project. +</p> +<h3>Derived from</h3> +QDialog, Ui_GitSubmodulesStatusDialog +<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="#GitSubmodulesStatusDialog.__init__">GitSubmodulesStatusDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#GitSubmodulesStatusDialog.__processOutput">__processOutput</a></td> +<td>Private method to process the output and populate the list.</td> +</tr> +<tr> +<td><a href="#GitSubmodulesStatusDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot called by a button of the button box clicked.</td> +</tr> +<tr> +<td><a href="#GitSubmodulesStatusDialog.on_indexCheckBox_toggled">on_indexCheckBox_toggled</a></td> +<td>Private slot handling a change of the index check box.</td> +</tr> +<tr> +<td><a href="#GitSubmodulesStatusDialog.on_recursiveCheckBox_toggled">on_recursiveCheckBox_toggled</a></td> +<td>Private slot handling a change of the recursive check box.</td> +</tr> +<tr> +<td><a href="#GitSubmodulesStatusDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> +<td>Private slot to refresh the status display.</td> +</tr> +<tr> +<td><a href="#GitSubmodulesStatusDialog.start">start</a></td> +<td>Public method to populate the status list.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="GitSubmodulesStatusDialog.__init__" ID="GitSubmodulesStatusDialog.__init__"></a> +<h4>GitSubmodulesStatusDialog (Constructor)</h4> +<b>GitSubmodulesStatusDialog</b>(<i>vcs, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>vcs</i> (Git)</dt> +<dd> +reference to the vcs object +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="GitSubmodulesStatusDialog.__processOutput" ID="GitSubmodulesStatusDialog.__processOutput"></a> +<h4>GitSubmodulesStatusDialog.__processOutput</h4> +<b>__processOutput</b>(<i>output</i>) + +<p> + Private method to process the output and populate the list. +</p> +<dl> + +<dt><i>output</i> (str)</dt> +<dd> +output of the submodule status command +</dd> +</dl> +<a NAME="GitSubmodulesStatusDialog.on_buttonBox_clicked" ID="GitSubmodulesStatusDialog.on_buttonBox_clicked"></a> +<h4>GitSubmodulesStatusDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) + +<p> + Private slot called by a button of the button box clicked. +</p> +<dl> + +<dt><i>button</i></dt> +<dd> +button that was clicked (QAbstractButton) +</dd> +</dl> +<a NAME="GitSubmodulesStatusDialog.on_indexCheckBox_toggled" ID="GitSubmodulesStatusDialog.on_indexCheckBox_toggled"></a> +<h4>GitSubmodulesStatusDialog.on_indexCheckBox_toggled</h4> +<b>on_indexCheckBox_toggled</b>(<i>checked</i>) + +<p> + Private slot handling a change of the index check box. +</p> +<dl> + +<dt><i>checked</i> (bool)</dt> +<dd> +check state of the check box +</dd> +</dl> +<a NAME="GitSubmodulesStatusDialog.on_recursiveCheckBox_toggled" ID="GitSubmodulesStatusDialog.on_recursiveCheckBox_toggled"></a> +<h4>GitSubmodulesStatusDialog.on_recursiveCheckBox_toggled</h4> +<b>on_recursiveCheckBox_toggled</b>(<i>checked</i>) + +<p> + Private slot handling a change of the recursive check box. +</p> +<dl> + +<dt><i>checked</i> (bool)</dt> +<dd> +check state of the check box +</dd> +</dl> +<a NAME="GitSubmodulesStatusDialog.on_refreshButton_clicked" ID="GitSubmodulesStatusDialog.on_refreshButton_clicked"></a> +<h4>GitSubmodulesStatusDialog.on_refreshButton_clicked</h4> +<b>on_refreshButton_clicked</b>(<i></i>) + +<p> + Private slot to refresh the status display. +</p> +<a NAME="GitSubmodulesStatusDialog.start" ID="GitSubmodulesStatusDialog.start"></a> +<h4>GitSubmodulesStatusDialog.start</h4> +<b>start</b>(<i>projectDir</i>) + +<p> + Public method to populate the status list. +</p> +<dl> + +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file