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