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

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitRemoteRepositoriesDialog</h1>
23 <p>
24 Module implementing a dialog to show available remote repositories.
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="#GitRemoteRepositoriesDialog">GitRemoteRepositoriesDialog</a></td>
34 <td>Class implementing a dialog to show available remote repositories.</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="GitRemoteRepositoriesDialog" ID="GitRemoteRepositoriesDialog"></a>
43 <h2>GitRemoteRepositoriesDialog</h2>
44 <p>
45 Class implementing a dialog to show available remote repositories.
46 </p>
47 <h3>Derived from</h3>
48 QWidget, Ui_GitRemoteRepositoriesDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</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="#GitRemoteRepositoriesDialog.__init__">GitRemoteRepositoriesDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#GitRemoteRepositoriesDialog.__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="#GitRemoteRepositoriesDialog.__generateItem">__generateItem</a></td>
67 <td>Private method to generate a status item in the status list.</td>
68 </tr><tr>
69 <td><a href="#GitRemoteRepositoriesDialog.__procFinished">__procFinished</a></td>
70 <td>Private slot connected to the finished signal.</td>
71 </tr><tr>
72 <td><a href="#GitRemoteRepositoriesDialog.__readStderr">__readStderr</a></td>
73 <td>Private slot to handle the readyReadStandardError signal.</td>
74 </tr><tr>
75 <td><a href="#GitRemoteRepositoriesDialog.__readStdout">__readStdout</a></td>
76 <td>Private slot to handle the readyReadStandardOutput signal.</td>
77 </tr><tr>
78 <td><a href="#GitRemoteRepositoriesDialog.__resizeColumns">__resizeColumns</a></td>
79 <td>Private method to resize the list columns.</td>
80 </tr><tr>
81 <td><a href="#GitRemoteRepositoriesDialog.__resort">__resort</a></td>
82 <td>Private method to resort the list.</td>
83 </tr><tr>
84 <td><a href="#GitRemoteRepositoriesDialog.__updateButtons">__updateButtons</a></td>
85 <td>Private method to update the buttons status.</td>
86 </tr><tr>
87 <td><a href="#GitRemoteRepositoriesDialog.closeEvent">closeEvent</a></td>
88 <td>Protected slot implementing a close event handler.</td>
89 </tr><tr>
90 <td><a href="#GitRemoteRepositoriesDialog.keyPressEvent">keyPressEvent</a></td>
91 <td>Protected slot to handle a key press event.</td>
92 </tr><tr>
93 <td><a href="#GitRemoteRepositoriesDialog.on_addButton_clicked">on_addButton_clicked</a></td>
94 <td>Private slot to add a remote repository.</td>
95 </tr><tr>
96 <td><a href="#GitRemoteRepositoriesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
97 <td>Private slot called by a button of the button box clicked.</td>
98 </tr><tr>
99 <td><a href="#GitRemoteRepositoriesDialog.on_changeUrlButton_clicked">on_changeUrlButton_clicked</a></td>
100 <td>Private slot to change the URL of a remote repository.</td>
101 </tr><tr>
102 <td><a href="#GitRemoteRepositoriesDialog.on_credentialsButton_clicked">on_credentialsButton_clicked</a></td>
103 <td>Private slot to change the credentials of a remote repository.</td>
104 </tr><tr>
105 <td><a href="#GitRemoteRepositoriesDialog.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="#GitRemoteRepositoriesDialog.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="#GitRemoteRepositoriesDialog.on_pruneButton_clicked">on_pruneButton_clicked</a></td>
112 <td>Private slot to prune all stale remote-tracking branches.</td>
113 </tr><tr>
114 <td><a href="#GitRemoteRepositoriesDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
115 <td>Private slot to refresh the status display.</td>
116 </tr><tr>
117 <td><a href="#GitRemoteRepositoriesDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
118 <td>Private slot to remove a remote repository.</td>
119 </tr><tr>
120 <td><a href="#GitRemoteRepositoriesDialog.on_renameButton_clicked">on_renameButton_clicked</a></td>
121 <td>Private slot to rename a remote repository.</td>
122 </tr><tr>
123 <td><a href="#GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged">on_repolist_itemSelectionChanged</a></td>
124 <td>Private slot to act upon changes of selected items.</td>
125 </tr><tr>
126 <td><a href="#GitRemoteRepositoriesDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
127 <td>Private slot to send the input to the git process.</td>
128 </tr><tr>
129 <td><a href="#GitRemoteRepositoriesDialog.on_showInfoButton_clicked">on_showInfoButton_clicked</a></td>
130 <td>Private slot to show information about a remote repository.</td>
131 </tr><tr>
132 <td><a href="#GitRemoteRepositoriesDialog.start">start</a></td>
133 <td>Public slot to start the git remote command.</td>
134 </tr>
135 </table>
136 <h3>Static Methods</h3>
137 <table>
138 <tr><td>None</td></tr>
139 </table>
140 <a NAME="GitRemoteRepositoriesDialog.__init__" ID="GitRemoteRepositoriesDialog.__init__"></a>
141 <h4>GitRemoteRepositoriesDialog (Constructor)</h4>
142 <b>GitRemoteRepositoriesDialog</b>(<i>vcs, parent=None</i>)
143 <p>
144 Constructor
145 </p><dl>
146 <dt><i>vcs</i></dt>
147 <dd>
148 reference to the vcs object
149 </dd><dt><i>parent</i></dt>
150 <dd>
151 parent widget (QWidget)
152 </dd>
153 </dl><a NAME="GitRemoteRepositoriesDialog.__finish" ID="GitRemoteRepositoriesDialog.__finish"></a>
154 <h4>GitRemoteRepositoriesDialog.__finish</h4>
155 <b>__finish</b>(<i></i>)
156 <p>
157 Private slot called when the process finished or the user pressed
158 the button.
159 </p><a NAME="GitRemoteRepositoriesDialog.__generateItem" ID="GitRemoteRepositoriesDialog.__generateItem"></a>
160 <h4>GitRemoteRepositoriesDialog.__generateItem</h4>
161 <b>__generateItem</b>(<i>name, url, oper</i>)
162 <p>
163 Private method to generate a status item in the status list.
164 </p><dl>
165 <dt><i>name</i></dt>
166 <dd>
167 name of the remote repository (string)
168 </dd><dt><i>url</i></dt>
169 <dd>
170 URL of the remote repository (string)
171 </dd><dt><i>oper</i></dt>
172 <dd>
173 operation the remote repository may be used for (string)
174 </dd>
175 </dl><a NAME="GitRemoteRepositoriesDialog.__procFinished" ID="GitRemoteRepositoriesDialog.__procFinished"></a>
176 <h4>GitRemoteRepositoriesDialog.__procFinished</h4>
177 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
178 <p>
179 Private slot connected to the finished signal.
180 </p><dl>
181 <dt><i>exitCode</i></dt>
182 <dd>
183 exit code of the process (integer)
184 </dd><dt><i>exitStatus</i></dt>
185 <dd>
186 exit status of the process (QProcess.ExitStatus)
187 </dd>
188 </dl><a NAME="GitRemoteRepositoriesDialog.__readStderr" ID="GitRemoteRepositoriesDialog.__readStderr"></a>
189 <h4>GitRemoteRepositoriesDialog.__readStderr</h4>
190 <b>__readStderr</b>(<i></i>)
191 <p>
192 Private slot to handle the readyReadStandardError signal.
193 </p><p>
194 It reads the error output of the process and inserts it into the
195 error pane.
196 </p><a NAME="GitRemoteRepositoriesDialog.__readStdout" ID="GitRemoteRepositoriesDialog.__readStdout"></a>
197 <h4>GitRemoteRepositoriesDialog.__readStdout</h4>
198 <b>__readStdout</b>(<i></i>)
199 <p>
200 Private slot to handle the readyReadStandardOutput signal.
201 </p><p>
202 It reads the output of the process, formats it and inserts it into
203 the contents pane.
204 </p><a NAME="GitRemoteRepositoriesDialog.__resizeColumns" ID="GitRemoteRepositoriesDialog.__resizeColumns"></a>
205 <h4>GitRemoteRepositoriesDialog.__resizeColumns</h4>
206 <b>__resizeColumns</b>(<i></i>)
207 <p>
208 Private method to resize the list columns.
209 </p><a NAME="GitRemoteRepositoriesDialog.__resort" ID="GitRemoteRepositoriesDialog.__resort"></a>
210 <h4>GitRemoteRepositoriesDialog.__resort</h4>
211 <b>__resort</b>(<i></i>)
212 <p>
213 Private method to resort the list.
214 </p><a NAME="GitRemoteRepositoriesDialog.__updateButtons" ID="GitRemoteRepositoriesDialog.__updateButtons"></a>
215 <h4>GitRemoteRepositoriesDialog.__updateButtons</h4>
216 <b>__updateButtons</b>(<i></i>)
217 <p>
218 Private method to update the buttons status.
219 </p><a NAME="GitRemoteRepositoriesDialog.closeEvent" ID="GitRemoteRepositoriesDialog.closeEvent"></a>
220 <h4>GitRemoteRepositoriesDialog.closeEvent</h4>
221 <b>closeEvent</b>(<i>e</i>)
222 <p>
223 Protected slot implementing a close event handler.
224 </p><dl>
225 <dt><i>e</i></dt>
226 <dd>
227 close event (QCloseEvent)
228 </dd>
229 </dl><a NAME="GitRemoteRepositoriesDialog.keyPressEvent" ID="GitRemoteRepositoriesDialog.keyPressEvent"></a>
230 <h4>GitRemoteRepositoriesDialog.keyPressEvent</h4>
231 <b>keyPressEvent</b>(<i>evt</i>)
232 <p>
233 Protected slot to handle a key press event.
234 </p><dl>
235 <dt><i>evt</i></dt>
236 <dd>
237 the key press event (QKeyEvent)
238 </dd>
239 </dl><a NAME="GitRemoteRepositoriesDialog.on_addButton_clicked" ID="GitRemoteRepositoriesDialog.on_addButton_clicked"></a>
240 <h4>GitRemoteRepositoriesDialog.on_addButton_clicked</h4>
241 <b>on_addButton_clicked</b>(<i></i>)
242 <p>
243 Private slot to add a remote repository.
244 </p><a NAME="GitRemoteRepositoriesDialog.on_buttonBox_clicked" ID="GitRemoteRepositoriesDialog.on_buttonBox_clicked"></a>
245 <h4>GitRemoteRepositoriesDialog.on_buttonBox_clicked</h4>
246 <b>on_buttonBox_clicked</b>(<i>button</i>)
247 <p>
248 Private slot called by a button of the button box clicked.
249 </p><dl>
250 <dt><i>button</i></dt>
251 <dd>
252 button that was clicked (QAbstractButton)
253 </dd>
254 </dl><a NAME="GitRemoteRepositoriesDialog.on_changeUrlButton_clicked" ID="GitRemoteRepositoriesDialog.on_changeUrlButton_clicked"></a>
255 <h4>GitRemoteRepositoriesDialog.on_changeUrlButton_clicked</h4>
256 <b>on_changeUrlButton_clicked</b>(<i></i>)
257 <p>
258 Private slot to change the URL of a remote repository.
259 </p><a NAME="GitRemoteRepositoriesDialog.on_credentialsButton_clicked" ID="GitRemoteRepositoriesDialog.on_credentialsButton_clicked"></a>
260 <h4>GitRemoteRepositoriesDialog.on_credentialsButton_clicked</h4>
261 <b>on_credentialsButton_clicked</b>(<i></i>)
262 <p>
263 Private slot to change the credentials of a remote repository.
264 </p><a NAME="GitRemoteRepositoriesDialog.on_input_returnPressed" ID="GitRemoteRepositoriesDialog.on_input_returnPressed"></a>
265 <h4>GitRemoteRepositoriesDialog.on_input_returnPressed</h4>
266 <b>on_input_returnPressed</b>(<i></i>)
267 <p>
268 Private slot to handle the press of the return key in the input field.
269 </p><a NAME="GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled" ID="GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled"></a>
270 <h4>GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled</h4>
271 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
272 <p>
273 Private slot to handle the password checkbox toggled.
274 </p><dl>
275 <dt><i>isOn</i></dt>
276 <dd>
277 flag indicating the status of the check box (boolean)
278 </dd>
279 </dl><a NAME="GitRemoteRepositoriesDialog.on_pruneButton_clicked" ID="GitRemoteRepositoriesDialog.on_pruneButton_clicked"></a>
280 <h4>GitRemoteRepositoriesDialog.on_pruneButton_clicked</h4>
281 <b>on_pruneButton_clicked</b>(<i></i>)
282 <p>
283 Private slot to prune all stale remote-tracking branches.
284 </p><a NAME="GitRemoteRepositoriesDialog.on_refreshButton_clicked" ID="GitRemoteRepositoriesDialog.on_refreshButton_clicked"></a>
285 <h4>GitRemoteRepositoriesDialog.on_refreshButton_clicked</h4>
286 <b>on_refreshButton_clicked</b>(<i></i>)
287 <p>
288 Private slot to refresh the status display.
289 </p><a NAME="GitRemoteRepositoriesDialog.on_removeButton_clicked" ID="GitRemoteRepositoriesDialog.on_removeButton_clicked"></a>
290 <h4>GitRemoteRepositoriesDialog.on_removeButton_clicked</h4>
291 <b>on_removeButton_clicked</b>(<i></i>)
292 <p>
293 Private slot to remove a remote repository.
294 </p><a NAME="GitRemoteRepositoriesDialog.on_renameButton_clicked" ID="GitRemoteRepositoriesDialog.on_renameButton_clicked"></a>
295 <h4>GitRemoteRepositoriesDialog.on_renameButton_clicked</h4>
296 <b>on_renameButton_clicked</b>(<i></i>)
297 <p>
298 Private slot to rename a remote repository.
299 </p><a NAME="GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged" ID="GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged"></a>
300 <h4>GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged</h4>
301 <b>on_repolist_itemSelectionChanged</b>(<i></i>)
302 <p>
303 Private slot to act upon changes of selected items.
304 </p><a NAME="GitRemoteRepositoriesDialog.on_sendButton_clicked" ID="GitRemoteRepositoriesDialog.on_sendButton_clicked"></a>
305 <h4>GitRemoteRepositoriesDialog.on_sendButton_clicked</h4>
306 <b>on_sendButton_clicked</b>(<i></i>)
307 <p>
308 Private slot to send the input to the git process.
309 </p><a NAME="GitRemoteRepositoriesDialog.on_showInfoButton_clicked" ID="GitRemoteRepositoriesDialog.on_showInfoButton_clicked"></a>
310 <h4>GitRemoteRepositoriesDialog.on_showInfoButton_clicked</h4>
311 <b>on_showInfoButton_clicked</b>(<i></i>)
312 <p>
313 Private slot to show information about a remote repository.
314 </p><a NAME="GitRemoteRepositoriesDialog.start" ID="GitRemoteRepositoriesDialog.start"></a>
315 <h4>GitRemoteRepositoriesDialog.start</h4>
316 <b>start</b>(<i>projectDir</i>)
317 <p>
318 Public slot to start the git remote command.
319 </p><dl>
320 <dt><i>projectDir</i></dt>
321 <dd>
322 name of the project directory (string)
323 </dd>
324 </dl>
325 <div align="right"><a href="#top">Up</a></div>
326 <hr />
327 </body></html>

eric ide

mercurial