|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.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><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitMergeDialog</h1> |
|
23 <p> |
|
24 Module implementing a dialog to enter the merge data. |
|
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="#GitMergeDialog">GitMergeDialog</a></td> |
|
34 <td>Class implementing a dialog to enter the merge data.</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="GitMergeDialog" ID="GitMergeDialog"></a> |
|
43 <h2>GitMergeDialog</h2> |
|
44 <p> |
|
45 Class implementing a dialog to enter the merge data. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 QDialog, Ui_GitMergeDialog |
|
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="#GitMergeDialog.__init__">GitMergeDialog</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#GitMergeDialog.__generateDefaultCommitMessage">__generateDefaultCommitMessage</a></td> |
|
64 <td>Private slot to generate a default commit message based on the data entered.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#GitMergeDialog.__updateOK">__updateOK</a></td> |
|
67 <td>Private slot to update the OK button.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#GitMergeDialog.getParameters">getParameters</a></td> |
|
70 <td>Public method to retrieve the merge data.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#GitMergeDialog.on_branchButton_toggled">on_branchButton_toggled</a></td> |
|
73 <td>Private slot to handle changes of the Branch select button.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#GitMergeDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td> |
|
76 <td>Private slot to handle changes of the Branch combo.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#GitMergeDialog.on_commitGroupBox_toggled">on_commitGroupBox_toggled</a></td> |
|
79 <td>Private slot to handle changes of the Commit select group.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#GitMergeDialog.on_commitMessageEdit_textChanged">on_commitMessageEdit_textChanged</a></td> |
|
82 <td>Private slot to handle changes of the commit message edit.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#GitMergeDialog.on_idButton_toggled">on_idButton_toggled</a></td> |
|
85 <td>Private slot to handle changes of the ID select button.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#GitMergeDialog.on_idEdit_textChanged">on_idEdit_textChanged</a></td> |
|
88 <td>Private slot to handle changes of the Commit edit.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#GitMergeDialog.on_noneButton_toggled">on_noneButton_toggled</a></td> |
|
91 <td>Private slot to handle changes of the None select button.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#GitMergeDialog.on_remoteBranchButton_toggled">on_remoteBranchButton_toggled</a></td> |
|
94 <td>Private slot to handle changes of the Remote Branch select button.</td> |
|
95 </tr><tr> |
|
96 <td><a href="#GitMergeDialog.on_remoteBranchCombo_editTextChanged">on_remoteBranchCombo_editTextChanged</a></td> |
|
97 <td>Private slot to handle changes of the Remote Branch combo.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#GitMergeDialog.on_tagButton_toggled">on_tagButton_toggled</a></td> |
|
100 <td>Private slot to handle changes of the Tag select button.</td> |
|
101 </tr><tr> |
|
102 <td><a href="#GitMergeDialog.on_tagCombo_editTextChanged">on_tagCombo_editTextChanged</a></td> |
|
103 <td>Private slot to handle changes of the Tag combo.</td> |
|
104 </tr> |
|
105 </table> |
|
106 <h3>Static Methods</h3> |
|
107 <table> |
|
108 <tr><td>None</td></tr> |
|
109 </table> |
|
110 <a NAME="GitMergeDialog.__init__" ID="GitMergeDialog.__init__"></a> |
|
111 <h4>GitMergeDialog (Constructor)</h4> |
|
112 <b>GitMergeDialog</b>(<i>tagsList, branchesList, currentBranch, remoteBranchesList, parent=None</i>) |
|
113 <p> |
|
114 Constructor |
|
115 </p><dl> |
|
116 <dt><i>tagsList</i></dt> |
|
117 <dd> |
|
118 list of tags (list of strings) |
|
119 </dd><dt><i>branchesList</i></dt> |
|
120 <dd> |
|
121 list of branches (list of strings) |
|
122 </dd><dt><i>currentBranch</i></dt> |
|
123 <dd> |
|
124 name of the current branch (string) |
|
125 </dd><dt><i>remoteBranchesList</i></dt> |
|
126 <dd> |
|
127 list of remote branches (list of strings) |
|
128 </dd><dt><i>parent</i></dt> |
|
129 <dd> |
|
130 reference to the parent widget (QWidget) |
|
131 </dd> |
|
132 </dl><a NAME="GitMergeDialog.__generateDefaultCommitMessage" ID="GitMergeDialog.__generateDefaultCommitMessage"></a> |
|
133 <h4>GitMergeDialog.__generateDefaultCommitMessage</h4> |
|
134 <b>__generateDefaultCommitMessage</b>(<i></i>) |
|
135 <p> |
|
136 Private slot to generate a default commit message based on the |
|
137 data entered. |
|
138 </p><a NAME="GitMergeDialog.__updateOK" ID="GitMergeDialog.__updateOK"></a> |
|
139 <h4>GitMergeDialog.__updateOK</h4> |
|
140 <b>__updateOK</b>(<i></i>) |
|
141 <p> |
|
142 Private slot to update the OK button. |
|
143 </p><a NAME="GitMergeDialog.getParameters" ID="GitMergeDialog.getParameters"></a> |
|
144 <h4>GitMergeDialog.getParameters</h4> |
|
145 <b>getParameters</b>(<i></i>) |
|
146 <p> |
|
147 Public method to retrieve the merge data. |
|
148 </p><dl> |
|
149 <dt>Returns:</dt> |
|
150 <dd> |
|
151 tuple naming the revision, a flag indicating that the merge |
|
152 shall be committed, the commit message, a flag indicating that a |
|
153 log summary shall be appended and a flag indicating to show diff |
|
154 statistics at the end of the merge (string, boolean, string, |
|
155 boolean, boolean) |
|
156 </dd> |
|
157 </dl><a NAME="GitMergeDialog.on_branchButton_toggled" ID="GitMergeDialog.on_branchButton_toggled"></a> |
|
158 <h4>GitMergeDialog.on_branchButton_toggled</h4> |
|
159 <b>on_branchButton_toggled</b>(<i>checked</i>) |
|
160 <p> |
|
161 Private slot to handle changes of the Branch select button. |
|
162 </p><dl> |
|
163 <dt><i>checked</i></dt> |
|
164 <dd> |
|
165 state of the button (boolean) |
|
166 </dd> |
|
167 </dl><a NAME="GitMergeDialog.on_branchCombo_editTextChanged" ID="GitMergeDialog.on_branchCombo_editTextChanged"></a> |
|
168 <h4>GitMergeDialog.on_branchCombo_editTextChanged</h4> |
|
169 <b>on_branchCombo_editTextChanged</b>(<i>txt</i>) |
|
170 <p> |
|
171 Private slot to handle changes of the Branch combo. |
|
172 </p><dl> |
|
173 <dt><i>txt</i></dt> |
|
174 <dd> |
|
175 text of the combo (string) |
|
176 </dd> |
|
177 </dl><a NAME="GitMergeDialog.on_commitGroupBox_toggled" ID="GitMergeDialog.on_commitGroupBox_toggled"></a> |
|
178 <h4>GitMergeDialog.on_commitGroupBox_toggled</h4> |
|
179 <b>on_commitGroupBox_toggled</b>(<i>checked</i>) |
|
180 <p> |
|
181 Private slot to handle changes of the Commit select group. |
|
182 </p><dl> |
|
183 <dt><i>checked</i></dt> |
|
184 <dd> |
|
185 state of the group (boolean) |
|
186 </dd> |
|
187 </dl><a NAME="GitMergeDialog.on_commitMessageEdit_textChanged" ID="GitMergeDialog.on_commitMessageEdit_textChanged"></a> |
|
188 <h4>GitMergeDialog.on_commitMessageEdit_textChanged</h4> |
|
189 <b>on_commitMessageEdit_textChanged</b>(<i></i>) |
|
190 <p> |
|
191 Private slot to handle changes of the commit message edit. |
|
192 </p><a NAME="GitMergeDialog.on_idButton_toggled" ID="GitMergeDialog.on_idButton_toggled"></a> |
|
193 <h4>GitMergeDialog.on_idButton_toggled</h4> |
|
194 <b>on_idButton_toggled</b>(<i>checked</i>) |
|
195 <p> |
|
196 Private slot to handle changes of the ID select button. |
|
197 </p><dl> |
|
198 <dt><i>checked</i></dt> |
|
199 <dd> |
|
200 state of the button (boolean) |
|
201 </dd> |
|
202 </dl><a NAME="GitMergeDialog.on_idEdit_textChanged" ID="GitMergeDialog.on_idEdit_textChanged"></a> |
|
203 <h4>GitMergeDialog.on_idEdit_textChanged</h4> |
|
204 <b>on_idEdit_textChanged</b>(<i>txt</i>) |
|
205 <p> |
|
206 Private slot to handle changes of the Commit edit. |
|
207 </p><dl> |
|
208 <dt><i>txt</i></dt> |
|
209 <dd> |
|
210 text of the edit (string) |
|
211 </dd> |
|
212 </dl><a NAME="GitMergeDialog.on_noneButton_toggled" ID="GitMergeDialog.on_noneButton_toggled"></a> |
|
213 <h4>GitMergeDialog.on_noneButton_toggled</h4> |
|
214 <b>on_noneButton_toggled</b>(<i>checked</i>) |
|
215 <p> |
|
216 Private slot to handle changes of the None select button. |
|
217 </p><dl> |
|
218 <dt><i>checked</i></dt> |
|
219 <dd> |
|
220 state of the button (boolean) |
|
221 </dd> |
|
222 </dl><a NAME="GitMergeDialog.on_remoteBranchButton_toggled" ID="GitMergeDialog.on_remoteBranchButton_toggled"></a> |
|
223 <h4>GitMergeDialog.on_remoteBranchButton_toggled</h4> |
|
224 <b>on_remoteBranchButton_toggled</b>(<i>checked</i>) |
|
225 <p> |
|
226 Private slot to handle changes of the Remote Branch select button. |
|
227 </p><dl> |
|
228 <dt><i>checked</i></dt> |
|
229 <dd> |
|
230 state of the button (boolean) |
|
231 </dd> |
|
232 </dl><a NAME="GitMergeDialog.on_remoteBranchCombo_editTextChanged" ID="GitMergeDialog.on_remoteBranchCombo_editTextChanged"></a> |
|
233 <h4>GitMergeDialog.on_remoteBranchCombo_editTextChanged</h4> |
|
234 <b>on_remoteBranchCombo_editTextChanged</b>(<i>txt</i>) |
|
235 <p> |
|
236 Private slot to handle changes of the Remote Branch combo. |
|
237 </p><dl> |
|
238 <dt><i>txt</i></dt> |
|
239 <dd> |
|
240 text of the combo (string) |
|
241 </dd> |
|
242 </dl><a NAME="GitMergeDialog.on_tagButton_toggled" ID="GitMergeDialog.on_tagButton_toggled"></a> |
|
243 <h4>GitMergeDialog.on_tagButton_toggled</h4> |
|
244 <b>on_tagButton_toggled</b>(<i>checked</i>) |
|
245 <p> |
|
246 Private slot to handle changes of the Tag select button. |
|
247 </p><dl> |
|
248 <dt><i>checked</i></dt> |
|
249 <dd> |
|
250 state of the button (boolean) |
|
251 </dd> |
|
252 </dl><a NAME="GitMergeDialog.on_tagCombo_editTextChanged" ID="GitMergeDialog.on_tagCombo_editTextChanged"></a> |
|
253 <h4>GitMergeDialog.on_tagCombo_editTextChanged</h4> |
|
254 <b>on_tagCombo_editTextChanged</b>(<i>txt</i>) |
|
255 <p> |
|
256 Private slot to handle changes of the Tag combo. |
|
257 </p><dl> |
|
258 <dt><i>txt</i></dt> |
|
259 <dd> |
|
260 text of the combo (string) |
|
261 </dd> |
|
262 </dl> |
|
263 <div align="right"><a href="#top">Up</a></div> |
|
264 <hr /> |
|
265 </body></html> |