Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.QScintilla.TypingCompleters.CompleterRuby.html
Documentation/Source/eric6.QScintilla.TypingCompleters.CompleterRuby.html
- changeset 3673
- e26d7d0c1088
equal
deleted
inserted
replaced
| 3670:f0cb7579c0b4 | 3673:e26d7d0c1088 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.QScintilla.TypingCompleters.CompleterRuby</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.TypingCompleters.CompleterRuby</h1> | |
| 23 <p> | |
| 24 Module implementing a typing completer for Ruby. | |
| 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="#CompleterRuby">CompleterRuby</a></td> | |
| 34 <td>Class implementing typing completer for Ruby.</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="CompleterRuby" ID="CompleterRuby"></a> | |
| 43 <h2>CompleterRuby</h2> | |
| 44 <p> | |
| 45 Class implementing typing completer for Ruby. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 CompleterBase | |
| 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="#CompleterRuby.__init__">CompleterRuby</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#CompleterRuby.__inComment">__inComment</a></td> | |
| 64 <td>Private method to check, if the cursor is inside a comment.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#CompleterRuby.__inDoubleQuotedString">__inDoubleQuotedString</a></td> | |
| 67 <td>Private method to check, if the cursor is within a double quoted string.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#CompleterRuby.__inHereDocument">__inHereDocument</a></td> | |
| 70 <td>Private method to check, if the cursor is within a here document.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#CompleterRuby.__inInlineDocument">__inInlineDocument</a></td> | |
| 73 <td>Private method to check, if the cursor is within an inline document.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#CompleterRuby.__inSingleQuotedString">__inSingleQuotedString</a></td> | |
| 76 <td>Private method to check, if the cursor is within a single quoted string.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#CompleterRuby.charAdded">charAdded</a></td> | |
| 79 <td>Public slot called to handle the user entering a character.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#CompleterRuby.readSettings">readSettings</a></td> | |
| 82 <td>Public slot called to reread the configuration parameters.</td> | |
| 83 </tr> | |
| 84 </table> | |
| 85 <h3>Static Methods</h3> | |
| 86 <table> | |
| 87 <tr><td>None</td></tr> | |
| 88 </table> | |
| 89 <a NAME="CompleterRuby.__init__" ID="CompleterRuby.__init__"></a> | |
| 90 <h4>CompleterRuby (Constructor)</h4> | |
| 91 <b>CompleterRuby</b>(<i>editor, parent=None</i>) | |
| 92 <p> | |
| 93 Constructor | |
| 94 </p><dl> | |
| 95 <dt><i>editor</i></dt> | |
| 96 <dd> | |
| 97 reference to the editor object (QScintilla.Editor) | |
| 98 </dd><dt><i>parent</i></dt> | |
| 99 <dd> | |
| 100 reference to the parent object (QObject) | |
| 101 </dd> | |
| 102 </dl><a NAME="CompleterRuby.__inComment" ID="CompleterRuby.__inComment"></a> | |
| 103 <h4>CompleterRuby.__inComment</h4> | |
| 104 <b>__inComment</b>(<i>line, col</i>) | |
| 105 <p> | |
| 106 Private method to check, if the cursor is inside a comment. | |
| 107 </p><dl> | |
| 108 <dt><i>line</i></dt> | |
| 109 <dd> | |
| 110 current line (integer) | |
| 111 </dd><dt><i>col</i></dt> | |
| 112 <dd> | |
| 113 current position within line (integer) | |
| 114 </dd> | |
| 115 </dl><dl> | |
| 116 <dt>Returns:</dt> | |
| 117 <dd> | |
| 118 flag indicating, if the cursor is inside a comment (boolean) | |
| 119 </dd> | |
| 120 </dl><a NAME="CompleterRuby.__inDoubleQuotedString" ID="CompleterRuby.__inDoubleQuotedString"></a> | |
| 121 <h4>CompleterRuby.__inDoubleQuotedString</h4> | |
| 122 <b>__inDoubleQuotedString</b>(<i></i>) | |
| 123 <p> | |
| 124 Private method to check, if the cursor is within a double quoted | |
| 125 string. | |
| 126 </p><dl> | |
| 127 <dt>Returns:</dt> | |
| 128 <dd> | |
| 129 flag indicating, if the cursor is inside a double | |
| 130 quoted string (boolean) | |
| 131 </dd> | |
| 132 </dl><a NAME="CompleterRuby.__inHereDocument" ID="CompleterRuby.__inHereDocument"></a> | |
| 133 <h4>CompleterRuby.__inHereDocument</h4> | |
| 134 <b>__inHereDocument</b>(<i></i>) | |
| 135 <p> | |
| 136 Private method to check, if the cursor is within a here document. | |
| 137 </p><dl> | |
| 138 <dt>Returns:</dt> | |
| 139 <dd> | |
| 140 flag indicating, if the cursor is inside a here document | |
| 141 (boolean) | |
| 142 </dd> | |
| 143 </dl><a NAME="CompleterRuby.__inInlineDocument" ID="CompleterRuby.__inInlineDocument"></a> | |
| 144 <h4>CompleterRuby.__inInlineDocument</h4> | |
| 145 <b>__inInlineDocument</b>(<i></i>) | |
| 146 <p> | |
| 147 Private method to check, if the cursor is within an inline document. | |
| 148 </p><dl> | |
| 149 <dt>Returns:</dt> | |
| 150 <dd> | |
| 151 flag indicating, if the cursor is inside an inline document | |
| 152 (boolean) | |
| 153 </dd> | |
| 154 </dl><a NAME="CompleterRuby.__inSingleQuotedString" ID="CompleterRuby.__inSingleQuotedString"></a> | |
| 155 <h4>CompleterRuby.__inSingleQuotedString</h4> | |
| 156 <b>__inSingleQuotedString</b>(<i></i>) | |
| 157 <p> | |
| 158 Private method to check, if the cursor is within a single quoted | |
| 159 string. | |
| 160 </p><dl> | |
| 161 <dt>Returns:</dt> | |
| 162 <dd> | |
| 163 flag indicating, if the cursor is inside a single | |
| 164 quoted string (boolean) | |
| 165 </dd> | |
| 166 </dl><a NAME="CompleterRuby.charAdded" ID="CompleterRuby.charAdded"></a> | |
| 167 <h4>CompleterRuby.charAdded</h4> | |
| 168 <b>charAdded</b>(<i>charNumber</i>) | |
| 169 <p> | |
| 170 Public slot called to handle the user entering a character. | |
| 171 </p><dl> | |
| 172 <dt><i>charNumber</i></dt> | |
| 173 <dd> | |
| 174 value of the character entered (integer) | |
| 175 </dd> | |
| 176 </dl><a NAME="CompleterRuby.readSettings" ID="CompleterRuby.readSettings"></a> | |
| 177 <h4>CompleterRuby.readSettings</h4> | |
| 178 <b>readSettings</b>(<i></i>) | |
| 179 <p> | |
| 180 Public slot called to reread the configuration parameters. | |
| 181 </p> | |
| 182 <div align="right"><a href="#top">Up</a></div> | |
| 183 <hr /> | |
| 184 </body></html> |
