Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarksListDialog.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarksListDialog.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.HgBookmarksListDialog</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.HgBookmarksListDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to show a list of bookmarks. | |
| 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="#HgBookmarksListDialog">HgBookmarksListDialog</a></td> | |
| 25 <td>Class implementing a dialog to show a list of bookmarks.</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="HgBookmarksListDialog" ID="HgBookmarksListDialog"></a> | |
| 36 <h2>HgBookmarksListDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to show a list of bookmarks. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_HgBookmarksListDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#HgBookmarksListDialog.__init__">HgBookmarksListDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#HgBookmarksListDialog.__deleteBookmark">__deleteBookmark</a></td> | |
| 63 <td>Private slot to delete the selected bookmark.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#HgBookmarksListDialog.__finish">__finish</a></td> | |
| 67 <td>Private slot called when the process finished or the user pressed the button.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#HgBookmarksListDialog.__generateItem">__generateItem</a></td> | |
| 71 <td>Private method to generate a bookmark item in the bookmarks list.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#HgBookmarksListDialog.__processOutputLine">__processOutputLine</a></td> | |
| 75 <td>Private method to process the lines of output.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#HgBookmarksListDialog.__pullBookmark">__pullBookmark</a></td> | |
| 79 <td>Private slot to pull the selected bookmark.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#HgBookmarksListDialog.__pushAllBookmarks">__pushAllBookmarks</a></td> | |
| 83 <td>Private slot to push all bookmarks.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#HgBookmarksListDialog.__pushBookmark">__pushBookmark</a></td> | |
| 87 <td>Private slot to push the selected bookmark.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#HgBookmarksListDialog.__pushCurrentBookmark">__pushCurrentBookmark</a></td> | |
| 91 <td>Private slot to push the current bookmark.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#HgBookmarksListDialog.__renameBookmark">__renameBookmark</a></td> | |
| 95 <td>Private slot to rename the selected bookmark.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#HgBookmarksListDialog.__resizeColumns">__resizeColumns</a></td> | |
| 99 <td>Private method to resize the list columns.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#HgBookmarksListDialog.__resort">__resort</a></td> | |
| 103 <td>Private method to resort the tree.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#HgBookmarksListDialog.__showError">__showError</a></td> | |
| 107 <td>Private slot to show some error.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#HgBookmarksListDialog.__switchTo">__switchTo</a></td> | |
| 111 <td>Private slot to switch the working directory to the selected revision.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#HgBookmarksListDialog.closeEvent">closeEvent</a></td> | |
| 115 <td>Protected slot implementing a close event handler.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#HgBookmarksListDialog.on_bookmarksList_customContextMenuRequested">on_bookmarksList_customContextMenuRequested</a></td> | |
| 119 <td>Private slot to handle the context menu request.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#HgBookmarksListDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 123 <td>Private slot called by a button of the button box clicked.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#HgBookmarksListDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> | |
| 127 <td>Private slot to refresh the status display.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#HgBookmarksListDialog.start">start</a></td> | |
| 131 <td>Public slot to start the bookmarks command.</td> | |
| 132 </tr> | |
| 133 </table> | |
| 134 <h3>Static Methods</h3> | |
| 135 | |
| 136 <table> | |
| 137 <tr><td>None</td></tr> | |
| 138 </table> | |
| 139 | |
| 140 <a NAME="HgBookmarksListDialog.__init__" ID="HgBookmarksListDialog.__init__"></a> | |
| 141 <h4>HgBookmarksListDialog (Constructor)</h4> | |
| 142 <b>HgBookmarksListDialog</b>(<i>vcs, parent=None</i>) | |
| 143 | |
| 144 <p> | |
| 145 Constructor | |
| 146 </p> | |
| 147 <dl> | |
| 148 | |
| 149 <dt><i>vcs</i></dt> | |
| 150 <dd> | |
| 151 reference to the vcs object | |
| 152 </dd> | |
| 153 <dt><i>parent</i></dt> | |
| 154 <dd> | |
| 155 parent widget (QWidget) | |
| 156 </dd> | |
| 157 </dl> | |
| 158 <a NAME="HgBookmarksListDialog.__deleteBookmark" ID="HgBookmarksListDialog.__deleteBookmark"></a> | |
| 159 <h4>HgBookmarksListDialog.__deleteBookmark</h4> | |
| 160 <b>__deleteBookmark</b>(<i></i>) | |
| 161 | |
| 162 <p> | |
| 163 Private slot to delete the selected bookmark. | |
| 164 </p> | |
| 165 <a NAME="HgBookmarksListDialog.__finish" ID="HgBookmarksListDialog.__finish"></a> | |
| 166 <h4>HgBookmarksListDialog.__finish</h4> | |
| 167 <b>__finish</b>(<i></i>) | |
| 168 | |
| 169 <p> | |
| 170 Private slot called when the process finished or the user pressed | |
| 171 the button. | |
| 172 </p> | |
| 173 <a NAME="HgBookmarksListDialog.__generateItem" ID="HgBookmarksListDialog.__generateItem"></a> | |
| 174 <h4>HgBookmarksListDialog.__generateItem</h4> | |
| 175 <b>__generateItem</b>(<i>revision, changeset, status, name</i>) | |
| 176 | |
| 177 <p> | |
| 178 Private method to generate a bookmark item in the bookmarks list. | |
| 179 </p> | |
| 180 <dl> | |
| 181 | |
| 182 <dt><i>revision</i></dt> | |
| 183 <dd> | |
| 184 revision of the bookmark (string) | |
| 185 </dd> | |
| 186 <dt><i>changeset</i></dt> | |
| 187 <dd> | |
| 188 changeset of the bookmark (string) | |
| 189 </dd> | |
| 190 <dt><i>status</i></dt> | |
| 191 <dd> | |
| 192 of the bookmark (string) | |
| 193 </dd> | |
| 194 <dt><i>name</i></dt> | |
| 195 <dd> | |
| 196 name of the bookmark (string) | |
| 197 </dd> | |
| 198 </dl> | |
| 199 <a NAME="HgBookmarksListDialog.__processOutputLine" ID="HgBookmarksListDialog.__processOutputLine"></a> | |
| 200 <h4>HgBookmarksListDialog.__processOutputLine</h4> | |
| 201 <b>__processOutputLine</b>(<i>line</i>) | |
| 202 | |
| 203 <p> | |
| 204 Private method to process the lines of output. | |
| 205 </p> | |
| 206 <dl> | |
| 207 | |
| 208 <dt><i>line</i></dt> | |
| 209 <dd> | |
| 210 output line to be processed (string) | |
| 211 </dd> | |
| 212 </dl> | |
| 213 <a NAME="HgBookmarksListDialog.__pullBookmark" ID="HgBookmarksListDialog.__pullBookmark"></a> | |
| 214 <h4>HgBookmarksListDialog.__pullBookmark</h4> | |
| 215 <b>__pullBookmark</b>(<i></i>) | |
| 216 | |
| 217 <p> | |
| 218 Private slot to pull the selected bookmark. | |
| 219 </p> | |
| 220 <a NAME="HgBookmarksListDialog.__pushAllBookmarks" ID="HgBookmarksListDialog.__pushAllBookmarks"></a> | |
| 221 <h4>HgBookmarksListDialog.__pushAllBookmarks</h4> | |
| 222 <b>__pushAllBookmarks</b>(<i></i>) | |
| 223 | |
| 224 <p> | |
| 225 Private slot to push all bookmarks. | |
| 226 </p> | |
| 227 <a NAME="HgBookmarksListDialog.__pushBookmark" ID="HgBookmarksListDialog.__pushBookmark"></a> | |
| 228 <h4>HgBookmarksListDialog.__pushBookmark</h4> | |
| 229 <b>__pushBookmark</b>(<i></i>) | |
| 230 | |
| 231 <p> | |
| 232 Private slot to push the selected bookmark. | |
| 233 </p> | |
| 234 <a NAME="HgBookmarksListDialog.__pushCurrentBookmark" ID="HgBookmarksListDialog.__pushCurrentBookmark"></a> | |
| 235 <h4>HgBookmarksListDialog.__pushCurrentBookmark</h4> | |
| 236 <b>__pushCurrentBookmark</b>(<i></i>) | |
| 237 | |
| 238 <p> | |
| 239 Private slot to push the current bookmark. | |
| 240 </p> | |
| 241 <a NAME="HgBookmarksListDialog.__renameBookmark" ID="HgBookmarksListDialog.__renameBookmark"></a> | |
| 242 <h4>HgBookmarksListDialog.__renameBookmark</h4> | |
| 243 <b>__renameBookmark</b>(<i></i>) | |
| 244 | |
| 245 <p> | |
| 246 Private slot to rename the selected bookmark. | |
| 247 </p> | |
| 248 <a NAME="HgBookmarksListDialog.__resizeColumns" ID="HgBookmarksListDialog.__resizeColumns"></a> | |
| 249 <h4>HgBookmarksListDialog.__resizeColumns</h4> | |
| 250 <b>__resizeColumns</b>(<i></i>) | |
| 251 | |
| 252 <p> | |
| 253 Private method to resize the list columns. | |
| 254 </p> | |
| 255 <a NAME="HgBookmarksListDialog.__resort" ID="HgBookmarksListDialog.__resort"></a> | |
| 256 <h4>HgBookmarksListDialog.__resort</h4> | |
| 257 <b>__resort</b>(<i></i>) | |
| 258 | |
| 259 <p> | |
| 260 Private method to resort the tree. | |
| 261 </p> | |
| 262 <a NAME="HgBookmarksListDialog.__showError" ID="HgBookmarksListDialog.__showError"></a> | |
| 263 <h4>HgBookmarksListDialog.__showError</h4> | |
| 264 <b>__showError</b>(<i>out</i>) | |
| 265 | |
| 266 <p> | |
| 267 Private slot to show some error. | |
| 268 </p> | |
| 269 <dl> | |
| 270 | |
| 271 <dt><i>out</i></dt> | |
| 272 <dd> | |
| 273 error to be shown (string) | |
| 274 </dd> | |
| 275 </dl> | |
| 276 <a NAME="HgBookmarksListDialog.__switchTo" ID="HgBookmarksListDialog.__switchTo"></a> | |
| 277 <h4>HgBookmarksListDialog.__switchTo</h4> | |
| 278 <b>__switchTo</b>(<i></i>) | |
| 279 | |
| 280 <p> | |
| 281 Private slot to switch the working directory to the selected revision. | |
| 282 </p> | |
| 283 <a NAME="HgBookmarksListDialog.closeEvent" ID="HgBookmarksListDialog.closeEvent"></a> | |
| 284 <h4>HgBookmarksListDialog.closeEvent</h4> | |
| 285 <b>closeEvent</b>(<i>e</i>) | |
| 286 | |
| 287 <p> | |
| 288 Protected slot implementing a close event handler. | |
| 289 </p> | |
| 290 <dl> | |
| 291 | |
| 292 <dt><i>e</i></dt> | |
| 293 <dd> | |
| 294 close event (QCloseEvent) | |
| 295 </dd> | |
| 296 </dl> | |
| 297 <a NAME="HgBookmarksListDialog.on_bookmarksList_customContextMenuRequested" ID="HgBookmarksListDialog.on_bookmarksList_customContextMenuRequested"></a> | |
| 298 <h4>HgBookmarksListDialog.on_bookmarksList_customContextMenuRequested</h4> | |
| 299 <b>on_bookmarksList_customContextMenuRequested</b>(<i>pos</i>) | |
| 300 | |
| 301 <p> | |
| 302 Private slot to handle the context menu request. | |
| 303 </p> | |
| 304 <dl> | |
| 305 | |
| 306 <dt><i>pos</i> (QPoint)</dt> | |
| 307 <dd> | |
| 308 position the context menu was requetsed at | |
| 309 </dd> | |
| 310 </dl> | |
| 311 <a NAME="HgBookmarksListDialog.on_buttonBox_clicked" ID="HgBookmarksListDialog.on_buttonBox_clicked"></a> | |
| 312 <h4>HgBookmarksListDialog.on_buttonBox_clicked</h4> | |
| 313 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 314 | |
| 315 <p> | |
| 316 Private slot called by a button of the button box clicked. | |
| 317 </p> | |
| 318 <dl> | |
| 319 | |
| 320 <dt><i>button</i></dt> | |
| 321 <dd> | |
| 322 button that was clicked (QAbstractButton) | |
| 323 </dd> | |
| 324 </dl> | |
| 325 <a NAME="HgBookmarksListDialog.on_refreshButton_clicked" ID="HgBookmarksListDialog.on_refreshButton_clicked"></a> | |
| 326 <h4>HgBookmarksListDialog.on_refreshButton_clicked</h4> | |
| 327 <b>on_refreshButton_clicked</b>(<i></i>) | |
| 328 | |
| 329 <p> | |
| 330 Private slot to refresh the status display. | |
| 331 </p> | |
| 332 <a NAME="HgBookmarksListDialog.start" ID="HgBookmarksListDialog.start"></a> | |
| 333 <h4>HgBookmarksListDialog.start</h4> | |
| 334 <b>start</b>(<i>bookmarksList</i>) | |
| 335 | |
| 336 <p> | |
| 337 Public slot to start the bookmarks command. | |
| 338 </p> | |
| 339 <dl> | |
| 340 | |
| 341 <dt><i>bookmarksList</i></dt> | |
| 342 <dd> | |
| 343 reference to string list receiving the bookmarks | |
| 344 (list of strings) | |
| 345 </dd> | |
| 346 </dl> | |
| 347 <div align="right"><a href="#top">Up</a></div> | |
| 348 <hr /> | |
| 349 </body></html> |
