eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBranchDialog.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.GitBranchDialog</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.GitBranchDialog</h1>
24
25 <p>
26 Module implementing a dialog to enter the data for a branching operation.
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="#GitBranchDialog">GitBranchDialog</a></td>
39 <td>Class implementing a dialog to enter the data for a branching operation.</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="GitBranchDialog" ID="GitBranchDialog"></a>
50 <h2>GitBranchDialog</h2>
51
52 <p>
53 Class implementing a dialog to enter the data for a branching operation.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_GitBranchDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <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>
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="#GitBranchDialog.__init__">GitBranchDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#GitBranchDialog.__updateOK">__updateOK</a></td>
77 <td>Private method used to enable/disable the OK-button.</td>
78 </tr>
79 <tr>
80 <td><a href="#GitBranchDialog.getParameters">getParameters</a></td>
81 <td>Public method to retrieve the branch data.</td>
82 </tr>
83 <tr>
84 <td><a href="#GitBranchDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td>
85 <td>Private slot to handle a change of the branch.</td>
86 </tr>
87 <tr>
88 <td><a href="#GitBranchDialog.on_createTrackingButton_toggled">on_createTrackingButton_toggled</a></td>
89 <td>Private slot to handle the selection of creating a tracking branch.</td>
90 </tr>
91 <tr>
92 <td><a href="#GitBranchDialog.on_newBranchNameEdit_textChanged">on_newBranchNameEdit_textChanged</a></td>
93 <td>Private slot to handle a change of the new branch.</td>
94 </tr>
95 <tr>
96 <td><a href="#GitBranchDialog.on_setTrackingButton_toggled">on_setTrackingButton_toggled</a></td>
97 <td>Private slot to handle the selection of setting a tracking branch.</td>
98 </tr>
99 <tr>
100 <td><a href="#GitBranchDialog.on_unsetTrackingButton_toggled">on_unsetTrackingButton_toggled</a></td>
101 <td>Private slot to handle the selection of unsetting a tracking branch.</td>
102 </tr>
103 </table>
104 <h3>Static Methods</h3>
105
106 <table>
107 <tr><td>None</td></tr>
108 </table>
109
110 <a NAME="GitBranchDialog.__init__" ID="GitBranchDialog.__init__"></a>
111 <h4>GitBranchDialog (Constructor)</h4>
112 <b>GitBranchDialog</b>(<i>branchlist, revision=None, branchName=None, branchOp=None, parent=None</i>)
113
114 <p>
115 Constructor
116 </p>
117 <dl>
118
119 <dt><i>branchlist</i></dt>
120 <dd>
121 list of previously entered branches (list of strings)
122 </dd>
123 <dt><i>revision</i></dt>
124 <dd>
125 revision to set tag for (string)
126 </dd>
127 <dt><i>branchName</i></dt>
128 <dd>
129 name of the branch (string)
130 </dd>
131 <dt><i>branchOp</i></dt>
132 <dd>
133 desired branch operation (integer)
134 </dd>
135 <dt><i>parent</i></dt>
136 <dd>
137 parent widget (QWidget)
138 </dd>
139 </dl>
140 <a NAME="GitBranchDialog.__updateOK" ID="GitBranchDialog.__updateOK"></a>
141 <h4>GitBranchDialog.__updateOK</h4>
142 <b>__updateOK</b>(<i></i>)
143
144 <p>
145 Private method used to enable/disable the OK-button.
146 </p>
147 <a NAME="GitBranchDialog.getParameters" ID="GitBranchDialog.getParameters"></a>
148 <h4>GitBranchDialog.getParameters</h4>
149 <b>getParameters</b>(<i></i>)
150
151 <p>
152 Public method to retrieve the branch data.
153 </p>
154 <dl>
155 <dt>Return:</dt>
156 <dd>
157 tuple of an int, four strings and a boolean
158 (branch operation, branch name, revision, new branch name,
159 remote branch name, enforce operation)
160 </dd>
161 </dl>
162 <a NAME="GitBranchDialog.on_branchCombo_editTextChanged" ID="GitBranchDialog.on_branchCombo_editTextChanged"></a>
163 <h4>GitBranchDialog.on_branchCombo_editTextChanged</h4>
164 <b>on_branchCombo_editTextChanged</b>(<i>text</i>)
165
166 <p>
167 Private slot to handle a change of the branch.
168 </p>
169 <dl>
170
171 <dt><i>text</i></dt>
172 <dd>
173 branch name entered in the combo (string)
174 </dd>
175 </dl>
176 <a NAME="GitBranchDialog.on_createTrackingButton_toggled" ID="GitBranchDialog.on_createTrackingButton_toggled"></a>
177 <h4>GitBranchDialog.on_createTrackingButton_toggled</h4>
178 <b>on_createTrackingButton_toggled</b>(<i>checked</i>)
179
180 <p>
181 Private slot to handle the selection of creating a tracking branch.
182 </p>
183 <dl>
184
185 <dt><i>checked</i></dt>
186 <dd>
187 state of the selection (boolean)
188 </dd>
189 </dl>
190 <a NAME="GitBranchDialog.on_newBranchNameEdit_textChanged" ID="GitBranchDialog.on_newBranchNameEdit_textChanged"></a>
191 <h4>GitBranchDialog.on_newBranchNameEdit_textChanged</h4>
192 <b>on_newBranchNameEdit_textChanged</b>(<i>text</i>)
193
194 <p>
195 Private slot to handle a change of the new branch.
196 </p>
197 <dl>
198
199 <dt><i>text</i></dt>
200 <dd>
201 new branch name entered (string)
202 </dd>
203 </dl>
204 <a NAME="GitBranchDialog.on_setTrackingButton_toggled" ID="GitBranchDialog.on_setTrackingButton_toggled"></a>
205 <h4>GitBranchDialog.on_setTrackingButton_toggled</h4>
206 <b>on_setTrackingButton_toggled</b>(<i>checked</i>)
207
208 <p>
209 Private slot to handle the selection of setting a tracking branch.
210 </p>
211 <dl>
212
213 <dt><i>checked</i></dt>
214 <dd>
215 state of the selection (boolean)
216 </dd>
217 </dl>
218 <a NAME="GitBranchDialog.on_unsetTrackingButton_toggled" ID="GitBranchDialog.on_unsetTrackingButton_toggled"></a>
219 <h4>GitBranchDialog.on_unsetTrackingButton_toggled</h4>
220 <b>on_unsetTrackingButton_toggled</b>(<i>checked</i>)
221
222 <p>
223 Private slot to handle the selection of unsetting a tracking branch.
224 </p>
225 <dl>
226
227 <dt><i>checked</i></dt>
228 <dd>
229 state of the selection (boolean)
230 </dd>
231 </dl>
232 <div align="right"><a href="#top">Up</a></div>
233 <hr />
234 </body></html>

eric ide

mercurial