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