eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitMergeDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitMergeDialog</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitMergeDialog</h1>
24
25 <p>
26 Module implementing a dialog to enter the merge data.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#GitMergeDialog">GitMergeDialog</a></td>
39 <td>Class implementing a dialog to enter the merge data.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="GitMergeDialog" ID="GitMergeDialog"></a>
50 <h2>GitMergeDialog</h2>
51
52 <p>
53 Class implementing a dialog to enter the merge data.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_GitMergeDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#GitMergeDialog.__init__">GitMergeDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#GitMergeDialog.__generateDefaultCommitMessage">__generateDefaultCommitMessage</a></td>
77 <td>Private slot to generate a default commit message based on the data entered.</td>
78 </tr>
79 <tr>
80 <td><a href="#GitMergeDialog.__updateOK">__updateOK</a></td>
81 <td>Private slot to update the OK button.</td>
82 </tr>
83 <tr>
84 <td><a href="#GitMergeDialog.getParameters">getParameters</a></td>
85 <td>Public method to retrieve the merge data.</td>
86 </tr>
87 <tr>
88 <td><a href="#GitMergeDialog.on_branchButton_toggled">on_branchButton_toggled</a></td>
89 <td>Private slot to handle changes of the Branch select button.</td>
90 </tr>
91 <tr>
92 <td><a href="#GitMergeDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td>
93 <td>Private slot to handle changes of the Branch combo.</td>
94 </tr>
95 <tr>
96 <td><a href="#GitMergeDialog.on_commitGroupBox_toggled">on_commitGroupBox_toggled</a></td>
97 <td>Private slot to handle changes of the Commit select group.</td>
98 </tr>
99 <tr>
100 <td><a href="#GitMergeDialog.on_commitMessageEdit_textChanged">on_commitMessageEdit_textChanged</a></td>
101 <td>Private slot to handle changes of the commit message edit.</td>
102 </tr>
103 <tr>
104 <td><a href="#GitMergeDialog.on_idButton_toggled">on_idButton_toggled</a></td>
105 <td>Private slot to handle changes of the ID select button.</td>
106 </tr>
107 <tr>
108 <td><a href="#GitMergeDialog.on_idEdit_textChanged">on_idEdit_textChanged</a></td>
109 <td>Private slot to handle changes of the Commit edit.</td>
110 </tr>
111 <tr>
112 <td><a href="#GitMergeDialog.on_noneButton_toggled">on_noneButton_toggled</a></td>
113 <td>Private slot to handle changes of the None select button.</td>
114 </tr>
115 <tr>
116 <td><a href="#GitMergeDialog.on_remoteBranchButton_toggled">on_remoteBranchButton_toggled</a></td>
117 <td>Private slot to handle changes of the Remote Branch select button.</td>
118 </tr>
119 <tr>
120 <td><a href="#GitMergeDialog.on_remoteBranchCombo_editTextChanged">on_remoteBranchCombo_editTextChanged</a></td>
121 <td>Private slot to handle changes of the Remote Branch combo.</td>
122 </tr>
123 <tr>
124 <td><a href="#GitMergeDialog.on_tagButton_toggled">on_tagButton_toggled</a></td>
125 <td>Private slot to handle changes of the Tag select button.</td>
126 </tr>
127 <tr>
128 <td><a href="#GitMergeDialog.on_tagCombo_editTextChanged">on_tagCombo_editTextChanged</a></td>
129 <td>Private slot to handle changes of the Tag combo.</td>
130 </tr>
131 </table>
132 <h3>Static Methods</h3>
133
134 <table>
135 <tr><td>None</td></tr>
136 </table>
137
138 <a NAME="GitMergeDialog.__init__" ID="GitMergeDialog.__init__"></a>
139 <h4>GitMergeDialog (Constructor)</h4>
140 <b>GitMergeDialog</b>(<i>tagsList, branchesList, currentBranch, remoteBranchesList, parent=None</i>)
141
142 <p>
143 Constructor
144 </p>
145 <dl>
146
147 <dt><i>tagsList</i></dt>
148 <dd>
149 list of tags (list of strings)
150 </dd>
151 <dt><i>branchesList</i></dt>
152 <dd>
153 list of branches (list of strings)
154 </dd>
155 <dt><i>currentBranch</i></dt>
156 <dd>
157 name of the current branch (string)
158 </dd>
159 <dt><i>remoteBranchesList</i></dt>
160 <dd>
161 list of remote branches (list of strings)
162 </dd>
163 <dt><i>parent</i></dt>
164 <dd>
165 reference to the parent widget (QWidget)
166 </dd>
167 </dl>
168 <a NAME="GitMergeDialog.__generateDefaultCommitMessage" ID="GitMergeDialog.__generateDefaultCommitMessage"></a>
169 <h4>GitMergeDialog.__generateDefaultCommitMessage</h4>
170 <b>__generateDefaultCommitMessage</b>(<i></i>)
171
172 <p>
173 Private slot to generate a default commit message based on the
174 data entered.
175 </p>
176 <a NAME="GitMergeDialog.__updateOK" ID="GitMergeDialog.__updateOK"></a>
177 <h4>GitMergeDialog.__updateOK</h4>
178 <b>__updateOK</b>(<i></i>)
179
180 <p>
181 Private slot to update the OK button.
182 </p>
183 <a NAME="GitMergeDialog.getParameters" ID="GitMergeDialog.getParameters"></a>
184 <h4>GitMergeDialog.getParameters</h4>
185 <b>getParameters</b>(<i></i>)
186
187 <p>
188 Public method to retrieve the merge data.
189 </p>
190 <dl>
191 <dt>Return:</dt>
192 <dd>
193 tuple naming the revision, a flag indicating that the merge
194 shall be committed, the commit message, a flag indicating that a
195 log summary shall be appended and a flag indicating to show diff
196 statistics at the end of the merge (string, boolean, string,
197 boolean, boolean)
198 </dd>
199 </dl>
200 <a NAME="GitMergeDialog.on_branchButton_toggled" ID="GitMergeDialog.on_branchButton_toggled"></a>
201 <h4>GitMergeDialog.on_branchButton_toggled</h4>
202 <b>on_branchButton_toggled</b>(<i>checked</i>)
203
204 <p>
205 Private slot to handle changes of the Branch select button.
206 </p>
207 <dl>
208
209 <dt><i>checked</i></dt>
210 <dd>
211 state of the button (boolean)
212 </dd>
213 </dl>
214 <a NAME="GitMergeDialog.on_branchCombo_editTextChanged" ID="GitMergeDialog.on_branchCombo_editTextChanged"></a>
215 <h4>GitMergeDialog.on_branchCombo_editTextChanged</h4>
216 <b>on_branchCombo_editTextChanged</b>(<i>txt</i>)
217
218 <p>
219 Private slot to handle changes of the Branch combo.
220 </p>
221 <dl>
222
223 <dt><i>txt</i></dt>
224 <dd>
225 text of the combo (string)
226 </dd>
227 </dl>
228 <a NAME="GitMergeDialog.on_commitGroupBox_toggled" ID="GitMergeDialog.on_commitGroupBox_toggled"></a>
229 <h4>GitMergeDialog.on_commitGroupBox_toggled</h4>
230 <b>on_commitGroupBox_toggled</b>(<i>checked</i>)
231
232 <p>
233 Private slot to handle changes of the Commit select group.
234 </p>
235 <dl>
236
237 <dt><i>checked</i></dt>
238 <dd>
239 state of the group (boolean)
240 </dd>
241 </dl>
242 <a NAME="GitMergeDialog.on_commitMessageEdit_textChanged" ID="GitMergeDialog.on_commitMessageEdit_textChanged"></a>
243 <h4>GitMergeDialog.on_commitMessageEdit_textChanged</h4>
244 <b>on_commitMessageEdit_textChanged</b>(<i></i>)
245
246 <p>
247 Private slot to handle changes of the commit message edit.
248 </p>
249 <a NAME="GitMergeDialog.on_idButton_toggled" ID="GitMergeDialog.on_idButton_toggled"></a>
250 <h4>GitMergeDialog.on_idButton_toggled</h4>
251 <b>on_idButton_toggled</b>(<i>checked</i>)
252
253 <p>
254 Private slot to handle changes of the ID select button.
255 </p>
256 <dl>
257
258 <dt><i>checked</i></dt>
259 <dd>
260 state of the button (boolean)
261 </dd>
262 </dl>
263 <a NAME="GitMergeDialog.on_idEdit_textChanged" ID="GitMergeDialog.on_idEdit_textChanged"></a>
264 <h4>GitMergeDialog.on_idEdit_textChanged</h4>
265 <b>on_idEdit_textChanged</b>(<i>txt</i>)
266
267 <p>
268 Private slot to handle changes of the Commit edit.
269 </p>
270 <dl>
271
272 <dt><i>txt</i></dt>
273 <dd>
274 text of the edit (string)
275 </dd>
276 </dl>
277 <a NAME="GitMergeDialog.on_noneButton_toggled" ID="GitMergeDialog.on_noneButton_toggled"></a>
278 <h4>GitMergeDialog.on_noneButton_toggled</h4>
279 <b>on_noneButton_toggled</b>(<i>checked</i>)
280
281 <p>
282 Private slot to handle changes of the None select button.
283 </p>
284 <dl>
285
286 <dt><i>checked</i></dt>
287 <dd>
288 state of the button (boolean)
289 </dd>
290 </dl>
291 <a NAME="GitMergeDialog.on_remoteBranchButton_toggled" ID="GitMergeDialog.on_remoteBranchButton_toggled"></a>
292 <h4>GitMergeDialog.on_remoteBranchButton_toggled</h4>
293 <b>on_remoteBranchButton_toggled</b>(<i>checked</i>)
294
295 <p>
296 Private slot to handle changes of the Remote Branch select button.
297 </p>
298 <dl>
299
300 <dt><i>checked</i></dt>
301 <dd>
302 state of the button (boolean)
303 </dd>
304 </dl>
305 <a NAME="GitMergeDialog.on_remoteBranchCombo_editTextChanged" ID="GitMergeDialog.on_remoteBranchCombo_editTextChanged"></a>
306 <h4>GitMergeDialog.on_remoteBranchCombo_editTextChanged</h4>
307 <b>on_remoteBranchCombo_editTextChanged</b>(<i>txt</i>)
308
309 <p>
310 Private slot to handle changes of the Remote Branch combo.
311 </p>
312 <dl>
313
314 <dt><i>txt</i></dt>
315 <dd>
316 text of the combo (string)
317 </dd>
318 </dl>
319 <a NAME="GitMergeDialog.on_tagButton_toggled" ID="GitMergeDialog.on_tagButton_toggled"></a>
320 <h4>GitMergeDialog.on_tagButton_toggled</h4>
321 <b>on_tagButton_toggled</b>(<i>checked</i>)
322
323 <p>
324 Private slot to handle changes of the Tag select button.
325 </p>
326 <dl>
327
328 <dt><i>checked</i></dt>
329 <dd>
330 state of the button (boolean)
331 </dd>
332 </dl>
333 <a NAME="GitMergeDialog.on_tagCombo_editTextChanged" ID="GitMergeDialog.on_tagCombo_editTextChanged"></a>
334 <h4>GitMergeDialog.on_tagCombo_editTextChanged</h4>
335 <b>on_tagCombo_editTextChanged</b>(<i>txt</i>)
336
337 <p>
338 Private slot to handle changes of the Tag combo.
339 </p>
340 <dl>
341
342 <dt><i>txt</i></dt>
343 <dd>
344 text of the combo (string)
345 </dd>
346 </dl>
347 <div align="right"><a href="#top">Up</a></div>
348 <hr />
349 </body></html>

eric ide

mercurial