src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.SetupWizard.AddEntryPointDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.WizardPlugins.SetupWizard.AddEntryPointDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.WizardPlugins.SetupWizard.AddEntryPointDialog</h1>

<p>
Module implementing a dialog to enter the data for an entry point.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#AddEntryPointDialog">AddEntryPointDialog</a></td>
<td>Class implementing a dialog to enter the data for an entry point.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="AddEntryPointDialog" ID="AddEntryPointDialog"></a>
<h2>AddEntryPointDialog</h2>

<p>
    Class implementing a dialog to enter the data for an entry point.
</p>
<h3>Derived from</h3>
QDialog, Ui_AddEntryPointDialog
<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="#AddEntryPointDialog.__init__">AddEntryPointDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#AddEntryPointDialog.__updateOK">__updateOK</a></td>
<td>Private slot to update the enabled state of the OK button.</td>
</tr>
<tr>
<td><a href="#AddEntryPointDialog.getEntryPoint">getEntryPoint</a></td>
<td>Public method to get the data for the entry point.</td>
</tr>
<tr>
<td><a href="#AddEntryPointDialog.on_scriptButton_clicked">on_scriptButton_clicked</a></td>
<td>Private slot to select a script via a file selection dialog.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="AddEntryPointDialog.__init__" ID="AddEntryPointDialog.__init__"></a>
<h4>AddEntryPointDialog (Constructor)</h4>
<b>AddEntryPointDialog</b>(<i>rootDirectory, epType="", name="", script="", parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>rootDirectory</i> (str)</dt>
<dd>
root directory for selecting script modules via
            a file selection dialog
</dd>
<dt><i>epType</i> (str (optional))</dt>
<dd>
type of the entry point (defaults to "")
</dd>
<dt><i>name</i> (str (optional))</dt>
<dd>
name of the entry point (defaults to "")
</dd>
<dt><i>script</i> (str (optional))</dt>
<dd>
script function of the entry point (defaults to "")
</dd>
<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="AddEntryPointDialog.__updateOK" ID="AddEntryPointDialog.__updateOK"></a>
<h4>AddEntryPointDialog.__updateOK</h4>
<b>__updateOK</b>(<i></i>)

<p>
        Private slot to update the enabled state of the OK button.
</p>
<a NAME="AddEntryPointDialog.getEntryPoint" ID="AddEntryPointDialog.getEntryPoint"></a>
<h4>AddEntryPointDialog.getEntryPoint</h4>
<b>getEntryPoint</b>(<i></i>)

<p>
        Public method to get the data for the entry point.
</p>
<dl>
<dt>Return:</dt>
<dd>
tuple containing the entry point type, category, name and
            script function
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, str, str)
</dd>
</dl>
<a NAME="AddEntryPointDialog.on_scriptButton_clicked" ID="AddEntryPointDialog.on_scriptButton_clicked"></a>
<h4>AddEntryPointDialog.on_scriptButton_clicked</h4>
<b>on_scriptButton_clicked</b>(<i></i>)

<p>
        Private slot to select a script via a file selection dialog.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>