--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListGuardsDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListGuardsDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,104 +18,138 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListGuardsDialog</h1> + <p> Module implementing a dialog to show the guards of a selected patch. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#HgQueuesListGuardsDialog">HgQueuesListGuardsDialog</a></td> <td>Class implementing a dialog to show the guards of a selected patch.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="HgQueuesListGuardsDialog" ID="HgQueuesListGuardsDialog"></a> <h2>HgQueuesListGuardsDialog</h2> + <p> Class implementing a dialog to show the guards of a selected patch. </p> <h3>Derived from</h3> QDialog, Ui_HgQueuesListGuardsDialog <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="#HgQueuesListGuardsDialog.__init__">HgQueuesListGuardsDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgQueuesListGuardsDialog.closeEvent">closeEvent</a></td> <td>Protected slot implementing a close event handler.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgQueuesListGuardsDialog.on_patchSelector_activated">on_patchSelector_activated</a></td> <td>Private slot to get the list of guards for the given patch name.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgQueuesListGuardsDialog.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="HgQueuesListGuardsDialog.__init__" ID="HgQueuesListGuardsDialog.__init__"></a> <h4>HgQueuesListGuardsDialog (Constructor)</h4> <b>HgQueuesListGuardsDialog</b>(<i>vcs, patchesList, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>vcs</i></dt> <dd> reference to the vcs object -</dd><dt><i>patchesList</i></dt> +</dd> +<dt><i>patchesList</i></dt> <dd> list of patches (list of strings) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="HgQueuesListGuardsDialog.closeEvent" ID="HgQueuesListGuardsDialog.closeEvent"></a> +</dl> +<a NAME="HgQueuesListGuardsDialog.closeEvent" ID="HgQueuesListGuardsDialog.closeEvent"></a> <h4>HgQueuesListGuardsDialog.closeEvent</h4> <b>closeEvent</b>(<i>e</i>) + <p> Protected slot implementing a close event handler. -</p><dl> +</p> +<dl> + <dt><i>e</i></dt> <dd> close event (QCloseEvent) </dd> -</dl><a NAME="HgQueuesListGuardsDialog.on_patchSelector_activated" ID="HgQueuesListGuardsDialog.on_patchSelector_activated"></a> +</dl> +<a NAME="HgQueuesListGuardsDialog.on_patchSelector_activated" ID="HgQueuesListGuardsDialog.on_patchSelector_activated"></a> <h4>HgQueuesListGuardsDialog.on_patchSelector_activated</h4> <b>on_patchSelector_activated</b>(<i>patch</i>) + <p> Private slot to get the list of guards for the given patch name. -</p><dl> +</p> +<dl> + <dt><i>patch</i></dt> <dd> selected patch name (empty for current patch) </dd> -</dl><a NAME="HgQueuesListGuardsDialog.start" ID="HgQueuesListGuardsDialog.start"></a> +</dl> +<a NAME="HgQueuesListGuardsDialog.start" ID="HgQueuesListGuardsDialog.start"></a> <h4>HgQueuesListGuardsDialog.start</h4> <b>start</b>(<i>path</i>) + <p> Public slot to start the list command. -</p><dl> +</p> +<dl> + <dt><i>path</i></dt> <dd> name of directory to be listed (string)