sswf::TagEditText Class Reference

#include <libsswf.h>

Inheritance diagram for sswf::TagEditText:


Public Types
	EDIT_TEXT_ALIGNMENT_CENTER = 2
	EDIT_TEXT_ALIGNMENT_JUSTIFY = 3
	EDIT_TEXT_ALIGNMENT_LEFT = 0
	EDIT_TEXT_ALIGNMENT_RIGHT = 1
enum	edit_text_alignment_t { EDIT_TEXT_ALIGNMENT_LEFT = 0, EDIT_TEXT_ALIGNMENT_RIGHT = 1, EDIT_TEXT_ALIGNMENT_CENTER = 2, EDIT_TEXT_ALIGNMENT_JUSTIFY = 3 }
Public Member Functions
void	AddUsedString (const char *string)
virtual ErrorManager::error_code_t	Save (Data &data)
	Pre-save all the children tags of this tag.
void	SetAlign (edit_text_alignment_t align)
void	SetAutoSize (bool status=true)
void	SetBorder (bool status=true)
void	SetBounds (const SRectangle &bounds)
void	SetColor (Color &color)
void	SetFont (const TagFont *font, long height)
void	SetHTML (bool status=true)
void	SetIndent (long indent)
void	SetLeading (long leading)
void	SetMargins (long left, long right)
void	SetMaxLength (long length)
void	SetMultiline (bool status=true)
void	SetNoSelect (bool status=true)
void	SetOutline (bool status=true)
void	SetPassword (bool status=true)
void	SetReadOnly (bool status=true)
void	SetText (const char *text)
void	SetUsedGlyphs (const char *lists)
void	SetVariableName (const char *name)
void	SetWordWrap (bool status=true)
	TagEditText (TagBase *parent)
virtual swf_type_t	TypeFlags (void) const
	Retrieve a set of flags desribing the type of the tag.
Private Member Functions
virtual ErrorManager::error_code_t	PreSave (void)
	Pre-save all the children tags of this tag.
Private Attributes
edit_text_alignment_t	f_align
bool	f_autosize
bool	f_border
SRectangle	f_bounds
Color	f_color
const TagFont *	f_font
unsigned short	f_font_height
bool	f_has_color
bool	f_html
long	f_indent
long	f_leading
long	f_left_margin
long	f_max_length
bool	f_multiline
bool	f_no_select
bool	f_outline
bool	f_password
bool	f_readonly
long	f_right_margin
char *	f_text
sswf_ucs4_t *	f_used_glyphs
sswf_ucs4_t *	f_used_strings
char *	f_var_name
bool	f_word_wrap

Member Enumeration Documentation

enum sswf::TagEditText::edit_text_alignment_t

Enumerator:

EDIT_TEXT_ALIGNMENT_LEFT
EDIT_TEXT_ALIGNMENT_RIGHT
EDIT_TEXT_ALIGNMENT_CENTER
EDIT_TEXT_ALIGNMENT_JUSTIFY

Constructor & Destructor Documentation

TagEditText::TagEditText ( TagBase * parent )

Member Function Documentation

void TagEditText::AddUsedString ( const char * string )

ErrorManager::error_code_t TagEditText::PreSave ( void ) [private, virtual]

This function calls the PreSave() function of all the children unless one returns a non-zero value in which case that value will be returned and the process stopped.

This function is aumatically called by the TagHeader and TagSprite in order to pre-save their children.

The PreSave() functions are expected to be used to test whether a tag can be saved. Especially, most tags will call the MinimumVersion() function with the version required to save these tags. This ensures that you can save the entire movie in a valid SWF. Please, see the reference of each tag for more information about what their PreSave() function does.

You should not have to call this function directly.

Returns:: Zero if the PreSave() succeeds; non-zero otherwise

Reimplemented from sswf::TagBase.

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

The Save() function is the one you want to call to save an SWF movie.

You may use the Save() on any tag, however, if you do so you need to properly initialize the system. For that purpose, you may want to look at the code in the TagHeader::Save(Data& data) function.

Otherwise, you simply have to call the Save() function of the TagHeader. That will save the entire movie with the smallest possible version (or fail if something cannot be saved with the present parameters.)

The TagHeader::Save() function first calls the PreSave() functions, the PreSave2ndPass() and then the Save() functions of all the children.

The other tag Save() function simply save the tag within the specified Data buffer. Note however that the TagSprite will also call the Save() function of all of its children. Yet it does not call the PreSave() functions.

The Save() function saves the movie in a Data buffer. Later you need to save that buffer on disk or some other medium.