Units documentation

rptypes.pas

Description

This unit implements base types and non-visual utility functions, near all units of the engine uses this unit because defines most base types.

Types

Name Description
TRpParamtype

Enumeration (rpParamString,rpParamInteger,rpParamDouble,rpParamDate, rpParamTime,rpParamDateTime,rpParamCurrency,rpParamBool, rpParamExpre,rpParamUnknown)

Possible parameter types

TRpType1Font

Enumeration (poHelvetica,poCourier,poTimesRoman,poSymbol,poZapfDingbats)

Possible Type1 Fonts, defined in Adobe PDF document specification

TRpBrushStyle

Enumeration (rpbsSolid, rpbsClear, rpbsHorizontal, rpbsVertical, rpbsFDiagonal, rpbsBDiagonal, rpbsCross, rpbsDiagCross, rpbsDense1, rpbsDense2, rpbsDense3, rpbsDense4, rpbsDense5, rpbsDense6, rpbsDense7)

Brush fill styles, not all drivers implement all styles

TRpTwips Integer, this is the measurement unit for positioning and sizing report elements, that is 1 inch have 1440 units
TRpImageDrawStyle

Enumeration (rpDrawCrop,rpDrawStretch,rpDrawFull,rpDrawTile)

Methods for drawing a picture inside a surface

TRpAggregate

Enumeration (rpAgNone,rpAgGroup,rpAgPage,rpAgGeneral)

Type of aggregate for report expressions

TRpAggregateType

Enumeration (rpagSum,rpagMin,rpagMax,rpagAvg,rpagStdDev)

Operation performed to do the aggregation

TRpReportChanged

Enumeration (rpReportStart,rpDataChange,rpGroupChange,rpPageChange,rpInvalidateValue,rpSubReportStart)

Used to notify report components the change in the report or subreport state

TRpShapeType

Enumeration (rpsRectangle, rpsSquare, rpsRoundRect, rpsRoundSquare, rpsEllipse, rpsCircle,rpsHorzLine,rpsVertLine,rpsOblique1,rpsOblique2)

Shape and line types

TRpPrinterFontsOption

Enumeration (rppfontsdefault,rppfontsalways,rppfontsnever)

Device font selection option

TRpPageSize

Enumeration (rpPageSizeDefault,rpPageSizeCustom,rpPageSizeUser)

Page size selectoin option,

TPageSizeQt Record used to store information about page selection when using the Qt driver
TRpPrinterSelect

Enumeration (pRpDefaultPrinter,pRpReportPrinter, pRpTicketPrinter,pRpGraphicprinter, pRpCharacterprinter,pRpReportPrinter2, pRpTicketPrinter2,pRpUserPrinter1,pRpUserPrinter2, pRpUserPrinter3,pRpUserPrinter4,pRpUserPrinter5, pRpUserPrinter6,pRpUserPrinter7,pRpUserPrinter8, pRpUserPrinter9)

Printer selection, each printer can have a system printer assigned, so changing printer configuration for pRpTicketPrinter results in output in a different printer for all reports defined to print in pRpTicketPrinter

TRpColor Color information for components, this is really an integer, containing RGB values
TRpPreviewStyle

Enumeration (spWide,spNormal,spEntirePage,spCustom)

Defines how the preview will show related to his window the first time is shown

TRpPreviewWindowStyle

Enumeration (spwNormal,spwMaximized)

The preview window initial state

TPrinterRawOp

Enumeration (rawopcutpaper,rawopopendrawer)

Special operations to perform after a document has been print.

TBitmapResizeEvent

procedure (awidth,aheight:integer;var scale:double) of object;

Event to trigger when a bitmap is resized to a scale (not used now)

TRpWString Record containing a widestring

Components and classes

Name Base class Description
TRpParamObject TObject Binary type parameter
TRpReportException Exception A exception containing the component that caused the exception and also the property
TRpWideStrings TObject This is like TStrings but for WideStrings, used by internationalization of labels

Functions

Declaration Description
function StreamCompare(Stream1:TStream; Stream2:TStream):Boolean; Compare two streams, returns true if they are equal
procedure WriteWideString(Writer:TWriter; Value:WideString); WideString component streaming
function ReadWideString(Reader:TReader):WideString; WideString component streaming
procedure Generatenewname(Component:TComponent); Generates a new name for a component
function FormatVariant(displayformat:string;Value:Variant; paramtype:TRpParamType):widestring; With a displayformat returns a formated string based on the variant and parameter type
function CopyFileTo(const Source, Destination: string): Boolean; Copy file function
function GetPrinterConfigName (printerindex:TRpPrinterSelect):string; Returns the name for a selected printer index
function GetPrinterOffset (printerindex:TRpPrinterSelect):TPoint; Returns the offset of the printer (defined by the user)
function GetDeviceFontsOption (printerindex:TRpPrinterSelect):boolean; Returns the device font option for the printer index
function GetPrinterRawOp (printerindex:TRpPrinterSelect; rawop:TPrinterRawOp):string; Returns the string to perform a device raw operation
procedure FillTreeDir (adirectory:String; alist:TStringList); Returns the reports in a directory and recurse directories, building a string list in tree structure
function WideStringToDOS (astring:WideString):WideString; Converts a WideString to OEM character set
function NumberToText (FNumero:currency; female:boolean;idiom:integer):String; Returns the full text representation of a number
function IsWindowsNT:Boolean; Return true if the running system is a NT system