~ubuntu-branches/ubuntu/karmic/eric/karmic

« back to all changes in this revision

Viewing changes to eric/Documentation/Source/eric4.Graphics.ImportsDiagram.html

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2008-01-28 18:02:25 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080128180225-6nrox6yrworh2c4v
Tags: 4.0.4-1ubuntu1
* Add python-qt3 to build-depends becuase that's where Ubuntu puts 
  pyqtconfig
* Change maintainer to MOTU

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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.ImportsDiagram</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.ImportsDiagram</h1>
 
24
<p>
 
25
Module implementing a dialog showing an imports diagram of a package.
 
26
</p>
 
27
<h3>Classes</h3>
 
28
<table>
 
29
<tr>
 
30
<td><a href="#ImportsDiagram">ImportsDiagram</a></td>
 
31
<td>Class implementing a dialog showing an imports diagram of a package.</td>
 
32
</tr>
 
33
</table>
 
34
<h3>Functions</h3>
 
35
<table>
 
36
<tr><td>None</td></tr>
 
37
</table>
 
38
<hr /><hr />
 
39
<a NAME="ImportsDiagram" ID="ImportsDiagram"></a>
 
40
<h2>ImportsDiagram</h2>
 
41
<p>
 
42
    Class implementing a dialog showing an imports diagram of a package.
 
43
</p><p>
 
44
    Note: Only package internal imports are show in order to maintain
 
45
    some readability.
 
46
</p>
 
47
<h3>Derived from</h3>
 
48
UMLDialog
 
49
<h3>Methods</h3>
 
50
<table>
 
51
<tr>
 
52
<td><a href="#ImportsDiagram.__init__">ImportsDiagram</a></td>
 
53
<td>Constructor</td>
 
54
</tr><tr>
 
55
<td><a href="#ImportsDiagram.__addModule">__addModule</a></td>
 
56
<td>Private method to add a module to the diagram.</td>
 
57
</tr><tr>
 
58
<td><a href="#ImportsDiagram.__buildImports">__buildImports</a></td>
 
59
<td>Private method to build the modules shapes of the diagram.</td>
 
60
</tr><tr>
 
61
<td><a href="#ImportsDiagram.__buildModulesDict">__buildModulesDict</a></td>
 
62
<td>Private method to build a dictionary of modules contained in the package.</td>
 
63
</tr><tr>
 
64
<td><a href="#ImportsDiagram.__createAssociations">__createAssociations</a></td>
 
65
<td>Private method to generate the associations between the module shapes.</td>
 
66
</tr><tr>
 
67
<td><a href="#ImportsDiagram.relayout">relayout</a></td>
 
68
<td>Method to relayout the diagram.</td>
 
69
</tr><tr>
 
70
<td><a href="#ImportsDiagram.show">show</a></td>
 
71
<td>Overriden method to show the dialog.</td>
 
72
</tr>
 
73
</table>
 
74
<p><a NAME="ImportsDiagram.__init__" ID="ImportsDiagram.__init__"></a>
 
75
<h4>ImportsDiagram (Constructor)</h4>
 
76
<b>ImportsDiagram</b>(<i>package, parent = None, name = None</i>)
 
77
<p>
 
78
        Constructor
 
79
</p><dl>
 
80
<dt><i>package</i></dt>
 
81
<dd>
 
82
name of a python package to show the import
 
83
            relationships (string)
 
84
</dd><dt><i>parent</i></dt>
 
85
<dd>
 
86
parent widget of the view (QWidget)
 
87
</dd><dt><i>name</i></dt>
 
88
<dd>
 
89
name of the view widget (QString or string)
 
90
</dd>
 
91
</dl><a NAME="ImportsDiagram.__addModule" ID="ImportsDiagram.__addModule"></a>
 
92
<h4>ImportsDiagram.__addModule</h4>
 
93
<b>__addModule</b>(<i>name, classes, x, y</i>)
 
94
<p>
 
95
        Private method to add a module to the diagram.
 
96
</p><dl>
 
97
<dt><i>name</i></dt>
 
98
<dd>
 
99
module name to be shown (string)
 
100
</dd><dt><i>classes</i></dt>
 
101
<dd>
 
102
list of class names contained in the module
 
103
            (list of strings)
 
104
</dd><dt><i>x</i></dt>
 
105
<dd>
 
106
x-coordinate (float)
 
107
</dd><dt><i>y</i></dt>
 
108
<dd>
 
109
y-coordinate (float)
 
110
</dd>
 
111
</dl><a NAME="ImportsDiagram.__buildImports" ID="ImportsDiagram.__buildImports"></a>
 
112
<h4>ImportsDiagram.__buildImports</h4>
 
113
<b>__buildImports</b>(<i></i>)
 
114
<p>
 
115
        Private method to build the modules shapes of the diagram.
 
116
</p><a NAME="ImportsDiagram.__buildModulesDict" ID="ImportsDiagram.__buildModulesDict"></a>
 
117
<h4>ImportsDiagram.__buildModulesDict</h4>
 
118
<b>__buildModulesDict</b>(<i></i>)
 
119
<p>
 
120
        Private method to build a dictionary of modules contained in the package.
 
121
</p><dl>
 
122
<dt>Returns:</dt>
 
123
<dd>
 
124
dictionary of modules contained in the package.
 
125
</dd>
 
126
</dl><a NAME="ImportsDiagram.__createAssociations" ID="ImportsDiagram.__createAssociations"></a>
 
127
<h4>ImportsDiagram.__createAssociations</h4>
 
128
<b>__createAssociations</b>(<i>shapes</i>)
 
129
<p>
 
130
        Private method to generate the associations between the module shapes.
 
131
</p><dl>
 
132
<dt><i>shapes</i></dt>
 
133
<dd>
 
134
list of shapes
 
135
</dd>
 
136
</dl><a NAME="ImportsDiagram.relayout" ID="ImportsDiagram.relayout"></a>
 
137
<h4>ImportsDiagram.relayout</h4>
 
138
<b>relayout</b>(<i></i>)
 
139
<p>
 
140
        Method to relayout the diagram.
 
141
</p><a NAME="ImportsDiagram.show" ID="ImportsDiagram.show"></a>
 
142
<h4>ImportsDiagram.show</h4>
 
143
<b>show</b>(<i></i>)
 
144
<p>
 
145
        Overriden method to show the dialog.
 
146
</p></p>
 
147
<div align="right"><a href="#top">Up</a></div>
 
148
<hr />
 
149
</body></html>
 
 
b'\\ No newline at end of file'