Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.shelve.html

eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.shelve.html

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

Mercurial Repository: eric

eric ide

mercurial