Functions
int	_CRpdfDocument (mmachine m)
	_CRpdfDocument : This function create a PDF document object

int	_DSpdfDocument (mmachine m)
	_DSpdfDocument : Destroy PDF document object

int	_SetPdfDocumentCharset (mmachine m)
	_SetPdfDocumentCharset : Set the current charset of a PDF document

int	_SavePdfDocument (mmachine m)
	_SavePdfDocument : Save a PDF document to a file

int	_SetPdfPageMode (mmachine m)
	_SetPdfPageMode : Set the page mode of a PDF document

int	_SetPdfLayoutMode (mmachine m)
	_SetPdfLayoutMode : Set the layout mode of a PDF document

int	_LoadPdfTrueTypeFont (mmachine m)
	_LoadPdfTrueTypeFont : load a TrueType font file into a PDF document

int	_GetPdfPageSize (mmachine m)
	_GetPdfPageSize : Get a PDF page size

int	_GetPdfPageTextWidth (mmachine m)
	_GetPdfPageTextWidth : Get a PDF text width from a font

int	_AddPdfPage (mmachine m)
	_AddPdfPage : Add a page to a PDF document

int	_AddPdfPageText (mmachine m)
	_AddPdfPageText : Add text to a PDF page

int	_AddPdfPageBitmap (mmachine m)
	_AddPdfPageBitmap : Add a bitmap to a PDF page

int	_AddPdfPageImage (mmachine m)
	_AddPdfPageImage : Add an image to a PDF page from a jpg or png file

int	_AddPdfPageRectangle (mmachine m)
	_AddPdfPageRectangle : Add a ractangle to a PDF page

int	_AddPdfPageEllipse (mmachine m)
	_AddPdfPageEllipse : Add an ellipse to a PDF page

int	_AddPdfPageLine (mmachine m)
	_AddPdfPageLine : Add a line to a PDF page

Detailed Description

Scol functions definition

Function Documentation

◆ _AddPdfPage()

int _AddPdfPage ( mmachine m )

_AddPdfPage : Add a page to a PDF document

fun [ObjPdfDoc I I] ObjPdfPage

Parameters

ObjPdfDoc	: PDF document Object
I	: Page size with defined values : PDF_PAGE_A3 PDF_PAGE_A4 PDF_PAGE_A5 PDF_PAGE_B4 PDF_PAGE_B5 PDF_PAGE_COMM1 PDF_PAGE_EOF PDF_PAGE_EXECUTIVE PDF_PAGE_LEGAL PDF_PAGE_LETTER PDF_PAGE_US4X6 PDF_PAGE_US4X8 PDF_PAGE_US5X7
I	: Page direction with defined values : PDF_PAGE_PORTRAIT PDF_PAGE_LANDSCAPE

Returns: ObjPdfPage : Created page on success, NIL otherwise

Definition at line 648 of file scolplugin.cpp.

◆ _AddPdfPageBitmap()

int _AddPdfPageBitmap ( mmachine m )

_AddPdfPageBitmap : Add a bitmap to a PDF page

fun [ObjPdfDoc ObjPdfPage ObjBitmap [F F] [F F] I] I

Parameters

ObjPdfDoc	: PDF document Object
ObjPdfPage	: Page Object
ObjBitmap	: bitmap
[F	F] : position x, y
[F	F] : size width, height
I	: align flags a combinaison of PDF_ALIGN_LEFT PDF_ALIGN_RIGHT PDF_ALIGN_CENTER PDF_ALIGN_TOP PDF_ALIGN_BOTTOM PDF_ALIGN_MIDDLE

Returns: I : 0 on success, NIL otherwise

Definition at line 836 of file scolplugin.cpp.

◆ _AddPdfPageEllipse()

int _AddPdfPageEllipse ( mmachine m )

_AddPdfPageEllipse : Add an ellipse to a PDF page

fun [ObjPdfDoc ObjPdfPage [F F] [F F] F I I I I] I

Parameters

ObjPdfDoc	: PDF document Object
ObjPdfPage	: Page Object
[F	F] : position x, y
[F	F] : X and Y radius
F	: line width
I	: line color
I	: fill color
I	: filled, 0 hollow, 1 filled
I	: align flags a combinaison of PDF_ALIGN_LEFT PDF_ALIGN_RIGHT PDF_ALIGN_CENTER PDF_ALIGN_TOP PDF_ALIGN_BOTTOM PDF_ALIGN_MIDDLE

Returns: I : 0 on success, NIL otherwise

Definition at line 1109 of file scolplugin.cpp.

◆ _AddPdfPageImage()

int _AddPdfPageImage ( mmachine m )

_AddPdfPageImage : Add an image to a PDF page from a jpg or png file

fun [ObjPdfDoc ObjPdfPage P [F F] [F F] I] I

Parameters

