1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Wt: Wt::WFlashObject Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceWt.html">Wt</a>::<a class="el" href="classWt_1_1WFlashObject.html">WFlashObject</a>
</div>
</div>
<div class="contents">
<h1>Wt::WFlashObject Class Reference</h1><!-- doxytag: class="Wt::WFlashObject" --><!-- doxytag: inherits="Wt::WContainerWidget" -->A widget that renders a Flash object (also known as Flash movie).
<a href="#_details">More...</a>
<p>
<code>#include <Wt/WFlashObject></code>
<p>
<div class="dynheader">
Inheritance diagram for Wt::WFlashObject:</div>
<div class="dynsection">
<p><center><img src="classWt_1_1WFlashObject__inherit__graph.png" border="0" usemap="#Wt_1_1WFlashObject__inherit__map" alt="Inheritance graph"></center>
<map name="Wt_1_1WFlashObject__inherit__map">
<area shape="rect" href="classWt_1_1WContainerWidget.html" title="A widget that holds and manages child widgets." alt="" coords="5,304,157,331"><area shape="rect" href="classWt_1_1WInteractWidget.html" title="An abstract widget that can receive user-interface interaction." alt="" coords="11,229,152,256"><area shape="rect" href="classWt_1_1WWebWidget.html" title="A base class for widgets with an HTML counterpart." alt="" coords="20,155,143,181"><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user-interface component." alt="" coords="33,80,129,107"><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="33,5,129,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classWt_1_1WFlashObject-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1ba25b0dc80aaea9bf6bebddb4566297"></a><!-- doxytag: member="Wt::WFlashObject::WFlashObject" ref="1ba25b0dc80aaea9bf6bebddb4566297" args="(const std::string &url, WContainerWidget *parent=0)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WFlashObject.html#1ba25b0dc80aaea9bf6bebddb4566297">WFlashObject</a> (const std::string &url, <a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> *parent=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a Flash widget. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WFlashObject.html#b171e2e30fe09b82db7e97b9b9589265">~WFlashObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#b171e2e30fe09b82db7e97b9b9589265"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WFlashObject.html#d4cb831ed24e824d7feeb2426994e2e3">resize</a> (const <a class="el" href="classWt_1_1WLength.html">WLength</a> &width, const <a class="el" href="classWt_1_1WLength.html">WLength</a> &height)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resizes the widget. <a href="#d4cb831ed24e824d7feeb2426994e2e3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WFlashObject.html#f5b66c371c595a6c749535280c2823e7">setFlashParameter</a> (const std::string &name, const <a class="el" href="classWt_1_1WString.html">WString</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a Flash parameter. <a href="#f5b66c371c595a6c749535280c2823e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WFlashObject.html#00d24cf3b700d448f504279b4c3f2501">setFlashVariable</a> (const std::string &name, const <a class="el" href="classWt_1_1WString.html">WString</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a Flash variable. <a href="#00d24cf3b700d448f504279b4c3f2501"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WFlashObject.html#fca00f0fe23c516684b7505bbbf8af62">jsFlashRef</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A JavaScript expression that returns the DOM node of the Flash object. <a href="#fca00f0fe23c516684b7505bbbf8af62"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A widget that renders a Flash object (also known as Flash movie).
<p>
This class dynamically loads a .swf Flash file in the browser.<p>
This widget is a container, which means that you can instantiate additional widgets inside it. These widgets can for example be the content that is shown when a Flash player is not available on the system or when JavaScript is disabled.<p>
Usage example: <div class="fragment"><pre class="fragment"> WFlash *player = <span class="keyword">new</span> WFlash(<span class="stringliteral">"dummy.swf"</span>, parent);
player->resize(300, 600);
player->setFlashParameter(<span class="stringliteral">"allowScriptAccess"</span>, <span class="stringliteral">"always"</span>);
player->setFlashParameter(<span class="stringliteral">"quality"</span>, <span class="stringliteral">"high"</span>);
player->setFlashParameter(<span class="stringliteral">"bgcolor"</span>, <span class="stringliteral">"#aaaaaa"</span>);
player->setFlashVariable(<span class="stringliteral">"someVar"</span>, <span class="stringliteral">"foo"</span>);
</pre></div><p>
This class uses <em>resourcesURL</em>"/swfobject.js", a companion JavaScript library, which is distributed with Wt in the resources folder, see also <a class="el" href="overview.html#deployment">deployment and resources</a>.<p>
<h3>CSS</h3>
<p>
Styling through CSS is not applicable. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="b171e2e30fe09b82db7e97b9b9589265"></a><!-- doxytag: member="Wt::WFlashObject::~WFlashObject" ref="b171e2e30fe09b82db7e97b9b9589265" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WFlashObject::~WFlashObject </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
The Flash object is removed.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d4cb831ed24e824d7feeb2426994e2e3"></a><!-- doxytag: member="Wt::WFlashObject::resize" ref="d4cb831ed24e824d7feeb2426994e2e3" args="(const WLength &width, const WLength &height)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WFlashObject::resize </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WLength.html">WLength</a> & </td>
<td class="paramname"> <em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WLength.html">WLength</a> & </td>
<td class="paramname"> <em>height</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Resizes the widget.
<p>
Specify a new size for this widget, by specifying width and height. By default a widget has automatic width and height, see <a class="el" href="classWt_1_1WLength.html#b4c9733029342fdbc1dee34a523ee40d" title="Returns whether the ength is 'auto'.">WLength::isAuto()</a>.<p>
This applies to CSS-based layout, and only <a class="el" href="classWt_1_1WWebWidget.html#73c0244d363cd2f8bd4814fe1ebee2b1">block</a> widgets can be given a size reliably.<p>
When inserted in a layout manager, the widget may be informed about its current size using <a class="el" href="classWt_1_1WWidget.html#4f83592912a7f8fa4fd35dadde78ee74" title="Sets the widget to be aware of its size set by a layout manager.">setLayoutSizeAware()</a>. If you have defined a "wtResize()" JavaScript method for the widget, then this method will also be called. operation.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WWebWidget.html#4187ef41415521e545106c970c2679f2" title="Returns the width.">width()</a>, <a class="el" href="classWt_1_1WWebWidget.html#7321103dca90574bbc3ac6ea9a91ccff" title="Returns the height.">height()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classWt_1_1WWebWidget.html#e1b84e31581405358b6d57ec14505234">Wt::WWebWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="f5b66c371c595a6c749535280c2823e7"></a><!-- doxytag: member="Wt::WFlashObject::setFlashParameter" ref="f5b66c371c595a6c749535280c2823e7" args="(const std::string &name, const WString &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WFlashObject::setFlashParameter </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets a Flash parameter.
<p>
The Flash parameters are items such as quality, scale, menu, ... Depending on the browser they are passed as attributes or PARAM objects to the Flash movie. See the adobe website for more information about these parameters: <a href="http://www.adobe.com/cfusion/knowledgebase/index.cfm?id=tn_12701">http://www.adobe.com/cfusion/knowledgebase/index.cfm?id=tn_12701</a><p>
Setting the same Flash parameter a second time will overwrite the previous value. Flash parameters can only be set before the widget is rendered for the first time, so it is recommended to call this method shortly after construction before returning to the idle loop.
</div>
</div><p>
<a class="anchor" name="00d24cf3b700d448f504279b4c3f2501"></a><!-- doxytag: member="Wt::WFlashObject::setFlashVariable" ref="00d24cf3b700d448f504279b4c3f2501" args="(const std::string &name, const WString &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WFlashObject::setFlashVariable </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets a Flash variable.
<p>
This method is a helper function to set variable values in the flashvars parameter.<p>
Setting the same Flash parameter a second time will overwrite the previous value. Flash parameters can only be set before the widget is rendered for the first time, so it is recommended to call this method shortly after construction before returning to the idle loop.
</div>
</div><p>
<a class="anchor" name="fca00f0fe23c516684b7505bbbf8af62"></a><!-- doxytag: member="Wt::WFlashObject::jsFlashRef" ref="fca00f0fe23c516684b7505bbbf8af62" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WFlashObject::jsFlashRef </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A JavaScript expression that returns the DOM node of the Flash object.
<p>
The Flash object is not stored in <a class="el" href="classWt_1_1WWidget.html#a2b7078b3b43d53a85e5244b45d504f7" title="Returns a JavaScript expression to the corresponding DOM node.">jsRef()</a>, but in <a class="el" href="classWt_1_1WFlashObject.html#fca00f0fe23c516684b7505bbbf8af62" title="A JavaScript expression that returns the DOM node of the Flash object.">jsFlashRef()</a>. Use this method in conjuction with <a class="el" href="classWt_1_1WApplication.html#2a92457b9212cef4057cb54e56183967" title="Executes some JavaScript code.">WApplication::doJavaScript()</a> or <a class="el" href="classWt_1_1JSlot.html" title="A slot that is only implemented in client side JavaScript code.">JSlot</a> in custom JavaScript code to refer to the Flash content.
</div>
</div><p>
</div>
<hr size="1"><address style="align: right;"><small>
Generated on Fri Mar 26 17:12:07 2010 for <a href="http://www.webtoolkit.eu/wt/">Wt</a> by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address>
</body>
</html>
|
