Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.VCS.ProjectHelper.html

eric6/Documentation/Source/eric6.VCS.ProjectHelper.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.VCS.ProjectHelper</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.VCS.ProjectHelper</h1>
23 <p>
24 Module implementing the base class of the VCS project helper.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#VcsProjectHelper">VcsProjectHelper</a></td>
34 <td>Class implementing the base class of the VCS project helper.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="VcsProjectHelper" ID="VcsProjectHelper"></a>
43 <h2>VcsProjectHelper</h2>
44 <p>
45 Class implementing the base class of the VCS project helper.
46 </p>
47 <h3>Derived from</h3>
48 QObject
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#VcsProjectHelper.__init__">VcsProjectHelper</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#VcsProjectHelper._vcsCheckout">_vcsCheckout</a></td>
64 <td>Protected slot used to create a local project from the repository.</td>
65 </tr><tr>
66 <td><a href="#VcsProjectHelper._vcsCleanup">_vcsCleanup</a></td>
67 <td>Protected slot used to cleanup the local project.</td>
68 </tr><tr>
69 <td><a href="#VcsProjectHelper._vcsCommand">_vcsCommand</a></td>
70 <td>Protected slot used to execute an arbitrary vcs command.</td>
71 </tr><tr>
72 <td><a href="#VcsProjectHelper._vcsCommandOptions">_vcsCommandOptions</a></td>
73 <td>Protected slot to edit the VCS command options.</td>
74 </tr><tr>
75 <td><a href="#VcsProjectHelper._vcsCommit">_vcsCommit</a></td>
76 <td>Protected slot used to commit changes to the local project to the repository.</td>
77 </tr><tr>
78 <td><a href="#VcsProjectHelper._vcsDiff">_vcsDiff</a></td>
79 <td>Protected slot used to show the difference of the local project to the repository.</td>
80 </tr><tr>
81 <td><a href="#VcsProjectHelper._vcsExport">_vcsExport</a></td>
82 <td>Protected slot used to export a project from the repository.</td>
83 </tr><tr>
84 <td><a href="#VcsProjectHelper._vcsImport">_vcsImport</a></td>
85 <td>Protected slot used to import the local project into the repository.</td>
86 </tr><tr>
87 <td><a href="#VcsProjectHelper._vcsInfoDisplay">_vcsInfoDisplay</a></td>
88 <td>Protected slot called to show some vcs information.</td>
89 </tr><tr>
90 <td><a href="#VcsProjectHelper._vcsLog">_vcsLog</a></td>
91 <td>Protected slot used to show the log of the local project.</td>
92 </tr><tr>
93 <td><a href="#VcsProjectHelper._vcsLogBrowser">_vcsLogBrowser</a></td>
94 <td>Protected slot used to show the log of the local project with a log browser dialog.</td>
95 </tr><tr>
96 <td><a href="#VcsProjectHelper._vcsMerge">_vcsMerge</a></td>
97 <td>Protected slot used to merge changes of a tag/revision into the local project.</td>
98 </tr><tr>
99 <td><a href="#VcsProjectHelper._vcsRemove">_vcsRemove</a></td>
100 <td>Protected slot used to remove the local project from the repository.</td>
101 </tr><tr>
102 <td><a href="#VcsProjectHelper._vcsRevert">_vcsRevert</a></td>
103 <td>Protected slot used to revert changes made to the local project.</td>
104 </tr><tr>
105 <td><a href="#VcsProjectHelper._vcsStatus">_vcsStatus</a></td>
106 <td>Protected slot used to show the status of the local project.</td>
107 </tr><tr>
108 <td><a href="#VcsProjectHelper._vcsSwitch">_vcsSwitch</a></td>
109 <td>Protected slot used to switch the local project to another tag/branch.</td>
110 </tr><tr>
111 <td><a href="#VcsProjectHelper._vcsTag">_vcsTag</a></td>
112 <td>Protected slot used to tag the local project in the repository.</td>
113 </tr><tr>
114 <td><a href="#VcsProjectHelper._vcsUpdate">_vcsUpdate</a></td>
115 <td>Protected slot used to update the local project from the repository.</td>
116 </tr><tr>
117 <td><a href="#VcsProjectHelper.initActions">initActions</a></td>
118 <td>Public method to generate the action objects.</td>
119 </tr><tr>
120 <td><a href="#VcsProjectHelper.initBasicToolbar">initBasicToolbar</a></td>
121 <td>Public slot to initialize the basic VCS toolbar.</td>
122 </tr><tr>
123 <td><a href="#VcsProjectHelper.initMenu">initMenu</a></td>
124 <td>Public method to generate the VCS menu.</td>
125 </tr><tr>
126 <td><a href="#VcsProjectHelper.initToolbar">initToolbar</a></td>
127 <td>Public slot to initialize the VCS toolbar.</td>
128 </tr><tr>
129 <td><a href="#VcsProjectHelper.revertChanges">revertChanges</a></td>
130 <td>Local function to revert the changes made to the project object.</td>
131 </tr><tr>
132 <td><a href="#VcsProjectHelper.setObjects">setObjects</a></td>
133 <td>Public method to set references to the vcs and project objects.</td>
134 </tr><tr>
135 <td><a href="#VcsProjectHelper.showMenu">showMenu</a></td>
136 <td>Public slot called before the vcs menu is shown.</td>
137 </tr>
138 </table>
139 <h3>Static Methods</h3>
140 <table>
141 <tr><td>None</td></tr>
142 </table>
143 <a NAME="VcsProjectHelper.__init__" ID="VcsProjectHelper.__init__"></a>
144 <h4>VcsProjectHelper (Constructor)</h4>
145 <b>VcsProjectHelper</b>(<i>vcsObject, projectObject, parent=None, name=None</i>)
146 <p>
147 Constructor
148 </p><dl>
149 <dt><i>vcsObject</i></dt>
150 <dd>
151 reference to the vcs object
152 </dd><dt><i>projectObject</i></dt>
153 <dd>
154 reference to the project object
155 </dd><dt><i>parent</i></dt>
156 <dd>
157 parent widget (QWidget)
158 </dd><dt><i>name</i></dt>
159 <dd>
160 name of this object (string)
161 </dd>
162 </dl><a NAME="VcsProjectHelper._vcsCheckout" ID="VcsProjectHelper._vcsCheckout"></a>
163 <h4>VcsProjectHelper._vcsCheckout</h4>
164 <b>_vcsCheckout</b>(<i>export=False</i>)
165 <p>
166 Protected slot used to create a local project from the repository.
167 </p><dl>
168 <dt><i>export</i></dt>
169 <dd>
170 flag indicating whether an export or a checkout
171 should be performed
172 </dd>
173 </dl><a NAME="VcsProjectHelper._vcsCleanup" ID="VcsProjectHelper._vcsCleanup"></a>
174 <h4>VcsProjectHelper._vcsCleanup</h4>
175 <b>_vcsCleanup</b>(<i></i>)
176 <p>
177 Protected slot used to cleanup the local project.
178 </p><a NAME="VcsProjectHelper._vcsCommand" ID="VcsProjectHelper._vcsCommand"></a>
179 <h4>VcsProjectHelper._vcsCommand</h4>
180 <b>_vcsCommand</b>(<i></i>)
181 <p>
182 Protected slot used to execute an arbitrary vcs command.
183 </p><a NAME="VcsProjectHelper._vcsCommandOptions" ID="VcsProjectHelper._vcsCommandOptions"></a>
184 <h4>VcsProjectHelper._vcsCommandOptions</h4>
185 <b>_vcsCommandOptions</b>(<i></i>)
186 <p>
187 Protected slot to edit the VCS command options.
188 </p><a NAME="VcsProjectHelper._vcsCommit" ID="VcsProjectHelper._vcsCommit"></a>
189 <h4>VcsProjectHelper._vcsCommit</h4>
190 <b>_vcsCommit</b>(<i></i>)
191 <p>
192 Protected slot used to commit changes to the local project to the
193 repository.
194 </p><a NAME="VcsProjectHelper._vcsDiff" ID="VcsProjectHelper._vcsDiff"></a>
195 <h4>VcsProjectHelper._vcsDiff</h4>
196 <b>_vcsDiff</b>(<i></i>)
197 <p>
198 Protected slot used to show the difference of the local project to
199 the repository.
200 </p><a NAME="VcsProjectHelper._vcsExport" ID="VcsProjectHelper._vcsExport"></a>
201 <h4>VcsProjectHelper._vcsExport</h4>
202 <b>_vcsExport</b>(<i></i>)
203 <p>
204 Protected slot used to export a project from the repository.
205 </p><a NAME="VcsProjectHelper._vcsImport" ID="VcsProjectHelper._vcsImport"></a>
206 <h4>VcsProjectHelper._vcsImport</h4>
207 <b>_vcsImport</b>(<i></i>)
208 <p>
209 Protected slot used to import the local project into the repository.
210 </p><p>
211 <b>NOTE</b>:
212 This does not necessarily make the local project a vcs controlled
213 project. You may have to checkout the project from the repository
214 in order to accomplish that.
215 </p><a NAME="VcsProjectHelper._vcsInfoDisplay" ID="VcsProjectHelper._vcsInfoDisplay"></a>
216 <h4>VcsProjectHelper._vcsInfoDisplay</h4>
217 <b>_vcsInfoDisplay</b>(<i></i>)
218 <p>
219 Protected slot called to show some vcs information.
220 </p><a NAME="VcsProjectHelper._vcsLog" ID="VcsProjectHelper._vcsLog"></a>
221 <h4>VcsProjectHelper._vcsLog</h4>
222 <b>_vcsLog</b>(<i></i>)
223 <p>
224 Protected slot used to show the log of the local project.
225 </p><a NAME="VcsProjectHelper._vcsLogBrowser" ID="VcsProjectHelper._vcsLogBrowser"></a>
226 <h4>VcsProjectHelper._vcsLogBrowser</h4>
227 <b>_vcsLogBrowser</b>(<i></i>)
228 <p>
229 Protected slot used to show the log of the local project with a
230 log browser dialog.
231 </p><a NAME="VcsProjectHelper._vcsMerge" ID="VcsProjectHelper._vcsMerge"></a>
232 <h4>VcsProjectHelper._vcsMerge</h4>
233 <b>_vcsMerge</b>(<i></i>)
234 <p>
235 Protected slot used to merge changes of a tag/revision into the local
236 project.
237 </p><a NAME="VcsProjectHelper._vcsRemove" ID="VcsProjectHelper._vcsRemove"></a>
238 <h4>VcsProjectHelper._vcsRemove</h4>
239 <b>_vcsRemove</b>(<i></i>)
240 <p>
241 Protected slot used to remove the local project from the repository.
242 </p><p>
243 Depending on the parameters set in the vcs object the project
244 may be removed from the local disk as well.
245 </p><a NAME="VcsProjectHelper._vcsRevert" ID="VcsProjectHelper._vcsRevert"></a>
246 <h4>VcsProjectHelper._vcsRevert</h4>
247 <b>_vcsRevert</b>(<i></i>)
248 <p>
249 Protected slot used to revert changes made to the local project.
250 </p><a NAME="VcsProjectHelper._vcsStatus" ID="VcsProjectHelper._vcsStatus"></a>
251 <h4>VcsProjectHelper._vcsStatus</h4>
252 <b>_vcsStatus</b>(<i></i>)
253 <p>
254 Protected slot used to show the status of the local project.
255 </p><a NAME="VcsProjectHelper._vcsSwitch" ID="VcsProjectHelper._vcsSwitch"></a>
256 <h4>VcsProjectHelper._vcsSwitch</h4>
257 <b>_vcsSwitch</b>(<i></i>)
258 <p>
259 Protected slot used to switch the local project to another tag/branch.
260 </p><a NAME="VcsProjectHelper._vcsTag" ID="VcsProjectHelper._vcsTag"></a>
261 <h4>VcsProjectHelper._vcsTag</h4>
262 <b>_vcsTag</b>(<i></i>)
263 <p>
264 Protected slot used to tag the local project in the repository.
265 </p><a NAME="VcsProjectHelper._vcsUpdate" ID="VcsProjectHelper._vcsUpdate"></a>
266 <h4>VcsProjectHelper._vcsUpdate</h4>
267 <b>_vcsUpdate</b>(<i></i>)
268 <p>
269 Protected slot used to update the local project from the repository.
270 </p><a NAME="VcsProjectHelper.initActions" ID="VcsProjectHelper.initActions"></a>
271 <h4>VcsProjectHelper.initActions</h4>
272 <b>initActions</b>(<i></i>)
273 <p>
274 Public method to generate the action objects.
275 </p><a NAME="VcsProjectHelper.initBasicToolbar" ID="VcsProjectHelper.initBasicToolbar"></a>
276 <h4>VcsProjectHelper.initBasicToolbar</h4>
277 <b>initBasicToolbar</b>(<i>ui, toolbarManager</i>)
278 <p>
279 Public slot to initialize the basic VCS toolbar.
280 </p><dl>
281 <dt><i>ui</i></dt>
282 <dd>
283 reference to the main window (UserInterface)
284 </dd><dt><i>toolbarManager</i></dt>
285 <dd>
286 reference to a toolbar manager object
287 (E5ToolBarManager)
288 </dd>
289 </dl><dl>
290 <dt>Returns:</dt>
291 <dd>
292 the toolbar generated (QToolBar)
293 </dd>
294 </dl><a NAME="VcsProjectHelper.initMenu" ID="VcsProjectHelper.initMenu"></a>
295 <h4>VcsProjectHelper.initMenu</h4>
296 <b>initMenu</b>(<i>menu</i>)
297 <p>
298 Public method to generate the VCS menu.
299 </p><dl>
300 <dt><i>menu</i></dt>
301 <dd>
302 reference to the menu to be populated (QMenu)
303 </dd>
304 </dl><a NAME="VcsProjectHelper.initToolbar" ID="VcsProjectHelper.initToolbar"></a>
305 <h4>VcsProjectHelper.initToolbar</h4>
306 <b>initToolbar</b>(<i>ui, toolbarManager</i>)
307 <p>
308 Public slot to initialize the VCS toolbar.
309 </p><dl>
310 <dt><i>ui</i></dt>
311 <dd>
312 reference to the main window (UserInterface)
313 </dd><dt><i>toolbarManager</i></dt>
314 <dd>
315 reference to a toolbar manager object
316 (E5ToolBarManager)
317 </dd>
318 </dl><dl>
319 <dt>Returns:</dt>
320 <dd>
321 the toolbar generated (QToolBar)
322 </dd>
323 </dl><a NAME="VcsProjectHelper.revertChanges" ID="VcsProjectHelper.revertChanges"></a>
324 <h4>VcsProjectHelper.revertChanges</h4>
325 <b>revertChanges</b>(<i></i>)
326 <p>
327 Local function to revert the changes made to the project object.
328 </p><a NAME="VcsProjectHelper.setObjects" ID="VcsProjectHelper.setObjects"></a>
329 <h4>VcsProjectHelper.setObjects</h4>
330 <b>setObjects</b>(<i>vcsObject, projectObject</i>)
331 <p>
332 Public method to set references to the vcs and project objects.
333 </p><dl>
334 <dt><i>vcsObject</i></dt>
335 <dd>
336 reference to the vcs object
337 </dd><dt><i>projectObject</i></dt>
338 <dd>
339 reference to the project object
340 </dd>
341 </dl><a NAME="VcsProjectHelper.showMenu" ID="VcsProjectHelper.showMenu"></a>
342 <h4>VcsProjectHelper.showMenu</h4>
343 <b>showMenu</b>(<i></i>)
344 <p>
345 Public slot called before the vcs menu is shown.
346 </p>
347 <div align="right"><a href="#top">Up</a></div>
348 <hr />
349 </body></html>

Mercurial Repository: eric

eric ide

mercurial