--- a/Documentation/Source/eric5.QScintilla.Lexers.__init__.html Thu Jan 14 17:27:31 2010 +0000 +++ b/Documentation/Source/eric5.QScintilla.Lexers.__init__.html Thu Jan 14 18:35:52 2010 +0000 @@ -22,7 +22,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.QScintilla.Lexers.__init__</h1> <p> -Package implementing lexers for the various supported programming languages. +Package implementing lexers for the various supported programming languages. </p> <h3>Global Attributes</h3> <table> @@ -36,28 +36,28 @@ <table> <tr> <td><a href="#__getPygmentsLexer">__getPygmentsLexer</a></td> -<td>Private module function to instantiate a pygments lexer.</td> +<td>Private module function to instantiate a pygments lexer.</td> </tr><tr> <td><a href="#getDefaultLexerAssociations">getDefaultLexerAssociations</a></td> <td></td> </tr><tr> <td><a href="#getLexer">getLexer</a></td> -<td>Module function to instantiate a lexer object for a given language.</td> +<td>Module function to instantiate a lexer object for a given language.</td> </tr><tr> <td><a href="#getOpenFileFiltersList">getOpenFileFiltersList</a></td> -<td>Module function to get the file filter list for an open file operation.</td> +<td>Module function to get the file filter list for an open file operation.</td> </tr><tr> <td><a href="#getSaveFileFiltersList">getSaveFileFiltersList</a></td> -<td>Module function to get the file filter list for a save file operation.</td> +<td>Module function to get the file filter list for a save file operation.</td> </tr><tr> <td><a href="#getSupportedLanguages">getSupportedLanguages</a></td> -<td>Module function to get a dictionary of supported lexer languages.</td> +<td>Module function to get a dictionary of supported lexer languages.</td> </tr><tr> <td><a href="#registerLexer">registerLexer</a></td> -<td>Module function to register a custom QScintilla lexer.</td> +<td>Module function to register a custom QScintilla lexer.</td> </tr><tr> <td><a href="#unregisterLexer">unregisterLexer</a></td> -<td>Module function to unregister a custom QScintilla lexer.</td> +<td>Module function to unregister a custom QScintilla lexer.</td> </tr> </table> <hr /><hr /> @@ -65,19 +65,19 @@ <h2>__getPygmentsLexer</h2> <b>__getPygmentsLexer</b>(<i>parent, name = ""</i>) <p> - Private module function to instantiate a pygments lexer. + Private module function to instantiate a pygments lexer. </p><dl> <dt><i>parent</i></dt> <dd> -reference to the parent widget +reference to the parent widget </dd><dt><i>name=</i></dt> <dd> -name of the pygments lexer to use (string) +name of the pygments lexer to use (string) </dd> </dl><dl> <dt>Returns:</dt> <dd> -reference to the lexer (LexerPygments) or None +reference to the lexer (LexerPygments) or None </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -92,22 +92,22 @@ <h2>getLexer</h2> <b>getLexer</b>(<i>language, parent = None, pyname = ""</i>) <p> - Module function to instantiate a lexer object for a given language. + Module function to instantiate a lexer object for a given language. </p><dl> <dt><i>language</i></dt> <dd> -language of the lexer (string) +language of the lexer (string) </dd><dt><i>parent</i></dt> <dd> -reference to the parent object (QObject) +reference to the parent object (QObject) </dd><dt><i>pyname=</i></dt> <dd> -name of the pygments lexer to use (string) +name of the pygments lexer to use (string) </dd> </dl><dl> <dt>Returns:</dt> <dd> -reference to the instanciated lexer object (QsciLexer) +reference to the instanciated lexer object (QsciLexer) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -116,21 +116,21 @@ <h2>getOpenFileFiltersList</h2> <b>getOpenFileFiltersList</b>(<i>includeAll = False, asString = False</i>) <p> - Module function to get the file filter list for an open file operation. + Module function to get the file filter list for an open file operation. </p><dl> <dt><i>includeAll</i></dt> <dd> -flag indicating the inclusion of the - All Files filter (boolean) +flag indicating the inclusion of the + All Files filter (boolean) </dd><dt><i>asString</i></dt> <dd> -flag indicating the list should be returned - as a string (boolean) +flag indicating the list should be returned + as a string (boolean) </dd> </dl><dl> <dt>Returns:</dt> <dd> -file filter list (list of strings or string) +file filter list (list of strings or string) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -139,21 +139,21 @@ <h2>getSaveFileFiltersList</h2> <b>getSaveFileFiltersList</b>(<i>includeAll = False, asString = False</i>) <p> - Module function to get the file filter list for a save file operation. + Module function to get the file filter list for a save file operation. </p><dl> <dt><i>includeAll</i></dt> <dd> -flag indicating the inclusion of the - All Files filter (boolean) +flag indicating the inclusion of the + All Files filter (boolean) </dd><dt><i>asString</i></dt> <dd> -flag indicating the list should be returned - as a string (boolean) +flag indicating the list should be returned + as a string (boolean) </dd> </dl><dl> <dt>Returns:</dt> <dd> -file filter list (list of strings or string) +file filter list (list of strings or string) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -162,15 +162,15 @@ <h2>getSupportedLanguages</h2> <b>getSupportedLanguages</b>(<i></i>) <p> - Module function to get a dictionary of supported lexer languages. + Module function to get a dictionary of supported lexer languages. </p><dl> <dt>Returns:</dt> <dd> -dictionary of supported lexer languages. The keys are the - internal language names. The items are lists of two entries. - The first is the display string for the language, the second - is a dummy file name, which can be used to derive the lexer. - (string, string) +dictionary of supported lexer languages. The keys are the + internal language names. The items are lists of two entries. + The first is the display string for the language, the second + is a dummy file name, which can be used to derive the lexer. + (string, string) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -179,36 +179,36 @@ <h2>registerLexer</h2> <b>registerLexer</b>(<i>name, displayString, filenameSample, getLexerFunc, openFilters = [], saveFilters = [], defaultAssocs = []</i>) <p> - Module function to register a custom QScintilla lexer. + Module function to register a custom QScintilla lexer. </p><dl> <dt><i>name</i></dt> <dd> -lexer language name (string) +lexer language name (string) </dd><dt><i>displayString</i></dt> <dd> -display string (string) +display string (string) </dd><dt><i>filenameSample</i></dt> <dd> -dummy filename to derive lexer name (string) +dummy filename to derive lexer name (string) </dd><dt><i>getLexerFunc</i></dt> <dd> -reference to a function instantiating the specific lexer. - This function must take a reference to the parent as it's only argument. +reference to a function instantiating the specific lexer. + This function must take a reference to the parent as it's only argument. </dd><dt><i>openFilters=</i></dt> <dd> -list of open file filters (list of strings) +list of open file filters (list of strings) </dd><dt><i>saveFilters=</i></dt> <dd> -list of save file filters (list of strings) +list of save file filters (list of strings) </dd><dt><i>defaultAssocs=</i></dt> <dd> -default lexer associations (list of strings of filename - wildcard patterns to be associated with the lexer) +default lexer associations (list of strings of filename + wildcard patterns to be associated with the lexer) </dd> </dl><dl> <dt>Raises <b>KeyError</b>:</dt> <dd> -raised when the given name is already in use +raised when the given name is already in use </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -217,11 +217,11 @@ <h2>unregisterLexer</h2> <b>unregisterLexer</b>(<i>name</i>) <p> - Module function to unregister a custom QScintilla lexer. + Module function to unregister a custom QScintilla lexer. </p><dl> <dt><i>name</i></dt> <dd> -lexer language name (string) +lexer language name (string) </dd> </dl> <div align="right"><a href="#top">Up</a></div>