src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBranchDialog.html

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitBranchDialog</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitBranchDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to enter the data for a branching operation. 11 Module implementing a dialog to enter the data for a branching operation.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#GitBranchDialog">GitBranchDialog</a></td> 22 <td><a href="#GitBranchDialog">GitBranchDialog</a></td>
25 <td>Class implementing a dialog to enter the data for a branching operation.</td> 23 <td>Class implementing a dialog to enter the data for a branching operation.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="GitBranchDialog" ID="GitBranchDialog"></a> 34 <a NAME="GitBranchDialog" ID="GitBranchDialog"></a>
36 <h2>GitBranchDialog</h2> 35 <h2>GitBranchDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to enter the data for a branching operation. 37 Class implementing a dialog to enter the data for a branching operation.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_GitBranchDialog 41 QDialog, Ui_GitBranchDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>CreateBranch</td></tr>
46 <tr><td>CreateBranch</td></tr><tr><td>CreateSwitchBranch</td></tr><tr><td>CreateTrackingBranch</td></tr><tr><td>DeleteBranch</td></tr><tr><td>RenameBranch</td></tr><tr><td>SetTrackingBranch</td></tr><tr><td>UnsetTrackingBranch</td></tr> 45 <tr><td>CreateSwitchBranch</td></tr>
47 </table> 46 <tr><td>CreateTrackingBranch</td></tr>
47 <tr><td>DeleteBranch</td></tr>
48 <tr><td>RenameBranch</td></tr>
49 <tr><td>SetTrackingBranch</td></tr>
50 <tr><td>UnsetTrackingBranch</td></tr>
51 </table>
52
48 <h3>Class Methods</h3> 53 <h3>Class Methods</h3>
49 54 <table>
50 <table> 55 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 56 </table>
52 </table> 57
53 <h3>Methods</h3> 58 <h3>Methods</h3>
54 59 <table>
55 <table>
56
57 <tr> 60 <tr>
58 <td><a href="#GitBranchDialog.__init__">GitBranchDialog</a></td> 61 <td><a href="#GitBranchDialog.__init__">GitBranchDialog</a></td>
59 <td>Constructor</td> 62 <td>Constructor</td>
60 </tr> 63 </tr>
61 <tr> 64 <tr>
85 <tr> 88 <tr>
86 <td><a href="#GitBranchDialog.on_unsetTrackingButton_toggled">on_unsetTrackingButton_toggled</a></td> 89 <td><a href="#GitBranchDialog.on_unsetTrackingButton_toggled">on_unsetTrackingButton_toggled</a></td>
87 <td>Private slot to handle the selection of unsetting a tracking branch.</td> 90 <td>Private slot to handle the selection of unsetting a tracking branch.</td>
88 </tr> 91 </tr>
89 </table> 92 </table>
93
90 <h3>Static Methods</h3> 94 <h3>Static Methods</h3>
91 95 <table>
92 <table> 96 <tr><td>None</td></tr>
93 <tr><td>None</td></tr> 97 </table>
94 </table> 98
95 99
96 <a NAME="GitBranchDialog.__init__" ID="GitBranchDialog.__init__"></a> 100 <a NAME="GitBranchDialog.__init__" ID="GitBranchDialog.__init__"></a>
97 <h4>GitBranchDialog (Constructor)</h4> 101 <h4>GitBranchDialog (Constructor)</h4>
98 <b>GitBranchDialog</b>(<i>branchlist, revision=None, branchName=None, branchOp=None, parent=None</i>) 102 <b>GitBranchDialog</b>(<i>branchlist, revision=None, branchName=None, branchOp=None, parent=None</i>)
99
100 <p> 103 <p>
101 Constructor 104 Constructor
102 </p> 105 </p>
106
103 <dl> 107 <dl>
104 108
105 <dt><i>branchlist</i> (list of str)</dt> 109 <dt><i>branchlist</i> (list of str)</dt>
106 <dd> 110 <dd>
107 list of previously entered branches 111 list of previously entered branches
124 </dd> 128 </dd>
125 </dl> 129 </dl>
126 <a NAME="GitBranchDialog.__updateOK" ID="GitBranchDialog.__updateOK"></a> 130 <a NAME="GitBranchDialog.__updateOK" ID="GitBranchDialog.__updateOK"></a>
127 <h4>GitBranchDialog.__updateOK</h4> 131 <h4>GitBranchDialog.__updateOK</h4>
128 <b>__updateOK</b>(<i></i>) 132 <b>__updateOK</b>(<i></i>)
129
130 <p> 133 <p>
131 Private method used to enable/disable the OK-button. 134 Private method used to enable/disable the OK-button.
132 </p> 135 </p>
136
133 <a NAME="GitBranchDialog.getParameters" ID="GitBranchDialog.getParameters"></a> 137 <a NAME="GitBranchDialog.getParameters" ID="GitBranchDialog.getParameters"></a>
134 <h4>GitBranchDialog.getParameters</h4> 138 <h4>GitBranchDialog.getParameters</h4>
135 <b>getParameters</b>(<i></i>) 139 <b>getParameters</b>(<i></i>)
136
137 <p> 140 <p>
138 Public method to retrieve the branch data. 141 Public method to retrieve the branch data.
139 </p> 142 </p>
143
140 <dl> 144 <dl>
141 <dt>Return:</dt> 145 <dt>Return:</dt>
142 <dd> 146 <dd>
143 tuple containing the branch operation, branch name, revision, 147 tuple containing the branch operation, branch name, revision,
144 new branch name, remote branch name and a flag indicating to enforce 148 new branch name, remote branch name and a flag indicating to enforce
152 </dd> 156 </dd>
153 </dl> 157 </dl>
154 <a NAME="GitBranchDialog.on_branchCombo_editTextChanged" ID="GitBranchDialog.on_branchCombo_editTextChanged"></a> 158 <a NAME="GitBranchDialog.on_branchCombo_editTextChanged" ID="GitBranchDialog.on_branchCombo_editTextChanged"></a>
155 <h4>GitBranchDialog.on_branchCombo_editTextChanged</h4> 159 <h4>GitBranchDialog.on_branchCombo_editTextChanged</h4>
156 <b>on_branchCombo_editTextChanged</b>(<i>text</i>) 160 <b>on_branchCombo_editTextChanged</b>(<i>text</i>)
157
158 <p> 161 <p>
159 Private slot to handle a change of the branch. 162 Private slot to handle a change of the branch.
160 </p> 163 </p>
164
161 <dl> 165 <dl>
162 166
163 <dt><i>text</i> (str)</dt> 167 <dt><i>text</i> (str)</dt>
164 <dd> 168 <dd>
165 branch name entered in the combo 169 branch name entered in the combo
166 </dd> 170 </dd>
167 </dl> 171 </dl>
168 <a NAME="GitBranchDialog.on_createTrackingButton_toggled" ID="GitBranchDialog.on_createTrackingButton_toggled"></a> 172 <a NAME="GitBranchDialog.on_createTrackingButton_toggled" ID="GitBranchDialog.on_createTrackingButton_toggled"></a>
169 <h4>GitBranchDialog.on_createTrackingButton_toggled</h4> 173 <h4>GitBranchDialog.on_createTrackingButton_toggled</h4>
170 <b>on_createTrackingButton_toggled</b>(<i>checked</i>) 174 <b>on_createTrackingButton_toggled</b>(<i>checked</i>)
171
172 <p> 175 <p>
173 Private slot to handle the selection of creating a tracking branch. 176 Private slot to handle the selection of creating a tracking branch.
174 </p> 177 </p>
178
175 <dl> 179 <dl>
176 180
177 <dt><i>checked</i> (bool)</dt> 181 <dt><i>checked</i> (bool)</dt>
178 <dd> 182 <dd>
179 state of the selection 183 state of the selection
180 </dd> 184 </dd>
181 </dl> 185 </dl>
182 <a NAME="GitBranchDialog.on_newBranchNameEdit_textChanged" ID="GitBranchDialog.on_newBranchNameEdit_textChanged"></a> 186 <a NAME="GitBranchDialog.on_newBranchNameEdit_textChanged" ID="GitBranchDialog.on_newBranchNameEdit_textChanged"></a>
183 <h4>GitBranchDialog.on_newBranchNameEdit_textChanged</h4> 187 <h4>GitBranchDialog.on_newBranchNameEdit_textChanged</h4>
184 <b>on_newBranchNameEdit_textChanged</b>(<i>text</i>) 188 <b>on_newBranchNameEdit_textChanged</b>(<i>text</i>)
185
186 <p> 189 <p>
187 Private slot to handle a change of the new branch. 190 Private slot to handle a change of the new branch.
188 </p> 191 </p>
192
189 <dl> 193 <dl>
190 194
191 <dt><i>text</i> (str)</dt> 195 <dt><i>text</i> (str)</dt>
192 <dd> 196 <dd>
193 new branch name entered 197 new branch name entered
194 </dd> 198 </dd>
195 </dl> 199 </dl>
196 <a NAME="GitBranchDialog.on_setTrackingButton_toggled" ID="GitBranchDialog.on_setTrackingButton_toggled"></a> 200 <a NAME="GitBranchDialog.on_setTrackingButton_toggled" ID="GitBranchDialog.on_setTrackingButton_toggled"></a>
197 <h4>GitBranchDialog.on_setTrackingButton_toggled</h4> 201 <h4>GitBranchDialog.on_setTrackingButton_toggled</h4>
198 <b>on_setTrackingButton_toggled</b>(<i>checked</i>) 202 <b>on_setTrackingButton_toggled</b>(<i>checked</i>)
199
200 <p> 203 <p>
201 Private slot to handle the selection of setting a tracking branch. 204 Private slot to handle the selection of setting a tracking branch.
202 </p> 205 </p>
206
203 <dl> 207 <dl>
204 208
205 <dt><i>checked</i> (bool)</dt> 209 <dt><i>checked</i> (bool)</dt>
206 <dd> 210 <dd>
207 state of the selection 211 state of the selection
208 </dd> 212 </dd>
209 </dl> 213 </dl>
210 <a NAME="GitBranchDialog.on_unsetTrackingButton_toggled" ID="GitBranchDialog.on_unsetTrackingButton_toggled"></a> 214 <a NAME="GitBranchDialog.on_unsetTrackingButton_toggled" ID="GitBranchDialog.on_unsetTrackingButton_toggled"></a>
211 <h4>GitBranchDialog.on_unsetTrackingButton_toggled</h4> 215 <h4>GitBranchDialog.on_unsetTrackingButton_toggled</h4>
212 <b>on_unsetTrackingButton_toggled</b>(<i>checked</i>) 216 <b>on_unsetTrackingButton_toggled</b>(<i>checked</i>)
213
214 <p> 217 <p>
215 Private slot to handle the selection of unsetting a tracking branch. 218 Private slot to handle the selection of unsetting a tracking branch.
216 </p> 219 </p>
220
217 <dl> 221 <dl>
218 222
219 <dt><i>checked</i> (bool)</dt> 223 <dt><i>checked</i> (bool)</dt>
220 <dd> 224 <dd>
221 state of the selection 225 state of the selection

eric ide

mercurial