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