Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitDialog.html

Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitDialog.html

changeset 6020
baf6da1ae288
equal deleted inserted replaced
6019:58ecdaf0b789 6020:baf6da1ae288
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsGit.GitDialog</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>eric6.Plugins.VcsPlugins.vcsGit.GitDialog</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="#GitDialog">GitDialog</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="GitDialog" ID="GitDialog"></a>
43 <h2>GitDialog</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_GitDialog
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="#GitDialog.__init__">GitDialog</a></td>
65 <td>Constructor</td>
66 </tr><tr>
67 <td><a href="#GitDialog.__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="#GitDialog.__procFinished">__procFinished</a></td>
71 <td>Private slot connected to the finished signal.</td>
72 </tr><tr>
73 <td><a href="#GitDialog.__readStderr">__readStderr</a></td>
74 <td>Private slot to handle the readyReadStandardError signal.</td>
75 </tr><tr>
76 <td><a href="#GitDialog.__readStdout">__readStdout</a></td>
77 <td>Private slot to handle the readyReadStandardOutput signal.</td>
78 </tr><tr>
79 <td><a href="#GitDialog.__showError">__showError</a></td>
80 <td>Private slot to show some error.</td>
81 </tr><tr>
82 <td><a href="#GitDialog.__showOutput">__showOutput</a></td>
83 <td>Private slot to show some output.</td>
84 </tr><tr>
85 <td><a href="#GitDialog.hasAddOrDelete">hasAddOrDelete</a></td>
86 <td>Public method to check, if the last action contained an add or delete.</td>
87 </tr><tr>
88 <td><a href="#GitDialog.keyPressEvent">keyPressEvent</a></td>
89 <td>Protected slot to handle a key press event.</td>
90 </tr><tr>
91 <td><a href="#GitDialog.normalExit">normalExit</a></td>
92 <td>Public method to check for a normal process termination.</td>
93 </tr><tr>
94 <td><a href="#GitDialog.normalExitWithoutErrors">normalExitWithoutErrors</a></td>
95 <td>Public method to check for a normal process termination without error messages.</td>
96 </tr><tr>
97 <td><a href="#GitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
98 <td>Private slot called by a button of the button box clicked.</td>
99 </tr><tr>
100 <td><a href="#GitDialog.on_input_returnPressed">on_input_returnPressed</a></td>
101 <td>Private slot to handle the press of the return key in the input field.</td>
102 </tr><tr>
103 <td><a href="#GitDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
104 <td>Private slot to handle the password checkbox toggled.</td>
105 </tr><tr>
106 <td><a href="#GitDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
107 <td>Private slot to send the input to the git process.</td>
108 </tr><tr>
109 <td><a href="#GitDialog.startProcess">startProcess</a></td>
110 <td>Public slot used to start the process.</td>
111 </tr>
112 </table>
113 <h3>Static Methods</h3>
114 <table>
115 <tr><td>None</td></tr>
116 </table>
117 <a NAME="GitDialog.__init__" ID="GitDialog.__init__"></a>
118 <h4>GitDialog (Constructor)</h4>
119 <b>GitDialog</b>(<i>text, git=None, parent=None</i>)
120 <p>
121 Constructor
122 </p><dl>
123 <dt><i>text</i></dt>
124 <dd>
125 text to be shown by the label (string)
126 </dd><dt><i>git</i></dt>
127 <dd>
128 reference to the Git interface object (Git)
129 </dd><dt><i>parent</i></dt>
130 <dd>
131 parent widget (QWidget)
132 </dd>
133 </dl><a NAME="GitDialog.__finish" ID="GitDialog.__finish"></a>
134 <h4>GitDialog.__finish</h4>
135 <b>__finish</b>(<i></i>)
136 <p>
137 Private slot called when the process finished or the user pressed
138 the button.
139 </p><a NAME="GitDialog.__procFinished" ID="GitDialog.__procFinished"></a>
140 <h4>GitDialog.__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="GitDialog.__readStderr" ID="GitDialog.__readStderr"></a>
153 <h4>GitDialog.__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="GitDialog.__readStdout" ID="GitDialog.__readStdout"></a>
161 <h4>GitDialog.__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="GitDialog.__showError" ID="GitDialog.__showError"></a>
169 <h4>GitDialog.__showError</h4>
170 <b>__showError</b>(<i>out</i>)
171 <p>
172 Private slot to show some error.
173 </p><dl>
174 <dt><i>out</i></dt>
175 <dd>
176 error to be shown (string)
177 </dd>
178 </dl><a NAME="GitDialog.__showOutput" ID="GitDialog.__showOutput"></a>
179 <h4>GitDialog.__showOutput</h4>
180 <b>__showOutput</b>(<i>out</i>)
181 <p>
182 Private slot to show some output.
183 </p><dl>
184 <dt><i>out</i></dt>
185 <dd>
186 output to be shown (string)
187 </dd>
188 </dl><a NAME="GitDialog.hasAddOrDelete" ID="GitDialog.hasAddOrDelete"></a>
189 <h4>GitDialog.hasAddOrDelete</h4>
190 <b>hasAddOrDelete</b>(<i></i>)
191 <p>
192 Public method to check, if the last action contained an add or delete.
193 </p><dl>
194 <dt>Returns:</dt>
195 <dd>
196 flag indicating the presence of an add or delete (boolean)
197 </dd>
198 </dl><a NAME="GitDialog.keyPressEvent" ID="GitDialog.keyPressEvent"></a>
199 <h4>GitDialog.keyPressEvent</h4>
200 <b>keyPressEvent</b>(<i>evt</i>)
201 <p>
202 Protected slot to handle a key press event.
203 </p><dl>
204 <dt><i>evt</i></dt>
205 <dd>
206 the key press event (QKeyEvent)
207 </dd>
208 </dl><a NAME="GitDialog.normalExit" ID="GitDialog.normalExit"></a>
209 <h4>GitDialog.normalExit</h4>
210 <b>normalExit</b>(<i></i>)
211 <p>
212 Public method to check for a normal process termination.
213 </p><dl>
214 <dt>Returns:</dt>
215 <dd>
216 flag indicating normal process termination (boolean)
217 </dd>
218 </dl><a NAME="GitDialog.normalExitWithoutErrors" ID="GitDialog.normalExitWithoutErrors"></a>
219 <h4>GitDialog.normalExitWithoutErrors</h4>
220 <b>normalExitWithoutErrors</b>(<i></i>)
221 <p>
222 Public method to check for a normal process termination without
223 error messages.
224 </p><dl>
225 <dt>Returns:</dt>
226 <dd>
227 flag indicating normal process termination (boolean)
228 </dd>
229 </dl><a NAME="GitDialog.on_buttonBox_clicked" ID="GitDialog.on_buttonBox_clicked"></a>
230 <h4>GitDialog.on_buttonBox_clicked</h4>
231 <b>on_buttonBox_clicked</b>(<i>button</i>)
232 <p>
233 Private slot called by a button of the button box clicked.
234 </p><dl>
235 <dt><i>button</i></dt>
236 <dd>
237 button that was clicked (QAbstractButton)
238 </dd>
239 </dl><a NAME="GitDialog.on_input_returnPressed" ID="GitDialog.on_input_returnPressed"></a>
240 <h4>GitDialog.on_input_returnPressed</h4>
241 <b>on_input_returnPressed</b>(<i></i>)
242 <p>
243 Private slot to handle the press of the return key in the input field.
244 </p><a NAME="GitDialog.on_passwordCheckBox_toggled" ID="GitDialog.on_passwordCheckBox_toggled"></a>
245 <h4>GitDialog.on_passwordCheckBox_toggled</h4>
246 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
247 <p>
248 Private slot to handle the password checkbox toggled.
249 </p><dl>
250 <dt><i>isOn</i></dt>
251 <dd>
252 flag indicating the status of the check box (boolean)
253 </dd>
254 </dl><a NAME="GitDialog.on_sendButton_clicked" ID="GitDialog.on_sendButton_clicked"></a>
255 <h4>GitDialog.on_sendButton_clicked</h4>
256 <b>on_sendButton_clicked</b>(<i></i>)
257 <p>
258 Private slot to send the input to the git process.
259 </p><a NAME="GitDialog.startProcess" ID="GitDialog.startProcess"></a>
260 <h4>GitDialog.startProcess</h4>
261 <b>startProcess</b>(<i>args, workingDir=None, showArgs=True, environment=None</i>)
262 <p>
263 Public slot used to start the process.
264 </p><dl>
265 <dt><i>args</i></dt>
266 <dd>
267 list of arguments for the process (list of strings)
268 </dd><dt><i>workingDir=</i></dt>
269 <dd>
270 working directory for the process (string)
271 </dd><dt><i>showArgs=</i></dt>
272 <dd>
273 flag indicating to show the arguments (boolean)
274 </dd><dt><i>environment=</i></dt>
275 <dd>
276 dictionary of environment settings to add
277 or change for the git process (dict of string and string)
278 </dd>
279 </dl><dl>
280 <dt>Returns:</dt>
281 <dd>
282 flag indicating a successful start of the process (boolean)
283 </dd>
284 </dl>
285 <div align="right"><a href="#top">Up</a></div>
286 <hr />
287 </body></html>

Mercurial Repository: eric

eric ide

mercurial