Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.Graphics.PackageItem.html
Documentation/Source/eric4.Graphics.PackageItem.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric4.Graphics.PackageItem</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.Graphics.PackageItem</h1> | |
| 24 <p> | |
| 25 Module implementing a package item. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#PackageItem">PackageItem</a></td> | |
| 35 <td>Class implementing a package item.</td> | |
| 36 </tr><tr> | |
| 37 <td><a href="#PackageModel">PackageModel</a></td> | |
| 38 <td>Class implementing the package model.</td> | |
| 39 </tr> | |
| 40 </table> | |
| 41 <h3>Functions</h3> | |
| 42 <table> | |
| 43 <tr><td>None</td></tr> | |
| 44 </table> | |
| 45 <hr /><hr /> | |
| 46 <a NAME="PackageItem" ID="PackageItem"></a> | |
| 47 <h2>PackageItem</h2> | |
| 48 <p> | |
| 49 Class implementing a package item. | |
| 50 </p> | |
| 51 <h3>Derived from</h3> | |
| 52 UMLItem | |
| 53 <h3>Class Attributes</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#PackageItem.__init__">PackageItem</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#PackageItem.__calculateSize">__calculateSize</a></td> | |
| 64 <td>Method to calculate the size of the package widget.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#PackageItem.__createTexts">__createTexts</a></td> | |
| 67 <td>Private method to create the text items of the class item.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#PackageItem.paint">paint</a></td> | |
| 70 <td>Public method to paint the item in local coordinates.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#PackageItem.setModel">setModel</a></td> | |
| 73 <td>Method to set the package model.</td> | |
| 74 </tr> | |
| 75 </table> | |
| 76 <a NAME="PackageItem.__init__" ID="PackageItem.__init__"></a> | |
| 77 <h4>PackageItem (Constructor)</h4> | |
| 78 <b>PackageItem</b>(<i>model = None, x = 0, y = 0, rounded = False, noModules = False, parent = None, scene = None</i>) | |
| 79 <p> | |
| 80 Constructor | |
| 81 </p><dl> | |
| 82 <dt><i>model</i></dt> | |
| 83 <dd> | |
| 84 module model containing the module data (ModuleModel) | |
| 85 </dd><dt><i>x</i></dt> | |
| 86 <dd> | |
| 87 x-coordinate (integer) | |
| 88 </dd><dt><i>y</i></dt> | |
| 89 <dd> | |
| 90 y-coordinate (integer) | |
| 91 </dd><dt><i>rounded</i></dt> | |
| 92 <dd> | |
| 93 flag indicating a rounded corner (boolean) | |
| 94 </dd><dt><i>noModules=</i></dt> | |
| 95 <dd> | |
| 96 flag indicating, that no module names should be | |
| 97 shown (boolean) | |
| 98 </dd><dt><i>parent=</i></dt> | |
| 99 <dd> | |
| 100 reference to the parent object (QGraphicsItem) | |
| 101 </dd><dt><i>scene=</i></dt> | |
| 102 <dd> | |
| 103 reference to the scene object (QGraphicsScene) | |
| 104 </dd> | |
| 105 </dl><a NAME="PackageItem.__calculateSize" ID="PackageItem.__calculateSize"></a> | |
| 106 <h4>PackageItem.__calculateSize</h4> | |
| 107 <b>__calculateSize</b>(<i></i>) | |
| 108 <p> | |
| 109 Method to calculate the size of the package widget. | |
| 110 </p><a NAME="PackageItem.__createTexts" ID="PackageItem.__createTexts"></a> | |
| 111 <h4>PackageItem.__createTexts</h4> | |
| 112 <b>__createTexts</b>(<i></i>) | |
| 113 <p> | |
| 114 Private method to create the text items of the class item. | |
| 115 </p><a NAME="PackageItem.paint" ID="PackageItem.paint"></a> | |
| 116 <h4>PackageItem.paint</h4> | |
| 117 <b>paint</b>(<i>painter, option, widget = None</i>) | |
| 118 <p> | |
| 119 Public method to paint the item in local coordinates. | |
| 120 </p><dl> | |
| 121 <dt><i>painter</i></dt> | |
| 122 <dd> | |
| 123 reference to the painter object (QPainter) | |
| 124 </dd><dt><i>option</i></dt> | |
| 125 <dd> | |
| 126 style options (QStyleOptionGraphicsItem) | |
| 127 </dd><dt><i>widget</i></dt> | |
| 128 <dd> | |
| 129 optional reference to the widget painted on (QWidget) | |
| 130 </dd> | |
| 131 </dl><a NAME="PackageItem.setModel" ID="PackageItem.setModel"></a> | |
| 132 <h4>PackageItem.setModel</h4> | |
| 133 <b>setModel</b>(<i>model</i>) | |
| 134 <p> | |
| 135 Method to set the package model. | |
| 136 </p><dl> | |
| 137 <dt><i>model</i></dt> | |
| 138 <dd> | |
| 139 package model containing the package data (PackageModel) | |
| 140 </dd> | |
| 141 </dl> | |
| 142 <div align="right"><a href="#top">Up</a></div> | |
| 143 <hr /><hr /> | |
| 144 <a NAME="PackageModel" ID="PackageModel"></a> | |
| 145 <h2>PackageModel</h2> | |
| 146 <p> | |
| 147 Class implementing the package model. | |
| 148 </p> | |
| 149 <h3>Derived from</h3> | |
| 150 object | |
| 151 <h3>Class Attributes</h3> | |
| 152 <table> | |
| 153 <tr><td>None</td></tr> | |
| 154 </table> | |
| 155 <h3>Methods</h3> | |
| 156 <table> | |
| 157 <tr> | |
| 158 <td><a href="#PackageModel.__init__">PackageModel</a></td> | |
| 159 <td>Constructor</td> | |
| 160 </tr><tr> | |
| 161 <td><a href="#PackageModel.addModule">addModule</a></td> | |
| 162 <td>Method to add a module to the package model.</td> | |
| 163 </tr><tr> | |
| 164 <td><a href="#PackageModel.getModules">getModules</a></td> | |
| 165 <td>Method to retrieve the modules of the package.</td> | |
| 166 </tr><tr> | |
| 167 <td><a href="#PackageModel.getName">getName</a></td> | |
| 168 <td>Method to retrieve the package name.</td> | |
| 169 </tr> | |
| 170 </table> | |
| 171 <a NAME="PackageModel.__init__" ID="PackageModel.__init__"></a> | |
| 172 <h4>PackageModel (Constructor)</h4> | |
| 173 <b>PackageModel</b>(<i>name, moduleslist = []</i>) | |
| 174 <p> | |
| 175 Constructor | |
| 176 </p><dl> | |
| 177 <dt><i>name</i></dt> | |
| 178 <dd> | |
| 179 package name (string) | |
| 180 </dd><dt><i>moduleslist</i></dt> | |
| 181 <dd> | |
| 182 list of module names (list of strings) | |
| 183 </dd> | |
| 184 </dl><a NAME="PackageModel.addModule" ID="PackageModel.addModule"></a> | |
| 185 <h4>PackageModel.addModule</h4> | |
| 186 <b>addModule</b>(<i>modulename</i>) | |
| 187 <p> | |
| 188 Method to add a module to the package model. | |
| 189 </p><dl> | |
| 190 <dt><i>modulename</i></dt> | |
| 191 <dd> | |
| 192 module name to be added (string) | |
| 193 </dd> | |
| 194 </dl><a NAME="PackageModel.getModules" ID="PackageModel.getModules"></a> | |
| 195 <h4>PackageModel.getModules</h4> | |
| 196 <b>getModules</b>(<i></i>) | |
| 197 <p> | |
| 198 Method to retrieve the modules of the package. | |
| 199 </p><dl> | |
| 200 <dt>Returns:</dt> | |
| 201 <dd> | |
| 202 list of module names (list of strings) | |
| 203 </dd> | |
| 204 </dl><a NAME="PackageModel.getName" ID="PackageModel.getName"></a> | |
| 205 <h4>PackageModel.getName</h4> | |
| 206 <b>getName</b>(<i></i>) | |
| 207 <p> | |
| 208 Method to retrieve the package name. | |
| 209 </p><dl> | |
| 210 <dt>Returns:</dt> | |
| 211 <dd> | |
| 212 package name (string) | |
| 213 </dd> | |
| 214 </dl> | |
| 215 <div align="right"><a href="#top">Up</a></div> | |
| 216 <hr /> | |
| 217 </body></html> |
