implementation

package
v0.5.0 Latest Latest
Warning

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

 Go to latest Published: Feb 5, 2022 License: MIT Imports: 25 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{},
}

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()

InitLibrary loads the actual C++ library.

func StartPlugin 

func StartPlugin()

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 ClipPathHandle added in v0.5.0 

type ClipPathHandle 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 FormHandleHandle added in v0.5.0 

type FormHandleHandle 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 PageRangeHandle added in v0.5.0 

type PageRangeHandle struct {
	// 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) FPDFAction_GetDest added in v0.5.0 

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

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 

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

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 

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

FPDFAction_GetType returns the action associated with a bookmark item.

func (*PdfiumImplementation) FPDFAction_GetURIPath added in v0.5.0 

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

FPDFAction_GetURIPath returns the URI path from a URI action.

func (*PdfiumImplementation) FPDFAttachment_GetFile added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFAttachment_GetName added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFAttachment_GetStringValue added in v0.5.0 

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

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 

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

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 

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

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 

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

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 

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

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) FPDFBookmark_Find added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFBookmark_GetAction added in v0.5.0 

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

FPDFBookmark_GetAction returns the action associated with a bookmark item. If the returned action is nil, you should try FPDFBookmark_GetDest.

func (*PdfiumImplementation) FPDFBookmark_GetDest added in v0.5.0 

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

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 

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

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 

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

FPDFBookmark_GetNextSibling returns the next bookmark item at the same level.

func (*PdfiumImplementation) FPDFBookmark_GetTitle added in v0.5.0 

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

FPDFBookmark_GetTitle returns the title of a bookmark.

func (*PdfiumImplementation) FPDFCatalog_IsTagged added in v0.5.0 

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

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).

func (*PdfiumImplementation) FPDFDest_GetDestPageIndex added in v0.5.0 

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

FPDFDest_GetDestPageIndex returns the page index from destination data.

func (*PdfiumImplementation) FPDFDest_GetLocationInPage added in v0.5.0 

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

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 

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

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

func (*PdfiumImplementation) FPDFDoc_AddAttachment added in v0.5.0 

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

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 

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

FPDFDoc_CloseJavaScriptAction closes a loaded FPDF_JAVASCRIPT_ACTION object. Experimental API.

func (*PdfiumImplementation) FPDFDoc_DeleteAttachment added in v0.5.0 

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

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 

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

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 

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

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

func (*PdfiumImplementation) FPDFDoc_GetJavaScriptAction added in v0.5.0 

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

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 

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

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

func (*PdfiumImplementation) FPDFDoc_GetPageMode added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFJavaScriptAction_GetName added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFJavaScriptAction_GetScript added in v0.5.0 

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

FPDFJavaScriptAction_GetScript returns the script from the javascript handle Experimental API. 

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

FPDFLink_CloseWebLinks releases resources used by weblink feature. 

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

FPDFLink_CountQuadPoints returns the count of quadrilateral points to the link. 

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

FPDFLink_CountRects returns the count of rectangular areas for the link. 

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

FPDFLink_CountWebLinks returns the count of detected web links. 

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

FPDFLink_Enumerate Enumerates all the link annotations in a page. 

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

FPDFLink_GetAction returns the action info for a link 

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

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

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

FPDFLink_GetAnnotRect returns the count of quadrilateral points to the link. 

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

FPDFLink_GetDest returns the destination info for a link. 

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

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

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

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(). 

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

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

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

FPDFLink_GetRect returns the boundaries of a rectangle for a link. 

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

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

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

FPDFLink_GetURL returns the URL information for a detected web link. 

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

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) FPDFPage_Flatten added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFPage_GetDecodedThumbnailData added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFPage_GetRawThumbnailData added in v0.5.0 

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

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 

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

FPDFPage_GetRotation returns the page rotation.

func (*PdfiumImplementation) FPDFPage_GetThumbnailAsBitmap added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFPage_HasTransparency added in v0.5.0 

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

FPDFPage_HasTransparency returns whether the page has transparency.

func (*PdfiumImplementation) FPDFPage_SetRotation added in v0.5.0 

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

FPDFPage_SetRotation sets the page rotation for a given page.

func (*PdfiumImplementation) FPDFSignatureObj_GetByteRange added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFSignatureObj_GetContents added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFSignatureObj_GetDocMDPPermission added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFSignatureObj_GetReason added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFSignatureObj_GetSubFilter added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFSignatureObj_GetTime added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFText_ClosePage added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFText_CountChars added in v0.5.0 

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

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 

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

FPDFText_CountRects returns the count of rectangular areas occupied by a segment of texts. 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. FPDFTEXT 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 

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

FPDFText_FindClose releases a search context.

func (*PdfiumImplementation) FPDFText_FindNext added in v0.5.0 

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

FPDFText_FindNext searches in the direction from page start to end.

func (*PdfiumImplementation) FPDFText_FindPrev added in v0.5.0 

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

FPDFText_FindPrev searches in the direction from page end to start.

func (*PdfiumImplementation) FPDFText_FindStart added in v0.5.0 

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

FPDFText_FindStart returns a handle to search a page.

func (*PdfiumImplementation) FPDFText_GetBoundedText added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFText_GetCharAngle added in v0.5.0 

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

FPDFText_GetCharAngle returns the character rotation angle. Experimental API.

