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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9236
db53a9efe7ef
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitRevisionSelectionDialog</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.GitRevisionSelectionDialog</h1>
10
11 <p>
12 Module implementing a dialog to select a revision.
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="#GitRevisionSelectionDialog">GitRevisionSelectionDialog</a></td>
25 <td>Class implementing a dialog to select a revision.</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="GitRevisionSelectionDialog" ID="GitRevisionSelectionDialog"></a>
36 <h2>GitRevisionSelectionDialog</h2>
37
38 <p>
39 Class implementing a dialog to select a revision.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_GitRevisionSelectionDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</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="#GitRevisionSelectionDialog.__init__">GitRevisionSelectionDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#GitRevisionSelectionDialog.__updateOK">__updateOK</a></td>
63 <td>Private slot to update the OK button.</td>
64 </tr>
65 <tr>
66 <td><a href="#GitRevisionSelectionDialog.getRevision">getRevision</a></td>
67 <td>Public method to retrieve the selected revision.</td>
68 </tr>
69 <tr>
70 <td><a href="#GitRevisionSelectionDialog.on_branchButton_toggled">on_branchButton_toggled</a></td>
71 <td>Private slot to handle changes of the Branch select button.</td>
72 </tr>
73 <tr>
74 <td><a href="#GitRevisionSelectionDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td>
75 <td>Private slot to handle changes of the Branch combo.</td>
76 </tr>
77 <tr>
78 <td><a href="#GitRevisionSelectionDialog.on_remoteBranchButton_toggled">on_remoteBranchButton_toggled</a></td>
79 <td>Private slot to handle changes of the Remote Branch select button.</td>
80 </tr>
81 <tr>
82 <td><a href="#GitRevisionSelectionDialog.on_remoteBranchCombo_editTextChanged">on_remoteBranchCombo_editTextChanged</a></td>
83 <td>Private slot to handle changes of the Remote Branch combo.</td>
84 </tr>
85 <tr>
86 <td><a href="#GitRevisionSelectionDialog.on_revButton_toggled">on_revButton_toggled</a></td>
87 <td>Private slot to handle changes of the rev select button.</td>
88 </tr>
89 <tr>
90 <td><a href="#GitRevisionSelectionDialog.on_revEdit_textChanged">on_revEdit_textChanged</a></td>
91 <td>Private slot to handle changes of the rev edit.</td>
92 </tr>
93 <tr>
94 <td><a href="#GitRevisionSelectionDialog.on_tagButton_toggled">on_tagButton_toggled</a></td>
95 <td>Private slot to handle changes of the Tag select button.</td>
96 </tr>
97 <tr>
98 <td><a href="#GitRevisionSelectionDialog.on_tagCombo_editTextChanged">on_tagCombo_editTextChanged</a></td>
99 <td>Private slot to handle changes of the Tag combo.</td>
100 </tr>
101 </table>
102 <h3>Static Methods</h3>
103
104 <table>
105 <tr><td>None</td></tr>
106 </table>
107
108 <a NAME="GitRevisionSelectionDialog.__init__" ID="GitRevisionSelectionDialog.__init__"></a>
109 <h4>GitRevisionSelectionDialog (Constructor)</h4>
110 <b>GitRevisionSelectionDialog</b>(<i>tagsList, branchesList, trackingBranchesList=None, noneLabel="", showBranches=True, showHead=True, parent=None</i>)
111
112 <p>
113 Constructor
114 </p>
115 <dl>
116
117 <dt><i>tagsList</i></dt>
118 <dd>
119 list of tags (list of strings)
120 </dd>
121 <dt><i>branchesList</i></dt>
122 <dd>
123 list of branches (list of strings)
124 </dd>
125 <dt><i>trackingBranchesList</i></dt>
126 <dd>
127 list of remote branches (list of strings)
128 </dd>
129 <dt><i>noneLabel</i></dt>
130 <dd>
131 label text for "no revision selected" (string)
132 </dd>
133 <dt><i>showBranches</i></dt>
134 <dd>
135 flag indicating to show the branch selection
136 (boolean)
137 </dd>
138 <dt><i>showHead</i></dt>
139 <dd>
140 flag indicating to show the head selection (boolean)
141 </dd>
142 <dt><i>parent</i></dt>
143 <dd>
144 parent widget (QWidget)
145 </dd>
146 </dl>
147 <a NAME="GitRevisionSelectionDialog.__updateOK" ID="GitRevisionSelectionDialog.__updateOK"></a>
148 <h4>GitRevisionSelectionDialog.__updateOK</h4>
149 <b>__updateOK</b>(<i></i>)
150
151 <p>
152 Private slot to update the OK button.
153 </p>
154 <a NAME="GitRevisionSelectionDialog.getRevision" ID="GitRevisionSelectionDialog.getRevision"></a>
155 <h4>GitRevisionSelectionDialog.getRevision</h4>
156 <b>getRevision</b>(<i></i>)
157
158 <p>
159 Public method to retrieve the selected revision.
160 </p>
161 <dl>
162 <dt>Return:</dt>
163 <dd>
164 selected revision (string)
165 </dd>
166 </dl>
167 <a NAME="GitRevisionSelectionDialog.on_branchButton_toggled" ID="GitRevisionSelectionDialog.on_branchButton_toggled"></a>
168 <h4>GitRevisionSelectionDialog.on_branchButton_toggled</h4>
169 <b>on_branchButton_toggled</b>(<i>checked</i>)
170
171 <p>
172 Private slot to handle changes of the Branch select button.
173 </p>
174 <dl>
175
176 <dt><i>checked</i></dt>
177 <dd>
178 state of the button (boolean)
179 </dd>
180 </dl>
181 <a NAME="GitRevisionSelectionDialog.on_branchCombo_editTextChanged" ID="GitRevisionSelectionDialog.on_branchCombo_editTextChanged"></a>
182 <h4>GitRevisionSelectionDialog.on_branchCombo_editTextChanged</h4>
183 <b>on_branchCombo_editTextChanged</b>(<i>txt</i>)
184
185 <p>
186 Private slot to handle changes of the Branch combo.
187 </p>
188 <dl>
189
190 <dt><i>txt</i></dt>
191 <dd>
192 text of the combo (string)
193 </dd>
194 </dl>
195 <a NAME="GitRevisionSelectionDialog.on_remoteBranchButton_toggled" ID="GitRevisionSelectionDialog.on_remoteBranchButton_toggled"></a>
196 <h4>GitRevisionSelectionDialog.on_remoteBranchButton_toggled</h4>
197 <b>on_remoteBranchButton_toggled</b>(<i>checked</i>)
198
199 <p>
200 Private slot to handle changes of the Remote Branch select button.
201 </p>
202 <dl>
203
204 <dt><i>checked</i></dt>
205 <dd>
206 state of the button (boolean)
207 </dd>
208 </dl>
209 <a NAME="GitRevisionSelectionDialog.on_remoteBranchCombo_editTextChanged" ID="GitRevisionSelectionDialog.on_remoteBranchCombo_editTextChanged"></a>
210 <h4>GitRevisionSelectionDialog.on_remoteBranchCombo_editTextChanged</h4>
211 <b>on_remoteBranchCombo_editTextChanged</b>(<i>txt</i>)
212
213 <p>
214 Private slot to handle changes of the Remote Branch combo.
215 </p>
216 <dl>
217
218 <dt><i>txt</i></dt>
219 <dd>
220 text of the combo (string)
221 </dd>
222 </dl>
223 <a NAME="GitRevisionSelectionDialog.on_revButton_toggled" ID="GitRevisionSelectionDialog.on_revButton_toggled"></a>
224 <h4>GitRevisionSelectionDialog.on_revButton_toggled</h4>
225 <b>on_revButton_toggled</b>(<i>checked</i>)
226
227 <p>
228 Private slot to handle changes of the rev select button.
229 </p>
230 <dl>
231
232 <dt><i>checked</i></dt>
233 <dd>
234 state of the button (boolean)
235 </dd>
236 </dl>
237 <a NAME="GitRevisionSelectionDialog.on_revEdit_textChanged" ID="GitRevisionSelectionDialog.on_revEdit_textChanged"></a>
238 <h4>GitRevisionSelectionDialog.on_revEdit_textChanged</h4>
239 <b>on_revEdit_textChanged</b>(<i>txt</i>)
240
241 <p>
242 Private slot to handle changes of the rev edit.
243 </p>
244 <dl>
245
246 <dt><i>txt</i></dt>
247 <dd>
248 text of the edit (string)
249 </dd>
250 </dl>
251 <a NAME="GitRevisionSelectionDialog.on_tagButton_toggled" ID="GitRevisionSelectionDialog.on_tagButton_toggled"></a>
252 <h4>GitRevisionSelectionDialog.on_tagButton_toggled</h4>
253 <b>on_tagButton_toggled</b>(<i>checked</i>)
254
255 <p>
256 Private slot to handle changes of the Tag select button.
257 </p>
258 <dl>
259
260 <dt><i>checked</i></dt>
261 <dd>
262 state of the button (boolean)
263 </dd>
264 </dl>
265 <a NAME="GitRevisionSelectionDialog.on_tagCombo_editTextChanged" ID="GitRevisionSelectionDialog.on_tagCombo_editTextChanged"></a>
266 <h4>GitRevisionSelectionDialog.on_tagCombo_editTextChanged</h4>
267 <b>on_tagCombo_editTextChanged</b>(<i>txt</i>)
268
269 <p>
270 Private slot to handle changes of the Tag combo.
271 </p>
272 <dl>
273
274 <dt><i>txt</i></dt>
275 <dd>
276 text of the combo (string)
277 </dd>
278 </dl>
279 <div align="right"><a href="#top">Up</a></div>
280 <hr />
281 </body></html>

eric ide

mercurial