pdf-core/io.github.limuyang2.pdf.core

Package-level declarations

Types

A rendered page image owned by the caller.

data class PdfBookmark(val title: String, val destination: PdfDestination?, val target: PdfLinkTarget?, val color: PdfColor?, val children: List<PdfBookmark>)

An entry of the document outline (bookmark tree).

PdfCapabilities

data class PdfCapabilities(val text: Boolean, val search: Boolean, val bookmarks: Boolean, val links: Boolean, val thumbnails: Boolean, val progressiveLoading: Boolean, val progressiveRendering: Boolean, val forms: Boolean, val editing: Boolean, val javascriptExecution: Boolean, val xfa: Boolean)

Capabilities of the active PDFium backend and bundled PDFium build.

PdfCharacter

data class PdfCharacter(val characterIndex: Int, val unicodeCodePoint: Int, val bounds: PdfRect?, val origin: PdfPoint?, val fontSize: Double?, val angleRadians: Double?, val isGenerated: Boolean, val isHyphen: Boolean, val hasUnicodeMappingError: Boolean)

Geometry and attributes of a single character within a PdfTextLayout.

PdfClosedException

class PdfClosedException(val resource: String) : PdfException

A document or bitmap was used after being closed.

PdfColor

@JvmInline

value class PdfColor(val argb: UInt)

A non-premultiplied ARGB color encoded as 0xAARRGGBB.

PdfDestination

data class PdfDestination(val pageIndex: Int, val view: PdfDestinationView)

A location inside a document that a link or bookmark points to.

PdfDestinationView

sealed interface PdfDestinationView

The view mode a PdfDestination requests for its page.

PdfDocument

@Stable

class PdfDocument : AutoCloseable

An open PDF document.

PdfDocumentInfo

data class PdfDocumentInfo(val version: PdfVersion?, val permissions: PdfPermissions, val securityRevision: Int?, val hasValidCrossReferenceTable: Boolean, val isLinearized: Boolean?)

Structural information about a document.

PdfException

sealed class PdfException : Exception

Base class of every failure this library throws for expected PDF errors.

PdfIncorrectPasswordException

class PdfIncorrectPasswordException : PdfException

The password supplied to PdfViewer.open did not decrypt the document.

PdfInvalidFormatException

class PdfInvalidFormatException : PdfException

The input is not a valid PDF document.

PdfIoException

class PdfIoException(message: String = "Could not read the PDF document", cause: Throwable? = null) : PdfException

A read failure occurred while loading the document.

PdfLink

data class PdfLink(val bounds: List<PdfQuad>, val target: PdfLinkTarget)

A clickable link annotation on a page.

PdfLinkTarget

sealed interface PdfLinkTarget

What a link annotation activates when clicked.

PdfMetadata

data class PdfMetadata(val title: String?, val author: String?, val subject: String?, val keywords: String?, val creator: String?, val producer: String?, val creationDate: String?, val modificationDate: String?, val additional: Map<String, String> = emptyMap())

Document information dictionary values.

PdfNativeException

class PdfNativeException(val nativeErrorCode: Int, message: String = "PDFium failed with error code ", cause: Throwable? = null) : PdfException

PDFium returned a native error that is not mapped to a more specific exception.

PdfPage

class PdfPage

Lightweight page descriptor. It does not keep a native PDFium page open.

PdfPageException

class PdfPageException(val pageIndex: Int, cause: Throwable? = null) : PdfException

A page-level operation failed.

PdfPageInfo

data class PdfPageInfo(val size: PdfSize, val rotation: PdfRotation, val boundingBox: PdfRect?)

Basic geometry of a single page.

PdfPasswordRequiredException

class PdfPasswordRequiredException : PdfException

The document is encrypted and no password was supplied to PdfViewer.open.

PdfPermissions

data class PdfPermissions(val canPrint: Boolean, val canModify: Boolean, val canCopy: Boolean, val canAnnotate: Boolean, val canFillForms: Boolean, val canExtractForAccessibility: Boolean, val canAssemble: Boolean, val canPrintHighQuality: Boolean)

Operations an encrypted document's security handler allows. Every flag is true for unencrypted documents.

PdfPixelFormat

enum PdfPixelFormat : Enum<PdfPixelFormat>

Pixel layouts a PdfBitmap can use.

PdfPixelSize

data class PdfPixelSize(val width: Int, val height: Int)

A size in device pixels, typically a render target.

PdfPoint

data class PdfPoint(val x: Double, val y: Double)

A point in PDF page space. Values are measured in PDF points.

PdfQuad

data class PdfQuad(val first: PdfPoint, val second: PdfPoint, val third: PdfPoint, val fourth: PdfPoint)

A quadrilateral in PDF page space, as reported by PDFium for link areas and search matches. A rectangle is emitted as four corner points.

PdfRect

data class PdfRect(val left: Double, val bottom: Double, val right: Double, val top: Double)

A rectangle in PDF page space, whose origin is at the bottom-left.

PdfRenderRequest

data class PdfRenderRequest(val outputSize: PdfPixelSize, val sourceRect: PdfRect? = null, val rotation: PdfRotation = PdfRotation.Degrees0, val backgroundColor: PdfColor = PdfColor.White, val renderAnnotations: Boolean = true, val grayscale: Boolean = false, val optimizeTextForLcd: Boolean = false)

Describes how a page is rendered into a bitmap.

PdfRotation

enum PdfRotation : Enum<PdfRotation>

Page rotation in 90-degree steps, applied clockwise.

PdfSearchMatch