Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.HgHisteditPlanEditor.html

eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.HgHisteditPlanEditor.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.HisteditExtension.HgHisteditPlanEditor</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.HisteditExtension.HgHisteditPlanEditor</h1>
24
25 <p>
26 Module implementing a dialog to edit the history modification plan.
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="#HgHisteditPlanActionComboBox">HgHisteditPlanActionComboBox</a></td>
39 <td>Class implementing a combo box to select the action in the plan tree.</td>
40 </tr>
41 <tr>
42 <td><a href="#HgHisteditPlanEditor">HgHisteditPlanEditor</a></td>
43 <td>Class implementing a dialog to edit the history modification plan.</td>
44 </tr>
45 </table>
46 <h3>Functions</h3>
47
48 <table>
49 <tr><td>None</td></tr>
50 </table>
51 <hr />
52 <hr />
53 <a NAME="HgHisteditPlanActionComboBox" ID="HgHisteditPlanActionComboBox"></a>
54 <h2>HgHisteditPlanActionComboBox</h2>
55
56 <p>
57 Class implementing a combo box to select the action in the plan tree.
58 </p>
59 <h3>Derived from</h3>
60 QComboBox
61 <h3>Class Attributes</h3>
62
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66 <h3>Class Methods</h3>
67
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Methods</h3>
72
73 <table>
74
75 <tr>
76 <td><a href="#HgHisteditPlanActionComboBox.__init__">HgHisteditPlanActionComboBox</a></td>
77 <td>Constructor</td>
78 </tr>
79 <tr>
80 <td><a href="#HgHisteditPlanActionComboBox.__changeItem">__changeItem</a></td>
81 <td>Private slot to handle the selection of a plan action.</td>
82 </tr>
83 <tr>
84 <td><a href="#HgHisteditPlanActionComboBox.showPopup">showPopup</a></td>
85 <td>Public method to show the list of items of the combo box.</td>
86 </tr>
87 </table>
88 <h3>Static Methods</h3>
89
90 <table>
91 <tr><td>None</td></tr>
92 </table>
93
94 <a NAME="HgHisteditPlanActionComboBox.__init__" ID="HgHisteditPlanActionComboBox.__init__"></a>
95 <h4>HgHisteditPlanActionComboBox (Constructor)</h4>
96 <b>HgHisteditPlanActionComboBox</b>(<i>item, column</i>)
97
98 <p>
99 Constructor
100 </p>
101 <dl>
102
103 <dt><i>item</i> (QTreeWidgetItem)</dt>
104 <dd>
105 reference to the item
106 </dd>
107 <dt><i>column</i> (int)</dt>
108 <dd>
109 column number inside the tree widget item
110 </dd>
111 </dl>
112 <a NAME="HgHisteditPlanActionComboBox.__changeItem" ID="HgHisteditPlanActionComboBox.__changeItem"></a>
113 <h4>HgHisteditPlanActionComboBox.__changeItem</h4>
114 <b>__changeItem</b>(<i>index</i>)
115
116 <p>
117 Private slot to handle the selection of a plan action.
118 </p>
119 <p>
120 This method sets the text of the associated item for the specified
121 cell in order to be able to retrieve it with a call of the text()
122 method of the item.
123 </p>
124 <dl>
125
126 <dt><i>index</i> (int)</dt>
127 <dd>
128 index of the selected action
129 </dd>
130 </dl>
131 <a NAME="HgHisteditPlanActionComboBox.showPopup" ID="HgHisteditPlanActionComboBox.showPopup"></a>
132 <h4>HgHisteditPlanActionComboBox.showPopup</h4>
133 <b>showPopup</b>(<i></i>)
134
135 <p>
136 Public method to show the list of items of the combo box.
137 </p>
138 <p>
139 This is reimplemented in order to set the associated item as the
140 current item of the tree widget.
141 </p>
142 <div align="right"><a href="#top">Up</a></div>
143 <hr />
144 <hr />
145 <a NAME="HgHisteditPlanEditor" ID="HgHisteditPlanEditor"></a>
146 <h2>HgHisteditPlanEditor</h2>
147
148 <p>
149 Class implementing a dialog to edit the history modification plan.
150 </p>
151 <h3>Derived from</h3>
152 QDialog, Ui_HgHisteditPlanEditor
153 <h3>Class Attributes</h3>
154
155 <table>
156 <tr><td>None</td></tr>
157 </table>
158 <h3>Class Methods</h3>
159
160 <table>
161 <tr><td>None</td></tr>
162 </table>
163 <h3>Methods</h3>
164
165 <table>
166
167 <tr>
168 <td><a href="#HgHisteditPlanEditor.__init__">HgHisteditPlanEditor</a></td>
169 <td>Constructor</td>
170 </tr>
171 <tr>
172 <td><a href="#HgHisteditPlanEditor.__addActionCombo">__addActionCombo</a></td>
173 <td>Private method to add an edit action combo to an item.</td>
174 </tr>
175 <tr>
176 <td><a href="#HgHisteditPlanEditor.__assembleEditPlan">__assembleEditPlan</a></td>
177 <td>Private method to assemble the edit plan into text suitable for the histedit file.</td>
178 </tr>
179 <tr>
180 <td><a href="#HgHisteditPlanEditor.__createPlanItem">__createPlanItem</a></td>
181 <td>Private method to create an edit plan tree item.</td>
182 </tr>
183 <tr>
184 <td><a href="#HgHisteditPlanEditor.__readFile">__readFile</a></td>
185 <td>Private method to read the file containing the edit plan and populate the dialog.</td>
186 </tr>
187 <tr>
188 <td><a href="#HgHisteditPlanEditor.__resizeSections">__resizeSections</a></td>
189 <td>Private method to resize the tree widget sections.</td>
190 </tr>
191 <tr>
192 <td><a href="#HgHisteditPlanEditor.__updateButtons">__updateButtons</a></td>
193 <td>Private method to set the enabled state of the up and down buttons.</td>
194 </tr>
195 <tr>
196 <td><a href="#HgHisteditPlanEditor.on_buttonBox_accepted">on_buttonBox_accepted</a></td>
197 <td>Private slot called by the buttonBox accepted signal.</td>
198 </tr>
199 <tr>
200 <td><a href="#HgHisteditPlanEditor.on_buttonBox_rejected">on_buttonBox_rejected</a></td>
201 <td>Private slot called by the buttonBox rejected signal.</td>
202 </tr>
203 <tr>
204 <td><a href="#HgHisteditPlanEditor.on_downButton_clicked">on_downButton_clicked</a></td>
205 <td>Private slot to move the current entry down one line.</td>
206 </tr>
207 <tr>
208 <td><a href="#HgHisteditPlanEditor.on_planTreeWidget_currentItemChanged">on_planTreeWidget_currentItemChanged</a></td>
209 <td>Private slot handling the change of the current edit plan item.</td>
210 </tr>
211 <tr>
212 <td><a href="#HgHisteditPlanEditor.on_upButton_clicked">on_upButton_clicked</a></td>
213 <td>Private slot to move the current entry up one line.</td>
214 </tr>
215 </table>
216 <h3>Static Methods</h3>
217
218 <table>
219 <tr><td>None</td></tr>
220 </table>
221
222 <a NAME="HgHisteditPlanEditor.__init__" ID="HgHisteditPlanEditor.__init__"></a>
223 <h4>HgHisteditPlanEditor (Constructor)</h4>
224 <b>HgHisteditPlanEditor</b>(<i>fileName, parent=None</i>)
225
226 <p>
227 Constructor
228 </p>
229 <dl>
230
231 <dt><i>fileName</i> (str)</dt>
232 <dd>
233 name of the file containing the history edit plan
234 to be edited
235 </dd>
236 <dt><i>parent</i> (QWidget)</dt>
237 <dd>
238 reference to the parent widget
239 </dd>
240 </dl>
241 <a NAME="HgHisteditPlanEditor.__addActionCombo" ID="HgHisteditPlanEditor.__addActionCombo"></a>
242 <h4>HgHisteditPlanEditor.__addActionCombo</h4>
243 <b>__addActionCombo</b>(<i>item</i>)
244
245 <p>
246 Private method to add an edit action combo to an item.
247 </p>
248 <dl>
249
250 <dt><i>item</i> (QTreeWidgetItem)</dt>
251 <dd>
252 reference to the tree widget item
253 </dd>
254 </dl>
255 <a NAME="HgHisteditPlanEditor.__assembleEditPlan" ID="HgHisteditPlanEditor.__assembleEditPlan"></a>
256 <h4>HgHisteditPlanEditor.__assembleEditPlan</h4>
257 <b>__assembleEditPlan</b>(<i></i>)
258
259 <p>
260 Private method to assemble the edit plan into text suitable for the
261 histedit file.
262 </p>
263 <dl>
264 <dt>Return:</dt>
265 <dd>
266 assembled edit plan text
267 </dd>
268 </dl>
269 <dl>
270 <dt>Return Type:</dt>
271 <dd>
272 str
273 </dd>
274 </dl>
275 <a NAME="HgHisteditPlanEditor.__createPlanItem" ID="HgHisteditPlanEditor.__createPlanItem"></a>
276 <h4>HgHisteditPlanEditor.__createPlanItem</h4>
277 <b>__createPlanItem</b>(<i>text</i>)
278
279 <p>
280 Private method to create an edit plan tree item.
281 </p>
282 <dl>
283
284 <dt><i>text</i> (str)</dt>
285 <dd>
286 line of text to be parsed
287 </dd>
288 </dl>
289 <a NAME="HgHisteditPlanEditor.__readFile" ID="HgHisteditPlanEditor.__readFile"></a>
290 <h4>HgHisteditPlanEditor.__readFile</h4>
291 <b>__readFile</b>(<i></i>)
292
293 <p>
294 Private method to read the file containing the edit plan and
295 populate the dialog.
296 </p>
297 <a NAME="HgHisteditPlanEditor.__resizeSections" ID="HgHisteditPlanEditor.__resizeSections"></a>
298 <h4>HgHisteditPlanEditor.__resizeSections</h4>
299 <b>__resizeSections</b>(<i></i>)
300
301 <p>
302 Private method to resize the tree widget sections.
303 </p>
304 <a NAME="HgHisteditPlanEditor.__updateButtons" ID="HgHisteditPlanEditor.__updateButtons"></a>
305 <h4>HgHisteditPlanEditor.__updateButtons</h4>
306 <b>__updateButtons</b>(<i></i>)
307
308 <p>
309 Private method to set the enabled state of the up and down buttons.
310 </p>
311 <a NAME="HgHisteditPlanEditor.on_buttonBox_accepted" ID="HgHisteditPlanEditor.on_buttonBox_accepted"></a>
312 <h4>HgHisteditPlanEditor.on_buttonBox_accepted</h4>
313 <b>on_buttonBox_accepted</b>(<i></i>)
314
315 <p>
316 Private slot called by the buttonBox accepted signal.
317 </p>
318 <a NAME="HgHisteditPlanEditor.on_buttonBox_rejected" ID="HgHisteditPlanEditor.on_buttonBox_rejected"></a>
319 <h4>HgHisteditPlanEditor.on_buttonBox_rejected</h4>
320 <b>on_buttonBox_rejected</b>(<i></i>)
321
322 <p>
323 Private slot called by the buttonBox rejected signal.
324 </p>
325 <a NAME="HgHisteditPlanEditor.on_downButton_clicked" ID="HgHisteditPlanEditor.on_downButton_clicked"></a>
326 <h4>HgHisteditPlanEditor.on_downButton_clicked</h4>
327 <b>on_downButton_clicked</b>(<i></i>)
328
329 <p>
330 Private slot to move the current entry down one line.
331 </p>
332 <a NAME="HgHisteditPlanEditor.on_planTreeWidget_currentItemChanged" ID="HgHisteditPlanEditor.on_planTreeWidget_currentItemChanged"></a>
333 <h4>HgHisteditPlanEditor.on_planTreeWidget_currentItemChanged</h4>
334 <b>on_planTreeWidget_currentItemChanged</b>(<i>current, previous</i>)
335
336 <p>
337 Private slot handling the change of the current edit plan item.
338 </p>
339 <dl>
340
341 <dt><i>current</i> (QTreeWidgetItem)</dt>
342 <dd>
343 reference to the current edit plan item
344 </dd>
345 <dt><i>previous</i> (QTreeWidgetItem)</dt>
346 <dd>
347 reference to the previous current edit plan item
348 </dd>
349 </dl>
350 <a NAME="HgHisteditPlanEditor.on_upButton_clicked" ID="HgHisteditPlanEditor.on_upButton_clicked"></a>
351 <h4>HgHisteditPlanEditor.on_upButton_clicked</h4>
352 <b>on_upButton_clicked</b>(<i></i>)
353
354 <p>
355 Private slot to move the current entry up one line.
356 </p>
357 <div align="right"><a href="#top">Up</a></div>
358 <hr />
359 </body></html>

Mercurial Repository: eric

eric ide

mercurial