eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitRemoteRepositoriesDialog.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.GitRemoteRepositoriesDialog</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.GitRemoteRepositoriesDialog</h1>
24
25 <p>
26 Module implementing a dialog to show available remote repositories.
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="#GitRemoteRepositoriesDialog">GitRemoteRepositoriesDialog</a></td>
39 <td>Class implementing a dialog to show available remote repositories.</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="GitRemoteRepositoriesDialog" ID="GitRemoteRepositoriesDialog"></a>
50 <h2>GitRemoteRepositoriesDialog</h2>
51
52 <p>
53 Class implementing a dialog to show available remote repositories.
54 </p>
55 <h3>Derived from</h3>
56 QWidget, Ui_GitRemoteRepositoriesDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</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="#GitRemoteRepositoriesDialog.__init__">GitRemoteRepositoriesDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#GitRemoteRepositoriesDialog.__finish">__finish</a></td>
77 <td>Private slot called when the process finished or the user pressed the button.</td>
78 </tr>
79 <tr>
80 <td><a href="#GitRemoteRepositoriesDialog.__generateItem">__generateItem</a></td>
81 <td>Private method to generate a status item in the status list.</td>
82 </tr>
83 <tr>
84 <td><a href="#GitRemoteRepositoriesDialog.__procFinished">__procFinished</a></td>
85 <td>Private slot connected to the finished signal.</td>
86 </tr>
87 <tr>
88 <td><a href="#GitRemoteRepositoriesDialog.__readStderr">__readStderr</a></td>
89 <td>Private slot to handle the readyReadStandardError signal.</td>
90 </tr>
91 <tr>
92 <td><a href="#GitRemoteRepositoriesDialog.__readStdout">__readStdout</a></td>
93 <td>Private slot to handle the readyReadStandardOutput signal.</td>
94 </tr>
95 <tr>
96 <td><a href="#GitRemoteRepositoriesDialog.__resizeColumns">__resizeColumns</a></td>
97 <td>Private method to resize the list columns.</td>
98 </tr>
99 <tr>
100 <td><a href="#GitRemoteRepositoriesDialog.__resort">__resort</a></td>
101 <td>Private method to resort the list.</td>
102 </tr>
103 <tr>
104 <td><a href="#GitRemoteRepositoriesDialog.__updateButtons">__updateButtons</a></td>
105 <td>Private method to update the buttons status.</td>
106 </tr>
107 <tr>
108 <td><a href="#GitRemoteRepositoriesDialog.closeEvent">closeEvent</a></td>
109 <td>Protected slot implementing a close event handler.</td>
110 </tr>
111 <tr>
112 <td><a href="#GitRemoteRepositoriesDialog.keyPressEvent">keyPressEvent</a></td>
113 <td>Protected slot to handle a key press event.</td>
114 </tr>
115 <tr>
116 <td><a href="#GitRemoteRepositoriesDialog.on_addButton_clicked">on_addButton_clicked</a></td>
117 <td>Private slot to add a remote repository.</td>
118 </tr>
119 <tr>
120 <td><a href="#GitRemoteRepositoriesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
121 <td>Private slot called by a button of the button box clicked.</td>
122 </tr>
123 <tr>
124 <td><a href="#GitRemoteRepositoriesDialog.on_changeUrlButton_clicked">on_changeUrlButton_clicked</a></td>
125 <td>Private slot to change the URL of a remote repository.</td>
126 </tr>
127 <tr>
128 <td><a href="#GitRemoteRepositoriesDialog.on_credentialsButton_clicked">on_credentialsButton_clicked</a></td>
129 <td>Private slot to change the credentials of a remote repository.</td>
130 </tr>
131 <tr>
132 <td><a href="#GitRemoteRepositoriesDialog.on_input_returnPressed">on_input_returnPressed</a></td>
133 <td>Private slot to handle the press of the return key in the input field.</td>
134 </tr>
135 <tr>
136 <td><a href="#GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
137 <td>Private slot to handle the password checkbox toggled.</td>
138 </tr>
139 <tr>
140 <td><a href="#GitRemoteRepositoriesDialog.on_pruneButton_clicked">on_pruneButton_clicked</a></td>
141 <td>Private slot to prune all stale remote-tracking branches.</td>
142 </tr>
143 <tr>
144 <td><a href="#GitRemoteRepositoriesDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
145 <td>Private slot to refresh the status display.</td>
146 </tr>
147 <tr>
148 <td><a href="#GitRemoteRepositoriesDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
149 <td>Private slot to remove a remote repository.</td>
150 </tr>
151 <tr>
152 <td><a href="#GitRemoteRepositoriesDialog.on_renameButton_clicked">on_renameButton_clicked</a></td>
153 <td>Private slot to rename a remote repository.</td>
154 </tr>
155 <tr>
156 <td><a href="#GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged">on_repolist_itemSelectionChanged</a></td>
157 <td>Private slot to act upon changes of selected items.</td>
158 </tr>
159 <tr>
160 <td><a href="#GitRemoteRepositoriesDialog.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="#GitRemoteRepositoriesDialog.on_showInfoButton_clicked">on_showInfoButton_clicked</a></td>
165 <td>Private slot to show information about a remote repository.</td>
166 </tr>
167 <tr>
168 <td><a href="#GitRemoteRepositoriesDialog.start">start</a></td>
169 <td>Public slot to start the git remote command.</td>
170 </tr>
171 </table>
172 <h3>Static Methods</h3>
173
174 <table>
175 <tr><td>None</td></tr>
176 </table>
177
178 <a NAME="GitRemoteRepositoriesDialog.__init__" ID="GitRemoteRepositoriesDialog.__init__"></a>
179 <h4>GitRemoteRepositoriesDialog (Constructor)</h4>
180 <b>GitRemoteRepositoriesDialog</b>(<i>vcs, parent=None</i>)
181
182 <p>
183 Constructor
184 </p>
185 <dl>
186
187 <dt><i>vcs</i></dt>
188 <dd>
189 reference to the vcs object
190 </dd>
191 <dt><i>parent</i></dt>
192 <dd>
193 parent widget (QWidget)
194 </dd>
195 </dl>
196 <a NAME="GitRemoteRepositoriesDialog.__finish" ID="GitRemoteRepositoriesDialog.__finish"></a>
197 <h4>GitRemoteRepositoriesDialog.__finish</h4>
198 <b>__finish</b>(<i></i>)
199
200 <p>
201 Private slot called when the process finished or the user pressed
202 the button.
203 </p>
204 <a NAME="GitRemoteRepositoriesDialog.__generateItem" ID="GitRemoteRepositoriesDialog.__generateItem"></a>
205 <h4>GitRemoteRepositoriesDialog.__generateItem</h4>
206 <b>__generateItem</b>(<i>name, url, oper</i>)
207
208 <p>
209 Private method to generate a status item in the status list.
210 </p>
211 <dl>
212
213 <dt><i>name</i></dt>
214 <dd>
215 name of the remote repository (string)
216 </dd>
217 <dt><i>url</i></dt>
218 <dd>
219 URL of the remote repository (string)
220 </dd>
221 <dt><i>oper</i></dt>
222 <dd>
223 operation the remote repository may be used for (string)
224 </dd>
225 </dl>
226 <a NAME="GitRemoteRepositoriesDialog.__procFinished" ID="GitRemoteRepositoriesDialog.__procFinished"></a>
227 <h4>GitRemoteRepositoriesDialog.__procFinished</h4>
228 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
229
230 <p>
231 Private slot connected to the finished signal.
232 </p>
233 <dl>
234
235 <dt><i>exitCode</i></dt>
236 <dd>
237 exit code of the process (integer)
238 </dd>
239 <dt><i>exitStatus</i></dt>
240 <dd>
241 exit status of the process (QProcess.ExitStatus)
242 </dd>
243 </dl>
244 <a NAME="GitRemoteRepositoriesDialog.__readStderr" ID="GitRemoteRepositoriesDialog.__readStderr"></a>
245 <h4>GitRemoteRepositoriesDialog.__readStderr</h4>
246 <b>__readStderr</b>(<i></i>)
247
248 <p>
249 Private slot to handle the readyReadStandardError signal.
250 </p>
251 <p>
252 It reads the error output of the process and inserts it into the
253 error pane.
254 </p>
255 <a NAME="GitRemoteRepositoriesDialog.__readStdout" ID="GitRemoteRepositoriesDialog.__readStdout"></a>
256 <h4>GitRemoteRepositoriesDialog.__readStdout</h4>
257 <b>__readStdout</b>(<i></i>)
258
259 <p>
260 Private slot to handle the readyReadStandardOutput signal.
261 </p>
262 <p>
263 It reads the output of the process, formats it and inserts it into
264 the contents pane.
265 </p>
266 <a NAME="GitRemoteRepositoriesDialog.__resizeColumns" ID="GitRemoteRepositoriesDialog.__resizeColumns"></a>
267 <h4>GitRemoteRepositoriesDialog.__resizeColumns</h4>
268 <b>__resizeColumns</b>(<i></i>)
269
270 <p>
271 Private method to resize the list columns.
272 </p>
273 <a NAME="GitRemoteRepositoriesDialog.__resort" ID="GitRemoteRepositoriesDialog.__resort"></a>
274 <h4>GitRemoteRepositoriesDialog.__resort</h4>
275 <b>__resort</b>(<i></i>)
276
277 <p>
278 Private method to resort the list.
279 </p>
280 <a NAME="GitRemoteRepositoriesDialog.__updateButtons" ID="GitRemoteRepositoriesDialog.__updateButtons"></a>
281 <h4>GitRemoteRepositoriesDialog.__updateButtons</h4>
282 <b>__updateButtons</b>(<i></i>)
283
284 <p>
285 Private method to update the buttons status.
286 </p>
287 <a NAME="GitRemoteRepositoriesDialog.closeEvent" ID="GitRemoteRepositoriesDialog.closeEvent"></a>
288 <h4>GitRemoteRepositoriesDialog.closeEvent</h4>
289 <b>closeEvent</b>(<i>e</i>)
290
291 <p>
292 Protected slot implementing a close event handler.
293 </p>
294 <dl>
295
296 <dt><i>e</i></dt>
297 <dd>
298 close event (QCloseEvent)
299 </dd>
300 </dl>
301 <a NAME="GitRemoteRepositoriesDialog.keyPressEvent" ID="GitRemoteRepositoriesDialog.keyPressEvent"></a>
302 <h4>GitRemoteRepositoriesDialog.keyPressEvent</h4>
303 <b>keyPressEvent</b>(<i>evt</i>)
304
305 <p>
306 Protected slot to handle a key press event.
307 </p>
308 <dl>
309
310 <dt><i>evt</i></dt>
311 <dd>
312 the key press event (QKeyEvent)
313 </dd>
314 </dl>
315 <a NAME="GitRemoteRepositoriesDialog.on_addButton_clicked" ID="GitRemoteRepositoriesDialog.on_addButton_clicked"></a>
316 <h4>GitRemoteRepositoriesDialog.on_addButton_clicked</h4>
317 <b>on_addButton_clicked</b>(<i></i>)
318
319 <p>
320 Private slot to add a remote repository.
321 </p>
322 <a NAME="GitRemoteRepositoriesDialog.on_buttonBox_clicked" ID="GitRemoteRepositoriesDialog.on_buttonBox_clicked"></a>
323 <h4>GitRemoteRepositoriesDialog.on_buttonBox_clicked</h4>
324 <b>on_buttonBox_clicked</b>(<i>button</i>)
325
326 <p>
327 Private slot called by a button of the button box clicked.
328 </p>
329 <dl>
330
331 <dt><i>button</i></dt>
332 <dd>
333 button that was clicked (QAbstractButton)
334 </dd>
335 </dl>
336 <a NAME="GitRemoteRepositoriesDialog.on_changeUrlButton_clicked" ID="GitRemoteRepositoriesDialog.on_changeUrlButton_clicked"></a>
337 <h4>GitRemoteRepositoriesDialog.on_changeUrlButton_clicked</h4>
338 <b>on_changeUrlButton_clicked</b>(<i></i>)
339
340 <p>
341 Private slot to change the URL of a remote repository.
342 </p>
343 <a NAME="GitRemoteRepositoriesDialog.on_credentialsButton_clicked" ID="GitRemoteRepositoriesDialog.on_credentialsButton_clicked"></a>
344 <h4>GitRemoteRepositoriesDialog.on_credentialsButton_clicked</h4>
345 <b>on_credentialsButton_clicked</b>(<i></i>)
346
347 <p>
348 Private slot to change the credentials of a remote repository.
349 </p>
350 <a NAME="GitRemoteRepositoriesDialog.on_input_returnPressed" ID="GitRemoteRepositoriesDialog.on_input_returnPressed"></a>
351 <h4>GitRemoteRepositoriesDialog.on_input_returnPressed</h4>
352 <b>on_input_returnPressed</b>(<i></i>)
353
354 <p>
355 Private slot to handle the press of the return key in the input field.
356 </p>
357 <a NAME="GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled" ID="GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled"></a>
358 <h4>GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled</h4>
359 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
360
361 <p>
362 Private slot to handle the password checkbox toggled.
363 </p>
364 <dl>
365
366 <dt><i>isOn</i></dt>
367 <dd>
368 flag indicating the status of the check box (boolean)
369 </dd>
370 </dl>
371 <a NAME="GitRemoteRepositoriesDialog.on_pruneButton_clicked" ID="GitRemoteRepositoriesDialog.on_pruneButton_clicked"></a>
372 <h4>GitRemoteRepositoriesDialog.on_pruneButton_clicked</h4>
373 <b>on_pruneButton_clicked</b>(<i></i>)
374
375 <p>
376 Private slot to prune all stale remote-tracking branches.
377 </p>
378 <a NAME="GitRemoteRepositoriesDialog.on_refreshButton_clicked" ID="GitRemoteRepositoriesDialog.on_refreshButton_clicked"></a>
379 <h4>GitRemoteRepositoriesDialog.on_refreshButton_clicked</h4>
380 <b>on_refreshButton_clicked</b>(<i></i>)
381
382 <p>
383 Private slot to refresh the status display.
384 </p>
385 <a NAME="GitRemoteRepositoriesDialog.on_removeButton_clicked" ID="GitRemoteRepositoriesDialog.on_removeButton_clicked"></a>
386 <h4>GitRemoteRepositoriesDialog.on_removeButton_clicked</h4>
387 <b>on_removeButton_clicked</b>(<i></i>)
388
389 <p>
390 Private slot to remove a remote repository.
391 </p>
392 <a NAME="GitRemoteRepositoriesDialog.on_renameButton_clicked" ID="GitRemoteRepositoriesDialog.on_renameButton_clicked"></a>
393 <h4>GitRemoteRepositoriesDialog.on_renameButton_clicked</h4>
394 <b>on_renameButton_clicked</b>(<i></i>)
395
396 <p>
397 Private slot to rename a remote repository.
398 </p>
399 <a NAME="GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged" ID="GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged"></a>
400 <h4>GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged</h4>
401 <b>on_repolist_itemSelectionChanged</b>(<i></i>)
402
403 <p>
404 Private slot to act upon changes of selected items.
405 </p>
406 <a NAME="GitRemoteRepositoriesDialog.on_sendButton_clicked" ID="GitRemoteRepositoriesDialog.on_sendButton_clicked"></a>
407 <h4>GitRemoteRepositoriesDialog.on_sendButton_clicked</h4>
408 <b>on_sendButton_clicked</b>(<i></i>)
409
410 <p>
411 Private slot to send the input to the git process.
412 </p>
413 <a NAME="GitRemoteRepositoriesDialog.on_showInfoButton_clicked" ID="GitRemoteRepositoriesDialog.on_showInfoButton_clicked"></a>
414 <h4>GitRemoteRepositoriesDialog.on_showInfoButton_clicked</h4>
415 <b>on_showInfoButton_clicked</b>(<i></i>)
416
417 <p>
418 Private slot to show information about a remote repository.
419 </p>
420 <a NAME="GitRemoteRepositoriesDialog.start" ID="GitRemoteRepositoriesDialog.start"></a>
421 <h4>GitRemoteRepositoriesDialog.start</h4>
422 <b>start</b>(<i>projectDir</i>)
423
424 <p>
425 Public slot to start the git remote command.
426 </p>
427 <dl>
428
429 <dt><i>projectDir</i></dt>
430 <dd>
431 name of the project directory (string)
432 </dd>
433 </dl>
434 <div align="right"><a href="#top">Up</a></div>
435 <hr />
436 </body></html>

eric ide

mercurial