Mercurial Repositories > Django Project / file comparison

comparison: ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoDialog.html

ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoDialog.html

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

Mercurial Repository: Django Project

eric ide

mercurial