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

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

eric ide

mercurial