ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.PluginProjectPyramid.html

changeset 144
5c3684ee818e
parent 138
72ebb74aa42d
child 147
eb28b4b6f7f5
equal deleted inserted replaced
143:4ef44e854b39 144:5c3684ee818e
210 210
211 <p> 211 <p>
212 Public method to activate this plugin. 212 Public method to activate this plugin.
213 </p> 213 </p>
214 <dl> 214 <dl>
215 <dt>Returns:</dt> 215 <dt>Return:</dt>
216 <dd> 216 <dd>
217 tuple of None and activation status (boolean) 217 tuple of None and activation status (boolean)
218 </dd> 218 </dd>
219 </dl> 219 </dl>
220 <a NAME="ProjectPyramidPlugin.binaryTranslationsCallback" ID="ProjectPyramidPlugin.binaryTranslationsCallback"></a> 220 <a NAME="ProjectPyramidPlugin.binaryTranslationsCallback" ID="ProjectPyramidPlugin.binaryTranslationsCallback"></a>
231 <dd> 231 <dd>
232 name of the translation source file (string) 232 name of the translation source file (string)
233 </dd> 233 </dd>
234 </dl> 234 </dl>
235 <dl> 235 <dl>
236 <dt>Returns:</dt> 236 <dt>Return:</dt>
237 <dd> 237 <dd>
238 name of the binary translation file (string) 238 name of the binary translation file (string)
239 </dd> 239 </dd>
240 </dl> 240 </dl>
241 <a NAME="ProjectPyramidPlugin.deactivate" ID="ProjectPyramidPlugin.deactivate"></a> 241 <a NAME="ProjectPyramidPlugin.deactivate" ID="ProjectPyramidPlugin.deactivate"></a>
252 <p> 252 <p>
253 Public method get the filetype associations of the Pyramid project 253 Public method get the filetype associations of the Pyramid project
254 type. 254 type.
255 </p> 255 </p>
256 <dl> 256 <dl>
257 <dt>Returns:</dt> 257 <dt>Return:</dt>
258 <dd> 258 <dd>
259 dictionary with file type associations 259 dictionary with file type associations
260 </dd> 260 </dd>
261 </dl> 261 </dl>
262 <a NAME="ProjectPyramidPlugin.getDefaultPreference" ID="ProjectPyramidPlugin.getDefaultPreference"></a> 262 <a NAME="ProjectPyramidPlugin.getDefaultPreference" ID="ProjectPyramidPlugin.getDefaultPreference"></a>
272 <dd> 272 <dd>
273 the key of the value to get 273 the key of the value to get
274 </dd> 274 </dd>
275 </dl> 275 </dl>
276 <dl> 276 <dl>
277 <dt>Returns:</dt> 277 <dt>Return:</dt>
278 <dd> 278 <dd>
279 the requested setting 279 the requested setting
280 </dd> 280 </dd>
281 </dl> 281 </dl>
282 <a NAME="ProjectPyramidPlugin.getMenu" ID="ProjectPyramidPlugin.getMenu"></a> 282 <a NAME="ProjectPyramidPlugin.getMenu" ID="ProjectPyramidPlugin.getMenu"></a>
292 <dd> 292 <dd>
293 name of the menu (string) 293 name of the menu (string)
294 </dd> 294 </dd>
295 </dl> 295 </dl>
296 <dl> 296 <dl>
297 <dt>Returns:</dt> 297 <dt>Return:</dt>
298 <dd> 298 <dd>
299 reference to the menu (QMenu) or None, if no 299 reference to the menu (QMenu) or None, if no
300 menu with the given name exists 300 menu with the given name exists
301 </dd> 301 </dd>
302 </dl> 302 </dl>
306 306
307 <p> 307 <p>
308 Public method to get the names of all menus. 308 Public method to get the names of all menus.
309 </p> 309 </p>
310 <dl> 310 <dl>
311 <dt>Returns:</dt> 311 <dt>Return:</dt>
312 <dd> 312 <dd>
313 menu names (list of string) 313 menu names (list of string)
314 </dd> 314 </dd>
315 </dl> 315 </dl>
316 <a NAME="ProjectPyramidPlugin.getPreferences" ID="ProjectPyramidPlugin.getPreferences"></a> 316 <a NAME="ProjectPyramidPlugin.getPreferences" ID="ProjectPyramidPlugin.getPreferences"></a>
326 <dd> 326 <dd>
327 the key of the value to get 327 the key of the value to get
328 </dd> 328 </dd>
329 </dl> 329 </dl>
330 <dl> 330 <dl>
331 <dt>Returns:</dt> 331 <dt>Return:</dt>
332 <dd> 332 <dd>
333 the requested setting 333 the requested setting
334 </dd> 334 </dd>
335 </dl> 335 </dl>
336 <a NAME="ProjectPyramidPlugin.lexerAssociationCallback" ID="ProjectPyramidPlugin.lexerAssociationCallback"></a> 336 <a NAME="ProjectPyramidPlugin.lexerAssociationCallback" ID="ProjectPyramidPlugin.lexerAssociationCallback"></a>
347 <dd> 347 <dd>
348 name of the file (string) 348 name of the file (string)
349 </dd> 349 </dd>
350 </dl> 350 </dl>
351 <dl> 351 <dl>
352 <dt>Returns:</dt> 352 <dt>Return:</dt>
353 <dd> 353 <dd>
354 name of the lexer (string) (Pygments lexers are prefixed with 354 name of the lexer (string) (Pygments lexers are prefixed with
355 'Pygments|') 355 'Pygments|')
356 </dd> 356 </dd>
357 </dl> 357 </dl>
389 <dd> 389 <dd>
390 language to get APIs for (string) 390 language to get APIs for (string)
391 </dd> 391 </dd>
392 </dl> 392 </dl>
393 <dl> 393 <dl>
394 <dt>Returns:</dt> 394 <dt>Return:</dt>
395 <dd> 395 <dd>
396 list of API filenames (list of string) 396 list of API filenames (list of string)
397 </dd> 397 </dd>
398 </dl> 398 </dl>
399 <div align="right"><a href="#top">Up</a></div> 399 <div align="right"><a href="#top">Up</a></div>
412 <dd> 412 <dd>
413 reference to the configuration dialog 413 reference to the configuration dialog
414 </dd> 414 </dd>
415 </dl> 415 </dl>
416 <dl> 416 <dl>
417 <dt>Returns:</dt> 417 <dt>Return:</dt>
418 <dd> 418 <dd>
419 reference to the configuration page 419 reference to the configuration page
420 </dd> 420 </dd>
421 </dl> 421 </dl>
422 <div align="right"><a href="#top">Up</a></div> 422 <div align="right"><a href="#top">Up</a></div>
428 428
429 <p> 429 <p>
430 Module function returning data as required by the configuration dialog. 430 Module function returning data as required by the configuration dialog.
431 </p> 431 </p>
432 <dl> 432 <dl>
433 <dt>Returns:</dt> 433 <dt>Return:</dt>
434 <dd> 434 <dd>
435 dictionary containing the relevant data 435 dictionary containing the relevant data
436 </dd> 436 </dd>
437 </dl> 437 </dl>
438 <div align="right"><a href="#top">Up</a></div> 438 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial