Mercurial Repositories > Pyramid Project / file comparison

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

ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.Project.html

changeset 133
8f183975895d
parent 114
4de6dbce4dd6
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.ProjectPyramid.Project</h1> 23 <h1>Plugin_Project_Pyramid.ProjectPyramid.Project</h1>
24
23 <p> 25 <p>
24 Module implementing the Pyramid project support. 26 Module implementing the Pyramid project support.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</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="#Project">Project</a></td> 38 <td><a href="#Project">Project</a></td>
34 <td>Class implementing the Pyramid project support.</td> 39 <td>Class implementing the Pyramid project support.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#PyramidNoProjectSelectedException">PyramidNoProjectSelectedException</a></td> 42 <td><a href="#PyramidNoProjectSelectedException">PyramidNoProjectSelectedException</a></td>
37 <td>Exception thrown to signal, that there is no current Pyramid project.</td> 43 <td>Exception thrown to signal, that there is no current Pyramid project.</td>
38 </tr><tr> 44 </tr>
45 <tr>
39 <td><a href="#QProcess">QProcess</a></td> 46 <td><a href="#QProcess">QProcess</a></td>
40 <td>Class transforming the call arguments in case of gnome-terminal.</td> 47 <td>Class transforming the call arguments in case of gnome-terminal.</td>
41 </tr> 48 </tr>
42 </table> 49 </table>
43 <h3>Functions</h3> 50 <h3>Functions</h3>
51
44 <table> 52 <table>
45 <tr><td>None</td></tr> 53 <tr><td>None</td></tr>
46 </table> 54 </table>
47 <hr /><hr /> 55 <hr />
56 <hr />
48 <a NAME="Project" ID="Project"></a> 57 <a NAME="Project" ID="Project"></a>
49 <h2>Project</h2> 58 <h2>Project</h2>
59
50 <p> 60 <p>
51 Class implementing the Pyramid project support. 61 Class implementing the Pyramid project support.
52 </p> 62 </p>
53 <h3>Derived from</h3> 63 <h3>Derived from</h3>
54 QObject 64 QObject
55 <h3>Class Attributes</h3> 65 <h3>Class Attributes</h3>
66
56 <table> 67 <table>
57 <tr><td>None</td></tr> 68 <tr><td>None</td></tr>
58 </table> 69 </table>
59 <h3>Class Methods</h3> 70 <h3>Class Methods</h3>
71
60 <table> 72 <table>
61 <tr><td>None</td></tr> 73 <tr><td>None</td></tr>
62 </table> 74 </table>
63 <h3>Methods</h3> 75 <h3>Methods</h3>
64 <table> 76
77 <table>
78
65 <tr> 79 <tr>
66 <td><a href="#Project.__init__">Project</a></td> 80 <td><a href="#Project.__init__">Project</a></td>
67 <td>Constructor</td> 81 <td>Constructor</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#Project.__adjustWorkingDirectory">__adjustWorkingDirectory</a></td> 84 <td><a href="#Project.__adjustWorkingDirectory">__adjustWorkingDirectory</a></td>
70 <td>Private method to adjust the working directory in the arguments list.</td> 85 <td>Private method to adjust the working directory in the arguments list.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#Project.__buildDistribution">__buildDistribution</a></td> 88 <td><a href="#Project.__buildDistribution">__buildDistribution</a></td>
73 <td>Private slot to build a distribution file for the current Pyramid project.</td> 89 <td>Private slot to build a distribution file for the current Pyramid project.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#Project.__createProject">__createProject</a></td> 92 <td><a href="#Project.__createProject">__createProject</a></td>
76 <td>Private slot to create a new Pyramid project.</td> 93 <td>Private slot to create a new Pyramid project.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#Project.__findProjects">__findProjects</a></td> 96 <td><a href="#Project.__findProjects">__findProjects</a></td>
79 <td>Private method to determine the relative path of all Pyramid projects (= top level dirs).</td> 97 <td>Private method to determine the relative path of all Pyramid projects (= top level dirs).</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#Project.__getDebugEnvironment">__getDebugEnvironment</a></td> 100 <td><a href="#Project.__getDebugEnvironment">__getDebugEnvironment</a></td>
82 <td>Private method to get the path of the debugger environment.</td> 101 <td>Private method to get the path of the debugger environment.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#Project.__getExecutablePaths">__getExecutablePaths</a></td> 104 <td><a href="#Project.__getExecutablePaths">__getExecutablePaths</a></td>
85 <td>Private method to build all full paths of an executable file from the environment.</td> 105 <td>Private method to build all full paths of an executable file from the environment.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#Project.__getInitDbCommand">__getInitDbCommand</a></td> 108 <td><a href="#Project.__getInitDbCommand">__getInitDbCommand</a></td>
88 <td>Private method to create the path to the initialization script.</td> 109 <td>Private method to create the path to the initialization script.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#Project.__getLocale">__getLocale</a></td> 112 <td><a href="#Project.__getLocale">__getLocale</a></td>
91 <td>Private method to extract the locale out of a file name.</td> 113 <td>Private method to extract the locale out of a file name.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#Project.__getVirtualEnvironment">__getVirtualEnvironment</a></td> 116 <td><a href="#Project.__getVirtualEnvironment">__getVirtualEnvironment</a></td>
94 <td>Private method to get the path of the virtual environment.</td> 117 <td>Private method to get the path of the virtual environment.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#Project.__initializeDatabase">__initializeDatabase</a></td> 120 <td><a href="#Project.__initializeDatabase">__initializeDatabase</a></td>
97 <td>Private slot to initialize the database of the Pyramid project.</td> 121 <td>Private slot to initialize the database of the Pyramid project.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#Project.__isSuitableForVariant">__isSuitableForVariant</a></td> 124 <td><a href="#Project.__isSuitableForVariant">__isSuitableForVariant</a></td>
100 <td>Private method to test, if a detected command file is suitable for the given Python variant.</td> 125 <td>Private method to test, if a detected command file is suitable for the given Python variant.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#Project.__normalizeList">__normalizeList</a></td> 128 <td><a href="#Project.__normalizeList">__normalizeList</a></td>
103 <td>Private method to normalize a list of file names.</td> 129 <td>Private method to normalize a list of file names.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#Project.__project">__project</a></td> 132 <td><a href="#Project.__project">__project</a></td>
106 <td>Private method to get the name of the current Pyramid project.</td> 133 <td>Private method to get the name of the current Pyramid project.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#Project.__projectFilteredList">__projectFilteredList</a></td> 136 <td><a href="#Project.__projectFilteredList">__projectFilteredList</a></td>
109 <td>Private method to filter a list of file names by Pyramid project.</td> 137 <td>Private method to filter a list of file names by Pyramid project.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#Project.__projectLanguageAdded">__projectLanguageAdded</a></td> 140 <td><a href="#Project.__projectLanguageAdded">__projectLanguageAdded</a></td>
112 <td>Private slot handling the addition of a new language.</td> 141 <td>Private slot handling the addition of a new language.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#Project.__projectPath">__projectPath</a></td> 144 <td><a href="#Project.__projectPath">__projectPath</a></td>
115 <td>Private method to calculate the full path of the Pyramid project.</td> 145 <td>Private method to calculate the full path of the Pyramid project.</td>
116 </tr><tr> 146 </tr>
147 <tr>
117 <td><a href="#Project.__pyramidInfo">__pyramidInfo</a></td> 148 <td><a href="#Project.__pyramidInfo">__pyramidInfo</a></td>
118 <td>Private slot to show some info about Pyramid.</td> 149 <td>Private slot to show some info about Pyramid.</td>
119 </tr><tr> 150 </tr>
151 <tr>
120 <td><a href="#Project.__runBrowser">__runBrowser</a></td> 152 <td><a href="#Project.__runBrowser">__runBrowser</a></td>
121 <td>Private slot to start the default web browser with the server URL.</td> 153 <td>Private slot to start the default web browser with the server URL.</td>
122 </tr><tr> 154 </tr>
155 <tr>
123 <td><a href="#Project.__runLoggingServer">__runLoggingServer</a></td> 156 <td><a href="#Project.__runLoggingServer">__runLoggingServer</a></td>
124 <td>Private slot to start the Pyramid Web server with logging.</td> 157 <td>Private slot to start the Pyramid Web server with logging.</td>
125 </tr><tr> 158 </tr>
159 <tr>
126 <td><a href="#Project.__runPythonShell">__runPythonShell</a></td> 160 <td><a href="#Project.__runPythonShell">__runPythonShell</a></td>
127 <td>Private slot to start a Python console for a Pyramid project.</td> 161 <td>Private slot to start a Python console for a Pyramid project.</td>
128 </tr><tr> 162 </tr>
163 <tr>
129 <td><a href="#Project.__runServer">__runServer</a></td> 164 <td><a href="#Project.__runServer">__runServer</a></td>
130 <td>Private slot to start the Pyramid Web server.</td> 165 <td>Private slot to start the Pyramid Web server.</td>
131 </tr><tr> 166 </tr>
167 <tr>
132 <td><a href="#Project.__selectProject">__selectProject</a></td> 168 <td><a href="#Project.__selectProject">__selectProject</a></td>
133 <td>Private method to select a Pyramid project to work with.</td> 169 <td>Private method to select a Pyramid project to work with.</td>
134 </tr><tr> 170 </tr>
171 <tr>
135 <td><a href="#Project.__serverProcFinished">__serverProcFinished</a></td> 172 <td><a href="#Project.__serverProcFinished">__serverProcFinished</a></td>
136 <td>Private slot connected to the finished signal.</td> 173 <td>Private slot connected to the finished signal.</td>
137 </tr><tr> 174 </tr>
175 <tr>
138 <td><a href="#Project.__setCurrentProject">__setCurrentProject</a></td> 176 <td><a href="#Project.__setCurrentProject">__setCurrentProject</a></td>
139 <td>Private slot to set the current project.</td> 177 <td>Private slot to set the current project.</td>
140 </tr><tr> 178 </tr>
179 <tr>
141 <td><a href="#Project.__setupDevelop">__setupDevelop</a></td> 180 <td><a href="#Project.__setupDevelop">__setupDevelop</a></td>
142 <td>Private slot to set up the development environment for the current project.</td> 181 <td>Private slot to set up the development environment for the current project.</td>
143 </tr><tr> 182 </tr>
183 <tr>
144 <td><a href="#Project.__showDocumentation">__showDocumentation</a></td> 184 <td><a href="#Project.__showDocumentation">__showDocumentation</a></td>
145 <td>Private slot to show the helpviewer with the Pyramid documentation.</td> 185 <td>Private slot to show the helpviewer with the Pyramid documentation.</td>
146 </tr><tr> 186 </tr>
187 <tr>
147 <td><a href="#Project.__showMatchingViews">__showMatchingViews</a></td> 188 <td><a href="#Project.__showMatchingViews">__showMatchingViews</a></td>
148 <td>Private slot showing all views that would match a given URL.</td> 189 <td>Private slot showing all views that would match a given URL.</td>
149 </tr><tr> 190 </tr>
191 <tr>
150 <td><a href="#Project.__showRoutes">__showRoutes</a></td> 192 <td><a href="#Project.__showRoutes">__showRoutes</a></td>
151 <td>Private slot showing all URL dispatch routes.</td> 193 <td>Private slot showing all URL dispatch routes.</td>
152 </tr><tr> 194 </tr>
195 <tr>
153 <td><a href="#Project.__showTweens">__showTweens</a></td> 196 <td><a href="#Project.__showTweens">__showTweens</a></td>
154 <td>Private slot showing all implicit and explicit tween objects.</td> 197 <td>Private slot showing all implicit and explicit tween objects.</td>
155 </tr><tr> 198 </tr>
199 <tr>
156 <td><a href="#Project.compileCatalogs">compileCatalogs</a></td> 200 <td><a href="#Project.compileCatalogs">compileCatalogs</a></td>
157 <td>Public method to compile the message catalogs.</td> 201 <td>Public method to compile the message catalogs.</td>
158 </tr><tr> 202 </tr>
203 <tr>
159 <td><a href="#Project.compileSelectedCatalogs">compileSelectedCatalogs</a></td> 204 <td><a href="#Project.compileSelectedCatalogs">compileSelectedCatalogs</a></td>
160 <td>Public method to update the message catalogs.</td> 205 <td>Public method to update the message catalogs.</td>
161 </tr><tr> 206 </tr>
207 <tr>
162 <td><a href="#Project.extractMessages">extractMessages</a></td> 208 <td><a href="#Project.extractMessages">extractMessages</a></td>
163 <td>Public method to extract the messages catalog template file.</td> 209 <td>Public method to extract the messages catalog template file.</td>
164 </tr><tr> 210 </tr>
211 <tr>
165 <td><a href="#Project.getMenu">getMenu</a></td> 212 <td><a href="#Project.getMenu">getMenu</a></td>
166 <td>Public method to get a reference to the requested menu.</td> 213 <td>Public method to get a reference to the requested menu.</td>
167 </tr><tr> 214 </tr>
215 <tr>
168 <td><a href="#Project.getMenuNames">getMenuNames</a></td> 216 <td><a href="#Project.getMenuNames">getMenuNames</a></td>
169 <td>Public method to get the names of all menus.</td> 217 <td>Public method to get the names of all menus.</td>
170 </tr><tr> 218 </tr>
219 <tr>
171 <td><a href="#Project.getPyramidCommand">getPyramidCommand</a></td> 220 <td><a href="#Project.getPyramidCommand">getPyramidCommand</a></td>
172 <td>Public method to build a Pyramid command.</td> 221 <td>Public method to build a Pyramid command.</td>
173 </tr><tr> 222 </tr>
223 <tr>
174 <td><a href="#Project.getPyramidVersion">getPyramidVersion</a></td> 224 <td><a href="#Project.getPyramidVersion">getPyramidVersion</a></td>
175 <td>Public method to get the Pyramid version as a tuple.</td> 225 <td>Public method to get the Pyramid version as a tuple.</td>
176 </tr><tr> 226 </tr>
227 <tr>
177 <td><a href="#Project.getPyramidVersionString">getPyramidVersionString</a></td> 228 <td><a href="#Project.getPyramidVersionString">getPyramidVersionString</a></td>
178 <td>Public method to get the Pyramid version as a string.</td> 229 <td>Public method to get the Pyramid version as a string.</td>
179 </tr><tr> 230 </tr>
231 <tr>
180 <td><a href="#Project.getPythonCommand">getPythonCommand</a></td> 232 <td><a href="#Project.getPythonCommand">getPythonCommand</a></td>
181 <td>Public method to build the Python command.</td> 233 <td>Public method to build the Python command.</td>
182 </tr><tr> 234 </tr>
235 <tr>
183 <td><a href="#Project.initActions">initActions</a></td> 236 <td><a href="#Project.initActions">initActions</a></td>
184 <td>Public method to define the Pyramid actions.</td> 237 <td>Public method to define the Pyramid actions.</td>
185 </tr><tr> 238 </tr>
239 <tr>
186 <td><a href="#Project.initMenu">initMenu</a></td> 240 <td><a href="#Project.initMenu">initMenu</a></td>
187 <td>Public slot to initialize the Pyramid menu.</td> 241 <td>Public slot to initialize the Pyramid menu.</td>
188 </tr><tr> 242 </tr>
243 <tr>
189 <td><a href="#Project.isSpawningConsole">isSpawningConsole</a></td> 244 <td><a href="#Project.isSpawningConsole">isSpawningConsole</a></td>
190 <td>Public method to check, if the given console is a spawning console.</td> 245 <td>Public method to check, if the given console is a spawning console.</td>
191 </tr><tr> 246 </tr>
247 <tr>
192 <td><a href="#Project.newForm">newForm</a></td> 248 <td><a href="#Project.newForm">newForm</a></td>
193 <td>Public method to create a new form.</td> 249 <td>Public method to create a new form.</td>
194 </tr><tr> 250 </tr>
251 <tr>
195 <td><a href="#Project.openPOEditor">openPOEditor</a></td> 252 <td><a href="#Project.openPOEditor">openPOEditor</a></td>
196 <td>Public method to edit the given file in an external .po editor.</td> 253 <td>Public method to edit the given file in an external .po editor.</td>
197 </tr><tr> 254 </tr>
255 <tr>
198 <td><a href="#Project.projectClosed">projectClosed</a></td> 256 <td><a href="#Project.projectClosed">projectClosed</a></td>
199 <td>Public method to handle the closing of a project.</td> 257 <td>Public method to handle the closing of a project.</td>
200 </tr><tr> 258 </tr>
259 <tr>
201 <td><a href="#Project.projectClosedHooks">projectClosedHooks</a></td> 260 <td><a href="#Project.projectClosedHooks">projectClosedHooks</a></td>
202 <td>Public method to remove our hook methods.</td> 261 <td>Public method to remove our hook methods.</td>
203 </tr><tr> 262 </tr>
263 <tr>
204 <td><a href="#Project.projectOpenedHooks">projectOpenedHooks</a></td> 264 <td><a href="#Project.projectOpenedHooks">projectOpenedHooks</a></td>
205 <td>Public method to add our hook methods.</td> 265 <td>Public method to add our hook methods.</td>
206 </tr><tr> 266 </tr>
267 <tr>
207 <td><a href="#Project.registerOpenHook">registerOpenHook</a></td> 268 <td><a href="#Project.registerOpenHook">registerOpenHook</a></td>
208 <td>Public method to register the open hook to open a translations file in a translations editor.</td> 269 <td>Public method to register the open hook to open a translations file in a translations editor.</td>
209 </tr><tr> 270 </tr>
271 <tr>
210 <td><a href="#Project.supportedPythonVariants">supportedPythonVariants</a></td> 272 <td><a href="#Project.supportedPythonVariants">supportedPythonVariants</a></td>
211 <td>Public method to get the supported Python variants.</td> 273 <td>Public method to get the supported Python variants.</td>
212 </tr><tr> 274 </tr>
275 <tr>
213 <td><a href="#Project.updateCatalogs">updateCatalogs</a></td> 276 <td><a href="#Project.updateCatalogs">updateCatalogs</a></td>
214 <td>Public method to update the message catalogs.</td> 277 <td>Public method to update the message catalogs.</td>
215 </tr><tr> 278 </tr>
279 <tr>
216 <td><a href="#Project.updateSelectedCatalogs">updateSelectedCatalogs</a></td> 280 <td><a href="#Project.updateSelectedCatalogs">updateSelectedCatalogs</a></td>
217 <td>Public method to update the message catalogs.</td> 281 <td>Public method to update the message catalogs.</td>
218 </tr> 282 </tr>
219 </table> 283 </table>
220 <h3>Static Methods</h3> 284 <h3>Static Methods</h3>
285
221 <table> 286 <table>
222 <tr><td>None</td></tr> 287 <tr><td>None</td></tr>
223 </table> 288 </table>
289
224 <a NAME="Project.__init__" ID="Project.__init__"></a> 290 <a NAME="Project.__init__" ID="Project.__init__"></a>
225 <h4>Project (Constructor)</h4> 291 <h4>Project (Constructor)</h4>
226 <b>Project</b>(<i>plugin, parent=None</i>) 292 <b>Project</b>(<i>plugin, iconSuffix, parent=None</i>)
293
227 <p> 294 <p>
228 Constructor 295 Constructor
229 </p><dl> 296 </p>
230 <dt><i>plugin</i></dt> 297 <dl>
298
299 <dt><i>plugin</i> (ProjectPyramidPlugin)</dt>
231 <dd> 300 <dd>
232 reference to the plugin object 301 reference to the plugin object
233 </dd><dt><i>parent</i></dt> 302 </dd>
234 <dd> 303 <dt><i>iconSuffix</i> (str)</dt>
235 parent (QObject) 304 <dd>
236 </dd> 305 suffix for the icons
237 </dl><a NAME="Project.__adjustWorkingDirectory" ID="Project.__adjustWorkingDirectory"></a> 306 </dd>
307 <dt><i>parent</i> (QObject)</dt>
308 <dd>
309 parent
310 </dd>
311 </dl>
312 <a NAME="Project.__adjustWorkingDirectory" ID="Project.__adjustWorkingDirectory"></a>
238 <h4>Project.__adjustWorkingDirectory</h4> 313 <h4>Project.__adjustWorkingDirectory</h4>
239 <b>__adjustWorkingDirectory</b>(<i>args, wd</i>) 314 <b>__adjustWorkingDirectory</b>(<i>args, wd</i>)
315
240 <p> 316 <p>
241 Private method to adjust the working directory in the arguments list. 317 Private method to adjust the working directory in the arguments list.
242 </p><dl> 318 </p>
319 <dl>
320
243 <dt><i>args</i> (list of str)</dt> 321 <dt><i>args</i> (list of str)</dt>
244 <dd> 322 <dd>
245 list of arguments to be modified 323 list of arguments to be modified
246 </dd><dt><i>wd</i> (str)</dt> 324 </dd>
325 <dt><i>wd</i> (str)</dt>
247 <dd> 326 <dd>
248 working directory 327 working directory
249 </dd> 328 </dd>
250 </dl><a NAME="Project.__buildDistribution" ID="Project.__buildDistribution"></a> 329 </dl>
330 <a NAME="Project.__buildDistribution" ID="Project.__buildDistribution"></a>
251 <h4>Project.__buildDistribution</h4> 331 <h4>Project.__buildDistribution</h4>
252 <b>__buildDistribution</b>(<i></i>) 332 <b>__buildDistribution</b>(<i></i>)
333
253 <p> 334 <p>
254 Private slot to build a distribution file for the current Pyramid 335 Private slot to build a distribution file for the current Pyramid
255 project. 336 project.
256 </p><a NAME="Project.__createProject" ID="Project.__createProject"></a> 337 </p>
338 <a NAME="Project.__createProject" ID="Project.__createProject"></a>
257 <h4>Project.__createProject</h4> 339 <h4>Project.__createProject</h4>
258 <b>__createProject</b>(<i></i>) 340 <b>__createProject</b>(<i></i>)
341
259 <p> 342 <p>
260 Private slot to create a new Pyramid project. 343 Private slot to create a new Pyramid project.
261 </p><a NAME="Project.__findProjects" ID="Project.__findProjects"></a> 344 </p>
345 <a NAME="Project.__findProjects" ID="Project.__findProjects"></a>
262 <h4>Project.__findProjects</h4> 346 <h4>Project.__findProjects</h4>
263 <b>__findProjects</b>(<i></i>) 347 <b>__findProjects</b>(<i></i>)
348
264 <p> 349 <p>
265 Private method to determine the relative path of all Pyramid 350 Private method to determine the relative path of all Pyramid
266 projects (= top level dirs). 351 projects (= top level dirs).
267 </p><dl> 352 </p>
353 <dl>
268 <dt>Returns:</dt> 354 <dt>Returns:</dt>
269 <dd> 355 <dd>
270 list of projects (list of string) 356 list of projects (list of string)
271 </dd> 357 </dd>
272 </dl><a NAME="Project.__getDebugEnvironment" ID="Project.__getDebugEnvironment"></a> 358 </dl>
359 <a NAME="Project.__getDebugEnvironment" ID="Project.__getDebugEnvironment"></a>
273 <h4>Project.__getDebugEnvironment</h4> 360 <h4>Project.__getDebugEnvironment</h4>
274 <b>__getDebugEnvironment</b>(<i>language=""</i>) 361 <b>__getDebugEnvironment</b>(<i>language=""</i>)
362
275 <p> 363 <p>
276 Private method to get the path of the debugger environment. 364 Private method to get the path of the debugger environment.
277 </p><dl> 365 </p>
366 <dl>
367
278 <dt><i>language</i></dt> 368 <dt><i>language</i></dt>
279 <dd> 369 <dd>
280 Python variant to get the debugger environment 370 Python variant to get the debugger environment
281 for (string, one of '', 'Python2' or 'Python3') 371 for (string, one of '', 'Python2' or 'Python3')
282 </dd> 372 </dd>
283 </dl><dl> 373 </dl>
374 <dl>
284 <dt>Returns:</dt> 375 <dt>Returns:</dt>
285 <dd> 376 <dd>
286 path of the debugger environment (string) 377 path of the debugger environment (string)
287 </dd> 378 </dd>
288 </dl><a NAME="Project.__getExecutablePaths" ID="Project.__getExecutablePaths"></a> 379 </dl>
380 <a NAME="Project.__getExecutablePaths" ID="Project.__getExecutablePaths"></a>
289 <h4>Project.__getExecutablePaths</h4> 381 <h4>Project.__getExecutablePaths</h4>
290 <b>__getExecutablePaths</b>(<i>file</i>) 382 <b>__getExecutablePaths</b>(<i>file</i>)
383
291 <p> 384 <p>
292 Private method to build all full paths of an executable file from 385 Private method to build all full paths of an executable file from
293 the environment. 386 the environment.
294 </p><dl> 387 </p>
388 <dl>
389
295 <dt><i>file</i></dt> 390 <dt><i>file</i></dt>
296 <dd> 391 <dd>
297 filename of the executable (string) 392 filename of the executable (string)
298 </dd> 393 </dd>
299 </dl><dl> 394 </dl>
395 <dl>
300 <dt>Returns:</dt> 396 <dt>Returns:</dt>
301 <dd> 397 <dd>
302 list of full executable names, if the executable file is 398 list of full executable names, if the executable file is
303 accessible via the searchpath defined by the PATH environment 399 accessible via the searchpath defined by the PATH environment
304 variable, or an empty list otherwise. 400 variable, or an empty list otherwise.
305 </dd> 401 </dd>
306 </dl><a NAME="Project.__getInitDbCommand" ID="Project.__getInitDbCommand"></a> 402 </dl>
403 <a NAME="Project.__getInitDbCommand" ID="Project.__getInitDbCommand"></a>
307 <h4>Project.__getInitDbCommand</h4> 404 <h4>Project.__getInitDbCommand</h4>
308 <b>__getInitDbCommand</b>(<i></i>) 405 <b>__getInitDbCommand</b>(<i></i>)
406
309 <p> 407 <p>
310 Private method to create the path to the initialization script. 408 Private method to create the path to the initialization script.
311 </p><dl> 409 </p>
410 <dl>
312 <dt>Returns:</dt> 411 <dt>Returns:</dt>
313 <dd> 412 <dd>
314 path to the initialization script (string) 413 path to the initialization script (string)
315 </dd> 414 </dd>
316 </dl><a NAME="Project.__getLocale" ID="Project.__getLocale"></a> 415 </dl>
416 <a NAME="Project.__getLocale" ID="Project.__getLocale"></a>
317 <h4>Project.__getLocale</h4> 417 <h4>Project.__getLocale</h4>
318 <b>__getLocale</b>(<i>filename</i>) 418 <b>__getLocale</b>(<i>filename</i>)
419
319 <p> 420 <p>
320 Private method to extract the locale out of a file name. 421 Private method to extract the locale out of a file name.
321 </p><dl> 422 </p>
423 <dl>
424
322 <dt><i>filename</i></dt> 425 <dt><i>filename</i></dt>
323 <dd> 426 <dd>
324 name of the file used for extraction (string) 427 name of the file used for extraction (string)
325 </dd> 428 </dd>
326 </dl><dl> 429 </dl>
430 <dl>
327 <dt>Returns:</dt> 431 <dt>Returns:</dt>
328 <dd> 432 <dd>
329 extracted locale (string) or None 433 extracted locale (string) or None
330 </dd> 434 </dd>
331 </dl><a NAME="Project.__getVirtualEnvironment" ID="Project.__getVirtualEnvironment"></a> 435 </dl>
436 <a NAME="Project.__getVirtualEnvironment" ID="Project.__getVirtualEnvironment"></a>
332 <h4>Project.__getVirtualEnvironment</h4> 437 <h4>Project.__getVirtualEnvironment</h4>
333 <b>__getVirtualEnvironment</b>(<i>language=""</i>) 438 <b>__getVirtualEnvironment</b>(<i>language=""</i>)
439
334 <p> 440 <p>
335 Private method to get the path of the virtual environment. 441 Private method to get the path of the virtual environment.
336 </p><dl> 442 </p>
443 <dl>
444
337 <dt><i>language</i></dt> 445 <dt><i>language</i></dt>
338 <dd> 446 <dd>
339 Python variant to get the virtual environment 447 Python variant to get the virtual environment
340 for (string, one of '', 'Python2' or 'Python3') 448 for (string, one of '', 'Python2' or 'Python3')
341 </dd> 449 </dd>
342 </dl><dl> 450 </dl>
451 <dl>
343 <dt>Returns:</dt> 452 <dt>Returns:</dt>
344 <dd> 453 <dd>
345 path of the virtual environment (string) 454 path of the virtual environment (string)
346 </dd> 455 </dd>
347 </dl><a NAME="Project.__initializeDatabase" ID="Project.__initializeDatabase"></a> 456 </dl>
457 <a NAME="Project.__initializeDatabase" ID="Project.__initializeDatabase"></a>
348 <h4>Project.__initializeDatabase</h4> 458 <h4>Project.__initializeDatabase</h4>
349 <b>__initializeDatabase</b>(<i></i>) 459 <b>__initializeDatabase</b>(<i></i>)
460
350 <p> 461 <p>
351 Private slot to initialize the database of the Pyramid project. 462 Private slot to initialize the database of the Pyramid project.
352 </p><a NAME="Project.__isSuitableForVariant" ID="Project.__isSuitableForVariant"></a> 463 </p>
464 <a NAME="Project.__isSuitableForVariant" ID="Project.__isSuitableForVariant"></a>
353 <h4>Project.__isSuitableForVariant</h4> 465 <h4>Project.__isSuitableForVariant</h4>
354 <b>__isSuitableForVariant</b>(<i>variant, line0</i>) 466 <b>__isSuitableForVariant</b>(<i>variant, line0</i>)
467
355 <p> 468 <p>
356 Private method to test, if a detected command file is suitable for the 469 Private method to test, if a detected command file is suitable for the
357 given Python variant. 470 given Python variant.
358 </p><dl> 471 </p>
472 <dl>
473
359 <dt><i>variant</i> (str (one of Python2 or Python3))</dt> 474 <dt><i>variant</i> (str (one of Python2 or Python3))</dt>
360 <dd> 475 <dd>
361 Python variant to test for 476 Python variant to test for
362 </dd><dt><i>line0</i> (str)</dt> 477 </dd>
478 <dt><i>line0</i> (str)</dt>
363 <dd> 479 <dd>
364 first line of the executable 480 first line of the executable
365 </dd> 481 </dd>
366 </dl><dl> 482 </dl>
483 <dl>
367 <dt>Returns:</dt> 484 <dt>Returns:</dt>
368 <dd> 485 <dd>
369 flag indicating a suitable command 486 flag indicating a suitable command
370 </dd> 487 </dd>
371 </dl><dl> 488 </dl>
489 <dl>
372 <dt>Return Type:</dt> 490 <dt>Return Type:</dt>
373 <dd> 491 <dd>
374 bool 492 bool
375 </dd> 493 </dd>
376 </dl><a NAME="Project.__normalizeList" ID="Project.__normalizeList"></a> 494 </dl>
495 <a NAME="Project.__normalizeList" ID="Project.__normalizeList"></a>
377 <h4>Project.__normalizeList</h4> 496 <h4>Project.__normalizeList</h4>
378 <b>__normalizeList</b>(<i>filenames</i>) 497 <b>__normalizeList</b>(<i>filenames</i>)
498
379 <p> 499 <p>
380 Private method to normalize a list of file names. 500 Private method to normalize a list of file names.
381 </p><dl> 501 </p>
502 <dl>
503
382 <dt><i>filenames</i></dt> 504 <dt><i>filenames</i></dt>
383 <dd> 505 <dd>
384 list of file names to normalize (list of string) 506 list of file names to normalize (list of string)
385 </dd> 507 </dd>
386 </dl><dl> 508 </dl>
509 <dl>
387 <dt>Returns:</dt> 510 <dt>Returns:</dt>
388 <dd> 511 <dd>
389 normalized file names (list of string) 512 normalized file names (list of string)
390 </dd> 513 </dd>
391 </dl><a NAME="Project.__project" ID="Project.__project"></a> 514 </dl>
515 <a NAME="Project.__project" ID="Project.__project"></a>
392 <h4>Project.__project</h4> 516 <h4>Project.__project</h4>
393 <b>__project</b>(<i></i>) 517 <b>__project</b>(<i></i>)
518
394 <p> 519 <p>
395 Private method to get the name of the current Pyramid project. 520 Private method to get the name of the current Pyramid project.
396 </p><dl> 521 </p>
522 <dl>
397 <dt>Returns:</dt> 523 <dt>Returns:</dt>
398 <dd> 524 <dd>
399 name of the project (string) 525 name of the project (string)
400 </dd> 526 </dd>
401 </dl><dl> 527 </dl>
528 <dl>
529
402 <dt>Raises <b>PyramidNoProjectSelectedException</b>:</dt> 530 <dt>Raises <b>PyramidNoProjectSelectedException</b>:</dt>
403 <dd> 531 <dd>
404 raised, if no project is 532 raised, if no project is
405 selected 533 selected
406 </dd> 534 </dd>
407 </dl><a NAME="Project.__projectFilteredList" ID="Project.__projectFilteredList"></a> 535 </dl>
536 <a NAME="Project.__projectFilteredList" ID="Project.__projectFilteredList"></a>
408 <h4>Project.__projectFilteredList</h4> 537 <h4>Project.__projectFilteredList</h4>
409 <b>__projectFilteredList</b>(<i>filenames</i>) 538 <b>__projectFilteredList</b>(<i>filenames</i>)
539
410 <p> 540 <p>
411 Private method to filter a list of file names by Pyramid project. 541 Private method to filter a list of file names by Pyramid project.
412 </p><dl> 542 </p>
543 <dl>
544
413 <dt><i>filenames</i></dt> 545 <dt><i>filenames</i></dt>
414 <dd> 546 <dd>
415 list of file names to be filtered (list of string) 547 list of file names to be filtered (list of string)
416 </dd> 548 </dd>
417 </dl><dl> 549 </dl>
550 <dl>
418 <dt>Returns:</dt> 551 <dt>Returns:</dt>
419 <dd> 552 <dd>
420 file names belonging to the current site (list of string) 553 file names belonging to the current site (list of string)
421 </dd> 554 </dd>
422 </dl><a NAME="Project.__projectLanguageAdded" ID="Project.__projectLanguageAdded"></a> 555 </dl>
556 <a NAME="Project.__projectLanguageAdded" ID="Project.__projectLanguageAdded"></a>
423 <h4>Project.__projectLanguageAdded</h4> 557 <h4>Project.__projectLanguageAdded</h4>
424 <b>__projectLanguageAdded</b>(<i>code</i>) 558 <b>__projectLanguageAdded</b>(<i>code</i>)
559
425 <p> 560 <p>
426 Private slot handling the addition of a new language. 561 Private slot handling the addition of a new language.
427 </p><dl> 562 </p>
563 <dl>
564
428 <dt><i>code</i></dt> 565 <dt><i>code</i></dt>
429 <dd> 566 <dd>
430 language code of the new language (string) 567 language code of the new language (string)
431 </dd> 568 </dd>
432 </dl><a NAME="Project.__projectPath" ID="Project.__projectPath"></a> 569 </dl>
570 <a NAME="Project.__projectPath" ID="Project.__projectPath"></a>
433 <h4>Project.__projectPath</h4> 571 <h4>Project.__projectPath</h4>
434 <b>__projectPath</b>(<i></i>) 572 <b>__projectPath</b>(<i></i>)
573
435 <p> 574 <p>
436 Private method to calculate the full path of the Pyramid project. 575 Private method to calculate the full path of the Pyramid project.
437 </p><dl> 576 </p>
577 <dl>
438 <dt>Returns:</dt> 578 <dt>Returns:</dt>
439 <dd> 579 <dd>
440 path of the project (string) 580 path of the project (string)
441 </dd> 581 </dd>
442 </dl><dl> 582 </dl>
583 <dl>
584
443 <dt>Raises <b>PyramidNoProjectSelectedException</b>:</dt> 585 <dt>Raises <b>PyramidNoProjectSelectedException</b>:</dt>
444 <dd> 586 <dd>
445 raised, if no project is 587 raised, if no project is
446 selected 588 selected
447 </dd> 589 </dd>
448 </dl><a NAME="Project.__pyramidInfo" ID="Project.__pyramidInfo"></a> 590 </dl>
591 <a NAME="Project.__pyramidInfo" ID="Project.__pyramidInfo"></a>
449 <h4>Project.__pyramidInfo</h4> 592 <h4>Project.__pyramidInfo</h4>
450 <b>__pyramidInfo</b>(<i></i>) 593 <b>__pyramidInfo</b>(<i></i>)
594
451 <p> 595 <p>
452 Private slot to show some info about Pyramid. 596 Private slot to show some info about Pyramid.
453 </p><a NAME="Project.__runBrowser" ID="Project.__runBrowser"></a> 597 </p>
598 <a NAME="Project.__runBrowser" ID="Project.__runBrowser"></a>
454 <h4>Project.__runBrowser</h4> 599 <h4>Project.__runBrowser</h4>
455 <b>__runBrowser</b>(<i></i>) 600 <b>__runBrowser</b>(<i></i>)
601
456 <p> 602 <p>
457 Private slot to start the default web browser with the server URL. 603 Private slot to start the default web browser with the server URL.
458 </p><a NAME="Project.__runLoggingServer" ID="Project.__runLoggingServer"></a> 604 </p>
605 <a NAME="Project.__runLoggingServer" ID="Project.__runLoggingServer"></a>
459 <h4>Project.__runLoggingServer</h4> 606 <h4>Project.__runLoggingServer</h4>
460 <b>__runLoggingServer</b>(<i></i>) 607 <b>__runLoggingServer</b>(<i></i>)
608
461 <p> 609 <p>
462 Private slot to start the Pyramid Web server with logging. 610 Private slot to start the Pyramid Web server with logging.
463 </p><a NAME="Project.__runPythonShell" ID="Project.__runPythonShell"></a> 611 </p>
612 <a NAME="Project.__runPythonShell" ID="Project.__runPythonShell"></a>
464 <h4>Project.__runPythonShell</h4> 613 <h4>Project.__runPythonShell</h4>
465 <b>__runPythonShell</b>(<i></i>) 614 <b>__runPythonShell</b>(<i></i>)
615
466 <p> 616 <p>
467 Private slot to start a Python console for a Pyramid project. 617 Private slot to start a Python console for a Pyramid project.
468 </p><a NAME="Project.__runServer" ID="Project.__runServer"></a> 618 </p>
619 <a NAME="Project.__runServer" ID="Project.__runServer"></a>
469 <h4>Project.__runServer</h4> 620 <h4>Project.__runServer</h4>
470 <b>__runServer</b>(<i>logging=False</i>) 621 <b>__runServer</b>(<i>logging=False</i>)
622
471 <p> 623 <p>
472 Private slot to start the Pyramid Web server. 624 Private slot to start the Pyramid Web server.
473 </p><dl> 625 </p>
626 <dl>
627
474 <dt><i>logging</i></dt> 628 <dt><i>logging</i></dt>
475 <dd> 629 <dd>
476 flag indicating to enable logging (boolean) 630 flag indicating to enable logging (boolean)
477 </dd> 631 </dd>
478 </dl><a NAME="Project.__selectProject" ID="Project.__selectProject"></a> 632 </dl>
633 <a NAME="Project.__selectProject" ID="Project.__selectProject"></a>
479 <h4>Project.__selectProject</h4> 634 <h4>Project.__selectProject</h4>
480 <b>__selectProject</b>(<i></i>) 635 <b>__selectProject</b>(<i></i>)
636
481 <p> 637 <p>
482 Private method to select a Pyramid project to work with. 638 Private method to select a Pyramid project to work with.
483 </p><a NAME="Project.__serverProcFinished" ID="Project.__serverProcFinished"></a> 639 </p>
640 <a NAME="Project.__serverProcFinished" ID="Project.__serverProcFinished"></a>
484 <h4>Project.__serverProcFinished</h4> 641 <h4>Project.__serverProcFinished</h4>
485 <b>__serverProcFinished</b>(<i></i>) 642 <b>__serverProcFinished</b>(<i></i>)
643
486 <p> 644 <p>
487 Private slot connected to the finished signal. 645 Private slot connected to the finished signal.
488 </p><a NAME="Project.__setCurrentProject" ID="Project.__setCurrentProject"></a> 646 </p>
647 <a NAME="Project.__setCurrentProject" ID="Project.__setCurrentProject"></a>
489 <h4>Project.__setCurrentProject</h4> 648 <h4>Project.__setCurrentProject</h4>
490 <b>__setCurrentProject</b>(<i>project</i>) 649 <b>__setCurrentProject</b>(<i>project</i>)
650
491 <p> 651 <p>
492 Private slot to set the current project. 652 Private slot to set the current project.
493 </p><dl> 653 </p>
654 <dl>
655
494 <dt><i>project</i></dt> 656 <dt><i>project</i></dt>
495 <dd> 657 <dd>
496 name of the project (string) 658 name of the project (string)
497 </dd> 659 </dd>
498 </dl><a NAME="Project.__setupDevelop" ID="Project.__setupDevelop"></a> 660 </dl>
661 <a NAME="Project.__setupDevelop" ID="Project.__setupDevelop"></a>
499 <h4>Project.__setupDevelop</h4> 662 <h4>Project.__setupDevelop</h4>
500 <b>__setupDevelop</b>(<i></i>) 663 <b>__setupDevelop</b>(<i></i>)
664
501 <p> 665 <p>
502 Private slot to set up the development environment for the current 666 Private slot to set up the development environment for the current
503 project. 667 project.
504 </p><a NAME="Project.__showDocumentation" ID="Project.__showDocumentation"></a> 668 </p>
669 <a NAME="Project.__showDocumentation" ID="Project.__showDocumentation"></a>
505 <h4>Project.__showDocumentation</h4> 670 <h4>Project.__showDocumentation</h4>
506 <b>__showDocumentation</b>(<i></i>) 671 <b>__showDocumentation</b>(<i></i>)
672
507 <p> 673 <p>
508 Private slot to show the helpviewer with the Pyramid documentation. 674 Private slot to show the helpviewer with the Pyramid documentation.
509 </p><a NAME="Project.__showMatchingViews" ID="Project.__showMatchingViews"></a> 675 </p>
676 <a NAME="Project.__showMatchingViews" ID="Project.__showMatchingViews"></a>
510 <h4>Project.__showMatchingViews</h4> 677 <h4>Project.__showMatchingViews</h4>
511 <b>__showMatchingViews</b>(<i></i>) 678 <b>__showMatchingViews</b>(<i></i>)
679
512 <p> 680 <p>
513 Private slot showing all views that would match a given URL. 681 Private slot showing all views that would match a given URL.
514 </p><a NAME="Project.__showRoutes" ID="Project.__showRoutes"></a> 682 </p>
683 <a NAME="Project.__showRoutes" ID="Project.__showRoutes"></a>
515 <h4>Project.__showRoutes</h4> 684 <h4>Project.__showRoutes</h4>
516 <b>__showRoutes</b>(<i></i>) 685 <b>__showRoutes</b>(<i></i>)
686
517 <p> 687 <p>
518 Private slot showing all URL dispatch routes. 688 Private slot showing all URL dispatch routes.
519 </p><a NAME="Project.__showTweens" ID="Project.__showTweens"></a> 689 </p>
690 <a NAME="Project.__showTweens" ID="Project.__showTweens"></a>
520 <h4>Project.__showTweens</h4> 691 <h4>Project.__showTweens</h4>
521 <b>__showTweens</b>(<i></i>) 692 <b>__showTweens</b>(<i></i>)
693
522 <p> 694 <p>
523 Private slot showing all implicit and explicit tween objects. 695 Private slot showing all implicit and explicit tween objects.
524 </p><a NAME="Project.compileCatalogs" ID="Project.compileCatalogs"></a> 696 </p>
697 <a NAME="Project.compileCatalogs" ID="Project.compileCatalogs"></a>
525 <h4>Project.compileCatalogs</h4> 698 <h4>Project.compileCatalogs</h4>
526 <b>compileCatalogs</b>(<i>filenames</i>) 699 <b>compileCatalogs</b>(<i>filenames</i>)
700
527 <p> 701 <p>
528 Public method to compile the message catalogs. 702 Public method to compile the message catalogs.
529 </p><dl> 703 </p>
704 <dl>
705
530 <dt><i>filenames</i></dt> 706 <dt><i>filenames</i></dt>
531 <dd> 707 <dd>
532 list of filenames (not used) 708 list of filenames (not used)
533 </dd> 709 </dd>
534 </dl><a NAME="Project.compileSelectedCatalogs" ID="Project.compileSelectedCatalogs"></a> 710 </dl>
711 <a NAME="Project.compileSelectedCatalogs" ID="Project.compileSelectedCatalogs"></a>
535 <h4>Project.compileSelectedCatalogs</h4> 712 <h4>Project.compileSelectedCatalogs</h4>
536 <b>compileSelectedCatalogs</b>(<i>filenames</i>) 713 <b>compileSelectedCatalogs</b>(<i>filenames</i>)
714
537 <p> 715 <p>
538 Public method to update the message catalogs. 716 Public method to update the message catalogs.
539 </p><dl> 717 </p>
718 <dl>
719
540 <dt><i>filenames</i></dt> 720 <dt><i>filenames</i></dt>
541 <dd> 721 <dd>
542 list of file names (list of string) 722 list of file names (list of string)
543 </dd> 723 </dd>
544 </dl><a NAME="Project.extractMessages" ID="Project.extractMessages"></a> 724 </dl>
725 <a NAME="Project.extractMessages" ID="Project.extractMessages"></a>
545 <h4>Project.extractMessages</h4> 726 <h4>Project.extractMessages</h4>
546 <b>extractMessages</b>(<i></i>) 727 <b>extractMessages</b>(<i></i>)
728
547 <p> 729 <p>
548 Public method to extract the messages catalog template file. 730 Public method to extract the messages catalog template file.
549 </p><a NAME="Project.getMenu" ID="Project.getMenu"></a> 731 </p>
732 <a NAME="Project.getMenu" ID="Project.getMenu"></a>
550 <h4>Project.getMenu</h4> 733 <h4>Project.getMenu</h4>
551 <b>getMenu</b>(<i>name</i>) 734 <b>getMenu</b>(<i>name</i>)
735
552 <p> 736 <p>
553 Public method to get a reference to the requested menu. 737 Public method to get a reference to the requested menu.
554 </p><dl> 738 </p>
739 <dl>
740
555 <dt><i>name</i></dt> 741 <dt><i>name</i></dt>
556 <dd> 742 <dd>
557 name of the menu (string) 743 name of the menu (string)
558 </dd> 744 </dd>
559 </dl><dl> 745 </dl>
746 <dl>
560 <dt>Returns:</dt> 747 <dt>Returns:</dt>
561 <dd> 748 <dd>
562 reference to the menu (QMenu) or None, if no 749 reference to the menu (QMenu) or None, if no
563 menu with the given name exists 750 menu with the given name exists
564 </dd> 751 </dd>
565 </dl><a NAME="Project.getMenuNames" ID="Project.getMenuNames"></a> 752 </dl>
753 <a NAME="Project.getMenuNames" ID="Project.getMenuNames"></a>
566 <h4>Project.getMenuNames</h4> 754 <h4>Project.getMenuNames</h4>
567 <b>getMenuNames</b>(<i></i>) 755 <b>getMenuNames</b>(<i></i>)
756
568 <p> 757 <p>
569 Public method to get the names of all menus. 758 Public method to get the names of all menus.
570 </p><dl> 759 </p>
760 <dl>
571 <dt>Returns:</dt> 761 <dt>Returns:</dt>
572 <dd> 762 <dd>
573 menu names (list of string) 763 menu names (list of string)
574 </dd> 764 </dd>
575 </dl><a NAME="Project.getPyramidCommand" ID="Project.getPyramidCommand"></a> 765 </dl>
766 <a NAME="Project.getPyramidCommand" ID="Project.getPyramidCommand"></a>
576 <h4>Project.getPyramidCommand</h4> 767 <h4>Project.getPyramidCommand</h4>
577 <b>getPyramidCommand</b>(<i>cmd, language=""</i>) 768 <b>getPyramidCommand</b>(<i>cmd, language=""</i>)
769
578 <p> 770 <p>
579 Public method to build a Pyramid command. 771 Public method to build a Pyramid command.
580 </p><dl> 772 </p>
773 <dl>
774
581 <dt><i>cmd</i></dt> 775 <dt><i>cmd</i></dt>
582 <dd> 776 <dd>
583 command (string) 777 command (string)
584 </dd><dt><i>language</i></dt> 778 </dd>
779 <dt><i>language</i></dt>
585 <dd> 780 <dd>
586 Python variant to get the virtual environment 781 Python variant to get the virtual environment
587 for (string, one of '', 'Python2' or 'Python3') 782 for (string, one of '', 'Python2' or 'Python3')
588 </dd> 783 </dd>
589 </dl><dl> 784 </dl>
785 <dl>
590 <dt>Returns:</dt> 786 <dt>Returns:</dt>
591 <dd> 787 <dd>
592 full pyramid command (string) 788 full pyramid command (string)
593 </dd> 789 </dd>
594 </dl><a NAME="Project.getPyramidVersion" ID="Project.getPyramidVersion"></a> 790 </dl>
791 <a NAME="Project.getPyramidVersion" ID="Project.getPyramidVersion"></a>
595 <h4>Project.getPyramidVersion</h4> 792 <h4>Project.getPyramidVersion</h4>
596 <b>getPyramidVersion</b>(<i></i>) 793 <b>getPyramidVersion</b>(<i></i>)
794
597 <p> 795 <p>
598 Public method to get the Pyramid version as a tuple. 796 Public method to get the Pyramid version as a tuple.
599 </p><dl> 797 </p>
798 <dl>
600 <dt>Returns:</dt> 799 <dt>Returns:</dt>
601 <dd> 800 <dd>
602 Pyramid version 801 Pyramid version
603 </dd> 802 </dd>
604 </dl><dl> 803 </dl>
804 <dl>
605 <dt>Return Type:</dt> 805 <dt>Return Type:</dt>
606 <dd> 806 <dd>
607 tuple of int 807 tuple of int
608 </dd> 808 </dd>
609 </dl><a NAME="Project.getPyramidVersionString" ID="Project.getPyramidVersionString"></a> 809 </dl>
810 <a NAME="Project.getPyramidVersionString" ID="Project.getPyramidVersionString"></a>
610 <h4>Project.getPyramidVersionString</h4> 811 <h4>Project.getPyramidVersionString</h4>
611 <b>getPyramidVersionString</b>(<i></i>) 812 <b>getPyramidVersionString</b>(<i></i>)
813
612 <p> 814 <p>
613 Public method to get the Pyramid version as a string. 815 Public method to get the Pyramid version as a string.
614 </p><dl> 816 </p>
817 <dl>
615 <dt>Returns:</dt> 818 <dt>Returns:</dt>
616 <dd> 819 <dd>
617 Pyramid version 820 Pyramid version
618 </dd> 821 </dd>
619 </dl><dl> 822 </dl>
823 <dl>
620 <dt>Return Type:</dt> 824 <dt>Return Type:</dt>
621 <dd> 825 <dd>
622 str 826 str
623 </dd> 827 </dd>
624 </dl><a NAME="Project.getPythonCommand" ID="Project.getPythonCommand"></a> 828 </dl>
829 <a NAME="Project.getPythonCommand" ID="Project.getPythonCommand"></a>
625 <h4>Project.getPythonCommand</h4> 830 <h4>Project.getPythonCommand</h4>
626 <b>getPythonCommand</b>(<i></i>) 831 <b>getPythonCommand</b>(<i></i>)
832
627 <p> 833 <p>
628 Public method to build the Python command. 834 Public method to build the Python command.
629 </p><dl> 835 </p>
836 <dl>
630 <dt>Returns:</dt> 837 <dt>Returns:</dt>
631 <dd> 838 <dd>
632 python command (string) 839 python command (string)
633 </dd> 840 </dd>
634 </dl><a NAME="Project.initActions" ID="Project.initActions"></a> 841 </dl>
842 <a NAME="Project.initActions" ID="Project.initActions"></a>
635 <h4>Project.initActions</h4> 843 <h4>Project.initActions</h4>
636 <b>initActions</b>(<i></i>) 844 <b>initActions</b>(<i></i>)
845
637 <p> 846 <p>
638 Public method to define the Pyramid actions. 847 Public method to define the Pyramid actions.
639 </p><a NAME="Project.initMenu" ID="Project.initMenu"></a> 848 </p>
849 <a NAME="Project.initMenu" ID="Project.initMenu"></a>
640 <h4>Project.initMenu</h4> 850 <h4>Project.initMenu</h4>
641 <b>initMenu</b>(<i></i>) 851 <b>initMenu</b>(<i></i>)
852
642 <p> 853 <p>
643 Public slot to initialize the Pyramid menu. 854 Public slot to initialize the Pyramid menu.
644 </p><dl> 855 </p>
856 <dl>
645 <dt>Returns:</dt> 857 <dt>Returns:</dt>
646 <dd> 858 <dd>
647 the menu generated (QMenu) 859 the menu generated (QMenu)
648 </dd> 860 </dd>
649 </dl><a NAME="Project.isSpawningConsole" ID="Project.isSpawningConsole"></a> 861 </dl>
862 <a NAME="Project.isSpawningConsole" ID="Project.isSpawningConsole"></a>
650 <h4>Project.isSpawningConsole</h4> 863 <h4>Project.isSpawningConsole</h4>
651 <b>isSpawningConsole</b>(<i>consoleCmd</i>) 864 <b>isSpawningConsole</b>(<i>consoleCmd</i>)
865
652 <p> 866 <p>
653 Public method to check, if the given console is a spawning console. 867 Public method to check, if the given console is a spawning console.
654 </p><dl> 868 </p>
869 <dl>
870
655 <dt><i>consoleCmd</i></dt> 871 <dt><i>consoleCmd</i></dt>
656 <dd> 872 <dd>
657 console command (string) 873 console command (string)
658 </dd> 874 </dd>
659 </dl><dl> 875 </dl>
876 <dl>
660 <dt>Returns:</dt> 877 <dt>Returns:</dt>
661 <dd> 878 <dd>
662 tuple of two entries giving an indication, if the console 879 tuple of two entries giving an indication, if the console
663 is spawning (boolean) and the (possibly) cleaned console command 880 is spawning (boolean) and the (possibly) cleaned console command
664 (string) 881 (string)
665 </dd> 882 </dd>
666 </dl><a NAME="Project.newForm" ID="Project.newForm"></a> 883 </dl>
884 <a NAME="Project.newForm" ID="Project.newForm"></a>
667 <h4>Project.newForm</h4> 885 <h4>Project.newForm</h4>
668 <b>newForm</b>(<i>path</i>) 886 <b>newForm</b>(<i>path</i>)
887
669 <p> 888 <p>
670 Public method to create a new form. 889 Public method to create a new form.
671 </p><dl> 890 </p>
891 <dl>
892
672 <dt><i>path</i></dt> 893 <dt><i>path</i></dt>
673 <dd> 894 <dd>
674 full directory path for the new form file (string) 895 full directory path for the new form file (string)
675 </dd> 896 </dd>
676 </dl><a NAME="Project.openPOEditor" ID="Project.openPOEditor"></a> 897 </dl>
898 <a NAME="Project.openPOEditor" ID="Project.openPOEditor"></a>
677 <h4>Project.openPOEditor</h4> 899 <h4>Project.openPOEditor</h4>
678 <b>openPOEditor</b>(<i>poFile</i>) 900 <b>openPOEditor</b>(<i>poFile</i>)
901
679 <p> 902 <p>
680 Public method to edit the given file in an external .po editor. 903 Public method to edit the given file in an external .po editor.
681 </p><dl> 904 </p>
905 <dl>
906
682 <dt><i>poFile</i></dt> 907 <dt><i>poFile</i></dt>
683 <dd> 908 <dd>
684 name of the .po file (string) 909 name of the .po file (string)
685 </dd> 910 </dd>
686 </dl><a NAME="Project.projectClosed" ID="Project.projectClosed"></a> 911 </dl>
912 <a NAME="Project.projectClosed" ID="Project.projectClosed"></a>
687 <h4>Project.projectClosed</h4> 913 <h4>Project.projectClosed</h4>
688 <b>projectClosed</b>(<i></i>) 914 <b>projectClosed</b>(<i></i>)
915
689 <p> 916 <p>
690 Public method to handle the closing of a project. 917 Public method to handle the closing of a project.
691 </p><a NAME="Project.projectClosedHooks" ID="Project.projectClosedHooks"></a> 918 </p>
919 <a NAME="Project.projectClosedHooks" ID="Project.projectClosedHooks"></a>
692 <h4>Project.projectClosedHooks</h4> 920 <h4>Project.projectClosedHooks</h4>
693 <b>projectClosedHooks</b>(<i></i>) 921 <b>projectClosedHooks</b>(<i></i>)
922
694 <p> 923 <p>
695 Public method to remove our hook methods. 924 Public method to remove our hook methods.
696 </p><a NAME="Project.projectOpenedHooks" ID="Project.projectOpenedHooks"></a> 925 </p>
926 <a NAME="Project.projectOpenedHooks" ID="Project.projectOpenedHooks"></a>
697 <h4>Project.projectOpenedHooks</h4> 927 <h4>Project.projectOpenedHooks</h4>
698 <b>projectOpenedHooks</b>(<i></i>) 928 <b>projectOpenedHooks</b>(<i></i>)
929
699 <p> 930 <p>
700 Public method to add our hook methods. 931 Public method to add our hook methods.
701 </p><a NAME="Project.registerOpenHook" ID="Project.registerOpenHook"></a> 932 </p>
933 <a NAME="Project.registerOpenHook" ID="Project.registerOpenHook"></a>
702 <h4>Project.registerOpenHook</h4> 934 <h4>Project.registerOpenHook</h4>
703 <b>registerOpenHook</b>(<i></i>) 935 <b>registerOpenHook</b>(<i></i>)
936
704 <p> 937 <p>
705 Public method to register the open hook to open a translations file 938 Public method to register the open hook to open a translations file
706 in a translations editor. 939 in a translations editor.
707 </p><a NAME="Project.supportedPythonVariants" ID="Project.supportedPythonVariants"></a> 940 </p>
941 <a NAME="Project.supportedPythonVariants" ID="Project.supportedPythonVariants"></a>
708 <h4>Project.supportedPythonVariants</h4> 942 <h4>Project.supportedPythonVariants</h4>
709 <b>supportedPythonVariants</b>(<i></i>) 943 <b>supportedPythonVariants</b>(<i></i>)
944
710 <p> 945 <p>
711 Public method to get the supported Python variants. 946 Public method to get the supported Python variants.
712 </p><dl> 947 </p>
948 <dl>
713 <dt>Returns:</dt> 949 <dt>Returns:</dt>
714 <dd> 950 <dd>
715 list of supported Python variants (list of strings) 951 list of supported Python variants (list of strings)
716 </dd> 952 </dd>
717 </dl><a NAME="Project.updateCatalogs" ID="Project.updateCatalogs"></a> 953 </dl>
954 <a NAME="Project.updateCatalogs" ID="Project.updateCatalogs"></a>
718 <h4>Project.updateCatalogs</h4> 955 <h4>Project.updateCatalogs</h4>
719 <b>updateCatalogs</b>(<i>filenames</i>) 956 <b>updateCatalogs</b>(<i>filenames</i>)
957
720 <p> 958 <p>
721 Public method to update the message catalogs. 959 Public method to update the message catalogs.
722 </p><dl> 960 </p>
961 <dl>
962
723 <dt><i>filenames</i></dt> 963 <dt><i>filenames</i></dt>
724 <dd> 964 <dd>
725 list of filenames (not used) 965 list of filenames (not used)
726 </dd> 966 </dd>
727 </dl><a NAME="Project.updateSelectedCatalogs" ID="Project.updateSelectedCatalogs"></a> 967 </dl>
968 <a NAME="Project.updateSelectedCatalogs" ID="Project.updateSelectedCatalogs"></a>
728 <h4>Project.updateSelectedCatalogs</h4> 969 <h4>Project.updateSelectedCatalogs</h4>
729 <b>updateSelectedCatalogs</b>(<i>filenames</i>) 970 <b>updateSelectedCatalogs</b>(<i>filenames</i>)
971
730 <p> 972 <p>
731 Public method to update the message catalogs. 973 Public method to update the message catalogs.
732 </p><dl> 974 </p>
975 <dl>
976
733 <dt><i>filenames</i></dt> 977 <dt><i>filenames</i></dt>
734 <dd> 978 <dd>
735 list of filenames 979 list of filenames
736 </dd> 980 </dd>
737 </dl> 981 </dl>
738 <div align="right"><a href="#top">Up</a></div> 982 <div align="right"><a href="#top">Up</a></div>
739 <hr /><hr /> 983 <hr />
984 <hr />
740 <a NAME="PyramidNoProjectSelectedException" ID="PyramidNoProjectSelectedException"></a> 985 <a NAME="PyramidNoProjectSelectedException" ID="PyramidNoProjectSelectedException"></a>
741 <h2>PyramidNoProjectSelectedException</h2> 986 <h2>PyramidNoProjectSelectedException</h2>
987
742 <p> 988 <p>
743 Exception thrown to signal, that there is no current Pyramid project. 989 Exception thrown to signal, that there is no current Pyramid project.
744 </p> 990 </p>
745 <h3>Derived from</h3> 991 <h3>Derived from</h3>
746 Exception 992 Exception
747 <h3>Class Attributes</h3> 993 <h3>Class Attributes</h3>
994
748 <table> 995 <table>
749 <tr><td>None</td></tr> 996 <tr><td>None</td></tr>
750 </table> 997 </table>
751 <h3>Class Methods</h3> 998 <h3>Class Methods</h3>
999
752 <table> 1000 <table>
753 <tr><td>None</td></tr> 1001 <tr><td>None</td></tr>
754 </table> 1002 </table>
755 <h3>Methods</h3> 1003 <h3>Methods</h3>
1004
756 <table> 1005 <table>
757 <tr><td>None</td></tr> 1006 <tr><td>None</td></tr>
758 </table> 1007 </table>
759 <h3>Static Methods</h3> 1008 <h3>Static Methods</h3>
1009
760 <table> 1010 <table>
761 <tr><td>None</td></tr> 1011 <tr><td>None</td></tr>
762 </table> 1012 </table>
763 1013
764 <div align="right"><a href="#top">Up</a></div> 1014 <div align="right"><a href="#top">Up</a></div>
765 <hr /><hr /> 1015 <hr />
1016 <hr />
766 <a NAME="QProcess" ID="QProcess"></a> 1017 <a NAME="QProcess" ID="QProcess"></a>
767 <h2>QProcess</h2> 1018 <h2>QProcess</h2>
1019
768 <p> 1020 <p>
769 Class transforming the call arguments in case of gnome-terminal. 1021 Class transforming the call arguments in case of gnome-terminal.
770 </p> 1022 </p>
771 <h3>Derived from</h3> 1023 <h3>Derived from</h3>
772 QProcessPyQt 1024 QProcessPyQt
773 <h3>Class Attributes</h3> 1025 <h3>Class Attributes</h3>
1026
774 <table> 1027 <table>
775 <tr><td>None</td></tr> 1028 <tr><td>None</td></tr>
776 </table> 1029 </table>
777 <h3>Class Methods</h3> 1030 <h3>Class Methods</h3>
1031
778 <table> 1032 <table>
779 <tr><td>None</td></tr> 1033 <tr><td>None</td></tr>
780 </table> 1034 </table>
781 <h3>Methods</h3> 1035 <h3>Methods</h3>
782 <table> 1036
1037 <table>
1038
783 <tr> 1039 <tr>
784 <td><a href="#QProcess.start">start</a></td> 1040 <td><a href="#QProcess.start">start</a></td>
785 <td>Public method to start the given program (cmd) in a new process, if none is already running, passing the command line arguments in args.</td> 1041 <td>Public method to start the given program (cmd) in a new process, if none is already running, passing the command line arguments in args.</td>
786 </tr> 1042 </tr>
787 </table> 1043 </table>
788 <h3>Static Methods</h3> 1044 <h3>Static Methods</h3>
789 <table> 1045
1046 <table>
1047
790 <tr> 1048 <tr>
791 <td><a href="#QProcess.startDetached">startDetached</a></td> 1049 <td><a href="#QProcess.startDetached">startDetached</a></td>
792 <td>Public static method to start the given program (cmd) in a new process, if none is already running, passing the command line arguments in args.</td> 1050 <td>Public static method to start the given program (cmd) in a new process, if none is already running, passing the command line arguments in args.</td>
793 </tr> 1051 </tr>
794 </table> 1052 </table>
1053
795 <a NAME="QProcess.start" ID="QProcess.start"></a> 1054 <a NAME="QProcess.start" ID="QProcess.start"></a>
796 <h4>QProcess.start</h4> 1055 <h4>QProcess.start</h4>
797 <b>start</b>(<i>cmd, args=None, mode=QProcessPyQt.ReadWrite</i>) 1056 <b>start</b>(<i>cmd, args=None, mode=QProcessPyQt.ReadWrite</i>)
1057
798 <p> 1058 <p>
799 Public method to start the given program (cmd) in a new process, if 1059 Public method to start the given program (cmd) in a new process, if
800 none is already running, passing the command line arguments in args. 1060 none is already running, passing the command line arguments in args.
801 </p><dl> 1061 </p>
1062 <dl>
1063
802 <dt><i>cmd</i></dt> 1064 <dt><i>cmd</i></dt>
803 <dd> 1065 <dd>
804 start the given program cmd (string) 1066 start the given program cmd (string)
805 </dd><dt><i>args=</i></dt> 1067 </dd>
1068 <dt><i>args=</i></dt>
806 <dd> 1069 <dd>
807 list of parameters (list of strings) 1070 list of parameters (list of strings)
808 </dd><dt><i>mode=</i></dt> 1071 </dd>
1072 <dt><i>mode=</i></dt>
809 <dd> 1073 <dd>
810 access mode (QIODevice.OpenMode) 1074 access mode (QIODevice.OpenMode)
811 </dd> 1075 </dd>
812 </dl><a NAME="QProcess.startDetached" ID="QProcess.startDetached"></a> 1076 </dl>
1077 <a NAME="QProcess.startDetached" ID="QProcess.startDetached"></a>
813 <h4>QProcess.startDetached (static)</h4> 1078 <h4>QProcess.startDetached (static)</h4>
814 <b>startDetached</b>(<i>args=None, path=''</i>) 1079 <b>startDetached</b>(<i>args=None, path=''</i>)
1080
815 <p> 1081 <p>
816 Public static method to start the given program (cmd) in a new process, 1082 Public static method to start the given program (cmd) in a new process,
817 if none is already running, passing the command line arguments in args. 1083 if none is already running, passing the command line arguments in args.
818 </p><dl> 1084 </p>
1085 <dl>
1086
819 <dt><i>cmd</i></dt> 1087 <dt><i>cmd</i></dt>
820 <dd> 1088 <dd>
821 start the given program cmd (string) 1089 start the given program cmd (string)
822 </dd><dt><i>args=</i></dt> 1090 </dd>
1091 <dt><i>args=</i></dt>
823 <dd> 1092 <dd>
824 list of parameters (list of strings) 1093 list of parameters (list of strings)
825 </dd><dt><i>path=</i></dt> 1094 </dd>
1095 <dt><i>path=</i></dt>
826 <dd> 1096 <dd>
827 new working directory (string) 1097 new working directory (string)
828 </dd> 1098 </dd>
829 </dl><dl> 1099 </dl>
1100 <dl>
830 <dt>Returns:</dt> 1101 <dt>Returns:</dt>
831 <dd> 1102 <dd>
832 tuple of successful start and process id (boolean, integer) 1103 tuple of successful start and process id (boolean, integer)
833 </dd> 1104 </dd>
834 </dl> 1105 </dl>

Mercurial Repository: Pyramid Project

eric ide

mercurial