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