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