Mercurial Repositories > eric / file comparison

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

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

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
equal deleted inserted replaced
57:81326a94fdca 58:37f0444c3479
20 </style> 20 </style>
21 </head> 21 </head>
22 <body><a NAME="top" ID="top"></a> 22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.QScintilla.TypingCompleters.CompleterRuby</h1> 23 <h1>eric5.QScintilla.TypingCompleters.CompleterRuby</h1>
24 <p> 24 <p>
25 &#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#116;y&#112;&#105;&#110;&#103; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101;&#114; &#102;&#111;&#114; &#82;&#117;&#98;y. 25 Module implementing a typing completer for Ruby.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#CompleterRuby">CompleterRuby</a></td> 34 <td><a href="#CompleterRuby">CompleterRuby</a></td>
35 <td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;y&#112;&#105;&#110;&#103; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101;&#114; &#102;&#111;&#114; &#82;&#117;&#98;y.</td> 35 <td>Class implementing typing completer for Ruby.</td>
36 </tr> 36 </tr>
37 </table> 37 </table>
38 <h3>Functions</h3> 38 <h3>Functions</h3>
39 <table> 39 <table>
40 <tr><td>None</td></tr> 40 <tr><td>None</td></tr>
41 </table> 41 </table>
42 <hr /><hr /> 42 <hr /><hr />
43 <a NAME="CompleterRuby" ID="CompleterRuby"></a> 43 <a NAME="CompleterRuby" ID="CompleterRuby"></a>
44 <h2>CompleterRuby</h2> 44 <h2>CompleterRuby</h2>
45 <p> 45 <p>
46 &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;y&#112;&#105;&#110;&#103; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101;&#114; &#102;&#111;&#114; &#82;&#117;&#98;y. 46 Class implementing typing completer for Ruby.
47 </p> 47 </p>
48 <h3>Derived from</h3> 48 <h3>Derived from</h3>
49 CompleterBase 49 CompleterBase
50 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
51 <table> 51 <table>
53 </table> 53 </table>
54 <h3>Methods</h3> 54 <h3>Methods</h3>
55 <table> 55 <table>
56 <tr> 56 <tr>
57 <td><a href="#CompleterRuby.__init__">CompleterRuby</a></td> 57 <td><a href="#CompleterRuby.__init__">CompleterRuby</a></td>
58 <td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 58 <td>Constructor</td>
59 </tr><tr> 59 </tr><tr>
60 <td><a href="#CompleterRuby.__inComment">__inComment</a></td> 60 <td><a href="#CompleterRuby.__inComment">__inComment</a></td>
61 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; &#105;&#110;&#115;&#105;&#100;&#101; &#97; &#99;&#111;&#109;&#109;&#101;&#110;&#116;</td> 61 <td>Private method to check, if the cursor is inside a comment</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#CompleterRuby.__inDoubleQuotedString">__inDoubleQuotedString</a></td> 63 <td><a href="#CompleterRuby.__inDoubleQuotedString">__inDoubleQuotedString</a></td>
64 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; w&#105;&#116;&#104;&#105;&#110; &#97; &#100;&#111;&#117;&#98;&#108;&#101; &#113;&#117;&#111;&#116;&#101;&#100; &#115;&#116;&#114;&#105;&#110;&#103;.</td> 64 <td>Private method to check, if the cursor is within a double quoted string.</td>
65 </tr><tr> 65 </tr><tr>
66 <td><a href="#CompleterRuby.__inHereDocument">__inHereDocument</a></td> 66 <td><a href="#CompleterRuby.__inHereDocument">__inHereDocument</a></td>
67 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; w&#105;&#116;&#104;&#105;&#110; &#97; &#104;&#101;&#114;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;.</td> 67 <td>Private method to check, if the cursor is within a here document.</td>
68 </tr><tr> 68 </tr><tr>
69 <td><a href="#CompleterRuby.__inInlineDocument">__inInlineDocument</a></td> 69 <td><a href="#CompleterRuby.__inInlineDocument">__inInlineDocument</a></td>
70 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; w&#105;&#116;&#104;&#105;&#110; &#97;&#110; &#105;&#110;&#108;&#105;&#110;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;.</td> 70 <td>Private method to check, if the cursor is within an inline document.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#CompleterRuby.__inSingleQuotedString">__inSingleQuotedString</a></td> 72 <td><a href="#CompleterRuby.__inSingleQuotedString">__inSingleQuotedString</a></td>
73 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; w&#105;&#116;&#104;&#105;&#110; &#97; &#115;&#105;&#110;&#103;&#108;&#101; &#113;&#117;&#111;&#116;&#101;&#100; &#115;&#116;&#114;&#105;&#110;&#103;.</td> 73 <td>Private method to check, if the cursor is within a single quoted string.</td>
74 </tr><tr> 74 </tr><tr>
75 <td><a href="#CompleterRuby.charAdded">charAdded</a></td> 75 <td><a href="#CompleterRuby.charAdded">charAdded</a></td>
76 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#117;&#115;&#101;&#114; &#101;&#110;&#116;&#101;&#114;&#105;&#110;&#103; &#97; &#99;&#104;&#97;&#114;&#97;&#99;&#116;&#101;&#114;.</td> 76 <td>Public slot called to handle the user entering a character.</td>
77 </tr><tr> 77 </tr><tr>
78 <td><a href="#CompleterRuby.readSettings">readSettings</a></td> 78 <td><a href="#CompleterRuby.readSettings">readSettings</a></td>
79 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#114;&#101;&#114;&#101;&#97;&#100; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115;.</td> 79 <td>Public slot called to reread the configuration parameters.</td>
80 </tr> 80 </tr>
81 </table> 81 </table>
82 <a NAME="CompleterRuby.__init__" ID="CompleterRuby.__init__"></a> 82 <a NAME="CompleterRuby.__init__" ID="CompleterRuby.__init__"></a>
83 <h4>CompleterRuby (Constructor)</h4> 83 <h4>CompleterRuby (Constructor)</h4>
84 <b>CompleterRuby</b>(<i>editor, parent = None</i>) 84 <b>CompleterRuby</b>(<i>editor, parent = None</i>)
85 <p> 85 <p>
86 &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 86 Constructor
87 </p><dl> 87 </p><dl>
88 <dt><i>editor</i></dt> 88 <dt><i>editor</i></dt>
89 <dd> 89 <dd>
90 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#101;&#100;&#105;&#116;&#111;&#114; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#83;&#99;&#105;&#110;&#116;&#105;&#108;&#108;&#97;.&#69;&#100;&#105;&#116;&#111;&#114;) 90 reference to the editor object (QScintilla.Editor)
91 </dd><dt><i>parent</i></dt> 91 </dd><dt><i>parent</i></dt>
92 <dd> 92 <dd>
93 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#79;&#98;&#106;&#101;&#99;&#116;) 93 reference to the parent object (QObject)
94 </dd> 94 </dd>
95 </dl><a NAME="CompleterRuby.__inComment" ID="CompleterRuby.__inComment"></a> 95 </dl><a NAME="CompleterRuby.__inComment" ID="CompleterRuby.__inComment"></a>
96 <h4>CompleterRuby.__inComment</h4> 96 <h4>CompleterRuby.__inComment</h4>
97 <b>__inComment</b>(<i>line, col</i>) 97 <b>__inComment</b>(<i>line, col</i>)
98 <p> 98 <p>
99 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; &#105;&#110;&#115;&#105;&#100;&#101; &#97; &#99;&#111;&#109;&#109;&#101;&#110;&#116; 99 Private method to check, if the cursor is inside a comment
100 </p><dl> 100 </p><dl>
101 <dt><i>line</i></dt> 101 <dt><i>line</i></dt>
102 <dd> 102 <dd>
103 &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#108;&#105;&#110;&#101; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;) 103 current line (integer)
104 </dd><dt><i>col</i></dt> 104 </dd><dt><i>col</i></dt>
105 <dd> 105 <dd>
106 &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; w&#105;&#116;&#104;&#105;&#110; &#108;&#105;&#110;&#101; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;) 106 current position within line (integer)
107 </dd> 107 </dd>
108 </dl><dl> 108 </dl><dl>
109 <dt>Returns:</dt> 109 <dt>Returns:</dt>
110 <dd> 110 <dd>
111 &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; &#105;&#110;&#115;&#105;&#100;&#101; &#97; &#99;&#111;&#109;&#109;&#101;&#110;&#116; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 111 flag indicating, if the cursor is inside a comment (boolean)
112 </dd> 112 </dd>
113 </dl><a NAME="CompleterRuby.__inDoubleQuotedString" ID="CompleterRuby.__inDoubleQuotedString"></a> 113 </dl><a NAME="CompleterRuby.__inDoubleQuotedString" ID="CompleterRuby.__inDoubleQuotedString"></a>
114 <h4>CompleterRuby.__inDoubleQuotedString</h4> 114 <h4>CompleterRuby.__inDoubleQuotedString</h4>
115 <b>__inDoubleQuotedString</b>(<i></i>) 115 <b>__inDoubleQuotedString</b>(<i></i>)
116 <p> 116 <p>
117 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; w&#105;&#116;&#104;&#105;&#110; &#97; &#100;&#111;&#117;&#98;&#108;&#101; &#113;&#117;&#111;&#116;&#101;&#100; &#115;&#116;&#114;&#105;&#110;&#103;. 117 Private method to check, if the cursor is within a double quoted string.
118 </p><dl> 118 </p><dl>
119 <dt>Returns:</dt> 119 <dt>Returns:</dt>
120 <dd> 120 <dd>
121 &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; &#105;&#110;&#115;&#105;&#100;&#101; &#97; &#100;&#111;&#117;&#98;&#108;&#101; 121 flag indicating, if the cursor is inside a double
122 &#113;&#117;&#111;&#116;&#101;&#100; &#115;&#116;&#114;&#105;&#110;&#103; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 122 quoted string (boolean)
123 </dd> 123 </dd>
124 </dl><a NAME="CompleterRuby.__inHereDocument" ID="CompleterRuby.__inHereDocument"></a> 124 </dl><a NAME="CompleterRuby.__inHereDocument" ID="CompleterRuby.__inHereDocument"></a>
125 <h4>CompleterRuby.__inHereDocument</h4> 125 <h4>CompleterRuby.__inHereDocument</h4>
126 <b>__inHereDocument</b>(<i></i>) 126 <b>__inHereDocument</b>(<i></i>)
127 <p> 127 <p>
128 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; w&#105;&#116;&#104;&#105;&#110; &#97; &#104;&#101;&#114;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;. 128 Private method to check, if the cursor is within a here document.
129 </p><dl> 129 </p><dl>
130 <dt>Returns:</dt> 130 <dt>Returns:</dt>
131 <dd> 131 <dd>
132 &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; &#105;&#110;&#115;&#105;&#100;&#101; &#97; &#104;&#101;&#114;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 132 flag indicating, if the cursor is inside a here document (boolean)
133 </dd> 133 </dd>
134 </dl><a NAME="CompleterRuby.__inInlineDocument" ID="CompleterRuby.__inInlineDocument"></a> 134 </dl><a NAME="CompleterRuby.__inInlineDocument" ID="CompleterRuby.__inInlineDocument"></a>
135 <h4>CompleterRuby.__inInlineDocument</h4> 135 <h4>CompleterRuby.__inInlineDocument</h4>
136 <b>__inInlineDocument</b>(<i></i>) 136 <b>__inInlineDocument</b>(<i></i>)
137 <p> 137 <p>
138 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; w&#105;&#116;&#104;&#105;&#110; &#97;&#110; &#105;&#110;&#108;&#105;&#110;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;. 138 Private method to check, if the cursor is within an inline document.
139 </p><dl> 139 </p><dl>
140 <dt>Returns:</dt> 140 <dt>Returns:</dt>
141 <dd> 141 <dd>
142 &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; &#105;&#110;&#115;&#105;&#100;&#101; &#97;&#110; &#105;&#110;&#108;&#105;&#110;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 142 flag indicating, if the cursor is inside an inline document (boolean)
143 </dd> 143 </dd>
144 </dl><a NAME="CompleterRuby.__inSingleQuotedString" ID="CompleterRuby.__inSingleQuotedString"></a> 144 </dl><a NAME="CompleterRuby.__inSingleQuotedString" ID="CompleterRuby.__inSingleQuotedString"></a>
145 <h4>CompleterRuby.__inSingleQuotedString</h4> 145 <h4>CompleterRuby.__inSingleQuotedString</h4>
146 <b>__inSingleQuotedString</b>(<i></i>) 146 <b>__inSingleQuotedString</b>(<i></i>)
147 <p> 147 <p>
148 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; w&#105;&#116;&#104;&#105;&#110; &#97; &#115;&#105;&#110;&#103;&#108;&#101; &#113;&#117;&#111;&#116;&#101;&#100; &#115;&#116;&#114;&#105;&#110;&#103;. 148 Private method to check, if the cursor is within a single quoted string.
149 </p><dl> 149 </p><dl>
150 <dt>Returns:</dt> 150 <dt>Returns:</dt>
151 <dd> 151 <dd>
152 &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103;, &#105;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#115;&#111;&#114; &#105;&#115; &#105;&#110;&#115;&#105;&#100;&#101; &#97; &#115;&#105;&#110;&#103;&#108;&#101; 152 flag indicating, if the cursor is inside a single
153 &#113;&#117;&#111;&#116;&#101;&#100; &#115;&#116;&#114;&#105;&#110;&#103; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 153 quoted string (boolean)
154 </dd> 154 </dd>
155 </dl><a NAME="CompleterRuby.charAdded" ID="CompleterRuby.charAdded"></a> 155 </dl><a NAME="CompleterRuby.charAdded" ID="CompleterRuby.charAdded"></a>
156 <h4>CompleterRuby.charAdded</h4> 156 <h4>CompleterRuby.charAdded</h4>
157 <b>charAdded</b>(<i>charNumber</i>) 157 <b>charAdded</b>(<i>charNumber</i>)
158 <p> 158 <p>
159 &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#117;&#115;&#101;&#114; &#101;&#110;&#116;&#101;&#114;&#105;&#110;&#103; &#97; &#99;&#104;&#97;&#114;&#97;&#99;&#116;&#101;&#114;. 159 Public slot called to handle the user entering a character.
160 </p><dl> 160 </p><dl>
161 <dt><i>charNumber</i></dt> 161 <dt><i>charNumber</i></dt>
162 <dd> 162 <dd>
163 v&#97;&#108;&#117;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#104;&#97;&#114;&#97;&#99;&#116;&#101;&#114; &#101;&#110;&#116;&#101;&#114;&#101;&#100; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;) 163 value of the character entered (integer)
164 </dd> 164 </dd>
165 </dl><a NAME="CompleterRuby.readSettings" ID="CompleterRuby.readSettings"></a> 165 </dl><a NAME="CompleterRuby.readSettings" ID="CompleterRuby.readSettings"></a>
166 <h4>CompleterRuby.readSettings</h4> 166 <h4>CompleterRuby.readSettings</h4>
167 <b>readSettings</b>(<i></i>) 167 <b>readSettings</b>(<i></i>)
168 <p> 168 <p>
169 &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#114;&#101;&#114;&#101;&#97;&#100; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115;. 169 Public slot called to reread the configuration parameters.
170 </p> 170 </p>
171 <div align="right"><a href="#top">Up</a></div> 171 <div align="right"><a href="#top">Up</a></div>
172 <hr /> 172 <hr />
173 </body></html> 173 </body></html>

Mercurial Repository: eric

eric ide

mercurial