ProjectKivy/Documentation/source/Plugin_Project_Kivy.PluginProjectKivy.html

branch
eric7
changeset 46
2ff6b838b040
parent 41
1d6ea7d73189
child 48
d79fe2dd2cb9
equal deleted inserted replaced
45:9249df1200c1 46:2ff6b838b040
118 <p> 118 <p>
119 Constructor 119 Constructor
120 </p> 120 </p>
121 <dl> 121 <dl>
122 122
123 <dt><i>ui</i></dt> 123 <dt><i>ui</i> (UserInterface)</dt>
124 <dd> 124 <dd>
125 reference to the user interface object (UI.UserInterface) 125 reference to the user interface object
126 </dd> 126 </dd>
127 </dl> 127 </dl>
128 <a NAME="ProjectKivyPlugin.__initialize" ID="ProjectKivyPlugin.__initialize"></a> 128 <a NAME="ProjectKivyPlugin.__initialize" ID="ProjectKivyPlugin.__initialize"></a>
129 <h4>ProjectKivyPlugin.__initialize</h4> 129 <h4>ProjectKivyPlugin.__initialize</h4>
130 <b>__initialize</b>(<i></i>) 130 <b>__initialize</b>(<i></i>)
145 145
146 <p> 146 <p>
147 Public method to activate this plugin. 147 Public method to activate this plugin.
148 </p> 148 </p>
149 <dl> 149 <dl>
150 <dt>Returns:</dt> 150 <dt>Return:</dt>
151 <dd> 151 <dd>
152 tuple of None and activation status (boolean) 152 tuple of None and activation status
153 </dd>
154 </dl>
155 <dl>
156 <dt>Return Type:</dt>
157 <dd>
158 bool
153 </dd> 159 </dd>
154 </dl> 160 </dl>
155 <a NAME="ProjectKivyPlugin.deactivate" ID="ProjectKivyPlugin.deactivate"></a> 161 <a NAME="ProjectKivyPlugin.deactivate" ID="ProjectKivyPlugin.deactivate"></a>
156 <h4>ProjectKivyPlugin.deactivate</h4> 162 <h4>ProjectKivyPlugin.deactivate</h4>
157 <b>deactivate</b>(<i></i>) 163 <b>deactivate</b>(<i></i>)
165 171
166 <p> 172 <p>
167 Public method get the filetype associations of the Kivy project type. 173 Public method get the filetype associations of the Kivy project type.
168 </p> 174 </p>
169 <dl> 175 <dl>
170 <dt>Returns:</dt> 176 <dt>Return:</dt>
171 <dd> 177 <dd>
172 dictionary with file type associations 178 dictionary with file type associations
179 </dd>
180 </dl>
181 <dl>
182 <dt>Return Type:</dt>
183 <dd>
184 dict
173 </dd> 185 </dd>
174 </dl> 186 </dl>
175 <a NAME="ProjectKivyPlugin.getLexer" ID="ProjectKivyPlugin.getLexer"></a> 187 <a NAME="ProjectKivyPlugin.getLexer" ID="ProjectKivyPlugin.getLexer"></a>
176 <h4>ProjectKivyPlugin.getLexer</h4> 188 <h4>ProjectKivyPlugin.getLexer</h4>
177 <b>getLexer</b>(<i>parent=None</i>) 189 <b>getLexer</b>(<i>parent=None</i>)
179 <p> 191 <p>
180 Public method to instantiate a Pygments Kivy lexer object. 192 Public method to instantiate a Pygments Kivy lexer object.
181 </p> 193 </p>
182 <dl> 194 <dl>
183 195
184 <dt><i>parent</i></dt> 196 <dt><i>parent</i> (QObject)</dt>
185 <dd> 197 <dd>
186 reference to the parent object (QObject) 198 reference to the parent object
187 </dd> 199 </dd>
188 </dl> 200 </dl>
189 <dl> 201 <dl>
190 <dt>Returns:</dt> 202 <dt>Return:</dt>
191 <dd> 203 <dd>
192 reference to the instanciated lexer object (QsciLexer) 204 reference to the instanciated lexer object
205 </dd>
206 </dl>
207 <dl>
208 <dt>Return Type:</dt>
209 <dd>
210 QsciLexer
193 </dd> 211 </dd>
194 </dl> 212 </dl>
195 <a NAME="ProjectKivyPlugin.lexerAssociationCallback" ID="ProjectKivyPlugin.lexerAssociationCallback"></a> 213 <a NAME="ProjectKivyPlugin.lexerAssociationCallback" ID="ProjectKivyPlugin.lexerAssociationCallback"></a>
196 <h4>ProjectKivyPlugin.lexerAssociationCallback</h4> 214 <h4>ProjectKivyPlugin.lexerAssociationCallback</h4>
197 <b>lexerAssociationCallback</b>(<i>filename</i>) 215 <b>lexerAssociationCallback</b>(<i>filename</i>)
200 Public method to get the lexer association of the Kivy project type for 218 Public method to get the lexer association of the Kivy project type for
201 a file. 219 a file.
202 </p> 220 </p>
203 <dl> 221 <dl>
204 222
205 <dt><i>filename</i></dt> 223 <dt><i>filename</i> (str)</dt>
206 <dd> 224 <dd>
207 name of the file (string) 225 name of the file
208 </dd> 226 </dd>
209 </dl> 227 </dl>
210 <dl> 228 <dl>
211 <dt>Returns:</dt> 229 <dt>Return:</dt>
212 <dd> 230 <dd>
213 name of the lexer (string) (Pygments lexers are prefixed with 231 name of the lexer (Pygments lexers are prefixed with
214 'Pygments|') 232 'Pygments|')
233 </dd>
234 </dl>
235 <dl>
236 <dt>Return Type:</dt>
237 <dd>
238 str
215 </dd> 239 </dd>
216 </dl> 240 </dl>
217 <div align="right"><a href="#top">Up</a></div> 241 <div align="right"><a href="#top">Up</a></div>
218 <hr /> 242 <hr />
219 <hr /> 243 <hr />
224 <p> 248 <p>
225 Module function to return the API files made available by this plugin. 249 Module function to return the API files made available by this plugin.
226 </p> 250 </p>
227 <dl> 251 <dl>
228 252
229 <dt><i>language</i></dt> 253 <dt><i>language</i> (str)</dt>
230 <dd> 254 <dd>
231 language to get API file for (string) 255 language to get API file for
232 </dd> 256 </dd>
233 </dl> 257 </dl>
234 <dl> 258 <dl>
235 <dt>Returns:</dt> 259 <dt>Return:</dt>
236 <dd> 260 <dd>
237 list of API filenames (list of string) 261 list of API filenames
262 </dd>
263 </dl>
264 <dl>
265 <dt>Return Type:</dt>
266 <dd>
267 list of str
238 </dd> 268 </dd>
239 </dl> 269 </dl>
240 <div align="right"><a href="#top">Up</a></div> 270 <div align="right"><a href="#top">Up</a></div>
241 <hr /> 271 <hr />
242 </body></html> 272 </body></html>

eric ide

mercurial