Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.shelve.html
Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.shelve.html
- changeset 3297
- 7b7e8124fb51
equal
deleted
inserted
replaced
| 3294:3aabaf28817b | 3297:7b7e8124fb51 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric5.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.shelve</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.shelve</h1> | |
| 23 <p> | |
| 24 Module implementing the shelve extension interface. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#Shelve">Shelve</a></td> | |
| 34 <td>Class implementing the shelve extension interface.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="Shelve" ID="Shelve"></a> | |
| 43 <h2>Shelve</h2> | |
| 44 <p> | |
| 45 Class implementing the shelve extension interface. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 HgExtension | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#Shelve.__init__">Shelve</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#Shelve.__hgGetShelveNamesList">__hgGetShelveNamesList</a></td> | |
| 64 <td>Private method to get the list of shelved changes.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#Shelve.hgCleanupShelves">hgCleanupShelves</a></td> | |
| 67 <td>Public method to delete all shelves.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#Shelve.hgDeleteShelves">hgDeleteShelves</a></td> | |
| 70 <td>Public method to delete named shelves.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#Shelve.hgShelve">hgShelve</a></td> | |
| 73 <td>Public method to shelve current changes of files or directories.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#Shelve.hgShelveBrowser">hgShelveBrowser</a></td> | |
| 76 <td>Public method to show the shelve browser dialog.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#Shelve.hgUnshelve">hgUnshelve</a></td> | |
| 79 <td>Public method to restore shelved changes to the project directory.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#Shelve.hgUnshelveAbort">hgUnshelveAbort</a></td> | |
| 82 <td>Public method to abort the ongoing restore operation.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#Shelve.hgUnshelveContinue">hgUnshelveContinue</a></td> | |
| 85 <td>Public method to continue the ongoing restore operation.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#Shelve.shutdown">shutdown</a></td> | |
| 88 <td>Public method used to shutdown the shelve interface.</td> | |
| 89 </tr> | |
| 90 </table> | |
| 91 <h3>Static Methods</h3> | |
| 92 <table> | |
| 93 <tr><td>None</td></tr> | |
| 94 </table> | |
| 95 <a NAME="Shelve.__init__" ID="Shelve.__init__"></a> | |
| 96 <h4>Shelve (Constructor)</h4> | |
| 97 <b>Shelve</b>(<i>vcs</i>) | |
| 98 <p> | |
| 99 Constructor | |
| 100 </p><dl> | |
| 101 <dt><i>vcs</i></dt> | |
| 102 <dd> | |
| 103 reference to the Mercurial vcs object | |
| 104 </dd> | |
| 105 </dl><a NAME="Shelve.__hgGetShelveNamesList" ID="Shelve.__hgGetShelveNamesList"></a> | |
| 106 <h4>Shelve.__hgGetShelveNamesList</h4> | |
| 107 <b>__hgGetShelveNamesList</b>(<i>repodir</i>) | |
| 108 <p> | |
| 109 Private method to get the list of shelved changes. | |
| 110 </p><dl> | |
| 111 <dt><i>repodir</i></dt> | |
| 112 <dd> | |
| 113 directory name of the repository (string) | |
| 114 </dd> | |
| 115 </dl><dl> | |
| 116 <dt>Returns:</dt> | |
| 117 <dd> | |
| 118 list of shelved changes (list of string) | |
| 119 </dd> | |
| 120 </dl><a NAME="Shelve.hgCleanupShelves" ID="Shelve.hgCleanupShelves"></a> | |
| 121 <h4>Shelve.hgCleanupShelves</h4> | |
| 122 <b>hgCleanupShelves</b>(<i>name</i>) | |
| 123 <p> | |
| 124 Public method to delete all shelves. | |
| 125 </p><dl> | |
| 126 <dt><i>name</i></dt> | |
| 127 <dd> | |
| 128 name of the project directory (string) | |
| 129 </dd> | |
| 130 </dl><a NAME="Shelve.hgDeleteShelves" ID="Shelve.hgDeleteShelves"></a> | |
| 131 <h4>Shelve.hgDeleteShelves</h4> | |
| 132 <b>hgDeleteShelves</b>(<i>name, shelveNames=None</i>) | |
| 133 <p> | |
| 134 Public method to delete named shelves. | |
| 135 </p><dl> | |
| 136 <dt><i>name</i></dt> | |
| 137 <dd> | |
| 138 name of the project directory (string) | |
| 139 </dd><dt><i>shelveNames</i></dt> | |
| 140 <dd> | |
| 141 name of shelves to delete (list of string) | |
| 142 </dd> | |
| 143 </dl><a NAME="Shelve.hgShelve" ID="Shelve.hgShelve"></a> | |
| 144 <h4>Shelve.hgShelve</h4> | |
| 145 <b>hgShelve</b>(<i>name</i>) | |
| 146 <p> | |
| 147 Public method to shelve current changes of files or directories. | |
| 148 </p><dl> | |
| 149 <dt><i>name</i></dt> | |
| 150 <dd> | |
| 151 directory or file name (string) or list of directory | |
| 152 or file names (list of string) | |
| 153 </dd> | |
| 154 </dl><dl> | |
| 155 <dt>Returns:</dt> | |
| 156 <dd> | |
| 157 flag indicating that the project should be reread (boolean) | |
| 158 </dd> | |
| 159 </dl><a NAME="Shelve.hgShelveBrowser" ID="Shelve.hgShelveBrowser"></a> | |
| 160 <h4>Shelve.hgShelveBrowser</h4> | |
| 161 <b>hgShelveBrowser</b>(<i>projectDir</i>) | |
| 162 <p> | |
| 163 Public method to show the shelve browser dialog. | |
| 164 </p><dl> | |
| 165 <dt><i>projectDir</i></dt> | |
| 166 <dd> | |
| 167 name of the project directory (string) | |
| 168 </dd> | |
| 169 </dl><a NAME="Shelve.hgUnshelve" ID="Shelve.hgUnshelve"></a> | |
| 170 <h4>Shelve.hgUnshelve</h4> | |
| 171 <b>hgUnshelve</b>(<i>name, shelveName=""</i>) | |
| 172 <p> | |
| 173 Public method to restore shelved changes to the project directory. | |
| 174 </p><dl> | |
| 175 <dt><i>name</i></dt> | |
| 176 <dd> | |
| 177 name of the project directory (string) | |
| 178 </dd><dt><i>shelveName=</i></dt> | |
| 179 <dd> | |
| 180 name of the shelve to restore (string) | |
| 181 </dd> | |
| 182 </dl><dl> | |
| 183 <dt>Returns:</dt> | |
| 184 <dd> | |
| 185 flag indicating that the project should be reread (boolean) | |
| 186 </dd> | |
| 187 </dl><a NAME="Shelve.hgUnshelveAbort" ID="Shelve.hgUnshelveAbort"></a> | |
| 188 <h4>Shelve.hgUnshelveAbort</h4> | |
| 189 <b>hgUnshelveAbort</b>(<i>name</i>) | |
| 190 <p> | |
| 191 Public method to abort the ongoing restore operation. | |
| 192 </p><dl> | |
| 193 <dt><i>name</i></dt> | |
| 194 <dd> | |
| 195 name of the project directory (string) | |
| 196 </dd> | |
| 197 </dl><dl> | |
| 198 <dt>Returns:</dt> | |
| 199 <dd> | |
| 200 flag indicating that the project should be reread (boolean) | |
| 201 </dd> | |
| 202 </dl><a NAME="Shelve.hgUnshelveContinue" ID="Shelve.hgUnshelveContinue"></a> | |
| 203 <h4>Shelve.hgUnshelveContinue</h4> | |
| 204 <b>hgUnshelveContinue</b>(<i>name</i>) | |
| 205 <p> | |
| 206 Public method to continue the ongoing restore operation. | |
| 207 </p><dl> | |
| 208 <dt><i>name</i></dt> | |
| 209 <dd> | |
| 210 name of the project directory (string) | |
| 211 </dd> | |
| 212 </dl><dl> | |
| 213 <dt>Returns:</dt> | |
| 214 <dd> | |
| 215 flag indicating that the project should be reread (boolean) | |
| 216 </dd> | |
| 217 </dl><a NAME="Shelve.shutdown" ID="Shelve.shutdown"></a> | |
| 218 <h4>Shelve.shutdown</h4> | |
| 219 <b>shutdown</b>(<i></i>) | |
| 220 <p> | |
| 221 Public method used to shutdown the shelve interface. | |
| 222 </p> | |
| 223 <div align="right"><a href="#top">Up</a></div> | |
| 224 <hr /> | |
| 225 </body></html> |
