Public Member Functions

gnash::TextFormat_as Class Reference

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

#include <TextFormat_as.h>

Inheritance diagram for gnash::TextFormat_as:
Inheritance graph
[legend]
Collaboration diagram for gnash::TextFormat_as:
Collaboration graph
[legend]

List of all members.

Public Member Functions

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

Paragraph alignment.

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

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

Referenced by alignSet().

void gnash::TextFormat_as::alignSet ( const std::string &  align  ) 
const Optional<boost::uint32_t>& gnash::TextFormat_as::blockIndent (  )  const [inline]

The block indent.

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

void gnash::TextFormat_as::blockIndentSet ( const Optional< boost::uint32_t > &  x  )  [inline]
const 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 Optional< bool > &  x  )  [inline]
const Optional<bool>& gnash::TextFormat_as::bullet (  )  const [inline]

Whether the text should have a bullet.

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

void gnash::TextFormat_as::bulletSet ( const Optional< bool > &  x  )  [inline]
const 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 Optional< rgba > &  x  )  [inline]
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!

Referenced by displaySet().

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

References displaySet().

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

Font name.

void gnash::TextFormat_as::fontSet ( const Optional< std::string > &  font  )  [inline]
const 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().

void gnash::TextFormat_as::indentSet ( const Optional< boost::uint16_t > &  x  )  [inline]
const 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 Optional< bool > &  x  )  [inline]
const 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().

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

Indicates the left margin of the paragraph, in points.

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

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

Indicates the right margin of the paragraph in twips.

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

void gnash::TextFormat_as::rightMarginSet ( const Optional< boost::uint16_t > &  x  )  [inline]
const 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().

void gnash::TextFormat_as::sizeSet ( const Optional< boost::uint16_t > &  x  )  [inline]
const Optional<std::vector<int> >& gnash::TextFormat_as::tabStops (  )  const [inline]
void gnash::TextFormat_as::tabStopsSet ( const std::vector< int > &  tabStops  )  [inline]
const Optional<std::string>& gnash::TextFormat_as::target (  )  const [inline]
void gnash::TextFormat_as::targetSet ( const Optional< std::string > &  s  )  [inline]

Setters.

const 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 Optional< bool > &  x  )  [inline]
const Optional<std::string>& gnash::TextFormat_as::url (  )  const [inline]
void gnash::TextFormat_as::urlSet ( const Optional< std::string > &  s  )  [inline]

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