Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarksInOutDialog.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarksInOutDialog.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.HgBookmarksInOutDialog</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.HgBookmarksInOutDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to show a list of incoming or outgoing 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="#HgBookmarksInOutDialog">HgBookmarksInOutDialog</a></td> | |
| 25 <td>Class implementing a dialog to show a list of incoming or outgoing 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="HgBookmarksInOutDialog" ID="HgBookmarksInOutDialog"></a> | |
| 36 <h2>HgBookmarksInOutDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to show a list of incoming or outgoing | |
| 40 bookmarks. | |
| 41 </p> | |
| 42 <h3>Derived from</h3> | |
| 43 QDialog, Ui_HgBookmarksInOutDialog | |
| 44 <h3>Class Attributes</h3> | |
| 45 | |
| 46 <table> | |
| 47 <tr><td>INCOMING</td></tr><tr><td>OUTGOING</td></tr> | |
| 48 </table> | |
| 49 <h3>Class Methods</h3> | |
| 50 | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 | |
| 56 <table> | |
| 57 | |
| 58 <tr> | |
| 59 <td><a href="#HgBookmarksInOutDialog.__init__">HgBookmarksInOutDialog</a></td> | |
| 60 <td>Constructor</td> | |
| 61 </tr> | |
| 62 <tr> | |
| 63 <td><a href="#HgBookmarksInOutDialog.__finish">__finish</a></td> | |
| 64 <td>Private slot called when the process finished or the user pressed the button.</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#HgBookmarksInOutDialog.__generateItem">__generateItem</a></td> | |
| 68 <td>Private method to generate a bookmark item in the bookmarks list.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#HgBookmarksInOutDialog.__processOutputLine">__processOutputLine</a></td> | |
| 72 <td>Private method to process the lines of output.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#HgBookmarksInOutDialog.__resizeColumns">__resizeColumns</a></td> | |
| 76 <td>Private method to resize the list columns.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#HgBookmarksInOutDialog.__resort">__resort</a></td> | |
| 80 <td>Private method to resort the tree.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#HgBookmarksInOutDialog.__showError">__showError</a></td> | |
| 84 <td>Private slot to show some error.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#HgBookmarksInOutDialog.closeEvent">closeEvent</a></td> | |
| 88 <td>Protected slot implementing a close event handler.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#HgBookmarksInOutDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 92 <td>Private slot called by a button of the button box clicked.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#HgBookmarksInOutDialog.start">start</a></td> | |
| 96 <td>Public slot to start the bookmarks command.</td> | |
| 97 </tr> | |
| 98 </table> | |
| 99 <h3>Static Methods</h3> | |
| 100 | |
| 101 <table> | |
| 102 <tr><td>None</td></tr> | |
| 103 </table> | |
| 104 | |
| 105 <a NAME="HgBookmarksInOutDialog.__init__" ID="HgBookmarksInOutDialog.__init__"></a> | |
| 106 <h4>HgBookmarksInOutDialog (Constructor)</h4> | |
| 107 <b>HgBookmarksInOutDialog</b>(<i>vcs, mode, parent=None</i>) | |
| 108 | |
| 109 <p> | |
| 110 Constructor | |
| 111 </p> | |
| 112 <dl> | |
| 113 | |
| 114 <dt><i>vcs</i></dt> | |
| 115 <dd> | |
| 116 reference to the vcs object | |
| 117 </dd> | |
| 118 <dt><i>mode</i></dt> | |
| 119 <dd> | |
| 120 mode of the dialog (HgBookmarksInOutDialog.INCOMING, | |
| 121 HgBookmarksInOutDialog.OUTGOING) | |
| 122 </dd> | |
| 123 <dt><i>parent</i></dt> | |
| 124 <dd> | |
| 125 reference to the parent widget (QWidget) | |
| 126 </dd> | |
| 127 </dl> | |
| 128 <dl> | |
| 129 | |
| 130 <dt>Raises <b>ValueError</b>:</dt> | |
| 131 <dd> | |
| 132 raised to indicate an invalid dialog mode | |
| 133 </dd> | |
| 134 </dl> | |
| 135 <a NAME="HgBookmarksInOutDialog.__finish" ID="HgBookmarksInOutDialog.__finish"></a> | |
| 136 <h4>HgBookmarksInOutDialog.__finish</h4> | |
| 137 <b>__finish</b>(<i></i>) | |
| 138 | |
| 139 <p> | |
| 140 Private slot called when the process finished or the user pressed | |
| 141 the button. | |
| 142 </p> | |
| 143 <a NAME="HgBookmarksInOutDialog.__generateItem" ID="HgBookmarksInOutDialog.__generateItem"></a> | |
| 144 <h4>HgBookmarksInOutDialog.__generateItem</h4> | |
| 145 <b>__generateItem</b>(<i>changeset, name</i>) | |
| 146 | |
| 147 <p> | |
| 148 Private method to generate a bookmark item in the bookmarks list. | |
| 149 </p> | |
| 150 <dl> | |
| 151 | |
| 152 <dt><i>changeset</i></dt> | |
| 153 <dd> | |
| 154 changeset of the bookmark (string) | |
| 155 </dd> | |
| 156 <dt><i>name</i></dt> | |
| 157 <dd> | |
| 158 name of the bookmark (string) | |
| 159 </dd> | |
| 160 </dl> | |
| 161 <a NAME="HgBookmarksInOutDialog.__processOutputLine" ID="HgBookmarksInOutDialog.__processOutputLine"></a> | |
| 162 <h4>HgBookmarksInOutDialog.__processOutputLine</h4> | |
| 163 <b>__processOutputLine</b>(<i>line</i>) | |
| 164 | |
| 165 <p> | |
| 166 Private method to process the lines of output. | |
| 167 </p> | |
| 168 <dl> | |
| 169 | |
| 170 <dt><i>line</i></dt> | |
| 171 <dd> | |
| 172 output line to be processed (string) | |
| 173 </dd> | |
| 174 </dl> | |
| 175 <a NAME="HgBookmarksInOutDialog.__resizeColumns" ID="HgBookmarksInOutDialog.__resizeColumns"></a> | |
| 176 <h4>HgBookmarksInOutDialog.__resizeColumns</h4> | |
| 177 <b>__resizeColumns</b>(<i></i>) | |
| 178 | |
| 179 <p> | |
| 180 Private method to resize the list columns. | |
| 181 </p> | |
| 182 <a NAME="HgBookmarksInOutDialog.__resort" ID="HgBookmarksInOutDialog.__resort"></a> | |
| 183 <h4>HgBookmarksInOutDialog.__resort</h4> | |
| 184 <b>__resort</b>(<i></i>) | |
| 185 | |
| 186 <p> | |
| 187 Private method to resort the tree. | |
| 188 </p> | |
| 189 <a NAME="HgBookmarksInOutDialog.__showError" ID="HgBookmarksInOutDialog.__showError"></a> | |
| 190 <h4>HgBookmarksInOutDialog.__showError</h4> | |
| 191 <b>__showError</b>(<i>out</i>) | |
| 192 | |
| 193 <p> | |
| 194 Private slot to show some error. | |
| 195 </p> | |
| 196 <dl> | |
| 197 | |
| 198 <dt><i>out</i></dt> | |
| 199 <dd> | |
| 200 error to be shown (string) | |
| 201 </dd> | |
| 202 </dl> | |
| 203 <a NAME="HgBookmarksInOutDialog.closeEvent" ID="HgBookmarksInOutDialog.closeEvent"></a> | |
| 204 <h4>HgBookmarksInOutDialog.closeEvent</h4> | |
| 205 <b>closeEvent</b>(<i>e</i>) | |
| 206 | |
| 207 <p> | |
| 208 Protected slot implementing a close event handler. | |
| 209 </p> | |
| 210 <dl> | |
| 211 | |
| 212 <dt><i>e</i></dt> | |
| 213 <dd> | |
| 214 close event (QCloseEvent) | |
| 215 </dd> | |
| 216 </dl> | |
| 217 <a NAME="HgBookmarksInOutDialog.on_buttonBox_clicked" ID="HgBookmarksInOutDialog.on_buttonBox_clicked"></a> | |
| 218 <h4>HgBookmarksInOutDialog.on_buttonBox_clicked</h4> | |
| 219 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 220 | |
| 221 <p> | |
| 222 Private slot called by a button of the button box clicked. | |
| 223 </p> | |
| 224 <dl> | |
| 225 | |
| 226 <dt><i>button</i></dt> | |
| 227 <dd> | |
| 228 button that was clicked (QAbstractButton) | |
| 229 </dd> | |
| 230 </dl> | |
| 231 <a NAME="HgBookmarksInOutDialog.start" ID="HgBookmarksInOutDialog.start"></a> | |
| 232 <h4>HgBookmarksInOutDialog.start</h4> | |
| 233 <b>start</b>(<i></i>) | |
| 234 | |
| 235 <p> | |
| 236 Public slot to start the bookmarks command. | |
| 237 </p> | |
| 238 <dl> | |
| 239 | |
| 240 <dt>Raises <b>ValueError</b>:</dt> | |
| 241 <dd> | |
| 242 raised to indicate an invalid dialog mode | |
| 243 </dd> | |
| 244 </dl> | |
| 245 <div align="right"><a href="#top">Up</a></div> | |
| 246 <hr /> | |
| 247 </body></html> |
