mozITXTToHTMLConv

IID:77c0e42a-1dd2-11b2-8ebf-edc6606f2f4b
Inherits From:nsIStreamConverter

This interface is implemented by the following components:


Constants

PRUint32 kEntities = 0
PRUint32 kURLs = 2
PRUint32 kGlyphSubstitution = 4
PRUint32 kStructPhrase = 8

Methods

PRUint32 citeLevelTXT ( PRUnichar* line , out PRUint32 logLineStart ) void findURLInPlaintext ( PRUnichar* text , PRInt32 length , PRInt32 pos , out PRInt32 startPos , out PRInt32 endPos ) PRUnichar* scanHTML ( PRUnichar* text , PRUint32 whattodo ) PRUnichar* scanTXT ( PRUnichar* text , PRUint32 whattodo )

PRUint32 citeLevelTXT ( PRUnichar* line , out PRUint32 logLineStart )

Arguments:
line: : line in original msg, possibly starting starting with txt quote tags like ">"
logLineStart: : pos in line, where the real content (logical line) begins, i.e. pos after all txt quote tags. E.g. position of "t" in "> > text". Initial value must be 0, unless line is not real line.
Returns:
Cite Level, i.e. number of txt quote tags found, i.e. number of nested quotes.

void findURLInPlaintext ( PRUnichar* text , PRInt32 length , PRInt32 pos , out PRInt32 startPos , out PRInt32 endPos )

AStartPos --> index into the start of a url (-1 if no url found) endPos --> index of the last character in the url (-1 if no url found)

Arguments:
text
length: --> the length of the buffer to be scanned
pos: --> the position in the buffer to start scanning for a url
startPos
endPos

PRUnichar* scanHTML ( PRUnichar* text , PRUint32 whattodo )

Adds additional formatting to user edited text, that the user was too lazy or "unknowledged" (DELETEME: is that a word?) to make.

Note: Don't use kGlyphSubstitution with this function. This option generates tags, that are unuseable for UAs other than Mozilla. This would be a data loss bug.

Arguments:
text: : HTML source to scan. May be a line, paragraph (recommended) or just a substring.

Must be correct HTML. "<", ">" and "&" must be escaped, other chars must be pure unicode.

Note: ScanTXT(a, o) + ScanTXT(b, o) may be != Scan(a + b, o)

whattodo: : Bitfield describing the modes of operation

PRUnichar* scanTXT ( PRUnichar* text , PRUint32 whattodo )

Arguments:
text: : plain text to scan. May be a line, paragraph (recommended) or just a substring.

Must be non-escaped, pure unicode.

Note: ScanTXT(a, o) + ScanTXT(b, o) may be != Scan(a + b, o)

whattodo: : Bitfield describing the modes of operation

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com