src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.shelve.html

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 9209
b99e7fd55fd3
child 10479
856476537696
equal deleted inserted replaced
10437:2f70ca07f0af 10438:4cd7e5a8b3cf
108 <p> 108 <p>
109 Constructor 109 Constructor
110 </p> 110 </p>
111 <dl> 111 <dl>
112 112
113 <dt><i>vcs</i></dt> 113 <dt><i>vcs</i> (Hg)</dt>
114 <dd> 114 <dd>
115 reference to the Mercurial vcs object 115 reference to the Mercurial vcs object
116 </dd> 116 </dd>
117 </dl> 117 </dl>
118 <a NAME="Shelve.__hgGetShelveNamesList" ID="Shelve.__hgGetShelveNamesList"></a> 118 <a NAME="Shelve.__hgGetShelveNamesList" ID="Shelve.__hgGetShelveNamesList"></a>
123 Private method to get the list of shelved changes. 123 Private method to get the list of shelved changes.
124 </p> 124 </p>
125 <dl> 125 <dl>
126 <dt>Return:</dt> 126 <dt>Return:</dt>
127 <dd> 127 <dd>
128 list of shelved changes (list of string) 128 list of shelved changes
129 </dd>
130 </dl>
131 <dl>
132 <dt>Return Type:</dt>
133 <dd>
134 list of str
129 </dd> 135 </dd>
130 </dl> 136 </dl>
131 <a NAME="Shelve.hgCleanupShelves" ID="Shelve.hgCleanupShelves"></a> 137 <a NAME="Shelve.hgCleanupShelves" ID="Shelve.hgCleanupShelves"></a>
132 <h4>Shelve.hgCleanupShelves</h4> 138 <h4>Shelve.hgCleanupShelves</h4>
133 <b>hgCleanupShelves</b>(<i></i>) 139 <b>hgCleanupShelves</b>(<i></i>)
142 <p> 148 <p>
143 Public method to delete named shelves. 149 Public method to delete named shelves.
144 </p> 150 </p>
145 <dl> 151 <dl>
146 152
147 <dt><i>shelveNames</i></dt> 153 <dt><i>shelveNames</i> (list of str)</dt>
148 <dd> 154 <dd>
149 name of shelves to delete (list of string) 155 name of shelves to delete
150 </dd> 156 </dd>
151 </dl> 157 </dl>
152 <a NAME="Shelve.hgShelve" ID="Shelve.hgShelve"></a> 158 <a NAME="Shelve.hgShelve" ID="Shelve.hgShelve"></a>
153 <h4>Shelve.hgShelve</h4> 159 <h4>Shelve.hgShelve</h4>
154 <b>hgShelve</b>(<i>name</i>) 160 <b>hgShelve</b>(<i>name</i>)
156 <p> 162 <p>
157 Public method to shelve current changes of files or directories. 163 Public method to shelve current changes of files or directories.
158 </p> 164 </p>
159 <dl> 165 <dl>
160 166
161 <dt><i>name</i></dt> 167 <dt><i>name</i> (list of str)</dt>
162 <dd> 168 <dd>
163 directory or file name (string) or list of directory 169 directory or file name (string) or list of directory
164 or file names (list of string) 170 or file names
165 </dd> 171 </dd>
166 </dl> 172 </dl>
167 <dl> 173 <dl>
168 <dt>Return:</dt> 174 <dt>Return:</dt>
169 <dd> 175 <dd>
170 flag indicating that the project should be reread (boolean) 176 flag indicating that the project should be reread
177 </dd>
178 </dl>
179 <dl>
180 <dt>Return Type:</dt>
181 <dd>
182 bool
171 </dd> 183 </dd>
172 </dl> 184 </dl>
173 <a NAME="Shelve.hgShelveBrowser" ID="Shelve.hgShelveBrowser"></a> 185 <a NAME="Shelve.hgShelveBrowser" ID="Shelve.hgShelveBrowser"></a>
174 <h4>Shelve.hgShelveBrowser</h4> 186 <h4>Shelve.hgShelveBrowser</h4>
175 <b>hgShelveBrowser</b>(<i></i>) 187 <b>hgShelveBrowser</b>(<i></i>)
184 <p> 196 <p>
185 Public method to restore shelved changes to the project directory. 197 Public method to restore shelved changes to the project directory.
186 </p> 198 </p>
187 <dl> 199 <dl>
188 200
189 <dt><i>shelveName</i></dt> 201 <dt><i>shelveName</i> (str)</dt>
190 <dd> 202 <dd>
191 name of the shelve to restore (string) 203 name of the shelve to restore
192 </dd> 204 </dd>
193 </dl> 205 </dl>
194 <dl> 206 <dl>
195 <dt>Return:</dt> 207 <dt>Return:</dt>
196 <dd> 208 <dd>
197 flag indicating that the project should be reread (boolean) 209 flag indicating that the project should be reread
210 </dd>
211 </dl>
212 <dl>
213 <dt>Return Type:</dt>
214 <dd>
215 bool
198 </dd> 216 </dd>
199 </dl> 217 </dl>
200 <a NAME="Shelve.hgUnshelveAbort" ID="Shelve.hgUnshelveAbort"></a> 218 <a NAME="Shelve.hgUnshelveAbort" ID="Shelve.hgUnshelveAbort"></a>
201 <h4>Shelve.hgUnshelveAbort</h4> 219 <h4>Shelve.hgUnshelveAbort</h4>
202 <b>hgUnshelveAbort</b>(<i></i>) 220 <b>hgUnshelveAbort</b>(<i></i>)
205 Public method to abort the ongoing restore operation. 223 Public method to abort the ongoing restore operation.
206 </p> 224 </p>
207 <dl> 225 <dl>
208 <dt>Return:</dt> 226 <dt>Return:</dt>
209 <dd> 227 <dd>
210 flag indicating that the project should be reread (boolean) 228 flag indicating that the project should be reread
229 </dd>
230 </dl>
231 <dl>
232 <dt>Return Type:</dt>
233 <dd>
234 bool
211 </dd> 235 </dd>
212 </dl> 236 </dl>
213 <a NAME="Shelve.hgUnshelveContinue" ID="Shelve.hgUnshelveContinue"></a> 237 <a NAME="Shelve.hgUnshelveContinue" ID="Shelve.hgUnshelveContinue"></a>
214 <h4>Shelve.hgUnshelveContinue</h4> 238 <h4>Shelve.hgUnshelveContinue</h4>
215 <b>hgUnshelveContinue</b>(<i></i>) 239 <b>hgUnshelveContinue</b>(<i></i>)
218 Public method to continue the ongoing restore operation. 242 Public method to continue the ongoing restore operation.
219 </p> 243 </p>
220 <dl> 244 <dl>
221 <dt>Return:</dt> 245 <dt>Return:</dt>
222 <dd> 246 <dd>
223 flag indicating that the project should be reread (boolean) 247 flag indicating that the project should be reread
248 </dd>
249 </dl>
250 <dl>
251 <dt>Return Type:</dt>
252 <dd>
253 bool
224 </dd> 254 </dd>
225 </dl> 255 </dl>
226 <a NAME="Shelve.shutdown" ID="Shelve.shutdown"></a> 256 <a NAME="Shelve.shutdown" ID="Shelve.shutdown"></a>
227 <h4>Shelve.shutdown</h4> 257 <h4>Shelve.shutdown</h4>
228 <b>shutdown</b>(<i></i>) 258 <b>shutdown</b>(<i></i>)

eric ide

mercurial