src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnRepoBrowserDialog.html

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

eric ide

mercurial