eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnRepoBrowserDialog.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.vcsSubversion.SvnRepoBrowserDialog</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.vcsSubversion.SvnRepoBrowserDialog</h1>
24
25 <p>
26 Module implementing the subversion repository browser dialog.
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="#SvnRepoBrowserDialog">SvnRepoBrowserDialog</a></td>
39 <td>Class implementing the subversion repository browser dialog.</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="SvnRepoBrowserDialog" ID="SvnRepoBrowserDialog"></a>
50 <h2>SvnRepoBrowserDialog</h2>
51
52 <p>
53 Class implementing the subversion repository browser dialog.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_SvnRepoBrowserDialog
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="#SvnRepoBrowserDialog.__init__">SvnRepoBrowserDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#SvnRepoBrowserDialog.__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="#SvnRepoBrowserDialog.__generateItem">__generateItem</a></td>
81 <td>Private method to generate a tree item in the repository tree.</td>
82 </tr>
83 <tr>
84 <td><a href="#SvnRepoBrowserDialog.__listRepo">__listRepo</a></td>
85 <td>Private method to perform the svn list command.</td>
86 </tr>
87 <tr>
88 <td><a href="#SvnRepoBrowserDialog.__normalizeUrl">__normalizeUrl</a></td>
89 <td>Private method to normalite the url.</td>
90 </tr>
91 <tr>
92 <td><a href="#SvnRepoBrowserDialog.__procFinished">__procFinished</a></td>
93 <td>Private slot connected to the finished signal.</td>
94 </tr>
95 <tr>
96 <td><a href="#SvnRepoBrowserDialog.__readStderr">__readStderr</a></td>
97 <td>Private slot to handle the readyReadStandardError signal.</td>
98 </tr>
99 <tr>
100 <td><a href="#SvnRepoBrowserDialog.__readStdout">__readStdout</a></td>
101 <td>Private slot to handle the readyReadStandardOutput signal.</td>
102 </tr>
103 <tr>
104 <td><a href="#SvnRepoBrowserDialog.__repoRoot">__repoRoot</a></td>
105 <td>Private method to get the repository root using the svn info command.</td>
106 </tr>
107 <tr>
108 <td><a href="#SvnRepoBrowserDialog.__resizeColumns">__resizeColumns</a></td>
109 <td>Private method to resize the tree columns.</td>
110 </tr>
111 <tr>
112 <td><a href="#SvnRepoBrowserDialog.__resort">__resort</a></td>
113 <td>Private method to resort the tree.</td>
114 </tr>
115 <tr>
116 <td><a href="#SvnRepoBrowserDialog.accept">accept</a></td>
117 <td>Public slot called when the dialog is accepted.</td>
118 </tr>
119 <tr>
120 <td><a href="#SvnRepoBrowserDialog.closeEvent">closeEvent</a></td>
121 <td>Protected slot implementing a close event handler.</td>
122 </tr>
123 <tr>
124 <td><a href="#SvnRepoBrowserDialog.getSelectedUrl">getSelectedUrl</a></td>
125 <td>Public method to retrieve the selected repository URL.</td>
126 </tr>
127 <tr>
128 <td><a href="#SvnRepoBrowserDialog.keyPressEvent">keyPressEvent</a></td>
129 <td>Protected slot to handle a key press event.</td>
130 </tr>
131 <tr>
132 <td><a href="#SvnRepoBrowserDialog.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="#SvnRepoBrowserDialog.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="#SvnRepoBrowserDialog.on_repoTree_itemCollapsed">on_repoTree_itemCollapsed</a></td>
141 <td>Private slot called when an item is collapsed.</td>
142 </tr>
143 <tr>
144 <td><a href="#SvnRepoBrowserDialog.on_repoTree_itemExpanded">on_repoTree_itemExpanded</a></td>
145 <td>Private slot called when an item is expanded.</td>
146 </tr>
147 <tr>
148 <td><a href="#SvnRepoBrowserDialog.on_repoTree_itemSelectionChanged">on_repoTree_itemSelectionChanged</a></td>
149 <td>Private slot called when the selection changes.</td>
150 </tr>
151 <tr>
152 <td><a href="#SvnRepoBrowserDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
153 <td>Private slot to send the input to the subversion process.</td>
154 </tr>
155 <tr>
156 <td><a href="#SvnRepoBrowserDialog.on_urlCombo_currentIndexChanged">on_urlCombo_currentIndexChanged</a></td>
157 <td>Private slot called, when a new repository URL is entered or selected.</td>
158 </tr>
159 <tr>
160 <td><a href="#SvnRepoBrowserDialog.start">start</a></td>
161 <td>Public slot to start the svn info command.</td>
162 </tr>
163 </table>
164 <h3>Static Methods</h3>
165
166 <table>
167 <tr><td>None</td></tr>
168 </table>
169
170 <a NAME="SvnRepoBrowserDialog.__init__" ID="SvnRepoBrowserDialog.__init__"></a>
171 <h4>SvnRepoBrowserDialog (Constructor)</h4>
172 <b>SvnRepoBrowserDialog</b>(<i>vcs, mode="browse", parent=None</i>)
173
174 <p>
175 Constructor
176 </p>
177 <dl>
178
179 <dt><i>vcs</i></dt>
180 <dd>
181 reference to the vcs object
182 </dd>
183 <dt><i>mode</i></dt>
184 <dd>
185 mode of the dialog (string, "browse" or "select")
186 </dd>
187 <dt><i>parent</i></dt>
188 <dd>
189 parent widget (QWidget)
190 </dd>
191 </dl>
192 <a NAME="SvnRepoBrowserDialog.__finish" ID="SvnRepoBrowserDialog.__finish"></a>
193 <h4>SvnRepoBrowserDialog.__finish</h4>
194 <b>__finish</b>(<i></i>)
195
196 <p>
197 Private slot called when the process finished or the user pressed the
198 button.
199 </p>
200 <a NAME="SvnRepoBrowserDialog.__generateItem" ID="SvnRepoBrowserDialog.__generateItem"></a>
201 <h4>SvnRepoBrowserDialog.__generateItem</h4>
202 <b>__generateItem</b>(<i>repopath, revision, author, size, date, nodekind, url</i>)
203
204 <p>
205 Private method to generate a tree item in the repository tree.
206 </p>
207 <dl>
208
209 <dt><i>repopath</i></dt>
210 <dd>
211 path of the item (string)
212 </dd>
213 <dt><i>revision</i></dt>
214 <dd>
215 revision info (string)
216 </dd>
217 <dt><i>author</i></dt>
218 <dd>
219 author info (string)
220 </dd>
221 <dt><i>size</i></dt>
222 <dd>
223 size info (string)
224 </dd>
225 <dt><i>date</i></dt>
226 <dd>
227 date info (string)
228 </dd>
229 <dt><i>nodekind</i></dt>
230 <dd>
231 node kind info (string, "dir" or "file")
232 </dd>
233 <dt><i>url</i></dt>
234 <dd>
235 url of the entry (string)
236 </dd>
237 </dl>
238 <dl>
239 <dt>Return:</dt>
240 <dd>
241 reference to the generated item (QTreeWidgetItem)
242 </dd>
243 </dl>
244 <a NAME="SvnRepoBrowserDialog.__listRepo" ID="SvnRepoBrowserDialog.__listRepo"></a>
245 <h4>SvnRepoBrowserDialog.__listRepo</h4>
246 <b>__listRepo</b>(<i>url, parent=None</i>)
247
248 <p>
249 Private method to perform the svn list command.
250 </p>
251 <dl>
252
253 <dt><i>url</i></dt>
254 <dd>
255 the repository URL to browse (string)
256 </dd>
257 <dt><i>parent</i></dt>
258 <dd>
259 reference to the item, the data should be appended to
260 (QTreeWidget or QTreeWidgetItem)
261 </dd>
262 </dl>
263 <a NAME="SvnRepoBrowserDialog.__normalizeUrl" ID="SvnRepoBrowserDialog.__normalizeUrl"></a>
264 <h4>SvnRepoBrowserDialog.__normalizeUrl</h4>
265 <b>__normalizeUrl</b>(<i>url</i>)
266
267 <p>
268 Private method to normalite the url.
269 </p>
270 <dl>
271
272 <dt><i>url</i></dt>
273 <dd>
274 the url to normalize (string)
275 </dd>
276 </dl>
277 <dl>
278 <dt>Return:</dt>
279 <dd>
280 normalized URL (string)
281 </dd>
282 </dl>
283 <a NAME="SvnRepoBrowserDialog.__procFinished" ID="SvnRepoBrowserDialog.__procFinished"></a>
284 <h4>SvnRepoBrowserDialog.__procFinished</h4>
285 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
286
287 <p>
288 Private slot connected to the finished signal.
289 </p>
290 <dl>
291
292 <dt><i>exitCode</i></dt>
293 <dd>
294 exit code of the process (integer)
295 </dd>
296 <dt><i>exitStatus</i></dt>
297 <dd>
298 exit status of the process (QProcess.ExitStatus)
299 </dd>
300 </dl>
301 <a NAME="SvnRepoBrowserDialog.__readStderr" ID="SvnRepoBrowserDialog.__readStderr"></a>
302 <h4>SvnRepoBrowserDialog.__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="SvnRepoBrowserDialog.__readStdout" ID="SvnRepoBrowserDialog.__readStdout"></a>
313 <h4>SvnRepoBrowserDialog.__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, formats it and inserts it into
321 the contents pane.
322 </p>
323 <a NAME="SvnRepoBrowserDialog.__repoRoot" ID="SvnRepoBrowserDialog.__repoRoot"></a>
324 <h4>SvnRepoBrowserDialog.__repoRoot</h4>
325 <b>__repoRoot</b>(<i>url</i>)
326
327 <p>
328 Private method to get the repository root using the svn info command.
329 </p>
330 <dl>
331
332 <dt><i>url</i></dt>
333 <dd>
334 the repository URL to browser (string)
335 </dd>
336 </dl>
337 <dl>
338 <dt>Return:</dt>
339 <dd>
340 repository root (string)
341 </dd>
342 </dl>
343 <a NAME="SvnRepoBrowserDialog.__resizeColumns" ID="SvnRepoBrowserDialog.__resizeColumns"></a>
344 <h4>SvnRepoBrowserDialog.__resizeColumns</h4>
345 <b>__resizeColumns</b>(<i></i>)
346
347 <p>
348 Private method to resize the tree columns.
349 </p>
350 <a NAME="SvnRepoBrowserDialog.__resort" ID="SvnRepoBrowserDialog.__resort"></a>
351 <h4>SvnRepoBrowserDialog.__resort</h4>
352 <b>__resort</b>(<i></i>)
353
354 <p>
355 Private method to resort the tree.
356 </p>
357 <a NAME="SvnRepoBrowserDialog.accept" ID="SvnRepoBrowserDialog.accept"></a>
358 <h4>SvnRepoBrowserDialog.accept</h4>
359 <b>accept</b>(<i></i>)
360
361 <p>
362 Public slot called when the dialog is accepted.
363 </p>
364 <a NAME="SvnRepoBrowserDialog.closeEvent" ID="SvnRepoBrowserDialog.closeEvent"></a>
365 <h4>SvnRepoBrowserDialog.closeEvent</h4>
366 <b>closeEvent</b>(<i>e</i>)
367
368 <p>
369 Protected slot implementing a close event handler.
370 </p>
371 <dl>
372
373 <dt><i>e</i></dt>
374 <dd>
375 close event (QCloseEvent)
376 </dd>
377 </dl>
378 <a NAME="SvnRepoBrowserDialog.getSelectedUrl" ID="SvnRepoBrowserDialog.getSelectedUrl"></a>
379 <h4>SvnRepoBrowserDialog.getSelectedUrl</h4>
380 <b>getSelectedUrl</b>(<i></i>)
381
382 <p>
383 Public method to retrieve the selected repository URL.
384 </p>
385 <dl>
386 <dt>Return:</dt>
387 <dd>
388 the selected repository URL (string)
389 </dd>
390 </dl>
391 <a NAME="SvnRepoBrowserDialog.keyPressEvent" ID="SvnRepoBrowserDialog.keyPressEvent"></a>
392 <h4>SvnRepoBrowserDialog.keyPressEvent</h4>
393 <b>keyPressEvent</b>(<i>evt</i>)
394
395 <p>
396 Protected slot to handle a key press event.
397 </p>
398 <dl>
399
400 <dt><i>evt</i></dt>
401 <dd>
402 the key press event (QKeyEvent)
403 </dd>
404 </dl>
405 <a NAME="SvnRepoBrowserDialog.on_input_returnPressed" ID="SvnRepoBrowserDialog.on_input_returnPressed"></a>
406 <h4>SvnRepoBrowserDialog.on_input_returnPressed</h4>
407 <b>on_input_returnPressed</b>(<i></i>)
408
409 <p>
410 Private slot to handle the press of the return key in the input field.
411 </p>
412 <a NAME="SvnRepoBrowserDialog.on_passwordCheckBox_toggled" ID="SvnRepoBrowserDialog.on_passwordCheckBox_toggled"></a>
413 <h4>SvnRepoBrowserDialog.on_passwordCheckBox_toggled</h4>
414 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
415
416 <p>
417 Private slot to handle the password checkbox toggled.
418 </p>
419 <dl>
420
421 <dt><i>isOn</i></dt>
422 <dd>
423 flag indicating the status of the check box (boolean)
424 </dd>
425 </dl>
426 <a NAME="SvnRepoBrowserDialog.on_repoTree_itemCollapsed" ID="SvnRepoBrowserDialog.on_repoTree_itemCollapsed"></a>
427 <h4>SvnRepoBrowserDialog.on_repoTree_itemCollapsed</h4>
428 <b>on_repoTree_itemCollapsed</b>(<i>item</i>)
429
430 <p>
431 Private slot called when an item is collapsed.
432 </p>
433 <dl>
434
435 <dt><i>item</i></dt>
436 <dd>
437 reference to the item to be collapsed (QTreeWidgetItem)
438 </dd>
439 </dl>
440 <a NAME="SvnRepoBrowserDialog.on_repoTree_itemExpanded" ID="SvnRepoBrowserDialog.on_repoTree_itemExpanded"></a>
441 <h4>SvnRepoBrowserDialog.on_repoTree_itemExpanded</h4>
442 <b>on_repoTree_itemExpanded</b>(<i>item</i>)
443
444 <p>
445 Private slot called when an item is expanded.
446 </p>
447 <dl>
448
449 <dt><i>item</i></dt>
450 <dd>
451 reference to the item to be expanded (QTreeWidgetItem)
452 </dd>
453 </dl>
454 <a NAME="SvnRepoBrowserDialog.on_repoTree_itemSelectionChanged" ID="SvnRepoBrowserDialog.on_repoTree_itemSelectionChanged"></a>
455 <h4>SvnRepoBrowserDialog.on_repoTree_itemSelectionChanged</h4>
456 <b>on_repoTree_itemSelectionChanged</b>(<i></i>)
457
458 <p>
459 Private slot called when the selection changes.
460 </p>
461 <a NAME="SvnRepoBrowserDialog.on_sendButton_clicked" ID="SvnRepoBrowserDialog.on_sendButton_clicked"></a>
462 <h4>SvnRepoBrowserDialog.on_sendButton_clicked</h4>
463 <b>on_sendButton_clicked</b>(<i></i>)
464
465 <p>
466 Private slot to send the input to the subversion process.
467 </p>
468 <a NAME="SvnRepoBrowserDialog.on_urlCombo_currentIndexChanged" ID="SvnRepoBrowserDialog.on_urlCombo_currentIndexChanged"></a>
469 <h4>SvnRepoBrowserDialog.on_urlCombo_currentIndexChanged</h4>
470 <b>on_urlCombo_currentIndexChanged</b>(<i>index</i>)
471
472 <p>
473 Private slot called, when a new repository URL is entered or selected.
474 </p>
475 <dl>
476
477 <dt><i>index</i> (int)</dt>
478 <dd>
479 index of the current item
480 </dd>
481 </dl>
482 <a NAME="SvnRepoBrowserDialog.start" ID="SvnRepoBrowserDialog.start"></a>
483 <h4>SvnRepoBrowserDialog.start</h4>
484 <b>start</b>(<i>url</i>)
485
486 <p>
487 Public slot to start the svn info command.
488 </p>
489 <dl>
490
491 <dt><i>url</i></dt>
492 <dd>
493 the repository URL to browser (string)
494 </dd>
495 </dl>
496 <div align="right"><a href="#top">Up</a></div>
497 <hr />
498 </body></html>

eric ide

mercurial