Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial