eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.StripExtension.HgStripDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.StripExtension.HgStripDialog</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.StripExtension.HgStripDialog</h1>
24
25 <p>
26 Module implementing a dialog to enter the data to strip changesets.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#HgStripDialog">HgStripDialog</a></td>
39 <td>Class implementing a dialog to enter the data to strip changesets.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="HgStripDialog" ID="HgStripDialog"></a>
50 <h2>HgStripDialog</h2>
51
52 <p>
53 Class implementing a dialog to enter the data to strip changesets.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_HgStripDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#HgStripDialog.__init__">HgStripDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#HgStripDialog.__getRevision">__getRevision</a></td>
77 <td>Private method to generate the revision.</td>
78 </tr>
79 <tr>
80 <td><a href="#HgStripDialog.__updateOK">__updateOK</a></td>
81 <td>Private slot to update the OK button.</td>
82 </tr>
83 <tr>
84 <td><a href="#HgStripDialog.getData">getData</a></td>
85 <td>Public method to retrieve the data for the strip action.</td>
86 </tr>
87 <tr>
88 <td><a href="#HgStripDialog.on_branchButton_toggled">on_branchButton_toggled</a></td>
89 <td>Private slot to handle changes of the Branch select button.</td>
90 </tr>
91 <tr>
92 <td><a href="#HgStripDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td>
93 <td>Private slot to handle changes of the Branch combo.</td>
94 </tr>
95 <tr>
96 <td><a href="#HgStripDialog.on_idButton_toggled">on_idButton_toggled</a></td>
97 <td>Private slot to handle changes of the ID select button.</td>
98 </tr>
99 <tr>
100 <td><a href="#HgStripDialog.on_idEdit_textChanged">on_idEdit_textChanged</a></td>
101 <td>Private slot to handle changes of the ID edit.</td>
102 </tr>
103 <tr>
104 <td><a href="#HgStripDialog.on_numberButton_toggled">on_numberButton_toggled</a></td>
105 <td>Private slot to handle changes of the Number select button.</td>
106 </tr>
107 <tr>
108 <td><a href="#HgStripDialog.on_numberSpinBox_valueChanged">on_numberSpinBox_valueChanged</a></td>
109 <td>Private slot to handle changes of the Number spin box.</td>
110 </tr>
111 <tr>
112 <td><a href="#HgStripDialog.on_tagButton_toggled">on_tagButton_toggled</a></td>
113 <td>Private slot to handle changes of the Tag select button.</td>
114 </tr>
115 <tr>
116 <td><a href="#HgStripDialog.on_tagCombo_editTextChanged">on_tagCombo_editTextChanged</a></td>
117 <td>Private slot to handle changes of the Tag combo.</td>
118 </tr>
119 </table>
120 <h3>Static Methods</h3>
121
122 <table>
123 <tr><td>None</td></tr>
124 </table>
125
126 <a NAME="HgStripDialog.__init__" ID="HgStripDialog.__init__"></a>
127 <h4>HgStripDialog (Constructor)</h4>
128 <b>HgStripDialog</b>(<i>tagsList, branchesList, bookmarksList=None, rev="", parent=None</i>)
129
130 <p>
131 Constructor
132 </p>
133 <dl>
134
135 <dt><i>tagsList</i> (list of str)</dt>
136 <dd>
137 list of tags
138 </dd>
139 <dt><i>branchesList</i> (list of str)</dt>
140 <dd>
141 list of branches
142 </dd>
143 <dt><i>bookmarksList</i> (list of str)</dt>
144 <dd>
145 list of bookmarks
146 </dd>
147 <dt><i>rev</i> (str)</dt>
148 <dd>
149 revision to strip from
150 </dd>
151 <dt><i>parent</i> (QWidget)</dt>
152 <dd>
153 reference to the parent widget
154 </dd>
155 </dl>
156 <a NAME="HgStripDialog.__getRevision" ID="HgStripDialog.__getRevision"></a>
157 <h4>HgStripDialog.__getRevision</h4>
158 <b>__getRevision</b>(<i></i>)
159
160 <p>
161 Private method to generate the revision.
162 </p>
163 <dl>
164 <dt>Return:</dt>
165 <dd>
166 revision
167 </dd>
168 </dl>
169 <dl>
170 <dt>Return Type:</dt>
171 <dd>
172 str
173 </dd>
174 </dl>
175 <a NAME="HgStripDialog.__updateOK" ID="HgStripDialog.__updateOK"></a>
176 <h4>HgStripDialog.__updateOK</h4>
177 <b>__updateOK</b>(<i></i>)
178
179 <p>
180 Private slot to update the OK button.
181 </p>
182 <a NAME="HgStripDialog.getData" ID="HgStripDialog.getData"></a>
183 <h4>HgStripDialog.getData</h4>
184 <b>getData</b>(<i></i>)
185
186 <p>
187 Public method to retrieve the data for the strip action.
188 </p>
189 <dl>
190 <dt>Return:</dt>
191 <dd>
192 tuple with the revision, a bookmark name, a flag indicating
193 to enforce the strip action, a flag indicating to omit the creation
194 of backup bundles and a flag indicating to not modify the working
195 directory
196 </dd>
197 </dl>
198 <dl>
199 <dt>Return Type:</dt>
200 <dd>
201 tuple (str, str, bool, bool, bool)
202 </dd>
203 </dl>
204 <a NAME="HgStripDialog.on_branchButton_toggled" ID="HgStripDialog.on_branchButton_toggled"></a>
205 <h4>HgStripDialog.on_branchButton_toggled</h4>
206 <b>on_branchButton_toggled</b>(<i>checked</i>)
207
208 <p>
209 Private slot to handle changes of the Branch select button.
210 </p>
211 <dl>
212
213 <dt><i>checked</i> (bool)</dt>
214 <dd>
215 state of the button
216 </dd>
217 </dl>
218 <a NAME="HgStripDialog.on_branchCombo_editTextChanged" ID="HgStripDialog.on_branchCombo_editTextChanged"></a>
219 <h4>HgStripDialog.on_branchCombo_editTextChanged</h4>
220 <b>on_branchCombo_editTextChanged</b>(<i>txt</i>)
221
222 <p>
223 Private slot to handle changes of the Branch combo.
224 </p>
225 <dl>
226
227 <dt><i>txt</i> (str)</dt>
228 <dd>
229 text of the combo
230 </dd>
231 </dl>
232 <a NAME="HgStripDialog.on_idButton_toggled" ID="HgStripDialog.on_idButton_toggled"></a>
233 <h4>HgStripDialog.on_idButton_toggled</h4>
234 <b>on_idButton_toggled</b>(<i>checked</i>)
235
236 <p>
237 Private slot to handle changes of the ID select button.
238 </p>
239 <dl>
240
241 <dt><i>checked</i> (bool)</dt>
242 <dd>
243 state of the button
244 </dd>
245 </dl>
246 <a NAME="HgStripDialog.on_idEdit_textChanged" ID="HgStripDialog.on_idEdit_textChanged"></a>
247 <h4>HgStripDialog.on_idEdit_textChanged</h4>
248 <b>on_idEdit_textChanged</b>(<i>txt</i>)
249
250 <p>
251 Private slot to handle changes of the ID edit.
252 </p>
253 <dl>
254
255 <dt><i>txt</i> (str)</dt>
256 <dd>
257 text of the edit
258 </dd>
259 </dl>
260 <a NAME="HgStripDialog.on_numberButton_toggled" ID="HgStripDialog.on_numberButton_toggled"></a>
261 <h4>HgStripDialog.on_numberButton_toggled</h4>
262 <b>on_numberButton_toggled</b>(<i>checked</i>)
263
264 <p>
265 Private slot to handle changes of the Number select button.
266 </p>
267 <dl>
268
269 <dt><i>checked</i> (bool)</dt>
270 <dd>
271 state of the button
272 </dd>
273 </dl>
274 <a NAME="HgStripDialog.on_numberSpinBox_valueChanged" ID="HgStripDialog.on_numberSpinBox_valueChanged"></a>
275 <h4>HgStripDialog.on_numberSpinBox_valueChanged</h4>
276 <b>on_numberSpinBox_valueChanged</b>(<i>val</i>)
277
278 <p>
279 Private slot to handle changes of the Number spin box.
280 </p>
281 <dl>
282
283 <dt><i>val</i> (int)</dt>
284 <dd>
285 value of the spin box
286 </dd>
287 </dl>
288 <a NAME="HgStripDialog.on_tagButton_toggled" ID="HgStripDialog.on_tagButton_toggled"></a>
289 <h4>HgStripDialog.on_tagButton_toggled</h4>
290 <b>on_tagButton_toggled</b>(<i>checked</i>)
291
292 <p>
293 Private slot to handle changes of the Tag select button.
294 </p>
295 <dl>
296
297 <dt><i>checked</i> (bool)</dt>
298 <dd>
299 state of the button
300 </dd>
301 </dl>
302 <a NAME="HgStripDialog.on_tagCombo_editTextChanged" ID="HgStripDialog.on_tagCombo_editTextChanged"></a>
303 <h4>HgStripDialog.on_tagCombo_editTextChanged</h4>
304 <b>on_tagCombo_editTextChanged</b>(<i>txt</i>)
305
306 <p>
307 Private slot to handle changes of the Tag combo.
308 </p>
309 <dl>
310
311 <dt><i>txt</i> (str)</dt>
312 <dd>
313 text of the combo
314 </dd>
315 </dl>
316 <div align="right"><a href="#top">Up</a></div>
317 <hr />
318 </body></html>

eric ide

mercurial