--- a/eric6/Documentation/Source/eric6.Plugins.PluginWizardQFileDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.PluginWizardQFileDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,155 +18,205 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.PluginWizardQFileDialog</h1> + <p> Module implementing the QFileDialog wizard plugin. </p> <h3>Global Attributes</h3> + <table> <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#FileDialogWizard">FileDialogWizard</a></td> <td>Class implementing the QFileDialog wizard plugin.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="FileDialogWizard" ID="FileDialogWizard"></a> <h2>FileDialogWizard</h2> + <p> Class implementing the QFileDialog wizard plugin. </p> <h3>Derived from</h3> QObject <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="#FileDialogWizard.__init__">FileDialogWizard</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizard.__callForm">__callForm</a></td> <td>Private method to display a dialog and get the code.</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizard.__handle">__handle</a></td> <td>Private method to handle the wizards action.</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizard.__handleE5FileDialog">__handleE5FileDialog</a></td> <td>Private slot to handle the wizard E5FileDialog action.</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizard.__handleQFileDialog">__handleQFileDialog</a></td> <td>Private slot to handle the wizard QFileDialog action.</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizard.__initActions">__initActions</a></td> <td>Private method to initialize the actions.</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizard.__initMenu">__initMenu</a></td> <td>Private method to add the actions to the right menu.</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizard.activate">activate</a></td> <td>Public method to activate this plugin.</td> -</tr><tr> +</tr> +<tr> <td><a href="#FileDialogWizard.deactivate">deactivate</a></td> <td>Public method to deactivate this plugin.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="FileDialogWizard.__init__" ID="FileDialogWizard.__init__"></a> <h4>FileDialogWizard (Constructor)</h4> <b>FileDialogWizard</b>(<i>ui</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>ui</i></dt> <dd> reference to the user interface object (UI.UserInterface) </dd> -</dl><a NAME="FileDialogWizard.__callForm" ID="FileDialogWizard.__callForm"></a> +</dl> +<a NAME="FileDialogWizard.__callForm" ID="FileDialogWizard.__callForm"></a> <h4>FileDialogWizard.__callForm</h4> <b>__callForm</b>(<i>editor, variant</i>) + <p> Private method to display a dialog and get the code. -</p><dl> +</p> +<dl> + <dt><i>editor</i> (Editor)</dt> <dd> reference to the current editor -</dd><dt><i>variant</i> (int)</dt> +</dd> +<dt><i>variant</i> (int)</dt> <dd> variant of code to be generated (-1 = E5FileDialog, 0 = unknown, 4 = PyQt4, 5 = PyQt5) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> the generated code (string) </dd> -</dl><a NAME="FileDialogWizard.__handle" ID="FileDialogWizard.__handle"></a> +</dl> +<a NAME="FileDialogWizard.__handle" ID="FileDialogWizard.__handle"></a> <h4>FileDialogWizard.__handle</h4> <b>__handle</b>(<i>variant</i>) + <p> Private method to handle the wizards action. -</p><dl> +</p> +<dl> + <dt><i>variant</i> (str)</dt> <dd> dialog variant to be generated (E5FileDialog or QFileDialog) </dd> -</dl><dl> +</dl> +<dl> + <dt>Raises <b>ValueError</b>:</dt> <dd> raised to indicate an illegal file dialog variant </dd> -</dl><a NAME="FileDialogWizard.__handleE5FileDialog" ID="FileDialogWizard.__handleE5FileDialog"></a> +</dl> +<a NAME="FileDialogWizard.__handleE5FileDialog" ID="FileDialogWizard.__handleE5FileDialog"></a> <h4>FileDialogWizard.__handleE5FileDialog</h4> <b>__handleE5FileDialog</b>(<i></i>) + <p> Private slot to handle the wizard E5FileDialog action. -</p><a NAME="FileDialogWizard.__handleQFileDialog" ID="FileDialogWizard.__handleQFileDialog"></a> +</p> +<a NAME="FileDialogWizard.__handleQFileDialog" ID="FileDialogWizard.__handleQFileDialog"></a> <h4>FileDialogWizard.__handleQFileDialog</h4> <b>__handleQFileDialog</b>(<i></i>) + <p> Private slot to handle the wizard QFileDialog action. -</p><a NAME="FileDialogWizard.__initActions" ID="FileDialogWizard.__initActions"></a> +</p> +<a NAME="FileDialogWizard.__initActions" ID="FileDialogWizard.__initActions"></a> <h4>FileDialogWizard.__initActions</h4> <b>__initActions</b>(<i></i>) + <p> Private method to initialize the actions. -</p><a NAME="FileDialogWizard.__initMenu" ID="FileDialogWizard.__initMenu"></a> +</p> +<a NAME="FileDialogWizard.__initMenu" ID="FileDialogWizard.__initMenu"></a> <h4>FileDialogWizard.__initMenu</h4> <b>__initMenu</b>(<i></i>) + <p> Private method to add the actions to the right menu. -</p><a NAME="FileDialogWizard.activate" ID="FileDialogWizard.activate"></a> +</p> +<a NAME="FileDialogWizard.activate" ID="FileDialogWizard.activate"></a> <h4>FileDialogWizard.activate</h4> <b>activate</b>(<i></i>) + <p> Public method to activate this plugin. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple of None and activation status (boolean) </dd> -</dl><a NAME="FileDialogWizard.deactivate" ID="FileDialogWizard.deactivate"></a> +</dl> +<a NAME="FileDialogWizard.deactivate" ID="FileDialogWizard.deactivate"></a> <h4>FileDialogWizard.deactivate</h4> <b>deactivate</b>(<i></i>) + <p> Public method to deactivate this plugin. </p>