src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarkRenameDialog.html

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

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#HgBookmarkRenameDialog">HgBookmarkRenameDialog</a></td>
<td>Class implementing a dialog to get the data to rename a bookmark.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="HgBookmarkRenameDialog" ID="HgBookmarkRenameDialog"></a>
<h2>HgBookmarkRenameDialog</h2>
<p>
    Class implementing a dialog to get the data to rename a bookmark.
</p>

<h3>Derived from</h3>
QDialog, Ui_HgBookmarkRenameDialog
<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="#HgBookmarkRenameDialog.__init__">HgBookmarkRenameDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HgBookmarkRenameDialog.__updateUI">__updateUI</a></td>
<td>Private slot to update the UI.</td>
</tr>
<tr>
<td><a href="#HgBookmarkRenameDialog.getData">getData</a></td>
<td>Public method to retrieve the entered data.</td>
</tr>
<tr>
<td><a href="#HgBookmarkRenameDialog.on_bookmarkCombo_editTextChanged">on_bookmarkCombo_editTextChanged</a></td>
<td>Private slot to handle changes of the selected bookmark.</td>
</tr>
<tr>
<td><a href="#HgBookmarkRenameDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td>
<td>Private slot to handle changes of the bookmark name.</td>
</tr>
</table>

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


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

<dl>

<dt><i>bookmarksList</i> (list of str)</dt>
<dd>
list of bookmarks
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="HgBookmarkRenameDialog.__updateUI" ID="HgBookmarkRenameDialog.__updateUI"></a>
<h4>HgBookmarkRenameDialog.__updateUI</h4>
<b>__updateUI</b>(<i></i>)
<p>
        Private slot to update the UI.
</p>

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

<dl>
<dt>Return:</dt>
<dd>
tuple naming the old and new bookmark names
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, str)
</dd>
</dl>
<a NAME="HgBookmarkRenameDialog.on_bookmarkCombo_editTextChanged" ID="HgBookmarkRenameDialog.on_bookmarkCombo_editTextChanged"></a>
<h4>HgBookmarkRenameDialog.on_bookmarkCombo_editTextChanged</h4>
<b>on_bookmarkCombo_editTextChanged</b>(<i>_txt</i>)
<p>
        Private slot to handle changes of the selected bookmark.
</p>

<dl>

<dt><i>_txt</i> (str)</dt>
<dd>
name of the selected bookmark (unused)
</dd>
</dl>
<a NAME="HgBookmarkRenameDialog.on_nameEdit_textChanged" ID="HgBookmarkRenameDialog.on_nameEdit_textChanged"></a>
<h4>HgBookmarkRenameDialog.on_nameEdit_textChanged</h4>
<b>on_nameEdit_textChanged</b>(<i>_txt</i>)
<p>
        Private slot to handle changes of the bookmark name.
</p>

<dl>

<dt><i>_txt</i> (str)</dt>
<dd>
text of the edit (unused)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>