Mercurial Repositories > Pyramid Project / file comparison
comparison: ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.PluginProjectPyramid.html
ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.PluginProjectPyramid.html
- branch
- eric7
- changeset 147
- eb28b4b6f7f5
- parent 144
- 5c3684ee818e
- child 148
- dcbd3a96f03c
equal
deleted
inserted
replaced
| 146:7d955b1995d5 | 147:eb28b4b6f7f5 |
|---|---|
| 162 <p> | 162 <p> |
| 163 Constructor | 163 Constructor |
| 164 </p> | 164 </p> |
| 165 <dl> | 165 <dl> |
| 166 | 166 |
| 167 <dt><i>ui</i></dt> | 167 <dt><i>ui</i> (UserInterface)</dt> |
| 168 <dd> | 168 <dd> |
| 169 reference to the user interface object (UI.UserInterface) | 169 reference to the user interface object |
| 170 </dd> | 170 </dd> |
| 171 </dl> | 171 </dl> |
| 172 <a NAME="ProjectPyramidPlugin.__initialize" ID="ProjectPyramidPlugin.__initialize"></a> | 172 <a NAME="ProjectPyramidPlugin.__initialize" ID="ProjectPyramidPlugin.__initialize"></a> |
| 173 <h4>ProjectPyramidPlugin.__initialize</h4> | 173 <h4>ProjectPyramidPlugin.__initialize</h4> |
| 174 <b>__initialize</b>(<i></i>) | 174 <b>__initialize</b>(<i></i>) |
| 212 Public method to activate this plugin. | 212 Public method to activate this plugin. |
| 213 </p> | 213 </p> |
| 214 <dl> | 214 <dl> |
| 215 <dt>Return:</dt> | 215 <dt>Return:</dt> |
| 216 <dd> | 216 <dd> |
| 217 tuple of None and activation status (boolean) | 217 tuple of None and activation status |
| 218 </dd> | |
| 219 </dl> | |
| 220 <dl> | |
| 221 <dt>Return Type:</dt> | |
| 222 <dd> | |
| 223 (None, bool) | |
| 218 </dd> | 224 </dd> |
| 219 </dl> | 225 </dl> |
| 220 <a NAME="ProjectPyramidPlugin.binaryTranslationsCallback" ID="ProjectPyramidPlugin.binaryTranslationsCallback"></a> | 226 <a NAME="ProjectPyramidPlugin.binaryTranslationsCallback" ID="ProjectPyramidPlugin.binaryTranslationsCallback"></a> |
| 221 <h4>ProjectPyramidPlugin.binaryTranslationsCallback</h4> | 227 <h4>ProjectPyramidPlugin.binaryTranslationsCallback</h4> |
| 222 <b>binaryTranslationsCallback</b>(<i>filename</i>) | 228 <b>binaryTranslationsCallback</b>(<i>filename</i>) |
| 225 Public method to determine the filename of a compiled translation file | 231 Public method to determine the filename of a compiled translation file |
| 226 given the translation source file. | 232 given the translation source file. |
| 227 </p> | 233 </p> |
| 228 <dl> | 234 <dl> |
| 229 | 235 |
| 230 <dt><i>filename</i></dt> | 236 <dt><i>filename</i> (str)</dt> |
| 231 <dd> | 237 <dd> |
| 232 name of the translation source file (string) | 238 name of the translation source file |
| 233 </dd> | 239 </dd> |
| 234 </dl> | 240 </dl> |
| 235 <dl> | 241 <dl> |
| 236 <dt>Return:</dt> | 242 <dt>Return:</dt> |
| 237 <dd> | 243 <dd> |
| 238 name of the binary translation file (string) | 244 name of the binary translation file |
| 245 </dd> | |
| 246 </dl> | |
| 247 <dl> | |
| 248 <dt>Return Type:</dt> | |
| 249 <dd> | |
| 250 str | |
| 239 </dd> | 251 </dd> |
| 240 </dl> | 252 </dl> |
| 241 <a NAME="ProjectPyramidPlugin.deactivate" ID="ProjectPyramidPlugin.deactivate"></a> | 253 <a NAME="ProjectPyramidPlugin.deactivate" ID="ProjectPyramidPlugin.deactivate"></a> |
| 242 <h4>ProjectPyramidPlugin.deactivate</h4> | 254 <h4>ProjectPyramidPlugin.deactivate</h4> |
| 243 <b>deactivate</b>(<i></i>) | 255 <b>deactivate</b>(<i></i>) |
| 257 <dt>Return:</dt> | 269 <dt>Return:</dt> |
| 258 <dd> | 270 <dd> |
| 259 dictionary with file type associations | 271 dictionary with file type associations |
| 260 </dd> | 272 </dd> |
| 261 </dl> | 273 </dl> |
| 274 <dl> | |
| 275 <dt>Return Type:</dt> | |
| 276 <dd> | |
| 277 dict | |
| 278 </dd> | |
| 279 </dl> | |
| 262 <a NAME="ProjectPyramidPlugin.getDefaultPreference" ID="ProjectPyramidPlugin.getDefaultPreference"></a> | 280 <a NAME="ProjectPyramidPlugin.getDefaultPreference" ID="ProjectPyramidPlugin.getDefaultPreference"></a> |
| 263 <h4>ProjectPyramidPlugin.getDefaultPreference</h4> | 281 <h4>ProjectPyramidPlugin.getDefaultPreference</h4> |
| 264 <b>getDefaultPreference</b>(<i>key</i>) | 282 <b>getDefaultPreference</b>(<i>key</i>) |
| 265 | 283 |
| 266 <p> | 284 <p> |
| 267 Public method to get the default value for a setting. | 285 Public method to get the default value for a setting. |
| 268 </p> | 286 </p> |
| 269 <dl> | 287 <dl> |
| 270 | 288 |
| 271 <dt><i>key</i></dt> | 289 <dt><i>key</i> (str)</dt> |
| 272 <dd> | 290 <dd> |
| 273 the key of the value to get | 291 key of the value to get |
| 274 </dd> | 292 </dd> |
| 275 </dl> | 293 </dl> |
| 276 <dl> | 294 <dl> |
| 277 <dt>Return:</dt> | 295 <dt>Return:</dt> |
| 278 <dd> | 296 <dd> |
| 279 the requested setting | 297 value of the requested setting |
| 298 </dd> | |
| 299 </dl> | |
| 300 <dl> | |
| 301 <dt>Return Type:</dt> | |
| 302 <dd> | |
| 303 Any | |
| 280 </dd> | 304 </dd> |
| 281 </dl> | 305 </dl> |
| 282 <a NAME="ProjectPyramidPlugin.getMenu" ID="ProjectPyramidPlugin.getMenu"></a> | 306 <a NAME="ProjectPyramidPlugin.getMenu" ID="ProjectPyramidPlugin.getMenu"></a> |
| 283 <h4>ProjectPyramidPlugin.getMenu</h4> | 307 <h4>ProjectPyramidPlugin.getMenu</h4> |
| 284 <b>getMenu</b>(<i>name</i>) | 308 <b>getMenu</b>(<i>name</i>) |
| 286 <p> | 310 <p> |
| 287 Public method to get a reference to the requested menu. | 311 Public method to get a reference to the requested menu. |
| 288 </p> | 312 </p> |
| 289 <dl> | 313 <dl> |
| 290 | 314 |
| 291 <dt><i>name</i></dt> | 315 <dt><i>name</i> (str)</dt> |
| 292 <dd> | 316 <dd> |
| 293 name of the menu (string) | 317 name of the menu |
| 294 </dd> | 318 </dd> |
| 295 </dl> | 319 </dl> |
| 296 <dl> | 320 <dl> |
| 297 <dt>Return:</dt> | 321 <dt>Return:</dt> |
| 298 <dd> | 322 <dd> |
| 299 reference to the menu (QMenu) or None, if no | 323 reference to the menu or None, if no menu with the given |
| 300 menu with the given name exists | 324 name exists |
| 325 </dd> | |
| 326 </dl> | |
| 327 <dl> | |
| 328 <dt>Return Type:</dt> | |
| 329 <dd> | |
| 330 QMenu | |
| 301 </dd> | 331 </dd> |
| 302 </dl> | 332 </dl> |
| 303 <a NAME="ProjectPyramidPlugin.getMenuNames" ID="ProjectPyramidPlugin.getMenuNames"></a> | 333 <a NAME="ProjectPyramidPlugin.getMenuNames" ID="ProjectPyramidPlugin.getMenuNames"></a> |
| 304 <h4>ProjectPyramidPlugin.getMenuNames</h4> | 334 <h4>ProjectPyramidPlugin.getMenuNames</h4> |
| 305 <b>getMenuNames</b>(<i></i>) | 335 <b>getMenuNames</b>(<i></i>) |
| 308 Public method to get the names of all menus. | 338 Public method to get the names of all menus. |
| 309 </p> | 339 </p> |
| 310 <dl> | 340 <dl> |
| 311 <dt>Return:</dt> | 341 <dt>Return:</dt> |
| 312 <dd> | 342 <dd> |
| 313 menu names (list of string) | 343 menu names |
| 344 </dd> | |
| 345 </dl> | |
| 346 <dl> | |
| 347 <dt>Return Type:</dt> | |
| 348 <dd> | |
| 349 list of str | |
| 314 </dd> | 350 </dd> |
| 315 </dl> | 351 </dl> |
| 316 <a NAME="ProjectPyramidPlugin.getPreferences" ID="ProjectPyramidPlugin.getPreferences"></a> | 352 <a NAME="ProjectPyramidPlugin.getPreferences" ID="ProjectPyramidPlugin.getPreferences"></a> |
| 317 <h4>ProjectPyramidPlugin.getPreferences</h4> | 353 <h4>ProjectPyramidPlugin.getPreferences</h4> |
| 318 <b>getPreferences</b>(<i>key</i>) | 354 <b>getPreferences</b>(<i>key</i>) |
| 320 <p> | 356 <p> |
| 321 Public method to retrieve the various settings. | 357 Public method to retrieve the various settings. |
| 322 </p> | 358 </p> |
| 323 <dl> | 359 <dl> |
| 324 | 360 |
| 325 <dt><i>key</i></dt> | 361 <dt><i>key</i> (str)</dt> |
| 326 <dd> | 362 <dd> |
| 327 the key of the value to get | 363 key of the value to get |
| 328 </dd> | 364 </dd> |
| 329 </dl> | 365 </dl> |
| 330 <dl> | 366 <dl> |
| 331 <dt>Return:</dt> | 367 <dt>Return:</dt> |
| 332 <dd> | 368 <dd> |
| 333 the requested setting | 369 value of the requested setting |
| 370 </dd> | |
| 371 </dl> | |
| 372 <dl> | |
| 373 <dt>Return Type:</dt> | |
| 374 <dd> | |
| 375 Any | |
| 334 </dd> | 376 </dd> |
| 335 </dl> | 377 </dl> |
| 336 <a NAME="ProjectPyramidPlugin.lexerAssociationCallback" ID="ProjectPyramidPlugin.lexerAssociationCallback"></a> | 378 <a NAME="ProjectPyramidPlugin.lexerAssociationCallback" ID="ProjectPyramidPlugin.lexerAssociationCallback"></a> |
| 337 <h4>ProjectPyramidPlugin.lexerAssociationCallback</h4> | 379 <h4>ProjectPyramidPlugin.lexerAssociationCallback</h4> |
| 338 <b>lexerAssociationCallback</b>(<i>filename</i>) | 380 <b>lexerAssociationCallback</b>(<i>filename</i>) |
| 341 Public method to get the lexer association of the Pyramid project type | 383 Public method to get the lexer association of the Pyramid project type |
| 342 for a file. | 384 for a file. |
| 343 </p> | 385 </p> |
| 344 <dl> | 386 <dl> |
| 345 | 387 |
| 346 <dt><i>filename</i></dt> | 388 <dt><i>filename</i> (str)</dt> |
| 347 <dd> | 389 <dd> |
| 348 name of the file (string) | 390 name of the file |
| 349 </dd> | 391 </dd> |
| 350 </dl> | 392 </dl> |
| 351 <dl> | 393 <dl> |
| 352 <dt>Return:</dt> | 394 <dt>Return:</dt> |
| 353 <dd> | 395 <dd> |
| 354 name of the lexer (string) (Pygments lexers are prefixed with | 396 name of the lexer (Pygments lexers are prefixed with |
| 355 'Pygments|') | 397 'Pygments|') |
| 398 </dd> | |
| 399 </dl> | |
| 400 <dl> | |
| 401 <dt>Return Type:</dt> | |
| 402 <dd> | |
| 403 str | |
| 356 </dd> | 404 </dd> |
| 357 </dl> | 405 </dl> |
| 358 <a NAME="ProjectPyramidPlugin.setPreferences" ID="ProjectPyramidPlugin.setPreferences"></a> | 406 <a NAME="ProjectPyramidPlugin.setPreferences" ID="ProjectPyramidPlugin.setPreferences"></a> |
| 359 <h4>ProjectPyramidPlugin.setPreferences</h4> | 407 <h4>ProjectPyramidPlugin.setPreferences</h4> |
| 360 <b>setPreferences</b>(<i>key, value</i>) | 408 <b>setPreferences</b>(<i>key, value</i>) |
| 362 <p> | 410 <p> |
| 363 Public method to store the various settings. | 411 Public method to store the various settings. |
| 364 </p> | 412 </p> |
| 365 <dl> | 413 <dl> |
| 366 | 414 |
| 367 <dt><i>key</i></dt> | 415 <dt><i>key</i> (str)</dt> |
| 368 <dd> | 416 <dd> |
| 369 the key of the setting to be set (string) | 417 key of the setting to be set |
| 370 </dd> | 418 </dd> |
| 371 <dt><i>value</i></dt> | 419 <dt><i>value</i> (Any)</dt> |
| 372 <dd> | 420 <dd> |
| 373 the value to be set | 421 value to be set |
| 374 </dd> | 422 </dd> |
| 375 </dl> | 423 </dl> |
| 376 <div align="right"><a href="#top">Up</a></div> | 424 <div align="right"><a href="#top">Up</a></div> |
| 377 <hr /> | 425 <hr /> |
| 378 <hr /> | 426 <hr /> |
| 383 <p> | 431 <p> |
| 384 Module function to return the API files made available by this plugin. | 432 Module function to return the API files made available by this plugin. |
| 385 </p> | 433 </p> |
| 386 <dl> | 434 <dl> |
| 387 | 435 |
| 388 <dt><i>language</i></dt> | 436 <dt><i>language</i> (str)</dt> |
| 389 <dd> | 437 <dd> |
| 390 language to get APIs for (string) | 438 language to get APIs for |
| 391 </dd> | 439 </dd> |
| 392 </dl> | 440 </dl> |
| 393 <dl> | 441 <dl> |
| 394 <dt>Return:</dt> | 442 <dt>Return:</dt> |
| 395 <dd> | 443 <dd> |
| 396 list of API filenames (list of string) | 444 list of API filenames |
| 445 </dd> | |
| 446 </dl> | |
| 447 <dl> | |
| 448 <dt>Return Type:</dt> | |
| 449 <dd> | |
| 450 list of str | |
| 397 </dd> | 451 </dd> |
| 398 </dl> | 452 </dl> |
| 399 <div align="right"><a href="#top">Up</a></div> | 453 <div align="right"><a href="#top">Up</a></div> |
| 400 <hr /> | 454 <hr /> |
| 401 <hr /> | 455 <hr /> |
| 406 <p> | 460 <p> |
| 407 Module function to create the Pyramid configuration page. | 461 Module function to create the Pyramid configuration page. |
| 408 </p> | 462 </p> |
| 409 <dl> | 463 <dl> |
| 410 | 464 |
| 411 <dt><i>configDlg</i></dt> | 465 <dt><i>configDlg</i> (ConfigurationWidget)</dt> |
| 412 <dd> | 466 <dd> |
| 413 reference to the configuration dialog | 467 reference to the configuration dialog |
| 414 </dd> | 468 </dd> |
| 415 </dl> | 469 </dl> |
| 416 <dl> | 470 <dl> |
| 417 <dt>Return:</dt> | 471 <dt>Return:</dt> |
| 418 <dd> | 472 <dd> |
| 419 reference to the configuration page | 473 reference to the configuration page |
| 474 </dd> | |
| 475 </dl> | |
| 476 <dl> | |
| 477 <dt>Return Type:</dt> | |
| 478 <dd> | |
| 479 PyramidPage | |
| 420 </dd> | 480 </dd> |
| 421 </dl> | 481 </dl> |
| 422 <div align="right"><a href="#top">Up</a></div> | 482 <div align="right"><a href="#top">Up</a></div> |
| 423 <hr /> | 483 <hr /> |
| 424 <hr /> | 484 <hr /> |
| 433 <dt>Return:</dt> | 493 <dt>Return:</dt> |
| 434 <dd> | 494 <dd> |
| 435 dictionary containing the relevant data | 495 dictionary containing the relevant data |
| 436 </dd> | 496 </dd> |
| 437 </dl> | 497 </dl> |
| 498 <dl> | |
| 499 <dt>Return Type:</dt> | |
| 500 <dd> | |
| 501 dict | |
| 502 </dd> | |
| 503 </dl> | |
| 438 <div align="right"><a href="#top">Up</a></div> | 504 <div align="right"><a href="#top">Up</a></div> |
| 439 <hr /> | 505 <hr /> |
| 440 <hr /> | 506 <hr /> |
| 441 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | 507 <a NAME="prepareUninstall" ID="prepareUninstall"></a> |
| 442 <h2>prepareUninstall</h2> | 508 <h2>prepareUninstall</h2> |
