Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.QScintilla.TypingCompleters.CompleterRuby.html
Documentation/Source/eric4.QScintilla.TypingCompleters.CompleterRuby.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric4.QScintilla.TypingCompleters.CompleterRuby</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.QScintilla.TypingCompleters.CompleterRuby</h1> | |
| 24 <p> | |
| 25 Module implementing a typing completer for Ruby. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#CompleterRuby">CompleterRuby</a></td> | |
| 35 <td>Class implementing typing completer for Ruby.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="CompleterRuby" ID="CompleterRuby"></a> | |
| 44 <h2>CompleterRuby</h2> | |
| 45 <p> | |
| 46 Class implementing typing completer for Ruby. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 CompleterBase | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#CompleterRuby.__init__">CompleterRuby</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#CompleterRuby.__inComment">__inComment</a></td> | |
| 61 <td>Private method to check, if the cursor is inside a comment</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#CompleterRuby.__inDoubleQuotedString">__inDoubleQuotedString</a></td> | |
| 64 <td>Private method to check, if the cursor is within a double quoted string.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#CompleterRuby.__inHereDocument">__inHereDocument</a></td> | |
| 67 <td>Private method to check, if the cursor is within a here document.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#CompleterRuby.__inInlineDocument">__inInlineDocument</a></td> | |
| 70 <td>Private method to check, if the cursor is within an inline document.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#CompleterRuby.__inSingleQuotedString">__inSingleQuotedString</a></td> | |
| 73 <td>Private method to check, if the cursor is within a single quoted string.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#CompleterRuby.charAdded">charAdded</a></td> | |
| 76 <td>Public slot called to handle the user entering a character.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#CompleterRuby.readSettings">readSettings</a></td> | |
| 79 <td>Public slot called to reread the configuration parameters.</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <a NAME="CompleterRuby.__init__" ID="CompleterRuby.__init__"></a> | |
| 83 <h4>CompleterRuby (Constructor)</h4> | |
| 84 <b>CompleterRuby</b>(<i>editor, parent = None</i>) | |
| 85 <p> | |
| 86 Constructor | |
| 87 </p><dl> | |
| 88 <dt><i>editor</i></dt> | |
| 89 <dd> | |
| 90 reference to the editor object (QScintilla.Editor) | |
| 91 </dd><dt><i>parent</i></dt> | |
| 92 <dd> | |
| 93 reference to the parent object (QObject) | |
| 94 </dd> | |
| 95 </dl><a NAME="CompleterRuby.__inComment" ID="CompleterRuby.__inComment"></a> | |
| 96 <h4>CompleterRuby.__inComment</h4> | |
| 97 <b>__inComment</b>(<i>line, col</i>) | |
| 98 <p> | |
| 99 Private method to check, if the cursor is inside a comment | |
| 100 </p><dl> | |
| 101 <dt><i>line</i></dt> | |
| 102 <dd> | |
| 103 current line (integer) | |
| 104 </dd><dt><i>col</i></dt> | |
| 105 <dd> | |
| 106 current position within line (integer) | |
| 107 </dd> | |
| 108 </dl><dl> | |
| 109 <dt>Returns:</dt> | |
| 110 <dd> | |
| 111 flag indicating, if the cursor is inside a comment (boolean) | |
| 112 </dd> | |
| 113 </dl><a NAME="CompleterRuby.__inDoubleQuotedString" ID="CompleterRuby.__inDoubleQuotedString"></a> | |
| 114 <h4>CompleterRuby.__inDoubleQuotedString</h4> | |
| 115 <b>__inDoubleQuotedString</b>(<i></i>) | |
| 116 <p> | |
| 117 Private method to check, if the cursor is within a double quoted string. | |
| 118 </p><dl> | |
| 119 <dt>Returns:</dt> | |
| 120 <dd> | |
| 121 flag indicating, if the cursor is inside a double | |
| 122 quoted string (boolean) | |
| 123 </dd> | |
| 124 </dl><a NAME="CompleterRuby.__inHereDocument" ID="CompleterRuby.__inHereDocument"></a> | |
| 125 <h4>CompleterRuby.__inHereDocument</h4> | |
| 126 <b>__inHereDocument</b>(<i></i>) | |
| 127 <p> | |
| 128 Private method to check, if the cursor is within a here document. | |
| 129 </p><dl> | |
| 130 <dt>Returns:</dt> | |
| 131 <dd> | |
| 132 flag indicating, if the cursor is inside a here document (boolean) | |
| 133 </dd> | |
| 134 </dl><a NAME="CompleterRuby.__inInlineDocument" ID="CompleterRuby.__inInlineDocument"></a> | |
| 135 <h4>CompleterRuby.__inInlineDocument</h4> | |
| 136 <b>__inInlineDocument</b>(<i></i>) | |
| 137 <p> | |
| 138 Private method to check, if the cursor is within an inline document. | |
| 139 </p><dl> | |
| 140 <dt>Returns:</dt> | |
| 141 <dd> | |
| 142 flag indicating, if the cursor is inside an inline document (boolean) | |
| 143 </dd> | |
| 144 </dl><a NAME="CompleterRuby.__inSingleQuotedString" ID="CompleterRuby.__inSingleQuotedString"></a> | |
| 145 <h4>CompleterRuby.__inSingleQuotedString</h4> | |
| 146 <b>__inSingleQuotedString</b>(<i></i>) | |
| 147 <p> | |
| 148 Private method to check, if the cursor is within a single quoted string. | |
| 149 </p><dl> | |
| 150 <dt>Returns:</dt> | |
| 151 <dd> | |
| 152 flag indicating, if the cursor is inside a single | |
| 153 quoted string (boolean) | |
| 154 </dd> | |
| 155 </dl><a NAME="CompleterRuby.charAdded" ID="CompleterRuby.charAdded"></a> | |
| 156 <h4>CompleterRuby.charAdded</h4> | |
| 157 <b>charAdded</b>(<i>charNumber</i>) | |
| 158 <p> | |
| 159 Public slot called to handle the user entering a character. | |
| 160 </p><dl> | |
| 161 <dt><i>charNumber</i></dt> | |
| 162 <dd> | |
| 163 value of the character entered (integer) | |
| 164 </dd> | |
| 165 </dl><a NAME="CompleterRuby.readSettings" ID="CompleterRuby.readSettings"></a> | |
| 166 <h4>CompleterRuby.readSettings</h4> | |
| 167 <b>readSettings</b>(<i></i>) | |
| 168 <p> | |
| 169 Public slot called to reread the configuration parameters. | |
| 170 </p> | |
| 171 <div align="right"><a href="#top">Up</a></div> | |
| 172 <hr /> | |
| 173 </body></html> |
