src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.HgHisteditPlanEditor.html

branch
eric7
changeset 10479
856476537696
parent 9209
b99e7fd55fd3
child 10690
fab36645aa7d
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.HgHisteditPlanEditor</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.HgHisteditPlanEditor</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to edit the history modification plan. 11 Module implementing a dialog to edit the history modification plan.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#HgHisteditPlanActionComboBox">HgHisteditPlanActionComboBox</a></td> 22 <td><a href="#HgHisteditPlanActionComboBox">HgHisteditPlanActionComboBox</a></td>
25 <td>Class implementing a combo box to select the action in the plan tree.</td> 23 <td>Class implementing a combo box to select the action in the plan tree.</td>
26 </tr> 24 </tr>
27 <tr> 25 <tr>
28 <td><a href="#HgHisteditPlanEditor">HgHisteditPlanEditor</a></td> 26 <td><a href="#HgHisteditPlanEditor">HgHisteditPlanEditor</a></td>
29 <td>Class implementing a dialog to edit the history modification plan.</td> 27 <td>Class implementing a dialog to edit the history modification plan.</td>
30 </tr> 28 </tr>
31 </table> 29 </table>
30
32 <h3>Functions</h3> 31 <h3>Functions</h3>
33 32 <table>
34 <table> 33 <tr><td>None</td></tr>
35 <tr><td>None</td></tr> 34 </table>
36 </table> 35
37 <hr /> 36 <hr />
38 <hr /> 37 <hr />
39 <a NAME="HgHisteditPlanActionComboBox" ID="HgHisteditPlanActionComboBox"></a> 38 <a NAME="HgHisteditPlanActionComboBox" ID="HgHisteditPlanActionComboBox"></a>
40 <h2>HgHisteditPlanActionComboBox</h2> 39 <h2>HgHisteditPlanActionComboBox</h2>
41
42 <p> 40 <p>
43 Class implementing a combo box to select the action in the plan tree. 41 Class implementing a combo box to select the action in the plan tree.
44 </p> 42 </p>
43
45 <h3>Derived from</h3> 44 <h3>Derived from</h3>
46 QComboBox 45 QComboBox
47 <h3>Class Attributes</h3> 46 <h3>Class Attributes</h3>
48 47 <table>
49 <table> 48 <tr><td>None</td></tr>
50 <tr><td>None</td></tr> 49 </table>
51 </table> 50
52 <h3>Class Methods</h3> 51 <h3>Class Methods</h3>
53 52 <table>
54 <table> 53 <tr><td>None</td></tr>
55 <tr><td>None</td></tr> 54 </table>
56 </table> 55
57 <h3>Methods</h3> 56 <h3>Methods</h3>
58 57 <table>
59 <table>
60
61 <tr> 58 <tr>
62 <td><a href="#HgHisteditPlanActionComboBox.__init__">HgHisteditPlanActionComboBox</a></td> 59 <td><a href="#HgHisteditPlanActionComboBox.__init__">HgHisteditPlanActionComboBox</a></td>
63 <td>Constructor</td> 60 <td>Constructor</td>
64 </tr> 61 </tr>
65 <tr> 62 <tr>
69 <tr> 66 <tr>
70 <td><a href="#HgHisteditPlanActionComboBox.showPopup">showPopup</a></td> 67 <td><a href="#HgHisteditPlanActionComboBox.showPopup">showPopup</a></td>
71 <td>Public method to show the list of items of the combo box.</td> 68 <td>Public method to show the list of items of the combo box.</td>
72 </tr> 69 </tr>
73 </table> 70 </table>
71
74 <h3>Static Methods</h3> 72 <h3>Static Methods</h3>
75 73 <table>
76 <table> 74 <tr><td>None</td></tr>
77 <tr><td>None</td></tr> 75 </table>
78 </table> 76
79 77
80 <a NAME="HgHisteditPlanActionComboBox.__init__" ID="HgHisteditPlanActionComboBox.__init__"></a> 78 <a NAME="HgHisteditPlanActionComboBox.__init__" ID="HgHisteditPlanActionComboBox.__init__"></a>
81 <h4>HgHisteditPlanActionComboBox (Constructor)</h4> 79 <h4>HgHisteditPlanActionComboBox (Constructor)</h4>
82 <b>HgHisteditPlanActionComboBox</b>(<i>item, column</i>) 80 <b>HgHisteditPlanActionComboBox</b>(<i>item, column</i>)
83
84 <p> 81 <p>
85 Constructor 82 Constructor
86 </p> 83 </p>
84
87 <dl> 85 <dl>
88 86
89 <dt><i>item</i> (QTreeWidgetItem)</dt> 87 <dt><i>item</i> (QTreeWidgetItem)</dt>
90 <dd> 88 <dd>
91 reference to the item 89 reference to the item
96 </dd> 94 </dd>
97 </dl> 95 </dl>
98 <a NAME="HgHisteditPlanActionComboBox.__changeItem" ID="HgHisteditPlanActionComboBox.__changeItem"></a> 96 <a NAME="HgHisteditPlanActionComboBox.__changeItem" ID="HgHisteditPlanActionComboBox.__changeItem"></a>
99 <h4>HgHisteditPlanActionComboBox.__changeItem</h4> 97 <h4>HgHisteditPlanActionComboBox.__changeItem</h4>
100 <b>__changeItem</b>(<i>index</i>) 98 <b>__changeItem</b>(<i>index</i>)
101
102 <p> 99 <p>
103 Private slot to handle the selection of a plan action. 100 Private slot to handle the selection of a plan action.
104 </p> 101 </p>
105 <p> 102 <p>
106 This method sets the text of the associated item for the specified 103 This method sets the text of the associated item for the specified
107 cell in order to be able to retrieve it with a call of the text() 104 cell in order to be able to retrieve it with a call of the text()
108 method of the item. 105 method of the item.
109 </p> 106 </p>
107
110 <dl> 108 <dl>
111 109
112 <dt><i>index</i> (int)</dt> 110 <dt><i>index</i> (int)</dt>
113 <dd> 111 <dd>
114 index of the selected action 112 index of the selected action
115 </dd> 113 </dd>
116 </dl> 114 </dl>
117 <a NAME="HgHisteditPlanActionComboBox.showPopup" ID="HgHisteditPlanActionComboBox.showPopup"></a> 115 <a NAME="HgHisteditPlanActionComboBox.showPopup" ID="HgHisteditPlanActionComboBox.showPopup"></a>
118 <h4>HgHisteditPlanActionComboBox.showPopup</h4> 116 <h4>HgHisteditPlanActionComboBox.showPopup</h4>
119 <b>showPopup</b>(<i></i>) 117 <b>showPopup</b>(<i></i>)
120
121 <p> 118 <p>
122 Public method to show the list of items of the combo box. 119 Public method to show the list of items of the combo box.
123 </p> 120 </p>
124 <p> 121 <p>
125 This is reimplemented in order to set the associated item as the 122 This is reimplemented in order to set the associated item as the
126 current item of the tree widget. 123 current item of the tree widget.
127 </p> 124 </p>
125
128 <div align="right"><a href="#top">Up</a></div> 126 <div align="right"><a href="#top">Up</a></div>
129 <hr /> 127 <hr />
130 <hr /> 128 <hr />
131 <a NAME="HgHisteditPlanEditor" ID="HgHisteditPlanEditor"></a> 129 <a NAME="HgHisteditPlanEditor" ID="HgHisteditPlanEditor"></a>
132 <h2>HgHisteditPlanEditor</h2> 130 <h2>HgHisteditPlanEditor</h2>
133
134 <p> 131 <p>
135 Class implementing a dialog to edit the history modification plan. 132 Class implementing a dialog to edit the history modification plan.
136 </p> 133 </p>
134
137 <h3>Derived from</h3> 135 <h3>Derived from</h3>
138 QDialog, Ui_HgHisteditPlanEditor 136 QDialog, Ui_HgHisteditPlanEditor
139 <h3>Class Attributes</h3> 137 <h3>Class Attributes</h3>
140 138 <table>
141 <table> 139 <tr><td>None</td></tr>
142 <tr><td>None</td></tr> 140 </table>
143 </table> 141
144 <h3>Class Methods</h3> 142 <h3>Class Methods</h3>
145 143 <table>
146 <table> 144 <tr><td>None</td></tr>
147 <tr><td>None</td></tr> 145 </table>
148 </table> 146
149 <h3>Methods</h3> 147 <h3>Methods</h3>
150 148 <table>
151 <table>
152
153 <tr> 149 <tr>
154 <td><a href="#HgHisteditPlanEditor.__init__">HgHisteditPlanEditor</a></td> 150 <td><a href="#HgHisteditPlanEditor.__init__">HgHisteditPlanEditor</a></td>
155 <td>Constructor</td> 151 <td>Constructor</td>
156 </tr> 152 </tr>
157 <tr> 153 <tr>
197 <tr> 193 <tr>
198 <td><a href="#HgHisteditPlanEditor.on_upButton_clicked">on_upButton_clicked</a></td> 194 <td><a href="#HgHisteditPlanEditor.on_upButton_clicked">on_upButton_clicked</a></td>
199 <td>Private slot to move the current entry up one line.</td> 195 <td>Private slot to move the current entry up one line.</td>
200 </tr> 196 </tr>
201 </table> 197 </table>
198
202 <h3>Static Methods</h3> 199 <h3>Static Methods</h3>
203 200 <table>
204 <table> 201 <tr><td>None</td></tr>
205 <tr><td>None</td></tr> 202 </table>
206 </table> 203
207 204
208 <a NAME="HgHisteditPlanEditor.__init__" ID="HgHisteditPlanEditor.__init__"></a> 205 <a NAME="HgHisteditPlanEditor.__init__" ID="HgHisteditPlanEditor.__init__"></a>
209 <h4>HgHisteditPlanEditor (Constructor)</h4> 206 <h4>HgHisteditPlanEditor (Constructor)</h4>
210 <b>HgHisteditPlanEditor</b>(<i>fileName, parent=None</i>) 207 <b>HgHisteditPlanEditor</b>(<i>fileName, parent=None</i>)
211
212 <p> 208 <p>
213 Constructor 209 Constructor
214 </p> 210 </p>
211
215 <dl> 212 <dl>
216 213
217 <dt><i>fileName</i> (str)</dt> 214 <dt><i>fileName</i> (str)</dt>
218 <dd> 215 <dd>
219 name of the file containing the history edit plan 216 name of the file containing the history edit plan
225 </dd> 222 </dd>
226 </dl> 223 </dl>
227 <a NAME="HgHisteditPlanEditor.__addActionCombo" ID="HgHisteditPlanEditor.__addActionCombo"></a> 224 <a NAME="HgHisteditPlanEditor.__addActionCombo" ID="HgHisteditPlanEditor.__addActionCombo"></a>
228 <h4>HgHisteditPlanEditor.__addActionCombo</h4> 225 <h4>HgHisteditPlanEditor.__addActionCombo</h4>
229 <b>__addActionCombo</b>(<i>item</i>) 226 <b>__addActionCombo</b>(<i>item</i>)
230
231 <p> 227 <p>
232 Private method to add an edit action combo to an item. 228 Private method to add an edit action combo to an item.
233 </p> 229 </p>
230
234 <dl> 231 <dl>
235 232
236 <dt><i>item</i> (QTreeWidgetItem)</dt> 233 <dt><i>item</i> (QTreeWidgetItem)</dt>
237 <dd> 234 <dd>
238 reference to the tree widget item 235 reference to the tree widget item
239 </dd> 236 </dd>
240 </dl> 237 </dl>
241 <a NAME="HgHisteditPlanEditor.__assembleEditPlan" ID="HgHisteditPlanEditor.__assembleEditPlan"></a> 238 <a NAME="HgHisteditPlanEditor.__assembleEditPlan" ID="HgHisteditPlanEditor.__assembleEditPlan"></a>
242 <h4>HgHisteditPlanEditor.__assembleEditPlan</h4> 239 <h4>HgHisteditPlanEditor.__assembleEditPlan</h4>
243 <b>__assembleEditPlan</b>(<i></i>) 240 <b>__assembleEditPlan</b>(<i></i>)
244
245 <p> 241 <p>
246 Private method to assemble the edit plan into text suitable for the 242 Private method to assemble the edit plan into text suitable for the
247 histedit file. 243 histedit file.
248 </p> 244 </p>
245
249 <dl> 246 <dl>
250 <dt>Return:</dt> 247 <dt>Return:</dt>
251 <dd> 248 <dd>
252 assembled edit plan text 249 assembled edit plan text
253 </dd> 250 </dd>
259 </dd> 256 </dd>
260 </dl> 257 </dl>
261 <a NAME="HgHisteditPlanEditor.__createPlanItem" ID="HgHisteditPlanEditor.__createPlanItem"></a> 258 <a NAME="HgHisteditPlanEditor.__createPlanItem" ID="HgHisteditPlanEditor.__createPlanItem"></a>
262 <h4>HgHisteditPlanEditor.__createPlanItem</h4> 259 <h4>HgHisteditPlanEditor.__createPlanItem</h4>
263 <b>__createPlanItem</b>(<i>text</i>) 260 <b>__createPlanItem</b>(<i>text</i>)
264
265 <p> 261 <p>
266 Private method to create an edit plan tree item. 262 Private method to create an edit plan tree item.
267 </p> 263 </p>
264
268 <dl> 265 <dl>
269 266
270 <dt><i>text</i> (str)</dt> 267 <dt><i>text</i> (str)</dt>
271 <dd> 268 <dd>
272 line of text to be parsed 269 line of text to be parsed
273 </dd> 270 </dd>
274 </dl> 271 </dl>
275 <a NAME="HgHisteditPlanEditor.__readFile" ID="HgHisteditPlanEditor.__readFile"></a> 272 <a NAME="HgHisteditPlanEditor.__readFile" ID="HgHisteditPlanEditor.__readFile"></a>
276 <h4>HgHisteditPlanEditor.__readFile</h4> 273 <h4>HgHisteditPlanEditor.__readFile</h4>
277 <b>__readFile</b>(<i></i>) 274 <b>__readFile</b>(<i></i>)
278
279 <p> 275 <p>
280 Private method to read the file containing the edit plan and 276 Private method to read the file containing the edit plan and
281 populate the dialog. 277 populate the dialog.
282 </p> 278 </p>
279
283 <a NAME="HgHisteditPlanEditor.__resizeSections" ID="HgHisteditPlanEditor.__resizeSections"></a> 280 <a NAME="HgHisteditPlanEditor.__resizeSections" ID="HgHisteditPlanEditor.__resizeSections"></a>
284 <h4>HgHisteditPlanEditor.__resizeSections</h4> 281 <h4>HgHisteditPlanEditor.__resizeSections</h4>
285 <b>__resizeSections</b>(<i></i>) 282 <b>__resizeSections</b>(<i></i>)
286
287 <p> 283 <p>
288 Private method to resize the tree widget sections. 284 Private method to resize the tree widget sections.
289 </p> 285 </p>
286
290 <a NAME="HgHisteditPlanEditor.__updateButtons" ID="HgHisteditPlanEditor.__updateButtons"></a> 287 <a NAME="HgHisteditPlanEditor.__updateButtons" ID="HgHisteditPlanEditor.__updateButtons"></a>
291 <h4>HgHisteditPlanEditor.__updateButtons</h4> 288 <h4>HgHisteditPlanEditor.__updateButtons</h4>
292 <b>__updateButtons</b>(<i></i>) 289 <b>__updateButtons</b>(<i></i>)
293
294 <p> 290 <p>
295 Private method to set the enabled state of the up and down buttons. 291 Private method to set the enabled state of the up and down buttons.
296 </p> 292 </p>
293
297 <a NAME="HgHisteditPlanEditor.on_buttonBox_accepted" ID="HgHisteditPlanEditor.on_buttonBox_accepted"></a> 294 <a NAME="HgHisteditPlanEditor.on_buttonBox_accepted" ID="HgHisteditPlanEditor.on_buttonBox_accepted"></a>
298 <h4>HgHisteditPlanEditor.on_buttonBox_accepted</h4> 295 <h4>HgHisteditPlanEditor.on_buttonBox_accepted</h4>
299 <b>on_buttonBox_accepted</b>(<i></i>) 296 <b>on_buttonBox_accepted</b>(<i></i>)
300
301 <p> 297 <p>
302 Private slot called by the buttonBox accepted signal. 298 Private slot called by the buttonBox accepted signal.
303 </p> 299 </p>
300
304 <a NAME="HgHisteditPlanEditor.on_buttonBox_rejected" ID="HgHisteditPlanEditor.on_buttonBox_rejected"></a> 301 <a NAME="HgHisteditPlanEditor.on_buttonBox_rejected" ID="HgHisteditPlanEditor.on_buttonBox_rejected"></a>
305 <h4>HgHisteditPlanEditor.on_buttonBox_rejected</h4> 302 <h4>HgHisteditPlanEditor.on_buttonBox_rejected</h4>
306 <b>on_buttonBox_rejected</b>(<i></i>) 303 <b>on_buttonBox_rejected</b>(<i></i>)
307
308 <p> 304 <p>
309 Private slot called by the buttonBox rejected signal. 305 Private slot called by the buttonBox rejected signal.
310 </p> 306 </p>
307
311 <a NAME="HgHisteditPlanEditor.on_downButton_clicked" ID="HgHisteditPlanEditor.on_downButton_clicked"></a> 308 <a NAME="HgHisteditPlanEditor.on_downButton_clicked" ID="HgHisteditPlanEditor.on_downButton_clicked"></a>
312 <h4>HgHisteditPlanEditor.on_downButton_clicked</h4> 309 <h4>HgHisteditPlanEditor.on_downButton_clicked</h4>
313 <b>on_downButton_clicked</b>(<i></i>) 310 <b>on_downButton_clicked</b>(<i></i>)
314
315 <p> 311 <p>
316 Private slot to move the current entry down one line. 312 Private slot to move the current entry down one line.
317 </p> 313 </p>
314
318 <a NAME="HgHisteditPlanEditor.on_planTreeWidget_currentItemChanged" ID="HgHisteditPlanEditor.on_planTreeWidget_currentItemChanged"></a> 315 <a NAME="HgHisteditPlanEditor.on_planTreeWidget_currentItemChanged" ID="HgHisteditPlanEditor.on_planTreeWidget_currentItemChanged"></a>
319 <h4>HgHisteditPlanEditor.on_planTreeWidget_currentItemChanged</h4> 316 <h4>HgHisteditPlanEditor.on_planTreeWidget_currentItemChanged</h4>
320 <b>on_planTreeWidget_currentItemChanged</b>(<i>current, previous</i>) 317 <b>on_planTreeWidget_currentItemChanged</b>(<i>current, previous</i>)
321
322 <p> 318 <p>
323 Private slot handling the change of the current edit plan item. 319 Private slot handling the change of the current edit plan item.
324 </p> 320 </p>
321
325 <dl> 322 <dl>
326 323
327 <dt><i>current</i> (QTreeWidgetItem)</dt> 324 <dt><i>current</i> (QTreeWidgetItem)</dt>
328 <dd> 325 <dd>
329 reference to the current edit plan item 326 reference to the current edit plan item
334 </dd> 331 </dd>
335 </dl> 332 </dl>
336 <a NAME="HgHisteditPlanEditor.on_upButton_clicked" ID="HgHisteditPlanEditor.on_upButton_clicked"></a> 333 <a NAME="HgHisteditPlanEditor.on_upButton_clicked" ID="HgHisteditPlanEditor.on_upButton_clicked"></a>
337 <h4>HgHisteditPlanEditor.on_upButton_clicked</h4> 334 <h4>HgHisteditPlanEditor.on_upButton_clicked</h4>
338 <b>on_upButton_clicked</b>(<i></i>) 335 <b>on_upButton_clicked</b>(<i></i>)
339
340 <p> 336 <p>
341 Private slot to move the current entry up one line. 337 Private slot to move the current entry up one line.
342 </p> 338 </p>
339
343 <div align="right"><a href="#top">Up</a></div> 340 <div align="right"><a href="#top">Up</a></div>
344 <hr /> 341 <hr />
345 </body></html> 342 </body></html>

eric ide

mercurial