eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitBranchDialog.html

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

eric ide

mercurial