Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnStatusDialog.html
Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnStatusDialog.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Plugins.VcsPlugins.vcsPySvn.SvnStatusDialog</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.Plugins.VcsPlugins.vcsPySvn.SvnStatusDialog</h1> | |
| 12 <p> | |
| 13 Module implementing a dialog to show the output of the svn status command process. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#SvnStatusDialog">SvnStatusDialog</a></td> | |
| 23 <td>Class implementing a dialog to show the output of the svn status command process.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="SvnStatusDialog" ID="SvnStatusDialog"></a> | |
| 32 <h2>SvnStatusDialog</h2> | |
| 33 <p> | |
| 34 Class implementing a dialog to show the output of the svn status command process. | |
| 35 </p> | |
| 36 <h3>Derived from</h3> | |
| 37 QWidget, SvnDialogMixin, Ui_SvnStatusDialog | |
| 38 <h3>Class Attributes</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <h3>Methods</h3> | |
| 43 <table> | |
| 44 <tr> | |
| 45 <td><a href="#SvnStatusDialog.__init__">SvnStatusDialog</a></td> | |
| 46 <td>Constructor</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#SvnStatusDialog.__add">__add</a></td> | |
| 49 <td>Private slot to handle the Add context menu entry.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#SvnStatusDialog.__addToChangelist">__addToChangelist</a></td> | |
| 52 <td>Private slot to add entries to a changelist.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#SvnStatusDialog.__breakLock">__breakLock</a></td> | |
| 55 <td>Private slot to handle the Break Lock context menu entry.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#SvnStatusDialog.__commit">__commit</a></td> | |
| 58 <td>Private slot to handle the Commit context menu entry.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#SvnStatusDialog.__committed">__committed</a></td> | |
| 61 <td>Private slot called after the commit has finished.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#SvnStatusDialog.__finish">__finish</a></td> | |
| 64 <td>Private slot called when the process finished or the user pressed the button.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#SvnStatusDialog.__generateItem">__generateItem</a></td> | |
| 67 <td>Private method to generate a status item in the status list.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#SvnStatusDialog.__getChangelistItems">__getChangelistItems</a></td> | |
| 70 <td>Private method to retrieve all entries, that are members of a changelist.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#SvnStatusDialog.__getLockActionItems">__getLockActionItems</a></td> | |
| 73 <td>Private method to retrieve all entries, that have a locked status.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#SvnStatusDialog.__getModifiedItems">__getModifiedItems</a></td> | |
| 76 <td>Private method to retrieve all entries, that have a modified status.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#SvnStatusDialog.__getNonChangelistItems">__getNonChangelistItems</a></td> | |
| 79 <td>Private method to retrieve all entries, that are not members of a changelist.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#SvnStatusDialog.__getUnversionedItems">__getUnversionedItems</a></td> | |
| 82 <td>Private method to retrieve all entries, that have an unversioned status.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#SvnStatusDialog.__lock">__lock</a></td> | |
| 85 <td>Private slot to handle the Lock context menu entry.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#SvnStatusDialog.__removeFromChangelist">__removeFromChangelist</a></td> | |
| 88 <td>Private slot to remove entries from their changelists.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#SvnStatusDialog.__resizeColumns">__resizeColumns</a></td> | |
| 91 <td>Private method to resize the list columns.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#SvnStatusDialog.__resort">__resort</a></td> | |
| 94 <td>Private method to resort the tree.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#SvnStatusDialog.__revert">__revert</a></td> | |
| 97 <td>Private slot to handle the Revert context menu entry.</td> | |
| 98 </tr><tr> | |
| 99 <td><a href="#SvnStatusDialog.__showContextMenu">__showContextMenu</a></td> | |
| 100 <td>Protected slot to show the context menu of the status list.</td> | |
| 101 </tr><tr> | |
| 102 <td><a href="#SvnStatusDialog.__showError">__showError</a></td> | |
| 103 <td>Private slot to show an error message.</td> | |
| 104 </tr><tr> | |
| 105 <td><a href="#SvnStatusDialog.__stealLock">__stealLock</a></td> | |
| 106 <td>Private slot to handle the Break Lock context menu entry.</td> | |
| 107 </tr><tr> | |
| 108 <td><a href="#SvnStatusDialog.__unlock">__unlock</a></td> | |
| 109 <td>Private slot to handle the Unlock context menu entry.</td> | |
| 110 </tr><tr> | |
| 111 <td><a href="#SvnStatusDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 112 <td>Private slot called by a button of the button box clicked.</td> | |
| 113 </tr><tr> | |
| 114 <td><a href="#SvnStatusDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> | |
| 115 <td>Private slot to refresh the status display.</td> | |
| 116 </tr><tr> | |
| 117 <td><a href="#SvnStatusDialog.start">start</a></td> | |
| 118 <td>Public slot to start the svn status command.</td> | |
| 119 </tr> | |
| 120 </table> | |
| 121 <a NAME="SvnStatusDialog.__init__" ID="SvnStatusDialog.__init__"></a> | |
| 122 <h4>SvnStatusDialog (Constructor)</h4> | |
| 123 <b>SvnStatusDialog</b>(<i>vcs, parent = None</i>) | |
| 124 <p> | |
| 125 Constructor | |
| 126 </p><dl> | |
| 127 <dt><i>vcs</i></dt> | |
| 128 <dd> | |
| 129 reference to the vcs object | |
| 130 </dd><dt><i>parent</i></dt> | |
| 131 <dd> | |
| 132 parent widget (QWidget) | |
| 133 </dd> | |
| 134 </dl><a NAME="SvnStatusDialog.__add" ID="SvnStatusDialog.__add"></a> | |
| 135 <h4>SvnStatusDialog.__add</h4> | |
| 136 <b>__add</b>(<i></i>) | |
| 137 <p> | |
| 138 Private slot to handle the Add context menu entry. | |
| 139 </p><a NAME="SvnStatusDialog.__addToChangelist" ID="SvnStatusDialog.__addToChangelist"></a> | |
| 140 <h4>SvnStatusDialog.__addToChangelist</h4> | |
| 141 <b>__addToChangelist</b>(<i></i>) | |
| 142 <p> | |
| 143 Private slot to add entries to a changelist. | |
| 144 </p><a NAME="SvnStatusDialog.__breakLock" ID="SvnStatusDialog.__breakLock"></a> | |
| 145 <h4>SvnStatusDialog.__breakLock</h4> | |
| 146 <b>__breakLock</b>(<i></i>) | |
| 147 <p> | |
| 148 Private slot to handle the Break Lock context menu entry. | |
| 149 </p><a NAME="SvnStatusDialog.__commit" ID="SvnStatusDialog.__commit"></a> | |
| 150 <h4>SvnStatusDialog.__commit</h4> | |
| 151 <b>__commit</b>(<i></i>) | |
| 152 <p> | |
| 153 Private slot to handle the Commit context menu entry. | |
| 154 </p><a NAME="SvnStatusDialog.__committed" ID="SvnStatusDialog.__committed"></a> | |
| 155 <h4>SvnStatusDialog.__committed</h4> | |
| 156 <b>__committed</b>(<i></i>) | |
| 157 <p> | |
| 158 Private slot called after the commit has finished. | |
| 159 </p><a NAME="SvnStatusDialog.__finish" ID="SvnStatusDialog.__finish"></a> | |
| 160 <h4>SvnStatusDialog.__finish</h4> | |
| 161 <b>__finish</b>(<i></i>) | |
| 162 <p> | |
| 163 Private slot called when the process finished or the user pressed the button. | |
| 164 </p><a NAME="SvnStatusDialog.__generateItem" ID="SvnStatusDialog.__generateItem"></a> | |
| 165 <h4>SvnStatusDialog.__generateItem</h4> | |
| 166 <b>__generateItem</b>(<i>changelist, status, propStatus, locked, history, switched, lockinfo, uptodate, revision, change, author, path</i>) | |
| 167 <p> | |
| 168 Private method to generate a status item in the status list. | |
| 169 </p><dl> | |
| 170 <dt><i>changelist</i></dt> | |
| 171 <dd> | |
| 172 name of the changelist (string) | |
| 173 </dd><dt><i>status</i></dt> | |
| 174 <dd> | |
| 175 text status (pysvn.wc_status_kind) | |
| 176 </dd><dt><i>propStatus</i></dt> | |
| 177 <dd> | |
| 178 property status (pysvn.wc_status_kind) | |
| 179 </dd><dt><i>locked</i></dt> | |
| 180 <dd> | |
| 181 locked flag (boolean) | |
| 182 </dd><dt><i>history</i></dt> | |
| 183 <dd> | |
| 184 history flag (boolean) | |
| 185 </dd><dt><i>switched</i></dt> | |
| 186 <dd> | |
| 187 switched flag (boolean) | |
| 188 </dd><dt><i>lockinfo</i></dt> | |
| 189 <dd> | |
| 190 lock indicator (string) | |
| 191 </dd><dt><i>uptodate</i></dt> | |
| 192 <dd> | |
| 193 up to date flag (boolean) | |
| 194 </dd><dt><i>revision</i></dt> | |
| 195 <dd> | |
| 196 revision (integer) | |
| 197 </dd><dt><i>change</i></dt> | |
| 198 <dd> | |
| 199 revision of last change (integer) | |
| 200 </dd><dt><i>author</i></dt> | |
| 201 <dd> | |
| 202 author of the last change (string) | |
| 203 </dd><dt><i>path</i></dt> | |
| 204 <dd> | |
| 205 path of the file or directory (string) | |
| 206 </dd> | |
| 207 </dl><a NAME="SvnStatusDialog.__getChangelistItems" ID="SvnStatusDialog.__getChangelistItems"></a> | |
| 208 <h4>SvnStatusDialog.__getChangelistItems</h4> | |
| 209 <b>__getChangelistItems</b>(<i></i>) | |
| 210 <p> | |
| 211 Private method to retrieve all entries, that are members of a changelist. | |
| 212 </p><dl> | |
| 213 <dt>Returns:</dt> | |
| 214 <dd> | |
| 215 list of all items belonging to a changelist | |
| 216 </dd> | |
| 217 </dl><a NAME="SvnStatusDialog.__getLockActionItems" ID="SvnStatusDialog.__getLockActionItems"></a> | |
| 218 <h4>SvnStatusDialog.__getLockActionItems</h4> | |
| 219 <b>__getLockActionItems</b>(<i>indicators</i>) | |
| 220 <p> | |
| 221 Private method to retrieve all entries, that have a locked status. | |
| 222 </p><dl> | |
| 223 <dt>Returns:</dt> | |
| 224 <dd> | |
| 225 list of all items with a locked status | |
| 226 </dd> | |
| 227 </dl><a NAME="SvnStatusDialog.__getModifiedItems" ID="SvnStatusDialog.__getModifiedItems"></a> | |
| 228 <h4>SvnStatusDialog.__getModifiedItems</h4> | |
| 229 <b>__getModifiedItems</b>(<i></i>) | |
| 230 <p> | |
| 231 Private method to retrieve all entries, that have a modified status. | |
| 232 </p><dl> | |
| 233 <dt>Returns:</dt> | |
| 234 <dd> | |
| 235 list of all items with a modified status | |
| 236 </dd> | |
| 237 </dl><a NAME="SvnStatusDialog.__getNonChangelistItems" ID="SvnStatusDialog.__getNonChangelistItems"></a> | |
| 238 <h4>SvnStatusDialog.__getNonChangelistItems</h4> | |
| 239 <b>__getNonChangelistItems</b>(<i></i>) | |
| 240 <p> | |
| 241 Private method to retrieve all entries, that are not members of a changelist. | |
| 242 </p><dl> | |
| 243 <dt>Returns:</dt> | |
| 244 <dd> | |
| 245 list of all items not belonging to a changelist | |
| 246 </dd> | |
| 247 </dl><a NAME="SvnStatusDialog.__getUnversionedItems" ID="SvnStatusDialog.__getUnversionedItems"></a> | |
| 248 <h4>SvnStatusDialog.__getUnversionedItems</h4> | |
| 249 <b>__getUnversionedItems</b>(<i></i>) | |
| 250 <p> | |
| 251 Private method to retrieve all entries, that have an unversioned status. | |
| 252 </p><dl> | |
| 253 <dt>Returns:</dt> | |
| 254 <dd> | |
| 255 list of all items with an unversioned status | |
| 256 </dd> | |
| 257 </dl><a NAME="SvnStatusDialog.__lock" ID="SvnStatusDialog.__lock"></a> | |
| 258 <h4>SvnStatusDialog.__lock</h4> | |
| 259 <b>__lock</b>(<i></i>) | |
| 260 <p> | |
| 261 Private slot to handle the Lock context menu entry. | |
| 262 </p><a NAME="SvnStatusDialog.__removeFromChangelist" ID="SvnStatusDialog.__removeFromChangelist"></a> | |
| 263 <h4>SvnStatusDialog.__removeFromChangelist</h4> | |
| 264 <b>__removeFromChangelist</b>(<i></i>) | |
| 265 <p> | |
| 266 Private slot to remove entries from their changelists. | |
| 267 </p><a NAME="SvnStatusDialog.__resizeColumns" ID="SvnStatusDialog.__resizeColumns"></a> | |
| 268 <h4>SvnStatusDialog.__resizeColumns</h4> | |
| 269 <b>__resizeColumns</b>(<i></i>) | |
| 270 <p> | |
| 271 Private method to resize the list columns. | |
| 272 </p><a NAME="SvnStatusDialog.__resort" ID="SvnStatusDialog.__resort"></a> | |
| 273 <h4>SvnStatusDialog.__resort</h4> | |
| 274 <b>__resort</b>(<i></i>) | |
| 275 <p> | |
| 276 Private method to resort the tree. | |
| 277 </p><a NAME="SvnStatusDialog.__revert" ID="SvnStatusDialog.__revert"></a> | |
| 278 <h4>SvnStatusDialog.__revert</h4> | |
| 279 <b>__revert</b>(<i></i>) | |
| 280 <p> | |
| 281 Private slot to handle the Revert context menu entry. | |
| 282 </p><a NAME="SvnStatusDialog.__showContextMenu" ID="SvnStatusDialog.__showContextMenu"></a> | |
| 283 <h4>SvnStatusDialog.__showContextMenu</h4> | |
| 284 <b>__showContextMenu</b>(<i>coord</i>) | |
| 285 <p> | |
| 286 Protected slot to show the context menu of the status list. | |
| 287 </p><dl> | |
| 288 <dt><i>coord</i></dt> | |
| 289 <dd> | |
| 290 the position of the mouse pointer (QPoint) | |
| 291 </dd> | |
| 292 </dl><a NAME="SvnStatusDialog.__showError" ID="SvnStatusDialog.__showError"></a> | |
| 293 <h4>SvnStatusDialog.__showError</h4> | |
| 294 <b>__showError</b>(<i>msg</i>) | |
| 295 <p> | |
| 296 Private slot to show an error message. | |
| 297 </p><dl> | |
| 298 <dt><i>msg</i></dt> | |
| 299 <dd> | |
| 300 error message to show (string) | |
| 301 </dd> | |
| 302 </dl><a NAME="SvnStatusDialog.__stealLock" ID="SvnStatusDialog.__stealLock"></a> | |
| 303 <h4>SvnStatusDialog.__stealLock</h4> | |
| 304 <b>__stealLock</b>(<i></i>) | |
| 305 <p> | |
| 306 Private slot to handle the Break Lock context menu entry. | |
| 307 </p><a NAME="SvnStatusDialog.__unlock" ID="SvnStatusDialog.__unlock"></a> | |
| 308 <h4>SvnStatusDialog.__unlock</h4> | |
| 309 <b>__unlock</b>(<i></i>) | |
| 310 <p> | |
| 311 Private slot to handle the Unlock context menu entry. | |
| 312 </p><a NAME="SvnStatusDialog.on_buttonBox_clicked" ID="SvnStatusDialog.on_buttonBox_clicked"></a> | |
| 313 <h4>SvnStatusDialog.on_buttonBox_clicked</h4> | |
| 314 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 315 <p> | |
| 316 Private slot called by a button of the button box clicked. | |
| 317 </p><dl> | |
| 318 <dt><i>button</i></dt> | |
| 319 <dd> | |
| 320 button that was clicked (QAbstractButton) | |
| 321 </dd> | |
| 322 </dl><a NAME="SvnStatusDialog.on_refreshButton_clicked" ID="SvnStatusDialog.on_refreshButton_clicked"></a> | |
| 323 <h4>SvnStatusDialog.on_refreshButton_clicked</h4> | |
| 324 <b>on_refreshButton_clicked</b>(<i></i>) | |
| 325 <p> | |
| 326 Private slot to refresh the status display. | |
| 327 </p><a NAME="SvnStatusDialog.start" ID="SvnStatusDialog.start"></a> | |
| 328 <h4>SvnStatusDialog.start</h4> | |
| 329 <b>start</b>(<i>fn</i>) | |
| 330 <p> | |
| 331 Public slot to start the svn status command. | |
| 332 </p><dl> | |
| 333 <dt><i>fn</i></dt> | |
| 334 <dd> | |
| 335 filename(s)/directoryname(s) to show the status of | |
| 336 (string or list of strings) | |
| 337 </dd> | |
| 338 </dl> | |
| 339 <div align="right"><a href="#top">Up</a></div> | |
| 340 <hr /> | |
| 341 </body></html> |
