--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.HgBookmarkRenameDialog.html Sun May 08 15:19:58 2011 +0200 @@ -0,0 +1,125 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.HgBookmarkRenameDialog</title> +<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>eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.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>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> +<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></dt> +<dd> +list of bookmarks (list of strings) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</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>Returns:</dt> +<dd> +tuple naming the new and old bookmark names + (string, string) +</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></dt> +<dd> +name of the selected bookmark (string) +</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></dt> +<dd> +text of the edit (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file