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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10438
4cd7e5a8b3cf
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitBranchDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitBranchDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter the data for a branching operation.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#GitBranchDialog">GitBranchDialog</a></td>
25 <td>Class implementing a dialog to enter the data for a branching operation.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="GitBranchDialog" ID="GitBranchDialog"></a>
36 <h2>GitBranchDialog</h2>
37
38 <p>
39 Class implementing a dialog to enter the data for a branching operation.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_GitBranchDialog
43 <h3>Class Attributes</h3>
44
45 <table>
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>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#GitBranchDialog.__init__">GitBranchDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#GitBranchDialog.__updateOK">__updateOK</a></td>
63 <td>Private method used to enable/disable the OK-button.</td>
64 </tr>
65 <tr>
66 <td><a href="#GitBranchDialog.getParameters">getParameters</a></td>
67 <td>Public method to retrieve the branch data.</td>
68 </tr>
69 <tr>
70 <td><a href="#GitBranchDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td>
71 <td>Private slot to handle a change of the branch.</td>
72 </tr>
73 <tr>
74 <td><a href="#GitBranchDialog.on_createTrackingButton_toggled">on_createTrackingButton_toggled</a></td>
75 <td>Private slot to handle the selection of creating a tracking branch.</td>
76 </tr>
77 <tr>
78 <td><a href="#GitBranchDialog.on_newBranchNameEdit_textChanged">on_newBranchNameEdit_textChanged</a></td>
79 <td>Private slot to handle a change of the new branch.</td>
80 </tr>
81 <tr>
82 <td><a href="#GitBranchDialog.on_setTrackingButton_toggled">on_setTrackingButton_toggled</a></td>
83 <td>Private slot to handle the selection of setting a tracking branch.</td>
84 </tr>
85 <tr>
86 <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>
88 </tr>
89 </table>
90 <h3>Static Methods</h3>
91
92 <table>
93 <tr><td>None</td></tr>
94 </table>
95
96 <a NAME="GitBranchDialog.__init__" ID="GitBranchDialog.__init__"></a>
97 <h4>GitBranchDialog (Constructor)</h4>
98 <b>GitBranchDialog</b>(<i>branchlist, revision=None, branchName=None, branchOp=None, parent=None</i>)
99
100 <p>
101 Constructor
102 </p>
103 <dl>
104
105 <dt><i>branchlist</i></dt>
106 <dd>
107 list of previously entered branches (list of strings)
108 </dd>
109 <dt><i>revision</i></dt>
110 <dd>
111 revision to set tag for (string)
112 </dd>
113 <dt><i>branchName</i></dt>
114 <dd>
115 name of the branch (string)
116 </dd>
117 <dt><i>branchOp</i></dt>
118 <dd>
119 desired branch operation (integer)
120 </dd>
121 <dt><i>parent</i></dt>
122 <dd>
123 parent widget (QWidget)
124 </dd>
125 </dl>
126 <a NAME="GitBranchDialog.__updateOK" ID="GitBranchDialog.__updateOK"></a>
127 <h4>GitBranchDialog.__updateOK</h4>
128 <b>__updateOK</b>(<i></i>)
129
130 <p>
131 Private method used to enable/disable the OK-button.
132 </p>
133 <a NAME="GitBranchDialog.getParameters" ID="GitBranchDialog.getParameters"></a>
134 <h4>GitBranchDialog.getParameters</h4>
135 <b>getParameters</b>(<i></i>)
136
137 <p>
138 Public method to retrieve the branch data.
139 </p>
140 <dl>
141 <dt>Return:</dt>
142 <dd>
143 tuple of an int, four strings and a boolean
144 (branch operation, branch name, revision, new branch name,
145 remote branch name, enforce operation)
146 </dd>
147 </dl>
148 <a NAME="GitBranchDialog.on_branchCombo_editTextChanged" ID="GitBranchDialog.on_branchCombo_editTextChanged"></a>
149 <h4>GitBranchDialog.on_branchCombo_editTextChanged</h4>
150 <b>on_branchCombo_editTextChanged</b>(<i>text</i>)
151
152 <p>
153 Private slot to handle a change of the branch.
154 </p>
155 <dl>
156
157 <dt><i>text</i></dt>
158 <dd>
159 branch name entered in the combo (string)
160 </dd>
161 </dl>
162 <a NAME="GitBranchDialog.on_createTrackingButton_toggled" ID="GitBranchDialog.on_createTrackingButton_toggled"></a>
163 <h4>GitBranchDialog.on_createTrackingButton_toggled</h4>
164 <b>on_createTrackingButton_toggled</b>(<i>checked</i>)
165
166 <p>
167 Private slot to handle the selection of creating a tracking branch.
168 </p>
169 <dl>
170
171 <dt><i>checked</i></dt>
172 <dd>
173 state of the selection (boolean)
174 </dd>
175 </dl>
176 <a NAME="GitBranchDialog.on_newBranchNameEdit_textChanged" ID="GitBranchDialog.on_newBranchNameEdit_textChanged"></a>
177 <h4>GitBranchDialog.on_newBranchNameEdit_textChanged</h4>
178 <b>on_newBranchNameEdit_textChanged</b>(<i>text</i>)
179
180 <p>
181 Private slot to handle a change of the new branch.
182 </p>
183 <dl>
184
185 <dt><i>text</i></dt>
186 <dd>
187 new branch name entered (string)
188 </dd>
189 </dl>
190 <a NAME="GitBranchDialog.on_setTrackingButton_toggled" ID="GitBranchDialog.on_setTrackingButton_toggled"></a>
191 <h4>GitBranchDialog.on_setTrackingButton_toggled</h4>
192 <b>on_setTrackingButton_toggled</b>(<i>checked</i>)
193
194 <p>
195 Private slot to handle the selection of setting a tracking branch.
196 </p>
197 <dl>
198
199 <dt><i>checked</i></dt>
200 <dd>
201 state of the selection (boolean)
202 </dd>
203 </dl>
204 <a NAME="GitBranchDialog.on_unsetTrackingButton_toggled" ID="GitBranchDialog.on_unsetTrackingButton_toggled"></a>
205 <h4>GitBranchDialog.on_unsetTrackingButton_toggled</h4>
206 <b>on_unsetTrackingButton_toggled</b>(<i>checked</i>)
207
208 <p>
209 Private slot to handle the selection of unsetting 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 <div align="right"><a href="#top">Up</a></div>
219 <hr />
220 </body></html>

eric ide

mercurial