Mercurial Repositories > Kivy Project / file comparison
comparison: ProjectKivy/Documentation/source/Plugin_Project_Kivy.PluginProjectKivy.html
ProjectKivy/Documentation/source/Plugin_Project_Kivy.PluginProjectKivy.html
- branch
- eric7
- changeset 59
- fb361b396c68
- parent 48
- d79fe2dd2cb9
equal
deleted
inserted
replaced
| 58:610af455ef9a | 59:fb361b396c68 |
|---|---|
| 31 | 31 |
| 32 <tr> | 32 <tr> |
| 33 <td><a href="#apiFiles">apiFiles</a></td> | 33 <td><a href="#apiFiles">apiFiles</a></td> |
| 34 <td>Module function to return the API files made available by this plugin.</td> | 34 <td>Module function to return the API files made available by this plugin.</td> |
| 35 </tr> | 35 </tr> |
| 36 <tr> | |
| 37 <td><a href="#prepareUninstall">prepareUninstall</a></td> | |
| 38 <td>Module function to prepare for an uninstallation.</td> | |
| 39 </tr> | |
| 36 </table> | 40 </table> |
| 37 <hr /> | 41 <hr /> |
| 38 <hr /> | 42 <hr /> |
| 39 <a NAME="ProjectKivyPlugin" ID="ProjectKivyPlugin"></a> | 43 <a NAME="ProjectKivyPlugin" ID="ProjectKivyPlugin"></a> |
| 40 <h2>ProjectKivyPlugin</h2> | 44 <h2>ProjectKivyPlugin</h2> |
| 45 <h3>Derived from</h3> | 49 <h3>Derived from</h3> |
| 46 QObject | 50 QObject |
| 47 <h3>Class Attributes</h3> | 51 <h3>Class Attributes</h3> |
| 48 | 52 |
| 49 <table> | 53 <table> |
| 50 <tr><td>KivyLexerEntry</td></tr><tr><td>KivyLexerKey</td></tr><tr><td>lexerAssociations</td></tr> | 54 <tr><td>KivyLexerEntry</td></tr><tr><td>KivyLexerKey</td></tr><tr><td>PreferencesKey</td></tr><tr><td>lexerAssociations</td></tr> |
| 51 </table> | 55 </table> |
| 52 <h3>Class Methods</h3> | 56 <h3>Class Methods</h3> |
| 53 | 57 |
| 54 <table> | 58 <table> |
| 55 <tr><td>None</td></tr> | 59 <tr><td>None</td></tr> |
| 73 <tr> | 77 <tr> |
| 74 <td><a href="#ProjectKivyPlugin.activate">activate</a></td> | 78 <td><a href="#ProjectKivyPlugin.activate">activate</a></td> |
| 75 <td>Public method to activate this plugin.</td> | 79 <td>Public method to activate this plugin.</td> |
| 76 </tr> | 80 </tr> |
| 77 <tr> | 81 <tr> |
| 82 <td><a href="#ProjectKivyPlugin.createTypingCompleter">createTypingCompleter</a></td> | |
| 83 <td>Public method to create a typing completer object for the given editor.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#ProjectKivyPlugin.createTypingCompleterConfigWidget">createTypingCompleterConfigWidget</a></td> | |
| 87 <td>Public method to create and populate the typing completer configuration widget.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 78 <td><a href="#ProjectKivyPlugin.deactivate">deactivate</a></td> | 90 <td><a href="#ProjectKivyPlugin.deactivate">deactivate</a></td> |
| 79 <td>Public method to deactivate this plugin.</td> | 91 <td>Public method to deactivate this plugin.</td> |
| 80 </tr> | 92 </tr> |
| 81 <tr> | 93 <tr> |
| 82 <td><a href="#ProjectKivyPlugin.fileTypesCallback">fileTypesCallback</a></td> | 94 <td><a href="#ProjectKivyPlugin.fileTypesCallback">fileTypesCallback</a></td> |
| 85 <tr> | 97 <tr> |
| 86 <td><a href="#ProjectKivyPlugin.getLexer">getLexer</a></td> | 98 <td><a href="#ProjectKivyPlugin.getLexer">getLexer</a></td> |
| 87 <td>Public method to instantiate a Pygments Kivy lexer object.</td> | 99 <td>Public method to instantiate a Pygments Kivy lexer object.</td> |
| 88 </tr> | 100 </tr> |
| 89 <tr> | 101 <tr> |
| 102 <td><a href="#ProjectKivyPlugin.getTypingPreferences">getTypingPreferences</a></td> | |
| 103 <td>Public method to retrieve the typing completer settings.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 90 <td><a href="#ProjectKivyPlugin.lexerAssociationCallback">lexerAssociationCallback</a></td> | 106 <td><a href="#ProjectKivyPlugin.lexerAssociationCallback">lexerAssociationCallback</a></td> |
| 91 <td>Public method to get the lexer association of the Kivy project type for a file.</td> | 107 <td>Public method to get the lexer association of the Kivy project type for a file.</td> |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#ProjectKivyPlugin.setTypingPreferences">setTypingPreferences</a></td> | |
| 111 <td>Public method to store the typing completer settings.</td> | |
| 92 </tr> | 112 </tr> |
| 93 </table> | 113 </table> |
| 94 <h3>Static Methods</h3> | 114 <h3>Static Methods</h3> |
| 95 | 115 |
| 96 <table> | 116 <table> |
| 142 <dt>Return Type:</dt> | 162 <dt>Return Type:</dt> |
| 143 <dd> | 163 <dd> |
| 144 bool | 164 bool |
| 145 </dd> | 165 </dd> |
| 146 </dl> | 166 </dl> |
| 167 <a NAME="ProjectKivyPlugin.createTypingCompleter" ID="ProjectKivyPlugin.createTypingCompleter"></a> | |
| 168 <h4>ProjectKivyPlugin.createTypingCompleter</h4> | |
| 169 <b>createTypingCompleter</b>(<i>editor, parent=None</i>) | |
| 170 | |
| 171 <p> | |
| 172 Public method to create a typing completer object for the given editor. | |
| 173 </p> | |
| 174 <dl> | |
| 175 | |
| 176 <dt><i>editor</i> (Editor)</dt> | |
| 177 <dd> | |
| 178 reference to the editor object | |
| 179 </dd> | |
| 180 <dt><i>parent</i> (QObject (optional))</dt> | |
| 181 <dd> | |
| 182 reference to the parent object (defaults to None) | |
| 183 </dd> | |
| 184 </dl> | |
| 185 <dl> | |
| 186 <dt>Return:</dt> | |
| 187 <dd> | |
| 188 reference to the instantiated typing completer object | |
| 189 </dd> | |
| 190 </dl> | |
| 191 <dl> | |
| 192 <dt>Return Type:</dt> | |
| 193 <dd> | |
| 194 CompleterKivy | |
| 195 </dd> | |
| 196 </dl> | |
| 197 <a NAME="ProjectKivyPlugin.createTypingCompleterConfigWidget" ID="ProjectKivyPlugin.createTypingCompleterConfigWidget"></a> | |
| 198 <h4>ProjectKivyPlugin.createTypingCompleterConfigWidget</h4> | |
| 199 <b>createTypingCompleterConfigWidget</b>(<i></i>) | |
| 200 | |
| 201 <p> | |
| 202 Public method to create and populate the typing completer configuration widget. | |
| 203 </p> | |
| 204 <dl> | |
| 205 <dt>Return:</dt> | |
| 206 <dd> | |
| 207 instantiated and populated configuration widget | |
| 208 </dd> | |
| 209 </dl> | |
| 210 <dl> | |
| 211 <dt>Return Type:</dt> | |
| 212 <dd> | |
| 213 CompleterKivyConfigWidget | |
| 214 </dd> | |
| 215 </dl> | |
| 147 <a NAME="ProjectKivyPlugin.deactivate" ID="ProjectKivyPlugin.deactivate"></a> | 216 <a NAME="ProjectKivyPlugin.deactivate" ID="ProjectKivyPlugin.deactivate"></a> |
| 148 <h4>ProjectKivyPlugin.deactivate</h4> | 217 <h4>ProjectKivyPlugin.deactivate</h4> |
| 149 <b>deactivate</b>(<i></i>) | 218 <b>deactivate</b>(<i></i>) |
| 150 | 219 |
| 151 <p> | 220 <p> |
| 194 <dt>Return Type:</dt> | 263 <dt>Return Type:</dt> |
| 195 <dd> | 264 <dd> |
| 196 QsciLexer | 265 QsciLexer |
| 197 </dd> | 266 </dd> |
| 198 </dl> | 267 </dl> |
| 268 <a NAME="ProjectKivyPlugin.getTypingPreferences" ID="ProjectKivyPlugin.getTypingPreferences"></a> | |
| 269 <h4>ProjectKivyPlugin.getTypingPreferences</h4> | |
| 270 <b>getTypingPreferences</b>(<i>key</i>) | |
| 271 | |
| 272 <p> | |
| 273 Public method to retrieve the typing completer settings. | |
| 274 </p> | |
| 275 <dl> | |
| 276 | |
| 277 <dt><i>key</i> (str)</dt> | |
| 278 <dd> | |
| 279 the key of the value to get | |
| 280 </dd> | |
| 281 </dl> | |
| 282 <dl> | |
| 283 <dt>Return:</dt> | |
| 284 <dd> | |
| 285 value of the requested setting | |
| 286 </dd> | |
| 287 </dl> | |
| 288 <dl> | |
| 289 <dt>Return Type:</dt> | |
| 290 <dd> | |
| 291 Any | |
| 292 </dd> | |
| 293 </dl> | |
| 199 <a NAME="ProjectKivyPlugin.lexerAssociationCallback" ID="ProjectKivyPlugin.lexerAssociationCallback"></a> | 294 <a NAME="ProjectKivyPlugin.lexerAssociationCallback" ID="ProjectKivyPlugin.lexerAssociationCallback"></a> |
| 200 <h4>ProjectKivyPlugin.lexerAssociationCallback</h4> | 295 <h4>ProjectKivyPlugin.lexerAssociationCallback</h4> |
| 201 <b>lexerAssociationCallback</b>(<i>filename</i>) | 296 <b>lexerAssociationCallback</b>(<i>filename</i>) |
| 202 | 297 |
| 203 <p> | 298 <p> |
| 222 <dt>Return Type:</dt> | 317 <dt>Return Type:</dt> |
| 223 <dd> | 318 <dd> |
| 224 str | 319 str |
| 225 </dd> | 320 </dd> |
| 226 </dl> | 321 </dl> |
| 322 <a NAME="ProjectKivyPlugin.setTypingPreferences" ID="ProjectKivyPlugin.setTypingPreferences"></a> | |
| 323 <h4>ProjectKivyPlugin.setTypingPreferences</h4> | |
| 324 <b>setTypingPreferences</b>(<i>key, value</i>) | |
| 325 | |
| 326 <p> | |
| 327 Public method to store the typing completer settings. | |
| 328 </p> | |
| 329 <dl> | |
| 330 | |
| 331 <dt><i>key</i> (str)</dt> | |
| 332 <dd> | |
| 333 the key of the setting to be set | |
| 334 </dd> | |
| 335 <dt><i>value</i> (Any)</dt> | |
| 336 <dd> | |
| 337 value to be set | |
| 338 </dd> | |
| 339 </dl> | |
| 227 <div align="right"><a href="#top">Up</a></div> | 340 <div align="right"><a href="#top">Up</a></div> |
| 228 <hr /> | 341 <hr /> |
| 229 <hr /> | 342 <hr /> |
| 230 <a NAME="apiFiles" ID="apiFiles"></a> | 343 <a NAME="apiFiles" ID="apiFiles"></a> |
| 231 <h2>apiFiles</h2> | 344 <h2>apiFiles</h2> |
| 253 list of str | 366 list of str |
| 254 </dd> | 367 </dd> |
| 255 </dl> | 368 </dl> |
| 256 <div align="right"><a href="#top">Up</a></div> | 369 <div align="right"><a href="#top">Up</a></div> |
| 257 <hr /> | 370 <hr /> |
| 371 <hr /> | |
| 372 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | |
| 373 <h2>prepareUninstall</h2> | |
| 374 <b>prepareUninstall</b>(<i></i>) | |
| 375 | |
| 376 <p> | |
| 377 Module function to prepare for an uninstallation. | |
| 378 </p> | |
| 379 <div align="right"><a href="#top">Up</a></div> | |
| 380 <hr /> | |
| 258 </body></html> | 381 </body></html> |
