Documentation/Source/eric6.Plugins.VcsPlugins.vcsSubversion.SvnRepoBrowserDialog.html

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsSubversion.SvnRepoBrowserDialog</h1>
23 <p>
24 Module implementing the subversion repository browser dialog.
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="#SvnRepoBrowserDialog">SvnRepoBrowserDialog</a></td>
34 <td>Class implementing the subversion repository browser dialog.</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="SvnRepoBrowserDialog" ID="SvnRepoBrowserDialog"></a>
43 <h2>SvnRepoBrowserDialog</h2>
44 <p>
45 Class implementing the subversion repository browser dialog.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_SvnRepoBrowserDialog
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="#SvnRepoBrowserDialog.__init__">SvnRepoBrowserDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#SvnRepoBrowserDialog.__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="#SvnRepoBrowserDialog.__generateItem">__generateItem</a></td>
67 <td>Private method to generate a tree item in the repository tree.</td>
68 </tr><tr>
69 <td><a href="#SvnRepoBrowserDialog.__listRepo">__listRepo</a></td>
70 <td>Private method to perform the svn list command.</td>
71 </tr><tr>
72 <td><a href="#SvnRepoBrowserDialog.__normalizeUrl">__normalizeUrl</a></td>
73 <td>Private method to normalite the url.</td>
74 </tr><tr>
75 <td><a href="#SvnRepoBrowserDialog.__procFinished">__procFinished</a></td>
76 <td>Private slot connected to the finished signal.</td>
77 </tr><tr>
78 <td><a href="#SvnRepoBrowserDialog.__readStderr">__readStderr</a></td>
79 <td>Private slot to handle the readyReadStandardError signal.</td>
80 </tr><tr>
81 <td><a href="#SvnRepoBrowserDialog.__readStdout">__readStdout</a></td>
82 <td>Private slot to handle the readyReadStandardOutput signal.</td>
83 </tr><tr>
84 <td><a href="#SvnRepoBrowserDialog.__repoRoot">__repoRoot</a></td>
85 <td>Private method to get the repository root using the svn info command.</td>
86 </tr><tr>
87 <td><a href="#SvnRepoBrowserDialog.__resizeColumns">__resizeColumns</a></td>
88 <td>Private method to resize the tree columns.</td>
89 </tr><tr>
90 <td><a href="#SvnRepoBrowserDialog.__resort">__resort</a></td>
91 <td>Private method to resort the tree.</td>
92 </tr><tr>
93 <td><a href="#SvnRepoBrowserDialog.accept">accept</a></td>
94 <td>Public slot called when the dialog is accepted.</td>
95 </tr><tr>
96 <td><a href="#SvnRepoBrowserDialog.closeEvent">closeEvent</a></td>
97 <td>Protected slot implementing a close event handler.</td>
98 </tr><tr>
99 <td><a href="#SvnRepoBrowserDialog.getSelectedUrl">getSelectedUrl</a></td>
100 <td>Public method to retrieve the selected repository URL.</td>
101 </tr><tr>
102 <td><a href="#SvnRepoBrowserDialog.keyPressEvent">keyPressEvent</a></td>
103 <td>Protected slot to handle a key press event.</td>
104 </tr><tr>
105 <td><a href="#SvnRepoBrowserDialog.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="#SvnRepoBrowserDialog.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="#SvnRepoBrowserDialog.on_repoTree_itemCollapsed">on_repoTree_itemCollapsed</a></td>
112 <td>Private slot called when an item is collapsed.</td>
113 </tr><tr>
114 <td><a href="#SvnRepoBrowserDialog.on_repoTree_itemExpanded">on_repoTree_itemExpanded</a></td>
115 <td>Private slot called when an item is expanded.</td>
116 </tr><tr>
117 <td><a href="#SvnRepoBrowserDialog.on_repoTree_itemSelectionChanged">on_repoTree_itemSelectionChanged</a></td>
118 <td>Private slot called when the selection changes.</td>
119 </tr><tr>
120 <td><a href="#SvnRepoBrowserDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
121 <td>Private slot to send the input to the subversion process.</td>
122 </tr><tr>
123 <td><a href="#SvnRepoBrowserDialog.on_urlCombo_currentIndexChanged">on_urlCombo_currentIndexChanged</a></td>
124 <td>Private slot called, when a new repository URL is entered or selected.</td>
125 </tr><tr>
126 <td><a href="#SvnRepoBrowserDialog.start">start</a></td>
127 <td>Public slot to start the svn info command.</td>
128 </tr>
129 </table>
130 <h3>Static Methods</h3>
131 <table>
132 <tr><td>None</td></tr>
133 </table>
134 <a NAME="SvnRepoBrowserDialog.__init__" ID="SvnRepoBrowserDialog.__init__"></a>
135 <h4>SvnRepoBrowserDialog (Constructor)</h4>
136 <b>SvnRepoBrowserDialog</b>(<i>vcs, mode="browse", 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>mode</i></dt>
144 <dd>
145 mode of the dialog (string, "browse" or "select")
146 </dd><dt><i>parent</i></dt>
147 <dd>
148 parent widget (QWidget)
149 </dd>
150 </dl><a NAME="SvnRepoBrowserDialog.__finish" ID="SvnRepoBrowserDialog.__finish"></a>
151 <h4>SvnRepoBrowserDialog.__finish</h4>
152 <b>__finish</b>(<i></i>)
153 <p>
154 Private slot called when the process finished or the user pressed the
155 button.
156 </p><a NAME="SvnRepoBrowserDialog.__generateItem" ID="SvnRepoBrowserDialog.__generateItem"></a>
157 <h4>SvnRepoBrowserDialog.__generateItem</h4>
158 <b>__generateItem</b>(<i>repopath, revision, author, size, date, nodekind, url</i>)
159 <p>
160 Private method to generate a tree item in the repository tree.
161 </p><dl>
162 <dt><i>repopath</i></dt>
163 <dd>
164 path of the item (string)
165 </dd><dt><i>revision</i></dt>
166 <dd>
167 revision info (string)
168 </dd><dt><i>author</i></dt>
169 <dd>
170 author info (string)
171 </dd><dt><i>size</i></dt>
172 <dd>
173 size info (string)
174 </dd><dt><i>date</i></dt>
175 <dd>
176 date info (string)
177 </dd><dt><i>nodekind</i></dt>
178 <dd>
179 node kind info (string, "dir" or "file")
180 </dd><dt><i>url</i></dt>
181 <dd>
182 url of the entry (string)
183 </dd>
184 </dl><dl>
185 <dt>Returns:</dt>
186 <dd>
187 reference to the generated item (QTreeWidgetItem)
188 </dd>
189 </dl><a NAME="SvnRepoBrowserDialog.__listRepo" ID="SvnRepoBrowserDialog.__listRepo"></a>
190 <h4>SvnRepoBrowserDialog.__listRepo</h4>
191 <b>__listRepo</b>(<i>url, parent=None</i>)
192 <p>
193 Private method to perform the svn list command.
194 </p><dl>
195 <dt><i>url</i></dt>
196 <dd>
197 the repository URL to browse (string)
198 </dd><dt><i>parent</i></dt>
199 <dd>
200 reference to the item, the data should be appended to
201 (QTreeWidget or QTreeWidgetItem)
202 </dd>
203 </dl><a NAME="SvnRepoBrowserDialog.__normalizeUrl" ID="SvnRepoBrowserDialog.__normalizeUrl"></a>
204 <h4>SvnRepoBrowserDialog.__normalizeUrl</h4>
205 <b>__normalizeUrl</b>(<i>url</i>)
206 <p>
207 Private method to normalite the url.
208 </p><dl>
209 <dt><i>url</i></dt>
210 <dd>
211 the url to normalize (string)
212 </dd>
213 </dl><dl>
214 <dt>Returns:</dt>
215 <dd>
216 normalized URL (string)
217 </dd>
218 </dl><a NAME="SvnRepoBrowserDialog.__procFinished" ID="SvnRepoBrowserDialog.__procFinished"></a>
219 <h4>SvnRepoBrowserDialog.__procFinished</h4>
220 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
221 <p>
222 Private slot connected to the finished signal.
223 </p><dl>
224 <dt><i>exitCode</i></dt>
225 <dd>
226 exit code of the process (integer)
227 </dd><dt><i>exitStatus</i></dt>
228 <dd>
229 exit status of the process (QProcess.ExitStatus)
230 </dd>
231 </dl><a NAME="SvnRepoBrowserDialog.__readStderr" ID="SvnRepoBrowserDialog.__readStderr"></a>
232 <h4>SvnRepoBrowserDialog.__readStderr</h4>
233 <b>__readStderr</b>(<i></i>)
234 <p>
235 Private slot to handle the readyReadStandardError signal.
236 </p><p>
237 It reads the error output of the process and inserts it into the
238 error pane.
239 </p><a NAME="SvnRepoBrowserDialog.__readStdout" ID="SvnRepoBrowserDialog.__readStdout"></a>
240 <h4>SvnRepoBrowserDialog.__readStdout</h4>
241 <b>__readStdout</b>(<i></i>)
242 <p>
243 Private slot to handle the readyReadStandardOutput signal.
244 </p><p>
245 It reads the output of the process, formats it and inserts it into
246 the contents pane.
247 </p><a NAME="SvnRepoBrowserDialog.__repoRoot" ID="SvnRepoBrowserDialog.__repoRoot"></a>
248 <h4>SvnRepoBrowserDialog.__repoRoot</h4>
249 <b>__repoRoot</b>(<i>url</i>)
250 <p>
251 Private method to get the repository root using the svn info command.
252 </p><dl>
253 <dt><i>url</i></dt>
254 <dd>
255 the repository URL to browser (string)
256 </dd>
257 </dl><dl>
258 <dt>Returns:</dt>
259 <dd>
260 repository root (string)
261 </dd>
262 </dl><a NAME="SvnRepoBrowserDialog.__resizeColumns" ID="SvnRepoBrowserDialog.__resizeColumns"></a>
263 <h4>SvnRepoBrowserDialog.__resizeColumns</h4>
264 <b>__resizeColumns</b>(<i></i>)
265 <p>
266 Private method to resize the tree columns.
267 </p><a NAME="SvnRepoBrowserDialog.__resort" ID="SvnRepoBrowserDialog.__resort"></a>
268 <h4>SvnRepoBrowserDialog.__resort</h4>
269 <b>__resort</b>(<i></i>)
270 <p>
271 Private method to resort the tree.
272 </p><a NAME="SvnRepoBrowserDialog.accept" ID="SvnRepoBrowserDialog.accept"></a>
273 <h4>SvnRepoBrowserDialog.accept</h4>
274 <b>accept</b>(<i></i>)
275 <p>
276 Public slot called when the dialog is accepted.
277 </p><a NAME="SvnRepoBrowserDialog.closeEvent" ID="SvnRepoBrowserDialog.closeEvent"></a>
278 <h4>SvnRepoBrowserDialog.closeEvent</h4>
279 <b>closeEvent</b>(<i>e</i>)
280 <p>
281 Protected slot implementing a close event handler.
282 </p><dl>
283 <dt><i>e</i></dt>
284 <dd>
285 close event (QCloseEvent)
286 </dd>
287 </dl><a NAME="SvnRepoBrowserDialog.getSelectedUrl" ID="SvnRepoBrowserDialog.getSelectedUrl"></a>
288 <h4>SvnRepoBrowserDialog.getSelectedUrl</h4>
289 <b>getSelectedUrl</b>(<i></i>)
290 <p>
291 Public method to retrieve the selected repository URL.
292 </p><dl>
293 <dt>Returns:</dt>
294 <dd>
295 the selected repository URL (string)
296 </dd>
297 </dl><a NAME="SvnRepoBrowserDialog.keyPressEvent" ID="SvnRepoBrowserDialog.keyPressEvent"></a>
298 <h4>SvnRepoBrowserDialog.keyPressEvent</h4>
299 <b>keyPressEvent</b>(<i>evt</i>)
300 <p>
301 Protected slot to handle a key press event.
302 </p><dl>
303 <dt><i>evt</i></dt>
304 <dd>
305 the key press event (QKeyEvent)
306 </dd>
307 </dl><a NAME="SvnRepoBrowserDialog.on_input_returnPressed" ID="SvnRepoBrowserDialog.on_input_returnPressed"></a>
308 <h4>SvnRepoBrowserDialog.on_input_returnPressed</h4>
309 <b>on_input_returnPressed</b>(<i></i>)
310 <p>
311 Private slot to handle the press of the return key in the input field.
312 </p><a NAME="SvnRepoBrowserDialog.on_passwordCheckBox_toggled" ID="SvnRepoBrowserDialog.on_passwordCheckBox_toggled"></a>
313 <h4>SvnRepoBrowserDialog.on_passwordCheckBox_toggled</h4>
314 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
315 <p>
316 Private slot to handle the password checkbox toggled.
317 </p><dl>
318 <dt><i>isOn</i></dt>
319 <dd>
320 flag indicating the status of the check box (boolean)
321 </dd>
322 </dl><a NAME="SvnRepoBrowserDialog.on_repoTree_itemCollapsed" ID="SvnRepoBrowserDialog.on_repoTree_itemCollapsed"></a>
323 <h4>SvnRepoBrowserDialog.on_repoTree_itemCollapsed</h4>
324 <b>on_repoTree_itemCollapsed</b>(<i>item</i>)
325 <p>
326 Private slot called when an item is collapsed.
327 </p><dl>
328 <dt><i>item</i></dt>
329 <dd>
330 reference to the item to be collapsed (QTreeWidgetItem)
331 </dd>
332 </dl><a NAME="SvnRepoBrowserDialog.on_repoTree_itemExpanded" ID="SvnRepoBrowserDialog.on_repoTree_itemExpanded"></a>
333 <h4>SvnRepoBrowserDialog.on_repoTree_itemExpanded</h4>
334 <b>on_repoTree_itemExpanded</b>(<i>item</i>)
335 <p>
336 Private slot called when an item is expanded.
337 </p><dl>
338 <dt><i>item</i></dt>
339 <dd>
340 reference to the item to be expanded (QTreeWidgetItem)
341 </dd>
342 </dl><a NAME="SvnRepoBrowserDialog.on_repoTree_itemSelectionChanged" ID="SvnRepoBrowserDialog.on_repoTree_itemSelectionChanged"></a>
343 <h4>SvnRepoBrowserDialog.on_repoTree_itemSelectionChanged</h4>
344 <b>on_repoTree_itemSelectionChanged</b>(<i></i>)
345 <p>
346 Private slot called when the selection changes.
347 </p><a NAME="SvnRepoBrowserDialog.on_sendButton_clicked" ID="SvnRepoBrowserDialog.on_sendButton_clicked"></a>
348 <h4>SvnRepoBrowserDialog.on_sendButton_clicked</h4>
349 <b>on_sendButton_clicked</b>(<i></i>)
350 <p>
351 Private slot to send the input to the subversion process.
352 </p><a NAME="SvnRepoBrowserDialog.on_urlCombo_currentIndexChanged" ID="SvnRepoBrowserDialog.on_urlCombo_currentIndexChanged"></a>
353 <h4>SvnRepoBrowserDialog.on_urlCombo_currentIndexChanged</h4>
354 <b>on_urlCombo_currentIndexChanged</b>(<i>text</i>)
355 <p>
356 Private slot called, when a new repository URL is entered or selected.
357 </p><dl>
358 <dt><i>text</i></dt>
359 <dd>
360 the text of the current item (string)
361 </dd>
362 </dl><a NAME="SvnRepoBrowserDialog.start" ID="SvnRepoBrowserDialog.start"></a>
363 <h4>SvnRepoBrowserDialog.start</h4>
364 <b>start</b>(<i>url</i>)
365 <p>
366 Public slot to start the svn info command.
367 </p><dl>
368 <dt><i>url</i></dt>
369 <dd>
370 the repository URL to browser (string)
371 </dd>
372 </dl>
373 <div align="right"><a href="#top">Up</a></div>
374 <hr />
375 </body></html>

eric ide

mercurial