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 10479
- 856476537696
- parent 10438
- 4cd7e5a8b3cf
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.HgBookmarksListDialog</h1> | 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarksListDialog</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a dialog to show a list of bookmarks. | 11 Module implementing a dialog to show a list of bookmarks. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | 15 <table> |
| 16 <table> | 16 <tr><td>None</td></tr> |
| 17 <tr><td>None</td></tr> | 17 </table> |
| 18 </table> | 18 |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#HgBookmarksListDialog">HgBookmarksListDialog</a></td> | 22 <td><a href="#HgBookmarksListDialog">HgBookmarksListDialog</a></td> |
| 25 <td>Class implementing a dialog to show a list of bookmarks.</td> | 23 <td>Class implementing a dialog to show a list of bookmarks.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | 28 <table> |
| 30 <table> | 29 <tr><td>None</td></tr> |
| 31 <tr><td>None</td></tr> | 30 </table> |
| 32 </table> | 31 |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="HgBookmarksListDialog" ID="HgBookmarksListDialog"></a> | 34 <a NAME="HgBookmarksListDialog" ID="HgBookmarksListDialog"></a> |
| 36 <h2>HgBookmarksListDialog</h2> | 35 <h2>HgBookmarksListDialog</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing a dialog to show a list of bookmarks. | 37 Class implementing a dialog to show a list of bookmarks. |
| 40 </p> | 38 </p> |
| 39 | |
| 41 <h3>Derived from</h3> | 40 <h3>Derived from</h3> |
| 42 QDialog, Ui_HgBookmarksListDialog | 41 QDialog, Ui_HgBookmarksListDialog |
| 43 <h3>Class Attributes</h3> | 42 <h3>Class Attributes</h3> |
| 44 | 43 <table> |
| 45 <table> | 44 <tr><td>None</td></tr> |
| 46 <tr><td>None</td></tr> | 45 </table> |
| 47 </table> | 46 |
| 48 <h3>Class Methods</h3> | 47 <h3>Class Methods</h3> |
| 49 | 48 <table> |
| 50 <table> | 49 <tr><td>None</td></tr> |
| 51 <tr><td>None</td></tr> | 50 </table> |
| 52 </table> | 51 |
| 53 <h3>Methods</h3> | 52 <h3>Methods</h3> |
| 54 | 53 <table> |
| 55 <table> | |
| 56 | |
| 57 <tr> | 54 <tr> |
| 58 <td><a href="#HgBookmarksListDialog.__init__">HgBookmarksListDialog</a></td> | 55 <td><a href="#HgBookmarksListDialog.__init__">HgBookmarksListDialog</a></td> |
| 59 <td>Constructor</td> | 56 <td>Constructor</td> |
| 60 </tr> | 57 </tr> |
| 61 <tr> | 58 <tr> |
| 129 <tr> | 126 <tr> |
| 130 <td><a href="#HgBookmarksListDialog.start">start</a></td> | 127 <td><a href="#HgBookmarksListDialog.start">start</a></td> |
| 131 <td>Public slot to start the bookmarks command.</td> | 128 <td>Public slot to start the bookmarks command.</td> |
| 132 </tr> | 129 </tr> |
| 133 </table> | 130 </table> |
| 131 | |
| 134 <h3>Static Methods</h3> | 132 <h3>Static Methods</h3> |
| 135 | 133 <table> |
| 136 <table> | 134 <tr><td>None</td></tr> |
| 137 <tr><td>None</td></tr> | 135 </table> |
| 138 </table> | 136 |
| 139 | 137 |
| 140 <a NAME="HgBookmarksListDialog.__init__" ID="HgBookmarksListDialog.__init__"></a> | 138 <a NAME="HgBookmarksListDialog.__init__" ID="HgBookmarksListDialog.__init__"></a> |
| 141 <h4>HgBookmarksListDialog (Constructor)</h4> | 139 <h4>HgBookmarksListDialog (Constructor)</h4> |
| 142 <b>HgBookmarksListDialog</b>(<i>vcs, parent=None</i>) | 140 <b>HgBookmarksListDialog</b>(<i>vcs, parent=None</i>) |
| 143 | |
| 144 <p> | 141 <p> |
| 145 Constructor | 142 Constructor |
| 146 </p> | 143 </p> |
| 144 | |
| 147 <dl> | 145 <dl> |
| 148 | 146 |
| 149 <dt><i>vcs</i> (Hg)</dt> | 147 <dt><i>vcs</i> (Hg)</dt> |
| 150 <dd> | 148 <dd> |
| 151 reference to the vcs object | 149 reference to the vcs object |
| 156 </dd> | 154 </dd> |
| 157 </dl> | 155 </dl> |
| 158 <a NAME="HgBookmarksListDialog.__deleteBookmark" ID="HgBookmarksListDialog.__deleteBookmark"></a> | 156 <a NAME="HgBookmarksListDialog.__deleteBookmark" ID="HgBookmarksListDialog.__deleteBookmark"></a> |
| 159 <h4>HgBookmarksListDialog.__deleteBookmark</h4> | 157 <h4>HgBookmarksListDialog.__deleteBookmark</h4> |
| 160 <b>__deleteBookmark</b>(<i></i>) | 158 <b>__deleteBookmark</b>(<i></i>) |
| 161 | |
| 162 <p> | 159 <p> |
| 163 Private slot to delete the selected bookmark. | 160 Private slot to delete the selected bookmark. |
| 164 </p> | 161 </p> |
| 162 | |
| 165 <a NAME="HgBookmarksListDialog.__finish" ID="HgBookmarksListDialog.__finish"></a> | 163 <a NAME="HgBookmarksListDialog.__finish" ID="HgBookmarksListDialog.__finish"></a> |
| 166 <h4>HgBookmarksListDialog.__finish</h4> | 164 <h4>HgBookmarksListDialog.__finish</h4> |
| 167 <b>__finish</b>(<i></i>) | 165 <b>__finish</b>(<i></i>) |
| 168 | |
| 169 <p> | 166 <p> |
| 170 Private slot called when the process finished or the user pressed | 167 Private slot called when the process finished or the user pressed |
| 171 the button. | 168 the button. |
| 172 </p> | 169 </p> |
| 170 | |
| 173 <a NAME="HgBookmarksListDialog.__generateItem" ID="HgBookmarksListDialog.__generateItem"></a> | 171 <a NAME="HgBookmarksListDialog.__generateItem" ID="HgBookmarksListDialog.__generateItem"></a> |
| 174 <h4>HgBookmarksListDialog.__generateItem</h4> | 172 <h4>HgBookmarksListDialog.__generateItem</h4> |
| 175 <b>__generateItem</b>(<i>revision, changeset, status, name</i>) | 173 <b>__generateItem</b>(<i>revision, changeset, status, name</i>) |
| 176 | |
| 177 <p> | 174 <p> |
| 178 Private method to generate a bookmark item in the bookmarks list. | 175 Private method to generate a bookmark item in the bookmarks list. |
| 179 </p> | 176 </p> |
| 177 | |
| 180 <dl> | 178 <dl> |
| 181 | 179 |
| 182 <dt><i>revision</i> (str)</dt> | 180 <dt><i>revision</i> (str)</dt> |
| 183 <dd> | 181 <dd> |
| 184 revision of the bookmark | 182 revision of the bookmark |
| 197 </dd> | 195 </dd> |
| 198 </dl> | 196 </dl> |
| 199 <a NAME="HgBookmarksListDialog.__processOutputLine" ID="HgBookmarksListDialog.__processOutputLine"></a> | 197 <a NAME="HgBookmarksListDialog.__processOutputLine" ID="HgBookmarksListDialog.__processOutputLine"></a> |
| 200 <h4>HgBookmarksListDialog.__processOutputLine</h4> | 198 <h4>HgBookmarksListDialog.__processOutputLine</h4> |
| 201 <b>__processOutputLine</b>(<i>line</i>) | 199 <b>__processOutputLine</b>(<i>line</i>) |
| 202 | |
| 203 <p> | 200 <p> |
| 204 Private method to process the lines of output. | 201 Private method to process the lines of output. |
| 205 </p> | 202 </p> |
| 203 | |
| 206 <dl> | 204 <dl> |
| 207 | 205 |
| 208 <dt><i>line</i> (str)</dt> | 206 <dt><i>line</i> (str)</dt> |
| 209 <dd> | 207 <dd> |
| 210 output line to be processed | 208 output line to be processed |
| 211 </dd> | 209 </dd> |
| 212 </dl> | 210 </dl> |
| 213 <a NAME="HgBookmarksListDialog.__pullBookmark" ID="HgBookmarksListDialog.__pullBookmark"></a> | 211 <a NAME="HgBookmarksListDialog.__pullBookmark" ID="HgBookmarksListDialog.__pullBookmark"></a> |
| 214 <h4>HgBookmarksListDialog.__pullBookmark</h4> | 212 <h4>HgBookmarksListDialog.__pullBookmark</h4> |
| 215 <b>__pullBookmark</b>(<i></i>) | 213 <b>__pullBookmark</b>(<i></i>) |
| 216 | |
| 217 <p> | 214 <p> |
| 218 Private slot to pull the selected bookmark. | 215 Private slot to pull the selected bookmark. |
| 219 </p> | 216 </p> |
| 217 | |
| 220 <a NAME="HgBookmarksListDialog.__pushAllBookmarks" ID="HgBookmarksListDialog.__pushAllBookmarks"></a> | 218 <a NAME="HgBookmarksListDialog.__pushAllBookmarks" ID="HgBookmarksListDialog.__pushAllBookmarks"></a> |
| 221 <h4>HgBookmarksListDialog.__pushAllBookmarks</h4> | 219 <h4>HgBookmarksListDialog.__pushAllBookmarks</h4> |
| 222 <b>__pushAllBookmarks</b>(<i></i>) | 220 <b>__pushAllBookmarks</b>(<i></i>) |
| 223 | |
| 224 <p> | 221 <p> |
| 225 Private slot to push all bookmarks. | 222 Private slot to push all bookmarks. |
| 226 </p> | 223 </p> |
| 224 | |
| 227 <a NAME="HgBookmarksListDialog.__pushBookmark" ID="HgBookmarksListDialog.__pushBookmark"></a> | 225 <a NAME="HgBookmarksListDialog.__pushBookmark" ID="HgBookmarksListDialog.__pushBookmark"></a> |
| 228 <h4>HgBookmarksListDialog.__pushBookmark</h4> | 226 <h4>HgBookmarksListDialog.__pushBookmark</h4> |
| 229 <b>__pushBookmark</b>(<i></i>) | 227 <b>__pushBookmark</b>(<i></i>) |
| 230 | |
| 231 <p> | 228 <p> |
| 232 Private slot to push the selected bookmark. | 229 Private slot to push the selected bookmark. |
| 233 </p> | 230 </p> |
| 231 | |
| 234 <a NAME="HgBookmarksListDialog.__pushCurrentBookmark" ID="HgBookmarksListDialog.__pushCurrentBookmark"></a> | 232 <a NAME="HgBookmarksListDialog.__pushCurrentBookmark" ID="HgBookmarksListDialog.__pushCurrentBookmark"></a> |
| 235 <h4>HgBookmarksListDialog.__pushCurrentBookmark</h4> | 233 <h4>HgBookmarksListDialog.__pushCurrentBookmark</h4> |
| 236 <b>__pushCurrentBookmark</b>(<i></i>) | 234 <b>__pushCurrentBookmark</b>(<i></i>) |
| 237 | |
| 238 <p> | 235 <p> |
| 239 Private slot to push the current bookmark. | 236 Private slot to push the current bookmark. |
| 240 </p> | 237 </p> |
| 238 | |
| 241 <a NAME="HgBookmarksListDialog.__renameBookmark" ID="HgBookmarksListDialog.__renameBookmark"></a> | 239 <a NAME="HgBookmarksListDialog.__renameBookmark" ID="HgBookmarksListDialog.__renameBookmark"></a> |
| 242 <h4>HgBookmarksListDialog.__renameBookmark</h4> | 240 <h4>HgBookmarksListDialog.__renameBookmark</h4> |
| 243 <b>__renameBookmark</b>(<i></i>) | 241 <b>__renameBookmark</b>(<i></i>) |
| 244 | |
| 245 <p> | 242 <p> |
| 246 Private slot to rename the selected bookmark. | 243 Private slot to rename the selected bookmark. |
| 247 </p> | 244 </p> |
| 245 | |
| 248 <a NAME="HgBookmarksListDialog.__resizeColumns" ID="HgBookmarksListDialog.__resizeColumns"></a> | 246 <a NAME="HgBookmarksListDialog.__resizeColumns" ID="HgBookmarksListDialog.__resizeColumns"></a> |
| 249 <h4>HgBookmarksListDialog.__resizeColumns</h4> | 247 <h4>HgBookmarksListDialog.__resizeColumns</h4> |
| 250 <b>__resizeColumns</b>(<i></i>) | 248 <b>__resizeColumns</b>(<i></i>) |
| 251 | |
| 252 <p> | 249 <p> |
| 253 Private method to resize the list columns. | 250 Private method to resize the list columns. |
| 254 </p> | 251 </p> |
| 252 | |
| 255 <a NAME="HgBookmarksListDialog.__resort" ID="HgBookmarksListDialog.__resort"></a> | 253 <a NAME="HgBookmarksListDialog.__resort" ID="HgBookmarksListDialog.__resort"></a> |
| 256 <h4>HgBookmarksListDialog.__resort</h4> | 254 <h4>HgBookmarksListDialog.__resort</h4> |
| 257 <b>__resort</b>(<i></i>) | 255 <b>__resort</b>(<i></i>) |
| 258 | |
| 259 <p> | 256 <p> |
| 260 Private method to resort the tree. | 257 Private method to resort the tree. |
| 261 </p> | 258 </p> |
| 259 | |
| 262 <a NAME="HgBookmarksListDialog.__showError" ID="HgBookmarksListDialog.__showError"></a> | 260 <a NAME="HgBookmarksListDialog.__showError" ID="HgBookmarksListDialog.__showError"></a> |
| 263 <h4>HgBookmarksListDialog.__showError</h4> | 261 <h4>HgBookmarksListDialog.__showError</h4> |
| 264 <b>__showError</b>(<i>out</i>) | 262 <b>__showError</b>(<i>out</i>) |
| 265 | |
| 266 <p> | 263 <p> |
| 267 Private slot to show some error. | 264 Private slot to show some error. |
| 268 </p> | 265 </p> |
| 266 | |
| 269 <dl> | 267 <dl> |
| 270 | 268 |
| 271 <dt><i>out</i> (str)</dt> | 269 <dt><i>out</i> (str)</dt> |
| 272 <dd> | 270 <dd> |
| 273 error to be shown | 271 error to be shown |
| 274 </dd> | 272 </dd> |
| 275 </dl> | 273 </dl> |
| 276 <a NAME="HgBookmarksListDialog.__switchTo" ID="HgBookmarksListDialog.__switchTo"></a> | 274 <a NAME="HgBookmarksListDialog.__switchTo" ID="HgBookmarksListDialog.__switchTo"></a> |
| 277 <h4>HgBookmarksListDialog.__switchTo</h4> | 275 <h4>HgBookmarksListDialog.__switchTo</h4> |
| 278 <b>__switchTo</b>(<i></i>) | 276 <b>__switchTo</b>(<i></i>) |
| 279 | |
| 280 <p> | 277 <p> |
| 281 Private slot to switch the working directory to the selected revision. | 278 Private slot to switch the working directory to the selected revision. |
| 282 </p> | 279 </p> |
| 280 | |
| 283 <a NAME="HgBookmarksListDialog.closeEvent" ID="HgBookmarksListDialog.closeEvent"></a> | 281 <a NAME="HgBookmarksListDialog.closeEvent" ID="HgBookmarksListDialog.closeEvent"></a> |
| 284 <h4>HgBookmarksListDialog.closeEvent</h4> | 282 <h4>HgBookmarksListDialog.closeEvent</h4> |
| 285 <b>closeEvent</b>(<i>e</i>) | 283 <b>closeEvent</b>(<i>e</i>) |
| 286 | |
| 287 <p> | 284 <p> |
| 288 Protected slot implementing a close event handler. | 285 Protected slot implementing a close event handler. |
| 289 </p> | 286 </p> |
| 287 | |
| 290 <dl> | 288 <dl> |
| 291 | 289 |
| 292 <dt><i>e</i> (QCloseEvent)</dt> | 290 <dt><i>e</i> (QCloseEvent)</dt> |
| 293 <dd> | 291 <dd> |
| 294 close event | 292 close event |
| 295 </dd> | 293 </dd> |
| 296 </dl> | 294 </dl> |
| 297 <a NAME="HgBookmarksListDialog.on_bookmarksList_customContextMenuRequested" ID="HgBookmarksListDialog.on_bookmarksList_customContextMenuRequested"></a> | 295 <a NAME="HgBookmarksListDialog.on_bookmarksList_customContextMenuRequested" ID="HgBookmarksListDialog.on_bookmarksList_customContextMenuRequested"></a> |
| 298 <h4>HgBookmarksListDialog.on_bookmarksList_customContextMenuRequested</h4> | 296 <h4>HgBookmarksListDialog.on_bookmarksList_customContextMenuRequested</h4> |
| 299 <b>on_bookmarksList_customContextMenuRequested</b>(<i>pos</i>) | 297 <b>on_bookmarksList_customContextMenuRequested</b>(<i>pos</i>) |
| 300 | |
| 301 <p> | 298 <p> |
| 302 Private slot to handle the context menu request. | 299 Private slot to handle the context menu request. |
| 303 </p> | 300 </p> |
| 301 | |
| 304 <dl> | 302 <dl> |
| 305 | 303 |
| 306 <dt><i>pos</i> (QPoint)</dt> | 304 <dt><i>pos</i> (QPoint)</dt> |
| 307 <dd> | 305 <dd> |
| 308 position the context menu was requetsed at | 306 position the context menu was requetsed at |
| 309 </dd> | 307 </dd> |
| 310 </dl> | 308 </dl> |
| 311 <a NAME="HgBookmarksListDialog.on_buttonBox_clicked" ID="HgBookmarksListDialog.on_buttonBox_clicked"></a> | 309 <a NAME="HgBookmarksListDialog.on_buttonBox_clicked" ID="HgBookmarksListDialog.on_buttonBox_clicked"></a> |
| 312 <h4>HgBookmarksListDialog.on_buttonBox_clicked</h4> | 310 <h4>HgBookmarksListDialog.on_buttonBox_clicked</h4> |
| 313 <b>on_buttonBox_clicked</b>(<i>button</i>) | 311 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 314 | |
| 315 <p> | 312 <p> |
| 316 Private slot called by a button of the button box clicked. | 313 Private slot called by a button of the button box clicked. |
| 317 </p> | 314 </p> |
| 315 | |
| 318 <dl> | 316 <dl> |
| 319 | 317 |
| 320 <dt><i>button</i> (QAbstractButton)</dt> | 318 <dt><i>button</i> (QAbstractButton)</dt> |
| 321 <dd> | 319 <dd> |
| 322 button that was clicked | 320 button that was clicked |
| 323 </dd> | 321 </dd> |
| 324 </dl> | 322 </dl> |
| 325 <a NAME="HgBookmarksListDialog.on_refreshButton_clicked" ID="HgBookmarksListDialog.on_refreshButton_clicked"></a> | 323 <a NAME="HgBookmarksListDialog.on_refreshButton_clicked" ID="HgBookmarksListDialog.on_refreshButton_clicked"></a> |
| 326 <h4>HgBookmarksListDialog.on_refreshButton_clicked</h4> | 324 <h4>HgBookmarksListDialog.on_refreshButton_clicked</h4> |
| 327 <b>on_refreshButton_clicked</b>(<i></i>) | 325 <b>on_refreshButton_clicked</b>(<i></i>) |
| 328 | |
| 329 <p> | 326 <p> |
| 330 Private slot to refresh the status display. | 327 Private slot to refresh the status display. |
| 331 </p> | 328 </p> |
| 329 | |
| 332 <a NAME="HgBookmarksListDialog.start" ID="HgBookmarksListDialog.start"></a> | 330 <a NAME="HgBookmarksListDialog.start" ID="HgBookmarksListDialog.start"></a> |
| 333 <h4>HgBookmarksListDialog.start</h4> | 331 <h4>HgBookmarksListDialog.start</h4> |
| 334 <b>start</b>(<i>bookmarksList</i>) | 332 <b>start</b>(<i>bookmarksList</i>) |
| 335 | |
| 336 <p> | 333 <p> |
| 337 Public slot to start the bookmarks command. | 334 Public slot to start the bookmarks command. |
| 338 </p> | 335 </p> |
| 336 | |
| 339 <dl> | 337 <dl> |
| 340 | 338 |
| 341 <dt><i>bookmarksList</i> (list of str)</dt> | 339 <dt><i>bookmarksList</i> (list of str)</dt> |
| 342 <dd> | 340 <dd> |
| 343 reference to string list receiving the bookmarks | 341 reference to string list receiving the bookmarks |
