Mercurial Repositories > eric / file diff

diff: eric6/Documentation/Source/eric6.QScintilla.Lexers.__init__.html

eric6/Documentation/Source/eric6.QScintilla.Lexers.__init__.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7900
72b88fb20261
--- a/eric6/Documentation/Source/eric6.QScintilla.Lexers.__init__.html	Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.QScintilla.Lexers.__init__.html	Wed Sep 25 19:42:44 2019 +0200
@@ -18,211 +18,269 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>eric6.QScintilla.Lexers.__init__</h1>
+
 <p>
 Package implementing lexers for the various supported programming languages.
 </p>
 <h3>Global Attributes</h3>
+
 <table>
 <tr><td>LexerRegistry</td></tr>
 </table>
 <h3>Classes</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Functions</h3>
+
 <table>
+
 <tr>
 <td><a href="#__getPygmentsLexer">__getPygmentsLexer</a></td>
 <td>Private module function to instantiate a pygments lexer.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#getDefaultLexerAssociations">getDefaultLexerAssociations</a></td>
 <td>Module function to get a dictionary with the default associations.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#getLanguageIcon">getLanguageIcon</a></td>
 <td>Module function to get an icon for a language.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#getLexer">getLexer</a></td>
 <td>Module function to instantiate a lexer object for a given language.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#getOpenFileFiltersList">getOpenFileFiltersList</a></td>
 <td>Module function to get the file filter list for an open file operation.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#getSaveFileFiltersList">getSaveFileFiltersList</a></td>
 <td>Module function to get the file filter list for a save file operation.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#getSupportedApiLanguages">getSupportedApiLanguages</a></td>
 <td>Module function to get a list of supported API languages.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#getSupportedLanguages">getSupportedLanguages</a></td>
 <td>Module function to get a dictionary of supported lexer languages.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#registerLexer">registerLexer</a></td>
 <td>Module function to register a custom QScintilla lexer.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#unregisterLexer">unregisterLexer</a></td>
 <td>Module function to unregister a custom QScintilla lexer.</td>
 </tr>
 </table>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="__getPygmentsLexer" ID="__getPygmentsLexer"></a>
 <h2>__getPygmentsLexer</h2>
 <b>__getPygmentsLexer</b>(<i>parent, name=""</i>)
+
 <p>
     Private module function to instantiate a pygments lexer.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>parent</i></dt>
 <dd>
 reference to the parent widget
-</dd><dt><i>name=</i></dt>
+</dd>
+<dt><i>name=</i></dt>
 <dd>
 name of the pygments lexer to use (string)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 reference to the lexer (LexerPygments) or None
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="getDefaultLexerAssociations" ID="getDefaultLexerAssociations"></a>
 <h2>getDefaultLexerAssociations</h2>
 <b>getDefaultLexerAssociations</b>(<i></i>)
+
 <p>
     Module function to get a dictionary with the default associations.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 dictionary with the default lexer associations
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="getLanguageIcon" ID="getLanguageIcon"></a>
 <h2>getLanguageIcon</h2>
 <b>getLanguageIcon</b>(<i>language, pixmap</i>)
+
 <p>
     Module function to get an icon for a language.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>language</i></dt>
 <dd>
 language of the lexer (string)
-</dd><dt><i>pixmap</i></dt>
+</dd>
+<dt><i>pixmap</i></dt>
 <dd>
 flag indicating to return a pixmap (boolean)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 icon for the language (QPixmap or QIcon)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="getLexer" ID="getLexer"></a>
 <h2>getLexer</h2>
 <b>getLexer</b>(<i>language, parent=None, pyname=""</i>)
+
 <p>
     Module function to instantiate a lexer object for a given language.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>language</i></dt>
 <dd>
 language of the lexer (string)
-</dd><dt><i>parent</i></dt>
+</dd>
+<dt><i>parent</i></dt>
 <dd>
 reference to the parent object (QObject)
-</dd><dt><i>pyname=</i></dt>
+</dd>
+<dt><i>pyname=</i></dt>
 <dd>
 name of the pygments lexer to use (string)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 reference to the instanciated lexer object (QsciLexer)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="getOpenFileFiltersList" ID="getOpenFileFiltersList"></a>
 <h2>getOpenFileFiltersList</h2>
 <b>getOpenFileFiltersList</b>(<i>includeAll=False, asString=False, withAdditional=True</i>)
