--- a/eric6/Documentation/Source/eric6.Plugins.WizardPlugins.FileDialogWizard.FileDialogWizardDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.WizardPlugins.FileDialogWizard.FileDialogWizardDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,187 +18,248 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.WizardPlugins.FileDialogWizard.FileDialogWizardDialog</h1> + <p> Module implementing the file dialog wizard dialog. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#FileDialogWizardDialog">FileDialogWizardDialog</a></td> <td>Class implementing the color dialog wizard dialog.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="FileDialogWizardDialog" ID="FileDialogWizardDialog"></a> <h2>FileDialogWizardDialog</h2> + <p> Class implementing the color dialog wizard dialog. -</p><p> +</p> +<p> It displays a dialog for entering the parameters for the E5FileDialog or QFileDialog code generator. </p> <h3>Derived from</h3> QDialog, Ui_FileDialogWizardDialog <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="#FileDialogWizardDialog.__init__">FileDialogWizardDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizardDialog.__adjustOptions">__adjustOptions</a></td> <td>Private method to adjust the file dialog options.</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizardDialog.__prepareSchemesList">__prepareSchemesList</a></td> <td>Private method to prepare the list of supported schemes.</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizardDialog.__toggleConfirmCheckBox">__toggleConfirmCheckBox</a></td> <td>Private slot to enable/disable the confirmation check box.</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizardDialog.__toggleGroupsAndTest">__toggleGroupsAndTest</a></td> <td>Private slot to enable/disable certain groups and the test button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizardDialog.__toggleInitialFilterAndResult">__toggleInitialFilterAndResult</a></td> <td>Private slot to enable/disable the initial filter elements and the results entries.</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizardDialog.getCode">getCode</a></td> <td>Public method to get the source code for Qt4 and Qt5.</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizardDialog.on_bTest_clicked">on_bTest_clicked</a></td> <td>Private method to test the selected options.</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizardDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> <td>Private slot called by a button of the button box clicked.</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizardDialog.on_pyqtComboBox_currentIndexChanged">on_pyqtComboBox_currentIndexChanged</a></td> <td>Private slot to setup the dialog for the selected PyQt variant.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="FileDialogWizardDialog.__init__" ID="FileDialogWizardDialog.__init__"></a> <h4>FileDialogWizardDialog (Constructor)</h4> <b>FileDialogWizardDialog</b>(<i>dialogVariant, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>dialogVariant</i> (int)</dt> <dd> variant of the file dialog to be generated (-1 = E5FileDialog, 0 = unknown, 4 = PyQt4, 5 = PyQt5) -</dd><dt><i>parent</i> (QWidget)</dt> +</dd> +<dt><i>parent</i> (QWidget)</dt> <dd> parent widget </dd> -</dl><a NAME="FileDialogWizardDialog.__adjustOptions" ID="FileDialogWizardDialog.__adjustOptions"></a> +</dl> +<a NAME="FileDialogWizardDialog.__adjustOptions" ID="FileDialogWizardDialog.__adjustOptions"></a> <h4>FileDialogWizardDialog.__adjustOptions</h4> <b>__adjustOptions</b>(<i>options</i>) + <p> Private method to adjust the file dialog options. -</p><dl> +</p> +<dl> + <dt><i>options</i></dt> <dd> file dialog options (QFileDialog.Options) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> modified options (QFileDialog.Options) </dd> -</dl><a NAME="FileDialogWizardDialog.__prepareSchemesList" ID="FileDialogWizardDialog.__prepareSchemesList"></a> +</dl> +<a NAME="FileDialogWizardDialog.__prepareSchemesList" ID="FileDialogWizardDialog.__prepareSchemesList"></a> <h4>FileDialogWizardDialog.__prepareSchemesList</h4> <b>__prepareSchemesList</b>(<i></i>) + <p> Private method to prepare the list of supported schemes. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> string representation of the supported schemes </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> str </dd> -</dl><a NAME="FileDialogWizardDialog.__toggleConfirmCheckBox" ID="FileDialogWizardDialog.__toggleConfirmCheckBox"></a> +</dl> +<a NAME="FileDialogWizardDialog.__toggleConfirmCheckBox" ID="FileDialogWizardDialog.__toggleConfirmCheckBox"></a> <h4>FileDialogWizardDialog.__toggleConfirmCheckBox</h4> <b>__toggleConfirmCheckBox</b>(<i></i>) + <p> Private slot to enable/disable the confirmation check box. -</p><a NAME="FileDialogWizardDialog.__toggleGroupsAndTest" ID="FileDialogWizardDialog.__toggleGroupsAndTest"></a> +</p> +<a NAME="FileDialogWizardDialog.__toggleGroupsAndTest" ID="FileDialogWizardDialog.__toggleGroupsAndTest"></a> <h4>FileDialogWizardDialog.__toggleGroupsAndTest</h4> <b>__toggleGroupsAndTest</b>(<i></i>) + <p> Private slot to enable/disable certain groups and the test button. -</p><a NAME="FileDialogWizardDialog.__toggleInitialFilterAndResult" ID="FileDialogWizardDialog.__toggleInitialFilterAndResult"></a> +</p> +<a NAME="FileDialogWizardDialog.__toggleInitialFilterAndResult" ID="FileDialogWizardDialog.__toggleInitialFilterAndResult"></a> <h4>FileDialogWizardDialog.__toggleInitialFilterAndResult</h4> <b>__toggleInitialFilterAndResult</b>(<i>checkedId</i>) + <p> Private slot to enable/disable the initial filter elements and the results entries. -</p><dl> +</p> +<dl> + <dt><i>checkedId</i></dt> <dd> id of the clicked button (integer) </dd> -</dl><a NAME="FileDialogWizardDialog.getCode" ID="FileDialogWizardDialog.getCode"></a> +</dl> +<a NAME="FileDialogWizardDialog.getCode" ID="FileDialogWizardDialog.getCode"></a> <h4>FileDialogWizardDialog.getCode</h4> <b>getCode</b>(<i>indLevel, indString</i>) + <p> Public method to get the source code for Qt4 and Qt5. -</p><dl> +</p> +<dl> + <dt><i>indLevel</i></dt> <dd> indentation level (int) -</dd><dt><i>indString</i></dt> +</dd> +<dt><i>indString</i></dt> <dd> string used for indentation (space or tab) (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> generated code (string) </dd> -</dl><a NAME="FileDialogWizardDialog.on_bTest_clicked" ID="FileDialogWizardDialog.on_bTest_clicked"></a> +</dl> +<a NAME="FileDialogWizardDialog.on_bTest_clicked" ID="FileDialogWizardDialog.on_bTest_clicked"></a> <h4>FileDialogWizardDialog.on_bTest_clicked</h4> <b>on_bTest_clicked</b>(<i></i>) + <p> Private method to test the selected options. -</p><a NAME="FileDialogWizardDialog.on_buttonBox_clicked" ID="FileDialogWizardDialog.on_buttonBox_clicked"></a> +</p> +<a NAME="FileDialogWizardDialog.on_buttonBox_clicked" ID="FileDialogWizardDialog.on_buttonBox_clicked"></a> <h4>FileDialogWizardDialog.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> +</p> +<dl> + <dt><i>button</i></dt> <dd> button that was clicked (QAbstractButton) </dd> -</dl><a NAME="FileDialogWizardDialog.on_pyqtComboBox_currentIndexChanged" ID="FileDialogWizardDialog.on_pyqtComboBox_currentIndexChanged"></a> +</dl> +<a NAME="FileDialogWizardDialog.on_pyqtComboBox_currentIndexChanged" ID="FileDialogWizardDialog.on_pyqtComboBox_currentIndexChanged"></a> <h4>FileDialogWizardDialog.on_pyqtComboBox_currentIndexChanged</h4> <b>on_pyqtComboBox_currentIndexChanged</b>(<i>txt</i>) + <p> Private slot to setup the dialog for the selected PyQt variant. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text of the selected combo box entry (string)