--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitPushDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitPushDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,135 +18,178 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsGit.GitPushDialog</h1> + <p> Module implementing a dialog to enter data for a Push operation. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#GitPushDialog">GitPushDialog</a></td> <td>Class implementing a dialog to enter data for a Push operation.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="GitPushDialog" ID="GitPushDialog"></a> <h2>GitPushDialog</h2> + <p> Class implementing a dialog to enter data for a Push operation. </p> <h3>Derived from</h3> QDialog, Ui_GitPushDialog <h3>Class Attributes</h3> + <table> <tr><td>ForceColumn</td></tr><tr><td>LocalBranchColumn</td></tr><tr><td>PushColumn</td></tr><tr><td>RemoteBranchColumn</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#GitPushDialog.__init__">GitPushDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitPushDialog.__resizeColumns">__resizeColumns</a></td> <td>Private slot to adjust the column sizes.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitPushDialog.getData">getData</a></td> <td>Public method to get the entered data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitPushDialog.on_branchesTree_itemChanged">on_branchesTree_itemChanged</a></td> <td>Private slot handling changes of a branch item.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitPushDialog.on_remotesComboBox_currentTextChanged">on_remotesComboBox_currentTextChanged</a></td> <td>Private slot to handle changes of the selected repository.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitPushDialog.on_selectAllCheckBox_stateChanged">on_selectAllCheckBox_stateChanged</a></td> <td>Private slot to select/deselect all branch items.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="GitPushDialog.__init__" ID="GitPushDialog.__init__"></a> <h4>GitPushDialog (Constructor)</h4> <b>GitPushDialog</b>(<i>vcs, repodir, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>vcs</i></dt> <dd> reference to the git object -</dd><dt><i>repodir</i></dt> +</dd> +<dt><i>repodir</i></dt> <dd> directory name of the local repository (string) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="GitPushDialog.__resizeColumns" ID="GitPushDialog.__resizeColumns"></a> +</dl> +<a NAME="GitPushDialog.__resizeColumns" ID="GitPushDialog.__resizeColumns"></a> <h4>GitPushDialog.__resizeColumns</h4> <b>__resizeColumns</b>(<i></i>) + <p> Private slot to adjust the column sizes. -</p><a NAME="GitPushDialog.getData" ID="GitPushDialog.getData"></a> +</p> +<a NAME="GitPushDialog.getData" ID="GitPushDialog.getData"></a> <h4>GitPushDialog.getData</h4> <b>getData</b>(<i></i>) + <p> Public method to get the entered data. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> remote name, list of branches to be pushed, a flag indicating to push tags as well, a flag indicating to set tracking information and the push method for submodules </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> tuple of (str, list of str, bool, bool, str) </dd> -</dl><a NAME="GitPushDialog.on_branchesTree_itemChanged" ID="GitPushDialog.on_branchesTree_itemChanged"></a> +</dl> +<a NAME="GitPushDialog.on_branchesTree_itemChanged" ID="GitPushDialog.on_branchesTree_itemChanged"></a> <h4>GitPushDialog.on_branchesTree_itemChanged</h4> <b>on_branchesTree_itemChanged</b>(<i>item, column</i>) + <p> Private slot handling changes of a branch item. -</p><dl> +</p> +<dl> + <dt><i>item</i></dt> <dd> reference to the changed item (QTreeWidgetItem) -</dd><dt><i>column</i></dt> +</dd> +<dt><i>column</i></dt> <dd> changed column (integer) </dd> -</dl><a NAME="GitPushDialog.on_remotesComboBox_currentTextChanged" ID="GitPushDialog.on_remotesComboBox_currentTextChanged"></a> +</dl> +<a NAME="GitPushDialog.on_remotesComboBox_currentTextChanged" ID="GitPushDialog.on_remotesComboBox_currentTextChanged"></a> <h4>GitPushDialog.on_remotesComboBox_currentTextChanged</h4> <b>on_remotesComboBox_currentTextChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the selected repository. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> current text of the combo box (string) </dd> -</dl><a NAME="GitPushDialog.on_selectAllCheckBox_stateChanged" ID="GitPushDialog.on_selectAllCheckBox_stateChanged"></a> +</dl> +<a NAME="GitPushDialog.on_selectAllCheckBox_stateChanged" ID="GitPushDialog.on_selectAllCheckBox_stateChanged"></a> <h4>GitPushDialog.on_selectAllCheckBox_stateChanged</h4> <b>on_selectAllCheckBox_stateChanged</b>(<i>state</i>) + <p> Private slot to select/deselect all branch items. -</p><dl> +</p> +<dl> + <dt><i>state</i></dt> <dd> check state of the check box (Qt.CheckState)