--- a/Documentation/Source/eric5.Utilities.Startup.html Thu Jan 14 17:27:31 2010 +0000 +++ b/Documentation/Source/eric5.Utilities.Startup.html Thu Jan 14 18:35:52 2010 +0000 @@ -22,7 +22,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.Utilities.Startup</h1> <p> -Module implementing some startup helper funcions +Module implementing some startup helper funcions </p> <h3>Global Attributes</h3> <table> @@ -36,28 +36,28 @@ <table> <tr> <td><a href="#handleArgs">handleArgs</a></td> -<td>Module function to handle the always present commandline options.</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> +<td>Module function to initialize the default mime source factory.</td> </tr><tr> <td><a href="#loadTranslatorForLocale">loadTranslatorForLocale</a></td> -<td>Module function to find and load a specific translation.</td> +<td>Module function to find and load a specific translation.</td> </tr><tr> <td><a href="#loadTranslators">loadTranslators</a></td> -<td>Module function to load all required translations.</td> +<td>Module function to load all required translations.</td> </tr><tr> <td><a href="#makeAppInfo">makeAppInfo</a></td> -<td>Module function to generate a dictionary describing the application.</td> +<td>Module function to generate a dictionary describing the application.</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> +<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> +<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> +<td>Module function to show the version information.</td> </tr> </table> <hr /><hr /> @@ -65,21 +65,21 @@ <h2>handleArgs</h2> <b>handleArgs</b>(<i>argv, appinfo</i>) <p> - Module function to handle the always present commandline options. + Module function to handle the always present commandline options. </p><dl> <dt><i>argv</i></dt> <dd> -list of commandline parameters (list of strings) +list of commandline parameters (list of strings) </dd><dt><i>appinfo</i></dt> <dd> -dictionary describing the application +dictionary describing the application </dd> </dl><dl> <dt>Returns:</dt> <dd> -index of the '--' option (integer). This is used to tell - the application, that all additional option don't belong to - the application. +index of the '--' option (integer). This is used to tell + the application, that all additional option don't belong to + the application. </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -88,7 +88,7 @@ <h2>initializeResourceSearchPath</h2> <b>initializeResourceSearchPath</b>(<i></i>) <p> - Module function to initialize the default mime source factory. + Module function to initialize the default mime source factory. </p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> @@ -96,19 +96,19 @@ <h2>loadTranslatorForLocale</h2> <b>loadTranslatorForLocale</b>(<i>dirs, tn</i>) <p> - Module function to find and load a specific translation. + Module function to find and load a specific translation. </p><dl> <dt><i>dirs</i></dt> <dd> -Searchpath for the translations. (list of strings) +Searchpath for the translations. (list of strings) </dd><dt><i>tn</i></dt> <dd> -The translation to be loaded. (string) +The translation to be loaded. (string) </dd> </dl><dl> <dt>Returns:</dt> <dd> -Tuple of a status flag and the loaded translator. (int, QTranslator) +Tuple of a status flag and the loaded translator. (int, QTranslator) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -117,23 +117,23 @@ <h2>loadTranslators</h2> <b>loadTranslators</b>(<i>qtTransDir, app, translationFiles = ()</i>) <p> - Module function to load all required translations. + Module function to load all required translations. </p><dl> <dt><i>qtTransDir</i></dt> <dd> -directory of the Qt translations files (string) +directory of the Qt translations files (string) </dd><dt><i>app</i></dt> <dd> -reference to the application object (QApplication) +reference to the application object (QApplication) </dd><dt><i>translationFiles</i></dt> <dd> -tuple of additional translations to - be loaded (tuple of strings) +tuple of additional translations to + be loaded (tuple of strings) </dd> </dl><dl> <dt>Returns:</dt> <dd> -the requested locale (string) +the requested locale (string) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -142,31 +142,31 @@ <h2>makeAppInfo</h2> <b>makeAppInfo</b>(<i>argv, name, arg, description, options = []</i>) <p> - Module function to generate a dictionary describing the application. + Module function to generate a dictionary describing the application. </p><dl> <dt><i>argv</i></dt> <dd> -list of commandline parameters (list of strings) +list of commandline parameters (list of strings) </dd><dt><i>name</i></dt> <dd> -name of the application (string) +name of the application (string) </dd><dt><i>arg</i></dt> <dd> -commandline arguments (string) +commandline arguments (string) </dd><dt><i>description</i></dt> <dd> -text describing the application (string) +text describing the application (string) </dd><dt><i>options</i></dt> <dd> -list of additional commandline options - (list of tuples of two strings (commandline option, option description)). - The options --version, --help and -h are always present and must not - be repeated in this list. +list of additional commandline options + (list of tuples of two strings (commandline option, option description)). + The options --version, --help and -h are always present and must not + be repeated in this list. </dd> </dl><dl> <dt>Returns:</dt> <dd> -dictionary describing the application +dictionary describing the application </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -175,28 +175,28 @@ <h2>simpleAppStartup</h2> <b>simpleAppStartup</b>(<i>argv, appinfo, mwFactory, quitOnLastWindowClosed = True</i>) <p> - Module function to start up an application that doesn't need a specialized start up. + Module function to start up an application that doesn't need a specialized start up. </p><p> - This function is used by all of eric5's helper programs. + This function is used by all of eric5's helper programs. </p><dl> <dt><i>argv</i></dt> <dd> -list of commandline parameters (list of strings) +list of commandline parameters (list of strings) </dd><dt><i>appinfo</i></dt> <dd> -dictionary describing the application +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> +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) +flag indicating to quit the application, + if the last window was closed (boolean) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -205,14 +205,14 @@ <h2>usage</h2> <b>usage</b>(<i>appinfo, optlen = 12</i>) <p> - Module function to show the usage information. + Module function to show the usage information. </p><dl> <dt><i>appinfo</i></dt> <dd> -dictionary describing the application +dictionary describing the application </dd><dt><i>optlen</i></dt> <dd> -length of the field for the commandline option (integer) +length of the field for the commandline option (integer) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -221,11 +221,11 @@ <h2>version</h2> <b>version</b>(<i>appinfo</i>) <p> - Module function to show the version information. + Module function to show the version information. </p><dl> <dt><i>appinfo</i></dt> <dd> -dictionary describing the application +dictionary describing the application </dd> </dl> <div align="right"><a href="#top">Up</a></div>