diff -r d6062691d424 -r e0227a7c850e eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,192 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.VcsPlugins.vcsMercurial.HgExportDialog</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.vcsMercurial.HgExportDialog</h1> + +<p> +Module implementing a dialog to enter data for the Mercurial export command. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#HgExportDialog">HgExportDialog</a></td> +<td>Class implementing a dialog to enter data for the Mercurial export command.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="HgExportDialog" ID="HgExportDialog"></a> +<h2>HgExportDialog</h2> + +<p> + Class implementing a dialog to enter data for the Mercurial export command. +</p> +<h3>Derived from</h3> +QDialog, Ui_HgExportDialog +<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="#HgExportDialog.__init__">HgExportDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#HgExportDialog.__updateOK">__updateOK</a></td> +<td>Private slot to update the OK button.</td> +</tr> +<tr> +<td><a href="#HgExportDialog.getParameters">getParameters</a></td> +<td>Public method to retrieve the export data.</td> +</tr> +<tr> +<td><a href="#HgExportDialog.on_changesetsEdit_textChanged">on_changesetsEdit_textChanged</a></td> +<td>Private slot to react on changes of the changesets edit.</td> +</tr> +<tr> +<td><a href="#HgExportDialog.on_directoryPicker_textChanged">on_directoryPicker_textChanged</a></td> +<td>Private slot to react on changes of the export directory edit.</td> +</tr> +<tr> +<td><a href="#HgExportDialog.on_patternEdit_textChanged">on_patternEdit_textChanged</a></td> +<td>Private slot to react on changes of the export file name pattern edit.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="HgExportDialog.__init__" ID="HgExportDialog.__init__"></a> +<h4>HgExportDialog (Constructor)</h4> +<b>HgExportDialog</b>(<i>bookmarksList, bookmarkAvailable, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>bookmarksList</i> (list of str)</dt> +<dd> +list of defined bookmarks +</dd> +<dt><i>bookmarkAvailable</i> (bool)</dt> +<dd> +flag indicating the availability of the + "--bookmark" option +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="HgExportDialog.__updateOK" ID="HgExportDialog.__updateOK"></a> +<h4>HgExportDialog.__updateOK</h4> +<b>__updateOK</b>(<i></i>) + +<p> + Private slot to update the OK button. +</p> +<a NAME="HgExportDialog.getParameters" ID="HgExportDialog.getParameters"></a> +<h4>HgExportDialog.getParameters</h4> +<b>getParameters</b>(<i></i>) + +<p> + Public method to retrieve the export data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple naming the output file name, the list of revisions to + export, the name of a bookmarked branch and flags indicating to + compare against the second parent, to treat all files as text, + to omit dates in the diff headers and to use the git extended + diff format +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, list of str, str, bool, bool, bool, bool) +</dd> +</dl> +<a NAME="HgExportDialog.on_changesetsEdit_textChanged" ID="HgExportDialog.on_changesetsEdit_textChanged"></a> +<h4>HgExportDialog.on_changesetsEdit_textChanged</h4> +<b>on_changesetsEdit_textChanged</b>(<i></i>) + +<p> + Private slot to react on changes of the changesets edit. +</p> +<a NAME="HgExportDialog.on_directoryPicker_textChanged" ID="HgExportDialog.on_directoryPicker_textChanged"></a> +<h4>HgExportDialog.on_directoryPicker_textChanged</h4> +<b>on_directoryPicker_textChanged</b>(<i>txt</i>) + +<p> + Private slot to react on changes of the export directory edit. +</p> +<dl> + +<dt><i>txt</i></dt> +<dd> +contents of the line edit (string) +</dd> +</dl> +<a NAME="HgExportDialog.on_patternEdit_textChanged" ID="HgExportDialog.on_patternEdit_textChanged"></a> +<h4>HgExportDialog.on_patternEdit_textChanged</h4> +<b>on_patternEdit_textChanged</b>(<i>txt</i>) + +<p> + Private slot to react on changes of the export file name pattern edit. +</p> +<dl> + +<dt><i>txt</i></dt> +<dd> +contents of the line edit (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file