func (*PdfiumImplementation) FPDFText_GetCharBox added in v0.5.0 

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

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 

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

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

func (*PdfiumImplementation) FPDFText_GetCharOrigin added in v0.5.0 

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

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 

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

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

func (*PdfiumImplementation) FPDFText_GetFontInfo added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFText_GetFontSize added in v0.5.0 

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

FPDFText_GetFontSize returns the font size of a particular character.

func (*PdfiumImplementation) FPDFText_GetFontWeight added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFText_GetLooseCharBox added in v0.5.0 

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

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 

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

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 

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

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 

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

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

func (*PdfiumImplementation) FPDFText_GetSchResultIndex added in v0.5.0 

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

FPDFText_GetSchResultIndex returns the starting character index of the search result.

func (*PdfiumImplementation) FPDFText_GetStrokeColor added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFText_GetText added in v0.5.0 

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

FPDFText_GetText extracts unicode text string from the page.

func (*PdfiumImplementation) FPDFText_GetTextRenderMode added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDFText_GetUnicode added in v0.5.0 

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

FPDFText_GetUnicode returns the unicode of a character in a page.

func (*PdfiumImplementation) FPDFText_LoadPage added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDF_CloseDocument added in v0.5.0 

func (p *PdfiumImplementation) FPDF_CloseDocument(document references.FPDF_DOCUMENT) error

func (*PdfiumImplementation) FPDF_ClosePage added in v0.5.0 

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

FPDF_ClosePage unloads a page by reference.

func (*PdfiumImplementation) FPDF_CloseXObject added in v0.5.0 

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

FPDF_CloseXObject closes an FPDF_XOBJECT handle created by FPDF_NewXObjectFromPage().

func (*PdfiumImplementation) FPDF_CopyViewerPreferences added in v0.5.0 

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

FPDF_CopyViewerPreferences copies the viewer preferences from one PDF document to another

func (*PdfiumImplementation) FPDF_CreateNewDocument added in v0.5.0 

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

FPDF_CreateNewDocument returns a new document.

func (*PdfiumImplementation) FPDF_GetDocPermissions added in v0.5.0 

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

FPDF_GetDocPermissions returns the permissions of the PDF.

func (*PdfiumImplementation) FPDF_GetFileIdentifier added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDF_GetFileVersion added in v0.5.0 

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

FPDF_GetFileVersion returns the version of the PDF file.

func (*PdfiumImplementation) FPDF_GetLastError added in v0.5.0 

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

FPDF_GetLastError returns the last error generated by PDFium.

func (*PdfiumImplementation) FPDF_GetMetaText added in v0.5.0 

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

FPDF_GetMetaText returns the requested metadata.

func (*PdfiumImplementation) FPDF_GetPageAAction added in v0.5.0 

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

FPDF_GetPageAAction returns an additional-action from page. Experimental API

func (*PdfiumImplementation) FPDF_GetPageCount added in v0.5.0 

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

FPDF_GetPageCount counts the amount of pages.

func (*PdfiumImplementation) FPDF_GetPageHeight added in v0.5.0 

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

FPDF_GetPageHeight returns the height of a page.

func (*PdfiumImplementation) FPDF_GetPageLabel added in v0.5.0 

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

FPDF_GetPageLabel returns the label for the given page.

func (*PdfiumImplementation) FPDF_GetPageSizeByIndex added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDF_GetPageWidth added in v0.5.0 

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

FPDF_GetPageWidth returns the width of a page.

func (*PdfiumImplementation) FPDF_GetSecurityHandlerRevision added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDF_GetSignatureCount added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDF_GetSignatureObject added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDF_ImportNPagesToOne added in v0.5.0 

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

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 

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

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

func (*PdfiumImplementation) FPDF_ImportPagesByIndex added in v0.5.0 

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

FPDF_ImportPagesByIndex imports pages to a FPDF_DOCUMENT. Experimental API.

func (*PdfiumImplementation) FPDF_LoadPage added in v0.5.0 

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

FPDF_LoadPage loads a page and returns a reference.

func (*PdfiumImplementation) FPDF_NewFormObjectFromXObject added in v0.5.0 

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

FPDF_NewFormObjectFromXObject creates a new form object from an FPDF_XOBJECT object.

func (*PdfiumImplementation) FPDF_NewXObjectFromPage added in v0.5.0 

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

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_SaveAsCopy added in v0.5.0 

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

FPDF_SaveAsCopy saves the document to a copy.

func (*PdfiumImplementation) FPDF_SaveWithVersion added in v0.5.0 

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

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

func (*PdfiumImplementation) FPDF_SetSandBoxPolicy added in v0.5.0 

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

FPDF_SetSandBoxPolicy set the policy for the sandbox environment.

func (*PdfiumImplementation) FSDK_SetLocaltimeFunction added in v0.5.0 

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

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 

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

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 

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

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 (p *PdfiumImplementation) GetActionInfo(request *requests.GetActionInfo) (*responses.GetActionInfo, error)

func (*PdfiumImplementation) GetAttachments added in v0.5.0 

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

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 

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

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 

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

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 

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

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 

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

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

func (*PdfiumImplementation) RenderPageInPixels added in v0.5.0 

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

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 

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

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

func (*PdfiumImplementation) RenderPagesInPixels added in v0.5.0 

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

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 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
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.