Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.ProjectHelper.html

changeset 1037
b547147ccb4b
child 1048
0cfd237feaf7
equal deleted inserted replaced
1036:1922b6ce2a57 1037:b547147ccb4b
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.ProjectHelper</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.ProjectHelper</h1>
24 <p>
25 Module implementing the queues extension project helper.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#QueuesProjectHelper">QueuesProjectHelper</a></td>
35 <td>Class implementing the queues extension project helper.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="QueuesProjectHelper" ID="QueuesProjectHelper"></a>
44 <h2>QueuesProjectHelper</h2>
45 <p>
46 Class implementing the queues extension project helper.
47 </p>
48 <h3>Derived from</h3>
49 QObject
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#QueuesProjectHelper.__init__">QueuesProjectHelper</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#QueuesProjectHelper.__hgQueueDeletePatch">__hgQueueDeletePatch</a></td>
61 <td>Private slot used to delete a patch.</td>
62 </tr><tr>
63 <td><a href="#QueuesProjectHelper.__hgQueueFinishAppliedPatches">__hgQueueFinishAppliedPatches</a></td>
64 <td>Private slot used to finish all applied patches.</td>
65 </tr><tr>
66 <td><a href="#QueuesProjectHelper.__hgQueueFoldUnappliedPatches">__hgQueueFoldUnappliedPatches</a></td>
67 <td>Private slot used to fold patches into the current patch.</td>
68 </tr><tr>
69 <td><a href="#QueuesProjectHelper.__hgQueueGotoPatch">__hgQueueGotoPatch</a></td>
70 <td>Private slot used to push or pop patches until the a named one is at the top of the stack.</td>
71 </tr><tr>
72 <td><a href="#QueuesProjectHelper.__hgQueueGotoPatchForced">__hgQueueGotoPatchForced</a></td>
73 <td>Private slot used to push or pop patches until the a named one is at the top of the stack overwriting local changes.</td>
74 </tr><tr>
75 <td><a href="#QueuesProjectHelper.__hgQueueListPatches">__hgQueueListPatches</a></td>
76 <td>Private slot used to show a list of applied and unapplied patches.</td>
77 </tr><tr>
78 <td><a href="#QueuesProjectHelper.__hgQueueNewPatch">__hgQueueNewPatch</a></td>
79 <td>Private slot used to create a new named patch.</td>
80 </tr><tr>
81 <td><a href="#QueuesProjectHelper.__hgQueuePopAllPatches">__hgQueuePopAllPatches</a></td>
82 <td>Private slot used to pop all patches off the stack.</td>
83 </tr><tr>
84 <td><a href="#QueuesProjectHelper.__hgQueuePopAllPatchesForced">__hgQueuePopAllPatchesForced</a></td>
85 <td>Private slot used to pop all patches off the stack forgetting any local changes to patched files.</td>
86 </tr><tr>
87 <td><a href="#QueuesProjectHelper.__hgQueuePopPatch">__hgQueuePopPatch</a></td>
88 <td>Private slot used to pop the current patch off the stack.</td>
89 </tr><tr>
90 <td><a href="#QueuesProjectHelper.__hgQueuePopPatchForced">__hgQueuePopPatchForced</a></td>
91 <td>Private slot used to pop the current patch off the stack forgetting any local changes to patched files.</td>
92 </tr><tr>
93 <td><a href="#QueuesProjectHelper.__hgQueuePopPatches">__hgQueuePopPatches</a></td>
94 <td>Private slot used to pop patches off the stack until a named one is at the top.</td>
95 </tr><tr>
96 <td><a href="#QueuesProjectHelper.__hgQueuePopPatchesForced">__hgQueuePopPatchesForced</a></td>
97 <td>Private slot used to pop patches off the stack until a named one is at the top forgetting any local changes to patched files.</td>
98 </tr><tr>
99 <td><a href="#QueuesProjectHelper.__hgQueuePushAllPatches">__hgQueuePushAllPatches</a></td>
100 <td>Private slot used to push all patches onto the stack.</td>
101 </tr><tr>
102 <td><a href="#QueuesProjectHelper.__hgQueuePushAllPatchesForced">__hgQueuePushAllPatchesForced</a></td>
103 <td>Private slot used to push all patches onto the stack on top of local changes.</td>
104 </tr><tr>
105 <td><a href="#QueuesProjectHelper.__hgQueuePushPatch">__hgQueuePushPatch</a></td>
106 <td>Private slot used to push the next patch onto the stack.</td>
107 </tr><tr>
108 <td><a href="#QueuesProjectHelper.__hgQueuePushPatchForced">__hgQueuePushPatchForced</a></td>
109 <td>Private slot used to push the next patch onto the stack on top of local changes.</td>
110 </tr><tr>
111 <td><a href="#QueuesProjectHelper.__hgQueuePushPatches">__hgQueuePushPatches</a></td>
112 <td>Private slot used to push patches onto the stack until a named one is at the top.</td>
113 </tr><tr>
114 <td><a href="#QueuesProjectHelper.__hgQueuePushPatchesForced">__hgQueuePushPatchesForced</a></td>
115 <td>Private slot used to push patches onto the stack until a named one is at the top on top of local changes.</td>
116 </tr><tr>
117 <td><a href="#QueuesProjectHelper.__hgQueueRefreshPatch">__hgQueueRefreshPatch</a></td>
118 <td>Private slot used to refresh the current patch.</td>
119 </tr><tr>
120 <td><a href="#QueuesProjectHelper.__hgQueueRefreshPatchMessage">__hgQueueRefreshPatchMessage</a></td>
121 <td>Private slot used to refresh the current patch and it's commit message.</td>
122 </tr><tr>
123 <td><a href="#QueuesProjectHelper.__hgQueueRenamePatch">__hgQueueRenamePatch</a></td>
124 <td>Private slot used to rename a patch.</td>
125 </tr><tr>
126 <td><a href="#QueuesProjectHelper.__hgQueueShowHeader">__hgQueueShowHeader</a></td>
127 <td>Private slot used to show the commit message of the current patch.</td>
128 </tr><tr>
129 <td><a href="#QueuesProjectHelper.__hgQueueShowPatch">__hgQueueShowPatch</a></td>
130 <td>Private slot used to show the contents of the current patch.</td>
131 </tr><tr>
132 <td><a href="#QueuesProjectHelper.__initPushPopActions">__initPushPopActions</a></td>
133 <td>Public method to generate the push and pop action objects.</td>
134 </tr><tr>
135 <td><a href="#QueuesProjectHelper.__initPushPopForceActions">__initPushPopForceActions</a></td>
136 <td>Public method to generate the push and pop (force) action objects.</td>
137 </tr><tr>
138 <td><a href="#QueuesProjectHelper.getActions">getActions</a></td>
139 <td>Public method to get a list of all actions.</td>
140 </tr><tr>
141 <td><a href="#QueuesProjectHelper.initActions">initActions</a></td>
142 <td>Public method to generate the action objects.</td>
143 </tr><tr>
144 <td><a href="#QueuesProjectHelper.initMenu">initMenu</a></td>
145 <td>Public method to generate the VCS menu.</td>
146 </tr><tr>
147 <td><a href="#QueuesProjectHelper.setObjects">setObjects</a></td>
148 <td>Public method to set references to the vcs and project objects.</td>
149 </tr>
150 </table>
151 <a NAME="QueuesProjectHelper.__init__" ID="QueuesProjectHelper.__init__"></a>
152 <h4>QueuesProjectHelper (Constructor)</h4>
153 <b>QueuesProjectHelper</b>(<i></i>)
154 <p>
155 Constructor
156 </p><a NAME="QueuesProjectHelper.__hgQueueDeletePatch" ID="QueuesProjectHelper.__hgQueueDeletePatch"></a>
157 <h4>QueuesProjectHelper.__hgQueueDeletePatch</h4>
158 <b>__hgQueueDeletePatch</b>(<i></i>)
159 <p>
160 Private slot used to delete a patch.
161 </p><a NAME="QueuesProjectHelper.__hgQueueFinishAppliedPatches" ID="QueuesProjectHelper.__hgQueueFinishAppliedPatches"></a>
162 <h4>QueuesProjectHelper.__hgQueueFinishAppliedPatches</h4>
163 <b>__hgQueueFinishAppliedPatches</b>(<i></i>)
164 <p>
165 Private slot used to finish all applied patches.
166 </p><a NAME="QueuesProjectHelper.__hgQueueFoldUnappliedPatches" ID="QueuesProjectHelper.__hgQueueFoldUnappliedPatches"></a>
167 <h4>QueuesProjectHelper.__hgQueueFoldUnappliedPatches</h4>
168 <b>__hgQueueFoldUnappliedPatches</b>(<i></i>)
169 <p>
170 Private slot used to fold patches into the current patch.
171 </p><a NAME="QueuesProjectHelper.__hgQueueGotoPatch" ID="QueuesProjectHelper.__hgQueueGotoPatch"></a>
172 <h4>QueuesProjectHelper.__hgQueueGotoPatch</h4>
173 <b>__hgQueueGotoPatch</b>(<i></i>)
174 <p>
175 Private slot used to push or pop patches until the a named one
176 is at the top of the stack.
177 </p><a NAME="QueuesProjectHelper.__hgQueueGotoPatchForced" ID="QueuesProjectHelper.__hgQueueGotoPatchForced"></a>
178 <h4>QueuesProjectHelper.__hgQueueGotoPatchForced</h4>
179 <b>__hgQueueGotoPatchForced</b>(<i></i>)
180 <p>
181 Private slot used to push or pop patches until the a named one
182 is at the top of the stack overwriting local changes.
183 </p><a NAME="QueuesProjectHelper.__hgQueueListPatches" ID="QueuesProjectHelper.__hgQueueListPatches"></a>
184 <h4>QueuesProjectHelper.__hgQueueListPatches</h4>
185 <b>__hgQueueListPatches</b>(<i></i>)
186 <p>
187 Private slot used to show a list of applied and unapplied patches.
188 </p><a NAME="QueuesProjectHelper.__hgQueueNewPatch" ID="QueuesProjectHelper.__hgQueueNewPatch"></a>
189 <h4>QueuesProjectHelper.__hgQueueNewPatch</h4>
190 <b>__hgQueueNewPatch</b>(<i></i>)
191 <p>
192 Private slot used to create a new named patch.
193 </p><a NAME="QueuesProjectHelper.__hgQueuePopAllPatches" ID="QueuesProjectHelper.__hgQueuePopAllPatches"></a>
194 <h4>QueuesProjectHelper.__hgQueuePopAllPatches</h4>
195 <b>__hgQueuePopAllPatches</b>(<i></i>)
196 <p>
197 Private slot used to pop all patches off the stack.
198 </p><a NAME="QueuesProjectHelper.__hgQueuePopAllPatchesForced" ID="QueuesProjectHelper.__hgQueuePopAllPatchesForced"></a>
199 <h4>QueuesProjectHelper.__hgQueuePopAllPatchesForced</h4>
200 <b>__hgQueuePopAllPatchesForced</b>(<i></i>)
201 <p>
202 Private slot used to pop all patches off the stack forgetting
203 any local changes to patched files.
204 </p><a NAME="QueuesProjectHelper.__hgQueuePopPatch" ID="QueuesProjectHelper.__hgQueuePopPatch"></a>
205 <h4>QueuesProjectHelper.__hgQueuePopPatch</h4>
206 <b>__hgQueuePopPatch</b>(<i></i>)
207 <p>
208 Private slot used to pop the current patch off the stack.
209 </p><a NAME="QueuesProjectHelper.__hgQueuePopPatchForced" ID="QueuesProjectHelper.__hgQueuePopPatchForced"></a>
210 <h4>QueuesProjectHelper.__hgQueuePopPatchForced</h4>
211 <b>__hgQueuePopPatchForced</b>(<i></i>)
212 <p>
213 Private slot used to pop the current patch off the stack forgetting
214 any local changes to patched files.
215 </p><a NAME="QueuesProjectHelper.__hgQueuePopPatches" ID="QueuesProjectHelper.__hgQueuePopPatches"></a>
216 <h4>QueuesProjectHelper.__hgQueuePopPatches</h4>
217 <b>__hgQueuePopPatches</b>(<i></i>)
218 <p>
219 Private slot used to pop patches off the stack until a named
220 one is at the top.
221 </p><a NAME="QueuesProjectHelper.__hgQueuePopPatchesForced" ID="QueuesProjectHelper.__hgQueuePopPatchesForced"></a>
222 <h4>QueuesProjectHelper.__hgQueuePopPatchesForced</h4>
223 <b>__hgQueuePopPatchesForced</b>(<i></i>)
224 <p>
225 Private slot used to pop patches off the stack until a named
226 one is at the top forgetting any local changes to patched files.
227 </p><a NAME="QueuesProjectHelper.__hgQueuePushAllPatches" ID="QueuesProjectHelper.__hgQueuePushAllPatches"></a>
228 <h4>QueuesProjectHelper.__hgQueuePushAllPatches</h4>
229 <b>__hgQueuePushAllPatches</b>(<i></i>)
230 <p>
231 Private slot used to push all patches onto the stack.
232 </p><a NAME="QueuesProjectHelper.__hgQueuePushAllPatchesForced" ID="QueuesProjectHelper.__hgQueuePushAllPatchesForced"></a>
233 <h4>QueuesProjectHelper.__hgQueuePushAllPatchesForced</h4>
234 <b>__hgQueuePushAllPatchesForced</b>(<i></i>)
235 <p>
236 Private slot used to push all patches onto the stack on top
237 of local changes.
238 </p><a NAME="QueuesProjectHelper.__hgQueuePushPatch" ID="QueuesProjectHelper.__hgQueuePushPatch"></a>
239 <h4>QueuesProjectHelper.__hgQueuePushPatch</h4>
240 <b>__hgQueuePushPatch</b>(<i></i>)
241 <p>
242 Private slot used to push the next patch onto the stack.
243 </p><a NAME="QueuesProjectHelper.__hgQueuePushPatchForced" ID="QueuesProjectHelper.__hgQueuePushPatchForced"></a>
244 <h4>QueuesProjectHelper.__hgQueuePushPatchForced</h4>
245 <b>__hgQueuePushPatchForced</b>(<i></i>)
246 <p>
247 Private slot used to push the next patch onto the stack on top
248 of local changes.
249 </p><a NAME="QueuesProjectHelper.__hgQueuePushPatches" ID="QueuesProjectHelper.__hgQueuePushPatches"></a>
250 <h4>QueuesProjectHelper.__hgQueuePushPatches</h4>
251 <b>__hgQueuePushPatches</b>(<i></i>)
252 <p>
253 Private slot used to push patches onto the stack until a named
254 one is at the top.
255 </p><a NAME="QueuesProjectHelper.__hgQueuePushPatchesForced" ID="QueuesProjectHelper.__hgQueuePushPatchesForced"></a>
256 <h4>QueuesProjectHelper.__hgQueuePushPatchesForced</h4>
257 <b>__hgQueuePushPatchesForced</b>(<i></i>)
258 <p>
259 Private slot used to push patches onto the stack until a named
260 one is at the top on top of local changes.
261 </p><a NAME="QueuesProjectHelper.__hgQueueRefreshPatch" ID="QueuesProjectHelper.__hgQueueRefreshPatch"></a>
262 <h4>QueuesProjectHelper.__hgQueueRefreshPatch</h4>
263 <b>__hgQueueRefreshPatch</b>(<i></i>)
264 <p>
265 Private slot used to refresh the current patch.
266 </p><a NAME="QueuesProjectHelper.__hgQueueRefreshPatchMessage" ID="QueuesProjectHelper.__hgQueueRefreshPatchMessage"></a>
267 <h4>QueuesProjectHelper.__hgQueueRefreshPatchMessage</h4>
268 <b>__hgQueueRefreshPatchMessage</b>(<i></i>)
269 <p>
270 Private slot used to refresh the current patch and it's commit message.
271 </p><a NAME="QueuesProjectHelper.__hgQueueRenamePatch" ID="QueuesProjectHelper.__hgQueueRenamePatch"></a>
272 <h4>QueuesProjectHelper.__hgQueueRenamePatch</h4>
273 <b>__hgQueueRenamePatch</b>(<i></i>)
274 <p>
275 Private slot used to rename a patch.
276 </p><a NAME="QueuesProjectHelper.__hgQueueShowHeader" ID="QueuesProjectHelper.__hgQueueShowHeader"></a>
277 <h4>QueuesProjectHelper.__hgQueueShowHeader</h4>
278 <b>__hgQueueShowHeader</b>(<i></i>)
279 <p>
280 Private slot used to show the commit message of the current patch.
281 </p><a NAME="QueuesProjectHelper.__hgQueueShowPatch" ID="QueuesProjectHelper.__hgQueueShowPatch"></a>
282 <h4>QueuesProjectHelper.__hgQueueShowPatch</h4>
283 <b>__hgQueueShowPatch</b>(<i></i>)
284 <p>
285 Private slot used to show the contents of the current patch.
286 </p><a NAME="QueuesProjectHelper.__initPushPopActions" ID="QueuesProjectHelper.__initPushPopActions"></a>
287 <h4>QueuesProjectHelper.__initPushPopActions</h4>
288 <b>__initPushPopActions</b>(<i></i>)
289 <p>
290 Public method to generate the push and pop action objects.
291 </p><a NAME="QueuesProjectHelper.__initPushPopForceActions" ID="QueuesProjectHelper.__initPushPopForceActions"></a>
292 <h4>QueuesProjectHelper.__initPushPopForceActions</h4>
293 <b>__initPushPopForceActions</b>(<i></i>)
294 <p>
295 Public method to generate the push and pop (force) action objects.
296 </p><a NAME="QueuesProjectHelper.getActions" ID="QueuesProjectHelper.getActions"></a>
297 <h4>QueuesProjectHelper.getActions</h4>
298 <b>getActions</b>(<i></i>)
299 <p>
300 Public method to get a list of all actions.
301 </p><dl>
302 <dt>Returns:</dt>
303 <dd>
304 list of all actions (list of E5Action)
305 </dd>
306 </dl><a NAME="QueuesProjectHelper.initActions" ID="QueuesProjectHelper.initActions"></a>
307 <h4>QueuesProjectHelper.initActions</h4>
308 <b>initActions</b>(<i></i>)
309 <p>
310 Public method to generate the action objects.
311 </p><a NAME="QueuesProjectHelper.initMenu" ID="QueuesProjectHelper.initMenu"></a>
312 <h4>QueuesProjectHelper.initMenu</h4>
313 <b>initMenu</b>(<i>mainMenu</i>)
314 <p>
315 Public method to generate the VCS menu.
316 </p><dl>
317 <dt><i>mainMenu</i></dt>
318 <dd>
319 reference to the main menu (QMenu)
320 </dd>
321 </dl><dl>
322 <dt>Returns:</dt>
323 <dd>
324 populated menu (QMenu)
325 </dd>
326 </dl><a NAME="QueuesProjectHelper.setObjects" ID="QueuesProjectHelper.setObjects"></a>
327 <h4>QueuesProjectHelper.setObjects</h4>
328 <b>setObjects</b>(<i>vcsObject, projectObject</i>)
329 <p>
330 Public method to set references to the vcs and project objects.
331 </p><dl>
332 <dt><i>vcsObject</i></dt>
333 <dd>
334 reference to the vcs object
335 </dd><dt><i>projectObject</i></dt>
336 <dd>
337 reference to the project object
338 </dd>
339 </dl>
340 <div align="right"><a href="#top">Up</a></div>
341 <hr />
342 </body></html>

eric ide

mercurial