Low-level file interface

Accessing file thourgh list of objects such as ArrayObjectHandle or DictionaryObjectHandle. More...

Modules
	Objects
	Basic object types from which a whole PDF file is composed.
	Cross-reference tables and streams
	The cross-reference table contains information that permits random access to indirect objects within the file so that the entire file need not be read to locate any particular object.
	Name constants
	Often used name constant definitions.

Classes
class	FileHandle
	Represents low-level file access handle. More...
class	FileStructureIssueHandle
	Represents a single structural issue found during validation. More...
class	FileStructureValidationResultHandle
	Container for all issues found during file structure validation. More...
class	FileStructureValidator
	Static utility class for validating PDF file structure. More...
class	FileWriterHandle
	Implements serialization of Files to destination stream. More...
class	FileWriterObserverHandle
	Allows hooking on FileWriterHandle events. More...
class	FilterBaseHandle
	Base class for all compression filters. More...
class	FlateDecodeFilterHandle
	The Flate method is based on the public-domain zlib/deflate compression method. More...
class	DCTDecodeFilterHandle
	The DCTDecode filter decodes grayscale or colour image data that has been encoded in the JPEG baseline format. More...
class	ASCII85DecodeFilterHandle
	The ASCII85Decode filter decodes data that has been encoded in ASCII base-85 encoding and produces binary data. More...
class	ASCIIHexDecodeFilterHandle
	The ASCIIHexDecode filter decodes data that has been encoded in ASCII hexadecimal form. More...
class	LZWDecodeFilterHandle
	LZW (Lempel-Ziv-Welch) is a variable-length, adaptive compression method that has been adopted as one of the standard compression methods in the Tag Image File Format (TIFF) standard. More...
class	JPXDecodeFilterHandle
	The JPXDecode filter (PDF 1.5) decodes data that has been encoded using the JPEG2000 compression method, an ISO standard for the compression and packaging of image data. More...

Enumerations
enum	FileStructureIssueSeverityType { FileStructureIssueSeverity_Undefined = 0 , FileStructureIssueSeverity_Info , FileStructureIssueSeverity_Warning , FileStructureIssueSeverity_Error }
	Severity level of a file structure issue. More...
enum	FileStructureIssueCodeType {   FileStructureIssueCode_Undefined = 0 , FileStructureIssueCode_HeaderMissing = 100 , FileStructureIssueCode_HeaderVersionUndefined = 101 , FileStructureIssueCode_TrailerMissingSize = 200 ,   FileStructureIssueCode_TrailerMissingRoot = 201 , FileStructureIssueCode_TrailerSizeMismatch = 202 , FileStructureIssueCode_TrailerMissing = 203 , FileStructureIssueCode_XrefUsedEntryBadOffset = 300 ,   FileStructureIssueCode_XrefUsedEntryOffsetExceedsFileSize = 301 , FileStructureIssueCode_XrefCompressedEntryMissingObjectStream = 302 , FileStructureIssueCode_XrefFreeEntryInvalidNextFree = 303 , FileStructureIssueCode_TrailerRootReferenceNotInXref = 400 ,   FileStructureIssueCode_TrailerInfoReferenceNotInXref = 401 , FileStructureIssueCode_XrefChainEmpty = 500 }
	Code identifying the specific type of structural issue. More...

Detailed Description

Accessing file thourgh list of objects such as ArrayObjectHandle or DictionaryObjectHandle.

An in-depth knowledge about PDF file format is strongly recommended as many functions are a direct reference to a PDF specification.

You might want to start with FileHandle, which is the low-level counterpart of the DocumentHandle.

It's primary use is for missing or misbehaving functionality in the High-level document interface.

This interface shall provide syntactic correctness for a file. However, the user is responsible for the semantic correctness.

It allows you to create files, that are syntactically correct, but are invalid in terms of PDF document semantics.

Enumeration Type Documentation

FileStructureIssueSeverityType

enum FileStructureIssueSeverityType

Severity level of a file structure issue.

Enumerator
FileStructureIssueSeverity_Undefined	Severity not set (uninitialized)
FileStructureIssueSeverity_Info	Informational observation
FileStructureIssueSeverity_Warning	Non-critical issue
FileStructureIssueSeverity_Error	Critical structural error

FileStructureIssueCodeType

enum FileStructureIssueCodeType

Code identifying the specific type of structural issue.

Enumerator
FileStructureIssueCode_Undefined	Code not set (uninitialized)
FileStructureIssueCode_HeaderMissing	File header is missing
FileStructureIssueCode_HeaderVersionUndefined	Header version is undefined
FileStructureIssueCode_TrailerMissingSize	Trailer missing /Size entry
FileStructureIssueCode_TrailerMissingRoot	Trailer missing /Root entry
FileStructureIssueCode_TrailerSizeMismatch	Trailer /Size does not match xref
FileStructureIssueCode_TrailerMissing	Trailer dictionary is missing entirely
FileStructureIssueCode_XrefUsedEntryBadOffset	Used entry has invalid offset
FileStructureIssueCode_XrefUsedEntryOffsetExceedsFileSize	Used entry offset exceeds file size
FileStructureIssueCode_XrefCompressedEntryMissingObjectStream	Compressed entry references missing object stream
FileStructureIssueCode_XrefFreeEntryInvalidNextFree	Free entry references invalid next free object
FileStructureIssueCode_TrailerRootReferenceNotInXref	/Root target not in xref
FileStructureIssueCode_TrailerInfoReferenceNotInXref	/Info target not in xref
FileStructureIssueCode_XrefChainEmpty	Xref chain has no sections