sswf::TagSetBackgroundColor Class Reference

Set the background color of the movie. More...

#include <libsswf.h>

Inheritance diagram for sswf::TagSetBackgroundColor:


Public Member Functions
Color &	GetColor (void)
	Retrive the current background color.
virtual ErrorManager::error_code_t	Save (Data &data)
	Save the background color.
void	SetColor (Color &color)
	Defines the color of the background.
	TagSetBackgroundColor (TagBase *parent)
	Initializes the background color object.
virtual swf_type_t	TypeFlags (void) const
	Defines the different types of the background color tag.
Private Attributes
Color	f_color

Detailed Description

This tag is used to defined the default background color of the movie. When unspecified, the background of a Flash animation is white.

Note however that the default color of a TagSetBackgroundColor is black.

The background color uses a solid color (no transparency). This prevents the Browsers from showing anything behind the Flash animation.

TagSetBackgroundColor::TagSetBackgroundColor ( TagBase * parent )

Initializes the background object.

Parameters:

[in] parent The header in which this tag is added

Color & TagSetBackgroundColor::GetColor ( void )

This function returns a copy of the current background color.

ErrorManager::error_code_t TagSetBackgroundColor::Save ( Data & data ) [virtual]

This function saves the background color in the specified Data buffer.

The red, green and blue components are saved. The alpha channel is ignored.

Returns:: An ErrorManager::error_code_t error, ErrorManager::ERROR_CODE_NONE when no error occured

void TagSetBackgroundColor::SetColor ( Color & color )

This function copies the user color as the new background color.

Parameters:

[in] color The new background color

TagBase::swf_type_t TagSetBackgroundColor::TypeFlags ( void ) const [virtual]

This function defines the SetBackgroundColor tag as:

The documentation for this class was generated from the following files:

Generated on Sun May 13 23:29:40 2007 for libsswf by

1.4.7