|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.QScintilla.Lexers.LexerPython</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.QScintilla.Lexers.LexerPython</h1> |
|
23 <p> |
|
24 Module implementing a Python lexer with some additional methods. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#LexerPython">LexerPython</a></td> |
|
34 <td>Subclass to implement some additional lexer dependant methods.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="LexerPython" ID="LexerPython"></a> |
|
43 <h2>LexerPython</h2> |
|
44 <p> |
|
45 Subclass to implement some additional lexer dependant methods. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 Lexer, QsciLexerPython |
|
49 <h3>Class Attributes</h3> |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Class Methods</h3> |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 <table> |
|
59 <tr> |
|
60 <td><a href="#LexerPython.__init__">LexerPython</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#LexerPython.autoCompletionWordSeparators">autoCompletionWordSeparators</a></td> |
|
64 <td>Public method to return the list of separators for autocompletion.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#LexerPython.defaultKeywords">defaultKeywords</a></td> |
|
67 <td>Public method to get the default keywords.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#LexerPython.getIndentationDifference">getIndentationDifference</a></td> |
|
70 <td>Public method to determine the difference for the new indentation.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#LexerPython.initProperties">initProperties</a></td> |
|
73 <td>Public slot to initialize the properties.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#LexerPython.isCommentStyle">isCommentStyle</a></td> |
|
76 <td>Public method to check, if a style is a comment style.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#LexerPython.isStringStyle">isStringStyle</a></td> |
|
79 <td>Public method to check, if a style is a string style.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#LexerPython.language">language</a></td> |
|
82 <td>Public method to get the lexer language.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#LexerPython.maximumKeywordSet">maximumKeywordSet</a></td> |
|
85 <td>Public method to get the maximum keyword set.</td> |
|
86 </tr> |
|
87 </table> |
|
88 <h3>Static Methods</h3> |
|
89 <table> |
|
90 <tr><td>None</td></tr> |
|
91 </table> |
|
92 <a NAME="LexerPython.__init__" ID="LexerPython.__init__"></a> |
|
93 <h4>LexerPython (Constructor)</h4> |
|
94 <b>LexerPython</b>(<i>variant="", parent=None</i>) |
|
95 <p> |
|
96 Constructor |
|
97 </p><dl> |
|
98 <dt><i>variant</i></dt> |
|
99 <dd> |
|
100 name of the language variant (string) |
|
101 </dd><dt><i>parent</i></dt> |
|
102 <dd> |
|
103 parent widget of this lexer |
|
104 </dd> |
|
105 </dl><a NAME="LexerPython.autoCompletionWordSeparators" ID="LexerPython.autoCompletionWordSeparators"></a> |
|
106 <h4>LexerPython.autoCompletionWordSeparators</h4> |
|
107 <b>autoCompletionWordSeparators</b>(<i></i>) |
|
108 <p> |
|
109 Public method to return the list of separators for autocompletion. |
|
110 </p><dl> |
|
111 <dt>Returns:</dt> |
|
112 <dd> |
|
113 list of separators (list of strings) |
|
114 </dd> |
|
115 </dl><a NAME="LexerPython.defaultKeywords" ID="LexerPython.defaultKeywords"></a> |
|
116 <h4>LexerPython.defaultKeywords</h4> |
|
117 <b>defaultKeywords</b>(<i>kwSet</i>) |
|
118 <p> |
|
119 Public method to get the default keywords. |
|
120 </p><dl> |
|
121 <dt><i>kwSet</i></dt> |
|
122 <dd> |
|
123 number of the keyword set (integer) |
|
124 </dd> |
|
125 </dl><dl> |
|
126 <dt>Returns:</dt> |
|
127 <dd> |
|
128 string giving the keywords (string) or None |
|
129 </dd> |
|
130 </dl><a NAME="LexerPython.getIndentationDifference" ID="LexerPython.getIndentationDifference"></a> |
|
131 <h4>LexerPython.getIndentationDifference</h4> |
|
132 <b>getIndentationDifference</b>(<i>line, editor</i>) |
|
133 <p> |
|
134 Public method to determine the difference for the new indentation. |
|
135 </p><dl> |
|
136 <dt><i>line</i></dt> |
|
137 <dd> |
|
138 line to perform the calculation for (integer) |
|
139 </dd><dt><i>editor</i></dt> |
|
140 <dd> |
|
141 QScintilla editor |
|
142 </dd> |
|
143 </dl><dl> |
|
144 <dt>Returns:</dt> |
|
145 <dd> |
|
146 amount of difference in indentation (integer) |
|
147 </dd> |
|
148 </dl><a NAME="LexerPython.initProperties" ID="LexerPython.initProperties"></a> |
|
149 <h4>LexerPython.initProperties</h4> |
|
150 <b>initProperties</b>(<i></i>) |
|
151 <p> |
|
152 Public slot to initialize the properties. |
|
153 </p><a NAME="LexerPython.isCommentStyle" ID="LexerPython.isCommentStyle"></a> |
|
154 <h4>LexerPython.isCommentStyle</h4> |
|
155 <b>isCommentStyle</b>(<i>style</i>) |
|
156 <p> |
|
157 Public method to check, if a style is a comment style. |
|
158 </p><dl> |
|
159 <dt><i>style</i></dt> |
|
160 <dd> |
|
161 style to check (integer) |
|
162 </dd> |
|
163 </dl><dl> |
|
164 <dt>Returns:</dt> |
|
165 <dd> |
|
166 flag indicating a comment style (boolean) |
|
167 </dd> |
|
168 </dl><a NAME="LexerPython.isStringStyle" ID="LexerPython.isStringStyle"></a> |
|
169 <h4>LexerPython.isStringStyle</h4> |
|
170 <b>isStringStyle</b>(<i>style</i>) |
|
171 <p> |
|
172 Public method to check, if a style is a string style. |
|
173 </p><dl> |
|
174 <dt><i>style</i></dt> |
|
175 <dd> |
|
176 style to check (integer) |
|
177 </dd> |
|
178 </dl><dl> |
|
179 <dt>Returns:</dt> |
|
180 <dd> |
|
181 flag indicating a string style (boolean) |
|
182 </dd> |
|
183 </dl><a NAME="LexerPython.language" ID="LexerPython.language"></a> |
|
184 <h4>LexerPython.language</h4> |
|
185 <b>language</b>(<i></i>) |
|
186 <p> |
|
187 Public method to get the lexer language. |
|
188 </p><dl> |
|
189 <dt>Returns:</dt> |
|
190 <dd> |
|
191 lexer language (string) |
|
192 </dd> |
|
193 </dl><a NAME="LexerPython.maximumKeywordSet" ID="LexerPython.maximumKeywordSet"></a> |
|
194 <h4>LexerPython.maximumKeywordSet</h4> |
|
195 <b>maximumKeywordSet</b>(<i></i>) |
|
196 <p> |
|
197 Public method to get the maximum keyword set. |
|
198 </p><dl> |
|
199 <dt>Returns:</dt> |
|
200 <dd> |
|
201 maximum keyword set (integer) |
|
202 </dd> |
|
203 </dl> |
|
204 <div align="right"><a href="#top">Up</a></div> |
|
205 <hr /> |
|
206 </body></html> |