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

changeset 6020
baf6da1ae288
child 6324
b11c36cba2a1
equal deleted inserted replaced
6019:58ecdaf0b789 6020:baf6da1ae288
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_input_returnPressed">on_input_returnPressed</a></td>
100 <td>Private slot to handle the press of the return key in the input field.</td>
101 </tr><tr>
102 <td><a href="#GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
103 <td>Private slot to handle the password checkbox toggled.</td>
104 </tr><tr>
105 <td><a href="#GitRemoteRepositoriesDialog.on_pruneButton_clicked">on_pruneButton_clicked</a></td>
106 <td>Private slot to prune all stale remote-tracking branches.</td>
107 </tr><tr>
108 <td><a href="#GitRemoteRepositoriesDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
109 <td>Private slot to refresh the status display.</td>
110 </tr><tr>
111 <td><a href="#GitRemoteRepositoriesDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
112 <td>Private slot to remove a remote repository.</td>
113 </tr><tr>
114 <td><a href="#GitRemoteRepositoriesDialog.on_renameButton_clicked">on_renameButton_clicked</a></td>
115 <td>Private slot to rename a remote repository.</td>
116 </tr><tr>
117 <td><a href="#GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged">on_repolist_itemSelectionChanged</a></td>
118 <td>Private slot to act upon changes of selected items.</td>
119 </tr><tr>
120 <td><a href="#GitRemoteRepositoriesDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
121 <td>Private slot to send the input to the git process.</td>
122 </tr><tr>
123 <td><a href="#GitRemoteRepositoriesDialog.on_showInfoButton_clicked">on_showInfoButton_clicked</a></td>
124 <td>Private slot to show information about a remote repository.</td>
125 </tr><tr>
126 <td><a href="#GitRemoteRepositoriesDialog.start">start</a></td>
127 <td>Public slot to start the git remote command.</td>
128 </tr>
129 </table>
130 <h3>Static Methods</h3>
131 <table>
132 <tr><td>None</td></tr>
133 </table>
134 <a NAME="GitRemoteRepositoriesDialog.__init__" ID="GitRemoteRepositoriesDialog.__init__"></a>
135 <h4>GitRemoteRepositoriesDialog (Constructor)</h4>
136 <b>GitRemoteRepositoriesDialog</b>(<i>vcs, parent=None</i>)
137 <p>
138 Constructor
139 </p><dl>
140 <dt><i>vcs</i></dt>
141 <dd>
142 reference to the vcs object
143 </dd><dt><i>parent</i></dt>
144 <dd>
145 parent widget (QWidget)
146 </dd>
147 </dl><a NAME="GitRemoteRepositoriesDialog.__finish" ID="GitRemoteRepositoriesDialog.__finish"></a>
148 <h4>GitRemoteRepositoriesDialog.__finish</h4>
149 <b>__finish</b>(<i></i>)
150 <p>
151 Private slot called when the process finished or the user pressed
152 the button.
153 </p><a NAME="GitRemoteRepositoriesDialog.__generateItem" ID="GitRemoteRepositoriesDialog.__generateItem"></a>
154 <h4>GitRemoteRepositoriesDialog.__generateItem</h4>
155 <b>__generateItem</b>(<i>name, url, oper</i>)
156 <p>
157 Private method to generate a status item in the status list.
158 </p><dl>
159 <dt><i>name</i></dt>
160 <dd>
161 name of the remote repository (string)
162 </dd><dt><i>url</i></dt>
163 <dd>
164 URL of the remote repository (string)
165 </dd><dt><i>oper</i></dt>
166 <dd>
167 operation the remote repository may be used for (string)
168 </dd>
169 </dl><a NAME="GitRemoteRepositoriesDialog.__procFinished" ID="GitRemoteRepositoriesDialog.__procFinished"></a>
170 <h4>GitRemoteRepositoriesDialog.__procFinished</h4>
171 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
172 <p>
173 Private slot connected to the finished signal.
174 </p><dl>
175 <dt><i>exitCode</i></dt>
176 <dd>
177 exit code of the process (integer)
178 </dd><dt><i>exitStatus</i></dt>
179 <dd>
180 exit status of the process (QProcess.ExitStatus)
181 </dd>
182 </dl><a NAME="GitRemoteRepositoriesDialog.__readStderr" ID="GitRemoteRepositoriesDialog.__readStderr"></a>
183 <h4>GitRemoteRepositoriesDialog.__readStderr</h4>
184 <b>__readStderr</b>(<i></i>)
185 <p>
186 Private slot to handle the readyReadStandardError signal.
187 </p><p>
188 It reads the error output of the process and inserts it into the
189 error pane.
190 </p><a NAME="GitRemoteRepositoriesDialog.__readStdout" ID="GitRemoteRepositoriesDialog.__readStdout"></a>
191 <h4>GitRemoteRepositoriesDialog.__readStdout</h4>
192 <b>__readStdout</b>(<i></i>)
193 <p>
194 Private slot to handle the readyReadStandardOutput signal.
195 </p><p>
196 It reads the output of the process, formats it and inserts it into
197 the contents pane.
198 </p><a NAME="GitRemoteRepositoriesDialog.__resizeColumns" ID="GitRemoteRepositoriesDialog.__resizeColumns"></a>
199 <h4>GitRemoteRepositoriesDialog.__resizeColumns</h4>
200 <b>__resizeColumns</b>(<i></i>)
201 <p>
202 Private method to resize the list columns.
203 </p><a NAME="GitRemoteRepositoriesDialog.__resort" ID="GitRemoteRepositoriesDialog.__resort"></a>
204 <h4>GitRemoteRepositoriesDialog.__resort</h4>
205 <b>__resort</b>(<i></i>)
206 <p>
207 Private method to resort the list.
208 </p><a NAME="GitRemoteRepositoriesDialog.__updateButtons" ID="GitRemoteRepositoriesDialog.__updateButtons"></a>
209 <h4>GitRemoteRepositoriesDialog.__updateButtons</h4>
210 <b>__updateButtons</b>(<i></i>)
211 <p>
212 Private method to update the buttons status.
213 </p><a NAME="GitRemoteRepositoriesDialog.closeEvent" ID="GitRemoteRepositoriesDialog.closeEvent"></a>
214 <h4>GitRemoteRepositoriesDialog.closeEvent</h4>
215 <b>closeEvent</b>(<i>e</i>)
216 <p>
217 Protected slot implementing a close event handler.
218 </p><dl>
219 <dt><i>e</i></dt>
220 <dd>
221 close event (QCloseEvent)
222 </dd>
223 </dl><a NAME="GitRemoteRepositoriesDialog.keyPressEvent" ID="GitRemoteRepositoriesDialog.keyPressEvent"></a>
224 <h4>GitRemoteRepositoriesDialog.keyPressEvent</h4>
225 <b>keyPressEvent</b>(<i>evt</i>)
226 <p>
227 Protected slot to handle a key press event.
228 </p><dl>
229 <dt><i>evt</i></dt>
230 <dd>
231 the key press event (QKeyEvent)
232 </dd>
233 </dl><a NAME="GitRemoteRepositoriesDialog.on_addButton_clicked" ID="GitRemoteRepositoriesDialog.on_addButton_clicked"></a>
234 <h4>GitRemoteRepositoriesDialog.on_addButton_clicked</h4>
235 <b>on_addButton_clicked</b>(<i></i>)
236 <p>
237 Private slot to add a remote repository.
238 </p><a NAME="GitRemoteRepositoriesDialog.on_buttonBox_clicked" ID="GitRemoteRepositoriesDialog.on_buttonBox_clicked"></a>
239 <h4>GitRemoteRepositoriesDialog.on_buttonBox_clicked</h4>
240 <b>on_buttonBox_clicked</b>(<i>button</i>)
241 <p>
242 Private slot called by a button of the button box clicked.
243 </p><dl>
244 <dt><i>button</i></dt>
245 <dd>
246 button that was clicked (QAbstractButton)
247 </dd>
248 </dl><a NAME="GitRemoteRepositoriesDialog.on_input_returnPressed" ID="GitRemoteRepositoriesDialog.on_input_returnPressed"></a>
249 <h4>GitRemoteRepositoriesDialog.on_input_returnPressed</h4>
250 <b>on_input_returnPressed</b>(<i></i>)
251 <p>
252 Private slot to handle the press of the return key in the input field.
253 </p><a NAME="GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled" ID="GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled"></a>
254 <h4>GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled</h4>
255 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
256 <p>
257 Private slot to handle the password checkbox toggled.
258 </p><dl>
259 <dt><i>isOn</i></dt>
260 <dd>
261 flag indicating the status of the check box (boolean)
262 </dd>
263 </dl><a NAME="GitRemoteRepositoriesDialog.on_pruneButton_clicked" ID="GitRemoteRepositoriesDialog.on_pruneButton_clicked"></a>
264 <h4>GitRemoteRepositoriesDialog.on_pruneButton_clicked</h4>
265 <b>on_pruneButton_clicked</b>(<i></i>)
266 <p>
267 Private slot to prune all stale remote-tracking branches.
268 </p><a NAME="GitRemoteRepositoriesDialog.on_refreshButton_clicked" ID="GitRemoteRepositoriesDialog.on_refreshButton_clicked"></a>
269 <h4>GitRemoteRepositoriesDialog.on_refreshButton_clicked</h4>
270 <b>on_refreshButton_clicked</b>(<i></i>)
271 <p>
272 Private slot to refresh the status display.
273 </p><a NAME="GitRemoteRepositoriesDialog.on_removeButton_clicked" ID="GitRemoteRepositoriesDialog.on_removeButton_clicked"></a>
274 <h4>GitRemoteRepositoriesDialog.on_removeButton_clicked</h4>
275 <b>on_removeButton_clicked</b>(<i></i>)
276 <p>
277 Private slot to remove a remote repository.
278 </p><a NAME="GitRemoteRepositoriesDialog.on_renameButton_clicked" ID="GitRemoteRepositoriesDialog.on_renameButton_clicked"></a>
279 <h4>GitRemoteRepositoriesDialog.on_renameButton_clicked</h4>
280 <b>on_renameButton_clicked</b>(<i></i>)
281 <p>
282 Private slot to rename a remote repository.
283 </p><a NAME="GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged" ID="GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged"></a>
284 <h4>GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged</h4>
285 <b>on_repolist_itemSelectionChanged</b>(<i></i>)
286 <p>
287 Private slot to act upon changes of selected items.
288 </p><a NAME="GitRemoteRepositoriesDialog.on_sendButton_clicked" ID="GitRemoteRepositoriesDialog.on_sendButton_clicked"></a>
289 <h4>GitRemoteRepositoriesDialog.on_sendButton_clicked</h4>
290 <b>on_sendButton_clicked</b>(<i></i>)
291 <p>
292 Private slot to send the input to the git process.
293 </p><a NAME="GitRemoteRepositoriesDialog.on_showInfoButton_clicked" ID="GitRemoteRepositoriesDialog.on_showInfoButton_clicked"></a>
294 <h4>GitRemoteRepositoriesDialog.on_showInfoButton_clicked</h4>
295 <b>on_showInfoButton_clicked</b>(<i></i>)
296 <p>
297 Private slot to show information about a remote repository.
298 </p><a NAME="GitRemoteRepositoriesDialog.start" ID="GitRemoteRepositoriesDialog.start"></a>
299 <h4>GitRemoteRepositoriesDialog.start</h4>
300 <b>start</b>(<i>projectDir</i>)
301 <p>
302 Public slot to start the git remote command.
303 </p><dl>
304 <dt><i>projectDir</i></dt>
305 <dd>
306 name of the project directory (string)
307 </dd>
308 </dl>
309 <div align="right"><a href="#top">Up</a></div>
310 <hr />
311 </body></html>

eric ide

mercurial