|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListDialog</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.vcsMercurial.QueuesExtension.HgQueuesListDialog</h1> |
|
23 <p> |
|
24 Module implementing a dialog to show a list of applied and unapplied patches. |
|
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="#HgQueuesListDialog">HgQueuesListDialog</a></td> |
|
34 <td>Class implementing a dialog to show a list of applied and unapplied patches.</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="HgQueuesListDialog" ID="HgQueuesListDialog"></a> |
|
43 <h2>HgQueuesListDialog</h2> |
|
44 <p> |
|
45 Class implementing a dialog to show a list of applied and unapplied |
|
46 patches. |
|
47 </p> |
|
48 <h3>Derived from</h3> |
|
49 QDialog, Ui_HgQueuesListDialog |
|
50 <h3>Class Attributes</h3> |
|
51 <table> |
|
52 <tr><td>None</td></tr> |
|
53 </table> |
|
54 <h3>Class Methods</h3> |
|
55 <table> |
|
56 <tr><td>None</td></tr> |
|
57 </table> |
|
58 <h3>Methods</h3> |
|
59 <table> |
|
60 <tr> |
|
61 <td><a href="#HgQueuesListDialog.__init__">HgQueuesListDialog</a></td> |
|
62 <td>Constructor</td> |
|
63 </tr><tr> |
|
64 <td><a href="#HgQueuesListDialog.__finish">__finish</a></td> |
|
65 <td>Private slot called when the process finished or the user pressed the button.</td> |
|
66 </tr><tr> |
|
67 <td><a href="#HgQueuesListDialog.__generateItem">__generateItem</a></td> |
|
68 <td>Private method to generate a patch item in the list of patches.</td> |
|
69 </tr><tr> |
|
70 <td><a href="#HgQueuesListDialog.__getSeries">__getSeries</a></td> |
|
71 <td>Private slot to get the list of applied, unapplied and guarded patches and patches missing in the series file.</td> |
|
72 </tr><tr> |
|
73 <td><a href="#HgQueuesListDialog.__getTop">__getTop</a></td> |
|
74 <td>Private slot to get patch at the top of the stack.</td> |
|
75 </tr><tr> |
|
76 <td><a href="#HgQueuesListDialog.__markTopItem">__markTopItem</a></td> |
|
77 <td>Private slot to mark the top patch entry.</td> |
|
78 </tr><tr> |
|
79 <td><a href="#HgQueuesListDialog.__procFinished">__procFinished</a></td> |
|
80 <td>Private slot connected to the finished signal.</td> |
|
81 </tr><tr> |
|
82 <td><a href="#HgQueuesListDialog.__processOutputLine">__processOutputLine</a></td> |
|
83 <td>Private method to process the lines of output.</td> |
|
84 </tr><tr> |
|
85 <td><a href="#HgQueuesListDialog.__readStderr">__readStderr</a></td> |
|
86 <td>Private slot to handle the readyReadStderr signal.</td> |
|
87 </tr><tr> |
|
88 <td><a href="#HgQueuesListDialog.__readStdout">__readStdout</a></td> |
|
89 <td>Private slot to handle the readyReadStdout signal.</td> |
|
90 </tr><tr> |
|
91 <td><a href="#HgQueuesListDialog.__resizeColumns">__resizeColumns</a></td> |
|
92 <td>Private method to resize the list columns.</td> |
|
93 </tr><tr> |
|
94 <td><a href="#HgQueuesListDialog.__resort">__resort</a></td> |
|
95 <td>Private method to resort the tree.</td> |
|
96 </tr><tr> |
|
97 <td><a href="#HgQueuesListDialog.__showError">__showError</a></td> |
|
98 <td>Private slot to show some error.</td> |
|
99 </tr><tr> |
|
100 <td><a href="#HgQueuesListDialog.closeEvent">closeEvent</a></td> |
|
101 <td>Protected slot implementing a close event handler.</td> |
|
102 </tr><tr> |
|
103 <td><a href="#HgQueuesListDialog.keyPressEvent">keyPressEvent</a></td> |
|
104 <td>Protected slot to handle a key press event.</td> |
|
105 </tr><tr> |
|
106 <td><a href="#HgQueuesListDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
107 <td>Private slot called by a button of the button box clicked.</td> |
|
108 </tr><tr> |
|
109 <td><a href="#HgQueuesListDialog.on_input_returnPressed">on_input_returnPressed</a></td> |
|
110 <td>Private slot to handle the press of the return key in the input field.</td> |
|
111 </tr><tr> |
|
112 <td><a href="#HgQueuesListDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> |
|
113 <td>Private slot to handle the password checkbox toggled.</td> |
|
114 </tr><tr> |
|
115 <td><a href="#HgQueuesListDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> |
|
116 <td>Private slot to send the input to the subversion process.</td> |
|
117 </tr><tr> |
|
118 <td><a href="#HgQueuesListDialog.start">start</a></td> |
|
119 <td>Public slot to start the list command.</td> |
|
120 </tr> |
|
121 </table> |
|
122 <h3>Static Methods</h3> |
|
123 <table> |
|
124 <tr><td>None</td></tr> |
|
125 </table> |
|
126 <a NAME="HgQueuesListDialog.__init__" ID="HgQueuesListDialog.__init__"></a> |
|
127 <h4>HgQueuesListDialog (Constructor)</h4> |
|
128 <b>HgQueuesListDialog</b>(<i>vcs, parent=None</i>) |
|
129 <p> |
|
130 Constructor |
|
131 </p><dl> |
|
132 <dt><i>vcs</i></dt> |
|
133 <dd> |
|
134 reference to the vcs object |
|
135 </dd><dt><i>parent</i></dt> |
|
136 <dd> |
|
137 parent widget (QWidget) |
|
138 </dd> |
|
139 </dl><a NAME="HgQueuesListDialog.__finish" ID="HgQueuesListDialog.__finish"></a> |
|
140 <h4>HgQueuesListDialog.__finish</h4> |
|
141 <b>__finish</b>(<i></i>) |
|
142 <p> |
|
143 Private slot called when the process finished or the user pressed |
|
144 the button. |
|
145 </p><a NAME="HgQueuesListDialog.__generateItem" ID="HgQueuesListDialog.__generateItem"></a> |
|
146 <h4>HgQueuesListDialog.__generateItem</h4> |
|
147 <b>__generateItem</b>(<i>index, status, name, summary, error=False</i>) |
|
148 <p> |
|
149 Private method to generate a patch item in the list of patches. |
|
150 </p><dl> |
|
151 <dt><i>index</i></dt> |
|
152 <dd> |
|
153 index of the patch (integer, -1 for missing) |
|
154 </dd><dt><i>status</i></dt> |
|
155 <dd> |
|
156 status of the patch (string) |
|
157 </dd><dt><i>name</i></dt> |
|
158 <dd> |
|
159 name of the patch (string) |
|
160 </dd><dt><i>summary</i></dt> |
|
161 <dd> |
|
162 first line of the patch header (string) |
|
163 </dd><dt><i>error</i></dt> |
|
164 <dd> |
|
165 flag indicating an error entry (boolean) |
|
166 </dd> |
|
167 </dl><a NAME="HgQueuesListDialog.__getSeries" ID="HgQueuesListDialog.__getSeries"></a> |
|
168 <h4>HgQueuesListDialog.__getSeries</h4> |
|
169 <b>__getSeries</b>(<i>missing=False</i>) |
|
170 <p> |
|
171 Private slot to get the list of applied, unapplied and guarded patches |
|
172 and patches missing in the series file. |
|
173 </p><dl> |
|
174 <dt><i>missing</i></dt> |
|
175 <dd> |
|
176 flag indicating to get the patches missing in the |
|
177 series file (boolean) |
|
178 </dd> |
|
179 </dl><a NAME="HgQueuesListDialog.__getTop" ID="HgQueuesListDialog.__getTop"></a> |
|
180 <h4>HgQueuesListDialog.__getTop</h4> |
|
181 <b>__getTop</b>(<i></i>) |
|
182 <p> |
|
183 Private slot to get patch at the top of the stack. |
|
184 </p><a NAME="HgQueuesListDialog.__markTopItem" ID="HgQueuesListDialog.__markTopItem"></a> |
|
185 <h4>HgQueuesListDialog.__markTopItem</h4> |
|
186 <b>__markTopItem</b>(<i>name</i>) |
|
187 <p> |
|
188 Private slot to mark the top patch entry. |
|
189 </p><dl> |
|
190 <dt><i>name</i></dt> |
|
191 <dd> |
|
192 name of the patch (string) |
|
193 </dd> |
|
194 </dl><a NAME="HgQueuesListDialog.__procFinished" ID="HgQueuesListDialog.__procFinished"></a> |
|
195 <h4>HgQueuesListDialog.__procFinished</h4> |
|
196 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) |
|
197 <p> |
|
198 Private slot connected to the finished signal. |
|
199 </p><dl> |
|
200 <dt><i>exitCode</i></dt> |
|
201 <dd> |
|
202 exit code of the process (integer) |
|
203 </dd><dt><i>exitStatus</i></dt> |
|
204 <dd> |
|
205 exit status of the process (QProcess.ExitStatus) |
|
206 </dd> |
|
207 </dl><a NAME="HgQueuesListDialog.__processOutputLine" ID="HgQueuesListDialog.__processOutputLine"></a> |
|
208 <h4>HgQueuesListDialog.__processOutputLine</h4> |
|
209 <b>__processOutputLine</b>(<i>line</i>) |
|
210 <p> |
|
211 Private method to process the lines of output. |
|
212 </p><dl> |
|
213 <dt><i>line</i></dt> |
|
214 <dd> |
|
215 output line to be processed (string) |
|
216 </dd> |
|
217 </dl><a NAME="HgQueuesListDialog.__readStderr" ID="HgQueuesListDialog.__readStderr"></a> |
|
218 <h4>HgQueuesListDialog.__readStderr</h4> |
|
219 <b>__readStderr</b>(<i></i>) |
|
220 <p> |
|
221 Private slot to handle the readyReadStderr signal. |
|
222 </p><p> |
|
223 It reads the error output of the process and inserts it into the |
|
224 error pane. |
|
225 </p><a NAME="HgQueuesListDialog.__readStdout" ID="HgQueuesListDialog.__readStdout"></a> |
|
226 <h4>HgQueuesListDialog.__readStdout</h4> |
|
227 <b>__readStdout</b>(<i></i>) |
|
228 <p> |
|
229 Private slot to handle the readyReadStdout signal. |
|
230 </p><p> |
|
231 It reads the output of the process, formats it and inserts it into |
|
232 the contents pane. |
|
233 </p><a NAME="HgQueuesListDialog.__resizeColumns" ID="HgQueuesListDialog.__resizeColumns"></a> |
|
234 <h4>HgQueuesListDialog.__resizeColumns</h4> |
|
235 <b>__resizeColumns</b>(<i></i>) |
|
236 <p> |
|
237 Private method to resize the list columns. |
|
238 </p><a NAME="HgQueuesListDialog.__resort" ID="HgQueuesListDialog.__resort"></a> |
|
239 <h4>HgQueuesListDialog.__resort</h4> |
|
240 <b>__resort</b>(<i></i>) |
|
241 <p> |
|
242 Private method to resort the tree. |
|
243 </p><a NAME="HgQueuesListDialog.__showError" ID="HgQueuesListDialog.__showError"></a> |
|
244 <h4>HgQueuesListDialog.__showError</h4> |
|
245 <b>__showError</b>(<i>out</i>) |
|
246 <p> |
|
247 Private slot to show some error. |
|
248 </p><dl> |
|
249 <dt><i>out</i></dt> |
|
250 <dd> |
|
251 error to be shown (string) |
|
252 </dd> |
|
253 </dl><a NAME="HgQueuesListDialog.closeEvent" ID="HgQueuesListDialog.closeEvent"></a> |
|
254 <h4>HgQueuesListDialog.closeEvent</h4> |
|
255 <b>closeEvent</b>(<i>e</i>) |
|
256 <p> |
|
257 Protected slot implementing a close event handler. |
|
258 </p><dl> |
|
259 <dt><i>e</i></dt> |
|
260 <dd> |
|
261 close event (QCloseEvent) |
|
262 </dd> |
|
263 </dl><a NAME="HgQueuesListDialog.keyPressEvent" ID="HgQueuesListDialog.keyPressEvent"></a> |
|
264 <h4>HgQueuesListDialog.keyPressEvent</h4> |
|
265 <b>keyPressEvent</b>(<i>evt</i>) |
|
266 <p> |
|
267 Protected slot to handle a key press event. |
|
268 </p><dl> |
|
269 <dt><i>evt</i></dt> |
|
270 <dd> |
|
271 the key press event (QKeyEvent) |
|
272 </dd> |
|
273 </dl><a NAME="HgQueuesListDialog.on_buttonBox_clicked" ID="HgQueuesListDialog.on_buttonBox_clicked"></a> |
|
274 <h4>HgQueuesListDialog.on_buttonBox_clicked</h4> |
|
275 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
276 <p> |
|
277 Private slot called by a button of the button box clicked. |
|
278 </p><dl> |
|
279 <dt><i>button</i></dt> |
|
280 <dd> |
|
281 button that was clicked (QAbstractButton) |
|
282 </dd> |
|
283 </dl><a NAME="HgQueuesListDialog.on_input_returnPressed" ID="HgQueuesListDialog.on_input_returnPressed"></a> |
|
284 <h4>HgQueuesListDialog.on_input_returnPressed</h4> |
|
285 <b>on_input_returnPressed</b>(<i></i>) |
|
286 <p> |
|
287 Private slot to handle the press of the return key in the input field. |
|
288 </p><a NAME="HgQueuesListDialog.on_passwordCheckBox_toggled" ID="HgQueuesListDialog.on_passwordCheckBox_toggled"></a> |
|
289 <h4>HgQueuesListDialog.on_passwordCheckBox_toggled</h4> |
|
290 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) |
|
291 <p> |
|
292 Private slot to handle the password checkbox toggled. |
|
293 </p><dl> |
|
294 <dt><i>isOn</i></dt> |
|
295 <dd> |
|
296 flag indicating the status of the check box (boolean) |
|
297 </dd> |
|
298 </dl><a NAME="HgQueuesListDialog.on_sendButton_clicked" ID="HgQueuesListDialog.on_sendButton_clicked"></a> |
|
299 <h4>HgQueuesListDialog.on_sendButton_clicked</h4> |
|
300 <b>on_sendButton_clicked</b>(<i></i>) |
|
301 <p> |
|
302 Private slot to send the input to the subversion process. |
|
303 </p><a NAME="HgQueuesListDialog.start" ID="HgQueuesListDialog.start"></a> |
|
304 <h4>HgQueuesListDialog.start</h4> |
|
305 <b>start</b>(<i>path</i>) |
|
306 <p> |
|
307 Public slot to start the list command. |
|
308 </p><dl> |
|
309 <dt><i>path</i></dt> |
|
310 <dd> |
|
311 name of directory to be listed (string) |
|
312 </dd> |
|
313 </dl> |
|
314 <div align="right"><a href="#top">Up</a></div> |
|
315 <hr /> |
|
316 </body></html> |