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

« back to all changes in this revision

Viewing changes to eric/Documentation/Source/eric4.Tools.UIPreviewer.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.Tools.UIPreviewer</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.Tools.UIPreviewer</h1>
 
24
<p>
 
25
Module implementing the UI Previewer main window.
 
26
</p>
 
27
<h3>Classes</h3>
 
28
<table>
 
29
<tr>
 
30
<td><a href="#UIPreviewer">UIPreviewer</a></td>
 
31
<td>Class implementing the UI Previewer main window.</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="UIPreviewer" ID="UIPreviewer"></a>
 
40
<h2>UIPreviewer</h2>
 
41
<p>
 
42
    Class implementing the UI Previewer main window.
 
43
</p>
 
44
<h3>Derived from</h3>
 
45
QMainWindow
 
46
<h3>Methods</h3>
 
47
<table>
 
48
<tr>
 
49
<td><a href="#UIPreviewer.__init__">UIPreviewer</a></td>
 
50
<td>Constructor</td>
 
51
</tr><tr>
 
52
<td><a href="#UIPreviewer.__about">__about</a></td>
 
53
<td>Private slot to show the about information.</td>
 
54
</tr><tr>
 
55
<td><a href="#UIPreviewer.__aboutQt">__aboutQt</a></td>
 
56
<td>Private slot to show info about Qt.</td>
 
57
</tr><tr>
 
58
<td><a href="#UIPreviewer.__copyImageToClipboard">__copyImageToClipboard</a></td>
 
59
<td>Private slot to handle the Copy Image menu action.</td>
 
60
</tr><tr>
 
61
<td><a href="#UIPreviewer.__guiStyleSelected">__guiStyleSelected</a></td>
 
62
<td>Private slot to handle the selection of a GUI style.</td>
 
63
</tr><tr>
 
64
<td><a href="#UIPreviewer.__handleCloseEvent">__handleCloseEvent</a></td>
 
65
<td>Private slot to handle the close event of a viewed QMainWidget.</td>
 
66
</tr><tr>
 
67
<td><a href="#UIPreviewer.__initActions">__initActions</a></td>
 
68
<td>Private method to define the user interface actions.</td>
 
69
</tr><tr>
 
70
<td><a href="#UIPreviewer.__initMenus">__initMenus</a></td>
 
71
<td>Private method to create the menus.</td>
 
72
</tr><tr>
 
73
<td><a href="#UIPreviewer.__initToolbars">__initToolbars</a></td>
 
74
<td>Private method to create the toolbars.</td>
 
75
</tr><tr>
 
76
<td><a href="#UIPreviewer.__loadFile">__loadFile</a></td>
 
77
<td>Private slot to load a ui file.</td>
 
78
</tr><tr>
 
79
<td><a href="#UIPreviewer.__openFile">__openFile</a></td>
 
80
<td>Private slot to load a new file.</td>
 
81
</tr><tr>
 
82
<td><a href="#UIPreviewer.__printImage">__printImage</a></td>
 
83
<td>Private slot to handle the Print Image menu action.</td>
 
84
</tr><tr>
 
85
<td><a href="#UIPreviewer.__saveImage">__saveImage</a></td>
 
86
<td>Private slot to handle the Save Image menu action.</td>
 
87
</tr><tr>
 
88
<td><a href="#UIPreviewer.__updateActions">__updateActions</a></td>
 
89
<td>Private slot to update the actions state.</td>
 
90
</tr><tr>
 
91
<td><a href="#UIPreviewer.__updateChildren">__updateChildren</a></td>
 
92
<td>Private slot to change the style of the show UI.</td>
 
93
</tr><tr>
 
94
<td><a href="#UIPreviewer.__whatsThis">__whatsThis</a></td>
 
95
<td>Private slot called in to enter Whats This mode.</td>
 
96
</tr><tr>
 
