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

changeset 6942
2602857055c5
parent 6047
39586a2de99d
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
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 implementing a dialog to enter the data to strip changesets.</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 implementing a dialog to enter the data to strip changesets.
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, rev="", parent=None</i>)
104 <p>
105 Constructor
106 </p><dl>
107 <dt><i>tagsList</i> (list of str)</dt>
108 <dd>
109 list of tags
110 </dd><dt><i>branchesList</i> (list of str)</dt>
111 <dd>
112 list of branches
113 </dd><dt><i>bookmarksList</i> (list of str)</dt>
114 <dd>
115 list of bookmarks
116 </dd><dt><i>rev=</i> (str)</dt>
117 <dd>
118 revision to strip from
119 </dd><dt><i>parent</i> (QWidget)</dt>
120 <dd>
121 reference to the parent widget
122 </dd>
123 </dl><a NAME="HgStripDialog.__getRevision" ID="HgStripDialog.__getRevision"></a>
124 <h4>HgStripDialog.__getRevision</h4>
125 <b>__getRevision</b>(<i></i>)
126 <p>
127 Private method to generate the revision.
128 </p><dl>
129 <dt>Returns:</dt>
130 <dd>
131 revision
132 </dd>
133 </dl><dl>
134 <dt>Return Type:</dt>
135 <dd>
136 str
137 </dd>
138 </dl><a NAME="HgStripDialog.__updateOK" ID="HgStripDialog.__updateOK"></a>
139 <h4>HgStripDialog.__updateOK</h4>
140 <b>__updateOK</b>(<i></i>)
141 <p>
142 Private slot to update the OK button.
143 </p><a NAME="HgStripDialog.getData" ID="HgStripDialog.getData"></a>
144 <h4>HgStripDialog.getData</h4>
145 <b>getData</b>(<i></i>)
146 <p>
147 Public method to retrieve the data for the strip action.
148 </p><dl>
149 <dt>Returns:</dt>
150 <dd>
151 tuple with the revision, a bookmark name, a flag indicating
152 to enforce the strip action, a flag indicating to omit the creation
153 of backup bundles and a flag indicating to not modify the working
154 directory
155 </dd>
156 </dl><dl>
157 <dt>Return Type:</dt>
158 <dd>
159 tuple (str, str, bool, bool, bool)
160 </dd>
161 </dl><a NAME="HgStripDialog.on_branchButton_toggled" ID="HgStripDialog.on_branchButton_toggled"></a>
162 <h4>HgStripDialog.on_branchButton_toggled</h4>
163 <b>on_branchButton_toggled</b>(<i>checked</i>)
164 <p>
165 Private slot to handle changes of the Branch select button.
166 </p><dl>
167 <dt><i>checked</i> (bool)</dt>
168 <dd>
169 state of the button
170 </dd>
171 </dl><a NAME="HgStripDialog.on_branchCombo_editTextChanged" ID="HgStripDialog.on_branchCombo_editTextChanged"></a>
172 <h4>HgStripDialog.on_branchCombo_editTextChanged</h4>
173 <b>on_branchCombo_editTextChanged</b>(<i>txt</i>)
174 <p>
175 Private slot to handle changes of the Branch combo.
176 </p><dl>
177 <dt><i>txt</i> (str)</dt>
178 <dd>
179 text of the combo
180 </dd>
181 </dl><a NAME="HgStripDialog.on_idButton_toggled" ID="HgStripDialog.on_idButton_toggled"></a>
182 <h4>HgStripDialog.on_idButton_toggled</h4>
183 <b>on_idButton_toggled</b>(<i>checked</i>)
184 <p>
185 Private slot to handle changes of the ID select button.
186 </p><dl>
187 <dt><i>checked</i> (bool)</dt>
188 <dd>
189 state of the button
190 </dd>
191 </dl><a NAME="HgStripDialog.on_idEdit_textChanged" ID="HgStripDialog.on_idEdit_textChanged"></a>
192 <h4>HgStripDialog.on_idEdit_textChanged</h4>
193 <b>on_idEdit_textChanged</b>(<i>txt</i>)
194 <p>
195 Private slot to handle changes of the ID edit.
196 </p><dl>
197 <dt><i>txt</i> (str)</dt>
198 <dd>
199 text of the edit
200 </dd>
201 </dl><a NAME="HgStripDialog.on_numberButton_toggled" ID="HgStripDialog.on_numberButton_toggled"></a>
202 <h4>HgStripDialog.on_numberButton_toggled</h4>
203 <b>on_numberButton_toggled</b>(<i>checked</i>)
204 <p>
205 Private slot to handle changes of the Number select button.
206 </p><dl>
207 <dt><i>checked</i> (bool)</dt>
208 <dd>
209 state of the button
210 </dd>
211 </dl><a NAME="HgStripDialog.on_numberSpinBox_valueChanged" ID="HgStripDialog.on_numberSpinBox_valueChanged"></a>
212 <h4>HgStripDialog.on_numberSpinBox_valueChanged</h4>
213 <b>on_numberSpinBox_valueChanged</b>(<i>val</i>)
214 <p>
215 Private slot to handle changes of the Number spin box.
216 </p><dl>
217 <dt><i>val</i> (int)</dt>
218 <dd>
219 value of the spin box
220 </dd>
221 </dl><a NAME="HgStripDialog.on_tagButton_toggled" ID="HgStripDialog.on_tagButton_toggled"></a>
222 <h4>HgStripDialog.on_tagButton_toggled</h4>
223 <b>on_tagButton_toggled</b>(<i>checked</i>)
224 <p>
225 Private slot to handle changes of the Tag select button.
226 </p><dl>
227 <dt><i>checked</i> (bool)</dt>
228 <dd>
229 state of the button
230 </dd>
231 </dl><a NAME="HgStripDialog.on_tagCombo_editTextChanged" ID="HgStripDialog.on_tagCombo_editTextChanged"></a>
232 <h4>HgStripDialog.on_tagCombo_editTextChanged</h4>
233 <b>on_tagCombo_editTextChanged</b>(<i>txt</i>)
234 <p>
235 Private slot to handle changes of the Tag combo.
236 </p><dl>
237 <dt><i>txt</i> (str)</dt>
238 <dd>
239 text of the combo
240 </dd>
241 </dl>
242 <div align="right"><a href="#top">Up</a></div>
243 <hr />
244 </body></html>

eric ide

mercurial