|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.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><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.StripExtension.HgStripDialog</h1> |
|
23 <p> |
|
24 Module implementing a dialog to enter the data to strip changesets. |
|
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="#HgStripDialog">HgStripDialog</a></td> |
|
34 <td>Class documentation goes here.</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="HgStripDialog" ID="HgStripDialog"></a> |
|
43 <h2>HgStripDialog</h2> |
|
44 <p> |
|
45 Class documentation goes here. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 QDialog, Ui_HgStripDialog |
|
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="#HgStripDialog.__init__">HgStripDialog</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#HgStripDialog.__getRevision">__getRevision</a></td> |
|
64 <td>Private method to generate the revision.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#HgStripDialog.__updateOK">__updateOK</a></td> |
|
67 <td>Private slot to update the OK button.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#HgStripDialog.getData">getData</a></td> |
|
70 <td>Public method to retrieve the data for the strip action.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#HgStripDialog.on_branchButton_toggled">on_branchButton_toggled</a></td> |
|
73 <td>Private slot to handle changes of the Branch select button.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#HgStripDialog.on_branchCombo_editTextChanged">on_branchCombo_editTextChanged</a></td> |
|
76 <td>Private slot to handle changes of the Branch combo.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#HgStripDialog.on_idButton_toggled">on_idButton_toggled</a></td> |
|
79 <td>Private slot to handle changes of the ID select button.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#HgStripDialog.on_idEdit_textChanged">on_idEdit_textChanged</a></td> |
|
82 <td>Private slot to handle changes of the ID edit.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#HgStripDialog.on_numberButton_toggled">on_numberButton_toggled</a></td> |
|
85 <td>Private slot to handle changes of the Number select button.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#HgStripDialog.on_numberSpinBox_valueChanged">on_numberSpinBox_valueChanged</a></td> |
|
88 <td>Private slot to handle changes of the Number spin box.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#HgStripDialog.on_tagButton_toggled">on_tagButton_toggled</a></td> |
|
91 <td>Private slot to handle changes of the Tag select button.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#HgStripDialog.on_tagCombo_editTextChanged">on_tagCombo_editTextChanged</a></td> |
|
94 <td>Private slot to handle changes of the Tag combo.</td> |
|
95 </tr> |
|
96 </table> |
|
97 <h3>Static Methods</h3> |
|
98 <table> |
|
99 <tr><td>None</td></tr> |
|
100 </table> |
|
101 <a NAME="HgStripDialog.__init__" ID="HgStripDialog.__init__"></a> |
|
102 <h4>HgStripDialog (Constructor)</h4> |
|
103 <b>HgStripDialog</b>(<i>tagsList, branchesList, bookmarksList=None, parent=None</i>) |
|
104 <p> |
|
105 Constructor |
|
106 </p><dl> |
|
107 <dt><i>tagsList</i></dt> |
|
108 <dd> |
|
109 list of tags (list of strings) |
|
110 </dd><dt><i>branchesList</i></dt> |
|
111 <dd> |
|
112 list of branches (list of strings) |
|
113 </dd><dt><i>bookmarksList</i></dt> |
|
114 <dd> |
|
115 list of bookmarks (list of strings) |
|
116 </dd><dt><i>parent</i></dt> |
|
117 <dd> |
|
118 reference to the parent widget (QWidget) |
|
119 </dd> |
|
120 </dl><a NAME="HgStripDialog.__getRevision" ID="HgStripDialog.__getRevision"></a> |
|
121 <h4>HgStripDialog.__getRevision</h4> |
|
122 <b>__getRevision</b>(<i></i>) |
|
123 <p> |
|
124 Private method to generate the revision. |
|
125 </p><dl> |
|
126 <dt>Returns:</dt> |
|
127 <dd> |
|
128 revision (string) |
|
129 </dd> |
|
130 </dl><a NAME="HgStripDialog.__updateOK" ID="HgStripDialog.__updateOK"></a> |
|
131 <h4>HgStripDialog.__updateOK</h4> |
|
132 <b>__updateOK</b>(<i></i>) |
|
133 <p> |
|
134 Private slot to update the OK button. |
|
135 </p><a NAME="HgStripDialog.getData" ID="HgStripDialog.getData"></a> |
|
136 <h4>HgStripDialog.getData</h4> |
|
137 <b>getData</b>(<i></i>) |
|
138 <p> |
|
139 Public method to retrieve the data for the strip action. |
|
140 </p><dl> |
|
141 <dt>Returns:</dt> |
|
142 <dd> |
|
143 tuple with the revision, a bookmark name, a flag indicating |
|
144 to enforce the strip action, a flag indicating to omit the creation |
|
145 of backup bundles and a flag indicating to not modify the working |
|
146 directory |
|
147 </dd> |
|
148 </dl><dl> |
|
149 <dt>Return Type:</dt> |
|
150 <dd> |
|
151 tuple (str, str, bool, bool, bool) |
|
152 </dd> |
|
153 </dl><a NAME="HgStripDialog.on_branchButton_toggled" ID="HgStripDialog.on_branchButton_toggled"></a> |
|
154 <h4>HgStripDialog.on_branchButton_toggled</h4> |
|
155 <b>on_branchButton_toggled</b>(<i>checked</i>) |
|
156 <p> |
|
157 Private slot to handle changes of the Branch select button. |
|
158 </p><dl> |
|
159 <dt><i>checked</i></dt> |
|
160 <dd> |
|
161 state of the button (boolean) |
|
162 </dd> |
|
163 </dl><a NAME="HgStripDialog.on_branchCombo_editTextChanged" ID="HgStripDialog.on_branchCombo_editTextChanged"></a> |
|
164 <h4>HgStripDialog.on_branchCombo_editTextChanged</h4> |
|
165 <b>on_branchCombo_editTextChanged</b>(<i>txt</i>) |
|
166 <p> |
|
167 Private slot to handle changes of the Branch combo. |
|
168 </p><dl> |
|
169 <dt><i>txt</i></dt> |
|
170 <dd> |
|
171 text of the combo (string) |
|
172 </dd> |
|
173 </dl><a NAME="HgStripDialog.on_idButton_toggled" ID="HgStripDialog.on_idButton_toggled"></a> |
|
174 <h4>HgStripDialog.on_idButton_toggled</h4> |
|
175 <b>on_idButton_toggled</b>(<i>checked</i>) |
|
176 <p> |
|
177 Private slot to handle changes of the ID select button. |
|
178 </p><dl> |
|
179 <dt><i>checked</i></dt> |
|
180 <dd> |
|
181 state of the button (boolean) |
|
182 </dd> |
|
183 </dl><a NAME="HgStripDialog.on_idEdit_textChanged" ID="HgStripDialog.on_idEdit_textChanged"></a> |
|
184 <h4>HgStripDialog.on_idEdit_textChanged</h4> |
|
185 <b>on_idEdit_textChanged</b>(<i>txt</i>) |
|
186 <p> |
|
187 Private slot to handle changes of the ID edit. |
|
188 </p><dl> |
|
189 <dt><i>txt</i></dt> |
|
190 <dd> |
|
191 text of the edit (string) |
|
192 </dd> |
|
193 </dl><a NAME="HgStripDialog.on_numberButton_toggled" ID="HgStripDialog.on_numberButton_toggled"></a> |
|
194 <h4>HgStripDialog.on_numberButton_toggled</h4> |
|
195 <b>on_numberButton_toggled</b>(<i>checked</i>) |
|
196 <p> |
|
197 Private slot to handle changes of the Number select button. |
|
198 </p><dl> |
|
199 <dt><i>checked</i></dt> |
|
200 <dd> |
|
201 state of the button (boolean) |
|
202 </dd> |
|
203 </dl><a NAME="HgStripDialog.on_numberSpinBox_valueChanged" ID="HgStripDialog.on_numberSpinBox_valueChanged"></a> |
|
204 <h4>HgStripDialog.on_numberSpinBox_valueChanged</h4> |
|
205 <b>on_numberSpinBox_valueChanged</b>(<i>val</i>) |
|
206 <p> |
|
207 Private slot to handle changes of the Number spin box. |
|
208 </p><dl> |
|
209 <dt><i>val</i> (int)</dt> |
|
210 <dd> |
|
211 value of the spin box |
|
212 </dd> |
|
213 </dl><a NAME="HgStripDialog.on_tagButton_toggled" ID="HgStripDialog.on_tagButton_toggled"></a> |
|
214 <h4>HgStripDialog.on_tagButton_toggled</h4> |
|
215 <b>on_tagButton_toggled</b>(<i>checked</i>) |
|
216 <p> |
|
217 Private slot to handle changes of the Tag select button. |
|
218 </p><dl> |
|
219 <dt><i>checked</i></dt> |
|
220 <dd> |
|
221 state of the button (boolean) |
|
222 </dd> |
|
223 </dl><a NAME="HgStripDialog.on_tagCombo_editTextChanged" ID="HgStripDialog.on_tagCombo_editTextChanged"></a> |
|
224 <h4>HgStripDialog.on_tagCombo_editTextChanged</h4> |
|
225 <b>on_tagCombo_editTextChanged</b>(<i>txt</i>) |
|
226 <p> |
|
227 Private slot to handle changes of the Tag combo. |
|
228 </p><dl> |
|
229 <dt><i>txt</i></dt> |
|
230 <dd> |
|
231 text of the combo (string) |
|
232 </dd> |
|
233 </dl> |
|
234 <div align="right"><a href="#top">Up</a></div> |
|
235 <hr /> |
|
236 </body></html> |