Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Graphics.ModuleItem.html

src/eric7/Documentation/Source/eric7.Graphics.ModuleItem.html

branch
eric7
changeset 10479
856476537696
parent 10259
b51dfacef37f
child 10684
58c7f23ae1cb
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Graphics.ModuleItem</h1> 9 <h1>eric7.Graphics.ModuleItem</h1>
10
11 <p> 10 <p>
12 Module implementing a module item. 11 Module implementing a module item.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#ModuleItem">ModuleItem</a></td> 22 <td><a href="#ModuleItem">ModuleItem</a></td>
25 <td>Class implementing a module item.</td> 23 <td>Class implementing a module item.</td>
26 </tr> 24 </tr>
27 <tr> 25 <tr>
28 <td><a href="#ModuleModel">ModuleModel</a></td> 26 <td><a href="#ModuleModel">ModuleModel</a></td>
29 <td>Class implementing the module model.</td> 27 <td>Class implementing the module model.</td>
30 </tr> 28 </tr>
31 </table> 29 </table>
30
32 <h3>Functions</h3> 31 <h3>Functions</h3>
33 32 <table>
34 <table> 33 <tr><td>None</td></tr>
35 <tr><td>None</td></tr> 34 </table>
36 </table> 35
37 <hr /> 36 <hr />
38 <hr /> 37 <hr />
39 <a NAME="ModuleItem" ID="ModuleItem"></a> 38 <a NAME="ModuleItem" ID="ModuleItem"></a>
40 <h2>ModuleItem</h2> 39 <h2>ModuleItem</h2>
41
42 <p> 40 <p>
43 Class implementing a module item. 41 Class implementing a module item.
44 </p> 42 </p>
43
45 <h3>Derived from</h3> 44 <h3>Derived from</h3>
46 UMLItem 45 UMLItem
47 <h3>Class Attributes</h3> 46 <h3>Class Attributes</h3>
48
49 <table> 47 <table>
50 <tr><td>ItemType</td></tr> 48 <tr><td>ItemType</td></tr>
51 </table> 49 </table>
50
52 <h3>Class Methods</h3> 51 <h3>Class Methods</h3>
53 52 <table>
54 <table>
55
56 <tr> 53 <tr>
57 <td><a href="#ModuleItem.fromDict">fromDict</a></td> 54 <td><a href="#ModuleItem.fromDict">fromDict</a></td>
58 <td>Class method to create a class item from persisted data.</td> 55 <td>Class method to create a class item from persisted data.</td>
59 </tr> 56 </tr>
60 </table> 57 </table>
58
61 <h3>Methods</h3> 59 <h3>Methods</h3>
62 60 <table>
63 <table>
64
65 <tr> 61 <tr>
66 <td><a href="#ModuleItem.__init__">ModuleItem</a></td> 62 <td><a href="#ModuleItem.__init__">ModuleItem</a></td>
67 <td>Constructor</td> 63 <td>Constructor</td>
68 </tr> 64 </tr>
69 <tr> 65 <tr>
89 <tr> 85 <tr>
90 <td><a href="#ModuleItem.toDict">toDict</a></td> 86 <td><a href="#ModuleItem.toDict">toDict</a></td>
91 <td>Public method to collect data to be persisted.</td> 87 <td>Public method to collect data to be persisted.</td>
92 </tr> 88 </tr>
93 </table> 89 </table>
90
94 <h3>Static Methods</h3> 91 <h3>Static Methods</h3>
95 92 <table>
96 <table> 93 <tr><td>None</td></tr>
97 <tr><td>None</td></tr> 94 </table>
98 </table> 95
99 96
100 <a NAME="ModuleItem.fromDict" ID="ModuleItem.fromDict"></a> 97 <a NAME="ModuleItem.fromDict" ID="ModuleItem.fromDict"></a>
101 <h4>ModuleItem.fromDict (class method)</h4> 98 <h4>ModuleItem.fromDict (class method)</h4>
102 <b>fromDict</b>(<i>data, colors=None</i>) 99 <b>fromDict</b>(<i>data, colors=None</i>)
103
104 <p> 100 <p>
105 Class method to create a class item from persisted data. 101 Class method to create a class item from persisted data.
106 </p> 102 </p>
103
107 <dl> 104 <dl>
108 105
109 <dt><i>data</i> (dict)</dt> 106 <dt><i>data</i> (dict)</dt>
110 <dd> 107 <dd>
111 dictionary containing the persisted data as generated 108 dictionary containing the persisted data as generated
129 </dd> 126 </dd>
130 </dl> 127 </dl>
131 <a NAME="ModuleItem.__init__" ID="ModuleItem.__init__"></a> 128 <a NAME="ModuleItem.__init__" ID="ModuleItem.__init__"></a>
132 <h4>ModuleItem (Constructor)</h4> 129 <h4>ModuleItem (Constructor)</h4>
133 <b>ModuleItem</b>(<i>model=None, x=0, y=0, rounded=False, colors=None, parent=None, scene=None</i>) 130 <b>ModuleItem</b>(<i>model=None, x=0, y=0, rounded=False, colors=None, parent=None, scene=None</i>)
134
135 <p> 131 <p>
136 Constructor 132 Constructor
137 </p> 133 </p>
134
138 <dl> 135 <dl>
139 136
140 <dt><i>model</i> (ModuleModel)</dt> 137 <dt><i>model</i> (ModuleModel)</dt>
141 <dd> 138 <dd>
142 module model containing the module data 139 module model containing the module data
167 </dd> 164 </dd>
168 </dl> 165 </dl>
169 <a NAME="ModuleItem.__calculateSize" ID="ModuleItem.__calculateSize"></a> 166 <a NAME="ModuleItem.__calculateSize" ID="ModuleItem.__calculateSize"></a>
170 <h4>ModuleItem.__calculateSize</h4> 167 <h4>ModuleItem.__calculateSize</h4>
171 <b>__calculateSize</b>(<i></i>) 168 <b>__calculateSize</b>(<i></i>)
172
173 <p> 169 <p>
174 Private method to calculate the size of the module item. 170 Private method to calculate the size of the module item.
175 </p> 171 </p>
172
176 <a NAME="ModuleItem.__createTexts" ID="ModuleItem.__createTexts"></a> 173 <a NAME="ModuleItem.__createTexts" ID="ModuleItem.__createTexts"></a>
177 <h4>ModuleItem.__createTexts</h4> 174 <h4>ModuleItem.__createTexts</h4>
178 <b>__createTexts</b>(<i></i>) 175 <b>__createTexts</b>(<i></i>)
179
180 <p> 176 <p>
181 Private method to create the text items of the module item. 177 Private method to create the text items of the module item.
182 </p> 178 </p>
179
183 <a NAME="ModuleItem.paint" ID="ModuleItem.paint"></a> 180 <a NAME="ModuleItem.paint" ID="ModuleItem.paint"></a>
184 <h4>ModuleItem.paint</h4> 181 <h4>ModuleItem.paint</h4>
185 <b>paint</b>(<i>painter, option, widget=None</i>) 182 <b>paint</b>(<i>painter, option, widget=None</i>)
186
187 <p> 183 <p>
188 Public method to paint the item in local coordinates. 184 Public method to paint the item in local coordinates.
189 </p> 185 </p>
186
190 <dl> 187 <dl>
191 188
192 <dt><i>painter</i> (QPainter)</dt> 189 <dt><i>painter</i> (QPainter)</dt>
193 <dd> 190 <dd>
194 reference to the painter object 191 reference to the painter object
203 </dd> 200 </dd>
204 </dl> 201 </dl>
205 <a NAME="ModuleItem.parseItemDataString" ID="ModuleItem.parseItemDataString"></a> 202 <a NAME="ModuleItem.parseItemDataString" ID="ModuleItem.parseItemDataString"></a>
206 <h4>ModuleItem.parseItemDataString</h4> 203 <h4>ModuleItem.parseItemDataString</h4>
207 <b>parseItemDataString</b>(<i>version, data</i>) 204 <b>parseItemDataString</b>(<i>version, data</i>)
208
209 <p> 205 <p>
210 Public method to parse the given persistence data. 206 Public method to parse the given persistence data.
211 </p> 207 </p>
208
212 <dl> 209 <dl>
213 210
214 <dt><i>version</i> (str)</dt> 211 <dt><i>version</i> (str)</dt>
215 <dd> 212 <dd>
216 version of the data 213 version of the data
233 </dd> 230 </dd>
234 </dl> 231 </dl>
235 <a NAME="ModuleItem.setModel" ID="ModuleItem.setModel"></a> 232 <a NAME="ModuleItem.setModel" ID="ModuleItem.setModel"></a>
236 <h4>ModuleItem.setModel</h4> 233 <h4>ModuleItem.setModel</h4>
237 <b>setModel</b>(<i>model</i>) 234 <b>setModel</b>(<i>model</i>)
238
239 <p> 235 <p>
240 Public method to set the module model. 236 Public method to set the module model.
241 </p> 237 </p>
238
242 <dl> 239 <dl>
243 240
244 <dt><i>model</i> (ModuleModel)</dt> 241 <dt><i>model</i> (ModuleModel)</dt>
245 <dd> 242 <dd>
246 module model containing the module data 243 module model containing the module data
247 </dd> 244 </dd>
248 </dl> 245 </dl>
249 <a NAME="ModuleItem.toDict" ID="ModuleItem.toDict"></a> 246 <a NAME="ModuleItem.toDict" ID="ModuleItem.toDict"></a>
250 <h4>ModuleItem.toDict</h4> 247 <h4>ModuleItem.toDict</h4>
251 <b>toDict</b>(<i></i>) 248 <b>toDict</b>(<i></i>)
252
253 <p> 249 <p>
254 Public method to collect data to be persisted. 250 Public method to collect data to be persisted.
255 </p> 251 </p>
252
256 <dl> 253 <dl>
257 <dt>Return:</dt> 254 <dt>Return:</dt>
258 <dd> 255 <dd>
259 dictionary containing data to be persisted 256 dictionary containing data to be persisted
260 </dd> 257 </dd>
268 <div align="right"><a href="#top">Up</a></div> 265 <div align="right"><a href="#top">Up</a></div>
269 <hr /> 266 <hr />
270 <hr /> 267 <hr />
271 <a NAME="ModuleModel" ID="ModuleModel"></a> 268 <a NAME="ModuleModel" ID="ModuleModel"></a>
272 <h2>ModuleModel</h2> 269 <h2>ModuleModel</h2>
273
274 <p> 270 <p>
275 Class implementing the module model. 271 Class implementing the module model.
276 </p> 272 </p>
273
277 <h3>Derived from</h3> 274 <h3>Derived from</h3>
278 UMLModel 275 UMLModel
279 <h3>Class Attributes</h3> 276 <h3>Class Attributes</h3>
280 277 <table>
281 <table> 278 <tr><td>None</td></tr>
282 <tr><td>None</td></tr> 279 </table>
283 </table> 280
284 <h3>Class Methods</h3> 281 <h3>Class Methods</h3>
285 282 <table>
286 <table> 283 <tr><td>None</td></tr>
287 <tr><td>None</td></tr> 284 </table>
288 </table> 285
289 <h3>Methods</h3> 286 <h3>Methods</h3>
290 287 <table>
291 <table>
292
293 <tr> 288 <tr>
294 <td><a href="#ModuleModel.__init__">ModuleModel</a></td> 289 <td><a href="#ModuleModel.__init__">ModuleModel</a></td>
295 <td>Constructor</td> 290 <td>Constructor</td>
296 </tr> 291 </tr>
297 <tr> 292 <tr>
301 <tr> 296 <tr>
302 <td><a href="#ModuleModel.getClasses">getClasses</a></td> 297 <td><a href="#ModuleModel.getClasses">getClasses</a></td>
303 <td>Public method to retrieve the classes of the module.</td> 298 <td>Public method to retrieve the classes of the module.</td>
304 </tr> 299 </tr>
305 </table> 300 </table>
301
306 <h3>Static Methods</h3> 302 <h3>Static Methods</h3>
307 303 <table>
308 <table> 304 <tr><td>None</td></tr>
309 <tr><td>None</td></tr> 305 </table>
310 </table> 306
311 307
312 <a NAME="ModuleModel.__init__" ID="ModuleModel.__init__"></a> 308 <a NAME="ModuleModel.__init__" ID="ModuleModel.__init__"></a>
313 <h4>ModuleModel (Constructor)</h4> 309 <h4>ModuleModel (Constructor)</h4>
314 <b>ModuleModel</b>(<i>name, classlist=None</i>) 310 <b>ModuleModel</b>(<i>name, classlist=None</i>)
315
316 <p> 311 <p>
317 Constructor 312 Constructor
318 </p> 313 </p>
314
319 <dl> 315 <dl>
320 316
321 <dt><i>name</i> (str)</dt> 317 <dt><i>name</i> (str)</dt>
322 <dd> 318 <dd>
323 the module name 319 the module name
328 </dd> 324 </dd>
329 </dl> 325 </dl>
330 <a NAME="ModuleModel.addClass" ID="ModuleModel.addClass"></a> 326 <a NAME="ModuleModel.addClass" ID="ModuleModel.addClass"></a>
331 <h4>ModuleModel.addClass</h4> 327 <h4>ModuleModel.addClass</h4>
332 <b>addClass</b>(<i>classname</i>) 328 <b>addClass</b>(<i>classname</i>)
333
334 <p> 329 <p>
335 Public method to add a class to the module model. 330 Public method to add a class to the module model.
336 </p> 331 </p>
332
337 <dl> 333 <dl>
338 334
339 <dt><i>classname</i> (str)</dt> 335 <dt><i>classname</i> (str)</dt>
340 <dd> 336 <dd>
341 class name to be added 337 class name to be added
342 </dd> 338 </dd>
343 </dl> 339 </dl>
344 <a NAME="ModuleModel.getClasses" ID="ModuleModel.getClasses"></a> 340 <a NAME="ModuleModel.getClasses" ID="ModuleModel.getClasses"></a>
345 <h4>ModuleModel.getClasses</h4> 341 <h4>ModuleModel.getClasses</h4>
346 <b>getClasses</b>(<i></i>) 342 <b>getClasses</b>(<i></i>)
347
348 <p> 343 <p>
349 Public method to retrieve the classes of the module. 344 Public method to retrieve the classes of the module.
350 </p> 345 </p>
346
351 <dl> 347 <dl>
352 <dt>Return:</dt> 348 <dt>Return:</dt>
353 <dd> 349 <dd>
354 list of class names 350 list of class names
355 </dd> 351 </dd>

Mercurial Repository: eric

eric ide

mercurial