Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.QScintilla.TypingCompleters.CompleterBase.html
eric6/Documentation/Source/eric6.QScintilla.TypingCompleters.CompleterBase.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.QScintilla.TypingCompleters.CompleterBase</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.CompleterBase</h1> | |
| 23 <p> | |
| 24 Module implementing a base class for all typing completers. | |
| 25 </p><p> | |
| 26 Typing completers are classes that implement some convenience actions, | |
| 27 that are performed while the user is typing (e.g. insert ')' when the | |
| 28 user types '('). | |
| 29 </p> | |
| 30 <h3>Global Attributes</h3> | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <h3>Classes</h3> | |
| 35 <table> | |
| 36 <tr> | |
| 37 <td><a href="#CompleterBase">CompleterBase</a></td> | |
| 38 <td>Class implementing the base class for all completers.</td> | |
| 39 </tr> | |
| 40 </table> | |
| 41 <h3>Functions</h3> | |
| 42 <table> | |
| 43 <tr><td>None</td></tr> | |
| 44 </table> | |
| 45 <hr /><hr /> | |
| 46 <a NAME="CompleterBase" ID="CompleterBase"></a> | |
| 47 <h2>CompleterBase</h2> | |
| 48 <p> | |
| 49 Class implementing the base class for all completers. | |
| 50 </p> | |
| 51 <h3>Derived from</h3> | |
| 52 QObject | |
| 53 <h3>Class Attributes</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Class Methods</h3> | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Methods</h3> | |
| 62 <table> | |
| 63 <tr> | |
| 64 <td><a href="#CompleterBase.__init__">CompleterBase</a></td> | |
| 65 <td>Constructor</td> | |
| 66 </tr><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><tr> | |
| 70 <td><a href="#CompleterBase.isEnabled">isEnabled</a></td> | |
| 71 <td>Public method to get the enabled state.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#CompleterBase.readSettings">readSettings</a></td> | |
| 74 <td>Public slot called to reread the configuration parameters.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#CompleterBase.setEnabled">setEnabled</a></td> | |
| 77 <td>Public slot to set the enabled state.</td> | |
| 78 </tr> | |
| 79 </table> | |
| 80 <h3>Static Methods</h3> | |
| 81 <table> | |
| 82 <tr><td>None</td></tr> | |
| 83 </table> | |
| 84 <a NAME="CompleterBase.__init__" ID="CompleterBase.__init__"></a> | |
| 85 <h4>CompleterBase (Constructor)</h4> | |
| 86 <b>CompleterBase</b>(<i>editor, parent=None</i>) | |
| 87 <p> | |
| 88 Constructor | |
| 89 </p><dl> | |
| 90 <dt><i>editor</i></dt> | |
| 91 <dd> | |
| 92 reference to the editor object (QScintilla.Editor) | |
| 93 </dd><dt><i>parent</i></dt> | |
| 94 <dd> | |
| 95 reference to the parent object (QObject) | |
| 96 If parent is None, we set the editor as the parent. | |
| 97 </dd> | |
| 98 </dl><a NAME="CompleterBase.charAdded" ID="CompleterBase.charAdded"></a> | |
| 99 <h4>CompleterBase.charAdded</h4> | |
| 100 <b>charAdded</b>(<i>charNumber</i>) | |
| 101 <p> | |
| 102 Public slot called to handle the user entering a character. | |
| 103 </p><p> | |
| 104 Note 1: this slot must be overridden by subclasses implementing the | |
| 105 specific behavior for the language. | |
| 106 </p><p> | |
| 107 Note 2: charNumber can be greater than 255 because the editor is | |
| 108 in UTF-8 mode by default. | |
| 109 </p><dl> | |
| 110 <dt><i>charNumber</i></dt> | |
| 111 <dd> | |
| 112 value of the character entered (integer) | |
| 113 </dd> | |
| 114 </dl><a NAME="CompleterBase.isEnabled" ID="CompleterBase.isEnabled"></a> | |
| 115 <h4>CompleterBase.isEnabled</h4> | |
| 116 <b>isEnabled</b>(<i></i>) | |
| 117 <p> | |
| 118 Public method to get the enabled state. | |
| 119 </p><dl> | |
| 120 <dt>Returns:</dt> | |
| 121 <dd> | |
| 122 enabled state (boolean) | |
| 123 </dd> | |
| 124 </dl><a NAME="CompleterBase.readSettings" ID="CompleterBase.readSettings"></a> | |
| 125 <h4>CompleterBase.readSettings</h4> | |
| 126 <b>readSettings</b>(<i></i>) | |
| 127 <p> | |
| 128 Public slot called to reread the configuration parameters. | |
| 129 </p><p> | |
| 130 Note: this slot should be overridden by subclasses having | |
| 131 configurable parameters. | |
| 132 </p><a NAME="CompleterBase.setEnabled" ID="CompleterBase.setEnabled"></a> | |
| 133 <h4>CompleterBase.setEnabled</h4> | |
| 134 <b>setEnabled</b>(<i>enable</i>) | |
| 135 <p> | |
| 136 Public slot to set the enabled state. | |
| 137 </p><dl> | |
| 138 <dt><i>enable</i></dt> | |
| 139 <dd> | |
| 140 flag indicating the new enabled state (boolean) | |
| 141 </dd> | |
| 142 </dl> | |
| 143 <div align="right"><a href="#top">Up</a></div> | |
| 144 <hr /> | |
| 145 </body></html> |
