Mercurial Repositories > Django Project / file comparison
comparison: ProjectDjango/Documentation/source/Plugin_Project_Django.PluginProjectDjango.html
ProjectDjango/Documentation/source/Plugin_Project_Django.PluginProjectDjango.html
- branch
- eric7
- changeset 172
- ea7980ded4f3
- parent 169
- b8f263e05c39
- child 176
- 1395e0583f4e
equal
deleted
inserted
replaced
| 171:af99f0984f20 | 172:ea7980ded4f3 |
|---|---|
| 158 <p> | 158 <p> |
| 159 Constructor | 159 Constructor |
| 160 </p> | 160 </p> |
| 161 <dl> | 161 <dl> |
| 162 | 162 |
| 163 <dt><i>ui</i></dt> | 163 <dt><i>ui</i> (UserInterface)</dt> |
| 164 <dd> | 164 <dd> |
| 165 reference to the user interface object (UI.UserInterface) | 165 reference to the user interface object |
| 166 </dd> | 166 </dd> |
| 167 </dl> | 167 </dl> |
| 168 <a NAME="ProjectDjangoPlugin.__initialize" ID="ProjectDjangoPlugin.__initialize"></a> | 168 <a NAME="ProjectDjangoPlugin.__initialize" ID="ProjectDjangoPlugin.__initialize"></a> |
| 169 <h4>ProjectDjangoPlugin.__initialize</h4> | 169 <h4>ProjectDjangoPlugin.__initialize</h4> |
| 170 <b>__initialize</b>(<i></i>) | 170 <b>__initialize</b>(<i></i>) |
| 208 Public method to activate this plugin. | 208 Public method to activate this plugin. |
| 209 </p> | 209 </p> |
| 210 <dl> | 210 <dl> |
| 211 <dt>Return:</dt> | 211 <dt>Return:</dt> |
| 212 <dd> | 212 <dd> |
| 213 tuple of None and activation status (boolean) | 213 tuple of None and activation status |
| 214 </dd> | |
| 215 </dl> | |
| 216 <dl> | |
| 217 <dt>Return Type:</dt> | |
| 218 <dd> | |
| 219 bool | |
| 214 </dd> | 220 </dd> |
| 215 </dl> | 221 </dl> |
| 216 <a NAME="ProjectDjangoPlugin.binaryTranslationsCallback" ID="ProjectDjangoPlugin.binaryTranslationsCallback"></a> | 222 <a NAME="ProjectDjangoPlugin.binaryTranslationsCallback" ID="ProjectDjangoPlugin.binaryTranslationsCallback"></a> |
| 217 <h4>ProjectDjangoPlugin.binaryTranslationsCallback</h4> | 223 <h4>ProjectDjangoPlugin.binaryTranslationsCallback</h4> |
| 218 <b>binaryTranslationsCallback</b>(<i>filename</i>) | 224 <b>binaryTranslationsCallback</b>(<i>filename</i>) |
| 221 Public method to determine the filename of a compiled translation file | 227 Public method to determine the filename of a compiled translation file |
| 222 given the translation source file. | 228 given the translation source file. |
| 223 </p> | 229 </p> |
| 224 <dl> | 230 <dl> |
| 225 | 231 |
| 226 <dt><i>filename</i></dt> | 232 <dt><i>filename</i> (str)</dt> |
| 227 <dd> | 233 <dd> |
| 228 name of the translation source file (string) | 234 name of the translation source file |
| 229 </dd> | 235 </dd> |
| 230 </dl> | 236 </dl> |
| 231 <dl> | 237 <dl> |
| 232 <dt>Return:</dt> | 238 <dt>Return:</dt> |
| 233 <dd> | 239 <dd> |
| 234 name of the binary translation file (string) | 240 name of the binary translation file |
| 241 </dd> | |
| 242 </dl> | |
| 243 <dl> | |
| 244 <dt>Return Type:</dt> | |
| 245 <dd> | |
| 246 str | |
| 235 </dd> | 247 </dd> |
| 236 </dl> | 248 </dl> |
| 237 <a NAME="ProjectDjangoPlugin.deactivate" ID="ProjectDjangoPlugin.deactivate"></a> | 249 <a NAME="ProjectDjangoPlugin.deactivate" ID="ProjectDjangoPlugin.deactivate"></a> |
| 238 <h4>ProjectDjangoPlugin.deactivate</h4> | 250 <h4>ProjectDjangoPlugin.deactivate</h4> |
| 239 <b>deactivate</b>(<i></i>) | 251 <b>deactivate</b>(<i></i>) |
| 252 <dt>Return:</dt> | 264 <dt>Return:</dt> |
| 253 <dd> | 265 <dd> |
| 254 dictionary with file type associations | 266 dictionary with file type associations |
| 255 </dd> | 267 </dd> |
| 256 </dl> | 268 </dl> |
| 269 <dl> | |
| 270 <dt>Return Type:</dt> | |
| 271 <dd> | |
| 272 dict | |
| 273 </dd> | |
| 274 </dl> | |
| 257 <a NAME="ProjectDjangoPlugin.getMenu" ID="ProjectDjangoPlugin.getMenu"></a> | 275 <a NAME="ProjectDjangoPlugin.getMenu" ID="ProjectDjangoPlugin.getMenu"></a> |
| 258 <h4>ProjectDjangoPlugin.getMenu</h4> | 276 <h4>ProjectDjangoPlugin.getMenu</h4> |
| 259 <b>getMenu</b>(<i>name</i>) | 277 <b>getMenu</b>(<i>name</i>) |
| 260 | 278 |
| 261 <p> | 279 <p> |
| 295 <p> | 313 <p> |
| 296 Public method to retrieve the various settings. | 314 Public method to retrieve the various settings. |
| 297 </p> | 315 </p> |
| 298 <dl> | 316 <dl> |
| 299 | 317 |
| 300 <dt><i>key</i></dt> | 318 <dt><i>key</i> (str)</dt> |
| 301 <dd> | 319 <dd> |
| 302 the key of the value to get | 320 the key of the value to get |
| 303 </dd> | 321 </dd> |
| 304 </dl> | 322 </dl> |
| 305 <dl> | 323 <dl> |
| 306 <dt>Return:</dt> | 324 <dt>Return:</dt> |
| 307 <dd> | 325 <dd> |
| 308 the requested setting | 326 value of the requested setting |
| 327 </dd> | |
| 328 </dl> | |
| 329 <dl> | |
| 330 <dt>Return Type:</dt> | |
| 331 <dd> | |
| 332 Any | |
| 309 </dd> | 333 </dd> |
| 310 </dl> | 334 </dl> |
| 311 <a NAME="ProjectDjangoPlugin.lexerAssociationCallback" ID="ProjectDjangoPlugin.lexerAssociationCallback"></a> | 335 <a NAME="ProjectDjangoPlugin.lexerAssociationCallback" ID="ProjectDjangoPlugin.lexerAssociationCallback"></a> |
| 312 <h4>ProjectDjangoPlugin.lexerAssociationCallback</h4> | 336 <h4>ProjectDjangoPlugin.lexerAssociationCallback</h4> |
| 313 <b>lexerAssociationCallback</b>(<i>filename</i>) | 337 <b>lexerAssociationCallback</b>(<i>filename</i>) |
| 316 Public method to get the lexer association of the Django project type | 340 Public method to get the lexer association of the Django project type |
| 317 for a file. | 341 for a file. |
| 318 </p> | 342 </p> |
| 319 <dl> | 343 <dl> |
| 320 | 344 |
| 321 <dt><i>filename</i></dt> | 345 <dt><i>filename</i> (str)</dt> |
| 322 <dd> | 346 <dd> |
| 323 name of the file (string) | 347 name of the file |
| 324 </dd> | 348 </dd> |
| 325 </dl> | 349 </dl> |
| 326 <dl> | 350 <dl> |
| 327 <dt>Return:</dt> | 351 <dt>Return:</dt> |
| 328 <dd> | 352 <dd> |
| 329 name of the lexer (string) (Pygments lexers are prefixed with | 353 name of the lexer (Pygments lexers are prefixed with |
| 330 'Pygments|') | 354 'Pygments|') |
| 355 </dd> | |
| 356 </dl> | |
| 357 <dl> | |
| 358 <dt>Return Type:</dt> | |
| 359 <dd> | |
| 360 str | |
| 331 </dd> | 361 </dd> |
| 332 </dl> | 362 </dl> |
| 333 <a NAME="ProjectDjangoPlugin.setPreferences" ID="ProjectDjangoPlugin.setPreferences"></a> | 363 <a NAME="ProjectDjangoPlugin.setPreferences" ID="ProjectDjangoPlugin.setPreferences"></a> |
| 334 <h4>ProjectDjangoPlugin.setPreferences</h4> | 364 <h4>ProjectDjangoPlugin.setPreferences</h4> |
| 335 <b>setPreferences</b>(<i>key, value</i>) | 365 <b>setPreferences</b>(<i>key, value</i>) |
| 337 <p> | 367 <p> |
| 338 Public method to store the various settings. | 368 Public method to store the various settings. |
| 339 </p> | 369 </p> |
| 340 <dl> | 370 <dl> |
| 341 | 371 |
| 342 <dt><i>key</i></dt> | 372 <dt><i>key</i> (str)</dt> |
| 343 <dd> | 373 <dd> |
| 344 the key of the setting to be set (string) | 374 the key of the setting to be set |
| 345 </dd> | 375 </dd> |
| 346 <dt><i>value</i></dt> | 376 <dt><i>value</i> (Any)</dt> |
| 347 <dd> | 377 <dd> |
| 348 the value to be set | 378 value to be set |
| 349 </dd> | 379 </dd> |
| 350 </dl> | 380 </dl> |
| 351 <div align="right"><a href="#top">Up</a></div> | 381 <div align="right"><a href="#top">Up</a></div> |
| 352 <hr /> | 382 <hr /> |
| 353 <hr /> | 383 <hr /> |
| 358 <p> | 388 <p> |
| 359 Module function to return the API files made available by this plugin. | 389 Module function to return the API files made available by this plugin. |
| 360 </p> | 390 </p> |
| 361 <dl> | 391 <dl> |
| 362 | 392 |
| 363 <dt><i>language</i></dt> | 393 <dt><i>language</i> (str)</dt> |
| 364 <dd> | 394 <dd> |
| 365 language to get APIs for (string) | 395 language to get APIs for |
| 366 </dd> | 396 </dd> |
| 367 </dl> | 397 </dl> |
| 368 <dl> | 398 <dl> |
| 369 <dt>Return:</dt> | 399 <dt>Return:</dt> |
| 370 <dd> | 400 <dd> |
| 371 list of API filenames (list of string) | 401 list of API filenames |
| 402 </dd> | |
| 403 </dl> | |
| 404 <dl> | |
| 405 <dt>Return Type:</dt> | |
| 406 <dd> | |
| 407 list of str | |
| 372 </dd> | 408 </dd> |
| 373 </dl> | 409 </dl> |
| 374 <div align="right"><a href="#top">Up</a></div> | 410 <div align="right"><a href="#top">Up</a></div> |
| 375 <hr /> | 411 <hr /> |
| 376 <hr /> | 412 <hr /> |
| 381 <p> | 417 <p> |
| 382 Module function to create the Django configuration page. | 418 Module function to create the Django configuration page. |
| 383 </p> | 419 </p> |
| 384 <dl> | 420 <dl> |
| 385 | 421 |
| 386 <dt><i>configDlg</i></dt> | 422 <dt><i>configDlg</i> (ConfigurationWidget)</dt> |
| 387 <dd> | 423 <dd> |
| 388 reference to the configuration dialog | 424 reference to the configuration dialog |
| 389 </dd> | 425 </dd> |
| 390 </dl> | 426 </dl> |
| 391 <dl> | 427 <dl> |
| 392 <dt>Return:</dt> | 428 <dt>Return:</dt> |
| 393 <dd> | 429 <dd> |
| 394 reference to the configuration page | 430 reference to the configuration page |
| 431 </dd> | |
| 432 </dl> | |
| 433 <dl> | |
| 434 <dt>Return Type:</dt> | |
| 435 <dd> | |
| 436 DjangoPage | |
| 395 </dd> | 437 </dd> |
| 396 </dl> | 438 </dl> |
| 397 <div align="right"><a href="#top">Up</a></div> | 439 <div align="right"><a href="#top">Up</a></div> |
| 398 <hr /> | 440 <hr /> |
| 399 <hr /> | 441 <hr /> |
| 408 <dt>Return:</dt> | 450 <dt>Return:</dt> |
| 409 <dd> | 451 <dd> |
| 410 dictionary containing the relevant data | 452 dictionary containing the relevant data |
| 411 </dd> | 453 </dd> |
| 412 </dl> | 454 </dl> |
| 455 <dl> | |
| 456 <dt>Return Type:</dt> | |
| 457 <dd> | |
| 458 dict | |
| 459 </dd> | |
| 460 </dl> | |
| 413 <div align="right"><a href="#top">Up</a></div> | 461 <div align="right"><a href="#top">Up</a></div> |
| 414 <hr /> | 462 <hr /> |
| 415 <hr /> | 463 <hr /> |
| 416 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | 464 <a NAME="prepareUninstall" ID="prepareUninstall"></a> |
| 417 <h2>prepareUninstall</h2> | 465 <h2>prepareUninstall</h2> |
