Documentation/Source/eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.html

changeset 562
8bf0dbc1ca6a
child 945
8cd4d08fa9f6
child 1278
fb0460fd00b9
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.html	Sat Sep 04 19:10:16 2010 +0200
@@ -0,0 +1,303 @@
+<?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.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog</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.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog</h1>
+<p>
+Module implementing the eric5 message box wizard dialog.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#E5MessageBoxWizardDialog">E5MessageBoxWizardDialog</a></td>
+<td>Class implementing the eric5 message box wizard dialog.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="E5MessageBoxWizardDialog" ID="E5MessageBoxWizardDialog"></a>
+<h2>E5MessageBoxWizardDialog</h2>
+<p>
+    Class implementing the eric5 message box wizard dialog.
+</p><p>
+    It displays a dialog for entering the parameters
+    for the E5MessageBox code generator.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_E5MessageBoxWizardDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#E5MessageBoxWizardDialog.__init__">E5MessageBoxWizardDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#E5MessageBoxWizardDialog.__enabledGroups">__enabledGroups</a></td>
+<td>Private method to enable/disable some group boxes.</td>
+</tr><tr>
+<td><a href="#E5MessageBoxWizardDialog.__getDefaultButtonCode">__getDefaultButtonCode</a></td>
+<td>Private method to generate the button code for the default button.</td>
+</tr><tr>
+<td><a href="#E5MessageBoxWizardDialog.__getStandardButtonCode">__getStandardButtonCode</a></td>
+<td>Private method to generate the button code for the standard buttons.</td>
+</tr><tr>
+<td><a href="#E5MessageBoxWizardDialog.getCode">getCode</a></td>
+<td>Public method to get the source code.</td>
+</tr><tr>
+<td><a href="#E5MessageBoxWizardDialog.on_bTest_clicked">on_bTest_clicked</a></td>
+<td>Private method to test the selected options.</td>
+</tr><tr>
+<td><a href="#E5MessageBoxWizardDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot called by a button of the button box clicked.</td>
+</tr><tr>
+<td><a href="#E5MessageBoxWizardDialog.on_rAboutQt_toggled">on_rAboutQt_toggled</a></td>
+<td>Private slot to handle the toggled signal of the rAboutQt radio button.</td>
+</tr><tr>
+<td><a href="#E5MessageBoxWizardDialog.on_rAbout_toggled">on_rAbout_toggled</a></td>
+<td>Private slot to handle the toggled signal of the rAbout radio button.</td>
+</tr><tr>
+<td><a href="#E5MessageBoxWizardDialog.on_rCritical_toggled">on_rCritical_toggled</a></td>
+<td>Private slot to handle the toggled signal of the rCritical radio button.</td>
+</tr><tr>
+<td><a href="#E5MessageBoxWizardDialog.on_rInformation_toggled">on_rInformation_toggled</a></td>
+<td>Private slot to handle the toggled signal of the rInformation radio button.</td>
+</tr><tr>
+<td><a href="#E5MessageBoxWizardDialog.on_rOkToClearData_toggled">on_rOkToClearData_toggled</a></td>
+<td>Private slot to handle the toggled signal of the rOkToClearData radio button.</td>
+</tr><tr>
+<td><a href="#E5MessageBoxWizardDialog.on_rQuestion_toggled">on_rQuestion_toggled</a></td>
+<td>Private slot to handle the toggled signal of the rQuestion radio button.</td>
+</tr><tr>
+<td><a href="#E5MessageBoxWizardDialog.on_rRetryAbort_toggled">on_rRetryAbort_toggled</a></td>
+<td>Private slot to handle the toggled signal of the rRetryAbort radio button.</td>
+</tr><tr>
+<td><a href="#E5MessageBoxWizardDialog.on_rStandard_toggled">on_rStandard_toggled</a></td>
+<td>Private slot to handle the toggled signal of the rStandard radio button.</td>
+</tr><tr>
+<td><a href="#E5MessageBoxWizardDialog.on_rWarning_toggled">on_rWarning_toggled</a></td>
+<td>Private slot to handle the toggled signal of the rWarning radio button.</td>
+</tr><tr>
+<td><a href="#E5MessageBoxWizardDialog.on_rYesNo_toggled">on_rYesNo_toggled</a></td>
+<td>Private slot to handle the toggled signal of the rYesNo radio button.</td>
+</tr>
+</table>
+<a NAME="E5MessageBoxWizardDialog.__init__" ID="E5MessageBoxWizardDialog.__init__"></a>
+<h4>E5MessageBoxWizardDialog (Constructor)</h4>
+<b>E5MessageBoxWizardDialog</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="E5MessageBoxWizardDialog.__enabledGroups" ID="E5MessageBoxWizardDialog.__enabledGroups"></a>
+<h4>E5MessageBoxWizardDialog.__enabledGroups</h4>
+<b>__enabledGroups</b>(<i></i>)
+<p>
+        Private method to enable/disable some group boxes.
+</p><a NAME="E5MessageBoxWizardDialog.__getDefaultButtonCode" ID="E5MessageBoxWizardDialog.__getDefaultButtonCode"></a>
+<h4>E5MessageBoxWizardDialog.__getDefaultButtonCode</h4>
+<b>__getDefaultButtonCode</b>(<i>istring</i>)
+<p>
+        Private method to generate the button code for the default button.
+</p><dl>
+<dt><i>istring</i></dt>
+<dd>
+indentation string (string)
+</dd><dt><i>indString</i></dt>
+<dd>
+string used for indentation (space or tab) (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+the button code (string)
+</dd>
+</dl><a NAME="E5MessageBoxWizardDialog.__getStandardButtonCode" ID="E5MessageBoxWizardDialog.__getStandardButtonCode"></a>
+<h4>E5MessageBoxWizardDialog.__getStandardButtonCode</h4>
+<b>__getStandardButtonCode</b>(<i>istring, indString, withIntro = True</i>)
+<p>
+        Private method to generate the button code for the standard buttons.
+</p><dl>
+<dt><i>istring</i></dt>
+<dd>
+indentation string (string)
+</dd><dt><i>indString</i></dt>
+<dd>
+string used for indentation (space or tab) (string)
+</dd><dt><i>withIntro=</i></dt>
+<dd>
+flag indicating to generate a first line
+            with introductory text (boolean)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+the button code (string)
+</dd>
+</dl><a NAME="E5MessageBoxWizardDialog.getCode" ID="E5MessageBoxWizardDialog.getCode"></a>
+<h4>E5MessageBoxWizardDialog.getCode</h4>
+<b>getCode</b>(<i>indLevel, indString</i>)
+<p>
+        Public method to get the source code.
+</p><dl>
+<dt><i>indLevel</i></dt>
+<dd>
+indentation level (int)
+</dd><dt><i>indString</i></dt>
+<dd>
+string used for indentation (space or tab) (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+generated code (string)
+</dd>
+</dl><a NAME="E5MessageBoxWizardDialog.on_bTest_clicked" ID="E5MessageBoxWizardDialog.on_bTest_clicked"></a>
+<h4>E5MessageBoxWizardDialog.on_bTest_clicked</h4>
+<b>on_bTest_clicked</b>(<i></i>)
+<p>
+        Private method to test the selected options.
+</p><a NAME="E5MessageBoxWizardDialog.on_buttonBox_clicked" ID="E5MessageBoxWizardDialog.on_buttonBox_clicked"></a>
+<h4>E5MessageBoxWizardDialog.on_buttonBox_clicked</h4>
+<b>on_buttonBox_clicked</b>(<i>button</i>)
+<p>
+        Private slot called by a button of the button box clicked.
+</p><dl>
+<dt><i>button</i></dt>
+<dd>
+button that was clicked (QAbstractButton)
+</dd>
+</dl><a NAME="E5MessageBoxWizardDialog.on_rAboutQt_toggled" ID="E5MessageBoxWizardDialog.on_rAboutQt_toggled"></a>
+<h4>E5MessageBoxWizardDialog.on_rAboutQt_toggled</h4>
+<b>on_rAboutQt_toggled</b>(<i>checked</i>)
+<p>
+        Private slot to handle the toggled signal of the rAboutQt radio button.
+</p><dl>
+<dt><i>on</i></dt>
+<dd>
+toggle state (boolean) (ignored)
+</dd>
+</dl><a NAME="E5MessageBoxWizardDialog.on_rAbout_toggled" ID="E5MessageBoxWizardDialog.on_rAbout_toggled"></a>
+<h4>E5MessageBoxWizardDialog.on_rAbout_toggled</h4>
+<b>on_rAbout_toggled</b>(<i>checked</i>)
+<p>
+        Private slot to handle the toggled signal of the rAbout radio button.
+</p><dl>
+<dt><i>on</i></dt>
+<dd>
+toggle state (boolean) (ignored)
+</dd>
+</dl><a NAME="E5MessageBoxWizardDialog.on_rCritical_toggled" ID="E5MessageBoxWizardDialog.on_rCritical_toggled"></a>
+<h4>E5MessageBoxWizardDialog.on_rCritical_toggled</h4>
+<b>on_rCritical_toggled</b>(<i>checked</i>)
+<p>
+        Private slot to handle the toggled signal of the rCritical radio button.
+</p><dl>
+<dt><i>on</i></dt>
+<dd>
+toggle state (boolean) (ignored)
+</dd>
+</dl><a NAME="E5MessageBoxWizardDialog.on_rInformation_toggled" ID="E5MessageBoxWizardDialog.on_rInformation_toggled"></a>
+<h4>E5MessageBoxWizardDialog.on_rInformation_toggled</h4>
+<b>on_rInformation_toggled</b>(<i>checked</i>)
+<p>
+        Private slot to handle the toggled signal of the rInformation radio button.
+</p><dl>
+<dt><i>on</i></dt>
+<dd>
+toggle state (boolean) (ignored)
+</dd>
+</dl><a NAME="E5MessageBoxWizardDialog.on_rOkToClearData_toggled" ID="E5MessageBoxWizardDialog.on_rOkToClearData_toggled"></a>
+<h4>E5MessageBoxWizardDialog.on_rOkToClearData_toggled</h4>
+<b>on_rOkToClearData_toggled</b>(<i>checked</i>)
+<p>
+        Private slot to handle the toggled signal of the rOkToClearData radio button.
+</p><dl>
+<dt><i>on</i></dt>
+<dd>
+toggle state (boolean) (ignored)
+</dd>
+</dl><a NAME="E5MessageBoxWizardDialog.on_rQuestion_toggled" ID="E5MessageBoxWizardDialog.on_rQuestion_toggled"></a>
+<h4>E5MessageBoxWizardDialog.on_rQuestion_toggled</h4>
+<b>on_rQuestion_toggled</b>(<i>checked</i>)
+<p>
+        Private slot to handle the toggled signal of the rQuestion radio button.
+</p><dl>
+<dt><i>on</i></dt>
+<dd>
+toggle state (boolean) (ignored)
+</dd>
+</dl><a NAME="E5MessageBoxWizardDialog.on_rRetryAbort_toggled" ID="E5MessageBoxWizardDialog.on_rRetryAbort_toggled"></a>
+<h4>E5MessageBoxWizardDialog.on_rRetryAbort_toggled</h4>
+<b>on_rRetryAbort_toggled</b>(<i>checked</i>)
+<p>
+        Private slot to handle the toggled signal of the rRetryAbort radio button.
+</p><dl>
+<dt><i>on</i></dt>
+<dd>
+toggle state (boolean) (ignored)
+</dd>
+</dl><a NAME="E5MessageBoxWizardDialog.on_rStandard_toggled" ID="E5MessageBoxWizardDialog.on_rStandard_toggled"></a>
+<h4>E5MessageBoxWizardDialog.on_rStandard_toggled</h4>
+<b>on_rStandard_toggled</b>(<i>checked</i>)
+<p>
+        Private slot to handle the toggled signal of the rStandard radio button.
+</p><dl>
+<dt><i>on</i></dt>
+<dd>
+toggle state (boolean) (ignored)
+</dd>
+</dl><a NAME="E5MessageBoxWizardDialog.on_rWarning_toggled" ID="E5MessageBoxWizardDialog.on_rWarning_toggled"></a>
+<h4>E5MessageBoxWizardDialog.on_rWarning_toggled</h4>
+<b>on_rWarning_toggled</b>(<i>checked</i>)
+<p>
+        Private slot to handle the toggled signal of the rWarning radio button.
+</p><dl>
+<dt><i>on</i></dt>
+<dd>
+toggle state (boolean) (ignored)
+</dd>
+</dl><a NAME="E5MessageBoxWizardDialog.on_rYesNo_toggled" ID="E5MessageBoxWizardDialog.on_rYesNo_toggled"></a>
+<h4>E5MessageBoxWizardDialog.on_rYesNo_toggled</h4>
+<b>on_rYesNo_toggled</b>(<i>checked</i>)
+<p>
+        Private slot to handle the toggled signal of the rYesNo radio button.
+</p><dl>
+<dt><i>on</i></dt>
+<dd>
+toggle state (boolean) (ignored)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial