Public Member Functions

Wt::WFlashObject Class Reference

A widget that renders a Flash object (also known as Flash movie). More...

#include <Wt/WFlashObject>

Inheritance diagram for Wt::WFlashObject:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 WFlashObject (const std::string &url, WContainerWidget *parent=0)
 Constructs a Flash widget.
 ~WFlashObject ()
 Destructor.
virtual void resize (const WLength &width, const WLength &height)
 Resizes the widget.
void setFlashParameter (const std::string &name, const WString &value)
 Sets a Flash parameter.
void setFlashVariable (const std::string &name, const WString &value)
 Sets a Flash variable.
std::string jsFlashRef () const
 A JavaScript expression that returns the DOM node of the Flash object.

Detailed Description

A widget that renders a Flash object (also known as Flash movie).

This class dynamically loads a .swf Flash file in the browser.

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.

Usage example:

 WFlash *player = new WFlash("dummy.swf", parent);
 player->resize(300, 600);
 player->setFlashParameter("allowScriptAccess", "always");
 player->setFlashParameter("quality", "high");
 player->setFlashParameter("bgcolor", "#aaaaaa");
 player->setFlashVariable("someVar", "foo");

This class uses resourcesURL"/swfobject.js", a companion JavaScript library, which is distributed with Wt in the resources folder, see also deployment and resources.

CSS

Styling through CSS is not applicable.


Constructor & Destructor Documentation

Wt::WFlashObject::~WFlashObject (  )

Destructor.

The Flash object is removed.


Member Function Documentation

std::string Wt::WFlashObject::jsFlashRef (  ) const

A JavaScript expression that returns the DOM node of the Flash object.

The Flash object is not stored in jsRef(), but in jsFlashRef(). Use this method in conjuction with WApplication::doJavaScript() or JSlot in custom JavaScript code to refer to the Flash content.

void Wt::WFlashObject::resize ( const WLength width,
const WLength height 
) [virtual]

Resizes the widget.

Specify a new size for this widget, by specifying width and height. By default a widget has automatic width and height, see WLength::isAuto().

This applies to CSS-based layout, and only block widgets can be given a size reliably.

When inserted in a layout manager, the widget may be informed about its current size using setLayoutSizeAware(). If you have defined a "wtResize()" JavaScript method for the widget, then this method will also be called. operation.

See also:
width(), height()

Reimplemented from Wt::WWebWidget.

void Wt::WFlashObject::setFlashParameter ( const std::string &  name,
const WString value 
)

Sets a Flash parameter.

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: http://www.adobe.com/cfusion/knowledgebase/index.cfm?id=tn_12701

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.

void Wt::WFlashObject::setFlashVariable ( const std::string &  name,
const WString value 
)

Sets a Flash variable.

This method is a helper function to set variable values in the flashvars parameter.

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.


Generated on Sat Dec 4 2010 06:32:35 for Wt by doxygen 1.7.2