Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.EricWidgets.EricToolBarDialog.html

eric7/Documentation/Source/eric7.EricWidgets.EricToolBarDialog.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.EricWidgets.EricToolBarDialog</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.EricWidgets.EricToolBarDialog</h1>
24
25 <p>
26 Module implementing a toolbar configuration dialog.
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="#EricToolBarDialog">EricToolBarDialog</a></td>
39 <td>Class implementing a toolbar configuration dialog.</td>
40 </tr>
41 <tr>
42 <td><a href="#EricToolBarItem">EricToolBarItem</a></td>
43 <td>Class storing data belonging to a toolbar entry of the toolbar dialog.</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="EricToolBarDialog" ID="EricToolBarDialog"></a>
54 <h2>EricToolBarDialog</h2>
55
56 <p>
57 Class implementing a toolbar configuration dialog.
58 </p>
59 <h3>Derived from</h3>
60 QDialog, Ui_EricToolBarDialog
61 <h3>Class Attributes</h3>
62
63 <table>
64 <tr><td>ActionIdRole</td></tr><tr><td>WidgetActionRole</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="#EricToolBarDialog.__init__">EricToolBarDialog</a></td>
77 <td>Constructor</td>
78 </tr>
79 <tr>
80 <td><a href="#EricToolBarDialog.__resetCurrentToolbar">__resetCurrentToolbar</a></td>
81 <td>Private method to revert all changes made to the current toolbar.</td>
82 </tr>
83 <tr>
84 <td><a href="#EricToolBarDialog.__restoreCurrentToolbar">__restoreCurrentToolbar</a></td>
85 <td>Private methdo to restore the current toolbar to the given list of actions.</td>
86 </tr>
87 <tr>
88 <td><a href="#EricToolBarDialog.__restoreCurrentToolbarToDefault">__restoreCurrentToolbarToDefault</a></td>
89 <td>Private method to set the current toolbar to its default configuration.</td>
90 </tr>
91 <tr>
92 <td><a href="#EricToolBarDialog.__saveToolBars">__saveToolBars</a></td>
93 <td>Private method to save the configured toolbars.</td>
94 </tr>
95 <tr>
96 <td><a href="#EricToolBarDialog.__setupButtons">__setupButtons</a></td>
97 <td>Private slot to set the buttons state.</td>
98 </tr>
99 <tr>
100 <td><a href="#EricToolBarDialog.__toolbarComboBox_currentIndexChanged">__toolbarComboBox_currentIndexChanged</a></td>
101 <td>Private slot called upon a selection of the current toolbar.</td>
102 </tr>
103 <tr>
104 <td><a href="#EricToolBarDialog.on_actionsTree_currentItemChanged">on_actionsTree_currentItemChanged</a></td>
105 <td>Private slot called, when the currently selected action changes.</td>
106 </tr>
107 <tr>
108 <td><a href="#EricToolBarDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
109 <td>Private slot called, when a button of the button box was clicked.</td>
110 </tr>
111 <tr>
112 <td><a href="#EricToolBarDialog.on_downButton_clicked">on_downButton_clicked</a></td>
113 <td>Private slot used to move an action down in the list.</td>
114 </tr>
115 <tr>
116 <td><a href="#EricToolBarDialog.on_leftButton_clicked">on_leftButton_clicked</a></td>
117 <td>Private slot to delete an action from the list.</td>
118 </tr>
119 <tr>
120 <td><a href="#EricToolBarDialog.on_newButton_clicked">on_newButton_clicked</a></td>
121 <td>Private slot to create a new toolbar.</td>
122 </tr>
123 <tr>
124 <td><a href="#EricToolBarDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
125 <td>Private slot to remove a custom toolbar.</td>
126 </tr>
127 <tr>
128 <td><a href="#EricToolBarDialog.on_renameButton_clicked">on_renameButton_clicked</a></td>
129 <td>Private slot to rename a custom toolbar.</td>
130 </tr>
131 <tr>
132 <td><a href="#EricToolBarDialog.on_rightButton_clicked">on_rightButton_clicked</a></td>
133 <td>Private slot to add an action to the list.</td>
134 </tr>
135 <tr>
136 <td><a href="#EricToolBarDialog.on_toolbarActionsList_currentItemChanged">on_toolbarActionsList_currentItemChanged</a></td>
137 <td>Private slot to handle a change of the current item.</td>
138 </tr>
139 <tr>
140 <td><a href="#EricToolBarDialog.on_upButton_clicked">on_upButton_clicked</a></td>
141 <td>Private slot used to move an action up in the list.</td>
142 </tr>
143 </table>
144 <h3>Static Methods</h3>
145
146 <table>
147 <tr><td>None</td></tr>
148 </table>
149
150 <a NAME="EricToolBarDialog.__init__" ID="EricToolBarDialog.__init__"></a>
151 <h4>EricToolBarDialog (Constructor)</h4>
152 <b>EricToolBarDialog</b>(<i>toolBarManager, parent=None</i>)
153
154 <p>
155 Constructor
156 </p>
157 <dl>
158
159 <dt><i>toolBarManager</i></dt>
160 <dd>
161 reference to a toolbar manager object
162 (EricToolBarManager)
163 </dd>
164 <dt><i>parent</i></dt>
165 <dd>
166 reference to the parent widget (QWidget)
167 </dd>
168 </dl>
169 <a NAME="EricToolBarDialog.__resetCurrentToolbar" ID="EricToolBarDialog.__resetCurrentToolbar"></a>
170 <h4>EricToolBarDialog.__resetCurrentToolbar</h4>
171 <b>__resetCurrentToolbar</b>(<i></i>)
172
173 <p>
174 Private method to revert all changes made to the current toolbar.
175 </p>
176 <a NAME="EricToolBarDialog.__restoreCurrentToolbar" ID="EricToolBarDialog.__restoreCurrentToolbar"></a>
177 <h4>EricToolBarDialog.__restoreCurrentToolbar</h4>
178 <b>__restoreCurrentToolbar</b>(<i>actions</i>)
179
180 <p>
181 Private methdo to restore the current toolbar to the given list of
182 actions.
183 </p>
184 <dl>
185
186 <dt><i>actions</i></dt>
187 <dd>
188 list of actions to set for the current toolbar
189 (list of QAction)
190 </dd>
191 </dl>
192 <a NAME="EricToolBarDialog.__restoreCurrentToolbarToDefault" ID="EricToolBarDialog.__restoreCurrentToolbarToDefault"></a>
193 <h4>EricToolBarDialog.__restoreCurrentToolbarToDefault</h4>
194 <b>__restoreCurrentToolbarToDefault</b>(<i></i>)
195
196 <p>
197 Private method to set the current toolbar to its default configuration.
198 </p>
199 <a NAME="EricToolBarDialog.__saveToolBars" ID="EricToolBarDialog.__saveToolBars"></a>
200 <h4>EricToolBarDialog.__saveToolBars</h4>
201 <b>__saveToolBars</b>(<i></i>)
202
203 <p>
204 Private method to save the configured toolbars.
205 </p>
206 <dl>
207
208 <dt>Raises <b>RuntimeError</b>:</dt>
209 <dd>
210 raised to indicate an invalid action
211 </dd>
212 </dl>
213 <a NAME="EricToolBarDialog.__setupButtons" ID="EricToolBarDialog.__setupButtons"></a>
214 <h4>EricToolBarDialog.__setupButtons</h4>
215 <b>__setupButtons</b>(<i></i>)
216
217 <p>
218 Private slot to set the buttons state.
219 </p>
220 <a NAME="EricToolBarDialog.__toolbarComboBox_currentIndexChanged" ID="EricToolBarDialog.__toolbarComboBox_currentIndexChanged"></a>
221 <h4>EricToolBarDialog.__toolbarComboBox_currentIndexChanged</h4>
222 <b>__toolbarComboBox_currentIndexChanged</b>(<i>index</i>)
223
224 <p>
225 Private slot called upon a selection of the current toolbar.
226 </p>
227 <dl>
228
229 <dt><i>index</i></dt>
230 <dd>
231 index of the new current toolbar (integer)
232 </dd>
233 </dl>
234 <a NAME="EricToolBarDialog.on_actionsTree_currentItemChanged" ID="EricToolBarDialog.on_actionsTree_currentItemChanged"></a>
235 <h4>EricToolBarDialog.on_actionsTree_currentItemChanged</h4>
236 <b>on_actionsTree_currentItemChanged</b>(<i>current, previous</i>)
237
238 <p>
239 Private slot called, when the currently selected action changes.
240 </p>
241 <dl>
242
243 <dt><i>current</i></dt>
244 <dd>
245 reference to the current item (QTreeWidgetItem)
246 </dd>
247 <dt><i>previous</i></dt>
248 <dd>
249 reference to the previous current item
250 (QTreeWidgetItem)
251 </dd>
252 </dl>
253 <a NAME="EricToolBarDialog.on_buttonBox_clicked" ID="EricToolBarDialog.on_buttonBox_clicked"></a>
254 <h4>EricToolBarDialog.on_buttonBox_clicked</h4>
255 <b>on_buttonBox_clicked</b>(<i>button</i>)
256
257 <p>
258 Private slot called, when a button of the button box was clicked.
259 </p>
260 <dl>
261
262 <dt><i>button</i></dt>
263 <dd>
264 reference to the button clicked (QAbstractButton)
265 </dd>
266 </dl>
267 <a NAME="EricToolBarDialog.on_downButton_clicked" ID="EricToolBarDialog.on_downButton_clicked"></a>
268 <h4>EricToolBarDialog.on_downButton_clicked</h4>
269 <b>on_downButton_clicked</b>(<i></i>)
270
271 <p>
272 Private slot used to move an action down in the list.
273 </p>
274 <a NAME="EricToolBarDialog.on_leftButton_clicked" ID="EricToolBarDialog.on_leftButton_clicked"></a>
275 <h4>EricToolBarDialog.on_leftButton_clicked</h4>
276 <b>on_leftButton_clicked</b>(<i></i>)
277
278 <p>
279 Private slot to delete an action from the list.
280 </p>
281 <a NAME="EricToolBarDialog.on_newButton_clicked" ID="EricToolBarDialog.on_newButton_clicked"></a>
282 <h4>EricToolBarDialog.on_newButton_clicked</h4>
283 <b>on_newButton_clicked</b>(<i></i>)
284
285 <p>
286 Private slot to create a new toolbar.
287 </p>
288 <a NAME="EricToolBarDialog.on_removeButton_clicked" ID="EricToolBarDialog.on_removeButton_clicked"></a>
289 <h4>EricToolBarDialog.on_removeButton_clicked</h4>
290 <b>on_removeButton_clicked</b>(<i></i>)
291
292 <p>
293 Private slot to remove a custom toolbar.
294 </p>
295 <a NAME="EricToolBarDialog.on_renameButton_clicked" ID="EricToolBarDialog.on_renameButton_clicked"></a>
296 <h4>EricToolBarDialog.on_renameButton_clicked</h4>
297 <b>on_renameButton_clicked</b>(<i></i>)
298
299 <p>
300 Private slot to rename a custom toolbar.
301 </p>
302 <a NAME="EricToolBarDialog.on_rightButton_clicked" ID="EricToolBarDialog.on_rightButton_clicked"></a>
303 <h4>EricToolBarDialog.on_rightButton_clicked</h4>
304 <b>on_rightButton_clicked</b>(<i></i>)
305
306 <p>
307 Private slot to add an action to the list.
308 </p>
309 <a NAME="EricToolBarDialog.on_toolbarActionsList_currentItemChanged" ID="EricToolBarDialog.on_toolbarActionsList_currentItemChanged"></a>
310 <h4>EricToolBarDialog.on_toolbarActionsList_currentItemChanged</h4>
311 <b>on_toolbarActionsList_currentItemChanged</b>(<i>current, previous</i>)
312
313 <p>
314 Private slot to handle a change of the current item.
315 </p>
316 <dl>
317
318 <dt><i>current</i></dt>
319 <dd>
320 reference to the current item (QListWidgetItem)
321 </dd>
322 <dt><i>previous</i></dt>
323 <dd>
324 reference to the previous current item
325 (QListWidgetItem)
326 </dd>
327 </dl>
328 <a NAME="EricToolBarDialog.on_upButton_clicked" ID="EricToolBarDialog.on_upButton_clicked"></a>
329 <h4>EricToolBarDialog.on_upButton_clicked</h4>
330 <b>on_upButton_clicked</b>(<i></i>)
331
332 <p>
333 Private slot used to move an action up in the list.
334 </p>
335 <div align="right"><a href="#top">Up</a></div>
336 <hr />
337 <hr />
338 <a NAME="EricToolBarItem" ID="EricToolBarItem"></a>
339 <h2>EricToolBarItem</h2>
340
341 <p>
342 Class storing data belonging to a toolbar entry of the toolbar dialog.
343 </p>
344 <h3>Derived from</h3>
345 None
346 <h3>Class Attributes</h3>
347
348 <table>
349 <tr><td>None</td></tr>
350 </table>
351 <h3>Class Methods</h3>
352
353 <table>
354 <tr><td>None</td></tr>
355 </table>
356 <h3>Methods</h3>
357
358 <table>
359
360 <tr>
361 <td><a href="#EricToolBarItem.__init__">EricToolBarItem</a></td>
362 <td>Constructor</td>
363 </tr>
364 </table>
365 <h3>Static Methods</h3>
366
367 <table>
368 <tr><td>None</td></tr>
369 </table>
370
371 <a NAME="EricToolBarItem.__init__" ID="EricToolBarItem.__init__"></a>
372 <h4>EricToolBarItem (Constructor)</h4>
373 <b>EricToolBarItem</b>(<i>toolBarId, actionIDs, default</i>)
374
375 <p>
376 Constructor
377 </p>
378 <dl>
379
380 <dt><i>toolBarId</i></dt>
381 <dd>
382 id of the toolbar object (integer)
383 </dd>
384 <dt><i>actionIDs</i></dt>
385 <dd>
386 list of action IDs belonging to the toolbar
387 (list of integer)
388 </dd>
389 <dt><i>default</i></dt>
390 <dd>
391 flag indicating a default toolbar (boolean)
392 </dd>
393 </dl>
394 <div align="right"><a href="#top">Up</a></div>
395 <hr />
396 </body></html>

Mercurial Repository: eric

eric ide

mercurial