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

changeset 3673
e26d7d0c1088
child 4126
c28d0cf3b639
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsSubversion.SvnBlameDialog</h1>
23 <p>
24 Module implementing a dialog to show the output of the svn blame command.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#SvnBlameDialog">SvnBlameDialog</a></td>
34 <td>Class implementing a dialog to show the output of the svn blame command.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="SvnBlameDialog" ID="SvnBlameDialog"></a>
43 <h2>SvnBlameDialog</h2>
44 <p>
45 Class implementing a dialog to show the output of the svn blame command.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_SvnBlameDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#SvnBlameDialog.__init__">SvnBlameDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#SvnBlameDialog.__finish">__finish</a></td>
64 <td>Private slot called when the process finished or the user pressed the button.</td>
65 </tr><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><tr>
69 <td><a href="#SvnBlameDialog.__procFinished">__procFinished</a></td>
70 <td>Private slot connected to the finished signal.</td>
71 </tr><tr>
72 <td><a href="#SvnBlameDialog.__readStderr">__readStderr</a></td>
73 <td>Private slot to handle the readyReadStderr signal.</td>
74 </tr><tr>
75 <td><a href="#SvnBlameDialog.__readStdout">__readStdout</a></td>
76 <td>Private slot to handle the readyReadStdout signal.</td>
77 </tr><tr>
78 <td><a href="#SvnBlameDialog.__resizeColumns">__resizeColumns</a></td>
79 <td>Private method to resize the list columns.</td>
80 </tr><tr>
81 <td><a href="#SvnBlameDialog.closeEvent">closeEvent</a></td>
82 <td>Protected slot implementing a close event handler.</td>
83 </tr><tr>
84 <td><a href="#SvnBlameDialog.keyPressEvent">keyPressEvent</a></td>
85 <td>Protected slot to handle a key press event.</td>
86 </tr><tr>
87 <td><a href="#SvnBlameDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
88 <td>Private slot called by a button of the button box clicked.</td>
89 </tr><tr>
90 <td><a href="#SvnBlameDialog.on_input_returnPressed">on_input_returnPressed</a></td>
91 <td>Private slot to handle the press of the return key in the input field.</td>
92 </tr><tr>
93 <td><a href="#SvnBlameDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
94 <td>Private slot to handle the password checkbox toggled.</td>
95 </tr><tr>
96 <td><a href="#SvnBlameDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
97 <td>Private slot to send the input to the subversion process.</td>
98 </tr><tr>
99 <td><a href="#SvnBlameDialog.start">start</a></td>
100 <td>Public slot to start the svn status command.</td>
101 </tr>
102 </table>
103 <h3>Static Methods</h3>
104 <table>
105 <tr><td>None</td></tr>
106 </table>
107 <a NAME="SvnBlameDialog.__init__" ID="SvnBlameDialog.__init__"></a>
108 <h4>SvnBlameDialog (Constructor)</h4>
109 <b>SvnBlameDialog</b>(<i>vcs, parent=None</i>)
110 <p>
111 Constructor
112 </p><dl>
113 <dt><i>vcs</i></dt>
114 <dd>
115 reference to the vcs object
116 </dd><dt><i>parent</i></dt>
117 <dd>
118 parent widget (QWidget)
119 </dd>
120 </dl><a NAME="SvnBlameDialog.__finish" ID="SvnBlameDialog.__finish"></a>
121 <h4>SvnBlameDialog.__finish</h4>
122 <b>__finish</b>(<i></i>)
123 <p>
124 Private slot called when the process finished or the user pressed the
125 button.
126 </p><a NAME="SvnBlameDialog.__generateItem" ID="SvnBlameDialog.__generateItem"></a>
127 <h4>SvnBlameDialog.__generateItem</h4>
128 <b>__generateItem</b>(<i>revision, author, text</i>)
129 <p>
130 Private method to generate a blame item in the blame list.
131 </p><dl>
132 <dt><i>revision</i></dt>
133 <dd>
134 revision string (string)
135 </dd><dt><i>author</i></dt>
136 <dd>
137 author of the change (string)
138 </dd><dt><i>text</i></dt>
139 <dd>
140 line of text from the annotated file (string)
141 </dd>
142 </dl><a NAME="SvnBlameDialog.__procFinished" ID="SvnBlameDialog.__procFinished"></a>
143 <h4>SvnBlameDialog.__procFinished</h4>
144 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
145 <p>
146 Private slot connected to the finished signal.
147 </p><dl>
148 <dt><i>exitCode</i></dt>
149 <dd>
150 exit code of the process (integer)
151 </dd><dt><i>exitStatus</i></dt>
152 <dd>
153 exit status of the process (QProcess.ExitStatus)
154 </dd>
155 </dl><a NAME="SvnBlameDialog.__readStderr" ID="SvnBlameDialog.__readStderr"></a>
156 <h4>SvnBlameDialog.__readStderr</h4>
157 <b>__readStderr</b>(<i></i>)
158 <p>
159 Private slot to handle the readyReadStderr signal.
160 </p><p>
161 It reads the error output of the process and inserts it into the
162 error pane.
163 </p><a NAME="SvnBlameDialog.__readStdout" ID="SvnBlameDialog.__readStdout"></a>
164 <h4>SvnBlameDialog.__readStdout</h4>
165 <b>__readStdout</b>(<i></i>)
166 <p>
167 Private slot to handle the readyReadStdout signal.
168 </p><p>
169 It reads the output of the process, formats it and inserts it into
170 the contents pane.
171 </p><a NAME="SvnBlameDialog.__resizeColumns" ID="SvnBlameDialog.__resizeColumns"></a>
172 <h4>SvnBlameDialog.__resizeColumns</h4>
173 <b>__resizeColumns</b>(<i></i>)
174 <p>
175 Private method to resize the list columns.
176 </p><a NAME="SvnBlameDialog.closeEvent" ID="SvnBlameDialog.closeEvent"></a>
177 <h4>SvnBlameDialog.closeEvent</h4>
178 <b>closeEvent</b>(<i>e</i>)
179 <p>
180 Protected slot implementing a close event handler.
181 </p><dl>
182 <dt><i>e</i></dt>
183 <dd>
184 close event (QCloseEvent)
185 </dd>
186 </dl><a NAME="SvnBlameDialog.keyPressEvent" ID="SvnBlameDialog.keyPressEvent"></a>
187 <h4>SvnBlameDialog.keyPressEvent</h4>
188 <b>keyPressEvent</b>(<i>evt</i>)
189 <p>
190 Protected slot to handle a key press event.
191 </p><dl>
192 <dt><i>evt</i></dt>
193 <dd>
194 the key press event (QKeyEvent)
195 </dd>
196 </dl><a NAME="SvnBlameDialog.on_buttonBox_clicked" ID="SvnBlameDialog.on_buttonBox_clicked"></a>
197 <h4>SvnBlameDialog.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="SvnBlameDialog.on_input_returnPressed" ID="SvnBlameDialog.on_input_returnPressed"></a>
207 <h4>SvnBlameDialog.on_input_returnPressed</h4>
208 <b>on_input_returnPressed</b>(<i></i>)
209 <p>
210 Private slot to handle the press of the return key in the input field.
211 </p><a NAME="SvnBlameDialog.on_passwordCheckBox_toggled" ID="SvnBlameDialog.on_passwordCheckBox_toggled"></a>
212 <h4>SvnBlameDialog.on_passwordCheckBox_toggled</h4>
213 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
214 <p>
215 Private slot to handle the password checkbox toggled.
216 </p><dl>
217 <dt><i>isOn</i></dt>
218 <dd>
219 flag indicating the status of the check box (boolean)
220 </dd>
221 </dl><a NAME="SvnBlameDialog.on_sendButton_clicked" ID="SvnBlameDialog.on_sendButton_clicked"></a>
222 <h4>SvnBlameDialog.on_sendButton_clicked</h4>
223 <b>on_sendButton_clicked</b>(<i></i>)
224 <p>
225 Private slot to send the input to the subversion process.
226 </p><a NAME="SvnBlameDialog.start" ID="SvnBlameDialog.start"></a>
227 <h4>SvnBlameDialog.start</h4>
228 <b>start</b>(<i>fn</i>)
229 <p>
230 Public slot to start the svn status command.
231 </p><dl>
232 <dt><i>fn</i></dt>
233 <dd>
234 filename to show the log for (string)
235 </dd>
236 </dl>
237 <div align="right"><a href="#top">Up</a></div>
238 <hr />
239 </body></html>

eric ide

mercurial