Mercurial Repositories > Django Project / file comparison

comparison: ProjectDjango/Documentation/source/Plugin_Project_Django.PluginProjectDjango.html

ProjectDjango/Documentation/source/Plugin_Project_Django.PluginProjectDjango.html

changeset 161
208fced62e00
parent 98
1db4d12fda93
child 169
b8f263e05c39
equal deleted inserted replaced
160:e2084f0a28a2 161:208fced62e00
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>Plugin_Project_Django.PluginProjectDjango</h1> 23 <h1>Plugin_Project_Django.PluginProjectDjango</h1>
24
23 <p> 25 <p>
24 Module implementing the Django project plugin. 26 Module implementing the Django project plugin.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
27 <table> 29
28 <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>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> 30 <table>
31 <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>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#ProjectDjangoPlugin">ProjectDjangoPlugin</a></td> 38 <td><a href="#ProjectDjangoPlugin">ProjectDjangoPlugin</a></td>
34 <td>Class implementing the Django project plugin.</td> 39 <td>Class implementing the Django project plugin.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
44 <table>
45
39 <tr> 46 <tr>
40 <td><a href="#apiFiles">apiFiles</a></td> 47 <td><a href="#apiFiles">apiFiles</a></td>
41 <td>Module function to return the API files made available by this plugin.</td> 48 <td>Module function to return the API files made available by this plugin.</td>
42 </tr><tr> 49 </tr>
50 <tr>
43 <td><a href="#createDjangoPage">createDjangoPage</a></td> 51 <td><a href="#createDjangoPage">createDjangoPage</a></td>
44 <td>Module function to create the Django configuration page.</td> 52 <td>Module function to create the Django configuration page.</td>
45 </tr><tr> 53 </tr>
54 <tr>
46 <td><a href="#getConfigData">getConfigData</a></td> 55 <td><a href="#getConfigData">getConfigData</a></td>
47 <td>Module function returning data as required by the configuration dialog.</td> 56 <td>Module function returning data as required by the configuration dialog.</td>
48 </tr><tr> 57 </tr>
58 <tr>
49 <td><a href="#prepareUninstall">prepareUninstall</a></td> 59 <td><a href="#prepareUninstall">prepareUninstall</a></td>
50 <td>Module function to prepare for an uninstallation.</td> 60 <td>Module function to prepare for an uninstallation.</td>
51 </tr> 61 </tr>
52 </table> 62 </table>
53 <hr /><hr /> 63 <hr />
64 <hr />
54 <a NAME="ProjectDjangoPlugin" ID="ProjectDjangoPlugin"></a> 65 <a NAME="ProjectDjangoPlugin" ID="ProjectDjangoPlugin"></a>
55 <h2>ProjectDjangoPlugin</h2> 66 <h2>ProjectDjangoPlugin</h2>
67
56 <p> 68 <p>
57 Class implementing the Django project plugin. 69 Class implementing the Django project plugin.
58 </p> 70 </p>
59 <h3>Derived from</h3> 71 <h3>Derived from</h3>
60 QObject 72 QObject
61 <h3>Class Attributes</h3> 73 <h3>Class Attributes</h3>
74
62 <table> 75 <table>
63 <tr><td>PreferencesKey</td></tr><tr><td>lexerAssociations</td></tr> 76 <tr><td>PreferencesKey</td></tr><tr><td>lexerAssociations</td></tr>
64 </table> 77 </table>
65 <h3>Class Methods</h3> 78 <h3>Class Methods</h3>
79
66 <table> 80 <table>
67 <tr><td>None</td></tr> 81 <tr><td>None</td></tr>
68 </table> 82 </table>
69 <h3>Methods</h3> 83 <h3>Methods</h3>
70 <table> 84
85 <table>
86
71 <tr> 87 <tr>
72 <td><a href="#ProjectDjangoPlugin.__init__">ProjectDjangoPlugin</a></td> 88 <td><a href="#ProjectDjangoPlugin.__init__">ProjectDjangoPlugin</a></td>
73 <td>Constructor</td> 89 <td>Constructor</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#ProjectDjangoPlugin.__initialize">__initialize</a></td> 92 <td><a href="#ProjectDjangoPlugin.__initialize">__initialize</a></td>
76 <td>Private slot to (re)initialize the plugin.</td> 93 <td>Private slot to (re)initialize the plugin.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#ProjectDjangoPlugin.__loadTranslator">__loadTranslator</a></td> 96 <td><a href="#ProjectDjangoPlugin.__loadTranslator">__loadTranslator</a></td>
79 <td>Private method to load the translation file.</td> 97 <td>Private method to load the translation file.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#ProjectDjangoPlugin.__projectClosed">__projectClosed</a></td> 100 <td><a href="#ProjectDjangoPlugin.__projectClosed">__projectClosed</a></td>
82 <td>Private slot to handle the projectClosed signal.</td> 101 <td>Private slot to handle the projectClosed signal.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#ProjectDjangoPlugin.__projectOpened">__projectOpened</a></td> 104 <td><a href="#ProjectDjangoPlugin.__projectOpened">__projectOpened</a></td>
85 <td>Private slot to handle the projectOpened signal.</td> 105 <td>Private slot to handle the projectOpened signal.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#ProjectDjangoPlugin.__reregisterProjectType">__reregisterProjectType</a></td> 108 <td><a href="#ProjectDjangoPlugin.__reregisterProjectType">__reregisterProjectType</a></td>
88 <td>Private method to re-register the project type.</td> 109 <td>Private method to re-register the project type.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#ProjectDjangoPlugin.activate">activate</a></td> 112 <td><a href="#ProjectDjangoPlugin.activate">activate</a></td>
91 <td>Public method to activate this plugin.</td> 113 <td>Public method to activate this plugin.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#ProjectDjangoPlugin.binaryTranslationsCallback">binaryTranslationsCallback</a></td> 116 <td><a href="#ProjectDjangoPlugin.binaryTranslationsCallback">binaryTranslationsCallback</a></td>
94 <td>Public method to determine the filename of a compiled translation file given the translation source file.</td> 117 <td>Public method to determine the filename of a compiled translation file given the translation source file.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#ProjectDjangoPlugin.deactivate">deactivate</a></td> 120 <td><a href="#ProjectDjangoPlugin.deactivate">deactivate</a></td>
97 <td>Public method to deactivate this plugin.</td> 121 <td>Public method to deactivate this plugin.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#ProjectDjangoPlugin.fileTypesCallback">fileTypesCallback</a></td> 124 <td><a href="#ProjectDjangoPlugin.fileTypesCallback">fileTypesCallback</a></td>
100 <td>Public method get the filetype associations of the Django project type.</td> 125 <td>Public method get the filetype associations of the Django project type.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#ProjectDjangoPlugin.getMenu">getMenu</a></td> 128 <td><a href="#ProjectDjangoPlugin.getMenu">getMenu</a></td>
103 <td>Public method to get a reference to the requested menu.</td> 129 <td>Public method to get a reference to the requested menu.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#ProjectDjangoPlugin.getMenuNames">getMenuNames</a></td> 132 <td><a href="#ProjectDjangoPlugin.getMenuNames">getMenuNames</a></td>
106 <td>Public method to get the names of all menus.</td> 133 <td>Public method to get the names of all menus.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#ProjectDjangoPlugin.getPreferences">getPreferences</a></td> 136 <td><a href="#ProjectDjangoPlugin.getPreferences">getPreferences</a></td>
109 <td>Public method to retrieve the various settings.</td> 137 <td>Public method to retrieve the various settings.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#ProjectDjangoPlugin.lexerAssociationCallback">lexerAssociationCallback</a></td> 140 <td><a href="#ProjectDjangoPlugin.lexerAssociationCallback">lexerAssociationCallback</a></td>
112 <td>Public method to get the lexer association of the Django project type for a file.</td> 141 <td>Public method to get the lexer association of the Django project type for a file.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#ProjectDjangoPlugin.setPreferences">setPreferences</a></td> 144 <td><a href="#ProjectDjangoPlugin.setPreferences">setPreferences</a></td>
115 <td>Public method to store the various settings.</td> 145 <td>Public method to store the various settings.</td>
116 </tr> 146 </tr>
117 </table> 147 </table>
118 <h3>Static Methods</h3> 148 <h3>Static Methods</h3>
149
119 <table> 150 <table>
120 <tr><td>None</td></tr> 151 <tr><td>None</td></tr>
121 </table> 152 </table>
153
122 <a NAME="ProjectDjangoPlugin.__init__" ID="ProjectDjangoPlugin.__init__"></a> 154 <a NAME="ProjectDjangoPlugin.__init__" ID="ProjectDjangoPlugin.__init__"></a>
123 <h4>ProjectDjangoPlugin (Constructor)</h4> 155 <h4>ProjectDjangoPlugin (Constructor)</h4>
124 <b>ProjectDjangoPlugin</b>(<i>ui</i>) 156 <b>ProjectDjangoPlugin</b>(<i>ui</i>)
157
125 <p> 158 <p>
126 Constructor 159 Constructor
127 </p><dl> 160 </p>
161 <dl>
162
128 <dt><i>ui</i></dt> 163 <dt><i>ui</i></dt>
129 <dd> 164 <dd>
130 reference to the user interface object (UI.UserInterface) 165 reference to the user interface object (UI.UserInterface)
131 </dd> 166 </dd>
132 </dl><a NAME="ProjectDjangoPlugin.__initialize" ID="ProjectDjangoPlugin.__initialize"></a> 167 </dl>
168 <a NAME="ProjectDjangoPlugin.__initialize" ID="ProjectDjangoPlugin.__initialize"></a>
133 <h4>ProjectDjangoPlugin.__initialize</h4> 169 <h4>ProjectDjangoPlugin.__initialize</h4>
134 <b>__initialize</b>(<i></i>) 170 <b>__initialize</b>(<i></i>)
171
135 <p> 172 <p>
136 Private slot to (re)initialize the plugin. 173 Private slot to (re)initialize the plugin.
137 </p><a NAME="ProjectDjangoPlugin.__loadTranslator" ID="ProjectDjangoPlugin.__loadTranslator"></a> 174 </p>
175 <a NAME="ProjectDjangoPlugin.__loadTranslator" ID="ProjectDjangoPlugin.__loadTranslator"></a>
138 <h4>ProjectDjangoPlugin.__loadTranslator</h4> 176 <h4>ProjectDjangoPlugin.__loadTranslator</h4>
139 <b>__loadTranslator</b>(<i></i>) 177 <b>__loadTranslator</b>(<i></i>)
178
140 <p> 179 <p>
141 Private method to load the translation file. 180 Private method to load the translation file.
142 </p><a NAME="ProjectDjangoPlugin.__projectClosed" ID="ProjectDjangoPlugin.__projectClosed"></a> 181 </p>
182 <a NAME="ProjectDjangoPlugin.__projectClosed" ID="ProjectDjangoPlugin.__projectClosed"></a>
143 <h4>ProjectDjangoPlugin.__projectClosed</h4> 183 <h4>ProjectDjangoPlugin.__projectClosed</h4>
144 <b>__projectClosed</b>(<i></i>) 184 <b>__projectClosed</b>(<i></i>)
185
145 <p> 186 <p>
146 Private slot to handle the projectClosed signal. 187 Private slot to handle the projectClosed signal.
147 </p><a NAME="ProjectDjangoPlugin.__projectOpened" ID="ProjectDjangoPlugin.__projectOpened"></a> 188 </p>
189 <a NAME="ProjectDjangoPlugin.__projectOpened" ID="ProjectDjangoPlugin.__projectOpened"></a>
148 <h4>ProjectDjangoPlugin.__projectOpened</h4> 190 <h4>ProjectDjangoPlugin.__projectOpened</h4>
149 <b>__projectOpened</b>(<i></i>) 191 <b>__projectOpened</b>(<i></i>)
192
150 <p> 193 <p>
151 Private slot to handle the projectOpened signal. 194 Private slot to handle the projectOpened signal.
152 </p><a NAME="ProjectDjangoPlugin.__reregisterProjectType" ID="ProjectDjangoPlugin.__reregisterProjectType"></a> 195 </p>
196 <a NAME="ProjectDjangoPlugin.__reregisterProjectType" ID="ProjectDjangoPlugin.__reregisterProjectType"></a>
153 <h4>ProjectDjangoPlugin.__reregisterProjectType</h4> 197 <h4>ProjectDjangoPlugin.__reregisterProjectType</h4>
154 <b>__reregisterProjectType</b>(<i></i>) 198 <b>__reregisterProjectType</b>(<i></i>)
199
155 <p> 200 <p>
156 Private method to re-register the project type. 201 Private method to re-register the project type.
157 </p><a NAME="ProjectDjangoPlugin.activate" ID="ProjectDjangoPlugin.activate"></a> 202 </p>
203 <a NAME="ProjectDjangoPlugin.activate" ID="ProjectDjangoPlugin.activate"></a>
158 <h4>ProjectDjangoPlugin.activate</h4> 204 <h4>ProjectDjangoPlugin.activate</h4>
159 <b>activate</b>(<i></i>) 205 <b>activate</b>(<i></i>)
206
160 <p> 207 <p>
161 Public method to activate this plugin. 208 Public method to activate this plugin.
162 </p><dl> 209 </p>
210 <dl>
163 <dt>Returns:</dt> 211 <dt>Returns:</dt>
164 <dd> 212 <dd>
165 tuple of None and activation status (boolean) 213 tuple of None and activation status (boolean)
166 </dd> 214 </dd>
167 </dl><a NAME="ProjectDjangoPlugin.binaryTranslationsCallback" ID="ProjectDjangoPlugin.binaryTranslationsCallback"></a> 215 </dl>
216 <a NAME="ProjectDjangoPlugin.binaryTranslationsCallback" ID="ProjectDjangoPlugin.binaryTranslationsCallback"></a>
168 <h4>ProjectDjangoPlugin.binaryTranslationsCallback</h4> 217 <h4>ProjectDjangoPlugin.binaryTranslationsCallback</h4>
169 <b>binaryTranslationsCallback</b>(<i>filename</i>) 218 <b>binaryTranslationsCallback</b>(<i>filename</i>)
219
170 <p> 220 <p>
171 Public method to determine the filename of a compiled translation file 221 Public method to determine the filename of a compiled translation file
172 given the translation source file. 222 given the translation source file.
173 </p><dl> 223 </p>
224 <dl>
225
174 <dt><i>filename</i></dt> 226 <dt><i>filename</i></dt>
175 <dd> 227 <dd>
176 name of the translation source file (string) 228 name of the translation source file (string)
177 </dd> 229 </dd>
178 </dl><dl> 230 </dl>
231 <dl>
179 <dt>Returns:</dt> 232 <dt>Returns:</dt>
180 <dd> 233 <dd>
181 name of the binary translation file (string) 234 name of the binary translation file (string)
182 </dd> 235 </dd>
183 </dl><a NAME="ProjectDjangoPlugin.deactivate" ID="ProjectDjangoPlugin.deactivate"></a> 236 </dl>
237 <a NAME="ProjectDjangoPlugin.deactivate" ID="ProjectDjangoPlugin.deactivate"></a>
184 <h4>ProjectDjangoPlugin.deactivate</h4> 238 <h4>ProjectDjangoPlugin.deactivate</h4>
185 <b>deactivate</b>(<i></i>) 239 <b>deactivate</b>(<i></i>)
240
186 <p> 241 <p>
187 Public method to deactivate this plugin. 242 Public method to deactivate this plugin.
188 </p><a NAME="ProjectDjangoPlugin.fileTypesCallback" ID="ProjectDjangoPlugin.fileTypesCallback"></a> 243 </p>
244 <a NAME="ProjectDjangoPlugin.fileTypesCallback" ID="ProjectDjangoPlugin.fileTypesCallback"></a>
189 <h4>ProjectDjangoPlugin.fileTypesCallback</h4> 245 <h4>ProjectDjangoPlugin.fileTypesCallback</h4>
190 <b>fileTypesCallback</b>(<i></i>) 246 <b>fileTypesCallback</b>(<i></i>)
247
191 <p> 248 <p>
192 Public method get the filetype associations of the Django project type. 249 Public method get the filetype associations of the Django project type.
193 </p><dl> 250 </p>
251 <dl>
194 <dt>Returns:</dt> 252 <dt>Returns:</dt>
195 <dd> 253 <dd>
196 dictionary with file type associations 254 dictionary with file type associations
197 </dd> 255 </dd>
198 </dl><a NAME="ProjectDjangoPlugin.getMenu" ID="ProjectDjangoPlugin.getMenu"></a> 256 </dl>
257 <a NAME="ProjectDjangoPlugin.getMenu" ID="ProjectDjangoPlugin.getMenu"></a>
199 <h4>ProjectDjangoPlugin.getMenu</h4> 258 <h4>ProjectDjangoPlugin.getMenu</h4>
200 <b>getMenu</b>(<i>name</i>) 259 <b>getMenu</b>(<i>name</i>)
260
201 <p> 261 <p>
202 Public method to get a reference to the requested menu. 262 Public method to get a reference to the requested menu.
203 </p><dl> 263 </p>
264 <dl>
265
204 <dt><i>name</i></dt> 266 <dt><i>name</i></dt>
205 <dd> 267 <dd>
206 name of the menu (string) 268 name of the menu (string)
207 </dd> 269 </dd>
208 </dl><dl> 270 </dl>
271 <dl>
209 <dt>Returns:</dt> 272 <dt>Returns:</dt>
210 <dd> 273 <dd>
211 reference to the menu (QMenu) or None, if no 274 reference to the menu (QMenu) or None, if no
212 menu with the given name exists 275 menu with the given name exists
213 </dd> 276 </dd>
214 </dl><a NAME="ProjectDjangoPlugin.getMenuNames" ID="ProjectDjangoPlugin.getMenuNames"></a> 277 </dl>
278 <a NAME="ProjectDjangoPlugin.getMenuNames" ID="ProjectDjangoPlugin.getMenuNames"></a>
215 <h4>ProjectDjangoPlugin.getMenuNames</h4> 279 <h4>ProjectDjangoPlugin.getMenuNames</h4>
216 <b>getMenuNames</b>(<i></i>) 280 <b>getMenuNames</b>(<i></i>)
281
217 <p> 282 <p>
218 Public method to get the names of all menus. 283 Public method to get the names of all menus.
219 </p><dl> 284 </p>
285 <dl>
220 <dt>Returns:</dt> 286 <dt>Returns:</dt>
221 <dd> 287 <dd>
222 menu names (list of string) 288 menu names (list of string)
223 </dd> 289 </dd>
224 </dl><a NAME="ProjectDjangoPlugin.getPreferences" ID="ProjectDjangoPlugin.getPreferences"></a> 290 </dl>
291 <a NAME="ProjectDjangoPlugin.getPreferences" ID="ProjectDjangoPlugin.getPreferences"></a>
225 <h4>ProjectDjangoPlugin.getPreferences</h4> 292 <h4>ProjectDjangoPlugin.getPreferences</h4>
226 <b>getPreferences</b>(<i>key</i>) 293 <b>getPreferences</b>(<i>key</i>)
294
227 <p> 295 <p>
228 Public method to retrieve the various settings. 296 Public method to retrieve the various settings.
229 </p><dl> 297 </p>
298 <dl>
299
230 <dt><i>key</i></dt> 300 <dt><i>key</i></dt>
231 <dd> 301 <dd>
232 the key of the value to get 302 the key of the value to get
233 </dd> 303 </dd>
234 </dl><dl> 304 </dl>
305 <dl>
235 <dt>Returns:</dt> 306 <dt>Returns:</dt>
236 <dd> 307 <dd>
237 the requested setting 308 the requested setting
238 </dd> 309 </dd>
239 </dl><a NAME="ProjectDjangoPlugin.lexerAssociationCallback" ID="ProjectDjangoPlugin.lexerAssociationCallback"></a> 310 </dl>
311 <a NAME="ProjectDjangoPlugin.lexerAssociationCallback" ID="ProjectDjangoPlugin.lexerAssociationCallback"></a>
240 <h4>ProjectDjangoPlugin.lexerAssociationCallback</h4> 312 <h4>ProjectDjangoPlugin.lexerAssociationCallback</h4>
241 <b>lexerAssociationCallback</b>(<i>filename</i>) 313 <b>lexerAssociationCallback</b>(<i>filename</i>)
314
242 <p> 315 <p>
243 Public method to get the lexer association of the Django project type 316 Public method to get the lexer association of the Django project type
244 for a file. 317 for a file.
245 </p><dl> 318 </p>
319 <dl>
320
246 <dt><i>filename</i></dt> 321 <dt><i>filename</i></dt>
247 <dd> 322 <dd>
248 name of the file (string) 323 name of the file (string)
249 </dd> 324 </dd>
250 </dl><dl> 325 </dl>
326 <dl>
251 <dt>Returns:</dt> 327 <dt>Returns:</dt>
252 <dd> 328 <dd>
253 name of the lexer (string) (Pygments lexers are prefixed with 329 name of the lexer (string) (Pygments lexers are prefixed with
254 'Pygments|') 330 'Pygments|')
255 </dd> 331 </dd>
256 </dl><a NAME="ProjectDjangoPlugin.setPreferences" ID="ProjectDjangoPlugin.setPreferences"></a> 332 </dl>
333 <a NAME="ProjectDjangoPlugin.setPreferences" ID="ProjectDjangoPlugin.setPreferences"></a>
257 <h4>ProjectDjangoPlugin.setPreferences</h4> 334 <h4>ProjectDjangoPlugin.setPreferences</h4>
258 <b>setPreferences</b>(<i>key, value</i>) 335 <b>setPreferences</b>(<i>key, value</i>)
336
259 <p> 337 <p>
260 Public method to store the various settings. 338 Public method to store the various settings.
261 </p><dl> 339 </p>
340 <dl>
341
262 <dt><i>key</i></dt> 342 <dt><i>key</i></dt>
263 <dd> 343 <dd>
264 the key of the setting to be set (string) 344 the key of the setting to be set (string)
265 </dd><dt><i>value</i></dt> 345 </dd>
346 <dt><i>value</i></dt>
266 <dd> 347 <dd>
267 the value to be set 348 the value to be set
268 </dd> 349 </dd>
269 </dl> 350 </dl>
270 <div align="right"><a href="#top">Up</a></div> 351 <div align="right"><a href="#top">Up</a></div>
271 <hr /><hr /> 352 <hr />
353 <hr />
272 <a NAME="apiFiles" ID="apiFiles"></a> 354 <a NAME="apiFiles" ID="apiFiles"></a>
273 <h2>apiFiles</h2> 355 <h2>apiFiles</h2>
274 <b>apiFiles</b>(<i>language</i>) 356 <b>apiFiles</b>(<i>language</i>)
357
275 <p> 358 <p>
276 Module function to return the API files made available by this plugin. 359 Module function to return the API files made available by this plugin.
277 </p><dl> 360 </p>
361 <dl>
362
278 <dt><i>language</i></dt> 363 <dt><i>language</i></dt>
279 <dd> 364 <dd>
280 language to get APIs for (string) 365 language to get APIs for (string)
281 </dd> 366 </dd>
282 </dl><dl> 367 </dl>
368 <dl>
283 <dt>Returns:</dt> 369 <dt>Returns:</dt>
284 <dd> 370 <dd>
285 list of API filenames (list of string) 371 list of API filenames (list of string)
286 </dd> 372 </dd>
287 </dl> 373 </dl>
288 <div align="right"><a href="#top">Up</a></div> 374 <div align="right"><a href="#top">Up</a></div>
289 <hr /><hr /> 375 <hr />
376 <hr />
290 <a NAME="createDjangoPage" ID="createDjangoPage"></a> 377 <a NAME="createDjangoPage" ID="createDjangoPage"></a>
291 <h2>createDjangoPage</h2> 378 <h2>createDjangoPage</h2>
292 <b>createDjangoPage</b>(<i>configDlg</i>) 379 <b>createDjangoPage</b>(<i>configDlg</i>)
380
293 <p> 381 <p>
294 Module function to create the Django configuration page. 382 Module function to create the Django configuration page.
295 </p><dl> 383 </p>
384 <dl>
385
296 <dt><i>configDlg</i></dt> 386 <dt><i>configDlg</i></dt>
297 <dd> 387 <dd>
298 reference to the configuration dialog 388 reference to the configuration dialog
299 </dd> 389 </dd>
300 </dl><dl> 390 </dl>
391 <dl>
301 <dt>Returns:</dt> 392 <dt>Returns:</dt>
302 <dd> 393 <dd>
303 reference to the configuration page 394 reference to the configuration page
304 </dd> 395 </dd>
305 </dl> 396 </dl>
306 <div align="right"><a href="#top">Up</a></div> 397 <div align="right"><a href="#top">Up</a></div>
307 <hr /><hr /> 398 <hr />
399 <hr />
308 <a NAME="getConfigData" ID="getConfigData"></a> 400 <a NAME="getConfigData" ID="getConfigData"></a>
309 <h2>getConfigData</h2> 401 <h2>getConfigData</h2>
310 <b>getConfigData</b>(<i></i>) 402 <b>getConfigData</b>(<i></i>)
403
311 <p> 404 <p>
312 Module function returning data as required by the configuration dialog. 405 Module function returning data as required by the configuration dialog.
313 </p><dl> 406 </p>
407 <dl>
314 <dt>Returns:</dt> 408 <dt>Returns:</dt>
315 <dd> 409 <dd>
316 dictionary containing the relevant data 410 dictionary containing the relevant data
317 </dd> 411 </dd>
318 </dl> 412 </dl>
319 <div align="right"><a href="#top">Up</a></div> 413 <div align="right"><a href="#top">Up</a></div>
320 <hr /><hr /> 414 <hr />
415 <hr />
321 <a NAME="prepareUninstall" ID="prepareUninstall"></a> 416 <a NAME="prepareUninstall" ID="prepareUninstall"></a>
322 <h2>prepareUninstall</h2> 417 <h2>prepareUninstall</h2>
323 <b>prepareUninstall</b>(<i></i>) 418 <b>prepareUninstall</b>(<i></i>)
419
324 <p> 420 <p>
325 Module function to prepare for an uninstallation. 421 Module function to prepare for an uninstallation.
326 </p> 422 </p>
327 <div align="right"><a href="#top">Up</a></div> 423 <div align="right"><a href="#top">Up</a></div>
328 <hr /> 424 <hr />

Mercurial Repository: Django Project

eric ide

mercurial