src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffGenerator.html

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffGenerator</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffGenerator</h1>
10
11 <p> 10 <p>
12 Module implementing a class to generate the output of the hg diff command. 11 Module implementing a class to generate the output of the hg diff command.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#HgDiffGenerator">HgDiffGenerator</a></td> 22 <td><a href="#HgDiffGenerator">HgDiffGenerator</a></td>
25 <td>Class implementing the generation of output of the hg diff command.</td> 23 <td>Class implementing the generation of output of the hg diff command.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="HgDiffGenerator" ID="HgDiffGenerator"></a> 34 <a NAME="HgDiffGenerator" ID="HgDiffGenerator"></a>
36 <h2>HgDiffGenerator</h2> 35 <h2>HgDiffGenerator</h2>
37
38 <p> 36 <p>
39 Class implementing the generation of output of the hg diff command. 37 Class implementing the generation of output of the hg diff command.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>finished()</dt> 43 <dt>finished()</dt>
45 <dd> 44 <dd>
47 </dd> 46 </dd>
48 </dl> 47 </dl>
49 <h3>Derived from</h3> 48 <h3>Derived from</h3>
50 QObject 49 QObject
51 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
52 51 <table>
53 <table> 52 <tr><td>None</td></tr>
54 <tr><td>None</td></tr> 53 </table>
55 </table> 54
56 <h3>Class Methods</h3> 55 <h3>Class Methods</h3>
57 56 <table>
58 <table> 57 <tr><td>None</td></tr>
59 <tr><td>None</td></tr> 58 </table>
60 </table> 59
61 <h3>Methods</h3> 60 <h3>Methods</h3>
62 61 <table>
63 <table>
64
65 <tr> 62 <tr>
66 <td><a href="#HgDiffGenerator.__init__">HgDiffGenerator</a></td> 63 <td><a href="#HgDiffGenerator.__init__">HgDiffGenerator</a></td>
67 <td>Constructor</td> 64 <td>Constructor</td>
68 </tr> 65 </tr>
69 <tr> 66 <tr>
93 <tr> 90 <tr>
94 <td><a href="#HgDiffGenerator.stopProcess">stopProcess</a></td> 91 <td><a href="#HgDiffGenerator.stopProcess">stopProcess</a></td>
95 <td>Public slot to stop the diff process.</td> 92 <td>Public slot to stop the diff process.</td>
96 </tr> 93 </tr>
97 </table> 94 </table>
95
98 <h3>Static Methods</h3> 96 <h3>Static Methods</h3>
99 97 <table>
100 <table> 98 <tr><td>None</td></tr>
101 <tr><td>None</td></tr> 99 </table>
102 </table> 100
103 101
104 <a NAME="HgDiffGenerator.__init__" ID="HgDiffGenerator.__init__"></a> 102 <a NAME="HgDiffGenerator.__init__" ID="HgDiffGenerator.__init__"></a>
105 <h4>HgDiffGenerator (Constructor)</h4> 103 <h4>HgDiffGenerator (Constructor)</h4>
106 <b>HgDiffGenerator</b>(<i>vcs, parent=None</i>) 104 <b>HgDiffGenerator</b>(<i>vcs, parent=None</i>)
107
108 <p> 105 <p>
109 Constructor 106 Constructor
110 </p> 107 </p>
108
111 <dl> 109 <dl>
112 110
113 <dt><i>vcs</i> (Hg)</dt> 111 <dt><i>vcs</i> (Hg)</dt>
114 <dd> 112 <dd>
115 reference to the vcs object 113 reference to the vcs object
120 </dd> 118 </dd>
121 </dl> 119 </dl>
122 <a NAME="HgDiffGenerator.__extractFileName" ID="HgDiffGenerator.__extractFileName"></a> 120 <a NAME="HgDiffGenerator.__extractFileName" ID="HgDiffGenerator.__extractFileName"></a>
123 <h4>HgDiffGenerator.__extractFileName</h4> 121 <h4>HgDiffGenerator.__extractFileName</h4>
124 <b>__extractFileName</b>(<i>line</i>) 122 <b>__extractFileName</b>(<i>line</i>)
125
126 <p> 123 <p>
127 Private method to extract the file name out of a file separator line. 124 Private method to extract the file name out of a file separator line.
128 </p> 125 </p>
126
129 <dl> 127 <dl>
130 128
131 <dt><i>line</i> (str)</dt> 129 <dt><i>line</i> (str)</dt>
132 <dd> 130 <dd>
133 line to be processed 131 line to be processed
146 </dd> 144 </dd>
147 </dl> 145 </dl>
148 <a NAME="HgDiffGenerator.__finish" ID="HgDiffGenerator.__finish"></a> 146 <a NAME="HgDiffGenerator.__finish" ID="HgDiffGenerator.__finish"></a>
149 <h4>HgDiffGenerator.__finish</h4> 147 <h4>HgDiffGenerator.__finish</h4>
150 <b>__finish</b>(<i></i>) 148 <b>__finish</b>(<i></i>)
151
152 <p> 149 <p>
153 Private slot called when the process finished or the user pressed 150 Private slot called when the process finished or the user pressed
154 the button. 151 the button.
155 </p> 152 </p>
153
156 <a NAME="HgDiffGenerator.__getVersionArg" ID="HgDiffGenerator.__getVersionArg"></a> 154 <a NAME="HgDiffGenerator.__getVersionArg" ID="HgDiffGenerator.__getVersionArg"></a>
157 <h4>HgDiffGenerator.__getVersionArg</h4> 155 <h4>HgDiffGenerator.__getVersionArg</h4>
158 <b>__getVersionArg</b>(<i>version</i>) 156 <b>__getVersionArg</b>(<i>version</i>)
159
160 <p> 157 <p>
161 Private method to get a hg revision argument for the given revision. 158 Private method to get a hg revision argument for the given revision.
162 </p> 159 </p>
160
163 <dl> 161 <dl>
164 162
165 <dt><i>version</i> (int or str)</dt> 163 <dt><i>version</i> (int or str)</dt>
166 <dd> 164 <dd>
167 revision 165 revision
180 </dd> 178 </dd>
181 </dl> 179 </dl>
182 <a NAME="HgDiffGenerator.__processFileLine" ID="HgDiffGenerator.__processFileLine"></a> 180 <a NAME="HgDiffGenerator.__processFileLine" ID="HgDiffGenerator.__processFileLine"></a>
183 <h4>HgDiffGenerator.__processFileLine</h4> 181 <h4>HgDiffGenerator.__processFileLine</h4>
184 <b>__processFileLine</b>(<i>lineno, line</i>) 182 <b>__processFileLine</b>(<i>lineno, line</i>)
185
186 <p> 183 <p>
187 Private slot to process a line giving the old/new file. 184 Private slot to process a line giving the old/new file.
188 </p> 185 </p>
186
189 <dl> 187 <dl>
190 188
191 <dt><i>lineno</i> (int)</dt> 189 <dt><i>lineno</i> (int)</dt>
192 <dd> 190 <dd>
193 line number of line to be processed 191 line number of line to be processed
198 </dd> 196 </dd>
199 </dl> 197 </dl>
200 <a NAME="HgDiffGenerator.getResult" ID="HgDiffGenerator.getResult"></a> 198 <a NAME="HgDiffGenerator.getResult" ID="HgDiffGenerator.getResult"></a>
201 <h4>HgDiffGenerator.getResult</h4> 199 <h4>HgDiffGenerator.getResult</h4>
202 <b>getResult</b>(<i></i>) 200 <b>getResult</b>(<i></i>)
203
204 <p> 201 <p>
205 Public method to return the result data. 202 Public method to return the result data.
206 </p> 203 </p>
204
207 <dl> 205 <dl>
208 <dt>Return:</dt> 206 <dt>Return:</dt>
209 <dd> 207 <dd>
210 tuple containing a list of lines of the diff, a list of errors 208 tuple containing a list of lines of the diff, a list of errors
211 and a list of tuples of filenames and the line into the diff output 209 and a list of tuples of filenames and the line into the diff output
218 </dd> 216 </dd>
219 </dl> 217 </dl>
220 <a NAME="HgDiffGenerator.start" ID="HgDiffGenerator.start"></a> 218 <a NAME="HgDiffGenerator.start" ID="HgDiffGenerator.start"></a>
221 <h4>HgDiffGenerator.start</h4> 219 <h4>HgDiffGenerator.start</h4>
222 <b>start</b>(<i>fn, versions=None, bundle=None, qdiff=False</i>) 220 <b>start</b>(<i>fn, versions=None, bundle=None, qdiff=False</i>)
223
224 <p> 221 <p>
225 Public slot to start the hg diff command. 222 Public slot to start the hg diff command.
226 </p> 223 </p>
224
227 <dl> 225 <dl>
228 226
229 <dt><i>fn</i> (str)</dt> 227 <dt><i>fn</i> (str)</dt>
230 <dd> 228 <dd>
231 filename to be diffed 229 filename to be diffed
256 </dd> 254 </dd>
257 </dl> 255 </dl>
258 <a NAME="HgDiffGenerator.stopProcess" ID="HgDiffGenerator.stopProcess"></a> 256 <a NAME="HgDiffGenerator.stopProcess" ID="HgDiffGenerator.stopProcess"></a>
259 <h4>HgDiffGenerator.stopProcess</h4> 257 <h4>HgDiffGenerator.stopProcess</h4>
260 <b>stopProcess</b>(<i></i>) 258 <b>stopProcess</b>(<i></i>)
261
262 <p> 259 <p>
263 Public slot to stop the diff process. 260 Public slot to stop the diff process.
264 </p> 261 </p>
262
265 <div align="right"><a href="#top">Up</a></div> 263 <div align="right"><a href="#top">Up</a></div>
266 <hr /> 264 <hr />
267 </body></html> 265 </body></html>

eric ide

mercurial