--- a/eric6/Documentation/Source/eric6.Toolbox.Startup.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Toolbox.Startup.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,62 +18,81 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Toolbox.Startup</h1> + <p> Module implementing some startup helper funcions. </p> <h3>Global Attributes</h3> + <table> <tr><td>application</td></tr><tr><td>loaded_translators</td></tr> </table> <h3>Classes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Functions</h3> + <table> + <tr> <td><a href="#handleArgs">handleArgs</a></td> <td>Module function to handle the always present commandline options.</td> -</tr><tr> +</tr> +<tr> <td><a href="#initializeResourceSearchPath">initializeResourceSearchPath</a></td> <td>Module function to initialize the default mime source factory.</td> -</tr><tr> +</tr> +<tr> <td><a href="#loadTranslatorForLocale">loadTranslatorForLocale</a></td> <td>Module function to find and load a specific translation.</td> -</tr><tr> +</tr> +<tr> <td><a href="#loadTranslators">loadTranslators</a></td> <td>Module function to load all required translations.</td> -</tr><tr> +</tr> +<tr> <td><a href="#setLibraryPaths">setLibraryPaths</a></td> <td>Module function to set the Qt library paths correctly for windows systems.</td> -</tr><tr> +</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> +</tr> +<tr> <td><a href="#usage">usage</a></td> <td>Module function to show the usage information.</td> -</tr><tr> +</tr> +<tr> <td><a href="#version">version</a></td> <td>Module function to show the version information.</td> </tr> </table> -<hr /><hr /> +<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> +</p> +<dl> + <dt><i>argv</i></dt> <dd> list of commandline parameters (list of strings) -</dd><dt><i>appinfo</i></dt> +</dd> +<dt><i>appinfo</i></dt> <dd> dictionary describing the application </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> index of the '--' option (integer). This is used to tell @@ -82,29 +101,37 @@ </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="initializeResourceSearchPath" ID="initializeResourceSearchPath"></a> <h2>initializeResourceSearchPath</h2> <b>initializeResourceSearchPath</b>(<i></i>) + <p> Module function to initialize the default mime source factory. </p> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="loadTranslatorForLocale" ID="loadTranslatorForLocale"></a> <h2>loadTranslatorForLocale</h2> <b>loadTranslatorForLocale</b>(<i>dirs, tn</i>) + <p> Module function to find and load a specific translation. -</p><dl> +</p> +<dl> + <dt><i>dirs</i></dt> <dd> Searchpath for the translations. (list of strings) -</dd><dt><i>tn</i></dt> +</dd> +<dt><i>tn</i></dt> <dd> The translation to be loaded. (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> Tuple of a status flag and the loaded translator @@ -112,56 +139,72 @@ </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="loadTranslators" ID="loadTranslators"></a> <h2>loadTranslators</h2> <b>loadTranslators</b>(<i>qtTransDir, app, translationFiles=()</i>) + <p> Module function to load all required translations. -</p><dl> +</p> +<dl> + <dt><i>qtTransDir</i></dt> <dd> directory of the Qt translations files (string) -</dd><dt><i>app</i></dt> +</dd> +<dt><i>app</i></dt> <dd> reference to the application object (QApplication) -</dd><dt><i>translationFiles</i></dt> +</dd> +<dt><i>translationFiles</i></dt> <dd> tuple of additional translations to be loaded (tuple of strings) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> the requested locale (string) </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="setLibraryPaths" ID="setLibraryPaths"></a> <h2>setLibraryPaths</h2> <b>setLibraryPaths</b>(<i></i>) + <p> Module function to set the Qt library paths correctly for windows systems. </p> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<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> +</p> +<p> This function is used by all of eric6's helper programs. -</p><dl> +</p> +<dl> + <dt><i>argv</i></dt> <dd> list of commandline parameters (list of strings) -</dd><dt><i>appinfo</i></dt> +</dd> +<dt><i>appinfo</i></dt> <dd> dictionary describing the application -</dd><dt><i>mwFactory</i></dt> +</dd> +<dt><i>mwFactory</i></dt> <dd> factory function generating the main widget. This function must accept the following parameter. @@ -169,52 +212,66 @@ <dt>argv</dt> <dd>list of commandline parameters (list of strings)</dd> </dl> -</dd><dt><i>quitOnLastWindowClosed=</i></dt> +</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> +<dt><i>app=</i></dt> <dd> reference to the application object (QApplication or None) -</dd><dt><i>raiseIt=</i></dt> +</dd> +<dt><i>raiseIt=</i></dt> <dd> flag indicating to raise the generated application window (boolean) -</dd><dt><i>installErrorHandler=</i></dt> +</dd> +<dt><i>installErrorHandler=</i></dt> <dd> flag indicating to install an error handler dialog (boolean) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> exit result (integer) </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<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> +</p> +<dl> + <dt><i>appinfo</i></dt> <dd> dictionary describing the application -</dd><dt><i>optlen</i></dt> +</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 /> +<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> +</p> +<dl> + <dt><i>appinfo</i></dt> <dd> dictionary describing the application