ObjPdfDoc	: PDF document Object
ObjPdfPage	: Page Object
P	: path to jpg or png file
[F	F] : position x, y
[F	F] : size width, height
I	: align flags a combinaison of PDF_ALIGN_LEFT PDF_ALIGN_RIGHT PDF_ALIGN_CENTER PDF_ALIGN_TOP PDF_ALIGN_BOTTOM PDF_ALIGN_MIDDLE

Returns: I : 0 on success, NIL otherwise

Definition at line 924 of file scolplugin.cpp.

◆ _AddPdfPageLine()

int _AddPdfPageLine ( mmachine m )

_AddPdfPageLine : Add a line to a PDF page

fun [ObjPdfDoc ObjPdfPage [F F] [F F] F I] I

Parameters

ObjPdfDoc	: PDF document Object
ObjPdfPage	: Page Object
[F	F] : first point position x, y
[F	F] : second point position x, y
F	: line width
I	: line color

Returns: I : 0 on success, NIL otherwise

Definition at line 1201 of file scolplugin.cpp.

◆ _AddPdfPageRectangle()

int _AddPdfPageRectangle ( mmachine m )

_AddPdfPageRectangle : Add a ractangle to a PDF page

fun [ObjPdfDoc ObjPdfPage [F F] [F F] F I I I I] I

Parameters

ObjPdfDoc	: PDF document Object
ObjPdfPage	: Page Object
[I	I] : position x, y
[I	I] : size width, height
F	: line width
I	: line color
I	: fill color
I	: filled, 0 hollow, 1 filled
I	: align flags a combinaison of PDF_ALIGN_LEFT PDF_ALIGN_RIGHT PDF_ALIGN_CENTER PDF_ALIGN_TOP PDF_ALIGN_BOTTOM PDF_ALIGN_MIDDLE

Returns: I : 0 on success, NIL otherwise

Definition at line 1008 of file scolplugin.cpp.

◆ _AddPdfPageText()

int _AddPdfPageText ( mmachine m )

_AddPdfPageText : Add text to a PDF page

fun [ObjPdfDoc ObjPdfPage S [F F] I S F I] I

Parameters

ObjPdfDoc	: PDF document Object
ObjPdfPage	: Page Object
S	: text to write
[F	F] : text position x, y
I	: text color (RGB)
S	: font name to use Default font names : Courier Courier-Bold Courier-Oblique Courier-BoldOblique Helvetica Helvetica-Bold Helvetica-Oblique Helvetica-BoldOblique Times-Roman Times-Bold Times-Italic Times-BoldItalic Symbol ZapfDingbats
F	: font size
I	: align flags a combinaison of PDF_ALIGN_LEFT PDF_ALIGN_RIGHT PDF_ALIGN_CENTER PDF_ALIGN_TOP PDF_ALIGN_BOTTOM PDF_ALIGN_MIDDLE

Returns: I : 0 on success, NIL otherwise

Definition at line 745 of file scolplugin.cpp.

◆ _CRpdfDocument()

int _CRpdfDocument ( mmachine m )

_CRpdfDocument : This function create a PDF document object

Prototype: fun [Chn S S S I] ObjPdfDoc

Parameters

Chn	: channel
S	: document title
S	: document creator
S	: document author
I	: Page DPI resolution, Nil for default (72dpi)

Returns: ObjPdfDoc : the PDF document object if success, NIL otherwise

Definition at line 111 of file scolplugin.cpp.

◆ _DSpdfDocument()

int _DSpdfDocument ( mmachine m )

_DSpdfDocument : Destroy PDF document object

fun [ObjPdfDoc] I

Parameters

ObjPdfDoc : PDF document Object to destroy

Returns: I : 0 if success, NIL otherwise

Definition at line 175 of file scolplugin.cpp.

◆ _GetPdfPageSize()

int _GetPdfPageSize ( mmachine m )

_GetPdfPageSize : Get a PDF page size

fun [ObjPdfDoc ObjPdfPage] [F F]

Parameters

ObjPdfDoc	: PDF document Object
ObjPdfPage	: Page Object

Returns: [F F] : page width and height on success, NIL otherwise

Definition at line 493 of file scolplugin.cpp.

◆ _GetPdfPageTextWidth()

int _GetPdfPageTextWidth ( mmachine m )

_GetPdfPageTextWidth : Get a PDF text width from a font

fun [ObjPdfDoc ObjPdfPage S S F] F

Parameters

ObjPdfDoc	: PDF document Object
ObjPdfPage	: Page Object
S	: Text
S	: Font name
F	: Font size

Returns: F : text width on success, NIL otherwise

Definition at line 562 of file scolplugin.cpp.

◆ _LoadPdfTrueTypeFont()

int _LoadPdfTrueTypeFont ( mmachine m )

