--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitTagBranchListDialog.html Sun Dec 10 17:42:11 2017 +0100
@@ -0,0 +1,308 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.Plugins.VcsPlugins.vcsGit.GitTagBranchListDialog</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>eric6.Plugins.VcsPlugins.vcsGit.GitTagBranchListDialog</h1>
+<p>
+Module implementing a dialog to show a list of tags or branches.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#GitTagBranchListDialog">GitTagBranchListDialog</a></td>
+<td>Class implementing a dialog to show a list of tags or branches.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="GitTagBranchListDialog" ID="GitTagBranchListDialog"></a>
+<h2>GitTagBranchListDialog</h2>
+<p>
+ Class implementing a dialog to show a list of tags or branches.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_GitTagBranchListDialog
+<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="#GitTagBranchListDialog.__init__">GitTagBranchListDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#GitTagBranchListDialog.__finish">__finish</a></td>
+<td>Private slot called when the process finished or the user pressed the button.</td>
+</tr><tr>
+<td><a href="#GitTagBranchListDialog.__generateItem">__generateItem</a></td>
+<td>Private method to generate a tag item in the tag list.</td>
+</tr><tr>
+<td><a href="#GitTagBranchListDialog.__getCommit">__getCommit</a></td>
+<td>Private method to get the commit id for a tag.</td>
+</tr><tr>
+<td><a href="#GitTagBranchListDialog.__procFinished">__procFinished</a></td>
+<td>Private slot connected to the finished signal.</td>
+</tr><tr>
+<td><a href="#GitTagBranchListDialog.__processOutputLine">__processOutputLine</a></td>
+<td>Private method to process the lines of output.</td>
+</tr><tr>
+<td><a href="#GitTagBranchListDialog.__readStderr">__readStderr</a></td>
+<td>Private slot to handle the readyReadStderr signal.</td>
+</tr><tr>
+<td><a href="#GitTagBranchListDialog.__readStdout">__readStdout</a></td>
+<td>Private slot to handle the readyReadStdout signal.</td>
+</tr><tr>
+<td><a href="#GitTagBranchListDialog.__resizeColumns">__resizeColumns</a></td>
+<td>Private method to resize the list columns.</td>
+</tr><tr>
+<td><a href="#GitTagBranchListDialog.__resort">__resort</a></td>
+<td>Private method to resort the tree.</td>
+</tr><tr>
+<td><a href="#GitTagBranchListDialog.__showError">__showError</a></td>
+<td>Private slot to show some error.</td>
+</tr><tr>
+<td><a href="#GitTagBranchListDialog.closeEvent">closeEvent</a></td>
+<td>Protected slot implementing a close event handler.</td>
+</tr><tr>
+<td><a href="#GitTagBranchListDialog.keyPressEvent">keyPressEvent</a></td>
+<td>Protected slot to handle a key press event.</td>
+</tr><tr>
+<td><a href="#GitTagBranchListDialog.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="#GitTagBranchListDialog.on_input_returnPressed">on_input_returnPressed</a></td>
+<td>Private slot to handle the press of the return key in the input field.</td>
+</tr><tr>
+<td><a href="#GitTagBranchListDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
+<td>Private slot to handle the password checkbox toggled.</td>
+</tr><tr>
+<td><a href="#GitTagBranchListDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
+<td>Private slot to send the input to the git process.</td>
+</tr><tr>
+<td><a href="#GitTagBranchListDialog.start">start</a></td>
+<td>Public slot to start the tag/branch list command.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="GitTagBranchListDialog.__init__" ID="GitTagBranchListDialog.__init__"></a>
+<h4>GitTagBranchListDialog (Constructor)</h4>
+<b>GitTagBranchListDialog</b>(<i>vcs, parent=None</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>vcs</i></dt>
+<dd>
+reference to the vcs object
+</dd><dt><i>parent</i></dt>
+<dd>
+parent widget (QWidget)
+</dd>
+</dl><a NAME="GitTagBranchListDialog.__finish" ID="GitTagBranchListDialog.__finish"></a>
+<h4>GitTagBranchListDialog.__finish</h4>
+<b>__finish</b>(<i></i>)
+<p>
+ Private slot called when the process finished or the user pressed
+ the button.
+</p><a NAME="GitTagBranchListDialog.__generateItem" ID="GitTagBranchListDialog.__generateItem"></a>
+<h4>GitTagBranchListDialog.__generateItem</h4>
+<b>__generateItem</b>(<i>commit, name, msg="", bold=False, italic=False</i>)
+<p>
+ Private method to generate a tag item in the tag list.
+</p><dl>
+<dt><i>commit</i></dt>
+<dd>
+commit id of the tag/branch (string)
+</dd><dt><i>name</i></dt>
+<dd>
+name of the tag/branch (string)
+</dd><dt><i>msg</i></dt>
+<dd>
+tag annotation message
+</dd><dt><i>bold</i></dt>
+<dd>
+flag indicating to show the entry in bold (boolean)
+</dd><dt><i>italic</i></dt>
+<dd>
+flag indicating to show the entry in italic (boolean)
+</dd>
+</dl><a NAME="GitTagBranchListDialog.__getCommit" ID="GitTagBranchListDialog.__getCommit"></a>
+<h4>GitTagBranchListDialog.__getCommit</h4>
+<b>__getCommit</b>(<i>tag</i>)
+<p>
+ Private method to get the commit id for a tag.
+</p><dl>
+<dt><i>tag</i></dt>
+<dd>
+tag name (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+commit id shortened to 10 characters (string)
+</dd>
+</dl><a NAME="GitTagBranchListDialog.__procFinished" ID="GitTagBranchListDialog.__procFinished"></a>
+<h4>GitTagBranchListDialog.__procFinished</h4>
+<b>__procFinished</b>(<i>exitCode, exitStatus</i>)
+<p>
+ Private slot connected to the finished signal.
+</p><dl>
+<dt><i>exitCode</i></dt>
+<dd>
+exit code of the process (integer)
+</dd><dt><i>exitStatus</i></dt>
+<dd>
+exit status of the process (QProcess.ExitStatus)
+</dd>
+</dl><a NAME="GitTagBranchListDialog.__processOutputLine" ID="GitTagBranchListDialog.__processOutputLine"></a>
+<h4>GitTagBranchListDialog.__processOutputLine</h4>
+<b>__processOutputLine</b>(<i>line</i>)
+<p>
+ Private method to process the lines of output.
+</p><dl>
+<dt><i>line</i></dt>
+<dd>
+output line to be processed (string)
+</dd>
+</dl><a NAME="GitTagBranchListDialog.__readStderr" ID="GitTagBranchListDialog.__readStderr"></a>
+<h4>GitTagBranchListDialog.__readStderr</h4>
+<b>__readStderr</b>(<i></i>)
+<p>
+ Private slot to handle the readyReadStderr signal.
+</p><p>
+ It reads the error output of the process and inserts it into the
+ error pane.
+</p><a NAME="GitTagBranchListDialog.__readStdout" ID="GitTagBranchListDialog.__readStdout"></a>
+<h4>GitTagBranchListDialog.__readStdout</h4>
+<b>__readStdout</b>(<i></i>)
+<p>
+ Private slot to handle the readyReadStdout signal.
+</p><p>
+ It reads the output of the process, formats it and inserts it into
+ the contents pane.
+</p><a NAME="GitTagBranchListDialog.__resizeColumns" ID="GitTagBranchListDialog.__resizeColumns"></a>
+<h4>GitTagBranchListDialog.__resizeColumns</h4>
+<b>__resizeColumns</b>(<i></i>)
+<p>
+ Private method to resize the list columns.
+</p><a NAME="GitTagBranchListDialog.__resort" ID="GitTagBranchListDialog.__resort"></a>
+<h4>GitTagBranchListDialog.__resort</h4>
+<b>__resort</b>(<i></i>)
+<p>
+ Private method to resort the tree.
+</p><a NAME="GitTagBranchListDialog.__showError" ID="GitTagBranchListDialog.__showError"></a>
+<h4>GitTagBranchListDialog.__showError</h4>
+<b>__showError</b>(<i>out</i>)
+<p>
+ Private slot to show some error.
+</p><dl>
+<dt><i>out</i></dt>
+<dd>
+error to be shown (string)
+</dd>
+</dl><a NAME="GitTagBranchListDialog.closeEvent" ID="GitTagBranchListDialog.closeEvent"></a>
+<h4>GitTagBranchListDialog.closeEvent</h4>
+<b>closeEvent</b>(<i>e</i>)
+<p>
+ Protected slot implementing a close event handler.
+</p><dl>
+<dt><i>e</i></dt>
+<dd>
+close event (QCloseEvent)
+</dd>
+</dl><a NAME="GitTagBranchListDialog.keyPressEvent" ID="GitTagBranchListDialog.keyPressEvent"></a>
+<h4>GitTagBranchListDialog.keyPressEvent</h4>
+<b>keyPressEvent</b>(<i>evt</i>)
+<p>
+ Protected slot to handle a key press event.
+</p><dl>
+<dt><i>evt</i></dt>
+<dd>
+the key press event (QKeyEvent)
+</dd>
+</dl><a NAME="GitTagBranchListDialog.on_buttonBox_clicked" ID="GitTagBranchListDialog.on_buttonBox_clicked"></a>
+<h4>GitTagBranchListDialog.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="GitTagBranchListDialog.on_input_returnPressed" ID="GitTagBranchListDialog.on_input_returnPressed"></a>
+<h4>GitTagBranchListDialog.on_input_returnPressed</h4>
+<b>on_input_returnPressed</b>(<i></i>)
+<p>
+ Private slot to handle the press of the return key in the input field.
+</p><a NAME="GitTagBranchListDialog.on_passwordCheckBox_toggled" ID="GitTagBranchListDialog.on_passwordCheckBox_toggled"></a>
+<h4>GitTagBranchListDialog.on_passwordCheckBox_toggled</h4>
+<b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
+<p>
+ Private slot to handle the password checkbox toggled.
+</p><dl>
+<dt><i>isOn</i></dt>
+<dd>
+flag indicating the status of the check box (boolean)
+</dd>
+</dl><a NAME="GitTagBranchListDialog.on_sendButton_clicked" ID="GitTagBranchListDialog.on_sendButton_clicked"></a>
+<h4>GitTagBranchListDialog.on_sendButton_clicked</h4>
+<b>on_sendButton_clicked</b>(<i></i>)
+<p>
+ Private slot to send the input to the git process.
+</p><a NAME="GitTagBranchListDialog.start" ID="GitTagBranchListDialog.start"></a>
+<h4>GitTagBranchListDialog.start</h4>
+<b>start</b>(<i>path, tags, listAll=True, merged=True</i>)
+<p>
+ Public slot to start the tag/branch list command.
+</p><dl>
+<dt><i>path</i></dt>
+<dd>
+name of directory to be listed (string)
+</dd><dt><i>tags</i></dt>
+<dd>
+flag indicating a list of tags is requested
+ (False = branches, True = tags)
+</dd><dt><i>listAll</i></dt>
+<dd>
+flag indicating to show all tags or branches (boolean)
+</dd><dt><i>merged</i></dt>
+<dd>
+flag indicating to show only merged or non-merged
+ branches (boolean)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
