Mercurial Repositories > eric / file comparison

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

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

changeset 6020
baf6da1ae288
equal deleted inserted replaced
6019:58ecdaf0b789 6020:baf6da1ae288
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsGit.GitBisectLogBrowserDialog</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.GitBisectLogBrowserDialog</h1>
23 <p>
24 Module implementing a dialog to browse the bisect log history.
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="#GitBisectLogBrowserDialog">GitBisectLogBrowserDialog</a></td>
34 <td>Class implementing a dialog to browse the bisect log history.</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="GitBisectLogBrowserDialog" ID="GitBisectLogBrowserDialog"></a>
43 <h2>GitBisectLogBrowserDialog</h2>
44 <p>
45 Class implementing a dialog to browse the bisect log history.
46 </p>
47 <h3>Derived from</h3>
48 QWidget, Ui_GitBisectLogBrowserDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>CommitIdColumn</td></tr><tr><td>OperationColumn</td></tr><tr><td>SubjectColumn</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="#GitBisectLogBrowserDialog.__init__">GitBisectLogBrowserDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#GitBisectLogBrowserDialog.__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="#GitBisectLogBrowserDialog.__generateLogItem">__generateLogItem</a></td>
67 <td>Private method to generate a bisect log tree entry.</td>
68 </tr><tr>
69 <td><a href="#GitBisectLogBrowserDialog.__getLogEntries">__getLogEntries</a></td>
70 <td>Private method to retrieve bisect log entries from the repository.</td>
71 </tr><tr>
72 <td><a href="#GitBisectLogBrowserDialog.__initData">__initData</a></td>
73 <td>Private method to (re-)initialize some data.</td>
74 </tr><tr>
75 <td><a href="#GitBisectLogBrowserDialog.__procFinished">__procFinished</a></td>
76 <td>Private slot connected to the finished signal.</td>
77 </tr><tr>
78 <td><a href="#GitBisectLogBrowserDialog.__processBuffer">__processBuffer</a></td>
79 <td>Private method to process the buffered output of the git log command.</td>
80 </tr><tr>
81 <td><a href="#GitBisectLogBrowserDialog.__readStderr">__readStderr</a></td>
82 <td>Private slot to handle the readyReadStandardError signal.</td>
83 </tr><tr>
84 <td><a href="#GitBisectLogBrowserDialog.__readStdout">__readStdout</a></td>
85 <td>Private slot to handle the readyReadStandardOutput signal.</td>
86 </tr><tr>
87 <td><a href="#GitBisectLogBrowserDialog.__resetUI">__resetUI</a></td>
88 <td>Private method to reset the user interface.</td>
89 </tr><tr>
90 <td><a href="#GitBisectLogBrowserDialog.__resizeColumnsLog">__resizeColumnsLog</a></td>
91 <td>Private method to resize the log tree columns.</td>
92 </tr><tr>
93 <td><a href="#GitBisectLogBrowserDialog.__showError">__showError</a></td>
94 <td>Private slot to show some error.</td>
95 </tr><tr>
96 <td><a href="#GitBisectLogBrowserDialog.closeEvent">closeEvent</a></td>
97 <td>Protected slot implementing a close event handler.</td>
98 </tr><tr>
99 <td><a href="#GitBisectLogBrowserDialog.keyPressEvent">keyPressEvent</a></td>
100 <td>Protected slot to handle a key press event.</td>
101 </tr><tr>
102 <td><a href="#GitBisectLogBrowserDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
103 <td>Private slot called by a button of the button box clicked.</td>
104 </tr><tr>
105 <td><a href="#GitBisectLogBrowserDialog.on_input_returnPressed">on_input_returnPressed</a></td>
106 <td>Private slot to handle the press of the return key in the input field.</td>
107 </tr><tr>
108 <td><a href="#GitBisectLogBrowserDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
109 <td>Private slot to handle the password checkbox toggled.</td>
110 </tr><tr>
111 <td><a href="#GitBisectLogBrowserDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
112 <td>Private slot to refresh the log.</td>
113 </tr><tr>
114 <td><a href="#GitBisectLogBrowserDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
115 <td>Private slot to send the input to the git process.</td>
116 </tr><tr>
117 <td><a href="#GitBisectLogBrowserDialog.show">show</a></td>
118 <td>Public slot to show the dialog.</td>
119 </tr><tr>
120 <td><a href="#GitBisectLogBrowserDialog.start">start</a></td>
121 <td>Public slot to start the git bisect log command.</td>
122 </tr>
123 </table>
124 <h3>Static Methods</h3>
125 <table>
126 <tr><td>None</td></tr>
127 </table>
128 <a NAME="GitBisectLogBrowserDialog.__init__" ID="GitBisectLogBrowserDialog.__init__"></a>
129 <h4>GitBisectLogBrowserDialog (Constructor)</h4>
130 <b>GitBisectLogBrowserDialog</b>(<i>vcs, parent=None</i>)
131 <p>
132 Constructor
133 </p><dl>
134 <dt><i>vcs</i></dt>
135 <dd>
136 reference to the vcs object
137 </dd><dt><i>parent</i></dt>
138 <dd>
139 reference to the parent widget (QWidget)
140 </dd>
141 </dl><a NAME="GitBisectLogBrowserDialog.__finish" ID="GitBisectLogBrowserDialog.__finish"></a>
142 <h4>GitBisectLogBrowserDialog.__finish</h4>
143 <b>__finish</b>(<i></i>)
144 <p>
145 Private slot called when the process finished or the user pressed
146 the button.
147 </p><a NAME="GitBisectLogBrowserDialog.__generateLogItem" ID="GitBisectLogBrowserDialog.__generateLogItem"></a>
148 <h4>GitBisectLogBrowserDialog.__generateLogItem</h4>
149 <b>__generateLogItem</b>(<i>commitId, operation, subject</i>)
150 <p>
151 Private method to generate a bisect log tree entry.
152 </p><dl>
153 <dt><i>commitId</i></dt>
154 <dd>
155 commit id info (string)
156 </dd><dt><i>operation</i></dt>
157 <dd>
158 bisect operation (string)
159 </dd><dt><i>subject</i></dt>
160 <dd>
161 subject of the bisect log entry (string)
162 </dd>
163 </dl><dl>
164 <dt>Returns:</dt>
165 <dd>
166 reference to the generated item (QTreeWidgetItem)
167 </dd>
168 </dl><a NAME="GitBisectLogBrowserDialog.__getLogEntries" ID="GitBisectLogBrowserDialog.__getLogEntries"></a>
169 <h4>GitBisectLogBrowserDialog.__getLogEntries</h4>
170 <b>__getLogEntries</b>(<i></i>)
171 <p>
172 Private method to retrieve bisect log entries from the repository.
173 </p><a NAME="GitBisectLogBrowserDialog.__initData" ID="GitBisectLogBrowserDialog.__initData"></a>
174 <h4>GitBisectLogBrowserDialog.__initData</h4>
175 <b>__initData</b>(<i></i>)
176 <p>
177 Private method to (re-)initialize some data.
178 </p><a NAME="GitBisectLogBrowserDialog.__procFinished" ID="GitBisectLogBrowserDialog.__procFinished"></a>
179 <h4>GitBisectLogBrowserDialog.__procFinished</h4>
180 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
181 <p>
182 Private slot connected to the finished signal.
183 </p><dl>
184 <dt><i>exitCode</i></dt>
185 <dd>
186 exit code of the process (integer)
187 </dd><dt><i>exitStatus</i></dt>
188 <dd>
189 exit status of the process (QProcess.ExitStatus)
190 </dd>
191 </dl><a NAME="GitBisectLogBrowserDialog.__processBuffer" ID="GitBisectLogBrowserDialog.__processBuffer"></a>
192 <h4>GitBisectLogBrowserDialog.__processBuffer</h4>
193 <b>__processBuffer</b>(<i></i>)
194 <p>
195 Private method to process the buffered output of the git log command.
196 </p><a NAME="GitBisectLogBrowserDialog.__readStderr" ID="GitBisectLogBrowserDialog.__readStderr"></a>
197 <h4>GitBisectLogBrowserDialog.__readStderr</h4>
198 <b>__readStderr</b>(<i></i>)
199 <p>
200 Private slot to handle the readyReadStandardError signal.
201 </p><p>
202 It reads the error output of the process and inserts it into the
203 error pane.
204 </p><a NAME="GitBisectLogBrowserDialog.__readStdout" ID="GitBisectLogBrowserDialog.__readStdout"></a>
205 <h4>GitBisectLogBrowserDialog.__readStdout</h4>
206 <b>__readStdout</b>(<i></i>)
207 <p>
208 Private slot to handle the readyReadStandardOutput signal.
209 </p><p>
210 It reads the output of the process and inserts it into a buffer.
211 </p><a NAME="GitBisectLogBrowserDialog.__resetUI" ID="GitBisectLogBrowserDialog.__resetUI"></a>
212 <h4>GitBisectLogBrowserDialog.__resetUI</h4>
213 <b>__resetUI</b>(<i></i>)
214 <p>
215 Private method to reset the user interface.
216 </p><a NAME="GitBisectLogBrowserDialog.__resizeColumnsLog" ID="GitBisectLogBrowserDialog.__resizeColumnsLog"></a>
217 <h4>GitBisectLogBrowserDialog.__resizeColumnsLog</h4>
218 <b>__resizeColumnsLog</b>(<i></i>)
219 <p>
220 Private method to resize the log tree columns.
221 </p><a NAME="GitBisectLogBrowserDialog.__showError" ID="GitBisectLogBrowserDialog.__showError"></a>
222 <h4>GitBisectLogBrowserDialog.__showError</h4>
223 <b>__showError</b>(<i>out</i>)
224 <p>
225 Private slot to show some error.
226 </p><dl>
227 <dt><i>out</i></dt>
228 <dd>
229 error to be shown (string)
230 </dd>
231 </dl><a NAME="GitBisectLogBrowserDialog.closeEvent" ID="GitBisectLogBrowserDialog.closeEvent"></a>
232 <h4>GitBisectLogBrowserDialog.closeEvent</h4>
233 <b>closeEvent</b>(<i>e</i>)
234 <p>
235 Protected slot implementing a close event handler.
236 </p><dl>
237 <dt><i>e</i></dt>
238 <dd>
239 close event (QCloseEvent)
240 </dd>
241 </dl><a NAME="GitBisectLogBrowserDialog.keyPressEvent" ID="GitBisectLogBrowserDialog.keyPressEvent"></a>
242 <h4>GitBisectLogBrowserDialog.keyPressEvent</h4>
243 <b>keyPressEvent</b>(<i>evt</i>)
244 <p>
245 Protected slot to handle a key press event.
246 </p><dl>
247 <dt><i>evt</i></dt>
248 <dd>
249 the key press event (QKeyEvent)
250 </dd>
251 </dl><a NAME="GitBisectLogBrowserDialog.on_buttonBox_clicked" ID="GitBisectLogBrowserDialog.on_buttonBox_clicked"></a>
252 <h4>GitBisectLogBrowserDialog.on_buttonBox_clicked</h4>
253 <b>on_buttonBox_clicked</b>(<i>button</i>)
254 <p>
255 Private slot called by a button of the button box clicked.
256 </p><dl>
257 <dt><i>button</i></dt>
258 <dd>
259 button that was clicked (QAbstractButton)
260 </dd>
261 </dl><a NAME="GitBisectLogBrowserDialog.on_input_returnPressed" ID="GitBisectLogBrowserDialog.on_input_returnPressed"></a>
262 <h4>GitBisectLogBrowserDialog.on_input_returnPressed</h4>
263 <b>on_input_returnPressed</b>(<i></i>)
264 <p>
265 Private slot to handle the press of the return key in the input field.
266 </p><a NAME="GitBisectLogBrowserDialog.on_passwordCheckBox_toggled" ID="GitBisectLogBrowserDialog.on_passwordCheckBox_toggled"></a>
267 <h4>GitBisectLogBrowserDialog.on_passwordCheckBox_toggled</h4>
268 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
269 <p>
270 Private slot to handle the password checkbox toggled.
271 </p><dl>
272 <dt><i>isOn</i></dt>
273 <dd>
274 flag indicating the status of the check box (boolean)
275 </dd>
276 </dl><a NAME="GitBisectLogBrowserDialog.on_refreshButton_clicked" ID="GitBisectLogBrowserDialog.on_refreshButton_clicked"></a>
277 <h4>GitBisectLogBrowserDialog.on_refreshButton_clicked</h4>
278 <b>on_refreshButton_clicked</b>(<i></i>)
279 <p>
280 Private slot to refresh the log.
281 </p><a NAME="GitBisectLogBrowserDialog.on_sendButton_clicked" ID="GitBisectLogBrowserDialog.on_sendButton_clicked"></a>
282 <h4>GitBisectLogBrowserDialog.on_sendButton_clicked</h4>
283 <b>on_sendButton_clicked</b>(<i></i>)
284 <p>
285 Private slot to send the input to the git process.
286 </p><a NAME="GitBisectLogBrowserDialog.show" ID="GitBisectLogBrowserDialog.show"></a>
287 <h4>GitBisectLogBrowserDialog.show</h4>
288 <b>show</b>(<i></i>)
289 <p>
290 Public slot to show the dialog.
291 </p><a NAME="GitBisectLogBrowserDialog.start" ID="GitBisectLogBrowserDialog.start"></a>
292 <h4>GitBisectLogBrowserDialog.start</h4>
293 <b>start</b>(<i>projectdir</i>)
294 <p>
295 Public slot to start the git bisect log command.
296 </p><dl>
297 <dt><i>projectdir</i></dt>
298 <dd>
299 directory name of the project (string)
300 </dd>
301 </dl>
302 <div align="right"><a href="#top">Up</a></div>
303 <hr />
304 </body></html>

Mercurial Repository: eric

eric ide

mercurial