Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveBuiltin.shelve.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveBuiltin.shelve.html
- branch
- eric7
- changeset 11068
- 15f0385e0471
equal
deleted
inserted
replaced
| 11067:67b92e2cb719 | 11068:15f0385e0471 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.ShelveBuiltin.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.ShelveBuiltin.shelve</h1> | |
| 10 <p> | |
| 11 Module implementing the shelve extension interface. | |
| 12 </p> | |
| 13 | |
| 14 <h3>Global Attributes</h3> | |
| 15 <table> | |
| 16 <tr><td>None</td></tr> | |
| 17 </table> | |
| 18 | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#Shelve">Shelve</a></td> | |
| 23 <td>Class implementing the shelve extension interface.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 | |
| 27 <h3>Functions</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 | |
| 32 <hr /> | |
| 33 <hr /> | |
| 34 <a NAME="Shelve" ID="Shelve"></a> | |
| 35 <h2>Shelve</h2> | |
| 36 <p> | |
| 37 Class implementing the shelve extension interface. | |
| 38 </p> | |
| 39 | |
| 40 <h3>Derived from</h3> | |
| 41 HgExtension | |
| 42 <h3>Class Attributes</h3> | |
| 43 <table> | |
| 44 <tr><td>None</td></tr> | |
| 45 </table> | |
| 46 | |
| 47 <h3>Class Methods</h3> | |
| 48 <table> | |
| 49 <tr><td>None</td></tr> | |
| 50 </table> | |
| 51 | |
| 52 <h3>Methods</h3> | |
| 53 <table> | |
| 54 <tr> | |
| 55 <td><a href="#Shelve.__init__">Shelve</a></td> | |
| 56 <td>Constructor</td> | |
| 57 </tr> | |
| 58 <tr> | |
| 59 <td><a href="#Shelve.__hgGetShelveNamesList">__hgGetShelveNamesList</a></td> | |
| 60 <td>Private method to get the list of shelved changes.</td> | |
| 61 </tr> | |
| 62 <tr> | |
| 63 <td><a href="#Shelve.hgCleanupShelves">hgCleanupShelves</a></td> | |
| 64 <td>Public method to delete all shelves.</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#Shelve.hgDeleteShelves">hgDeleteShelves</a></td> | |
| 68 <td>Public method to delete named shelves.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#Shelve.hgShelve">hgShelve</a></td> | |
| 72 <td>Public method to shelve current changes of files or directories.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#Shelve.hgShelveBrowser">hgShelveBrowser</a></td> | |
| 76 <td>Public method to show the shelve browser dialog.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#Shelve.hgUnshelve">hgUnshelve</a></td> | |
| 80 <td>Public method to restore shelved changes to the project directory.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#Shelve.hgUnshelveAbort">hgUnshelveAbort</a></td> | |
| 84 <td>Public method to abort the ongoing restore operation.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#Shelve.hgUnshelveContinue">hgUnshelveContinue</a></td> | |
| 88 <td>Public method to continue the ongoing restore operation.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#Shelve.shutdown">shutdown</a></td> | |
| 92 <td>Public method used to shutdown the shelve interface.</td> | |
| 93 </tr> | |
| 94 </table> | |
| 95 | |
| 96 <h3>Static Methods</h3> | |
| 97 <table> | |
| 98 <tr><td>None</td></tr> | |
| 99 </table> | |
| 100 | |
| 101 | |
| 102 <a NAME="Shelve.__init__" ID="Shelve.__init__"></a> | |
| 103 <h4>Shelve (Constructor)</h4> | |
| 104 <b>Shelve</b>(<i>vcs, ui=None</i>) | |
| 105 <p> | |
| 106 Constructor | |
| 107 </p> | |
| 108 | |
| 109 <dl> | |
| 110 | |
| 111 <dt><i>vcs</i> (Hg)</dt> | |
| 112 <dd> | |
| 113 reference to the Mercurial vcs object | |
| 114 </dd> | |
| 115 <dt><i>ui</i> (QWidget)</dt> | |
| 116 <dd> | |
| 117 reference to a UI widget (defaults to None) | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <a NAME="Shelve.__hgGetShelveNamesList" ID="Shelve.__hgGetShelveNamesList"></a> | |
| 121 <h4>Shelve.__hgGetShelveNamesList</h4> | |
| 122 <b>__hgGetShelveNamesList</b>(<i></i>) | |
| 123 <p> | |
| 124 Private method to get the list of shelved changes. | |
| 125 </p> | |
| 126 | |
| 127 <dl> | |
| 128 <dt>Return:</dt> | |
| 129 <dd> | |
| 130 list of shelved changes | |
| 131 </dd> | |
| 132 </dl> | |
| 133 <dl> | |
| 134 <dt>Return Type:</dt> | |
| 135 <dd> | |
| 136 list of str | |
| 137 </dd> | |
| 138 </dl> | |
| 139 <a NAME="Shelve.hgCleanupShelves" ID="Shelve.hgCleanupShelves"></a> | |
| 140 <h4>Shelve.hgCleanupShelves</h4> | |
| 141 <b>hgCleanupShelves</b>(<i></i>) | |
| 142 <p> | |
| 143 Public method to delete all shelves. | |
| 144 </p> | |
| 145 | |
| 146 <a NAME="Shelve.hgDeleteShelves" ID="Shelve.hgDeleteShelves"></a> | |
| 147 <h4>Shelve.hgDeleteShelves</h4> | |
| 148 <b>hgDeleteShelves</b>(<i>shelveNames=None</i>) | |
| 149 <p> | |
| 150 Public method to delete named shelves. | |
| 151 </p> | |
| 152 | |
| 153 <dl> | |
| 154 | |
| 155 <dt><i>shelveNames</i> (list of str)</dt> | |
| 156 <dd> | |
| 157 name of shelves to delete | |
| 158 </dd> | |
| 159 </dl> | |
| 160 <a NAME="Shelve.hgShelve" ID="Shelve.hgShelve"></a> | |
| 161 <h4>Shelve.hgShelve</h4> | |
| 162 <b>hgShelve</b>(<i>name</i>) | |
| 163 <p> | |
| 164 Public method to shelve current changes of files or directories. | |
| 165 </p> | |
| 166 | |
| 167 <dl> | |
| 168 | |
| 169 <dt><i>name</i> (list of str)</dt> | |
| 170 <dd> | |
| 171 directory or file name (string) or list of directory | |
| 172 or file names | |
| 173 </dd> | |
| 174 </dl> | |
| 175 <dl> | |
| 176 <dt>Return:</dt> | |
| 177 <dd> | |
| 178 flag indicating that the project should be reread | |
| 179 </dd> | |
| 180 </dl> | |
| 181 <dl> | |
| 182 <dt>Return Type:</dt> | |
| 183 <dd> | |
| 184 bool | |
| 185 </dd> | |
| 186 </dl> | |
| 187 <a NAME="Shelve.hgShelveBrowser" ID="Shelve.hgShelveBrowser"></a> | |
| 188 <h4>Shelve.hgShelveBrowser</h4> | |
| 189 <b>hgShelveBrowser</b>(<i></i>) | |
| 190 <p> | |
| 191 Public method to show the shelve browser dialog. | |
| 192 </p> | |
| 193 | |
| 194 <a NAME="Shelve.hgUnshelve" ID="Shelve.hgUnshelve"></a> | |
| 195 <h4>Shelve.hgUnshelve</h4> | |
| 196 <b>hgUnshelve</b>(<i>shelveName=""</i>) | |
| 197 <p> | |
| 198 Public method to restore shelved changes to the project directory. | |
| 199 </p> | |
| 200 | |
| 201 <dl> | |
| 202 | |
| 203 <dt><i>shelveName</i> (str)</dt> | |
| 204 <dd> | |
| 205 name of the shelve to restore | |
| 206 </dd> | |
| 207 </dl> | |
| 208 <dl> | |
| 209 <dt>Return:</dt> | |
| 210 <dd> | |
| 211 flag indicating that the project should be reread | |
| 212 </dd> | |
| 213 </dl> | |
| 214 <dl> | |
| 215 <dt>Return Type:</dt> | |
| 216 <dd> | |
| 217 bool | |
| 218 </dd> | |
| 219 </dl> | |
| 220 <a NAME="Shelve.hgUnshelveAbort" ID="Shelve.hgUnshelveAbort"></a> | |
| 221 <h4>Shelve.hgUnshelveAbort</h4> | |
| 222 <b>hgUnshelveAbort</b>(<i></i>) | |
| 223 <p> | |
| 224 Public method to abort the ongoing restore operation. | |
| 225 </p> | |
| 226 | |
| 227 <dl> | |
| 228 <dt>Return:</dt> | |
| 229 <dd> | |
| 230 flag indicating that the project should be reread | |
| 231 </dd> | |
| 232 </dl> | |
| 233 <dl> | |
| 234 <dt>Return Type:</dt> | |
| 235 <dd> | |
| 236 bool | |
| 237 </dd> | |
| 238 </dl> | |
| 239 <a NAME="Shelve.hgUnshelveContinue" ID="Shelve.hgUnshelveContinue"></a> | |
| 240 <h4>Shelve.hgUnshelveContinue</h4> | |
| 241 <b>hgUnshelveContinue</b>(<i></i>) | |
| 242 <p> | |
| 243 Public method to continue the ongoing restore operation. | |
| 244 </p> | |
| 245 | |
| 246 <dl> | |
| 247 <dt>Return:</dt> | |
| 248 <dd> | |
| 249 flag indicating that the project should be reread | |
| 250 </dd> | |
| 251 </dl> | |
| 252 <dl> | |
| 253 <dt>Return Type:</dt> | |
| 254 <dd> | |
| 255 bool | |
| 256 </dd> | |
| 257 </dl> | |
| 258 <a NAME="Shelve.shutdown" ID="Shelve.shutdown"></a> | |
| 259 <h4>Shelve.shutdown</h4> | |
| 260 <b>shutdown</b>(<i></i>) | |
| 261 <p> | |
| 262 Public method used to shutdown the shelve interface. | |
| 263 </p> | |
| 264 | |
| 265 <div align="right"><a href="#top">Up</a></div> | |
| 266 <hr /> | |
| 267 </body></html> |
