--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBranchDialog.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,234 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.VcsPlugins.vcsGit.GitBranchDialog</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.GitBranchDialog</h1> + +<p> +Module implementing a dialog to enter the data for a branching operation. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#GitBranchDialog">GitBranchDialog</a></td> +<td>Class implementing a dialog to enter the data for a branching operation.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="GitBranchDialog" ID="GitBranchDialog"></a> +<h2>GitBranchDialog</h2> + +<p> + Class implementing a dialog to enter the data for a branching operation. +</p> +<h3>Derived from</h3> +QDialog, Ui_GitBranchDialog +<h3>Class Attributes</h3> + +<table> +<tr><td>CreateBranch</td></tr><tr><td>CreateSwitchBranch</td></tr><tr><td>CreateTrackingBranch</td></tr><tr><td>DeleteBranch</td></tr><tr><td>RenameBranch</td></tr><tr><td>SetTrackingBranch</td></tr><tr><td>UnsetTrackingBranch</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#GitBranchDialog.__init__">GitBranchDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#GitBranchDialog.__updateOK">__updateOK</a></td> +<td>Private method used to enable/disable the OK-button.</td> +</tr> +<tr> +<td><a href="#GitBranchDialog.getParameters">getParameters</a></td> +<td>Public method to retrieve the branch data.</td> +</tr> +<tr> +<td><a href="#GitBranchDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td> +<td>Private slot to handle a change of the branch.</td> +</tr> +<tr> +<td><a href="#GitBranchDialog.on_createTrackingButton_toggled">on_createTrackingButton_toggled</a></td> +<td>Private slot to handle the selection of creating a tracking branch.</td> +</tr> +<tr> +<td><a href="#GitBranchDialog.on_newBranchNameEdit_textChanged">on_newBranchNameEdit_textChanged</a></td> +<td>Private slot to handle a change of the new branch.</td> +</tr> +<tr> +<td><a href="#GitBranchDialog.on_setTrackingButton_toggled">on_setTrackingButton_toggled</a></td> +<td>Private slot to handle the selection of setting a tracking branch.</td> +</tr> +<tr> +<td><a href="#GitBranchDialog.on_unsetTrackingButton_toggled">on_unsetTrackingButton_toggled</a></td> +<td>Private slot to handle the selection of unsetting a tracking branch.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="GitBranchDialog.__init__" ID="GitBranchDialog.__init__"></a> +<h4>GitBranchDialog (Constructor)</h4> +<b>GitBranchDialog</b>(<i>branchlist, revision=None, branchName=None, branchOp=None, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>branchlist</i></dt> +<dd> +list of previously entered branches (list of strings) +</dd> +<dt><i>revision</i></dt> +<dd> +revision to set tag for (string) +</dd> +<dt><i>branchName</i></dt> +<dd> +name of the branch (string) +</dd> +<dt><i>branchOp</i></dt> +<dd> +desired branch operation (integer) +</dd> +<dt><i>parent</i></dt> +<dd> +parent widget (QWidget) +</dd> +</dl> +<a NAME="GitBranchDialog.__updateOK" ID="GitBranchDialog.__updateOK"></a> +<h4>GitBranchDialog.__updateOK</h4> +<b>__updateOK</b>(<i></i>) + +<p> + Private method used to enable/disable the OK-button. +</p> +<a NAME="GitBranchDialog.getParameters" ID="GitBranchDialog.getParameters"></a> +<h4>GitBranchDialog.getParameters</h4> +<b>getParameters</b>(<i></i>) + +<p> + Public method to retrieve the branch data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple of an int, four strings and a boolean + (branch operation, branch name, revision, new branch name, + remote branch name, enforce operation) +</dd> +</dl> +<a NAME="GitBranchDialog.on_branchCombo_editTextChanged" ID="GitBranchDialog.on_branchCombo_editTextChanged"></a> +<h4>GitBranchDialog.on_branchCombo_editTextChanged</h4> +<b>on_branchCombo_editTextChanged</b>(<i>text</i>) + +<p> + Private slot to handle a change of the branch. +</p> +<dl> + +<dt><i>text</i></dt> +<dd> +branch name entered in the combo (string) +</dd> +</dl> +<a NAME="GitBranchDialog.on_createTrackingButton_toggled" ID="GitBranchDialog.on_createTrackingButton_toggled"></a> +<h4>GitBranchDialog.on_createTrackingButton_toggled</h4> +<b>on_createTrackingButton_toggled</b>(<i>checked</i>) + +<p> + Private slot to handle the selection of creating a tracking branch. +</p> +<dl> + +<dt><i>checked</i></dt> +<dd> +state of the selection (boolean) +</dd> +</dl> +<a NAME="GitBranchDialog.on_newBranchNameEdit_textChanged" ID="GitBranchDialog.on_newBranchNameEdit_textChanged"></a> +<h4>GitBranchDialog.on_newBranchNameEdit_textChanged</h4> +<b>on_newBranchNameEdit_textChanged</b>(<i>text</i>) + +<p> + Private slot to handle a change of the new branch. +</p> +<dl> + +<dt><i>text</i></dt> +<dd> +new branch name entered (string) +</dd> +</dl> +<a NAME="GitBranchDialog.on_setTrackingButton_toggled" ID="GitBranchDialog.on_setTrackingButton_toggled"></a> +<h4>GitBranchDialog.on_setTrackingButton_toggled</h4> +<b>on_setTrackingButton_toggled</b>(<i>checked</i>) + +<p> + Private slot to handle the selection of setting a tracking branch. +</p> +<dl> + +<dt><i>checked</i></dt> +<dd> +state of the selection (boolean) +</dd> +</dl> +<a NAME="GitBranchDialog.on_unsetTrackingButton_toggled" ID="GitBranchDialog.on_unsetTrackingButton_toggled"></a> +<h4>GitBranchDialog.on_unsetTrackingButton_toggled</h4> +<b>on_unsetTrackingButton_toggled</b>(<i>checked</i>) + +<p> + Private slot to handle the selection of unsetting a tracking branch. +</p> +<dl> + +<dt><i>checked</i></dt> +<dd> +state of the selection (boolean) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file