diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitRevisionSelectionDialog.html --- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitRevisionSelectionDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitRevisionSelectionDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,203 +18,273 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsGit.GitRevisionSelectionDialog</h1> + <p> Module implementing a dialog to select a revision. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#GitRevisionSelectionDialog">GitRevisionSelectionDialog</a></td> <td>Class implementing a dialog to select a revision.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="GitRevisionSelectionDialog" ID="GitRevisionSelectionDialog"></a> <h2>GitRevisionSelectionDialog</h2> + <p> Class implementing a dialog to select a revision. </p> <h3>Derived from</h3> QDialog, Ui_GitRevisionSelectionDialog <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="#GitRevisionSelectionDialog.__init__">GitRevisionSelectionDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionSelectionDialog.__updateOK">__updateOK</a></td> <td>Private slot to update the OK button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionSelectionDialog.getRevision">getRevision</a></td> <td>Public method to retrieve the selected revision.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionSelectionDialog.on_branchButton_toggled">on_branchButton_toggled</a></td> <td>Private slot to handle changes of the Branch select button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionSelectionDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td> <td>Private slot to handle changes of the Branch combo.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionSelectionDialog.on_remoteBranchButton_toggled">on_remoteBranchButton_toggled</a></td> <td>Private slot to handle changes of the Remote Branch select button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionSelectionDialog.on_remoteBranchCombo_editTextChanged">on_remoteBranchCombo_editTextChanged</a></td> <td>Private slot to handle changes of the Remote Branch combo.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionSelectionDialog.on_revButton_toggled">on_revButton_toggled</a></td> <td>Private slot to handle changes of the rev select button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionSelectionDialog.on_revEdit_textChanged">on_revEdit_textChanged</a></td> <td>Private slot to handle changes of the rev edit.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionSelectionDialog.on_tagButton_toggled">on_tagButton_toggled</a></td> <td>Private slot to handle changes of the Tag select button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionSelectionDialog.on_tagCombo_editTextChanged">on_tagCombo_editTextChanged</a></td> <td>Private slot to handle changes of the Tag combo.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="GitRevisionSelectionDialog.__init__" ID="GitRevisionSelectionDialog.__init__"></a> <h4>GitRevisionSelectionDialog (Constructor)</h4> <b>GitRevisionSelectionDialog</b>(<i>tagsList, branchesList, trackingBranchesList=None, noneLabel="", showBranches=True, showHead=True, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>tagsList</i></dt> <dd> list of tags (list of strings) -</dd><dt><i>branchesList</i></dt> +</dd> +<dt><i>branchesList</i></dt> <dd> list of branches (list of strings) -</dd><dt><i>trackingBranchesList</i></dt> +</dd> +<dt><i>trackingBranchesList</i></dt> <dd> list of remote branches (list of strings) -</dd><dt><i>noneLabel</i></dt> +</dd> +<dt><i>noneLabel</i></dt> <dd> label text for "no revision selected" (string) -</dd><dt><i>showBranches</i></dt> +</dd> +<dt><i>showBranches</i></dt> <dd> flag indicating to show the branch selection (boolean) -</dd><dt><i>showHead</i></dt> +</dd> +<dt><i>showHead</i></dt> <dd> flag indicating to show the head selection (boolean) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> parent widget (QWidget) </dd> -</dl><a NAME="GitRevisionSelectionDialog.__updateOK" ID="GitRevisionSelectionDialog.__updateOK"></a> +</dl> +<a NAME="GitRevisionSelectionDialog.__updateOK" ID="GitRevisionSelectionDialog.__updateOK"></a> <h4>GitRevisionSelectionDialog.__updateOK</h4> <b>__updateOK</b>(<i></i>) + <p> Private slot to update the OK button. -</p><a NAME="GitRevisionSelectionDialog.getRevision" ID="GitRevisionSelectionDialog.getRevision"></a> +</p> +<a NAME="GitRevisionSelectionDialog.getRevision" ID="GitRevisionSelectionDialog.getRevision"></a> <h4>GitRevisionSelectionDialog.getRevision</h4> <b>getRevision</b>(<i></i>) + <p> Public method to retrieve the selected revision. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> selected revision (string) </dd> -</dl><a NAME="GitRevisionSelectionDialog.on_branchButton_toggled" ID="GitRevisionSelectionDialog.on_branchButton_toggled"></a> +</dl> +<a NAME="GitRevisionSelectionDialog.on_branchButton_toggled" ID="GitRevisionSelectionDialog.on_branchButton_toggled"></a> <h4>GitRevisionSelectionDialog.on_branchButton_toggled</h4> <b>on_branchButton_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the Branch select button. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> state of the button (boolean) </dd> -</dl><a NAME="GitRevisionSelectionDialog.on_branchCombo_editTextChanged" ID="GitRevisionSelectionDialog.on_branchCombo_editTextChanged"></a> +</dl> +<a NAME="GitRevisionSelectionDialog.on_branchCombo_editTextChanged" ID="GitRevisionSelectionDialog.on_branchCombo_editTextChanged"></a> <h4>GitRevisionSelectionDialog.on_branchCombo_editTextChanged</h4> <b>on_branchCombo_editTextChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the Branch combo. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the combo (string) </dd> -</dl><a NAME="GitRevisionSelectionDialog.on_remoteBranchButton_toggled" ID="GitRevisionSelectionDialog.on_remoteBranchButton_toggled"></a> +</dl> +<a NAME="GitRevisionSelectionDialog.on_remoteBranchButton_toggled" ID="GitRevisionSelectionDialog.on_remoteBranchButton_toggled"></a> <h4>GitRevisionSelectionDialog.on_remoteBranchButton_toggled</h4> <b>on_remoteBranchButton_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the Remote Branch select button. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> state of the button (boolean) </dd> -</dl><a NAME="GitRevisionSelectionDialog.on_remoteBranchCombo_editTextChanged" ID="GitRevisionSelectionDialog.on_remoteBranchCombo_editTextChanged"></a> +</dl> +<a NAME="GitRevisionSelectionDialog.on_remoteBranchCombo_editTextChanged" ID="GitRevisionSelectionDialog.on_remoteBranchCombo_editTextChanged"></a> <h4>GitRevisionSelectionDialog.on_remoteBranchCombo_editTextChanged</h4> <b>on_remoteBranchCombo_editTextChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the Remote Branch combo. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the combo (string) </dd> -</dl><a NAME="GitRevisionSelectionDialog.on_revButton_toggled" ID="GitRevisionSelectionDialog.on_revButton_toggled"></a> +</dl> +<a NAME="GitRevisionSelectionDialog.on_revButton_toggled" ID="GitRevisionSelectionDialog.on_revButton_toggled"></a> <h4>GitRevisionSelectionDialog.on_revButton_toggled</h4> <b>on_revButton_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the rev select button. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> state of the button (boolean) </dd> -</dl><a NAME="GitRevisionSelectionDialog.on_revEdit_textChanged" ID="GitRevisionSelectionDialog.on_revEdit_textChanged"></a> +</dl> +<a NAME="GitRevisionSelectionDialog.on_revEdit_textChanged" ID="GitRevisionSelectionDialog.on_revEdit_textChanged"></a> <h4>GitRevisionSelectionDialog.on_revEdit_textChanged</h4> <b>on_revEdit_textChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the rev edit. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the edit (string) </dd> -</dl><a NAME="GitRevisionSelectionDialog.on_tagButton_toggled" ID="GitRevisionSelectionDialog.on_tagButton_toggled"></a> +</dl> +<a NAME="GitRevisionSelectionDialog.on_tagButton_toggled" ID="GitRevisionSelectionDialog.on_tagButton_toggled"></a> <h4>GitRevisionSelectionDialog.on_tagButton_toggled</h4> <b>on_tagButton_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the Tag select button. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> state of the button (boolean) </dd> -</dl><a NAME="GitRevisionSelectionDialog.on_tagCombo_editTextChanged" ID="GitRevisionSelectionDialog.on_tagCombo_editTextChanged"></a> +</dl> +<a NAME="GitRevisionSelectionDialog.on_tagCombo_editTextChanged" ID="GitRevisionSelectionDialog.on_tagCombo_editTextChanged"></a> <h4>GitRevisionSelectionDialog.on_tagCombo_editTextChanged</h4> <b>on_tagCombo_editTextChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the Tag combo. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the combo (string)