Mercurial Repositories > Pyramid Project / file comparison
comparison: ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.PluginProjectPyramid.html
ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.PluginProjectPyramid.html
- changeset 54
- 71c83a661c83
- parent 44
- 989c961c33ab
- child 64
- 3b2da211e126
equal
deleted
inserted
replaced
| 53:a3ba38d3a25e | 54:71c83a661c83 |
|---|---|
| 194 Public method to deactivate this plugin. | 194 Public method to deactivate this plugin. |
| 195 </p><a NAME="ProjectPyramidPlugin.fileTypesCallback" ID="ProjectPyramidPlugin.fileTypesCallback"></a> | 195 </p><a NAME="ProjectPyramidPlugin.fileTypesCallback" ID="ProjectPyramidPlugin.fileTypesCallback"></a> |
| 196 <h4>ProjectPyramidPlugin.fileTypesCallback</h4> | 196 <h4>ProjectPyramidPlugin.fileTypesCallback</h4> |
| 197 <b>fileTypesCallback</b>(<i></i>) | 197 <b>fileTypesCallback</b>(<i></i>) |
| 198 <p> | 198 <p> |
| 199 Public method get the filetype associations of the Pyramid project type. | 199 Public method get the filetype associations of the Pyramid project |
| 200 type. | |
| 200 </p><dl> | 201 </p><dl> |
| 201 <dt>Returns:</dt> | 202 <dt>Returns:</dt> |
| 202 <dd> | 203 <dd> |
| 203 dictionary with file type associations | 204 dictionary with file type associations |
| 204 </dd> | 205 </dd> |
| 209 Public method to retrieve the various settings. | 210 Public method to retrieve the various settings. |
| 210 </p><dl> | 211 </p><dl> |
| 211 <dt><i>key</i></dt> | 212 <dt><i>key</i></dt> |
| 212 <dd> | 213 <dd> |
| 213 the key of the value to get | 214 the key of the value to get |
| 214 </dd><dt><i>prefClass</i></dt> | |
| 215 <dd> | |
| 216 preferences class used as the storage area | |
| 217 </dd> | 215 </dd> |
| 218 </dl><dl> | 216 </dl><dl> |
| 219 <dt>Returns:</dt> | 217 <dt>Returns:</dt> |
| 220 <dd> | 218 <dd> |
| 221 the requested setting | 219 the requested setting |
| 222 </dd> | 220 </dd> |
| 223 </dl><a NAME="ProjectPyramidPlugin.lexerAssociationCallback" ID="ProjectPyramidPlugin.lexerAssociationCallback"></a> | 221 </dl><a NAME="ProjectPyramidPlugin.lexerAssociationCallback" ID="ProjectPyramidPlugin.lexerAssociationCallback"></a> |
| 224 <h4>ProjectPyramidPlugin.lexerAssociationCallback</h4> | 222 <h4>ProjectPyramidPlugin.lexerAssociationCallback</h4> |
| 225 <b>lexerAssociationCallback</b>(<i>filename</i>) | 223 <b>lexerAssociationCallback</b>(<i>filename</i>) |
| 226 <p> | 224 <p> |
| 227 Public method to get the lexer association of the Pyramid project type for | 225 Public method to get the lexer association of the Pyramid project type |
| 228 a file. | 226 for a file. |
| 229 </p><dl> | 227 </p><dl> |
| 230 <dt><i>filename</i></dt> | 228 <dt><i>filename</i></dt> |
| 231 <dd> | 229 <dd> |
| 232 name of the file (string) | 230 name of the file (string) |
| 233 </dd> | 231 </dd> |
| 234 </dl><dl> | 232 </dl><dl> |
| 235 <dt>Returns:</dt> | 233 <dt>Returns:</dt> |
| 236 <dd> | 234 <dd> |
| 237 name of the lexer (string) (Pygments lexers are prefixed with 'Pygments|') | 235 name of the lexer (string) (Pygments lexers are prefixed with |
| 236 'Pygments|') | |
| 238 </dd> | 237 </dd> |
| 239 </dl><a NAME="ProjectPyramidPlugin.setPreferences" ID="ProjectPyramidPlugin.setPreferences"></a> | 238 </dl><a NAME="ProjectPyramidPlugin.setPreferences" ID="ProjectPyramidPlugin.setPreferences"></a> |
| 240 <h4>ProjectPyramidPlugin.setPreferences</h4> | 239 <h4>ProjectPyramidPlugin.setPreferences</h4> |
| 241 <b>setPreferences</b>(<i>key, value</i>) | 240 <b>setPreferences</b>(<i>key, value</i>) |
| 242 <p> | 241 <p> |
| 246 <dd> | 245 <dd> |
| 247 the key of the setting to be set (string) | 246 the key of the setting to be set (string) |
| 248 </dd><dt><i>value</i></dt> | 247 </dd><dt><i>value</i></dt> |
| 249 <dd> | 248 <dd> |
| 250 the value to be set | 249 the value to be set |
| 251 </dd><dt><i>prefClass</i></dt> | |
| 252 <dd> | |
| 253 preferences class used as the storage area | |
| 254 </dd> | 250 </dd> |
| 255 </dl> | 251 </dl> |
| 256 <div align="right"><a href="#top">Up</a></div> | 252 <div align="right"><a href="#top">Up</a></div> |
| 257 <hr /><hr /> | 253 <hr /><hr /> |
| 258 <a NAME="apiFiles" ID="apiFiles"></a> | 254 <a NAME="apiFiles" ID="apiFiles"></a> |
| 259 <h2>apiFiles</h2> | 255 <h2>apiFiles</h2> |
| 260 <b>apiFiles</b>(<i>language</i>) | 256 <b>apiFiles</b>(<i>language</i>) |
| 261 <p> | 257 <p> |
| 262 Module function to return the API files made available by this plugin. | 258 Module function to return the API files made available by this plugin. |
| 263 </p><dl> | 259 </p><dl> |
| 260 <dt><i>language</i></dt> | |
| 261 <dd> | |
| 262 language to get APIs for (string) | |
| 263 </dd> | |
| 264 </dl><dl> | |
| 264 <dt>Returns:</dt> | 265 <dt>Returns:</dt> |
| 265 <dd> | 266 <dd> |
| 266 list of API filenames (list of string) | 267 list of API filenames (list of string) |
| 267 </dd> | 268 </dd> |
| 268 </dl> | 269 </dl> |
| 272 <h2>createPyramidPage</h2> | 273 <h2>createPyramidPage</h2> |
| 273 <b>createPyramidPage</b>(<i>configDlg</i>) | 274 <b>createPyramidPage</b>(<i>configDlg</i>) |
| 274 <p> | 275 <p> |
| 275 Module function to create the Pyramid configuration page. | 276 Module function to create the Pyramid configuration page. |
| 276 </p><dl> | 277 </p><dl> |
| 278 <dt><i>configDlg</i></dt> | |
| 279 <dd> | |
| 280 reference to the configuration dialog | |
| 281 </dd> | |
| 282 </dl><dl> | |
| 277 <dt>Returns:</dt> | 283 <dt>Returns:</dt> |
| 278 <dd> | 284 <dd> |
| 279 reference to the configuration page | 285 reference to the configuration page |
| 280 </dd> | 286 </dd> |
| 281 </dl> | 287 </dl> |