_LoadPdfTrueTypeFont : load a TrueType font file into a PDF document

fun [ObjPdfDoc P] S

Parameters

ObjPdfDoc	: PDF document Object
P	: TrueType font file (*.ttf)

Returns: S : the font name if success, NIL otherwise

Definition at line 443 of file scolplugin.cpp.

◆ _SavePdfDocument()

int _SavePdfDocument ( mmachine m )

_SavePdfDocument : Save a PDF document to a file

fun [ObjPdfDoc W] I

Parameters

ObjPdfDoc	: PDF document Object
W	: File to write

Returns: I : 0 if success, NIL otherwise

Definition at line 284 of file scolplugin.cpp.

◆ _SetPdfDocumentCharset()

int _SetPdfDocumentCharset ( mmachine m )

_SetPdfDocumentCharset : Set the current charset of a PDF document

fun [ObjPdfDoc S] I

Parameters

ObjPdfDoc : PDF document Object

S : new charset from StandardEncoding :It is the default encoding of PDF MacRomanEncoding :The standard encoding of Mac OS WinAnsiEncoding :The standard encoding of Windows FontSpecific :Use the built-in encoding of a font. ISO8859-2 :Latin Alphabet No.2 ISO8859-3 :Latin Alphabet No.3 ISO8859-4 :Latin Alphabet No.4 ISO8859-5 :Latin Cyrillic Alphabet ISO8859-6 :Latin Arabic Alphabet ISO8859-7 :Latin Greek Alphabet ISO8859-8 :Latin Hebrew Alphabet ISO8859-9 :Latin Alphabet No. 5 ISO8859-10 :Latin Alphabet No. 6 ISO8859-11 :Thai, TIS 620-2569 character set ISO8859-13 :Latin Alphabet No. 7 ISO8859-14 :Latin Alphabet No. 8 ISO8859-15 :Latin Alphabet No. 9 ISO8859-16 :Latin Alphabet No. 10 CP1250 :Microsoft Windows Codepage 1250 (EE) CP1251 :Microsoft Windows Codepage 1251 (Cyrl) CP1252 :Microsoft Windows Codepage 1252 (ANSI) CP1253 :Microsoft Windows Codepage 1253 (Greek) CP1254 :Microsoft Windows Codepage 1254 (Turk) CP1255 :Microsoft Windows Codepage 1255 (Hebr) CP1256 :Microsoft Windows Codepage 1256 (Arab CP1257 :Microsoft Windows Codepage 1257 (BaltRim) CP1258 :Microsoft Windows Codepage 1258 (Viet) KOI8-R :Russian Net Character Set

Returns: I : 0 if success, NIL otherwise

Definition at line 235 of file scolplugin.cpp.

◆ _SetPdfLayoutMode()

int _SetPdfLayoutMode ( mmachine m )

_SetPdfLayoutMode : Set the layout mode of a PDF document

fun [ObjPdfDoc I] I

Parameters

ObjPdfDoc	: PDF document Object
I	: Layout mode from PDF_PAGE_LAYOUT_EOF PDF_PAGE_LAYOUT_ONE_COLUMN PDF_PAGE_LAYOUT_SINGLE PDF_PAGE_LAYOUT_TWO_COLUMN_LEFT PDF_PAGE_LAYOUT_TWO_COLUMN_RIGHT PDF_PAGE_LAYOUT_TWO_PAGE_LEFT PDF_PAGE_LAYOUT_TWO_PAGE_RIGHT

Returns: I : 0 if success, NIL otherwise

Definition at line 394 of file scolplugin.cpp.

◆ _SetPdfPageMode()

int _SetPdfPageMode ( mmachine m )

_SetPdfPageMode : Set the page mode of a PDF document

fun [ObjPdfDoc I] I

Parameters

ObjPdfDoc	: PDF document Object
I	: Page mode from PDF_PAGE_MODE_EOF PDF_PAGE_MODE_FULLSCREEN PDF_PAGE_MODE_NONE PDF_PAGE_MODE_OUTLINE PDF_PAGE_MODE_THUMBS

Returns: I : 0 if success, NIL otherwise

Definition at line 338 of file scolplugin.cpp.

Functions

Detailed Description

Function Documentation

◆ _AddPdfPage()

◆ _AddPdfPageBitmap()

◆ _AddPdfPageEllipse()

◆ _AddPdfPageImage()

◆ _AddPdfPageLine()

◆ _AddPdfPageRectangle()

◆ _AddPdfPageText()

◆ _CRpdfDocument()

◆ _DSpdfDocument()

◆ _GetPdfPageSize()

◆ _GetPdfPageTextWidth()

◆ _LoadPdfTrueTypeFont()

◆ _SavePdfDocument()

◆ _SetPdfDocumentCharset()

◆ _SetPdfLayoutMode()

◆ _SetPdfPageMode()