ScroogeXHTML for Object Pascal 9.2
Loading...
Searching...
No Matches
SxTypes.pas File Reference

Classes

class  TCharacterProperties
 A class which stores character properties. More...
 
class  TFontDescriptor
 A class which stores a font table font definition. More...
 
class  TParagraphProperties
 A class which stores paragraph properties. More...
 
class  TPictureInformation
 Class which stores picture informations. More...
 
class  TReaderProperties
 A class which stores the current reader state. More...
 
struct  TTokenDef
 A TTokenDef object stores the description of a RTF token. More...
 

Typedefs

typedef set< TFontOptionTFontConversionOptions
 Set of conversion options.
 
typedef set< TFontStyleTFontStyles
 
typedef set< TMarginConversionFlagTMarginConversionFlags
 Set of margin conversion flags.
 

Enumerations

enum  TDirection { diLTR , diRTL }
 Supported text directions. More...
 
enum  TDocumentType { dtHTML_50 , dtXHTML_10_Strict }
 Enum for all available output document types. More...
 
enum  TFontFamily {
  ffNil , ffRoman , ffSwiss , ffModern ,
  ffScript , ffDecor , ffTech , ffBidi
}
 used in the tokenTable to specify a RTF font family More...
 
enum  TFontOption {
  opFontName , opFontSize , opFontStyle , opFontColor ,
  opFontBGColor , opFontHLColor
}
 Available font conversion options. More...
 
enum  TFontSizeScale { fsPoint , fsEM , fsEX , fsPercent }
 Enum for all supported font size units. More...
 
enum  TFontStyle { fsBold , fsItalic , fsUnderline , fsStrikeOut }
 Enum for all supported font styles. More...
 
enum  TInternalState { isNorm , isBin , isHex }
 RTF reader internal states. More...
 
enum  TLogLevel {
  logDebug , logInfo , logWarning , logError ,
  logFatal
}
 Enum for logging levels. More...
 
enum  TMarginConversionFlag { mcConvertBottomMargin , mcConvertTopMargin }
 Available paragraph margin conversion flags. More...
 
enum  TNoRTFHeaderAction { acReturnEmptyString , acRaiseException }
 Action on missing or invalid RTF header. More...
 
enum  TOrderedListStyleType { lsNone , lsDecimal , lsLowerAlpha , lsUpperAlpha }
 CSS list-style-type for ordered lists. More...
 
enum  TParagraphAlignment { paLeftJustify , paRightJustify , paCenter , paJustify }
 
enum  TRTFDestination {
  destIgnore , destFontTable , destFileTable , destColorTable ,
  destStyleSheet , destRevisionTable , destTemplate , destBodyText ,
  destBkmkStart , destBkmkEnd , destInformation , destUpr ,
  destParagraphNumbering , destPicture , destPnText , destField ,
  destFldInst , destFldRslt , destListTable , destList ,
  destListOverrideTable , destListOverride , destListLevel
}
 used in the tokenTable to specify the RTF destination (KeyType = ktDest) More...
 
enum  TRTFFunction {
  fnctBin , fnctHex , fnctSkipDest , fnctPlain ,
  fnctSkipWord , fnctLinebreak , fnctMiddot , fnctNonshppict
}
 used in the tokenTable to specify the RTF special function More...
 
enum  TRTFKeyType {
  ktChar , ktDest , ktProp , ktFnct ,
  ktFamily
}
 used in the tokenTable to identify the token type More...
 
