16 |
16 |
17 a { color: #BA6D36; } |
17 a { color: #BA6D36; } |
18 |
18 |
19 </style> |
19 </style> |
20 </head> |
20 </head> |
21 <body><a NAME="top" ID="top"></a> |
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
22 <h1>eric6.E5Gui.E5ModelToolBar</h1> |
23 <h1>eric6.E5Gui.E5ModelToolBar</h1> |
|
24 |
23 <p> |
25 <p> |
24 Module implementing a tool bar populated from a QAbstractItemModel. |
26 Module implementing a tool bar populated from a QAbstractItemModel. |
25 </p> |
27 </p> |
26 <h3>Global Attributes</h3> |
28 <h3>Global Attributes</h3> |
|
29 |
27 <table> |
30 <table> |
28 <tr><td>None</td></tr> |
31 <tr><td>None</td></tr> |
29 </table> |
32 </table> |
30 <h3>Classes</h3> |
33 <h3>Classes</h3> |
31 <table> |
34 |
|
35 <table> |
|
36 |
32 <tr> |
37 <tr> |
33 <td><a href="#E5ModelToolBar">E5ModelToolBar</a></td> |
38 <td><a href="#E5ModelToolBar">E5ModelToolBar</a></td> |
34 <td>Class implementing a tool bar populated from a QAbstractItemModel.</td> |
39 <td>Class implementing a tool bar populated from a QAbstractItemModel.</td> |
35 </tr> |
40 </tr> |
36 </table> |
41 </table> |
37 <h3>Functions</h3> |
42 <h3>Functions</h3> |
38 <table> |
43 |
39 <tr><td>None</td></tr> |
44 <table> |
40 </table> |
45 <tr><td>None</td></tr> |
41 <hr /><hr /> |
46 </table> |
|
47 <hr /> |
|
48 <hr /> |
42 <a NAME="E5ModelToolBar" ID="E5ModelToolBar"></a> |
49 <a NAME="E5ModelToolBar" ID="E5ModelToolBar"></a> |
43 <h2>E5ModelToolBar</h2> |
50 <h2>E5ModelToolBar</h2> |
|
51 |
44 <p> |
52 <p> |
45 Class implementing a tool bar populated from a QAbstractItemModel. |
53 Class implementing a tool bar populated from a QAbstractItemModel. |
46 </p><h3>Signals</h3> |
54 </p> |
47 <dl> |
55 <h3>Signals</h3> |
|
56 <dl> |
|
57 |
48 <dt>activated(QModelIndex)</dt> |
58 <dt>activated(QModelIndex)</dt> |
49 <dd> |
59 <dd> |
50 emitted when an action has been triggered |
60 emitted when an action has been triggered |
51 </dd> |
61 </dd> |
52 </dl> |
62 </dl> |
53 <h3>Derived from</h3> |
63 <h3>Derived from</h3> |
54 QToolBar |
64 QToolBar |
55 <h3>Class Attributes</h3> |
65 <h3>Class Attributes</h3> |
|
66 |
56 <table> |
67 <table> |
57 <tr><td>None</td></tr> |
68 <tr><td>None</td></tr> |
58 </table> |
69 </table> |
59 <h3>Class Methods</h3> |
70 <h3>Class Methods</h3> |
|
71 |
60 <table> |
72 <table> |
61 <tr><td>None</td></tr> |
73 <tr><td>None</td></tr> |
62 </table> |
74 </table> |
63 <h3>Methods</h3> |
75 <h3>Methods</h3> |
64 <table> |
76 |
|
77 <table> |
|
78 |
65 <tr> |
79 <tr> |
66 <td><a href="#E5ModelToolBar.__init__">E5ModelToolBar</a></td> |
80 <td><a href="#E5ModelToolBar.__init__">E5ModelToolBar</a></td> |
67 <td>Constructor</td> |
81 <td>Constructor</td> |
68 </tr><tr> |
82 </tr> |
|
83 <tr> |
69 <td><a href="#E5ModelToolBar._build">_build</a></td> |
84 <td><a href="#E5ModelToolBar._build">_build</a></td> |
70 <td>Protected slot to build the tool bar.</td> |
85 <td>Protected slot to build the tool bar.</td> |
71 </tr><tr> |
86 </tr> |
|
87 <tr> |
72 <td><a href="#E5ModelToolBar._createMenu">_createMenu</a></td> |
88 <td><a href="#E5ModelToolBar._createMenu">_createMenu</a></td> |
73 <td>Protected method to create the menu for a tool bar action.</td> |
89 <td>Protected method to create the menu for a tool bar action.</td> |
74 </tr><tr> |
90 </tr> |
|
91 <tr> |
75 <td><a href="#E5ModelToolBar.dragEnterEvent">dragEnterEvent</a></td> |
92 <td><a href="#E5ModelToolBar.dragEnterEvent">dragEnterEvent</a></td> |
76 <td>Protected method to handle drag enter events.</td> |
93 <td>Protected method to handle drag enter events.</td> |
77 </tr><tr> |
94 </tr> |
|
95 <tr> |
78 <td><a href="#E5ModelToolBar.dropEvent">dropEvent</a></td> |
96 <td><a href="#E5ModelToolBar.dropEvent">dropEvent</a></td> |
79 <td>Protected method to handle drop events.</td> |
97 <td>Protected method to handle drop events.</td> |
80 </tr><tr> |
98 </tr> |
|
99 <tr> |
81 <td><a href="#E5ModelToolBar.eventFilter">eventFilter</a></td> |
100 <td><a href="#E5ModelToolBar.eventFilter">eventFilter</a></td> |
82 <td>Public method to handle event for other objects.</td> |
101 <td>Public method to handle event for other objects.</td> |
83 </tr><tr> |
102 </tr> |
|
103 <tr> |
84 <td><a href="#E5ModelToolBar.hideEvent">hideEvent</a></td> |
104 <td><a href="#E5ModelToolBar.hideEvent">hideEvent</a></td> |
85 <td>Protected method to handle hide events.</td> |
105 <td>Protected method to handle hide events.</td> |
86 </tr><tr> |
106 </tr> |
|
107 <tr> |
87 <td><a href="#E5ModelToolBar.index">index</a></td> |
108 <td><a href="#E5ModelToolBar.index">index</a></td> |
88 <td>Public method to get the index of an action.</td> |
109 <td>Public method to get the index of an action.</td> |
89 </tr><tr> |
110 </tr> |
|
111 <tr> |
90 <td><a href="#E5ModelToolBar.model">model</a></td> |
112 <td><a href="#E5ModelToolBar.model">model</a></td> |
91 <td>Public method to get a reference to the model.</td> |
113 <td>Public method to get a reference to the model.</td> |
92 </tr><tr> |
114 </tr> |
|
115 <tr> |
93 <td><a href="#E5ModelToolBar.mouseMoveEvent">mouseMoveEvent</a></td> |
116 <td><a href="#E5ModelToolBar.mouseMoveEvent">mouseMoveEvent</a></td> |
94 <td>Protected method to handle mouse move events.</td> |
117 <td>Protected method to handle mouse move events.</td> |
95 </tr><tr> |
118 </tr> |
|
119 <tr> |
96 <td><a href="#E5ModelToolBar.resetFlags">resetFlags</a></td> |
120 <td><a href="#E5ModelToolBar.resetFlags">resetFlags</a></td> |
97 <td>Public method to reset the saved internal state.</td> |
121 <td>Public method to reset the saved internal state.</td> |
98 </tr><tr> |
122 </tr> |
|
123 <tr> |
99 <td><a href="#E5ModelToolBar.rootIndex">rootIndex</a></td> |
124 <td><a href="#E5ModelToolBar.rootIndex">rootIndex</a></td> |
100 <td>Public method to get the root index.</td> |
125 <td>Public method to get the root index.</td> |
101 </tr><tr> |
126 </tr> |
|
127 <tr> |
102 <td><a href="#E5ModelToolBar.setModel">setModel</a></td> |
128 <td><a href="#E5ModelToolBar.setModel">setModel</a></td> |
103 <td>Public method to set the model for the tool bar.</td> |
129 <td>Public method to set the model for the tool bar.</td> |
104 </tr><tr> |
130 </tr> |
|
131 <tr> |
105 <td><a href="#E5ModelToolBar.setRootIndex">setRootIndex</a></td> |
132 <td><a href="#E5ModelToolBar.setRootIndex">setRootIndex</a></td> |
106 <td>Public method to set the root index.</td> |
133 <td>Public method to set the root index.</td> |
107 </tr><tr> |
134 </tr> |
|
135 <tr> |
108 <td><a href="#E5ModelToolBar.showEvent">showEvent</a></td> |
136 <td><a href="#E5ModelToolBar.showEvent">showEvent</a></td> |
109 <td>Protected method to handle show events.</td> |
137 <td>Protected method to handle show events.</td> |
110 </tr> |
138 </tr> |
111 </table> |
139 </table> |
112 <h3>Static Methods</h3> |
140 <h3>Static Methods</h3> |
113 <table> |
141 |
114 <tr><td>None</td></tr> |
142 <table> |
115 </table> |
143 <tr><td>None</td></tr> |
|
144 </table> |
|
145 |
116 <a NAME="E5ModelToolBar.__init__" ID="E5ModelToolBar.__init__"></a> |
146 <a NAME="E5ModelToolBar.__init__" ID="E5ModelToolBar.__init__"></a> |
117 <h4>E5ModelToolBar (Constructor)</h4> |
147 <h4>E5ModelToolBar (Constructor)</h4> |
118 <b>E5ModelToolBar</b>(<i>title=None, parent=None</i>) |
148 <b>E5ModelToolBar</b>(<i>title=None, parent=None</i>) |
|
149 |
119 <p> |
150 <p> |
120 Constructor |
151 Constructor |
121 </p><dl> |
152 </p> |
|
153 <dl> |
|
154 |
122 <dt><i>title</i></dt> |
155 <dt><i>title</i></dt> |
123 <dd> |
156 <dd> |
124 title for the tool bar (string) |
157 title for the tool bar (string) |
125 </dd><dt><i>parent</i></dt> |
158 </dd> |
|
159 <dt><i>parent</i></dt> |
126 <dd> |
160 <dd> |
127 reference to the parent widget (QWidget) |
161 reference to the parent widget (QWidget) |
128 </dd> |
162 </dd> |
129 </dl><a NAME="E5ModelToolBar._build" ID="E5ModelToolBar._build"></a> |
163 </dl> |
|
164 <a NAME="E5ModelToolBar._build" ID="E5ModelToolBar._build"></a> |
130 <h4>E5ModelToolBar._build</h4> |
165 <h4>E5ModelToolBar._build</h4> |
131 <b>_build</b>(<i></i>) |
166 <b>_build</b>(<i></i>) |
|
167 |
132 <p> |
168 <p> |
133 Protected slot to build the tool bar. |
169 Protected slot to build the tool bar. |
134 </p><a NAME="E5ModelToolBar._createMenu" ID="E5ModelToolBar._createMenu"></a> |
170 </p> |
|
171 <a NAME="E5ModelToolBar._createMenu" ID="E5ModelToolBar._createMenu"></a> |
135 <h4>E5ModelToolBar._createMenu</h4> |
172 <h4>E5ModelToolBar._createMenu</h4> |
136 <b>_createMenu</b>(<i></i>) |
173 <b>_createMenu</b>(<i></i>) |
|
174 |
137 <p> |
175 <p> |
138 Protected method to create the menu for a tool bar action. |
176 Protected method to create the menu for a tool bar action. |
139 </p><dl> |
177 </p> |
|
178 <dl> |
140 <dt>Returns:</dt> |
179 <dt>Returns:</dt> |
141 <dd> |
180 <dd> |
142 menu for a tool bar action (E5ModelMenu) |
181 menu for a tool bar action (E5ModelMenu) |
143 </dd> |
182 </dd> |
144 </dl><a NAME="E5ModelToolBar.dragEnterEvent" ID="E5ModelToolBar.dragEnterEvent"></a> |
183 </dl> |
|
184 <a NAME="E5ModelToolBar.dragEnterEvent" ID="E5ModelToolBar.dragEnterEvent"></a> |
145 <h4>E5ModelToolBar.dragEnterEvent</h4> |
185 <h4>E5ModelToolBar.dragEnterEvent</h4> |
146 <b>dragEnterEvent</b>(<i>evt</i>) |
186 <b>dragEnterEvent</b>(<i>evt</i>) |
|
187 |
147 <p> |
188 <p> |
148 Protected method to handle drag enter events. |
189 Protected method to handle drag enter events. |
149 </p><dl> |
190 </p> |
|
191 <dl> |
|
192 |
150 <dt><i>evt</i></dt> |
193 <dt><i>evt</i></dt> |
151 <dd> |
194 <dd> |
152 reference to the event (QDragEnterEvent) |
195 reference to the event (QDragEnterEvent) |
153 </dd> |
196 </dd> |
154 </dl><a NAME="E5ModelToolBar.dropEvent" ID="E5ModelToolBar.dropEvent"></a> |
197 </dl> |
|
198 <a NAME="E5ModelToolBar.dropEvent" ID="E5ModelToolBar.dropEvent"></a> |
155 <h4>E5ModelToolBar.dropEvent</h4> |
199 <h4>E5ModelToolBar.dropEvent</h4> |
156 <b>dropEvent</b>(<i>evt</i>) |
200 <b>dropEvent</b>(<i>evt</i>) |
|
201 |
157 <p> |
202 <p> |
158 Protected method to handle drop events. |
203 Protected method to handle drop events. |
159 </p><dl> |
204 </p> |
|
205 <dl> |
|
206 |
160 <dt><i>evt</i></dt> |
207 <dt><i>evt</i></dt> |
161 <dd> |
208 <dd> |
162 reference to the event (QDropEvent) |
209 reference to the event (QDropEvent) |
163 </dd> |
210 </dd> |
164 </dl><a NAME="E5ModelToolBar.eventFilter" ID="E5ModelToolBar.eventFilter"></a> |
211 </dl> |
|
212 <a NAME="E5ModelToolBar.eventFilter" ID="E5ModelToolBar.eventFilter"></a> |
165 <h4>E5ModelToolBar.eventFilter</h4> |
213 <h4>E5ModelToolBar.eventFilter</h4> |
166 <b>eventFilter</b>(<i>obj, evt</i>) |
214 <b>eventFilter</b>(<i>obj, evt</i>) |
|
215 |
167 <p> |
216 <p> |
168 Public method to handle event for other objects. |
217 Public method to handle event for other objects. |
169 </p><dl> |
218 </p> |
|
219 <dl> |
|
220 |
170 <dt><i>obj</i></dt> |
221 <dt><i>obj</i></dt> |
171 <dd> |
222 <dd> |
172 reference to the object (QObject) |
223 reference to the object (QObject) |
173 </dd><dt><i>evt</i></dt> |
224 </dd> |
|
225 <dt><i>evt</i></dt> |
174 <dd> |
226 <dd> |
175 reference to the event (QEvent) |
227 reference to the event (QEvent) |
176 </dd> |
228 </dd> |
177 </dl><dl> |
229 </dl> |
|
230 <dl> |
178 <dt>Returns:</dt> |
231 <dt>Returns:</dt> |
179 <dd> |
232 <dd> |
180 flag indicating that the event should be filtered out (boolean) |
233 flag indicating that the event should be filtered out (boolean) |
181 </dd> |
234 </dd> |
182 </dl><a NAME="E5ModelToolBar.hideEvent" ID="E5ModelToolBar.hideEvent"></a> |
235 </dl> |
|
236 <a NAME="E5ModelToolBar.hideEvent" ID="E5ModelToolBar.hideEvent"></a> |
183 <h4>E5ModelToolBar.hideEvent</h4> |
237 <h4>E5ModelToolBar.hideEvent</h4> |
184 <b>hideEvent</b>(<i>evt</i>) |
238 <b>hideEvent</b>(<i>evt</i>) |
|
239 |
185 <p> |
240 <p> |
186 Protected method to handle hide events. |
241 Protected method to handle hide events. |
187 </p><dl> |
242 </p> |
|
243 <dl> |
|
244 |
188 <dt><i>evt</i></dt> |
245 <dt><i>evt</i></dt> |
189 <dd> |
246 <dd> |
190 reference to the hide event (QHideEvent) |
247 reference to the hide event (QHideEvent) |
191 </dd> |
248 </dd> |
192 </dl><a NAME="E5ModelToolBar.index" ID="E5ModelToolBar.index"></a> |
249 </dl> |
|
250 <a NAME="E5ModelToolBar.index" ID="E5ModelToolBar.index"></a> |
193 <h4>E5ModelToolBar.index</h4> |
251 <h4>E5ModelToolBar.index</h4> |
194 <b>index</b>(<i>action</i>) |
252 <b>index</b>(<i>action</i>) |
|
253 |
195 <p> |
254 <p> |
196 Public method to get the index of an action. |
255 Public method to get the index of an action. |
197 </p><dl> |
256 </p> |
|
257 <dl> |
|
258 |
198 <dt><i>action</i></dt> |
259 <dt><i>action</i></dt> |
199 <dd> |
260 <dd> |
200 reference to the action to get the index for (QAction) |
261 reference to the action to get the index for (QAction) |
201 </dd> |
262 </dd> |
202 </dl><dl> |
263 </dl> |
|
264 <dl> |
203 <dt>Returns:</dt> |
265 <dt>Returns:</dt> |
204 <dd> |
266 <dd> |
205 index of the action (QModelIndex) |
267 index of the action (QModelIndex) |
206 </dd> |
268 </dd> |
207 </dl><a NAME="E5ModelToolBar.model" ID="E5ModelToolBar.model"></a> |
269 </dl> |
|
270 <a NAME="E5ModelToolBar.model" ID="E5ModelToolBar.model"></a> |
208 <h4>E5ModelToolBar.model</h4> |
271 <h4>E5ModelToolBar.model</h4> |
209 <b>model</b>(<i></i>) |
272 <b>model</b>(<i></i>) |
|
273 |
210 <p> |
274 <p> |
211 Public method to get a reference to the model. |
275 Public method to get a reference to the model. |
212 </p><dl> |
276 </p> |
|
277 <dl> |
213 <dt>Returns:</dt> |
278 <dt>Returns:</dt> |
214 <dd> |
279 <dd> |
215 reference to the model (QAbstractItemModel) |
280 reference to the model (QAbstractItemModel) |
216 </dd> |
281 </dd> |
217 </dl><a NAME="E5ModelToolBar.mouseMoveEvent" ID="E5ModelToolBar.mouseMoveEvent"></a> |
282 </dl> |
|
283 <a NAME="E5ModelToolBar.mouseMoveEvent" ID="E5ModelToolBar.mouseMoveEvent"></a> |
218 <h4>E5ModelToolBar.mouseMoveEvent</h4> |
284 <h4>E5ModelToolBar.mouseMoveEvent</h4> |
219 <b>mouseMoveEvent</b>(<i>evt</i>) |
285 <b>mouseMoveEvent</b>(<i>evt</i>) |
|
286 |
220 <p> |
287 <p> |
221 Protected method to handle mouse move events. |
288 Protected method to handle mouse move events. |
222 </p><dl> |
289 </p> |
|
290 <dl> |
|
291 |
223 <dt><i>evt</i></dt> |
292 <dt><i>evt</i></dt> |
224 <dd> |
293 <dd> |
225 reference to the event (QMouseEvent) |
294 reference to the event (QMouseEvent) |
226 </dd> |
295 </dd> |
227 </dl><a NAME="E5ModelToolBar.resetFlags" ID="E5ModelToolBar.resetFlags"></a> |
296 </dl> |
|
297 <a NAME="E5ModelToolBar.resetFlags" ID="E5ModelToolBar.resetFlags"></a> |
228 <h4>E5ModelToolBar.resetFlags</h4> |
298 <h4>E5ModelToolBar.resetFlags</h4> |
229 <b>resetFlags</b>(<i></i>) |
299 <b>resetFlags</b>(<i></i>) |
|
300 |
230 <p> |
301 <p> |
231 Public method to reset the saved internal state. |
302 Public method to reset the saved internal state. |
232 </p><a NAME="E5ModelToolBar.rootIndex" ID="E5ModelToolBar.rootIndex"></a> |
303 </p> |
|
304 <a NAME="E5ModelToolBar.rootIndex" ID="E5ModelToolBar.rootIndex"></a> |
233 <h4>E5ModelToolBar.rootIndex</h4> |
305 <h4>E5ModelToolBar.rootIndex</h4> |
234 <b>rootIndex</b>(<i></i>) |
306 <b>rootIndex</b>(<i></i>) |
|
307 |
235 <p> |
308 <p> |
236 Public method to get the root index. |
309 Public method to get the root index. |
237 </p><dl> |
310 </p> |
|
311 <dl> |
238 <dt>Returns:</dt> |
312 <dt>Returns:</dt> |
239 <dd> |
313 <dd> |
240 root index (QModelIndex) |
314 root index (QModelIndex) |
241 </dd> |
315 </dd> |
242 </dl><a NAME="E5ModelToolBar.setModel" ID="E5ModelToolBar.setModel"></a> |
316 </dl> |
|
317 <a NAME="E5ModelToolBar.setModel" ID="E5ModelToolBar.setModel"></a> |
243 <h4>E5ModelToolBar.setModel</h4> |
318 <h4>E5ModelToolBar.setModel</h4> |
244 <b>setModel</b>(<i>model</i>) |
319 <b>setModel</b>(<i>model</i>) |
|
320 |
245 <p> |
321 <p> |
246 Public method to set the model for the tool bar. |
322 Public method to set the model for the tool bar. |
247 </p><dl> |
323 </p> |
|
324 <dl> |
|
325 |
248 <dt><i>model</i></dt> |
326 <dt><i>model</i></dt> |
249 <dd> |
327 <dd> |
250 reference to the model (QAbstractItemModel) |
328 reference to the model (QAbstractItemModel) |
251 </dd> |
329 </dd> |
252 </dl><a NAME="E5ModelToolBar.setRootIndex" ID="E5ModelToolBar.setRootIndex"></a> |
330 </dl> |
|
331 <a NAME="E5ModelToolBar.setRootIndex" ID="E5ModelToolBar.setRootIndex"></a> |
253 <h4>E5ModelToolBar.setRootIndex</h4> |
332 <h4>E5ModelToolBar.setRootIndex</h4> |
254 <b>setRootIndex</b>(<i>idx</i>) |
333 <b>setRootIndex</b>(<i>idx</i>) |
|
334 |
255 <p> |
335 <p> |
256 Public method to set the root index. |
336 Public method to set the root index. |
257 </p><dl> |
337 </p> |
|
338 <dl> |
|
339 |
258 <dt><i>idx</i></dt> |
340 <dt><i>idx</i></dt> |
259 <dd> |
341 <dd> |
260 index to be set as the root index (QModelIndex) |
342 index to be set as the root index (QModelIndex) |
261 </dd> |
343 </dd> |
262 </dl><a NAME="E5ModelToolBar.showEvent" ID="E5ModelToolBar.showEvent"></a> |
344 </dl> |
|
345 <a NAME="E5ModelToolBar.showEvent" ID="E5ModelToolBar.showEvent"></a> |
263 <h4>E5ModelToolBar.showEvent</h4> |
346 <h4>E5ModelToolBar.showEvent</h4> |
264 <b>showEvent</b>(<i>evt</i>) |
347 <b>showEvent</b>(<i>evt</i>) |
|
348 |
265 <p> |
349 <p> |
266 Protected method to handle show events. |
350 Protected method to handle show events. |
267 </p><dl> |
351 </p> |
|
352 <dl> |
|
353 |
268 <dt><i>evt</i></dt> |
354 <dt><i>evt</i></dt> |
269 <dd> |
355 <dd> |
270 reference to the hide event (QHideEvent) |
356 reference to the hide event (QHideEvent) |
271 </dd> |
357 </dd> |
272 </dl> |
358 </dl> |