eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnBlameDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsSubversion.SvnBlameDialog</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Plugins.VcsPlugins.vcsSubversion.SvnBlameDialog</h1>
24
25 <p>
26 Module implementing a dialog to show the output of the svn blame command.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#SvnBlameDialog">SvnBlameDialog</a></td>
39 <td>Class implementing a dialog to show the output of the svn blame command.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="SvnBlameDialog" ID="SvnBlameDialog"></a>
50 <h2>SvnBlameDialog</h2>
51
52 <p>
53 Class implementing a dialog to show the output of the svn blame command.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_SvnBlameDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#SvnBlameDialog.__init__">SvnBlameDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#SvnBlameDialog.__finish">__finish</a></td>
77 <td>Private slot called when the process finished or the user pressed the button.</td>
78 </tr>
79 <tr>
80 <td><a href="#SvnBlameDialog.__generateItem">__generateItem</a></td>
81 <td>Private method to generate a blame item in the blame list.</td>
82 </tr>
83 <tr>
84 <td><a href="#SvnBlameDialog.__procFinished">__procFinished</a></td>
85 <td>Private slot connected to the finished signal.</td>
86 </tr>
87 <tr>
88 <td><a href="#SvnBlameDialog.__readStderr">__readStderr</a></td>
89 <td>Private slot to handle the readyReadStderr signal.</td>
90 </tr>
91 <tr>
92 <td><a href="#SvnBlameDialog.__readStdout">__readStdout</a></td>
93 <td>Private slot to handle the readyReadStdout signal.</td>
94 </tr>
95 <tr>
96 <td><a href="#SvnBlameDialog.__resizeColumns">__resizeColumns</a></td>
97 <td>Private method to resize the list columns.</td>
98 </tr>
99 <tr>
100 <td><a href="#SvnBlameDialog.closeEvent">closeEvent</a></td>
101 <td>Protected slot implementing a close event handler.</td>
102 </tr>
103 <tr>
104 <td><a href="#SvnBlameDialog.keyPressEvent">keyPressEvent</a></td>
105 <td>Protected slot to handle a key press event.</td>
106 </tr>
107 <tr>
108 <td><a href="#SvnBlameDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
109 <td>Private slot called by a button of the button box clicked.</td>
110 </tr>
111 <tr>
112 <td><a href="#SvnBlameDialog.on_input_returnPressed">on_input_returnPressed</a></td>
113 <td>Private slot to handle the press of the return key in the input field.</td>
114 </tr>
115 <tr>
116 <td><a href="#SvnBlameDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
117 <td>Private slot to handle the password checkbox toggled.</td>
118 </tr>
119 <tr>
120 <td><a href="#SvnBlameDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
121 <td>Private slot to send the input to the subversion process.</td>
122 </tr>
123 <tr>
124 <td><a href="#SvnBlameDialog.start">start</a></td>
125 <td>Public slot to start the svn blame command.</td>
126 </tr>
127 </table>
128 <h3>Static Methods</h3>
129
130 <table>
131 <tr><td>None</td></tr>
132 </table>
133
134 <a NAME="SvnBlameDialog.__init__" ID="SvnBlameDialog.__init__"></a>
135 <h4>SvnBlameDialog (Constructor)</h4>
136 <b>SvnBlameDialog</b>(<i>vcs, parent=None</i>)
137
138 <p>
139 Constructor
140 </p>
141 <dl>
142
143 <dt><i>vcs</i></dt>
144 <dd>
145 reference to the vcs object
146 </dd>
147 <dt><i>parent</i></dt>
148 <dd>
149 parent widget (QWidget)
150 </dd>
151 </dl>
152 <a NAME="SvnBlameDialog.__finish" ID="SvnBlameDialog.__finish"></a>
153 <h4>SvnBlameDialog.__finish</h4>
154 <b>__finish</b>(<i></i>)
155
156 <p>
157 Private slot called when the process finished or the user pressed the
158 button.
159 </p>
160 <a NAME="SvnBlameDialog.__generateItem" ID="SvnBlameDialog.__generateItem"></a>
161 <h4>SvnBlameDialog.__generateItem</h4>
162 <b>__generateItem</b>(<i>revision, author, text</i>)
163
164 <p>
165 Private method to generate a blame item in the blame list.
166 </p>
167 <dl>
168
169 <dt><i>revision</i></dt>
170 <dd>
171 revision string (string)
172 </dd>
173 <dt><i>author</i></dt>
174 <dd>
175 author of the change (string)
176 </dd>
177 <dt><i>text</i></dt>
178 <dd>
179 line of text from the annotated file (string)
180 </dd>
181 </dl>
182 <a NAME="SvnBlameDialog.__procFinished" ID="SvnBlameDialog.__procFinished"></a>
183 <h4>SvnBlameDialog.__procFinished</h4>
184 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
185
186 <p>
187 Private slot connected to the finished signal.
188 </p>
189 <dl>
190
191 <dt><i>exitCode</i></dt>
192 <dd>
193 exit code of the process (integer)
194 </dd>
195 <dt><i>exitStatus</i></dt>
196 <dd>
197 exit status of the process (QProcess.ExitStatus)
198 </dd>
199 </dl>
200 <a NAME="SvnBlameDialog.__readStderr" ID="SvnBlameDialog.__readStderr"></a>
201 <h4>SvnBlameDialog.__readStderr</h4>
202 <b>__readStderr</b>(<i></i>)
203
204 <p>
205 Private slot to handle the readyReadStderr signal.
206 </p>
207 <p>
208 It reads the error output of the process and inserts it into the
209 error pane.
210 </p>
211 <a NAME="SvnBlameDialog.__readStdout" ID="SvnBlameDialog.__readStdout"></a>
212 <h4>SvnBlameDialog.__readStdout</h4>
213 <b>__readStdout</b>(<i></i>)
214
215 <p>
216 Private slot to handle the readyReadStdout signal.
217 </p>
218 <p>
219 It reads the output of the process, formats it and inserts it into
220 the contents pane.
221 </p>
222 <a NAME="SvnBlameDialog.__resizeColumns" ID="SvnBlameDialog.__resizeColumns"></a>
223 <h4>SvnBlameDialog.__resizeColumns</h4>
224 <b>__resizeColumns</b>(<i></i>)
225
226 <p>
227 Private method to resize the list columns.
228 </p>
229 <a NAME="SvnBlameDialog.closeEvent" ID="SvnBlameDialog.closeEvent"></a>
230 <h4>SvnBlameDialog.closeEvent</h4>
231 <b>closeEvent</b>(<i>e</i>)
232
233 <p>
234 Protected slot implementing a close event handler.
235 </p>
236 <dl>
237
238 <dt><i>e</i></dt>
239 <dd>
240 close event (QCloseEvent)
241 </dd>
242 </dl>
243 <a NAME="SvnBlameDialog.keyPressEvent" ID="SvnBlameDialog.keyPressEvent"></a>
244 <h4>SvnBlameDialog.keyPressEvent</h4>
245 <b>keyPressEvent</b>(<i>evt</i>)
246
247 <p>
248 Protected slot to handle a key press event.
249 </p>
250 <dl>
251
252 <dt><i>evt</i></dt>
253 <dd>
254 the key press event (QKeyEvent)
255 </dd>
256 </dl>
257 <a NAME="SvnBlameDialog.on_buttonBox_clicked" ID="SvnBlameDialog.on_buttonBox_clicked"></a>
258 <h4>SvnBlameDialog.on_buttonBox_clicked</h4>
259 <b>on_buttonBox_clicked</b>(<i>button</i>)
260
261 <p>
262 Private slot called by a button of the button box clicked.
263 </p>
264 <dl>
265
266 <dt><i>button</i></dt>
267 <dd>
268 button that was clicked (QAbstractButton)
269 </dd>
270 </dl>
271 <a NAME="SvnBlameDialog.on_input_returnPressed" ID="SvnBlameDialog.on_input_returnPressed"></a>
272 <h4>SvnBlameDialog.on_input_returnPressed</h4>
273 <b>on_input_returnPressed</b>(<i></i>)
274
275 <p>
276 Private slot to handle the press of the return key in the input field.
277 </p>
278 <a NAME="SvnBlameDialog.on_passwordCheckBox_toggled" ID="SvnBlameDialog.on_passwordCheckBox_toggled"></a>
279 <h4>SvnBlameDialog.on_passwordCheckBox_toggled</h4>
280 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
281
282 <p>
283 Private slot to handle the password checkbox toggled.
284 </p>
285 <dl>
286
287 <dt><i>isOn</i></dt>
288 <dd>
289 flag indicating the status of the check box (boolean)
290 </dd>
291 </dl>
292 <a NAME="SvnBlameDialog.on_sendButton_clicked" ID="SvnBlameDialog.on_sendButton_clicked"></a>
293 <h4>SvnBlameDialog.on_sendButton_clicked</h4>
294 <b>on_sendButton_clicked</b>(<i></i>)
295
296 <p>
297 Private slot to send the input to the subversion process.
298 </p>
299 <a NAME="SvnBlameDialog.start" ID="SvnBlameDialog.start"></a>
300 <h4>SvnBlameDialog.start</h4>
301 <b>start</b>(<i>fn</i>)
302
303 <p>
304 Public slot to start the svn blame command.
305 </p>
306 <dl>
307
308 <dt><i>fn</i></dt>
309 <dd>
310 filename to show the blame for (string)
311 </dd>
312 </dl>
313 <div align="right"><a href="#top">Up</a></div>
314 <hr />
315 </body></html>

eric ide

mercurial