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 198
- dd36f90e77ee
- parent 192
- a4b66a1acea6
equal
deleted
inserted
replaced
| 197:2667e16a3379 | 198:dd36f90e77ee |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>Plugin_Project_Django.PluginProjectDjango</h1> | 9 <h1>Plugin_Project_Django.PluginProjectDjango</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the Django project plugin. | 11 Module implementing the Django project plugin. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | 15 <table> |
| 16 <table> | 16 <tr><td>__header__</td></tr> |
| 17 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>djangoPluginObject</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> | 17 <tr><td>djangoPluginObject</td></tr> |
| 18 </table> | 18 <tr><td>error</td></tr> |
| 19 </table> | |
| 20 | |
| 19 <h3>Classes</h3> | 21 <h3>Classes</h3> |
| 20 | 22 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 23 <tr> |
| 24 <td><a href="#ProjectDjangoPlugin">ProjectDjangoPlugin</a></td> | 24 <td><a href="#ProjectDjangoPlugin">ProjectDjangoPlugin</a></td> |
| 25 <td>Class implementing the Django project plugin.</td> | 25 <td>Class implementing the Django project plugin.</td> |
| 26 </tr> | 26 </tr> |
| 27 </table> | 27 </table> |
| 28 | |
| 28 <h3>Functions</h3> | 29 <h3>Functions</h3> |
| 29 | 30 <table> |
| 30 <table> | |
| 31 | |
| 32 <tr> | 31 <tr> |
| 33 <td><a href="#apiFiles">apiFiles</a></td> | 32 <td><a href="#apiFiles">apiFiles</a></td> |
| 34 <td>Module function to return the API files made available by this plugin.</td> | 33 <td>Module function to return the API files made available by this plugin.</td> |
| 35 </tr> | 34 </tr> |
| 36 <tr> | 35 <tr> |
| 44 <tr> | 43 <tr> |
| 45 <td><a href="#prepareUninstall">prepareUninstall</a></td> | 44 <td><a href="#prepareUninstall">prepareUninstall</a></td> |
| 46 <td>Module function to prepare for an uninstallation.</td> | 45 <td>Module function to prepare for an uninstallation.</td> |
| 47 </tr> | 46 </tr> |
| 48 </table> | 47 </table> |
| 48 | |
| 49 <hr /> | 49 <hr /> |
| 50 <hr /> | 50 <hr /> |
| 51 <a NAME="ProjectDjangoPlugin" ID="ProjectDjangoPlugin"></a> | 51 <a NAME="ProjectDjangoPlugin" ID="ProjectDjangoPlugin"></a> |
| 52 <h2>ProjectDjangoPlugin</h2> | 52 <h2>ProjectDjangoPlugin</h2> |
| 53 | |
| 54 <p> | 53 <p> |
| 55 Class implementing the Django project plugin. | 54 Class implementing the Django project plugin. |
| 56 </p> | 55 </p> |
| 56 | |
| 57 <h3>Derived from</h3> | 57 <h3>Derived from</h3> |
| 58 QObject | 58 QObject |
| 59 <h3>Class Attributes</h3> | 59 <h3>Class Attributes</h3> |
| 60 | 60 <table> |
| 61 <table> | 61 <tr><td>PreferencesKey</td></tr> |
| 62 <tr><td>PreferencesKey</td></tr><tr><td>lexerAssociations</td></tr> | 62 <tr><td>lexerAssociations</td></tr> |
| 63 </table> | 63 </table> |
| 64 | |
| 64 <h3>Class Methods</h3> | 65 <h3>Class Methods</h3> |
| 65 | |
| 66 <table> | 66 <table> |
| 67 <tr><td>None</td></tr> | 67 <tr><td>None</td></tr> |
| 68 </table> | 68 </table> |
| 69 | |
| 69 <h3>Methods</h3> | 70 <h3>Methods</h3> |
| 70 | 71 <table> |
| 71 <table> | |
| 72 | |
| 73 <tr> | 72 <tr> |
| 74 <td><a href="#ProjectDjangoPlugin.__init__">ProjectDjangoPlugin</a></td> | 73 <td><a href="#ProjectDjangoPlugin.__init__">ProjectDjangoPlugin</a></td> |
| 75 <td>Constructor</td> | 74 <td>Constructor</td> |
| 76 </tr> | 75 </tr> |
| 77 <tr> | 76 <tr> |
| 129 <tr> | 128 <tr> |
| 130 <td><a href="#ProjectDjangoPlugin.setPreferences">setPreferences</a></td> | 129 <td><a href="#ProjectDjangoPlugin.setPreferences">setPreferences</a></td> |
| 131 <td>Public method to store the various settings.</td> | 130 <td>Public method to store the various settings.</td> |
| 132 </tr> | 131 </tr> |
| 133 </table> | 132 </table> |
| 133 | |
| 134 <h3>Static Methods</h3> | 134 <h3>Static Methods</h3> |
| 135 | |
| 136 <table> | 135 <table> |
| 137 <tr><td>None</td></tr> | 136 <tr><td>None</td></tr> |
| 138 </table> | 137 </table> |
| 138 | |
| 139 | 139 |
| 140 <a NAME="ProjectDjangoPlugin.__init__" ID="ProjectDjangoPlugin.__init__"></a> | 140 <a NAME="ProjectDjangoPlugin.__init__" ID="ProjectDjangoPlugin.__init__"></a> |
| 141 <h4>ProjectDjangoPlugin (Constructor)</h4> | 141 <h4>ProjectDjangoPlugin (Constructor)</h4> |
| 142 <b>ProjectDjangoPlugin</b>(<i>ui</i>) | 142 <b>ProjectDjangoPlugin</b>(<i>ui</i>) |
| 143 | |
| 144 <p> | 143 <p> |
| 145 Constructor | 144 Constructor |
| 146 </p> | 145 </p> |
| 146 | |
| 147 <dl> | 147 <dl> |
| 148 | 148 |
| 149 <dt><i>ui</i> (UserInterface)</dt> | 149 <dt><i>ui</i> (UserInterface)</dt> |
| 150 <dd> | 150 <dd> |
| 151 reference to the user interface object | 151 reference to the user interface object |
| 152 </dd> | 152 </dd> |
| 153 </dl> | 153 </dl> |
| 154 <a NAME="ProjectDjangoPlugin.__initialize" ID="ProjectDjangoPlugin.__initialize"></a> | 154 <a NAME="ProjectDjangoPlugin.__initialize" ID="ProjectDjangoPlugin.__initialize"></a> |
| 155 <h4>ProjectDjangoPlugin.__initialize</h4> | 155 <h4>ProjectDjangoPlugin.__initialize</h4> |
| 156 <b>__initialize</b>(<i></i>) | 156 <b>__initialize</b>(<i></i>) |
| 157 | |
| 158 <p> | 157 <p> |
| 159 Private slot to (re)initialize the plugin. | 158 Private slot to (re)initialize the plugin. |
| 160 </p> | 159 </p> |
| 160 | |
| 161 <a NAME="ProjectDjangoPlugin.__loadTranslator" ID="ProjectDjangoPlugin.__loadTranslator"></a> | 161 <a NAME="ProjectDjangoPlugin.__loadTranslator" ID="ProjectDjangoPlugin.__loadTranslator"></a> |
| 162 <h4>ProjectDjangoPlugin.__loadTranslator</h4> | 162 <h4>ProjectDjangoPlugin.__loadTranslator</h4> |
| 163 <b>__loadTranslator</b>(<i></i>) | 163 <b>__loadTranslator</b>(<i></i>) |
| 164 | |
| 165 <p> | 164 <p> |
| 166 Private method to load the translation file. | 165 Private method to load the translation file. |
| 167 </p> | 166 </p> |
| 167 | |
| 168 <a NAME="ProjectDjangoPlugin.__projectClosed" ID="ProjectDjangoPlugin.__projectClosed"></a> | 168 <a NAME="ProjectDjangoPlugin.__projectClosed" ID="ProjectDjangoPlugin.__projectClosed"></a> |
| 169 <h4>ProjectDjangoPlugin.__projectClosed</h4> | 169 <h4>ProjectDjangoPlugin.__projectClosed</h4> |
| 170 <b>__projectClosed</b>(<i></i>) | 170 <b>__projectClosed</b>(<i></i>) |
| 171 | |
| 172 <p> | 171 <p> |
| 173 Private slot to handle the projectClosed signal. | 172 Private slot to handle the projectClosed signal. |
| 174 </p> | 173 </p> |
| 174 | |
| 175 <a NAME="ProjectDjangoPlugin.__projectOpened" ID="ProjectDjangoPlugin.__projectOpened"></a> | 175 <a NAME="ProjectDjangoPlugin.__projectOpened" ID="ProjectDjangoPlugin.__projectOpened"></a> |
| 176 <h4>ProjectDjangoPlugin.__projectOpened</h4> | 176 <h4>ProjectDjangoPlugin.__projectOpened</h4> |
| 177 <b>__projectOpened</b>(<i></i>) | 177 <b>__projectOpened</b>(<i></i>) |
| 178 | |
| 179 <p> | 178 <p> |
| 180 Private slot to handle the projectOpened signal. | 179 Private slot to handle the projectOpened signal. |
| 181 </p> | 180 </p> |
| 181 | |
| 182 <a NAME="ProjectDjangoPlugin.__reregisterProjectType" ID="ProjectDjangoPlugin.__reregisterProjectType"></a> | 182 <a NAME="ProjectDjangoPlugin.__reregisterProjectType" ID="ProjectDjangoPlugin.__reregisterProjectType"></a> |
| 183 <h4>ProjectDjangoPlugin.__reregisterProjectType</h4> | 183 <h4>ProjectDjangoPlugin.__reregisterProjectType</h4> |
| 184 <b>__reregisterProjectType</b>(<i></i>) | 184 <b>__reregisterProjectType</b>(<i></i>) |
| 185 | |
| 186 <p> | 185 <p> |
| 187 Private method to re-register the project type. | 186 Private method to re-register the project type. |
| 188 </p> | 187 </p> |
| 188 | |
| 189 <a NAME="ProjectDjangoPlugin.activate" ID="ProjectDjangoPlugin.activate"></a> | 189 <a NAME="ProjectDjangoPlugin.activate" ID="ProjectDjangoPlugin.activate"></a> |
| 190 <h4>ProjectDjangoPlugin.activate</h4> | 190 <h4>ProjectDjangoPlugin.activate</h4> |
| 191 <b>activate</b>(<i></i>) | 191 <b>activate</b>(<i></i>) |
| 192 | |
| 193 <p> | 192 <p> |
| 194 Public method to activate this plugin. | 193 Public method to activate this plugin. |
| 195 </p> | 194 </p> |
| 195 | |
| 196 <dl> | 196 <dl> |
| 197 <dt>Return:</dt> | 197 <dt>Return:</dt> |
| 198 <dd> | 198 <dd> |
| 199 tuple of None and activation status | 199 tuple of None and activation status |
| 200 </dd> | 200 </dd> |
| 206 </dd> | 206 </dd> |
| 207 </dl> | 207 </dl> |
| 208 <a NAME="ProjectDjangoPlugin.binaryTranslationsCallback" ID="ProjectDjangoPlugin.binaryTranslationsCallback"></a> | 208 <a NAME="ProjectDjangoPlugin.binaryTranslationsCallback" ID="ProjectDjangoPlugin.binaryTranslationsCallback"></a> |
| 209 <h4>ProjectDjangoPlugin.binaryTranslationsCallback</h4> | 209 <h4>ProjectDjangoPlugin.binaryTranslationsCallback</h4> |
| 210 <b>binaryTranslationsCallback</b>(<i>filename</i>) | 210 <b>binaryTranslationsCallback</b>(<i>filename</i>) |
| 211 | |
| 212 <p> | 211 <p> |
| 213 Public method to determine the filename of a compiled translation file | 212 Public method to determine the filename of a compiled translation file |
| 214 given the translation source file. | 213 given the translation source file. |
| 215 </p> | 214 </p> |
| 215 | |
| 216 <dl> | 216 <dl> |
| 217 | 217 |
| 218 <dt><i>filename</i> (str)</dt> | 218 <dt><i>filename</i> (str)</dt> |
| 219 <dd> | 219 <dd> |
| 220 name of the translation source file | 220 name of the translation source file |
| 233 </dd> | 233 </dd> |
| 234 </dl> | 234 </dl> |
| 235 <a NAME="ProjectDjangoPlugin.deactivate" ID="ProjectDjangoPlugin.deactivate"></a> | 235 <a NAME="ProjectDjangoPlugin.deactivate" ID="ProjectDjangoPlugin.deactivate"></a> |
| 236 <h4>ProjectDjangoPlugin.deactivate</h4> | 236 <h4>ProjectDjangoPlugin.deactivate</h4> |
| 237 <b>deactivate</b>(<i></i>) | 237 <b>deactivate</b>(<i></i>) |
| 238 | |
| 239 <p> | 238 <p> |
| 240 Public method to deactivate this plugin. | 239 Public method to deactivate this plugin. |
| 241 </p> | 240 </p> |
| 241 | |
| 242 <a NAME="ProjectDjangoPlugin.fileTypesCallback" ID="ProjectDjangoPlugin.fileTypesCallback"></a> | 242 <a NAME="ProjectDjangoPlugin.fileTypesCallback" ID="ProjectDjangoPlugin.fileTypesCallback"></a> |
| 243 <h4>ProjectDjangoPlugin.fileTypesCallback</h4> | 243 <h4>ProjectDjangoPlugin.fileTypesCallback</h4> |
| 244 <b>fileTypesCallback</b>(<i></i>) | 244 <b>fileTypesCallback</b>(<i></i>) |
| 245 | |
| 246 <p> | 245 <p> |
| 247 Public method get the filetype associations of the Django project type. | 246 Public method get the filetype associations of the Django project type. |
| 248 </p> | 247 </p> |
| 248 | |
| 249 <dl> | 249 <dl> |
| 250 <dt>Return:</dt> | 250 <dt>Return:</dt> |
| 251 <dd> | 251 <dd> |
| 252 dictionary with file type associations | 252 dictionary with file type associations |
| 253 </dd> | 253 </dd> |
| 259 </dd> | 259 </dd> |
| 260 </dl> | 260 </dl> |
| 261 <a NAME="ProjectDjangoPlugin.getMenu" ID="ProjectDjangoPlugin.getMenu"></a> | 261 <a NAME="ProjectDjangoPlugin.getMenu" ID="ProjectDjangoPlugin.getMenu"></a> |
| 262 <h4>ProjectDjangoPlugin.getMenu</h4> | 262 <h4>ProjectDjangoPlugin.getMenu</h4> |
| 263 <b>getMenu</b>(<i>name</i>) | 263 <b>getMenu</b>(<i>name</i>) |
| 264 | |
| 265 <p> | 264 <p> |
| 266 Public method to get a reference to the requested menu. | 265 Public method to get a reference to the requested menu. |
| 267 </p> | 266 </p> |
| 267 | |
| 268 <dl> | 268 <dl> |
| 269 | 269 |
| 270 <dt><i>name</i> (str)</dt> | 270 <dt><i>name</i> (str)</dt> |
| 271 <dd> | 271 <dd> |
| 272 name of the menu | 272 name of the menu |
| 285 </dd> | 285 </dd> |
| 286 </dl> | 286 </dl> |
| 287 <a NAME="ProjectDjangoPlugin.getMenuNames" ID="ProjectDjangoPlugin.getMenuNames"></a> | 287 <a NAME="ProjectDjangoPlugin.getMenuNames" ID="ProjectDjangoPlugin.getMenuNames"></a> |
| 288 <h4>ProjectDjangoPlugin.getMenuNames</h4> | 288 <h4>ProjectDjangoPlugin.getMenuNames</h4> |
| 289 <b>getMenuNames</b>(<i></i>) | 289 <b>getMenuNames</b>(<i></i>) |
| 290 | |
| 291 <p> | 290 <p> |
| 292 Public method to get the names of all menus. | 291 Public method to get the names of all menus. |
| 293 </p> | 292 </p> |
| 293 | |
| 294 <dl> | 294 <dl> |
| 295 <dt>Return:</dt> | 295 <dt>Return:</dt> |
| 296 <dd> | 296 <dd> |
| 297 menu names | 297 menu names |
| 298 </dd> | 298 </dd> |
| 304 </dd> | 304 </dd> |
| 305 </dl> | 305 </dl> |
| 306 <a NAME="ProjectDjangoPlugin.getPreferences" ID="ProjectDjangoPlugin.getPreferences"></a> | 306 <a NAME="ProjectDjangoPlugin.getPreferences" ID="ProjectDjangoPlugin.getPreferences"></a> |
| 307 <h4>ProjectDjangoPlugin.getPreferences</h4> | 307 <h4>ProjectDjangoPlugin.getPreferences</h4> |
| 308 <b>getPreferences</b>(<i>key</i>) | 308 <b>getPreferences</b>(<i>key</i>) |
| 309 | |
| 310 <p> | 309 <p> |
| 311 Public method to retrieve the various settings. | 310 Public method to retrieve the various settings. |
| 312 </p> | 311 </p> |
| 312 | |
| 313 <dl> | 313 <dl> |
| 314 | 314 |
| 315 <dt><i>key</i> (str)</dt> | 315 <dt><i>key</i> (str)</dt> |
| 316 <dd> | 316 <dd> |
| 317 the key of the value to get | 317 the key of the value to get |
| 330 </dd> | 330 </dd> |
| 331 </dl> | 331 </dl> |
| 332 <a NAME="ProjectDjangoPlugin.lexerAssociationCallback" ID="ProjectDjangoPlugin.lexerAssociationCallback"></a> | 332 <a NAME="ProjectDjangoPlugin.lexerAssociationCallback" ID="ProjectDjangoPlugin.lexerAssociationCallback"></a> |
| 333 <h4>ProjectDjangoPlugin.lexerAssociationCallback</h4> | 333 <h4>ProjectDjangoPlugin.lexerAssociationCallback</h4> |
| 334 <b>lexerAssociationCallback</b>(<i>filename</i>) | 334 <b>lexerAssociationCallback</b>(<i>filename</i>) |
| 335 | |
| 336 <p> | 335 <p> |
| 337 Public method to get the lexer association of the Django project type | 336 Public method to get the lexer association of the Django project type |
| 338 for a file. | 337 for a file. |
| 339 </p> | 338 </p> |
| 339 | |
| 340 <dl> | 340 <dl> |
| 341 | 341 |
| 342 <dt><i>filename</i> (str)</dt> | 342 <dt><i>filename</i> (str)</dt> |
| 343 <dd> | 343 <dd> |
| 344 name of the file | 344 name of the file |
| 358 </dd> | 358 </dd> |
| 359 </dl> | 359 </dl> |
| 360 <a NAME="ProjectDjangoPlugin.setPreferences" ID="ProjectDjangoPlugin.setPreferences"></a> | 360 <a NAME="ProjectDjangoPlugin.setPreferences" ID="ProjectDjangoPlugin.setPreferences"></a> |
| 361 <h4>ProjectDjangoPlugin.setPreferences</h4> | 361 <h4>ProjectDjangoPlugin.setPreferences</h4> |
| 362 <b>setPreferences</b>(<i>key, value</i>) | 362 <b>setPreferences</b>(<i>key, value</i>) |
| 363 | |
| 364 <p> | 363 <p> |
| 365 Public method to store the various settings. | 364 Public method to store the various settings. |
| 366 </p> | 365 </p> |
| 366 | |
| 367 <dl> | 367 <dl> |
| 368 | 368 |
| 369 <dt><i>key</i> (str)</dt> | 369 <dt><i>key</i> (str)</dt> |
| 370 <dd> | 370 <dd> |
| 371 the key of the setting to be set | 371 the key of the setting to be set |
| 379 <hr /> | 379 <hr /> |
| 380 <hr /> | 380 <hr /> |
| 381 <a NAME="apiFiles" ID="apiFiles"></a> | 381 <a NAME="apiFiles" ID="apiFiles"></a> |
| 382 <h2>apiFiles</h2> | 382 <h2>apiFiles</h2> |
| 383 <b>apiFiles</b>(<i>language</i>) | 383 <b>apiFiles</b>(<i>language</i>) |
| 384 | |
| 385 <p> | 384 <p> |
| 386 Module function to return the API files made available by this plugin. | 385 Module function to return the API files made available by this plugin. |
| 387 </p> | 386 </p> |
| 387 | |
| 388 <dl> | 388 <dl> |
| 389 | 389 |
| 390 <dt><i>language</i> (str)</dt> | 390 <dt><i>language</i> (str)</dt> |
| 391 <dd> | 391 <dd> |
| 392 language to get APIs for | 392 language to get APIs for |
| 408 <hr /> | 408 <hr /> |
| 409 <hr /> | 409 <hr /> |
| 410 <a NAME="createDjangoPage" ID="createDjangoPage"></a> | 410 <a NAME="createDjangoPage" ID="createDjangoPage"></a> |
| 411 <h2>createDjangoPage</h2> | 411 <h2>createDjangoPage</h2> |
| 412 <b>createDjangoPage</b>(<i>configDlg</i>) | 412 <b>createDjangoPage</b>(<i>configDlg</i>) |
| 413 | |
| 414 <p> | 413 <p> |
| 415 Module function to create the Django configuration page. | 414 Module function to create the Django configuration page. |
| 416 </p> | 415 </p> |
| 416 | |
| 417 <dl> | 417 <dl> |
| 418 | 418 |
| 419 <dt><i>configDlg</i> (ConfigurationWidget)</dt> | 419 <dt><i>configDlg</i> (ConfigurationWidget)</dt> |
| 420 <dd> | 420 <dd> |
| 421 reference to the configuration dialog | 421 reference to the configuration dialog |
| 437 <hr /> | 437 <hr /> |
| 438 <hr /> | 438 <hr /> |
| 439 <a NAME="getConfigData" ID="getConfigData"></a> | 439 <a NAME="getConfigData" ID="getConfigData"></a> |
| 440 <h2>getConfigData</h2> | 440 <h2>getConfigData</h2> |
| 441 <b>getConfigData</b>(<i></i>) | 441 <b>getConfigData</b>(<i></i>) |
| 442 | |
| 443 <p> | 442 <p> |
| 444 Module function returning data as required by the configuration dialog. | 443 Module function returning data as required by the configuration dialog. |
| 445 </p> | 444 </p> |
| 445 | |
| 446 <dl> | 446 <dl> |
| 447 <dt>Return:</dt> | 447 <dt>Return:</dt> |
| 448 <dd> | 448 <dd> |
| 449 dictionary containing the relevant data | 449 dictionary containing the relevant data |
| 450 </dd> | 450 </dd> |
| 459 <hr /> | 459 <hr /> |
| 460 <hr /> | 460 <hr /> |
| 461 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | 461 <a NAME="prepareUninstall" ID="prepareUninstall"></a> |
| 462 <h2>prepareUninstall</h2> | 462 <h2>prepareUninstall</h2> |
| 463 <b>prepareUninstall</b>(<i></i>) | 463 <b>prepareUninstall</b>(<i></i>) |
| 464 | |
| 465 <p> | 464 <p> |
| 466 Module function to prepare for an uninstallation. | 465 Module function to prepare for an uninstallation. |
| 467 </p> | 466 </p> |
| 467 | |
| 468 <div align="right"><a href="#top">Up</a></div> | 468 <div align="right"><a href="#top">Up</a></div> |
| 469 <hr /> | 469 <hr /> |
| 470 </body></html> | 470 </body></html> |
