implementation

package
v1.0.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 2, 2022 License: MIT Imports: 27 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Pdfium = &mainPdfium{
	mutex:        &sync.Mutex{},
	instanceRefs: map[int]*PdfiumImplementation{},
	documentRefs: map[references.FPDF_DOCUMENT]*DocumentHandle{},
	fileReaders:  map[string]*fileReaderRef{},
}

Pdfium is a container so that we can always only have 1 instance of PDFium per process. We need this so that we can guarantee thread safety.

Functions

func DestroyLibrary

func DestroyLibrary()

DestroyLibrary unloads the actual C++ library. If any documents were loaded, it closes them.

func InitLibrary

func InitLibrary(config *pdfium.LibraryConfig)

InitLibrary loads the actual C++ library.

func StartPlugin

func StartPlugin(config *pdfium.LibraryConfig)

Types

type ActionHandle added in v0.5.0

type ActionHandle struct {
	// contains filtered or unexported fields
}

type AnnotationHandle added in v0.5.0

type AnnotationHandle struct {
	// contains filtered or unexported fields
}

type AttachmentHandle added in v0.5.0

type AttachmentHandle struct {
	// contains filtered or unexported fields
}

type BitmapHandle added in v0.5.0

type BitmapHandle struct {
	// contains filtered or unexported fields
}

type BookmarkHandle added in v0.5.0

type BookmarkHandle struct {
	// contains filtered or unexported fields
}

type BytesReaderCloser added in v0.9.0

type BytesReaderCloser struct {
	// contains filtered or unexported fields
}

A Reader implements the io.Reader, io.ReaderAt, io.WriterTo, io.Seeker, io.ByteScanner, and io.RuneScanner interfaces by reading from a byte slice. Unlike a Buffer, a Reader is read-only and supports seeking.

func NewBytesReaderCloser added in v0.9.0

func NewBytesReaderCloser(b []byte) *BytesReaderCloser

BytesReaderCloser returns a new Reader reading from b.

func (*BytesReaderCloser) Close added in v0.9.0

func (r *BytesReaderCloser) Close() error

func (*BytesReaderCloser) Len added in v0.9.0

func (r *BytesReaderCloser) Len() int

Len returns the number of bytes of the unread portion of the slice.

func (*BytesReaderCloser) Read added in v0.9.0

func (r *BytesReaderCloser) Read(b []byte) (n int, err error)

Read implements the io.Reader interface.

func (*BytesReaderCloser) ReadAt added in v0.9.0

func (r *BytesReaderCloser) ReadAt(b []byte, off int64) (n int, err error)

ReadAt implements the io.ReaderAt interface.

func (*BytesReaderCloser) ReadByte added in v0.9.0

func (r *BytesReaderCloser) ReadByte() (byte, error)

ReadByte implements the io.ByteReader interface.

func (*BytesReaderCloser) ReadRune added in v0.9.0

func (r *BytesReaderCloser) ReadRune() (ch rune, size int, err error)

ReadRune implements the io.RuneReader interface.

func (*BytesReaderCloser) Reset added in v0.9.0

func (r *BytesReaderCloser) Reset(b []byte)

Reset resets the Reader to be reading from b.

func (*BytesReaderCloser) Seek added in v0.9.0

func (r *BytesReaderCloser) Seek(offset int64, whence int) (int64, error)

Seek implements the io.Seeker interface.

func (*BytesReaderCloser) Size added in v0.9.0

func (r *BytesReaderCloser) Size() int64

Size returns the original length of the underlying byte slice. Size is the number of bytes available for reading via ReadAt. The returned value is always the same and is not affected by calls to any other method.

func (*BytesReaderCloser) UnreadByte added in v0.9.0

func (r *BytesReaderCloser) UnreadByte() error

UnreadByte complements ReadByte in implementing the io.ByteScanner interface.

func (*BytesReaderCloser) UnreadRune added in v0.9.0

func (r *BytesReaderCloser) UnreadRune() error

UnreadRune complements ReadRune in implementing the io.RuneScanner interface.

func (*BytesReaderCloser) WriteTo added in v0.9.0

func (r *BytesReaderCloser) WriteTo(w io.Writer) (n int64, err error)

WriteTo implements the io.WriterTo interface.

type ClipPathHandle added in v0.5.0

type ClipPathHandle struct {
	// contains filtered or unexported fields
}

type DataAvailHandle added in v0.9.0

type DataAvailHandle struct {
	// contains filtered or unexported fields
}

type DestHandle added in v0.5.0

type DestHandle struct {
	// contains filtered or unexported fields
}

type DocumentHandle added in v0.5.0

type DocumentHandle struct {
	// contains filtered or unexported fields
}

func (*DocumentHandle) Close added in v0.5.0

func (d *DocumentHandle) Close() error

Close closes the internal references in FPDF

type FontHandle added in v0.9.0

type FontHandle struct {
	// contains filtered or unexported fields
}

type FormFillInfo added in v1.0.0

type FormFillInfo struct {
	Struct           *C.FPDF_FORMFILLINFO
	FormFillInfo     *structs.FPDF_FORMFILLINFO
	FormHandleHandle *FormHandleHandle
	Instance         *PdfiumImplementation
}

type FormHandleHandle added in v0.5.0

type FormHandleHandle struct {
	// contains filtered or unexported fields
}

type GlyphPathHandle added in v0.9.0

type GlyphPathHandle struct {
	// contains filtered or unexported fields
}

type JavaScriptActionHandle added in v0.5.0

type JavaScriptActionHandle struct {
	// contains filtered or unexported fields
}

type LinkHandle added in v0.5.0

type LinkHandle struct {
	// contains filtered or unexported fields
}

type PageHandle added in v0.5.0

type PageHandle struct {
	// contains filtered or unexported fields
}

func (*PageHandle) Close added in v0.5.0

func (p *PageHandle) Close()

Close closes the internal references in FPDF

type PageLinkHandle added in v0.5.0

type PageLinkHandle struct {
	// contains filtered or unexported fields
}

type PageObjectHandle added in v0.5.0

type PageObjectHandle struct {
	// contains filtered or unexported fields
}

type PageObjectMarkHandle added in v0.9.0

type PageObjectMarkHandle struct {
	// contains filtered or unexported fields
}

type PageRangeHandle added in v0.5.0

type PageRangeHandle struct {
	// contains filtered or unexported fields
}

type PathSegmentHandle added in v0.9.0

type PathSegmentHandle struct {
	// contains filtered or unexported fields
}

type PauseHandle added in v0.9.0

type PauseHandle struct {
	Struct   *C.IFSDK_PAUSE
	Callback func() bool
	// contains filtered or unexported fields
}

type PdfiumImplementation added in v0.5.0

type PdfiumImplementation struct {
	// contains filtered or unexported fields
}

Here is the real implementation of Pdfium

func (*PdfiumImplementation) Close added in v0.5.0

func (p *PdfiumImplementation) Close() error

func (*PdfiumImplementation) FORM_CanRedo added in v1.0.0

func (p *PdfiumImplementation) FORM_CanRedo(request *requests.FORM_CanRedo) (*responses.FORM_CanRedo, error)

FORM_CanRedo Find out if it is possible for the current focused widget in a given form to perform a redo operation.

func (*PdfiumImplementation) FORM_CanUndo added in v1.0.0

func (p *PdfiumImplementation) FORM_CanUndo(request *requests.FORM_CanUndo) (*responses.FORM_CanUndo, error)

FORM_CanUndo Find out if it is possible for the current focused widget in a given form to perform an undo operation.

func (*PdfiumImplementation) FORM_DoDocumentAAction added in v1.0.0

FORM_DoDocumentAAction This method is required for performing the document's additional-action. This method will do nothing if there is no document additional-action corresponding to the specified type.

func (*PdfiumImplementation) FORM_DoDocumentJSAction added in v1.0.0

FORM_DoDocumentJSAction This method is required for performing document-level JavaScript actions. It should be invoked after the PDF document has been loaded. If there is document-level JavaScript action embedded in the document, this method will execute the JavaScript action. Otherwise, the method will do nothing.

func (*PdfiumImplementation) FORM_DoDocumentOpenAction added in v1.0.0

FORM_DoDocumentOpenAction This method is required for performing open-action when the document is opened. This method will do nothing if there are no open-actions embedded in the document.

func (*PdfiumImplementation) FORM_DoPageAAction added in v1.0.0

FORM_DoPageAAction This method is required for performing the page object's additional-action when opened or closed. This method will do nothing if no additional-action corresponding to the specified type exists.

func (*PdfiumImplementation) FORM_ForceToKillFocus added in v1.0.0

FORM_ForceToKillFocus Call this member function to force to kill the focus of the form field which has focus. If it would kill the focus of a form field, save the value of form field if was changed by theuser.

func (*PdfiumImplementation) FORM_GetFocusedAnnot added in v1.0.0

FORM_GetFocusedAnnot Call this member function to get the currently focused annotation. Not currently supported for XFA forms - will report no focused annotation. Must call FPDFPage_CloseAnnot() when the annotation returned by this function is no longer needed. Experimental API.

func (*PdfiumImplementation) FORM_GetFocusedText added in v1.0.0

FORM_GetFocusedText Call this function to obtain the text within the current focused field, if any. Experimental API

func (*PdfiumImplementation) FORM_GetSelectedText added in v1.0.0

FORM_GetSelectedText Call this function to obtain selected text within a form text field or form combobox text field.

func (*PdfiumImplementation) FORM_IsIndexSelected added in v1.0.0

FORM_IsIndexSelected returns whether or not the value at index of the focused annotation is currently selected. Intended for use with listbox/combobox widget types. Default implementation is a no-op that will return false for other types. Not currently supported for XFA forms - will return false. Experimental API

func (*PdfiumImplementation) FORM_OnAfterLoadPage added in v1.0.0

FORM_OnAfterLoadPage This method is required for implementing all the form related functions. Should be invoked after user successfully loaded a PDF page, and FPDFDOC_InitFormFillEnvironment() has been invoked.

func (*PdfiumImplementation) FORM_OnBeforeClosePage added in v1.0.0

FORM_OnBeforeClosePage This method is required for implementing all the form related functions. Should be invoked before user closes the PDF page.

func (*PdfiumImplementation) FORM_OnChar added in v1.0.0

func (p *PdfiumImplementation) FORM_OnChar(request *requests.FORM_OnChar) (*responses.FORM_OnChar, error)

FORM_OnChar Call this member function when a keystroke translates to a nonsystem character.

func (*PdfiumImplementation) FORM_OnFocus added in v1.0.0

func (p *PdfiumImplementation) FORM_OnFocus(request *requests.FORM_OnFocus) (*responses.FORM_OnFocus, error)

FORM_OnFocus This function focuses the form annotation at a given point. If the annotation at the point already has focus, nothing happens. If there is no annotation at the point, removes form focus.

func (*PdfiumImplementation) FORM_OnKeyDown added in v1.0.0

FORM_OnKeyDown Call this member function when a nonsystem key is pressed.

func (*PdfiumImplementation) FORM_OnKeyUp added in v1.0.0

func (p *PdfiumImplementation) FORM_OnKeyUp(request *requests.FORM_OnKeyUp) (*responses.FORM_OnKeyUp, error)

FORM_OnKeyUp Call this member function when a nonsystem key is released. Currently unimplemented and always returns false. PDFium reserves this API and may implement it in the future on an as-needed basis.

func (*PdfiumImplementation) FORM_OnLButtonDoubleClick added in v1.0.0

FORM_OnLButtonDoubleClick Call this member function when the user double clicks the left mouse button.

func (*PdfiumImplementation) FORM_OnLButtonDown added in v1.0.0

FORM_OnLButtonDown Call this member function when the user presses the left mouse button.

func (*PdfiumImplementation) FORM_OnLButtonUp added in v1.0.0

FORM_OnLButtonUp Call this member function when the user releases the left mouse button.

func (*PdfiumImplementation) FORM_OnMouseMove added in v1.0.0

