Mercurial Repositories > eric / file diff

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

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

changeset 3673
e26d7d0c1088
child 6866
b792455b35cd
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.QScintilla.Lexers.Lexer.html	Sat Jul 05 12:29:15 2014 +0200
@@ -0,0 +1,316 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.QScintilla.Lexers.Lexer</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric6.QScintilla.Lexers.Lexer</h1>
+<p>
+Module implementing the lexer mixin class.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#Lexer">Lexer</a></td>
+<td>Class to implement the lexer mixin class.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="Lexer" ID="Lexer"></a>
+<h2>Lexer</h2>
+<p>
+    Class to implement the lexer mixin class.
+</p>
+<h3>Derived from</h3>
+object
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#Lexer.__init__">Lexer</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#Lexer.alwaysKeepTabs">alwaysKeepTabs</a></td>
+<td>Public method to check, if tab conversion is allowed.</td>
+</tr><tr>
+<td><a href="#Lexer.autoCompletionWordSeparators">autoCompletionWordSeparators</a></td>
+<td>Public method to return the list of separators for autocompletion.</td>
+</tr><tr>
+<td><a href="#Lexer.boxCommentStr">boxCommentStr</a></td>
+<td>Public method to return the box comment strings.</td>
+</tr><tr>
+<td><a href="#Lexer.canBlockComment">canBlockComment</a></td>
+<td>Public method to determine, whether the lexer language supports a block comment.</td>
+</tr><tr>
+<td><a href="#Lexer.canBoxComment">canBoxComment</a></td>
+<td>Public method to determine, whether the lexer language supports a box comment.</td>
+</tr><tr>
+<td><a href="#Lexer.canStreamComment">canStreamComment</a></td>
+<td>Public method to determine, whether the lexer language supports a stream comment.</td>
+</tr><tr>
+<td><a href="#Lexer.commentStr">commentStr</a></td>
+<td>Public method to return the comment string.</td>
+</tr><tr>
+<td><a href="#Lexer.hasSmartIndent">hasSmartIndent</a></td>
+<td>Public method indicating whether lexer can do smart indentation.</td>
+</tr><tr>
+<td><a href="#Lexer.initProperties">initProperties</a></td>
+<td>Public slot to initialize the properties.</td>
+</tr><tr>
+<td><a href="#Lexer.isCommentStyle">isCommentStyle</a></td>
+<td>Public method to check, if a style is a comment style.</td>
+</tr><tr>
+<td><a href="#Lexer.isStringStyle">isStringStyle</a></td>
+<td>Public method to check, if a style is a string style.</td>
+</tr><tr>
+<td><a href="#Lexer.keywords">keywords</a></td>
+<td>Public method to get the keywords.</td>
+</tr><tr>
+<td><a href="#Lexer.lexerName">lexerName</a></td>
+<td>Public method to return the lexer name.</td>
+</tr><tr>
+<td><a href="#Lexer.maximumKeywordSet">maximumKeywordSet</a></td>
+<td>Public method to get the maximum keyword set.</td>
+</tr><tr>
+<td><a href="#Lexer.smartIndentLine">smartIndentLine</a></td>
+<td>Public method to handle smart indentation for a line.</td>
+</tr><tr>
+<td><a href="#Lexer.smartIndentSelection">smartIndentSelection</a></td>
+<td>Public method to handle smart indentation for a selection of lines.</td>
+</tr><tr>
+<td><a href="#Lexer.streamCommentStr">streamCommentStr</a></td>
+<td>Public method to return the stream comment strings.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="Lexer.__init__" ID="Lexer.__init__"></a>
+<h4>Lexer (Constructor)</h4>
+<b>Lexer</b>(<i></i>)
+<p>
+        Constructor
+</p><a NAME="Lexer.alwaysKeepTabs" ID="Lexer.alwaysKeepTabs"></a>
+<h4>Lexer.alwaysKeepTabs</h4>
+<b>alwaysKeepTabs</b>(<i></i>)
+<p>
+        Public method to check, if tab conversion is allowed.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating to keep tabs (boolean)
+</dd>
+</dl><a NAME="Lexer.autoCompletionWordSeparators" ID="Lexer.autoCompletionWordSeparators"></a>
+<h4>Lexer.autoCompletionWordSeparators</h4>
+<b>autoCompletionWordSeparators</b>(<i></i>)
+<p>
+        Public method to return the list of separators for autocompletion.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of separators (list of strings)
+</dd>
+</dl><a NAME="Lexer.boxCommentStr" ID="Lexer.boxCommentStr"></a>
+<h4>Lexer.boxCommentStr</h4>
+<b>boxCommentStr</b>(<i></i>)
+<p>
+        Public method to return the box comment strings.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+box comment strings (dictionary with three QStrings)
+</dd>
+</dl><a NAME="Lexer.canBlockComment" ID="Lexer.canBlockComment"></a>
+<h4>Lexer.canBlockComment</h4>
+<b>canBlockComment</b>(<i></i>)
+<p>
+        Public method to determine, whether the lexer language supports a
+        block comment.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag (boolean)
+</dd>
+</dl><a NAME="Lexer.canBoxComment" ID="Lexer.canBoxComment"></a>
+<h4>Lexer.canBoxComment</h4>
+<b>canBoxComment</b>(<i></i>)
+<p>
+        Public method to determine, whether the lexer language supports a
+        box comment.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag (boolean)
+</dd>
+</dl><a NAME="Lexer.canStreamComment" ID="Lexer.canStreamComment"></a>
+<h4>Lexer.canStreamComment</h4>
+<b>canStreamComment</b>(<i></i>)
+<p>
+        Public method to determine, whether the lexer language supports a
+        stream comment.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag (boolean)
+</dd>
+</dl><a NAME="Lexer.commentStr" ID="Lexer.commentStr"></a>
+<h4>Lexer.commentStr</h4>
+<b>commentStr</b>(<i></i>)
+<p>
+        Public method to return the comment string.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+comment string (string)
+</dd>
+</dl><a NAME="Lexer.hasSmartIndent" ID="Lexer.hasSmartIndent"></a>
+<h4>Lexer.hasSmartIndent</h4>
+<b>hasSmartIndent</b>(<i></i>)
+<p>
+        Public method indicating whether lexer can do smart indentation.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating availability of smartIndentLine and
+            smartIndentSelection methods (boolean)
+</dd>
+</dl><a NAME="Lexer.initProperties" ID="Lexer.initProperties"></a>
+<h4>Lexer.initProperties</h4>
+<b>initProperties</b>(<i></i>)
+<p>
+        Public slot to initialize the properties.
+</p><a NAME="Lexer.isCommentStyle" ID="Lexer.isCommentStyle"></a>
+<h4>Lexer.isCommentStyle</h4>
+<b>isCommentStyle</b>(<i>style</i>)
+<p>
+        Public method to check, if a style is a comment style.
+</p><dl>
+<dt><i>style</i></dt>
+<dd>
+style to check (integer)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a comment style (boolean)
+</dd>
+</dl><a NAME="Lexer.isStringStyle" ID="Lexer.isStringStyle"></a>
+<h4>Lexer.isStringStyle</h4>
+<b>isStringStyle</b>(<i>style</i>)
+<p>
+        Public method to check, if a style is a string style.
+</p><dl>
+<dt><i>style</i></dt>
+<dd>
+style to check (integer)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a string style (boolean)
+</dd>
+</dl><a NAME="Lexer.keywords" ID="Lexer.keywords"></a>
+<h4>Lexer.keywords</h4>
+<b>keywords</b>(<i>kwSet</i>)
+<p>
+        Public method to get the keywords.
+</p><dl>
+<dt><i>kwSet</i></dt>
+<dd>
+number of the keyword set (integer)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+string giving the keywords (string) or None
+</dd>
+</dl><a NAME="Lexer.lexerName" ID="Lexer.lexerName"></a>
+<h4>Lexer.lexerName</h4>
+<b>lexerName</b>(<i></i>)
+<p>
+        Public method to return the lexer name.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+lexer name (string)
+</dd>
+</dl><a NAME="Lexer.maximumKeywordSet" ID="Lexer.maximumKeywordSet"></a>
+<h4>Lexer.maximumKeywordSet</h4>
+<b>maximumKeywordSet</b>(<i></i>)
+<p>
+        Public method to get the maximum keyword set.
+</p><p>
+        Note: A return value of 0 indicates to determine this dynamically.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+maximum keyword set (integer)
+</dd>
+</dl><a NAME="Lexer.smartIndentLine" ID="Lexer.smartIndentLine"></a>
+<h4>Lexer.smartIndentLine</h4>
+<b>smartIndentLine</b>(<i>editor</i>)
+<p>
+        Public method to handle smart indentation for a line.
+</p><dl>
+<dt><i>editor</i></dt>
+<dd>
+reference to the QScintilla editor object
+</dd>
+</dl><a NAME="Lexer.smartIndentSelection" ID="Lexer.smartIndentSelection"></a>
+<h4>Lexer.smartIndentSelection</h4>
+<b>smartIndentSelection</b>(<i>editor</i>)
+<p>
+        Public method to handle smart indentation for a selection of lines.
+</p><p>
+        Note: The assumption is, that the first line determines the new
+              indentation level.
+</p><dl>
+<dt><i>editor</i></dt>
+<dd>
+reference to the QScintilla editor object
+</dd>
+</dl><a NAME="Lexer.streamCommentStr" ID="Lexer.streamCommentStr"></a>
+<h4>Lexer.streamCommentStr</h4>
+<b>streamCommentStr</b>(<i></i>)
+<p>
+        Public method to return the stream comment strings.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+stream comment strings (dictionary with two strings)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

Mercurial Repository: eric

eric ide

mercurial