Public Member Functions | Public Attributes

mozITXTToHTMLConv Interface Reference

import "mozITXTToHTMLConv.idl";

Inheritance diagram for mozITXTToHTMLConv:
Collaboration diagram for mozITXTToHTMLConv:

List of all members.

Public Member Functions

wstring scanTXT (in wstring text, in unsigned long whattodo)
wstring scanHTML (in wstring text, in unsigned long whattodo)
 Adds additional formatting to user edited text, that the user was too lazy or "unknowledged" (DELETEME: is that a word?) to make.
unsigned long citeLevelTXT (in wstring line, out unsigned long logLineStart)
void findURLInPlaintext (in wstring text, in long aLength, in long aPos, out long aStartPos, out long aEndPos)

Public Attributes

const unsigned long kEntities = 0
const unsigned long kURLs = 1 << 1
const unsigned long kGlyphSubstitution = 1 << 2
const unsigned long kStructPhrase = 1 << 3

Member Function Documentation

unsigned long mozITXTToHTMLConv::citeLevelTXT ( in wstring  line,
out unsigned long  logLineStart 
)
Parameters:
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 mozITXTToHTMLConv::findURLInPlaintext ( in wstring  text,
in long  aLength,
in long  aPos,
out long  aStartPos,
out long  aEndPos 
)
Parameters:
a wide string to scan for the presence of a URL.
aLength --> the length of the buffer to be scanned
aPos --> the position in the buffer to start scanning for a url

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

wstring mozITXTToHTMLConv::scanHTML ( in wstring  text,
in unsigned long  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.

Parameters:
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)

Parameters:
whattodo,: Bitfield describing the modes of operation
Returns:
Additional HTML tags are inserted where appropriate.
wstring mozITXTToHTMLConv::scanTXT ( in wstring  text,
in unsigned long  whattodo 
)
Parameters:
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)

Parameters:
whattodo,: Bitfield describing the modes of operation
Returns:
"<", ">" and "&" are escaped and HTML tags are inserted where appropriate.

Member Data Documentation

const unsigned long mozITXTToHTMLConv::kEntities = 0
const unsigned long mozITXTToHTMLConv::kGlyphSubstitution = 1 << 2
const unsigned long mozITXTToHTMLConv::kStructPhrase = 1 << 3
const unsigned long mozITXTToHTMLConv::kURLs = 1 << 1

The documentation for this interface was generated from the following file: