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

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Plugins.VcsPlugins.vcsSubversion.SvnBlameDialog</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Plugins.VcsPlugins.vcsSubversion.SvnBlameDialog</h1>
24 <p>
25 Module implementing a dialog to show the output of the svn blame command.
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="#SvnBlameDialog">SvnBlameDialog</a></td>
35 <td>Class implementing a dialog to show the output of the svn blame 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="SvnBlameDialog" ID="SvnBlameDialog"></a>
44 <h2>SvnBlameDialog</h2>
45 <p>
46 Class implementing a dialog to show the output of the svn blame command.
47 </p>
48 <h3>Derived from</h3>
49 QDialog, Ui_SvnBlameDialog
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#SvnBlameDialog.__init__">SvnBlameDialog</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#SvnBlameDialog.__finish">__finish</a></td>
61 <td>Private slot called when the process finished or the user pressed the button.</td>
62 </tr><tr>
63 <td><a href="#SvnBlameDialog.__generateItem">__generateItem</a></td>
64 <td>Private method to generate a tag item in the taglist.</td>
65 </tr><tr>
66 <td><a href="#SvnBlameDialog.__procFinished">__procFinished</a></td>
67 <td>Private slot connected to the finished signal.</td>
68 </tr><tr>
69 <td><a href="#SvnBlameDialog.__readStderr">__readStderr</a></td>
70 <td>Private slot to handle the readyReadStderr signal.</td>
71 </tr><tr>
72 <td><a href="#SvnBlameDialog.__readStdout">__readStdout</a></td>
73 <td>Private slot to handle the readyReadStdout signal.</td>
74 </tr><tr>
75 <td><a href="#SvnBlameDialog.__resizeColumns">__resizeColumns</a></td>
76 <td>Private method to resize the list columns.</td>
77 </tr><tr>
78 <td><a href="#SvnBlameDialog.closeEvent">closeEvent</a></td>
79 <td>Private slot implementing a close event handler.</td>
80 </tr><tr>
81 <td><a href="#SvnBlameDialog.keyPressEvent">keyPressEvent</a></td>
82 <td>Protected slot to handle a key press event.</td>
83 </tr><tr>
84 <td><a href="#SvnBlameDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
85 <td>Private slot called by a button of the button box clicked.</td>
86 </tr><tr>
87 <td><a href="#SvnBlameDialog.on_input_returnPressed">on_input_returnPressed</a></td>
88 <td>Private slot to handle the press of the return key in the input field.</td>
89 </tr><tr>
90 <td><a href="#SvnBlameDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
91 <td>Private slot to handle the password checkbox toggled.</td>
92 </tr><tr>
93 <td><a href="#SvnBlameDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
94 <td>Private slot to send the input to the subversion process.</td>
95 </tr><tr>
96 <td><a href="#SvnBlameDialog.start">start</a></td>
97 <td>Public slot to start the svn status command.</td>
98 </tr>
99 </table>
100 <a NAME="SvnBlameDialog.__init__" ID="SvnBlameDialog.__init__"></a>
101 <h4>SvnBlameDialog (Constructor)</h4>
102 <b>SvnBlameDialog</b>(<i>vcs, parent = None</i>)
103 <p>
104 Constructor
105 </p><dl>
106 <dt><i>vcs</i></dt>
107 <dd>
108 reference to the vcs object
109 </dd><dt><i>parent</i></dt>
110 <dd>
111 parent widget (QWidget)
112 </dd>
113 </dl><a NAME="SvnBlameDialog.__finish" ID="SvnBlameDialog.__finish"></a>
114 <h4>SvnBlameDialog.__finish</h4>
115 <b>__finish</b>(<i></i>)
116 <p>
117 Private slot called when the process finished or the user pressed the button.
118 </p><a NAME="SvnBlameDialog.__generateItem" ID="SvnBlameDialog.__generateItem"></a>
119 <h4>SvnBlameDialog.__generateItem</h4>
120 <b>__generateItem</b>(<i>revision, author, text</i>)
121 <p>
122 Private method to generate a tag item in the taglist.
123 </p><dl>
124 <dt><i>revision</i></dt>
125 <dd>
126 revision string (string)
127 </dd><dt><i>author</i></dt>
128 <dd>
129 author of the tag (string)
130 </dd><dt><i>date</i></dt>
131 <dd>
132 date of the tag (string)
133 </dd><dt><i>name</i></dt>
134 <dd>
135 name (path) of the tag (string)
136 </dd>
137 </dl><a NAME="SvnBlameDialog.__procFinished" ID="SvnBlameDialog.__procFinished"></a>
138 <h4>SvnBlameDialog.__procFinished</h4>
139 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
140 <p>
141 Private slot connected to the finished signal.
142 </p><dl>
143 <dt><i>exitCode</i></dt>
144 <dd>
145 exit code of the process (integer)
146 </dd><dt><i>exitStatus</i></dt>
147 <dd>
148 exit status of the process (QProcess.ExitStatus)
149 </dd>
150 </dl><a NAME="SvnBlameDialog.__readStderr" ID="SvnBlameDialog.__readStderr"></a>
151 <h4>SvnBlameDialog.__readStderr</h4>
152 <b>__readStderr</b>(<i></i>)
153 <p>
154 Private slot to handle the readyReadStderr signal.
155 </p><p>
156 It reads the error output of the process and inserts it into the
157 error pane.
158 </p><a NAME="SvnBlameDialog.__readStdout" ID="SvnBlameDialog.__readStdout"></a>
159 <h4>SvnBlameDialog.__readStdout</h4>
160 <b>__readStdout</b>(<i></i>)
161 <p>
162 Private slot to handle the readyReadStdout signal.
163 </p><p>
164 It reads the output of the process, formats it and inserts it into
165 the contents pane.
166 </p><a NAME="SvnBlameDialog.__resizeColumns" ID="SvnBlameDialog.__resizeColumns"></a>
167 <h4>SvnBlameDialog.__resizeColumns</h4>
168 <b>__resizeColumns</b>(<i></i>)
169 <p>
170 Private method to resize the list columns.
171 </p><a NAME="SvnBlameDialog.closeEvent" ID="SvnBlameDialog.closeEvent"></a>
172 <h4>SvnBlameDialog.closeEvent</h4>
173 <b>closeEvent</b>(<i>e</i>)
174 <p>
175 Private slot implementing a close event handler.
176 </p><dl>
177 <dt><i>e</i></dt>
178 <dd>
179 close event (QCloseEvent)
180 </dd>
181 </dl><a NAME="SvnBlameDialog.keyPressEvent" ID="SvnBlameDialog.keyPressEvent"></a>
182 <h4>SvnBlameDialog.keyPressEvent</h4>
183 <b>keyPressEvent</b>(<i>evt</i>)
184 <p>
185 Protected slot to handle a key press event.
186 </p><dl>
187 <dt><i>evt</i></dt>
188 <dd>
189 the key press event (QKeyEvent)
190 </dd>
191 </dl><a NAME="SvnBlameDialog.on_buttonBox_clicked" ID="SvnBlameDialog.on_buttonBox_clicked"></a>
192 <h4>SvnBlameDialog.on_buttonBox_clicked</h4>
193 <b>on_buttonBox_clicked</b>(<i>button</i>)
194 <p>
195 Private slot called by a button of the button box clicked.
196 </p><dl>
197 <dt><i>button</i></dt>
198 <dd>
199 button that was clicked (QAbstractButton)
200 </dd>
201 </dl><a NAME="SvnBlameDialog.on_input_returnPressed" ID="SvnBlameDialog.on_input_returnPressed"></a>
202 <h4>SvnBlameDialog.on_input_returnPressed</h4>
203 <b>on_input_returnPressed</b>(<i></i>)
204 <p>
205 Private slot to handle the press of the return key in the input field.
206 </p><a NAME="SvnBlameDialog.on_passwordCheckBox_toggled" ID="SvnBlameDialog.on_passwordCheckBox_toggled"></a>
207 <h4>SvnBlameDialog.on_passwordCheckBox_toggled</h4>
208 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
209 <p>
210 Private slot to handle the password checkbox toggled.
211 </p><dl>
212 <dt><i>isOn</i></dt>
213 <dd>
214 flag indicating the status of the check box (boolean)
215 </dd>
216 </dl><a NAME="SvnBlameDialog.on_sendButton_clicked" ID="SvnBlameDialog.on_sendButton_clicked"></a>
217 <h4>SvnBlameDialog.on_sendButton_clicked</h4>
218 <b>on_sendButton_clicked</b>(<i></i>)
219 <p>
220 Private slot to send the input to the subversion process.
221 </p><a NAME="SvnBlameDialog.start" ID="SvnBlameDialog.start"></a>
222 <h4>SvnBlameDialog.start</h4>
223 <b>start</b>(<i>fn</i>)
224 <p>
225 Public slot to start the svn status command.
226 </p><dl>
227 <dt><i>fn</i></dt>
228 <dd>
229 filename to show the log for (string)
230 </dd>
231 </dl>
232 <div align="right"><a href="#top">Up</a></div>
233 <hr />
234 </body></html>

eric ide

mercurial