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

branch
maintenance
changeset 7286
7eb04391adf7
parent 7273
391d6b7b1eff
child 7989
a21d673a8f99
equal deleted inserted replaced
7226:babe80d84a3e 7286:7eb04391adf7
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.VCS.ProjectHelper</h1> 23 <h1>eric6.VCS.ProjectHelper</h1>
24
23 <p> 25 <p>
24 Module implementing the base class of the VCS project helper. 26 Module implementing the base class of the VCS project helper.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#VcsProjectHelper">VcsProjectHelper</a></td> 38 <td><a href="#VcsProjectHelper">VcsProjectHelper</a></td>
34 <td>Class implementing the base class of the VCS project helper.</td> 39 <td>Class implementing the base class of the VCS project helper.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="VcsProjectHelper" ID="VcsProjectHelper"></a> 49 <a NAME="VcsProjectHelper" ID="VcsProjectHelper"></a>
43 <h2>VcsProjectHelper</h2> 50 <h2>VcsProjectHelper</h2>
51
44 <p> 52 <p>
45 Class implementing the base class of the VCS project helper. 53 Class implementing the base class of the VCS project helper.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QObject 56 QObject
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#VcsProjectHelper.__init__">VcsProjectHelper</a></td> 72 <td><a href="#VcsProjectHelper.__init__">VcsProjectHelper</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#VcsProjectHelper._vcsCheckout">_vcsCheckout</a></td> 76 <td><a href="#VcsProjectHelper._vcsCheckout">_vcsCheckout</a></td>
64 <td>Protected slot used to create a local project from the repository.</td> 77 <td>Protected slot used to create a local project from the repository.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#VcsProjectHelper._vcsCleanup">_vcsCleanup</a></td> 80 <td><a href="#VcsProjectHelper._vcsCleanup">_vcsCleanup</a></td>
67 <td>Protected slot used to cleanup the local project.</td> 81 <td>Protected slot used to cleanup the local project.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#VcsProjectHelper._vcsCommand">_vcsCommand</a></td> 84 <td><a href="#VcsProjectHelper._vcsCommand">_vcsCommand</a></td>
70 <td>Protected slot used to execute an arbitrary vcs command.</td> 85 <td>Protected slot used to execute an arbitrary vcs command.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#VcsProjectHelper._vcsCommandOptions">_vcsCommandOptions</a></td> 88 <td><a href="#VcsProjectHelper._vcsCommandOptions">_vcsCommandOptions</a></td>
73 <td>Protected slot to edit the VCS command options.</td> 89 <td>Protected slot to edit the VCS command options.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#VcsProjectHelper._vcsCommit">_vcsCommit</a></td> 92 <td><a href="#VcsProjectHelper._vcsCommit">_vcsCommit</a></td>
76 <td>Protected slot used to commit changes to the local project to the repository.</td> 93 <td>Protected slot used to commit changes to the local project to the repository.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#VcsProjectHelper._vcsDiff">_vcsDiff</a></td> 96 <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> 97 <td>Protected slot used to show the difference of the local project to the repository.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#VcsProjectHelper._vcsExport">_vcsExport</a></td> 100 <td><a href="#VcsProjectHelper._vcsExport">_vcsExport</a></td>
82 <td>Protected slot used to export a project from the repository.</td> 101 <td>Protected slot used to export a project from the repository.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#VcsProjectHelper._vcsImport">_vcsImport</a></td> 104 <td><a href="#VcsProjectHelper._vcsImport">_vcsImport</a></td>
85 <td>Protected slot used to import the local project into the repository.</td> 105 <td>Protected slot used to import the local project into the repository.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#VcsProjectHelper._vcsInfoDisplay">_vcsInfoDisplay</a></td> 108 <td><a href="#VcsProjectHelper._vcsInfoDisplay">_vcsInfoDisplay</a></td>
88 <td>Protected slot called to show some vcs information.</td> 109 <td>Protected slot called to show some vcs information.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#VcsProjectHelper._vcsLog">_vcsLog</a></td> 112 <td><a href="#VcsProjectHelper._vcsLog">_vcsLog</a></td>
91 <td>Protected slot used to show the log of the local project.</td> 113 <td>Protected slot used to show the log of the local project.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#VcsProjectHelper._vcsLogBrowser">_vcsLogBrowser</a></td> 116 <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> 117 <td>Protected slot used to show the log of the local project with a log browser dialog.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#VcsProjectHelper._vcsMerge">_vcsMerge</a></td> 120 <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> 121 <td>Protected slot used to merge changes of a tag/revision into the local project.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#VcsProjectHelper._vcsRemove">_vcsRemove</a></td> 124 <td><a href="#VcsProjectHelper._vcsRemove">_vcsRemove</a></td>
100 <td>Protected slot used to remove the local project from the repository.</td> 125 <td>Protected slot used to remove the local project from the repository.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#VcsProjectHelper._vcsRevert">_vcsRevert</a></td> 128 <td><a href="#VcsProjectHelper._vcsRevert">_vcsRevert</a></td>
103 <td>Protected slot used to revert changes made to the local project.</td> 129 <td>Protected slot used to revert changes made to the local project.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#VcsProjectHelper._vcsStatus">_vcsStatus</a></td> 132 <td><a href="#VcsProjectHelper._vcsStatus">_vcsStatus</a></td>
106 <td>Protected slot used to show the status of the local project.</td> 133 <td>Protected slot used to show the status of the local project.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#VcsProjectHelper._vcsSwitch">_vcsSwitch</a></td> 136 <td><a href="#VcsProjectHelper._vcsSwitch">_vcsSwitch</a></td>
109 <td>Protected slot used to switch the local project to another tag/branch.</td> 137 <td>Protected slot used to switch the local project to another tag/branch.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#VcsProjectHelper._vcsTag">_vcsTag</a></td> 140 <td><a href="#VcsProjectHelper._vcsTag">_vcsTag</a></td>
112 <td>Protected slot used to tag the local project in the repository.</td> 141 <td>Protected slot used to tag the local project in the repository.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#VcsProjectHelper._vcsUpdate">_vcsUpdate</a></td> 144 <td><a href="#VcsProjectHelper._vcsUpdate">_vcsUpdate</a></td>
115 <td>Protected slot used to update the local project from the repository.</td> 145 <td>Protected slot used to update the local project from the repository.</td>
116 </tr><tr> 146 </tr>
147 <tr>
117 <td><a href="#VcsProjectHelper.initActions">initActions</a></td> 148 <td><a href="#VcsProjectHelper.initActions">initActions</a></td>
118 <td>Public method to generate the action objects.</td> 149 <td>Public method to generate the action objects.</td>
119 </tr><tr> 150 </tr>
151 <tr>
120 <td><a href="#VcsProjectHelper.initBasicToolbar">initBasicToolbar</a></td> 152 <td><a href="#VcsProjectHelper.initBasicToolbar">initBasicToolbar</a></td>
121 <td>Public slot to initialize the basic VCS toolbar.</td> 153 <td>Public slot to initialize the basic VCS toolbar.</td>
122 </tr><tr> 154 </tr>
155 <tr>
123 <td><a href="#VcsProjectHelper.initMenu">initMenu</a></td> 156 <td><a href="#VcsProjectHelper.initMenu">initMenu</a></td>
124 <td>Public method to generate the VCS menu.</td> 157 <td>Public method to generate the VCS menu.</td>
125 </tr><tr> 158 </tr>
159 <tr>
126 <td><a href="#VcsProjectHelper.initToolbar">initToolbar</a></td> 160 <td><a href="#VcsProjectHelper.initToolbar">initToolbar</a></td>
127 <td>Public slot to initialize the VCS toolbar.</td> 161 <td>Public slot to initialize the VCS toolbar.</td>
128 </tr><tr> 162 </tr>
163 <tr>
129 <td><a href="#VcsProjectHelper.revertChanges">revertChanges</a></td> 164 <td><a href="#VcsProjectHelper.revertChanges">revertChanges</a></td>
130 <td>Local function to revert the changes made to the project object.</td> 165 <td>Local function to revert the changes made to the project object.</td>
131 </tr><tr> 166 </tr>
167 <tr>
132 <td><a href="#VcsProjectHelper.setObjects">setObjects</a></td> 168 <td><a href="#VcsProjectHelper.setObjects">setObjects</a></td>
133 <td>Public method to set references to the vcs and project objects.</td> 169 <td>Public method to set references to the vcs and project objects.</td>
134 </tr><tr> 170 </tr>
171 <tr>
135 <td><a href="#VcsProjectHelper.showMenu">showMenu</a></td> 172 <td><a href="#VcsProjectHelper.showMenu">showMenu</a></td>
136 <td>Public slot called before the vcs menu is shown.</td> 173 <td>Public slot called before the vcs menu is shown.</td>
137 </tr> 174 </tr>
138 </table> 175 </table>
139 <h3>Static Methods</h3> 176 <h3>Static Methods</h3>
177
140 <table> 178 <table>
141 <tr><td>None</td></tr> 179 <tr><td>None</td></tr>
142 </table> 180 </table>
181
143 <a NAME="VcsProjectHelper.__init__" ID="VcsProjectHelper.__init__"></a> 182 <a NAME="VcsProjectHelper.__init__" ID="VcsProjectHelper.__init__"></a>
144 <h4>VcsProjectHelper (Constructor)</h4> 183 <h4>VcsProjectHelper (Constructor)</h4>
145 <b>VcsProjectHelper</b>(<i>vcsObject, projectObject, parent=None, name=None</i>) 184 <b>VcsProjectHelper</b>(<i>vcsObject, projectObject, parent=None, name=None</i>)
185
146 <p> 186 <p>
147 Constructor 187 Constructor
148 </p><dl> 188 </p>
189 <dl>
190
149 <dt><i>vcsObject</i></dt> 191 <dt><i>vcsObject</i></dt>
150 <dd> 192 <dd>
151 reference to the vcs object 193 reference to the vcs object
152 </dd><dt><i>projectObject</i></dt> 194 </dd>
195 <dt><i>projectObject</i></dt>
153 <dd> 196 <dd>
154 reference to the project object 197 reference to the project object
155 </dd><dt><i>parent</i></dt> 198 </dd>
199 <dt><i>parent</i></dt>
156 <dd> 200 <dd>
157 parent widget (QWidget) 201 parent widget (QWidget)
158 </dd><dt><i>name</i></dt> 202 </dd>
203 <dt><i>name</i></dt>
159 <dd> 204 <dd>
160 name of this object (string) 205 name of this object (string)
161 </dd> 206 </dd>
162 </dl><a NAME="VcsProjectHelper._vcsCheckout" ID="VcsProjectHelper._vcsCheckout"></a> 207 </dl>
208 <a NAME="VcsProjectHelper._vcsCheckout" ID="VcsProjectHelper._vcsCheckout"></a>
163 <h4>VcsProjectHelper._vcsCheckout</h4> 209 <h4>VcsProjectHelper._vcsCheckout</h4>
164 <b>_vcsCheckout</b>(<i>export=False</i>) 210 <b>_vcsCheckout</b>(<i>export=False</i>)
211
165 <p> 212 <p>
166 Protected slot used to create a local project from the repository. 213 Protected slot used to create a local project from the repository.
167 </p><dl> 214 </p>
215 <dl>
216
168 <dt><i>export</i></dt> 217 <dt><i>export</i></dt>
169 <dd> 218 <dd>
170 flag indicating whether an export or a checkout 219 flag indicating whether an export or a checkout
171 should be performed 220 should be performed
172 </dd> 221 </dd>
173 </dl><a NAME="VcsProjectHelper._vcsCleanup" ID="VcsProjectHelper._vcsCleanup"></a> 222 </dl>
223 <a NAME="VcsProjectHelper._vcsCleanup" ID="VcsProjectHelper._vcsCleanup"></a>
174 <h4>VcsProjectHelper._vcsCleanup</h4> 224 <h4>VcsProjectHelper._vcsCleanup</h4>
175 <b>_vcsCleanup</b>(<i></i>) 225 <b>_vcsCleanup</b>(<i></i>)
226
176 <p> 227 <p>
177 Protected slot used to cleanup the local project. 228 Protected slot used to cleanup the local project.
178 </p><a NAME="VcsProjectHelper._vcsCommand" ID="VcsProjectHelper._vcsCommand"></a> 229 </p>
230 <a NAME="VcsProjectHelper._vcsCommand" ID="VcsProjectHelper._vcsCommand"></a>
179 <h4>VcsProjectHelper._vcsCommand</h4> 231 <h4>VcsProjectHelper._vcsCommand</h4>
180 <b>_vcsCommand</b>(<i></i>) 232 <b>_vcsCommand</b>(<i></i>)
233
181 <p> 234 <p>
182 Protected slot used to execute an arbitrary vcs command. 235 Protected slot used to execute an arbitrary vcs command.
183 </p><a NAME="VcsProjectHelper._vcsCommandOptions" ID="VcsProjectHelper._vcsCommandOptions"></a> 236 </p>
237 <a NAME="VcsProjectHelper._vcsCommandOptions" ID="VcsProjectHelper._vcsCommandOptions"></a>
184 <h4>VcsProjectHelper._vcsCommandOptions</h4> 238 <h4>VcsProjectHelper._vcsCommandOptions</h4>
185 <b>_vcsCommandOptions</b>(<i></i>) 239 <b>_vcsCommandOptions</b>(<i></i>)
240
186 <p> 241 <p>
187 Protected slot to edit the VCS command options. 242 Protected slot to edit the VCS command options.
188 </p><a NAME="VcsProjectHelper._vcsCommit" ID="VcsProjectHelper._vcsCommit"></a> 243 </p>
244 <a NAME="VcsProjectHelper._vcsCommit" ID="VcsProjectHelper._vcsCommit"></a>
189 <h4>VcsProjectHelper._vcsCommit</h4> 245 <h4>VcsProjectHelper._vcsCommit</h4>
190 <b>_vcsCommit</b>(<i></i>) 246 <b>_vcsCommit</b>(<i></i>)
247
191 <p> 248 <p>
192 Protected slot used to commit changes to the local project to the 249 Protected slot used to commit changes to the local project to the
193 repository. 250 repository.
194 </p><a NAME="VcsProjectHelper._vcsDiff" ID="VcsProjectHelper._vcsDiff"></a> 251 </p>
252 <a NAME="VcsProjectHelper._vcsDiff" ID="VcsProjectHelper._vcsDiff"></a>
195 <h4>VcsProjectHelper._vcsDiff</h4> 253 <h4>VcsProjectHelper._vcsDiff</h4>
196 <b>_vcsDiff</b>(<i></i>) 254 <b>_vcsDiff</b>(<i></i>)
255
197 <p> 256 <p>
198 Protected slot used to show the difference of the local project to 257 Protected slot used to show the difference of the local project to
199 the repository. 258 the repository.
200 </p><a NAME="VcsProjectHelper._vcsExport" ID="VcsProjectHelper._vcsExport"></a> 259 </p>
260 <a NAME="VcsProjectHelper._vcsExport" ID="VcsProjectHelper._vcsExport"></a>
201 <h4>VcsProjectHelper._vcsExport</h4> 261 <h4>VcsProjectHelper._vcsExport</h4>
202 <b>_vcsExport</b>(<i></i>) 262 <b>_vcsExport</b>(<i></i>)
263
203 <p> 264 <p>
204 Protected slot used to export a project from the repository. 265 Protected slot used to export a project from the repository.
205 </p><a NAME="VcsProjectHelper._vcsImport" ID="VcsProjectHelper._vcsImport"></a> 266 </p>
267 <a NAME="VcsProjectHelper._vcsImport" ID="VcsProjectHelper._vcsImport"></a>
206 <h4>VcsProjectHelper._vcsImport</h4> 268 <h4>VcsProjectHelper._vcsImport</h4>
207 <b>_vcsImport</b>(<i></i>) 269 <b>_vcsImport</b>(<i></i>)
270
208 <p> 271 <p>
209 Protected slot used to import the local project into the repository. 272 Protected slot used to import the local project into the repository.
210 </p><p> 273 </p>
274 <p>
211 <b>NOTE</b>: 275 <b>NOTE</b>:
212 This does not necessarily make the local project a vcs controlled 276 This does not necessarily make the local project a vcs controlled
213 project. You may have to checkout the project from the repository 277 project. You may have to checkout the project from the repository
214 in order to accomplish that. 278 in order to accomplish that.
215 </p><a NAME="VcsProjectHelper._vcsInfoDisplay" ID="VcsProjectHelper._vcsInfoDisplay"></a> 279 </p>
280 <a NAME="VcsProjectHelper._vcsInfoDisplay" ID="VcsProjectHelper._vcsInfoDisplay"></a>
216 <h4>VcsProjectHelper._vcsInfoDisplay</h4> 281 <h4>VcsProjectHelper._vcsInfoDisplay</h4>
217 <b>_vcsInfoDisplay</b>(<i></i>) 282 <b>_vcsInfoDisplay</b>(<i></i>)
283
218 <p> 284 <p>
219 Protected slot called to show some vcs information. 285 Protected slot called to show some vcs information.
220 </p><a NAME="VcsProjectHelper._vcsLog" ID="VcsProjectHelper._vcsLog"></a> 286 </p>
287 <a NAME="VcsProjectHelper._vcsLog" ID="VcsProjectHelper._vcsLog"></a>
221 <h4>VcsProjectHelper._vcsLog</h4> 288 <h4>VcsProjectHelper._vcsLog</h4>
222 <b>_vcsLog</b>(<i></i>) 289 <b>_vcsLog</b>(<i></i>)
290
223 <p> 291 <p>
224 Protected slot used to show the log of the local project. 292 Protected slot used to show the log of the local project.
225 </p><a NAME="VcsProjectHelper._vcsLogBrowser" ID="VcsProjectHelper._vcsLogBrowser"></a> 293 </p>
294 <a NAME="VcsProjectHelper._vcsLogBrowser" ID="VcsProjectHelper._vcsLogBrowser"></a>
226 <h4>VcsProjectHelper._vcsLogBrowser</h4> 295 <h4>VcsProjectHelper._vcsLogBrowser</h4>
227 <b>_vcsLogBrowser</b>(<i></i>) 296 <b>_vcsLogBrowser</b>(<i></i>)
297
228 <p> 298 <p>
229 Protected slot used to show the log of the local project with a 299 Protected slot used to show the log of the local project with a
230 log browser dialog. 300 log browser dialog.
231 </p><a NAME="VcsProjectHelper._vcsMerge" ID="VcsProjectHelper._vcsMerge"></a> 301 </p>
302 <a NAME="VcsProjectHelper._vcsMerge" ID="VcsProjectHelper._vcsMerge"></a>
232 <h4>VcsProjectHelper._vcsMerge</h4> 303 <h4>VcsProjectHelper._vcsMerge</h4>
233 <b>_vcsMerge</b>(<i></i>) 304 <b>_vcsMerge</b>(<i></i>)
305
234 <p> 306 <p>
235 Protected slot used to merge changes of a tag/revision into the local 307 Protected slot used to merge changes of a tag/revision into the local
236 project. 308 project.
237 </p><a NAME="VcsProjectHelper._vcsRemove" ID="VcsProjectHelper._vcsRemove"></a> 309 </p>
310 <a NAME="VcsProjectHelper._vcsRemove" ID="VcsProjectHelper._vcsRemove"></a>
238 <h4>VcsProjectHelper._vcsRemove</h4> 311 <h4>VcsProjectHelper._vcsRemove</h4>
239 <b>_vcsRemove</b>(<i></i>) 312 <b>_vcsRemove</b>(<i></i>)
313
240 <p> 314 <p>
241 Protected slot used to remove the local project from the repository. 315 Protected slot used to remove the local project from the repository.
242 </p><p> 316 </p>
317 <p>
243 Depending on the parameters set in the vcs object the project 318 Depending on the parameters set in the vcs object the project
244 may be removed from the local disk as well. 319 may be removed from the local disk as well.
245 </p><a NAME="VcsProjectHelper._vcsRevert" ID="VcsProjectHelper._vcsRevert"></a> 320 </p>
321 <a NAME="VcsProjectHelper._vcsRevert" ID="VcsProjectHelper._vcsRevert"></a>
246 <h4>VcsProjectHelper._vcsRevert</h4> 322 <h4>VcsProjectHelper._vcsRevert</h4>
247 <b>_vcsRevert</b>(<i></i>) 323 <b>_vcsRevert</b>(<i></i>)
324
248 <p> 325 <p>
249 Protected slot used to revert changes made to the local project. 326 Protected slot used to revert changes made to the local project.
250 </p><a NAME="VcsProjectHelper._vcsStatus" ID="VcsProjectHelper._vcsStatus"></a> 327 </p>
328 <a NAME="VcsProjectHelper._vcsStatus" ID="VcsProjectHelper._vcsStatus"></a>
251 <h4>VcsProjectHelper._vcsStatus</h4> 329 <h4>VcsProjectHelper._vcsStatus</h4>
252 <b>_vcsStatus</b>(<i></i>) 330 <b>_vcsStatus</b>(<i></i>)
331
253 <p> 332 <p>
254 Protected slot used to show the status of the local project. 333 Protected slot used to show the status of the local project.
255 </p><a NAME="VcsProjectHelper._vcsSwitch" ID="VcsProjectHelper._vcsSwitch"></a> 334 </p>
335 <a NAME="VcsProjectHelper._vcsSwitch" ID="VcsProjectHelper._vcsSwitch"></a>
256 <h4>VcsProjectHelper._vcsSwitch</h4> 336 <h4>VcsProjectHelper._vcsSwitch</h4>
257 <b>_vcsSwitch</b>(<i></i>) 337 <b>_vcsSwitch</b>(<i></i>)
338
258 <p> 339 <p>
259 Protected slot used to switch the local project to another tag/branch. 340 Protected slot used to switch the local project to another tag/branch.
260 </p><a NAME="VcsProjectHelper._vcsTag" ID="VcsProjectHelper._vcsTag"></a> 341 </p>
342 <a NAME="VcsProjectHelper._vcsTag" ID="VcsProjectHelper._vcsTag"></a>
261 <h4>VcsProjectHelper._vcsTag</h4> 343 <h4>VcsProjectHelper._vcsTag</h4>
262 <b>_vcsTag</b>(<i></i>) 344 <b>_vcsTag</b>(<i></i>)
345
263 <p> 346 <p>
264 Protected slot used to tag the local project in the repository. 347 Protected slot used to tag the local project in the repository.
265 </p><a NAME="VcsProjectHelper._vcsUpdate" ID="VcsProjectHelper._vcsUpdate"></a> 348 </p>
349 <a NAME="VcsProjectHelper._vcsUpdate" ID="VcsProjectHelper._vcsUpdate"></a>
266 <h4>VcsProjectHelper._vcsUpdate</h4> 350 <h4>VcsProjectHelper._vcsUpdate</h4>
267 <b>_vcsUpdate</b>(<i></i>) 351 <b>_vcsUpdate</b>(<i></i>)
352
268 <p> 353 <p>
269 Protected slot used to update the local project from the repository. 354 Protected slot used to update the local project from the repository.
270 </p><a NAME="VcsProjectHelper.initActions" ID="VcsProjectHelper.initActions"></a> 355 </p>
356 <a NAME="VcsProjectHelper.initActions" ID="VcsProjectHelper.initActions"></a>
271 <h4>VcsProjectHelper.initActions</h4> 357 <h4>VcsProjectHelper.initActions</h4>
272 <b>initActions</b>(<i></i>) 358 <b>initActions</b>(<i></i>)
359
273 <p> 360 <p>
274 Public method to generate the action objects. 361 Public method to generate the action objects.
275 </p><a NAME="VcsProjectHelper.initBasicToolbar" ID="VcsProjectHelper.initBasicToolbar"></a> 362 </p>
363 <a NAME="VcsProjectHelper.initBasicToolbar" ID="VcsProjectHelper.initBasicToolbar"></a>
276 <h4>VcsProjectHelper.initBasicToolbar</h4> 364 <h4>VcsProjectHelper.initBasicToolbar</h4>
277 <b>initBasicToolbar</b>(<i>ui, toolbarManager</i>) 365 <b>initBasicToolbar</b>(<i>ui, toolbarManager</i>)
366
278 <p> 367 <p>
279 Public slot to initialize the basic VCS toolbar. 368 Public slot to initialize the basic VCS toolbar.
280 </p><dl> 369 </p>
370 <dl>
371
281 <dt><i>ui</i></dt> 372 <dt><i>ui</i></dt>
282 <dd> 373 <dd>
283 reference to the main window (UserInterface) 374 reference to the main window (UserInterface)
284 </dd><dt><i>toolbarManager</i></dt> 375 </dd>
376 <dt><i>toolbarManager</i></dt>
285 <dd> 377 <dd>
286 reference to a toolbar manager object 378 reference to a toolbar manager object
287 (E5ToolBarManager) 379 (E5ToolBarManager)
288 </dd> 380 </dd>
289 </dl><dl> 381 </dl>
382 <dl>
290 <dt>Returns:</dt> 383 <dt>Returns:</dt>
291 <dd> 384 <dd>
292 the toolbar generated (QToolBar) 385 the toolbar generated (QToolBar)
293 </dd> 386 </dd>
294 </dl><a NAME="VcsProjectHelper.initMenu" ID="VcsProjectHelper.initMenu"></a> 387 </dl>
388 <a NAME="VcsProjectHelper.initMenu" ID="VcsProjectHelper.initMenu"></a>
295 <h4>VcsProjectHelper.initMenu</h4> 389 <h4>VcsProjectHelper.initMenu</h4>
296 <b>initMenu</b>(<i>menu</i>) 390 <b>initMenu</b>(<i>menu</i>)
391
297 <p> 392 <p>
298 Public method to generate the VCS menu. 393 Public method to generate the VCS menu.
299 </p><dl> 394 </p>
395 <dl>
396
300 <dt><i>menu</i></dt> 397 <dt><i>menu</i></dt>
301 <dd> 398 <dd>
302 reference to the menu to be populated (QMenu) 399 reference to the menu to be populated (QMenu)
303 </dd> 400 </dd>
304 </dl><a NAME="VcsProjectHelper.initToolbar" ID="VcsProjectHelper.initToolbar"></a> 401 </dl>
402 <a NAME="VcsProjectHelper.initToolbar" ID="VcsProjectHelper.initToolbar"></a>
305 <h4>VcsProjectHelper.initToolbar</h4> 403 <h4>VcsProjectHelper.initToolbar</h4>
306 <b>initToolbar</b>(<i>ui, toolbarManager</i>) 404 <b>initToolbar</b>(<i>ui, toolbarManager</i>)
405
307 <p> 406 <p>
308 Public slot to initialize the VCS toolbar. 407 Public slot to initialize the VCS toolbar.
309 </p><dl> 408 </p>
409 <dl>
410
310 <dt><i>ui</i></dt> 411 <dt><i>ui</i></dt>
311 <dd> 412 <dd>
312 reference to the main window (UserInterface) 413 reference to the main window (UserInterface)
313 </dd><dt><i>toolbarManager</i></dt> 414 </dd>
415 <dt><i>toolbarManager</i></dt>
314 <dd> 416 <dd>
315 reference to a toolbar manager object 417 reference to a toolbar manager object
316 (E5ToolBarManager) 418 (E5ToolBarManager)
317 </dd> 419 </dd>
318 </dl><dl> 420 </dl>
421 <dl>
319 <dt>Returns:</dt> 422 <dt>Returns:</dt>
320 <dd> 423 <dd>
321 the toolbar generated (QToolBar) 424 the toolbar generated (QToolBar)
322 </dd> 425 </dd>
323 </dl><a NAME="VcsProjectHelper.revertChanges" ID="VcsProjectHelper.revertChanges"></a> 426 </dl>
427 <a NAME="VcsProjectHelper.revertChanges" ID="VcsProjectHelper.revertChanges"></a>
324 <h4>VcsProjectHelper.revertChanges</h4> 428 <h4>VcsProjectHelper.revertChanges</h4>
325 <b>revertChanges</b>(<i></i>) 429 <b>revertChanges</b>(<i></i>)
430
326 <p> 431 <p>
327 Local function to revert the changes made to the project object. 432 Local function to revert the changes made to the project object.
328 </p><a NAME="VcsProjectHelper.setObjects" ID="VcsProjectHelper.setObjects"></a> 433 </p>
434 <a NAME="VcsProjectHelper.setObjects" ID="VcsProjectHelper.setObjects"></a>
329 <h4>VcsProjectHelper.setObjects</h4> 435 <h4>VcsProjectHelper.setObjects</h4>
330 <b>setObjects</b>(<i>vcsObject, projectObject</i>) 436 <b>setObjects</b>(<i>vcsObject, projectObject</i>)
437
331 <p> 438 <p>
332 Public method to set references to the vcs and project objects. 439 Public method to set references to the vcs and project objects.
333 </p><dl> 440 </p>
441 <dl>
442
334 <dt><i>vcsObject</i></dt> 443 <dt><i>vcsObject</i></dt>
335 <dd> 444 <dd>
336 reference to the vcs object 445 reference to the vcs object
337 </dd><dt><i>projectObject</i></dt> 446 </dd>
447 <dt><i>projectObject</i></dt>
338 <dd> 448 <dd>
339 reference to the project object 449 reference to the project object
340 </dd> 450 </dd>
341 </dl><a NAME="VcsProjectHelper.showMenu" ID="VcsProjectHelper.showMenu"></a> 451 </dl>
452 <a NAME="VcsProjectHelper.showMenu" ID="VcsProjectHelper.showMenu"></a>
342 <h4>VcsProjectHelper.showMenu</h4> 453 <h4>VcsProjectHelper.showMenu</h4>
343 <b>showMenu</b>(<i></i>) 454 <b>showMenu</b>(<i></i>)
455
344 <p> 456 <p>
345 Public slot called before the vcs menu is shown. 457 Public slot called before the vcs menu is shown.
346 </p> 458 </p>
347 <div align="right"><a href="#top">Up</a></div> 459 <div align="right"><a href="#top">Up</a></div>
348 <hr /> 460 <hr />

eric ide

mercurial