--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitRevisionsSelectionDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitRevisionsSelectionDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,29 +18,37 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsGit.GitRevisionsSelectionDialog</h1> + <p> Module implementing a dialog to enter the revisions for the git diff command. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#GitRevisionsSelectionDialog">GitRevisionsSelectionDialog</a></td> <td>Class implementing a dialog to enter the revisions for the git diff command.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="GitRevisionsSelectionDialog" ID="GitRevisionsSelectionDialog"></a> <h2>GitRevisionsSelectionDialog</h2> + <p> Class implementing a dialog to enter the revisions for the git diff command. @@ -48,231 +56,315 @@ <h3>Derived from</h3> QDialog, Ui_GitRevisionsSelectionDialog <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="#GitRevisionsSelectionDialog.__init__">GitRevisionsSelectionDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionsSelectionDialog.__getRevision">__getRevision</a></td> <td>Private method to generate the revision.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionsSelectionDialog.__updateOK">__updateOK</a></td> <td>Private slot to update the OK button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionsSelectionDialog.getRevisions">getRevisions</a></td> <td>Public method to get the revisions.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionsSelectionDialog.on_branch1Button_toggled">on_branch1Button_toggled</a></td> <td>Private slot to handle changes of the Branch1 select button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionsSelectionDialog.on_branch1Combo_editTextChanged">on_branch1Combo_editTextChanged</a></td> <td>Private slot to handle changes of the Branch1 combo.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionsSelectionDialog.on_branch2Button_toggled">on_branch2Button_toggled</a></td> <td>Private slot to handle changes of the Branch2 select button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionsSelectionDialog.on_branch2Combo_editTextChanged">on_branch2Combo_editTextChanged</a></td> <td>Private slot to handle changes of the Branch2 combo.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionsSelectionDialog.on_rev1Button_toggled">on_rev1Button_toggled</a></td> <td>Private slot to handle changes of the rev1 select button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionsSelectionDialog.on_rev1Edit_textChanged">on_rev1Edit_textChanged</a></td> <td>Private slot to handle changes of the rev1 edit.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionsSelectionDialog.on_rev2Button_toggled">on_rev2Button_toggled</a></td> <td>Private slot to handle changes of the rev2 select button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionsSelectionDialog.on_rev2Edit_textChanged">on_rev2Edit_textChanged</a></td> <td>Private slot to handle changes of the rev2 edit.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionsSelectionDialog.on_tag1Button_toggled">on_tag1Button_toggled</a></td> <td>Private slot to handle changes of the Tag1 select button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionsSelectionDialog.on_tag1Combo_editTextChanged">on_tag1Combo_editTextChanged</a></td> <td>Private slot to handle changes of the Tag1 combo.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionsSelectionDialog.on_tag2Button_toggled">on_tag2Button_toggled</a></td> <td>Private slot to handle changes of the Tag2 select button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitRevisionsSelectionDialog.on_tag2Combo_editTextChanged">on_tag2Combo_editTextChanged</a></td> <td>Private slot to handle changes of the Tag2 combo.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="GitRevisionsSelectionDialog.__init__" ID="GitRevisionsSelectionDialog.__init__"></a> <h4>GitRevisionsSelectionDialog (Constructor)</h4> <b>GitRevisionsSelectionDialog</b>(<i>tagsList, branchesList, 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>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> parent widget of the dialog (QWidget) </dd> -</dl><a NAME="GitRevisionsSelectionDialog.__getRevision" ID="GitRevisionsSelectionDialog.__getRevision"></a> +</dl> +<a NAME="GitRevisionsSelectionDialog.__getRevision" ID="GitRevisionsSelectionDialog.__getRevision"></a> <h4>GitRevisionsSelectionDialog.__getRevision</h4> <b>__getRevision</b>(<i>no</i>) + <p> Private method to generate the revision. -</p><dl> +</p> +<dl> + <dt><i>no</i></dt> <dd> revision number to generate (1 or 2) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> revision (string) </dd> -</dl><a NAME="GitRevisionsSelectionDialog.__updateOK" ID="GitRevisionsSelectionDialog.__updateOK"></a> +</dl> +<a NAME="GitRevisionsSelectionDialog.__updateOK" ID="GitRevisionsSelectionDialog.__updateOK"></a> <h4>GitRevisionsSelectionDialog.__updateOK</h4> <b>__updateOK</b>(<i></i>) + <p> Private slot to update the OK button. -</p><a NAME="GitRevisionsSelectionDialog.getRevisions" ID="GitRevisionsSelectionDialog.getRevisions"></a> +</p> +<a NAME="GitRevisionsSelectionDialog.getRevisions" ID="GitRevisionsSelectionDialog.getRevisions"></a> <h4>GitRevisionsSelectionDialog.getRevisions</h4> <b>getRevisions</b>(<i></i>) + <p> Public method to get the revisions. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> list of two revisions (list of strings) </dd> -</dl><a NAME="GitRevisionsSelectionDialog.on_branch1Button_toggled" ID="GitRevisionsSelectionDialog.on_branch1Button_toggled"></a> +</dl> +<a NAME="GitRevisionsSelectionDialog.on_branch1Button_toggled" ID="GitRevisionsSelectionDialog.on_branch1Button_toggled"></a> <h4>GitRevisionsSelectionDialog.on_branch1Button_toggled</h4> <b>on_branch1Button_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the Branch1 select button. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> state of the button (boolean) </dd> -</dl><a NAME="GitRevisionsSelectionDialog.on_branch1Combo_editTextChanged" ID="GitRevisionsSelectionDialog.on_branch1Combo_editTextChanged"></a> +</dl> +<a NAME="GitRevisionsSelectionDialog.on_branch1Combo_editTextChanged" ID="GitRevisionsSelectionDialog.on_branch1Combo_editTextChanged"></a> <h4>GitRevisionsSelectionDialog.on_branch1Combo_editTextChanged</h4> <b>on_branch1Combo_editTextChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the Branch1 combo. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the combo (string) </dd> -</dl><a NAME="GitRevisionsSelectionDialog.on_branch2Button_toggled" ID="GitRevisionsSelectionDialog.on_branch2Button_toggled"></a> +</dl> +<a NAME="GitRevisionsSelectionDialog.on_branch2Button_toggled" ID="GitRevisionsSelectionDialog.on_branch2Button_toggled"></a> <h4>GitRevisionsSelectionDialog.on_branch2Button_toggled</h4> <b>on_branch2Button_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the Branch2 select button. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> state of the button (boolean) </dd> -</dl><a NAME="GitRevisionsSelectionDialog.on_branch2Combo_editTextChanged" ID="GitRevisionsSelectionDialog.on_branch2Combo_editTextChanged"></a> +</dl> +<a NAME="GitRevisionsSelectionDialog.on_branch2Combo_editTextChanged" ID="GitRevisionsSelectionDialog.on_branch2Combo_editTextChanged"></a> <h4>GitRevisionsSelectionDialog.on_branch2Combo_editTextChanged</h4> <b>on_branch2Combo_editTextChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the Branch2 combo. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the combo (string) </dd> -</dl><a NAME="GitRevisionsSelectionDialog.on_rev1Button_toggled" ID="GitRevisionsSelectionDialog.on_rev1Button_toggled"></a> +</dl> +<a NAME="GitRevisionsSelectionDialog.on_rev1Button_toggled" ID="GitRevisionsSelectionDialog.on_rev1Button_toggled"></a> <h4>GitRevisionsSelectionDialog.on_rev1Button_toggled</h4> <b>on_rev1Button_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the rev1 select button. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> state of the button (boolean) </dd> -</dl><a NAME="GitRevisionsSelectionDialog.on_rev1Edit_textChanged" ID="GitRevisionsSelectionDialog.on_rev1Edit_textChanged"></a> +</dl> +<a NAME="GitRevisionsSelectionDialog.on_rev1Edit_textChanged" ID="GitRevisionsSelectionDialog.on_rev1Edit_textChanged"></a> <h4>GitRevisionsSelectionDialog.on_rev1Edit_textChanged</h4> <b>on_rev1Edit_textChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the rev1 edit. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the edit (string) </dd> -</dl><a NAME="GitRevisionsSelectionDialog.on_rev2Button_toggled" ID="GitRevisionsSelectionDialog.on_rev2Button_toggled"></a> +</dl> +<a NAME="GitRevisionsSelectionDialog.on_rev2Button_toggled" ID="GitRevisionsSelectionDialog.on_rev2Button_toggled"></a> <h4>GitRevisionsSelectionDialog.on_rev2Button_toggled</h4> <b>on_rev2Button_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the rev2 select button. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> state of the button (boolean) </dd> -</dl><a NAME="GitRevisionsSelectionDialog.on_rev2Edit_textChanged" ID="GitRevisionsSelectionDialog.on_rev2Edit_textChanged"></a> +</dl> +<a NAME="GitRevisionsSelectionDialog.on_rev2Edit_textChanged" ID="GitRevisionsSelectionDialog.on_rev2Edit_textChanged"></a> <h4>GitRevisionsSelectionDialog.on_rev2Edit_textChanged</h4> <b>on_rev2Edit_textChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the rev2 edit. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the edit (string) </dd> -</dl><a NAME="GitRevisionsSelectionDialog.on_tag1Button_toggled" ID="GitRevisionsSelectionDialog.on_tag1Button_toggled"></a> +</dl> +<a NAME="GitRevisionsSelectionDialog.on_tag1Button_toggled" ID="GitRevisionsSelectionDialog.on_tag1Button_toggled"></a> <h4>GitRevisionsSelectionDialog.on_tag1Button_toggled</h4> <b>on_tag1Button_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the Tag1 select button. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> state of the button (boolean) </dd> -</dl><a NAME="GitRevisionsSelectionDialog.on_tag1Combo_editTextChanged" ID="GitRevisionsSelectionDialog.on_tag1Combo_editTextChanged"></a> +</dl> +<a NAME="GitRevisionsSelectionDialog.on_tag1Combo_editTextChanged" ID="GitRevisionsSelectionDialog.on_tag1Combo_editTextChanged"></a> <h4>GitRevisionsSelectionDialog.on_tag1Combo_editTextChanged</h4> <b>on_tag1Combo_editTextChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the Tag1 combo. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the combo (string) </dd> -</dl><a NAME="GitRevisionsSelectionDialog.on_tag2Button_toggled" ID="GitRevisionsSelectionDialog.on_tag2Button_toggled"></a> +</dl> +<a NAME="GitRevisionsSelectionDialog.on_tag2Button_toggled" ID="GitRevisionsSelectionDialog.on_tag2Button_toggled"></a> <h4>GitRevisionsSelectionDialog.on_tag2Button_toggled</h4> <b>on_tag2Button_toggled</b>(<i>checked</i>) + <p> Private slot to handle changes of the Tag2 select button. -</p><dl> +</p> +<dl> + <dt><i>checked</i></dt> <dd> state of the button (boolean) </dd> -</dl><a NAME="GitRevisionsSelectionDialog.on_tag2Combo_editTextChanged" ID="GitRevisionsSelectionDialog.on_tag2Combo_editTextChanged"></a> +</dl> +<a NAME="GitRevisionsSelectionDialog.on_tag2Combo_editTextChanged" ID="GitRevisionsSelectionDialog.on_tag2Combo_editTextChanged"></a> <h4>GitRevisionsSelectionDialog.on_tag2Combo_editTextChanged</h4> <b>on_tag2Combo_editTextChanged</b>(<i>txt</i>) + <p> Private slot to handle changes of the Tag2 combo. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the combo (string)