Foxit PDF SDK
|
Public Member Functions | |
def | PSI (bitmap, simulate) |
Constructor, with a bitmap as canvas. More... | |
def | AddPoint (point, type, pressure) |
Add a point. More... | |
def | ConvertToPDFAnnot (page, annot_rect, rotate) |
Convert a PSI object to a PSInk annotation and insert the PSInk annotation to a PDF page. More... | |
def | GetBitmap () |
Get the canvas bitmap. More... | |
def | GetContentsRect () |
Get contents rectangle. More... | |
def | IsEmpty () |
Check whether current object is empty or not. More... | |
def | SetCallback (callback) |
Set a callback object for refreshing. More... | |
def | SetColor (color) |
Set ink color. More... | |
def | SetDiameter (diameter) |
Set ink diameter. More... | |
def | SetOpacity (opacity) |
Set ink opacity. More... | |
PSI, "pressure sensitive ink", is specially defined for manual signature, and usually works together with a handwriting board or for a touchscreen. PSI contains private coordinates, and a canvas is created in its coordinates. Canvas limits operating area and generates appearance of PSI.
PSI is independent of PDF, and can even be used directly in the device screen. If user wants to save a PSI object to PDF file, please call function FoxitPDFSDKPython2.PSI.ConvertToPDFAnnot . This function will convert PSI data to a PSInk annotation (as a Foxit custom annotation type) and insert the PSInk annotation to the specified position in a PDF page.
def FoxitPDFSDKPython2.PSI.PSI | ( | bitmap, | |
simulate | |||
) |
Constructor, with a bitmap as canvas.
Constructor, with another PSI object.
Constructor, with specified width and height for canvas.
[in] | bitmap | A bitmap used as canvas. It should be created with FoxitPDFSDKPython2.Bitmap.e_DIBArgb format. User should ensure this bitmap to keep valid until current PSI object is released. |
[in] | simulate | Used to decide whether to turn on simulation of PSI or not: true means to turn on simulation, and false means to turn off simulation. It can simulate handwriting weights by writing speed when simulation is on. |
[in] | width | Width of PSI canvas in device coordinate system. This shall be greater than 0. |
[in] | height | Height of PSI canvas in device coordinate system. This shall be greater than 0. |
[in] | simulate | Used to decide whether to turn on simulation of PSI or not: true means to turn on simulation, and false means to turn off simulation. It can simulate handwriting weights by writing speed when simulation is on. |
[in] | other | Another PSI object. |
def FoxitPDFSDKPython2.PSI.AddPoint | ( | point, | |
type, | |||
pressure | |||
) |
Add a point.
[in] | point | A point in canvas coordinate system. |
[in] | type | Point type. This should be one of following values: FoxitPDFSDKPython2.Path.e_TypeMoveTo , FoxitPDFSDKPython2.Path.e_TypeLineTo , FoxitPDFSDKPython2.Path.e_TypeLineToCloseFigure , |
[in] | pressure | Pressure value for this point. Valid range: from 0.0 to 1.0. |
def FoxitPDFSDKPython2.PSI.ConvertToPDFAnnot | ( | page, | |
annot_rect, | |||
rotate | |||
) |
Convert a PSI object to a PSInk annotation and insert the PSInk annotation to a PDF page.
Actually, this function is to convert the path data of current PSI to a PSInk annotation, ignoring the canvas bitmap.
Before calling this function, user should ensure that current PSI object has contained a valid path (whose last point's type is FoxitPDFSDKPython2.Path.e_TypeLineToCloseFigure . Otherwise, the conversion will be failed and this function will throw exception FoxitPDFSDKPython2.e_ErrInvalidData .
[in] | page | A valid PDF page object, to which the PSI is expected to inserted. |
[in] | annot_rect | A rectangle to specify the position in the PDF page, where the new PSInk annotation will be inserted. It should be valid in [PDF coordinate system] (). |
[in] | rotate | Rotation value. Currently, it can only be FoxitPDFSDKPython2.e_Rotation0 . |
def FoxitPDFSDKPython2.PSI.GetBitmap | ( | ) |
Get the canvas bitmap.
def FoxitPDFSDKPython2.PSI.GetContentsRect | ( | ) |
Get contents rectangle.
def FoxitPDFSDKPython2.PSI.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
def FoxitPDFSDKPython2.PSI.SetCallback | ( | callback | ) |
Set a callback object for refreshing.
[in] | callback | A callback object PSICallback which is implemented by user. Please ensure that the callback object keeps valid until the life-cycle of current PSI object ends. |
def FoxitPDFSDKPython2.PSI.SetColor | ( | color | ) |
Set ink color.
This should be set before adding first point to PSI object. If not set, the default value 0x000000 will be used.
[in] | color | Ink color. Format: 0xRRGGBB. |
def FoxitPDFSDKPython2.PSI.SetDiameter | ( | diameter | ) |
Set ink diameter.
This should be set before adding first point to PSI object. If not set, the default value 10 will be used.
[in] | diameter | Ink diameter. This should be bigger than 1. |
def FoxitPDFSDKPython2.PSI.SetOpacity | ( | opacity | ) |
Set ink opacity.
This should be set before adding first point to PSI object. If not set, the default value 1.0 will be used.
[in] | opacity | Ink opacity. Valid range: from 0.0 to 1.0. 0.0 means full transparency and 1.0 means full opaque. |