The TextFormat_as Relay type stores text properties. More...

#include <TextFormat_as.h>

Inheritance diagram for gnash::TextFormat_as:

Public Member Functions
	TextFormat_as ()
	~TextFormat_as ()
const boost::optional< bool > &	underlined () const
	Return a Boolean value that indicates whether the text is underlined.
const boost::optional< bool > &	bold () const
	Return a Boolean value that indicates whether the text is boldface.
const boost::optional< bool > &	italic () const
	Return a Boolean value that indicates whether the text is italicized.
const boost::optional< rgba > &	color () const
	Return the color of text using this text format.
const boost::optional< bool > &	bullet () const
	Whether the text should have a bullet.
TextField::TextFormatDisplay	display () const
	The display type (block or inline).
const boost::optional < std::vector< int > > &	tabStops () const
const boost::optional < boost::uint16_t > &	indent () const
	Indentation from left margin to the first character in the paragraph.
const boost::optional < TextField::TextAlignment > &	align () const
	Paragraph alignment.
const boost::optional < std::string > &	font () const
	Font name.
const boost::optional < std::string > &	target () const
const boost::optional < std::string > &	url () const
const boost::optional < boost::uint32_t > &	blockIndent () const
	The block indent.
const boost::optional < boost::uint16_t > &	leading () const
const boost::optional < boost::uint16_t > &	leftMargin () const
	Indicates the left margin of the paragraph, in points.
const boost::optional < boost::uint16_t > &	rightMargin () const
	Indicates the right margin of the paragraph in twips.
const boost::optional < boost::uint16_t > &	size () const
	Return a float that indicates the point size in twips.
void	targetSet (const boost::optional< std::string > &s)
	Setters.
void	urlSet (const boost::optional< std::string > &s)
void	underlinedSet (const boost::optional< bool > &x)
void	italicSet (const boost::optional< bool > &x)
void	boldSet (const boost::optional< bool > &x)
void	bulletSet (const boost::optional< bool > &x)
void	colorSet (const boost::optional< rgba > &x)
void	indentSet (const boost::optional< boost::uint16_t > &x)
void	fontSet (const boost::optional< std::string > &font)
void	alignSet (const boost::optional< TextField::TextAlignment > &x)
void	alignSet (const std::string &align)
void	blockIndentSet (const boost::optional< boost::uint32_t > &x)
void	leadingSet (const boost::optional< boost::uint16_t > &x)
void	leftMarginSet (const boost::optional< boost::uint16_t > &x)
void	rightMarginSet (const boost::optional< boost::uint16_t > &x)
void	sizeSet (const boost::optional< boost::uint16_t > &x)
void	tabStopsSet (const std::vector< int > &tabStops)
void	displaySet (TextField::TextFormatDisplay x)
	These are not optional!
void	displaySet (const std::string &display)

Detailed Description

The TextFormat_as Relay type stores text properties.

Most properties can either have a value or be null. TODO: SWF8 has two additional members: kerning and letterSpacing.

Constructor & Destructor Documentation

gnash::TextFormat_as::TextFormat_as ( )

gnash::TextFormat_as::~TextFormat_as ( ) [inline]

Member Function Documentation

const boost::optional<TextField::TextAlignment>& gnash::TextFormat_as::align ( ) const [inline]

Paragraph alignment.

Referenced by gnash::TextField::setTextFormat().

void gnash::TextFormat_as::alignSet ( const boost::optional< TextField::TextAlignment > & x ) [inline]

References x.

Referenced by alignSet().

void gnash::TextFormat_as::alignSet ( const std::string & align )

References alignSet(), gnash::TextField::ALIGN_LEFT, gnash::TextField::ALIGN_CENTER, gnash::TextField::ALIGN_RIGHT, and gnash::TextField::ALIGN_JUSTIFY.

const boost::optional<boost::uint32_t>& gnash::TextFormat_as::blockIndent ( ) const [inline]

The block indent.

Referenced by gnash::TextField::setTextFormat(), and gnash::registerTextFormatNative().

void gnash::TextFormat_as::blockIndentSet ( const boost::optional< boost::uint32_t > & x ) [inline]

References x.

Referenced by gnash::registerTextFormatNative().

const boost::optional<bool>& gnash::TextFormat_as::bold ( ) const [inline]

Return a Boolean value that indicates whether the text is boldface.

void gnash::TextFormat_as::boldSet ( const boost::optional< bool > & x ) [inline]

References x.

Referenced by gnash::registerTextFormatNative().

const boost::optional<bool>& gnash::TextFormat_as::bullet ( ) const [inline]

Whether the text should have a bullet.

Referenced by gnash::TextField::setTextFormat(), and gnash::registerTextFormatNative().

void gnash::TextFormat_as::bulletSet ( const boost::optional< bool > & x ) [inline]