enum  TRTFProperty {
  propANSI , propMAC , propPlain , propLeftInd ,
  propRightInd , propFirstInd , propSpaceBefore , propSpaceAfter ,
  propParBGColor , propParBox , propBold , propItalic ,
  propUnderline , propHidden , propJustL , propJustC ,
  propJustR , propJustified , propPard , propRed ,
  propGreen , propBlue , propFontSize , propFontNumber ,
  propFontColor , propFontCharSet , propFontBGColor , propFontHLColor ,
  propStrikeOut , propPnLvl , propPnLvlCont , propDefLang ,
  propDeff , propSuper , propSub , propNoSuper ,
  propLanguage , propLTR , propRTL , propLTRPar ,
  propRTLPar , propUnicode , propUnicodeSkip , propEMF ,
  propPNG , propJPEG , propPICT , propWMF ,
  propBMP , propPicW , propPicH , propWGoal ,
  propHGoal , propScaleX , propScaleY , propLISTID ,
  propLISTTEMPLATEID , propLISTOVERRIDE_INDEX , propLEVELNFC
}
 used in the tokenTable to identify the associated property (KeyType = ktProp) More...
 
enum  TUnOrderedListStyleType { ulNone , ulBullet , ulDisc }
 CSS list-style-type for unordered lists. More...
 
enum  TVerticalAlignment { vaBaseline , vaSub , vaSuper }
 Supported vertical alignments. More...
 

Functions

TBytes ToBytes (const RawByteString AValue)
 

Variables

const ALL_FONT_CONVERSION_OPTIONS
 
const ContentTypeUTF_8 = "text/html; charset=UTF-8"
 
const CrLf = #13#10
 
const dcBlack = "#000000"
 
const dcBlue = "#0000ff"
 
const DEFAULT_FONT_COLOR = "#000000"
 
const DEFAULT_FONT_NAME = "Times,serif"
 
const DEFAULT_FONT_SIZE = 12
 
const DEFAULT_TAB_STRING = "&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"
 
const maxToken = 136
 size of token definition table
 
const NL_BODY = 10
 
const NL_BULLET = 11
 
const NL_NONE = 0
 
const array[0..maxToken] of TTokenDef TokenTable
 the RTF token definition table
 
const XML_DECLARATION = "<?xml version='1.0'?>"
 

Typedef Documentation

◆ TFontConversionOptions

Set of conversion options.

◆ TFontStyles

typedef set< TFontStyle> TFontStyles

◆ TMarginConversionFlags

Set of margin conversion flags.

Enumeration Type Documentation

◆ TDirection

enum TDirection

Supported text directions.

Enumerator
diLTR 
diRTL 

◆ TDocumentType

Enum for all available output document types.

Enumerator
dtHTML_50 

HTML5.

dtXHTML_10_Strict 

XHTML 1.0 Strict.

◆ TFontFamily

used in the tokenTable to specify a RTF font family

Enumerator
ffNil 
ffRoman 
ffSwiss 
ffModern 
ffScript 
ffDecor 
ffTech 
ffBidi 

◆ TFontOption

Available font conversion options.

Enumerator
opFontName 
opFontSize 
opFontStyle 
opFontColor 
opFontBGColor 
opFontHLColor 

◆ TFontSizeScale

Enum for all supported font size units.

Enumerator
fsPoint 
fsEM 
fsEX 
fsPercent 

◆ TFontStyle

enum TFontStyle

Enum for all supported font styles.

Enumerator
fsBold 
fsItalic 
fsUnderline 
fsStrikeOut 

◆ TInternalState

RTF reader internal states.

Enumerator
isNorm 

normal text

isBin 

binary data

isHex 

hexadecimal data

◆ TLogLevel

enum TLogLevel

Enum for logging levels.

Enumerator
logDebug 
logInfo 
logWarning 
logError 
logFatal 

◆ TMarginConversionFlag

Available paragraph margin conversion flags.

Enumerator
mcConvertBottomMargin 
mcConvertTopMargin 

◆ TNoRTFHeaderAction

Action on missing or invalid RTF header.

Enumerator
acReturnEmptyString 
acRaiseException 

◆ TOrderedListStyleType

CSS list-style-type for ordered lists.

Enumerator
lsNone 
lsDecimal 
lsLowerAlpha 
lsUpperAlpha 

◆ TParagraphAlignment

Enumerator
paLeftJustify 
paRightJustify 
paCenter 
paJustify 

◆ TRTFDestination

used in the tokenTable to specify the RTF destination (KeyType = ktDest)

