Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.shelve.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.shelve.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.ShelveExtension.shelve</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.ShelveExtension.shelve</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the shelve extension interface. | |
| 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="#Shelve">Shelve</a></td> | |
| 25 <td>Class implementing the shelve extension interface.</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="Shelve" ID="Shelve"></a> | |
| 36 <h2>Shelve</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the shelve extension interface. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 HgExtension | |
| 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="#Shelve.__init__">Shelve</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#Shelve.__hgGetShelveNamesList">__hgGetShelveNamesList</a></td> | |
| 63 <td>Private method to get the list of shelved changes.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#Shelve.hgCleanupShelves">hgCleanupShelves</a></td> | |
| 67 <td>Public method to delete all shelves.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#Shelve.hgDeleteShelves">hgDeleteShelves</a></td> | |
| 71 <td>Public method to delete named shelves.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#Shelve.hgShelve">hgShelve</a></td> | |
| 75 <td>Public method to shelve current changes of files or directories.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#Shelve.hgShelveBrowser">hgShelveBrowser</a></td> | |
| 79 <td>Public method to show the shelve browser dialog.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#Shelve.hgUnshelve">hgUnshelve</a></td> | |
| 83 <td>Public method to restore shelved changes to the project directory.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#Shelve.hgUnshelveAbort">hgUnshelveAbort</a></td> | |
| 87 <td>Public method to abort the ongoing restore operation.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#Shelve.hgUnshelveContinue">hgUnshelveContinue</a></td> | |
| 91 <td>Public method to continue the ongoing restore operation.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#Shelve.shutdown">shutdown</a></td> | |
| 95 <td>Public method used to shutdown the shelve interface.</td> | |
| 96 </tr> | |
| 97 </table> | |
| 98 <h3>Static Methods</h3> | |
| 99 | |
| 100 <table> | |
| 101 <tr><td>None</td></tr> | |
| 102 </table> | |
| 103 | |
| 104 <a NAME="Shelve.__init__" ID="Shelve.__init__"></a> | |
| 105 <h4>Shelve (Constructor)</h4> | |
| 106 <b>Shelve</b>(<i>vcs</i>) | |
| 107 | |
| 108 <p> | |
| 109 Constructor | |
| 110 </p> | |
| 111 <dl> | |
| 112 | |
| 113 <dt><i>vcs</i></dt> | |
| 114 <dd> | |
| 115 reference to the Mercurial vcs object | |
| 116 </dd> | |
| 117 </dl> | |
| 118 <a NAME="Shelve.__hgGetShelveNamesList" ID="Shelve.__hgGetShelveNamesList"></a> | |
| 119 <h4>Shelve.__hgGetShelveNamesList</h4> | |
| 120 <b>__hgGetShelveNamesList</b>(<i></i>) | |
| 121 | |
| 122 <p> | |
| 123 Private method to get the list of shelved changes. | |
| 124 </p> | |
| 125 <dl> | |
| 126 <dt>Return:</dt> | |
| 127 <dd> | |
| 128 list of shelved changes (list of string) | |
| 129 </dd> | |
| 130 </dl> | |
| 131 <a NAME="Shelve.hgCleanupShelves" ID="Shelve.hgCleanupShelves"></a> | |
| 132 <h4>Shelve.hgCleanupShelves</h4> | |
| 133 <b>hgCleanupShelves</b>(<i></i>) | |
| 134 | |
| 135 <p> | |
| 136 Public method to delete all shelves. | |
| 137 </p> | |
| 138 <a NAME="Shelve.hgDeleteShelves" ID="Shelve.hgDeleteShelves"></a> | |
| 139 <h4>Shelve.hgDeleteShelves</h4> | |
| 140 <b>hgDeleteShelves</b>(<i>shelveNames=None</i>) | |
| 141 | |
| 142 <p> | |
| 143 Public method to delete named shelves. | |
| 144 </p> | |
| 145 <dl> | |
| 146 | |
| 147 <dt><i>shelveNames</i></dt> | |
| 148 <dd> | |
| 149 name of shelves to delete (list of string) | |
| 150 </dd> | |
| 151 </dl> | |
| 152 <a NAME="Shelve.hgShelve" ID="Shelve.hgShelve"></a> | |
| 153 <h4>Shelve.hgShelve</h4> | |
| 154 <b>hgShelve</b>(<i>name</i>) | |
| 155 | |
| 156 <p> | |
| 157 Public method to shelve current changes of files or directories. | |
| 158 </p> | |
| 159 <dl> | |
| 160 | |
| 161 <dt><i>name</i></dt> | |
| 162 <dd> | |
| 163 directory or file name (string) or list of directory | |
| 164 or file names (list of string) | |
| 165 </dd> | |
| 166 </dl> | |
| 167 <dl> | |
| 168 <dt>Return:</dt> | |
| 169 <dd> | |
| 170 flag indicating that the project should be reread (boolean) | |
| 171 </dd> | |
| 172 </dl> | |
| 173 <a NAME="Shelve.hgShelveBrowser" ID="Shelve.hgShelveBrowser"></a> | |
| 174 <h4>Shelve.hgShelveBrowser</h4> | |
| 175 <b>hgShelveBrowser</b>(<i></i>) | |
| 176 | |
| 177 <p> | |
| 178 Public method to show the shelve browser dialog. | |
| 179 </p> | |
| 180 <a NAME="Shelve.hgUnshelve" ID="Shelve.hgUnshelve"></a> | |
| 181 <h4>Shelve.hgUnshelve</h4> | |
| 182 <b>hgUnshelve</b>(<i>shelveName=""</i>) | |
| 183 | |
| 184 <p> | |
| 185 Public method to restore shelved changes to the project directory. | |
| 186 </p> | |
| 187 <dl> | |
| 188 | |
| 189 <dt><i>shelveName</i></dt> | |
| 190 <dd> | |
| 191 name of the shelve to restore (string) | |
| 192 </dd> | |
| 193 </dl> | |
| 194 <dl> | |
| 195 <dt>Return:</dt> | |
| 196 <dd> | |
| 197 flag indicating that the project should be reread (boolean) | |
| 198 </dd> | |
| 199 </dl> | |
| 200 <a NAME="Shelve.hgUnshelveAbort" ID="Shelve.hgUnshelveAbort"></a> | |
| 201 <h4>Shelve.hgUnshelveAbort</h4> | |
| 202 <b>hgUnshelveAbort</b>(<i></i>) | |
| 203 | |
| 204 <p> | |
| 205 Public method to abort the ongoing restore operation. | |
| 206 </p> | |
| 207 <dl> | |
| 208 <dt>Return:</dt> | |
| 209 <dd> | |
| 210 flag indicating that the project should be reread (boolean) | |
| 211 </dd> | |
| 212 </dl> | |
| 213 <a NAME="Shelve.hgUnshelveContinue" ID="Shelve.hgUnshelveContinue"></a> | |
| 214 <h4>Shelve.hgUnshelveContinue</h4> | |
| 215 <b>hgUnshelveContinue</b>(<i></i>) | |
| 216 | |
| 217 <p> | |
| 218 Public method to continue the ongoing restore operation. | |
| 219 </p> | |
| 220 <dl> | |
| 221 <dt>Return:</dt> | |
| 222 <dd> | |
| 223 flag indicating that the project should be reread (boolean) | |
| 224 </dd> | |
| 225 </dl> | |
| 226 <a NAME="Shelve.shutdown" ID="Shelve.shutdown"></a> | |
| 227 <h4>Shelve.shutdown</h4> | |
| 228 <b>shutdown</b>(<i></i>) | |
| 229 | |
| 230 <p> | |
| 231 Public method used to shutdown the shelve interface. | |
| 232 </p> | |
| 233 <div align="right"><a href="#top">Up</a></div> | |
| 234 <hr /> | |
| 235 </body></html> |
