ScroogeXHTML for Object Pascal 8.0
TCustomScrooge Class Reference

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

Inheritance diagram for TCustomScrooge:
TSxMain TSxBase TBTScroogeXHTML

Public Member Functions

 ConvertRTFFile (const TFileName RTFFilename, const TFileName HTMLFilename)
 Convert a RTF file to a HTML file. More...
 
UTF8String ConvertRTF (const TFileName RTFfilename)
 Convert a RTF file to a HTML string. More...
 
UTF8String Convert (const TStream AStream)
 Convert RTF contained in a TStream to a HTML string. More...
 
- Public Member Functions inherited from TSxMain
UTF8String Convert (const RawByteString RTF)
 Convert RTF to HTML.
 
string GetLeadingHTMLTags ()
 Build the tags before the HTML body code.
 
string GetTrailingHTMLTags ()
 Build the tags after the HTML body code.
 
- Public Member Functions inherited from TSxBase
 TSxBase ()
 Create a new TSxBase instance.
 
 TSxBase (TComponent AOwner)
 Create a new TSxBase instance.
 
 ~TSxBase ()
 Destroy TSxBase instance.
 
 VerifySettings ()
 Checks properties for invalid settings. More...
 
string GetCloseEmptyElement ()
 returns ' />' or '>' depending on DOCTYPE

 
string GetEmptyParagraph ()
 returns an empty paragraph
 
string GetParOpen ()
 returns the opening tag for a paragraph without ">"
 
string GetOrderedListTag ()
 get the opening tag for an ordered list
 
string GetUnorderedListTag ()
 get the opening tag for an unordered list
 
string GetLineBreakTag ()
 returns the line break element
 
 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
 
 ReplaceHyperlink (const ISimpleDomTextNode TextElement)
 replace a hyperlink
 
string TextElementToXHTML (const ISimpleDomTextNode TextElement)
 convert a text element to HTML / XHTML. More...
 

Additional Inherited Members

- Public Attributes inherited from TSxBase
ISxFormatter Formatter
 The formatter. More...
 
IHyperlinkURIBuilder HyperlinkURIBuilder
 
IMarginBuilding MarginBuilder
 The margin builder. More...
 
IPictureAdapter PictureAdapter
 The picture adapter. More...
 
Boolean RtfEnd
 True -> end of document. More...
 
ISxTranslator Translator
 The HTML / XHTML Translator. More...
 
Boolean ConvertAnchors
 Activates support for anchor conversion. More...
 
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 />). More...
 
Boolean ConvertFields
 Activates support for field conversion. More...
 
Boolean ConvertHyperlinks
 Set this property to True to activate hyperlink support. More...
 
Boolean ConvertIndent
 Set this property to True if You want to activate support for left and right paragraph indent. More...
 
Boolean ConvertLanguage
 Activates support for language conversion. More...
 
Boolean ConvertPictures
 Activates support for picture conversion. More...
 
Boolean ConvertSpaces
 If two or more spaces are found in sequence, they will be converted to &nbsp;. More...
 
Boolean ConvertToPlainText
 Convert to plain text. More...
 
string DefaultLanguage
 Use this property to set the default language of the document. More...
 
TDocumentType DocumentType
 The document type. More...
 
TFontConversionOptions FontConversionOptions
 Set these options to control which character properties are converted. More...
 
TFontSizeScale FontSizeScale
 Use this option to set the font size scale. More...
 
Boolean IncludeDocType
 Include DOCTYPE at the beginning of the document. More...
 
Boolean IncludeXMLDeclaration
 Includes the XML declaration line at the beginning of the document. More...
 
TLogLevel LogLevel
 This property can be used to control the detail level of the logging procedure. More...
 
TStrings ReplaceFonts
 Font names which will be replaced. More...
 
string TabString
 the HTML representation of a TAB charcter More...
 
string Version
 the ScroogeXHTML version More...
 
TSxOptionsHead OptionsHead
 HTML HEAD options. More...
 
TSxOptionsOptimize OptionsOptimize
 Optimization options. More...
 
TPostProcessEventListeners PostProcessEventListeners
 A list of TPostProcessEventListener instances. More...
 
TEncodingEvent OnAfterEncode
 Event handler which will be called after the encoding. More...
 
TEncodingEvent OnBeforeEncode
 Event handler which will be called before the encoding. More...
 
TLogEvent OnLog
 Event handler for log messages. More...
 
TReplaceFontEvent OnReplaceFont
 This event handler can be used to define a font substition. More...
 
- Protected Member Functions inherited from TSxMain
UTF8String DoConvert (const RawByteString RTF)
 The main conversion function.
 

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

◆ Convert()

UTF8String TCustomScrooge::Convert ( const TStream  AStream)

Convert RTF contained in a TStream to a HTML string.

Since
8.0

◆ 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