Led 3.0 Class Library Documentation

Module StyledTextIO_HTML


Classes and Global Functions Index

Module Description:

Subclasses of StyledTextIOReader and StyledTextIOWriter are where the knowledge of particular file formats resides. For example, the knowledge of how to read HTML is in StyledTextIOReader_HTML and the knowledge of how to write HTML is in StyledTextIOWriter_HTML.


Class: HTMLInfo [public]

Description:

Class: StyledTextIOReader_HTML [public]

Base Classes: StyledTextIOReader
Description:
Member Details

StyledTextIOReader_HTML::GetEntityRefMapTable [public]

const vector < StyledTextIOReader_HTML::EntityRefMapEntry > & StyledTextIOReader_HTML::GetEntityRefMapTable () const

Return a vector of StyledTextIOReader_HTML::EntityRefMapEntry to be used in reading in HTML text. These entity refs will be recognized in the input text, and mapped to the appropriate given character.

NB: The return value is a REFERENCE to vector. The lifetime of that vector must be at least til the next call of this function, or til the death of this object. Typically, it is assumed, a static table will be used so the lifetime will be the end of the process.

StyledTextIOReader_HTML::GetEntityRefMapTable (overload 1) [public]

const vector < StyledTextIOWriter_HTML::EntityRefMapEntry > & StyledTextIOWriter_HTML::GetEntityRefMapTable () const

Return a vector of StyledTextIOReader_HTML::EntityRefMapEntry to be used in reading in HTML text. These entity refs will be recognized in the input text, and mapped to the appropriate given character.

NB: The return value is a REFERENCE to vector. The lifetime of that vector must be at least til the next call of this function, or til the death of this object. Typically, it is assumed, a static table will be used so the lifetime will be the end of the process.


Class: StyledTextIOWriter_HTML [public]

Base Classes: StyledTextIOWriter
Description:
Member Details

StyledTextIOWriter_HTML::IsTagOnStack [public]

bool StyledTextIOWriter_HTML::IsTagOnStack (WriterContext& writerContext, const string& tagName)

See if there is an open tag on the stack with the given name.

See also StyledTextIOWriter_HTML::WriteOpenTag.

StyledTextIOWriter_HTML::WriteCloseTag [public]

void StyledTextIOWriter_HTML::WriteCloseTag (WriterContext& writerContext, const string& tagName)

Closes the given tag and removes it from the tag stack. First removes any implicity closed tags from the tag stack (and emits their closing tag HTML).

See also StyledTextIOWriter_HTML::WriteOpenTag.

StyledTextIOWriter_HTML::WriteOpenCloseTag [public]

void StyledTextIOWriter_HTML::WriteOpenCloseTag (WriterContext& writerContext, const string& tagName, const string& tagExtras)

Writes an open tag - possibly with arguments - and implicitly closes it. Tags like "br" get handled that way.

See also StyledTextIOWriter_HTML::WriteOpenTag.

StyledTextIOWriter_HTML::WriteOpenTag [public]

void StyledTextIOWriter_HTML::WriteOpenTag (WriterContext& writerContext, const string& tagName, const string& tagExtras)

Write the given tag (given by name - eg. "b" for bold) to the output. Save it in the tagstack so that later closing tags will be implicitly closed.

See also StyledTextIOWriter_HTML::WriteCloseTag.

StyledTextIOWriter_HTML::WriteOpenTagSpecial [public]

void StyledTextIOWriter_HTML::WriteOpenTagSpecial (WriterContext& writerContext, const string& tagName, const string& tagFullText)

Like StyledTextIOWriter_HTML::WriteOpenTag.- but use the tiven argument text as what we write out. Helper in case we saved exact text from input document.

See also StyledTextIOWriter_HTML::WriteOpenTag.


Config Variable: qThrowAwayMostUnknownHTMLTags [public]

Description:

By default, on reading, we throw away or interpret losely most tags. This makes the reader very lossy, but produces the most human-readable result. For now control which behavior you want via this compiletime flag. -- LGP 961015


Config Variable: qWriteOutMostHTMLEntitiesByName [public]

Description:

By default, off - cuz that works more compatably with many older web browser (such as Netscape 4.x). And writing them by number is slightly faster.


Return to Led Page Return to Led ClassLib Documentation Index Return to Led Reference Manual Index
Last Updated 2001-10-20