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

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
child 10690
fab36645aa7d
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelveBrowserDialog</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelveBrowserDialog</h1>
10
11 <p> 10 <p>
12 Module implementing Mercurial shelve browser dialog. 11 Module implementing Mercurial shelve browser dialog.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#HgShelveBrowserDialog">HgShelveBrowserDialog</a></td> 22 <td><a href="#HgShelveBrowserDialog">HgShelveBrowserDialog</a></td>
25 <td>Class implementing Mercurial shelve browser dialog.</td> 23 <td>Class implementing Mercurial shelve browser dialog.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="HgShelveBrowserDialog" ID="HgShelveBrowserDialog"></a> 34 <a NAME="HgShelveBrowserDialog" ID="HgShelveBrowserDialog"></a>
36 <h2>HgShelveBrowserDialog</h2> 35 <h2>HgShelveBrowserDialog</h2>
37
38 <p> 36 <p>
39 Class implementing Mercurial shelve browser dialog. 37 Class implementing Mercurial shelve browser dialog.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QWidget, Ui_HgShelveBrowserDialog 41 QWidget, Ui_HgShelveBrowserDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>AgeColumn</td></tr>
46 <tr><td>AgeColumn</td></tr><tr><td>MessageColumn</td></tr><tr><td>NameColumn</td></tr> 45 <tr><td>MessageColumn</td></tr>
47 </table> 46 <tr><td>NameColumn</td></tr>
47 </table>
48
48 <h3>Class Methods</h3> 49 <h3>Class Methods</h3>
49
50 <table> 50 <table>
51 <tr><td>None</td></tr> 51 <tr><td>None</td></tr>
52 </table> 52 </table>
53
53 <h3>Methods</h3> 54 <h3>Methods</h3>
54 55 <table>
55 <table>
56
57 <tr> 56 <tr>
58 <td><a href="#HgShelveBrowserDialog.__init__">HgShelveBrowserDialog</a></td> 57 <td><a href="#HgShelveBrowserDialog.__init__">HgShelveBrowserDialog</a></td>
59 <td>Constructor</td> 58 <td>Constructor</td>
60 </tr> 59 </tr>
61 <tr> 60 <tr>
125 <tr> 124 <tr>
126 <td><a href="#HgShelveBrowserDialog.start">start</a></td> 125 <td><a href="#HgShelveBrowserDialog.start">start</a></td>
127 <td>Public slot to start the hg shelve command.</td> 126 <td>Public slot to start the hg shelve command.</td>
128 </tr> 127 </tr>
129 </table> 128 </table>
129
130 <h3>Static Methods</h3> 130 <h3>Static Methods</h3>
131
132 <table> 131 <table>
133 <tr><td>None</td></tr> 132 <tr><td>None</td></tr>
134 </table> 133 </table>
134
135 135
136 <a NAME="HgShelveBrowserDialog.__init__" ID="HgShelveBrowserDialog.__init__"></a> 136 <a NAME="HgShelveBrowserDialog.__init__" ID="HgShelveBrowserDialog.__init__"></a>
137 <h4>HgShelveBrowserDialog (Constructor)</h4> 137 <h4>HgShelveBrowserDialog (Constructor)</h4>
138 <b>HgShelveBrowserDialog</b>(<i>vcs, parent=None</i>) 138 <b>HgShelveBrowserDialog</b>(<i>vcs, parent=None</i>)
139
140 <p> 139 <p>
141 Constructor 140 Constructor
142 </p> 141 </p>
142
143 <dl> 143 <dl>
144 144
145 <dt><i>vcs</i> (Hg)</dt> 145 <dt><i>vcs</i> (Hg)</dt>
146 <dd> 146 <dd>
147 reference to the vcs object 147 reference to the vcs object
152 </dd> 152 </dd>
153 </dl> 153 </dl>
154 <a NAME="HgShelveBrowserDialog.__cleanupShelves" ID="HgShelveBrowserDialog.__cleanupShelves"></a> 154 <a NAME="HgShelveBrowserDialog.__cleanupShelves" ID="HgShelveBrowserDialog.__cleanupShelves"></a>
155 <h4>HgShelveBrowserDialog.__cleanupShelves</h4> 155 <h4>HgShelveBrowserDialog.__cleanupShelves</h4>
156 <b>__cleanupShelves</b>(<i></i>) 156 <b>__cleanupShelves</b>(<i></i>)
157
158 <p> 157 <p>
159 Private slot to delete all shelves. 158 Private slot to delete all shelves.
160 </p> 159 </p>
160
161 <a NAME="HgShelveBrowserDialog.__deleteShelves" ID="HgShelveBrowserDialog.__deleteShelves"></a> 161 <a NAME="HgShelveBrowserDialog.__deleteShelves" ID="HgShelveBrowserDialog.__deleteShelves"></a>
162 <h4>HgShelveBrowserDialog.__deleteShelves</h4> 162 <h4>HgShelveBrowserDialog.__deleteShelves</h4>
163 <b>__deleteShelves</b>(<i></i>) 163 <b>__deleteShelves</b>(<i></i>)
164
165 <p> 164 <p>
166 Private slot to delete the selected shelves. 165 Private slot to delete the selected shelves.
167 </p> 166 </p>
167
168 <a NAME="HgShelveBrowserDialog.__finish" ID="HgShelveBrowserDialog.__finish"></a> 168 <a NAME="HgShelveBrowserDialog.__finish" ID="HgShelveBrowserDialog.__finish"></a>
169 <h4>HgShelveBrowserDialog.__finish</h4> 169 <h4>HgShelveBrowserDialog.__finish</h4>
170 <b>__finish</b>(<i></i>) 170 <b>__finish</b>(<i></i>)
171
172 <p> 171 <p>
173 Private slot called when the process finished or the user pressed 172 Private slot called when the process finished or the user pressed
174 the button. 173 the button.
175 </p> 174 </p>
175
176 <a NAME="HgShelveBrowserDialog.__generateShelveEntry" ID="HgShelveBrowserDialog.__generateShelveEntry"></a> 176 <a NAME="HgShelveBrowserDialog.__generateShelveEntry" ID="HgShelveBrowserDialog.__generateShelveEntry"></a>
177 <h4>HgShelveBrowserDialog.__generateShelveEntry</h4> 177 <h4>HgShelveBrowserDialog.__generateShelveEntry</h4>
178 <b>__generateShelveEntry</b>(<i>name, age, message, fileStatistics, totals</i>) 178 <b>__generateShelveEntry</b>(<i>name, age, message, fileStatistics, totals</i>)
179
180 <p> 179 <p>
181 Private method to generate the shelve items. 180 Private method to generate the shelve items.
182 </p> 181 </p>
182
183 <dl> 183 <dl>
184 184
185 <dt><i>name</i> (str)</dt> 185 <dt><i>name</i> (str)</dt>
186 <dd> 186 <dd>
187 name of the shelve 187 name of the shelve
207 </dd> 207 </dd>
208 </dl> 208 </dl>
209 <a NAME="HgShelveBrowserDialog.__getShelveEntries" ID="HgShelveBrowserDialog.__getShelveEntries"></a> 209 <a NAME="HgShelveBrowserDialog.__getShelveEntries" ID="HgShelveBrowserDialog.__getShelveEntries"></a>
210 <h4>HgShelveBrowserDialog.__getShelveEntries</h4> 210 <h4>HgShelveBrowserDialog.__getShelveEntries</h4>
211 <b>__getShelveEntries</b>(<i></i>) 211 <b>__getShelveEntries</b>(<i></i>)
212
213 <p> 212 <p>
214 Private method to retrieve the list of shelves. 213 Private method to retrieve the list of shelves.
215 </p> 214 </p>
215
216 <a NAME="HgShelveBrowserDialog.__processBuffer" ID="HgShelveBrowserDialog.__processBuffer"></a> 216 <a NAME="HgShelveBrowserDialog.__processBuffer" ID="HgShelveBrowserDialog.__processBuffer"></a>
217 <h4>HgShelveBrowserDialog.__processBuffer</h4> 217 <h4>HgShelveBrowserDialog.__processBuffer</h4>
218 <b>__processBuffer</b>(<i></i>) 218 <b>__processBuffer</b>(<i></i>)
219
220 <p> 219 <p>
221 Private method to process the buffered output of the hg shelve command. 220 Private method to process the buffered output of the hg shelve command.
222 </p> 221 </p>
222
223 <a NAME="HgShelveBrowserDialog.__resetUI" ID="HgShelveBrowserDialog.__resetUI"></a> 223 <a NAME="HgShelveBrowserDialog.__resetUI" ID="HgShelveBrowserDialog.__resetUI"></a>
224 <h4>HgShelveBrowserDialog.__resetUI</h4> 224 <h4>HgShelveBrowserDialog.__resetUI</h4>
225 <b>__resetUI</b>(<i></i>) 225 <b>__resetUI</b>(<i></i>)
226
227 <p> 226 <p>
228 Private method to reset the user interface. 227 Private method to reset the user interface.
229 </p> 228 </p>
229
230 <a NAME="HgShelveBrowserDialog.__resizeColumnsShelves" ID="HgShelveBrowserDialog.__resizeColumnsShelves"></a> 230 <a NAME="HgShelveBrowserDialog.__resizeColumnsShelves" ID="HgShelveBrowserDialog.__resizeColumnsShelves"></a>
231 <h4>HgShelveBrowserDialog.__resizeColumnsShelves</h4> 231 <h4>HgShelveBrowserDialog.__resizeColumnsShelves</h4>
232 <b>__resizeColumnsShelves</b>(<i></i>) 232 <b>__resizeColumnsShelves</b>(<i></i>)
233
234 <p> 233 <p>
235 Private method to resize the shelve list columns. 234 Private method to resize the shelve list columns.
236 </p> 235 </p>
236
237 <a NAME="HgShelveBrowserDialog.__showError" ID="HgShelveBrowserDialog.__showError"></a> 237 <a NAME="HgShelveBrowserDialog.__showError" ID="HgShelveBrowserDialog.__showError"></a>
238 <h4>HgShelveBrowserDialog.__showError</h4> 238 <h4>HgShelveBrowserDialog.__showError</h4>
239 <b>__showError</b>(<i>out</i>) 239 <b>__showError</b>(<i>out</i>)
240
241 <p> 240 <p>
242 Private slot to show some error. 241 Private slot to show some error.
243 </p> 242 </p>
243
244 <dl> 244 <dl>
245 245
246 <dt><i>out</i> (str)</dt> 246 <dt><i>out</i> (str)</dt>
247 <dd> 247 <dd>
248 error to be shown 248 error to be shown
249 </dd> 249 </dd>
250 </dl> 250 </dl>
251 <a NAME="HgShelveBrowserDialog.__unshelve" ID="HgShelveBrowserDialog.__unshelve"></a> 251 <a NAME="HgShelveBrowserDialog.__unshelve" ID="HgShelveBrowserDialog.__unshelve"></a>
252 <h4>HgShelveBrowserDialog.__unshelve</h4> 252 <h4>HgShelveBrowserDialog.__unshelve</h4>
253 <b>__unshelve</b>(<i></i>) 253 <b>__unshelve</b>(<i></i>)
254
255 <p> 254 <p>
256 Private slot to restore the selected shelve of changes. 255 Private slot to restore the selected shelve of changes.
257 </p> 256 </p>
257
258 <a NAME="HgShelveBrowserDialog.closeEvent" ID="HgShelveBrowserDialog.closeEvent"></a> 258 <a NAME="HgShelveBrowserDialog.closeEvent" ID="HgShelveBrowserDialog.closeEvent"></a>
259 <h4>HgShelveBrowserDialog.closeEvent</h4> 259 <h4>HgShelveBrowserDialog.closeEvent</h4>
260 <b>closeEvent</b>(<i>e</i>) 260 <b>closeEvent</b>(<i>e</i>)
261
262 <p> 261 <p>
263 Protected slot implementing a close event handler. 262 Protected slot implementing a close event handler.
264 </p> 263 </p>
264
265 <dl> 265 <dl>
266 266
267 <dt><i>e</i> (QCloseEvent)</dt> 267 <dt><i>e</i> (QCloseEvent)</dt>
268 <dd> 268 <dd>
269 close event 269 close event
270 </dd> 270 </dd>
271 </dl> 271 </dl>
272 <a NAME="HgShelveBrowserDialog.on_buttonBox_clicked" ID="HgShelveBrowserDialog.on_buttonBox_clicked"></a> 272 <a NAME="HgShelveBrowserDialog.on_buttonBox_clicked" ID="HgShelveBrowserDialog.on_buttonBox_clicked"></a>
273 <h4>HgShelveBrowserDialog.on_buttonBox_clicked</h4> 273 <h4>HgShelveBrowserDialog.on_buttonBox_clicked</h4>
274 <b>on_buttonBox_clicked</b>(<i>button</i>) 274 <b>on_buttonBox_clicked</b>(<i>button</i>)
275
276 <p> 275 <p>
277 Private slot called by a button of the button box clicked. 276 Private slot called by a button of the button box clicked.
278 </p> 277 </p>
278
279 <dl> 279 <dl>
280 280
281 <dt><i>button</i> (QAbstractButton)</dt> 281 <dt><i>button</i> (QAbstractButton)</dt>
282 <dd> 282 <dd>
283 button that was clicked 283 button that was clicked
284 </dd> 284 </dd>
285 </dl> 285 </dl>
286 <a NAME="HgShelveBrowserDialog.on_refreshButton_clicked" ID="HgShelveBrowserDialog.on_refreshButton_clicked"></a> 286 <a NAME="HgShelveBrowserDialog.on_refreshButton_clicked" ID="HgShelveBrowserDialog.on_refreshButton_clicked"></a>
287 <h4>HgShelveBrowserDialog.on_refreshButton_clicked</h4> 287 <h4>HgShelveBrowserDialog.on_refreshButton_clicked</h4>
288 <b>on_refreshButton_clicked</b>(<i></i>) 288 <b>on_refreshButton_clicked</b>(<i></i>)
289
290 <p> 289 <p>
291 Private slot to refresh the list of shelves. 290 Private slot to refresh the list of shelves.
292 </p> 291 </p>
292
293 <a NAME="HgShelveBrowserDialog.on_shelveList_currentItemChanged" ID="HgShelveBrowserDialog.on_shelveList_currentItemChanged"></a> 293 <a NAME="HgShelveBrowserDialog.on_shelveList_currentItemChanged" ID="HgShelveBrowserDialog.on_shelveList_currentItemChanged"></a>
294 <h4>HgShelveBrowserDialog.on_shelveList_currentItemChanged</h4> 294 <h4>HgShelveBrowserDialog.on_shelveList_currentItemChanged</h4>
295 <b>on_shelveList_currentItemChanged</b>(<i>current, previous</i>) 295 <b>on_shelveList_currentItemChanged</b>(<i>current, previous</i>)
296
297 <p> 296 <p>
298 Private slot called, when the current item of the shelve list changes. 297 Private slot called, when the current item of the shelve list changes.
299 </p> 298 </p>
299
300 <dl> 300 <dl>
301 301
302 <dt><i>current</i> (QTreeWidgetItem)</dt> 302 <dt><i>current</i> (QTreeWidgetItem)</dt>
303 <dd> 303 <dd>
304 reference to the new current item 304 reference to the new current item
309 </dd> 309 </dd>
310 </dl> 310 </dl>
311 <a NAME="HgShelveBrowserDialog.on_shelveList_customContextMenuRequested" ID="HgShelveBrowserDialog.on_shelveList_customContextMenuRequested"></a> 311 <a NAME="HgShelveBrowserDialog.on_shelveList_customContextMenuRequested" ID="HgShelveBrowserDialog.on_shelveList_customContextMenuRequested"></a>
312 <h4>HgShelveBrowserDialog.on_shelveList_customContextMenuRequested</h4> 312 <h4>HgShelveBrowserDialog.on_shelveList_customContextMenuRequested</h4>
313 <b>on_shelveList_customContextMenuRequested</b>(<i>pos</i>) 313 <b>on_shelveList_customContextMenuRequested</b>(<i>pos</i>)
314
315 <p> 314 <p>
316 Private slot to show the context menu of the shelve list. 315 Private slot to show the context menu of the shelve list.
317 </p> 316 </p>
317
318 <dl> 318 <dl>
319 319
320 <dt><i>pos</i> (QPoint)</dt> 320 <dt><i>pos</i> (QPoint)</dt>
321 <dd> 321 <dd>
322 position of the mouse pointer 322 position of the mouse pointer
323 </dd> 323 </dd>
324 </dl> 324 </dl>
325 <a NAME="HgShelveBrowserDialog.show" ID="HgShelveBrowserDialog.show"></a> 325 <a NAME="HgShelveBrowserDialog.show" ID="HgShelveBrowserDialog.show"></a>
326 <h4>HgShelveBrowserDialog.show</h4> 326 <h4>HgShelveBrowserDialog.show</h4>
327 <b>show</b>(<i></i>) 327 <b>show</b>(<i></i>)
328
329 <p> 328 <p>
330 Public slot to show the dialog. 329 Public slot to show the dialog.
331 </p> 330 </p>
331
332 <a NAME="HgShelveBrowserDialog.start" ID="HgShelveBrowserDialog.start"></a> 332 <a NAME="HgShelveBrowserDialog.start" ID="HgShelveBrowserDialog.start"></a>
333 <h4>HgShelveBrowserDialog.start</h4> 333 <h4>HgShelveBrowserDialog.start</h4>
334 <b>start</b>(<i></i>) 334 <b>start</b>(<i></i>)
335
336 <p> 335 <p>
337 Public slot to start the hg shelve command. 336 Public slot to start the hg shelve command.
338 </p> 337 </p>
338
339 <div align="right"><a href="#top">Up</a></div> 339 <div align="right"><a href="#top">Up</a></div>
340 <hr /> 340 <hr />
341 </body></html> 341 </body></html>

eric ide

mercurial