Added source docu for the Mercurial phase dialog.

Mon, 13 Feb 2012 18:53:48 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Mon, 13 Feb 2012 18:53:48 +0100
changeset 1619
56348a48c5e0
parent 1616
40f0ddd40d8a
child 1620
8172cc5d4dda

Added source docu for the Mercurial phase dialog.

Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgPhaseDialog.html file | annotate | diff | comparison | revisions
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgPhaseDialog.html	Mon Feb 13 18:53:48 2012 +0100
@@ -0,0 +1,120 @@
+<?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.HgPhaseDialog</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.HgPhaseDialog</h1>
+<p>
+Module implementing a dialog to enter data for the Mercurial Phase operation.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#HgPhaseDialog">HgPhaseDialog</a></td>
+<td>Class dimplementing a dialog to enter data for the Mercurial Phase operation.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="HgPhaseDialog" ID="HgPhaseDialog"></a>
+<h2>HgPhaseDialog</h2>
+<p>
+    Class dimplementing a dialog to enter data for the Mercurial Phase operation.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_HgPhaseDialog
+<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="#HgPhaseDialog.__init__">HgPhaseDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#HgPhaseDialog.__updateOk">__updateOk</a></td>
+<td>Private slot to update the state of the OK button.</td>
+</tr><tr>
+<td><a href="#HgPhaseDialog.getData">getData</a></td>
+<td>Public method to retrieve the entered data.</td>
+</tr><tr>
+<td><a href="#HgPhaseDialog.on_phaseCombo_activated">on_phaseCombo_activated</a></td>
+<td>Private slot to react upon changes of the phase.</td>
+</tr><tr>
+<td><a href="#HgPhaseDialog.on_revisionsEdit_textChanged">on_revisionsEdit_textChanged</a></td>
+<td>Private slot to react upon changes of revisions.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="HgPhaseDialog.__init__" ID="HgPhaseDialog.__init__"></a>
+<h4>HgPhaseDialog (Constructor)</h4>
+<b>HgPhaseDialog</b>(<i>parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="HgPhaseDialog.__updateOk" ID="HgPhaseDialog.__updateOk"></a>
+<h4>HgPhaseDialog.__updateOk</h4>
+<b>__updateOk</b>(<i></i>)
+<p>
+        Private slot to update the state of the OK button.
+</p><a NAME="HgPhaseDialog.getData" ID="HgPhaseDialog.getData"></a>
+<h4>HgPhaseDialog.getData</h4>
+<b>getData</b>(<i></i>)
+<p>
+        Public method to retrieve the entered data.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+tuple with list of revisions, phase and a flag indicating
+            a forced operation (list of strings, string, boolean)
+</dd>
+</dl><a NAME="HgPhaseDialog.on_phaseCombo_activated" ID="HgPhaseDialog.on_phaseCombo_activated"></a>
+<h4>HgPhaseDialog.on_phaseCombo_activated</h4>
+<b>on_phaseCombo_activated</b>(<i>txt</i>)
+<p>
+        Private slot to react upon changes of the phase.
+</p><a NAME="HgPhaseDialog.on_revisionsEdit_textChanged" ID="HgPhaseDialog.on_revisionsEdit_textChanged"></a>
+<h4>HgPhaseDialog.on_revisionsEdit_textChanged</h4>
+<b>on_revisionsEdit_textChanged</b>(<i></i>)
+<p>
+        Private slot to react upon changes of revisions.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial