Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsPySvn.SvnDiffDialog.html

eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsPySvn.SvnDiffDialog.html

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

Mercurial Repository: eric

eric ide

mercurial