--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric6.Plugins.WizardPlugins.EricPluginWizard.PluginWizardDialog.html Sun Dec 10 13:55:30 2017 +0100 @@ -0,0 +1,137 @@ +<!DOCTYPE html> +<html><head> +<title>eric6.Plugins.WizardPlugins.EricPluginWizard.PluginWizardDialog</title> +<meta charset="UTF-8"> +<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>eric6.Plugins.WizardPlugins.EricPluginWizard.PluginWizardDialog</h1> +<p> +Module implementing the eric plug-in wizard dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#PluginWizardDialog">PluginWizardDialog</a></td> +<td>Class implementing the eric plug-in wizard dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="PluginWizardDialog" ID="PluginWizardDialog"></a> +<h2>PluginWizardDialog</h2> +<p> + Class implementing the eric plug-in wizard dialog. +</p> +<h3>Derived from</h3> +QDialog, Ui_PluginWizardDialog +<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="#PluginWizardDialog.__init__">PluginWizardDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#PluginWizardDialog.__enableOkButton">__enableOkButton</a></td> +<td>Private slot to set the state of the OK button.</td> +</tr><tr> +<td><a href="#PluginWizardDialog.getCode">getCode</a></td> +<td>Public method to get the source code.</td> +</tr><tr> +<td><a href="#PluginWizardDialog.on_pluginTypeCombo_currentTextChanged">on_pluginTypeCombo_currentTextChanged</a></td> +<td>Private slot to react upon the selection of a plug-in type.</td> +</tr><tr> +<td><a href="#PluginWizardDialog.on_projectButton_clicked">on_projectButton_clicked</a></td> +<td>Private slot to populate some fields with data retrieved from the current project.</td> +</tr><tr> +<td><a href="#PluginWizardDialog.packageName">packageName</a></td> +<td>Public method to retrieve the plug-in package name.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="PluginWizardDialog.__init__" ID="PluginWizardDialog.__init__"></a> +<h4>PluginWizardDialog (Constructor)</h4> +<b>PluginWizardDialog</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="PluginWizardDialog.__enableOkButton" ID="PluginWizardDialog.__enableOkButton"></a> +<h4>PluginWizardDialog.__enableOkButton</h4> +<b>__enableOkButton</b>(<i></i>) +<p> + Private slot to set the state of the OK button. +</p><a NAME="PluginWizardDialog.getCode" ID="PluginWizardDialog.getCode"></a> +<h4>PluginWizardDialog.getCode</h4> +<b>getCode</b>(<i></i>) +<p> + Public method to get the source code. +</p><dl> +<dt>Returns:</dt> +<dd> +generated code (string) +</dd> +</dl><a NAME="PluginWizardDialog.on_pluginTypeCombo_currentTextChanged" ID="PluginWizardDialog.on_pluginTypeCombo_currentTextChanged"></a> +<h4>PluginWizardDialog.on_pluginTypeCombo_currentTextChanged</h4> +<b>on_pluginTypeCombo_currentTextChanged</b>(<i>txt</i>) +<p> + Private slot to react upon the selection of a plug-in type. +</p><dl> +<dt><i>txt</i></dt> +<dd> +selected plug-in type (string) +</dd> +</dl><a NAME="PluginWizardDialog.on_projectButton_clicked" ID="PluginWizardDialog.on_projectButton_clicked"></a> +<h4>PluginWizardDialog.on_projectButton_clicked</h4> +<b>on_projectButton_clicked</b>(<i></i>) +<p> + Private slot to populate some fields with data retrieved from the + current project. +</p><a NAME="PluginWizardDialog.packageName" ID="PluginWizardDialog.packageName"></a> +<h4>PluginWizardDialog.packageName</h4> +<b>packageName</b>(<i></i>) +<p> + Public method to retrieve the plug-in package name. +</p><dl> +<dt>Returns:</dt> +<dd> +plug-in package name (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file