qm.structured_text.HtmlFormatter

Package qm :: Module structured_text :: Class HtmlFormatter

[show private | hide private]

Class HtmlFormatter

Formatter --+
            |
           HtmlFormatter

Formatter for generating HTML from structured text.

Method Summary
	`__init__(self, output_file)` Create a new HTML formatter.
	`End(self)` End the processed text document.
	`EndItem(self, type)` End an element in the environment of type 'type'.
	`EndLink(self)` End a hyperlink.
	`EndList(self, type)` End a list environment of type 'type'.
	`EndStyle(self, style)` End the text style 'style'.
	`FinishDefinedTerm(self)` Finish the definition of a term in a definition list.
	`StartItem(self, type, label)` Begin an element to the environment of type 'type'.
	`StartLink(self, target)` Being a hyperlink to 'target'.
	`StartList(self, type)` Start a list environment of type 'type'.
	`StartStyle(self, style)` Start a new text style 'style'.
	`WriteText(self, text)` Write ordinary text.

Method Details

init(self, output_file=<epydoc.imports._DevNull instance at 0xb7d602cc>)
(Constructor)

Create a new HTML formatter.

'output_file' -- A file object to which HTML source is written.

End(self)

End the processed text document.

EndItem(self, type)

End an element in the environment of type 'type'.

EndLink(self)

End a hyperlink.

EndList(self, type)

End a list environment of type 'type'.

EndStyle(self, style)

End the text style 'style'.

FinishDefinedTerm(self)

Finish the definition of a term in a definition list.

StartItem(self, type, label=None)

Begin an element to the environment of type 'type'.

'label' -- If type is "ordered list", this is the label for this list element.

StartLink(self, target)

Being a hyperlink to 'target'.

StartList(self, type)

Start a list environment of type 'type'.

StartStyle(self, style)

Start a new text style 'style'.

WriteText(self, text)

Write ordinary text.

Generated by Epydoc 2.1 on Thu Sep 27 15:48:59 2007

http://epydoc.sf.net