97
<td><a href="#UIPreviewer.eventFilter">eventFilter</a></td>
 
98
<td>Protected method called to filter an event.</td>
 
99
</tr><tr>
 
100
<td><a href="#UIPreviewer.show">show</a></td>
 
101
<td>Public slot to show this dialog.</td>
 
102
</tr>
 
103
</table>
 
104
<p><a NAME="UIPreviewer.__init__" ID="UIPreviewer.__init__"></a>
 
105
<h4>UIPreviewer (Constructor)</h4>
 
106
<b>UIPreviewer</b>(<i>filename = None, parent = None, name = None</i>)
 
107
<p>
 
108
        Constructor
 
109
</p><dl>
 
110
<dt><i>filename</i></dt>
 
111
<dd>
 
112
name of a UI file to load
 
113
</dd><dt><i>parent</i></dt>
 
114
<dd>
 
115
parent widget of this window (QWidget)
 
116
</dd><dt><i>name</i></dt>
 
117
<dd>
 
118
name of this window (string or QString)
 
119
</dd>
 
120
</dl><a NAME="UIPreviewer.__about" ID="UIPreviewer.__about"></a>
 
121
<h4>UIPreviewer.__about</h4>
 
122
<b>__about</b>(<i></i>)
 
123
<p>
 
124
        Private slot to show the about information.
 
125
</p><a NAME="UIPreviewer.__aboutQt" ID="UIPreviewer.__aboutQt"></a>
 
126
<h4>UIPreviewer.__aboutQt</h4>
 
127
<b>__aboutQt</b>(<i></i>)
 
128
<p>
 
129
        Private slot to show info about Qt.
 
130
</p><a NAME="UIPreviewer.__copyImageToClipboard" ID="UIPreviewer.__copyImageToClipboard"></a>
 
131
<h4>UIPreviewer.__copyImageToClipboard</h4>
 
132
<b>__copyImageToClipboard</b>(<i></i>)
 
133
<p>
 
134
        Private slot to handle the Copy Image menu action.
 
135
</p><a NAME="UIPreviewer.__guiStyleSelected" ID="UIPreviewer.__guiStyleSelected"></a>
 
136
<h4>UIPreviewer.__guiStyleSelected</h4>
 
137
<b>__guiStyleSelected</b>(<i>selectedStyle</i>)
 
138
<p>
 
139
        Private slot to handle the selection of a GUI style.
 
140
</p><dl>
 
141
<dt><i>selectedStyle</i></dt>
 
142
<dd>
 
143
name of the selected style (QString)
 
144
</dd>
 
145
</dl><a NAME="UIPreviewer.__handleCloseEvent" ID="UIPreviewer.__handleCloseEvent"></a>
 
146
<h4>UIPreviewer.__handleCloseEvent</h4>
 
147
<b>__handleCloseEvent</b>(<i></i>)
 
148
<p>
 
149
        Private slot to handle the close event of a viewed QMainWidget.
 
150
</p><a NAME="UIPreviewer.__initActions" ID="UIPreviewer.__initActions"></a>
 
151
<h4>UIPreviewer.__initActions</h4>
 
152
<b>__initActions</b>(<i></i>)
 
153
<p>
 
154
        Private method to define the user interface actions.
 
155
</p><a NAME="UIPreviewer.__initMenus" ID="UIPreviewer.__initMenus"></a>
 
156
<h4>UIPreviewer.__initMenus</h4>
 
157
<b>__initMenus</b>(<i></i>)
 
158
<p>
 
159
        Private method to create the menus.
 
160
</p><a NAME="UIPreviewer.__initToolbars" ID="UIPreviewer.__initToolbars"></a>
 
161
<h4>UIPreviewer.__initToolbars</h4>
 
162
<b>__initToolbars</b>(<i></i>)
 
163
<p>
 
164
        Private method to create the toolbars.
 
165
</p><a NAME="UIPreviewer.__loadFile" ID="UIPreviewer.__loadFile"></a>
 
166
<h4>UIPreviewer.__loadFile</h4>
 
167
<b>__loadFile</b>(<i>fn</i>)
 
168
<p>
 
169
        Private slot to load a ui file.
 
170
</p><dl>
 
171
<dt><i>fn</i></dt>
 
172
<dd>
 
173
name of the ui file to be laoded (string or QString)
 
174
</dd>
 
175
</dl><a NAME="UIPreviewer.__openFile" ID="UIPreviewer.__openFile"></a>
 
176
<h4>UIPreviewer.__openFile</h4>
 
177
<b>__openFile</b>(<i></i>)
 
178
<p>
 
179
        Private slot to load a new file.
 
180
</p><a NAME="UIPreviewer.__printImage" ID="UIPreviewer.__printImage"></a>
 
181
<h4>UIPreviewer.__printImage</h4>
 
182
<b>__printImage</b>(<i></i>)
 
183
<p>
 
184
        Private slot to handle the Print Image menu action.
 
185
</p><a NAME="UIPreviewer.__saveImage" ID="UIPreviewer.__saveImage"></a>
 
186
<h4>UIPreviewer.__saveImage</h4>
 
187
<b>__saveImage</b>(<i></i>)
 
188
<p>
 
189
        Private slot to handle the Save Image menu action.
 
190
</p><a NAME="UIPreviewer.__updateActions" ID="UIPreviewer.__updateActions"></a>
 
191
<h4>UIPreviewer.__updateActions</h4>
 
192
<b>__updateActions</b>(<i></i>)
 
193
<p>
 
194
        Private slot to update the actions state.
 
195
</p><a NAME="UIPreviewer.__updateChildren" ID="UIPreviewer.__updateChildren"></a>
 
196
<h4>UIPreviewer.__updateChildren</h4>
 
197
<b>__updateChildren</b>(<i>sstyle</i>)
 
198
<p>
 
199
        Private slot to change the style of the show UI.
 
200
</p><dl>
 
201
<dt><i>sstyle</i></dt>
 
202
<dd>
 
203
name of the selected style (QString)
 
204
</dd>
 
205
</dl><a NAME="UIPreviewer.__whatsThis" ID="UIPreviewer.__whatsThis"></a>
 
206
<h4>UIPreviewer.__whatsThis</h4>
 
207
<b>__whatsThis</b>(<i></i>)
 
208
<p>
 
209
        Private slot called in to enter Whats This mode.
 
210
</p><a NAME="UIPreviewer.eventFilter" ID="UIPreviewer.eventFilter"></a>
 
211
<h4>UIPreviewer.eventFilter</h4>
 
212
<b>eventFilter</b>(<i>obj, ev</i>)
 
213
<p>
 
214
        Protected method called to filter an event.
 
215
</p><dl>
 
216
<dt><i>object</i></dt>
 
217
<dd>
 
218
object, that generated the event (QObject)
 
219
</dd><dt><i>event</i></dt>
 
220
<dd>
 
221
the event, that was generated by object (QEvent)
 
222
</dd>
 
223
</dl><dl>
 
224
<dt>Returns:</dt>
 
225
<dd>
 
226
flag indicating if event was filtered out
 
227
</dd>
 
228
</dl><a NAME="UIPreviewer.show" ID="UIPreviewer.show"></a>
 
229
<h4>UIPreviewer.show</h4>
 
230
<b>show</b>(<i></i>)
 
231
<p>
 
232
        Public slot to show this dialog.
 
233
</p><p>
 
234
        This overloaded slot loads a UI file to be previewed after
 
235
        the main window has been shown. This way, previewing a dialog
 
236
        doesn't interfere with showing the main window.
 
237
</p></p>
 
238
<div align="right"><a href="#top">Up</a></div>
 
239
<hr />
 
240
</body></html>
 
 
b'\\ No newline at end of file'