+
 <p>
     Module function to get the file filter list for an open file operation.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>includeAll</i></dt>
 <dd>
 flag indicating the inclusion of the
         All Files filter (boolean)
-</dd><dt><i>asString</i></dt>
+</dd>
+<dt><i>asString</i></dt>
 <dd>
 flag indicating the list should be returned
         as a string (boolean)
-</dd><dt><i>withAdditional=</i></dt>
+</dd>
+<dt><i>withAdditional=</i></dt>
 <dd>
 flag indicating to include additional filters
         defined by the user (boolean)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 file filter list (list of strings or string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="getSaveFileFiltersList" ID="getSaveFileFiltersList"></a>
 <h2>getSaveFileFiltersList</h2>
 <b>getSaveFileFiltersList</b>(<i>includeAll=False, asString=False, withAdditional=True</i>)
+
 <p>
     Module function to get the file filter list for a save file operation.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>includeAll</i></dt>
 <dd>
 flag indicating the inclusion of the
         All Files filter (boolean)
-</dd><dt><i>asString</i></dt>
+</dd>
+<dt><i>asString</i></dt>
 <dd>
 flag indicating the list should be returned
         as a string (boolean)
-</dd><dt><i>withAdditional=</i></dt>
+</dd>
+<dt><i>withAdditional=</i></dt>
 <dd>
 flag indicating to include additional filters
         defined by the user (boolean)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 file filter list (list of strings or string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="getSupportedApiLanguages" ID="getSupportedApiLanguages"></a>
 <h2>getSupportedApiLanguages</h2>
 <b>getSupportedApiLanguages</b>(<i></i>)
+
 <p>
     Module function to get a list of supported API languages.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 list of supported API languages
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 list of str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="getSupportedLanguages" ID="getSupportedLanguages"></a>
 <h2>getSupportedLanguages</h2>
 <b>getSupportedLanguages</b>(<i></i>)
+
 <p>
     Module function to get a dictionary of supported lexer languages.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 dictionary of supported lexer languages. The keys are the
@@ -234,55 +292,72 @@
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="registerLexer" ID="registerLexer"></a>
 <h2>registerLexer</h2>
 <b>registerLexer</b>(<i>name, displayString, filenameSample, getLexerFunc, openFilters=None, saveFilters=None, defaultAssocs=None, iconFileName=""</i>)
+
 <p>
     Module function to register a custom QScintilla lexer.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>name</i></dt>
 <dd>
 lexer language name (string)
-</dd><dt><i>displayString</i></dt>
+</dd>
+<dt><i>displayString</i></dt>
 <dd>
 display string (string)
-</dd><dt><i>filenameSample</i></dt>
+</dd>
+<dt><i>filenameSample</i></dt>
 <dd>
 dummy filename to derive lexer name (string)
-</dd><dt><i>getLexerFunc</i></dt>
+</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 its only
         argument.
-</dd><dt><i>openFilters=</i></dt>
+</dd>
+<dt><i>openFilters=</i></dt>
 <dd>
 list of open file filters (list of strings)
-</dd><dt><i>saveFilters=</i></dt>
+</dd>
+<dt><i>saveFilters=</i></dt>
 <dd>
 list of save file filters (list of strings)
-</dd><dt><i>defaultAssocs=</i></dt>
+</dd>
+<dt><i>defaultAssocs=</i></dt>
 <dd>
 default lexer associations (list of strings of
         filename wildcard patterns to be associated with the lexer)
-</dd><dt><i>iconFileName=</i></dt>
+</dd>
+<dt><i>iconFileName=</i></dt>
 <dd>
 name of an icon file (string)
 </dd>
-</dl><dl>
+</dl>
+<dl>
+
 <dt>Raises <b>KeyError</b>:</dt>
 <dd>
 raised when the given name is already in use
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="unregisterLexer" ID="unregisterLexer"></a>
 <h2>unregisterLexer</h2>
 <b>unregisterLexer</b>(<i>name</i>)
+
 <p>
     Module function to unregister a custom QScintilla lexer.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>name</i></dt>
 <dd>
 lexer language name (string)

Mercurial Repository: eric

eric ide

mercurial