Mercurial Repositories > Pyramid Project / file comparison

comparison: ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.PluginProjectPyramid.html

ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.PluginProjectPyramid.html

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

Mercurial Repository: Pyramid Project

eric ide

mercurial