src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10438
4cd7e5a8b3cf
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListDialog</h1>
10
11 <p>
12 Module implementing a dialog to show a list of applied and unapplied patches.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#HgQueuesListDialog">HgQueuesListDialog</a></td>
25 <td>Class implementing a dialog to show a list of applied and unapplied patches.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="HgQueuesListDialog" ID="HgQueuesListDialog"></a>
36 <h2>HgQueuesListDialog</h2>
37
38 <p>
39 Class implementing a dialog to show a list of applied and unapplied
40 patches.
41 </p>
42 <h3>Derived from</h3>
43 QDialog, Ui_HgQueuesListDialog
44 <h3>Class Attributes</h3>
45
46 <table>
47 <tr><td>None</td></tr>
48 </table>
49 <h3>Class Methods</h3>
50
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55
56 <table>
57
58 <tr>
59 <td><a href="#HgQueuesListDialog.__init__">HgQueuesListDialog</a></td>
60 <td>Constructor</td>
61 </tr>
62 <tr>
63 <td><a href="#HgQueuesListDialog.__finish">__finish</a></td>
64 <td>Private slot called when the process finished or the user pressed the button.</td>
65 </tr>
66 <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>
70 <tr>
71 <td><a href="#HgQueuesListDialog.__getSeries">__getSeries</a></td>
72 <td>Private slot to get the list of applied, unapplied and guarded patches and patches missing in the series file.</td>
73 </tr>
74 <tr>
75 <td><a href="#HgQueuesListDialog.__getTop">__getTop</a></td>
76 <td>Private slot to get patch at the top of the stack.</td>
77 </tr>
78 <tr>
79 <td><a href="#HgQueuesListDialog.__markTopItem">__markTopItem</a></td>
80 <td>Private slot to mark the top patch entry.</td>
81 </tr>
82 <tr>
83 <td><a href="#HgQueuesListDialog.__processOutputLine">__processOutputLine</a></td>
84 <td>Private method to process the lines of output.</td>
85 </tr>
86 <tr>
87 <td><a href="#HgQueuesListDialog.__resizeColumns">__resizeColumns</a></td>
88 <td>Private method to resize the list columns.</td>
89 </tr>
90 <tr>
91 <td><a href="#HgQueuesListDialog.__resort">__resort</a></td>
92 <td>Private method to resort the tree.</td>
93 </tr>
94 <tr>
95 <td><a href="#HgQueuesListDialog.__showError">__showError</a></td>
96 <td>Private slot to show some error.</td>
97 </tr>
98 <tr>
99 <td><a href="#HgQueuesListDialog.closeEvent">closeEvent</a></td>
100 <td>Protected slot implementing a close event handler.</td>
101 </tr>
102 <tr>
103 <td><a href="#HgQueuesListDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
104 <td>Private slot called by a button of the button box clicked.</td>
105 </tr>
106 <tr>
107 <td><a href="#HgQueuesListDialog.start">start</a></td>
108 <td>Public slot to start the list command.</td>
109 </tr>
110 </table>
111 <h3>Static Methods</h3>
112
113 <table>
114 <tr><td>None</td></tr>
115 </table>
116
117 <a NAME="HgQueuesListDialog.__init__" ID="HgQueuesListDialog.__init__"></a>
118 <h4>HgQueuesListDialog (Constructor)</h4>
119 <b>HgQueuesListDialog</b>(<i>vcs, parent=None</i>)
120
121 <p>
122 Constructor
123 </p>
124 <dl>
125
126 <dt><i>vcs</i></dt>
127 <dd>
128 reference to the vcs object
129 </dd>
130 <dt><i>parent</i></dt>
131 <dd>
132 parent widget (QWidget)
133 </dd>
134 </dl>
135 <a NAME="HgQueuesListDialog.__finish" ID="HgQueuesListDialog.__finish"></a>
136 <h4>HgQueuesListDialog.__finish</h4>
137 <b>__finish</b>(<i></i>)
138
139 <p>
140 Private slot called when the process finished or the user pressed
141 the button.
142 </p>
143 <a NAME="HgQueuesListDialog.__generateItem" ID="HgQueuesListDialog.__generateItem"></a>
144 <h4>HgQueuesListDialog.__generateItem</h4>
145 <b>__generateItem</b>(<i>index, status, name, summary, error=False</i>)
146
147 <p>
148 Private method to generate a patch item in the list of patches.
149 </p>
150 <dl>
151
152 <dt><i>index</i></dt>
153 <dd>
154 index of the patch (integer, -1 for missing)
155 </dd>
156 <dt><i>status</i></dt>
157 <dd>
158 status of the patch (string)
159 </dd>
160 <dt><i>name</i></dt>
161 <dd>
162 name of the patch (string)
163 </dd>
164 <dt><i>summary</i></dt>
165 <dd>
166 first line of the patch header (string)
167 </dd>
168 <dt><i>error</i></dt>
169 <dd>
170 flag indicating an error entry (boolean)
171 </dd>
172 </dl>
173 <a NAME="HgQueuesListDialog.__getSeries" ID="HgQueuesListDialog.__getSeries"></a>
174 <h4>HgQueuesListDialog.__getSeries</h4>
175 <b>__getSeries</b>(<i>missing=False</i>)
176
177 <p>
178 Private slot to get the list of applied, unapplied and guarded patches
179 and patches missing in the series file.
180 </p>
181 <dl>
182
183 <dt><i>missing</i></dt>
184 <dd>
185 flag indicating to get the patches missing in the
186 series file (boolean)
187 </dd>
188 </dl>
189 <a NAME="HgQueuesListDialog.__getTop" ID="HgQueuesListDialog.__getTop"></a>
190 <h4>HgQueuesListDialog.__getTop</h4>
191 <b>__getTop</b>(<i></i>)
192
193 <p>
194 Private slot to get patch at the top of the stack.
195 </p>
196 <a NAME="HgQueuesListDialog.__markTopItem" ID="HgQueuesListDialog.__markTopItem"></a>
197 <h4>HgQueuesListDialog.__markTopItem</h4>
198 <b>__markTopItem</b>(<i>name</i>)
199
200 <p>
201 Private slot to mark the top patch entry.
202 </p>
203 <dl>
204
205 <dt><i>name</i></dt>
206 <dd>
207 name of the patch (string)
208 </dd>
209 </dl>
210 <a NAME="HgQueuesListDialog.__processOutputLine" ID="HgQueuesListDialog.__processOutputLine"></a>
211 <h4>HgQueuesListDialog.__processOutputLine</h4>
212 <b>__processOutputLine</b>(<i>line</i>)
213
214 <p>
215 Private method to process the lines of output.
216 </p>
217 <dl>
218
219 <dt><i>line</i></dt>
220 <dd>
221 output line to be processed (string)
222 </dd>
223 </dl>
224 <a NAME="HgQueuesListDialog.__resizeColumns" ID="HgQueuesListDialog.__resizeColumns"></a>
225 <h4>HgQueuesListDialog.__resizeColumns</h4>
226 <b>__resizeColumns</b>(<i></i>)
227
228 <p>
229 Private method to resize the list columns.
230 </p>
231 <a NAME="HgQueuesListDialog.__resort" ID="HgQueuesListDialog.__resort"></a>
232 <h4>HgQueuesListDialog.__resort</h4>
233 <b>__resort</b>(<i></i>)
234
235 <p>
236 Private method to resort the tree.
237 </p>
238 <a NAME="HgQueuesListDialog.__showError" ID="HgQueuesListDialog.__showError"></a>
239 <h4>HgQueuesListDialog.__showError</h4>
240 <b>__showError</b>(<i>out</i>)
241
242 <p>
243 Private slot to show some error.
244 </p>
245 <dl>
246
247 <dt><i>out</i></dt>
248 <dd>
249 error to be shown (string)
250 </dd>
251 </dl>
252 <a NAME="HgQueuesListDialog.closeEvent" ID="HgQueuesListDialog.closeEvent"></a>
253 <h4>HgQueuesListDialog.closeEvent</h4>
254 <b>closeEvent</b>(<i>e</i>)
255
256 <p>
257 Protected slot implementing a close event handler.
258 </p>
259 <dl>
260
261 <dt><i>e</i></dt>
262 <dd>
263 close event (QCloseEvent)
264 </dd>
265 </dl>
266 <a NAME="HgQueuesListDialog.on_buttonBox_clicked" ID="HgQueuesListDialog.on_buttonBox_clicked"></a>
267 <h4>HgQueuesListDialog.on_buttonBox_clicked</h4>
268 <b>on_buttonBox_clicked</b>(<i>button</i>)
269
270 <p>
271 Private slot called by a button of the button box clicked.
272 </p>
273 <dl>
274
275 <dt><i>button</i></dt>
276 <dd>
277 button that was clicked (QAbstractButton)
278 </dd>
279 </dl>
280 <a NAME="HgQueuesListDialog.start" ID="HgQueuesListDialog.start"></a>
281 <h4>HgQueuesListDialog.start</h4>
282 <b>start</b>(<i></i>)
283
284 <p>
285 Public slot to start the list command.
286 </p>
287 <div align="right"><a href="#top">Up</a></div>
288 <hr />
289 </body></html>

eric ide

mercurial