diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.html --- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,96 +18,125 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.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 /> +<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> +</tr> +<tr> <td><a href="#HgExportDialog.__updateOK">__updateOK</a></td> <td>Private slot to update the OK button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgExportDialog.getParameters">getParameters</a></td> <td>Public method to retrieve the export data.</td> -</tr><tr> +</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> +</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> +</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> +</p> +<dl> + <dt><i>bookmarksList</i> (list of str)</dt> <dd> list of defined bookmarks -</dd><dt><i>bookmarkAvailable</i> (bool)</dt> +</dd> +<dt><i>bookmarkAvailable</i> (bool)</dt> <dd> flag indicating the availability of the "--bookmark" option -</dd><dt><i>parent</i> (QWidget)</dt> +</dd> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget </dd> -</dl><a NAME="HgExportDialog.__updateOK" ID="HgExportDialog.__updateOK"></a> +</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> +</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> +</p> +<dl> <dt>Returns:</dt> <dd> tuple naming the output file name, the list of revisions to @@ -116,32 +145,43 @@ to omit dates in the diff headers and to use the git extended diff format </dd> -</dl><dl> +</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> +</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> +</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> +</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> +</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> +</p> +<dl> + <dt><i>txt</i></dt> <dd> contents of the line edit (string)