FORM_OnMouseMove Call this member function when the mouse cursor moves.

func (*PdfiumImplementation) FORM_OnMouseWheel added in v1.0.0

FORM_OnMouseWheel Call this member function when the user scrolls the mouse wheel. For X and Y delta, the caller must normalize platform-specific wheel deltas. e.g. On Windows, a delta value of 240 for a WM_MOUSEWHEEL event normalizes to 2, since Windows defines WHEEL_DELTA as 120. Experimental API

func (*PdfiumImplementation) FORM_OnRButtonDown added in v1.0.0

FORM_OnRButtonDown Call this member function when the user presses the right mouse button. At the present time, has no effect except in XFA builds, but is included for the sake of symmetry.

func (*PdfiumImplementation) FORM_OnRButtonUp added in v1.0.0

FORM_OnRButtonUp Call this member function when the user releases the right mouse button. At the present time, has no effect except in XFA builds, but is included for the sake of symmetry.

func (*PdfiumImplementation) FORM_Redo added in v1.0.0

func (p *PdfiumImplementation) FORM_Redo(request *requests.FORM_Redo) (*responses.FORM_Redo, error)

FORM_Redo Make the current focussed widget perform a redo operation.

func (*PdfiumImplementation) FORM_ReplaceSelection added in v1.0.0

FORM_ReplaceSelection Call this function to replace the selected text in a form text field or user-editable form combobox text field with another text string (which can be empty or non-empty). If there is no selected text, this function will append the replacement text after the current caret position.

func (*PdfiumImplementation) FORM_SelectAllText added in v1.0.0

FORM_SelectAllText Call this function to select all the text within the currently focused form text field or form combobox text field. Experimental API

func (*PdfiumImplementation) FORM_SetFocusedAnnot added in v1.0.0

FORM_SetFocusedAnnot Call this member function to set the currently focused annotation. The annotation can't be nil. To kill focus, use FORM_ForceToKillFocus() instead. Experimental API.

func (*PdfiumImplementation) FORM_SetIndexSelected added in v1.0.0

FORM_SetIndexSelected selects/deselects the value at the given index of the focused annotation. Intended for use with listbox/combobox widget types. Comboboxes have at most a single value selected at a time which cannot be deselected. Deselect on a combobox is a no-op that returns false. Default implementation is a no-op that will return false for other types. Not currently supported for XFA forms - will return false. Experimental API

func (*PdfiumImplementation) FORM_Undo added in v1.0.0

func (p *PdfiumImplementation) FORM_Undo(request *requests.FORM_Undo) (*responses.FORM_Undo, error)

FORM_Undo Make the current focussed widget perform an undo operation.

func (*PdfiumImplementation) FPDFAction_GetDest added in v0.5.0

FPDFAction_GetDest returns the destination of a specific go-to or remote-goto action. Only action with type PDF_ACTION_ACTION_GOTO and PDF_ACTION_ACTION_REMOTEGOTO can have destination data. In case of remote goto action, the application should first use function FPDFAction_GetFilePath to get file path, then load that particular document, and use its document handle to call this function.

func (*PdfiumImplementation) FPDFAction_GetFilePath added in v0.5.0

FPDFAction_GetFilePath returns the file path from a remote goto or launch action. Only works on actions that have the type FPDF_ACTION_ACTION_REMOTEGOTO or FPDF_ACTION_ACTION_LAUNCH.

func (*PdfiumImplementation) FPDFAction_GetType added in v0.5.0

FPDFAction_GetType returns the action associated with a bookmark item.

func (*PdfiumImplementation) FPDFAction_GetURIPath added in v0.5.0

FPDFAction_GetURIPath returns the URI path from a URI action.

func (*PdfiumImplementation) FPDFAnnot_AddInkStroke added in v1.0.0

FPDFAnnot_AddInkStroke adds a new InkStroke, represented by an array of points, to the InkList of the annotation. The API creates an InkList if one doesn't already exist in the annotation. This API works only for ink annotations. Please refer to ISO 32000-1:2008 spec, section 12.5.6.13. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_AppendAttachmentPoints added in v1.0.0

FPDFAnnot_AppendAttachmentPoints appends to the list of attachment points (i.e. quadpoints) of an annotation. If the annotation's appearance stream is defined and this annotation is of a type with quadpoints, then update the bounding box too if the new quadpoints define a bigger one. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_AppendObject added in v1.0.0

FPDFAnnot_AppendObject adds the given object to the given annotation. The object must have been created by FPDFPageObj_CreateNew{Path|Rect}() or FPDFPageObj_New{Text|Image}Obj(), and will be owned by the annotation. Note that an object cannot belong to more than one annotation. Currently, only ink and stamp annotations are supported by this API. Also note that only path, image, and text objects have APIs for creation. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_CountAttachmentPoints added in v1.0.0

FPDFAnnot_CountAttachmentPoints returns the number of sets of quadpoints of an annotation. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetAP added in v1.0.0

FPDFAnnot_GetAP returns the AP (appearance string) from annotation's dictionary for a given appearance mode. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetAttachmentPoints added in v1.0.0

FPDFAnnot_GetAttachmentPoints returns the attachment points (i.e. quadpoints) of an annotation. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetBorder added in v1.0.0

FPDFAnnot_GetBorder returns the characteristics of the annotation's border (rounded rectangle). Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetColor added in v1.0.0

FPDFAnnot_GetColor returns the color of an annotation. If no color is specified, default to yellow for highlight annotation, black for all else. Fails when called on annotations with appearance streams already defined; instead use FPDFPath_Get{Stroke|Fill}Color(). Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetFlags added in v1.0.0

FPDFAnnot_GetFlags returns the annotation flags of the given annotation. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetFocusableSubtypes added in v1.0.0

FPDFAnnot_GetFocusableSubtypes returns the list of focusable annotation subtype as set by host. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetFocusableSubtypesCount added in v1.0.0

FPDFAnnot_GetFocusableSubtypesCount returns the count of focusable annotation subtypes as set by host. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetFontSize added in v1.0.0

FPDFAnnot_GetFontSize returns the float value of the font size for an annotation with variable text. If 0, the font is to be auto-sized: its size is computed as a function of the height of the annotation rectangle. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetFormControlCount added in v1.0.0

FPDFAnnot_GetFormControlCount returns the count of annotations in the annotation's control group. A group of interactive form annotations is collectively called a form control group. Here, annotation, an interactive form annotation, should be either a radio button or a checkbox. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetFormControlIndex added in v1.0.0

FPDFAnnot_GetFormControlIndex returns the index of the given annotation it's control group. A group of interactive form annotations is collectively called a form control group. Here, the annotation, an interactive form annotation, should be either a radio button or a checkbox. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetFormFieldAtPoint added in v1.0.0

FPDFAnnot_GetFormFieldAtPoint returns an interactive form annotation whose rectangle contains a given point on a page. Must call FPDFPage_CloseAnnot() when the annotation returned is no longer needed. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetFormFieldExportValue added in v1.0.0

FPDFAnnot_GetFormFieldExportValue returns the export value of the given annotation which is an interactive form annotation. Intended for use with radio button and checkbox widget annotations. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetFormFieldFlags added in v1.0.0

FPDFAnnot_GetFormFieldFlags returns the form field annotation flags of the given annotation. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetFormFieldName added in v1.0.0

FPDFAnnot_GetFormFieldName returns the name of the given annotation, which is an interactive form annotation. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetFormFieldType added in v1.0.0

FPDFAnnot_GetFormFieldType returns the form field type of the given annotation, which is an interactive form annotation. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetFormFieldValue added in v1.0.0

FPDFAnnot_GetFormFieldValue returns the value of the given annotation, which is an interactive form annotation. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetInkListCount added in v1.0.0

FPDFAnnot_GetInkListCount returns the number of paths in the ink list of an ink annotation. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetInkListPath added in v1.0.0

FPDFAnnot_GetInkListPath returns a path in the ink list of an ink annotation. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetLine added in v1.0.0

FPDFAnnot_GetLine returns the starting and ending coordinates of a line annotation. Experimental API.

FPDFAnnot_GetLink returns FPDF_LINK object for the given annotation. Intended to use for link annotations. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetLinkedAnnot added in v1.0.0

FPDFAnnot_GetLinkedAnnot returns the annotation corresponding to the given key in the annotations's dictionary. Common keys for linking annotations include "IRT" and "Popup". Must call FPDFPage_CloseAnnot() when the annotation returned by this function is no longer needed. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetNumberValue added in v1.0.0

FPDFAnnot_GetNumberValue returns the float value corresponding to the given key in the annotations's dictionary. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetObject added in v1.0.0

FPDFAnnot_GetObject returns the object in the given annotation at the given index. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetObjectCount added in v1.0.0

FPDFAnnot_GetObjectCount returns the total number of objects in the given annotation, including path objects, text objects, external objects, image objects, and shading objects. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetOptionCount added in v1.0.0

FPDFAnnot_GetOptionCount returns the number of options in the annotation's "Opt" dictionary. Intended for use with listbox and combobox widget annotations. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetOptionLabel added in v1.0.0

FPDFAnnot_GetOptionLabel returns the string value for the label of the option at the given index in annotation's "Opt" dictionary. Intended for use with listbox and combobox widget annotations. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetRect added in v1.0.0

FPDFAnnot_GetRect returns the annotation rectangle defining the location of the annotation. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetStringValue added in v1.0.0

FPDFAnnot_GetStringValue returns the string value corresponding to the given key in the annotations's dictionary. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetSubtype added in v1.0.0

FPDFAnnot_GetSubtype returns the subtype of an annotation. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetValueType added in v1.0.0

FPDFAnnot_GetValueType returns the type of the value corresponding to the given key the annotation's dictionary. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_GetVertices added in v1.0.0

FPDFAnnot_GetVertices returns the vertices of a polygon or polyline annotation. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_HasAttachmentPoints added in v1.0.0

FPDFAnnot_HasAttachmentPoints returns whether the annotation is of a type that has attachment points (i.e. quadpoints). Quadpoints are the vertices of the rectangle that encompasses the texts affected by the annotation. They provide the coordinates in the page where the annotation is attached. Only text markup annotations (i.e. highlight, strikeout, squiggly, and underline) and link annotations have quadpoints. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_HasKey added in v1.0.0

FPDFAnnot_HasKey checks whether the given annotation's dictionary has the given key as a key. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_IsChecked added in v1.0.0

FPDFAnnot_IsChecked returns whether the given annotation is a form widget that is checked. Intended for use with checkbox and radio button widgets. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_IsObjectSupportedSubtype added in v1.0.0

FPDFAnnot_IsObjectSupportedSubtype checks whether an annotation subtype is currently supported for object extraction, update, and removal. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_IsOptionSelected added in v1.0.0

FPDFAnnot_IsOptionSelected returns whether or not the option at the given index in annotation's "Opt" dictionary is selected. Intended for use with listbox and combobox widget annotations. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_IsSupportedSubtype added in v1.0.0

FPDFAnnot_IsSupportedSubtype returns whether an annotation subtype is currently supported for creation. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_RemoveInkList added in v1.0.0

FPDFAnnot_RemoveInkList removes an InkList in the given annotation. This API works only for ink annotations. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_RemoveObject added in v1.0.0

FPDFAnnot_RemoveObject removes the object in the given annotation at the given index. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_SetAP added in v1.0.0

FPDFAnnot_SetAP sets the AP (appearance string) in annotations's dictionary for a given appearance mode. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_SetAttachmentPoints added in v1.0.0

FPDFAnnot_SetAttachmentPoints replaces the attachment points (i.e. quadpoints) set of an annotation at the given quad index. This index needs to be within the result of FPDFAnnot_CountAttachmentPoints(). If the annotation's appearance stream is defined and this annotation is of a type with quadpoints, then update the bounding box too if the new quadpoints define a bigger one. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_SetBorder added in v1.0.0

FPDFAnnot_SetBorder sets the characteristics of the annotation's border (rounded rectangle). Experimental API.

