Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.VCS.ProjectHelper.html

changeset 3673
e26d7d0c1088
child 4081
9bf3aa6c65e0
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
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.initMenu">initMenu</a></td>
121 <td>Public method to generate the VCS menu.</td>
122 </tr><tr>
123 <td><a href="#VcsProjectHelper.revertChanges">revertChanges</a></td>
124 <td>Local function to revert the changes made to the project object.</td>
125 </tr><tr>
126 <td><a href="#VcsProjectHelper.setObjects">setObjects</a></td>
127 <td>Public method to set references to the vcs and project objects.</td>
128 </tr><tr>
129 <td><a href="#VcsProjectHelper.showMenu">showMenu</a></td>
130 <td>Public slot called before the vcs menu is shown.</td>
131 </tr>
132 </table>
133 <h3>Static Methods</h3>
134 <table>
135 <tr><td>None</td></tr>
136 </table>
137 <a NAME="VcsProjectHelper.__init__" ID="VcsProjectHelper.__init__"></a>
138 <h4>VcsProjectHelper (Constructor)</h4>
139 <b>VcsProjectHelper</b>(<i>vcsObject, projectObject, parent=None, name=None</i>)
140 <p>
141 Constructor
142 </p><dl>
143 <dt><i>vcsObject</i></dt>
144 <dd>
145 reference to the vcs object
146 </dd><dt><i>projectObject</i></dt>
147 <dd>
148 reference to the project object
149 </dd><dt><i>parent</i></dt>
150 <dd>
151 parent widget (QWidget)
152 </dd><dt><i>name</i></dt>
153 <dd>
154 name of this object (string)
155 </dd>
156 </dl><a NAME="VcsProjectHelper._vcsCheckout" ID="VcsProjectHelper._vcsCheckout"></a>
157 <h4>VcsProjectHelper._vcsCheckout</h4>
158 <b>_vcsCheckout</b>(<i>export=False</i>)
159 <p>
160 Protected slot used to create a local project from the repository.
161 </p><dl>
162 <dt><i>export</i></dt>
163 <dd>
164 flag indicating whether an export or a checkout
165 should be performed
166 </dd>
167 </dl><a NAME="VcsProjectHelper._vcsCleanup" ID="VcsProjectHelper._vcsCleanup"></a>
168 <h4>VcsProjectHelper._vcsCleanup</h4>
169 <b>_vcsCleanup</b>(<i></i>)
170 <p>
171 Protected slot used to cleanup the local project.
172 </p><a NAME="VcsProjectHelper._vcsCommand" ID="VcsProjectHelper._vcsCommand"></a>
173 <h4>VcsProjectHelper._vcsCommand</h4>
174 <b>_vcsCommand</b>(<i></i>)
175 <p>
176 Protected slot used to execute an arbitrary vcs command.
177 </p><a NAME="VcsProjectHelper._vcsCommandOptions" ID="VcsProjectHelper._vcsCommandOptions"></a>
178 <h4>VcsProjectHelper._vcsCommandOptions</h4>
179 <b>_vcsCommandOptions</b>(<i></i>)
180 <p>
181 Protected slot to edit the VCS command options.
182 </p><a NAME="VcsProjectHelper._vcsCommit" ID="VcsProjectHelper._vcsCommit"></a>
183 <h4>VcsProjectHelper._vcsCommit</h4>
184 <b>_vcsCommit</b>(<i></i>)
185 <p>
186 Protected slot used to commit changes to the local project to the
187 repository.
188 </p><a NAME="VcsProjectHelper._vcsDiff" ID="VcsProjectHelper._vcsDiff"></a>
189 <h4>VcsProjectHelper._vcsDiff</h4>
190 <b>_vcsDiff</b>(<i></i>)
191 <p>
192 Protected slot used to show the difference of the local project to
193 the repository.
194 </p><a NAME="VcsProjectHelper._vcsExport" ID="VcsProjectHelper._vcsExport"></a>
195 <h4>VcsProjectHelper._vcsExport</h4>
196 <b>_vcsExport</b>(<i></i>)
197 <p>
198 Protected slot used to export a project from the repository.
199 </p><a NAME="VcsProjectHelper._vcsImport" ID="VcsProjectHelper._vcsImport"></a>
200 <h4>VcsProjectHelper._vcsImport</h4>
201 <b>_vcsImport</b>(<i></i>)
202 <p>
203 Protected slot used to import the local project into the repository.
204 </p><p>
205 <b>NOTE</b>:
206 This does not necessarily make the local project a vcs controlled
207 project. You may have to checkout the project from the repository
208 in order to accomplish that.
209 </p><a NAME="VcsProjectHelper._vcsInfoDisplay" ID="VcsProjectHelper._vcsInfoDisplay"></a>
210 <h4>VcsProjectHelper._vcsInfoDisplay</h4>
211 <b>_vcsInfoDisplay</b>(<i></i>)
212 <p>
213 Protected slot called to show some vcs information.
214 </p><a NAME="VcsProjectHelper._vcsLog" ID="VcsProjectHelper._vcsLog"></a>
215 <h4>VcsProjectHelper._vcsLog</h4>
216 <b>_vcsLog</b>(<i></i>)
217 <p>
218 Protected slot used to show the log of the local project.
219 </p><a NAME="VcsProjectHelper._vcsLogBrowser" ID="VcsProjectHelper._vcsLogBrowser"></a>
220 <h4>VcsProjectHelper._vcsLogBrowser</h4>
221 <b>_vcsLogBrowser</b>(<i></i>)
222 <p>
223 Protected slot used to show the log of the local project with a
224 log browser dialog.
225 </p><a NAME="VcsProjectHelper._vcsMerge" ID="VcsProjectHelper._vcsMerge"></a>
226 <h4>VcsProjectHelper._vcsMerge</h4>
227 <b>_vcsMerge</b>(<i></i>)
228 <p>
229 Protected slot used to merge changes of a tag/revision into the local
230 project.
231 </p><a NAME="VcsProjectHelper._vcsRemove" ID="VcsProjectHelper._vcsRemove"></a>
232 <h4>VcsProjectHelper._vcsRemove</h4>
233 <b>_vcsRemove</b>(<i></i>)
234 <p>
235 Protected slot used to remove the local project from the repository.
236 </p><p>
237 Depending on the parameters set in the vcs object the project
238 may be removed from the local disk as well.
239 </p><a NAME="VcsProjectHelper._vcsRevert" ID="VcsProjectHelper._vcsRevert"></a>
240 <h4>VcsProjectHelper._vcsRevert</h4>
241 <b>_vcsRevert</b>(<i></i>)
242 <p>
243 Protected slot used to revert changes made to the local project.
244 </p><a NAME="VcsProjectHelper._vcsStatus" ID="VcsProjectHelper._vcsStatus"></a>
245 <h4>VcsProjectHelper._vcsStatus</h4>
246 <b>_vcsStatus</b>(<i></i>)
247 <p>
248 Protected slot used to show the status of the local project.
249 </p><a NAME="VcsProjectHelper._vcsSwitch" ID="VcsProjectHelper._vcsSwitch"></a>
250 <h4>VcsProjectHelper._vcsSwitch</h4>
251 <b>_vcsSwitch</b>(<i></i>)
252 <p>
253 Protected slot used to switch the local project to another tag/branch.
254 </p><a NAME="VcsProjectHelper._vcsTag" ID="VcsProjectHelper._vcsTag"></a>
255 <h4>VcsProjectHelper._vcsTag</h4>
256 <b>_vcsTag</b>(<i></i>)
257 <p>
258 Protected slot used to tag the local project in the repository.
259 </p><a NAME="VcsProjectHelper._vcsUpdate" ID="VcsProjectHelper._vcsUpdate"></a>
260 <h4>VcsProjectHelper._vcsUpdate</h4>
261 <b>_vcsUpdate</b>(<i></i>)
262 <p>
263 Protected slot used to update the local project from the repository.
264 </p><a NAME="VcsProjectHelper.initActions" ID="VcsProjectHelper.initActions"></a>
265 <h4>VcsProjectHelper.initActions</h4>
266 <b>initActions</b>(<i></i>)
267 <p>
268 Public method to generate the action objects.
269 </p><a NAME="VcsProjectHelper.initMenu" ID="VcsProjectHelper.initMenu"></a>
270 <h4>VcsProjectHelper.initMenu</h4>
271 <b>initMenu</b>(<i>menu</i>)
272 <p>
273 Public method to generate the VCS menu.
274 </p><dl>
275 <dt><i>menu</i></dt>
276 <dd>
277 reference to the menu to be populated (QMenu)
278 </dd>
279 </dl><a NAME="VcsProjectHelper.revertChanges" ID="VcsProjectHelper.revertChanges"></a>
280 <h4>VcsProjectHelper.revertChanges</h4>
281 <b>revertChanges</b>(<i></i>)
282 <p>
283 Local function to revert the changes made to the project object.
284 </p><a NAME="VcsProjectHelper.setObjects" ID="VcsProjectHelper.setObjects"></a>
285 <h4>VcsProjectHelper.setObjects</h4>
286 <b>setObjects</b>(<i>vcsObject, projectObject</i>)
287 <p>
288 Public method to set references to the vcs and project objects.
289 </p><dl>
290 <dt><i>vcsObject</i></dt>
291 <dd>
292 reference to the vcs object
293 </dd><dt><i>projectObject</i></dt>
294 <dd>
295 reference to the project object
296 </dd>
297 </dl><a NAME="VcsProjectHelper.showMenu" ID="VcsProjectHelper.showMenu"></a>
298 <h4>VcsProjectHelper.showMenu</h4>
299 <b>showMenu</b>(<i></i>)
300 <p>
301 Public slot called before the vcs menu is shown.
302 </p>
303 <div align="right"><a href="#top">Up</a></div>
304 <hr />
305 </body></html>

Mercurial Repository: eric

eric ide

mercurial