Documentation/Source/eric6.Plugins.VcsPlugins.vcsPySvn.SvnDiffDialog.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.vcsPySvn.SvnDiffDialog</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.vcsPySvn.SvnDiffDialog</h1>
23 <p>
24 Module implementing a dialog to show the output of the svn diff command
25 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="#SvnDiffDialog">SvnDiffDialog</a></td>
35 <td>Class implementing a dialog to show the output of the svn diff command.</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="SvnDiffDialog" ID="SvnDiffDialog"></a>
44 <h2>SvnDiffDialog</h2>
45 <p>
46 Class implementing a dialog to show the output of the svn diff command.
47 </p>
48 <h3>Derived from</h3>
49 QWidget, SvnDialogMixin, Ui_SvnDiffDialog
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="#SvnDiffDialog.__init__">SvnDiffDialog</a></td>
62 <td>Constructor</td>
63 </tr><tr>
64 <td><a href="#SvnDiffDialog.__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="#SvnDiffDialog.__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="#SvnDiffDialog.__finish">__finish</a></td>
71 <td>Private slot called when the user pressed the button.</td>
72 </tr><tr>
73 <td><a href="#SvnDiffDialog.__getDiffSummaryKind">__getDiffSummaryKind</a></td>
74 <td>Private method to get a string descripion of the diff summary.</td>
75 </tr><tr>
76 <td><a href="#SvnDiffDialog.__getVersionArg">__getVersionArg</a></td>
77 <td>Private method to get a pysvn revision object for the given version number.</td>
78 </tr><tr>
79 <td><a href="#SvnDiffDialog.__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="#SvnDiffDialog.__showError">__showError</a></td>
83 <td>Private slot to show an error message.</td>
84 </tr><tr>
85 <td><a href="#SvnDiffDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
86 <td>Private slot called by a button of the button box clicked.</td>
87 </tr><tr>
88 <td><a href="#SvnDiffDialog.on_filesCombo_activated">on_filesCombo_activated</a></td>
89 <td>Private slot to handle the selection of a file.</td>
90 </tr><tr>
91 <td><a href="#SvnDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td>
92 <td>Private slot to handle the Save button press.</td>
93 </tr><tr>
94 <td><a href="#SvnDiffDialog.start">start</a></td>
95 <td>Public slot to start the svn diff command.</td>
96 </tr>
97 </table>
98 <h3>Static Methods</h3>
99 <table>
100 <tr><td>None</td></tr>
101 </table>
102 <a NAME="SvnDiffDialog.__init__" ID="SvnDiffDialog.__init__"></a>
103 <h4>SvnDiffDialog (Constructor)</h4>
104 <b>SvnDiffDialog</b>(<i>vcs, parent=None</i>)
105 <p>
106 Constructor
107 </p><dl>
108 <dt><i>vcs</i></dt>
109 <dd>
110 reference to the vcs object
111 </dd><dt><i>parent</i></dt>
112 <dd>
113 parent widget (QWidget)
114 </dd>
115 </dl><a NAME="SvnDiffDialog.__appendText" ID="SvnDiffDialog.__appendText"></a>
116 <h4>SvnDiffDialog.__appendText</h4>
117 <b>__appendText</b>(<i>line</i>)
118 <p>
119 Private method to append text to the end of the contents pane.
120 </p><dl>
121 <dt><i>line</i></dt>
122 <dd>
123 line of text to insert (string)
124 </dd>
125 </dl><a NAME="SvnDiffDialog.__extractFileName" ID="SvnDiffDialog.__extractFileName"></a>
126 <h4>SvnDiffDialog.__extractFileName</h4>
127 <b>__extractFileName</b>(<i>line</i>)
128 <p>
129 Private method to extract the file name out of a file separator line.
130 </p><dl>
131 <dt><i>line</i></dt>
132 <dd>
133 line to be processed (string)
134 </dd>
135 </dl><dl>
136 <dt>Returns:</dt>
137 <dd>
138 extracted file name (string)
139 </dd>
140 </dl><a NAME="SvnDiffDialog.__finish" ID="SvnDiffDialog.__finish"></a>
141 <h4>SvnDiffDialog.__finish</h4>
142 <b>__finish</b>(<i></i>)
143 <p>
144 Private slot called when the user pressed the button.
145 </p><a NAME="SvnDiffDialog.__getDiffSummaryKind" ID="SvnDiffDialog.__getDiffSummaryKind"></a>
146 <h4>SvnDiffDialog.__getDiffSummaryKind</h4>
147 <b>__getDiffSummaryKind</b>(<i>summaryKind</i>)
148 <p>
149 Private method to get a string descripion of the diff summary.
150 </p><dl>
151 <dt><i>summaryKind</i></dt>
152 <dd>
153 (pysvn.diff_summarize.summarize_kind)
154 </dd>
155 </dl><dl>
156 <dt>Returns:</dt>
157 <dd>
158 one letter string indicating the change type (string)
159 </dd>
160 </dl><a NAME="SvnDiffDialog.__getVersionArg" ID="SvnDiffDialog.__getVersionArg"></a>
161 <h4>SvnDiffDialog.__getVersionArg</h4>
162 <b>__getVersionArg</b>(<i>version</i>)
163 <p>
164 Private method to get a pysvn revision object for the given version
165 number.
166 </p><dl>
167 <dt><i>version</i></dt>
168 <dd>
169 revision (integer or string)
170 </dd>
171 </dl><dl>
172 <dt>Returns:</dt>
173 <dd>
174 revision object (pysvn.Revision)
175 </dd>
176 </dl><a NAME="SvnDiffDialog.__processFileLine" ID="SvnDiffDialog.__processFileLine"></a>
177 <h4>SvnDiffDialog.__processFileLine</h4>
178 <b>__processFileLine</b>(<i>line</i>)
179 <p>
180 Private slot to process a line giving the old/new file.
181 </p><dl>
182 <dt><i>line</i></dt>
183 <dd>
184 line to be processed (string)
185 </dd>
186 </dl><a NAME="SvnDiffDialog.__showError" ID="SvnDiffDialog.__showError"></a>
187 <h4>SvnDiffDialog.__showError</h4>
188 <b>__showError</b>(<i>msg</i>)
189 <p>
190 Private slot to show an error message.
191 </p><dl>
192 <dt><i>msg</i></dt>
193 <dd>
194 error message to show (string)
195 </dd>
196 </dl><a NAME="SvnDiffDialog.on_buttonBox_clicked" ID="SvnDiffDialog.on_buttonBox_clicked"></a>
197 <h4>SvnDiffDialog.on_buttonBox_clicked</h4>
198 <b>on_buttonBox_clicked</b>(<i>button</i>)
199 <p>
200 Private slot called by a button of the button box clicked.
201 </p><dl>
202 <dt><i>button</i></dt>
203 <dd>
204 button that was clicked (QAbstractButton)
205 </dd>
206 </dl><a NAME="SvnDiffDialog.on_filesCombo_activated" ID="SvnDiffDialog.on_filesCombo_activated"></a>
207 <h4>SvnDiffDialog.on_filesCombo_activated</h4>
208 <b>on_filesCombo_activated</b>(<i>index</i>)
209 <p>
210 Private slot to handle the selection of a file.
211 </p><dl>
212 <dt><i>index</i></dt>
213 <dd>
214 activated row (integer)
215 </dd>
216 </dl><a NAME="SvnDiffDialog.on_saveButton_clicked" ID="SvnDiffDialog.on_saveButton_clicked"></a>
217 <h4>SvnDiffDialog.on_saveButton_clicked</h4>
218 <b>on_saveButton_clicked</b>(<i></i>)
219 <p>
220 Private slot to handle the Save button press.
221 </p><p>
222 It saves the diff shown in the dialog to a file in the local
223 filesystem.
224 </p><a NAME="SvnDiffDialog.start" ID="SvnDiffDialog.start"></a>
225 <h4>SvnDiffDialog.start</h4>
226 <b>start</b>(<i>fn, versions=None, urls=None, summary=False, pegRev=None</i>)
227 <p>
228 Public slot to start the svn diff command.
229 </p><dl>
230 <dt><i>fn</i></dt>
231 <dd>
232 filename to be diffed (string)
233 </dd><dt><i>versions</i></dt>
234 <dd>
235 list of versions to be diffed (list of up to 2 integer
236 or None)
237 </dd><dt><i>urls=</i></dt>
238 <dd>
239 list of repository URLs (list of 2 strings)
240 </dd><dt><i>summary=</i></dt>
241 <dd>
242 flag indicating a summarizing diff
243 (only valid for URL diffs) (boolean)
244 </dd><dt><i>pegRev=</i></dt>
245 <dd>
246 revision number the filename is valid (integer)
247 </dd>
248 </dl>
249 <div align="right"><a href="#top">Up</a></div>
250 <hr />
251 </body></html>

eric ide

mercurial