func (*PdfiumImplementation) FPDFAnnot_SetColor added in v1.0.0

FPDFAnnot_SetColor sets the color of an annotation. Fails when called on annotations with appearance streams already defined; instead use FPDFPath_Set{Stroke|Fill}Color(). Experimental API.

func (*PdfiumImplementation) FPDFAnnot_SetFlags added in v1.0.0

FPDFAnnot_SetFlags sets the annotation flags of the given annotation. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_SetFocusableSubtypes added in v1.0.0

FPDFAnnot_SetFocusableSubtypes returns the list of focusable annotation subtypes. Annotations of subtype FPDF_ANNOT_WIDGET are by default focusable. New subtypes set using this API will override the existing subtypes. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_SetRect added in v1.0.0

FPDFAnnot_SetRect sets the annotation rectangle defining the location of the annotation. If the annotation's appearance stream is defined and this annotation is of a type without quadpoints, then update the bounding box too if the new rectangle defines a bigger one. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_SetStringValue added in v1.0.0

FPDFAnnot_SetStringValue sets the string value corresponding to the given key in the annotations's dictionary, overwriting the existing value if any. The value type would be FPDF_OBJECT_STRING after this function call succeeds. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_SetURI added in v1.0.0

FPDFAnnot_SetURI adds a URI action to the given annotation, overwriting the existing action, if any. Experimental API.

func (*PdfiumImplementation) FPDFAnnot_UpdateObject added in v1.0.0

FPDFAnnot_UpdateObject updates the given object in the given annotation. The object must be in the annotation already and must have been retrieved by FPDFAnnot_GetObject(). Currently, only ink and stamp annotations are supported by this API. Also note that only path, image, and /text objects have APIs for modification; see FPDFPath_*(), FPDFText_*(), and FPDFImageObj_*(). Experimental API.

func (*PdfiumImplementation) FPDFAttachment_GetFile added in v0.5.0

FPDFAttachment_GetFile gets the file data of the given attachment. Experimental API.

func (*PdfiumImplementation) FPDFAttachment_GetName added in v0.5.0

FPDFAttachment_GetName returns the name of the attachment file. Experimental API.

func (*PdfiumImplementation) FPDFAttachment_GetStringValue added in v0.5.0

FPDFAttachment_GetStringValue gets the string value corresponding to the given key in the params dictionary of the embedded file attachment. Experimental API.

func (*PdfiumImplementation) FPDFAttachment_GetValueType added in v0.5.0

FPDFAttachment_GetValueType returns the type of the value corresponding to the given key in the params dictionary of the embedded attachment. Experimental API.

func (*PdfiumImplementation) FPDFAttachment_HasKey added in v0.5.0

FPDFAttachment_HasKey check if the params dictionary of the given attachment has the given key as a key. Experimental API.

func (*PdfiumImplementation) FPDFAttachment_SetFile added in v0.5.0

FPDFAttachment_SetFile set the file data of the given attachment, overwriting the existing file data if any. The creation date and checksum will be updated, while all other dictionary entries will be deleted. Note that only contents with a length smaller than INT_MAX is supported. Experimental API.

func (*PdfiumImplementation) FPDFAttachment_SetStringValue added in v0.5.0

FPDFAttachment_SetStringValue sets the string value corresponding to the given key in the params dictionary of the embedded file attachment, overwriting the existing value if any. Experimental API.

func (*PdfiumImplementation) FPDFAvail_Create added in v0.9.0

FPDFAvail_Create creates a document availability provider. FPDFAvail_Destroy() must be called when done with the availability provider.

func (*PdfiumImplementation) FPDFAvail_Destroy added in v0.9.0

FPDFAvail_Destroy destroys the given document availability provider.

func (*PdfiumImplementation) FPDFAvail_GetDocument added in v0.9.0

FPDFAvail_GetDocument returns the document from the availability provider. When FPDFAvail_IsDocAvail() returns TRUE, call FPDFAvail_GetDocument() to retrieve the document handle.

func (*PdfiumImplementation) FPDFAvail_GetFirstPageNum added in v0.9.0

FPDFAvail_GetFirstPageNum returns the page number for the first available page in a linearized PDF. For most linearized PDFs, the first available page will be the first page, however, some PDFs might make another page the first available page. For non-linearized PDFs, this function will always return zero.

func (*PdfiumImplementation) FPDFAvail_IsDocAvail added in v0.9.0

FPDFAvail_IsDocAvail checks if the document is ready for loading, if not, gets download hints. Applications should call this function whenever new data arrives, and process all the generated download hints, if any, until the function returns enums.PDF_FILEAVAIL_DATA_ERROR or enums.PDF_FILEAVAIL_DATA_AVAIL. if hints is nil, the function just check current document availability.

Once all data is available, call FPDFAvail_GetDocument() to get a document handle.

func (*PdfiumImplementation) FPDFAvail_IsFormAvail added in v0.9.0

FPDFAvail_IsFormAvail This function can be called only after FPDFAvail_GetDocument() is called. Applications should call this function whenever new data arrives and process all the generated download hints, if any, until this function returns enums.PDF_FILEAVAIL_DATA_ERROR or enums.PDF_FILEAVAIL_DATA_AVAIL. Applications can then perform page loading. if hints is nil, the function just check current availability of specified page.

func (*PdfiumImplementation) FPDFAvail_IsLinearized added in v0.9.0

FPDFAvail_IsLinearized Check whether a document is a linearized PDF. FPDFAvail_IsLinearized() will return enums.PDF_FILEAVAIL_LINEARIZED or enums.PDF_FILEAVAIL_NOT_LINEARIZED when we have 1k of data. If the files size less than 1k, it returns enums.PDF_FILEAVAIL_LINEARIZATION_UNKNOWN as there is insufficient information to determine if the PDF is linearlized.

func (*PdfiumImplementation) FPDFAvail_IsPageAvail added in v0.9.0

FPDFAvail_IsPageAvail checks if the given page index is ready for loading, if not, it will call the hints to fetch more data.

func (*PdfiumImplementation) FPDFBitmap_Create added in v0.7.0

FPDFBitmap_Create Create a device independent bitmap (FXDIB).

func (*PdfiumImplementation) FPDFBitmap_CreateEx added in v0.7.0

FPDFBitmap_CreateEx Create a device independent bitmap (FXDIB) with an external buffer. Similar to FPDFBitmap_Create function, but allows for more formats and an external buffer is supported. The bitmap created by this function can be used in any place that a FPDF_BITMAP handle is required.

If an external buffer is used, then the application should destroy the buffer by itself. FPDFBitmap_Destroy function will not destroy the buffer.

Not supported on multi-threaded usage.

func (*PdfiumImplementation) FPDFBitmap_Destroy added in v0.7.0

FPDFBitmap_Destroy destroys a bitmap and release all related buffers. This function will not destroy any external buffers provided when the bitmap was created.

func (*PdfiumImplementation) FPDFBitmap_FillRect added in v0.7.0

FPDFBitmap_FillRect fills a rectangle in a bitmap. This function sets the color and (optionally) alpha value in the specified region of the bitmap.

NOTE: If the alpha channel is used, this function does NOT composite the background with the source color, instead the background will be replaced by the source color and the alpha.

If the alpha channel is not used, the alpha parameter is ignored.

func (*PdfiumImplementation) FPDFBitmap_GetBuffer added in v0.7.0

FPDFBitmap_GetBuffer returns the data buffer of a bitmap. The stride may be more than width * number of bytes per pixel

Applications can use this function to get the bitmap buffer pointer, then manipulate any color and/or alpha values for any pixels in the bitmap.

The data is in BGRA format. Where the A maybe unused if alpha was not specified.

func (*PdfiumImplementation) FPDFBitmap_GetFormat added in v0.7.0

FPDFBitmap_GetFormat returns the format of the bitmap. Only formats supported by FPDFBitmap_CreateEx are supported by this function.

func (*PdfiumImplementation) FPDFBitmap_GetHeight added in v0.7.0

FPDFBitmap_GetHeight returns the height of a bitmap.

func (*PdfiumImplementation) FPDFBitmap_GetStride added in v0.7.0

FPDFBitmap_GetStride returns the number of bytes for each line in the bitmap buffer.

func (*PdfiumImplementation) FPDFBitmap_GetWidth added in v0.7.0

FPDFBitmap_GetWidth returns the width of a bitmap.

func (*PdfiumImplementation) FPDFBookmark_Find added in v0.5.0

FPDFBookmark_Find finds a bookmark in the document, using the bookmark title.

func (*PdfiumImplementation) FPDFBookmark_GetAction added in v0.5.0

FPDFBookmark_GetAction returns the action associated with a bookmark item. If this function returns a valid handle, it is valid as long as the bookmark is valid. If the returned action is nil, you should try FPDFBookmark_GetDest.

func (*PdfiumImplementation) FPDFBookmark_GetDest added in v0.5.0

FPDFBookmark_GetDest returns the destination associated with a bookmark item. If the returned destination is nil, none is associated to the bookmark item.

func (*PdfiumImplementation) FPDFBookmark_GetFirstChild added in v0.5.0

FPDFBookmark_GetFirstChild returns the first child of a bookmark item, or the first top level bookmark item.

func (*PdfiumImplementation) FPDFBookmark_GetNextSibling added in v0.5.0

FPDFBookmark_GetNextSibling returns the next bookmark item at the same level. Note that the caller is responsible for handling circular bookmark references, as may arise from malformed documents.

func (*PdfiumImplementation) FPDFBookmark_GetTitle added in v0.5.0

FPDFBookmark_GetTitle returns the title of a bookmark.

func (*PdfiumImplementation) FPDFCatalog_IsTagged added in v0.5.0

FPDFCatalog_IsTagged determines if the given document represents a tagged PDF. For the definition of tagged PDF, See (see 10.7 "Tagged PDF" in PDF Reference 1.7). Experimental API.

func (*PdfiumImplementation) FPDFClipPath_CountPathSegments added in v0.9.0

FPDFClipPath_CountPathSegments returns the number of segments inside one path of the given clip path. Experimental API.

func (*PdfiumImplementation) FPDFClipPath_CountPaths added in v0.9.0

FPDFClipPath_CountPaths returns the number of paths inside the given clip path. Experimental API.

func (*PdfiumImplementation) FPDFClipPath_GetPathSegment added in v0.9.0

FPDFClipPath_GetPathSegment returns the segment in one specific path of the given clip path at index. Experimental API.

func (*PdfiumImplementation) FPDFDOC_ExitFormFillEnvironment added in v1.0.0

FPDFDOC_ExitFormFillEnvironment takes ownership of the handle and exits form fill environment.

func (*PdfiumImplementation) FPDFDOC_InitFormFillEnvironment added in v1.0.0

FPDFDOC_InitFormFillEnvironment initializes form fill environment This function should be called before any form fill operation. Not supported on multi-threaded usage due to its bidirectional nature.

func (*PdfiumImplementation) FPDFDest_GetDestPageIndex added in v0.5.0

FPDFDest_GetDestPageIndex returns the page index from destination data.

func (*PdfiumImplementation) FPDFDest_GetLocationInPage added in v0.5.0

FPDFDest_GetLocationInPage returns the (x, y, zoom) location of dest in the destination page, if the destination is in [page /XYZ x y zoom] syntax.

func (*PdfiumImplementation) FPDFDest_GetView added in v0.5.0

FPDFDest_GetView returns the view (fit type) for a given dest. Experimental API.

func (*PdfiumImplementation) FPDFDoc_AddAttachment added in v0.5.0

FPDFDoc_AddAttachment adds an embedded file with the given name in the given document. If the name is empty, or if the name is the name of an existing embedded file in the document, or if the document's embedded file name tree is too deep (i.e. the document has too many embedded files already), then a new attachment will not be added. Experimental API.

func (*PdfiumImplementation) FPDFDoc_CloseJavaScriptAction added in v0.5.0

FPDFDoc_CloseJavaScriptAction closes a loaded FPDF_JAVASCRIPT_ACTION object. Experimental API.

