--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitArchiveDataDialog.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,263 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.VcsPlugins.vcsGit.GitArchiveDataDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Plugins.VcsPlugins.vcsGit.GitArchiveDataDialog</h1> + +<p> +Module implementing a dialog to enter the data for the creation of an archive. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#GitArchiveDataDialog">GitArchiveDataDialog</a></td> +<td>Class implementing a dialog to enter the data for the creation of an archive.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="GitArchiveDataDialog" ID="GitArchiveDataDialog"></a> +<h2>GitArchiveDataDialog</h2> + +<p> + Class implementing a dialog to enter the data for the creation of an + archive. +</p> +<h3>Derived from</h3> +QDialog, Ui_GitArchiveDataDialog +<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="#GitArchiveDataDialog.__init__">GitArchiveDataDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#GitArchiveDataDialog.__updateOK">__updateOK</a></td> +<td>Private slot to update the OK button.</td> +</tr> +<tr> +<td><a href="#GitArchiveDataDialog.getData">getData</a></td> +<td>Public method to retrieve the entered data.</td> +</tr> +<tr> +<td><a href="#GitArchiveDataDialog.on_branchButton_toggled">on_branchButton_toggled</a></td> +<td>Private slot to handle changes of the Branch select button.</td> +</tr> +<tr> +<td><a href="#GitArchiveDataDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td> +<td>Private slot to handle changes of the Branch combo.</td> +</tr> +<tr> +<td><a href="#GitArchiveDataDialog.on_fileButton_clicked">on_fileButton_clicked</a></td> +<td>Private slot to select a file via a file selection dialog.</td> +</tr> +<tr> +<td><a href="#GitArchiveDataDialog.on_fileEdit_textChanged">on_fileEdit_textChanged</a></td> +<td>Private slot to handle changes of the file edit.</td> +</tr> +<tr> +<td><a href="#GitArchiveDataDialog.on_revButton_toggled">on_revButton_toggled</a></td> +<td>Private slot to handle changes of the rev select button.</td> +</tr> +<tr> +<td><a href="#GitArchiveDataDialog.on_revEdit_textChanged">on_revEdit_textChanged</a></td> +<td>Private slot to handle changes of the rev edit.</td> +</tr> +<tr> +<td><a href="#GitArchiveDataDialog.on_tagButton_toggled">on_tagButton_toggled</a></td> +<td>Private slot to handle changes of the Tag select button.</td> +</tr> +<tr> +<td><a href="#GitArchiveDataDialog.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="GitArchiveDataDialog.__init__" ID="GitArchiveDataDialog.__init__"></a> +<h4>GitArchiveDataDialog (Constructor)</h4> +<b>GitArchiveDataDialog</b>(<i>tagsList, branchesList, formatsList, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>tagsList</i></dt> +<dd> +list of tags (list of strings) +</dd> +<dt><i>branchesList</i></dt> +<dd> +list of branches (list of strings) +</dd> +<dt><i>formatsList</i></dt> +<dd> +list of archive formats (list of strings) +</dd> +<dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl> +<a NAME="GitArchiveDataDialog.__updateOK" ID="GitArchiveDataDialog.__updateOK"></a> +<h4>GitArchiveDataDialog.__updateOK</h4> +<b>__updateOK</b>(<i></i>) + +<p> + Private slot to update the OK button. +</p> +<a NAME="GitArchiveDataDialog.getData" ID="GitArchiveDataDialog.getData"></a> +<h4>GitArchiveDataDialog.getData</h4> +<b>getData</b>(<i></i>) + +<p> + Public method to retrieve the entered data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple of selected revision (string), archive format (string), + archive file (string) and prefix (string) +</dd> +</dl> +<a NAME="GitArchiveDataDialog.on_branchButton_toggled" ID="GitArchiveDataDialog.on_branchButton_toggled"></a> +<h4>GitArchiveDataDialog.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> + +<dt><i>checked</i></dt> +<dd> +state of the button (boolean) +</dd> +</dl> +<a NAME="GitArchiveDataDialog.on_branchCombo_editTextChanged" ID="GitArchiveDataDialog.on_branchCombo_editTextChanged"></a> +<h4>GitArchiveDataDialog.on_branchCombo_editTextChanged</h4> +<b>on_branchCombo_editTextChanged</b>(<i>txt</i>) + +<p> + Private slot to handle changes of the Branch combo. +</p> +<dl> + +<dt><i>txt</i></dt> +<dd> +text of the combo (string) +</dd> +</dl> +<a NAME="GitArchiveDataDialog.on_fileButton_clicked" ID="GitArchiveDataDialog.on_fileButton_clicked"></a> +<h4>GitArchiveDataDialog.on_fileButton_clicked</h4> +<b>on_fileButton_clicked</b>(<i></i>) + +<p> + Private slot to select a file via a file selection dialog. +</p> +<a NAME="GitArchiveDataDialog.on_fileEdit_textChanged" ID="GitArchiveDataDialog.on_fileEdit_textChanged"></a> +<h4>GitArchiveDataDialog.on_fileEdit_textChanged</h4> +<b>on_fileEdit_textChanged</b>(<i>txt</i>) + +<p> + Private slot to handle changes of the file edit. +</p> +<dl> + +<dt><i>txt</i></dt> +<dd> +text of the edit (string) +</dd> +</dl> +<a NAME="GitArchiveDataDialog.on_revButton_toggled" ID="GitArchiveDataDialog.on_revButton_toggled"></a> +<h4>GitArchiveDataDialog.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> + +<dt><i>checked</i></dt> +<dd> +state of the button (boolean) +</dd> +</dl> +<a NAME="GitArchiveDataDialog.on_revEdit_textChanged" ID="GitArchiveDataDialog.on_revEdit_textChanged"></a> +<h4>GitArchiveDataDialog.on_revEdit_textChanged</h4> +<b>on_revEdit_textChanged</b>(<i>txt</i>) + +<p> + Private slot to handle changes of the rev edit. +</p> +<dl> + +<dt><i>txt</i></dt> +<dd> +text of the edit (string) +</dd> +</dl> +<a NAME="GitArchiveDataDialog.on_tagButton_toggled" ID="GitArchiveDataDialog.on_tagButton_toggled"></a> +<h4>GitArchiveDataDialog.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> + +<dt><i>checked</i></dt> +<dd> +state of the button (boolean) +</dd> +</dl> +<a NAME="GitArchiveDataDialog.on_tagCombo_editTextChanged" ID="GitArchiveDataDialog.on_tagCombo_editTextChanged"></a> +<h4>GitArchiveDataDialog.on_tagCombo_editTextChanged</h4> +<b>on_tagCombo_editTextChanged</b>(<i>txt</i>) + +<p> + Private slot to handle changes of the Tag combo. +</p> +<dl> + +<dt><i>txt</i></dt> +<dd> +text of the combo (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file