Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.QScintilla.TypingCompleters.CompleterRuby.html

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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.QScintilla.TypingCompleters.CompleterRuby</h1> 23 <h1>eric6.QScintilla.TypingCompleters.CompleterRuby</h1>
24
23 <p> 25 <p>
24 Module implementing a typing completer for Ruby. 26 Module implementing a typing completer for Ruby.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#CompleterRuby">CompleterRuby</a></td> 38 <td><a href="#CompleterRuby">CompleterRuby</a></td>
34 <td>Class implementing typing completer for Ruby.</td> 39 <td>Class implementing typing completer for Ruby.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
39 <tr><td>None</td></tr> 44 <table>
40 </table> 45 <tr><td>None</td></tr>
41 <hr /><hr /> 46 </table>
47 <hr />
48 <hr />
42 <a NAME="CompleterRuby" ID="CompleterRuby"></a> 49 <a NAME="CompleterRuby" ID="CompleterRuby"></a>
43 <h2>CompleterRuby</h2> 50 <h2>CompleterRuby</h2>
51
44 <p> 52 <p>
45 Class implementing typing completer for Ruby. 53 Class implementing typing completer for Ruby.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 CompleterBase 56 CompleterBase
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#CompleterRuby.__init__">CompleterRuby</a></td> 72 <td><a href="#CompleterRuby.__init__">CompleterRuby</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#CompleterRuby.__inComment">__inComment</a></td> 76 <td><a href="#CompleterRuby.__inComment">__inComment</a></td>
64 <td>Private method to check, if the cursor is inside a comment.</td> 77 <td>Private method to check, if the cursor is inside a comment.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#CompleterRuby.__inDoubleQuotedString">__inDoubleQuotedString</a></td> 80 <td><a href="#CompleterRuby.__inDoubleQuotedString">__inDoubleQuotedString</a></td>
67 <td>Private method to check, if the cursor is within a double quoted string.</td> 81 <td>Private method to check, if the cursor is within a double quoted string.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#CompleterRuby.__inHereDocument">__inHereDocument</a></td> 84 <td><a href="#CompleterRuby.__inHereDocument">__inHereDocument</a></td>
70 <td>Private method to check, if the cursor is within a here document.</td> 85 <td>Private method to check, if the cursor is within a here document.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#CompleterRuby.__inInlineDocument">__inInlineDocument</a></td> 88 <td><a href="#CompleterRuby.__inInlineDocument">__inInlineDocument</a></td>
73 <td>Private method to check, if the cursor is within an inline document.</td> 89 <td>Private method to check, if the cursor is within an inline document.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#CompleterRuby.__inSingleQuotedString">__inSingleQuotedString</a></td> 92 <td><a href="#CompleterRuby.__inSingleQuotedString">__inSingleQuotedString</a></td>
76 <td>Private method to check, if the cursor is within a single quoted string.</td> 93 <td>Private method to check, if the cursor is within a single quoted string.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#CompleterRuby.charAdded">charAdded</a></td> 96 <td><a href="#CompleterRuby.charAdded">charAdded</a></td>
79 <td>Public slot called to handle the user entering a character.</td> 97 <td>Public slot called to handle the user entering a character.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#CompleterRuby.readSettings">readSettings</a></td> 100 <td><a href="#CompleterRuby.readSettings">readSettings</a></td>
82 <td>Public slot called to reread the configuration parameters.</td> 101 <td>Public slot called to reread the configuration parameters.</td>
83 </tr> 102 </tr>
84 </table> 103 </table>
85 <h3>Static Methods</h3> 104 <h3>Static Methods</h3>
86 <table> 105
87 <tr><td>None</td></tr> 106 <table>
88 </table> 107 <tr><td>None</td></tr>
108 </table>
109
89 <a NAME="CompleterRuby.__init__" ID="CompleterRuby.__init__"></a> 110 <a NAME="CompleterRuby.__init__" ID="CompleterRuby.__init__"></a>
90 <h4>CompleterRuby (Constructor)</h4> 111 <h4>CompleterRuby (Constructor)</h4>
91 <b>CompleterRuby</b>(<i>editor, parent=None</i>) 112 <b>CompleterRuby</b>(<i>editor, parent=None</i>)
113
92 <p> 114 <p>
93 Constructor 115 Constructor
94 </p><dl> 116 </p>
117 <dl>
118
95 <dt><i>editor</i></dt> 119 <dt><i>editor</i></dt>
96 <dd> 120 <dd>
97 reference to the editor object (QScintilla.Editor) 121 reference to the editor object (QScintilla.Editor)
98 </dd><dt><i>parent</i></dt> 122 </dd>
123 <dt><i>parent</i></dt>
99 <dd> 124 <dd>
100 reference to the parent object (QObject) 125 reference to the parent object (QObject)
101 </dd> 126 </dd>
102 </dl><a NAME="CompleterRuby.__inComment" ID="CompleterRuby.__inComment"></a> 127 </dl>
128 <a NAME="CompleterRuby.__inComment" ID="CompleterRuby.__inComment"></a>
103 <h4>CompleterRuby.__inComment</h4> 129 <h4>CompleterRuby.__inComment</h4>
104 <b>__inComment</b>(<i>line, col</i>) 130 <b>__inComment</b>(<i>line, col</i>)
131
105 <p> 132 <p>
106 Private method to check, if the cursor is inside a comment. 133 Private method to check, if the cursor is inside a comment.
107 </p><dl> 134 </p>
135 <dl>
136
108 <dt><i>line</i></dt> 137 <dt><i>line</i></dt>
109 <dd> 138 <dd>
110 current line (integer) 139 current line (integer)
111 </dd><dt><i>col</i></dt> 140 </dd>
141 <dt><i>col</i></dt>
112 <dd> 142 <dd>
113 current position within line (integer) 143 current position within line (integer)
114 </dd> 144 </dd>
115 </dl><dl> 145 </dl>
146 <dl>
116 <dt>Returns:</dt> 147 <dt>Returns:</dt>
117 <dd> 148 <dd>
118 flag indicating, if the cursor is inside a comment (boolean) 149 flag indicating, if the cursor is inside a comment (boolean)
119 </dd> 150 </dd>
120 </dl><a NAME="CompleterRuby.__inDoubleQuotedString" ID="CompleterRuby.__inDoubleQuotedString"></a> 151 </dl>
152 <a NAME="CompleterRuby.__inDoubleQuotedString" ID="CompleterRuby.__inDoubleQuotedString"></a>
121 <h4>CompleterRuby.__inDoubleQuotedString</h4> 153 <h4>CompleterRuby.__inDoubleQuotedString</h4>
122 <b>__inDoubleQuotedString</b>(<i></i>) 154 <b>__inDoubleQuotedString</b>(<i></i>)
155
123 <p> 156 <p>
124 Private method to check, if the cursor is within a double quoted 157 Private method to check, if the cursor is within a double quoted
125 string. 158 string.
126 </p><dl> 159 </p>
160 <dl>
127 <dt>Returns:</dt> 161 <dt>Returns:</dt>
128 <dd> 162 <dd>
129 flag indicating, if the cursor is inside a double 163 flag indicating, if the cursor is inside a double
130 quoted string (boolean) 164 quoted string (boolean)
131 </dd> 165 </dd>
132 </dl><a NAME="CompleterRuby.__inHereDocument" ID="CompleterRuby.__inHereDocument"></a> 166 </dl>
167 <a NAME="CompleterRuby.__inHereDocument" ID="CompleterRuby.__inHereDocument"></a>
133 <h4>CompleterRuby.__inHereDocument</h4> 168 <h4>CompleterRuby.__inHereDocument</h4>
134 <b>__inHereDocument</b>(<i></i>) 169 <b>__inHereDocument</b>(<i></i>)
170
135 <p> 171 <p>
136 Private method to check, if the cursor is within a here document. 172 Private method to check, if the cursor is within a here document.
137 </p><dl> 173 </p>
174 <dl>
138 <dt>Returns:</dt> 175 <dt>Returns:</dt>
139 <dd> 176 <dd>
140 flag indicating, if the cursor is inside a here document 177 flag indicating, if the cursor is inside a here document
141 (boolean) 178 (boolean)
142 </dd> 179 </dd>
143 </dl><a NAME="CompleterRuby.__inInlineDocument" ID="CompleterRuby.__inInlineDocument"></a> 180 </dl>
181 <a NAME="CompleterRuby.__inInlineDocument" ID="CompleterRuby.__inInlineDocument"></a>
144 <h4>CompleterRuby.__inInlineDocument</h4> 182 <h4>CompleterRuby.__inInlineDocument</h4>
145 <b>__inInlineDocument</b>(<i></i>) 183 <b>__inInlineDocument</b>(<i></i>)
184
146 <p> 185 <p>
147 Private method to check, if the cursor is within an inline document. 186 Private method to check, if the cursor is within an inline document.
148 </p><dl> 187 </p>
188 <dl>
149 <dt>Returns:</dt> 189 <dt>Returns:</dt>
150 <dd> 190 <dd>
151 flag indicating, if the cursor is inside an inline document 191 flag indicating, if the cursor is inside an inline document
152 (boolean) 192 (boolean)
153 </dd> 193 </dd>
154 </dl><a NAME="CompleterRuby.__inSingleQuotedString" ID="CompleterRuby.__inSingleQuotedString"></a> 194 </dl>
195 <a NAME="CompleterRuby.__inSingleQuotedString" ID="CompleterRuby.__inSingleQuotedString"></a>
155 <h4>CompleterRuby.__inSingleQuotedString</h4> 196 <h4>CompleterRuby.__inSingleQuotedString</h4>
156 <b>__inSingleQuotedString</b>(<i></i>) 197 <b>__inSingleQuotedString</b>(<i></i>)
198
157 <p> 199 <p>
158 Private method to check, if the cursor is within a single quoted 200 Private method to check, if the cursor is within a single quoted
159 string. 201 string.
160 </p><dl> 202 </p>
203 <dl>
161 <dt>Returns:</dt> 204 <dt>Returns:</dt>
162 <dd> 205 <dd>
163 flag indicating, if the cursor is inside a single 206 flag indicating, if the cursor is inside a single
164 quoted string (boolean) 207 quoted string (boolean)
165 </dd> 208 </dd>
166 </dl><a NAME="CompleterRuby.charAdded" ID="CompleterRuby.charAdded"></a> 209 </dl>
210 <a NAME="CompleterRuby.charAdded" ID="CompleterRuby.charAdded"></a>
167 <h4>CompleterRuby.charAdded</h4> 211 <h4>CompleterRuby.charAdded</h4>
168 <b>charAdded</b>(<i>charNumber</i>) 212 <b>charAdded</b>(<i>charNumber</i>)
213
169 <p> 214 <p>
170 Public slot called to handle the user entering a character. 215 Public slot called to handle the user entering a character.
171 </p><dl> 216 </p>
217 <dl>
218
172 <dt><i>charNumber</i></dt> 219 <dt><i>charNumber</i></dt>
173 <dd> 220 <dd>
174 value of the character entered (integer) 221 value of the character entered (integer)
175 </dd> 222 </dd>
176 </dl><a NAME="CompleterRuby.readSettings" ID="CompleterRuby.readSettings"></a> 223 </dl>
224 <a NAME="CompleterRuby.readSettings" ID="CompleterRuby.readSettings"></a>
177 <h4>CompleterRuby.readSettings</h4> 225 <h4>CompleterRuby.readSettings</h4>
178 <b>readSettings</b>(<i></i>) 226 <b>readSettings</b>(<i></i>)
227
179 <p> 228 <p>
180 Public slot called to reread the configuration parameters. 229 Public slot called to reread the configuration parameters.
181 </p> 230 </p>
182 <div align="right"><a href="#top">Up</a></div> 231 <div align="right"><a href="#top">Up</a></div>
183 <hr /> 232 <hr />

Mercurial Repository: eric

eric ide

mercurial