References x.

Referenced by gnash::registerTextFormatNative().

const boost::optional<rgba>& gnash::TextFormat_as::color ( ) const [inline]

Return the color of text using this text format.

Referenced by gnash::TextField::setTextFormat().

void gnash::TextFormat_as::colorSet ( const boost::optional< rgba > & x ) [inline]

References x.

TextField::TextFormatDisplay gnash::TextFormat_as::display ( ) const [inline]

The display type (block or inline).

Note this is not an optional parameter.

Referenced by gnash::TextField::setTextFormat().

void gnash::TextFormat_as::displaySet ( TextField::TextFormatDisplay x ) [inline]

These are not optional!

References x.

Referenced by displaySet().

void gnash::TextFormat_as::displaySet ( const std::string & display )

References displaySet().

const boost::optional<std::string>& gnash::TextFormat_as::font ( ) const [inline]

Font name.

Referenced by fontSet().

void gnash::TextFormat_as::fontSet ( const boost::optional< std::string > & font ) [inline]

References font().

Referenced by gnash::registerTextFormatNative().

const boost::optional<boost::uint16_t>& gnash::TextFormat_as::indent ( ) const [inline]

Indentation from left margin to the first character in the paragraph.

Referenced by gnash::TextField::setTextFormat(), and gnash::registerTextFormatNative().

void gnash::TextFormat_as::indentSet ( const boost::optional< boost::uint16_t > & x ) [inline]

References x.

Referenced by gnash::registerTextFormatNative().

const boost::optional<bool>& gnash::TextFormat_as::italic ( ) const [inline]

Return a Boolean value that indicates whether the text is italicized.

void gnash::TextFormat_as::italicSet ( const boost::optional< bool > & x ) [inline]

References x.

Referenced by gnash::registerTextFormatNative().

const boost::optional<boost::uint16_t>& gnash::TextFormat_as::leading ( ) const [inline]

Return a number that indicates the amount of leading vertical space between lines.

Referenced by gnash::TextField::setTextFormat(), and gnash::registerTextFormatNative().

void gnash::TextFormat_as::leadingSet ( const boost::optional< boost::uint16_t > & x ) [inline]

References x.

Referenced by gnash::registerTextFormatNative().

const boost::optional<boost::uint16_t>& gnash::TextFormat_as::leftMargin ( ) const [inline]

Indicates the left margin of the paragraph, in points.

Referenced by gnash::TextField::setTextFormat(), and gnash::registerTextFormatNative().

void gnash::TextFormat_as::leftMarginSet ( const boost::optional< boost::uint16_t > & x ) [inline]

References x.

Referenced by gnash::registerTextFormatNative().

const boost::optional<boost::uint16_t>& gnash::TextFormat_as::rightMargin ( ) const [inline]

Indicates the right margin of the paragraph in twips.

Referenced by gnash::TextField::setTextFormat(), and gnash::registerTextFormatNative().

void gnash::TextFormat_as::rightMarginSet ( const boost::optional< boost::uint16_t > & x ) [inline]

References x.

Referenced by gnash::registerTextFormatNative().

const boost::optional<boost::uint16_t>& gnash::TextFormat_as::size ( ) const [inline]

Return a float that indicates the point size in twips.

Referenced by gnash::TextField::setTextFormat(), and gnash::registerTextFormatNative().

void gnash::TextFormat_as::sizeSet ( const boost::optional< boost::uint16_t > & x ) [inline]

References x.

Referenced by gnash::registerTextFormatNative().

const boost::optional<std::vector<int> >& gnash::TextFormat_as::tabStops ( ) const [inline]

Referenced by gnash::TextField::setTextFormat(), and tabStopsSet().

void gnash::TextFormat_as::tabStopsSet ( const std::vector< int > & tabStops ) [inline]

References tabStops().

const boost::optional<std::string>& gnash::TextFormat_as::target ( ) const [inline]

Referenced by gnash::TextField::setTextFormat().

void gnash::TextFormat_as::targetSet ( const boost::optional< std::string > & s ) [inline]

Setters.

References gnash::key::s.

Referenced by gnash::registerTextFormatNative().

const boost::optional<bool>& gnash::TextFormat_as::underlined ( ) const [inline]

Return a Boolean value that indicates whether the text is underlined.

Referenced by gnash::TextField::setTextFormat().

void gnash::TextFormat_as::underlinedSet ( const boost::optional< bool > & x ) [inline]

References x.

Referenced by gnash::registerTextFormatNative().

const boost::optional<std::string>& gnash::TextFormat_as::url ( ) const [inline]

Referenced by gnash::TextField::setTextFormat().

void gnash::TextFormat_as::urlSet ( const boost::optional< std::string > & s ) [inline]

References gnash::key::s.

Referenced by gnash::registerTextFormatNative().

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation