--- a/eric6/Documentation/Source/eric6.Plugins.WizardPlugins.DotDesktopWizard.DotDesktopWizardDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.WizardPlugins.DotDesktopWizard.DotDesktopWizardDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,178 +18,239 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.WizardPlugins.DotDesktopWizard.DotDesktopWizardDialog</h1> + <p> Module implementing the .desktop wizard dialog. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#DotDesktopWizardDialog">DotDesktopWizardDialog</a></td> <td>Class implementing the .desktop wizard dialog.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="DotDesktopWizardDialog" ID="DotDesktopWizardDialog"></a> <h2>DotDesktopWizardDialog</h2> + <p> Class implementing the .desktop wizard dialog. </p> <h3>Derived from</h3> QDialog, Ui_DotDesktopWizardDialog <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="#DotDesktopWizardDialog.__init__">DotDesktopWizardDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#DotDesktopWizardDialog.__checkOK">__checkOK</a></td> <td>Private slot to check, if the OK button should be enabled.</td> -</tr><tr> +</tr> +<tr> <td><a href="#DotDesktopWizardDialog.getCode">getCode</a></td> <td>Public method to get the source code.</td> -</tr><tr> +</tr> +<tr> <td><a href="#DotDesktopWizardDialog.on_categoriesButton_clicked">on_categoriesButton_clicked</a></td> <td>Private slot to select the categories.</td> -</tr><tr> +</tr> +<tr> <td><a href="#DotDesktopWizardDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> <td>Private slot to check, if the nameEdit field is empty.</td> -</tr><tr> +</tr> +<tr> <td><a href="#DotDesktopWizardDialog.on_notShowButton_clicked">on_notShowButton_clicked</a></td> <td>Private slot to select the NotShowIn environments.</td> -</tr><tr> +</tr> +<tr> <td><a href="#DotDesktopWizardDialog.on_notShowEdit_textChanged">on_notShowEdit_textChanged</a></td> <td>Private slot to check the contents of the notShowEdit field.</td> -</tr><tr> +</tr> +<tr> <td><a href="#DotDesktopWizardDialog.on_onlyShowButton_clicked">on_onlyShowButton_clicked</a></td> <td>Private slot to select the OnlyShowIn environments.</td> -</tr><tr> +</tr> +<tr> <td><a href="#DotDesktopWizardDialog.on_onlyShowEdit_textChanged">on_onlyShowEdit_textChanged</a></td> <td>Private slot to check the contents of the onlyShowEdit field.</td> -</tr><tr> +</tr> +<tr> <td><a href="#DotDesktopWizardDialog.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> +</tr> +<tr> <td><a href="#DotDesktopWizardDialog.on_typeComboBox_currentIndexChanged">on_typeComboBox_currentIndexChanged</a></td> <td>Private slot to handle a change of the .desktop type.</td> -</tr><tr> +</tr> +<tr> <td><a href="#DotDesktopWizardDialog.on_typeEdit_textChanged">on_typeEdit_textChanged</a></td> <td>Private slot to check, if the typeEdit field is empty.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="DotDesktopWizardDialog.__init__" ID="DotDesktopWizardDialog.__init__"></a> <h4>DotDesktopWizardDialog (Constructor)</h4> <b>DotDesktopWizardDialog</b>(<i>parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="DotDesktopWizardDialog.__checkOK" ID="DotDesktopWizardDialog.__checkOK"></a> +</dl> +<a NAME="DotDesktopWizardDialog.__checkOK" ID="DotDesktopWizardDialog.__checkOK"></a> <h4>DotDesktopWizardDialog.__checkOK</h4> <b>__checkOK</b>(<i></i>) + <p> Private slot to check, if the OK button should be enabled. -</p><a NAME="DotDesktopWizardDialog.getCode" ID="DotDesktopWizardDialog.getCode"></a> +</p> +<a NAME="DotDesktopWizardDialog.getCode" ID="DotDesktopWizardDialog.getCode"></a> <h4>DotDesktopWizardDialog.getCode</h4> <b>getCode</b>(<i></i>) + <p> Public method to get the source code. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> generated code (string) </dd> -</dl><a NAME="DotDesktopWizardDialog.on_categoriesButton_clicked" ID="DotDesktopWizardDialog.on_categoriesButton_clicked"></a> +</dl> +<a NAME="DotDesktopWizardDialog.on_categoriesButton_clicked" ID="DotDesktopWizardDialog.on_categoriesButton_clicked"></a> <h4>DotDesktopWizardDialog.on_categoriesButton_clicked</h4> <b>on_categoriesButton_clicked</b>(<i></i>) + <p> Private slot to select the categories. -</p><a NAME="DotDesktopWizardDialog.on_nameEdit_textChanged" ID="DotDesktopWizardDialog.on_nameEdit_textChanged"></a> +</p> +<a NAME="DotDesktopWizardDialog.on_nameEdit_textChanged" ID="DotDesktopWizardDialog.on_nameEdit_textChanged"></a> <h4>DotDesktopWizardDialog.on_nameEdit_textChanged</h4> <b>on_nameEdit_textChanged</b>(<i>txt</i>) + <p> Private slot to check, if the nameEdit field is empty. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the entry field (string) </dd> -</dl><a NAME="DotDesktopWizardDialog.on_notShowButton_clicked" ID="DotDesktopWizardDialog.on_notShowButton_clicked"></a> +</dl> +<a NAME="DotDesktopWizardDialog.on_notShowButton_clicked" ID="DotDesktopWizardDialog.on_notShowButton_clicked"></a> <h4>DotDesktopWizardDialog.on_notShowButton_clicked</h4> <b>on_notShowButton_clicked</b>(<i></i>) + <p> Private slot to select the NotShowIn environments. -</p><a NAME="DotDesktopWizardDialog.on_notShowEdit_textChanged" ID="DotDesktopWizardDialog.on_notShowEdit_textChanged"></a> +</p> +<a NAME="DotDesktopWizardDialog.on_notShowEdit_textChanged" ID="DotDesktopWizardDialog.on_notShowEdit_textChanged"></a> <h4>DotDesktopWizardDialog.on_notShowEdit_textChanged</h4> <b>on_notShowEdit_textChanged</b>(<i>txt</i>) + <p> Private slot to check the contents of the notShowEdit field. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the entry field (string) </dd> -</dl><a NAME="DotDesktopWizardDialog.on_onlyShowButton_clicked" ID="DotDesktopWizardDialog.on_onlyShowButton_clicked"></a> +</dl> +<a NAME="DotDesktopWizardDialog.on_onlyShowButton_clicked" ID="DotDesktopWizardDialog.on_onlyShowButton_clicked"></a> <h4>DotDesktopWizardDialog.on_onlyShowButton_clicked</h4> <b>on_onlyShowButton_clicked</b>(<i></i>) + <p> Private slot to select the OnlyShowIn environments. -</p><a NAME="DotDesktopWizardDialog.on_onlyShowEdit_textChanged" ID="DotDesktopWizardDialog.on_onlyShowEdit_textChanged"></a> +</p> +<a NAME="DotDesktopWizardDialog.on_onlyShowEdit_textChanged" ID="DotDesktopWizardDialog.on_onlyShowEdit_textChanged"></a> <h4>DotDesktopWizardDialog.on_onlyShowEdit_textChanged</h4> <b>on_onlyShowEdit_textChanged</b>(<i>txt</i>) + <p> Private slot to check the contents of the onlyShowEdit field. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the entry field (string) </dd> -</dl><a NAME="DotDesktopWizardDialog.on_projectButton_clicked" ID="DotDesktopWizardDialog.on_projectButton_clicked"></a> +</dl> +<a NAME="DotDesktopWizardDialog.on_projectButton_clicked" ID="DotDesktopWizardDialog.on_projectButton_clicked"></a> <h4>DotDesktopWizardDialog.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="DotDesktopWizardDialog.on_typeComboBox_currentIndexChanged" ID="DotDesktopWizardDialog.on_typeComboBox_currentIndexChanged"></a> +</p> +<a NAME="DotDesktopWizardDialog.on_typeComboBox_currentIndexChanged" ID="DotDesktopWizardDialog.on_typeComboBox_currentIndexChanged"></a> <h4>DotDesktopWizardDialog.on_typeComboBox_currentIndexChanged</h4> <b>on_typeComboBox_currentIndexChanged</b>(<i>index</i>) + <p> Private slot to handle a change of the .desktop type. -</p><dl> +</p> +<dl> + <dt><i>index</i></dt> <dd> index of the selected entry (integer) </dd> -</dl><a NAME="DotDesktopWizardDialog.on_typeEdit_textChanged" ID="DotDesktopWizardDialog.on_typeEdit_textChanged"></a> +</dl> +<a NAME="DotDesktopWizardDialog.on_typeEdit_textChanged" ID="DotDesktopWizardDialog.on_typeEdit_textChanged"></a> <h4>DotDesktopWizardDialog.on_typeEdit_textChanged</h4> <b>on_typeEdit_textChanged</b>(<i>txt</i>) + <p> Private slot to check, if the typeEdit field is empty. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the entry field (string)