Enumerator
destIgnore 
destFontTable 
destFileTable 
destColorTable 
destStyleSheet 
destRevisionTable 
destTemplate 
destBodyText 
destBkmkStart 
destBkmkEnd 
destInformation 
destUpr 
destParagraphNumbering 
destPicture 
destPnText 
destField 
destFldInst 
destFldRslt 
destListTable 
destList 
destListOverrideTable 
destListOverride 
destListLevel 

◆ TRTFFunction

used in the tokenTable to specify the RTF special function

Enumerator
fnctBin 
fnctHex 
fnctSkipDest 
fnctPlain 
fnctSkipWord 
fnctLinebreak 
fnctMiddot 
fnctNonshppict 

◆ TRTFKeyType

used in the tokenTable to identify the token type

Enumerator
ktChar 
ktDest 
ktProp 
ktFnct 
ktFamily 

◆ TRTFProperty

used in the tokenTable to identify the associated property (KeyType = ktProp)

Enumerator
propANSI 
propMAC 
propPlain 
propLeftInd 
propRightInd 
propFirstInd 
propSpaceBefore 
propSpaceAfter 
propParBGColor 
propParBox 
propBold 
propItalic 
propUnderline 
propHidden 
propJustL 
propJustC 
propJustR 
propJustified 
propPard 
propRed 
propGreen 
propBlue 
propFontSize 
propFontNumber 
propFontColor 
propFontCharSet 
propFontBGColor 
propFontHLColor 
propStrikeOut 
propPnLvl 
propPnLvlCont 
propDefLang 
propDeff 
propSuper 
propSub 
propNoSuper 
propLanguage 
propLTR 
propRTL 
propLTRPar 
propRTLPar 
propUnicode 
propUnicodeSkip 
propEMF 
propPNG 
propJPEG 
propPICT 
propWMF 
propBMP 
propPicW 
propPicH 
propWGoal 
propHGoal 
propScaleX 
propScaleY 
propLISTID 
propLISTTEMPLATEID 
propLISTOVERRIDE_INDEX 
propLEVELNFC 

◆ TUnOrderedListStyleType

CSS list-style-type for unordered lists.

Enumerator
ulNone 
ulBullet 
ulDisc 

◆ TVerticalAlignment

Supported vertical alignments.

Enumerator
vaBaseline 
vaSub 
vaSuper 

Function Documentation

◆ ToBytes()

TBytes ToBytes ( const RawByteString AValue)

Variable Documentation

◆ ALL_FONT_CONVERSION_OPTIONS

const ALL_FONT_CONVERSION_OPTIONS
Initial value:
=
@ opFontHLColor
Definition SxTypes.pas:66
@ opFontColor
Definition SxTypes.pas:64
@ opFontStyle
Definition SxTypes.pas:63
@ opFontName
Definition SxTypes.pas:61
@ opFontSize
Definition SxTypes.pas:62
@ opFontBGColor
Definition SxTypes.pas:65

◆ ContentTypeUTF_8

const ContentTypeUTF_8 = "text/html; charset=UTF-8"

◆ CrLf

const CrLf = #13#10

◆ dcBlack

const dcBlack = "#000000"

◆ dcBlue

const dcBlue = "#0000ff"

◆ DEFAULT_FONT_COLOR

const DEFAULT_FONT_COLOR = "#000000"

◆ DEFAULT_FONT_NAME

const DEFAULT_FONT_NAME = "Times,serif"

◆ DEFAULT_FONT_SIZE

const DEFAULT_FONT_SIZE = 12

◆ DEFAULT_TAB_STRING

const DEFAULT_TAB_STRING = "&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"

◆ maxToken

const maxToken = 136

size of token definition table

◆ NL_BODY

const NL_BODY = 10

◆ NL_BULLET

const NL_BULLET = 11

◆ NL_NONE

const NL_NONE = 0

◆ TokenTable

const array [0..maxToken] of TTokenDef TokenTable

the RTF token definition table

◆ XML_DECLARATION

const XML_DECLARATION = "<?xml version='1.0'?>"