Mercurial Repositories > Kivy Project / file comparison
comparison: ProjectKivy/Documentation/source/Plugin_Project_Kivy.PluginProjectKivy.html
ProjectKivy/Documentation/source/Plugin_Project_Kivy.PluginProjectKivy.html
- changeset 41
- 1d6ea7d73189
- parent 22
- 0de62c0edd89
- child 46
- 2ff6b838b040
equal
deleted
inserted
replaced
| 40:9fce5c54f543 | 41:1d6ea7d73189 |
|---|---|
| 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>Plugin_Project_Kivy.PluginProjectKivy</h1> | 23 <h1>Plugin_Project_Kivy.PluginProjectKivy</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the Kivy project plug-in. | 26 Module implementing the Kivy project plug-in. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 27 <table> | 29 |
| 28 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> | 30 <table> |
| 31 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> | |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 31 <table> | 34 |
| 35 <table> | |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#ProjectKivyPlugin">ProjectKivyPlugin</a></td> | 38 <td><a href="#ProjectKivyPlugin">ProjectKivyPlugin</a></td> |
| 34 <td>Class implementing the Kivy project plugin.</td> | 39 <td>Class implementing the Kivy project plugin.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 38 <table> | 43 |
| 44 <table> | |
| 45 | |
| 39 <tr> | 46 <tr> |
| 40 <td><a href="#apiFiles">apiFiles</a></td> | 47 <td><a href="#apiFiles">apiFiles</a></td> |
| 41 <td>Module function to return the API files made available by this plugin.</td> | 48 <td>Module function to return the API files made available by this plugin.</td> |
| 42 </tr> | 49 </tr> |
| 43 </table> | 50 </table> |
| 44 <hr /><hr /> | 51 <hr /> |
| 52 <hr /> | |
| 45 <a NAME="ProjectKivyPlugin" ID="ProjectKivyPlugin"></a> | 53 <a NAME="ProjectKivyPlugin" ID="ProjectKivyPlugin"></a> |
| 46 <h2>ProjectKivyPlugin</h2> | 54 <h2>ProjectKivyPlugin</h2> |
| 55 | |
| 47 <p> | 56 <p> |
| 48 Class implementing the Kivy project plugin. | 57 Class implementing the Kivy project plugin. |
| 49 </p> | 58 </p> |
| 50 <h3>Derived from</h3> | 59 <h3>Derived from</h3> |
| 51 QObject | 60 QObject |
| 52 <h3>Class Attributes</h3> | 61 <h3>Class Attributes</h3> |
| 62 | |
| 53 <table> | 63 <table> |
| 54 <tr><td>KivyLexerEntry</td></tr><tr><td>KivyLexerKey</td></tr><tr><td>lexerAssociations</td></tr> | 64 <tr><td>KivyLexerEntry</td></tr><tr><td>KivyLexerKey</td></tr><tr><td>lexerAssociations</td></tr> |
| 55 </table> | 65 </table> |
| 56 <h3>Class Methods</h3> | 66 <h3>Class Methods</h3> |
| 67 | |
| 57 <table> | 68 <table> |
| 58 <tr><td>None</td></tr> | 69 <tr><td>None</td></tr> |
| 59 </table> | 70 </table> |
| 60 <h3>Methods</h3> | 71 <h3>Methods</h3> |
| 61 <table> | 72 |
| 73 <table> | |
| 74 | |
| 62 <tr> | 75 <tr> |
| 63 <td><a href="#ProjectKivyPlugin.__init__">ProjectKivyPlugin</a></td> | 76 <td><a href="#ProjectKivyPlugin.__init__">ProjectKivyPlugin</a></td> |
| 64 <td>Constructor</td> | 77 <td>Constructor</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#ProjectKivyPlugin.__initialize">__initialize</a></td> | 80 <td><a href="#ProjectKivyPlugin.__initialize">__initialize</a></td> |
| 67 <td>Private slot to (re)initialize the plugin.</td> | 81 <td>Private slot to (re)initialize the plugin.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#ProjectKivyPlugin.__loadTranslator">__loadTranslator</a></td> | 84 <td><a href="#ProjectKivyPlugin.__loadTranslator">__loadTranslator</a></td> |
| 70 <td>Private method to load the translation file.</td> | 85 <td>Private method to load the translation file.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#ProjectKivyPlugin.activate">activate</a></td> | 88 <td><a href="#ProjectKivyPlugin.activate">activate</a></td> |
| 73 <td>Public method to activate this plugin.</td> | 89 <td>Public method to activate this plugin.</td> |
| 74 </tr><tr> | 90 </tr> |
| 91 <tr> | |
| 75 <td><a href="#ProjectKivyPlugin.deactivate">deactivate</a></td> | 92 <td><a href="#ProjectKivyPlugin.deactivate">deactivate</a></td> |
| 76 <td>Public method to deactivate this plugin.</td> | 93 <td>Public method to deactivate this plugin.</td> |
| 77 </tr><tr> | 94 </tr> |
| 95 <tr> | |
| 78 <td><a href="#ProjectKivyPlugin.fileTypesCallback">fileTypesCallback</a></td> | 96 <td><a href="#ProjectKivyPlugin.fileTypesCallback">fileTypesCallback</a></td> |
| 79 <td>Public method get the filetype associations of the Kivy project type.</td> | 97 <td>Public method get the filetype associations of the Kivy project type.</td> |
| 80 </tr><tr> | 98 </tr> |
| 99 <tr> | |
| 81 <td><a href="#ProjectKivyPlugin.getLexer">getLexer</a></td> | 100 <td><a href="#ProjectKivyPlugin.getLexer">getLexer</a></td> |
| 82 <td>Public method to instantiate a Pygments Kivy lexer object.</td> | 101 <td>Public method to instantiate a Pygments Kivy lexer object.</td> |
| 83 </tr><tr> | 102 </tr> |
| 103 <tr> | |
| 84 <td><a href="#ProjectKivyPlugin.lexerAssociationCallback">lexerAssociationCallback</a></td> | 104 <td><a href="#ProjectKivyPlugin.lexerAssociationCallback">lexerAssociationCallback</a></td> |
| 85 <td>Public method to get the lexer association of the Kivy project type for a file.</td> | 105 <td>Public method to get the lexer association of the Kivy project type for a file.</td> |
| 86 </tr> | 106 </tr> |
| 87 </table> | 107 </table> |
| 88 <h3>Static Methods</h3> | 108 <h3>Static Methods</h3> |
| 109 | |
| 89 <table> | 110 <table> |
| 90 <tr><td>None</td></tr> | 111 <tr><td>None</td></tr> |
| 91 </table> | 112 </table> |
| 113 | |
| 92 <a NAME="ProjectKivyPlugin.__init__" ID="ProjectKivyPlugin.__init__"></a> | 114 <a NAME="ProjectKivyPlugin.__init__" ID="ProjectKivyPlugin.__init__"></a> |
| 93 <h4>ProjectKivyPlugin (Constructor)</h4> | 115 <h4>ProjectKivyPlugin (Constructor)</h4> |
| 94 <b>ProjectKivyPlugin</b>(<i>ui</i>) | 116 <b>ProjectKivyPlugin</b>(<i>ui</i>) |
| 117 | |
| 95 <p> | 118 <p> |
| 96 Constructor | 119 Constructor |
| 97 </p><dl> | 120 </p> |
| 121 <dl> | |
| 122 | |
| 98 <dt><i>ui</i></dt> | 123 <dt><i>ui</i></dt> |
| 99 <dd> | 124 <dd> |
| 100 reference to the user interface object (UI.UserInterface) | 125 reference to the user interface object (UI.UserInterface) |
| 101 </dd> | 126 </dd> |
| 102 </dl><a NAME="ProjectKivyPlugin.__initialize" ID="ProjectKivyPlugin.__initialize"></a> | 127 </dl> |
| 128 <a NAME="ProjectKivyPlugin.__initialize" ID="ProjectKivyPlugin.__initialize"></a> | |
| 103 <h4>ProjectKivyPlugin.__initialize</h4> | 129 <h4>ProjectKivyPlugin.__initialize</h4> |
| 104 <b>__initialize</b>(<i></i>) | 130 <b>__initialize</b>(<i></i>) |
| 131 | |
| 105 <p> | 132 <p> |
| 106 Private slot to (re)initialize the plugin. | 133 Private slot to (re)initialize the plugin. |
| 107 </p><a NAME="ProjectKivyPlugin.__loadTranslator" ID="ProjectKivyPlugin.__loadTranslator"></a> | 134 </p> |
| 135 <a NAME="ProjectKivyPlugin.__loadTranslator" ID="ProjectKivyPlugin.__loadTranslator"></a> | |
| 108 <h4>ProjectKivyPlugin.__loadTranslator</h4> | 136 <h4>ProjectKivyPlugin.__loadTranslator</h4> |
| 109 <b>__loadTranslator</b>(<i></i>) | 137 <b>__loadTranslator</b>(<i></i>) |
| 138 | |
| 110 <p> | 139 <p> |
| 111 Private method to load the translation file. | 140 Private method to load the translation file. |
| 112 </p><a NAME="ProjectKivyPlugin.activate" ID="ProjectKivyPlugin.activate"></a> | 141 </p> |
| 142 <a NAME="ProjectKivyPlugin.activate" ID="ProjectKivyPlugin.activate"></a> | |
| 113 <h4>ProjectKivyPlugin.activate</h4> | 143 <h4>ProjectKivyPlugin.activate</h4> |
| 114 <b>activate</b>(<i></i>) | 144 <b>activate</b>(<i></i>) |
| 145 | |
| 115 <p> | 146 <p> |
| 116 Public method to activate this plugin. | 147 Public method to activate this plugin. |
| 117 </p><dl> | 148 </p> |
| 149 <dl> | |
| 118 <dt>Returns:</dt> | 150 <dt>Returns:</dt> |
| 119 <dd> | 151 <dd> |
| 120 tuple of None and activation status (boolean) | 152 tuple of None and activation status (boolean) |
| 121 </dd> | 153 </dd> |
| 122 </dl><a NAME="ProjectKivyPlugin.deactivate" ID="ProjectKivyPlugin.deactivate"></a> | 154 </dl> |
| 155 <a NAME="ProjectKivyPlugin.deactivate" ID="ProjectKivyPlugin.deactivate"></a> | |
| 123 <h4>ProjectKivyPlugin.deactivate</h4> | 156 <h4>ProjectKivyPlugin.deactivate</h4> |
| 124 <b>deactivate</b>(<i></i>) | 157 <b>deactivate</b>(<i></i>) |
| 158 | |
| 125 <p> | 159 <p> |
| 126 Public method to deactivate this plugin. | 160 Public method to deactivate this plugin. |
| 127 </p><a NAME="ProjectKivyPlugin.fileTypesCallback" ID="ProjectKivyPlugin.fileTypesCallback"></a> | 161 </p> |
| 162 <a NAME="ProjectKivyPlugin.fileTypesCallback" ID="ProjectKivyPlugin.fileTypesCallback"></a> | |
| 128 <h4>ProjectKivyPlugin.fileTypesCallback</h4> | 163 <h4>ProjectKivyPlugin.fileTypesCallback</h4> |
| 129 <b>fileTypesCallback</b>(<i></i>) | 164 <b>fileTypesCallback</b>(<i></i>) |
| 165 | |
| 130 <p> | 166 <p> |
| 131 Public method get the filetype associations of the Kivy project type. | 167 Public method get the filetype associations of the Kivy project type. |
| 132 </p><dl> | 168 </p> |
| 169 <dl> | |
| 133 <dt>Returns:</dt> | 170 <dt>Returns:</dt> |
| 134 <dd> | 171 <dd> |
| 135 dictionary with file type associations | 172 dictionary with file type associations |
| 136 </dd> | 173 </dd> |
| 137 </dl><a NAME="ProjectKivyPlugin.getLexer" ID="ProjectKivyPlugin.getLexer"></a> | 174 </dl> |
| 175 <a NAME="ProjectKivyPlugin.getLexer" ID="ProjectKivyPlugin.getLexer"></a> | |
| 138 <h4>ProjectKivyPlugin.getLexer</h4> | 176 <h4>ProjectKivyPlugin.getLexer</h4> |
| 139 <b>getLexer</b>(<i>parent=None</i>) | 177 <b>getLexer</b>(<i>parent=None</i>) |
| 178 | |
| 140 <p> | 179 <p> |
| 141 Public method to instantiate a Pygments Kivy lexer object. | 180 Public method to instantiate a Pygments Kivy lexer object. |
| 142 </p><dl> | 181 </p> |
| 182 <dl> | |
| 183 | |
| 143 <dt><i>parent</i></dt> | 184 <dt><i>parent</i></dt> |
| 144 <dd> | 185 <dd> |
| 145 reference to the parent object (QObject) | 186 reference to the parent object (QObject) |
| 146 </dd> | 187 </dd> |
| 147 </dl><dl> | 188 </dl> |
| 189 <dl> | |
| 148 <dt>Returns:</dt> | 190 <dt>Returns:</dt> |
| 149 <dd> | 191 <dd> |
| 150 reference to the instanciated lexer object (QsciLexer) | 192 reference to the instanciated lexer object (QsciLexer) |
| 151 </dd> | 193 </dd> |
| 152 </dl><a NAME="ProjectKivyPlugin.lexerAssociationCallback" ID="ProjectKivyPlugin.lexerAssociationCallback"></a> | 194 </dl> |
| 195 <a NAME="ProjectKivyPlugin.lexerAssociationCallback" ID="ProjectKivyPlugin.lexerAssociationCallback"></a> | |
| 153 <h4>ProjectKivyPlugin.lexerAssociationCallback</h4> | 196 <h4>ProjectKivyPlugin.lexerAssociationCallback</h4> |
| 154 <b>lexerAssociationCallback</b>(<i>filename</i>) | 197 <b>lexerAssociationCallback</b>(<i>filename</i>) |
| 198 | |
| 155 <p> | 199 <p> |
| 156 Public method to get the lexer association of the Kivy project type for | 200 Public method to get the lexer association of the Kivy project type for |
| 157 a file. | 201 a file. |
| 158 </p><dl> | 202 </p> |
| 203 <dl> | |
| 204 | |
| 159 <dt><i>filename</i></dt> | 205 <dt><i>filename</i></dt> |
| 160 <dd> | 206 <dd> |
| 161 name of the file (string) | 207 name of the file (string) |
| 162 </dd> | 208 </dd> |
| 163 </dl><dl> | 209 </dl> |
| 210 <dl> | |
| 164 <dt>Returns:</dt> | 211 <dt>Returns:</dt> |
| 165 <dd> | 212 <dd> |
| 166 name of the lexer (string) (Pygments lexers are prefixed with | 213 name of the lexer (string) (Pygments lexers are prefixed with |
| 167 'Pygments|') | 214 'Pygments|') |
| 168 </dd> | 215 </dd> |
| 169 </dl> | 216 </dl> |
| 170 <div align="right"><a href="#top">Up</a></div> | 217 <div align="right"><a href="#top">Up</a></div> |
| 171 <hr /><hr /> | 218 <hr /> |
| 219 <hr /> | |
| 172 <a NAME="apiFiles" ID="apiFiles"></a> | 220 <a NAME="apiFiles" ID="apiFiles"></a> |
| 173 <h2>apiFiles</h2> | 221 <h2>apiFiles</h2> |
| 174 <b>apiFiles</b>(<i>language</i>) | 222 <b>apiFiles</b>(<i>language</i>) |
| 223 | |
| 175 <p> | 224 <p> |
| 176 Module function to return the API files made available by this plugin. | 225 Module function to return the API files made available by this plugin. |
| 177 </p><dl> | 226 </p> |
| 227 <dl> | |
| 228 | |
| 178 <dt><i>language</i></dt> | 229 <dt><i>language</i></dt> |
| 179 <dd> | 230 <dd> |
| 180 language to get API file for (string) | 231 language to get API file for (string) |
| 181 </dd> | 232 </dd> |
| 182 </dl><dl> | 233 </dl> |
| 234 <dl> | |
| 183 <dt>Returns:</dt> | 235 <dt>Returns:</dt> |
| 184 <dd> | 236 <dd> |
| 185 list of API filenames (list of string) | 237 list of API filenames (list of string) |
| 186 </dd> | 238 </dd> |
| 187 </dl> | 239 </dl> |
