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