Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelveBrowserDialog.html

eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelveBrowserDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelveBrowserDialog</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelveBrowserDialog</h1>
24
25 <p>
26 Module implementing Mercurial shelve browser dialog.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#HgShelveBrowserDialog">HgShelveBrowserDialog</a></td>
39 <td>Class implementing Mercurial shelve browser dialog.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="HgShelveBrowserDialog" ID="HgShelveBrowserDialog"></a>
50 <h2>HgShelveBrowserDialog</h2>
51
52 <p>
53 Class implementing Mercurial shelve browser dialog.
54 </p>
55 <h3>Derived from</h3>
56 QWidget, Ui_HgShelveBrowserDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>AgeColumn</td></tr><tr><td>MessageColumn</td></tr><tr><td>NameColumn</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#HgShelveBrowserDialog.__init__">HgShelveBrowserDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#HgShelveBrowserDialog.__cleanupShelves">__cleanupShelves</a></td>
77 <td>Private slot to delete all shelves.</td>
78 </tr>
79 <tr>
80 <td><a href="#HgShelveBrowserDialog.__deleteShelves">__deleteShelves</a></td>
81 <td>Private slot to delete the selected shelves.</td>
82 </tr>
83 <tr>
84 <td><a href="#HgShelveBrowserDialog.__finish">__finish</a></td>
85 <td>Private slot called when the process finished or the user pressed the button.</td>
86 </tr>
87 <tr>
88 <td><a href="#HgShelveBrowserDialog.__generateShelveEntry">__generateShelveEntry</a></td>
89 <td>Private method to generate the shelve items.</td>
90 </tr>
91 <tr>
92 <td><a href="#HgShelveBrowserDialog.__getShelveEntries">__getShelveEntries</a></td>
93 <td>Private method to retrieve the list of shelves.</td>
94 </tr>
95 <tr>
96 <td><a href="#HgShelveBrowserDialog.__processBuffer">__processBuffer</a></td>
97 <td>Private method to process the buffered output of the hg shelve command.</td>
98 </tr>
99 <tr>
100 <td><a href="#HgShelveBrowserDialog.__resetUI">__resetUI</a></td>
101 <td>Private method to reset the user interface.</td>
102 </tr>
103 <tr>
104 <td><a href="#HgShelveBrowserDialog.__resizeColumnsShelves">__resizeColumnsShelves</a></td>
105 <td>Private method to resize the shelve list columns.</td>
106 </tr>
107 <tr>
108 <td><a href="#HgShelveBrowserDialog.__showError">__showError</a></td>
109 <td>Private slot to show some error.</td>
110 </tr>
111 <tr>
112 <td><a href="#HgShelveBrowserDialog.__unshelve">__unshelve</a></td>
113 <td>Private slot to restore the selected shelve of changes.</td>
114 </tr>
115 <tr>
116 <td><a href="#HgShelveBrowserDialog.closeEvent">closeEvent</a></td>
117 <td>Protected slot implementing a close event handler.</td>
118 </tr>
119 <tr>
120 <td><a href="#HgShelveBrowserDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
121 <td>Private slot called by a button of the button box clicked.</td>
122 </tr>
123 <tr>
124 <td><a href="#HgShelveBrowserDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
125 <td>Private slot to refresh the list of shelves.</td>
126 </tr>
127 <tr>
128 <td><a href="#HgShelveBrowserDialog.on_shelveList_currentItemChanged">on_shelveList_currentItemChanged</a></td>
129 <td>Private slot called, when the current item of the shelve list changes.</td>
130 </tr>
131 <tr>
132 <td><a href="#HgShelveBrowserDialog.on_shelveList_customContextMenuRequested">on_shelveList_customContextMenuRequested</a></td>
133 <td>Private slot to show the context menu of the shelve list.</td>
134 </tr>
135 <tr>
136 <td><a href="#HgShelveBrowserDialog.show">show</a></td>
137 <td>Public slot to show the dialog.</td>
138 </tr>
139 <tr>
140 <td><a href="#HgShelveBrowserDialog.start">start</a></td>
141 <td>Public slot to start the hg shelve command.</td>
142 </tr>
143 </table>
144 <h3>Static Methods</h3>
145
146 <table>
147 <tr><td>None</td></tr>
148 </table>
149
150 <a NAME="HgShelveBrowserDialog.__init__" ID="HgShelveBrowserDialog.__init__"></a>
151 <h4>HgShelveBrowserDialog (Constructor)</h4>
152 <b>HgShelveBrowserDialog</b>(<i>vcs, parent=None</i>)
153
154 <p>
155 Constructor
156 </p>
157 <dl>
158
159 <dt><i>vcs</i></dt>
160 <dd>
161 reference to the vcs object
162 </dd>
163 <dt><i>parent</i></dt>
164 <dd>
165 parent widget (QWidget)
166 </dd>
167 </dl>
168 <a NAME="HgShelveBrowserDialog.__cleanupShelves" ID="HgShelveBrowserDialog.__cleanupShelves"></a>
169 <h4>HgShelveBrowserDialog.__cleanupShelves</h4>
170 <b>__cleanupShelves</b>(<i></i>)
171
172 <p>
173 Private slot to delete all shelves.
174 </p>
175 <a NAME="HgShelveBrowserDialog.__deleteShelves" ID="HgShelveBrowserDialog.__deleteShelves"></a>
176 <h4>HgShelveBrowserDialog.__deleteShelves</h4>
177 <b>__deleteShelves</b>(<i></i>)
178
179 <p>
180 Private slot to delete the selected shelves.
181 </p>
182 <a NAME="HgShelveBrowserDialog.__finish" ID="HgShelveBrowserDialog.__finish"></a>
183 <h4>HgShelveBrowserDialog.__finish</h4>
184 <b>__finish</b>(<i></i>)
185
186 <p>
187 Private slot called when the process finished or the user pressed
188 the button.
189 </p>
190 <a NAME="HgShelveBrowserDialog.__generateShelveEntry" ID="HgShelveBrowserDialog.__generateShelveEntry"></a>
191 <h4>HgShelveBrowserDialog.__generateShelveEntry</h4>
192 <b>__generateShelveEntry</b>(<i>name, age, message, fileStatistics, totals</i>)
193
194 <p>
195 Private method to generate the shelve items.
196 </p>
197 <dl>
198
199 <dt><i>name</i></dt>
200 <dd>
201 name of the shelve (string)
202 </dd>
203 <dt><i>age</i></dt>
204 <dd>
205 age of the shelve (string)
206 </dd>
207 <dt><i>message</i></dt>
208 <dd>
209 shelve message (string)
210 </dd>
211 <dt><i>fileStatistics</i></dt>
212 <dd>
213 per file change statistics (tuple of
214 four strings with file name, number of changes, number of
215 added lines and number of deleted lines)
216 </dd>
217 <dt><i>totals</i></dt>
218 <dd>
219 overall statistics (tuple of three strings with
220 number of changed files, number of added lines and number
221 of deleted lines)
222 </dd>
223 </dl>
224 <a NAME="HgShelveBrowserDialog.__getShelveEntries" ID="HgShelveBrowserDialog.__getShelveEntries"></a>
225 <h4>HgShelveBrowserDialog.__getShelveEntries</h4>
226 <b>__getShelveEntries</b>(<i></i>)
227
228 <p>
229 Private method to retrieve the list of shelves.
230 </p>
231 <a NAME="HgShelveBrowserDialog.__processBuffer" ID="HgShelveBrowserDialog.__processBuffer"></a>
232 <h4>HgShelveBrowserDialog.__processBuffer</h4>
233 <b>__processBuffer</b>(<i></i>)
234
235 <p>
236 Private method to process the buffered output of the hg shelve command.
237 </p>
238 <a NAME="HgShelveBrowserDialog.__resetUI" ID="HgShelveBrowserDialog.__resetUI"></a>
239 <h4>HgShelveBrowserDialog.__resetUI</h4>
240 <b>__resetUI</b>(<i></i>)
241
242 <p>
243 Private method to reset the user interface.
244 </p>
245 <a NAME="HgShelveBrowserDialog.__resizeColumnsShelves" ID="HgShelveBrowserDialog.__resizeColumnsShelves"></a>
246 <h4>HgShelveBrowserDialog.__resizeColumnsShelves</h4>
247 <b>__resizeColumnsShelves</b>(<i></i>)
248
249 <p>
250 Private method to resize the shelve list columns.
251 </p>
252 <a NAME="HgShelveBrowserDialog.__showError" ID="HgShelveBrowserDialog.__showError"></a>
253 <h4>HgShelveBrowserDialog.__showError</h4>
254 <b>__showError</b>(<i>out</i>)
255
256 <p>
257 Private slot to show some error.
258 </p>
259 <dl>
260
261 <dt><i>out</i></dt>
262 <dd>
263 error to be shown (string)
264 </dd>
265 </dl>
266 <a NAME="HgShelveBrowserDialog.__unshelve" ID="HgShelveBrowserDialog.__unshelve"></a>
267 <h4>HgShelveBrowserDialog.__unshelve</h4>
268 <b>__unshelve</b>(<i></i>)
269
270 <p>
271 Private slot to restore the selected shelve of changes.
272 </p>
273 <a NAME="HgShelveBrowserDialog.closeEvent" ID="HgShelveBrowserDialog.closeEvent"></a>
274 <h4>HgShelveBrowserDialog.closeEvent</h4>
275 <b>closeEvent</b>(<i>e</i>)
276
277 <p>
278 Protected slot implementing a close event handler.
279 </p>
280 <dl>
281
282 <dt><i>e</i></dt>
283 <dd>
284 close event (QCloseEvent)
285 </dd>
286 </dl>
287 <a NAME="HgShelveBrowserDialog.on_buttonBox_clicked" ID="HgShelveBrowserDialog.on_buttonBox_clicked"></a>
288 <h4>HgShelveBrowserDialog.on_buttonBox_clicked</h4>
289 <b>on_buttonBox_clicked</b>(<i>button</i>)
290
291 <p>
292 Private slot called by a button of the button box clicked.
293 </p>
294 <dl>
295
296 <dt><i>button</i></dt>
297 <dd>
298 button that was clicked (QAbstractButton)
299 </dd>
300 </dl>
301 <a NAME="HgShelveBrowserDialog.on_refreshButton_clicked" ID="HgShelveBrowserDialog.on_refreshButton_clicked"></a>
302 <h4>HgShelveBrowserDialog.on_refreshButton_clicked</h4>
303 <b>on_refreshButton_clicked</b>(<i></i>)
304
305 <p>
306 Private slot to refresh the list of shelves.
307 </p>
308 <a NAME="HgShelveBrowserDialog.on_shelveList_currentItemChanged" ID="HgShelveBrowserDialog.on_shelveList_currentItemChanged"></a>
309 <h4>HgShelveBrowserDialog.on_shelveList_currentItemChanged</h4>
310 <b>on_shelveList_currentItemChanged</b>(<i>current, previous</i>)
311
312 <p>
313 Private slot called, when the current item of the shelve list changes.
314 </p>
315 <dl>
316
317 <dt><i>current</i></dt>
318 <dd>
319 reference to the new current item (QTreeWidgetItem)
320 </dd>
321 <dt><i>previous</i></dt>
322 <dd>
323 reference to the old current item (QTreeWidgetItem)
324 </dd>
325 </dl>
326 <a NAME="HgShelveBrowserDialog.on_shelveList_customContextMenuRequested" ID="HgShelveBrowserDialog.on_shelveList_customContextMenuRequested"></a>
327 <h4>HgShelveBrowserDialog.on_shelveList_customContextMenuRequested</h4>
328 <b>on_shelveList_customContextMenuRequested</b>(<i>pos</i>)
329
330 <p>
331 Private slot to show the context menu of the shelve list.
332 </p>
333 <dl>
334
335 <dt><i>pos</i></dt>
336 <dd>
337 position of the mouse pointer (QPoint)
338 </dd>
339 </dl>
340 <a NAME="HgShelveBrowserDialog.show" ID="HgShelveBrowserDialog.show"></a>
341 <h4>HgShelveBrowserDialog.show</h4>
342 <b>show</b>(<i></i>)
343
344 <p>
345 Public slot to show the dialog.
346 </p>
347 <a NAME="HgShelveBrowserDialog.start" ID="HgShelveBrowserDialog.start"></a>
348 <h4>HgShelveBrowserDialog.start</h4>
349 <b>start</b>(<i></i>)
350
351 <p>
352 Public slot to start the hg shelve command.
353 </p>
354 <div align="right"><a href="#top">Up</a></div>
355 <hr />
356 </body></html>

Mercurial Repository: eric

eric ide

mercurial