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

changeset 6020
baf6da1ae288
equal deleted inserted replaced
6019:58ecdaf0b789 6020:baf6da1ae288
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitBranchDialog</h1>
23 <p>
24 Module implementing a dialog to enter the data for a branching operation.
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="#GitBranchDialog">GitBranchDialog</a></td>
34 <td>Class implementing a dialog to enter the data for a branching operation.</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="GitBranchDialog" ID="GitBranchDialog"></a>
43 <h2>GitBranchDialog</h2>
44 <p>
45 Class implementing a dialog to enter the data for a branching operation.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_GitBranchDialog
49 <h3>Class Attributes</h3>
50 <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>
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="#GitBranchDialog.__init__">GitBranchDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#GitBranchDialog.__updateOK">__updateOK</a></td>
64 <td>Private method used to enable/disable the OK-button.</td>
65 </tr><tr>
66 <td><a href="#GitBranchDialog.getParameters">getParameters</a></td>
67 <td>Public method to retrieve the branch data.</td>
68 </tr><tr>
69 <td><a href="#GitBranchDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td>
70 <td>Private slot to handle a change of the branch.</td>
71 </tr><tr>
72 <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>
74 </tr><tr>
75 <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>
77 </tr><tr>
78 <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>
80 </tr><tr>
81 <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>
83 </tr>
84 </table>
85 <h3>Static Methods</h3>
86 <table>
87 <tr><td>None</td></tr>
88 </table>
89 <a NAME="GitBranchDialog.__init__" ID="GitBranchDialog.__init__"></a>
90 <h4>GitBranchDialog (Constructor)</h4>
91 <b>GitBranchDialog</b>(<i>branchlist, revision=None, branchName=None, branchOp=None, parent=None</i>)
92 <p>
93 Constructor
94 </p><dl>
95 <dt><i>branchlist</i></dt>
96 <dd>
97 list of previously entered branches (list of strings)
98 </dd><dt><i>revision</i></dt>
99 <dd>
100 revision to set tag for (string)
101 </dd><dt><i>branchName</i></dt>
102 <dd>
103 name of the branch (string)
104 </dd><dt><i>branchOp</i></dt>
105 <dd>
106 desired branch operation (integer)
107 </dd><dt><i>parent</i></dt>
108 <dd>
109 parent widget (QWidget)
110 </dd>
111 </dl><a NAME="GitBranchDialog.__updateOK" ID="GitBranchDialog.__updateOK"></a>
112 <h4>GitBranchDialog.__updateOK</h4>
113 <b>__updateOK</b>(<i></i>)
114 <p>
115 Private method used to enable/disable the OK-button.
116 </p><a NAME="GitBranchDialog.getParameters" ID="GitBranchDialog.getParameters"></a>
117 <h4>GitBranchDialog.getParameters</h4>
118 <b>getParameters</b>(<i></i>)
119 <p>
120 Public method to retrieve the branch data.
121 </p><dl>
122 <dt>Returns:</dt>
123 <dd>
124 tuple of an int, four strings and a boolean
125 (branch operation, branch name, revision, new branch name,
126 remote branch name, enforce operation)
127 </dd>
128 </dl><a NAME="GitBranchDialog.on_branchCombo_editTextChanged" ID="GitBranchDialog.on_branchCombo_editTextChanged"></a>
129 <h4>GitBranchDialog.on_branchCombo_editTextChanged</h4>
130 <b>on_branchCombo_editTextChanged</b>(<i>text</i>)
131 <p>
132 Private slot to handle a change of the branch.
133 </p><dl>
134 <dt><i>text</i></dt>
135 <dd>
136 branch name entered in the combo (string)
137 </dd>
138 </dl><a NAME="GitBranchDialog.on_createTrackingButton_toggled" ID="GitBranchDialog.on_createTrackingButton_toggled"></a>
139 <h4>GitBranchDialog.on_createTrackingButton_toggled</h4>
140 <b>on_createTrackingButton_toggled</b>(<i>checked</i>)
141 <p>
142 Private slot to handle the selection of creating a tracking branch.
143 </p><dl>
144 <dt><i>checked</i></dt>
145 <dd>
146 state of the selection (boolean)
147 </dd>
148 </dl><a NAME="GitBranchDialog.on_newBranchNameEdit_textChanged" ID="GitBranchDialog.on_newBranchNameEdit_textChanged"></a>
149 <h4>GitBranchDialog.on_newBranchNameEdit_textChanged</h4>
150 <b>on_newBranchNameEdit_textChanged</b>(<i>text</i>)
151 <p>
152 Private slot to handle a change of the new branch.
153 </p><dl>
154 <dt><i>text</i></dt>
155 <dd>
156 new branch name entered (string)
157 </dd>
158 </dl><a NAME="GitBranchDialog.on_setTrackingButton_toggled" ID="GitBranchDialog.on_setTrackingButton_toggled"></a>
159 <h4>GitBranchDialog.on_setTrackingButton_toggled</h4>
160 <b>on_setTrackingButton_toggled</b>(<i>checked</i>)
161 <p>
162 Private slot to handle the selection of setting a tracking branch.
163 </p><dl>
164 <dt><i>checked</i></dt>
165 <dd>
166 state of the selection (boolean)
167 </dd>
168 </dl><a NAME="GitBranchDialog.on_unsetTrackingButton_toggled" ID="GitBranchDialog.on_unsetTrackingButton_toggled"></a>
169 <h4>GitBranchDialog.on_unsetTrackingButton_toggled</h4>
170 <b>on_unsetTrackingButton_toggled</b>(<i>checked</i>)
171 <p>
172 Private slot to handle the selection of unsetting a tracking branch.
173 </p><dl>
174 <dt><i>checked</i></dt>
175 <dd>
176 state of the selection (boolean)
177 </dd>
178 </dl>
179 <div align="right"><a href="#top">Up</a></div>
180 <hr />
181 </body></html>

eric ide

mercurial