--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListDialog.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,303 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListDialog</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.QueuesExtension.HgQueuesListDialog</h1> + +<p> +Module implementing a dialog to show a list of applied and unapplied patches. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#HgQueuesListDialog">HgQueuesListDialog</a></td> +<td>Class implementing a dialog to show a list of applied and unapplied patches.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="HgQueuesListDialog" ID="HgQueuesListDialog"></a> +<h2>HgQueuesListDialog</h2> + +<p> + Class implementing a dialog to show a list of applied and unapplied + patches. +</p> +<h3>Derived from</h3> +QDialog, Ui_HgQueuesListDialog +<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="#HgQueuesListDialog.__init__">HgQueuesListDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#HgQueuesListDialog.__finish">__finish</a></td> +<td>Private slot called when the process finished or the user pressed the button.</td> +</tr> +<tr> +<td><a href="#HgQueuesListDialog.__generateItem">__generateItem</a></td> +<td>Private method to generate a patch item in the list of patches.</td> +</tr> +<tr> +<td><a href="#HgQueuesListDialog.__getSeries">__getSeries</a></td> +<td>Private slot to get the list of applied, unapplied and guarded patches and patches missing in the series file.</td> +</tr> +<tr> +<td><a href="#HgQueuesListDialog.__getTop">__getTop</a></td> +<td>Private slot to get patch at the top of the stack.</td> +</tr> +<tr> +<td><a href="#HgQueuesListDialog.__markTopItem">__markTopItem</a></td> +<td>Private slot to mark the top patch entry.</td> +</tr> +<tr> +<td><a href="#HgQueuesListDialog.__processOutputLine">__processOutputLine</a></td> +<td>Private method to process the lines of output.</td> +</tr> +<tr> +<td><a href="#HgQueuesListDialog.__resizeColumns">__resizeColumns</a></td> +<td>Private method to resize the list columns.</td> +</tr> +<tr> +<td><a href="#HgQueuesListDialog.__resort">__resort</a></td> +<td>Private method to resort the tree.</td> +</tr> +<tr> +<td><a href="#HgQueuesListDialog.__showError">__showError</a></td> +<td>Private slot to show some error.</td> +</tr> +<tr> +<td><a href="#HgQueuesListDialog.closeEvent">closeEvent</a></td> +<td>Protected slot implementing a close event handler.</td> +</tr> +<tr> +<td><a href="#HgQueuesListDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot called by a button of the button box clicked.</td> +</tr> +<tr> +<td><a href="#HgQueuesListDialog.start">start</a></td> +<td>Public slot to start the list command.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="HgQueuesListDialog.__init__" ID="HgQueuesListDialog.__init__"></a> +<h4>HgQueuesListDialog (Constructor)</h4> +<b>HgQueuesListDialog</b>(<i>vcs, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>vcs</i></dt> +<dd> +reference to the vcs object +</dd> +<dt><i>parent</i></dt> +<dd> +parent widget (QWidget) +</dd> +</dl> +<a NAME="HgQueuesListDialog.__finish" ID="HgQueuesListDialog.__finish"></a> +<h4>HgQueuesListDialog.__finish</h4> +<b>__finish</b>(<i></i>) + +<p> + Private slot called when the process finished or the user pressed + the button. +</p> +<a NAME="HgQueuesListDialog.__generateItem" ID="HgQueuesListDialog.__generateItem"></a> +<h4>HgQueuesListDialog.__generateItem</h4> +<b>__generateItem</b>(<i>index, status, name, summary, error=False</i>) + +<p> + Private method to generate a patch item in the list of patches. +</p> +<dl> + +<dt><i>index</i></dt> +<dd> +index of the patch (integer, -1 for missing) +</dd> +<dt><i>status</i></dt> +<dd> +status of the patch (string) +</dd> +<dt><i>name</i></dt> +<dd> +name of the patch (string) +</dd> +<dt><i>summary</i></dt> +<dd> +first line of the patch header (string) +</dd> +<dt><i>error</i></dt> +<dd> +flag indicating an error entry (boolean) +</dd> +</dl> +<a NAME="HgQueuesListDialog.__getSeries" ID="HgQueuesListDialog.__getSeries"></a> +<h4>HgQueuesListDialog.__getSeries</h4> +<b>__getSeries</b>(<i>missing=False</i>) + +<p> + Private slot to get the list of applied, unapplied and guarded patches + and patches missing in the series file. +</p> +<dl> + +<dt><i>missing</i></dt> +<dd> +flag indicating to get the patches missing in the + series file (boolean) +</dd> +</dl> +<a NAME="HgQueuesListDialog.__getTop" ID="HgQueuesListDialog.__getTop"></a> +<h4>HgQueuesListDialog.__getTop</h4> +<b>__getTop</b>(<i></i>) + +<p> + Private slot to get patch at the top of the stack. +</p> +<a NAME="HgQueuesListDialog.__markTopItem" ID="HgQueuesListDialog.__markTopItem"></a> +<h4>HgQueuesListDialog.__markTopItem</h4> +<b>__markTopItem</b>(<i>name</i>) + +<p> + Private slot to mark the top patch entry. +</p> +<dl> + +<dt><i>name</i></dt> +<dd> +name of the patch (string) +</dd> +</dl> +<a NAME="HgQueuesListDialog.__processOutputLine" ID="HgQueuesListDialog.__processOutputLine"></a> +<h4>HgQueuesListDialog.__processOutputLine</h4> +<b>__processOutputLine</b>(<i>line</i>) + +<p> + Private method to process the lines of output. +</p> +<dl> + +<dt><i>line</i></dt> +<dd> +output line to be processed (string) +</dd> +</dl> +<a NAME="HgQueuesListDialog.__resizeColumns" ID="HgQueuesListDialog.__resizeColumns"></a> +<h4>HgQueuesListDialog.__resizeColumns</h4> +<b>__resizeColumns</b>(<i></i>) + +<p> + Private method to resize the list columns. +</p> +<a NAME="HgQueuesListDialog.__resort" ID="HgQueuesListDialog.__resort"></a> +<h4>HgQueuesListDialog.__resort</h4> +<b>__resort</b>(<i></i>) + +<p> + Private method to resort the tree. +</p> +<a NAME="HgQueuesListDialog.__showError" ID="HgQueuesListDialog.__showError"></a> +<h4>HgQueuesListDialog.__showError</h4> +<b>__showError</b>(<i>out</i>) + +<p> + Private slot to show some error. +</p> +<dl> + +<dt><i>out</i></dt> +<dd> +error to be shown (string) +</dd> +</dl> +<a NAME="HgQueuesListDialog.closeEvent" ID="HgQueuesListDialog.closeEvent"></a> +<h4>HgQueuesListDialog.closeEvent</h4> +<b>closeEvent</b>(<i>e</i>) + +<p> + Protected slot implementing a close event handler. +</p> +<dl> + +<dt><i>e</i></dt> +<dd> +close event (QCloseEvent) +</dd> +</dl> +<a NAME="HgQueuesListDialog.on_buttonBox_clicked" ID="HgQueuesListDialog.on_buttonBox_clicked"></a> +<h4>HgQueuesListDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) + +<p> + Private slot called by a button of the button box clicked. +</p> +<dl> + +<dt><i>button</i></dt> +<dd> +button that was clicked (QAbstractButton) +</dd> +</dl> +<a NAME="HgQueuesListDialog.start" ID="HgQueuesListDialog.start"></a> +<h4>HgQueuesListDialog.start</h4> +<b>start</b>(<i></i>) + +<p> + Public slot to start the list command. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file