Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog.html

Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog.html

changeset 3673
e26d7d0c1088
child 4072
46fb585f60f2
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog</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.vcsMercurial.HgDiffDialog</h1>
23 <p>
24 Module implementing a dialog to show the output of the hg diff command process.
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="#HgDiffDialog">HgDiffDialog</a></td>
34 <td>Class implementing a dialog to show the output of the hg diff command process.</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="HgDiffDialog" ID="HgDiffDialog"></a>
43 <h2>HgDiffDialog</h2>
44 <p>
45 Class implementing a dialog to show the output of the hg diff command
46 process.
47 </p>
48 <h3>Derived from</h3>
49 QWidget, Ui_HgDiffDialog
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Class Methods</h3>
55 <table>
56 <tr><td>None</td></tr>
57 </table>
58 <h3>Methods</h3>
59 <table>
60 <tr>
61 <td><a href="#HgDiffDialog.__init__">HgDiffDialog</a></td>
62 <td>Constructor</td>
63 </tr><tr>
64 <td><a href="#HgDiffDialog.__appendText">__appendText</a></td>
65 <td>Private method to append text to the end of the contents pane.</td>
66 </tr><tr>
67 <td><a href="#HgDiffDialog.__extractFileName">__extractFileName</a></td>
68 <td>Private method to extract the file name out of a file separator line.</td>
69 </tr><tr>
70 <td><a href="#HgDiffDialog.__finish">__finish</a></td>
71 <td>Private slot called when the process finished or the user pressed the button.</td>
72 </tr><tr>
73 <td><a href="#HgDiffDialog.__getVersionArg">__getVersionArg</a></td>
74 <td>Private method to get a hg revision argument for the given revision.</td>
75 </tr><tr>
76 <td><a href="#HgDiffDialog.__procFinished">__procFinished</a></td>
77 <td>Private slot connected to the finished signal.</td>
78 </tr><tr>
79 <td><a href="#HgDiffDialog.__processFileLine">__processFileLine</a></td>
80 <td>Private slot to process a line giving the old/new file.</td>
81 </tr><tr>
82 <td><a href="#HgDiffDialog.__processOutputLine">__processOutputLine</a></td>
83 <td>Private method to process the lines of output.</td>
84 </tr><tr>
85 <td><a href="#HgDiffDialog.__readStderr">__readStderr</a></td>
86 <td>Private slot to handle the readyReadStandardError signal.</td>
87 </tr><tr>
88 <td><a href="#HgDiffDialog.__readStdout">__readStdout</a></td>
89 <td>Private slot to handle the readyReadStandardOutput signal.</td>
90 </tr><tr>
91 <td><a href="#HgDiffDialog.__showError">__showError</a></td>
92 <td>Private slot to show some error.</td>
93 </tr><tr>
94 <td><a href="#HgDiffDialog.closeEvent">closeEvent</a></td>
95 <td>Protected slot implementing a close event handler.</td>
96 </tr><tr>
97 <td><a href="#HgDiffDialog.keyPressEvent">keyPressEvent</a></td>
98 <td>Protected slot to handle a key press event.</td>
99 </tr><tr>
100 <td><a href="#HgDiffDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
101 <td>Private slot called by a button of the button box clicked.</td>
102 </tr><tr>
103 <td><a href="#HgDiffDialog.on_filesCombo_activated">on_filesCombo_activated</a></td>
104 <td>Private slot to handle the selection of a file.</td>
105 </tr><tr>
106 <td><a href="#HgDiffDialog.on_input_returnPressed">on_input_returnPressed</a></td>
107 <td>Private slot to handle the press of the return key in the input field.</td>
108 </tr><tr>
109 <td><a href="#HgDiffDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
110 <td>Private slot to handle the password checkbox toggled.</td>
111 </tr><tr>
112 <td><a href="#HgDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td>
113 <td>Private slot to handle the Save button press.</td>
114 </tr><tr>
115 <td><a href="#HgDiffDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
116 <td>Private slot to send the input to the subversion process.</td>
117 </tr><tr>
118 <td><a href="#HgDiffDialog.start">start</a></td>
119 <td>Public slot to start the hg diff command.</td>
120 </tr>
121 </table>
122 <h3>Static Methods</h3>
123 <table>
124 <tr><td>None</td></tr>
125 </table>
126 <a NAME="HgDiffDialog.__init__" ID="HgDiffDialog.__init__"></a>
127 <h4>HgDiffDialog (Constructor)</h4>
128 <b>HgDiffDialog</b>(<i>vcs, parent=None</i>)
129 <p>
130 Constructor
131 </p><dl>
132 <dt><i>vcs</i></dt>
133 <dd>
134 reference to the vcs object
135 </dd><dt><i>parent</i></dt>
136 <dd>
137 parent widget (QWidget)
138 </dd>
139 </dl><a NAME="HgDiffDialog.__appendText" ID="HgDiffDialog.__appendText"></a>
140 <h4>HgDiffDialog.__appendText</h4>
141 <b>__appendText</b>(<i>txt, format</i>)
142 <p>
143 Private method to append text to the end of the contents pane.
144 </p><dl>
145 <dt><i>txt</i></dt>
146 <dd>
147 text to insert (string)
148 </dd><dt><i>format</i></dt>
149 <dd>
150 text format to be used (QTextCharFormat)
151 </dd>
152 </dl><a NAME="HgDiffDialog.__extractFileName" ID="HgDiffDialog.__extractFileName"></a>
153 <h4>HgDiffDialog.__extractFileName</h4>
154 <b>__extractFileName</b>(<i>line</i>)
155 <p>
156 Private method to extract the file name out of a file separator line.
157 </p><dl>
158 <dt><i>line</i></dt>
159 <dd>
160 line to be processed (string)
161 </dd>
162 </dl><dl>
163 <dt>Returns:</dt>
164 <dd>
165 extracted file name (string)
166 </dd>
167 </dl><a NAME="HgDiffDialog.__finish" ID="HgDiffDialog.__finish"></a>
168 <h4>HgDiffDialog.__finish</h4>
169 <b>__finish</b>(<i></i>)
170 <p>
171 Private slot called when the process finished or the user pressed
172 the button.
173 </p><a NAME="HgDiffDialog.__getVersionArg" ID="HgDiffDialog.__getVersionArg"></a>
174 <h4>HgDiffDialog.__getVersionArg</h4>
175 <b>__getVersionArg</b>(<i>version</i>)
176 <p>
177 Private method to get a hg revision argument for the given revision.
178 </p><dl>
179 <dt><i>version</i></dt>
180 <dd>
181 revision (integer or string)
182 </dd>
183 </dl><dl>
184 <dt>Returns:</dt>
185 <dd>
186 version argument (string)
187 </dd>
188 </dl><a NAME="HgDiffDialog.__procFinished" ID="HgDiffDialog.__procFinished"></a>
189 <h4>HgDiffDialog.__procFinished</h4>
190 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
191 <p>
192 Private slot connected to the finished signal.
193 </p><dl>
194 <dt><i>exitCode</i></dt>
195 <dd>
196 exit code of the process (integer)
197 </dd><dt><i>exitStatus</i></dt>
198 <dd>
199 exit status of the process (QProcess.ExitStatus)
200 </dd>
201 </dl><a NAME="HgDiffDialog.__processFileLine" ID="HgDiffDialog.__processFileLine"></a>
202 <h4>HgDiffDialog.__processFileLine</h4>
203 <b>__processFileLine</b>(<i>line</i>)
204 <p>
205 Private slot to process a line giving the old/new file.
206 </p><dl>
207 <dt><i>line</i></dt>
208 <dd>
209 line to be processed (string)
210 </dd>
211 </dl><a NAME="HgDiffDialog.__processOutputLine" ID="HgDiffDialog.__processOutputLine"></a>
212 <h4>HgDiffDialog.__processOutputLine</h4>
213 <b>__processOutputLine</b>(<i>line</i>)
214 <p>
215 Private method to process the lines of output.
216 </p><dl>
217 <dt><i>line</i></dt>
218 <dd>
219 output line to be processed (string)
220 </dd>
221 </dl><a NAME="HgDiffDialog.__readStderr" ID="HgDiffDialog.__readStderr"></a>
222 <h4>HgDiffDialog.__readStderr</h4>
223 <b>__readStderr</b>(<i></i>)
224 <p>
225 Private slot to handle the readyReadStandardError signal.
226 </p><p>
227 It reads the error output of the process and inserts it into the
228 error pane.
229 </p><a NAME="HgDiffDialog.__readStdout" ID="HgDiffDialog.__readStdout"></a>
230 <h4>HgDiffDialog.__readStdout</h4>
231 <b>__readStdout</b>(<i></i>)
232 <p>
233 Private slot to handle the readyReadStandardOutput signal.
234 </p><p>
235 It reads the output of the process, formats it and inserts it into
236 the contents pane.
237 </p><a NAME="HgDiffDialog.__showError" ID="HgDiffDialog.__showError"></a>
238 <h4>HgDiffDialog.__showError</h4>
239 <b>__showError</b>(<i>out</i>)
240 <p>
241 Private slot to show some error.
242 </p><dl>
243 <dt><i>out</i></dt>
244 <dd>
245 error to be shown (string)
246 </dd>
247 </dl><a NAME="HgDiffDialog.closeEvent" ID="HgDiffDialog.closeEvent"></a>
248 <h4>HgDiffDialog.closeEvent</h4>
249 <b>closeEvent</b>(<i>e</i>)
250 <p>
251 Protected slot implementing a close event handler.
252 </p><dl>
253 <dt><i>e</i></dt>
254 <dd>
255 close event (QCloseEvent)
256 </dd>
257 </dl><a NAME="HgDiffDialog.keyPressEvent" ID="HgDiffDialog.keyPressEvent"></a>
258 <h4>HgDiffDialog.keyPressEvent</h4>
259 <b>keyPressEvent</b>(<i>evt</i>)
260 <p>
261 Protected slot to handle a key press event.
262 </p><dl>
263 <dt><i>evt</i></dt>
264 <dd>
265 the key press event (QKeyEvent)
266 </dd>
267 </dl><a NAME="HgDiffDialog.on_buttonBox_clicked" ID="HgDiffDialog.on_buttonBox_clicked"></a>
268 <h4>HgDiffDialog.on_buttonBox_clicked</h4>
269 <b>on_buttonBox_clicked</b>(<i>button</i>)
270 <p>
271 Private slot called by a button of the button box clicked.
272 </p><dl>
273 <dt><i>button</i></dt>
274 <dd>
275 button that was clicked (QAbstractButton)
276 </dd>
277 </dl><a NAME="HgDiffDialog.on_filesCombo_activated" ID="HgDiffDialog.on_filesCombo_activated"></a>
278 <h4>HgDiffDialog.on_filesCombo_activated</h4>
279 <b>on_filesCombo_activated</b>(<i>index</i>)
280 <p>
281 Private slot to handle the selection of a file.
282 </p><dl>
283 <dt><i>index</i></dt>
284 <dd>
285 activated row (integer)
286 </dd>
287 </dl><a NAME="HgDiffDialog.on_input_returnPressed" ID="HgDiffDialog.on_input_returnPressed"></a>
288 <h4>HgDiffDialog.on_input_returnPressed</h4>
289 <b>on_input_returnPressed</b>(<i></i>)
290 <p>
291 Private slot to handle the press of the return key in the input field.
292 </p><a NAME="HgDiffDialog.on_passwordCheckBox_toggled" ID="HgDiffDialog.on_passwordCheckBox_toggled"></a>
293 <h4>HgDiffDialog.on_passwordCheckBox_toggled</h4>
294 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
295 <p>
296 Private slot to handle the password checkbox toggled.
297 </p><dl>
298 <dt><i>isOn</i></dt>
299 <dd>
300 flag indicating the status of the check box (boolean)
301 </dd>
302 </dl><a NAME="HgDiffDialog.on_saveButton_clicked" ID="HgDiffDialog.on_saveButton_clicked"></a>
303 <h4>HgDiffDialog.on_saveButton_clicked</h4>
304 <b>on_saveButton_clicked</b>(<i></i>)
305 <p>
306 Private slot to handle the Save button press.
307 </p><p>
308 It saves the diff shown in the dialog to a file in the local
309 filesystem.
310 </p><a NAME="HgDiffDialog.on_sendButton_clicked" ID="HgDiffDialog.on_sendButton_clicked"></a>
311 <h4>HgDiffDialog.on_sendButton_clicked</h4>
312 <b>on_sendButton_clicked</b>(<i></i>)
313 <p>
314 Private slot to send the input to the subversion process.
315 </p><a NAME="HgDiffDialog.start" ID="HgDiffDialog.start"></a>
316 <h4>HgDiffDialog.start</h4>
317 <b>start</b>(<i>fn, versions=None, bundle=None, qdiff=False</i>)
318 <p>
319 Public slot to start the hg diff command.
320 </p><dl>
321 <dt><i>fn</i></dt>
322 <dd>
323 filename to be diffed (string)
324 </dd><dt><i>versions</i></dt>
325 <dd>
326 list of versions to be diffed (list of up to 2 strings
327 or None)
328 </dd><dt><i>bundle</i></dt>
329 <dd>
330 name of a bundle file (string)
331 </dd><dt><i>qdiff</i></dt>
332 <dd>
333 flag indicating qdiff command shall be used (boolean)
334 </dd>
335 </dl>
336 <div align="right"><a href="#top">Up</a></div>
337 <hr />
338 </body></html>

Mercurial Repository: eric

eric ide

mercurial