src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBisectLogBrowserDialog.html

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
child 10690
fab36645aa7d
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitBisectLogBrowserDialog</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitBisectLogBrowserDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to browse the bisect log history. 11 Module implementing a dialog to browse the bisect log history.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#GitBisectLogBrowserDialog">GitBisectLogBrowserDialog</a></td> 22 <td><a href="#GitBisectLogBrowserDialog">GitBisectLogBrowserDialog</a></td>
25 <td>Class implementing a dialog to browse the bisect log history.</td> 23 <td>Class implementing a dialog to browse the bisect log history.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="GitBisectLogBrowserDialog" ID="GitBisectLogBrowserDialog"></a> 34 <a NAME="GitBisectLogBrowserDialog" ID="GitBisectLogBrowserDialog"></a>
36 <h2>GitBisectLogBrowserDialog</h2> 35 <h2>GitBisectLogBrowserDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to browse the bisect log history. 37 Class implementing a dialog to browse the bisect log history.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QWidget, Ui_GitBisectLogBrowserDialog 41 QWidget, Ui_GitBisectLogBrowserDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>CommitIdColumn</td></tr>
46 <tr><td>CommitIdColumn</td></tr><tr><td>OperationColumn</td></tr><tr><td>SubjectColumn</td></tr> 45 <tr><td>OperationColumn</td></tr>
47 </table> 46 <tr><td>SubjectColumn</td></tr>
47 </table>
48
48 <h3>Class Methods</h3> 49 <h3>Class Methods</h3>
49
50 <table> 50 <table>
51 <tr><td>None</td></tr> 51 <tr><td>None</td></tr>
52 </table> 52 </table>
53
53 <h3>Methods</h3> 54 <h3>Methods</h3>
54 55 <table>
55 <table>
56
57 <tr> 56 <tr>
58 <td><a href="#GitBisectLogBrowserDialog.__init__">GitBisectLogBrowserDialog</a></td> 57 <td><a href="#GitBisectLogBrowserDialog.__init__">GitBisectLogBrowserDialog</a></td>
59 <td>Constructor</td> 58 <td>Constructor</td>
60 </tr> 59 </tr>
61 <tr> 60 <tr>
137 <tr> 136 <tr>
138 <td><a href="#GitBisectLogBrowserDialog.start">start</a></td> 137 <td><a href="#GitBisectLogBrowserDialog.start">start</a></td>
139 <td>Public slot to start the git bisect log command.</td> 138 <td>Public slot to start the git bisect log command.</td>
140 </tr> 139 </tr>
141 </table> 140 </table>
141
142 <h3>Static Methods</h3> 142 <h3>Static Methods</h3>
143
144 <table> 143 <table>
145 <tr><td>None</td></tr> 144 <tr><td>None</td></tr>
146 </table> 145 </table>
146
147 147
148 <a NAME="GitBisectLogBrowserDialog.__init__" ID="GitBisectLogBrowserDialog.__init__"></a> 148 <a NAME="GitBisectLogBrowserDialog.__init__" ID="GitBisectLogBrowserDialog.__init__"></a>
149 <h4>GitBisectLogBrowserDialog (Constructor)</h4> 149 <h4>GitBisectLogBrowserDialog (Constructor)</h4>
150 <b>GitBisectLogBrowserDialog</b>(<i>vcs, parent=None</i>) 150 <b>GitBisectLogBrowserDialog</b>(<i>vcs, parent=None</i>)
151
152 <p> 151 <p>
153 Constructor 152 Constructor
154 </p> 153 </p>
154
155 <dl> 155 <dl>
156 156
157 <dt><i>vcs</i> (Git)</dt> 157 <dt><i>vcs</i> (Git)</dt>
158 <dd> 158 <dd>
159 reference to the vcs object 159 reference to the vcs object
164 </dd> 164 </dd>
165 </dl> 165 </dl>
166 <a NAME="GitBisectLogBrowserDialog.__finish" ID="GitBisectLogBrowserDialog.__finish"></a> 166 <a NAME="GitBisectLogBrowserDialog.__finish" ID="GitBisectLogBrowserDialog.__finish"></a>
167 <h4>GitBisectLogBrowserDialog.__finish</h4> 167 <h4>GitBisectLogBrowserDialog.__finish</h4>
168 <b>__finish</b>(<i></i>) 168 <b>__finish</b>(<i></i>)
169
170 <p> 169 <p>
171 Private slot called when the process finished or the user pressed 170 Private slot called when the process finished or the user pressed
172 the button. 171 the button.
173 </p> 172 </p>
173
174 <a NAME="GitBisectLogBrowserDialog.__generateLogItem" ID="GitBisectLogBrowserDialog.__generateLogItem"></a> 174 <a NAME="GitBisectLogBrowserDialog.__generateLogItem" ID="GitBisectLogBrowserDialog.__generateLogItem"></a>
175 <h4>GitBisectLogBrowserDialog.__generateLogItem</h4> 175 <h4>GitBisectLogBrowserDialog.__generateLogItem</h4>
176 <b>__generateLogItem</b>(<i>commitId, operation, subject</i>) 176 <b>__generateLogItem</b>(<i>commitId, operation, subject</i>)
177
178 <p> 177 <p>
179 Private method to generate a bisect log tree entry. 178 Private method to generate a bisect log tree entry.
180 </p> 179 </p>
180
181 <dl> 181 <dl>
182 182
183 <dt><i>commitId</i> (str)</dt> 183 <dt><i>commitId</i> (str)</dt>
184 <dd> 184 <dd>
185 commit id info 185 commit id info
206 </dd> 206 </dd>
207 </dl> 207 </dl>
208 <a NAME="GitBisectLogBrowserDialog.__getLogEntries" ID="GitBisectLogBrowserDialog.__getLogEntries"></a> 208 <a NAME="GitBisectLogBrowserDialog.__getLogEntries" ID="GitBisectLogBrowserDialog.__getLogEntries"></a>
209 <h4>GitBisectLogBrowserDialog.__getLogEntries</h4> 209 <h4>GitBisectLogBrowserDialog.__getLogEntries</h4>
210 <b>__getLogEntries</b>(<i></i>) 210 <b>__getLogEntries</b>(<i></i>)
211
212 <p> 211 <p>
213 Private method to retrieve bisect log entries from the repository. 212 Private method to retrieve bisect log entries from the repository.
214 </p> 213 </p>
214
215 <a NAME="GitBisectLogBrowserDialog.__initData" ID="GitBisectLogBrowserDialog.__initData"></a> 215 <a NAME="GitBisectLogBrowserDialog.__initData" ID="GitBisectLogBrowserDialog.__initData"></a>
216 <h4>GitBisectLogBrowserDialog.__initData</h4> 216 <h4>GitBisectLogBrowserDialog.__initData</h4>
217 <b>__initData</b>(<i></i>) 217 <b>__initData</b>(<i></i>)
218
219 <p> 218 <p>
220 Private method to (re-)initialize some data. 219 Private method to (re-)initialize some data.
221 </p> 220 </p>
221
222 <a NAME="GitBisectLogBrowserDialog.__procFinished" ID="GitBisectLogBrowserDialog.__procFinished"></a> 222 <a NAME="GitBisectLogBrowserDialog.__procFinished" ID="GitBisectLogBrowserDialog.__procFinished"></a>
223 <h4>GitBisectLogBrowserDialog.__procFinished</h4> 223 <h4>GitBisectLogBrowserDialog.__procFinished</h4>
224 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) 224 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
225
226 <p> 225 <p>
227 Private slot connected to the finished signal. 226 Private slot connected to the finished signal.
228 </p> 227 </p>
228
229 <dl> 229 <dl>
230 230
231 <dt><i>exitCode</i> (int)</dt> 231 <dt><i>exitCode</i> (int)</dt>
232 <dd> 232 <dd>
233 exit code of the process 233 exit code of the process
238 </dd> 238 </dd>
239 </dl> 239 </dl>
240 <a NAME="GitBisectLogBrowserDialog.__processBuffer" ID="GitBisectLogBrowserDialog.__processBuffer"></a> 240 <a NAME="GitBisectLogBrowserDialog.__processBuffer" ID="GitBisectLogBrowserDialog.__processBuffer"></a>
241 <h4>GitBisectLogBrowserDialog.__processBuffer</h4> 241 <h4>GitBisectLogBrowserDialog.__processBuffer</h4>
242 <b>__processBuffer</b>(<i></i>) 242 <b>__processBuffer</b>(<i></i>)
243
244 <p> 243 <p>
245 Private method to process the buffered output of the git log command. 244 Private method to process the buffered output of the git log command.
246 </p> 245 </p>
246
247 <a NAME="GitBisectLogBrowserDialog.__readStderr" ID="GitBisectLogBrowserDialog.__readStderr"></a> 247 <a NAME="GitBisectLogBrowserDialog.__readStderr" ID="GitBisectLogBrowserDialog.__readStderr"></a>
248 <h4>GitBisectLogBrowserDialog.__readStderr</h4> 248 <h4>GitBisectLogBrowserDialog.__readStderr</h4>
249 <b>__readStderr</b>(<i></i>) 249 <b>__readStderr</b>(<i></i>)
250
251 <p> 250 <p>
252 Private slot to handle the readyReadStandardError signal. 251 Private slot to handle the readyReadStandardError signal.
253 </p> 252 </p>
254 <p> 253 <p>
255 It reads the error output of the process and inserts it into the 254 It reads the error output of the process and inserts it into the
256 error pane. 255 error pane.
257 </p> 256 </p>
257
258 <a NAME="GitBisectLogBrowserDialog.__readStdout" ID="GitBisectLogBrowserDialog.__readStdout"></a> 258 <a NAME="GitBisectLogBrowserDialog.__readStdout" ID="GitBisectLogBrowserDialog.__readStdout"></a>
259 <h4>GitBisectLogBrowserDialog.__readStdout</h4> 259 <h4>GitBisectLogBrowserDialog.__readStdout</h4>
260 <b>__readStdout</b>(<i></i>) 260 <b>__readStdout</b>(<i></i>)
261
262 <p> 261 <p>
263 Private slot to handle the readyReadStandardOutput signal. 262 Private slot to handle the readyReadStandardOutput signal.
264 </p> 263 </p>
265 <p> 264 <p>
266 It reads the output of the process and inserts it into a buffer. 265 It reads the output of the process and inserts it into a buffer.
267 </p> 266 </p>
267
268 <a NAME="GitBisectLogBrowserDialog.__resetUI" ID="GitBisectLogBrowserDialog.__resetUI"></a> 268 <a NAME="GitBisectLogBrowserDialog.__resetUI" ID="GitBisectLogBrowserDialog.__resetUI"></a>
269 <h4>GitBisectLogBrowserDialog.__resetUI</h4> 269 <h4>GitBisectLogBrowserDialog.__resetUI</h4>
270 <b>__resetUI</b>(<i></i>) 270 <b>__resetUI</b>(<i></i>)
271
272 <p> 271 <p>
273 Private method to reset the user interface. 272 Private method to reset the user interface.
274 </p> 273 </p>
274
275 <a NAME="GitBisectLogBrowserDialog.__resizeColumnsLog" ID="GitBisectLogBrowserDialog.__resizeColumnsLog"></a> 275 <a NAME="GitBisectLogBrowserDialog.__resizeColumnsLog" ID="GitBisectLogBrowserDialog.__resizeColumnsLog"></a>
276 <h4>GitBisectLogBrowserDialog.__resizeColumnsLog</h4> 276 <h4>GitBisectLogBrowserDialog.__resizeColumnsLog</h4>
277 <b>__resizeColumnsLog</b>(<i></i>) 277 <b>__resizeColumnsLog</b>(<i></i>)
278
279 <p> 278 <p>
280 Private method to resize the log tree columns. 279 Private method to resize the log tree columns.
281 </p> 280 </p>
281
282 <a NAME="GitBisectLogBrowserDialog.__showError" ID="GitBisectLogBrowserDialog.__showError"></a> 282 <a NAME="GitBisectLogBrowserDialog.__showError" ID="GitBisectLogBrowserDialog.__showError"></a>
283 <h4>GitBisectLogBrowserDialog.__showError</h4> 283 <h4>GitBisectLogBrowserDialog.__showError</h4>
284 <b>__showError</b>(<i>out</i>) 284 <b>__showError</b>(<i>out</i>)
285
286 <p> 285 <p>
287 Private slot to show some error. 286 Private slot to show some error.
288 </p> 287 </p>
288
289 <dl> 289 <dl>
290 290
291 <dt><i>out</i> (str)</dt> 291 <dt><i>out</i> (str)</dt>
292 <dd> 292 <dd>
293 error to be shown 293 error to be shown
294 </dd> 294 </dd>
295 </dl> 295 </dl>
296 <a NAME="GitBisectLogBrowserDialog.closeEvent" ID="GitBisectLogBrowserDialog.closeEvent"></a> 296 <a NAME="GitBisectLogBrowserDialog.closeEvent" ID="GitBisectLogBrowserDialog.closeEvent"></a>
297 <h4>GitBisectLogBrowserDialog.closeEvent</h4> 297 <h4>GitBisectLogBrowserDialog.closeEvent</h4>
298 <b>closeEvent</b>(<i>e</i>) 298 <b>closeEvent</b>(<i>e</i>)
299
300 <p> 299 <p>
301 Protected slot implementing a close event handler. 300 Protected slot implementing a close event handler.
302 </p> 301 </p>
302
303 <dl> 303 <dl>
304 304
305 <dt><i>e</i> (QCloseEvent)</dt> 305 <dt><i>e</i> (QCloseEvent)</dt>
306 <dd> 306 <dd>
307 close event 307 close event
308 </dd> 308 </dd>
309 </dl> 309 </dl>
310 <a NAME="GitBisectLogBrowserDialog.keyPressEvent" ID="GitBisectLogBrowserDialog.keyPressEvent"></a> 310 <a NAME="GitBisectLogBrowserDialog.keyPressEvent" ID="GitBisectLogBrowserDialog.keyPressEvent"></a>
311 <h4>GitBisectLogBrowserDialog.keyPressEvent</h4> 311 <h4>GitBisectLogBrowserDialog.keyPressEvent</h4>
312 <b>keyPressEvent</b>(<i>evt</i>) 312 <b>keyPressEvent</b>(<i>evt</i>)
313
314 <p> 313 <p>
315 Protected slot to handle a key press event. 314 Protected slot to handle a key press event.
316 </p> 315 </p>
316
317 <dl> 317 <dl>
318 318
319 <dt><i>evt</i> (QKeyEvent)</dt> 319 <dt><i>evt</i> (QKeyEvent)</dt>
320 <dd> 320 <dd>
321 the key press event 321 the key press event
322 </dd> 322 </dd>
323 </dl> 323 </dl>
324 <a NAME="GitBisectLogBrowserDialog.on_buttonBox_clicked" ID="GitBisectLogBrowserDialog.on_buttonBox_clicked"></a> 324 <a NAME="GitBisectLogBrowserDialog.on_buttonBox_clicked" ID="GitBisectLogBrowserDialog.on_buttonBox_clicked"></a>
325 <h4>GitBisectLogBrowserDialog.on_buttonBox_clicked</h4> 325 <h4>GitBisectLogBrowserDialog.on_buttonBox_clicked</h4>
326 <b>on_buttonBox_clicked</b>(<i>button</i>) 326 <b>on_buttonBox_clicked</b>(<i>button</i>)
327
328 <p> 327 <p>
329 Private slot called by a button of the button box clicked. 328 Private slot called by a button of the button box clicked.
330 </p> 329 </p>
330
331 <dl> 331 <dl>
332 332
333 <dt><i>button</i> (QAbstractButton)</dt> 333 <dt><i>button</i> (QAbstractButton)</dt>
334 <dd> 334 <dd>
335 button that was clicked 335 button that was clicked
336 </dd> 336 </dd>
337 </dl> 337 </dl>
338 <a NAME="GitBisectLogBrowserDialog.on_input_returnPressed" ID="GitBisectLogBrowserDialog.on_input_returnPressed"></a> 338 <a NAME="GitBisectLogBrowserDialog.on_input_returnPressed" ID="GitBisectLogBrowserDialog.on_input_returnPressed"></a>
339 <h4>GitBisectLogBrowserDialog.on_input_returnPressed</h4> 339 <h4>GitBisectLogBrowserDialog.on_input_returnPressed</h4>
340 <b>on_input_returnPressed</b>(<i></i>) 340 <b>on_input_returnPressed</b>(<i></i>)
341
342 <p> 341 <p>
343 Private slot to handle the press of the return key in the input field. 342 Private slot to handle the press of the return key in the input field.
344 </p> 343 </p>
344
345 <a NAME="GitBisectLogBrowserDialog.on_passwordCheckBox_toggled" ID="GitBisectLogBrowserDialog.on_passwordCheckBox_toggled"></a> 345 <a NAME="GitBisectLogBrowserDialog.on_passwordCheckBox_toggled" ID="GitBisectLogBrowserDialog.on_passwordCheckBox_toggled"></a>
346 <h4>GitBisectLogBrowserDialog.on_passwordCheckBox_toggled</h4> 346 <h4>GitBisectLogBrowserDialog.on_passwordCheckBox_toggled</h4>
347 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) 347 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
348
349 <p> 348 <p>
350 Private slot to handle the password checkbox toggled. 349 Private slot to handle the password checkbox toggled.
351 </p> 350 </p>
351
352 <dl> 352 <dl>
353 353
354 <dt><i>isOn</i> (bool)</dt> 354 <dt><i>isOn</i> (bool)</dt>
355 <dd> 355 <dd>
356 flag indicating the status of the check box 356 flag indicating the status of the check box
357 </dd> 357 </dd>
358 </dl> 358 </dl>
359 <a NAME="GitBisectLogBrowserDialog.on_refreshButton_clicked" ID="GitBisectLogBrowserDialog.on_refreshButton_clicked"></a> 359 <a NAME="GitBisectLogBrowserDialog.on_refreshButton_clicked" ID="GitBisectLogBrowserDialog.on_refreshButton_clicked"></a>
360 <h4>GitBisectLogBrowserDialog.on_refreshButton_clicked</h4> 360 <h4>GitBisectLogBrowserDialog.on_refreshButton_clicked</h4>
361 <b>on_refreshButton_clicked</b>(<i></i>) 361 <b>on_refreshButton_clicked</b>(<i></i>)
362
363 <p> 362 <p>
364 Private slot to refresh the log. 363 Private slot to refresh the log.
365 </p> 364 </p>
365
366 <a NAME="GitBisectLogBrowserDialog.on_sendButton_clicked" ID="GitBisectLogBrowserDialog.on_sendButton_clicked"></a> 366 <a NAME="GitBisectLogBrowserDialog.on_sendButton_clicked" ID="GitBisectLogBrowserDialog.on_sendButton_clicked"></a>
367 <h4>GitBisectLogBrowserDialog.on_sendButton_clicked</h4> 367 <h4>GitBisectLogBrowserDialog.on_sendButton_clicked</h4>
368 <b>on_sendButton_clicked</b>(<i></i>) 368 <b>on_sendButton_clicked</b>(<i></i>)
369
370 <p> 369 <p>
371 Private slot to send the input to the git process. 370 Private slot to send the input to the git process.
372 </p> 371 </p>
372
373 <a NAME="GitBisectLogBrowserDialog.show" ID="GitBisectLogBrowserDialog.show"></a> 373 <a NAME="GitBisectLogBrowserDialog.show" ID="GitBisectLogBrowserDialog.show"></a>
374 <h4>GitBisectLogBrowserDialog.show</h4> 374 <h4>GitBisectLogBrowserDialog.show</h4>
375 <b>show</b>(<i></i>) 375 <b>show</b>(<i></i>)
376
377 <p> 376 <p>
378 Public slot to show the dialog. 377 Public slot to show the dialog.
379 </p> 378 </p>
379
380 <a NAME="GitBisectLogBrowserDialog.start" ID="GitBisectLogBrowserDialog.start"></a> 380 <a NAME="GitBisectLogBrowserDialog.start" ID="GitBisectLogBrowserDialog.start"></a>
381 <h4>GitBisectLogBrowserDialog.start</h4> 381 <h4>GitBisectLogBrowserDialog.start</h4>
382 <b>start</b>(<i>projectdir</i>) 382 <b>start</b>(<i>projectdir</i>)
383
384 <p> 383 <p>
385 Public slot to start the git bisect log command. 384 Public slot to start the git bisect log command.
386 </p> 385 </p>
386
387 <dl> 387 <dl>
388 388
389 <dt><i>projectdir</i> (str)</dt> 389 <dt><i>projectdir</i> (str)</dt>
390 <dd> 390 <dd>
391 directory name of the project 391 directory name of the project

eric ide

mercurial