Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStashBrowserDialog.html

eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStashBrowserDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitStashBrowserDialog</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitStashBrowserDialog</h1>
24
25 <p>
26 Module implementing a dialog to show the stashes.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#GitStashBrowserDialog">GitStashBrowserDialog</a></td>
39 <td>Class implementing a dialog to show the stashes.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="GitStashBrowserDialog" ID="GitStashBrowserDialog"></a>
50 <h2>GitStashBrowserDialog</h2>
51
52 <p>
53 Class implementing a dialog to show the stashes.
54 </p>
55 <h3>Derived from</h3>
56 QWidget, Ui_GitStashBrowserDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>DateColumn</td></tr><tr><td>FileStatisticsRole</td></tr><tr><td>MessageColumn</td></tr><tr><td>NameColumn</td></tr><tr><td>Separator</td></tr><tr><td>TotalStatisticsRole</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#GitStashBrowserDialog.__init__">GitStashBrowserDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#GitStashBrowserDialog.__apply">__apply</a></td>
77 <td>Private slot to apply the selected stash but keep it.</td>
78 </tr>
79 <tr>
80 <td><a href="#GitStashBrowserDialog.__branch">__branch</a></td>
81 <td>Private slot to create a branch from the selected stash.</td>
82 </tr>
83 <tr>
84 <td><a href="#GitStashBrowserDialog.__clear">__clear</a></td>
85 <td>Private slot to delete all stashes.</td>
86 </tr>
87 <tr>
88 <td><a href="#GitStashBrowserDialog.__drop">__drop</a></td>
89 <td>Private slot to delete the selected stash.</td>
90 </tr>
91 <tr>
92 <td><a href="#GitStashBrowserDialog.__finish">__finish</a></td>
93 <td>Private slot called when the process finished or the user pressed the button.</td>
94 </tr>
95 <tr>
96 <td><a href="#GitStashBrowserDialog.__generateStashEntry">__generateStashEntry</a></td>
97 <td>Private method to generate the stash items.</td>
98 </tr>
99 <tr>
100 <td><a href="#GitStashBrowserDialog.__getStashEntries">__getStashEntries</a></td>
101 <td>Private method to retrieve the list of stashes.</td>
102 </tr>
103 <tr>
104 <td><a href="#GitStashBrowserDialog.__pop">__pop</a></td>
105 <td>Private slot to apply the selected stash and delete it.</td>
106 </tr>
107 <tr>
108 <td><a href="#GitStashBrowserDialog.__procFinished">__procFinished</a></td>
109 <td>Private slot connected to the finished signal.</td>
110 </tr>
111 <tr>
112 <td><a href="#GitStashBrowserDialog.__processBuffer">__processBuffer</a></td>
113 <td>Private method to process the buffered output of the git stash command.</td>
114 </tr>
115 <tr>
116 <td><a href="#GitStashBrowserDialog.__readStderr">__readStderr</a></td>
117 <td>Private slot to handle the readyReadStandardError signal.</td>
118 </tr>
119 <tr>
120 <td><a href="#GitStashBrowserDialog.__readStdout">__readStdout</a></td>
121 <td>Private slot to handle the readyReadStandardOutput signal.</td>
122 </tr>
123 <tr>
124 <td><a href="#GitStashBrowserDialog.__resetUI">__resetUI</a></td>
125 <td>Private method to reset the user interface.</td>
126 </tr>
127 <tr>
128 <td><a href="#GitStashBrowserDialog.__resizeColumnsStashes">__resizeColumnsStashes</a></td>
129 <td>Private method to resize the shelve list columns.</td>
130 </tr>
131 <tr>
132 <td><a href="#GitStashBrowserDialog.__showPatch">__showPatch</a></td>
133 <td>Private slot to show the contents of the selected stash.</td>
134 </tr>
135 <tr>
136 <td><a href="#GitStashBrowserDialog.closeEvent">closeEvent</a></td>
137 <td>Protected slot implementing a close event handler.</td>
138 </tr>
139 <tr>
140 <td><a href="#GitStashBrowserDialog.keyPressEvent">keyPressEvent</a></td>
141 <td>Protected slot to handle a key press event.</td>
142 </tr>
143 <tr>
144 <td><a href="#GitStashBrowserDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
145 <td>Private slot called by a button of the button box clicked.</td>
146 </tr>
147 <tr>
148 <td><a href="#GitStashBrowserDialog.on_input_returnPressed">on_input_returnPressed</a></td>
149 <td>Private slot to handle the press of the return key in the input field.</td>
150 </tr>
151 <tr>
152 <td><a href="#GitStashBrowserDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
153 <td>Private slot to handle the password checkbox toggled.</td>
154 </tr>
155 <tr>
156 <td><a href="#GitStashBrowserDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
157 <td>Private slot to refresh the list of shelves.</td>
158 </tr>
159 <tr>
160 <td><a href="#GitStashBrowserDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
161 <td>Private slot to send the input to the git process.</td>
162 </tr>
163 <tr>
164 <td><a href="#GitStashBrowserDialog.on_stashList_currentItemChanged">on_stashList_currentItemChanged</a></td>
165 <td>Private slot called, when the current item of the stash list changes.</td>
166 </tr>
167 <tr>
168 <td><a href="#GitStashBrowserDialog.on_stashList_customContextMenuRequested">on_stashList_customContextMenuRequested</a></td>
169 <td>Private slot to show the context menu of the stash list.</td>
170 </tr>
171 <tr>
172 <td><a href="#GitStashBrowserDialog.show">show</a></td>
173 <td>Public slot to show the dialog.</td>
174 </tr>
175 <tr>
176 <td><a href="#GitStashBrowserDialog.start">start</a></td>
177 <td>Public slot to start the git stash command.</td>
178 </tr>
179 </table>
180 <h3>Static Methods</h3>
181
182 <table>
183 <tr><td>None</td></tr>
184 </table>
185
186 <a NAME="GitStashBrowserDialog.__init__" ID="GitStashBrowserDialog.__init__"></a>
187 <h4>GitStashBrowserDialog (Constructor)</h4>
188 <b>GitStashBrowserDialog</b>(<i>vcs, parent=None</i>)
189
190 <p>
191 Constructor
192 </p>
193 <dl>
194
195 <dt><i>vcs</i></dt>
196 <dd>
197 reference to the vcs object
198 </dd>
199 <dt><i>parent</i></dt>
200 <dd>
201 reference to the parent widget (QWidget)
202 </dd>
203 </dl>
204 <a NAME="GitStashBrowserDialog.__apply" ID="GitStashBrowserDialog.__apply"></a>
205 <h4>GitStashBrowserDialog.__apply</h4>
206 <b>__apply</b>(<i></i>)
207
208 <p>
209 Private slot to apply the selected stash but keep it.
210 </p>
211 <a NAME="GitStashBrowserDialog.__branch" ID="GitStashBrowserDialog.__branch"></a>
212 <h4>GitStashBrowserDialog.__branch</h4>
213 <b>__branch</b>(<i></i>)
214
215 <p>
216 Private slot to create a branch from the selected stash.
217 </p>
218 <a NAME="GitStashBrowserDialog.__clear" ID="GitStashBrowserDialog.__clear"></a>
219 <h4>GitStashBrowserDialog.__clear</h4>
220 <b>__clear</b>(<i></i>)
221
222 <p>
223 Private slot to delete all stashes.
224 </p>
225 <a NAME="GitStashBrowserDialog.__drop" ID="GitStashBrowserDialog.__drop"></a>
226 <h4>GitStashBrowserDialog.__drop</h4>
227 <b>__drop</b>(<i></i>)
228
229 <p>
230 Private slot to delete the selected stash.
231 </p>
232 <a NAME="GitStashBrowserDialog.__finish" ID="GitStashBrowserDialog.__finish"></a>
233 <h4>GitStashBrowserDialog.__finish</h4>
234 <b>__finish</b>(<i></i>)
235
236 <p>
237 Private slot called when the process finished or the user pressed
238 the button.
239 </p>
240 <a NAME="GitStashBrowserDialog.__generateStashEntry" ID="GitStashBrowserDialog.__generateStashEntry"></a>
241 <h4>GitStashBrowserDialog.__generateStashEntry</h4>
242 <b>__generateStashEntry</b>(<i>name, date, message</i>)
243
244 <p>
245 Private method to generate the stash items.
246 </p>
247 <dl>
248
249 <dt><i>name</i></dt>
250 <dd>
251 name of the stash (string)
252 </dd>
253 <dt><i>date</i></dt>
254 <dd>
255 date the stash was created (string)
256 </dd>
257 <dt><i>message</i></dt>
258 <dd>
259 stash message (string)
260 </dd>
261 </dl>
262 <a NAME="GitStashBrowserDialog.__getStashEntries" ID="GitStashBrowserDialog.__getStashEntries"></a>
263 <h4>GitStashBrowserDialog.__getStashEntries</h4>
264 <b>__getStashEntries</b>(<i></i>)
265
266 <p>
267 Private method to retrieve the list of stashes.
268 </p>
269 <a NAME="GitStashBrowserDialog.__pop" ID="GitStashBrowserDialog.__pop"></a>
270 <h4>GitStashBrowserDialog.__pop</h4>
271 <b>__pop</b>(<i></i>)
272
273 <p>
274 Private slot to apply the selected stash and delete it.
275 </p>
276 <a NAME="GitStashBrowserDialog.__procFinished" ID="GitStashBrowserDialog.__procFinished"></a>
277 <h4>GitStashBrowserDialog.__procFinished</h4>
278 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
279
280 <p>
281 Private slot connected to the finished signal.
282 </p>
283 <dl>
284
285 <dt><i>exitCode</i></dt>
286 <dd>
287 exit code of the process (integer)
288 </dd>
289 <dt><i>exitStatus</i></dt>
290 <dd>
291 exit status of the process (QProcess.ExitStatus)
292 </dd>
293 </dl>
294 <a NAME="GitStashBrowserDialog.__processBuffer" ID="GitStashBrowserDialog.__processBuffer"></a>
295 <h4>GitStashBrowserDialog.__processBuffer</h4>
296 <b>__processBuffer</b>(<i></i>)
297
298 <p>
299 Private method to process the buffered output of the git stash command.
300 </p>
301 <a NAME="GitStashBrowserDialog.__readStderr" ID="GitStashBrowserDialog.__readStderr"></a>
302 <h4>GitStashBrowserDialog.__readStderr</h4>
303 <b>__readStderr</b>(<i></i>)
304
305 <p>
306 Private slot to handle the readyReadStandardError signal.
307 </p>
308 <p>
309 It reads the error output of the process and inserts it into the
310 error pane.
311 </p>
312 <a NAME="GitStashBrowserDialog.__readStdout" ID="GitStashBrowserDialog.__readStdout"></a>
313 <h4>GitStashBrowserDialog.__readStdout</h4>
314 <b>__readStdout</b>(<i></i>)
315
316 <p>
317 Private slot to handle the readyReadStandardOutput signal.
318 </p>
319 <p>
320 It reads the output of the process and inserts it into a buffer.
321 </p>
322 <a NAME="GitStashBrowserDialog.__resetUI" ID="GitStashBrowserDialog.__resetUI"></a>
323 <h4>GitStashBrowserDialog.__resetUI</h4>
324 <b>__resetUI</b>(<i></i>)
325
326 <p>
327 Private method to reset the user interface.
328 </p>
329 <a NAME="GitStashBrowserDialog.__resizeColumnsStashes" ID="GitStashBrowserDialog.__resizeColumnsStashes"></a>
330 <h4>GitStashBrowserDialog.__resizeColumnsStashes</h4>
331 <b>__resizeColumnsStashes</b>(<i></i>)
332
333 <p>
334 Private method to resize the shelve list columns.
335 </p>
336 <a NAME="GitStashBrowserDialog.__showPatch" ID="GitStashBrowserDialog.__showPatch"></a>
337 <h4>GitStashBrowserDialog.__showPatch</h4>
338 <b>__showPatch</b>(<i></i>)
339
340 <p>
341 Private slot to show the contents of the selected stash.
342 </p>
343 <a NAME="GitStashBrowserDialog.closeEvent" ID="GitStashBrowserDialog.closeEvent"></a>
344 <h4>GitStashBrowserDialog.closeEvent</h4>
345 <b>closeEvent</b>(<i>e</i>)
346
347 <p>
348 Protected slot implementing a close event handler.
349 </p>
350 <dl>
351
352 <dt><i>e</i></dt>
353 <dd>
354 close event (QCloseEvent)
355 </dd>
356 </dl>
357 <a NAME="GitStashBrowserDialog.keyPressEvent" ID="GitStashBrowserDialog.keyPressEvent"></a>
358 <h4>GitStashBrowserDialog.keyPressEvent</h4>
359 <b>keyPressEvent</b>(<i>evt</i>)
360
361 <p>
362 Protected slot to handle a key press event.
363 </p>
364 <dl>
365
366 <dt><i>evt</i></dt>
367 <dd>
368 the key press event (QKeyEvent)
369 </dd>
370 </dl>
371 <a NAME="GitStashBrowserDialog.on_buttonBox_clicked" ID="GitStashBrowserDialog.on_buttonBox_clicked"></a>
372 <h4>GitStashBrowserDialog.on_buttonBox_clicked</h4>
373 <b>on_buttonBox_clicked</b>(<i>button</i>)
374
375 <p>
376 Private slot called by a button of the button box clicked.
377 </p>
378 <dl>
379
380 <dt><i>button</i></dt>
381 <dd>
382 button that was clicked (QAbstractButton)
383 </dd>
384 </dl>
385 <a NAME="GitStashBrowserDialog.on_input_returnPressed" ID="GitStashBrowserDialog.on_input_returnPressed"></a>
386 <h4>GitStashBrowserDialog.on_input_returnPressed</h4>
387 <b>on_input_returnPressed</b>(<i></i>)
388
389 <p>
390 Private slot to handle the press of the return key in the input field.
391 </p>
392 <a NAME="GitStashBrowserDialog.on_passwordCheckBox_toggled" ID="GitStashBrowserDialog.on_passwordCheckBox_toggled"></a>
393 <h4>GitStashBrowserDialog.on_passwordCheckBox_toggled</h4>
394 <b>on_passwordCheckBox_toggled</b>(<i>checked</i>)
395
396 <p>
397 Private slot to handle the password checkbox toggled.
398 </p>
399 <dl>
400
401 <dt><i>checked</i></dt>
402 <dd>
403 flag indicating the status of the check box (boolean)
404 </dd>
405 </dl>
406 <a NAME="GitStashBrowserDialog.on_refreshButton_clicked" ID="GitStashBrowserDialog.on_refreshButton_clicked"></a>
407 <h4>GitStashBrowserDialog.on_refreshButton_clicked</h4>
408 <b>on_refreshButton_clicked</b>(<i></i>)
409
410 <p>
411 Private slot to refresh the list of shelves.
412 </p>
413 <a NAME="GitStashBrowserDialog.on_sendButton_clicked" ID="GitStashBrowserDialog.on_sendButton_clicked"></a>
414 <h4>GitStashBrowserDialog.on_sendButton_clicked</h4>
415 <b>on_sendButton_clicked</b>(<i></i>)
416
417 <p>
418 Private slot to send the input to the git process.
419 </p>
420 <a NAME="GitStashBrowserDialog.on_stashList_currentItemChanged" ID="GitStashBrowserDialog.on_stashList_currentItemChanged"></a>
421 <h4>GitStashBrowserDialog.on_stashList_currentItemChanged</h4>
422 <b>on_stashList_currentItemChanged</b>(<i>current, previous</i>)
423
424 <p>
425 Private slot called, when the current item of the stash list changes.
426 </p>
427 <dl>
428
429 <dt><i>current</i></dt>
430 <dd>
431 reference to the new current item (QTreeWidgetItem)
432 </dd>
433 <dt><i>previous</i></dt>
434 <dd>
435 reference to the old current item (QTreeWidgetItem)
436 </dd>
437 </dl>
438 <a NAME="GitStashBrowserDialog.on_stashList_customContextMenuRequested" ID="GitStashBrowserDialog.on_stashList_customContextMenuRequested"></a>
439 <h4>GitStashBrowserDialog.on_stashList_customContextMenuRequested</h4>
440 <b>on_stashList_customContextMenuRequested</b>(<i>pos</i>)
441
442 <p>
443 Private slot to show the context menu of the stash list.
444 </p>
445 <dl>
446
447 <dt><i>pos</i></dt>
448 <dd>
449 position of the mouse pointer (QPoint)
450 </dd>
451 </dl>
452 <a NAME="GitStashBrowserDialog.show" ID="GitStashBrowserDialog.show"></a>
453 <h4>GitStashBrowserDialog.show</h4>
454 <b>show</b>(<i></i>)
455
456 <p>
457 Public slot to show the dialog.
458 </p>
459 <a NAME="GitStashBrowserDialog.start" ID="GitStashBrowserDialog.start"></a>
460 <h4>GitStashBrowserDialog.start</h4>
461 <b>start</b>(<i>projectDir</i>)
462
463 <p>
464 Public slot to start the git stash command.
465 </p>
466 <dl>
467
468 <dt><i>projectDir</i></dt>
469 <dd>
470 name of the project directory (string)
471 </dd>
472 </dl>
473 <div align="right"><a href="#top">Up</a></div>
474 <hr />
475 </body></html>

Mercurial Repository: eric

eric ide

mercurial