Mercurial Repositories > Pyramid Project / file comparison

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

ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog.html

changeset 15
db83e46b35da
child 25
2dd3d1cf573a
equal deleted inserted replaced
14:e3cb581b4653 15:db83e46b35da
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog</h1>
24 <p>
25 Module implementing a dialog starting a process and showing its output.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#PyramidDialog">PyramidDialog</a></td>
35 <td>Class implementing a dialog starting a process and showing its output.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="PyramidDialog" ID="PyramidDialog"></a>
44 <h2>PyramidDialog</h2>
45 <p>
46 Class implementing a dialog starting a process and showing its output.
47 </p><p>
48 It starts a QProcess and displays a dialog that
49 shows the output of the process. The dialog is modal,
50 which causes a synchronized execution of the process.
51 </p>
52 <h3>Derived from</h3>
53 QDialog, Ui_PyramidDialog
54 <h3>Class Attributes</h3>
55 <table>
56 <tr><td>None</td></tr>
57 </table>
58 <h3>Class Methods</h3>
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Methods</h3>
63 <table>
64 <tr>
65 <td><a href="#PyramidDialog.__init__">PyramidDialog</a></td>
66 <td>Constructor</td>
67 </tr><tr>
68 <td><a href="#PyramidDialog.__procFinished">__procFinished</a></td>
69 <td>Private slot connected to the finished signal.</td>
70 </tr><tr>
71 <td><a href="#PyramidDialog.__readStderr">__readStderr</a></td>
72 <td>Private slot to handle the readyReadStandardError signal.</td>
73 </tr><tr>
74 <td><a href="#PyramidDialog.__readStdout">__readStdout</a></td>
75 <td>Private slot to handle the readyReadStandardOutput signal.</td>
76 </tr><tr>
77 <td><a href="#PyramidDialog.finish">finish</a></td>
78 <td>Public slot called when the process finished or the user pressed the button.</td>
79 </tr><tr>
80 <td><a href="#PyramidDialog.keyPressEvent">keyPressEvent</a></td>
81 <td>Protected slot to handle a key press event.</td>
82 </tr><tr>
83 <td><a href="#PyramidDialog.normalExit">normalExit</a></td>
84 <td>Public method to check for a normal process termination.</td>
85 </tr><tr>
86 <td><a href="#PyramidDialog.normalExitWithoutErrors">normalExitWithoutErrors</a></td>
87 <td>Public method to check for a normal process termination without error messages.</td>
88 </tr><tr>
89 <td><a href="#PyramidDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
90 <td>Private slot called by a button of the button box clicked.</td>
91 </tr><tr>
92 <td><a href="#PyramidDialog.on_input_returnPressed">on_input_returnPressed</a></td>
93 <td>Private slot to handle the press of the return key in the input field.</td>
94 </tr><tr>
95 <td><a href="#PyramidDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
96 <td>Private slot to handle the password checkbox toggled.</td>
97 </tr><tr>
98 <td><a href="#PyramidDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
99 <td>Private slot to send the input to the subversion process.</td>
100 </tr><tr>
101 <td><a href="#PyramidDialog.startBatchProcesses">startBatchProcesses</a></td>
102 <td>Public slot used to start a batch of processes.</td>
103 </tr><tr>
104 <td><a href="#PyramidDialog.startProcess">startProcess</a></td>
105 <td>Public slot used to start the process.</td>
106 </tr>
107 </table>
108 <h3>Static Methods</h3>
109 <table>
110 <tr><td>None</td></tr>
111 </table>
112 <a NAME="PyramidDialog.__init__" ID="PyramidDialog.__init__"></a>
113 <h4>PyramidDialog (Constructor)</h4>
114 <b>PyramidDialog</b>(<i>text, fixed = False, linewrap = True, msgSuccess = None, msgError = None, parent = None</i>)
115 <p>
116 Constructor
117 </p><dl>
118 <dt><i>text</i></dt>
119 <dd>
120 text to be shown by the label (string)
121 </dd><dt><i>fixed=</i></dt>
122 <dd>
123 flag indicating a fixed font should be used (boolean)
124 </dd><dt><i>linewrap=</i></dt>
125 <dd>
126 flag indicating to wrap long lines (boolean)
127 </dd><dt><i>msgSuccess=</i></dt>
128 <dd>
129 optional string to show upon successful execution
130 (string)
131 </dd><dt><i>msgError=</i></dt>
132 <dd>
133 optional string to show upon unsuccessful execution
134 (string)
135 </dd><dt><i>parent=</i></dt>
136 <dd>
137 parent widget (QWidget)
138 </dd>
139 </dl><a NAME="PyramidDialog.__procFinished" ID="PyramidDialog.__procFinished"></a>
140 <h4>PyramidDialog.__procFinished</h4>
141 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
142 <p>
143 Private slot connected to the finished signal.
144 </p><dl>
145 <dt><i>exitCode</i></dt>
146 <dd>
147 exit code of the process (integer)
148 </dd><dt><i>exitStatus</i></dt>
149 <dd>
150 exit status of the process (QProcess.ExitStatus)
151 </dd>
152 </dl><a NAME="PyramidDialog.__readStderr" ID="PyramidDialog.__readStderr"></a>
153 <h4>PyramidDialog.__readStderr</h4>
154 <b>__readStderr</b>(<i></i>)
155 <p>
156 Private slot to handle the readyReadStandardError signal.
157 </p><p>
158 It reads the error output of the process and inserts it into the
159 error pane.
160 </p><a NAME="PyramidDialog.__readStdout" ID="PyramidDialog.__readStdout"></a>
161 <h4>PyramidDialog.__readStdout</h4>
162 <b>__readStdout</b>(<i></i>)
163 <p>
164 Private slot to handle the readyReadStandardOutput signal.
165 </p><p>
166 It reads the output of the process, formats it and inserts it into
167 the contents pane.
168 </p><a NAME="PyramidDialog.finish" ID="PyramidDialog.finish"></a>
169 <h4>PyramidDialog.finish</h4>
170 <b>finish</b>(<i></i>)
171 <p>
172 Public slot called when the process finished or the user pressed the button.
173 </p><a NAME="PyramidDialog.keyPressEvent" ID="PyramidDialog.keyPressEvent"></a>
174 <h4>PyramidDialog.keyPressEvent</h4>
175 <b>keyPressEvent</b>(<i>evt</i>)
176 <p>
177 Protected slot to handle a key press event.
178 </p><dl>
179 <dt><i>evt</i></dt>
180 <dd>
181 the key press event (QKeyEvent)
182 </dd>
183 </dl><a NAME="PyramidDialog.normalExit" ID="PyramidDialog.normalExit"></a>
184 <h4>PyramidDialog.normalExit</h4>
185 <b>normalExit</b>(<i></i>)
186 <p>
187 Public method to check for a normal process termination.
188 </p><dl>
189 <dt>Returns:</dt>
190 <dd>
191 flag indicating normal process termination (boolean)
192 </dd>
193 </dl><a NAME="PyramidDialog.normalExitWithoutErrors" ID="PyramidDialog.normalExitWithoutErrors"></a>
194 <h4>PyramidDialog.normalExitWithoutErrors</h4>
195 <b>normalExitWithoutErrors</b>(<i></i>)
196 <p>
197 Public method to check for a normal process termination without
198 error messages.
199 </p><dl>
200 <dt>Returns:</dt>
201 <dd>
202 flag indicating normal process termination (boolean)
203 </dd>
204 </dl><a NAME="PyramidDialog.on_buttonBox_clicked" ID="PyramidDialog.on_buttonBox_clicked"></a>
205 <h4>PyramidDialog.on_buttonBox_clicked</h4>
206 <b>on_buttonBox_clicked</b>(<i>button</i>)
207 <p>
208 Private slot called by a button of the button box clicked.
209 </p><dl>
210 <dt><i>button</i></dt>
211 <dd>
212 button that was clicked (QAbstractButton)
213 </dd>
214 </dl><a NAME="PyramidDialog.on_input_returnPressed" ID="PyramidDialog.on_input_returnPressed"></a>
215 <h4>PyramidDialog.on_input_returnPressed</h4>
216 <b>on_input_returnPressed</b>(<i></i>)
217 <p>
218 Private slot to handle the press of the return key in the input field.
219 </p><a NAME="PyramidDialog.on_passwordCheckBox_toggled" ID="PyramidDialog.on_passwordCheckBox_toggled"></a>
220 <h4>PyramidDialog.on_passwordCheckBox_toggled</h4>
221 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
222 <p>
223 Private slot to handle the password checkbox toggled.
224 </p><dl>
225 <dt><i>isOn</i></dt>
226 <dd>
227 flag indicating the status of the check box (boolean)
228 </dd>
229 </dl><a NAME="PyramidDialog.on_sendButton_clicked" ID="PyramidDialog.on_sendButton_clicked"></a>
230 <h4>PyramidDialog.on_sendButton_clicked</h4>
231 <b>on_sendButton_clicked</b>(<i></i>)
232 <p>
233 Private slot to send the input to the subversion process.
234 </p><a NAME="PyramidDialog.startBatchProcesses" ID="PyramidDialog.startBatchProcesses"></a>
235 <h4>PyramidDialog.startBatchProcesses</h4>
236 <b>startBatchProcesses</b>(<i>argsLists, workingDir = None</i>)
237 <p>
238 Public slot used to start a batch of processes.
239 </p><dl>
240 <dt><i>argsLists</i></dt>
241 <dd>
242 list of lists of arguments for the processes
243 (list of list of string)
244 </dd><dt><i>workingDir</i></dt>
245 <dd>
246 working directory for the process (string)
247 </dd>
248 </dl><dl>
249 <dt>Returns:</dt>
250 <dd>
251 flag indicating a successful start of the first process (boolean)
252 </dd>
253 </dl><a NAME="PyramidDialog.startProcess" ID="PyramidDialog.startProcess"></a>
254 <h4>PyramidDialog.startProcess</h4>
255 <b>startProcess</b>(<i>command, args, workingDir=None, showArgs=True</i>)
256 <p>
257 Public slot used to start the process.
258 </p><dl>
259 <dt><i>command</i></dt>
260 <dd>
261 command to start (string)
262 </dd><dt><i>args</i></dt>
263 <dd>
264 list of arguments for the process (list of strings)
265 </dd><dt><i>workingDir=</i></dt>
266 <dd>
267 working directory for the process (string)
268 </dd><dt><i>showArgs=</i></dt>
269 <dd>
270 flag indicating to show the arguments (boolean)
271 </dd>
272 </dl><dl>
273 <dt>Returns:</dt>
274 <dd>
275 flag indicating a successful start of the process
276 </dd>
277 </dl>
278 <div align="right"><a href="#top">Up</a></div>
279 <hr />
280 </body></html>

Mercurial Repository: Pyramid Project

eric ide

mercurial