--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesNewPatchDialog.html Sun May 15 19:13:36 2011 +0200 @@ -0,0 +1,172 @@ +<?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.QueuesExtension.HgQueuesNewPatchDialog</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.QueuesExtension.HgQueuesNewPatchDialog</h1> +<p> +Module implementing a dialog to get the data for a new patch. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#HgQueuesNewPatchDialog">HgQueuesNewPatchDialog</a></td> +<td>Class implementing a dialog to get the data for a new patch.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="HgQueuesNewPatchDialog" ID="HgQueuesNewPatchDialog"></a> +<h2>HgQueuesNewPatchDialog</h2> +<p> + Class implementing a dialog to get the data for a new patch. +</p> +<h3>Derived from</h3> +QDialog, Ui_HgQueuesNewPatchDialog +<h3>Class Attributes</h3> +<table> +<tr><td>NEW_MODE</td></tr><tr><td>REFRESH_MODE</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#HgQueuesNewPatchDialog.__init__">HgQueuesNewPatchDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#HgQueuesNewPatchDialog.__updateUI">__updateUI</a></td> +<td>Private slot to update the UI.</td> +</tr><tr> +<td><a href="#HgQueuesNewPatchDialog.getData">getData</a></td> +<td>Public method to retrieve the entered data.</td> +</tr><tr> +<td><a href="#HgQueuesNewPatchDialog.on_currentUserCheckBox_toggled">on_currentUserCheckBox_toggled</a></td> +<td>Private slot to handle changes of the currentuser state.</td> +</tr><tr> +<td><a href="#HgQueuesNewPatchDialog.on_messageEdit_textChanged">on_messageEdit_textChanged</a></td> +<td>Private slot to handle changes of the patch message.</td> +</tr><tr> +<td><a href="#HgQueuesNewPatchDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> +<td>Private slot to handle changes of the patch name.</td> +</tr><tr> +<td><a href="#HgQueuesNewPatchDialog.on_userEdit_textChanged">on_userEdit_textChanged</a></td> +<td>Private slot to handle changes of the user name.</td> +</tr><tr> +<td><a href="#HgQueuesNewPatchDialog.on_userGroup_toggled">on_userGroup_toggled</a></td> +<td>Private slot to handle changes of the user group state.</td> +</tr> +</table> +<a NAME="HgQueuesNewPatchDialog.__init__" ID="HgQueuesNewPatchDialog.__init__"></a> +<h4>HgQueuesNewPatchDialog (Constructor)</h4> +<b>HgQueuesNewPatchDialog</b>(<i>mode, message="", parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>mode</i></dt> +<dd> +mode of the dialog (HgQueuesNewPatchDialog.NEW_MODE, + HgQueuesNewPatchDialog.REFRESH_MODE) +</dd><dt><i>message</i></dt> +<dd> +text to set as the commit message (string) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="HgQueuesNewPatchDialog.__updateUI" ID="HgQueuesNewPatchDialog.__updateUI"></a> +<h4>HgQueuesNewPatchDialog.__updateUI</h4> +<b>__updateUI</b>(<i></i>) +<p> + Private slot to update the UI. +</p><a NAME="HgQueuesNewPatchDialog.getData" ID="HgQueuesNewPatchDialog.getData"></a> +<h4>HgQueuesNewPatchDialog.getData</h4> +<b>getData</b>(<i></i>) +<p> + Public method to retrieve the entered data. +</p><dl> +<dt>Returns:</dt> +<dd> +tuple giving the patch name and message, a tuple giving a + flag indicating to set the user, a flag indicating to use the + current user and the user name and another tuple giving a flag + indicating to set the date, a flag indicating to use the + current date and the date (string, string, (boolean, boolean, string), + (boolean, boolean, string)) +</dd> +</dl><a NAME="HgQueuesNewPatchDialog.on_currentUserCheckBox_toggled" ID="HgQueuesNewPatchDialog.on_currentUserCheckBox_toggled"></a> +<h4>HgQueuesNewPatchDialog.on_currentUserCheckBox_toggled</h4> +<b>on_currentUserCheckBox_toggled</b>(<i>checked</i>) +<p> + Private slot to handle changes of the currentuser state. +</p><dl> +<dt><i>checked</i></dt> +<dd> +flag giving the checked state (boolean) +</dd> +</dl><a NAME="HgQueuesNewPatchDialog.on_messageEdit_textChanged" ID="HgQueuesNewPatchDialog.on_messageEdit_textChanged"></a> +<h4>HgQueuesNewPatchDialog.on_messageEdit_textChanged</h4> +<b>on_messageEdit_textChanged</b>(<i></i>) +<p> + Private slot to handle changes of the patch message. +</p><dl> +<dt><i>txt</i></dt> +<dd> +text of the edit (string) +</dd> +</dl><a NAME="HgQueuesNewPatchDialog.on_nameEdit_textChanged" ID="HgQueuesNewPatchDialog.on_nameEdit_textChanged"></a> +<h4>HgQueuesNewPatchDialog.on_nameEdit_textChanged</h4> +<b>on_nameEdit_textChanged</b>(<i>txt</i>) +<p> + Private slot to handle changes of the patch name. +</p><dl> +<dt><i>txt</i></dt> +<dd> +text of the edit (string) +</dd> +</dl><a NAME="HgQueuesNewPatchDialog.on_userEdit_textChanged" ID="HgQueuesNewPatchDialog.on_userEdit_textChanged"></a> +<h4>HgQueuesNewPatchDialog.on_userEdit_textChanged</h4> +<b>on_userEdit_textChanged</b>(<i>txt</i>) +<p> + Private slot to handle changes of the user name. +</p><dl> +<dt><i>txt</i></dt> +<dd> +text of the edit (string) +</dd> +</dl><a NAME="HgQueuesNewPatchDialog.on_userGroup_toggled" ID="HgQueuesNewPatchDialog.on_userGroup_toggled"></a> +<h4>HgQueuesNewPatchDialog.on_userGroup_toggled</h4> +<b>on_userGroup_toggled</b>(<i>checked</i>) +<p> + Private slot to handle changes of the user group state. +</p><dl> +<dt><i>checked</i></dt> +<dd> +flag giving the checked state (boolean) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file