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

Fri, 11 Jul 2014 19:01:33 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 11 Jul 2014 19:01:33 +0200
changeset 74
11587ae1122f
parent 64
3b2da211e126
child 95
2b0933087db9
permissions
-rw-r--r--

Ported to PyQt5 and eric6.

37
1b089e0fba1e Modified the code to do lazy import.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 25
diff changeset
1 <!DOCTYPE html>
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>Plugin_Project_Pyramid.ProjectPyramid.Project</title>
37
1b089e0fba1e Modified the code to do lazy import.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 25
diff changeset
4 <meta charset="UTF-8">
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <body><a NAME="top" ID="top"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <h1>Plugin_Project_Pyramid.ProjectPyramid.Project</h1>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 Module implementing the Pyramid project support.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 </p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 <h3>Global Attributes</h3>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <tr><td>None</td></tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 </table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <h3>Classes</h3>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <td><a href="#Project">Project</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <td>Class implementing the Pyramid project support.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 <td><a href="#PyramidNoProjectSelectedException">PyramidNoProjectSelectedException</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <td>Exception thrown to signal, that there is no current Pyramid project.</td>
56
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
38 </tr><tr>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
39 <td><a href="#QProcess">QProcess</a></td>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
40 <td>Class transforming the call arguments in case of gnome-terminal.</td>
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 </tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 </table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <h3>Functions</h3>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <tr><td>None</td></tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 </table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <hr /><hr />
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <a NAME="Project" ID="Project"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <h2>Project</h2>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 Class implementing the Pyramid project support.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 </p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 <h3>Derived from</h3>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 QObject
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <h3>Class Attributes</h3>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 <table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <tr><td>None</td></tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 </table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <h3>Class Methods</h3>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 <tr><td>None</td></tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 </table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <h3>Methods</h3>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 <tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 <td><a href="#Project.__init__">Project</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 <td>Constructor</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 <td><a href="#Project.__buildDistribution">__buildDistribution</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <td>Private slot to build a distribution file for the current Pyramid project.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <td><a href="#Project.__createProject">__createProject</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 <td>Private slot to create a new Pyramid project.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 <td><a href="#Project.__findProjects">__findProjects</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <td>Private method to determine the relative path of all Pyramid projects (= top level dirs).</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 </tr><tr>
56
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
78 <td><a href="#Project.__getDebugEnvironment">__getDebugEnvironment</a></td>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
79 <td>Private method to get the path of the debugger environment.</td>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
80 </tr><tr>
44
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
81 <td><a href="#Project.__getExecutablePaths">__getExecutablePaths</a></td>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
82 <td>Private method to build all full path of an executable file from the environment.</td>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
83 </tr><tr>
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <td><a href="#Project.__getInitDbCommand">__getInitDbCommand</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 <td>Private method to create the path to the initialization script.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <td><a href="#Project.__getLocale">__getLocale</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 <td>Private method to extract the locale out of a file name.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 <td><a href="#Project.__getVirtualEnvironment">__getVirtualEnvironment</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 <td>Private method to get the path of the virtual environment.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 <td><a href="#Project.__initializeDatabase">__initializeDatabase</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 <td>Private slot to initialize the database of the Pyramid project.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <td><a href="#Project.__normalizeList">__normalizeList</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 <td>Private method to normalize a list of file names.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 <td><a href="#Project.__project">__project</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 <td>Private method to get the name of the current Pyramid project.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 <td><a href="#Project.__projectFilteredList">__projectFilteredList</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 <td>Private method to filter a list of file names by Pyramid project.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 <td><a href="#Project.__projectLanguageAdded">__projectLanguageAdded</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 <td>Private slot handling the addition of a new language.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 <td><a href="#Project.__projectPath">__projectPath</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 <td>Private method to calculate the full path of the Pyramid project.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 <td><a href="#Project.__pyramidInfo">__pyramidInfo</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 <td>Private slot to show some info about Pyramid.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 <td><a href="#Project.__runBrowser">__runBrowser</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 <td>Private slot to start the default web browser with the server URL.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
117 <td><a href="#Project.__runLoggingServer">__runLoggingServer</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
118 <td>Private slot to start the Pyramid Web server with logging.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
120 <td><a href="#Project.__runPythonShell">__runPythonShell</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
121 <td>Private slot to start a Python console for a Pyramid project.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
122 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
123 <td><a href="#Project.__runServer">__runServer</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
124 <td>Private slot to start the Pyramid Web server.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
125 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
126 <td><a href="#Project.__selectProject">__selectProject</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
127 <td>Private method to select a Pyramid project to work with.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
128 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
129 <td><a href="#Project.__serverProcFinished">__serverProcFinished</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
130 <td>Private slot connected to the finished signal.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
131 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
132 <td><a href="#Project.__setCurrentProject">__setCurrentProject</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
133 <td>Private slot to set the current project.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
134 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
135 <td><a href="#Project.__setupDevelop">__setupDevelop</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
136 <td>Private slot to set up the development environment for the current project.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
137 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
138 <td><a href="#Project.__showDocumentation">__showDocumentation</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
139 <td>Private slot to show the helpviewer with the Pyramid documentation.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
140 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
141 <td><a href="#Project.__showMatchingViews">__showMatchingViews</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
142 <td>Private slot showing all views that would match a given URL.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
143 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
144 <td><a href="#Project.__showRoutes">__showRoutes</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
145 <td>Private slot showing all URL dispatch routes.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
146 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
147 <td><a href="#Project.__showTweens">__showTweens</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
148 <td>Private slot showing all implicit and explicit tween objects.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
149 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
150 <td><a href="#Project.compileCatalogs">compileCatalogs</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
151 <td>Public method to compile the message catalogs.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
152 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
153 <td><a href="#Project.compileSelectedCatalogs">compileSelectedCatalogs</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
154 <td>Public method to update the message catalogs.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
155 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
156 <td><a href="#Project.extractMessages">extractMessages</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
157 <td>Public method to extract the messages catalog template file.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
158 </tr><tr>
64
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
159 <td><a href="#Project.getMenu">getMenu</a></td>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
160 <td>Public method to get a reference to the requested menu.</td>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
161 </tr><tr>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
162 <td><a href="#Project.getMenuNames">getMenuNames</a></td>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
163 <td>Public method to get the names of all menus.</td>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
164 </tr><tr>
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
165 <td><a href="#Project.getPyramidCommand">getPyramidCommand</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
166 <td>Public method to build a Pyramid command.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
167 </tr><tr>
44
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
168 <td><a href="#Project.getPyramidVersion">getPyramidVersion</a></td>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
169 <td>Public method to get the Pyramid version.</td>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
170 </tr><tr>
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
171 <td><a href="#Project.getPythonCommand">getPythonCommand</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
172 <td>Public method to build the Python command.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
173 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
174 <td><a href="#Project.initActions">initActions</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
175 <td>Public method to define the Pyramid actions.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
176 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
177 <td><a href="#Project.initMenu">initMenu</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
178 <td>Public slot to initialize the Pyramid menu.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
179 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
180 <td><a href="#Project.isSpawningConsole">isSpawningConsole</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
181 <td>Public method to check, if the given console is a spawning console.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
182 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
183 <td><a href="#Project.newForm">newForm</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
184 <td>Public method to create a new form.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
185 </tr><tr>
48
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
186 <td><a href="#Project.openPOEditor">openPOEditor</a></td>
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
187 <td>Public method to edit the given file in an external .po editor.</td>
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
188 </tr><tr>
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
189 <td><a href="#Project.projectClosed">projectClosed</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
190 <td>Public method to handle the closing of a project.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
191 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
192 <td><a href="#Project.projectClosedHooks">projectClosedHooks</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
193 <td>Public method to remove our hook methods.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
194 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
195 <td><a href="#Project.projectOpenedHooks">projectOpenedHooks</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
196 <td>Public method to add our hook methods.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
197 </tr><tr>
48
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
198 <td><a href="#Project.registerOpenHook">registerOpenHook</a></td>
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
199 <td>Public method to register the open hook to open a translations file in a translations editor.</td>
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
200 </tr><tr>
44
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
201 <td><a href="#Project.supportedPythonVariants">supportedPythonVariants</a></td>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
202 <td>Public method to get the supported Python variants.</td>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
203 </tr><tr>
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
204 <td><a href="#Project.updateCatalogs">updateCatalogs</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
205 <td>Public method to update the message catalogs.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
206 </tr><tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
207 <td><a href="#Project.updateSelectedCatalogs">updateSelectedCatalogs</a></td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
208 <td>Public method to update the message catalogs.</td>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
209 </tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
210 </table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
211 <h3>Static Methods</h3>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
212 <table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
213 <tr><td>None</td></tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
214 </table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
215 <a NAME="Project.__init__" ID="Project.__init__"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
216 <h4>Project (Constructor)</h4>
25
2dd3d1cf573a Fixed a bug related to uninstalling the plug-in via the external plug-in uninstaller.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 15
diff changeset
217 <b>Project</b>(<i>plugin, parent=None</i>)
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
218 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
219 Constructor
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
220 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
221 <dt><i>plugin</i></dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
222 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
223 reference to the plugin object
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
224 </dd><dt><i>parent</i></dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
225 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
226 parent (QObject)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
227 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
228 </dl><a NAME="Project.__buildDistribution" ID="Project.__buildDistribution"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
229 <h4>Project.__buildDistribution</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
230 <b>__buildDistribution</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
231 <p>
54
71c83a661c83 Fixed code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 48
diff changeset
232 Private slot to build a distribution file for the current Pyramid
71c83a661c83 Fixed code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 48
diff changeset
233 project.
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
234 </p><a NAME="Project.__createProject" ID="Project.__createProject"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
235 <h4>Project.__createProject</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
236 <b>__createProject</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
237 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
238 Private slot to create a new Pyramid project.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
239 </p><a NAME="Project.__findProjects" ID="Project.__findProjects"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
240 <h4>Project.__findProjects</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
241 <b>__findProjects</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
242 <p>
25
2dd3d1cf573a Fixed a bug related to uninstalling the plug-in via the external plug-in uninstaller.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 15
diff changeset
243 Private method to determine the relative path of all Pyramid
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
244 projects (= top level dirs).
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
245 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
246 <dt>Returns:</dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
247 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
248 list of projects (list of string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
249 </dd>
56
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
250 </dl><a NAME="Project.__getDebugEnvironment" ID="Project.__getDebugEnvironment"></a>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
251 <h4>Project.__getDebugEnvironment</h4>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
252 <b>__getDebugEnvironment</b>(<i>language=""</i>)
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
253 <p>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
254 Private method to get the path of the debugger environment.
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
255 </p><dl>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
256 <dt><i>language</i></dt>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
257 <dd>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
258 Python variant to get the debugger environment
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
259 for (string, one of '', 'Python2' or 'Python3')
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
260 </dd>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
261 </dl><dl>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
262 <dt>Returns:</dt>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
263 <dd>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
264 path of the debugger environment (string)
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
265 </dd>
44
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
266 </dl><a NAME="Project.__getExecutablePaths" ID="Project.__getExecutablePaths"></a>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
267 <h4>Project.__getExecutablePaths</h4>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
268 <b>__getExecutablePaths</b>(<i>file</i>)
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
269 <p>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
270 Private method to build all full path of an executable file from
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
271 the environment.
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
272 </p><dl>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
273 <dt><i>file</i></dt>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
274 <dd>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
275 filename of the executable (string)
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
276 </dd>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
277 </dl><dl>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
278 <dt>Returns:</dt>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
279 <dd>
54
71c83a661c83 Fixed code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 48
diff changeset
280 list of full executable names, if the executable file is
71c83a661c83 Fixed code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 48
diff changeset
281 accessible via the searchpath defined by the PATH environment
71c83a661c83 Fixed code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 48
diff changeset
282 variable, or an empty list otherwise.
44
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
283 </dd>
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
284 </dl><a NAME="Project.__getInitDbCommand" ID="Project.__getInitDbCommand"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
285 <h4>Project.__getInitDbCommand</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
286 <b>__getInitDbCommand</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
287 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
288 Private method to create the path to the initialization script.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
289 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
290 <dt>Returns:</dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
291 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
292 path to the initialization script (string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
293 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
294 </dl><a NAME="Project.__getLocale" ID="Project.__getLocale"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
295 <h4>Project.__getLocale</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
296 <b>__getLocale</b>(<i>filename</i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
297 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
298 Private method to extract the locale out of a file name.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
299 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
300 <dt><i>filename</i></dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
301 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
302 name of the file used for extraction (string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
303 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
304 </dl><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
305 <dt>Returns:</dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
306 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
307 extracted locale (string) or None
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
308 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
309 </dl><a NAME="Project.__getVirtualEnvironment" ID="Project.__getVirtualEnvironment"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
310 <h4>Project.__getVirtualEnvironment</h4>
44
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
311 <b>__getVirtualEnvironment</b>(<i>language=""</i>)
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
312 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
313 Private method to get the path of the virtual environment.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
314 </p><dl>
44
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
315 <dt><i>language</i></dt>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
316 <dd>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
317 Python variant to get the virtual environment
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
318 for (string, one of '', 'Python2' or 'Python3')
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
319 </dd>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
320 </dl><dl>
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
321 <dt>Returns:</dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
322 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
323 path of the virtual environment (string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
324 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
325 </dl><a NAME="Project.__initializeDatabase" ID="Project.__initializeDatabase"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
326 <h4>Project.__initializeDatabase</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
327 <b>__initializeDatabase</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
328 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
329 Private slot to initialize the database of the Pyramid project.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
330 </p><a NAME="Project.__normalizeList" ID="Project.__normalizeList"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
331 <h4>Project.__normalizeList</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
332 <b>__normalizeList</b>(<i>filenames</i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
333 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
334 Private method to normalize a list of file names.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
335 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
336 <dt><i>filenames</i></dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
337 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
338 list of file names to normalize (list of string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
339 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
340 </dl><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
341 <dt>Returns:</dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
342 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
343 normalized file names (list of string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
344 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
345 </dl><a NAME="Project.__project" ID="Project.__project"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
346 <h4>Project.__project</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
347 <b>__project</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
348 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
349 Private method to get the name of the current Pyramid project.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
350 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
351 <dt>Returns:</dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
352 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
353 name of the project (string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
354 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
355 </dl><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
356 <dt>Raises <b>PyramidNoProjectSelectedException</b>:</dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
357 <dd>
54
71c83a661c83 Fixed code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 48
diff changeset
358 raised, if no project is
71c83a661c83 Fixed code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 48
diff changeset
359 selected
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
360 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
361 </dl><a NAME="Project.__projectFilteredList" ID="Project.__projectFilteredList"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
362 <h4>Project.__projectFilteredList</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
363 <b>__projectFilteredList</b>(<i>filenames</i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
364 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
365 Private method to filter a list of file names by Pyramid project.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
366 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
367 <dt><i>filenames</i></dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
368 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
369 list of file names to be filtered (list of string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
370 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
371 </dl><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
372 <dt>Returns:</dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
373 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
374 file names belonging to the current site (list of string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
375 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
376 </dl><a NAME="Project.__projectLanguageAdded" ID="Project.__projectLanguageAdded"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
377 <h4>Project.__projectLanguageAdded</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
378 <b>__projectLanguageAdded</b>(<i>code</i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
379 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
380 Private slot handling the addition of a new language.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
381 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
382 <dt><i>code</i></dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
383 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
384 language code of the new language (string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
385 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
386 </dl><a NAME="Project.__projectPath" ID="Project.__projectPath"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
387 <h4>Project.__projectPath</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
388 <b>__projectPath</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
389 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
390 Private method to calculate the full path of the Pyramid project.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
391 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
392 <dt>Returns:</dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
393 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
394 path of the project (string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
395 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
396 </dl><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
397 <dt>Raises <b>PyramidNoProjectSelectedException</b>:</dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
398 <dd>
54
71c83a661c83 Fixed code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 48
diff changeset
399 raised, if no project is
71c83a661c83 Fixed code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 48
diff changeset
400 selected
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
401 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
402 </dl><a NAME="Project.__pyramidInfo" ID="Project.__pyramidInfo"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
403 <h4>Project.__pyramidInfo</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
404 <b>__pyramidInfo</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
405 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
406 Private slot to show some info about Pyramid.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
407 </p><a NAME="Project.__runBrowser" ID="Project.__runBrowser"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
408 <h4>Project.__runBrowser</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
409 <b>__runBrowser</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
410 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
411 Private slot to start the default web browser with the server URL.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
412 </p><a NAME="Project.__runLoggingServer" ID="Project.__runLoggingServer"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
413 <h4>Project.__runLoggingServer</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
414 <b>__runLoggingServer</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
415 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
416 Private slot to start the Pyramid Web server with logging.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
417 </p><a NAME="Project.__runPythonShell" ID="Project.__runPythonShell"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
418 <h4>Project.__runPythonShell</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
419 <b>__runPythonShell</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
420 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
421 Private slot to start a Python console for a Pyramid project.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
422 </p><a NAME="Project.__runServer" ID="Project.__runServer"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
423 <h4>Project.__runServer</h4>
25
2dd3d1cf573a Fixed a bug related to uninstalling the plug-in via the external plug-in uninstaller.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 15
diff changeset
424 <b>__runServer</b>(<i>logging=False</i>)
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
425 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
426 Private slot to start the Pyramid Web server.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
427 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
428 <dt><i>logging</i></dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
429 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
430 flag indicating to enable logging (boolean)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
431 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
432 </dl><a NAME="Project.__selectProject" ID="Project.__selectProject"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
433 <h4>Project.__selectProject</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
434 <b>__selectProject</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
435 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
436 Private method to select a Pyramid project to work with.
54
71c83a661c83 Fixed code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 48
diff changeset
437 </p><a NAME="Project.__serverProcFinished" ID="Project.__serverProcFinished"></a>
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
438 <h4>Project.__serverProcFinished</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
439 <b>__serverProcFinished</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
440 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
441 Private slot connected to the finished signal.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
442 </p><a NAME="Project.__setCurrentProject" ID="Project.__setCurrentProject"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
443 <h4>Project.__setCurrentProject</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
444 <b>__setCurrentProject</b>(<i>project</i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
445 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
446 Private slot to set the current project.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
447 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
448 <dt><i>project</i></dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
449 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
450 name of the project (string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
451 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
452 </dl><a NAME="Project.__setupDevelop" ID="Project.__setupDevelop"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
453 <h4>Project.__setupDevelop</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
454 <b>__setupDevelop</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
455 <p>
54
71c83a661c83 Fixed code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 48
diff changeset
456 Private slot to set up the development environment for the current
71c83a661c83 Fixed code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 48
diff changeset
457 project.
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
458 </p><a NAME="Project.__showDocumentation" ID="Project.__showDocumentation"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
459 <h4>Project.__showDocumentation</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
460 <b>__showDocumentation</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
461 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
462 Private slot to show the helpviewer with the Pyramid documentation.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
463 </p><a NAME="Project.__showMatchingViews" ID="Project.__showMatchingViews"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
464 <h4>Project.__showMatchingViews</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
465 <b>__showMatchingViews</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
466 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
467 Private slot showing all views that would match a given URL.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
468 </p><a NAME="Project.__showRoutes" ID="Project.__showRoutes"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
469 <h4>Project.__showRoutes</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
470 <b>__showRoutes</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
471 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
472 Private slot showing all URL dispatch routes.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
473 </p><a NAME="Project.__showTweens" ID="Project.__showTweens"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
474 <h4>Project.__showTweens</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
475 <b>__showTweens</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
476 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
477 Private slot showing all implicit and explicit tween objects.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
478 </p><a NAME="Project.compileCatalogs" ID="Project.compileCatalogs"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
479 <h4>Project.compileCatalogs</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
480 <b>compileCatalogs</b>(<i>filenames</i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
481 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
482 Public method to compile the message catalogs.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
483 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
484 <dt><i>filenames</i></dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
485 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
486 list of filenames (not used)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
487 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
488 </dl><a NAME="Project.compileSelectedCatalogs" ID="Project.compileSelectedCatalogs"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
489 <h4>Project.compileSelectedCatalogs</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
490 <b>compileSelectedCatalogs</b>(<i>filenames</i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
491 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
492 Public method to update the message catalogs.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
493 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
494 <dt><i>filenames</i></dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
495 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
496 list of file names (list of string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
497 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
498 </dl><a NAME="Project.extractMessages" ID="Project.extractMessages"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
499 <h4>Project.extractMessages</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
500 <b>extractMessages</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
501 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
502 Public method to extract the messages catalog template file.
64
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
503 </p><a NAME="Project.getMenu" ID="Project.getMenu"></a>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
504 <h4>Project.getMenu</h4>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
505 <b>getMenu</b>(<i>name</i>)
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
506 <p>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
507 Public method to get a reference to the requested menu.
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
508 </p><dl>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
509 <dt><i>name</i></dt>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
510 <dd>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
511 name of the menu (string)
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
512 </dd>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
513 </dl><dl>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
514 <dt>Returns:</dt>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
515 <dd>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
516 reference to the menu (QMenu) or None, if no
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
517 menu with the given name exists
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
518 </dd>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
519 </dl><a NAME="Project.getMenuNames" ID="Project.getMenuNames"></a>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
520 <h4>Project.getMenuNames</h4>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
521 <b>getMenuNames</b>(<i></i>)
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
522 <p>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
523 Public method to get the names of all menus.
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
524 </p><dl>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
525 <dt>Returns:</dt>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
526 <dd>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
527 menu names (list of string)
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
528 </dd>
3b2da211e126 Extended the API to allow for plug-in extension by another plug-in.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
529 </dl><a NAME="Project.getPyramidCommand" ID="Project.getPyramidCommand"></a>
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
530 <h4>Project.getPyramidCommand</h4>
44
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
531 <b>getPyramidCommand</b>(<i>cmd, language=""</i>)
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
532 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
533 Public method to build a Pyramid command.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
534 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
535 <dt><i>cmd</i></dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
536 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
537 command (string)
44
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
538 </dd><dt><i>language</i></dt>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
539 <dd>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
540 Python variant to get the virtual environment
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
541 for (string, one of '', 'Python2' or 'Python3')
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
542 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
543 </dl><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
544 <dt>Returns:</dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
545 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
546 full pyramid command (string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
547 </dd>
44
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
548 </dl><a NAME="Project.getPyramidVersion" ID="Project.getPyramidVersion"></a>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
549 <h4>Project.getPyramidVersion</h4>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
550 <b>getPyramidVersion</b>(<i></i>)
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
551 <p>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
552 Public method to get the Pyramid version.
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
553 </p><dl>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
554 <dt>Returns:</dt>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
555 <dd>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
556 Pyramid version (string)
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
557 </dd>
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
558 </dl><a NAME="Project.getPythonCommand" ID="Project.getPythonCommand"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
559 <h4>Project.getPythonCommand</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
560 <b>getPythonCommand</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
561 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
562 Public method to build the Python command.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
563 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
564 <dt>Returns:</dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
565 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
566 python command (string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
567 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
568 </dl><a NAME="Project.initActions" ID="Project.initActions"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
569 <h4>Project.initActions</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
570 <b>initActions</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
571 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
572 Public method to define the Pyramid actions.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
573 </p><a NAME="Project.initMenu" ID="Project.initMenu"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
574 <h4>Project.initMenu</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
575 <b>initMenu</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
576 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
577 Public slot to initialize the Pyramid menu.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
578 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
579 <dt>Returns:</dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
580 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
581 the menu generated (QMenu)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
582 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
583 </dl><a NAME="Project.isSpawningConsole" ID="Project.isSpawningConsole"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
584 <h4>Project.isSpawningConsole</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
585 <b>isSpawningConsole</b>(<i>consoleCmd</i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
586 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
587 Public method to check, if the given console is a spawning console.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
588 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
589 <dt><i>consoleCmd</i></dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
590 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
591 console command (string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
592 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
593 </dl><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
594 <dt>Returns:</dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
595 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
596 tuple of two entries giving an indication, if the console
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
597 is spawning (boolean) and the (possibly) cleaned console command
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
598 (string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
599 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
600 </dl><a NAME="Project.newForm" ID="Project.newForm"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
601 <h4>Project.newForm</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
602 <b>newForm</b>(<i>path</i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
603 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
604 Public method to create a new form.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
605 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
606 <dt><i>path</i></dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
607 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
608 full directory path for the new form file (string)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
609 </dd>
48
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
610 </dl><a NAME="Project.openPOEditor" ID="Project.openPOEditor"></a>
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
611 <h4>Project.openPOEditor</h4>
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
612 <b>openPOEditor</b>(<i>poFile</i>)
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
613 <p>
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
614 Public method to edit the given file in an external .po editor.
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
615 </p><dl>
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
616 <dt><i>poFile</i></dt>
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
617 <dd>
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
618 name of the .po file (string)
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
619 </dd>
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
620 </dl><a NAME="Project.projectClosed" ID="Project.projectClosed"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
621 <h4>Project.projectClosed</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
622 <b>projectClosed</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
623 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
624 Public method to handle the closing of a project.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
625 </p><a NAME="Project.projectClosedHooks" ID="Project.projectClosedHooks"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
626 <h4>Project.projectClosedHooks</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
627 <b>projectClosedHooks</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
628 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
629 Public method to remove our hook methods.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
630 </p><a NAME="Project.projectOpenedHooks" ID="Project.projectOpenedHooks"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
631 <h4>Project.projectOpenedHooks</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
632 <b>projectOpenedHooks</b>(<i></i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
633 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
634 Public method to add our hook methods.
48
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
635 </p><a NAME="Project.registerOpenHook" ID="Project.registerOpenHook"></a>
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
636 <h4>Project.registerOpenHook</h4>
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
637 <b>registerOpenHook</b>(<i></i>)
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
638 <p>
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
639 Public method to register the open hook to open a translations file
c313efdb01de Added a menu entry to call a translations editor from the translations viewer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 44
diff changeset
640 in a translations editor.
44
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
641 </p><a NAME="Project.supportedPythonVariants" ID="Project.supportedPythonVariants"></a>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
642 <h4>Project.supportedPythonVariants</h4>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
643 <b>supportedPythonVariants</b>(<i></i>)
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
644 <p>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
645 Public method to get the supported Python variants.
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
646 </p><dl>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
647 <dt>Returns:</dt>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
648 <dd>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
649 list of supported Python variants (list of strings)
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
650 </dd>
989c961c33ab Extended the Python variant detection to only offer the Pyramid project type, if it is found for the respective Python.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
651 </dl><a NAME="Project.updateCatalogs" ID="Project.updateCatalogs"></a>
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
652 <h4>Project.updateCatalogs</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
653 <b>updateCatalogs</b>(<i>filenames</i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
654 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
655 Public method to update the message catalogs.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
656 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
657 <dt><i>filenames</i></dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
658 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
659 list of filenames (not used)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
660 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
661 </dl><a NAME="Project.updateSelectedCatalogs" ID="Project.updateSelectedCatalogs"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
662 <h4>Project.updateSelectedCatalogs</h4>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
663 <b>updateSelectedCatalogs</b>(<i>filenames</i>)
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
664 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
665 Public method to update the message catalogs.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
666 </p><dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
667 <dt><i>filenames</i></dt>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
668 <dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
669 list of filenames
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
670 </dd>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
671 </dl>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
672 <div align="right"><a href="#top">Up</a></div>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
673 <hr /><hr />
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
674 <a NAME="PyramidNoProjectSelectedException" ID="PyramidNoProjectSelectedException"></a>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
675 <h2>PyramidNoProjectSelectedException</h2>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
676 <p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
677 Exception thrown to signal, that there is no current Pyramid project.
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
678 </p>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
679 <h3>Derived from</h3>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
680 Exception
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
681 <h3>Class Attributes</h3>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
682 <table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
683 <tr><td>None</td></tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
684 </table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
685 <h3>Class Methods</h3>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
686 <table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
687 <tr><td>None</td></tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
688 </table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
689 <h3>Methods</h3>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
690 <table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
691 <tr><td>None</td></tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
692 </table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
693 <h3>Static Methods</h3>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
694 <table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
695 <tr><td>None</td></tr>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
696 </table>
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
697
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
698 <div align="right"><a href="#top">Up</a></div>
56
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
699 <hr /><hr />
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
700 <a NAME="QProcess" ID="QProcess"></a>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
701 <h2>QProcess</h2>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
702 <p>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
703 Class transforming the call arguments in case of gnome-terminal.
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
704 </p>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
705 <h3>Derived from</h3>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
706 QProcessPyQt
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
707 <h3>Class Attributes</h3>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
708 <table>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
709 <tr><td>None</td></tr>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
710 </table>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
711 <h3>Class Methods</h3>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
712 <table>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
713 <tr><td>None</td></tr>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
714 </table>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
715 <h3>Methods</h3>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
716 <table>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
717 <tr>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
718 <td><a href="#QProcess.start">start</a></td>
58
6acbfbba1e9d Corrected some code and documentation style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 57
diff changeset
719 <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>
56
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
720 </tr>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
721 </table>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
722 <h3>Static Methods</h3>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
723 <table>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
724 <tr>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
725 <td><a href="#QProcess.startDetached">startDetached</a></td>
74
11587ae1122f Ported to PyQt5 and eric6.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 64
diff changeset
726 <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>
56
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
727 </tr>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
728 </table>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
729 <a NAME="QProcess.start" ID="QProcess.start"></a>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
730 <h4>QProcess.start</h4>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
731 <b>start</b>(<i>cmd, args=[], mode=QProcessPyQt.ReadWrite</i>)
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
732 <p>
58
6acbfbba1e9d Corrected some code and documentation style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 57
diff changeset
733 Public method to start the given program (cmd) in a new process, if
6acbfbba1e9d Corrected some code and documentation style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 57
diff changeset
734 none is already running, passing the command line arguments in args.
56
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
735 </p><dl>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
736 <dt><i>cmd</i></dt>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
737 <dd>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
738 start the given program cmd (string)
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
739 </dd><dt><i>args=</i></dt>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
740 <dd>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
741 list of parameters (list of strings)
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
742 </dd><dt><i>mode=</i></dt>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
743 <dd>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
744 access mode (QIODevice.OpenMode)
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
745 </dd>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
746 </dl><a NAME="QProcess.startDetached" ID="QProcess.startDetached"></a>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
747 <h4>QProcess.startDetached (static)</h4>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
748 <b>startDetached</b>(<i>args=[], path=''</i>)
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
749 <p>
74
11587ae1122f Ported to PyQt5 and eric6.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 64
diff changeset
750 Public static method to start the given program (cmd) in a new process,
11587ae1122f Ported to PyQt5 and eric6.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 64
diff changeset
751 if none is already running, passing the command line arguments in args.
56
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
752 </p><dl>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
753 <dt><i>cmd</i></dt>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
754 <dd>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
755 start the given program cmd (string)
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
756 </dd><dt><i>args=</i></dt>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
757 <dd>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
758 list of parameters (list of strings)
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
759 </dd><dt><i>path=</i></dt>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
760 <dd>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
761 new working directory (string)
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
762 </dd>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
763 </dl><dl>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
764 <dt>Returns:</dt>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
765 <dd>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
766 tuple of successful start and process id (boolean, integer)
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
767 </dd>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
768 </dl>
c7adc68350dd Python 2 compatibility for Eric 5.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents: 48
diff changeset
769 <div align="right"><a href="#top">Up</a></div>
15
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
770 <hr />
db83e46b35da Added some documentation files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
771 </body></html>

eric ide

mercurial