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