TCustomScrooge Class Reference

This class implements high-level converter methods. More...

Inheritance diagram for TCustomScrooge:

Public Member Functions
UTF8String	ConvertRTF (const TFileName RTFfilename)
	Convert a RTF file to a HTML string.
	ConvertRTFFile (const TFileName RTFFilename, const TFileName HTMLFilename)
	Convert a RTF file to a HTML file.
Public Member Functions inherited from TSxMain
UTF8String	Convert (const RawByteString RTF)
	Convert RTF to HTML.
UTF8String	Convert (const TStream AStream)
	Convert RTF contained in a TStream to a HTML string.
Public Member Functions inherited from TSxBase
	TSxBase ()
	Create a new TSxBase instance.
	TSxBase (TComponent AOwner)
	Create a new TSxBase instance.
	~TSxBase ()
	Destroy TSxBase instance.
string	GetCloseEmptyElement ()
	returns ' />' or '>' depending on DOCTYPE
string	GetEmptyParagraph ()
	returns an empty paragraph
string	GetLineBreakTag ()
	returns the line break element
string	GetOrderedListTag ()
	get the opening tag for an ordered list
string	GetParOpen ()
	returns the opening tag for a paragraph without ">"
string	GetUnorderedListTag ()
	get the opening tag for an unordered list
	Log (const TLogLevel ALogLevel, const string ALogText)
	call the log event handler and pass the log level and message
	ReplaceFont (string &FontName)
	replace a font name
string	TextElementToXHTML (const ISimpleDomTextNode TextElement, TParagraphProperties ParProps)
	convert a text element to HTML / XHTML.
	VerifySettings ()
	Checks properties for invalid settings.

Additional Inherited Members
Public Attributes inherited from TSxBase
Boolean	ConvertAnchors
	Activates support for anchor conversion.
Boolean	ConvertEmptyParagraphs
	Set this property to True to replace empty paragraphs (where the opening <p> tag is followed by the closing </p> tag) by a line break tag (<br />).
Boolean	ConvertFields
	Activates support for field conversion.
Boolean	ConvertHyperlinks
	Set this property to True to activate hyperlink support.
Boolean	ConvertIndent
	Set this property to True if You want to activate support for left and right paragraph indent.
Boolean	ConvertLanguage
	Activates support for language conversion.
Boolean	ConvertPictures
	Activates support for picture conversion.
Boolean	ConvertSpaces
	If two or more spaces are found in sequence, they will be converted to &nbsp; Default: True
Boolean	ConvertToPlainText
	Convert to plain text.
string	DefaultLanguage
	Use this property to set the default language of the document.
TDocumentType	DocumentType
	The document type.
TFontConversionOptions	FontConversionOptions
	Set these options to control which character properties are converted.
TFontSizeScale	FontSizeScale
	Use this option to set the font size scale.
ISxFormatter	Formatter
	The formatter.
IHyperlinkURIBuilder	HyperlinkURIBuilder
Boolean	IncludeDocType
	Include DOCTYPE at the beginning of the document.
Boolean	IncludeXMLDeclaration
	Includes the XML declaration line at the beginning of the document.
TLogLevel	LogLevel
	This property can be used to control the detail level of the logging procedure.
IMarginBuilding	MarginBuilder
	The margin builder.
TMarginConversionFlags	MarginConversionFlags
	Flags for paragraph margin conversion.
TNoRTFHeaderAction	NoRTFHeaderAction
	Action on missing or invalid RTF header.
TSxOptionsHead	OptionsHead
	HTML HEAD options.
TSxOptionsOptimize	OptionsOptimize
	Optimization options.
string	ParagraphElementAttributes
	The optional attributes to use for the p element.
IPictureAdapter	PictureAdapter
	The picture adapter.
TPostProcessEventListeners	PostProcessEventListeners
	A list of TPostProcessEventListener instances.
TStrings	ReplaceFonts
	Font names which will be replaced.
Boolean	RtfEnd
	True -> end of document.
string	TabString
	the HTML representation of a TAB charcter
ISxTranslator	Translator
	The HTML / XHTML Translator.
string	Version
	the ScroogeXHTML version
TEncodingEvent	OnAfterEncode
	Event handler which will be called after the encoding.
TEncodingEvent	OnBeforeEncode
	Event handler which will be called before the encoding.
TLogEvent	OnLog
	Event handler for log messages.
TReplaceFontEvent	OnReplaceFont
	This event handler can be used to define a font substition.
Protected Member Functions inherited from TSxMain
RawByteString	LoadBytesFromStream (const TStream AStream)
Protected Member Functions inherited from TSxBase
	DoPostProcessing (const ISimpleDomDocument ADocument)

Detailed Description

This class implements high-level converter methods.

The basic conversion method TSxBase#Convert, is defined in the parent class TSxBase.

Member Function Documentation

ConvertRTF()

UTF8String TCustomScrooge::ConvertRTF

(

const TFileName

RTFfilename

)

Convert a RTF file to a HTML string.

• RTFFilename The name of the input RTF file

ConvertRTFFile()

TCustomScrooge::ConvertRTFFile	(	const TFileName	RTFFilename,
		const TFileName	HTMLFilename )

Convert a RTF file to a HTML file.

• RTFFilename The name of the input RTF file
• HTMLFilename The name of the output HTML file