Mercurial Repositories > eric / file comparison

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

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

changeset 178
dd9f0bca5e2f
child 217
8ce554fb0bee
equal deleted inserted replaced
177:c822ccc4d138 178:dd9f0bca5e2f
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>eric5.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog</h1>
24 <p>
25 Module implementing a dialog to show the output of the hg diff command process.
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="#HgDiffDialog">HgDiffDialog</a></td>
35 <td>Class implementing a dialog to show the output of the hg diff command process.</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="HgDiffDialog" ID="HgDiffDialog"></a>
44 <h2>HgDiffDialog</h2>
45 <p>
46 Class implementing a dialog to show the output of the hg diff command 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>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#HgDiffDialog.__init__">HgDiffDialog</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#HgDiffDialog.__appendText">__appendText</a></td>
61 <td>Private method to append text to the end of the contents pane.</td>
62 </tr><tr>
63 <td><a href="#HgDiffDialog.__getVersionArg">__getVersionArg</a></td>
64 <td>Private method to get a hg revision argument for the given revision.</td>
65 </tr><tr>
66 <td><a href="#HgDiffDialog.__procFinished">__procFinished</a></td>
67 <td>Private slot connected to the finished signal.</td>
68 </tr><tr>
69 <td><a href="#HgDiffDialog.__readStderr">__readStderr</a></td>
70 <td>Private slot to handle the readyReadStandardError signal.</td>
71 </tr><tr>
72 <td><a href="#HgDiffDialog.__readStdout">__readStdout</a></td>
73 <td>Private slot to handle the readyReadStandardOutput signal.</td>
74 </tr><tr>
75 <td><a href="#HgDiffDialog.closeEvent">closeEvent</a></td>
76 <td>Private slot implementing a close event handler.</td>
77 </tr><tr>
78 <td><a href="#HgDiffDialog.keyPressEvent">keyPressEvent</a></td>
79 <td>Protected slot to handle a key press event.</td>
80 </tr><tr>
81 <td><a href="#HgDiffDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
82 <td>Private slot called by a button of the button box clicked.</td>
83 </tr><tr>
84 <td><a href="#HgDiffDialog.on_input_returnPressed">on_input_returnPressed</a></td>
85 <td>Private slot to handle the press of the return key in the input field.</td>
86 </tr><tr>
87 <td><a href="#HgDiffDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
88 <td>Private slot to handle the password checkbox toggled.</td>
89 </tr><tr>
90 <td><a href="#HgDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td>
91 <td>Private slot to handle the Save button press.</td>
92 </tr><tr>
93 <td><a href="#HgDiffDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
94 <td>Private slot to send the input to the subversion process.</td>
95 </tr><tr>
96 <td><a href="#HgDiffDialog.start">start</a></td>
97 <td>Public slot to start the hg diff command.</td>
98 </tr>
99 </table>
100 <a NAME="HgDiffDialog.__init__" ID="HgDiffDialog.__init__"></a>
101 <h4>HgDiffDialog (Constructor)</h4>
102 <b>HgDiffDialog</b>(<i>vcs, parent = None</i>)
103 <p>
104 Constructor
105 </p><dl>
106 <dt><i>vcs</i></dt>
107 <dd>
108 reference to the vcs object
109 </dd><dt><i>parent</i></dt>
110 <dd>
111 parent widget (QWidget)
112 </dd>
113 </dl><a NAME="HgDiffDialog.__appendText" ID="HgDiffDialog.__appendText"></a>
114 <h4>HgDiffDialog.__appendText</h4>
115 <b>__appendText</b>(<i>txt, format</i>)
116 <p>
117 Private method to append text to the end of the contents pane.
118 </p><dl>
119 <dt><i>txt</i></dt>
120 <dd>
121 text to insert (string)
122 </dd><dt><i>format</i></dt>
123 <dd>
124 text format to be used (QTextCharFormat)
125 </dd>
126 </dl><a NAME="HgDiffDialog.__getVersionArg" ID="HgDiffDialog.__getVersionArg"></a>
127 <h4>HgDiffDialog.__getVersionArg</h4>
128 <b>__getVersionArg</b>(<i>version</i>)
129 <p>
130 Private method to get a hg revision argument for the given revision.
131 </p><dl>
132 <dt><i>version</i></dt>
133 <dd>
134 revision (integer or string)
135 </dd>
136 </dl><dl>
137 <dt>Returns:</dt>
138 <dd>
139 version argument (string)
140 </dd>
141 </dl><a NAME="HgDiffDialog.__procFinished" ID="HgDiffDialog.__procFinished"></a>
142 <h4>HgDiffDialog.__procFinished</h4>
143 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
144 <p>
145 Private slot connected to the finished signal.
146 </p><dl>
147 <dt><i>exitCode</i></dt>
148 <dd>
149 exit code of the process (integer)
150 </dd><dt><i>exitStatus</i></dt>
151 <dd>
152 exit status of the process (QProcess.ExitStatus)
153 </dd>
154 </dl><a NAME="HgDiffDialog.__readStderr" ID="HgDiffDialog.__readStderr"></a>
155 <h4>HgDiffDialog.__readStderr</h4>
156 <b>__readStderr</b>(<i></i>)
157 <p>
158 Private slot to handle the readyReadStandardError signal.
159 </p><p>
160 It reads the error output of the process and inserts it into the
161 error pane.
162 </p><a NAME="HgDiffDialog.__readStdout" ID="HgDiffDialog.__readStdout"></a>
163 <h4>HgDiffDialog.__readStdout</h4>
164 <b>__readStdout</b>(<i></i>)
165 <p>
166 Private slot to handle the readyReadStandardOutput signal.
167 </p><p>
168 It reads the output of the process, formats it and inserts it into
169 the contents pane.
170 </p><a NAME="HgDiffDialog.closeEvent" ID="HgDiffDialog.closeEvent"></a>
171 <h4>HgDiffDialog.closeEvent</h4>
172 <b>closeEvent</b>(<i>e</i>)
173 <p>
174 Private slot implementing a close event handler.
175 </p><dl>
176 <dt><i>e</i></dt>
177 <dd>
178 close event (QCloseEvent)
179 </dd>
180 </dl><a NAME="HgDiffDialog.keyPressEvent" ID="HgDiffDialog.keyPressEvent"></a>
181 <h4>HgDiffDialog.keyPressEvent</h4>
182 <b>keyPressEvent</b>(<i>evt</i>)
183 <p>
184 Protected slot to handle a key press event.
185 </p><dl>
186 <dt><i>evt</i></dt>
187 <dd>
188 the key press event (QKeyEvent)
189 </dd>
190 </dl><a NAME="HgDiffDialog.on_buttonBox_clicked" ID="HgDiffDialog.on_buttonBox_clicked"></a>
191 <h4>HgDiffDialog.on_buttonBox_clicked</h4>
192 <b>on_buttonBox_clicked</b>(<i>button</i>)
193 <p>
194 Private slot called by a button of the button box clicked.
195 </p><dl>
196 <dt><i>button</i></dt>
197 <dd>
198 button that was clicked (QAbstractButton)
199 </dd>
200 </dl><a NAME="HgDiffDialog.on_input_returnPressed" ID="HgDiffDialog.on_input_returnPressed"></a>
201 <h4>HgDiffDialog.on_input_returnPressed</h4>
202 <b>on_input_returnPressed</b>(<i></i>)
203 <p>
204 Private slot to handle the press of the return key in the input field.
205 </p><a NAME="HgDiffDialog.on_passwordCheckBox_toggled" ID="HgDiffDialog.on_passwordCheckBox_toggled"></a>
206 <h4>HgDiffDialog.on_passwordCheckBox_toggled</h4>
207 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
208 <p>
209 Private slot to handle the password checkbox toggled.
210 </p><dl>
211 <dt><i>isOn</i></dt>
212 <dd>
213 flag indicating the status of the check box (boolean)
214 </dd>
215 </dl><a NAME="HgDiffDialog.on_saveButton_clicked" ID="HgDiffDialog.on_saveButton_clicked"></a>
216 <h4>HgDiffDialog.on_saveButton_clicked</h4>
217 <b>on_saveButton_clicked</b>(<i></i>)
218 <p>
219 Private slot to handle the Save button press.
220 </p><p>
221 It saves the diff shown in the dialog to a file in the local
222 filesystem.
223 </p><a NAME="HgDiffDialog.on_sendButton_clicked" ID="HgDiffDialog.on_sendButton_clicked"></a>
224 <h4>HgDiffDialog.on_sendButton_clicked</h4>
225 <b>on_sendButton_clicked</b>(<i></i>)
226 <p>
227 Private slot to send the input to the subversion process.
228 </p><a NAME="HgDiffDialog.start" ID="HgDiffDialog.start"></a>
229 <h4>HgDiffDialog.start</h4>
230 <b>start</b>(<i>fn, versions = None</i>)
231 <p>
232 Public slot to start the hg diff command.
233 </p><dl>
234 <dt><i>fn</i></dt>
235 <dd>
236 filename to be diffed (string)
237 </dd><dt><i>versions</i></dt>
238 <dd>
239 list of versions to be diffed (list of up to 2 strings or None)
240 </dd>
241 </dl>
242 <div align="right"><a href="#top">Up</a></div>
243 <hr />
244 </body></html>

Mercurial Repository: eric

eric ide

mercurial