|
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.VCS.ProjectHelper</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.VCS.ProjectHelper</h1> |
|
12 <p> |
|
13 Module implementing the base class of the VCS project helper. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#VcsProjectHelper">VcsProjectHelper</a></td> |
|
23 <td>Class implementing the base class of the VCS project helper.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="VcsProjectHelper" ID="VcsProjectHelper"></a> |
|
32 <h2>VcsProjectHelper</h2> |
|
33 <p> |
|
34 Class implementing the base class of the VCS project helper. |
|
35 </p> |
|
36 <h3>Derived from</h3> |
|
37 QObject |
|
38 <h3>Class Attributes</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <h3>Methods</h3> |
|
43 <table> |
|
44 <tr> |
|
45 <td><a href="#VcsProjectHelper.__init__">VcsProjectHelper</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#VcsProjectHelper._vcsCheckout">_vcsCheckout</a></td> |
|
49 <td>Protected slot used to create a local project from the repository.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#VcsProjectHelper._vcsCleanup">_vcsCleanup</a></td> |
|
52 <td>Protected slot used to cleanup the local project.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#VcsProjectHelper._vcsCommand">_vcsCommand</a></td> |
|
55 <td>Protected slot used to execute an arbitrary vcs command.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#VcsProjectHelper._vcsCommandOptions">_vcsCommandOptions</a></td> |
|
58 <td>Protected slot to edit the VCS command options.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#VcsProjectHelper._vcsCommit">_vcsCommit</a></td> |
|
61 <td>Protected slot used to commit changes to the local project to the repository.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#VcsProjectHelper._vcsDiff">_vcsDiff</a></td> |
|
64 <td>Protected slot used to show the difference of the local project to the repository.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#VcsProjectHelper._vcsExport">_vcsExport</a></td> |
|
67 <td>Protected slot used to export a project from the repository.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#VcsProjectHelper._vcsImport">_vcsImport</a></td> |
|
70 <td>Protected slot used to import the local project into the repository.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#VcsProjectHelper._vcsInfoDisplay">_vcsInfoDisplay</a></td> |
|
73 <td>Protected slot called to show some vcs information.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#VcsProjectHelper._vcsLog">_vcsLog</a></td> |
|
76 <td>Protected slot used to show the log of the local project.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#VcsProjectHelper._vcsMerge">_vcsMerge</a></td> |
|
79 <td>Protected slot used to merge changes of a tag/revision into the local project.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#VcsProjectHelper._vcsRemove">_vcsRemove</a></td> |
|
82 <td>Protected slot used to remove the local project from the repository.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#VcsProjectHelper._vcsRevert">_vcsRevert</a></td> |
|
85 <td>Protected slot used to revert changes made to the local project.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#VcsProjectHelper._vcsStatus">_vcsStatus</a></td> |
|
88 <td>Protected slot used to show the status of the local project.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#VcsProjectHelper._vcsSwitch">_vcsSwitch</a></td> |
|
91 <td>Protected slot used to switch the local project to another tag/branch.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#VcsProjectHelper._vcsTag">_vcsTag</a></td> |
|
94 <td>Protected slot used to tag the local project in the repository.</td> |
|
95 </tr><tr> |
|
96 <td><a href="#VcsProjectHelper._vcsUpdate">_vcsUpdate</a></td> |
|
97 <td>Protected slot used to update the local project from the repository.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#VcsProjectHelper.initActions">initActions</a></td> |
|
100 <td>Public method to generate the action objects.</td> |
|
101 </tr><tr> |
|
102 <td><a href="#VcsProjectHelper.initMenu">initMenu</a></td> |
|
103 <td>Public method to generate the VCS menu.</td> |
|
104 </tr><tr> |
|
105 <td><a href="#VcsProjectHelper.revertChanges">revertChanges</a></td> |
|
106 <td>Local function to revert the changes made to the project object.</td> |
|
107 </tr><tr> |
|
108 <td><a href="#VcsProjectHelper.setObjects">setObjects</a></td> |
|
109 <td>Public method to set references to the vcs and project objects.</td> |
|
110 </tr><tr> |
|
111 <td><a href="#VcsProjectHelper.showMenu">showMenu</a></td> |
|
112 <td>Public slot called before the vcs menu is shown.</td> |
|
113 </tr> |
|
114 </table> |
|
115 <a NAME="VcsProjectHelper.__init__" ID="VcsProjectHelper.__init__"></a> |
|
116 <h4>VcsProjectHelper (Constructor)</h4> |
|
117 <b>VcsProjectHelper</b>(<i>vcsObject, projectObject, parent = None, name = None</i>) |
|
118 <p> |
|
119 Constructor |
|
120 </p><dl> |
|
121 <dt><i>vcsObject</i></dt> |
|
122 <dd> |
|
123 reference to the vcs object |
|
124 </dd><dt><i>projectObject</i></dt> |
|
125 <dd> |
|
126 reference to the project object |
|
127 </dd><dt><i>parent</i></dt> |
|
128 <dd> |
|
129 parent widget (QWidget) |
|
130 </dd><dt><i>name</i></dt> |
|
131 <dd> |
|
132 name of this object (string) |
|
133 </dd> |
|
134 </dl><a NAME="VcsProjectHelper._vcsCheckout" ID="VcsProjectHelper._vcsCheckout"></a> |
|
135 <h4>VcsProjectHelper._vcsCheckout</h4> |
|
136 <b>_vcsCheckout</b>(<i>export = False</i>) |
|
137 <p> |
|
138 Protected slot used to create a local project from the repository. |
|
139 </p><dl> |
|
140 <dt><i>export</i></dt> |
|
141 <dd> |
|
142 flag indicating whether an export or a checkout |
|
143 should be performed |
|
144 </dd> |
|
145 </dl><a NAME="VcsProjectHelper._vcsCleanup" ID="VcsProjectHelper._vcsCleanup"></a> |
|
146 <h4>VcsProjectHelper._vcsCleanup</h4> |
|
147 <b>_vcsCleanup</b>(<i></i>) |
|
148 <p> |
|
149 Protected slot used to cleanup the local project. |
|
150 </p><a NAME="VcsProjectHelper._vcsCommand" ID="VcsProjectHelper._vcsCommand"></a> |
|
151 <h4>VcsProjectHelper._vcsCommand</h4> |
|
152 <b>_vcsCommand</b>(<i></i>) |
|
153 <p> |
|
154 Protected slot used to execute an arbitrary vcs command. |
|
155 </p><a NAME="VcsProjectHelper._vcsCommandOptions" ID="VcsProjectHelper._vcsCommandOptions"></a> |
|
156 <h4>VcsProjectHelper._vcsCommandOptions</h4> |
|
157 <b>_vcsCommandOptions</b>(<i></i>) |
|
158 <p> |
|
159 Protected slot to edit the VCS command options. |
|
160 </p><a NAME="VcsProjectHelper._vcsCommit" ID="VcsProjectHelper._vcsCommit"></a> |
|
161 <h4>VcsProjectHelper._vcsCommit</h4> |
|
162 <b>_vcsCommit</b>(<i></i>) |
|
163 <p> |
|
164 Protected slot used to commit changes to the local project to the repository. |
|
165 </p><a NAME="VcsProjectHelper._vcsDiff" ID="VcsProjectHelper._vcsDiff"></a> |
|
166 <h4>VcsProjectHelper._vcsDiff</h4> |
|
167 <b>_vcsDiff</b>(<i></i>) |
|
168 <p> |
|
169 Protected slot used to show the difference of the local project to the repository. |
|
170 </p><a NAME="VcsProjectHelper._vcsExport" ID="VcsProjectHelper._vcsExport"></a> |
|
171 <h4>VcsProjectHelper._vcsExport</h4> |
|
172 <b>_vcsExport</b>(<i></i>) |
|
173 <p> |
|
174 Protected slot used to export a project from the repository. |
|
175 </p><a NAME="VcsProjectHelper._vcsImport" ID="VcsProjectHelper._vcsImport"></a> |
|
176 <h4>VcsProjectHelper._vcsImport</h4> |
|
177 <b>_vcsImport</b>(<i></i>) |
|
178 <p> |
|
179 Protected slot used to import the local project into the repository. |
|
180 </p><p> |
|
181 <b>NOTE</b>: |
|
182 This does not necessarily make the local project a vcs controlled |
|
183 project. You may have to checkout the project from the repository in |
|
184 order to accomplish that. |
|
185 </p><a NAME="VcsProjectHelper._vcsInfoDisplay" ID="VcsProjectHelper._vcsInfoDisplay"></a> |
|
186 <h4>VcsProjectHelper._vcsInfoDisplay</h4> |
|
187 <b>_vcsInfoDisplay</b>(<i></i>) |
|
188 <p> |
|
189 Protected slot called to show some vcs information. |
|
190 </p><a NAME="VcsProjectHelper._vcsLog" ID="VcsProjectHelper._vcsLog"></a> |
|
191 <h4>VcsProjectHelper._vcsLog</h4> |
|
192 <b>_vcsLog</b>(<i></i>) |
|
193 <p> |
|
194 Protected slot used to show the log of the local project. |
|
195 </p><a NAME="VcsProjectHelper._vcsMerge" ID="VcsProjectHelper._vcsMerge"></a> |
|
196 <h4>VcsProjectHelper._vcsMerge</h4> |
|
197 <b>_vcsMerge</b>(<i></i>) |
|
198 <p> |
|
199 Protected slot used to merge changes of a tag/revision into the local project. |
|
200 </p><a NAME="VcsProjectHelper._vcsRemove" ID="VcsProjectHelper._vcsRemove"></a> |
|
201 <h4>VcsProjectHelper._vcsRemove</h4> |
|
202 <b>_vcsRemove</b>(<i></i>) |
|
203 <p> |
|
204 Protected slot used to remove the local project from the repository. |
|
205 </p><p> |
|
206 Depending on the parameters set in the vcs object the project |
|
207 may be removed from the local disk as well. |
|
208 </p><a NAME="VcsProjectHelper._vcsRevert" ID="VcsProjectHelper._vcsRevert"></a> |
|
209 <h4>VcsProjectHelper._vcsRevert</h4> |
|
210 <b>_vcsRevert</b>(<i></i>) |
|
211 <p> |
|
212 Protected slot used to revert changes made to the local project. |
|
213 </p><a NAME="VcsProjectHelper._vcsStatus" ID="VcsProjectHelper._vcsStatus"></a> |
|
214 <h4>VcsProjectHelper._vcsStatus</h4> |
|
215 <b>_vcsStatus</b>(<i></i>) |
|
216 <p> |
|
217 Protected slot used to show the status of the local project. |
|
218 </p><a NAME="VcsProjectHelper._vcsSwitch" ID="VcsProjectHelper._vcsSwitch"></a> |
|
219 <h4>VcsProjectHelper._vcsSwitch</h4> |
|
220 <b>_vcsSwitch</b>(<i></i>) |
|
221 <p> |
|
222 Protected slot used to switch the local project to another tag/branch. |
|
223 </p><a NAME="VcsProjectHelper._vcsTag" ID="VcsProjectHelper._vcsTag"></a> |
|
224 <h4>VcsProjectHelper._vcsTag</h4> |
|
225 <b>_vcsTag</b>(<i></i>) |
|
226 <p> |
|
227 Protected slot used to tag the local project in the repository. |
|
228 </p><a NAME="VcsProjectHelper._vcsUpdate" ID="VcsProjectHelper._vcsUpdate"></a> |
|
229 <h4>VcsProjectHelper._vcsUpdate</h4> |
|
230 <b>_vcsUpdate</b>(<i></i>) |
|
231 <p> |
|
232 Protected slot used to update the local project from the repository. |
|
233 </p><a NAME="VcsProjectHelper.initActions" ID="VcsProjectHelper.initActions"></a> |
|
234 <h4>VcsProjectHelper.initActions</h4> |
|
235 <b>initActions</b>(<i></i>) |
|
236 <p> |
|
237 Public method to generate the action objects. |
|
238 </p><a NAME="VcsProjectHelper.initMenu" ID="VcsProjectHelper.initMenu"></a> |
|
239 <h4>VcsProjectHelper.initMenu</h4> |
|
240 <b>initMenu</b>(<i>menu</i>) |
|
241 <p> |
|
242 Public method to generate the VCS menu. |
|
243 </p><dl> |
|
244 <dt><i>menu</i></dt> |
|
245 <dd> |
|
246 reference to the menu to be populated (QMenu) |
|
247 </dd> |
|
248 </dl><a NAME="VcsProjectHelper.revertChanges" ID="VcsProjectHelper.revertChanges"></a> |
|
249 <h4>VcsProjectHelper.revertChanges</h4> |
|
250 <b>revertChanges</b>(<i></i>) |
|
251 <p> |
|
252 Local function to revert the changes made to the project object. |
|
253 </p><a NAME="VcsProjectHelper.setObjects" ID="VcsProjectHelper.setObjects"></a> |
|
254 <h4>VcsProjectHelper.setObjects</h4> |
|
255 <b>setObjects</b>(<i>vcsObject, projectObject</i>) |
|
256 <p> |
|
257 Public method to set references to the vcs and project objects. |
|
258 </p><dl> |
|
259 <dt><i>vcsObject</i></dt> |
|
260 <dd> |
|
261 reference to the vcs object |
|
262 </dd><dt><i>projectObject</i></dt> |
|
263 <dd> |
|
264 reference to the project object |
|
265 </dd> |
|
266 </dl><a NAME="VcsProjectHelper.showMenu" ID="VcsProjectHelper.showMenu"></a> |
|
267 <h4>VcsProjectHelper.showMenu</h4> |
|
268 <b>showMenu</b>(<i></i>) |
|
269 <p> |
|
270 Public slot called before the vcs menu is shown. |
|
271 </p> |
|
272 <div align="right"><a href="#top">Up</a></div> |
|
273 <hr /> |
|
274 </body></html> |