eric6/Documentation/Source/eric6.QScintilla.TypingCompleters.CompleterYaml.html

changeset 7281
8087ef6df2e4
child 7989
a21d673a8f99
equal deleted inserted replaced
7280:eb15faf0e3e2 7281:8087ef6df2e4
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.QScintilla.TypingCompleters.CompleterYaml</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric6.QScintilla.TypingCompleters.CompleterYaml</h1>
24
25 <p>
26 Module implementing a typing completer for Python.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#CompleterYaml">CompleterYaml</a></td>
39 <td>Class implementing typing completer for Python.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="CompleterYaml" ID="CompleterYaml"></a>
50 <h2>CompleterYaml</h2>
51
52 <p>
53 Class implementing typing completer for Python.
54 </p>
55 <h3>Derived from</h3>
56 CompleterBase
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#CompleterYaml.__init__">CompleterYaml</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#CompleterYaml.__inComment">__inComment</a></td>
77 <td>Private method to check, if the cursor is inside a comment.</td>
78 </tr>
79 <tr>
80 <td><a href="#CompleterYaml.charAdded">charAdded</a></td>
81 <td>Public slot called to handle the user entering a character.</td>
82 </tr>
83 <tr>
84 <td><a href="#CompleterYaml.readSettings">readSettings</a></td>
85 <td>Public slot called to reread the configuration parameters.</td>
86 </tr>
87 </table>
88 <h3>Static Methods</h3>
89
90 <table>
91 <tr><td>None</td></tr>
92 </table>
93
94 <a NAME="CompleterYaml.__init__" ID="CompleterYaml.__init__"></a>
95 <h4>CompleterYaml (Constructor)</h4>
96 <b>CompleterYaml</b>(<i>editor, parent=None</i>)
97
98 <p>
99 Constructor
100 </p>
101 <dl>
102
103 <dt><i>editor</i> (QScintilla.Editor)</dt>
104 <dd>
105 reference to the editor object
106 </dd>
107 <dt><i>parent</i> (QObject)</dt>
108 <dd>
109 reference to the parent object
110 </dd>
111 </dl>
112 <a NAME="CompleterYaml.__inComment" ID="CompleterYaml.__inComment"></a>
113 <h4>CompleterYaml.__inComment</h4>
114 <b>__inComment</b>(<i>line, col</i>)
115
116 <p>
117 Private method to check, if the cursor is inside a comment.
118 </p>
119 <dl>
120
121 <dt><i>line</i> (int)</dt>
122 <dd>
123 current line
124 </dd>
125 <dt><i>col</i> (int)</dt>
126 <dd>
127 current position within line
128 </dd>
129 </dl>
130 <dl>
131 <dt>Returns:</dt>
132 <dd>
133 flag indicating, if the cursor is inside a comment
134 </dd>
135 </dl>
136 <dl>
137 <dt>Return Type:</dt>
138 <dd>
139 bool
140 </dd>
141 </dl>
142 <a NAME="CompleterYaml.charAdded" ID="CompleterYaml.charAdded"></a>
143 <h4>CompleterYaml.charAdded</h4>
144 <b>charAdded</b>(<i>charNumber</i>)
145
146 <p>
147 Public slot called to handle the user entering a character.
148 </p>
149 <dl>
150
151 <dt><i>charNumber</i> (int)</dt>
152 <dd>
153 value of the character entered
154 </dd>
155 </dl>
156 <a NAME="CompleterYaml.readSettings" ID="CompleterYaml.readSettings"></a>
157 <h4>CompleterYaml.readSettings</h4>
158 <b>readSettings</b>(<i></i>)
159
160 <p>
161 Public slot called to reread the configuration parameters.
162 </p>
163 <div align="right"><a href="#top">Up</a></div>
164 <hr />
165 </body></html>

eric ide

mercurial