Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QScintilla.TypingCompleters.CompleterBase.html
src/eric7/Documentation/Source/eric7.QScintilla.TypingCompleters.CompleterBase.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10431
- 64157aeb0312
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.QScintilla.TypingCompleters.CompleterBase</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.QScintilla.TypingCompleters.CompleterBase</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a base class for all typing completers. | |
| 13 </p> | |
| 14 <p> | |
| 15 Typing completers are classes that implement some convenience actions, | |
| 16 that are performed while the user is typing (e.g. insert ')' when the | |
| 17 user types '('). | |
| 18 </p> | |
| 19 <h3>Global Attributes</h3> | |
| 20 | |
| 21 <table> | |
| 22 <tr><td>None</td></tr> | |
| 23 </table> | |
| 24 <h3>Classes</h3> | |
| 25 | |
| 26 <table> | |
| 27 | |
| 28 <tr> | |
| 29 <td><a href="#CompleterBase">CompleterBase</a></td> | |
| 30 <td>Class implementing the base class for all completers.</td> | |
| 31 </tr> | |
| 32 </table> | |
| 33 <h3>Functions</h3> | |
| 34 | |
| 35 <table> | |
| 36 <tr><td>None</td></tr> | |
| 37 </table> | |
| 38 <hr /> | |
| 39 <hr /> | |
| 40 <a NAME="CompleterBase" ID="CompleterBase"></a> | |
| 41 <h2>CompleterBase</h2> | |
| 42 | |
| 43 <p> | |
| 44 Class implementing the base class for all completers. | |
| 45 </p> | |
| 46 <h3>Derived from</h3> | |
| 47 QObject | |
| 48 <h3>Class Attributes</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 <h3>Methods</h3> | |
| 59 | |
| 60 <table> | |
| 61 | |
| 62 <tr> | |
| 63 <td><a href="#CompleterBase.__init__">CompleterBase</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#CompleterBase.charAdded">charAdded</a></td> | |
| 68 <td>Public slot called to handle the user entering a character.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#CompleterBase.isEnabled">isEnabled</a></td> | |
| 72 <td>Public method to get the enabled state.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#CompleterBase.readSettings">readSettings</a></td> | |
| 76 <td>Public slot called to reread the configuration parameters.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#CompleterBase.setEnabled">setEnabled</a></td> | |
| 80 <td>Public slot to set the enabled state.</td> | |
| 81 </tr> | |
| 82 </table> | |
| 83 <h3>Static Methods</h3> | |
| 84 | |
| 85 <table> | |
| 86 <tr><td>None</td></tr> | |
| 87 </table> | |
| 88 | |
| 89 <a NAME="CompleterBase.__init__" ID="CompleterBase.__init__"></a> | |
| 90 <h4>CompleterBase (Constructor)</h4> | |
| 91 <b>CompleterBase</b>(<i>editor, parent=None</i>) | |
| 92 | |
| 93 <p> | |
| 94 Constructor | |
| 95 </p> | |
| 96 <dl> | |
| 97 | |
| 98 <dt><i>editor</i></dt> | |
| 99 <dd> | |
| 100 reference to the editor object (QScintilla.Editor) | |
| 101 </dd> | |
| 102 <dt><i>parent</i></dt> | |
| 103 <dd> | |
| 104 reference to the parent object (QObject) | |
| 105 If parent is None, we set the editor as the parent. | |
| 106 </dd> | |
| 107 </dl> | |
| 108 <a NAME="CompleterBase.charAdded" ID="CompleterBase.charAdded"></a> | |
| 109 <h4>CompleterBase.charAdded</h4> | |
| 110 <b>charAdded</b>(<i>charNumber</i>) | |
| 111 | |
| 112 <p> | |
| 113 Public slot called to handle the user entering a character. | |
| 114 </p> | |
| 115 <p> | |
| 116 Note 1: this slot must be overridden by subclasses implementing the | |
| 117 specific behavior for the language. | |
| 118 </p> | |
| 119 <p> | |
| 120 Note 2: charNumber can be greater than 255 because the editor is | |
| 121 in UTF-8 mode by default. | |
| 122 </p> | |
| 123 <dl> | |
| 124 | |
| 125 <dt><i>charNumber</i></dt> | |
| 126 <dd> | |
| 127 value of the character entered (integer) | |
| 128 </dd> | |
| 129 </dl> | |
| 130 <a NAME="CompleterBase.isEnabled" ID="CompleterBase.isEnabled"></a> | |
| 131 <h4>CompleterBase.isEnabled</h4> | |
| 132 <b>isEnabled</b>(<i></i>) | |
| 133 | |
| 134 <p> | |
| 135 Public method to get the enabled state. | |
| 136 </p> | |
| 137 <dl> | |
| 138 <dt>Return:</dt> | |
| 139 <dd> | |
| 140 enabled state (boolean) | |
| 141 </dd> | |
| 142 </dl> | |
| 143 <a NAME="CompleterBase.readSettings" ID="CompleterBase.readSettings"></a> | |
| 144 <h4>CompleterBase.readSettings</h4> | |
| 145 <b>readSettings</b>(<i></i>) | |
| 146 | |
| 147 <p> | |
| 148 Public slot called to reread the configuration parameters. | |
| 149 </p> | |
| 150 <p> | |
| 151 Note: this slot should be overridden by subclasses having | |
| 152 configurable parameters. | |
| 153 </p> | |
| 154 <a NAME="CompleterBase.setEnabled" ID="CompleterBase.setEnabled"></a> | |
| 155 <h4>CompleterBase.setEnabled</h4> | |
| 156 <b>setEnabled</b>(<i>enable</i>) | |
| 157 | |
| 158 <p> | |
| 159 Public slot to set the enabled state. | |
| 160 </p> | |
| 161 <dl> | |
| 162 | |
| 163 <dt><i>enable</i></dt> | |
| 164 <dd> | |
| 165 flag indicating the new enabled state (boolean) | |
| 166 </dd> | |
| 167 </dl> | |
| 168 <div align="right"><a href="#top">Up</a></div> | |
| 169 <hr /> | |
| 170 </body></html> |
