|
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.vcsPySvn.SvnDiffDialog</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.Plugins.VcsPlugins.vcsPySvn.SvnDiffDialog</h1> |
|
12 <p> |
|
13 Module implementing a dialog to show the output of the svn diff command process. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#SvnDiffDialog">SvnDiffDialog</a></td> |
|
23 <td>Class implementing a dialog to show the output of the svn diff command.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="SvnDiffDialog" ID="SvnDiffDialog"></a> |
|
32 <h2>SvnDiffDialog</h2> |
|
33 <p> |
|
34 Class implementing a dialog to show the output of the svn diff command. |
|
35 </p> |
|
36 <h3>Derived from</h3> |
|
37 QWidget, SvnDialogMixin, Ui_SvnDiffDialog |
|
38 <h3>Class Attributes</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <h3>Methods</h3> |
|
43 <table> |
|
44 <tr> |
|
45 <td><a href="#SvnDiffDialog.__init__">SvnDiffDialog</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#SvnDiffDialog.__appendText">__appendText</a></td> |
|
49 <td>Private method to append text to the end of the contents pane.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#SvnDiffDialog.__finish">__finish</a></td> |
|
52 <td>Private slot called when the user pressed the button.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#SvnDiffDialog.__getDiffSummaryKind">__getDiffSummaryKind</a></td> |
|
55 <td>Private method to get a string descripion of the diff summary.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#SvnDiffDialog.__getVersionArg">__getVersionArg</a></td> |
|
58 <td>Private method to get a pysvn revision object for the given version number.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#SvnDiffDialog.__showError">__showError</a></td> |
|
61 <td>Private slot to show an error message.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#SvnDiffDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
64 <td>Private slot called by a button of the button box clicked.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#SvnDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> |
|
67 <td>Private slot to handle the Save button press.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#SvnDiffDialog.start">start</a></td> |
|
70 <td>Public slot to start the svn diff command.</td> |
|
71 </tr> |
|
72 </table> |
|
73 <a NAME="SvnDiffDialog.__init__" ID="SvnDiffDialog.__init__"></a> |
|
74 <h4>SvnDiffDialog (Constructor)</h4> |
|
75 <b>SvnDiffDialog</b>(<i>vcs, parent = None</i>) |
|
76 <p> |
|
77 Constructor |
|
78 </p><dl> |
|
79 <dt><i>vcs</i></dt> |
|
80 <dd> |
|
81 reference to the vcs object |
|
82 </dd><dt><i>parent</i></dt> |
|
83 <dd> |
|
84 parent widget (QWidget) |
|
85 </dd> |
|
86 </dl><a NAME="SvnDiffDialog.__appendText" ID="SvnDiffDialog.__appendText"></a> |
|
87 <h4>SvnDiffDialog.__appendText</h4> |
|
88 <b>__appendText</b>(<i>line</i>) |
|
89 <p> |
|
90 Private method to append text to the end of the contents pane. |
|
91 </p><dl> |
|
92 <dt><i>line</i></dt> |
|
93 <dd> |
|
94 line of text to insert (string) |
|
95 </dd> |
|
96 </dl><a NAME="SvnDiffDialog.__finish" ID="SvnDiffDialog.__finish"></a> |
|
97 <h4>SvnDiffDialog.__finish</h4> |
|
98 <b>__finish</b>(<i></i>) |
|
99 <p> |
|
100 Private slot called when the user pressed the button. |
|
101 </p><a NAME="SvnDiffDialog.__getDiffSummaryKind" ID="SvnDiffDialog.__getDiffSummaryKind"></a> |
|
102 <h4>SvnDiffDialog.__getDiffSummaryKind</h4> |
|
103 <b>__getDiffSummaryKind</b>(<i>summaryKind</i>) |
|
104 <p> |
|
105 Private method to get a string descripion of the diff summary. |
|
106 </p><dl> |
|
107 <dt><i>summaryKind</i></dt> |
|
108 <dd> |
|
109 (pysvn.diff_summarize.summarize_kind) |
|
110 </dd> |
|
111 </dl><dl> |
|
112 <dt>Returns:</dt> |
|
113 <dd> |
|
114 one letter string indicating the change type (string) |
|
115 </dd> |
|
116 </dl><a NAME="SvnDiffDialog.__getVersionArg" ID="SvnDiffDialog.__getVersionArg"></a> |
|
117 <h4>SvnDiffDialog.__getVersionArg</h4> |
|
118 <b>__getVersionArg</b>(<i>version</i>) |
|
119 <p> |
|
120 Private method to get a pysvn revision object for the given version number. |
|
121 </p><dl> |
|
122 <dt><i>version</i></dt> |
|
123 <dd> |
|
124 revision (integer or string) |
|
125 </dd> |
|
126 </dl><dl> |
|
127 <dt>Returns:</dt> |
|
128 <dd> |
|
129 revision object (pysvn.Revision) |
|
130 </dd> |
|
131 </dl><a NAME="SvnDiffDialog.__showError" ID="SvnDiffDialog.__showError"></a> |
|
132 <h4>SvnDiffDialog.__showError</h4> |
|
133 <b>__showError</b>(<i>msg</i>) |
|
134 <p> |
|
135 Private slot to show an error message. |
|
136 </p><dl> |
|
137 <dt><i>msg</i></dt> |
|
138 <dd> |
|
139 error message to show (string) |
|
140 </dd> |
|
141 </dl><a NAME="SvnDiffDialog.on_buttonBox_clicked" ID="SvnDiffDialog.on_buttonBox_clicked"></a> |
|
142 <h4>SvnDiffDialog.on_buttonBox_clicked</h4> |
|
143 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
144 <p> |
|
145 Private slot called by a button of the button box clicked. |
|
146 </p><dl> |
|
147 <dt><i>button</i></dt> |
|
148 <dd> |
|
149 button that was clicked (QAbstractButton) |
|
150 </dd> |
|
151 </dl><a NAME="SvnDiffDialog.on_saveButton_clicked" ID="SvnDiffDialog.on_saveButton_clicked"></a> |
|
152 <h4>SvnDiffDialog.on_saveButton_clicked</h4> |
|
153 <b>on_saveButton_clicked</b>(<i></i>) |
|
154 <p> |
|
155 Private slot to handle the Save button press. |
|
156 </p><p> |
|
157 It saves the diff shown in the dialog to a file in the local |
|
158 filesystem. |
|
159 </p><a NAME="SvnDiffDialog.start" ID="SvnDiffDialog.start"></a> |
|
160 <h4>SvnDiffDialog.start</h4> |
|
161 <b>start</b>(<i>fn, versions = None, urls = None, summary = False, pegRev = None</i>) |
|
162 <p> |
|
163 Public slot to start the svn diff command. |
|
164 </p><dl> |
|
165 <dt><i>fn</i></dt> |
|
166 <dd> |
|
167 filename to be diffed (string) |
|
168 </dd><dt><i>versions</i></dt> |
|
169 <dd> |
|
170 list of versions to be diffed (list of up to 2 integer or None) |
|
171 </dd><dt><i>urls=</i></dt> |
|
172 <dd> |
|
173 list of repository URLs (list of 2 strings) |
|
174 </dd><dt><i>summary=</i></dt> |
|
175 <dd> |
|
176 flag indicating a summarizing diff |
|
177 (only valid for URL diffs) (boolean) |
|
178 </dd><dt><i>pegRev=</i></dt> |
|
179 <dd> |
|
180 revision number the filename is valid (integer) |
|
181 </dd> |
|
182 </dl> |
|
183 <div align="right"><a href="#top">Up</a></div> |
|
184 <hr /> |
|
185 </body></html> |