Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.E5Gui.E5ToolBarDialog.html

eric6/Documentation/Source/eric6.E5Gui.E5ToolBarDialog.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.E5Gui.E5ToolBarDialog</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.E5Gui.E5ToolBarDialog</h1>
23 <p>
24 Module implementing a toolbar configuration dialog.
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="#E5ToolBarDialog">E5ToolBarDialog</a></td>
34 <td>Class implementing a toolbar configuration dialog.</td>
35 </tr><tr>
36 <td><a href="#E5ToolBarItem">E5ToolBarItem</a></td>
37 <td>Class storing data belonging to a toolbar entry of the toolbar dialog.</td>
38 </tr>
39 </table>
40 <h3>Functions</h3>
41 <table>
42 <tr><td>None</td></tr>
43 </table>
44 <hr /><hr />
45 <a NAME="E5ToolBarDialog" ID="E5ToolBarDialog"></a>
46 <h2>E5ToolBarDialog</h2>
47 <p>
48 Class implementing a toolbar configuration dialog.
49 </p>
50 <h3>Derived from</h3>
51 QDialog, Ui_E5ToolBarDialog
52 <h3>Class Attributes</h3>
53 <table>
54 <tr><td>ActionIdRole</td></tr><tr><td>WidgetActionRole</td></tr>
55 </table>
56 <h3>Class Methods</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#E5ToolBarDialog.__init__">E5ToolBarDialog</a></td>
64 <td>Constructor</td>
65 </tr><tr>
66 <td><a href="#E5ToolBarDialog.__resetCurrentToolbar">__resetCurrentToolbar</a></td>
67 <td>Private method to revert all changes made to the current toolbar.</td>
68 </tr><tr>
69 <td><a href="#E5ToolBarDialog.__restoreCurrentToolbar">__restoreCurrentToolbar</a></td>
70 <td>Private methdo to restore the current toolbar to the given list of actions.</td>
71 </tr><tr>
72 <td><a href="#E5ToolBarDialog.__restoreCurrentToolbarToDefault">__restoreCurrentToolbarToDefault</a></td>
73 <td>Private method to set the current toolbar to its default configuration.</td>
74 </tr><tr>
75 <td><a href="#E5ToolBarDialog.__saveToolBars">__saveToolBars</a></td>
76 <td>Private method to save the configured toolbars.</td>
77 </tr><tr>
78 <td><a href="#E5ToolBarDialog.__setupButtons">__setupButtons</a></td>
79 <td>Private slot to set the buttons state.</td>
80 </tr><tr>
81 <td><a href="#E5ToolBarDialog.__toolbarComboBox_currentIndexChanged">__toolbarComboBox_currentIndexChanged</a></td>
82 <td>Private slot called upon a selection of the current toolbar.</td>
83 </tr><tr>
84 <td><a href="#E5ToolBarDialog.on_actionsTree_currentItemChanged">on_actionsTree_currentItemChanged</a></td>
85 <td>Private slot called, when the currently selected action changes.</td>
86 </tr><tr>
87 <td><a href="#E5ToolBarDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
88 <td>Private slot called, when a button of the button box was clicked.</td>
89 </tr><tr>
90 <td><a href="#E5ToolBarDialog.on_downButton_clicked">on_downButton_clicked</a></td>
91 <td>Private slot used to move an action down in the list.</td>
92 </tr><tr>
93 <td><a href="#E5ToolBarDialog.on_leftButton_clicked">on_leftButton_clicked</a></td>
94 <td>Private slot to delete an action from the list.</td>
95 </tr><tr>
96 <td><a href="#E5ToolBarDialog.on_newButton_clicked">on_newButton_clicked</a></td>
97 <td>Private slot to create a new toolbar.</td>
98 </tr><tr>
99 <td><a href="#E5ToolBarDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
100 <td>Private slot to remove a custom toolbar.</td>
101 </tr><tr>
102 <td><a href="#E5ToolBarDialog.on_renameButton_clicked">on_renameButton_clicked</a></td>
103 <td>Private slot to rename a custom toolbar.</td>
104 </tr><tr>
105 <td><a href="#E5ToolBarDialog.on_rightButton_clicked">on_rightButton_clicked</a></td>
106 <td>Private slot to add an action to the list.</td>
107 </tr><tr>
108 <td><a href="#E5ToolBarDialog.on_toolbarActionsList_currentItemChanged">on_toolbarActionsList_currentItemChanged</a></td>
109 <td>Private slot to handle a change of the current item.</td>
110 </tr><tr>
111 <td><a href="#E5ToolBarDialog.on_upButton_clicked">on_upButton_clicked</a></td>
112 <td>Private slot used to move an action up in the list.</td>
113 </tr>
114 </table>
115 <h3>Static Methods</h3>
116 <table>
117 <tr><td>None</td></tr>
118 </table>
119 <a NAME="E5ToolBarDialog.__init__" ID="E5ToolBarDialog.__init__"></a>
120 <h4>E5ToolBarDialog (Constructor)</h4>
121 <b>E5ToolBarDialog</b>(<i>toolBarManager, parent=None</i>)
122 <p>
123 Constructor
124 </p><dl>
125 <dt><i>toolBarManager</i></dt>
126 <dd>
127 reference to a toolbar manager object
128 (E5ToolBarManager)
129 </dd><dt><i>parent</i></dt>
130 <dd>
131 reference to the parent widget (QWidget)
132 </dd>
133 </dl><a NAME="E5ToolBarDialog.__resetCurrentToolbar" ID="E5ToolBarDialog.__resetCurrentToolbar"></a>
134 <h4>E5ToolBarDialog.__resetCurrentToolbar</h4>
135 <b>__resetCurrentToolbar</b>(<i></i>)
136 <p>
137 Private method to revert all changes made to the current toolbar.
138 </p><a NAME="E5ToolBarDialog.__restoreCurrentToolbar" ID="E5ToolBarDialog.__restoreCurrentToolbar"></a>
139 <h4>E5ToolBarDialog.__restoreCurrentToolbar</h4>
140 <b>__restoreCurrentToolbar</b>(<i>actions</i>)
141 <p>
142 Private methdo to restore the current toolbar to the given list of
143 actions.
144 </p><dl>
145 <dt><i>actions</i></dt>
146 <dd>
147 list of actions to set for the current toolbar
148 (list of QAction)
149 </dd>
150 </dl><a NAME="E5ToolBarDialog.__restoreCurrentToolbarToDefault" ID="E5ToolBarDialog.__restoreCurrentToolbarToDefault"></a>
151 <h4>E5ToolBarDialog.__restoreCurrentToolbarToDefault</h4>
152 <b>__restoreCurrentToolbarToDefault</b>(<i></i>)
153 <p>
154 Private method to set the current toolbar to its default configuration.
155 </p><a NAME="E5ToolBarDialog.__saveToolBars" ID="E5ToolBarDialog.__saveToolBars"></a>
156 <h4>E5ToolBarDialog.__saveToolBars</h4>
157 <b>__saveToolBars</b>(<i></i>)
158 <p>
159 Private method to save the configured toolbars.
160 </p><dl>
161 <dt>Raises <b>RuntimeError</b>:</dt>
162 <dd>
163 raised to indicate an invalid action
164 </dd>
165 </dl><a NAME="E5ToolBarDialog.__setupButtons" ID="E5ToolBarDialog.__setupButtons"></a>
166 <h4>E5ToolBarDialog.__setupButtons</h4>
167 <b>__setupButtons</b>(<i></i>)
168 <p>
169 Private slot to set the buttons state.
170 </p><a NAME="E5ToolBarDialog.__toolbarComboBox_currentIndexChanged" ID="E5ToolBarDialog.__toolbarComboBox_currentIndexChanged"></a>
171 <h4>E5ToolBarDialog.__toolbarComboBox_currentIndexChanged</h4>
172 <b>__toolbarComboBox_currentIndexChanged</b>(<i>index</i>)
173 <p>
174 Private slot called upon a selection of the current toolbar.
175 </p><dl>
176 <dt><i>index</i></dt>
177 <dd>
178 index of the new current toolbar (integer)
179 </dd>
180 </dl><a NAME="E5ToolBarDialog.on_actionsTree_currentItemChanged" ID="E5ToolBarDialog.on_actionsTree_currentItemChanged"></a>
181 <h4>E5ToolBarDialog.on_actionsTree_currentItemChanged</h4>
182 <b>on_actionsTree_currentItemChanged</b>(<i>current, previous</i>)
183 <p>
184 Private slot called, when the currently selected action changes.
185 </p><dl>
186 <dt><i>current</i></dt>
187 <dd>
188 reference to the current item (QTreeWidgetItem)
189 </dd><dt><i>previous</i></dt>
190 <dd>
191 reference to the previous current item
192 (QTreeWidgetItem)
193 </dd>
194 </dl><a NAME="E5ToolBarDialog.on_buttonBox_clicked" ID="E5ToolBarDialog.on_buttonBox_clicked"></a>
195 <h4>E5ToolBarDialog.on_buttonBox_clicked</h4>
196 <b>on_buttonBox_clicked</b>(<i>button</i>)
197 <p>
198 Private slot called, when a button of the button box was clicked.
199 </p><dl>
200 <dt><i>button</i></dt>
201 <dd>
202 reference to the button clicked (QAbstractButton)
203 </dd>
204 </dl><a NAME="E5ToolBarDialog.on_downButton_clicked" ID="E5ToolBarDialog.on_downButton_clicked"></a>
205 <h4>E5ToolBarDialog.on_downButton_clicked</h4>
206 <b>on_downButton_clicked</b>(<i></i>)
207 <p>
208 Private slot used to move an action down in the list.
209 </p><a NAME="E5ToolBarDialog.on_leftButton_clicked" ID="E5ToolBarDialog.on_leftButton_clicked"></a>
210 <h4>E5ToolBarDialog.on_leftButton_clicked</h4>
211 <b>on_leftButton_clicked</b>(<i></i>)
212 <p>
213 Private slot to delete an action from the list.
214 </p><a NAME="E5ToolBarDialog.on_newButton_clicked" ID="E5ToolBarDialog.on_newButton_clicked"></a>
215 <h4>E5ToolBarDialog.on_newButton_clicked</h4>
216 <b>on_newButton_clicked</b>(<i></i>)
217 <p>
218 Private slot to create a new toolbar.
219 </p><a NAME="E5ToolBarDialog.on_removeButton_clicked" ID="E5ToolBarDialog.on_removeButton_clicked"></a>
220 <h4>E5ToolBarDialog.on_removeButton_clicked</h4>
221 <b>on_removeButton_clicked</b>(<i></i>)
222 <p>
223 Private slot to remove a custom toolbar.
224 </p><a NAME="E5ToolBarDialog.on_renameButton_clicked" ID="E5ToolBarDialog.on_renameButton_clicked"></a>
225 <h4>E5ToolBarDialog.on_renameButton_clicked</h4>
226 <b>on_renameButton_clicked</b>(<i></i>)
227 <p>
228 Private slot to rename a custom toolbar.
229 </p><a NAME="E5ToolBarDialog.on_rightButton_clicked" ID="E5ToolBarDialog.on_rightButton_clicked"></a>
230 <h4>E5ToolBarDialog.on_rightButton_clicked</h4>
231 <b>on_rightButton_clicked</b>(<i></i>)
232 <p>
233 Private slot to add an action to the list.
234 </p><a NAME="E5ToolBarDialog.on_toolbarActionsList_currentItemChanged" ID="E5ToolBarDialog.on_toolbarActionsList_currentItemChanged"></a>
235 <h4>E5ToolBarDialog.on_toolbarActionsList_currentItemChanged</h4>
236 <b>on_toolbarActionsList_currentItemChanged</b>(<i>current, previous</i>)
237 <p>
238 Private slot to handle a change of the current item.
239 </p><dl>
240 <dt><i>current</i></dt>
241 <dd>
242 reference to the current item (QListWidgetItem)
243 </dd><dt><i>previous</i></dt>
244 <dd>
245 reference to the previous current item
246 (QListWidgetItem)
247 </dd>
248 </dl><a NAME="E5ToolBarDialog.on_upButton_clicked" ID="E5ToolBarDialog.on_upButton_clicked"></a>
249 <h4>E5ToolBarDialog.on_upButton_clicked</h4>
250 <b>on_upButton_clicked</b>(<i></i>)
251 <p>
252 Private slot used to move an action up in the list.
253 </p>
254 <div align="right"><a href="#top">Up</a></div>
255 <hr /><hr />
256 <a NAME="E5ToolBarItem" ID="E5ToolBarItem"></a>
257 <h2>E5ToolBarItem</h2>
258 <p>
259 Class storing data belonging to a toolbar entry of the toolbar dialog.
260 </p>
261 <h3>Derived from</h3>
262 object
263 <h3>Class Attributes</h3>
264 <table>
265 <tr><td>None</td></tr>
266 </table>
267 <h3>Class Methods</h3>
268 <table>
269 <tr><td>None</td></tr>
270 </table>
271 <h3>Methods</h3>
272 <table>
273 <tr>
274 <td><a href="#E5ToolBarItem.__init__">E5ToolBarItem</a></td>
275 <td>Constructor</td>
276 </tr>
277 </table>
278 <h3>Static Methods</h3>
279 <table>
280 <tr><td>None</td></tr>
281 </table>
282 <a NAME="E5ToolBarItem.__init__" ID="E5ToolBarItem.__init__"></a>
283 <h4>E5ToolBarItem (Constructor)</h4>
284 <b>E5ToolBarItem</b>(<i>toolBarId, actionIDs, default</i>)
285 <p>
286 Constructor
287 </p><dl>
288 <dt><i>toolBarId</i></dt>
289 <dd>
290 id of the toolbar object (integer)
291 </dd><dt><i>actionIDs</i></dt>
292 <dd>
293 list of action IDs belonging to the toolbar
294 (list of integer)
295 </dd><dt><i>default</i></dt>
296 <dd>
297 flag indicating a default toolbar (boolean)
298 </dd>
299 </dl>
300 <div align="right"><a href="#top">Up</a></div>
301 <hr />
302 </body></html>

Mercurial Repository: eric

eric ide

mercurial