src/eric7/Documentation/Source/eric7.UI.CompareDialog.html

branch
eric7
changeset 10433
328f3ec4b77a
parent 10303
ee1aadab1215
child 10479
856476537696
equal deleted inserted replaced
10432:2fe91fe443dd 10433:328f3ec4b77a
146 <p> 146 <p>
147 Constructor 147 Constructor
148 </p> 148 </p>
149 <dl> 149 <dl>
150 150
151 <dt><i>files</i> (list of two tuples of (str, str))</dt> 151 <dt><i>files</i> (list of tuples of (str, str))</dt>
152 <dd> 152 <dd>
153 list of files to compare and their label 153 list of files to compare and their label
154 </dd> 154 </dd>
155 <dt><i>parent</i> (QWidget)</dt> 155 <dt><i>parent</i> (QWidget)</dt>
156 <dd> 156 <dd>
164 <p> 164 <p>
165 Private method to append text to the end of the contents pane. 165 Private method to append text to the end of the contents pane.
166 </p> 166 </p>
167 <dl> 167 <dl>
168 168
169 <dt><i>pane</i></dt> 169 <dt><i>pane</i> (QTextedit)</dt>
170 <dd> 170 <dd>
171 text edit widget to append text to (QTextedit) 171 text edit widget to append text to
172 </dd> 172 </dd>
173 <dt><i>linenumber</i></dt> 173 <dt><i>linenumber</i> (str)</dt>
174 <dd> 174 <dd>
175 number of line to insert (string) 175 number of line to insert
176 </dd> 176 </dd>
177 <dt><i>line</i></dt> 177 <dt><i>line</i> (str)</dt>
178 <dd> 178 <dd>
179 text to insert (string) 179 text to insert
180 </dd> 180 </dd>
181 <dt><i>charFormat</i></dt> 181 <dt><i>charFormat</i> (QTextCharFormat)</dt>
182 <dd> 182 <dd>
183 text format to be used (QTextCharFormat) 183 text format to be used
184 </dd> 184 </dd>
185 <dt><i>interLine</i></dt> 185 <dt><i>interLine</i> (bool)</dt>
186 <dd> 186 <dd>
187 flag indicating interline changes (boolean) 187 flag indicating interline changes
188 </dd> 188 </dd>
189 </dl> 189 </dl>
190 <a NAME="CompareDialog.__compare" ID="CompareDialog.__compare"></a> 190 <a NAME="CompareDialog.__compare" ID="CompareDialog.__compare"></a>
191 <h4>CompareDialog.__compare</h4> 191 <h4>CompareDialog.__compare</h4>
192 <b>__compare</b>(<i>lines1, lines2</i>) 192 <b>__compare</b>(<i>lines1, lines2</i>)
194 <p> 194 <p>
195 Private method to compare two lists of text. 195 Private method to compare two lists of text.
196 </p> 196 </p>
197 <dl> 197 <dl>
198 198
199 <dt><i>lines1</i></dt> 199 <dt><i>lines1</i> (list of str)</dt>
200 <dd> 200 <dd>
201 text to compare against (list of strings) 201 text to compare against
202 </dd> 202 </dd>
203 <dt><i>lines2</i></dt> 203 <dt><i>lines2</i> (list of str)</dt>
204 <dd> 204 <dd>
205 text to compare (list of strings) 205 text to compare
206 </dd> 206 </dd>
207 </dl> 207 </dl>
208 <a NAME="CompareDialog.__fileChanged" ID="CompareDialog.__fileChanged"></a> 208 <a NAME="CompareDialog.__fileChanged" ID="CompareDialog.__fileChanged"></a>
209 <h4>CompareDialog.__fileChanged</h4> 209 <h4>CompareDialog.__fileChanged</h4>
210 <b>__fileChanged</b>(<i></i>) 210 <b>__fileChanged</b>(<i></i>)
234 Private slot to enable the buttons and set the current diff position 234 Private slot to enable the buttons and set the current diff position
235 depending on scrollbar position. 235 depending on scrollbar position.
236 </p> 236 </p>
237 <dl> 237 <dl>
238 238
239 <dt><i>value</i></dt> 239 <dt><i>value</i> (int)</dt>
240 <dd> 240 <dd>
241 scrollbar position (integer) 241 scrollbar position
242 </dd> 242 </dd>
243 </dl> 243 </dl>
244 <a NAME="CompareDialog.compare" ID="CompareDialog.compare"></a> 244 <a NAME="CompareDialog.compare" ID="CompareDialog.compare"></a>
245 <h4>CompareDialog.compare</h4> 245 <h4>CompareDialog.compare</h4>
246 <b>compare</b>(<i>lines1, lines2, name1="", name2=""</i>) 246 <b>compare</b>(<i>lines1, lines2, name1="", name2=""</i>)
248 <p> 248 <p>
249 Public method to compare two lists of text. 249 Public method to compare two lists of text.
250 </p> 250 </p>
251 <dl> 251 <dl>
252 252
253 <dt><i>lines1</i></dt> 253 <dt><i>lines1</i> (str or list of str)</dt>
254 <dd> 254 <dd>
255 text to compare against (string or list of strings) 255 text to compare against
256 </dd> 256 </dd>
257 <dt><i>lines2</i></dt> 257 <dt><i>lines2</i> (str or list of str))</dt>
258 <dd> 258 <dd>
259 text to compare (string or list of strings) 259 text to compare
260 </dd> 260 </dd>
261 <dt><i>name1</i></dt> 261 <dt><i>name1</i> (str)</dt>
262 <dd> 262 <dd>
263 name to be shown for the first text (string) 263 name to be shown for the first text
264 </dd> 264 </dd>
265 <dt><i>name2</i></dt> 265 <dt><i>name2</i> (str)</dt>
266 <dd> 266 <dd>
267 name to be shown for the second text (string) 267 name to be shown for the second text
268 </dd> 268 </dd>
269 </dl> 269 </dl>
270 <a NAME="CompareDialog.on_buttonBox_clicked" ID="CompareDialog.on_buttonBox_clicked"></a> 270 <a NAME="CompareDialog.on_buttonBox_clicked" ID="CompareDialog.on_buttonBox_clicked"></a>
271 <h4>CompareDialog.on_buttonBox_clicked</h4> 271 <h4>CompareDialog.on_buttonBox_clicked</h4>
272 <b>on_buttonBox_clicked</b>(<i>button</i>) 272 <b>on_buttonBox_clicked</b>(<i>button</i>)
274 <p> 274 <p>
275 Private slot called by a button of the button box clicked. 275 Private slot called by a button of the button box clicked.
276 </p> 276 </p>
277 <dl> 277 <dl>
278 278
279 <dt><i>button</i></dt> 279 <dt><i>button</i> (QAbstractButton)</dt>
280 <dd> 280 <dd>
281 button that was clicked (QAbstractButton) 281 button that was clicked
282 </dd> 282 </dd>
283 </dl> 283 </dl>
284 <a NAME="CompareDialog.on_diffButton_clicked" ID="CompareDialog.on_diffButton_clicked"></a> 284 <a NAME="CompareDialog.on_diffButton_clicked" ID="CompareDialog.on_diffButton_clicked"></a>
285 <h4>CompareDialog.on_diffButton_clicked</h4> 285 <h4>CompareDialog.on_diffButton_clicked</h4>
286 <b>on_diffButton_clicked</b>(<i></i>) 286 <b>on_diffButton_clicked</b>(<i></i>)
316 <p> 316 <p>
317 Private slot to connect or disconnect the scrollbars of the displays. 317 Private slot to connect or disconnect the scrollbars of the displays.
318 </p> 318 </p>
319 <dl> 319 <dl>
320 320
321 <dt><i>sync</i></dt> 321 <dt><i>sync</i> (bool)</dt>
322 <dd> 322 <dd>
323 flag indicating synchronisation status (boolean) 323 flag indicating synchronisation status
324 </dd> 324 </dd>
325 </dl> 325 </dl>
326 <a NAME="CompareDialog.on_upButton_clicked" ID="CompareDialog.on_upButton_clicked"></a> 326 <a NAME="CompareDialog.on_upButton_clicked" ID="CompareDialog.on_upButton_clicked"></a>
327 <h4>CompareDialog.on_upButton_clicked</h4> 327 <h4>CompareDialog.on_upButton_clicked</h4>
328 <b>on_upButton_clicked</b>(<i></i>) 328 <b>on_upButton_clicked</b>(<i></i>)
337 <p> 337 <p>
338 Public slot to show the dialog. 338 Public slot to show the dialog.
339 </p> 339 </p>
340 <dl> 340 <dl>
341 341
342 <dt><i>filename</i></dt> 342 <dt><i>filename</i> (str)</dt>
343 <dd> 343 <dd>
344 name of a file to use as the first file (string) 344 name of a file to use as the first file
345 </dd> 345 </dd>
346 </dl> 346 </dl>
347 <div align="right"><a href="#top">Up</a></div> 347 <div align="right"><a href="#top">Up</a></div>
348 <hr /> 348 <hr />
349 <hr /> 349 <hr />
391 <p> 391 <p>
392 Constructor 392 Constructor
393 </p> 393 </p>
394 <dl> 394 <dl>
395 395
396 <dt><i>files</i></dt> 396 <dt><i>files</i> (list of [(str, str), (str, str)])</dt>
397 <dd> 397 <dd>
398 list of files to compare and their label 398 list of files to compare and their label
399 (list of two tuples of two strings) 399 </dd>
400 </dd> 400 <dt><i>parent</i> (QWidget)</dt>
401 <dt><i>parent</i></dt> 401 <dd>
402 <dd> 402 reference to the parent widget
403 reference to the parent widget (QWidget)
404 </dd> 403 </dd>
405 </dl> 404 </dl>
406 <a NAME="CompareWindow.eventFilter" ID="CompareWindow.eventFilter"></a> 405 <a NAME="CompareWindow.eventFilter" ID="CompareWindow.eventFilter"></a>
407 <h4>CompareWindow.eventFilter</h4> 406 <h4>CompareWindow.eventFilter</h4>
408 <b>eventFilter</b>(<i>obj, event</i>) 407 <b>eventFilter</b>(<i>obj, event</i>)
410 <p> 409 <p>
411 Public method to filter events. 410 Public method to filter events.
412 </p> 411 </p>
413 <dl> 412 <dl>
414 413
415 <dt><i>obj</i></dt> 414 <dt><i>obj</i> (QObject)</dt>
416 <dd> 415 <dd>
417 reference to the object the event is meant for (QObject) 416 reference to the object the event is meant for
418 </dd> 417 </dd>
419 <dt><i>event</i></dt> 418 <dt><i>event</i> (QEvent)</dt>
420 <dd> 419 <dd>
421 reference to the event object (QEvent) 420 reference to the event object
422 </dd> 421 </dd>
423 </dl> 422 </dl>
424 <dl> 423 <dl>
425 <dt>Return:</dt> 424 <dt>Return:</dt>
426 <dd> 425 <dd>
427 flag indicating, whether the event was handled (boolean) 426 flag indicating, whether the event was handled
427 </dd>
428 </dl>
429 <dl>
430 <dt>Return Type:</dt>
431 <dd>
432 bool
428 </dd> 433 </dd>
429 </dl> 434 </dl>
430 <div align="right"><a href="#top">Up</a></div> 435 <div align="right"><a href="#top">Up</a></div>
431 <hr /> 436 <hr />
432 <hr /> 437 <hr />
437 <p> 442 <p>
438 Internal function to remove all diff markers. 443 Internal function to remove all diff markers.
439 </p> 444 </p>
440 <dl> 445 <dl>
441 446
442 <dt><i>line</i></dt> 447 <dt><i>line</i> (str)</dt>
443 <dd> 448 <dd>
444 line to work on (string) 449 line to work on
445 </dd> 450 </dd>
446 </dl> 451 </dl>
447 <dl> 452 <dl>
448 <dt>Return:</dt> 453 <dt>Return:</dt>
449 <dd> 454 <dd>
450 line without diff markers (string) 455 line without diff markers
456 </dd>
457 </dl>
458 <dl>
459 <dt>Return Type:</dt>
460 <dd>
461 str
451 </dd> 462 </dd>
452 </dl> 463 </dl>
453 <div align="right"><a href="#top">Up</a></div> 464 <div align="right"><a href="#top">Up</a></div>
454 <hr /> 465 <hr />
455 <hr /> 466 <hr />
461 Compare two sequences of lines; generate the delta for display side by 472 Compare two sequences of lines; generate the delta for display side by
462 side. 473 side.
463 </p> 474 </p>
464 <dl> 475 <dl>
465 476
466 <dt><i>a</i></dt> 477 <dt><i>a</i> (list of str)</dt>
467 <dd> 478 <dd>
468 first sequence of lines (list of strings) 479 first sequence of lines
469 </dd> 480 </dd>
470 <dt><i>b</i></dt> 481 <dt><i>b</i> (list of str)</dt>
471 <dd> 482 <dd>
472 second sequence of lines (list of strings) 483 second sequence of lines
473 </dd> 484 </dd>
474 <dt><i>linenumberwidth</i></dt> 485 <dt><i>linenumberwidth</i> (int)</dt>
475 <dd> 486 <dd>
476 width (in characters) of the linenumbers (integer) 487 width (in characters) of the linenumbers
477 </dd> 488 </dd>
478 </dl> 489 </dl>
479 <dl> 490 <dl>
480 <dt>Yield:</dt> 491 <dt>Yield:</dt>
481 <dd> 492 <dd>

eric ide

mercurial