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

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

eric ide

mercurial