Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric4.VCS.ProjectHelper.html

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

Mercurial Repository: eric

eric ide

mercurial