src/eric7/Documentation/Source/eric7.QScintilla.TypingCompleters.CompleterYaml.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9503
ae9232bf4854
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.QScintilla.TypingCompleters.CompleterYaml</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.QScintilla.TypingCompleters.CompleterYaml</h1>
10
11 <p>
12 Module implementing a typing completer for Python.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#CompleterYaml">CompleterYaml</a></td>
25 <td>Class implementing typing completer for Python.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="CompleterYaml" ID="CompleterYaml"></a>
36 <h2>CompleterYaml</h2>
37
38 <p>
39 Class implementing typing completer for Python.
40 </p>
41 <h3>Derived from</h3>
42 CompleterBase
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#CompleterYaml.__init__">CompleterYaml</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#CompleterYaml.__inComment">__inComment</a></td>
63 <td>Private method to check, if the cursor is inside a comment.</td>
64 </tr>
65 <tr>
66 <td><a href="#CompleterYaml.charAdded">charAdded</a></td>
67 <td>Public slot called to handle the user entering a character.</td>
68 </tr>
69 <tr>
70 <td><a href="#CompleterYaml.readSettings">readSettings</a></td>
71 <td>Public slot called to reread the configuration parameters.</td>
72 </tr>
73 </table>
74 <h3>Static Methods</h3>
75
76 <table>
77 <tr><td>None</td></tr>
78 </table>
79
80 <a NAME="CompleterYaml.__init__" ID="CompleterYaml.__init__"></a>
81 <h4>CompleterYaml (Constructor)</h4>
82 <b>CompleterYaml</b>(<i>editor, parent=None</i>)
83
84 <p>
85 Constructor
86 </p>
87 <dl>
88
89 <dt><i>editor</i> (QScintilla.Editor)</dt>
90 <dd>
91 reference to the editor object
92 </dd>
93 <dt><i>parent</i> (QObject)</dt>
94 <dd>
95 reference to the parent object
96 </dd>
97 </dl>
98 <a NAME="CompleterYaml.__inComment" ID="CompleterYaml.__inComment"></a>
99 <h4>CompleterYaml.__inComment</h4>
100 <b>__inComment</b>(<i>line, col</i>)
101
102 <p>
103 Private method to check, if the cursor is inside a comment.
104 </p>
105 <dl>
106
107 <dt><i>line</i> (int)</dt>
108 <dd>
109 current line
110 </dd>
111 <dt><i>col</i> (int)</dt>
112 <dd>
113 current position within line
114 </dd>
115 </dl>
116 <dl>
117 <dt>Return:</dt>
118 <dd>
119 flag indicating, if the cursor is inside a comment
120 </dd>
121 </dl>
122 <dl>
123 <dt>Return Type:</dt>
124 <dd>
125 bool
126 </dd>
127 </dl>
128 <a NAME="CompleterYaml.charAdded" ID="CompleterYaml.charAdded"></a>
129 <h4>CompleterYaml.charAdded</h4>
130 <b>charAdded</b>(<i>charNumber</i>)
131
132 <p>
133 Public slot called to handle the user entering a character.
134 </p>
135 <dl>
136
137 <dt><i>charNumber</i> (int)</dt>
138 <dd>
139 value of the character entered
140 </dd>
141 </dl>
142 <a NAME="CompleterYaml.readSettings" ID="CompleterYaml.readSettings"></a>
143 <h4>CompleterYaml.readSettings</h4>
144 <b>readSettings</b>(<i></i>)
145
146 <p>
147 Public slot called to reread the configuration parameters.
148 </p>
149 <div align="right"><a href="#top">Up</a></div>
150 <hr />
151 </body></html>

eric ide

mercurial