func (*PdfiumImplementation) FPDFDoc_DeleteAttachment added in v0.5.0

FPDFDoc_DeleteAttachment deletes the embedded attachment at the given index in the given document. Note that this does not remove the attachment data from the PDF file; it simply removes the file's entry in the embedded files name tree so that it does not appear in the attachment list. This behavior may change in the future. Experimental API.

func (*PdfiumImplementation) FPDFDoc_GetAttachment added in v0.5.0

FPDFDoc_GetAttachment returns the embedded attachment at the given index in the given document. Note that the returned attachment handle is only valid while the document is open. Experimental API.

func (*PdfiumImplementation) FPDFDoc_GetAttachmentCount added in v0.5.0

FPDFDoc_GetAttachmentCount returns the number of embedded files in the given document. Experimental API.

func (*PdfiumImplementation) FPDFDoc_GetJavaScriptAction added in v0.5.0

FPDFDoc_GetJavaScriptAction returns the JavaScript action at the given index in the given document. Experimental API.

func (*PdfiumImplementation) FPDFDoc_GetJavaScriptActionCount added in v0.5.0

FPDFDoc_GetJavaScriptActionCount returns the number of JavaScript actions in the given document. Experimental API.

func (*PdfiumImplementation) FPDFDoc_GetPageMode added in v0.5.0

FPDFDoc_GetPageMode returns the document's page mode, which describes how the document should be displayed when opened.

func (*PdfiumImplementation) FPDFFont_Close added in v0.9.0

FPDFFont_Close closes a loaded PDF font

func (*PdfiumImplementation) FPDFFont_GetAscent added in v0.9.0

FPDFFont_GetAscent returns ascent distance of a font. Ascent is the maximum distance in points above the baseline reached by the glyphs of the font. One point is 1/72 inch (around 0.3528 mm). Experimental API.

func (*PdfiumImplementation) FPDFFont_GetDescent added in v0.9.0

FPDFFont_GetDescent returns the descent distance of a font. Descent is the maximum distance in points below the baseline reached by the glyphs of the font. One point is 1/72 inch (around 0.3528 mm). Experimental API.

func (*PdfiumImplementation) FPDFFont_GetFlags added in v0.9.0

FPDFFont_GetFlags returns the descriptor flags of a font. Returns the bit flags specifying various characteristics of the font as defined in ISO 32000-1:2008, table 123. Experimental API.

func (*PdfiumImplementation) FPDFFont_GetFontName added in v0.9.0

FPDFFont_GetFontName returns the font name of a font. Experimental API.

func (*PdfiumImplementation) FPDFFont_GetGlyphPath added in v0.9.0

FPDFFont_GetGlyphPath returns the glyphpath describing how to draw a font glyph. Experimental API.

func (*PdfiumImplementation) FPDFFont_GetGlyphWidth added in v0.9.0

FPDFFont_GetGlyphWidth returns the width of a glyph in a font. Glyph width is the distance from the end of the prior glyph to the next glyph. This will be the vertical distance for vertical writing. Experimental API.

func (*PdfiumImplementation) FPDFFont_GetItalicAngle added in v0.9.0

FPDFFont_GetItalicAngle returns the italic angle of a font. The italic angle of a font is defined as degrees counterclockwise from vertical. For a font that slopes to the right, this will be negative. Experimental API.

func (*PdfiumImplementation) FPDFFont_GetWeight added in v0.9.0

FPDFFont_GetWeight returns the font weight of a font. Typical values are 400 (normal) and 700 (bold). Experimental API.

func (*PdfiumImplementation) FPDFFormObj_CountObjects added in v0.9.0

FPDFFormObj_CountObjects returns the number of page objects inside the given form object.

func (*PdfiumImplementation) FPDFFormObj_GetObject added in v0.9.0

FPDFFormObj_GetObject returns the page object in the given form object at the given index.

func (*PdfiumImplementation) FPDFGlyphPath_CountGlyphSegments added in v0.9.0

FPDFGlyphPath_CountGlyphSegments returns the number of segments inside the given glyphpath. Experimental API.

func (*PdfiumImplementation) FPDFGlyphPath_GetGlyphPathSegment added in v0.9.0

FPDFGlyphPath_GetGlyphPathSegment returns the segment in glyphpath at the given index. Experimental API.

func (*PdfiumImplementation) FPDFImageObj_GetBitmap added in v0.9.0

FPDFImageObj_GetBitmap returns a bitmap rasterization of the given image object. FPDFImageObj_GetBitmap() only operates on the image object and does not take the associated image mask into account. It also ignores the matrix for the image object. The returned bitmap will be owned by the caller, and FPDFBitmap_Destroy() must be called on the returned bitmap when it is no longer needed.

func (*PdfiumImplementation) FPDFImageObj_GetImageDataDecoded added in v0.9.0

FPDFImageObj_GetImageDataDecoded returns the decoded image data of the image object. The decoded data is the uncompressed image data, i.e. the raw image data after having all filters applied.

func (*PdfiumImplementation) FPDFImageObj_GetImageDataRaw added in v0.9.0

FPDFImageObj_GetImageDataRaw returns the raw image data of the image object. The raw data is the image data as stored in the PDF without applying any filters.

func (*PdfiumImplementation) FPDFImageObj_GetImageFilter added in v0.9.0

FPDFImageObj_GetImageFilter returns the filter at index of the image object's list of filters. Note that the filters need to be applied in order, i.e. the first filter should be applied first, then the second, etc.

func (*PdfiumImplementation) FPDFImageObj_GetImageFilterCount added in v0.9.0

FPDFImageObj_GetImageFilterCount returns the number of filters (i.e. decoders) of the image in image object.

func (*PdfiumImplementation) FPDFImageObj_GetImageMetadata added in v0.9.0

FPDFImageObj_GetImageMetadata returns the image metadata of the image object, including dimension, DPI, bits per pixel, and colorspace. If the image object is not an image object or if it does not have an image, then the return value will be false. Otherwise, failure to retrieve any specific parameter would result in its value being 0.

func (*PdfiumImplementation) FPDFImageObj_GetRenderedBitmap added in v0.9.0

FPDFImageObj_GetRenderedBitmap returns a bitmap rasterization of the given image object that takes the image mask and image matrix into account. To render correctly, the caller must provide the document associated with the image object. If there is a page associated with the image object the caller should provide that as well. The returned bitmap will be owned by the caller, and FPDFBitmap_Destroy() must be called on the returned bitmap when it is no longer needed. Experimental API.

func (*PdfiumImplementation) FPDFImageObj_LoadJpegFile added in v0.9.0

FPDFImageObj_LoadJpegFile loads an image from a JPEG image file and then set it into the given image object. The image object might already have an associated image, which is shared and cached by the loaded pages. In that case, we need to clear the cached image for all the loaded pages. Pass the pages and page count to this API to clear the image cache. If the image is not previously shared, nil is a valid pages value.

func (*PdfiumImplementation) FPDFImageObj_LoadJpegFileInline added in v0.9.0

FPDFImageObj_LoadJpegFileInline The image object might already have an associated image, which is shared and cached by the loaded pages. In that case, we need to clear the cached image for all the loaded pages. Pass the pages and page count to this API to clear the image cache. If the image is not previously shared, nil is a valid pages value. This function loads the JPEG image inline, so the image content is copied to the file. This allows the file access and its associated data to be deleted after this function returns.

func (*PdfiumImplementation) FPDFImageObj_SetBitmap added in v0.9.0

FPDFImageObj_SetBitmap sets the given bitmap to the given image object.

func (*PdfiumImplementation) FPDFImageObj_SetMatrix added in v0.9.0

FPDFImageObj_SetMatrix sets the transform matrix of the given image object. The matrix is composed as:

|a c e|
|b d f|

and can be used to scale, rotate, shear and translate the image object. Will be deprecated once FPDFPageObj_SetMatrix() is stable.

func (*PdfiumImplementation) FPDFJavaScriptAction_GetName added in v0.5.0

FPDFJavaScriptAction_GetName returns the name from the javascript handle. Experimental API.

func (*PdfiumImplementation) FPDFJavaScriptAction_GetScript added in v0.5.0

FPDFJavaScriptAction_GetScript returns the script from the javascript handle Experimental API.

FPDFLink_CloseWebLinks releases resources used by weblink feature.

FPDFLink_CountQuadPoints returns the count of quadrilateral points to the link.

FPDFLink_CountRects returns the count of rectangular areas for the link.

FPDFLink_CountWebLinks returns the count of detected web links.

FPDFLink_Enumerate Enumerates all the link annotations in a page.

FPDFLink_GetAction returns the action info for a link If this function returns a valid handle, it is valid as long as the link is valid.

FPDFLink_GetAnnot returns a FPDF_ANNOTATION object for a link. Experimental API.

FPDFLink_GetAnnotRect returns the count of quadrilateral points to the link.

FPDFLink_GetDest returns the destination info for a link.

FPDFLink_GetLinkAtPoint finds a link at a point on a page. You can convert coordinates from screen coordinates to page coordinates using FPDF_DeviceToPage().

FPDFLink_GetLinkZOrderAtPoint finds the Z-order of link at a point on a page. You can convert coordinates from screen coordinates to page coordinates using FPDF_DeviceToPage().

FPDFLink_GetQuadPoints returns the quadrilateral points for the specified quad index in the link.

FPDFLink_GetRect returns the boundaries of a rectangle for a link.

FPDFLink_GetTextRange returns the start char index and char count for a link. Experimental API.

FPDFLink_GetURL returns the URL information for a detected web link.

