Mercurial Repositories > Kivy Project / file comparison
comparison: ProjectKivy/Documentation/source/Plugin_Project_Kivy.PluginProjectKivy.html
ProjectKivy/Documentation/source/Plugin_Project_Kivy.PluginProjectKivy.html
- changeset 3
- b7e3e3b131ea
- child 11
- a3a738778142
equal
deleted
inserted
replaced
| 2:373da5610be1 | 3:b7e3e3b131ea |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Project_Kivy.PluginProjectKivy</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Project_Kivy.PluginProjectKivy</h1> | |
| 23 <p> | |
| 24 Module implementing the Kivy project plug-in. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 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>shortDescription</td></tr><tr><td>version</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#ProjectKivyPlugin">ProjectKivyPlugin</a></td> | |
| 34 <td>Class implementing the Kivy project plugin.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr> | |
| 40 <td><a href="#apiFiles">apiFiles</a></td> | |
| 41 <td>Module function to return the API files made available by this plugin.</td> | |
| 42 </tr> | |
| 43 </table> | |
| 44 <hr /><hr /> | |
| 45 <a NAME="ProjectKivyPlugin" ID="ProjectKivyPlugin"></a> | |
| 46 <h2>ProjectKivyPlugin</h2> | |
| 47 <p> | |
| 48 Class implementing the Kivy project plugin. | |
| 49 </p> | |
| 50 <h3>Derived from</h3> | |
| 51 QObject | |
| 52 <h3>Class Attributes</h3> | |
| 53 <table> | |
| 54 <tr><td>KivyLexerEntry</td></tr><tr><td>KivyLexerKey</td></tr><tr><td>lexerAssociations</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Methods</h3> | |
| 61 <table> | |
| 62 <tr> | |
| 63 <td><a href="#ProjectKivyPlugin.__init__">ProjectKivyPlugin</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#ProjectKivyPlugin.__initialize">__initialize</a></td> | |
| 67 <td>Private slot to (re)initialize the plugin.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#ProjectKivyPlugin.__loadTranslator">__loadTranslator</a></td> | |
| 70 <td>Private method to load the translation file.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#ProjectKivyPlugin.activate">activate</a></td> | |
| 73 <td>Public method to activate this plugin.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#ProjectKivyPlugin.deactivate">deactivate</a></td> | |
| 76 <td>Public method to deactivate this plugin.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#ProjectKivyPlugin.fileTypesCallback">fileTypesCallback</a></td> | |
| 79 <td>Public method get the filetype associations of the Kivy project type.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#ProjectKivyPlugin.getLexer">getLexer</a></td> | |
| 82 <td>Public method to instantiate a Pygments Kivy lexer object.</td> | |
| 83 </tr><tr> | |
| 84 <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> | |
| 86 </tr> | |
| 87 </table> | |
| 88 <h3>Static Methods</h3> | |
| 89 <table> | |
| 90 <tr><td>None</td></tr> | |
| 91 </table> | |
| 92 <a NAME="ProjectKivyPlugin.__init__" ID="ProjectKivyPlugin.__init__"></a> | |
| 93 <h4>ProjectKivyPlugin (Constructor)</h4> | |
| 94 <b>ProjectKivyPlugin</b>(<i>ui</i>) | |
| 95 <p> | |
| 96 Constructor | |
| 97 </p><dl> | |
| 98 <dt><i>ui</i></dt> | |
| 99 <dd> | |
| 100 reference to the user interface object (UI.UserInterface) | |
| 101 </dd> | |
| 102 </dl><a NAME="ProjectKivyPlugin.__initialize" ID="ProjectKivyPlugin.__initialize"></a> | |
| 103 <h4>ProjectKivyPlugin.__initialize</h4> | |
| 104 <b>__initialize</b>(<i></i>) | |
| 105 <p> | |
| 106 Private slot to (re)initialize the plugin. | |
| 107 </p><a NAME="ProjectKivyPlugin.__loadTranslator" ID="ProjectKivyPlugin.__loadTranslator"></a> | |
| 108 <h4>ProjectKivyPlugin.__loadTranslator</h4> | |
| 109 <b>__loadTranslator</b>(<i></i>) | |
| 110 <p> | |
| 111 Private method to load the translation file. | |
| 112 </p><a NAME="ProjectKivyPlugin.activate" ID="ProjectKivyPlugin.activate"></a> | |
| 113 <h4>ProjectKivyPlugin.activate</h4> | |
| 114 <b>activate</b>(<i></i>) | |
| 115 <p> | |
| 116 Public method to activate this plugin. | |
| 117 </p><dl> | |
| 118 <dt>Returns:</dt> | |
| 119 <dd> | |
| 120 tuple of None and activation status (boolean) | |
| 121 </dd> | |
| 122 </dl><a NAME="ProjectKivyPlugin.deactivate" ID="ProjectKivyPlugin.deactivate"></a> | |
| 123 <h4>ProjectKivyPlugin.deactivate</h4> | |
| 124 <b>deactivate</b>(<i></i>) | |
| 125 <p> | |
| 126 Public method to deactivate this plugin. | |
| 127 </p><a NAME="ProjectKivyPlugin.fileTypesCallback" ID="ProjectKivyPlugin.fileTypesCallback"></a> | |
| 128 <h4>ProjectKivyPlugin.fileTypesCallback</h4> | |
| 129 <b>fileTypesCallback</b>(<i></i>) | |
| 130 <p> | |
| 131 Public method get the filetype associations of the Kivy project type. | |
| 132 </p><dl> | |
| 133 <dt>Returns:</dt> | |
| 134 <dd> | |
| 135 dictionary with file type associations | |
| 136 </dd> | |
| 137 </dl><a NAME="ProjectKivyPlugin.getLexer" ID="ProjectKivyPlugin.getLexer"></a> | |
| 138 <h4>ProjectKivyPlugin.getLexer</h4> | |
| 139 <b>getLexer</b>(<i>parent=None</i>) | |
| 140 <p> | |
| 141 Public method to instantiate a Pygments Kivy lexer object. | |
| 142 </p><dl> | |
| 143 <dt><i>parent</i></dt> | |
| 144 <dd> | |
| 145 reference to the parent object (QObject) | |
| 146 </dd> | |
| 147 </dl><dl> | |
| 148 <dt>Returns:</dt> | |
| 149 <dd> | |
| 150 reference to the instanciated lexer object (QsciLexer) | |
| 151 </dd> | |
| 152 </dl><a NAME="ProjectKivyPlugin.lexerAssociationCallback" ID="ProjectKivyPlugin.lexerAssociationCallback"></a> | |
| 153 <h4>ProjectKivyPlugin.lexerAssociationCallback</h4> | |
| 154 <b>lexerAssociationCallback</b>(<i>filename</i>) | |
| 155 <p> | |
| 156 Public method to get the lexer association of the Kivy project type for | |
| 157 a file. | |
| 158 </p><dl> | |
| 159 <dt><i>filename</i></dt> | |
| 160 <dd> | |
| 161 name of the file (string) | |
| 162 </dd> | |
| 163 </dl><dl> | |
| 164 <dt>Returns:</dt> | |
| 165 <dd> | |
| 166 name of the lexer (string) (Pygments lexers are prefixed with 'Pygments|') | |
| 167 </dd> | |
| 168 </dl> | |
| 169 <div align="right"><a href="#top">Up</a></div> | |
| 170 <hr /><hr /> | |
| 171 <a NAME="apiFiles" ID="apiFiles"></a> | |
| 172 <h2>apiFiles</h2> | |
| 173 <b>apiFiles</b>(<i>language</i>) | |
| 174 <p> | |
| 175 Module function to return the API files made available by this plugin. | |
| 176 </p><dl> | |
| 177 <dt>Returns:</dt> | |
| 178 <dd> | |
| 179 list of API filenames (list of string) | |
| 180 </dd> | |
| 181 </dl> | |
| 182 <div align="right"><a href="#top">Up</a></div> | |
| 183 <hr /> | |
| 184 </body></html> |
