|
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>eric5.Plugins.VcsPlugins.vcsSubversion.SvnTagBranchListDialog</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.Plugins.VcsPlugins.vcsSubversion.SvnTagBranchListDialog</h1> |
|
12 <p> |
|
13 Module implementing a dialog to show a list of tags or branches. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#SvnTagBranchListDialog">SvnTagBranchListDialog</a></td> |
|
23 <td>Class implementing a dialog to show a list of tags or branches.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="SvnTagBranchListDialog" ID="SvnTagBranchListDialog"></a> |
|
32 <h2>SvnTagBranchListDialog</h2> |
|
33 <p> |
|
34 Class implementing a dialog to show a list of tags or branches. |
|
35 </p> |
|
36 <h3>Derived from</h3> |
|
37 QDialog, Ui_SvnTagBranchListDialog |
|
38 <h3>Class Attributes</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <h3>Methods</h3> |
|
43 <table> |
|
44 <tr> |
|
45 <td><a href="#SvnTagBranchListDialog.__init__">SvnTagBranchListDialog</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#SvnTagBranchListDialog.__finish">__finish</a></td> |
|
49 <td>Private slot called when the process finished or the user pressed the button.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#SvnTagBranchListDialog.__generateItem">__generateItem</a></td> |
|
52 <td>Private method to generate a tag item in the taglist.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#SvnTagBranchListDialog.__procFinished">__procFinished</a></td> |
|
55 <td>Private slot connected to the finished signal.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#SvnTagBranchListDialog.__readStderr">__readStderr</a></td> |
|
58 <td>Private slot to handle the readyReadStderr signal.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#SvnTagBranchListDialog.__readStdout">__readStdout</a></td> |
|
61 <td>Private slot to handle the readyReadStdout signal.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#SvnTagBranchListDialog.__resizeColumns">__resizeColumns</a></td> |
|
64 <td>Private method to resize the list columns.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#SvnTagBranchListDialog.__resort">__resort</a></td> |
|
67 <td>Private method to resort the tree.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#SvnTagBranchListDialog.closeEvent">closeEvent</a></td> |
|
70 <td>Private slot implementing a close event handler.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#SvnTagBranchListDialog.keyPressEvent">keyPressEvent</a></td> |
|
73 <td>Protected slot to handle a key press event.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#SvnTagBranchListDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
76 <td>Private slot called by a button of the button box clicked.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#SvnTagBranchListDialog.on_input_returnPressed">on_input_returnPressed</a></td> |
|
79 <td>Private slot to handle the press of the return key in the input field.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#SvnTagBranchListDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> |
|
82 <td>Private slot to handle the password checkbox toggled.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#SvnTagBranchListDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> |
|
85 <td>Private slot to send the input to the subversion process.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#SvnTagBranchListDialog.start">start</a></td> |
|
88 <td>Public slot to start the svn status command.</td> |
|
89 </tr> |
|
90 </table> |
|
91 <a NAME="SvnTagBranchListDialog.__init__" ID="SvnTagBranchListDialog.__init__"></a> |
|
92 <h4>SvnTagBranchListDialog (Constructor)</h4> |
|
93 <b>SvnTagBranchListDialog</b>(<i>vcs, parent = None</i>) |
|
94 <p> |
|
95 Constructor |
|
96 </p><dl> |
|
97 <dt><i>vcs</i></dt> |
|
98 <dd> |
|
99 reference to the vcs object |
|
100 </dd><dt><i>parent</i></dt> |
|
101 <dd> |
|
102 parent widget (QWidget) |
|
103 </dd> |
|
104 </dl><a NAME="SvnTagBranchListDialog.__finish" ID="SvnTagBranchListDialog.__finish"></a> |
|
105 <h4>SvnTagBranchListDialog.__finish</h4> |
|
106 <b>__finish</b>(<i></i>) |
|
107 <p> |
|
108 Private slot called when the process finished or the user pressed the button. |
|
109 </p><a NAME="SvnTagBranchListDialog.__generateItem" ID="SvnTagBranchListDialog.__generateItem"></a> |
|
110 <h4>SvnTagBranchListDialog.__generateItem</h4> |
|
111 <b>__generateItem</b>(<i>revision, author, date, name</i>) |
|
112 <p> |
|
113 Private method to generate a tag item in the taglist. |
|
114 </p><dl> |
|
115 <dt><i>revision</i></dt> |
|
116 <dd> |
|
117 revision string (string) |
|
118 </dd><dt><i>author</i></dt> |
|
119 <dd> |
|
120 author of the tag (string) |
|
121 </dd><dt><i>date</i></dt> |
|
122 <dd> |
|
123 date of the tag (string) |
|
124 </dd><dt><i>name</i></dt> |
|
125 <dd> |
|
126 name (path) of the tag (string) |
|
127 </dd> |
|
128 </dl><a NAME="SvnTagBranchListDialog.__procFinished" ID="SvnTagBranchListDialog.__procFinished"></a> |
|
129 <h4>SvnTagBranchListDialog.__procFinished</h4> |
|
130 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) |
|
131 <p> |
|
132 Private slot connected to the finished signal. |
|
133 </p><dl> |
|
134 <dt><i>exitCode</i></dt> |
|
135 <dd> |
|
136 exit code of the process (integer) |
|
137 </dd><dt><i>exitStatus</i></dt> |
|
138 <dd> |
|
139 exit status of the process (QProcess.ExitStatus) |
|
140 </dd> |
|
141 </dl><a NAME="SvnTagBranchListDialog.__readStderr" ID="SvnTagBranchListDialog.__readStderr"></a> |
|
142 <h4>SvnTagBranchListDialog.__readStderr</h4> |
|
143 <b>__readStderr</b>(<i></i>) |
|
144 <p> |
|
145 Private slot to handle the readyReadStderr signal. |
|
146 </p><p> |
|
147 It reads the error output of the process and inserts it into the |
|
148 error pane. |
|
149 </p><a NAME="SvnTagBranchListDialog.__readStdout" ID="SvnTagBranchListDialog.__readStdout"></a> |
|
150 <h4>SvnTagBranchListDialog.__readStdout</h4> |
|
151 <b>__readStdout</b>(<i></i>) |
|
152 <p> |
|
153 Private slot to handle the readyReadStdout signal. |
|
154 </p><p> |
|
155 It reads the output of the process, formats it and inserts it into |
|
156 the contents pane. |
|
157 </p><a NAME="SvnTagBranchListDialog.__resizeColumns" ID="SvnTagBranchListDialog.__resizeColumns"></a> |
|
158 <h4>SvnTagBranchListDialog.__resizeColumns</h4> |
|
159 <b>__resizeColumns</b>(<i></i>) |
|
160 <p> |
|
161 Private method to resize the list columns. |
|
162 </p><a NAME="SvnTagBranchListDialog.__resort" ID="SvnTagBranchListDialog.__resort"></a> |
|
163 <h4>SvnTagBranchListDialog.__resort</h4> |
|
164 <b>__resort</b>(<i></i>) |
|
165 <p> |
|
166 Private method to resort the tree. |
|
167 </p><a NAME="SvnTagBranchListDialog.closeEvent" ID="SvnTagBranchListDialog.closeEvent"></a> |
|
168 <h4>SvnTagBranchListDialog.closeEvent</h4> |
|
169 <b>closeEvent</b>(<i>e</i>) |
|
170 <p> |
|
171 Private slot implementing a close event handler. |
|
172 </p><dl> |
|
173 <dt><i>e</i></dt> |
|
174 <dd> |
|
175 close event (QCloseEvent) |
|
176 </dd> |
|
177 </dl><a NAME="SvnTagBranchListDialog.keyPressEvent" ID="SvnTagBranchListDialog.keyPressEvent"></a> |
|
178 <h4>SvnTagBranchListDialog.keyPressEvent</h4> |
|
179 <b>keyPressEvent</b>(<i>evt</i>) |
|
180 <p> |
|
181 Protected slot to handle a key press event. |
|
182 </p><dl> |
|
183 <dt><i>evt</i></dt> |
|
184 <dd> |
|
185 the key press event (QKeyEvent) |
|
186 </dd> |
|
187 </dl><a NAME="SvnTagBranchListDialog.on_buttonBox_clicked" ID="SvnTagBranchListDialog.on_buttonBox_clicked"></a> |
|
188 <h4>SvnTagBranchListDialog.on_buttonBox_clicked</h4> |
|
189 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
190 <p> |
|
191 Private slot called by a button of the button box clicked. |
|
192 </p><dl> |
|
193 <dt><i>button</i></dt> |
|
194 <dd> |
|
195 button that was clicked (QAbstractButton) |
|
196 </dd> |
|
197 </dl><a NAME="SvnTagBranchListDialog.on_input_returnPressed" ID="SvnTagBranchListDialog.on_input_returnPressed"></a> |
|
198 <h4>SvnTagBranchListDialog.on_input_returnPressed</h4> |
|
199 <b>on_input_returnPressed</b>(<i></i>) |
|
200 <p> |
|
201 Private slot to handle the press of the return key in the input field. |
|
202 </p><a NAME="SvnTagBranchListDialog.on_passwordCheckBox_toggled" ID="SvnTagBranchListDialog.on_passwordCheckBox_toggled"></a> |
|
203 <h4>SvnTagBranchListDialog.on_passwordCheckBox_toggled</h4> |
|
204 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) |
|
205 <p> |
|
206 Private slot to handle the password checkbox toggled. |
|
207 </p><dl> |
|
208 <dt><i>isOn</i></dt> |
|
209 <dd> |
|
210 flag indicating the status of the check box (boolean) |
|
211 </dd> |
|
212 </dl><a NAME="SvnTagBranchListDialog.on_sendButton_clicked" ID="SvnTagBranchListDialog.on_sendButton_clicked"></a> |
|
213 <h4>SvnTagBranchListDialog.on_sendButton_clicked</h4> |
|
214 <b>on_sendButton_clicked</b>(<i></i>) |
|
215 <p> |
|
216 Private slot to send the input to the subversion process. |
|
217 </p><a NAME="SvnTagBranchListDialog.start" ID="SvnTagBranchListDialog.start"></a> |
|
218 <h4>SvnTagBranchListDialog.start</h4> |
|
219 <b>start</b>(<i>path, tags, tagsList, allTagsList</i>) |
|
220 <p> |
|
221 Public slot to start the svn status command. |
|
222 </p><dl> |
|
223 <dt><i>path</i></dt> |
|
224 <dd> |
|
225 name of directory to be listed (string) |
|
226 </dd><dt><i>tags</i></dt> |
|
227 <dd> |
|
228 flag indicating a list of tags is requested |
|
229 (False = branches, True = tags) |
|
230 </dd><dt><i>tagsList</i></dt> |
|
231 <dd> |
|
232 reference to string list receiving the tags (list of strings) |
|
233 </dd><dt><i>allsTagsList</i></dt> |
|
234 <dd> |
|
235 reference to string list all tags (list of strings) |
|
236 </dd> |
|
237 </dl> |
|
238 <div align="right"><a href="#top">Up</a></div> |
|
239 <hr /> |
|
240 </body></html> |