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

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsSubversion.SvnTagBranchListDialog</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.SvnTagBranchListDialog</h1>
23 <p>
24 Module implementing a dialog to show a list of tags or branches.
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="#SvnTagBranchListDialog">SvnTagBranchListDialog</a></td>
34 <td>Class implementing a dialog to show a list of tags or branches.</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="SvnTagBranchListDialog" ID="SvnTagBranchListDialog"></a>
43 <h2>SvnTagBranchListDialog</h2>
44 <p>
45 Class implementing a dialog to show a list of tags or branches.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_SvnTagBranchListDialog
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="#SvnTagBranchListDialog.__init__">SvnTagBranchListDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#SvnTagBranchListDialog.__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="#SvnTagBranchListDialog.__generateItem">__generateItem</a></td>
67 <td>Private method to generate a tag item in the taglist.</td>
68 </tr><tr>
69 <td><a href="#SvnTagBranchListDialog.__procFinished">__procFinished</a></td>
70 <td>Private slot connected to the finished signal.</td>
71 </tr><tr>
72 <td><a href="#SvnTagBranchListDialog.__readStderr">__readStderr</a></td>
73 <td>Private slot to handle the readyReadStderr signal.</td>
74 </tr><tr>
75 <td><a href="#SvnTagBranchListDialog.__readStdout">__readStdout</a></td>
76 <td>Private slot to handle the readyReadStdout signal.</td>
77 </tr><tr>
78 <td><a href="#SvnTagBranchListDialog.__resizeColumns">__resizeColumns</a></td>
79 <td>Private method to resize the list columns.</td>
80 </tr><tr>
81 <td><a href="#SvnTagBranchListDialog.__resort">__resort</a></td>
82 <td>Private method to resort the tree.</td>
83 </tr><tr>
84 <td><a href="#SvnTagBranchListDialog.closeEvent">closeEvent</a></td>
85 <td>Protected slot implementing a close event handler.</td>
86 </tr><tr>
87 <td><a href="#SvnTagBranchListDialog.keyPressEvent">keyPressEvent</a></td>
88 <td>Protected slot to handle a key press event.</td>
89 </tr><tr>
90 <td><a href="#SvnTagBranchListDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
91 <td>Private slot called by a button of the button box clicked.</td>
92 </tr><tr>
93 <td><a href="#SvnTagBranchListDialog.on_input_returnPressed">on_input_returnPressed</a></td>
94 <td>Private slot to handle the press of the return key in the input field.</td>
95 </tr><tr>
96 <td><a href="#SvnTagBranchListDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
97 <td>Private slot to handle the password checkbox toggled.</td>
98 </tr><tr>
99 <td><a href="#SvnTagBranchListDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
100 <td>Private slot to send the input to the subversion process.</td>
101 </tr><tr>
102 <td><a href="#SvnTagBranchListDialog.start">start</a></td>
103 <td>Public slot to start the svn status command.</td>
104 </tr>
105 </table>
106 <h3>Static Methods</h3>
107 <table>
108 <tr><td>None</td></tr>
109 </table>
110 <a NAME="SvnTagBranchListDialog.__init__" ID="SvnTagBranchListDialog.__init__"></a>
111 <h4>SvnTagBranchListDialog (Constructor)</h4>
112 <b>SvnTagBranchListDialog</b>(<i>vcs, parent=None</i>)
113 <p>
114 Constructor
115 </p><dl>
116 <dt><i>vcs</i></dt>
117 <dd>
118 reference to the vcs object
119 </dd><dt><i>parent</i></dt>
120 <dd>
121 parent widget (QWidget)
122 </dd>
123 </dl><a NAME="SvnTagBranchListDialog.__finish" ID="SvnTagBranchListDialog.__finish"></a>
124 <h4>SvnTagBranchListDialog.__finish</h4>
125 <b>__finish</b>(<i></i>)
126 <p>
127 Private slot called when the process finished or the user pressed the
128 button.
129 </p><a NAME="SvnTagBranchListDialog.__generateItem" ID="SvnTagBranchListDialog.__generateItem"></a>
130 <h4>SvnTagBranchListDialog.__generateItem</h4>
131 <b>__generateItem</b>(<i>revision, author, date, name</i>)
132 <p>
133 Private method to generate a tag item in the taglist.
134 </p><dl>
135 <dt><i>revision</i></dt>
136 <dd>
137 revision string (string)
138 </dd><dt><i>author</i></dt>
139 <dd>
140 author of the tag (string)
141 </dd><dt><i>date</i></dt>
142 <dd>
143 date of the tag (string)
144 </dd><dt><i>name</i></dt>
145 <dd>
146 name (path) of the tag (string)
147 </dd>
148 </dl><a NAME="SvnTagBranchListDialog.__procFinished" ID="SvnTagBranchListDialog.__procFinished"></a>
149 <h4>SvnTagBranchListDialog.__procFinished</h4>
150 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
151 <p>
152 Private slot connected to the finished signal.
153 </p><dl>
154 <dt><i>exitCode</i></dt>
155 <dd>
156 exit code of the process (integer)
157 </dd><dt><i>exitStatus</i></dt>
158 <dd>
159 exit status of the process (QProcess.ExitStatus)
160 </dd>
161 </dl><a NAME="SvnTagBranchListDialog.__readStderr" ID="SvnTagBranchListDialog.__readStderr"></a>
162 <h4>SvnTagBranchListDialog.__readStderr</h4>
163 <b>__readStderr</b>(<i></i>)
164 <p>
165 Private slot to handle the readyReadStderr signal.
166 </p><p>
167 It reads the error output of the process and inserts it into the
168 error pane.
169 </p><a NAME="SvnTagBranchListDialog.__readStdout" ID="SvnTagBranchListDialog.__readStdout"></a>
170 <h4>SvnTagBranchListDialog.__readStdout</h4>
171 <b>__readStdout</b>(<i></i>)
172 <p>
173 Private slot to handle the readyReadStdout signal.
174 </p><p>
175 It reads the output of the process, formats it and inserts it into
176 the contents pane.
177 </p><a NAME="SvnTagBranchListDialog.__resizeColumns" ID="SvnTagBranchListDialog.__resizeColumns"></a>
178 <h4>SvnTagBranchListDialog.__resizeColumns</h4>
179 <b>__resizeColumns</b>(<i></i>)
180 <p>
181 Private method to resize the list columns.
182 </p><a NAME="SvnTagBranchListDialog.__resort" ID="SvnTagBranchListDialog.__resort"></a>
183 <h4>SvnTagBranchListDialog.__resort</h4>
184 <b>__resort</b>(<i></i>)
185 <p>
186 Private method to resort the tree.
187 </p><a NAME="SvnTagBranchListDialog.closeEvent" ID="SvnTagBranchListDialog.closeEvent"></a>
188 <h4>SvnTagBranchListDialog.closeEvent</h4>
189 <b>closeEvent</b>(<i>e</i>)
190 <p>
191 Protected slot implementing a close event handler.
192 </p><dl>
193 <dt><i>e</i></dt>
194 <dd>
195 close event (QCloseEvent)
196 </dd>
197 </dl><a NAME="SvnTagBranchListDialog.keyPressEvent" ID="SvnTagBranchListDialog.keyPressEvent"></a>
198 <h4>SvnTagBranchListDialog.keyPressEvent</h4>
199 <b>keyPressEvent</b>(<i>evt</i>)
200 <p>
201 Protected slot to handle a key press event.
202 </p><dl>
203 <dt><i>evt</i></dt>
204 <dd>
205 the key press event (QKeyEvent)
206 </dd>
207 </dl><a NAME="SvnTagBranchListDialog.on_buttonBox_clicked" ID="SvnTagBranchListDialog.on_buttonBox_clicked"></a>
208 <h4>SvnTagBranchListDialog.on_buttonBox_clicked</h4>
209 <b>on_buttonBox_clicked</b>(<i>button</i>)
210 <p>
211 Private slot called by a button of the button box clicked.
212 </p><dl>
213 <dt><i>button</i></dt>
214 <dd>
215 button that was clicked (QAbstractButton)
216 </dd>
217 </dl><a NAME="SvnTagBranchListDialog.on_input_returnPressed" ID="SvnTagBranchListDialog.on_input_returnPressed"></a>
218 <h4>SvnTagBranchListDialog.on_input_returnPressed</h4>
219 <b>on_input_returnPressed</b>(<i></i>)
220 <p>
221 Private slot to handle the press of the return key in the input field.
222 </p><a NAME="SvnTagBranchListDialog.on_passwordCheckBox_toggled" ID="SvnTagBranchListDialog.on_passwordCheckBox_toggled"></a>
223 <h4>SvnTagBranchListDialog.on_passwordCheckBox_toggled</h4>
224 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
225 <p>
226 Private slot to handle the password checkbox toggled.
227 </p><dl>
228 <dt><i>isOn</i></dt>
229 <dd>
230 flag indicating the status of the check box (boolean)
231 </dd>
232 </dl><a NAME="SvnTagBranchListDialog.on_sendButton_clicked" ID="SvnTagBranchListDialog.on_sendButton_clicked"></a>
233 <h4>SvnTagBranchListDialog.on_sendButton_clicked</h4>
234 <b>on_sendButton_clicked</b>(<i></i>)
235 <p>
236 Private slot to send the input to the subversion process.
237 </p><a NAME="SvnTagBranchListDialog.start" ID="SvnTagBranchListDialog.start"></a>
238 <h4>SvnTagBranchListDialog.start</h4>
239 <b>start</b>(<i>path, tags, tagsList, allTagsList</i>)
240 <p>
241 Public slot to start the svn status command.
242 </p><dl>
243 <dt><i>path</i></dt>
244 <dd>
245 name of directory to be listed (string)
246 </dd><dt><i>tags</i></dt>
247 <dd>
248 flag indicating a list of tags is requested
249 (False = branches, True = tags)
250 </dd><dt><i>tagsList</i></dt>
251 <dd>
252 reference to string list receiving the tags
253 (list of strings)
254 </dd><dt><i>allTagsList</i></dt>
255 <dd>
256 reference to string list all tags (list of strings)
257 </dd>
258 </dl>
259 <div align="right"><a href="#top">Up</a></div>
260 <hr />
261 </body></html>

eric ide

mercurial