--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarksInOutDialog.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,261 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarksInOutDialog</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.HgBookmarksInOutDialog</h1> + +<p> +Module implementing a dialog to show a list of incoming or outgoing bookmarks. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#HgBookmarksInOutDialog">HgBookmarksInOutDialog</a></td> +<td>Class implementing a dialog to show a list of incoming or outgoing bookmarks.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="HgBookmarksInOutDialog" ID="HgBookmarksInOutDialog"></a> +<h2>HgBookmarksInOutDialog</h2> + +<p> + Class implementing a dialog to show a list of incoming or outgoing + bookmarks. +</p> +<h3>Derived from</h3> +QDialog, Ui_HgBookmarksInOutDialog +<h3>Class Attributes</h3> + +<table> +<tr><td>INCOMING</td></tr><tr><td>OUTGOING</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#HgBookmarksInOutDialog.__init__">HgBookmarksInOutDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#HgBookmarksInOutDialog.__finish">__finish</a></td> +<td>Private slot called when the process finished or the user pressed the button.</td> +</tr> +<tr> +<td><a href="#HgBookmarksInOutDialog.__generateItem">__generateItem</a></td> +<td>Private method to generate a bookmark item in the bookmarks list.</td> +</tr> +<tr> +<td><a href="#HgBookmarksInOutDialog.__processOutputLine">__processOutputLine</a></td> +<td>Private method to process the lines of output.</td> +</tr> +<tr> +<td><a href="#HgBookmarksInOutDialog.__resizeColumns">__resizeColumns</a></td> +<td>Private method to resize the list columns.</td> +</tr> +<tr> +<td><a href="#HgBookmarksInOutDialog.__resort">__resort</a></td> +<td>Private method to resort the tree.</td> +</tr> +<tr> +<td><a href="#HgBookmarksInOutDialog.__showError">__showError</a></td> +<td>Private slot to show some error.</td> +</tr> +<tr> +<td><a href="#HgBookmarksInOutDialog.closeEvent">closeEvent</a></td> +<td>Protected slot implementing a close event handler.</td> +</tr> +<tr> +<td><a href="#HgBookmarksInOutDialog.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="#HgBookmarksInOutDialog.start">start</a></td> +<td>Public slot to start the bookmarks command.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="HgBookmarksInOutDialog.__init__" ID="HgBookmarksInOutDialog.__init__"></a> +<h4>HgBookmarksInOutDialog (Constructor)</h4> +<b>HgBookmarksInOutDialog</b>(<i>vcs, mode, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>vcs</i></dt> +<dd> +reference to the vcs object +</dd> +<dt><i>mode</i></dt> +<dd> +mode of the dialog (HgBookmarksInOutDialog.INCOMING, + HgBookmarksInOutDialog.OUTGOING) +</dd> +<dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl> +<dl> + +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid dialog mode +</dd> +</dl> +<a NAME="HgBookmarksInOutDialog.__finish" ID="HgBookmarksInOutDialog.__finish"></a> +<h4>HgBookmarksInOutDialog.__finish</h4> +<b>__finish</b>(<i></i>) + +<p> + Private slot called when the process finished or the user pressed + the button. +</p> +<a NAME="HgBookmarksInOutDialog.__generateItem" ID="HgBookmarksInOutDialog.__generateItem"></a> +<h4>HgBookmarksInOutDialog.__generateItem</h4> +<b>__generateItem</b>(<i>changeset, name</i>) + +<p> + Private method to generate a bookmark item in the bookmarks list. +</p> +<dl> + +<dt><i>changeset</i></dt> +<dd> +changeset of the bookmark (string) +</dd> +<dt><i>name</i></dt> +<dd> +name of the bookmark (string) +</dd> +</dl> +<a NAME="HgBookmarksInOutDialog.__processOutputLine" ID="HgBookmarksInOutDialog.__processOutputLine"></a> +<h4>HgBookmarksInOutDialog.__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="HgBookmarksInOutDialog.__resizeColumns" ID="HgBookmarksInOutDialog.__resizeColumns"></a> +<h4>HgBookmarksInOutDialog.__resizeColumns</h4> +<b>__resizeColumns</b>(<i></i>) + +<p> + Private method to resize the list columns. +</p> +<a NAME="HgBookmarksInOutDialog.__resort" ID="HgBookmarksInOutDialog.__resort"></a> +<h4>HgBookmarksInOutDialog.__resort</h4> +<b>__resort</b>(<i></i>) + +<p> + Private method to resort the tree. +</p> +<a NAME="HgBookmarksInOutDialog.__showError" ID="HgBookmarksInOutDialog.__showError"></a> +<h4>HgBookmarksInOutDialog.__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="HgBookmarksInOutDialog.closeEvent" ID="HgBookmarksInOutDialog.closeEvent"></a> +<h4>HgBookmarksInOutDialog.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="HgBookmarksInOutDialog.on_buttonBox_clicked" ID="HgBookmarksInOutDialog.on_buttonBox_clicked"></a> +<h4>HgBookmarksInOutDialog.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="HgBookmarksInOutDialog.start" ID="HgBookmarksInOutDialog.start"></a> +<h4>HgBookmarksInOutDialog.start</h4> +<b>start</b>(<i></i>) + +<p> + Public slot to start the bookmarks command. +</p> +<dl> + +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised to indicate an invalid dialog mode +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file