src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.EricMessageBoxWizard.EricMessageBoxWizardDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.EricMessageBoxWizard.EricMessageBoxWizardDialog.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,417 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Plugins.WizardPlugins.EricMessageBoxWizard.EricMessageBoxWizardDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Plugins.WizardPlugins.EricMessageBoxWizard.EricMessageBoxWizardDialog</h1>
+
+<p>
+Module implementing the eric message box wizard dialog.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#EricMessageBoxWizardDialog">EricMessageBoxWizardDialog</a></td>
+<td>Class implementing the eric message box wizard dialog.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="EricMessageBoxWizardDialog" ID="EricMessageBoxWizardDialog"></a>
+<h2>EricMessageBoxWizardDialog</h2>
+
+<p>
+    Class implementing the eric message box wizard dialog.
+</p>
+<p>
+    It displays a dialog for entering the parameters
+    for the EricMessageBox code generator.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_EricMessageBoxWizardDialog
+<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="#EricMessageBoxWizardDialog.__init__">EricMessageBoxWizardDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#EricMessageBoxWizardDialog.__enabledGroups">__enabledGroups</a></td>
+<td>Private method to enable/disable some group boxes.</td>
+</tr>
+<tr>
+<td><a href="#EricMessageBoxWizardDialog.__getDefaultButtonCode">__getDefaultButtonCode</a></td>
+<td>Private method to generate the button code for the default button.</td>
+</tr>
+<tr>
+<td><a href="#EricMessageBoxWizardDialog.__getStandardButtonCode">__getStandardButtonCode</a></td>
+<td>Private method to generate the button code for the standard buttons.</td>
+</tr>
+<tr>
+<td><a href="#EricMessageBoxWizardDialog.getCode">getCode</a></td>
+<td>Public method to get the source code.</td>
+</tr>
+<tr>
+<td><a href="#EricMessageBoxWizardDialog.on_bTest_clicked">on_bTest_clicked</a></td>
+<td>Private method to test the selected options.</td>
+</tr>
+<tr>
+<td><a href="#EricMessageBoxWizardDialog.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="#EricMessageBoxWizardDialog.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="#EricMessageBoxWizardDialog.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="#EricMessageBoxWizardDialog.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="#EricMessageBoxWizardDialog.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="#EricMessageBoxWizardDialog.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="#EricMessageBoxWizardDialog.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="#EricMessageBoxWizardDialog.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="#EricMessageBoxWizardDialog.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="#EricMessageBoxWizardDialog.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="#EricMessageBoxWizardDialog.on_rYesNo_toggled">on_rYesNo_toggled</a></td>
+<td>Private slot to handle the toggled signal of the rYesNo radio button.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="EricMessageBoxWizardDialog.__init__" ID="EricMessageBoxWizardDialog.__init__"></a>
+<h4>EricMessageBoxWizardDialog (Constructor)</h4>
+<b>EricMessageBoxWizardDialog</b>(<i>parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl>
+<a NAME="EricMessageBoxWizardDialog.__enabledGroups" ID="EricMessageBoxWizardDialog.__enabledGroups"></a>
+<h4>EricMessageBoxWizardDialog.__enabledGroups</h4>
+<b>__enabledGroups</b>(<i></i>)
+
+<p>
+        Private method to enable/disable some group boxes.
+</p>
+<a NAME="EricMessageBoxWizardDialog.__getDefaultButtonCode" ID="EricMessageBoxWizardDialog.__getDefaultButtonCode"></a>
+<h4>EricMessageBoxWizardDialog.__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> (str)</dt>
+<dd>
+indentation string
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+the button code
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="EricMessageBoxWizardDialog.__getStandardButtonCode" ID="EricMessageBoxWizardDialog.__getStandardButtonCode"></a>
+<h4>EricMessageBoxWizardDialog.__getStandardButtonCode</h4>
+<b>__getStandardButtonCode</b>(<i>istring, withIntro=True</i>)
+
+<p>
+        Private method to generate the button code for the standard buttons.
+</p>
+<dl>
+
+<dt><i>istring</i> (str)</dt>
+<dd>
+indentation string
+</dd>
+<dt><i>withIntro</i> (bool)</dt>
+<dd>
+flag indicating to generate a first line
+            with introductory text
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+the button code
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="EricMessageBoxWizardDialog.getCode" ID="EricMessageBoxWizardDialog.getCode"></a>
+<h4>EricMessageBoxWizardDialog.getCode</h4>
+<b>getCode</b>(<i>indLevel, indString</i>)
+
+<p>
+        Public method to get the source code.
+</p>
+<dl>
+
+<dt><i>indLevel</i> (int)</dt>
+<dd>
+indentation level
+</dd>
+<dt><i>indString</i> (str)</dt>
+<dd>
+string used for indentation (space or tab)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+generated code
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="EricMessageBoxWizardDialog.on_bTest_clicked" ID="EricMessageBoxWizardDialog.on_bTest_clicked"></a>
+<h4>EricMessageBoxWizardDialog.on_bTest_clicked</h4>
+<b>on_bTest_clicked</b>(<i></i>)
+
+<p>
+        Private method to test the selected options.
+</p>
+<a NAME="EricMessageBoxWizardDialog.on_buttonBox_clicked" ID="EricMessageBoxWizardDialog.on_buttonBox_clicked"></a>
+<h4>EricMessageBoxWizardDialog.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> (QAbstractButton)</dt>
+<dd>
+button that was clicked
+</dd>
+</dl>
+<a NAME="EricMessageBoxWizardDialog.on_rAboutQt_toggled" ID="EricMessageBoxWizardDialog.on_rAboutQt_toggled"></a>
+<h4>EricMessageBoxWizardDialog.on_rAboutQt_toggled</h4>
+<b>on_rAboutQt_toggled</b>(<i>on</i>)
+
+<p>
+        Private slot to handle the toggled signal of the rAboutQt
+        radio button.
+</p>
+<dl>
+
+<dt><i>on</i> (bool)</dt>
+<dd>
+toggle state (ignored)
+</dd>
+</dl>
+<a NAME="EricMessageBoxWizardDialog.on_rAbout_toggled" ID="EricMessageBoxWizardDialog.on_rAbout_toggled"></a>
+<h4>EricMessageBoxWizardDialog.on_rAbout_toggled</h4>
+<b>on_rAbout_toggled</b>(<i>on</i>)
+
+<p>
+        Private slot to handle the toggled signal of the rAbout
+        radio button.
+</p>
+<dl>
+
+<dt><i>on</i> (bool)</dt>
+<dd>
+toggle state (ignored)
+</dd>
+</dl>
+<a NAME="EricMessageBoxWizardDialog.on_rCritical_toggled" ID="EricMessageBoxWizardDialog.on_rCritical_toggled"></a>
+<h4>EricMessageBoxWizardDialog.on_rCritical_toggled</h4>
+<b>on_rCritical_toggled</b>(<i>on</i>)
+
+<p>
+        Private slot to handle the toggled signal of the rCritical
+        radio button.
+</p>
+<dl>
+
+<dt><i>on</i> (bool)</dt>
+<dd>
+toggle state (ignored)
+</dd>
+</dl>
+<a NAME="EricMessageBoxWizardDialog.on_rInformation_toggled" ID="EricMessageBoxWizardDialog.on_rInformation_toggled"></a>
+<h4>EricMessageBoxWizardDialog.on_rInformation_toggled</h4>
+<b>on_rInformation_toggled</b>(<i>on</i>)
+
+<p>
+        Private slot to handle the toggled signal of the rInformation
+        radio button.
+</p>
+<dl>
+
+<dt><i>on</i> (bool)</dt>
+<dd>
+toggle state (ignored)
+</dd>
+</dl>
+<a NAME="EricMessageBoxWizardDialog.on_rOkToClearData_toggled" ID="EricMessageBoxWizardDialog.on_rOkToClearData_toggled"></a>
+<h4>EricMessageBoxWizardDialog.on_rOkToClearData_toggled</h4>
+<b>on_rOkToClearData_toggled</b>(<i>on</i>)
+
+<p>
+        Private slot to handle the toggled signal of the rOkToClearData
+        radio button.
+</p>
+<dl>
+
+<dt><i>on</i> (bool)</dt>
+<dd>
+toggle state (ignored)
+</dd>
+</dl>
+<a NAME="EricMessageBoxWizardDialog.on_rQuestion_toggled" ID="EricMessageBoxWizardDialog.on_rQuestion_toggled"></a>
+<h4>EricMessageBoxWizardDialog.on_rQuestion_toggled</h4>
+<b>on_rQuestion_toggled</b>(<i>on</i>)
+
+<p>
+        Private slot to handle the toggled signal of the rQuestion
+        radio button.
+</p>
+<dl>
+
+<dt><i>on</i> (bool)</dt>
+<dd>
+toggle state (ignored)
+</dd>
+</dl>
+<a NAME="EricMessageBoxWizardDialog.on_rRetryAbort_toggled" ID="EricMessageBoxWizardDialog.on_rRetryAbort_toggled"></a>
+<h4>EricMessageBoxWizardDialog.on_rRetryAbort_toggled</h4>
+<b>on_rRetryAbort_toggled</b>(<i>on</i>)
+
+<p>
+        Private slot to handle the toggled signal of the rRetryAbort
+        radio button.
+</p>
+<dl>
+
+<dt><i>on</i> (bool)</dt>
+<dd>
+toggle state (ignored)
+</dd>
+</dl>
+<a NAME="EricMessageBoxWizardDialog.on_rStandard_toggled" ID="EricMessageBoxWizardDialog.on_rStandard_toggled"></a>
+<h4>EricMessageBoxWizardDialog.on_rStandard_toggled</h4>
+<b>on_rStandard_toggled</b>(<i>on</i>)
+
+<p>
+        Private slot to handle the toggled signal of the rStandard
+        radio button.
+</p>
+<dl>
+
+<dt><i>on</i> (bool)</dt>
+<dd>
+toggle state (ignored)
+</dd>
+</dl>
+<a NAME="EricMessageBoxWizardDialog.on_rWarning_toggled" ID="EricMessageBoxWizardDialog.on_rWarning_toggled"></a>
+<h4>EricMessageBoxWizardDialog.on_rWarning_toggled</h4>
+<b>on_rWarning_toggled</b>(<i>on</i>)
+
+<p>
+        Private slot to handle the toggled signal of the rWarning
+        radio button.
+</p>
+<dl>
+
+<dt><i>on</i> (bool)</dt>
+<dd>
+toggle state (ignored)
+</dd>
+</dl>
+<a NAME="EricMessageBoxWizardDialog.on_rYesNo_toggled" ID="EricMessageBoxWizardDialog.on_rYesNo_toggled"></a>
+<h4>EricMessageBoxWizardDialog.on_rYesNo_toggled</h4>
+<b>on_rYesNo_toggled</b>(<i>on</i>)
+
+<p>
+        Private slot to handle the toggled signal of the rYesNo
+        radio button.
+</p>
+<dl>
+
+<dt><i>on</i> (bool)</dt>
+<dd>
+toggle state (ignored)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial