Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitBlameDialog.html

Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitBlameDialog.html

changeset 6020
baf6da1ae288
equal deleted inserted replaced
6019:58ecdaf0b789 6020:baf6da1ae288
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsGit.GitBlameDialog</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.vcsGit.GitBlameDialog</h1>
23 <p>
24 Module implementing a dialog to show the output of git blame.
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="#GitBlameDialog">GitBlameDialog</a></td>
34 <td>Class implementing a dialog to show the output of git blame.</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="GitBlameDialog" ID="GitBlameDialog"></a>
43 <h2>GitBlameDialog</h2>
44 <p>
45 Class implementing a dialog to show the output of git blame.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_GitBlameDialog
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="#GitBlameDialog.__init__">GitBlameDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#GitBlameDialog.__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="#GitBlameDialog.__generateItem">__generateItem</a></td>
67 <td>Private method to generate a blame item in the annotation list.</td>
68 </tr><tr>
69 <td><a href="#GitBlameDialog.__procFinished">__procFinished</a></td>
70 <td>Private slot connected to the finished signal.</td>
71 </tr><tr>
72 <td><a href="#GitBlameDialog.__readStderr">__readStderr</a></td>
73 <td>Private slot to handle the readyReadStderr signal.</td>
74 </tr><tr>
75 <td><a href="#GitBlameDialog.__readStdout">__readStdout</a></td>
76 <td>Private slot to handle the readyReadStdout signal.</td>
77 </tr><tr>
78 <td><a href="#GitBlameDialog.__resizeColumns">__resizeColumns</a></td>
79 <td>Private method to resize the list columns.</td>
80 </tr><tr>
81 <td><a href="#GitBlameDialog.closeEvent">closeEvent</a></td>
82 <td>Protected slot implementing a close event handler.</td>
83 </tr><tr>
84 <td><a href="#GitBlameDialog.keyPressEvent">keyPressEvent</a></td>
85 <td>Protected slot to handle a key press event.</td>
86 </tr><tr>
87 <td><a href="#GitBlameDialog.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="#GitBlameDialog.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="#GitBlameDialog.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="#GitBlameDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
97 <td>Private slot to send the input to the git process.</td>
98 </tr><tr>
99 <td><a href="#GitBlameDialog.start">start</a></td>
100 <td>Public slot to start the blame command.</td>
101 </tr>
102 </table>
103 <h3>Static Methods</h3>
104 <table>
105 <tr><td>None</td></tr>
106 </table>
107 <a NAME="GitBlameDialog.__init__" ID="GitBlameDialog.__init__"></a>
108 <h4>GitBlameDialog (Constructor)</h4>
109 <b>GitBlameDialog</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 reference to the parent widget (QWidget)
119 </dd>
120 </dl><a NAME="GitBlameDialog.__finish" ID="GitBlameDialog.__finish"></a>
121 <h4>GitBlameDialog.__finish</h4>
122 <b>__finish</b>(<i></i>)
123 <p>
124 Private slot called when the process finished or the user pressed
125 the button.
126 </p><a NAME="GitBlameDialog.__generateItem" ID="GitBlameDialog.__generateItem"></a>
127 <h4>GitBlameDialog.__generateItem</h4>
128 <b>__generateItem</b>(<i>commitId, author, date, time, lineno, text</i>)
129 <p>
130 Private method to generate a blame item in the annotation list.
131 </p><dl>
132 <dt><i>commitId</i></dt>
133 <dd>
134 commit identifier (string)
135 </dd><dt><i>author</i></dt>
136 <dd>
137 author of the change (string)
138 </dd><dt><i>date</i></dt>
139 <dd>
140 date of the change (string)
141 </dd><dt><i>time</i></dt>
142 <dd>
143 time of the change (string)
144 </dd><dt><i>lineno</i></dt>
145 <dd>
146 line number of the change (string)
147 </dd><dt><i>text</i></dt>
148 <dd>
149 name (path) of the tag (string)
150 </dd>
151 </dl><a NAME="GitBlameDialog.__procFinished" ID="GitBlameDialog.__procFinished"></a>
152 <h4>GitBlameDialog.__procFinished</h4>
153 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
154 <p>
155 Private slot connected to the finished signal.
156 </p><dl>
157 <dt><i>exitCode</i></dt>
158 <dd>
159 exit code of the process (integer)
160 </dd><dt><i>exitStatus</i></dt>
161 <dd>
162 exit status of the process (QProcess.ExitStatus)
163 </dd>
164 </dl><a NAME="GitBlameDialog.__readStderr" ID="GitBlameDialog.__readStderr"></a>
165 <h4>GitBlameDialog.__readStderr</h4>
166 <b>__readStderr</b>(<i></i>)
167 <p>
168 Private slot to handle the readyReadStderr signal.
169 </p><p>
170 It reads the error output of the process and inserts it into the
171 error pane.
172 </p><a NAME="GitBlameDialog.__readStdout" ID="GitBlameDialog.__readStdout"></a>
173 <h4>GitBlameDialog.__readStdout</h4>
174 <b>__readStdout</b>(<i></i>)
175 <p>
176 Private slot to handle the readyReadStdout signal.
177 </p><p>
178 It reads the output of the process, formats it and inserts it into
179 the annotation list.
180 </p><a NAME="GitBlameDialog.__resizeColumns" ID="GitBlameDialog.__resizeColumns"></a>
181 <h4>GitBlameDialog.__resizeColumns</h4>
182 <b>__resizeColumns</b>(<i></i>)
183 <p>
184 Private method to resize the list columns.
185 </p><a NAME="GitBlameDialog.closeEvent" ID="GitBlameDialog.closeEvent"></a>
186 <h4>GitBlameDialog.closeEvent</h4>
187 <b>closeEvent</b>(<i>e</i>)
188 <p>
189 Protected slot implementing a close event handler.
190 </p><dl>
191 <dt><i>e</i></dt>
192 <dd>
193 close event (QCloseEvent)
194 </dd>
195 </dl><a NAME="GitBlameDialog.keyPressEvent" ID="GitBlameDialog.keyPressEvent"></a>
196 <h4>GitBlameDialog.keyPressEvent</h4>
197 <b>keyPressEvent</b>(<i>evt</i>)
198 <p>
199 Protected slot to handle a key press event.
200 </p><dl>
201 <dt><i>evt</i></dt>
202 <dd>
203 the key press event (QKeyEvent)
204 </dd>
205 </dl><a NAME="GitBlameDialog.on_buttonBox_clicked" ID="GitBlameDialog.on_buttonBox_clicked"></a>
206 <h4>GitBlameDialog.on_buttonBox_clicked</h4>
207 <b>on_buttonBox_clicked</b>(<i>button</i>)
208 <p>
209 Private slot called by a button of the button box clicked.
210 </p><dl>
211 <dt><i>button</i></dt>
212 <dd>
213 button that was clicked (QAbstractButton)
214 </dd>
215 </dl><a NAME="GitBlameDialog.on_input_returnPressed" ID="GitBlameDialog.on_input_returnPressed"></a>
216 <h4>GitBlameDialog.on_input_returnPressed</h4>
217 <b>on_input_returnPressed</b>(<i></i>)
218 <p>
219 Private slot to handle the press of the return key in the input field.
220 </p><a NAME="GitBlameDialog.on_passwordCheckBox_toggled" ID="GitBlameDialog.on_passwordCheckBox_toggled"></a>
221 <h4>GitBlameDialog.on_passwordCheckBox_toggled</h4>
222 <b>on_passwordCheckBox_toggled</b>(<i>checked</i>)
223 <p>
224 Private slot to handle the password checkbox toggled.
225 </p><dl>
226 <dt><i>checked</i></dt>
227 <dd>
228 flag indicating the status of the check box (boolean)
229 </dd>
230 </dl><a NAME="GitBlameDialog.on_sendButton_clicked" ID="GitBlameDialog.on_sendButton_clicked"></a>
231 <h4>GitBlameDialog.on_sendButton_clicked</h4>
232 <b>on_sendButton_clicked</b>(<i></i>)
233 <p>
234 Private slot to send the input to the git process.
235 </p><a NAME="GitBlameDialog.start" ID="GitBlameDialog.start"></a>
236 <h4>GitBlameDialog.start</h4>
237 <b>start</b>(<i>fn</i>)
238 <p>
239 Public slot to start the blame command.
240 </p><dl>
241 <dt><i>fn</i></dt>
242 <dd>
243 filename to show the blame for (string)
244 </dd>
245 </dl>
246 <div align="right"><a href="#top">Up</a></div>
247 <hr />
248 </body></html>

Mercurial Repository: eric

eric ide

mercurial