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

changeset 6020
baf6da1ae288
equal deleted inserted replaced
6019:58ecdaf0b789 6020:baf6da1ae288
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsGit.GitRevisionSelectionDialog</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.GitRevisionSelectionDialog</h1>
23 <p>
24 Module implementing a dialog to select a revision.
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="#GitRevisionSelectionDialog">GitRevisionSelectionDialog</a></td>
34 <td>Class implementing a dialog to select a revision.</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="GitRevisionSelectionDialog" ID="GitRevisionSelectionDialog"></a>
43 <h2>GitRevisionSelectionDialog</h2>
44 <p>
45 Class implementing a dialog to select a revision.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_GitRevisionSelectionDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</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="#GitRevisionSelectionDialog.__init__">GitRevisionSelectionDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#GitRevisionSelectionDialog.__updateOK">__updateOK</a></td>
64 <td>Private slot to update the OK button.</td>
65 </tr><tr>
66 <td><a href="#GitRevisionSelectionDialog.getRevision">getRevision</a></td>
67 <td>Public method to retrieve the selected revision.</td>
68 </tr><tr>
69 <td><a href="#GitRevisionSelectionDialog.on_branchButton_toggled">on_branchButton_toggled</a></td>
70 <td>Private slot to handle changes of the Branch select button.</td>
71 </tr><tr>
72 <td><a href="#GitRevisionSelectionDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td>
73 <td>Private slot to handle changes of the Branch combo.</td>
74 </tr><tr>
75 <td><a href="#GitRevisionSelectionDialog.on_remoteBranchButton_toggled">on_remoteBranchButton_toggled</a></td>
76 <td>Private slot to handle changes of the Remote Branch select button.</td>
77 </tr><tr>
78 <td><a href="#GitRevisionSelectionDialog.on_remoteBranchCombo_editTextChanged">on_remoteBranchCombo_editTextChanged</a></td>
79 <td>Private slot to handle changes of the Remote Branch combo.</td>
80 </tr><tr>
81 <td><a href="#GitRevisionSelectionDialog.on_revButton_toggled">on_revButton_toggled</a></td>
82 <td>Private slot to handle changes of the rev select button.</td>
83 </tr><tr>
84 <td><a href="#GitRevisionSelectionDialog.on_revEdit_textChanged">on_revEdit_textChanged</a></td>
85 <td>Private slot to handle changes of the rev edit.</td>
86 </tr><tr>
87 <td><a href="#GitRevisionSelectionDialog.on_tagButton_toggled">on_tagButton_toggled</a></td>
88 <td>Private slot to handle changes of the Tag select button.</td>
89 </tr><tr>
90 <td><a href="#GitRevisionSelectionDialog.on_tagCombo_editTextChanged">on_tagCombo_editTextChanged</a></td>
91 <td>Private slot to handle changes of the Tag combo.</td>
92 </tr>
93 </table>
94 <h3>Static Methods</h3>
95 <table>
96 <tr><td>None</td></tr>
97 </table>
98 <a NAME="GitRevisionSelectionDialog.__init__" ID="GitRevisionSelectionDialog.__init__"></a>
99 <h4>GitRevisionSelectionDialog (Constructor)</h4>
100 <b>GitRevisionSelectionDialog</b>(<i>tagsList, branchesList, trackingBranchesList=None, noneLabel="", showBranches=True, showHead=True, parent=None</i>)
101 <p>
102 Constructor
103 </p><dl>
104 <dt><i>tagsList</i></dt>
105 <dd>
106 list of tags (list of strings)
107 </dd><dt><i>branchesList</i></dt>
108 <dd>
109 list of branches (list of strings)
110 </dd><dt><i>trackingBranchesList</i></dt>
111 <dd>
112 list of remote branches (list of strings)
113 </dd><dt><i>noneLabel</i></dt>
114 <dd>
115 label text for "no revision selected" (string)
116 </dd><dt><i>showBranches</i></dt>
117 <dd>
118 flag indicating to show the branch selection
119 (boolean)
120 </dd><dt><i>showHead</i></dt>
121 <dd>
122 flag indicating to show the head selection (boolean)
123 </dd><dt><i>parent</i></dt>
124 <dd>
125 parent widget (QWidget)
126 </dd>
127 </dl><a NAME="GitRevisionSelectionDialog.__updateOK" ID="GitRevisionSelectionDialog.__updateOK"></a>
128 <h4>GitRevisionSelectionDialog.__updateOK</h4>
129 <b>__updateOK</b>(<i></i>)
130 <p>
131 Private slot to update the OK button.
132 </p><a NAME="GitRevisionSelectionDialog.getRevision" ID="GitRevisionSelectionDialog.getRevision"></a>
133 <h4>GitRevisionSelectionDialog.getRevision</h4>
134 <b>getRevision</b>(<i></i>)
135 <p>
136 Public method to retrieve the selected revision.
137 </p><dl>
138 <dt>Returns:</dt>
139 <dd>
140 selected revision (string)
141 </dd>
142 </dl><a NAME="GitRevisionSelectionDialog.on_branchButton_toggled" ID="GitRevisionSelectionDialog.on_branchButton_toggled"></a>
143 <h4>GitRevisionSelectionDialog.on_branchButton_toggled</h4>
144 <b>on_branchButton_toggled</b>(<i>checked</i>)
145 <p>
146 Private slot to handle changes of the Branch select button.
147 </p><dl>
148 <dt><i>checked</i></dt>
149 <dd>
150 state of the button (boolean)
151 </dd>
152 </dl><a NAME="GitRevisionSelectionDialog.on_branchCombo_editTextChanged" ID="GitRevisionSelectionDialog.on_branchCombo_editTextChanged"></a>
153 <h4>GitRevisionSelectionDialog.on_branchCombo_editTextChanged</h4>
154 <b>on_branchCombo_editTextChanged</b>(<i>txt</i>)
155 <p>
156 Private slot to handle changes of the Branch combo.
157 </p><dl>
158 <dt><i>txt</i></dt>
159 <dd>
160 text of the combo (string)
161 </dd>
162 </dl><a NAME="GitRevisionSelectionDialog.on_remoteBranchButton_toggled" ID="GitRevisionSelectionDialog.on_remoteBranchButton_toggled"></a>
163 <h4>GitRevisionSelectionDialog.on_remoteBranchButton_toggled</h4>
164 <b>on_remoteBranchButton_toggled</b>(<i>checked</i>)
165 <p>
166 Private slot to handle changes of the Remote Branch select button.
167 </p><dl>
168 <dt><i>checked</i></dt>
169 <dd>
170 state of the button (boolean)
171 </dd>
172 </dl><a NAME="GitRevisionSelectionDialog.on_remoteBranchCombo_editTextChanged" ID="GitRevisionSelectionDialog.on_remoteBranchCombo_editTextChanged"></a>
173 <h4>GitRevisionSelectionDialog.on_remoteBranchCombo_editTextChanged</h4>
174 <b>on_remoteBranchCombo_editTextChanged</b>(<i>txt</i>)
175 <p>
176 Private slot to handle changes of the Remote Branch combo.
177 </p><dl>
178 <dt><i>txt</i></dt>
179 <dd>
180 text of the combo (string)
181 </dd>
182 </dl><a NAME="GitRevisionSelectionDialog.on_revButton_toggled" ID="GitRevisionSelectionDialog.on_revButton_toggled"></a>
183 <h4>GitRevisionSelectionDialog.on_revButton_toggled</h4>
184 <b>on_revButton_toggled</b>(<i>checked</i>)
185 <p>
186 Private slot to handle changes of the rev select button.
187 </p><dl>
188 <dt><i>checked</i></dt>
189 <dd>
190 state of the button (boolean)
191 </dd>
192 </dl><a NAME="GitRevisionSelectionDialog.on_revEdit_textChanged" ID="GitRevisionSelectionDialog.on_revEdit_textChanged"></a>
193 <h4>GitRevisionSelectionDialog.on_revEdit_textChanged</h4>
194 <b>on_revEdit_textChanged</b>(<i>txt</i>)
195 <p>
196 Private slot to handle changes of the rev edit.
197 </p><dl>
198 <dt><i>txt</i></dt>
199 <dd>
200 text of the edit (string)
201 </dd>
202 </dl><a NAME="GitRevisionSelectionDialog.on_tagButton_toggled" ID="GitRevisionSelectionDialog.on_tagButton_toggled"></a>
203 <h4>GitRevisionSelectionDialog.on_tagButton_toggled</h4>
204 <b>on_tagButton_toggled</b>(<i>checked</i>)
205 <p>
206 Private slot to handle changes of the Tag select button.
207 </p><dl>
208 <dt><i>checked</i></dt>
209 <dd>
210 state of the button (boolean)
211 </dd>
212 </dl><a NAME="GitRevisionSelectionDialog.on_tagCombo_editTextChanged" ID="GitRevisionSelectionDialog.on_tagCombo_editTextChanged"></a>
213 <h4>GitRevisionSelectionDialog.on_tagCombo_editTextChanged</h4>
214 <b>on_tagCombo_editTextChanged</b>(<i>txt</i>)
215 <p>
216 Private slot to handle changes of the Tag combo.
217 </p><dl>
218 <dt><i>txt</i></dt>
219 <dd>
220 text of the combo (string)
221 </dd>
222 </dl>
223 <div align="right"><a href="#top">Up</a></div>
224 <hr />
225 </body></html>

eric ide

mercurial