tip/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarkDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarkDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarkDialog</h1>
<p>
Module implementing the bookmark dialog.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#HgBookmarkAction">HgBookmarkAction</a></td>
<td>Class defining the supported bookmark actions.</td>
</tr>
<tr>
<td><a href="#HgBookmarkDialog">HgBookmarkDialog</a></td>
<td>Class mplementing the bookmark dialog.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="HgBookmarkAction" ID="HgBookmarkAction"></a>
<h2>HgBookmarkAction</h2>
<p>
    Class defining the supported bookmark actions.
</p>

<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>
<table>
<tr><td>DEFINE</td></tr>
<tr><td>MOVE</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="HgBookmarkDialog" ID="HgBookmarkDialog"></a>
<h2>HgBookmarkDialog</h2>
<p>
    Class mplementing the bookmark dialog.
</p>

<h3>Derived from</h3>
QDialog, Ui_HgBookmarkDialog
<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="#HgBookmarkDialog.__init__">HgBookmarkDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HgBookmarkDialog.__updateBookmarksCombo">__updateBookmarksCombo</a></td>
<td>Private slot to update the bookmarks combo.</td>
</tr>
<tr>
<td><a href="#HgBookmarkDialog.__updateOK">__updateOK</a></td>
<td>Private slot to update the OK button.</td>
</tr>
<tr>
<td><a href="#HgBookmarkDialog.getData">getData</a></td>
<td>Public method to retrieve the entered data.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="HgBookmarkDialog.__init__" ID="HgBookmarkDialog.__init__"></a>
<h4>HgBookmarkDialog (Constructor)</h4>
<b>HgBookmarkDialog</b>(<i>action, tagsList, branchesList, bookmarksList, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>action</i> (HgBookmarkAction)</dt>
<dd>
bookmark action to be performed
</dd>
<dt><i>tagsList</i> (list of str)</dt>
<dd>
list of tags
</dd>
<dt><i>branchesList</i> (list of str)</dt>
<dd>
list of branches
</dd>
<dt><i>bookmarksList</i> (list of str)</dt>
<dd>
list of bookmarks
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
parent widget
</dd>
</dl>
<a NAME="HgBookmarkDialog.__updateBookmarksCombo" ID="HgBookmarkDialog.__updateBookmarksCombo"></a>
<h4>HgBookmarkDialog.__updateBookmarksCombo</h4>
<b>__updateBookmarksCombo</b>(<i></i>)
<p>
        Private slot to update the bookmarks combo.
</p>

<a NAME="HgBookmarkDialog.__updateOK" ID="HgBookmarkDialog.__updateOK"></a>
<h4>HgBookmarkDialog.__updateOK</h4>
<b>__updateOK</b>(<i></i>)
<p>
        Private slot to update the OK button.
</p>

<a NAME="HgBookmarkDialog.getData" ID="HgBookmarkDialog.getData"></a>
<h4>HgBookmarkDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to retrieve the entered data.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple naming the revision and the bookmark name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, str)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>