Mercurial Repositories > Pyramid Project / file comparison

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

ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.PluginProjectPyramid.html

changeset 15
db83e46b35da
child 25
2dd3d1cf573a
equal deleted inserted replaced
14:e3cb581b4653 15:db83e46b35da
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>Plugin_Project_Pyramid.PluginProjectPyramid</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>Plugin_Project_Pyramid.PluginProjectPyramid</h1>
24 <p>
25 Module implementing the Pyramid project plugin.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <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>shortDescription</td></tr><tr><td>version</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#ProjectPyramidPlugin">ProjectPyramidPlugin</a></td>
35 <td>Class implementing the Pyramid project plugin.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr>
41 <td><a href="#apiFiles">apiFiles</a></td>
42 <td>Module function to return the API files made available by this plugin.</td>
43 </tr><tr>
44 <td><a href="#createPyramidPage">createPyramidPage</a></td>
45 <td>Module function to create the Pyramid configuration page.</td>
46 </tr><tr>
47 <td><a href="#getConfigData">getConfigData</a></td>
48 <td>Module function returning data as required by the configuration dialog.</td>
49 </tr><tr>
50 <td><a href="#prepareUninstall">prepareUninstall</a></td>
51 <td>Module function to prepare for an uninstallation.</td>
52 </tr>
53 </table>
54 <hr /><hr />
55 <a NAME="ProjectPyramidPlugin" ID="ProjectPyramidPlugin"></a>
56 <h2>ProjectPyramidPlugin</h2>
57 <p>
58 Class implementing the Pyramid project plugin.
59 </p>
60 <h3>Derived from</h3>
61 QObject
62 <h3>Class Attributes</h3>
63 <table>
64 <tr><td>lexerAssociations</td></tr>
65 </table>
66 <h3>Class Methods</h3>
67 <table>
68 <tr><td>None</td></tr>
69 </table>
70 <h3>Methods</h3>
71 <table>
72 <tr>
73 <td><a href="#ProjectPyramidPlugin.__init__">ProjectPyramidPlugin</a></td>
74 <td>Constructor</td>
75 </tr><tr>
76 <td><a href="#ProjectPyramidPlugin.__checkVersions">__checkVersions</a></td>
77 <td>Private function to check that the eric5 version is ok.</td>
78 </tr><tr>
79 <td><a href="#ProjectPyramidPlugin.__initialize">__initialize</a></td>
80 <td>Private slot to (re)initialize the plugin.</td>
81 </tr><tr>
82 <td><a href="#ProjectPyramidPlugin.__loadTranslator">__loadTranslator</a></td>
83 <td>Private method to load the translation file.</td>
84 </tr><tr>
85 <td><a href="#ProjectPyramidPlugin.__projectClosed">__projectClosed</a></td>
86 <td>Private slot to handle the projectClosed signal.</td>
87 </tr><tr>
88 <td><a href="#ProjectPyramidPlugin.__projectOpened">__projectOpened</a></td>
89 <td>Private slot to handle the projectOpened signal.</td>
90 </tr><tr>
91 <td><a href="#ProjectPyramidPlugin.activate">activate</a></td>
92 <td>Public method to activate this plugin.</td>
93 </tr><tr>
94 <td><a href="#ProjectPyramidPlugin.binaryTranslationsCallback">binaryTranslationsCallback</a></td>
95 <td>Public method to determine the filename of a compiled translation file given the translation source file.</td>
96 </tr><tr>
97 <td><a href="#ProjectPyramidPlugin.deactivate">deactivate</a></td>
98 <td>Public method to deactivate this plugin.</td>
99 </tr><tr>
100 <td><a href="#ProjectPyramidPlugin.fileTypesCallback">fileTypesCallback</a></td>
101 <td>Public method get the filetype associations of the Pyramid project type.</td>
102 </tr><tr>
103 <td><a href="#ProjectPyramidPlugin.getPreferences">getPreferences</a></td>
104 <td>Public method to retrieve the various settings.</td>
105 </tr><tr>
106 <td><a href="#ProjectPyramidPlugin.lexerAssociationCallback">lexerAssociationCallback</a></td>
107 <td>Public method to get the lexer association of the Pyramid project type for a file.</td>
108 </tr><tr>
109 <td><a href="#ProjectPyramidPlugin.prepareUninstall">prepareUninstall</a></td>
110 <td>Public method to prepare for an uninstallation.</td>
111 </tr><tr>
112 <td><a href="#ProjectPyramidPlugin.setPreferences">setPreferences</a></td>
113 <td>Public method to store the various settings.</td>
114 </tr>
115 </table>
116 <h3>Static Methods</h3>
117 <table>
118 <tr><td>None</td></tr>
119 </table>
120 <a NAME="ProjectPyramidPlugin.__init__" ID="ProjectPyramidPlugin.__init__"></a>
121 <h4>ProjectPyramidPlugin (Constructor)</h4>
122 <b>ProjectPyramidPlugin</b>(<i>ui</i>)
123 <p>
124 Constructor
125 </p><dl>
126 <dt><i>ui</i></dt>
127 <dd>
128 reference to the user interface object (UI.UserInterface)
129 </dd>
130 </dl><a NAME="ProjectPyramidPlugin.__checkVersions" ID="ProjectPyramidPlugin.__checkVersions"></a>
131 <h4>ProjectPyramidPlugin.__checkVersions</h4>
132 <b>__checkVersions</b>(<i></i>)
133 <p>
134 Private function to check that the eric5 version is ok.
135 </p><dl>
136 <dt>Returns:</dt>
137 <dd>
138 flag indicating version is ok (boolean)
139 </dd>
140 </dl><a NAME="ProjectPyramidPlugin.__initialize" ID="ProjectPyramidPlugin.__initialize"></a>
141 <h4>ProjectPyramidPlugin.__initialize</h4>
142 <b>__initialize</b>(<i></i>)
143 <p>
144 Private slot to (re)initialize the plugin.
145 </p><a NAME="ProjectPyramidPlugin.__loadTranslator" ID="ProjectPyramidPlugin.__loadTranslator"></a>
146 <h4>ProjectPyramidPlugin.__loadTranslator</h4>
147 <b>__loadTranslator</b>(<i></i>)
148 <p>
149 Private method to load the translation file.
150 </p><a NAME="ProjectPyramidPlugin.__projectClosed" ID="ProjectPyramidPlugin.__projectClosed"></a>
151 <h4>ProjectPyramidPlugin.__projectClosed</h4>
152 <b>__projectClosed</b>(<i></i>)
153 <p>
154 Private slot to handle the projectClosed signal.
155 </p><a NAME="ProjectPyramidPlugin.__projectOpened" ID="ProjectPyramidPlugin.__projectOpened"></a>
156 <h4>ProjectPyramidPlugin.__projectOpened</h4>
157 <b>__projectOpened</b>(<i></i>)
158 <p>
159 Private slot to handle the projectOpened signal.
160 </p><a NAME="ProjectPyramidPlugin.activate" ID="ProjectPyramidPlugin.activate"></a>
161 <h4>ProjectPyramidPlugin.activate</h4>
162 <b>activate</b>(<i></i>)
163 <p>
164 Public method to activate this plugin.
165 </p><dl>
166 <dt>Returns:</dt>
167 <dd>
168 tuple of None and activation status (boolean)
169 </dd>
170 </dl><a NAME="ProjectPyramidPlugin.binaryTranslationsCallback" ID="ProjectPyramidPlugin.binaryTranslationsCallback"></a>
171 <h4>ProjectPyramidPlugin.binaryTranslationsCallback</h4>
172 <b>binaryTranslationsCallback</b>(<i>filename</i>)
173 <p>
174 Public method to determine the filename of a compiled translation file
175 given the translation source file.
176 </p><dl>
177 <dt><i>filename</i></dt>
178 <dd>
179 name of the translation source file (string)
180 </dd>
181 </dl><dl>
182 <dt>Returns:</dt>
183 <dd>
184 name of the binary translation file (string)
185 </dd>
186 </dl><a NAME="ProjectPyramidPlugin.deactivate" ID="ProjectPyramidPlugin.deactivate"></a>
187 <h4>ProjectPyramidPlugin.deactivate</h4>
188 <b>deactivate</b>(<i></i>)
189 <p>
190 Public method to deactivate this plugin.
191 </p><a NAME="ProjectPyramidPlugin.fileTypesCallback" ID="ProjectPyramidPlugin.fileTypesCallback"></a>
192 <h4>ProjectPyramidPlugin.fileTypesCallback</h4>
193 <b>fileTypesCallback</b>(<i></i>)
194 <p>
195 Public method get the filetype associations of the Pyramid project type.
196 </p><dl>
197 <dt>Returns:</dt>
198 <dd>
199 dictionary with file type associations
200 </dd>
201 </dl><a NAME="ProjectPyramidPlugin.getPreferences" ID="ProjectPyramidPlugin.getPreferences"></a>
202 <h4>ProjectPyramidPlugin.getPreferences</h4>
203 <b>getPreferences</b>(<i>key</i>)
204 <p>
205 Public method to retrieve the various settings.
206 </p><dl>
207 <dt><i>key</i></dt>
208 <dd>
209 the key of the value to get
210 </dd><dt><i>prefClass</i></dt>
211 <dd>
212 preferences class used as the storage area
213 </dd>
214 </dl><dl>
215 <dt>Returns:</dt>
216 <dd>
217 the requested setting
218 </dd>
219 </dl><a NAME="ProjectPyramidPlugin.lexerAssociationCallback" ID="ProjectPyramidPlugin.lexerAssociationCallback"></a>
220 <h4>ProjectPyramidPlugin.lexerAssociationCallback</h4>
221 <b>lexerAssociationCallback</b>(<i>filename</i>)
222 <p>
223 Public method to get the lexer association of the Pyramid project type for
224 a file.
225 </p><dl>
226 <dt><i>filename</i></dt>
227 <dd>
228 name of the file (string)
229 </dd>
230 </dl><dl>
231 <dt>Returns:</dt>
232 <dd>
233 name of the lexer (string) (Pygments lexers are prefixed with 'Pygments|')
234 </dd>
235 </dl><a NAME="ProjectPyramidPlugin.prepareUninstall" ID="ProjectPyramidPlugin.prepareUninstall"></a>
236 <h4>ProjectPyramidPlugin.prepareUninstall</h4>
237 <b>prepareUninstall</b>(<i></i>)
238 <p>
239 Public method to prepare for an uninstallation.
240 </p><a NAME="ProjectPyramidPlugin.setPreferences" ID="ProjectPyramidPlugin.setPreferences"></a>
241 <h4>ProjectPyramidPlugin.setPreferences</h4>
242 <b>setPreferences</b>(<i>key, value</i>)
243 <p>
244 Public method to store the various settings.
245 </p><dl>
246 <dt><i>key</i></dt>
247 <dd>
248 the key of the setting to be set (string)
249 </dd><dt><i>value</i></dt>
250 <dd>
251 the value to be set
252 </dd><dt><i>prefClass</i></dt>
253 <dd>
254 preferences class used as the storage area
255 </dd>
256 </dl>
257 <div align="right"><a href="#top">Up</a></div>
258 <hr /><hr />
259 <a NAME="apiFiles" ID="apiFiles"></a>
260 <h2>apiFiles</h2>
261 <b>apiFiles</b>(<i>language</i>)
262 <p>
263 Module function to return the API files made available by this plugin.
264 </p><dl>
265 <dt>Returns:</dt>
266 <dd>
267 list of API filenames (list of string)
268 </dd>
269 </dl>
270 <div align="right"><a href="#top">Up</a></div>
271 <hr /><hr />
272 <a NAME="createPyramidPage" ID="createPyramidPage"></a>
273 <h2>createPyramidPage</h2>
274 <b>createPyramidPage</b>(<i>configDlg</i>)
275 <p>
276 Module function to create the Pyramid configuration page.
277 </p><dl>
278 <dt>Returns:</dt>
279 <dd>
280 reference to the configuration page
281 </dd>
282 </dl>
283 <div align="right"><a href="#top">Up</a></div>
284 <hr /><hr />
285 <a NAME="getConfigData" ID="getConfigData"></a>
286 <h2>getConfigData</h2>
287 <b>getConfigData</b>(<i></i>)
288 <p>
289 Module function returning data as required by the configuration dialog.
290 </p><dl>
291 <dt>Returns:</dt>
292 <dd>
293 dictionary containing the relevant data
294 </dd>
295 </dl>
296 <div align="right"><a href="#top">Up</a></div>
297 <hr /><hr />
298 <a NAME="prepareUninstall" ID="prepareUninstall"></a>
299 <h2>prepareUninstall</h2>
300 <b>prepareUninstall</b>(<i></i>)
301 <p>
302 Module function to prepare for an uninstallation.
303 </p>
304 <div align="right"><a href="#top">Up</a></div>
305 <hr />
306 </body></html>

Mercurial Repository: Pyramid Project

eric ide

mercurial