FPDFLink_LoadWebLinks prepares information about weblinks in a page. Weblinks are those links implicitly embedded in PDF pages. PDF also has a type of annotation called "link" (FPDFTEXT doesn't deal with that kind of link). FPDFTEXT weblink feature is useful for automatically detecting links in the page contents. For example, things like "https://www.example.com" will be detected, so applications can allow user to click on those characters to activate the link, even the PDF doesn't come with link annotations.

FPDFLink_CloseWebLinks must be called to release resources.

func (*PdfiumImplementation) FPDFPageObjMark_CountParams added in v0.9.0

FPDFPageObjMark_CountParams returns the number of key/value pair parameters in the given mark. Experimental API.

func (*PdfiumImplementation) FPDFPageObjMark_GetName added in v0.9.0

FPDFPageObjMark_GetName returns the name of a content mark. Experimental API.

func (*PdfiumImplementation) FPDFPageObjMark_GetParamBlobValue added in v0.9.0

FPDFPageObjMark_GetParamBlobValue returns the value of a blob property in a content mark by key. Experimental API.

func (*PdfiumImplementation) FPDFPageObjMark_GetParamIntValue added in v0.9.0

FPDFPageObjMark_GetParamIntValue returns the value of a number property in a content mark by key as int. FPDFPageObjMark_GetParamValueType() should have returned FPDF_OBJECT_NUMBER for this property. Experimental API.

func (*PdfiumImplementation) FPDFPageObjMark_GetParamKey added in v0.9.0

FPDFPageObjMark_GetParamKey returns the key of a property in a content mark. Experimental API.

func (*PdfiumImplementation) FPDFPageObjMark_GetParamStringValue added in v0.9.0

FPDFPageObjMark_GetParamStringValue returns the value of a string property in a content mark by key. Experimental API.

func (*PdfiumImplementation) FPDFPageObjMark_GetParamValueType added in v0.9.0

FPDFPageObjMark_GetParamValueType returns the type of the value of a property in a content mark by key. Experimental API.

func (*PdfiumImplementation) FPDFPageObjMark_RemoveParam added in v0.9.0

FPDFPageObjMark_RemoveParam removes a property from a content mark by key. Experimental API.

func (*PdfiumImplementation) FPDFPageObjMark_SetBlobParam added in v0.9.0

FPDFPageObjMark_SetBlobParam sets the value of a blob property in a content mark by key. If a parameter with the given key exists, its value is set to the given value. Otherwise, it is added as a new parameter. Experimental API.

func (*PdfiumImplementation) FPDFPageObjMark_SetIntParam added in v0.9.0

FPDFPageObjMark_SetIntParam sets the value of an int property in a content mark by key. If a parameter with the given key exists, its value is set to the given value. Otherwise, it is added as a new parameter. Experimental API.

func (*PdfiumImplementation) FPDFPageObjMark_SetStringParam added in v0.9.0

FPDFPageObjMark_SetStringParam sets the value of a string property in a content mark by key. If a parameter with the given key exists, its value is set to the given value. Otherwise, it is added as a new parameter. Experimental API.

func (*PdfiumImplementation) FPDFPageObj_AddMark added in v0.9.0

FPDFPageObj_AddMark adds a new content mark to the given page object. Experimental API.

func (*PdfiumImplementation) FPDFPageObj_CountMarks added in v0.9.0

FPDFPageObj_CountMarks returns the count of content marks in a page object. Experimental API.

func (*PdfiumImplementation) FPDFPageObj_CreateNewPath added in v0.9.0

FPDFPageObj_CreateNewPath creates a new path object at an initial position.

func (*PdfiumImplementation) FPDFPageObj_CreateNewRect added in v0.9.0

FPDFPageObj_CreateNewRect creates a closed path consisting of a rectangle.

func (*PdfiumImplementation) FPDFPageObj_CreateTextObj added in v0.9.0

FPDFPageObj_CreateTextObj creates a new text object using a loaded font.

func (*PdfiumImplementation) FPDFPageObj_Destroy added in v0.9.0

FPDFPageObj_Destroy destroys the page object by releasing its resources. The page object must have been created by FPDFPageObj_CreateNew{Path|Rect}() or FPDFPageObj_New{Text|Image}Obj(). This function must be called on newly-created objects if they are not added to a page through FPDFPage_InsertObject() or to an annotation through FPDFAnnot_AppendObject().

func (*PdfiumImplementation) FPDFPageObj_GetBounds added in v0.9.0

FPDFPageObj_GetBounds returns the bounding box of the given page object.

func (*PdfiumImplementation) FPDFPageObj_GetClipPath added in v0.9.0

FPDFPageObj_GetClipPath Get the clip path of the page object. Experimental API.

func (*PdfiumImplementation) FPDFPageObj_GetDashArray added in v0.9.0

FPDFPageObj_GetDashArray returns the line dash array of the page object. Experimental API.

func (*PdfiumImplementation) FPDFPageObj_GetDashCount added in v0.9.0

FPDFPageObj_GetDashCount returns the line dash array size of the page object. Experimental API.

func (*PdfiumImplementation) FPDFPageObj_GetDashPhase added in v0.9.0

FPDFPageObj_GetDashPhase returns the line dash phase of the page object. Experimental API.

func (*PdfiumImplementation) FPDFPageObj_GetFillColor added in v0.9.0

FPDFPageObj_GetFillColor returns the fill RGBA of a page object

func (*PdfiumImplementation) FPDFPageObj_GetLineCap added in v0.9.0

FPDFPageObj_GetLineCap returns the line cap of the page object.

func (*PdfiumImplementation) FPDFPageObj_GetLineJoin added in v0.9.0

FPDFPageObj_GetLineJoin returns the line join of the page object.

func (*PdfiumImplementation) FPDFPageObj_GetMark added in v0.9.0

FPDFPageObj_GetMark returns the content mark of a page object at the given index. Experimental API.

func (*PdfiumImplementation) FPDFPageObj_GetMatrix added in v0.9.0

FPDFPageObj_GetMatrix returns the transform matrix of a page object. The matrix is composed as:

|a c e|
|b d f|

and can be used to scale, rotate, shear and translate the page object. Experimental API.

func (*PdfiumImplementation) FPDFPageObj_GetStrokeColor added in v0.9.0

FPDFPageObj_GetStrokeColor returns the stroke RGBA of a page object

func (*PdfiumImplementation) FPDFPageObj_GetStrokeWidth added in v0.9.0

FPDFPageObj_GetStrokeWidth returns the stroke width of a page object.

func (*PdfiumImplementation) FPDFPageObj_GetType added in v0.9.0

FPDFPageObj_GetType returns the type of the given page object.

func (*PdfiumImplementation) FPDFPageObj_HasTransparency added in v0.9.0

FPDFPageObj_HasTransparency returns whether the given page object contains transparency.

func (*PdfiumImplementation) FPDFPageObj_NewImageObj added in v0.9.0

FPDFPageObj_NewImageObj creates a new image object.

func (*PdfiumImplementation) FPDFPageObj_NewTextObj added in v0.9.0

FPDFPageObj_NewTextObj creates a new text object using one of the standard PDF fonts.

func (*PdfiumImplementation) FPDFPageObj_RemoveMark added in v0.9.0

FPDFPageObj_RemoveMark removes the given content mark from the given page object. Experimental API.

func (*PdfiumImplementation) FPDFPageObj_SetBlendMode added in v0.9.0

FPDFPageObj_SetBlendMode sets the blend mode of the page object.

func (*PdfiumImplementation) FPDFPageObj_SetDashArray added in v0.9.0

FPDFPageObj_SetDashArray sets the line dash array of the page object. Experimental API.

func (*PdfiumImplementation) FPDFPageObj_SetDashPhase added in v0.9.0

FPDFPageObj_SetDashPhase sets the line dash phase of the page object. Experimental API.

func (*PdfiumImplementation) FPDFPageObj_SetFillColor added in v0.9.0

FPDFPageObj_SetFillColor sets the fill RGBA of a page object

func (*PdfiumImplementation) FPDFPageObj_SetLineCap added in v0.9.0

FPDFPageObj_SetLineCap sets the line cap of the page object.

func (*PdfiumImplementation) FPDFPageObj_SetLineJoin added in v0.9.0

FPDFPageObj_SetLineJoin sets the line join of the page object.

func (*PdfiumImplementation) FPDFPageObj_SetMatrix added in v0.9.0

FPDFPageObj_SetMatrix sets the transform matrix on a page object. The matrix is composed as:

|a c e|
|b d f|

and can be used to scale, rotate, shear and translate the page object. Experimental API.

func (*PdfiumImplementation) FPDFPageObj_SetStrokeColor added in v0.9.0

FPDFPageObj_SetStrokeColor sets the stroke RGBA of a page object.

func (*PdfiumImplementation) FPDFPageObj_SetStrokeWidth added in v0.9.0

FPDFPageObj_SetStrokeWidth sets the stroke width of a page object

func (*PdfiumImplementation) FPDFPageObj_Transform added in v0.9.0

FPDFPageObj_Transform transforms the page object by the given matrix. The matrix is composed as:

|a c e|
|b d f|

and can be used to scale, rotate, shear and translate the page object.

func (*PdfiumImplementation) FPDFPageObj_TransformClipPath added in v0.9.0

FPDFPageObj_TransformClipPath transform (scale, rotate, shear, move) the clip path of page object.

func (*PdfiumImplementation) FPDFPage_CloseAnnot added in v1.0.0

FPDFPage_CloseAnnot closes an annotation. Must be called when the annotation returned by FPDFPage_CreateAnnot() or FPDFPage_GetAnnot() is no longer needed. This function does not remove the annotation from the document. Experimental API.

func (*PdfiumImplementation) FPDFPage_CountObjects added in v0.9.0

FPDFPage_CountObjects returns the number of page objects inside the given page.

func (*PdfiumImplementation) FPDFPage_CreateAnnot added in v1.0.0

FPDFPage_CreateAnnot creates an annotation in the given page of the given subtype. If the specified subtype is illegal or unsupported, then a new annotation will not be created. Must call FPDFPage_CloseAnnot() when the annotation returned by this function is no longer needed. Experimental API.

func (*PdfiumImplementation) FPDFPage_Delete added in v0.9.0

FPDFPage_Delete deletes the page at the given index.

func (*PdfiumImplementation) FPDFPage_Flatten added in v0.5.0

FPDFPage_Flatten makes annotations and form fields become part of the page contents itself.

func (*PdfiumImplementation) FPDFPage_FormFieldZOrderAtPoint added in v1.0.0

FPDFPage_FormFieldZOrderAtPoint returns the form field z-order by point.

func (*PdfiumImplementation) FPDFPage_GenerateContent added in v0.9.0

FPDFPage_GenerateContent generates the contents of the page.

func (*PdfiumImplementation) FPDFPage_GetAnnot added in v1.0.0

FPDFPage_GetAnnot returns annotation at the given page and index. Must call FPDFPage_CloseAnnot() when the annotation returned by this function is no longer needed. Experimental API.

func (*PdfiumImplementation) FPDFPage_GetAnnotCount added in v1.0.0

FPDFPage_GetAnnotCount returns the number of annotations in a given page. Experimental API.

func (*PdfiumImplementation) FPDFPage_GetAnnotIndex added in v1.0.0

FPDFPage_GetAnnotIndex returns the index of the given annotation in the given page. This is the opposite of FPDFPage_GetAnnot(). Experimental API.

func (*PdfiumImplementation) FPDFPage_GetArtBox added in v0.9.0

FPDFPage_GetArtBox gets the "ArtBox" entry from the page dictionary.

func (*PdfiumImplementation) FPDFPage_GetBleedBox added in v0.9.0

FPDFPage_GetBleedBox gets the "BleedBox" entry from the page dictionary.

func (*PdfiumImplementation) FPDFPage_GetCropBox added in v0.9.0

FPDFPage_GetCropBox gets the "CropBox" entry from the page dictionary.

func (*PdfiumImplementation) FPDFPage_GetDecodedThumbnailData added in v0.5.0

FPDFPage_GetDecodedThumbnailData returns the decoded data from the thumbnail of the given page if it exists. Experimental API.

func (*PdfiumImplementation) FPDFPage_GetMediaBox added in v0.9.0

FPDFPage_GetMediaBox gets the "MediaBox" entry from the page dictionary

func (*PdfiumImplementation) FPDFPage_GetObject added in v0.9.0

FPDFPage_GetObject returns the object at the given index.

func (*PdfiumImplementation) FPDFPage_GetRawThumbnailData added in v0.5.0

FPDFPage_GetRawThumbnailData returns the raw data from the thumbnail of the given page if it exists. Experimental API.

func (*PdfiumImplementation) FPDFPage_GetRotation added in v0.5.0

FPDFPage_GetRotation returns the page rotation.

func (*PdfiumImplementation) FPDFPage_GetThumbnailAsBitmap added in v0.5.0

FPDFPage_GetThumbnailAsBitmap returns the thumbnail of the given page as a FPDF_BITMAP. Experimental API.

func (*PdfiumImplementation) FPDFPage_GetTrimBox added in v0.9.0

FPDFPage_GetTrimBox gets the "TrimBox" entry from the page dictionary.

func (*PdfiumImplementation) FPDFPage_HasFormFieldAtPoint added in v1.0.0

FPDFPage_HasFormFieldAtPoint returns the form field type by point.

func (*PdfiumImplementation) FPDFPage_HasTransparency added in v0.5.0

FPDFPage_HasTransparency returns whether the page has transparency.

func (*PdfiumImplementation) FPDFPage_InsertClipPath added in v0.9.0

FPDFPage_InsertClipPath Clip the page content, the page content that outside the clipping region become invisible.

func (*PdfiumImplementation) FPDFPage_InsertObject added in v0.9.0

FPDFPage_InsertObject inserts the given object into a page.

func (*PdfiumImplementation) FPDFPage_New added in v0.9.0

func (p *PdfiumImplementation) FPDFPage_New(request *requests.FPDFPage_New) (*responses.FPDFPage_New, error)

FPDFPage_New creates a new PDF page. The page should be closed with FPDF_ClosePage() when finished as with any other page in the document.

func (*PdfiumImplementation) FPDFPage_RemoveAnnot added in v1.0.0

FPDFPage_RemoveAnnot removes the annotation in the given page at the given index. Experimental API.

func (*PdfiumImplementation) FPDFPage_RemoveObject added in v0.9.0

FPDFPage_RemoveObject removes an object from a page. Ownership is transferred to the caller. Call FPDFPageObj_Destroy() to free it. Experimental API.

func (*PdfiumImplementation) FPDFPage_SetArtBox added in v0.9.0

FPDFPage_SetArtBox sets the "ArtBox" entry to the page dictionary.

func (*PdfiumImplementation) FPDFPage_SetBleedBox added in v0.9.0

FPDFPage_SetBleedBox sets the "BleedBox" entry to the page dictionary.

func (*PdfiumImplementation) FPDFPage_SetCropBox added in v0.9.0

FPDFPage_SetCropBox sets the "CropBox" entry to the page dictionary.

func (*PdfiumImplementation) FPDFPage_SetMediaBox added in v0.9.0

FPDFPage_SetMediaBox sets the "MediaBox" entry to the page dictionary.

func (*PdfiumImplementation) FPDFPage_SetRotation added in v0.5.0

FPDFPage_SetRotation sets the page rotation for a given page.

func (*PdfiumImplementation) FPDFPage_SetTrimBox added in v0.9.0

FPDFPage_SetTrimBox sets the "TrimBox" entry to the page dictionary.

func (*PdfiumImplementation) FPDFPage_TransFormWithClip added in v0.9.0

FPDFPage_TransFormWithClip applies the transforms to the page.

func (*PdfiumImplementation) FPDFPage_TransformAnnots added in v0.9.0

FPDFPage_TransformAnnots transforms all annotations in the given page. The matrix is composed as:

|a c e|
|b d f|

and can be used to scale, rotate, shear and translate the page annotations.

func (*PdfiumImplementation) FPDFPathSegment_GetClose added in v0.9.0

FPDFPathSegment_GetClose returns whether the segment closes the current subpath of a given path.

func (*PdfiumImplementation) FPDFPathSegment_GetPoint added in v0.9.0

FPDFPathSegment_GetPoint returns the coordinates of the given segment.

func (*PdfiumImplementation) FPDFPathSegment_GetType added in v0.9.0

FPDFPathSegment_GetType returns the type of the given segment.

func (*PdfiumImplementation) FPDFPath_BezierTo added in v0.9.0

FPDFPath_BezierTo adds a cubic Bezier curve to the given path, starting at the current point.

func (*PdfiumImplementation) FPDFPath_Close added in v0.9.0

FPDFPath_Close closes the current subpath of a given path.

func (*PdfiumImplementation) FPDFPath_CountSegments added in v0.9.0

FPDFPath_CountSegments returns the number of segments inside the given path. A segment is a command, created by e.g. FPDFPath_MoveTo(), FPDFPath_LineTo() or FPDFPath_BezierTo().

func (*PdfiumImplementation) FPDFPath_GetDrawMode added in v0.9.0

FPDFPath_GetDrawMode returns the drawing mode of a path.

func (*PdfiumImplementation) FPDFPath_GetPathSegment added in v0.9.0

FPDFPath_GetPathSegment returns the segment in the given path at the given index.

func (*PdfiumImplementation) FPDFPath_LineTo added in v0.9.0

FPDFPath_LineTo adds a line between the current point and a new point in the path.

func (*PdfiumImplementation) FPDFPath_MoveTo added in v0.9.0

FPDFPath_MoveTo moves a path's current point. Note that no line will be created between the previous current point and the new one.

func (*PdfiumImplementation) FPDFPath_SetDrawMode added in v0.9.0

FPDFPath_SetDrawMode sets the drawing mode of a path.

func (*PdfiumImplementation) FPDFSignatureObj_GetByteRange added in v0.5.0

FPDFSignatureObj_GetByteRange returns the byte range of a signature object. Experimental API.

func (*PdfiumImplementation) FPDFSignatureObj_GetContents added in v0.5.0

FPDFSignatureObj_GetContents returns the contents of a signature object. Experimental API.

func (*PdfiumImplementation) FPDFSignatureObj_GetDocMDPPermission added in v0.5.0

FPDFSignatureObj_GetDocMDPPermission returns the DocMDP permission of a signature object. Experimental API.

func (*PdfiumImplementation) FPDFSignatureObj_GetReason added in v0.5.0

FPDFSignatureObj_GetReason returns the reason (comment) of the signature object. Experimental API.

func (*PdfiumImplementation) FPDFSignatureObj_GetSubFilter added in v0.5.0

FPDFSignatureObj_GetSubFilter returns the encoding of the value of a signature object. Experimental API.

func (*PdfiumImplementation) FPDFSignatureObj_GetTime added in v0.5.0

FPDFSignatureObj_GetTime returns the time of signing of a signature object. Experimental API.

func (*PdfiumImplementation) FPDFTextObj_GetFont added in v0.9.0

FPDFTextObj_GetFont returns the font of a text object. Experimental API.

func (*PdfiumImplementation) FPDFTextObj_GetFontSize added in v0.9.0

FPDFTextObj_GetFontSize returns the font size of a text object.

func (*PdfiumImplementation) FPDFTextObj_GetText added in v0.9.0

FPDFTextObj_GetText returns the text of a text object.

func (*PdfiumImplementation) FPDFTextObj_GetTextRenderMode added in v0.9.0

FPDFTextObj_GetTextRenderMode returns the text rendering mode of a text object.

func (*PdfiumImplementation) FPDFTextObj_SetTextRenderMode added in v0.9.0

FPDFTextObj_SetTextRenderMode sets the text rendering mode of a text object. Experimental API.

func (*PdfiumImplementation) FPDFText_ClosePage added in v0.5.0

FPDFText_ClosePage Release all resources allocated for a text page information structure.

func (*PdfiumImplementation) FPDFText_CountChars added in v0.5.0

FPDFText_CountChars returns the number of characters in a page. Characters in a page form a "stream", inside the stream, each character has an index. We will use the index parameters in many of FPDFTEXT functions. The first character in the page has an index value of zero.

func (*PdfiumImplementation) FPDFText_CountRects added in v0.5.0

FPDFText_CountRects returns the count of rectangular areas occupied by a segment of text, and caches the result for subsequent FPDFText_GetRect() calls. This function, along with FPDFText_GetRect can be used by applications to detect the position on the page for a text segment, so proper areas can be highlighted. The FPDFText_* functions will automatically merge small character boxes into bigger one if those characters are on the same line and use same font settings.

func (*PdfiumImplementation) FPDFText_FindClose added in v0.5.0

FPDFText_FindClose releases a search context.

func (*PdfiumImplementation) FPDFText_FindNext added in v0.5.0

FPDFText_FindNext searches in the direction from page start to end.

func (*PdfiumImplementation) FPDFText_FindPrev added in v0.5.0

FPDFText_FindPrev searches in the direction from page end to start.

func (*PdfiumImplementation) FPDFText_FindStart added in v0.5.0

FPDFText_FindStart returns a handle to search a page.

func (*PdfiumImplementation) FPDFText_GetBoundedText added in v0.5.0

FPDFText_GetBoundedText extract unicode text within a rectangular boundary on the page.

func (*PdfiumImplementation) FPDFText_GetCharAngle added in v0.5.0

FPDFText_GetCharAngle returns the character rotation angle. Experimental API.

func (*PdfiumImplementation) FPDFText_GetCharBox added in v0.5.0

FPDFText_GetCharBox returns the bounding box of a particular character. All positions are measured in PDF "user space".

func (*PdfiumImplementation) FPDFText_GetCharIndexAtPos added in v0.5.0

FPDFText_GetCharIndexAtPos returns the index of a character at or nearby a certain position on the page.

func (*PdfiumImplementation) FPDFText_GetCharIndexFromTextIndex added in v0.6.0

FPDFText_GetCharIndexFromTextIndex returns the character index in the text page internal character list. Where the character index is an index of the text returned from FPDFText_GetText().

func (*PdfiumImplementation) FPDFText_GetCharOrigin added in v0.5.0

FPDFText_GetCharOrigin returns origin of a particular character. All positions are measured in PDF "user space".

func (*PdfiumImplementation) FPDFText_GetFillColor added in v0.5.0

FPDFText_GetFillColor returns the fill color of a particular character. Experimental API.

func (*PdfiumImplementation) FPDFText_GetFontInfo added in v0.5.0

FPDFText_GetFontInfo returns the font name and flags of a particular character. Experimental API.

func (*PdfiumImplementation) FPDFText_GetFontSize added in v0.5.0

FPDFText_GetFontSize returns the font size of a particular character.

func (*PdfiumImplementation) FPDFText_GetFontWeight added in v0.5.0

FPDFText_GetFontWeight returns the font weight of a particular character. Experimental API.

func (*PdfiumImplementation) FPDFText_GetLooseCharBox added in v0.5.0

FPDFText_GetLooseCharBox returns a "loose" bounding box of a particular character, i.e., covering the entire glyph bounds, without taking the actual glyph shape into account. All positions are measured in PDF "user space". Experimental API.

func (*PdfiumImplementation) FPDFText_GetMatrix added in v0.5.0

FPDFText_GetMatrix returns the effective transformation matrix for a particular character. All positions are measured in PDF "user space". Experimental API.

func (*PdfiumImplementation) FPDFText_GetRect added in v0.5.0

FPDFText_GetRect returns a rectangular area from the result generated by FPDFText_CountRects Note: this method only works if you called FPDFText_CountRects first.

func (*PdfiumImplementation) FPDFText_GetSchCount added in v0.5.0

FPDFText_GetSchCount returns the number of matched characters in the search result.

func (*PdfiumImplementation) FPDFText_GetSchResultIndex added in v0.5.0

FPDFText_GetSchResultIndex returns the starting character index of the search result.

func (*PdfiumImplementation) FPDFText_GetStrokeColor added in v0.5.0

FPDFText_GetStrokeColor returns the stroke color of a particular character. Experimental API.

func (*PdfiumImplementation) FPDFText_GetText added in v0.5.0

FPDFText_GetText extracts unicode text string from the page.

func (*PdfiumImplementation) FPDFText_GetTextIndexFromCharIndex added in v0.6.0

FPDFText_GetTextIndexFromCharIndex returns the text index in the text page internal character list. Where the text index is an index of the character in the internal character list.

func (*PdfiumImplementation) FPDFText_GetTextRenderMode added in v0.5.0

FPDFText_GetTextRenderMode returns the text rendering mode of character. Experimental API.

func (*PdfiumImplementation) FPDFText_GetUnicode added in v0.5.0

FPDFText_GetUnicode returns the unicode of a character in a page.

func (*PdfiumImplementation) FPDFText_LoadFont added in v0.9.0

FPDFText_LoadFont returns a font object loaded from a stream of data. The font is loaded into the document. The loaded font can be closed using FPDFFont_Close.

func (*PdfiumImplementation) FPDFText_LoadPage added in v0.5.0

FPDFText_LoadPage returns a handle to the text page information structure. Application must call FPDFText_ClosePage to release the text page

func (*PdfiumImplementation) FPDFText_LoadStandardFont added in v0.9.0

FPDFText_LoadStandardFont loads one of the standard 14 fonts per PDF spec 1.7 page 416. The preferred way of using font style is using a dash to separate the name from the style, for example 'Helvetica-BoldItalic'. The loaded font can be closed using FPDFFont_Close. Experimental API.

func (*PdfiumImplementation) FPDFText_SetCharcodes added in v0.9.0

FPDFText_SetCharcodes sets the text using charcodes for a text object. If it had text, it will be replaced.

func (*PdfiumImplementation) FPDFText_SetText added in v0.9.0

FPDFText_SetText sets the text for a text object. If it had text, it will be replaced.

func (*PdfiumImplementation) FPDF_CloseDocument added in v0.5.0

FPDF_CloseDocument closes the references, releases the resources.

func (*PdfiumImplementation) FPDF_ClosePage added in v0.5.0

FPDF_ClosePage unloads a page by reference.

func (*PdfiumImplementation) FPDF_CloseXObject added in v0.5.0

FPDF_CloseXObject closes an FPDF_XOBJECT handle created by FPDF_NewXObjectFromPage(). Experimental API.

func (*PdfiumImplementation) FPDF_CopyViewerPreferences added in v0.5.0

FPDF_CopyViewerPreferences copies the viewer preferences from one PDF document to another

func (*PdfiumImplementation) FPDF_CountNamedDests added in v0.7.0

FPDF_CountNamedDests returns the count of named destinations in the PDF document.

func (*PdfiumImplementation) FPDF_CreateClipPath added in v0.9.0

FPDF_CreateClipPath creates a new clip path, with a rectangle inserted.

func (*PdfiumImplementation) FPDF_CreateNewDocument added in v0.5.0

FPDF_CreateNewDocument returns a new document.

func (*PdfiumImplementation) FPDF_DestroyClipPath added in v0.9.0

FPDF_DestroyClipPath destroys the clip path.

func (*PdfiumImplementation) FPDF_DeviceToPage added in v0.7.0

FPDF_DeviceToPage converts the screen coordinates of a point to page coordinates. The page coordinate system has its origin at the left-bottom corner of the page, with the X-axis on the bottom going to the right, and the Y-axis on the left side going up.

NOTE: this coordinate system can be altered when you zoom, scroll, or rotate a page, however, a point on the page should always have the same coordinate values in the page coordinate system.

The device coordinate system is device dependent. For screen device, its origin is at the left-top corner of the window. However this origin can be altered by the Windows coordinate transformation utilities.

You must make sure the start_x, start_y, size_x, size_y and rotate parameters have exactly same values as you used in the FPDF_RenderPage() function call.

func (*PdfiumImplementation) FPDF_DocumentHasValidCrossReferenceTable added in v0.7.0

FPDF_DocumentHasValidCrossReferenceTable returns whether the document's cross reference table is valid or not. Experimental API.

func (*PdfiumImplementation) FPDF_FFLDraw added in v1.0.0

func (p *PdfiumImplementation) FPDF_FFLDraw(request *requests.FPDF_FFLDraw) (*responses.FPDF_FFLDraw, error)

FPDF_FFLDraw renders FormFields and popup window on a page to a device independent bitmap. This function is designed to render annotations that are user-interactive, which are widget annotations (for FormFields) and popup annotations. With the FPDF_ANNOT flag, this function will render a popup annotation when users mouse-hover on a non-widget annotation. Regardless of FPDF_ANNOT flag, this function will always render widget annotations for FormFields. In order to implement the FormFill functions, implementation should call this function after rendering functions, such as FPDF_RenderPageBitmap() or FPDF_RenderPageBitmap_Start(), have finished rendering the page contents.

func (*PdfiumImplementation) FPDF_GetDocPermissions added in v0.5.0

FPDF_GetDocPermissions returns the permissions of the PDF.

func (*PdfiumImplementation) FPDF_GetFileIdentifier added in v0.5.0

FPDF_GetFileIdentifier Get the file identifier defined in the trailer of a document. Experimental API.

func (*PdfiumImplementation) FPDF_GetFileVersion added in v0.5.0

FPDF_GetFileVersion returns the version of the PDF file.

func (*PdfiumImplementation) FPDF_GetFormType added in v1.0.0

FPDF_GetFormType returns the type of form contained in the PDF document. If document is nil, then the return value is FORMTYPE_NONE. Experimental API

func (*PdfiumImplementation) FPDF_GetLastError added in v0.5.0

FPDF_GetLastError returns the last error generated by PDFium.

func (*PdfiumImplementation) FPDF_GetMetaText added in v0.5.0

FPDF_GetMetaText returns the requested metadata.

func (*PdfiumImplementation) FPDF_GetNamedDest added in v0.7.0

FPDF_GetNamedDest returns the named destination by index.

func (*PdfiumImplementation) FPDF_GetNamedDestByName added in v0.7.0

FPDF_GetNamedDestByName returns the destination handle for the given name.

func (*PdfiumImplementation) FPDF_GetPageAAction added in v0.5.0

FPDF_GetPageAAction returns an additional-action from page. Experimental API

func (*PdfiumImplementation) FPDF_GetPageBoundingBox added in v0.7.0

FPDF_GetPageBoundingBox returns the bounding box of the page. This is the intersection between its media box and its crop box. Experimental API.

func (*PdfiumImplementation) FPDF_GetPageCount added in v0.5.0

FPDF_GetPageCount counts the amount of pages.

func (*PdfiumImplementation) FPDF_GetPageHeight added in v0.5.0

FPDF_GetPageHeight returns the height of a page.

func (*PdfiumImplementation) FPDF_GetPageHeightF added in v0.7.0

FPDF_GetPageHeightF returns the page height in float32. Experimental API.

func (*PdfiumImplementation) FPDF_GetPageLabel added in v0.5.0

FPDF_GetPageLabel returns the label for the given page.

func (*PdfiumImplementation) FPDF_GetPageSizeByIndex added in v0.5.0

FPDF_GetPageSizeByIndex returns the size of a page by the page index.

func (*PdfiumImplementation) FPDF_GetPageSizeByIndexF added in v0.7.0

FPDF_GetPageSizeByIndexF returns the size of the page at the given index. Prefer FPDF_GetPageSizeByIndexF(). This will be deprecated in the future. Experimental API.

func (*PdfiumImplementation) FPDF_GetPageWidth added in v0.5.0

FPDF_GetPageWidth returns the width of a page.

func (*PdfiumImplementation) FPDF_GetPageWidthF added in v0.7.0

FPDF_GetPageWidthF returns the page width in float32. Experimental API.

func (*PdfiumImplementation) FPDF_GetSecurityHandlerRevision added in v0.5.0

FPDF_GetSecurityHandlerRevision returns the revision number of security handlers of the file.

func (*PdfiumImplementation) FPDF_GetSignatureCount added in v0.5.0

FPDF_GetSignatureCount returns the total number of signatures in the document. Experimental API.

func (*PdfiumImplementation) FPDF_GetSignatureObject added in v0.5.0

FPDF_GetSignatureObject returns the Nth signature of the document. Experimental API.

func (*PdfiumImplementation) FPDF_GetTrailerEnds added in v0.7.0

FPDF_GetTrailerEnds returns the byte offsets of trailer ends. Experimental API.

func (*PdfiumImplementation) FPDF_GetXFAPacketContent added in v0.7.0

FPDF_GetXFAPacketContent returns the content of a packet in the XFA array. Experimental API.

func (*PdfiumImplementation) FPDF_GetXFAPacketCount added in v0.7.0

FPDF_GetXFAPacketCount returns the number of valid packets in the XFA entry. Experimental API.

func (*PdfiumImplementation) FPDF_GetXFAPacketName added in v0.7.0

FPDF_GetXFAPacketName returns the name of a packet in the XFA array. Experimental API.

func (*PdfiumImplementation) FPDF_ImportNPagesToOne added in v0.5.0

FPDF_ImportNPagesToOne creates a new document from source document. The pages of source document will be combined to provide NumPagesOnXAxis x NumPagesOnYAxis pages per page of the output document. Experimental API.

func (*PdfiumImplementation) FPDF_ImportPages added in v0.5.0

FPDF_ImportPages imports some pages from one PDF document to another one.

func (*PdfiumImplementation) FPDF_ImportPagesByIndex added in v0.5.0

FPDF_ImportPagesByIndex imports pages to a FPDF_DOCUMENT. Experimental API.

func (*PdfiumImplementation) FPDF_LoadCustomDocument added in v0.6.0

FPDF_LoadCustomDocument loads a PDF document from a custom access descriptor. This is implemented as an io.ReadSeeker in go-pdfium. This is only really efficient for single threaded usage, the multi-threaded usage will just load the file in memory because it can't transfer readers over gRPC. The single-threaded usage will actually efficiently walk over the PDF as it's being used by PDFium. Loaded document can be closed by FPDF_CloseDocument(). If this function fails, you can use FPDF_GetLastError() to retrieve the reason why it failed.

func (*PdfiumImplementation) FPDF_LoadDocument added in v0.6.0

FPDF_LoadDocument opens and load a PDF document from a file path. Loaded document can be closed by FPDF_CloseDocument(). If this function fails, you can use FPDF_GetLastError() to retrieve the reason why it failed.

func (*PdfiumImplementation) FPDF_LoadMemDocument added in v0.6.0

FPDF_LoadMemDocument opens and load a PDF document from memory. Loaded document can be closed by FPDF_CloseDocument(). If this function fails, you can use FPDF_GetLastError() to retrieve the reason why it failed.

func (*PdfiumImplementation) FPDF_LoadMemDocument64 added in v0.6.0

FPDF_LoadMemDocument64 opens and load a PDF document from memory. Loaded document can be closed by FPDF_CloseDocument(). If this function fails, you can use FPDF_GetLastError() to retrieve the reason why it failed. Experimental API.

func (*PdfiumImplementation) FPDF_LoadPage added in v0.5.0

FPDF_LoadPage loads a page and returns a reference.

func (*PdfiumImplementation) FPDF_LoadXFA added in v1.0.0

func (p *PdfiumImplementation) FPDF_LoadXFA(request *requests.FPDF_LoadXFA) (*responses.FPDF_LoadXFA, error)

FPDF_LoadXFA load XFA fields of the document if it consists of XFA fields.

func (*PdfiumImplementation) FPDF_NewFormObjectFromXObject added in v0.5.0

FPDF_NewFormObjectFromXObject creates a new form object from an FPDF_XOBJECT object. Experimental API.

func (*PdfiumImplementation) FPDF_NewXObjectFromPage added in v0.5.0

FPDF_NewXObjectFromPage creates a template to generate form xobjects from the source document's page at the given index, for use in the destination document. Experimental API.

func (*PdfiumImplementation) FPDF_PageToDevice added in v0.7.0

FPDF_PageToDevice converts the page coordinates of a point to screen coordinates. See comments for FPDF_DeviceToPage().

func (*PdfiumImplementation) FPDF_RemoveFormFieldHighlight added in v1.0.0

FPDF_RemoveFormFieldHighlight removes the form field highlight color in the document.

func (*PdfiumImplementation) FPDF_RenderPage added in v0.8.0

FPDF_RenderPage renders contents of a page to a device (screen, bitmap, or printer). This feature does not work on multi-threaded usage as you will need to give a device handle. Windows only!

func (*PdfiumImplementation) FPDF_RenderPageBitmap added in v0.7.0

FPDF_RenderPageBitmap renders contents of a page to a device independent bitmap.

func (*PdfiumImplementation) FPDF_RenderPageBitmapWithColorScheme_Start added in v0.9.0

FPDF_RenderPageBitmapWithColorScheme_Start starts to render page contents to a device independent bitmap progressively with a specified color scheme for the content. Not supported on multi-threaded usage. Experimental API.

func (*PdfiumImplementation) FPDF_RenderPageBitmapWithMatrix added in v0.7.0

FPDF_RenderPageBitmapWithMatrix renders contents of a page to a device independent bitmap.

func (*PdfiumImplementation) FPDF_RenderPageBitmap_Start added in v0.9.0

FPDF_RenderPageBitmap_Start starts to render page contents to a device independent bitmap progressively. Not supported on multi-threaded usage.

func (*PdfiumImplementation) FPDF_RenderPage_Close added in v0.9.0

FPDF_RenderPage_Close Release the resource allocate during page rendering. Need to be called after finishing rendering or cancel the rendering. Not supported on multi-threaded usage.

func (*PdfiumImplementation) FPDF_RenderPage_Continue added in v0.9.0

FPDF_RenderPage_Continue continues rendering a PDF page. Not supported on multi-threaded usage.

func (*PdfiumImplementation) FPDF_SaveAsCopy added in v0.5.0

FPDF_SaveAsCopy saves the document to a copy.

func (*PdfiumImplementation) FPDF_SaveWithVersion added in v0.5.0

FPDF_SaveWithVersion save the document to a copy, with a specific file version.

func (*PdfiumImplementation) FPDF_SetFormFieldHighlightAlpha added in v1.0.0

FPDF_SetFormFieldHighlightAlpha sets the transparency of the form field highlight color in the document.

func (*PdfiumImplementation) FPDF_SetFormFieldHighlightColor added in v1.0.0

FPDF_SetFormFieldHighlightColor sets the highlight color of the specified (or all) form fields in the document.

func (*PdfiumImplementation) FPDF_SetPrintMode added in v0.8.0

FPDF_SetPrintMode sets printing mode when printing on Windows. Experimental API. Windows only!

func (*PdfiumImplementation) FPDF_SetSandBoxPolicy added in v0.5.0

FPDF_SetSandBoxPolicy set the policy for the sandbox environment.

func (*PdfiumImplementation) FPDF_StructElement_Attr_GetBlobValue added in v1.0.0

FPDF_StructElement_Attr_GetBlobValue returns the value of a blob attribute in an attribute map by name as string. Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_Attr_GetBooleanValue added in v1.0.0

FPDF_StructElement_Attr_GetBooleanValue returns the value of a boolean attribute in an attribute map by name as FPDF_BOOL. FPDF_StructElement_Attr_GetType() should have returned FPDF_OBJECT_BOOLEAN for this property. Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_Attr_GetCount added in v1.0.0

FPDF_StructElement_Attr_GetCount returns the number of attributes in a structure element attribute map. Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_Attr_GetName added in v1.0.0

FPDF_StructElement_Attr_GetName returns the name of an attribute in a structure element attribute map. Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_Attr_GetNumberValue added in v1.0.0

FPDF_StructElement_Attr_GetNumberValue returns the value of a number attribute in an attribute map by name as float. FPDF_StructElement_Attr_GetType() should have returned FPDF_OBJECT_NUMBER for this property. Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_Attr_GetStringValue added in v1.0.0

FPDF_StructElement_Attr_GetStringValue returns the value of a string attribute in an attribute map by name as string. FPDF_StructElement_Attr_GetType() should have returned FPDF_OBJECT_STRING or FPDF_OBJECT_NAME for this property. Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_Attr_GetType added in v1.0.0

FPDF_StructElement_Attr_GetType returns the type of an attribute in a structure element attribute map. Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_CountChildren added in v0.9.0

FPDF_StructElement_CountChildren counts the number of children for the structure element.

func (*PdfiumImplementation) FPDF_StructElement_GetActualText added in v1.0.0

FPDF_StructElement_GetActualText returns the actual text for a given element. Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_GetAltText added in v0.9.0

FPDF_StructElement_GetAltText returns the alt text for a given element.

func (*PdfiumImplementation) FPDF_StructElement_GetAttributeAtIndex added in v1.0.0

FPDF_StructElement_GetAttributeAtIndex returns an attribute object in the structure element. If the attribute object exists but is not a dict, then this function will return an error. This will also return an error for out of bounds indices. Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_GetAttributeCount added in v1.0.0

FPDF_StructElement_GetAttributeCount returns the number of attributes for the structure element. Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_GetChildAtIndex added in v0.9.0

FPDF_StructElement_GetChildAtIndex returns a child in the structure element. If the child exists but is not an element, then this function will return an error. This will also return an error for out of bounds indices.

func (*PdfiumImplementation) FPDF_StructElement_GetID added in v0.9.0

FPDF_StructElement_GetID returns the ID for a given element. Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_GetLang added in v0.9.0

FPDF_StructElement_GetLang returns the case-insensitive IETF BCP 47 language code for an element. Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_GetMarkedContentID added in v0.9.0

FPDF_StructElement_GetMarkedContentID returns the marked content ID for a given element.

func (*PdfiumImplementation) FPDF_StructElement_GetMarkedContentIdAtIndex added in v1.0.0

FPDF_StructElement_GetMarkedContentIdAtIndex returns the marked content id at a given index for a given element. Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_GetMarkedContentIdCount added in v1.0.0

FPDF_StructElement_GetMarkedContentIdCount returns the count of marked content ids for a given element. Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_GetObjType added in v1.0.0

FPDF_StructElement_GetObjType returns the object type (/Type) for a given element. Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_GetParent added in v1.0.0

FPDF_StructElement_GetParent returns the parent of the structure element. If structure element is StructTreeRoot, then this function will return an error. Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_GetStringAttribute added in v0.9.0

FPDF_StructElement_GetStringAttribute returns a struct element attribute of type "name" or "string" Experimental API.

func (*PdfiumImplementation) FPDF_StructElement_GetTitle added in v0.9.0

FPDF_StructElement_GetTitle returns the title (/T) for a given element.

func (*PdfiumImplementation) FPDF_StructElement_GetType added in v0.9.0

FPDF_StructElement_GetType returns the type (/S) for a given element.

func (*PdfiumImplementation) FPDF_StructTree_Close added in v0.9.0

FPDF_StructTree_Close releases a resource allocated by FPDF_StructTree_GetForPage().

func (*PdfiumImplementation) FPDF_StructTree_CountChildren added in v0.9.0

FPDF_StructTree_CountChildren counts the number of children for the structure tree.

func (*PdfiumImplementation) FPDF_StructTree_GetChildAtIndex added in v0.9.0

FPDF_StructTree_GetChildAtIndex returns a child in the structure tree.

func (*PdfiumImplementation) FPDF_StructTree_GetForPage added in v0.9.0

FPDF_StructTree_GetForPage returns the structure tree for a page.

func (*PdfiumImplementation) FPDF_VIEWERREF_GetDuplex added in v0.7.0

FPDF_VIEWERREF_GetDuplex returns the paper handling option to be used when printing from the print dialog.

func (*PdfiumImplementation) FPDF_VIEWERREF_GetName added in v0.7.0

FPDF_VIEWERREF_GetName returns the contents for a viewer ref, with a given key. The value must be of type "name".

func (*PdfiumImplementation) FPDF_VIEWERREF_GetNumCopies added in v0.7.0

FPDF_VIEWERREF_GetNumCopies returns the number of copies to be printed.

func (*PdfiumImplementation) FPDF_VIEWERREF_GetPrintPageRange added in v0.7.0

FPDF_VIEWERREF_GetPrintPageRange returns the page numbers to initialize print dialog box when file is printed.

func (*PdfiumImplementation) FPDF_VIEWERREF_GetPrintPageRangeCount added in v0.7.0

FPDF_VIEWERREF_GetPrintPageRangeCount returns the number of elements in a FPDF_PAGERANGE. Experimental API.

func (*PdfiumImplementation) FPDF_VIEWERREF_GetPrintPageRangeElement added in v0.7.0

FPDF_VIEWERREF_GetPrintPageRangeElement returns an element from a FPDF_PAGERANGE. Experimental API.

func (*PdfiumImplementation) FPDF_VIEWERREF_GetPrintScaling added in v0.7.0

FPDF_VIEWERREF_GetPrintScaling returns whether the PDF document prefers to be scaled or not.

func (*PdfiumImplementation) FSDK_SetLocaltimeFunction added in v0.5.0

FSDK_SetLocaltimeFunction sets a replacement function for calls to localtime(). This API is intended to be used only for testing, thus may cause PDFium to behave poorly in production environments. Since callbacks can't be transferred between processes in gRPC, you can only use this in single-threaded mode.

func (*PdfiumImplementation) FSDK_SetTimeFunction added in v0.5.0

FSDK_SetTimeFunction sets a replacement function for calls to time(). This API is intended to be used only for testing, thus may cause PDFium to behave poorly in production environments. Since callbacks can't be transferred between processes in gRPC, you can only use this in single-threaded mode.

func (*PdfiumImplementation) FSDK_SetUnSpObjProcessHandler added in v0.5.0

FSDK_SetUnSpObjProcessHandler set ups an unsupported object handler. Since callbacks can't be transferred between processes in gRPC, you can only use this in single-threaded mode.

func (*PdfiumImplementation) GetActionInfo added in v0.5.0

func (*PdfiumImplementation) GetAttachments added in v0.5.0

GetAttachments returns all the attachments of a document. Experimental API.

func (*PdfiumImplementation) GetBookmarks added in v0.5.0

func (p *PdfiumImplementation) GetBookmarks(request *requests.GetBookmarks) (*responses.GetBookmarks, error)

GetBookmarks returns all the bookmarks of a document.

func (*PdfiumImplementation) GetDestInfo added in v0.5.0

func (p *PdfiumImplementation) GetDestInfo(request *requests.GetDestInfo) (*responses.GetDestInfo, error)

func (*PdfiumImplementation) GetJavaScriptActions added in v0.5.0

GetJavaScriptActions returns all the JavaScript Actions of a document. Experimental API.

func (*PdfiumImplementation) GetMetaData added in v0.5.0

func (p *PdfiumImplementation) GetMetaData(request *requests.GetMetaData) (*responses.GetMetaData, error)

GetMetaData returns the metadata values of the document.

func (*PdfiumImplementation) GetPageSize added in v0.5.0

func (p *PdfiumImplementation) GetPageSize(request *requests.GetPageSize) (*responses.GetPageSize, error)

GetPageSize returns the page size in points One point is 1/72 inch (around 0.3528 mm)

func (*PdfiumImplementation) GetPageSizeInPixels added in v0.5.0

GetPageSizeInPixels returns the pixel size of a page given the page number and the DPI.

func (*PdfiumImplementation) GetPageText added in v0.5.0

func (p *PdfiumImplementation) GetPageText(request *requests.GetPageText) (*responses.GetPageText, error)

GetPageText returns the text of a page

func (*PdfiumImplementation) GetPageTextStructured added in v0.5.0

GetPageTextStructured returns the text of a page in a structured way

func (*PdfiumImplementation) Lock added in v0.5.0

func (p *PdfiumImplementation) Lock()

func (*PdfiumImplementation) OpenDocument added in v0.5.0

func (p *PdfiumImplementation) OpenDocument(request *requests.OpenDocument) (*responses.OpenDocument, error)

func (*PdfiumImplementation) Ping added in v0.5.0

func (p *PdfiumImplementation) Ping() (string, error)

func (*PdfiumImplementation) RenderPageInDPI added in v0.5.0

RenderPageInDPI renders a specific page in a specific dpi, the result is an image.

func (*PdfiumImplementation) RenderPageInPixels added in v0.5.0

RenderPageInPixels renders a specific page in a specific pixel size, the result is an image. The given resolution is a maximum, we automatically calculate either the width or the height to make sure it stays withing the maximum resolution.

func (*PdfiumImplementation) RenderPagesInDPI added in v0.5.0

RenderPagesInDPI renders a list of pages in a specific dpi, the result is an image.

func (*PdfiumImplementation) RenderPagesInPixels added in v0.5.0

RenderPagesInPixels renders a list of pages in a specific pixel size, the result is an image. The given resolution is a maximum, we automatically calculate either the width or the height to make sure it stays withing the maximum resolution.

func (*PdfiumImplementation) RenderToFile added in v0.5.0

func (p *PdfiumImplementation) RenderToFile(request *requests.RenderToFile) (*responses.RenderToFile, error)

func (*PdfiumImplementation) Unlock added in v0.5.0

func (p *PdfiumImplementation) Unlock()

type SchHandleHandle added in v0.5.0

type SchHandleHandle struct {
	// contains filtered or unexported fields
}

type SearchHandle added in v0.5.0

type SearchHandle struct {
	// contains filtered or unexported fields
}

type SignatureHandle added in v0.5.0

type SignatureHandle struct {
	// contains filtered or unexported fields
}

type StructElementAttributeHandle added in v1.0.0

type StructElementAttributeHandle struct {
	// contains filtered or unexported fields
}

type StructElementHandle added in v0.9.0

type StructElementHandle struct {
	// contains filtered or unexported fields
}

type StructTreeHandle added in v0.9.0

type StructTreeHandle struct {
	// contains filtered or unexported fields
}

type TextPageHandle added in v0.5.0

type TextPageHandle struct {
	// contains filtered or unexported fields
}

type XObjectHandle added in v0.5.0

type XObjectHandle struct {
	// contains filtered or unexported fields
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL