diff -r 8cb0dabf852f -r ee1aadab1215 src/eric7/Documentation/Source/eric7.Toolbox.Startup.html --- a/src/eric7/Documentation/Source/eric7.Toolbox.Startup.html Sat Nov 11 10:13:29 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Toolbox.Startup.html Sat Nov 11 12:44:51 2023 +0100 @@ -26,14 +26,14 @@ <table> <tr> +<td><a href="#appStartup">appStartup</a></td> +<td>Module function to start up an application that doesn't need a specialized start up.</td> +</tr> +<tr> <td><a href="#getDefaultIconPaths">getDefaultIconPaths</a></td> <td>Module function to determine the default icon paths.</td> </tr> <tr> -<td><a href="#handleArgs">handleArgs</a></td> -<td>Module function to handle the always present commandline options.</td> -</tr> -<tr> <td><a href="#initializeResourceSearchPath">initializeResourceSearchPath</a></td> <td>Module function to initialize the default mime source factory.</td> </tr> @@ -49,21 +49,71 @@ <td><a href="#setLibraryPaths">setLibraryPaths</a></td> <td>Module function to set the Qt library paths correctly.</td> </tr> -<tr> -<td><a href="#simpleAppStartup">simpleAppStartup</a></td> -<td>Module function to start up an application that doesn't need a specialized start up.</td> -</tr> -<tr> -<td><a href="#usage">usage</a></td> -<td>Module function to show the usage information.</td> -</tr> -<tr> -<td><a href="#version">version</a></td> -<td>Module function to show the version information.</td> -</tr> </table> <hr /> <hr /> +<a NAME="appStartup" ID="appStartup"></a> +<h2>appStartup</h2> +<b>appStartup</b>(<i>args, mwFactory, quitOnLastWindowClosed=True, app=None, raiseIt=True, installErrorHandler=False, </i>) + +<p> + Module function to start up an application that doesn't need a specialized + start up. +</p> +<p> + This function is used by all of eric's helper programs. +</p> +<dl> + +<dt><i>args</i> (argparse.Namespace)</dt> +<dd> +namespace object created by ArgumentParser.parse_args() containing + the parsed command line arguments +</dd> +<dt><i>mwFactory</i></dt> +<dd> +factory function generating the main widget. This + function must accept the following parameter. + <dl> + <dt>args</dt> + <dd>parsed command line arguments (argparse.Namespace)</dd> + </dl> +</dd> +<dt><i>quitOnLastWindowClosed</i> (bool)</dt> +<dd> +flag indicating to quit the application, + if the last window was closed +</dd> +<dt><i>app</i> (QApplication or None)</dt> +<dd> +reference to the application object +</dd> +<dt><i>raiseIt</i> (bool)</dt> +<dd> +flag indicating to raise the generated application + window +</dd> +<dt><i>installErrorHandler</i> (bool)</dt> +<dd> +flag indicating to install an error + handler dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +exit result +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> <a NAME="getDefaultIconPaths" ID="getDefaultIconPaths"></a> <h2>getDefaultIconPaths</h2> <b>getDefaultIconPaths</b>(<i>application</i>) @@ -93,35 +143,6 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> -<a NAME="handleArgs" ID="handleArgs"></a> -<h2>handleArgs</h2> -<b>handleArgs</b>(<i>argv, appinfo</i>) - -<p> - Module function to handle the always present commandline options. -</p> -<dl> - -<dt><i>argv</i></dt> -<dd> -list of commandline parameters (list of strings) -</dd> -<dt><i>appinfo</i></dt> -<dd> -dictionary describing the application -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -index of the '--' option (integer). This is used to tell - the application, that all additional options don't belong to - the application. -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> <a NAME="initializeResourceSearchPath" ID="initializeResourceSearchPath"></a> <h2>initializeResourceSearchPath</h2> <b>initializeResourceSearchPath</b>(<i>application</i>) @@ -148,20 +169,25 @@ </p> <dl> -<dt><i>dirs</i></dt> +<dt><i>dirs</i> (list of str)</dt> <dd> -Searchpath for the translations. (list of strings) +searchpath for the translations </dd> -<dt><i>tn</i></dt> +<dt><i>tn</i> (str)</dt> <dd> -The translation to be loaded. (string) +translation to be loaded </dd> </dl> <dl> <dt>Return:</dt> <dd> -Tuple of a status flag and the loaded translator - (int, QTranslator) +tuple containing a status flag and the loaded translator +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, QTranslator) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -176,24 +202,30 @@ </p> <dl> -<dt><i>qtTransDir</i></dt> +<dt><i>qtTransDir</i> (str)</dt> <dd> -directory of the Qt translations files (string) +directory of the Qt translations files </dd> -<dt><i>app</i></dt> +<dt><i>app</i> (QApplication)</dt> <dd> -reference to the application object (QApplication) +reference to the application object </dd> -<dt><i>translationFiles</i></dt> +<dt><i>translationFiles</i> (tuple of str)</dt> <dd> tuple of additional translations to - be loaded (tuple of strings) + be loaded </dd> </dl> <dl> <dt>Return:</dt> <dd> -the requested locale (string) +the requested locale +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -208,101 +240,4 @@ </p> <div align="right"><a href="#top">Up</a></div> <hr /> -<hr /> -<a NAME="simpleAppStartup" ID="simpleAppStartup"></a> -<h2>simpleAppStartup</h2> -<b>simpleAppStartup</b>(<i>argv, appinfo, mwFactory, quitOnLastWindowClosed=True, app=None, raiseIt=True, installErrorHandler=False, </i>) - -<p> - Module function to start up an application that doesn't need a specialized - start up. -</p> -<p> - This function is used by all of eric's helper programs. -</p> -<dl> - -<dt><i>argv</i></dt> -<dd> -list of commandline parameters (list of strings) -</dd> -<dt><i>appinfo</i></dt> -<dd> -dictionary describing the application -</dd> -<dt><i>mwFactory</i></dt> -<dd> -factory function generating the main widget. This - function must accept the following parameter. - <dl> - <dt>argv</dt> - <dd>list of commandline parameters (list of strings)</dd> - </dl> -</dd> -<dt><i>quitOnLastWindowClosed</i></dt> -<dd> -flag indicating to quit the application, - if the last window was closed (boolean) -</dd> -<dt><i>app</i></dt> -<dd> -reference to the application object (QApplication or None) -</dd> -<dt><i>raiseIt</i></dt> -<dd> -flag indicating to raise the generated application - window (boolean) -</dd> -<dt><i>installErrorHandler</i></dt> -<dd> -flag indicating to install an error - handler dialog (boolean) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -exit result (integer) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="usage" ID="usage"></a> -<h2>usage</h2> -<b>usage</b>(<i>appinfo, optlen=12</i>) - -<p> - Module function to show the usage information. -</p> -<dl> - -<dt><i>appinfo</i></dt> -<dd> -dictionary describing the application -</dd> -<dt><i>optlen</i></dt> -<dd> -length of the field for the commandline option (integer) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="version" ID="version"></a> -<h2>version</h2> -<b>version</b>(<i>appinfo</i>) - -<p> - Module function to show the version information. -</p> -<dl> - -<dt><i>appinfo</i></dt> -<dd> -dictionary describing the application -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> </body></html> \ No newline at end of file