mupdf
index
/home/jules/artifex/mupdf/build/shared-release/mupdf.py

# This file was automatically generated by SWIG (http://www.swig.org).
# Version 4.0.2
#
# Do not make changes to this file unless you know what you are doing--modify
# the SWIG interface file instead.

 
Modules
       
builtins
_mupdf
re

 
Classes
       
builtins.object
AaContext
Aes
AllocContext
Arc4
Archive
BandWriter
Bitmap
Buffer
ColorParams
Colorspace
ColorspaceContext
CompressedBuffer
CompressedImage
CompressionParams
Context
Cookie
DefaultColorspaces
Device
DeviceContainerStack
DisplayList
Document
DocumentHandler
DocumentHandlerContext
DocumentWriter
DrawOptions
ErrorContext
ErrorStackSlot
Font
FontContext
FontFlagsT
Glyph
GlyphCache
Halftone
HashTable
IccProfile
Image
Irect
IteratorWrap
Jbig2Globals
KeyStorable
LayoutBlock
LayoutChar
LayoutLine
Link
LinkIterator
Location
LocksContext
Matrix
Md5
Outline
OutlineIterator
Output
Overprint
Page
Path
PathWalker
PclOptions
PclmOptions
PdfAlertEvent
PdfAnnot
PdfCmap
PdfCrypt
PdfCsi
PdfDocEvent
PdfDocument
PdfFilterOptions
PdfFontDesc
PdfFunction
PdfGraftMap
PdfGstate
PdfHintPage
PdfHintShared
PdfHmtx
PdfJs
PdfKeystrokeEvent
PdfLaunchUrlEvent
PdfLayerConfig
PdfLayerConfigUi
PdfLexbuf
PdfLexbufLarge
PdfLockedFields
PdfMailDocEvent
PdfMrange
PdfObj
PdfOcgDescriptor
PdfPage
PdfPattern
PdfPkcs7DesignatedName
PdfPkcs7Signer
PdfPkcs7Verifier
PdfProcessor
PdfRange
PdfRedactOptions
PdfRevPageMap
PdfTextObjectState
PdfTextState
PdfUnsavedSig
PdfVmtx
PdfWriteOptions
PdfXfa
PdfXfaEntry
PdfXrange
PdfXref
PdfXrefEntry
PdfXrefSubsec
Pixmap
PixmapImage
Point
Pool
PwgOptions
Quad
Range
Rect
Separations
Sha256
Sha512
Shade
ShaperDataT
StextBlock
StextBlockIterator
StextChar
StextLine
StextLineIterator
StextOptions
StextPage
StextPageIterator
Storable
Store
StoreHash
StoreType
Stream
StrokeState
StyleContext
SwigPyIterator
Text
TextItem
TextSpan
Transition
Tree
TuningContext
Vertex
WarnContext
Xml
XmlDoc
ZipWriter
fz_aa_context
fz_aes
fz_alloc_context
fz_arc4
fz_archive
fz_band_writer
fz_bitmap
fz_buffer
fz_color_params
fz_colorspace
fz_compressed_buffer
fz_compression_params
fz_context
fz_cookie
fz_default_colorspaces
fz_device
fz_device_container_stack
fz_document
fz_document_handler
fz_document_writer
fz_draw_options
fz_error_context
fz_font
fz_font_flags_t
fz_image
fz_irect
fz_key_storable
fz_layout_block
fz_layout_char
fz_layout_line
fz_link
fz_location
fz_locks_context
fz_matrix
fz_md5
fz_outline
fz_output
fz_page
fz_path_walker
fz_pcl_options
fz_pclm_options
fz_pixmap
fz_point
fz_pwg_options
fz_quad
fz_range
fz_rect
fz_sha256
fz_sha512
fz_shade
fz_shaper_data_t
fz_stext_block
fz_stext_char
fz_stext_line
fz_stext_options
fz_stext_page
fz_storable
fz_store_hash
fz_store_type
fz_stream
fz_stroke_state
fz_text
fz_text_item
fz_text_span
fz_transition
fz_vertex
fz_warn_context
pdf_alert_event
pdf_annot
pdf_cmap
pdf_csi
pdf_doc_event
pdf_document
pdf_filter_options
pdf_font_desc
pdf_hint_page
pdf_hint_shared
pdf_hmtx
pdf_keystroke_event
pdf_launch_url_event
pdf_layer_config
pdf_layer_config_ui
pdf_lexbuf
pdf_lexbuf_large
pdf_mail_doc_event
pdf_mrange
pdf_page
pdf_pattern
pdf_pkcs7_designated_name
pdf_pkcs7_signer
pdf_pkcs7_verifier
pdf_processor
pdf_range
pdf_redact_options
pdf_rev_page_map
pdf_text_object_state
pdf_text_state
pdf_unsaved_sig
pdf_vmtx
pdf_write_options
pdf_xfa
pdf_xfa_entry
pdf_xrange
pdf_xref
pdf_xref_entry
pdf_xref_subsec
vectori

 
class AaContext(builtins.object)
    AaContext(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
internal(self, *args)

Static methods defined here:
__swig_destroy__ = delete_AaContext(...)
delete_AaContext(AaContext self)
 
Parameters
----------
self: mupdf::AaContext *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
bits
AaContext_bits_get(AaContext self) -> int
 
Parameters
----------
self: mupdf::AaContext *
hscale
AaContext_hscale_get(AaContext self) -> int
 
Parameters
----------
self: mupdf::AaContext *
min_line_width
AaContext_min_line_width_get(AaContext self) -> float
 
Parameters
----------
self: mupdf::AaContext *
scale
AaContext_scale_get(AaContext self) -> int
 
Parameters
----------
self: mupdf::AaContext *
text_bits
AaContext_text_bits_get(AaContext self) -> int
 
Parameters
----------
self: mupdf::AaContext *
thisown
The membership flag
vscale
AaContext_vscale_get(AaContext self) -> int
 
Parameters
----------
self: mupdf::AaContext *

 
class Aes(builtins.object)
    Aes(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
aes_crypt_cbc(self, mode, length, iv, input, output)
AES block processing. Encrypts or Decrypts (according to mode,
which must match what was initially set up) length bytes (which
must be a multiple of 16), using (and modifying) the insertion
vector iv, reading from input, and writing to output.
 
Never throws an exception.
aes_setkey_dec(self, key, keysize)
AES decryption intialisation. Fills in the supplied context
and prepares for decryption using the given key.
 
Returns non-zero for error (key size other than 128/192/256).
 
Never throws an exception.
aes_setkey_enc(self, key, keysize)
AES encryption intialisation. Fills in the supplied context
and prepares for encryption using the given key.
 
Returns non-zero for error (key size other than 128/192/256).
 
Never throws an exception.

Static methods defined here:
__swig_destroy__ = delete_Aes(...)
delete_Aes(Aes self)
 
Parameters
----------
self: mupdf::Aes *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Aes_m_internal_get(Aes self) -> fz_aes
 
Parameters
----------
self: mupdf::Aes *
thisown
The membership flag

 
class AllocContext(builtins.object)
    AllocContext(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
new_context_imp(self, locks, max_store, version)

Static methods defined here:
__swig_destroy__ = delete_AllocContext(...)
delete_AllocContext(AllocContext self)
 
Parameters
----------
self: mupdf::AllocContext *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
AllocContext_m_internal_get(AllocContext self) -> fz_alloc_context
 
Parameters
----------
self: mupdf::AllocContext *
thisown
The membership flag

 
class Arc4(builtins.object)
    Arc4(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
arc4_encrypt(self, dest, src, len)
RC4 block encrypt operation; encrypt src into dst (both of
length len) updating the RC4 state as we go.
 
Never throws an exception.
arc4_init(self, key, len)
RC4 initialization. Begins an RC4 operation, writing a new
context.
 
Never throws an exception.

Static methods defined here:
__swig_destroy__ = delete_Arc4(...)
delete_Arc4(Arc4 self)
 
Parameters
----------
self: mupdf::Arc4 *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Arc4_m_internal_get(Arc4 self) -> fz_arc4
 
Parameters
----------
self: mupdf::Arc4 *
thisown
The membership flag

 
class Archive(builtins.object)
    Archive(*args)
 
fz_archive:
 
fz_archive provides methods for accessing "archive" files.
An archive file is a conceptual entity that contains multiple
files, which can be counted, enumerated, and read.
 
Implementations of fz_archive based upon directories, zip
and tar files are included.
 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
archive_format(self)
Return a pointer to a string describing the format of the
archive.
 
The lifetime of the string is unspecified (in current
implementations the string will persist until the archive
is closed, but this is not guaranteed).
count_archive_entries(self)
Number of entries in archive.
 
Will always return a value >= 0.
 
May throw an exception if this type of archive cannot count the
entries (such as a directory).
has_archive_entry(self, name)
Check if entry by given name exists.
 
If named entry does not exist 0 will be returned, if it does
exist 1 is returned.
 
name: Entry name to look for, this must be an exact match to
the entry name in the archive.
list_archive_entry(self, idx)
Get listed name of entry position idx.
 
idx: Must be a value >= 0 < return value from
fz_count_archive_entries. If not in range NULL will be
returned.
 
May throw an exception if this type of archive cannot list the
entries (such as a directory).
open_archive_entry(self, name)
Opens an archive entry as a stream.
 
name: Entry name to look for, this must be an exact match to
the entry name in the archive.
read_archive_entry(self, name)
Reads all bytes in an archive entry
into a buffer.
 
name: Entry name to look for, this must be an exact match to
the entry name in the archive.

Static methods defined here:
__swig_destroy__ = delete_Archive(...)
delete_Archive(Archive self)
 
Parameters
----------
self: mupdf::Archive *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Archive_m_internal_get(Archive self) -> fz_archive *
 
Parameters
----------
self: mupdf::Archive *
thisown
The membership flag

 
class BandWriter(builtins.object)
    BandWriter(*args)
 
fz_band_writer
 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
write_band(self, stride, band_height, samples)
Cause a band writer to write the next band
of data for an image.
 
stride: The byte offset from the first byte of the data
for a pixel to the first byte of the data for the same pixel
on the row below.
 
band_height: The number of lines in this band.
 
samples: Pointer to first byte of the data.
write_header(self, w, h, n, alpha, xres, yres, pagenum, cs, seps)
Cause a band writer to write the header for
a banded image with the given properties/dimensions etc. This
also configures the bandwriter for the format of the data to be
passed in future calls.
 
w, h: Width and Height of the entire page.
 
n: Number of components (including spots and alphas).
 
alpha: Number of alpha components.
 
xres, yres: X and Y resolutions in dpi.
 
cs: Colorspace (NULL for bitmaps)
 
seps: Separation details (or NULL).

Static methods defined here:
__swig_destroy__ = delete_BandWriter(...)
delete_BandWriter(BandWriter self)
 
Parameters
----------
self: mupdf::BandWriter *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
BandWriter_m_internal_get(BandWriter self) -> fz_band_writer *
 
Parameters
----------
self: mupdf::BandWriter *
thisown
The membership flag

Data and other attributes defined here:
COLOR = 1
MONO = 0
PAM = 2
PBM = 3
PKM = 4
PNG = 0
PNM = 1
PS = 5
PSD = 6

 
class Bitmap(builtins.object)
    Bitmap(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
bitmap_details(self)
Retrieve details of a given bitmap.
 
bitmap: The bitmap to query.
 
w: Pointer to storage to retrieve width (or NULL).
 
h: Pointer to storage to retrieve height (or NULL).
 
n: Pointer to storage to retrieve number of color components (or
NULL).
 
stride: Pointer to storage to retrieve bitmap stride (or NULL).
clear_bitmap(self)
Set the entire bitmap to 0.
 
Never throws exceptions.
save_bitmap_as_pbm(self, filename)
Save a bitmap as a pbm.
save_bitmap_as_pcl(self, filename, append, pcl)
Save a bitmap as mono PCL.
save_bitmap_as_pkm(self, filename)
Save a CMYK bitmap as a pkm.
save_bitmap_as_pwg(self, filename, append, pwg)
Save a bitmap as a PWG.

Static methods defined here:
__swig_destroy__ = delete_Bitmap(...)
delete_Bitmap(Bitmap self)
 
Parameters
----------
self: mupdf::Bitmap *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Bitmap_m_internal_get(Bitmap self) -> fz_bitmap
 
Parameters
----------
self: mupdf::Bitmap *
thisown
The membership flag

 
class Buffer(builtins.object)
    Buffer(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
append_bits(self, value, count)
append_bits_pad(self)
append_buffer(self, source)
Append the contents of the source buffer onto the end of the
destination buffer, extending automatically as required.
 
Ownership of buffers does not change.
append_byte(self, c)
append_data(self, data, len)
fz_append_*: Append data to a buffer.
 
The buffer will automatically grow as required.
append_int16_be(self, x)
append_int16_le(self, x)
append_int32_be(self, x)
append_int32_le(self, x)
append_pdf_string(self, text)
fz_append_pdf_string: Append a string with PDF syntax quotes and
escapes.
 
The buffer will automatically grow as required.
append_rune(self, c)
append_string(self, data)
buffer_extract(self, OUTPUT)
Take ownership of buffer contents.
 
Performs the same task as fz_buffer_storage, but ownership of
the data buffer returns with this call. The buffer is left
empty.
 
Note: Bad things may happen if this is called on a buffer with
multiple references that is being used from multiple threads.
 
data: Pointer to place to retrieve data pointer.
 
Returns length of stream.
buffer_storage(self, OUTPUT)
Retrieve internal memory of buffer.
 
datap: Output parameter that will be pointed to the data.
 
Returns the current size of the data in bytes.
clear_buffer(self)
Empties the buffer. Storage is not freed, but is held ready
to be reused as the buffer is refilled.
 
Never throws exceptions.
grow_buffer(self)
Make some space within a buffer (i.e. ensure that
capacity > size).
load_jbig2_globals(self)
Create a jbig2 globals record from a buffer.
 
Immutable once created.
md5_buffer(self, digest)
Create an MD5 digest from buffer contents.
 
Never throws exceptions.
new_display_list_from_svg(self, base_uri, zip)
Parse an SVG document into a display-list.
new_image_from_buffer(self)
Create a new image from a
buffer of data, inferring its type from the format
of the data.
new_image_from_svg(self, base_uri, zip)
Create a scalable image from an SVG document.
open_buffer(self)
Open a buffer as a stream.
 
buf: The buffer to open. Ownership of the buffer is NOT passed
in (this function takes its own reference).
 
Returns pointer to newly created stream. May throw exceptions on
failure to allocate.
parse_xml(self, preserve_white, for_html)
Parse the contents of buffer into a tree of xml nodes.
 
preserve_white: whether to keep or delete all-whitespace nodes.
 
for_html: enable special html tweaks (auto closing of tags,
workarounds for less-than-perfect nesting etc).
pdf_append_token(self, tok, lex)
pdf_new_buffer_processor(self, ahxencode)
resize_buffer(self, capacity)
Ensure that a buffer has a given capacity,
truncating data if required.
 
capacity: The desired capacity for the buffer. If the current
size of the buffer contents is smaller than capacity, it is
truncated.
save_buffer(self, filename)
Save the contents of a buffer to a file.
string_from_buffer(self)
Ensure that a buffer's data ends in a
0 byte, and return a pointer to it.
terminate_buffer(self)
Zero-terminate buffer in order to use as a C string.
 
This byte is invisible and does not affect the length of the
buffer as returned by fz_buffer_storage. The zero byte is
written *after* the data, and subsequent writes will overwrite
the terminating byte.
 
Subsequent changes to the size of the buffer (such as by
fz_buffer_trim, fz_buffer_grow, fz_resize_buffer, etc) may
invalidate this.
trim_buffer(self)
Trim wasted capacity from a buffer by resizing internal memory.

Static methods defined here:
__swig_destroy__ = delete_Buffer(...)
delete_Buffer(Buffer self)
 
Parameters
----------
self: mupdf::Buffer *
new_buffer_from_copied_data(data, size)
Create a new buffer containing a copy of the passed data.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Buffer_m_internal_get(Buffer self) -> fz_buffer
 
Parameters
----------
self: mupdf::Buffer *
thisown
The membership flag

 
class ColorParams(builtins.object)
    ColorParams(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
internal(self, *args)

Static methods defined here:
__swig_destroy__ = delete_ColorParams(...)
delete_ColorParams(ColorParams self)
 
Parameters
----------
self: mupdf::ColorParams *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
bp
ColorParams_bp_get(ColorParams self) -> uint8_t
 
Parameters
----------
self: mupdf::ColorParams *
op
ColorParams_op_get(ColorParams self) -> uint8_t
 
Parameters
----------
self: mupdf::ColorParams *
opm
ColorParams_opm_get(ColorParams self) -> uint8_t
 
Parameters
----------
self: mupdf::ColorParams *
ri
ColorParams_ri_get(ColorParams self) -> uint8_t
 
Parameters
----------
self: mupdf::ColorParams *
thisown
The membership flag

 
class Colorspace(builtins.object)
    Colorspace(*args)
 
Describes a given colorspace.
 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
clamp_color(self)
Clamp the samples in a color to the correct ranges for a
given colorspace.
colorspace_colorant(self, n)
Retrieve a the name for a colorant.
 
Returns a pointer with the same lifespan as the colorspace.
colorspace_device_n_has_cmyk(self)
True if DeviceN color space has cyan magenta yellow or black as
one of its colorants.
colorspace_device_n_has_only_cmyk(self)
True if DeviceN color space has only colorants from the CMYK set.
colorspace_is_cmyk(self)
colorspace_is_device(self)
colorspace_is_device_cmyk(self)
colorspace_is_device_gray(self)
colorspace_is_device_n(self)
colorspace_is_gray(self)
Tests for particular types of colorspaces
colorspace_is_indexed(self)
colorspace_is_lab(self)
colorspace_is_lab_icc(self)
colorspace_is_rgb(self)
colorspace_is_subtractive(self)
True for CMYK, Separation and DeviceN colorspaces.
colorspace_n(self)
Query the number of colorants in a colorspace.
colorspace_name(self)
Query the name of a colorspace.
 
The returned string has the same lifespan as the colorspace
does. Caller should not free it.
colorspace_name_colorant(self, n, name)
Assign a name for a given colorant in a colorspace.
 
Used while initially setting up a colorspace. The string is
copied into local storage, so need not be retained by the
caller.
colorspace_type(self)
Query the type of colorspace.
convert_color(self, ds, _is, params)
Convert color values sv from colorspace ss into colorvalues dv
for colorspace ds, via an optional intervening space is,
respecting the given color_params.
convert_separation_colors(self, dst_seps, dst_cs, color_params)
Convert a color given in terms of one colorspace,
to a color in terms of another colorspace/separations.
is_valid_blend_colorspace(self)
Check to see that a colorspace is appropriate to be used as
a blending space (i.e. only grey, rgb or cmyk).
new_indexed_colorspace(self, high, lookup)
Create an indexed colorspace.
 
The supplied lookup table is high palette entries long. Each
entry is n bytes long, where n is given by the number of
colorants in the base colorspace, one byte per colorant.
 
Ownership of lookup is passed it; it will be freed on
destruction, so must be heap allocated.
 
The colorspace will keep an additional reference to the base
colorspace that will be dropped on destruction.
 
The returned reference should be dropped when it is finished
with.
 
Colorspaces are immutable once created.
new_pixmap(self, w, h, seps, alpha)
Create a new pixmap, with its origin at (0,0)
 
cs: The colorspace to use for the pixmap, or NULL for an alpha
plane/mask.
 
w: The width of the pixmap (in pixels)
 
h: The height of the pixmap (in pixels)
 
seps: Details of separations.
 
alpha: 0 for no alpha, 1 for alpha.
 
Returns a pointer to the new pixmap. Throws exception on failure
to allocate.
new_pixmap_with_bbox(self, bbox, seps, alpha)
Create a pixmap of a given size, location and pixel format.
 
The bounding box specifies the size of the created pixmap and
where it will be located. The colorspace determines the number
of components per pixel. Alpha is always present. Pixmaps are
reference counted, so drop references using fz_drop_pixmap.
 
colorspace: Colorspace format used for the created pixmap. The
pixmap will keep a reference to the colorspace.
 
bbox: Bounding box specifying location/size of created pixmap.
 
seps: Details of separations.
 
alpha: 0 for no alpha, 1 for alpha.
 
Returns a pointer to the new pixmap. Throws exception on failure
to allocate.
new_pixmap_with_bbox_and_data(self, rect, seps, alpha, samples)
Create a pixmap of a given size, location and pixel format,
using the supplied data block.
 
The bounding box specifies the size of the created pixmap and
where it will be located. The colorspace determines the number
of components per pixel. Alpha is always present. Pixmaps are
reference counted, so drop references using fz_drop_pixmap.
 
colorspace: Colorspace format used for the created pixmap. The
pixmap will keep a reference to the colorspace.
 
rect: Bounding box specifying location/size of created pixmap.
 
seps: Details of separations.
 
alpha: Number of alpha planes (0 or 1).
 
samples: The data block to keep the samples in.
 
Returns a pointer to the new pixmap. Throws exception on failure
to allocate.
new_pixmap_with_data(self, w, h, seps, alpha, stride, samples)
Create a new pixmap, with its origin at
(0,0) using the supplied data block.
 
cs: The colorspace to use for the pixmap, or NULL for an alpha
plane/mask.
 
w: The width of the pixmap (in pixels)
 
h: The height of the pixmap (in pixels)
 
seps: Details of separations.
 
alpha: 0 for no alpha, 1 for alpha.
 
stride: The byte offset from the pixel data in a row to the
pixel data in the next row.
 
samples: The data block to keep the samples in.
 
Returns a pointer to the new pixmap. Throws exception on failure to
allocate.
pdf_is_tint_colorspace(self)

Static methods defined here:
__swig_destroy__ = delete_Colorspace(...)
delete_Colorspace(Colorspace self)
 
Parameters
----------
self: mupdf::Colorspace *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Colorspace_m_internal_get(Colorspace self) -> fz_colorspace *
 
Parameters
----------
self: mupdf::Colorspace *
thisown
The membership flag

Data and other attributes defined here:
Fixed_BGR = 2
Fixed_CMYK = 3
Fixed_GRAY = 0
Fixed_LAB = 4
Fixed_RGB = 1

 
class ColorspaceContext(builtins.object)
    ColorspaceContext(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_ColorspaceContext(...)
delete_ColorspaceContext(ColorspaceContext self)
 
Parameters
----------
self: mupdf::ColorspaceContext *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
ColorspaceContext_m_internal_get(ColorspaceContext self) -> fz_colorspace_context *
 
Parameters
----------
self: mupdf::ColorspaceContext *
thisown
The membership flag

 
class CompressedBuffer(builtins.object)
    CompressedBuffer(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
compressed_buffer_size(self)
Return the storage size used for a buffer and its data.
Used in implementing store handling.
 
Never throws exceptions.
open_compressed_buffer(self)
Open a stream to read the decompressed version of a buffer.
open_image_decomp_stream_from_buffer(self)
Open a stream to read the decompressed version of a buffer,
with optional log2 subsampling.
 
l2factor = NULL for no subsampling, or a pointer to an integer
containing the maximum log2 subsample factor acceptable (0 =
none, 1 = halve dimensions, 2 = quarter dimensions etc). If
non-NULL, then *l2factor will be updated on exit with the actual
log2 subsample factor achieved.

Static methods defined here:
__swig_destroy__ = delete_CompressedBuffer(...)
delete_CompressedBuffer(CompressedBuffer self)
 
Parameters
----------
self: mupdf::CompressedBuffer *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
CompressedBuffer_m_internal_get(CompressedBuffer self) -> fz_compressed_buffer
 
Parameters
----------
self: mupdf::CompressedBuffer *
thisown
The membership flag

 
class CompressedImage(builtins.object)
    CompressedImage(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
set_compressed_image_buffer(self, buf)

Static methods defined here:
__swig_destroy__ = delete_CompressedImage(...)
delete_CompressedImage(CompressedImage self)
 
Parameters
----------
self: mupdf::CompressedImage *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
CompressedImage_m_internal_get(CompressedImage self) -> fz_compressed_image *
 
Parameters
----------
self: mupdf::CompressedImage *
thisown
The membership flag

 
class CompressionParams(builtins.object)
    CompressionParams(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_CompressionParams(...)
delete_CompressionParams(CompressionParams self)
 
Parameters
----------
self: mupdf::CompressionParams *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
CompressionParams_m_internal_get(CompressionParams self) -> fz_compression_params
 
Parameters
----------
self: mupdf::CompressionParams *
thisown
The membership flag

 
class Context(builtins.object)
    Context(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_Context(...)
delete_Context(Context self)
 
Parameters
----------
self: mupdf::Context *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Context_m_internal_get(Context self) -> fz_context *
 
Parameters
----------
self: mupdf::Context *
thisown
The membership flag

 
class Cookie(builtins.object)
    Cookie(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
abort(self)
errors(self)
get_errors(self)
get_incomplete(self)
get_progress(self)
get_progress_max(self)
incomplete(self)
increment_errors(self)
progress(self)
progress_max(self)
set_abort(self)

Static methods defined here:
__swig_destroy__ = delete_Cookie(...)
delete_Cookie(Cookie self)
 
Parameters
----------
self: mupdf::Cookie *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Cookie_m_internal_get(Cookie self) -> fz_cookie
 
Parameters
----------
self: mupdf::Cookie *
thisown
The membership flag

 
class DefaultColorspaces(builtins.object)
    DefaultColorspaces(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
clone_default_colorspaces(self)
Returns a reference to a newly cloned default colorspaces
structure.
 
The new clone may safely be altered without fear of race
conditions as the caller is the only reference holder.
default_cmyk(self)
default_gray(self)
Retrieve default colorspaces (typically page local).
 
If default_cs is non NULL, the default is retrieved from there,
otherwise the global default is retrieved.
 
These return borrowed references that should not be dropped,
unless they are kept first.
default_output_intent(self)
default_rgb(self)
pdf_update_default_colorspaces(self, res)
set_default_cmyk(self, cs)
set_default_gray(self, cs)
Set new defaults within the default colorspace structure.
 
New references are taken to the new default, and references to
the old defaults dropped.
 
Never throws exceptions.
set_default_output_intent(self, cs)
set_default_rgb(self, cs)

Static methods defined here:
__swig_destroy__ = delete_DefaultColorspaces(...)
delete_DefaultColorspaces(DefaultColorspaces self)
 
Parameters
----------
self: mupdf::DefaultColorspaces *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
DefaultColorspaces_m_internal_get(DefaultColorspaces self) -> fz_default_colorspaces
 
Parameters
----------
self: mupdf::DefaultColorspaces *
thisown
The membership flag

 
class Device(builtins.object)
    Device(*args)
 
The different format handlers (pdf, xps etc) interpret pages to
a device. These devices can then process the stream of calls
they receive in various ways:
    The trace device outputs debugging information for the calls.
    The draw device will render them.
    The list device stores them in a list to play back later.
    The text device performs text extraction and searching.
    The bbox device calculates the bounding box for the page.
Other devices can (and will) be written in the future.
 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
begin_group(self, area, cs, isolated, knockout, blendmode, alpha)
begin_layer(self, layer_name)
begin_mask(self, area, luminosity, colorspace, color_params)
begin_tile(self, area, view, xstep, ystep, ctm)
begin_tile_id(self, area, view, xstep, ystep, ctm, id)
clip_image_mask(self, image, ctm, scissor)
clip_path(self, path, even_odd, ctm, scissor)
clip_stroke_path(self, path, stroke, ctm, scissor)
clip_stroke_text(self, text, stroke, ctm, scissor)
clip_text(self, text, ctm, scissor)
close_device(self)
Signal the end of input, and flush any buffered output.
This is NOT called implicitly on fz_drop_device. This
may throw exceptions.
device_current_scissor(self)
Find current scissor region as tracked by the device.
disable_device_hints(self, hints)
Disable (clear) hint bits within the hint bitfield for a device.
enable_device_hints(self, hints)
Enable (set) hint bits within the hint bitfield for a device.
end_group(self)
end_layer(self)
end_mask(self)
end_tile(self)
fill_image(self, image, ctm, alpha, color_params)
fill_image_mask(self, image, ctm, colorspace, alpha, color_params)
fill_path(self, path, even_odd, ctm, colorspace, alpha, color_params)
Device calls; graphics primitives and containers.
fill_shade(self, shade, ctm, alpha, color_params)
fill_text(self, text, ctm, colorspace, alpha, color_params)
ignore_text(self, text, ctm)
pdf_new_run_processor(self, ctm, usage, gstate, default_cs, cookie)
pop_clip(self)
render_flags(self, set, clear)
render_t3_glyph_direct(self, font, gid, trm, gstate, def_cs)
Nasty PDF interpreter specific hernia, required to allow the
interpreter to replay glyphs from a type3 font directly into
the target device.
 
This is only used in exceptional circumstances (such as type3
glyphs that inherit current graphics state, or nested type3
glyphs).
set_default_colorspaces(self, default_cs)
stroke_path(self, path, stroke, ctm, colorspace, alpha, color_params)
stroke_text(self, text, stroke, ctm, colorspace, alpha, color_params)

Static methods defined here:
__swig_destroy__ = delete_Device(...)
delete_Device(Device self)
 
Parameters
----------
self: mupdf::Device *
new_draw_device_type3(transform, dest)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Device_m_internal_get(Device self) -> fz_device *
 
Parameters
----------
self: mupdf::Device *
thisown
The membership flag

 
class DeviceContainerStack(builtins.object)
    DeviceContainerStack(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_DeviceContainerStack(...)
delete_DeviceContainerStack(DeviceContainerStack self)
 
Parameters
----------
self: mupdf::DeviceContainerStack *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
DeviceContainerStack_m_internal_get(DeviceContainerStack self) -> fz_device_container_stack
 
Parameters
----------
self: mupdf::DeviceContainerStack *
thisown
The membership flag

 
class DisplayList(builtins.object)
    DisplayList(*args)
 
fz_display_list is a list containing drawing commands (text,
images, etc.). The intent is two-fold: as a caching-mechanism
to reduce parsing of a page, and to be used as a data
structure in multi-threading where one thread parses the page
and another renders pages.
 
Create a display list with fz_new_display_list, hand it over to
fz_new_list_device to have it populated, and later replay the
list (once or many times) by calling fz_run_display_list. When
the list is no longer needed drop it with fz_drop_display_list.
 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
bound_display_list(self)
Return the bounding box of the page recorded in a display list.
display_list_is_empty(self)
Check for a display list being empty
 
list: The list to check.
 
Returns true if empty, false otherwise.
new_buffer_from_display_list(self, options)
new_list_device(self)
Create a rendering device for a display list.
 
When the device is rendering a page it will populate the
display list with drawing commands (text, images, etc.). The
display list can later be reused to render a page many times
without having to re-interpret the page from the document file
for each rendering. Once the device is no longer needed, free
it with fz_drop_device.
 
list: A display list that the list device takes ownership of.
new_pixmap_from_display_list(self, ctm, cs, alpha)
Render the page to a pixmap using the transform and colorspace.
 
Ownership of the pixmap is returned to the caller.
new_pixmap_from_display_list_with_separations(self, ctm, cs, seps, alpha)
Render the page contents with control over spot colors.
 
Ownership of the pixmap is returned to the caller.
run_display_list(self, dev, ctm, scissor, cookie)
(Re)-run a display list through a device.
 
list: A display list, created by fz_new_display_list and
populated with objects from a page by running fz_run_page on a
device obtained from fz_new_list_device.
 
ctm: Transform to apply to display list contents. May include
for example scaling and rotation, see fz_scale, fz_rotate and
fz_concat. Set to fz_identity if no transformation is desired.
 
scissor: Only the part of the contents of the display list
visible within this area will be considered when the list is
run through the device. This does not imply for tile objects
contained in the display list.
 
cookie: Communication mechanism between caller and library
running the page. Intended for multi-threaded applications,
while single-threaded applications set cookie to NULL. The
caller may abort an ongoing page run. Cookie also communicates
progress information back to the caller. The fields inside
cookie are continually updated while the page is being run.
search_display_list(self, needle, hit_bbox, hit_max)

Static methods defined here:
__swig_destroy__ = delete_DisplayList(...)
delete_DisplayList(DisplayList self)
 
Parameters
----------
self: mupdf::DisplayList *
new_display_list_from_page_contents(page)
Create a display list from page contents (no annotations).
 
Ownership of the display list is returned to the caller.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
DisplayList_m_internal_get(DisplayList self) -> fz_display_list *
 
Parameters
----------
self: mupdf::DisplayList *
thisown
The membership flag

 
class Document(builtins.object)
    Document(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
authenticate_password(self, password)
Test if the given password can decrypt the document.
 
password: The password string to be checked. Some document
specifications do not specify any particular text encoding, so
neither do we.
 
Returns 0 for failure to authenticate, non-zero for success.
 
For PDF documents, further information can be given by examining
the bits in the return code.
 
        Bit 0 => No password required
        Bit 1 => User password authenticated
        Bit 2 => Owner password authenticated
clamp_location(self, loc)
Clamps a location into valid chapter/page range. (First clamps
the chapter into range, then the page into range).
count_chapter_pages(self, chapter)
Return the number of pages in a chapter.
May return 0.
count_chapters(self)
Return the number of chapters in the document.
At least 1.
count_pages(self)
Return the number of pages in document
 
May return 0 for documents with no pages.
document_output_intent(self)
Find the output intent colorspace if the document has defined
one.
 
Returns a borrowed reference that should not be dropped, unless
it is kept first.
document_supports_accelerator(self)
Query if the document supports the saving of accelerator data.
has_permission(self, p)
Check permission flags on document.
is_document_reflowable(self)
Is the document reflowable.
 
Returns 1 to indicate reflowable documents, otherwise 0.
last_page(self)
Function to get the location for the last page in the document.
Using this can be far more efficient in some cases than calling
fz_count_pages and using the page number.
layout_document(self, w, h, em)
Layout reflowable document types.
 
w, h: Page size in points.
em: Default font size in points.
load_chapter_page(self, chapter, page)
Load a page.
 
After fz_load_page is it possible to retrieve the size of the
page using fz_bound_page, or to render the page using
fz_run_page_*. Free the page by calling fz_drop_page.
 
chapter: chapter number, 0 is the first chapter of the document.
number: page number, 0 is the first page of the chapter.
load_page(self, number)
Load a given page number from a document. This may be much less
efficient than loading by location (chapter+page) for some
document types.
location_from_page_number(self, number)
Converts from page number to chapter+page. This may cause many
chapters to be laid out in order to calculate the number of
pages within those chapters.
lookup_bookmark(self, mark)
Find a bookmark and return its page number.
lookup_metadata(self, key, buf, size)
Retrieve document meta data strings.
 
doc: The document to query.
 
key: Which meta data key to retrieve...
 
Basic information:
        'format'        -- Document format and version.
        'encryption'    -- Description of the encryption used.
 
From the document information dictionary:
        'info:Title'
        'info:Author'
        'info:Subject'
        'info:Keywords'
        'info:Creator'
        'info:Producer'
        'info:CreationDate'
        'info:ModDate'
 
buf: The buffer to hold the results (a nul-terminated UTF-8
string).
 
size: Size of 'buf'.
 
Returns the size of the output string (may be larger than 'size'
if the output was truncated), or -1 if the key is not recognized
or found.
make_bookmark(self, loc)
Create a bookmark for the given page, which can be used to find
the same location after the document has been laid out with
different parameters.
needs_password(self)
Check if a document is encrypted with a
non-blank password.
new_buffer_from_page_number(self, number, options)
new_display_list_from_page_number(self, number)
new_pixmap_from_page_number(self, number, ctm, cs, alpha)
new_pixmap_from_page_number_with_separations(self, number, ctm, cs, seps, alpha)
new_xhtml_document_from_document(self, *args)
*Overload 1:*
 
                Use text extraction to convert the input document into XHTML,
                then open the result as a new document that can be reflowed.
 
 
|
 
*Overload 2:*
 
                Use text extraction to convert the input document into XHTML,
                then open the result as a new document that can be reflowed.
next_page(self, loc)
Function to get the location of the next page (allowing for the
end of chapters etc). If at the end of the document, returns the
current location.
output_accelerator(self, accel)
Output accelerator data for the document to a given output
stream.
page_number_from_location(self, loc)
Converts from chapter+page to page number. This may cause many
chapters to be laid out in order to calculate the number of
pages within those chapters.
pdf_count_pages_imp(self, chapter)
pdf_document_from_fz_document(self)
pdf_load_page_imp(self, chapter, number)
pdf_specifics(self)
previous_page(self, loc)
Function to get the location of the previous page (allowing for
the end of chapters etc). If already at the start of the
document, returns the current page.
resolve_link(self, uri)
Resolve an internal link to a page number.
 
xp, yp: Pointer to store coordinate of destination on the page.
 
Returns (-1,-1) if the URI cannot be resolved.
save_accelerator(self, accel)
Save accelerator data for the document to a given file.
search_chapter_page_number(self, chapter, page, needle, hit_bbox, hit_max)
search_page_number(self, number, needle, hit_bbox, hit_max)

Static methods defined here:
__swig_destroy__ = delete_Document(...)
delete_Document(Document self)
 
Parameters
----------
self: mupdf::Document *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Document_m_internal_get(Document self) -> fz_document *
 
Parameters
----------
self: mupdf::Document *
thisown
The membership flag

 
class DocumentHandler(builtins.object)
    DocumentHandler(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
register_document_handler(self)
Register a handler for a document type.
 
handler: The handler to register.

Static methods defined here:
__swig_destroy__ = delete_DocumentHandler(...)
delete_DocumentHandler(DocumentHandler self)
 
Parameters
----------
self: mupdf::DocumentHandler *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
DocumentHandler_m_internal_get(DocumentHandler self) -> fz_document_handler *
 
Parameters
----------
self: mupdf::DocumentHandler *
thisown
The membership flag

 
class DocumentHandlerContext(builtins.object)
    DocumentHandlerContext(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_DocumentHandlerContext(...)
delete_DocumentHandlerContext(DocumentHandlerContext self)
 
Parameters
----------
self: mupdf::DocumentHandlerContext *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
DocumentHandlerContext_m_internal_get(DocumentHandlerContext self) -> fz_document_handler_context *
 
Parameters
----------
self: mupdf::DocumentHandlerContext *
thisown
The membership flag

 
class DocumentWriter(builtins.object)
    DocumentWriter(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
begin_page(self, mediabox)
close_document_writer(self)
Called to end the process of writing
pages to a document.
 
This writes any file level trailers required. After this
completes successfully the file is up to date and complete.
end_page(self)
Called to end the process of writing a page to a
document.

Static methods defined here:
__swig_destroy__ = delete_DocumentWriter(...)
delete_DocumentWriter(DocumentWriter self)
 
Parameters
----------
self: mupdf::DocumentWriter *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
DocumentWriter_m_internal_get(DocumentWriter self) -> fz_document_writer *
 
Parameters
----------
self: mupdf::DocumentWriter *
thisown
The membership flag

Data and other attributes defined here:
OutputType_CBZ = 0
OutputType_PCL = 1
OutputType_PCLM = 2
OutputType_PS = 3
OutputType_PWG = 4
Type_CBZ = 0
Type_PAM_PIXMAP = 1
Type_PBM_PIXMAP = 2
Type_PCL = 3
Type_PCLM = 4
Type_PGM_PIXMAP = 5
Type_PKM_PIXMAP = 6
Type_PNG_PIXMAP = 7
Type_PNM_PIXMAP = 8
Type_PPM_PIXMAP = 9
Type_PS = 10
Type_PWG = 11
Type_SVG = 12

 
class DrawOptions(builtins.object)
    DrawOptions(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
internal(self, *args)

Static methods defined here:
__swig_destroy__ = delete_DrawOptions(...)
delete_DrawOptions(DrawOptions self)
 
Parameters
----------
self: mupdf::DrawOptions *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
alpha
DrawOptions_alpha_get(DrawOptions self) -> int
 
Parameters
----------
self: mupdf::DrawOptions *
colorspace
DrawOptions_colorspace_get(DrawOptions self) -> fz_colorspace *
 
Parameters
----------
self: mupdf::DrawOptions *
graphics
DrawOptions_graphics_get(DrawOptions self) -> int
 
Parameters
----------
self: mupdf::DrawOptions *
height
DrawOptions_height_get(DrawOptions self) -> int
 
Parameters
----------
self: mupdf::DrawOptions *
rotate
DrawOptions_rotate_get(DrawOptions self) -> int
 
Parameters
----------
self: mupdf::DrawOptions *
text
DrawOptions_text_get(DrawOptions self) -> int
 
Parameters
----------
self: mupdf::DrawOptions *
thisown
The membership flag
width
DrawOptions_width_get(DrawOptions self) -> int
 
Parameters
----------
self: mupdf::DrawOptions *
x_resolution
DrawOptions_x_resolution_get(DrawOptions self) -> int
 
Parameters
----------
self: mupdf::DrawOptions *
y_resolution
DrawOptions_y_resolution_get(DrawOptions self) -> int
 
Parameters
----------
self: mupdf::DrawOptions *

 
class ErrorContext(builtins.object)
    ErrorContext(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_ErrorContext(...)
delete_ErrorContext(ErrorContext self)
 
Parameters
----------
self: mupdf::ErrorContext *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
ErrorContext_m_internal_get(ErrorContext self) -> fz_error_context
 
Parameters
----------
self: mupdf::ErrorContext *
thisown
The membership flag

 
class ErrorStackSlot(builtins.object)
    ErrorStackSlot(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_ErrorStackSlot(...)
delete_ErrorStackSlot(ErrorStackSlot self)
 
Parameters
----------
self: mupdf::ErrorStackSlot *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
ErrorStackSlot_m_internal_get(ErrorStackSlot self) -> fz_error_stack_slot *
 
Parameters
----------
self: mupdf::ErrorStackSlot *
thisown
The membership flag

 
class Font(builtins.object)
    Font(*args)
 
An abstract font handle.
 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
advance_glyph(self, glyph, wmode)
Return the advance for a given glyph.
 
font: The font to look for the glyph in.
 
glyph: The glyph to find the advance for.
 
wmode: 1 for vertical mode, 0 for horizontal.
 
Returns the advance for the glyph.
bound_glyph(self, gid, trm)
Return a bbox for a given glyph in a font.
 
font: The font to look for the glyph in.
 
gid: The glyph to bound.
 
trm: The matrix to apply to the glyph before bounding.
 
r: Pointer to a fz_rect to use for storage.
 
Returns r, after filling it in with the bounds of the given
glyph.
decouple_type3_font(self, t3doc)
encode_character(self, unicode)
Find the glyph id for a given unicode
character within a font.
 
font: The font to look for the unicode character in.
 
unicode: The unicode character to encode.
 
Returns the glyph id for the given unicode value, or 0 if
unknown.
encode_character_by_glyph_name(self, glyphname)
Encode character.
 
Either by direct lookup of glyphname within a font, or, failing
that, by mapping glyphname to unicode and thence to the glyph
index within the given font.
 
Returns zero for type3 fonts.
encode_character_sc(self, unicode)
Encode character, preferring small-caps variant if available.
 
font: The font to look for the unicode character in.
 
unicode: The unicode character to encode.
 
Returns the glyph id for the given unicode value, or 0 if
unknown.
font_ascender(self)
Retrieve font ascender in ems.
font_bbox(self)
Retrieve a pointer to the font bbox.
 
font: The font to query.
 
Returns a pointer to the font bbox (or NULL if the
font is NULL).
font_descender(self)
Retrieve font descender in ems.
font_digest(self, digest)
Retrieve the MD5 digest for the font's data.
font_flags(self)
Retrieve a pointer to the font flags
for a given font. These can then be updated as required.
 
font: The font to query
 
Returns a pointer to the flags structure (or NULL, if
the font is NULL).
font_ft_face(self)
Retrieve the FT_Face handle
for the font.
 
font: The font to query
 
Returns the FT_Face handle for the font, or NULL
if not a freetype handled font. (Cast to void *
to avoid nasty header exposure).
font_is_bold(self)
Query whether the font flags say that this font is bold.
font_is_italic(self)
Query whether the font flags say that this font is italic.
font_is_monospaced(self)
Query whether the font flags say that this font is monospaced.
font_is_serif(self)
Query whether the font flags say that this font is serif.
font_name(self)
Retrieve a pointer to the name of the font.
 
font: The font to query.
 
Returns a pointer to an internal copy of the font name.
Will never be NULL, but may be the empty string.
font_shaper_data(self)
Retrieve a pointer to the shaper data
structure for the given font.
 
font: The font to query.
 
Returns a pointer to the shaper data structure (or NULL if
font is NULL).
font_t3_procs(self)
Retrieve the Type3 procs
for a font.
 
font: The font to query
 
Returns the t3_procs pointer. Will be NULL for a
non type-3 font.
get_glyph_name(self, glyph, buf, size)
Find the name of a glyph
 
font: The font to look for the glyph in.
 
glyph: The glyph id to look for.
 
buf: Pointer to a buffer for the name to be inserted into.
 
size: The size of the buffer.
 
If a font contains a name table, then the name of the glyph
will be returned in the supplied buffer. Otherwise a name
is synthesised. The name will be truncated to fit in
the buffer.
glyph_cacheable(self, gid)
Determine if a given glyph in a font
is cacheable. Certain glyphs in a type 3 font cannot safely
be cached, as their appearance depends on the enclosing
graphic state.
 
font: The font to look for the glyph in.
 
gif: The glyph to query.
 
Returns non-zero if cacheable, 0 if not.
outline_glyph(self, gid, ctm)
Look a glyph up from a font, and return the outline of the
glyph using the given transform.
 
The caller owns the returned path, and so is responsible for
ensuring that it eventually gets dropped.
pdf_font_writing_supported(self)
prepare_t3_glyph(self, gid)
Force a type3 font to cache the displaylist for a given glyph
id.
 
This caching can involve reading the underlying file, so must
happen ahead of time, so we aren't suddenly forced to read the
file while playing a displaylist back.
render_glyph_pixmap(self, gid, ctm, scissor, aa)
Create a pixmap containing a rendered glyph.
 
Lookup gid from font, clip it with scissor, and rendering it
with aa bits of antialiasing into a new pixmap.
 
The caller takes ownership of the pixmap and so must free it.
 
Note: This function is no longer used for normal rendering
operations, and is kept around just because we use it in the
app. It should be considered "at risk" of removal from the API.
run_t3_glyph(self, gid, trm, dev)
Run a glyph from a Type3 font to
a given device.
 
font: The font to find the glyph in.
 
gid: The glyph to run.
 
trm: The transform to apply.
 
dev: The device to render onto.
set_font_bbox(self, xmin, ymin, xmax, ymax)
Set the font bbox.
 
font: The font to set the bbox for.
 
xmin, ymin, xmax, ymax: The bounding box.

Static methods defined here:
__swig_destroy__ = delete_Font(...)
delete_Font(Font self)
 
Parameters
----------
self: mupdf::Font *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Font_m_internal_get(Font self) -> fz_font *
 
Parameters
----------
self: mupdf::Font *
thisown
The membership flag

 
class FontContext(builtins.object)
    FontContext(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_FontContext(...)
delete_FontContext(FontContext self)
 
Parameters
----------
self: mupdf::FontContext *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
FontContext_m_internal_get(FontContext self) -> fz_font_context *
 
Parameters
----------
self: mupdf::FontContext *
thisown
The membership flag

 
class FontFlagsT(builtins.object)
    FontFlagsT(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_FontFlagsT(...)
delete_FontFlagsT(FontFlagsT self)
 
Parameters
----------
self: mupdf::FontFlagsT *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
FontFlagsT_m_internal_get(FontFlagsT self) -> fz_font_flags_t
 
Parameters
----------
self: mupdf::FontFlagsT *
thisown
The membership flag

 
class Glyph(builtins.object)
    Glyph(*args)
 
Glyphs represent a run length encoded set of pixels for a 2
dimensional region of a plane.
 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
glyph_bbox(self)
Return the bounding box of the glyph in pixels.
glyph_bbox_no_ctx(self)
glyph_height(self)
Return the height of the glyph in pixels.
glyph_width(self)
Return the width of the glyph in pixels.

Static methods defined here:
__swig_destroy__ = delete_Glyph(...)
delete_Glyph(Glyph self)
 
Parameters
----------
self: mupdf::Glyph *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Glyph_m_internal_get(Glyph self) -> fz_glyph *
 
Parameters
----------
self: mupdf::Glyph *
thisown
The membership flag

Data and other attributes defined here:
Bpp_1 = 0
Bpp_8 = 1

 
class GlyphCache(builtins.object)
    GlyphCache(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_GlyphCache(...)
delete_GlyphCache(GlyphCache self)
 
Parameters
----------
self: mupdf::GlyphCache *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
GlyphCache_m_internal_get(GlyphCache self) -> fz_glyph_cache *
 
Parameters
----------
self: mupdf::GlyphCache *
thisown
The membership flag

 
class Halftone(builtins.object)
    Halftone(*args)
 
A halftone is a set of threshold tiles, one per component. Each
threshold tile is a pixmap, possibly of varying sizes and
phases. Currently, we only provide one 'default' halftone tile
for operating on 1 component plus alpha pixmaps (where the alpha
is ignored). This is signified by a fz_halftone pointer to NULL.
 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_Halftone(...)
delete_Halftone(Halftone self)
 
Parameters
----------
self: mupdf::Halftone *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Halftone_m_internal_get(Halftone self) -> fz_halftone *
 
Parameters
----------
self: mupdf::Halftone *
thisown
The membership flag

 
class HashTable(builtins.object)
    HashTable(*args)
 
Generic hash-table with fixed-length keys.
 
The keys and values are NOT reference counted by the hash table.
Callers are responsible for taking care the reference counts are
correct. Inserting a duplicate entry will NOT overwrite the old
value, and will return the old value.
 
The drop_val callback function is only used to release values
when the hash table is destroyed.
 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
hash_find(self, key)
Search for a matching hash within the table, and return the
associated value.
hash_for_each(self, state, callback)
Iterate over the entries in a hash table.
hash_insert(self, key, val)
Insert a new key/value pair into the hash table.
 
If an existing entry with the same key is found, no change is
made to the hash table, and a pointer to the existing value is
returned.
 
If no existing entry with the same key is found, ownership of
val passes in, key is copied, and NULL is returned.
hash_remove(self, key)
Remove the entry for a given key.
 
The value is NOT freed, so the caller is expected to take care
of this.

Static methods defined here:
__swig_destroy__ = delete_HashTable(...)
delete_HashTable(HashTable self)
 
Parameters
----------
self: mupdf::HashTable *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
HashTable_m_internal_get(HashTable self) -> fz_hash_table *
 
Parameters
----------
self: mupdf::HashTable *
thisown
The membership flag

 
class IccProfile(builtins.object)
    IccProfile(internal)
 
Opaque type for an ICC Profile.
 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_IccProfile(...)
delete_IccProfile(IccProfile self)
 
Parameters
----------
self: mupdf::IccProfile *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
IccProfile_m_internal_get(IccProfile self) -> fz_icc_profile *
 
Parameters
----------
self: mupdf::IccProfile *
thisown
The membership flag

 
class Image(builtins.object)
    Image(*args)
 
Images are storable objects from which we can obtain fz_pixmaps.
These may be implemented as simple wrappers around a pixmap, or
as more complex things that decode at different subsample
settings on demand.
 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
compressed_image_buffer(self)
Retrieve the underlying compressed data for an image.
 
Returns a pointer to the underlying data buffer for an image,
or NULL if this image is not based upon a compressed data
buffer.
 
This is not a reference counted structure, so no reference is
returned. Lifespan is limited to that of the image itself.
get_pixmap_from_image(self, subarea, ctm)
Called to get a handle to a pixmap from an image.
 
image: The image to retrieve a pixmap from.
 
color_params: The color parameters (or NULL for defaults).
 
subarea: The subarea of the image that we actually care about
(or NULL to indicate the whole image).
 
trans: Optional, unless subarea is given. If given, then on
entry this is the transform that will be applied to the complete
image. It should be updated on exit to the transform to apply to
the given subarea of the image. This is used to calculate the
desired width/height for subsampling.
 
w: If non-NULL, a pointer to an int to be updated on exit to the
width (in pixels) that the scaled output will cover.
 
h: If non-NULL, a pointer to an int to be updated on exit to the
height (in pixels) that the scaled output will cover.
 
Returns a non NULL pixmap pointer. May throw exceptions.
image_resolution(self)
Request the natural resolution
of an image.
 
xres, yres: Pointers to ints to be updated with the
natural resolution of an image (or a sensible default
if not encoded).
image_size(self)
Return the size of the storage used by an image.
new_buffer_from_image_as_png(self, color_params)
Reencode a given image as a PNG into a buffer.
 
Ownership of the buffer is returned.

Static methods defined here:
__swig_destroy__ = delete_Image(...)
delete_Image(Image self)
 
Parameters
----------
self: mupdf::Image *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Image_m_internal_get(Image self) -> fz_image *
 
Parameters
----------
self: mupdf::Image *
thisown
The membership flag

 
class Irect(builtins.object)
    Irect(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
expand_irect(self, expand)
internal(self, *args)
intersect_irect(self, b)
Compute intersection of two bounding boxes.
 
Similar to fz_intersect_rect but operates on two bounding
boxes instead of two rectangles.
is_empty_irect(self)
is_infinite_irect(self)
Check if an integer rectangle
is infinite.
 
An infinite rectangle is defined as one where either of the
two relationships between corner coordinates are not true.
rect_from_irect(self)
Convert a bbox into a rect.
 
For our purposes, a rect can represent all the values we meet in
a bbox, so nothing can go wrong.
 
rect: A place to store the generated rectangle.
 
bbox: The bbox to convert.
 
Returns rect (updated).
translate_irect(self, xoff, yoff)

Static methods defined here:
__swig_destroy__ = delete_Irect(...)
delete_Irect(Irect self)
 
Parameters
----------
self: mupdf::Irect *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag
x0
Irect_x0_get(Irect self) -> int
 
Parameters
----------
self: mupdf::Irect *
x1
Irect_x1_get(Irect self) -> int
 
Parameters
----------
self: mupdf::Irect *
y0
Irect_y0_get(Irect self) -> int
 
Parameters
----------
self: mupdf::Irect *
y1
Irect_y1_get(Irect self) -> int
 
Parameters
----------
self: mupdf::Irect *

 
class IteratorWrap(builtins.object)
    IteratorWrap(container)
 
This is a Python iterator for containers that have C++-style
begin() and end() methods that return iterators.
 
Iterators must have the following methods:
 
    __increment__(): move to next item in the container.
    __ref__(): return reference to item in the container.
 
Must also be able to compare two iterators for equality.
 
  Methods defined here:
__init__(self, container)
Initialize self.  See help(type(self)) for accurate signature.
__iter__(self)
__next__(self)
next(self)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class Jbig2Globals(builtins.object)
    Jbig2Globals(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_Jbig2Globals(...)
delete_Jbig2Globals(Jbig2Globals self)
 
Parameters
----------
self: mupdf::Jbig2Globals *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Jbig2Globals_m_internal_get(Jbig2Globals self) -> fz_jbig2_globals *
 
Parameters
----------
self: mupdf::Jbig2Globals *
thisown
The membership flag

 
class KeyStorable(builtins.object)
    KeyStorable(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_KeyStorable(...)
delete_KeyStorable(KeyStorable self)
 
Parameters
----------
self: mupdf::KeyStorable *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
KeyStorable_m_internal_get(KeyStorable self) -> fz_key_storable
 
Parameters
----------
self: mupdf::KeyStorable *
thisown
The membership flag

 
class LayoutBlock(builtins.object)
    LayoutBlock(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
add_layout_char(self, x, w, p)
Add a new char to the line at the end of the layout block.
add_layout_line(self, x, y, h, p)
Add a new line to the end of the layout block.

Static methods defined here:
__swig_destroy__ = delete_LayoutBlock(...)
delete_LayoutBlock(LayoutBlock self)
 
Parameters
----------
self: mupdf::LayoutBlock *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
LayoutBlock_m_internal_get(LayoutBlock self) -> fz_layout_block
 
Parameters
----------
self: mupdf::LayoutBlock *
thisown
The membership flag

 
class LayoutChar(builtins.object)
    LayoutChar(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_LayoutChar(...)
delete_LayoutChar(LayoutChar self)
 
Parameters
----------
self: mupdf::LayoutChar *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
LayoutChar_m_internal_get(LayoutChar self) -> fz_layout_char
 
Parameters
----------
self: mupdf::LayoutChar *
thisown
The membership flag

 
class LayoutLine(builtins.object)
    LayoutLine(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_LayoutLine(...)
delete_LayoutLine(LayoutLine self)
 
Parameters
----------
self: mupdf::LayoutLine *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
LayoutLine_m_internal_get(LayoutLine self) -> fz_layout_line
 
Parameters
----------
self: mupdf::LayoutLine *
thisown
The membership flag

 
class Link(builtins.object)
    Link(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__iter__ lambda self
__repr__ = _swig_repr(self)
begin(self)
end(self)

Static methods defined here:
__swig_destroy__ = delete_Link(...)
delete_Link(Link self)
 
Parameters
----------
self: mupdf::Link *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Link_m_internal_get(Link self) -> fz_link
 
Parameters
----------
self: mupdf::Link *
thisown
The membership flag

 
class LinkIterator(builtins.object)
    LinkIterator(item)
 

 
  Methods defined here:
__deref__(self)
__eq__(self, rhs)
Return self==value.
__increment__(self)
__init__(self, item)
Initialize self.  See help(type(self)) for accurate signature.
__ne__(self, rhs)
Return self!=value.
__ref__(self)
__repr__ = _swig_repr(self)
begin(self)
end(self)

Static methods defined here:
__swig_destroy__ = delete_LinkIterator(...)
delete_LinkIterator(LinkIterator self)
 
Parameters
----------
self: mupdf::LinkIterator *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
LinkIterator_m_internal_get(LinkIterator self) -> fz_link
 
Parameters
----------
self: mupdf::LinkIterator *
thisown
The membership flag

Data and other attributes defined here:
__hash__ = None

 
class Location(builtins.object)
    Location(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
internal(self, *args)

Static methods defined here:
__swig_destroy__ = delete_Location(...)
delete_Location(Location self)
 
Parameters
----------
self: mupdf::Location *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
chapter
Location_chapter_get(Location self) -> int
 
Parameters
----------
self: mupdf::Location *
page
Location_page_get(Location self) -> int
 
Parameters
----------
self: mupdf::Location *
thisown
The membership flag

 
class LocksContext(builtins.object)
    LocksContext(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_LocksContext(...)
delete_LocksContext(LocksContext self)
 
Parameters
----------
self: mupdf::LocksContext *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
LocksContext_m_internal_get(LocksContext self) -> fz_locks_context
 
Parameters
----------
self: mupdf::LocksContext *
thisown
The membership flag

 
class Matrix(builtins.object)
    Matrix(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
concat(self, *args)
*Overload 1:*
 
                Multiply two matrices.
 
                The order of the two matrices are important since matrix
                multiplication is not commutative.
 
                Returns result.
 
 
|
 
*Overload 2:*
 
                Multiply two matrices.
 
                The order of the two matrices are important since matrix
                multiplication is not commutative.
 
                Returns result.
internal(self, *args)
invert_matrix(self)
Create an inverse matrix.
 
inverse: Place to store inverse matrix.
 
matrix: Matrix to invert. A degenerate matrix, where the
determinant is equal to zero, can not be inverted and the
original matrix is returned instead.
 
Returns inverse.
is_identity(self)
is_rectilinear(self)
Check if a transformation is rectilinear.
 
Rectilinear means that no shearing is present and that any
rotations present are a multiple of 90 degrees. Usually this
is used to make sure that axis-aligned rectangles before the
transformation are still axis-aligned rectangles afterwards.
matrix_expansion(self)
Calculate average scaling factor of matrix.
matrix_max_expansion(self)
Find the largest expansion performed by this matrix.
(i.e. max(abs(m.a),abs(m.b),abs(m.c),abs(m.d))
post_scale(self, sx, sy)
Scale a matrix by postmultiplication.
 
m: Pointer to the matrix to scale
 
sx, sy: Scaling factors along the X- and Y-axes. A scaling
factor of 1.0 will not cause any scaling along the relevant
axis.
 
Returns m (updated).
pre_rotate(self, degrees)
Rotate a transformation by premultiplying.
 
The premultiplied matrix is of the form
[ cos(deg) sin(deg) -sin(deg) cos(deg) 0 0 ].
 
m: Pointer to matrix to premultiply.
 
degrees: Degrees of counter clockwise rotation. Values less
than zero and greater than 360 are handled as expected.
 
Returns m (updated).
pre_scale(self, sx, sy)
Scale a matrix by premultiplication.
 
m: Pointer to the matrix to scale
 
sx, sy: Scaling factors along the X- and Y-axes. A scaling
factor of 1.0 will not cause any scaling along the relevant
axis.
 
Returns m (updated).
pre_shear(self, sx, sy)
Premultiply a matrix with a shearing matrix.
 
The shearing matrix is of the form [ 1 sy sx 1 0 0 ].
 
m: pointer to matrix to premultiply
 
sx, sy: Shearing factors. A shearing factor of 0.0 will not
cause any shearing along the relevant axis.
 
Returns m (updated).
pre_translate(self, tx, ty)
Translate a matrix by premultiplication.
 
m: The matrix to translate
 
tx, ty: Translation distances along the X- and Y-axes. A
translation of 0 will not cause any translation along the
relevant axis.
 
Returns m.
subpixel_adjust(self, subpix_ctm, qe, qf)
Perform subpixel quantisation and adjustment on a glyph matrix.
 
ctm: On entry, the desired 'ideal' transformation for a glyph.
On exit, adjusted to a (very similar) transformation quantised
for subpixel caching.
 
subpix_ctm: Initialised by the routine to the transform that
should be used to render the glyph.
 
qe, qf: which subpixel position we quantised to.
 
Returns: the size of the glyph.
 
Note: This is currently only exposed for use in our app. It
should be considered "at risk" of removal from the API.
try_invert_matrix(self, src)
Attempt to create an inverse matrix.
 
inverse: Place to store inverse matrix.
 
matrix: Matrix to invert. A degenerate matrix, where the
determinant is equal to zero, can not be inverted.
 
Returns 1 if matrix is degenerate (singular), or 0 otherwise.

Static methods defined here:
__swig_destroy__ = delete_Matrix(...)
delete_Matrix(Matrix self)
 
Parameters
----------
self: mupdf::Matrix *
rotate(degrees)
Create a rotation matrix.
 
The returned matrix is of the form
[ cos(deg) sin(deg) -sin(deg) cos(deg) 0 0 ].
 
m: Pointer to place to store matrix
 
degrees: Degrees of counter clockwise rotation. Values less
than zero and greater than 360 are handled as expected.
 
Returns m.
scale(sx, sy)
Create a scaling matrix.
 
The returned matrix is of the form [ sx 0 0 sy 0 0 ].
 
m: Pointer to the matrix to populate
 
sx, sy: Scaling factors along the X- and Y-axes. A scaling
factor of 1.0 will not cause any scaling along the relevant
axis.
 
Returns m.
shear(sx, sy)
Create a shearing matrix.
 
The returned matrix is of the form [ 1 sy sx 1 0 0 ].
 
m: pointer to place to store returned matrix
 
sx, sy: Shearing factors. A shearing factor of 0.0 will not
cause any shearing along the relevant axis.
 
Returns m.
transform_page(mediabox, resolution, rotate)
Create transform matrix to draw page
at a given resolution and rotation. Adjusts the scaling
factors so that the page covers whole number of
pixels and adjust the page origin to be at 0,0.
translate(tx, ty)
Create a translation matrix.
 
The returned matrix is of the form [ 1 0 0 1 tx ty ].
 
m: A place to store the created matrix.
 
tx, ty: Translation distances along the X- and Y-axes. A
translation of 0 will not cause any translation along the
relevant axis.
 
Returns m.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
a
Matrix_a_get(Matrix self) -> float
 
Parameters
----------
self: mupdf::Matrix *
b
Matrix_b_get(Matrix self) -> float
 
Parameters
----------
self: mupdf::Matrix *
c
Matrix_c_get(Matrix self) -> float
 
Parameters
----------
self: mupdf::Matrix *
d
Matrix_d_get(Matrix self) -> float
 
Parameters
----------
self: mupdf::Matrix *
e
Matrix_e_get(Matrix self) -> float
 
Parameters
----------
self: mupdf::Matrix *
f
Matrix_f_get(Matrix self) -> float
 
Parameters
----------
self: mupdf::Matrix *
thisown
The membership flag

 
class Md5(builtins.object)
    Md5(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
md5_final(self, digest)
MD5 finalization. Ends an MD5 message-digest operation, writing
the message digest and zeroizing the context.
 
Never throws an exception.
md5_init(self)
MD5 initialization. Begins an MD5 operation, writing a new
context.
 
Never throws an exception.
md5_update(self, input, inlen)
MD5 block update operation. Continues an MD5 message-digest
operation, processing another message block, and updating the
context.
 
Never throws an exception.

Static methods defined here:
__swig_destroy__ = delete_Md5(...)
delete_Md5(Md5 self)
 
Parameters
----------
self: mupdf::Md5 *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Md5_m_internal_get(Md5 self) -> fz_md5
 
Parameters
----------
self: mupdf::Md5 *
thisown
The membership flag

 
class Outline(builtins.object)
    Outline(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__iter__ lambda self
__repr__ = _swig_repr(self)
begin(self)
down(self)
end(self)
is_open(self)
next(self)
page(self)
refs(self)
title(self)
uri(self)
x(self)
y(self)

Static methods defined here:
__swig_destroy__ = delete_Outline(...)
delete_Outline(Outline self)
 
Parameters
----------
self: mupdf::Outline *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Outline_m_internal_get(Outline self) -> fz_outline
 
Parameters
----------
self: mupdf::Outline *
thisown
The membership flag

 
class OutlineIterator(builtins.object)
    OutlineIterator(*args)
 

 
  Methods defined here:
__deref__(self)
__eq__(self, rhs)
Return self==value.
__increment__(self)
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__ne__(self, rhs)
Return self!=value.
__ref__(self)
__repr__ = _swig_repr(self)
begin(self)
down(self)
end(self)
is_open(self)
next(self)
page(self)
refs(self)
title(self)
uri(self)
x(self)
y(self)

Static methods defined here:
__swig_destroy__ = delete_OutlineIterator(...)
delete_OutlineIterator(OutlineIterator self)
 
Parameters
----------
self: mupdf::OutlineIterator *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
OutlineIterator_m_internal_get(OutlineIterator self) -> fz_outline
 
Parameters
----------
self: mupdf::OutlineIterator *
thisown
The membership flag

Data and other attributes defined here:
__hash__ = None

 
class Output(builtins.object)
    Output(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
close_output(self)
Flush pending output and close an output stream.
debug_store(self)
Output debugging information for the current state of the store
to the given output channel.
dump_glyph_cache_stats(self)
Dump debug statistics for the glyph cache.
flush_output(self)
Flush unwritten data.
new_svg_device(self, page_width, page_height, text_format, reuse_images)
Create a device that outputs (single page) SVG files to
the given output stream.
 
Equivalent to fz_new_svg_device_with_id passing id = NULL.
new_svg_device_with_id(self, page_width, page_height, text_format, reuse_images)
Create a device that outputs (single page) SVG files to
the given output stream.
 
output: The output stream to send the constructed SVG page to.
 
page_width, page_height: The page dimensions to use (in points).
 
text_format: How to emit text. One of the following values:
        FZ_SVG_TEXT_AS_TEXT: As <text> elements with possible
        layout errors and mismatching fonts.
        FZ_SVG_TEXT_AS_PATH: As <path> elements with exact
        visual appearance.
 
reuse_images: Share image resources using <symbol> definitions.
 
id: ID parameter to keep generated IDs unique across SVG files.
new_trace_device(self)
Create a device to print a debug trace of all device calls.
new_zip_writer_with_output(self)
Create a new zip writer that writes to a given output stream.
output_supports_stream(self)
Query whether a given fz_output supports fz_stream_from_output.
pdf_new_output_processor(self, ahxencode)
pdf_print_crypt(self, crypt)
pdf_print_encrypted_obj(self, obj, tight, ascii, crypt, num, gen)
pdf_print_font(self, fontdesc)
pdf_print_obj(self, obj, tight, ascii)
pdf_write_digest(self, byte_range, digest_offset, digest_length, signer)
print_stext_header_as_html(self)
print_stext_header_as_xhtml(self)
print_stext_page_as_html(self, page, id)
Output a page to a file in HTML (visual) format.
print_stext_page_as_text(self, page)
Output a page to a file in UTF-8 format.
print_stext_page_as_xhtml(self, page, id)
Output a page to a file in XHTML (semantic) format.
print_stext_page_as_xml(self, page, id)
Output a page to a file in XML format.
print_stext_trailer_as_html(self)
print_stext_trailer_as_xhtml(self)
seek_output(self, off, whence)
Seek to the specified file position.
See fseek for arguments.
 
Throw an error on unseekable outputs.
stream_from_output(self)
Obtain the fz_output in the form of a fz_stream.
 
This allows data to be read back from some forms of fz_output
object. When finished reading, the fz_stream should be released
by calling fz_drop_stream. Until the fz_stream is dropped, no
further operations should be performed on the fz_output object.
tell_output(self)
Return the current file position.
 
Throw an error on untellable outputs.
truncate_output(self)
Truncate the output at the current position.
 
This allows output streams which have seeked back from the end
of their storage to be truncated at the current point.
write_base64(self, data, size, newline)
Write a base64 encoded data block, optionally with periodic
newlines.
write_base64_buffer(self, data, newline)
Write a base64 encoded fz_buffer, optionally with periodic
newlines.
write_bitmap_as_pbm(self, bitmap)
Write a bitmap as a pbm.
write_bitmap_as_pcl(self, bitmap, pcl)
Write a bitmap as mono PCL.
write_bitmap_as_pkm(self, bitmap)
Write a CMYK bitmap as a pkm.
write_bitmap_as_pwg(self, bitmap, pwg)
Write a bitmap as a PWG.
write_bitmap_as_pwg_page(self, bitmap, pwg)
Write a bitmap as a PWG page.
 
Caller should provide a file header by calling
fz_write_pwg_file_header, but can then write several pages to
the same file.
write_byte(self, x)
write_char(self, x)
write_data(self, data, size)
Write data to output.
 
data: Pointer to data to write.
size: Size of data to write in bytes.
write_float_be(self, f)
write_float_le(self, f)
write_image_as_data_uri(self, image)
Write image as a data URI (for HTML and SVG output).
write_int16_be(self, x)
write_int16_le(self, x)
write_int32_be(self, x)
Write different sized data to an output stream.
write_int32_le(self, x)
write_pixmap_as_data_uri(self, pixmap)
write_pixmap_as_pam(self, pixmap)
Write a pixmap as a pnm (greyscale, rgb or cmyk, with or without
alpha).
write_pixmap_as_pcl(self, pixmap, pcl)
Write an (RGB) pixmap as color PCL.
write_pixmap_as_pclm(self, pixmap, options)
Write a (Greyscale or RGB) pixmap as pclm.
write_pixmap_as_png(self, pixmap)
Write a (Greyscale or RGB) pixmap as a png.
write_pixmap_as_pnm(self, pixmap)
Write a pixmap as a pnm (greyscale or rgb, no alpha).
write_pixmap_as_ps(self, pixmap)
Write a (gray, rgb, or cmyk, no alpha) pixmap out as postscript.
write_pixmap_as_psd(self, pixmap)
Write a pixmap as a PSD file.
write_pixmap_as_pwg(self, pixmap, pwg)
Write a pixmap as a PWG.
write_pixmap_as_pwg_page(self, pixmap, pwg)
Write a pixmap as a PWG page.
 
Caller should provide a file header by calling
fz_write_pwg_file_header, but can then write several pages to
the same file.
write_ps_file_header(self)
Write the file level header for ps band writer output.
write_ps_file_trailer(self, pages)
Write the file level trailer for ps band writer output.
write_pwg_file_header(self)
Output the file header to a pwg stream, ready for pages to follow it.
write_rune(self, rune)
Write a UTF-8 encoded unicode character.
write_string(self, s)
Write a string. Does not write zero terminator.
write_uint16_be(self, x)
write_uint16_le(self, x)
write_uint32_be(self, x)
write_uint32_le(self, x)

Static methods defined here:
__swig_destroy__ = delete_Output(...)
delete_Output(Output self)
 
Parameters
----------
self: mupdf::Output *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Output_m_internal_get(Output self) -> fz_output
 
Parameters
----------
self: mupdf::Output *
thisown
The membership flag

Data and other attributes defined here:
Filter_85 = 1
Filter_HEX = 0
Filter_RLE = 2
Fixed_STDERR = 2
Fixed_STDOUT = 1

 
class Overprint(builtins.object)
    Overprint(internal)
 
Pixmaps represent a set of pixels for a 2 dimensional region of
a plane. Each pixel has n components per pixel. The components
are in the order process-components, spot-colors, alpha, where
there can be 0 of any of those types. The data is in
premultiplied alpha when rendering, but non-premultiplied for
colorspace conversions and rescaling.
 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_Overprint(...)
delete_Overprint(Overprint self)
 
Parameters
----------
self: mupdf::Overprint *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Overprint_m_internal_get(Overprint self) -> fz_overprint *
 
Parameters
----------
self: mupdf::Overprint *
thisown
The membership flag

 
class Page(builtins.object)
    Page(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
bound_page(self)
Determine the size of a page at 72 dpi.
load_links(self)
Load the list of links for a page.
 
Returns a linked list of all the links on the page, each with
its clickable region and link destination. Each link is
reference counted so drop and free the list of links by
calling fz_drop_link on the pointer return from fz_load_links.
 
page: Page obtained from fz_load_page.
new_buffer_from_page(self, options)
new_display_list_from_page(self)
Create a display list.
 
Ownership of the display list is returned to the caller.
new_display_list_from_page_contents(self)
Create a display list from page contents (no annotations).
 
Ownership of the display list is returned to the caller.
new_pixmap_from_page(self, ctm, cs, alpha)
new_pixmap_from_page_contents(self, ctm, cs, alpha)
Render the page contents without annotations.
 
Ownership of the pixmap is returned to the caller.
new_pixmap_from_page_contents_with_separations(self, ctm, cs, seps, alpha)
new_pixmap_from_page_with_separations(self, ctm, cs, seps, alpha)
page_presentation(self, transition)
Get the presentation details for a given page.
 
transition: A pointer to a transition struct to fill out.
 
duration: A pointer to a place to set the page duration in
seconds. Will be set to 0 if no transition is specified for the
page.
 
Returns: a pointer to the transition structure, or NULL if there
is no transition specified for the page.
page_separations(self)
Get the separations details for a page.
This will be NULL, unless the format specifically supports
separations (such as PDF files). May be NULL even
so, if there are no separations on a page.
 
Returns a reference that must be dropped.
page_uses_overprint(self)
Query if a given page requires overprint.
pdf_page_from_fz_page(self)
run(self, dev, transform, cookie)
Run a page through a device.
 
page: Page obtained from fz_load_page.
 
dev: Device obtained from fz_new_*_device.
 
transform: Transform to apply to page. May include for example
scaling and rotation, see fz_scale, fz_rotate and fz_concat.
Set to fz_identity if no transformation is desired.
 
cookie: Communication mechanism between caller and library
rendering the page. Intended for multi-threaded applications,
while single-threaded applications set cookie to NULL. The
caller may abort an ongoing rendering of a page. Cookie also
communicates progress information back to the caller. The
fields inside cookie are continually updated while the page is
rendering.
run_annots(self, dev, transform, cookie)
Run the annotations on a page through a device.
run_contents(self, dev, transform, cookie)
Run a page through a device. Just the main
page content, without the annotations, if any.
 
page: Page obtained from fz_load_page.
 
dev: Device obtained from fz_new_*_device.
 
transform: Transform to apply to page. May include for example
scaling and rotation, see fz_scale, fz_rotate and fz_concat.
Set to fz_identity if no transformation is desired.
 
cookie: Communication mechanism between caller and library
rendering the page. Intended for multi-threaded applications,
while single-threaded applications set cookie to NULL. The
caller may abort an ongoing rendering of a page. Cookie also
communicates progress information back to the caller. The
fields inside cookie are continually updated while the page is
rendering.
run_widgets(self, dev, transform, cookie)
Run the widgets on a page through a device.
search_page(self, needle, hit_bbox, hit_max)
Search for the 'needle' text on the page.
Record the hits in the hit_bbox array and return the number of
hits. Will stop looking once it has filled hit_max rectangles.

Static methods defined here:
__swig_destroy__ = delete_Page(...)
delete_Page(Page self)
 
Parameters
----------
self: mupdf::Page *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Page_m_internal_get(Page self) -> fz_page *
 
Parameters
----------
self: mupdf::Page *
thisown
The membership flag

 
class Path(builtins.object)
    Path(*args)
 
Vector path buffer.
It can be stroked and dashed, or be filled.
It has a fill rule (nonzero or even_odd).
 
When rendering, they are flattened, stroked and dashed straight
into the Global Edge List.
 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
bound_path(self, stroke, ctm)
Return a bounding rectangle for a path.
 
path: The path to bound.
 
stroke: If NULL, the bounding rectangle given is for
the filled path. If non-NULL the bounding rectangle
given is for the path stroked with the given attributes.
 
ctm: The matrix to apply to the path during stroking.
 
r: Pointer to a fz_rect which will be used to hold
the result.
 
Returns r, updated to contain the bounding rectangle.
clone_path(self)
Clone the data for a path.
 
This is used in preference to fz_keep_path when a whole
new copy of a path is required, rather than just a shared
pointer. This probably indicates that the path is about to
be modified.
 
path: path to clone.
 
Throws exceptions on failure to allocate.
closepath(self)
Close the current subpath.
 
path: The path to modify.
 
Throws exceptions on failure to allocate, attempting to modify
a packed path, and illegal path closes (i.e. closing a non open
path).
currentpoint(self)
Return the current point that a path has
reached or (0,0) if empty.
 
path: path to return the current point of.
curveto(self, x0, y0, x1, y1, x2, y2)
Append a 'curveto' command to an open path. (For a
cubic bezier).
 
path: The path to modify.
 
x0, y0: The coordinates of the first control point for the
curve.
 
x1, y1: The coordinates of the second control point for the
curve.
 
x2, y2: The end coordinates for the curve.
 
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
curvetov(self, x1, y1, x2, y2)
Append a 'curvetov' command to an open path. (For a
cubic bezier with the first control coordinate equal to
the start point).
 
path: The path to modify.
 
x1, y1: The coordinates of the second control point for the
curve.
 
x2, y2: The end coordinates for the curve.
 
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
curvetoy(self, x0, y0, x2, y2)
Append a 'curvetoy' command to an open path. (For a
cubic bezier with the second control coordinate equal to
the end point).
 
path: The path to modify.
 
x0, y0: The coordinates of the first control point for the
curve.
 
x2, y2: The end coordinates for the curve (and the second
control coordinate).
 
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
lineto(self, x, y)
Append a 'lineto' command to an open path.
 
path: The path to modify.
 
x, y: The coordinate to line to.
 
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
moveto(self, x, y)
Append a 'moveto' command to a path.
This 'opens' a path.
 
path: The path to modify.
 
x, y: The coordinate to move to.
 
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
packed_path_size(self)
Return the number of bytes required to pack a path.
quadto(self, x0, y0, x1, y1)
Append a 'quadto' command to an open path. (For a
quadratic bezier).
 
path: The path to modify.
 
x0, y0: The control coordinates for the quadratic curve.
 
x1, y1: The end coordinates for the quadratic curve.
 
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
rectto(self, x0, y0, x1, y1)
Append a 'rectto' command to an open path.
 
The rectangle is equivalent to:
        moveto x0 y0
        lineto x1 y0
        lineto x1 y1
        lineto x0 y1
        closepath
 
path: The path to modify.
 
x0, y0: First corner of the rectangle.
 
x1, y1: Second corner of the rectangle.
 
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
transform_path(self, transform)
Transform a path by a given
matrix.
 
path: The path to modify (must not be a packed path).
 
transform: The transform to apply.
 
Throws exceptions if the path is packed, or on failure
to allocate.
trim_path(self)
Minimise the internal storage used by a path.
 
As paths are constructed, the internal buffers
grow. To avoid repeated reallocations they
grow with some spare space. Once a path has
been fully constructed, this call allows the
excess space to be trimmed.
walk_path(self, walker, arg)
Walk the segments of a path, calling the
appropriate callback function from a given set for each
segment of the path.
 
path: The path to walk.
 
walker: The set of callback functions to use. The first
4 callback pointers in the set must be non-NULL. The
subsequent ones can either be supplied, or can be left
as NULL, in which case the top 4 functions will be
called as appropriate to simulate them.
 
arg: An opaque argument passed in to each callback.
 
Exceptions will only be thrown if the underlying callback
functions throw them.

Static methods defined here:
__swig_destroy__ = delete_Path(...)
delete_Path(Path self)
 
Parameters
----------
self: mupdf::Path *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Path_m_internal_get(Path self) -> fz_path *
 
Parameters
----------
self: mupdf::Path *
thisown
The membership flag

 
class PathWalker(builtins.object)
    PathWalker(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PathWalker(...)
delete_PathWalker(PathWalker self)
 
Parameters
----------
self: mupdf::PathWalker *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PathWalker_m_internal_get(PathWalker self) -> fz_path_walker
 
Parameters
----------
self: mupdf::PathWalker *
thisown
The membership flag

 
class PclOptions(builtins.object)
    PclOptions(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
pcl_preset(self, preset)
Initialize PCL option struct for a given preset.
 
Currently defined presets include:
 
        generic Generic PCL printer
        ljet4   HP DeskJet
        dj500   HP DeskJet 500
        fs600   Kyocera FS-600
        lj      HP LaserJet, HP LaserJet Plus
        lj2     HP LaserJet IIp, HP LaserJet IId
        lj3     HP LaserJet III
        lj3d    HP LaserJet IIId
        lj4     HP LaserJet 4
        lj4pl   HP LaserJet 4 PL
        lj4d    HP LaserJet 4d
        lp2563b HP 2563B line printer
        oce9050 Oce 9050 Line printer

Static methods defined here:
__swig_destroy__ = delete_PclOptions(...)
delete_PclOptions(PclOptions self)
 
Parameters
----------
self: mupdf::PclOptions *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PclOptions_m_internal_get(PclOptions self) -> fz_pcl_options
 
Parameters
----------
self: mupdf::PclOptions *
thisown
The membership flag

 
class PclmOptions(builtins.object)
    PclmOptions(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PclmOptions(...)
delete_PclmOptions(PclmOptions self)
 
Parameters
----------
self: mupdf::PclmOptions *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PclmOptions_m_internal_get(PclmOptions self) -> fz_pclm_options
 
Parameters
----------
self: mupdf::PclmOptions *
thisown
The membership flag

 
class PdfAlertEvent(builtins.object)
    PdfAlertEvent(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfAlertEvent(...)
delete_PdfAlertEvent(PdfAlertEvent self)
 
Parameters
----------
self: mupdf::PdfAlertEvent *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfAlertEvent_m_internal_get(PdfAlertEvent self) -> pdf_alert_event
 
Parameters
----------
self: mupdf::PdfAlertEvent *
thisown
The membership flag

 
class PdfAnnot(builtins.object)
    PdfAnnot(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
add_annot_ink_list_stroke(self)
add_annot_ink_list_stroke_vertex(self, p)
add_annot_quad_point(self, quad)
add_annot_vertex(self, p)
annot_MK_BC(self, color)
annot_MK_BC_rgb(self, rgb)
annot_MK_BG(self, color)
annot_MK_BG_rgb(self, rgb)
annot_author(self)
annot_border(self)
annot_color(self, color)
annot_contents(self)
annot_default_appearance(self, arg2, color)
annot_event_blur(self)
annot_event_down(self)
annot_event_enter(self)
annot_event_exit(self)
annot_event_focus(self)
annot_event_page_close(self)
annot_event_page_invisible(self)
annot_event_page_open(self)
annot_event_page_visible(self)
annot_event_up(self)
annot_flags(self)
annot_has_author(self)
annot_has_icon_name(self)
annot_has_ink_list(self)
annot_has_interior_color(self)
annot_has_line(self)
annot_has_line_ending_styles(self)
annot_has_open(self)
annot_has_quad_points(self)
annot_has_vertices(self)
annot_icon_name(self)
annot_ink_list_count(self)
annot_ink_list_stroke_count(self, i)
annot_ink_list_stroke_vertex(self, i, k)
annot_interior_color(self, color)
annot_is_open(self)
annot_language(self)
annot_line(self, a, b)
annot_line_end_style(self)
annot_line_ending_styles(self, arg2, arg3)
annot_line_start_style(self)
annot_modification_date(self)
annot_opacity(self)
annot_quad_point(self, i)
annot_quad_point_count(self)
annot_quadding(self)
annot_rect(self)
annot_transform(self)
annot_type(self)
annot_vertex(self, i)
annot_vertex_count(self)
bound_annot(self)
bound_widget(self)
choice_widget_is_multiselect(self)
choice_widget_options(self, exportval, opts)
choice_widget_set_value(self, n, opts)
choice_widget_value(self, opts)
clear_annot_ink_list(self)
clear_annot_quad_points(self)
clear_annot_vertices(self)
clear_signature(self)
dirty_annot(self)
get_widget_editing_state(self)
layout_text_widget(self)
new_display_list_from_annot(self)
new_pixmap_from_annot(self, ctm, cs, seps, alpha)
next_annot(self)
next_widget(self)
run_annot(self, dev, ctm, cookie)
set_annot_author(self, author)
set_annot_border(self, width)
set_annot_color(self, n)
set_annot_contents(self, text)
set_annot_default_appearance(self, font, size, color)
set_annot_flags(self, flags)
set_annot_icon_name(self, name)
set_annot_ink_list(self, n, v)
set_annot_interior_color(self, n)
set_annot_is_open(self, is_open)
set_annot_language(self, lang)
set_annot_line(self, a, b)
set_annot_line_end_style(self, e)
set_annot_line_ending_styles(self, start_style, end_style)
set_annot_line_start_style(self, s)
set_annot_modification_date(self, time)
set_annot_opacity(self, opacity)
set_annot_quad_points(self, n, qv)
set_annot_quadding(self, q)
set_annot_rect(self, rect)
set_annot_vertex(self, i, p)
set_annot_vertices(self, n, v)
set_choice_field_value(self, value)
set_text_field_value(self, value)
set_widget_editing_state(self, editing)
sign_signature(self, signer)
text_widget_format(self)
text_widget_max_len(self)
toggle_widget(self)
update_annot(self)
update_appearance(self)
update_signature_appearance(self, name, text, date)
update_widget(self)
validate_signature(self)
widget_is_signed(self)
widget_type(self)

Static methods defined here:
__swig_destroy__ = delete_PdfAnnot(...)
delete_PdfAnnot(PdfAnnot self)
 
Parameters
----------
self: mupdf::PdfAnnot *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfAnnot_m_internal_get(PdfAnnot self) -> pdf_annot *
 
Parameters
----------
self: mupdf::PdfAnnot *
thisown
The membership flag

 
class PdfCmap(builtins.object)
    PdfCmap(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
add_codespace(self, low, high, n)
cmap_size(self)
cmap_wmode(self)
decode_cmap(self, s, e)
lookup_cmap(self, cpt)
lookup_cmap_full(self, cpt)
map_one_to_many(self, one, len)
map_range_to_range(self, srclo, srchi, dstlo)
set_cmap_wmode(self, wmode)
set_usecmap(self, usecmap)
sort_cmap(self)

Static methods defined here:
__swig_destroy__ = delete_PdfCmap(...)
delete_PdfCmap(PdfCmap self)
 
Parameters
----------
self: mupdf::PdfCmap *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfCmap_m_internal_get(PdfCmap self) -> pdf_cmap
 
Parameters
----------
self: mupdf::PdfCmap *
thisown
The membership flag

 
class PdfCrypt(builtins.object)
    PdfCrypt(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
crypt_encrypt_metadata(self)
crypt_key(self)
crypt_length(self)
crypt_method(self)
crypt_obj(self, obj, num, gen)
crypt_owner_encryption(self)
crypt_owner_password(self)
crypt_permissions(self)
crypt_permissions_encryption(self)
crypt_revision(self)
crypt_user_encryption(self)
crypt_user_password(self)
crypt_version(self)
encrypt_data(self, num, gen, fmt_str_out, arg, s, n)
encrypted_len(self, num, gen, len)

Static methods defined here:
__swig_destroy__ = delete_PdfCrypt(...)
delete_PdfCrypt(PdfCrypt self)
 
Parameters
----------
self: mupdf::PdfCrypt *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfCrypt_m_internal_get(PdfCrypt self) -> pdf_crypt *
 
Parameters
----------
self: mupdf::PdfCrypt *
thisown
The membership flag

 
class PdfCsi(builtins.object)
    PdfCsi(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfCsi(...)
delete_PdfCsi(PdfCsi self)
 
Parameters
----------
self: mupdf::PdfCsi *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfCsi_m_internal_get(PdfCsi self) -> pdf_csi
 
Parameters
----------
self: mupdf::PdfCsi *
thisown
The membership flag

 
class PdfDocEvent(builtins.object)
    PdfDocEvent(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
access_alert_event(self)
access_exec_menu_item_event(self)
access_launch_url_event(self)
access_mail_doc_event(self)

Static methods defined here:
__swig_destroy__ = delete_PdfDocEvent(...)
delete_PdfDocEvent(PdfDocEvent self)
 
Parameters
----------
self: mupdf::PdfDocEvent *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfDocEvent_m_internal_get(PdfDocEvent self) -> pdf_doc_event *
 
Parameters
----------
self: mupdf::PdfDocEvent *
thisown
The membership flag

 
class PdfDocument(builtins.object)
    PdfDocument(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
add_cid_font(self, font)
add_cjk_font(self, font, script, wmode, serif)
add_embedded_file(self, filename, mimetype, contents)
add_image(self, image)
add_new_array(self, initial)
add_new_dict(self, initial)
add_object(self, obj)
add_object_drop(self, obj)
add_page(self, mediabox, rotate, resources, contents)
add_simple_font(self, font, encoding)
add_stream(self, buf, obj, compressed)
authenticate_password(self, pw)
cache_object(self, num)
calculate_form(self)
can_be_saved_incrementally(self)
clear_xref(self)
clear_xref_to_mark(self)
count_layer_config_ui(self)
count_layer_configs(self)
count_objects(self)
count_pages(self)
count_signatures(self)
count_unsaved_versions(self)
count_versions(self)
create_object(self)
delete_object(self, num)
delete_page(self, number)
delete_page_range(self, start, end)
deselect_layer_config_ui(self, ui)
disable_js(self)
doc_was_linearized(self)
document_event_did_print(self)
document_event_did_save(self)
document_event_will_close(self)
document_event_will_print(self)
document_event_will_save(self)
document_language(self)
document_output_intent(self)
document_permissions(self)
empty_store(self)
enable_js(self)
ensure_solid_xref(self, num)
event_issue_alert(self, event)
event_issue_exec_menu_item(self, item)
event_issue_launch_url(self, url, new_frame)
event_issue_mail_doc(self, event)
event_issue_print(self)
field_event_calculate(self, field)
field_event_format(self, field)
field_event_keystroke(self, field, evt)
field_event_validate(self, field, value)
field_reset(self, field)
filter_annot_contents(self, annot, filter)
filter_page_contents(self, page, filter)
find_font_resource(self, type, encoding, item, md5)
find_image_resource(self, item, md5)
find_locked_fields(self, version)
find_locked_fields_for_sig(self, sig)
find_version_for_obj(self, obj)
forget_xref(self)
get_doc_event_callback_data(self)
get_populating_xref_entry(self, i)
get_xref_entry(self, i)
graft_object(self, obj)
has_permission(self, p)
has_unsaved_changes(self)
has_unsaved_sigs(self)
insert_font_resource(self, md5, obj)
insert_image_resource(self, md5, obj)
insert_page(self, at, page)
invalidate_xfa(self)
js_supported(self)
layer_config_info(self, config_num, info)
layer_config_ui_info(self, ui, info)
load_compressed_inline_image(self, dict, length, cstm, indexed, image)
load_compressed_stream(self, num)
load_default_colorspaces(self, page)
load_embedded_cmap(self, ref)
load_font(self, rdb, obj)
load_hail_mary_font(self)
load_image(self, obj)
load_inline_image(self, rdb, dict, file)
load_link_annots(self, annots, pagenum, page_ctm)
load_name_tree(self, which)
load_object(self, num)
load_page(self, number)
load_page_tree(self)
load_pattern(self, obj)
load_raw_stream_number(self, num)
load_shading(self, obj)
load_stream_number(self, num)
load_to_unicode(self, font, OUTPUT, collection, cmapstm)
load_type3_font(self, rdb, obj)
load_type3_glyphs(self, fontdesc)
load_unencrypted_object(self, num)
localise_page_resources(self)
lookup_anchor(self, name)
lookup_dest(self, needle)
lookup_metadata(self, key, ptr, size)
lookup_name(self, which, needle)
lookup_page_number(self, pageobj)
lookup_page_obj(self, needle)
mark_xref(self)
needs_password(self)
new_array(self, initialcap)
new_dict(self, initialcap)
new_filter_processor(self, chain, old_res, new_res, struct_parents, transform, filter)
new_graft_map(self)
new_indirect(self, num, gen)
new_matrix(self, mtx)
new_pdf_device(self, topctm, mediabox, resources, contents)
new_rect(self, rect)
new_xobject(self, bbox, matrix, res, buffer)
obj_num_is_stream(self, num)
open_contents_stream(self, obj)
open_inline_stream(self, stmobj, length, chain, params)
open_raw_stream_number(self, num)
open_stream_number(self, num)
open_stream_with_offset(self, num, dict, stm_ofs)
page_write(self, mediabox, arg3, arg4)
parse_array(self, f, buf)
parse_dict(self, f, buf)
parse_ind_obj(self, f, buf, arg4)
parse_link_action(self, obj, pagenum)
parse_link_dest(self, obj)
parse_stm_obj(self, f, buf)
progressive_advance(self, pagenum)
read_ocg(self)
redact_page(self, page, opts)
repair_obj(self, buf, arg3, arg4, arg5, arg6, arg7, arg8)
repair_obj_stms(self)
repair_xref(self)
replace_xref(self, entries, n)
reset_form(self, fields, exclude)
resolve_link(self, uri)
run_glyph(self, resources, contents, dev, ctm, gstate, default_cs)
run_page_with_usage(self, page, dev, ctm, usage, cookie)
save_document(self, filename, opts)
select_layer_config(self, config_num)
select_layer_config_ui(self, ui)
set_doc_event_callback(self, event_cb, data)
set_document_language(self, lang)
set_field_value(self, field, text, ignore_trigger_events)
set_layer_config_as_default(self)
set_populating_xref_trailer(self, trailer)
signature_byte_range(self, signature, byte_range)
signature_contents(self, signature, OUTPUT)
signature_hash_bytes(self, signature)
signature_incremental_change_since_signing(self, signature)
signature_is_signed(self, field)
signature_set_value(self, field, signer, stime)
toggle_layer_config_ui(self, ui)
trailer(self)
update_object(self, num, obj)
update_stream(self, ref, buf, compressed)
update_xobject(self, xobj, bbox, mat, res, buffer)
validate_change_history(self)
validate_changes(self, version)
version(self)
was_pure_xfa(self)
write_document(self, out, opts)
xref_ensure_incremental_object(self, num)
xref_is_incremental(self, num)
xref_len(self)
xref_obj_is_unsaved_signature(self, obj)
xref_store_unsaved_signature(self, field, signer)

Static methods defined here:
__swig_destroy__ = delete_PdfDocument(...)
delete_PdfDocument(PdfDocument self)
 
Parameters
----------
self: mupdf::PdfDocument *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfDocument_m_internal_get(PdfDocument self) -> pdf_document *
 
Parameters
----------
self: mupdf::PdfDocument *
thisown
The membership flag

 
class PdfFilterOptions(builtins.object)
    PdfFilterOptions(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfFilterOptions(...)
delete_PdfFilterOptions(PdfFilterOptions self)
 
Parameters
----------
self: mupdf::PdfFilterOptions *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfFilterOptions_m_internal_get(PdfFilterOptions self) -> pdf_filter_options
 
Parameters
----------
self: mupdf::PdfFilterOptions *
thisown
The membership flag

 
class PdfFontDesc(builtins.object)
    PdfFontDesc(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
add_hmtx(self, lo, hi, w)
add_vmtx(self, lo, hi, x, y, w)
end_hmtx(self)
end_vmtx(self)
font_cid_to_gid(self, cid)
lookup_hmtx(self, cid)
lookup_vmtx(self, cid)
set_default_hmtx(self, w)
set_default_vmtx(self, y, w)
set_font_wmode(self, wmode)

Static methods defined here:
__swig_destroy__ = delete_PdfFontDesc(...)
delete_PdfFontDesc(PdfFontDesc self)
 
Parameters
----------
self: mupdf::PdfFontDesc *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfFontDesc_m_internal_get(PdfFontDesc self) -> pdf_font_desc
 
Parameters
----------
self: mupdf::PdfFontDesc *
thisown
The membership flag

 
class PdfFunction(builtins.object)
    PdfFunction(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
eval_function(self, inlen, outlen)
function_size(self)

Static methods defined here:
__swig_destroy__ = delete_PdfFunction(...)
delete_PdfFunction(PdfFunction self)
 
Parameters
----------
self: mupdf::PdfFunction *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfFunction_m_internal_get(PdfFunction self) -> pdf_function *
 
Parameters
----------
self: mupdf::PdfFunction *
thisown
The membership flag

 
class PdfGraftMap(builtins.object)
    PdfGraftMap(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
graft_mapped_object(self, obj)

Static methods defined here:
__swig_destroy__ = delete_PdfGraftMap(...)
delete_PdfGraftMap(PdfGraftMap self)
 
Parameters
----------
self: mupdf::PdfGraftMap *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfGraftMap_m_internal_get(PdfGraftMap self) -> pdf_graft_map *
 
Parameters
----------
self: mupdf::PdfGraftMap *
thisown
The membership flag

 
class PdfGstate(builtins.object)
    PdfGstate(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfGstate(...)
delete_PdfGstate(PdfGstate self)
 
Parameters
----------
self: mupdf::PdfGstate *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfGstate_m_internal_get(PdfGstate self) -> pdf_gstate *
 
Parameters
----------
self: mupdf::PdfGstate *
thisown
The membership flag

 
class PdfHintPage(builtins.object)
    PdfHintPage(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfHintPage(...)
delete_PdfHintPage(PdfHintPage self)
 
Parameters
----------
self: mupdf::PdfHintPage *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfHintPage_m_internal_get(PdfHintPage self) -> pdf_hint_page
 
Parameters
----------
self: mupdf::PdfHintPage *
thisown
The membership flag

 
class PdfHintShared(builtins.object)
    PdfHintShared(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfHintShared(...)
delete_PdfHintShared(PdfHintShared self)
 
Parameters
----------
self: mupdf::PdfHintShared *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfHintShared_m_internal_get(PdfHintShared self) -> pdf_hint_shared
 
Parameters
----------
self: mupdf::PdfHintShared *
thisown
The membership flag

 
class PdfHmtx(builtins.object)
    PdfHmtx(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfHmtx(...)
delete_PdfHmtx(PdfHmtx self)
 
Parameters
----------
self: mupdf::PdfHmtx *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfHmtx_m_internal_get(PdfHmtx self) -> pdf_hmtx
 
Parameters
----------
self: mupdf::PdfHmtx *
thisown
The membership flag

 
class PdfJs(builtins.object)
    PdfJs(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
js_event_init(self, target, value, willCommit)
js_event_init_keystroke(self, target, evt)
js_event_result(self)
js_event_result_keystroke(self, evt)
js_event_value(self)
js_execute(self, name, code)

Static methods defined here:
__swig_destroy__ = delete_PdfJs(...)
delete_PdfJs(PdfJs self)
 
Parameters
----------
self: mupdf::PdfJs *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfJs_m_internal_get(PdfJs self) -> pdf_js *
 
Parameters
----------
self: mupdf::PdfJs *
thisown
The membership flag

 
class PdfKeystrokeEvent(builtins.object)
    PdfKeystrokeEvent(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfKeystrokeEvent(...)
delete_PdfKeystrokeEvent(PdfKeystrokeEvent self)
 
Parameters
----------
self: mupdf::PdfKeystrokeEvent *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfKeystrokeEvent_m_internal_get(PdfKeystrokeEvent self) -> pdf_keystroke_event
 
Parameters
----------
self: mupdf::PdfKeystrokeEvent *
thisown
The membership flag

 
class PdfLaunchUrlEvent(builtins.object)
    PdfLaunchUrlEvent(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfLaunchUrlEvent(...)
delete_PdfLaunchUrlEvent(PdfLaunchUrlEvent self)
 
Parameters
----------
self: mupdf::PdfLaunchUrlEvent *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfLaunchUrlEvent_m_internal_get(PdfLaunchUrlEvent self) -> pdf_launch_url_event
 
Parameters
----------
self: mupdf::PdfLaunchUrlEvent *
thisown
The membership flag

 
class PdfLayerConfig(builtins.object)
    PdfLayerConfig(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfLayerConfig(...)
delete_PdfLayerConfig(PdfLayerConfig self)
 
Parameters
----------
self: mupdf::PdfLayerConfig *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfLayerConfig_m_internal_get(PdfLayerConfig self) -> pdf_layer_config
 
Parameters
----------
self: mupdf::PdfLayerConfig *
thisown
The membership flag

 
class PdfLayerConfigUi(builtins.object)
    PdfLayerConfigUi(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfLayerConfigUi(...)
delete_PdfLayerConfigUi(PdfLayerConfigUi self)
 
Parameters
----------
self: mupdf::PdfLayerConfigUi *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfLayerConfigUi_m_internal_get(PdfLayerConfigUi self) -> pdf_layer_config_ui
 
Parameters
----------
self: mupdf::PdfLayerConfigUi *
thisown
The membership flag

 
class PdfLexbuf(builtins.object)
    PdfLexbuf(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
lexbuf_fin(self)
lexbuf_grow(self)
lexbuf_init(self, size)

Static methods defined here:
__swig_destroy__ = delete_PdfLexbuf(...)
delete_PdfLexbuf(PdfLexbuf self)
 
Parameters
----------
self: mupdf::PdfLexbuf *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfLexbuf_m_internal_get(PdfLexbuf self) -> pdf_lexbuf
 
Parameters
----------
self: mupdf::PdfLexbuf *
thisown
The membership flag

 
class PdfLexbufLarge(builtins.object)
    PdfLexbufLarge(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfLexbufLarge(...)
delete_PdfLexbufLarge(PdfLexbufLarge self)
 
Parameters
----------
self: mupdf::PdfLexbufLarge *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfLexbufLarge_m_internal_get(PdfLexbufLarge self) -> pdf_lexbuf_large
 
Parameters
----------
self: mupdf::PdfLexbufLarge *
thisown
The membership flag

 
class PdfLockedFields(builtins.object)
    PdfLockedFields(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
is_field_locked(self, name)

Static methods defined here:
__swig_destroy__ = delete_PdfLockedFields(...)
delete_PdfLockedFields(PdfLockedFields self)
 
Parameters
----------
self: mupdf::PdfLockedFields *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfLockedFields_m_internal_get(PdfLockedFields self) -> pdf_locked_fields *
 
Parameters
----------
self: mupdf::PdfLockedFields *
thisown
The membership flag

 
class PdfMailDocEvent(builtins.object)
    PdfMailDocEvent(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfMailDocEvent(...)
delete_PdfMailDocEvent(PdfMailDocEvent self)
 
Parameters
----------
self: mupdf::PdfMailDocEvent *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfMailDocEvent_m_internal_get(PdfMailDocEvent self) -> pdf_mail_doc_event
 
Parameters
----------
self: mupdf::PdfMailDocEvent *
thisown
The membership flag

 
class PdfMrange(builtins.object)
    PdfMrange(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfMrange(...)
delete_PdfMrange(PdfMrange self)
 
Parameters
----------
self: mupdf::PdfMrange *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfMrange_m_internal_get(PdfMrange self) -> pdf_mrange
 
Parameters
----------
self: mupdf::PdfMrange *
thisown
The membership flag

 
class PdfObj(builtins.object)
    PdfObj(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
array_contains(self, obj)
array_delete(self, index)
array_find(self, obj)
array_get(self, i)
array_get_bool(self, index)
array_get_int(self, index)
array_get_matrix(self, index)
array_get_name(self, index)
array_get_real(self, index)
array_get_rect(self, index)
array_get_string(self, index)
array_get_text_string(self, index)
array_insert(self, obj, index)
array_insert_drop(self, obj, index)
array_len(self)
array_push(self, obj)
array_push_array(self, initial)
array_push_bool(self, x)
array_push_dict(self, initial)
array_push_drop(self, obj)
array_push_int(self, x)
array_push_name(self, x)
array_push_real(self, x)
array_push_string(self, x, n)
array_push_text_string(self, x)
array_put(self, i, obj)
array_put_drop(self, i, obj)
button_field_on_state(self)
choice_field_option(self, exportval, i)
choice_field_option_count(self)
clean_obj(self)
copy_array(self)
copy_dict(self)
debug_obj(self)
debug_ref(self)
deep_copy_obj(self)
dict_del(self, key)
dict_dels(self, key)
dict_get(self, key)
dict_get_bool(self, key)
dict_get_inheritable(self, key)
dict_get_int(self, key)
dict_get_key(self, idx)
dict_get_matrix(self, key)
dict_get_name(self, key)
dict_get_put_drop(self, key, val, OUTPUT)
dict_get_real(self, key)
dict_get_rect(self, key)
dict_get_string(self, key)
dict_get_text_string(self, key)
dict_get_val(self, idx)
dict_geta(self, key, abbrev)
dict_getp(self, path)
dict_gets(self, key)
dict_getsa(self, key, abbrev)
dict_len(self)
dict_put(self, key, val)
dict_put_array(self, key, initial)
dict_put_bool(self, key, x)
dict_put_dict(self, key, initial)
dict_put_drop(self, key, val)
dict_put_int(self, key, x)
dict_put_matrix(self, key, x)
dict_put_name(self, key, x)
dict_put_real(self, key, x)
dict_put_rect(self, key, x)
dict_put_string(self, key, x, n)
dict_put_text_string(self, key, x)
dict_put_val_null(self, idx)
dict_putp(self, path, val)
dict_putp_drop(self, path, val)
dict_puts(self, key, val)
dict_puts_dict(self, key, initial)
dict_puts_drop(self, key, val)
dirty_obj(self)
embedded_file_name(self)
embedded_file_stream(self)
embedded_file_type(self)
field_border_style(self)
field_display(self)
field_flags(self)
field_label(self)
field_name(self)
field_set_border_style(self, text)
field_set_button_caption(self, text)
field_set_display(self, d)
field_set_fill_color(self, col)
field_set_text_color(self, col)
field_type(self)
field_value(self)
filter_xobject_instance(self, page_res, ctm, filter)
flatten_inheritable_page_items(self)
get_bound_document(self)
get_indirect_document(self)
is_array(self)
is_bool(self)
is_dict(self)
is_embedded_file(self)
is_indirect(self)
is_int(self)
is_jpx_image(self)
is_name(self)
is_null(self)
is_number(self)
is_real(self)
is_stream(self)
is_string(self)
line_ending_from_name(self)
load_colorspace(self)
load_embedded_file(self)
load_function(self, _in, out)
load_raw_stream(self)
load_stream(self)
load_stream_or_string_as_utf8(self)
lookup_field(self, name)
lookup_number(self, needle)
mark_obj(self)
name_eq(self, b)
new_crypt(self, id)
new_utf8_from_pdf_stream_obj(self)
new_utf8_from_pdf_string_obj(self)
obj_is_dirty(self)
obj_marked(self)
obj_memo(self, bit)
obj_parent_num(self)
obj_refs(self)
objcmp(self, b)
objcmp_resolve(self, b)
open_raw_stream(self)
open_stream(self)
page_obj_transform(self, page_mediabox, page_ctm)
resolve_indirect(self)
resolve_indirect_chain(self)
set_int(self, i)
set_obj_memo(self, bit, memo)
set_obj_parent(self, num)
set_str_len(self, newlen)
sort_dict(self)
store_item(self, val, itemsize)
to_bool(self)
to_gen(self)
to_int(self)
to_int64(self)
to_matrix(self)
to_name(self)
to_num(self)
to_quad(self, offset)
to_real(self)
to_rect(self)
to_str_buf(self)
to_str_len(self)
to_string(self)
to_text_string(self)
unmark_obj(self)
walk_tree(self, kid_name, arrive, leave, arg, arg6, arg7)
xobject_bbox(self)
xobject_colorspace(self)
xobject_isolated(self)
xobject_knockout(self)
xobject_matrix(self)
xobject_resources(self)
xobject_transparency(self)

Static methods defined here:
__swig_destroy__ = delete_PdfObj(...)
delete_PdfObj(PdfObj self)
 
Parameters
----------
self: mupdf::PdfObj *
new_dict(doc, initialcap)
new_text_string(s)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfObj_m_internal_get(PdfObj self) -> pdf_obj *
 
Parameters
----------
self: mupdf::PdfObj *
thisown
The membership flag

 
class PdfOcgDescriptor(builtins.object)
    PdfOcgDescriptor(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
is_hidden_ocg(self, rdb, usage, ocg)

Static methods defined here:
__swig_destroy__ = delete_PdfOcgDescriptor(...)
delete_PdfOcgDescriptor(PdfOcgDescriptor self)
 
Parameters
----------
self: mupdf::PdfOcgDescriptor *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfOcgDescriptor_m_internal_get(PdfOcgDescriptor self) -> pdf_ocg_descriptor *
 
Parameters
----------
self: mupdf::PdfOcgDescriptor *
thisown
The membership flag

 
class PdfPage(builtins.object)
    PdfPage(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
bound_page(self)
create_annot(self, type)
create_annot_raw(self, type)
delete_annot(self, annot)
first_annot(self)
first_widget(self)
load_annots(self, annots)
load_links(self)
page_contents(self)
page_event_close(self)
page_event_open(self)
page_group(self)
page_presentation(self, transition)
page_resources(self)
page_separations(self)
page_transform(self, mediabox, ctm)
run_page(self, dev, ctm, cookie)
run_page_annots(self, dev, ctm, cookie)
run_page_contents(self, dev, ctm, cookie)
run_page_widgets(self, dev, ctm, cookie)
update_page(self)

Static methods defined here:
__swig_destroy__ = delete_PdfPage(...)
delete_PdfPage(PdfPage self)
 
Parameters
----------
self: mupdf::PdfPage *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfPage_m_internal_get(PdfPage self) -> pdf_page *
 
Parameters
----------
self: mupdf::PdfPage *
thisown
The membership flag

 
class PdfPattern(builtins.object)
    PdfPattern(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfPattern(...)
delete_PdfPattern(PdfPattern self)
 
Parameters
----------
self: mupdf::PdfPattern *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfPattern_m_internal_get(PdfPattern self) -> pdf_pattern
 
Parameters
----------
self: mupdf::PdfPattern *
thisown
The membership flag

 
class PdfPkcs7DesignatedName(builtins.object)
    PdfPkcs7DesignatedName(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
signature_drop_designated_name(self)
signature_format_designated_name(self)

Static methods defined here:
__swig_destroy__ = delete_PdfPkcs7DesignatedName(...)
delete_PdfPkcs7DesignatedName(PdfPkcs7DesignatedName self)
 
Parameters
----------
self: mupdf::PdfPkcs7DesignatedName *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfPkcs7DesignatedName_m_internal_get(PdfPkcs7DesignatedName self) -> pdf_pkcs7_designated_name
 
Parameters
----------
self: mupdf::PdfPkcs7DesignatedName *
thisown
The membership flag

 
class PdfPkcs7Signer(builtins.object)
    PdfPkcs7Signer(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfPkcs7Signer(...)
delete_PdfPkcs7Signer(PdfPkcs7Signer self)
 
Parameters
----------
self: mupdf::PdfPkcs7Signer *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfPkcs7Signer_m_internal_get(PdfPkcs7Signer self) -> pdf_pkcs7_signer *
 
Parameters
----------
self: mupdf::PdfPkcs7Signer *
thisown
The membership flag

 
class PdfPkcs7Verifier(builtins.object)
    PdfPkcs7Verifier(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
check_certificate(self, doc, signature)
check_digest(self, doc, signature)
check_signature(self, doc, signature, ebuf, ebufsize)
signature_get_signatory(self, doc, signature)

Static methods defined here:
__swig_destroy__ = delete_PdfPkcs7Verifier(...)
delete_PdfPkcs7Verifier(PdfPkcs7Verifier self)
 
Parameters
----------
self: mupdf::PdfPkcs7Verifier *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfPkcs7Verifier_m_internal_get(PdfPkcs7Verifier self) -> pdf_pkcs7_verifier *
 
Parameters
----------
self: mupdf::PdfPkcs7Verifier *
thisown
The membership flag

 
class PdfProcessor(builtins.object)
    PdfProcessor(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
close_processor(self)
process_annot(self, doc, page, annot, cookie)
process_contents(self, doc, obj, res, cookie)
process_glyph(self, doc, resources, contents)

Static methods defined here:
__swig_destroy__ = delete_PdfProcessor(...)
delete_PdfProcessor(PdfProcessor self)
 
Parameters
----------
self: mupdf::PdfProcessor *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfProcessor_m_internal_get(PdfProcessor self) -> pdf_processor *
 
Parameters
----------
self: mupdf::PdfProcessor *
thisown
The membership flag

 
class PdfRange(builtins.object)
    PdfRange(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfRange(...)
delete_PdfRange(PdfRange self)
 
Parameters
----------
self: mupdf::PdfRange *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfRange_m_internal_get(PdfRange self) -> pdf_range
 
Parameters
----------
self: mupdf::PdfRange *
thisown
The membership flag

 
class PdfRedactOptions(builtins.object)
    PdfRedactOptions(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfRedactOptions(...)
delete_PdfRedactOptions(PdfRedactOptions self)
 
Parameters
----------
self: mupdf::PdfRedactOptions *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfRedactOptions_m_internal_get(PdfRedactOptions self) -> pdf_redact_options
 
Parameters
----------
self: mupdf::PdfRedactOptions *
thisown
The membership flag

 
class PdfRevPageMap(builtins.object)
    PdfRevPageMap(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfRevPageMap(...)
delete_PdfRevPageMap(PdfRevPageMap self)
 
Parameters
----------
self: mupdf::PdfRevPageMap *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfRevPageMap_m_internal_get(PdfRevPageMap self) -> pdf_rev_page_map
 
Parameters
----------
self: mupdf::PdfRevPageMap *
thisown
The membership flag

 
class PdfTextObjectState(builtins.object)
    PdfTextObjectState(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
tos_get_text(self)
tos_make_trm(self, text, fontdesc, cid, trm)
tos_move_after_char(self)
tos_newline(self, leading)
tos_reset(self, render)
tos_set_matrix(self, a, b, c, d, e, f)
tos_translate(self, tx, ty)

Static methods defined here:
__swig_destroy__ = delete_PdfTextObjectState(...)
delete_PdfTextObjectState(PdfTextObjectState self)
 
Parameters
----------
self: mupdf::PdfTextObjectState *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfTextObjectState_m_internal_get(PdfTextObjectState self) -> pdf_text_object_state
 
Parameters
----------
self: mupdf::PdfTextObjectState *
thisown
The membership flag

 
class PdfTextState(builtins.object)
    PdfTextState(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfTextState(...)
delete_PdfTextState(PdfTextState self)
 
Parameters
----------
self: mupdf::PdfTextState *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfTextState_m_internal_get(PdfTextState self) -> pdf_text_state
 
Parameters
----------
self: mupdf::PdfTextState *
thisown
The membership flag

 
class PdfUnsavedSig(builtins.object)
    PdfUnsavedSig(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfUnsavedSig(...)
delete_PdfUnsavedSig(PdfUnsavedSig self)
 
Parameters
----------
self: mupdf::PdfUnsavedSig *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfUnsavedSig_m_internal_get(PdfUnsavedSig self) -> pdf_unsaved_sig
 
Parameters
----------
self: mupdf::PdfUnsavedSig *
thisown
The membership flag

 
class PdfVmtx(builtins.object)
    PdfVmtx(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfVmtx(...)
delete_PdfVmtx(PdfVmtx self)
 
Parameters
----------
self: mupdf::PdfVmtx *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfVmtx_m_internal_get(PdfVmtx self) -> pdf_vmtx
 
Parameters
----------
self: mupdf::PdfVmtx *
thisown
The membership flag

 
class PdfWriteOptions(builtins.object)
    PdfWriteOptions(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
internal(self, *args)
parse_write_options(self, args)

Static methods defined here:
__swig_destroy__ = delete_PdfWriteOptions(...)
delete_PdfWriteOptions(PdfWriteOptions self)
 
Parameters
----------
self: mupdf::PdfWriteOptions *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
do_appearance
PdfWriteOptions_do_appearance_get(PdfWriteOptions self) -> int
 
Parameters
----------
self: mupdf::PdfWriteOptions *
do_ascii
PdfWriteOptions_do_ascii_get(PdfWriteOptions self) -> int
 
Parameters
----------
self: mupdf::PdfWriteOptions *
do_clean
PdfWriteOptions_do_clean_get(PdfWriteOptions self) -> int
 
Parameters
----------
self: mupdf::PdfWriteOptions *
do_compress
PdfWriteOptions_do_compress_get(PdfWriteOptions self) -> int
 
Parameters
----------
self: mupdf::PdfWriteOptions *
do_compress_fonts
PdfWriteOptions_do_compress_fonts_get(PdfWriteOptions self) -> int
 
Parameters
----------
self: mupdf::PdfWriteOptions *
do_compress_images
PdfWriteOptions_do_compress_images_get(PdfWriteOptions self) -> int
 
Parameters
----------
self: mupdf::PdfWriteOptions *
do_decompress
PdfWriteOptions_do_decompress_get(PdfWriteOptions self) -> int
 
Parameters
----------
self: mupdf::PdfWriteOptions *
do_encrypt
PdfWriteOptions_do_encrypt_get(PdfWriteOptions self) -> int
 
Parameters
----------
self: mupdf::PdfWriteOptions *
do_garbage
PdfWriteOptions_do_garbage_get(PdfWriteOptions self) -> int
 
Parameters
----------
self: mupdf::PdfWriteOptions *
do_incremental
PdfWriteOptions_do_incremental_get(PdfWriteOptions self) -> int
 
Parameters
----------
self: mupdf::PdfWriteOptions *
do_linear
PdfWriteOptions_do_linear_get(PdfWriteOptions self) -> int
 
Parameters
----------
self: mupdf::PdfWriteOptions *
do_pretty
PdfWriteOptions_do_pretty_get(PdfWriteOptions self) -> int
 
Parameters
----------
self: mupdf::PdfWriteOptions *
do_sanitize
PdfWriteOptions_do_sanitize_get(PdfWriteOptions self) -> int
 
Parameters
----------
self: mupdf::PdfWriteOptions *
opwd_utf8
PdfWriteOptions_opwd_utf8_get(PdfWriteOptions self) -> char [128]
 
Parameters
----------
self: mupdf::PdfWriteOptions *
permissions
PdfWriteOptions_permissions_get(PdfWriteOptions self) -> int
 
Parameters
----------
self: mupdf::PdfWriteOptions *
thisown
The membership flag
upwd_utf8
PdfWriteOptions_upwd_utf8_get(PdfWriteOptions self) -> char [128]
 
Parameters
----------
self: mupdf::PdfWriteOptions *

 
class PdfXfa(builtins.object)
    PdfXfa(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfXfa(...)
delete_PdfXfa(PdfXfa self)
 
Parameters
----------
self: mupdf::PdfXfa *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfXfa_m_internal_get(PdfXfa self) -> pdf_xfa
 
Parameters
----------
self: mupdf::PdfXfa *
thisown
The membership flag

 
class PdfXfaEntry(builtins.object)
    PdfXfaEntry(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfXfaEntry(...)
delete_PdfXfaEntry(PdfXfaEntry self)
 
Parameters
----------
self: mupdf::PdfXfaEntry *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfXfaEntry_m_internal_get(PdfXfaEntry self) -> pdf_xfa_entry
 
Parameters
----------
self: mupdf::PdfXfaEntry *
thisown
The membership flag

 
class PdfXrange(builtins.object)
    PdfXrange(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfXrange(...)
delete_PdfXrange(PdfXrange self)
 
Parameters
----------
self: mupdf::PdfXrange *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfXrange_m_internal_get(PdfXrange self) -> pdf_xrange
 
Parameters
----------
self: mupdf::PdfXrange *
thisown
The membership flag

 
class PdfXref(builtins.object)
    PdfXref(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfXref(...)
delete_PdfXref(PdfXref self)
 
Parameters
----------
self: mupdf::PdfXref *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfXref_m_internal_get(PdfXref self) -> pdf_xref *
 
Parameters
----------
self: mupdf::PdfXref *
thisown
The membership flag

 
class PdfXrefEntry(builtins.object)
    PdfXrefEntry(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfXrefEntry(...)
delete_PdfXrefEntry(PdfXrefEntry self)
 
Parameters
----------
self: mupdf::PdfXrefEntry *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfXrefEntry_m_internal_get(PdfXrefEntry self) -> pdf_xref_entry
 
Parameters
----------
self: mupdf::PdfXrefEntry *
thisown
The membership flag

 
class PdfXrefSubsec(builtins.object)
    PdfXrefSubsec(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_PdfXrefSubsec(...)
delete_PdfXrefSubsec(PdfXrefSubsec self)
 
Parameters
----------
self: mupdf::PdfXrefSubsec *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PdfXrefSubsec_m_internal_get(PdfXrefSubsec self) -> pdf_xref_subsec
 
Parameters
----------
self: mupdf::PdfXrefSubsec *
thisown
The membership flag

 
class Pixmap(builtins.object)
    Pixmap(*args)
 
Pixmaps represent a set of pixels for a 2 dimensional region of
a plane. Each pixel has n components per pixel. The components
are in the order process-components, spot-colors, alpha, where
there can be 0 of any of those types. The data is in
premultiplied alpha when rendering, but non-premultiplied for
colorspace conversions and rescaling.
 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
alpha(self)
alpha_from_gray(self)
clear_pixmap(self)
Sets all components (including alpha) of
all pixels in a pixmap to 0.
 
pix: The pixmap to clear.
clear_pixmap_rect_with_value(self, value, r)
Clears a subrect of a pixmap with the given value.
 
pix: The pixmap to clear.
 
value: Values in the range 0 to 255 are valid. Each component
sample for each pixel in the pixmap will be set to this value,
while alpha will always be set to 255 (non-transparent).
 
r: the rectangle.
clear_pixmap_with_value(self, value)
Clears a pixmap with the given value.
 
pix: The pixmap to clear.
 
value: Values in the range 0 to 255 are valid. Each component
sample for each pixel in the pixmap will be set to this value,
while alpha will always be set to 255 (non-transparent).
 
This function is horrible, and should be removed from the
API and replaced with a less magic one.
clone_pixmap(self)
Clone a pixmap, copying the pixels and associated data to new
storage.
 
The reference count of 'old' is unchanged.
colorspace(self)
convert_indexed_pixmap_to_base(self)
Convert pixmap from indexed to base colorspace.
 
This creates a new bitmap containing the converted pixmap data.
convert_pixmap(self, cs_des, prf, default_cs, color_params, keep_alpha)
Convert an existing pixmap to a desired
colorspace. Other properties of the pixmap, such as resolution
and position are copied to the converted pixmap.
 
pix: The pixmap to convert.
 
default_cs: If NULL pix->colorspace is used. It is possible that
the data may need to be interpreted as one of the color spaces
in default_cs.
 
cs_des: Desired colorspace, may be NULL to denote alpha-only.
 
prf: Proofing color space through which we need to convert.
 
color_params: Parameters that may be used in conversion (e.g.
ri).
 
keep_alpha: If 0 any alpha component is removed, otherwise
alpha is kept if present in the pixmap.
convert_separation_pixmap_to_base(self)
Convert pixmap from DeviceN/Separation to base colorspace.
 
This creates a new bitmap containing the converted pixmap data.
decode_tile(self)
fill_pixmap_with_color(self, colorspace, color_params)
Fill pixmap with solid color.
flags(self)
gamma_pixmap(self, gamma)
Apply gamma correction to a pixmap. All components
of all pixels are modified (except alpha, which is unchanged).
 
gamma: The gamma value to apply; 1.0 for no change.
generate_transition(self, opix, npix, time, trans)
Generate a frame of a transition.
 
tpix: Target pixmap
opix: Old pixmap
npix: New pixmap
time: Position within the transition (0 to 256)
trans: Transition details
 
Returns 1 if successfully generated a frame.
 
Note: Pixmaps must include alpha.
h(self)
invert_pixmap(self)
Invert all the pixels in a pixmap. All components (process and
spots) of all pixels are inverted (except alpha, which is
unchanged).
invert_pixmap_luminance(self)
Transform the pixels in a pixmap so that luminance of each
pixel is inverted, and the chrominance remains unchanged (as
much as accuracy allows).
 
All components of all pixels are inverted (except alpha, which
is unchanged). Only supports Grey and RGB bitmaps.
invert_pixmap_rect(self, rect)
Invert all the pixels in a given rectangle of a
pixmap. All components of all pixels in the rectangle are
inverted (except alpha, which is unchanged).
is_pixmap_monochrome(self)
Check if the pixmap is a 1-channel image containing samples with
only values 0 and 255
md5_pixmap(self)
n(self)
new_bitmap_from_pixmap(self, ht)
Make a bitmap from a pixmap and a halftone.
 
pix: The pixmap to generate from. Currently must be a single
color component with no alpha.
 
ht: The halftone to use. NULL implies the default halftone.
 
Returns the resultant bitmap. Throws exceptions in the case of
failure to allocate.
new_bitmap_from_pixmap_band(self, ht, band_start)
Make a bitmap from a pixmap and a
halftone, allowing for the position of the pixmap within an
overall banded rendering.
 
pix: The pixmap to generate from. Currently must be a single
color component with no alpha.
 
ht: The halftone to use. NULL implies the default halftone.
 
band_start: Vertical offset within the overall banded rendering
(in pixels)
 
Returns the resultant bitmap. Throws exceptions in the case of
failure to allocate.
new_buffer_from_pixmap_as_png(self, color_params)
Reencode a given pixmap as a PNG into a buffer.
 
Ownership of the buffer is returned.
new_image_from_pixmap(self, mask)
Create an image from the given
pixmap.
 
pixmap: The pixmap to base the image upon. A new reference
to this is taken.
 
mask: NULL, or another image to use as a mask for this one.
A new reference is taken to this image. Supplying a masked
image as a mask to another image is illegal!
new_pixmap_from_pixmap(self, rect)
Create a new pixmap that represents a subarea of the specified
pixmap. A reference is taken to this pixmap that will be dropped
on destruction.
 
The supplied rectangle must be wholly contained within the
original pixmap.
 
Returns a pointer to the new pixmap. Throws exception on failure
to allocate.
pixmap_alpha(self)
Return the number of alpha planes in a pixmap.
 
Returns the number of alphas. Does not throw exceptions.
pixmap_bbox(self)
Return the bounding box for a pixmap.
pixmap_colorants(self)
Return the number of colorants in a pixmap.
 
Returns the number of colorants (components, less any spots and
alpha).
pixmap_colorspace(self)
Return the colorspace of a pixmap
 
Returns colorspace.
pixmap_components(self)
Return the number of components in a pixmap.
 
Returns the number of components (including spots and alpha).
pixmap_height(self)
Return the height of the pixmap in pixels.
pixmap_samples(self)
Returns a pointer to the pixel data of a pixmap.
 
Returns the pointer.
pixmap_spots(self)
Return the number of spots in a pixmap.
 
Returns the number of spots (components, less colorants and
alpha). Does not throw exceptions.
pixmap_stride(self)
Return the number of bytes in a row in the pixmap.
pixmap_width(self)
Return the width of the pixmap in pixels.
pixmap_x(self)
Return the x value of the pixmap in pixels.
pixmap_y(self)
Return the y value of the pixmap in pixels.
s(self)
samples(self)
save_pixmap_as_pam(self, filename)
Save a pixmap as a pnm (greyscale, rgb or cmyk, with or without
alpha).
save_pixmap_as_pbm(self, filename)
Save a pixmap as a pbm. (Performing halftoning).
save_pixmap_as_pcl(self, filename, append, pcl)
Save an (RGB) pixmap as color PCL.
save_pixmap_as_pclm(self, filename, append, options)
Save a (Greyscale or RGB) pixmap as pclm.
save_pixmap_as_pkm(self, filename)
Save a CMYK pixmap as a pkm. (Performing halftoning).
save_pixmap_as_png(self, filename)
Save a (Greyscale or RGB) pixmap as a png.
save_pixmap_as_pnm(self, filename)
Save a pixmap as a pnm (greyscale or rgb, no alpha).
save_pixmap_as_ps(self, filename, append)
Save a (gray, rgb, or cmyk, no alpha) pixmap out as postscript.
save_pixmap_as_psd(self, filename)
Save a pixmap as a PSD file.
save_pixmap_as_pwg(self, filename, append, pwg)
Save a pixmap as a PWG.
seps(self)
set_pixmap_resolution(self, xres, yres)
Set the pixels per inch resolution of the pixmap.
storable(self)
stride(self)
tint_pixmap(self, black, white)
Tint all the pixels in an RGB, BGR, or Gray pixmap.
 
black: Map black to this hexadecimal RGB color.
 
white: Map white to this hexadecimal RGB color.
underlying(self)
w(self)
x(self)
xres(self)
y(self)
yres(self)

Static methods defined here:
__swig_destroy__ = delete_Pixmap(...)
delete_Pixmap(Pixmap self)
 
Parameters
----------
self: mupdf::Pixmap *
new_pixmap_from_page_contents(page, ctm, cs, alpha)
Render the page contents without annotations.
 
Ownership of the pixmap is returned to the caller.
new_pixmap_from_page_contents_with_separations(page, ctm, cs, seps, alpha)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Pixmap_m_internal_get(Pixmap self) -> fz_pixmap *
 
Parameters
----------
self: mupdf::Pixmap *
thisown
The membership flag

 
class PixmapImage(builtins.object)
    PixmapImage(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
pixmap_image_tile(self)
Retrieve the underlying fz_pixmap for an image.
 
Returns a pointer to the underlying fz_pixmap for an image,
or NULL if this image is not based upon an fz_pixmap.
 
No reference is returned. Lifespan is limited to that of
the image itself. If required, use fz_keep_pixmap to take
a reference to keep it longer.
set_pixmap_image_tile(self, pix)

Static methods defined here:
__swig_destroy__ = delete_PixmapImage(...)
delete_PixmapImage(PixmapImage self)
 
Parameters
----------
self: mupdf::PixmapImage *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PixmapImage_m_internal_get(PixmapImage self) -> fz_pixmap_image *
 
Parameters
----------
self: mupdf::PixmapImage *
thisown
The membership flag

 
class Point(builtins.object)
    Point(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
internal(self, *args)
is_point_inside_quad(self, q)
Inclusion test for quads.
is_point_inside_rect(self, r)
Inclusion test for rects.
normalize_vector(self)
Normalize a vector to length one.
transform(self, m)
transform_point(self, *args)
*Overload 1:*
 
                Apply a transformation to a point.
 
                transform: Transformation matrix to apply. See fz_concat,
                fz_scale, fz_rotate and fz_translate for how to create a
                matrix.
 
                point: Pointer to point to update.
 
                Returns transform (unchanged).
 
 
|
 
*Overload 2:*
 
                Apply a transformation to a point.
 
                transform: Transformation matrix to apply. See fz_concat,
                fz_scale, fz_rotate and fz_translate for how to create a
                matrix.
 
                point: Pointer to point to update.
 
                Returns transform (unchanged).
transform_vector(self, *args)
*Overload 1:*
 
                Apply a transformation to a vector.
 
                transform: Transformation matrix to apply. See fz_concat,
                fz_scale and fz_rotate for how to create a matrix. Any
                translation will be ignored.
 
                vector: Pointer to vector to update.
 
 
|
 
*Overload 2:*
 
                Apply a transformation to a vector.
 
                transform: Transformation matrix to apply. See fz_concat,
                fz_scale and fz_rotate for how to create a matrix. Any
                translation will be ignored.
 
                vector: Pointer to vector to update.

Static methods defined here:
__swig_destroy__ = delete_Point(...)
delete_Point(Point self)
 
Parameters
----------
self: mupdf::Point *
transform_point_xy(x, y, m)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag
x
Point_x_get(Point self) -> float
 
Parameters
----------
self: mupdf::Point *
y
Point_y_get(Point self) -> float
 
Parameters
----------
self: mupdf::Point *

 
class Pool(builtins.object)
    Pool(*args)
 
Simple pool allocators.
 
Allocate from the pool, which can then be freed at once.
 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
pool_alloc(self, size)
Allocate a block of size bytes from the pool.
pool_size(self)
The current size of the pool.
 
The number of bytes of storage currently allocated to the pool.
This is the total of the storage used for the blocks making
up the pool, rather then total of the allocated blocks so far,
so it will increase in 'lumps'.
from the pool, then the pool size may still be X
pool_strdup(self, s)
strdup equivalent allocating from the pool.

Static methods defined here:
__swig_destroy__ = delete_Pool(...)
delete_Pool(Pool self)
 
Parameters
----------
self: mupdf::Pool *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Pool_m_internal_get(Pool self) -> fz_pool *
 
Parameters
----------
self: mupdf::Pool *
thisown
The membership flag

 
class PwgOptions(builtins.object)
    PwgOptions(internal)
 

 
  Methods defined here:
PageSize(self)
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
advance_distance(self)
advance_media(self)
collate(self)
compression(self)
cut_media(self)
duplex(self)
insert_sheet(self)
jog(self)
leading_edge(self)
manual_feed(self)
media_class(self)
media_color(self)
media_position(self)
media_type(self)
media_type_num(self)
media_weight(self)
mirror_print(self)
negative_print(self)
num_copies(self)
orientation(self)
output_face_up(self)
output_type(self)
page_size_name(self)
rendering_intent(self)
row_count(self)
row_feed(self)
row_step(self)
separations(self)
tray_switch(self)
tumble(self)

Static methods defined here:
__swig_destroy__ = delete_PwgOptions(...)
delete_PwgOptions(PwgOptions self)
 
Parameters
----------
self: mupdf::PwgOptions *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
PwgOptions_m_internal_get(PwgOptions self) -> fz_pwg_options
 
Parameters
----------
self: mupdf::PwgOptions *
thisown
The membership flag

 
class Quad(builtins.object)
    Quad(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
internal(self, *args)
is_quad_inside_quad(self, haystack)
Inclusion test for quad in quad.
 
This may break down if quads are not 'well formed'.
is_quad_intersecting_quad(self, b)
Intersection test for quads.
 
This may break down if quads are not 'well formed'.
rect_from_quad(self)
Convert a quad to the smallest rect that covers it.
transform_quad(self, m)
Transform a quad by a matrix.

Static methods defined here:
__swig_destroy__ = delete_Quad(...)
delete_Quad(Quad self)
 
Parameters
----------
self: mupdf::Quad *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
ll
Quad_ll_get(Quad self) -> fz_point
 
Parameters
----------
self: mupdf::Quad *
lr
Quad_lr_get(Quad self) -> fz_point
 
Parameters
----------
self: mupdf::Quad *
thisown
The membership flag
ul
Quad_ul_get(Quad self) -> fz_point
 
Parameters
----------
self: mupdf::Quad *
ur
Quad_ur_get(Quad self) -> fz_point
 
Parameters
----------
self: mupdf::Quad *

 
class Range(builtins.object)
    Range(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_Range(...)
delete_Range(Range self)
 
Parameters
----------
self: mupdf::Range *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Range_m_internal_get(Range self) -> fz_range
 
Parameters
----------
self: mupdf::Range *
thisown
The membership flag

 
class Rect(builtins.object)
    Rect(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
adjust_rect_for_stroke(self, stroke, ctm)
Given a rectangle (assumed to be the bounding box for a path),
expand it to allow for the expansion of the bbox that would be
seen by stroking the path with the given stroke state and
transform.
contains(self, *args)
contains_rect(self, b)
Test rectangle inclusion.
 
Return true if a entirely contains b.
expand_rect(self, expand)
Expand a bbox by a given amount in all directions.
include_point_in_rect(self, p)
Expand a bbox to include a given point.
To create a rectangle that encompasses a sequence of points, the
rectangle must first be set to be the empty rectangle at one of
the points before including the others.
internal(self, *args)
intersect_rect(self, *args)
*Overload 1:*
 
                Compute intersection of two rectangles.
 
                Given two rectangles, update the first to be the smallest
                axis-aligned rectangle that covers the area covered by both
                given rectangles. If either rectangle is empty then the
                intersection is also empty. If either rectangle is infinite
                then the intersection is simply the non-infinite rectangle.
                Should both rectangles be infinite, then the intersection is
                also infinite.
 
 
|
 
*Overload 2:*
 
                Compute intersection of two rectangles.
 
                Given two rectangles, update the first to be the smallest
                axis-aligned rectangle that covers the area covered by both
                given rectangles. If either rectangle is empty then the
                intersection is also empty. If either rectangle is infinite
                then the intersection is simply the non-infinite rectangle.
                Should both rectangles be infinite, then the intersection is
                also infinite.
irect_from_rect(self)
Convert a rect into the minimal bounding box
that covers the rectangle.
 
Coordinates in a bounding box are integers, so rounding of the
rects coordinates takes place. The top left corner is rounded
upwards and left while the bottom right corner is rounded
downwards and to the right.
is_empty(self)
is_empty_rect(self)
Check if rectangle is empty.
 
An empty rectangle is defined as one whose area is zero.
is_infinite_rect(self)
Check if rectangle is infinite.
 
An infinite rectangle is defined as one where either of the
two relationships between corner coordinates are not true.
new_bbox_device(self)
Create a device to compute the bounding
box of all marks on a page.
 
The returned bounding box will be the union of all bounding
boxes of all objects on a page.
new_display_list(self)
Create an empty display list.
 
A display list contains drawing commands (text, images, etc.).
Use fz_new_list_device for populating the list.
 
mediabox: Bounds of the page (in points) represented by the
display list.
new_link(self, doc, uri)
Create a new link record.
 
next is set to NULL with the expectation that the caller will
handle the linked list setup.
quad_from_rect(self)
Convert a rect to a quad (losslessly).
round_rect(self)
Round rectangle coordinates.
 
Coordinates in a bounding box are integers, so rounding of the
rects coordinates takes place. The top left corner is rounded
upwards and left while the bottom right corner is rounded
downwards and to the right.
 
This differs from fz_irect_from_rect, in that fz_irect_from_rect
slavishly follows the numbers (i.e any slight over/under
calculations can cause whole extra pixels to be added).
fz_round_rect allows for a small amount of rounding error when
calculating the bbox.
transform(self, m)
transform_page(self, resolution, rotate)
Create transform matrix to draw page
at a given resolution and rotation. Adjusts the scaling
factors so that the page covers whole number of
pixels and adjust the page origin to be at 0,0.
transform_rect(self, m)
Apply a transform to a rectangle.
 
After the four corner points of the axis-aligned rectangle
have been transformed it may not longer be axis-aligned. So a
new axis-aligned rectangle is created covering at least the
area of the transformed rectangle.
 
transform: Transformation matrix to apply. See fz_concat,
fz_scale and fz_rotate for how to create a matrix.
 
rect: Rectangle to be transformed. The two special cases
fz_empty_rect and fz_infinite_rect, may be used but are
returned unchanged as expected.
translate_rect(self, xoff, yoff)
Translate bounding box.
 
Translate a bbox by a given x and y offset. Allows for overflow.
union_(self, rhs)
union_rect(self, *args)
*Overload 1:*
 
                Compute union of two rectangles.
 
                Given two rectangles, update the first to be the smallest
                axis-aligned rectangle that encompasses both given rectangles.
                If either rectangle is infinite then the union is also infinite.
                If either rectangle is empty then the union is simply the
                non-empty rectangle. Should both rectangles be empty, then the
                union is also empty.
 
 
|
 
*Overload 2:*
 
                Compute union of two rectangles.
 
                Given two rectangles, update the first to be the smallest
                axis-aligned rectangle that encompasses both given rectangles.
                If either rectangle is infinite then the union is also infinite.
                If either rectangle is empty then the union is simply the
                non-empty rectangle. Should both rectangles be empty, then the
                union is also empty.

Static methods defined here:
__swig_destroy__ = delete_Rect(...)
delete_Rect(Rect self)
 
Parameters
----------
self: mupdf::Rect *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag
x0
Rect_x0_get(Rect self) -> float
 
Parameters
----------
self: mupdf::Rect *
x1
Rect_x1_get(Rect self) -> float
 
Parameters
----------
self: mupdf::Rect *
y0
Rect_y0_get(Rect self) -> float
 
Parameters
----------
self: mupdf::Rect *
y1
Rect_y1_get(Rect self) -> float
 
Parameters
----------
self: mupdf::Rect *

Data and other attributes defined here:
Fixed_EMPTY = 1
Fixed_INFINITE = 2
Fixed_UNIT = 0

 
class Separations(builtins.object)
    Separations(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
add_separation(self, name, cs, cs_channel)
Add a separation (null terminated name, colorspace)
add_separation_equivalents(self, rgba, cmyk, name)
Add a separation with equivalents (null terminated name,
colorspace)
 
(old, deprecated)
clone_separations_for_overprint(self)
Return a separations object with all the spots in the input
separations object that are set to composite, reset to be
enabled. If there ARE no spots in the object, this returns
NULL. If the object already has all its spots enabled, then
just returns another handle on the same object.
count_active_separations(self)
Return the number of active separations.
count_separations(self)
separation_current_behavior(self, separation)
Test for the current behavior of a separation.
separation_equivalent(self, idx, dst_cs, prf, color_params)
Get the equivalent separation color in a given colorspace.
separation_name(self, separation)
set_separation_behavior(self, separation, behavior)
Control the rendering of a given separation.

Static methods defined here:
__swig_destroy__ = delete_Separations(...)
delete_Separations(Separations self)
 
Parameters
----------
self: mupdf::Separations *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Separations_m_internal_get(Separations self) -> fz_separations *
 
Parameters
----------
self: mupdf::Separations *
thisown
The membership flag

 
class Sha256(builtins.object)
    Sha256(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
sha256_final(self, digest)
MD5 finalization. Ends an MD5 message-digest operation, writing
the message digest and zeroizing the context.
 
Never throws an exception.
sha256_init(self)
SHA256 initialization. Begins an SHA256 operation, initialising
the supplied context.
 
Never throws an exception.
sha256_update(self, input, inlen)
SHA256 block update operation. Continues an SHA256 message-
digest operation, processing another message block, and updating
the context.
 
Never throws an exception.

Static methods defined here:
__swig_destroy__ = delete_Sha256(...)
delete_Sha256(Sha256 self)
 
Parameters
----------
self: mupdf::Sha256 *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Sha256_m_internal_get(Sha256 self) -> fz_sha256
 
Parameters
----------
self: mupdf::Sha256 *
thisown
The membership flag

 
class Sha512(builtins.object)
    Sha512(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
sha384_final(self, digest)
SHA384 finalization. Ends an SHA384 message-digest operation,
writing the message digest and zeroizing the context.
 
Never throws an exception.
sha384_init(self)
SHA384 initialization. Begins an SHA384 operation, initialising
the supplied context.
 
Never throws an exception.
sha384_update(self, input, inlen)
SHA384 block update operation. Continues an SHA384 message-
digest operation, processing another message block, and updating
the context.
 
Never throws an exception.
sha512_final(self, digest)
SHA512 finalization. Ends an SHA512 message-digest operation,
writing the message digest and zeroizing the context.
 
Never throws an exception.
sha512_init(self)
SHA512 initialization. Begins an SHA512 operation, initialising
the supplied context.
 
Never throws an exception.
sha512_update(self, input, inlen)
SHA512 block update operation. Continues an SHA512 message-
digest operation, processing another message block, and updating
the context.
 
Never throws an exception.

Static methods defined here:
__swig_destroy__ = delete_Sha512(...)
delete_Sha512(Sha512 self)
 
Parameters
----------
self: mupdf::Sha512 *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Sha512_m_internal_get(Sha512 self) -> fz_sha512
 
Parameters
----------
self: mupdf::Sha512 *
thisown
The membership flag

 
class Shade(builtins.object)
    Shade(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
bound_shade(self, ctm)
Bound a given shading.
 
shade: The shade to bound.
 
ctm: The transform to apply to the shade before bounding.
 
r: Pointer to storage to put the bounds in.
 
Returns r, updated to contain the bounds for the shading.
paint_shade(self, override_cs, ctm, dest, color_params, bbox, eop)
Render a shade to a given pixmap.
 
shade: The shade to paint.
 
override_cs: NULL, or colorspace to override the shades
inbuilt colorspace.
 
ctm: The transform to apply.
 
dest: The pixmap to render into.
 
color_params: The color rendering settings
 
bbox: Pointer to a bounding box to limit the rendering
of the shade.
 
op: NULL, or pointer to overprint bitmap.
process_shade(self, ctm, scissor, prepare, process, process_arg)
Process a shade, using supplied callback functions. This
decomposes the shading to a mesh (even ones that are not
natively meshes, such as linear or radial shadings), and
processes triangles from those meshes.
 
shade: The shade to process.
 
ctm: The transform to use
 
prepare: Callback function to 'prepare' each vertex.
This function is passed an array of floats, and populates
fz_vertex structure.
 
process: This function is passed 3 pointers to vertex
structures, and actually performs the processing (typically
filling the area between the vertexes).
 
process_arg: An opaque argument passed through from caller
to callback functions.

Static methods defined here:
__swig_destroy__ = delete_Shade(...)
delete_Shade(Shade self)
 
Parameters
----------
self: mupdf::Shade *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Shade_m_internal_get(Shade self) -> fz_shade
 
Parameters
----------
self: mupdf::Shade *
thisown
The membership flag

 
class ShaperDataT(builtins.object)
    ShaperDataT(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_ShaperDataT(...)
delete_ShaperDataT(ShaperDataT self)
 
Parameters
----------
self: mupdf::ShaperDataT *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
ShaperDataT_m_internal_get(ShaperDataT self) -> fz_shaper_data_t
 
Parameters
----------
self: mupdf::ShaperDataT *
thisown
The membership flag

 
class StextBlock(builtins.object)
    StextBlock(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__iter__ lambda self
__repr__ = _swig_repr(self)
begin(self)
end(self)

Static methods defined here:
__swig_destroy__ = delete_StextBlock(...)
delete_StextBlock(StextBlock self)
 
Parameters
----------
self: mupdf::StextBlock *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
StextBlock_m_internal_get(StextBlock self) -> fz_stext_block *
 
Parameters
----------
self: mupdf::StextBlock *
thisown
The membership flag

 
class StextBlockIterator(builtins.object)
    StextBlockIterator(item)
 

 
  Methods defined here:
__deref__(self)
__eq__(self, rhs)
Return self==value.
__increment__(self)
__init__(self, item)
Initialize self.  See help(type(self)) for accurate signature.
__ne__(self, rhs)
Return self!=value.
__ref__(self)
__repr__ = _swig_repr(self)
begin(self)
end(self)

Static methods defined here:
__swig_destroy__ = delete_StextBlockIterator(...)
delete_StextBlockIterator(StextBlockIterator self)
 
Parameters
----------
self: mupdf::StextBlockIterator *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
StextBlockIterator_m_internal_get(StextBlockIterator self) -> fz_stext_line *
 
Parameters
----------
self: mupdf::StextBlockIterator *
thisown
The membership flag

Data and other attributes defined here:
__hash__ = None

 
class StextChar(builtins.object)
    StextChar(internal)
 
Text extraction device: Used for searching, format conversion etc.
 
(In development - Subject to change in future versions)
 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_StextChar(...)
delete_StextChar(StextChar self)
 
Parameters
----------
self: mupdf::StextChar *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
StextChar_m_internal_get(StextChar self) -> fz_stext_char *
 
Parameters
----------
self: mupdf::StextChar *
thisown
The membership flag

 
class StextLine(builtins.object)
    StextLine(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__iter__ lambda self
__repr__ = _swig_repr(self)
begin(self)
end(self)

Static methods defined here:
__swig_destroy__ = delete_StextLine(...)
delete_StextLine(StextLine self)
 
Parameters
----------
self: mupdf::StextLine *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
StextLine_m_internal_get(StextLine self) -> fz_stext_line *
 
Parameters
----------
self: mupdf::StextLine *
thisown
The membership flag

 
class StextLineIterator(builtins.object)
    StextLineIterator(item)
 

 
  Methods defined here:
__deref__(self)
__eq__(self, rhs)
Return self==value.
__increment__(self)
__init__(self, item)
Initialize self.  See help(type(self)) for accurate signature.
__ne__(self, rhs)
Return self!=value.
__ref__(self)
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_StextLineIterator(...)
delete_StextLineIterator(StextLineIterator self)
 
Parameters
----------
self: mupdf::StextLineIterator *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
StextLineIterator_m_internal_get(StextLineIterator self) -> fz_stext_char *
 
Parameters
----------
self: mupdf::StextLineIterator *
thisown
The membership flag

Data and other attributes defined here:
__hash__ = None

 
class StextOptions(builtins.object)
    StextOptions(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
internal(self, *args)
parse_stext_options(self, string)
Parse stext device options from a comma separated key-value
string.

Static methods defined here:
__swig_destroy__ = delete_StextOptions(...)
delete_StextOptions(StextOptions self)
 
Parameters
----------
self: mupdf::StextOptions *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
flags
StextOptions_flags_get(StextOptions self) -> int
 
Parameters
----------
self: mupdf::StextOptions *
thisown
The membership flag

 
class StextPage(builtins.object)
    StextPage(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__iter__ lambda self
__repr__ = _swig_repr(self)
begin(self)
copy_rectangle(self, area, crlf)
Return a newly allocated UTF-8 string with the text for a given
selection rectangle.
 
crlf: If true, write "\r\n" style line endings (otherwise "\n"
only).
copy_selection(self, a, b, crlf)
end(self)
highlight_selection(self, a, b, quads, max_quads)
Return a list of quads to highlight lines inside the selection
points.
new_buffer_from_stext_page(self)
Convert structured text into plain text.
new_stext_device(self, options)
Create a device to extract the text on a page.
 
Gather the text on a page into blocks and lines.
 
The reading order is taken from the order the text is drawn in
the source file, so may not be accurate.
 
page: The text page to which content should be added. This will
usually be a newly created (empty) text page, but it can be one
containing data already (for example when merging multiple
pages, or watermarking).
 
options: Options to configure the stext device.
search_stext_page(self, needle, quads, max_quads)
Search for occurrence of 'needle' in text page.
 
Return the number of hits and store hit quads in the passed in
array.
 
NOTE: This is an experimental interface and subject to change
without notice.
snap_selection(self, ap, bp, mode)

Static methods defined here:
__swig_destroy__ = delete_StextPage(...)
delete_StextPage(StextPage self)
 
Parameters
----------
self: mupdf::StextPage *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
StextPage_m_internal_get(StextPage self) -> fz_stext_page
 
Parameters
----------
self: mupdf::StextPage *
thisown
The membership flag

 
class StextPageIterator(builtins.object)
    StextPageIterator(item)
 

 
  Methods defined here:
__deref__(self)
__eq__(self, rhs)
Return self==value.
__increment__(self)
__init__(self, item)
Initialize self.  See help(type(self)) for accurate signature.
__ne__(self, rhs)
Return self!=value.
__ref__(self)
__repr__ = _swig_repr(self)
begin(self)
end(self)

Static methods defined here:
__swig_destroy__ = delete_StextPageIterator(...)
delete_StextPageIterator(StextPageIterator self)
 
Parameters
----------
self: mupdf::StextPageIterator *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
StextPageIterator_m_internal_get(StextPageIterator self) -> fz_stext_block *
 
Parameters
----------
self: mupdf::StextPageIterator *
thisown
The membership flag

Data and other attributes defined here:
__hash__ = None

 
class Storable(builtins.object)
    Storable(*args)
 
Resource store
 
MuPDF stores decoded "objects" into a store for potential reuse.
If the size of the store gets too big, objects stored within it
can be evicted and freed to recover space. When MuPDF comes to
decode such an object, it will check to see if a version of this
object is already in the store - if it is, it will simply reuse
it. If not, it will decode it and place it into the store.
 
All objects that can be placed into the store are derived from
the fz_storable type (i.e. this should be the first component of
the objects structure). This allows for consistent (thread safe)
reference counting, and includes a function that will be called
to free the object as soon as the reference count reaches zero.
 
Most objects offer fz_keep_XXXX/fz_drop_XXXX functions derived
from fz_keep_storable/fz_drop_storable. Creation of such objects
includes a call to FZ_INIT_STORABLE to set up the fz_storable
header.
 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_Storable(...)
delete_Storable(Storable self)
 
Parameters
----------
self: mupdf::Storable *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Storable_m_internal_get(Storable self) -> fz_storable *
 
Parameters
----------
self: mupdf::Storable *
thisown
The membership flag

 
class Store(builtins.object)
    Store(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_Store(...)
delete_Store(Store self)
 
Parameters
----------
self: mupdf::Store *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Store_m_internal_get(Store self) -> fz_store *
 
Parameters
----------
self: mupdf::Store *
thisown
The membership flag

 
class StoreHash(builtins.object)
    StoreHash(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_StoreHash(...)
delete_StoreHash(StoreHash self)
 
Parameters
----------
self: mupdf::StoreHash *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
StoreHash_m_internal_get(StoreHash self) -> fz_store_hash
 
Parameters
----------
self: mupdf::StoreHash *
thisown
The membership flag

 
class StoreType(builtins.object)
    StoreType(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_StoreType(...)
delete_StoreType(StoreType self)
 
Parameters
----------
self: mupdf::StoreType *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
StoreType_m_internal_get(StoreType self) -> fz_store_type
 
Parameters
----------
self: mupdf::StoreType *
thisown
The membership flag

 
class Stream(builtins.object)
    Stream(*args)
 
fz_stream is a buffered reader capable of seeking in both
directions.
 
Streams are reference counted, so references must be dropped
by a call to fz_drop_stream.
 
Only the data between rp and wp is valid.
 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
available(self, max)
Ask how many bytes are available immediately from
a given stream.
 
stm: The stream to read from.
 
max: A hint for the underlying stream; the maximum number of
bytes that we are sure we will want to read. If you do not know
this number, give 1.
 
Returns the number of bytes immediately available between the
read and write pointers. This number is guaranteed only to be 0
if we have hit EOF. The number of bytes returned here need have
no relation to max (could be larger, could be smaller).
concat_push_drop(self, chain)
Add a chained stream to the end of the concatenate filter.
 
Ownership of chain is passed in.
decomp_image_from_stream(self, image, subarea, indexed, l2factor)
Decode a subarea of a compressed image at a given l2factor
from the given stream.
is_eof(self)
Query if the stream has reached EOF (during normal bytewise
reading).
 
See fz_is_eof_bits for the equivalent function for bitwise
reading.
is_eof_bits(self)
Query if the stream has reached EOF (during bitwise
reading).
 
See fz_is_eof for the equivalent function for bytewise
reading.
is_tar_archive(self)
Detect if stream object is a tar achieve.
 
Assumes that the stream object is seekable.
is_zip_archive(self)
Detect if stream object is a zip archive.
 
Assumes that the stream object is seekable.
new_archive_of_size(self, size)
open_a85d(self)
a85d filter performs ASCII 85 Decoding of data read
from the chained filter.
open_aesd(self, key, keylen)
aesd filter performs AES decoding of data read from the chained
filter using the supplied key.
open_ahxd(self)
ahxd filter performs ASCII Hex decoding of data read
from the chained filter.
open_arc4(self, key, keylen)
arc4 filter performs RC4 decoding of data read from the chained
filter using the supplied key.
open_archive_with_stream(self)
Open zip or tar archive stream.
 
Open an archive using a seekable stream object rather than
opening a file or directory on disk.
open_dctd(self, color_transform, l2factor, jpegtables)
dctd filter performs DCT (JPEG) decoding of data read
from the chained filter.
 
color_transform implements the PDF color_transform option;
use -1 (unset) as a default.
 
For subsampling on decode, set l2factor to the log2 of the
reduction required (therefore 0 = full size decode).
 
jpegtables is an optional stream from which the JPEG tables
can be read. Use NULL if not required.
open_endstream_filter(self, len, offset)
The endstream filter reads a PDF substream, and starts to look
for an 'endstream' token after the specified length.
open_faxd(self, k, end_of_line, encoded_byte_align, columns, rows, end_of_block, black_is_1)
faxd filter performs FAX decoding of data read from
the chained filter.
 
k: see fax specification (fax default is 0).
 
end_of_line: whether we expect end of line markers (fax default
is 0).
 
encoded_byte_align: whether we align to bytes after each line
(fax default is 0).
 
columns: how many columns in the image (fax default is 1728).
 
rows: 0 for unspecified or the number of rows of data to expect.
 
end_of_block: whether we expect end of block markers (fax
default is 1).
 
black_is_1: determines the polarity of the image (fax default is
0).
open_flated(self, window_bits)
flated filter performs LZ77 decoding (inflating) of data read
from the chained filter.
 
window_bits: How large a decompression window to use. Typically
15. A negative number, -n, means to use n bits, but to expect
raw data with no header.
open_image_decomp_stream(self, arg_1)
Open a stream to read the decompressed version of another stream
with optional log2 subsampling.
open_jbig2d(self, globals)
Open a filter that performs jbig2 decompression on the chained
stream, using the optional globals record.
open_leecher(self, buf)
Attach a filter to a stream that will store any
characters read from the stream into the supplied buffer.
 
chain: The underlying stream to leech from.
 
buf: The buffer into which the read data should be appended.
The buffer will be resized as required.
 
Returns pointer to newly created stream. May throw exceptions on
failure to allocate.
open_lzwd(self, early_change, min_bits, reverse_bits, old_tiff)
lzwd filter performs LZW decoding of data read from the chained
filter.
 
early_change: (Default 1) specifies whether to change codes 1
bit early.
 
min_bits: (Default 9) specifies the minimum number of bits to
use.
 
reverse_bits: (Default 0) allows for compatibility with gif and
old style tiffs (1).
 
old_tiff: (Default 0) allows for different handling of the clear
code, as found in old style tiffs.
open_null_filter(self, len, offset)
The null filter reads a specified amount of data from the
substream.
open_predict(self, predictor, columns, colors, bpc)
predict filter performs pixel prediction on data read from
the chained filter.
 
predictor: 1 = copy, 2 = tiff, other = inline PNG predictor
 
columns: width of image in pixels
 
colors: number of components.
 
bpc: bits per component (typically 8)
open_range_filter(self, ranges, nranges)
The range filter copies data from specified ranges of the
chained stream.
open_rld(self)
rld filter performs Run Length Decoding of data read
from the chained filter.
open_sgilog16(self, w)
SGI Log 16bit (greyscale) decode from the chained filter.
Decodes lines of w pixels to 8bpp greyscale.
open_sgilog24(self, w)
SGI Log 24bit (LUV) decode from the chained filter.
Decodes lines of w pixels to 8bpc rgb.
open_sgilog32(self, w)
SGI Log 32bit (LUV) decode from the chained filter.
Decodes lines of w pixels to 8bpc rgb.
open_tar_archive_with_stream(self)
Open a tar archive stream.
 
Open an archive using a seekable stream object rather than
opening a file or directory on disk.
 
An exception is throw if the stream is not a tar archive as
indicated by the presence of a tar signature.
open_thunder(self, w)
4bit greyscale Thunderscan decoding from the chained filter.
Decodes lines of w pixels to 8bpp greyscale.
open_zip_archive_with_stream(self)
Open a zip archive stream.
 
Open an archive using a seekable stream object rather than
opening a file or directory on disk.
 
An exception is throw if the stream is not a zip archive as
indicated by the presence of a zip signature.
pdf_lex(self, lexbuf)
pdf_lex_no_string(self, lexbuf)
pdf_load_cmap(self)
pdf_open_crypt(self, crypt, num, gen)
pdf_open_crypt_with_filter(self, crypt, name, num, gen)
pdf_open_document_with_stream(self)
peek_byte(self)
Peek at the next byte in a stream.
 
stm: The stream to peek at.
 
Returns -1 for EOF, or the next byte that will be read.
read(self, data, len)
Read from a stream into a given data block.
 
stm: The stream to read from.
 
data: The data block to read into.
 
len: The length of the data block (in bytes).
 
Returns the number of bytes read. May throw exceptions.
read_all(self, initial)
Read all of a stream into a buffer.
 
stm: The stream to read from
 
initial: Suggested initial size for the buffer.
 
Returns a buffer created from reading from the stream. May throw
exceptions on failure to allocate.
read_best(self, initial)
Attempt to read a stream into a buffer. If truncated
is NULL behaves as fz_read_all, sets a truncated flag in case of
error.
 
stm: The stream to read from.
 
initial: Suggested initial size for the buffer.
 
truncated: Flag to store success/failure indication in.
 
Returns a buffer created from reading from the stream.
read_bits(self, n)
Read the next n bits from a stream (assumed to
be packed most significant bit first).
 
stm: The stream to read from.
 
n: The number of bits to read, between 1 and 8*sizeof(int)
inclusive.
 
Returns -1 for EOF, or the required number of bits.
read_byte(self)
Read the next byte from a stream.
 
stm: The stream t read from.
 
Returns -1 for end of stream, or the next byte. May
throw exceptions.
read_float(self)
read_float_le(self)
read_int16(self)
read_int16_le(self)
read_int32(self)
read_int32_le(self)
read_int64(self)
read_int64_le(self)
read_line(self, buf, max)
Read a line from stream into the buffer until either a
terminating newline or EOF, which it replaces with a null byte
('').
 
Returns buf on success, and NULL when end of file occurs while
no characters have been read.
read_rbits(self, n)
Read the next n bits from a stream (assumed to
be packed least significant bit first).
 
stm: The stream to read from.
 
n: The number of bits to read, between 1 and 8*sizeof(int)
inclusive.
 
Returns (unsigned int)-1 for EOF, or the required number of bits.
read_string(self, buffer, len)
Read a null terminated string from the stream into
a buffer of a given length. The buffer will be null terminated.
Throws on failure (including the failure to fit the entire
string including the terminator into the buffer).
read_uint16(self)
fz_read_[u]int(16|24|32|64)(_le)?
 
Read a 16/32/64 bit signed/unsigned integer from stream,
in big or little-endian byte orders.
 
Throws an exception if EOF is encountered.
read_uint16_le(self)
read_uint24(self)
read_uint24_le(self)
read_uint32(self)
read_uint32_le(self)
read_uint64(self)
read_uint64_le(self)
seek(self, offset, whence)
Seek within a stream.
 
stm: The stream to seek within.
 
offset: The offset to seek to.
 
whence: From where the offset is measured (see fseek).
skip(self, len)
Read from a stream discarding data.
 
stm: The stream to read from.
 
len: The number of bytes to read.
 
Returns the number of bytes read. May throw exceptions.
sync_bits(self)
Called after reading bits to tell the stream
that we are about to return to reading bytewise. Resyncs
the stream to whole byte boundaries.
tell(self)
return the current reading position within a stream
unread_byte(self)
Unread the single last byte successfully
read from a stream. Do not call this without having
successfully read a byte.
 
stm: The stream to operate upon.

Static methods defined here:
__swig_destroy__ = delete_Stream(...)
delete_Stream(Stream self)
 
Parameters
----------
self: mupdf::Stream *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Stream_m_internal_get(Stream self) -> fz_stream *
 
Parameters
----------
self: mupdf::Stream *
thisown
The membership flag

 
class StrokeState(builtins.object)
    StrokeState(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
clone_stroke_state(self)
Create an identical stroke_state structure and return a
reference to it.
 
stroke: The stroke state reference to clone.
 
Exceptions may be thrown in the event of a failure to
allocate.
unshare_stroke_state(self)
Given a reference to a (possibly) shared stroke_state structure,
return a reference to an equivalent stroke_state structure
that is guaranteed to be unshared (i.e. one that can
safely be modified).
 
shared: The reference to a (possibly) shared structure
to unshare. Ownership of this reference is passed in
to this function, even in the case of exceptions being
thrown.
 
Exceptions may be thrown in the event of failure to
allocate if required.
unshare_stroke_state_with_dash_len(self, len)
Given a reference to a (possibly) shared stroke_state structure,
return a reference to a stroke_state structure (with room for a
given amount of dash data) that is guaranteed to be unshared
(i.e. one that can safely be modified).
 
shared: The reference to a (possibly) shared structure
to unshare. Ownership of this reference is passed in
to this function, even in the case of exceptions being
thrown.
 
Exceptions may be thrown in the event of failure to
allocate if required.

Static methods defined here:
__swig_destroy__ = delete_StrokeState(...)
delete_StrokeState(StrokeState self)
 
Parameters
----------
self: mupdf::StrokeState *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
StrokeState_m_internal_get(StrokeState self) -> fz_stroke_state
 
Parameters
----------
self: mupdf::StrokeState *
thisown
The membership flag

 
class StyleContext(builtins.object)
    StyleContext(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_StyleContext(...)
delete_StyleContext(StyleContext self)
 
Parameters
----------
self: mupdf::StyleContext *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
StyleContext_m_internal_get(StyleContext self) -> fz_style_context *
 
Parameters
----------
self: mupdf::StyleContext *
thisown
The membership flag

 
class SwigPyIterator(builtins.object)
    SwigPyIterator(*args, **kwargs)
 

 
  Methods defined here:
__add__(self, n)
__eq__(self, x)
Return self==value.
__iadd__(self, n)
__init__(self, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__isub__(self, n)
__iter__(self)
__ne__(self, x)
Return self!=value.
__next__(self)
__repr__ = _swig_repr(self)
__sub__(self, *args)
advance(self, n)
copy(self)
decr(self, n=1)
distance(self, x)
equal(self, x)
incr(self, n=1)
next(self)
previous(self)
value(self)

Static methods defined here:
__swig_destroy__ = delete_SwigPyIterator(...)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag

Data and other attributes defined here:
__hash__ = None

 
class Text(builtins.object)
    Text(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
bound_text(self, stroke, ctm)
Find the bounds of a given text object.
 
text: The text object to find the bounds of.
 
stroke: Pointer to the stroke attributes (for stroked
text), or NULL (for filled text).
 
ctm: The matrix in use.
 
r: pointer to storage for the bounds.
 
Returns a pointer to r, which is updated to contain the
bounding box for the text object.
show_glyph(self, font, trm, glyph, unicode, wmode, bidi_level, markup_dir, language)
Add a glyph/unicode value to a text object.
 
text: Text object to add to.
 
font: The font the glyph should be added in.
 
trm: The transform to use for the glyph.
 
glyph: The glyph id to add.
 
unicode: The unicode character for the glyph.
 
wmode: 1 for vertical mode, 0 for horizontal.
 
bidi_level: The bidirectional level for this glyph.
 
markup_dir: The direction of the text as specified in the
markup.
 
language: The language in use (if known, 0 otherwise)
(e.g. FZ_LANG_zh_Hans).
 
Throws exception on failure to allocate.
show_string(self, font, trm, s, wmode, bidi_level, markup_dir, language)
Add a UTF8 string to a text object.
 
text: Text object to add to.
 
font: The font the string should be added in.
 
trm: The transform to use.
 
s: The utf-8 string to add.
 
wmode: 1 for vertical mode, 0 for horizontal.
 
bidi_level: The bidirectional level for this glyph.
 
markup_dir: The direction of the text as specified in the
markup.
 
language: The language in use (if known, 0 otherwise)
(e.g. FZ_LANG_zh_Hans).
 
Returns the transform updated with the advance width of the
string.

Static methods defined here:
__swig_destroy__ = delete_Text(...)
delete_Text(Text self)
 
Parameters
----------
self: mupdf::Text *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Text_m_internal_get(Text self) -> fz_text
 
Parameters
----------
self: mupdf::Text *
thisown
The membership flag

 
class TextItem(builtins.object)
    TextItem(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_TextItem(...)
delete_TextItem(TextItem self)
 
Parameters
----------
self: mupdf::TextItem *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
TextItem_m_internal_get(TextItem self) -> fz_text_item
 
Parameters
----------
self: mupdf::TextItem *
thisown
The membership flag

 
class TextSpan(builtins.object)
    TextSpan(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_TextSpan(...)
delete_TextSpan(TextSpan self)
 
Parameters
----------
self: mupdf::TextSpan *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
TextSpan_m_internal_get(TextSpan self) -> fz_text_span
 
Parameters
----------
self: mupdf::TextSpan *
thisown
The membership flag

 
class Transition(builtins.object)
    Transition(*args)
 

 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
internal(self, *args)

Static methods defined here:
__swig_destroy__ = delete_Transition(...)
delete_Transition(Transition self)
 
Parameters
----------
self: mupdf::Transition *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
direction
Transition_direction_get(Transition self) -> int
 
Parameters
----------
self: mupdf::Transition *
duration
Transition_duration_get(Transition self) -> float
 
Parameters
----------
self: mupdf::Transition *
outwards
Transition_outwards_get(Transition self) -> int
 
Parameters
----------
self: mupdf::Transition *
state0
Transition_state0_get(Transition self) -> int
 
Parameters
----------
self: mupdf::Transition *
state1
Transition_state1_get(Transition self) -> int
 
Parameters
----------
self: mupdf::Transition *
thisown
The membership flag
type
Transition_type_get(Transition self) -> int
 
Parameters
----------
self: mupdf::Transition *
vertical
Transition_vertical_get(Transition self) -> int
 
Parameters
----------
self: mupdf::Transition *

 
class Tree(builtins.object)
    Tree(internal)
 
AA-tree to look up things by strings.
 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
tree_insert(self, key, value)
Insert a new key/value pair and rebalance the tree.
Return the new root of the tree after inserting and rebalancing.
May be called with a NULL root to create a new tree.
 
No data is copied into the tree structure; key and value are
merely kept as pointers.
tree_lookup(self, key)
Look for the value of a node in the tree with the given key.
 
Simple pointer equivalence is used for key.
 
Returns NULL for no match.

Static methods defined here:
__swig_destroy__ = delete_Tree(...)
delete_Tree(Tree self)
 
Parameters
----------
self: mupdf::Tree *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Tree_m_internal_get(Tree self) -> fz_tree *
 
Parameters
----------
self: mupdf::Tree *
thisown
The membership flag

 
class TuningContext(builtins.object)
    TuningContext(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_TuningContext(...)
delete_TuningContext(TuningContext self)
 
Parameters
----------
self: mupdf::TuningContext *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
TuningContext_m_internal_get(TuningContext self) -> fz_tuning_context *
 
Parameters
----------
self: mupdf::TuningContext *
thisown
The membership flag

 
class Vertex(builtins.object)
    Vertex(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_Vertex(...)
delete_Vertex(Vertex self)
 
Parameters
----------
self: mupdf::Vertex *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Vertex_m_internal_get(Vertex self) -> fz_vertex
 
Parameters
----------
self: mupdf::Vertex *
thisown
The membership flag

 
class WarnContext(builtins.object)
    WarnContext(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_WarnContext(...)
delete_WarnContext(WarnContext self)
 
Parameters
----------
self: mupdf::WarnContext *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
WarnContext_m_internal_get(WarnContext self) -> fz_warn_context
 
Parameters
----------
self: mupdf::WarnContext *
thisown
The membership flag

 
class Xml(builtins.object)
    Xml(internal)
 

 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
debug_xml(self, level)
Pretty-print an XML tree to stdout.
new_display_list_from_svg_xml(self, base_uri, zip)
Parse an SVG document into a display-list.
new_image_from_svg_xml(self, base_uri, zip)
Create a scalable image from an SVG document.
xml_att(self, att)
Return the value of an attribute of an XML node.
NULL if the attribute doesn't exist.
xml_att_eq(self, name, match)
Check for a matching attribute on an XML node.
 
If the node has the requested attribute (name), and the value
matches (match) then return 1. Otherwise, 0.
xml_down(self)
Return first child of XML node.
xml_find(self, tag)
Search the siblings of XML nodes starting with item looking for
the first with the given tag.
 
Return NULL if none found.
xml_find_down(self, tag)
Search the siblings of XML nodes starting with the first child
of item looking for the first with the given tag.
 
Return NULL if none found.
xml_find_down_match(self, tag, att, match)
Search the siblings of XML nodes starting with the first child
of item looking for the first with the given tag, and with a
matching attribute.
 
Return NULL if none found.
xml_find_match(self, tag, att, match)
Search the siblings of XML nodes starting with item looking for
the first with the given tag, and with a matching attribute.
 
Return NULL if none found.
xml_find_next(self, tag)
Search the siblings of XML nodes starting with the first sibling
of item looking for the first with the given tag.
 
Return NULL if none found.
xml_find_next_match(self, tag, att, match)
Search the siblings of XML nodes starting with the first sibling
of item looking for the first with the given tag, and with a
matching attribute.
 
Return NULL if none found.
xml_is_tag(self, name)
Return true if the tag name matches.
xml_next(self)
Return next sibling of XML node.
xml_prev(self)
Return previous sibling of XML node.
xml_tag(self)
Return tag of XML node. Return NULL for text nodes.
xml_text(self)
Return the text content of an XML node.
Return NULL if the node is a tag.
xml_up(self)
Return parent of XML node.

Static methods defined here:
__swig_destroy__ = delete_Xml(...)
delete_Xml(Xml self)
 
Parameters
----------
self: mupdf::Xml *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
Xml_m_internal_get(Xml self) -> fz_xml *
 
Parameters
----------
self: mupdf::Xml *
thisown
The membership flag

 
class XmlDoc(builtins.object)
    XmlDoc(internal)
 
XML document model
 
  Methods defined here:
__init__(self, internal)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
detach_xml(self, node)
Detach a node from the tree, unlinking it from its parent,
and setting the document root to the node.
xml_root(self)
Return the topmost XML node of a document.

Static methods defined here:
__swig_destroy__ = delete_XmlDoc(...)
delete_XmlDoc(XmlDoc self)
 
Parameters
----------
self: mupdf::XmlDoc *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
XmlDoc_m_internal_get(XmlDoc self) -> fz_xml_doc *
 
Parameters
----------
self: mupdf::XmlDoc *
thisown
The membership flag

 
class ZipWriter(builtins.object)
    ZipWriter(*args)
 
fz_zip_writer offers methods for creating and writing zip files.
It can be seen as the reverse of the fz_archive zip
implementation.
 
  Methods defined here:
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)
close_zip_writer(self)
Close the zip file for writing.
 
This flushes any pending data to the file. This can throw
exceptions.
write_zip_entry(self, name, buf, compress)
Given a buffer of data, (optionally) compress it, and add it to
the zip file with the given name.

Static methods defined here:
__swig_destroy__ = delete_ZipWriter(...)
delete_ZipWriter(ZipWriter self)
 
Parameters
----------
self: mupdf::ZipWriter *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
m_internal
ZipWriter_m_internal_get(ZipWriter self) -> fz_zip_writer *
 
Parameters
----------
self: mupdf::ZipWriter *
thisown
The membership flag

 
class fz_aa_context(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_aa_context(...)
delete_fz_aa_context(fz_aa_context self)
 
Parameters
----------
self: fz_aa_context *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
bits
fz_aa_context_bits_get(fz_aa_context self) -> int
 
Parameters
----------
self: fz_aa_context *
hscale
fz_aa_context_hscale_get(fz_aa_context self) -> int
 
Parameters
----------
self: fz_aa_context *
min_line_width
fz_aa_context_min_line_width_get(fz_aa_context self) -> float
 
Parameters
----------
self: fz_aa_context *
scale
fz_aa_context_scale_get(fz_aa_context self) -> int
 
Parameters
----------
self: fz_aa_context *
text_bits
fz_aa_context_text_bits_get(fz_aa_context self) -> int
 
Parameters
----------
self: fz_aa_context *
thisown
The membership flag
vscale
fz_aa_context_vscale_get(fz_aa_context self) -> int
 
Parameters
----------
self: fz_aa_context *

 
class fz_aes(builtins.object)
    Structure definitions are public to enable stack
based allocation. Do not access the members directly.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_aes(...)
delete_fz_aes(fz_aes self)
 
Parameters
----------
self: fz_aes *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
buf
fz_aes_buf_get(fz_aes self) -> unsigned long [68]
 
Parameters
----------
self: fz_aes *
nr
fz_aes_nr_get(fz_aes self) -> int
 
Parameters
----------
self: fz_aes *
rk
fz_aes_rk_get(fz_aes self) -> unsigned long *
 
Parameters
----------
self: fz_aes *
thisown
The membership flag

 
class fz_alloc_context(builtins.object)
    Allocator structure; holds callbacks and private data pointer.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_alloc_context(...)
delete_fz_alloc_context(fz_alloc_context self)
 
Parameters
----------
self: fz_alloc_context *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
free
fz_alloc_context_free_get(fz_alloc_context self) -> void (*)(void *,void *)
 
Parameters
----------
self: fz_alloc_context *
malloc
fz_alloc_context_malloc_get(fz_alloc_context self) -> void *(*)(void *,size_t)
 
Parameters
----------
self: fz_alloc_context *
realloc
fz_alloc_context_realloc_get(fz_alloc_context self) -> void *(*)(void *,void *,size_t)
 
Parameters
----------
self: fz_alloc_context *
thisown
The membership flag
user
fz_alloc_context_user_get(fz_alloc_context self) -> void *
 
Parameters
----------
self: fz_alloc_context *

 
class fz_arc4(builtins.object)
    Structure definition is public to enable stack
based allocation. Do not access the members directly.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_arc4(...)
delete_fz_arc4(fz_arc4 self)
 
Parameters
----------
self: fz_arc4 *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
state
fz_arc4_state_get(fz_arc4 self) -> unsigned char [256]
 
Parameters
----------
self: fz_arc4 *
thisown
The membership flag
x
fz_arc4_x_get(fz_arc4 self) -> unsigned int
 
Parameters
----------
self: fz_arc4 *
y
fz_arc4_y_get(fz_arc4 self) -> unsigned int
 
Parameters
----------
self: fz_arc4 *

 
class fz_archive(builtins.object)
    Implementation details: Subject to change.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_archive(...)
delete_fz_archive(fz_archive * self)
 
Parameters
----------
self: fz_archive *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
count_entries
fz_archive_count_entries_get(fz_archive * self) -> int (*)(fz_context *,fz_archive *)
 
Parameters
----------
self: fz_archive *
drop_archive
fz_archive_drop_archive_get(fz_archive * self) -> void (*)(fz_context *,fz_archive *)
 
Parameters
----------
self: fz_archive *
file
fz_archive_file_get(fz_archive * self) -> fz_stream *
 
Parameters
----------
self: fz_archive *
format
fz_archive_format_get(fz_archive * self) -> char const *
 
Parameters
----------
self: fz_archive *
has_entry
fz_archive_has_entry_get(fz_archive * self) -> int (*)(fz_context *,fz_archive *,char const *)
 
Parameters
----------
self: fz_archive *
list_entry
fz_archive_list_entry_get(fz_archive * self) -> char const *(*)(fz_context *,fz_archive *,int)
 
Parameters
----------
self: fz_archive *
open_entry
fz_archive_open_entry_get(fz_archive * self) -> fz_stream *(*)(fz_context *,fz_archive *,char const *)
 
Parameters
----------
self: fz_archive *
read_entry
fz_archive_read_entry_get(fz_archive * self) -> fz_buffer *(*)(fz_context *,fz_archive *,char const *)
 
Parameters
----------
self: fz_archive *
thisown
The membership flag

 
class fz_band_writer(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_band_writer(...)
delete_fz_band_writer(fz_band_writer * self)
 
Parameters
----------
self: fz_band_writer *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
alpha
fz_band_writer_alpha_get(fz_band_writer * self) -> int
 
Parameters
----------
self: fz_band_writer *
band
fz_band_writer_band_get(fz_band_writer * self) -> fz_write_band_fn *
 
Parameters
----------
self: fz_band_writer *
drop
fz_band_writer_drop_get(fz_band_writer * self) -> fz_drop_band_writer_fn *
 
Parameters
----------
self: fz_band_writer *
h
fz_band_writer_h_get(fz_band_writer * self) -> int
 
Parameters
----------
self: fz_band_writer *
header
fz_band_writer_header_get(fz_band_writer * self) -> fz_write_header_fn *
 
Parameters
----------
self: fz_band_writer *
line
fz_band_writer_line_get(fz_band_writer * self) -> int
 
Parameters
----------
self: fz_band_writer *
n
fz_band_writer_n_get(fz_band_writer * self) -> int
 
Parameters
----------
self: fz_band_writer *
out
fz_band_writer_out_get(fz_band_writer * self) -> fz_output
 
Parameters
----------
self: fz_band_writer *
pagenum
fz_band_writer_pagenum_get(fz_band_writer * self) -> int
 
Parameters
----------
self: fz_band_writer *
s
fz_band_writer_s_get(fz_band_writer * self) -> int
 
Parameters
----------
self: fz_band_writer *
seps
fz_band_writer_seps_get(fz_band_writer * self) -> fz_separations *
 
Parameters
----------
self: fz_band_writer *
thisown
The membership flag
trailer
fz_band_writer_trailer_get(fz_band_writer * self) -> fz_write_trailer_fn *
 
Parameters
----------
self: fz_band_writer *
w
fz_band_writer_w_get(fz_band_writer * self) -> int
 
Parameters
----------
self: fz_band_writer *
xres
fz_band_writer_xres_get(fz_band_writer * self) -> int
 
Parameters
----------
self: fz_band_writer *
yres
fz_band_writer_yres_get(fz_band_writer * self) -> int
 
Parameters
----------
self: fz_band_writer *

 
class fz_bitmap(builtins.object)
    Bitmaps have 1 bit per component. Only used for creating
halftoned versions of contone buffers, and saving out. Samples
are stored msb first, akin to pbms.
 
The internals of this struct are considered implementation
details and subject to change. Where possible, accessor
functions should be used in preference.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_bitmap(...)
delete_fz_bitmap(fz_bitmap self)
 
Parameters
----------
self: fz_bitmap *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
h
fz_bitmap_h_get(fz_bitmap self) -> int
 
Parameters
----------
self: fz_bitmap *
n
fz_bitmap_n_get(fz_bitmap self) -> int
 
Parameters
----------
self: fz_bitmap *
refs
fz_bitmap_refs_get(fz_bitmap self) -> int
 
Parameters
----------
self: fz_bitmap *
samples
fz_bitmap_samples_get(fz_bitmap self) -> unsigned char *
 
Parameters
----------
self: fz_bitmap *
stride
fz_bitmap_stride_get(fz_bitmap self) -> int
 
Parameters
----------
self: fz_bitmap *
thisown
The membership flag
w
fz_bitmap_w_get(fz_bitmap self) -> int
 
Parameters
----------
self: fz_bitmap *
xres
fz_bitmap_xres_get(fz_bitmap self) -> int
 
Parameters
----------
self: fz_bitmap *
yres
fz_bitmap_yres_get(fz_bitmap self) -> int
 
Parameters
----------
self: fz_bitmap *

 
class fz_buffer(builtins.object)
    fz_buffer is a wrapper around a dynamically allocated array of
bytes.
 
Buffers have a capacity (the number of bytes storage immediately
available) and a current size.
 
The contents of the structure are considered implementation
details and are subject to change. Users should use the accessor
functions in preference.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_buffer(...)
delete_fz_buffer(fz_buffer self)
 
Parameters
----------
self: fz_buffer *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
cap
fz_buffer_cap_get(fz_buffer self) -> size_t
 
Parameters
----------
self: fz_buffer *
data
fz_buffer_data_get(fz_buffer self) -> unsigned char *
 
Parameters
----------
self: fz_buffer *
len
fz_buffer_len_get(fz_buffer self) -> size_t
 
Parameters
----------
self: fz_buffer *
refs
fz_buffer_refs_get(fz_buffer self) -> int
 
Parameters
----------
self: fz_buffer *
shared
fz_buffer_shared_get(fz_buffer self) -> int
 
Parameters
----------
self: fz_buffer *
thisown
The membership flag
unused_bits
fz_buffer_unused_bits_get(fz_buffer self) -> int
 
Parameters
----------
self: fz_buffer *

 
class fz_color_params(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_color_params(...)
delete_fz_color_params(fz_color_params self)
 
Parameters
----------
self: fz_color_params *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
bp
fz_color_params_bp_get(fz_color_params self) -> uint8_t
 
Parameters
----------
self: fz_color_params *
op
fz_color_params_op_get(fz_color_params self) -> uint8_t
 
Parameters
----------
self: fz_color_params *
opm
fz_color_params_opm_get(fz_color_params self) -> uint8_t
 
Parameters
----------
self: fz_color_params *
ri
fz_color_params_ri_get(fz_color_params self) -> uint8_t
 
Parameters
----------
self: fz_color_params *
thisown
The membership flag

 
class fz_colorspace(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_colorspace(...)
delete_fz_colorspace(fz_colorspace * self)
 
Parameters
----------
self: fz_colorspace *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
flags
fz_colorspace_flags_get(fz_colorspace * self) -> int
 
Parameters
----------
self: fz_colorspace *
key_storable
fz_colorspace_key_storable_get(fz_colorspace * self) -> fz_key_storable
 
Parameters
----------
self: fz_colorspace *
n
fz_colorspace_n_get(fz_colorspace * self) -> int
 
Parameters
----------
self: fz_colorspace *
name
fz_colorspace_name_get(fz_colorspace * self) -> char *
 
Parameters
----------
self: fz_colorspace *
thisown
The membership flag
type
fz_colorspace_type_get(fz_colorspace * self) -> enum fz_colorspace_type
 
Parameters
----------
self: fz_colorspace *

 
class fz_compressed_buffer(builtins.object)
    Buffers of compressed data; typically for the source data
for images.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_compressed_buffer(...)
delete_fz_compressed_buffer(fz_compressed_buffer self)
 
Parameters
----------
self: fz_compressed_buffer *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
buffer
fz_compressed_buffer_buffer_get(fz_compressed_buffer self) -> fz_buffer
 
Parameters
----------
self: fz_compressed_buffer *
params
fz_compressed_buffer_params_get(fz_compressed_buffer self) -> fz_compression_params
 
Parameters
----------
self: fz_compressed_buffer *
thisown
The membership flag

 
class fz_compression_params(builtins.object)
    Compression parameters used for buffers of compressed data;
typically for the source data for images.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_compression_params(...)
delete_fz_compression_params(fz_compression_params self)
 
Parameters
----------
self: fz_compression_params *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag
type
fz_compression_params_type_get(fz_compression_params self) -> int
 
Parameters
----------
self: fz_compression_params *

 
class fz_context(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_context(...)
delete_fz_context(fz_context * self)
 
Parameters
----------
self: fz_context *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
aa
fz_context_aa_get(fz_context * self) -> fz_aa_context
 
Parameters
----------
self: fz_context *
alloc
fz_context_alloc_get(fz_context * self) -> fz_alloc_context
 
Parameters
----------
self: fz_context *
colorspace
fz_context_colorspace_get(fz_context * self) -> fz_colorspace_context *
 
Parameters
----------
self: fz_context *
error
fz_context_error_get(fz_context * self) -> fz_error_context
 
Parameters
----------
self: fz_context *
font
fz_context_font_get(fz_context * self) -> fz_font_context *
 
Parameters
----------
self: fz_context *
glyph_cache
fz_context_glyph_cache_get(fz_context * self) -> fz_glyph_cache *
 
Parameters
----------
self: fz_context *
handler
fz_context_handler_get(fz_context * self) -> fz_document_handler_context *
 
Parameters
----------
self: fz_context *
icc_enabled
fz_context_icc_enabled_get(fz_context * self) -> int
 
Parameters
----------
self: fz_context *
locks
fz_context_locks_get(fz_context * self) -> fz_locks_context
 
Parameters
----------
self: fz_context *
seed48
fz_context_seed48_get(fz_context * self) -> uint16_t [7]
 
Parameters
----------
self: fz_context *
store
fz_context_store_get(fz_context * self) -> fz_store *
 
Parameters
----------
self: fz_context *
style
fz_context_style_get(fz_context * self) -> fz_style_context *
 
Parameters
----------
self: fz_context *
thisown
The membership flag
tuning
fz_context_tuning_get(fz_context * self) -> fz_tuning_context *
 
Parameters
----------
self: fz_context *
user
fz_context_user_get(fz_context * self) -> void *
 
Parameters
----------
self: fz_context *
warn
fz_context_warn_get(fz_context * self) -> fz_warn_context
 
Parameters
----------
self: fz_context *

 
class fz_cookie(builtins.object)
    Cookie support - simple communication channel between app/library.
 
Provide two-way communication between application and library.
Intended for multi-threaded applications where one thread is
rendering pages and another thread wants to read progress
feedback or abort a job that takes a long time to finish. The
communication is unsynchronized without locking.
 
abort: The application should set this field to 0 before
calling fz_run_page to render a page. At any point when the
page is being rendered the application my set this field to 1
which will cause the rendering to finish soon. This field is
checked periodically when the page is rendered, but exactly
when is not known, therefore there is no upper bound on
exactly when the rendering will abort. If the application
did not provide a set of locks to fz_new_context, it must also
await the completion of fz_run_page before issuing another
call to fz_run_page. Note that once the application has set
this field to 1 after it called fz_run_page it may not change
the value again.
 
progress: Communicates rendering progress back to the
application and is read only. Increments as a page is being
rendered. The value starts out at 0 and is limited to less
than or equal to progress_max, unless progress_max is -1.
 
progress_max: Communicates the known upper bound of rendering
back to the application and is read only. The maximum value
that the progress field may take. If there is no known upper
bound on how long the rendering may take this value is -1 and
progress is not limited. Note that the value of progress_max
may change from -1 to a positive value once an upper bound is
known, so take this into consideration when comparing the
value of progress to that of progress_max.
 
errors: count of errors during current rendering.
 
incomplete: Initially should be set to 0. Will be set to
non-zero if a TRYLATER error is thrown during rendering.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_cookie(...)
delete_fz_cookie(fz_cookie self)
 
Parameters
----------
self: fz_cookie *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
abort
fz_cookie_abort_get(fz_cookie self) -> int
 
Parameters
----------
self: fz_cookie *
errors
fz_cookie_errors_get(fz_cookie self) -> int
 
Parameters
----------
self: fz_cookie *
incomplete
fz_cookie_incomplete_get(fz_cookie self) -> int
 
Parameters
----------
self: fz_cookie *
progress
fz_cookie_progress_get(fz_cookie self) -> int
 
Parameters
----------
self: fz_cookie *
progress_max
fz_cookie_progress_max_get(fz_cookie self) -> size_t
 
Parameters
----------
self: fz_cookie *
thisown
The membership flag

 
class fz_default_colorspaces(builtins.object)
    Structure to hold default colorspaces.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_default_colorspaces(...)
delete_fz_default_colorspaces(fz_default_colorspaces self)
 
Parameters
----------
self: fz_default_colorspaces *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
cmyk
fz_default_colorspaces_cmyk_get(fz_default_colorspaces self) -> fz_colorspace *
 
Parameters
----------
self: fz_default_colorspaces *
gray
fz_default_colorspaces_gray_get(fz_default_colorspaces self) -> fz_colorspace *
 
Parameters
----------
self: fz_default_colorspaces *
oi
fz_default_colorspaces_oi_get(fz_default_colorspaces self) -> fz_colorspace *
 
Parameters
----------
self: fz_default_colorspaces *
refs
fz_default_colorspaces_refs_get(fz_default_colorspaces self) -> int
 
Parameters
----------
self: fz_default_colorspaces *
rgb
fz_default_colorspaces_rgb_get(fz_default_colorspaces self) -> fz_colorspace *
 
Parameters
----------
self: fz_default_colorspaces *
thisown
The membership flag

 
class fz_device(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_device(...)
delete_fz_device(fz_device * self)
 
Parameters
----------
self: fz_device *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
begin_group
fz_device_begin_group_get(fz_device * self) -> void (*)(fz_context *,fz_device *,fz_rect,fz_colorspace *,int,int,int,float)
 
Parameters
----------
self: fz_device *
begin_layer
fz_device_begin_layer_get(fz_device * self) -> void (*)(fz_context *,fz_device *,char const *)
 
Parameters
----------
self: fz_device *
begin_mask
fz_device_begin_mask_get(fz_device * self) -> void (*)(fz_context *,fz_device *,fz_rect,int,fz_colorspace *,float const *,fz_color_params)
 
Parameters
----------
self: fz_device *
begin_tile
fz_device_begin_tile_get(fz_device * self) -> int (*)(fz_context *,fz_device *,fz_rect,fz_rect,float,float,fz_matrix,int)
 
Parameters
----------
self: fz_device *
clip_image_mask
fz_device_clip_image_mask_get(fz_device * self) -> void (*)(fz_context *,fz_device *,fz_image *,fz_matrix,fz_rect)
 
Parameters
----------
self: fz_device *
clip_path
fz_device_clip_path_get(fz_device * self) -> void (*)(fz_context *,fz_device *,fz_path const *,int,fz_matrix,fz_rect)
 
Parameters
----------
self: fz_device *
clip_stroke_path
fz_device_clip_stroke_path_get(fz_device * self) -> void (*)(fz_context *,fz_device *,fz_path const *,fz_stroke_state const *,fz_matrix,fz_rect)
 
Parameters
----------
self: fz_device *
clip_stroke_text
fz_device_clip_stroke_text_get(fz_device * self) -> void (*)(fz_context *,fz_device *,fz_text const *,fz_stroke_state const *,fz_matrix,fz_rect)
 
Parameters
----------
self: fz_device *
clip_text
fz_device_clip_text_get(fz_device * self) -> void (*)(fz_context *,fz_device *,fz_text const *,fz_matrix,fz_rect)
 
Parameters
----------
self: fz_device *
close_device
fz_device_close_device_get(fz_device * self) -> void (*)(fz_context *,fz_device *)
 
Parameters
----------
self: fz_device *
container
fz_device_container_get(fz_device * self) -> fz_device_container_stack
 
Parameters
----------
self: fz_device *
container_cap
fz_device_container_cap_get(fz_device * self) -> int
 
Parameters
----------
self: fz_device *
container_len
fz_device_container_len_get(fz_device * self) -> int
 
Parameters
----------
self: fz_device *
d1_rect
fz_device_d1_rect_get(fz_device * self) -> fz_rect
 
Parameters
----------
self: fz_device *
drop_device
fz_device_drop_device_get(fz_device * self) -> void (*)(fz_context *,fz_device *)
 
Parameters
----------
self: fz_device *
end_group
fz_device_end_group_get(fz_device * self) -> void (*)(fz_context *,fz_device *)
 
Parameters
----------
self: fz_device *
end_layer
fz_device_end_layer_get(fz_device * self) -> void (*)(fz_context *,fz_device *)
 
Parameters
----------
self: fz_device *
end_mask
fz_device_end_mask_get(fz_device * self) -> void (*)(fz_context *,fz_device *)
 
Parameters
----------
self: fz_device *
end_tile
fz_device_end_tile_get(fz_device * self) -> void (*)(fz_context *,fz_device *)
 
Parameters
----------
self: fz_device *
fill_image
fz_device_fill_image_get(fz_device * self) -> void (*)(fz_context *,fz_device *,fz_image *,fz_matrix,float,fz_color_params)
 
Parameters
----------
self: fz_device *
fill_image_mask
fz_device_fill_image_mask_get(fz_device * self) -> void (*)(fz_context *,fz_device *,fz_image *,fz_matrix,fz_colorspace *,float const *,float,fz_color_params)
 
Parameters
----------
self: fz_device *
fill_path
fz_device_fill_path_get(fz_device * self) -> void (*)(fz_context *,fz_device *,fz_path const *,int,fz_matrix,fz_colorspace *,float const *,float,fz_color_params)
 
Parameters
----------
self: fz_device *
fill_shade
fz_device_fill_shade_get(fz_device * self) -> void (*)(fz_context *,fz_device *,fz_shade *,fz_matrix,float,fz_color_params)
 
Parameters
----------
self: fz_device *
fill_text
fz_device_fill_text_get(fz_device * self) -> void (*)(fz_context *,fz_device *,fz_text const *,fz_matrix,fz_colorspace *,float const *,float,fz_color_params)
 
Parameters
----------
self: fz_device *
flags
fz_device_flags_get(fz_device * self) -> int
 
Parameters
----------
self: fz_device *
hints
fz_device_hints_get(fz_device * self) -> int
 
Parameters
----------
self: fz_device *
ignore_text
fz_device_ignore_text_get(fz_device * self) -> void (*)(fz_context *,fz_device *,fz_text const *,fz_matrix)
 
Parameters
----------
self: fz_device *
pop_clip
fz_device_pop_clip_get(fz_device * self) -> void (*)(fz_context *,fz_device *)
 
Parameters
----------
self: fz_device *
refs
fz_device_refs_get(fz_device * self) -> int
 
Parameters
----------
self: fz_device *
render_flags
fz_device_render_flags_get(fz_device * self) -> void (*)(fz_context *,fz_device *,int,int)
 
Parameters
----------
self: fz_device *
set_default_colorspaces
fz_device_set_default_colorspaces_get(fz_device * self) -> void (*)(fz_context *,fz_device *,fz_default_colorspaces *)
 
Parameters
----------
self: fz_device *
stroke_path
fz_device_stroke_path_get(fz_device * self) -> void (*)(fz_context *,fz_device *,fz_path const *,fz_stroke_state const *,fz_matrix,fz_colorspace *,float const *,float,fz_color_params)
 
Parameters
----------
self: fz_device *
stroke_text
fz_device_stroke_text_get(fz_device * self) -> void (*)(fz_context *,fz_device *,fz_text const *,fz_stroke_state const *,fz_matrix,fz_colorspace *,float const *,float,fz_color_params)
 
Parameters
----------
self: fz_device *
thisown
The membership flag

 
class fz_device_container_stack(builtins.object)
    The device structure is public to allow devices to be
implemented outside of fitz.
 
Device methods should always be called using e.g.
fz_fill_path(ctx, dev, ...) rather than
dev->fill_path(ctx, dev, ...)
 
Devices can keep track of containers (clips/masks/groups/tiles)
as they go to save callers having to do it.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_device_container_stack(...)
delete_fz_device_container_stack(fz_device_container_stack self)
 
Parameters
----------
self: fz_device_container_stack *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
scissor
fz_device_container_stack_scissor_get(fz_device_container_stack self) -> fz_rect
 
Parameters
----------
self: fz_device_container_stack *
thisown
The membership flag
type
fz_device_container_stack_type_get(fz_device_container_stack self) -> int
 
Parameters
----------
self: fz_device_container_stack *
user
fz_device_container_stack_user_get(fz_device_container_stack self) -> int
 
Parameters
----------
self: fz_device_container_stack *

 
class fz_document(builtins.object)
    Structure definition is public so other classes can
derive from it. Callers should not access the members
directly, though implementations will need initialize
functions directly.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_document(...)
delete_fz_document(fz_document * self)
 
Parameters
----------
self: fz_document *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
authenticate_password
fz_document_authenticate_password_get(fz_document * self) -> fz_document_authenticate_password_fn *
 
Parameters
----------
self: fz_document *
count_chapters
fz_document_count_chapters_get(fz_document * self) -> fz_document_count_chapters_fn *
 
Parameters
----------
self: fz_document *
count_pages
fz_document_count_pages_get(fz_document * self) -> fz_document_count_pages_fn *
 
Parameters
----------
self: fz_document *
did_layout
fz_document_did_layout_get(fz_document * self) -> int
 
Parameters
----------
self: fz_document *
drop_document
fz_document_drop_document_get(fz_document * self) -> fz_document_drop_fn *
 
Parameters
----------
self: fz_document *
get_output_intent
fz_document_get_output_intent_get(fz_document * self) -> fz_document_output_intent_fn *
 
Parameters
----------
self: fz_document *
has_permission
fz_document_has_permission_get(fz_document * self) -> fz_document_has_permission_fn *
 
Parameters
----------
self: fz_document *
is_reflowable
fz_document_is_reflowable_get(fz_document * self) -> int
 
Parameters
----------
self: fz_document *
layout
fz_document_layout_get(fz_document * self) -> fz_document_layout_fn *
 
Parameters
----------
self: fz_document *
load_outline
fz_document_load_outline_get(fz_document * self) -> fz_document_load_outline_fn *
 
Parameters
----------
self: fz_document *
load_page
fz_document_load_page_get(fz_document * self) -> fz_document_load_page_fn *
 
Parameters
----------
self: fz_document *
lookup_bookmark
fz_document_lookup_bookmark_get(fz_document * self) -> fz_document_lookup_bookmark_fn *
 
Parameters
----------
self: fz_document *
lookup_metadata
fz_document_lookup_metadata_get(fz_document * self) -> fz_document_lookup_metadata_fn *
 
Parameters
----------
self: fz_document *
make_bookmark
fz_document_make_bookmark_get(fz_document * self) -> fz_document_make_bookmark_fn *
 
Parameters
----------
self: fz_document *
needs_password
fz_document_needs_password_get(fz_document * self) -> fz_document_needs_password_fn *
 
Parameters
----------
self: fz_document *
open
fz_document_open_get(fz_document * self) -> fz_page *
 
Parameters
----------
self: fz_document *
output_accelerator
fz_document_output_accelerator_get(fz_document * self) -> fz_document_output_accelerator_fn *
 
Parameters
----------
self: fz_document *
refs
fz_document_refs_get(fz_document * self) -> int
 
Parameters
----------
self: fz_document *
resolve_link
fz_document_resolve_link_get(fz_document * self) -> fz_document_resolve_link_fn *
 
Parameters
----------
self: fz_document *
thisown
The membership flag

 
class fz_document_handler(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_document_handler(...)
delete_fz_document_handler(fz_document_handler * self)
 
Parameters
----------
self: fz_document_handler *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
extensions
fz_document_handler_extensions_get(fz_document_handler * self) -> char const **
 
Parameters
----------
self: fz_document_handler *
mimetypes
fz_document_handler_mimetypes_get(fz_document_handler * self) -> char const **
 
Parameters
----------
self: fz_document_handler *
open
fz_document_handler_open_get(fz_document_handler * self) -> fz_document_open_fn *
 
Parameters
----------
self: fz_document_handler *
open_accel
fz_document_handler_open_accel_get(fz_document_handler * self) -> fz_document_open_accel_fn *
 
Parameters
----------
self: fz_document_handler *
open_accel_with_stream
fz_document_handler_open_accel_with_stream_get(fz_document_handler * self) -> fz_document_open_accel_with_stream_fn *
 
Parameters
----------
self: fz_document_handler *
open_with_stream
fz_document_handler_open_with_stream_get(fz_document_handler * self) -> fz_document_open_with_stream_fn *
 
Parameters
----------
self: fz_document_handler *
recognize
fz_document_handler_recognize_get(fz_document_handler * self) -> fz_document_recognize_fn *
 
Parameters
----------
self: fz_document_handler *
thisown
The membership flag

 
class fz_document_writer(builtins.object)
    Structure is public to allow other structures to
be derived from it. Do not access members directly.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_document_writer(...)
delete_fz_document_writer(fz_document_writer * self)
 
Parameters
----------
self: fz_document_writer *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
begin_page
fz_document_writer_begin_page_get(fz_document_writer * self) -> fz_document_writer_begin_page_fn *
 
Parameters
----------
self: fz_document_writer *
close_writer
fz_document_writer_close_writer_get(fz_document_writer * self) -> fz_document_writer_close_writer_fn *
 
Parameters
----------
self: fz_document_writer *
dev
fz_document_writer_dev_get(fz_document_writer * self) -> fz_device *
 
Parameters
----------
self: fz_document_writer *
drop_writer
fz_document_writer_drop_writer_get(fz_document_writer * self) -> fz_document_writer_drop_writer_fn *
 
Parameters
----------
self: fz_document_writer *
end_page
fz_document_writer_end_page_get(fz_document_writer * self) -> fz_document_writer_end_page_fn *
 
Parameters
----------
self: fz_document_writer *
thisown
The membership flag

 
class fz_draw_options(builtins.object)
    struct fz_draw_options: Options for creating a pixmap and draw
device.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_draw_options(...)
delete_fz_draw_options(fz_draw_options self)
 
Parameters
----------
self: fz_draw_options *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
alpha
fz_draw_options_alpha_get(fz_draw_options self) -> int
 
Parameters
----------
self: fz_draw_options *
colorspace
fz_draw_options_colorspace_get(fz_draw_options self) -> fz_colorspace *
 
Parameters
----------
self: fz_draw_options *
graphics
fz_draw_options_graphics_get(fz_draw_options self) -> int
 
Parameters
----------
self: fz_draw_options *
height
fz_draw_options_height_get(fz_draw_options self) -> int
 
Parameters
----------
self: fz_draw_options *
rotate
fz_draw_options_rotate_get(fz_draw_options self) -> int
 
Parameters
----------
self: fz_draw_options *
text
fz_draw_options_text_get(fz_draw_options self) -> int
 
Parameters
----------
self: fz_draw_options *
thisown
The membership flag
width
fz_draw_options_width_get(fz_draw_options self) -> int
 
Parameters
----------
self: fz_draw_options *
x_resolution
fz_draw_options_x_resolution_get(fz_draw_options self) -> int
 
Parameters
----------
self: fz_draw_options *
y_resolution
fz_draw_options_y_resolution_get(fz_draw_options self) -> int
 
Parameters
----------
self: fz_draw_options *

 
class fz_error_context(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_error_context(...)
delete_fz_error_context(fz_error_context self)
 
Parameters
----------
self: fz_error_context *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
errcode
fz_error_context_errcode_get(fz_error_context self) -> int
 
Parameters
----------
self: fz_error_context *
message
fz_error_context_message_get(fz_error_context self) -> char [256]
 
Parameters
----------
self: fz_error_context *
print_user
fz_error_context_print_user_get(fz_error_context self) -> void *
 
Parameters
----------
self: fz_error_context *
stack
fz_error_context_stack_get(fz_error_context self) -> fz_error_stack_slot [256]
 
Parameters
----------
self: fz_error_context *
thisown
The membership flag
top
fz_error_context_top_get(fz_error_context self) -> fz_error_stack_slot *
 
Parameters
----------
self: fz_error_context *

 
class fz_font(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_font(...)
delete_fz_font(fz_font * self)
 
Parameters
----------
self: fz_font *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
advance_cache
fz_font_advance_cache_get(fz_font * self) -> float *
 
Parameters
----------
self: fz_font *
bbox
fz_font_bbox_get(fz_font * self) -> fz_rect
 
Parameters
----------
self: fz_font *
bbox_table
fz_font_bbox_table_get(fz_font * self) -> fz_rect
 
Parameters
----------
self: fz_font *
buffer
fz_font_buffer_get(fz_font * self) -> fz_buffer
 
Parameters
----------
self: fz_font *
digest
fz_font_digest_get(fz_font * self) -> unsigned char [16]
 
Parameters
----------
self: fz_font *
encoding_cache
fz_font_encoding_cache_get(fz_font * self) -> uint16_t *[256]
 
Parameters
----------
self: fz_font *
flags
fz_font_flags_get(fz_font * self) -> fz_font_flags_t
 
Parameters
----------
self: fz_font *
ft_face
fz_font_ft_face_get(fz_font * self) -> void *
 
Parameters
----------
self: fz_font *
glyph_count
fz_font_glyph_count_get(fz_font * self) -> int
 
Parameters
----------
self: fz_font *
has_digest
fz_font_has_digest_get(fz_font * self) -> int
 
Parameters
----------
self: fz_font *
name
fz_font_name_get(fz_font * self) -> char [32]
 
Parameters
----------
self: fz_font *
refs
fz_font_refs_get(fz_font * self) -> int
 
Parameters
----------
self: fz_font *
shaper_data
fz_font_shaper_data_get(fz_font * self) -> fz_shaper_data_t
 
Parameters
----------
self: fz_font *
t3doc
fz_font_t3doc_get(fz_font * self) -> void *
 
Parameters
----------
self: fz_font *
t3flags
fz_font_t3flags_get(fz_font * self) -> unsigned short *
 
Parameters
----------
self: fz_font *
t3freeres
fz_font_t3freeres_get(fz_font * self) -> void (*)(fz_context *,void *,void *)
 
Parameters
----------
self: fz_font *
t3lists
fz_font_t3lists_get(fz_font * self) -> fz_display_list **
 
Parameters
----------
self: fz_font *
t3matrix
fz_font_t3matrix_get(fz_font * self) -> fz_matrix
 
Parameters
----------
self: fz_font *
t3procs
fz_font_t3procs_get(fz_font * self) -> fz_buffer **
 
Parameters
----------
self: fz_font *
t3resources
fz_font_t3resources_get(fz_font * self) -> void *
 
Parameters
----------
self: fz_font *
t3run
fz_font_t3run_get(fz_font * self) -> void (*)(fz_context *,void *,void *,fz_buffer *,fz_device *,fz_matrix,void *,fz_default_colorspaces *)
 
Parameters
----------
self: fz_font *
t3widths
fz_font_t3widths_get(fz_font * self) -> float *
 
Parameters
----------
self: fz_font *
thisown
The membership flag
width_count
fz_font_width_count_get(fz_font * self) -> int
 
Parameters
----------
self: fz_font *
width_default
fz_font_width_default_get(fz_font * self) -> short
 
Parameters
----------
self: fz_font *
width_table
fz_font_width_table_get(fz_font * self) -> short *
 
Parameters
----------
self: fz_font *

 
class fz_font_flags_t(builtins.object)
    Every fz_font carries a set of flags
within it, in a fz_font_flags_t structure.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_font_flags_t(...)
delete_fz_font_flags_t(fz_font_flags_t self)
 
Parameters
----------
self: fz_font_flags_t *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
fake_bold
fz_font_flags_t_fake_bold_get(fz_font_flags_t self) -> unsigned int
 
Parameters
----------
self: fz_font_flags_t *
fake_italic
fz_font_flags_t_fake_italic_get(fz_font_flags_t self) -> unsigned int
 
Parameters
----------
self: fz_font_flags_t *
ft_stretch
fz_font_flags_t_ft_stretch_get(fz_font_flags_t self) -> unsigned int
 
Parameters
----------
self: fz_font_flags_t *
ft_substitute
fz_font_flags_t_ft_substitute_get(fz_font_flags_t self) -> unsigned int
 
Parameters
----------
self: fz_font_flags_t *
has_opentype
fz_font_flags_t_has_opentype_get(fz_font_flags_t self) -> unsigned int
 
Parameters
----------
self: fz_font_flags_t *
invalid_bbox
fz_font_flags_t_invalid_bbox_get(fz_font_flags_t self) -> unsigned int
 
Parameters
----------
self: fz_font_flags_t *
is_bold
fz_font_flags_t_is_bold_get(fz_font_flags_t self) -> unsigned int
 
Parameters
----------
self: fz_font_flags_t *
is_italic
fz_font_flags_t_is_italic_get(fz_font_flags_t self) -> unsigned int
 
Parameters
----------
self: fz_font_flags_t *
is_mono
fz_font_flags_t_is_mono_get(fz_font_flags_t self) -> unsigned int
 
Parameters
----------
self: fz_font_flags_t *
is_serif
fz_font_flags_t_is_serif_get(fz_font_flags_t self) -> unsigned int
 
Parameters
----------
self: fz_font_flags_t *
thisown
The membership flag

 
class fz_image(builtins.object)
    Structure is public to allow other structures to
be derived from it. Do not access members directly.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_image(...)
delete_fz_image(fz_image * self)
 
Parameters
----------
self: fz_image *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
bpc
fz_image_bpc_get(fz_image * self) -> uint8_t
 
Parameters
----------
self: fz_image *
colorkey
fz_image_colorkey_get(fz_image * self) -> int [FZ_MAX_COLORS*2]
 
Parameters
----------
self: fz_image *
colorspace
fz_image_colorspace_get(fz_image * self) -> fz_colorspace *
 
Parameters
----------
self: fz_image *
decode
fz_image_decode_get(fz_image * self) -> float [FZ_MAX_COLORS*2]
 
Parameters
----------
self: fz_image *
decoded
fz_image_decoded_get(fz_image * self) -> unsigned int
 
Parameters
----------
self: fz_image *
drop_image
fz_image_drop_image_get(fz_image * self) -> fz_drop_image_fn *
 
Parameters
----------
self: fz_image *
get_pixmap
fz_image_get_pixmap_get(fz_image * self) -> fz_image_get_pixmap_fn *
 
Parameters
----------
self: fz_image *
get_size
fz_image_get_size_get(fz_image * self) -> fz_image_get_size_fn *
 
Parameters
----------
self: fz_image *
h
fz_image_h_get(fz_image * self) -> int
 
Parameters
----------
self: fz_image *
imagemask
fz_image_imagemask_get(fz_image * self) -> unsigned int
 
Parameters
----------
self: fz_image *
interpolate
fz_image_interpolate_get(fz_image * self) -> unsigned int
 
Parameters
----------
self: fz_image *
invert_cmyk_jpeg
fz_image_invert_cmyk_jpeg_get(fz_image * self) -> unsigned int
 
Parameters
----------
self: fz_image *
key_storable
fz_image_key_storable_get(fz_image * self) -> fz_key_storable
 
Parameters
----------
self: fz_image *
mask
fz_image_mask_get(fz_image * self) -> fz_image *
 
Parameters
----------
self: fz_image *
n
fz_image_n_get(fz_image * self) -> uint8_t
 
Parameters
----------
self: fz_image *
scalable
fz_image_scalable_get(fz_image * self) -> unsigned int
 
Parameters
----------
self: fz_image *
thisown
The membership flag
use_colorkey
fz_image_use_colorkey_get(fz_image * self) -> unsigned int
 
Parameters
----------
self: fz_image *
use_decode
fz_image_use_decode_get(fz_image * self) -> unsigned int
 
Parameters
----------
self: fz_image *
w
fz_image_w_get(fz_image * self) -> int
 
Parameters
----------
self: fz_image *
xres
fz_image_xres_get(fz_image * self) -> int
 
Parameters
----------
self: fz_image *
yres
fz_image_yres_get(fz_image * self) -> int
 
Parameters
----------
self: fz_image *

 
class fz_irect(builtins.object)
    fz_irect is a rectangle using integers instead of floats.
 
It's used in the draw device and for pixmap dimensions.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_irect(...)
delete_fz_irect(fz_irect self)
 
Parameters
----------
self: fz_irect *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag
x0
fz_irect_x0_get(fz_irect self) -> int
 
Parameters
----------
self: fz_irect *
x1
fz_irect_x1_get(fz_irect self) -> int
 
Parameters
----------
self: fz_irect *
y0
fz_irect_y0_get(fz_irect self) -> int
 
Parameters
----------
self: fz_irect *
y1
fz_irect_y1_get(fz_irect self) -> int
 
Parameters
----------
self: fz_irect *

 
class fz_key_storable(builtins.object)
    Any storable object that can appear in the key of another
storable object should include an fz_key_storable structure
at the start (by convention at least) of their structure.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_key_storable(...)
delete_fz_key_storable(fz_key_storable self)
 
Parameters
----------
self: fz_key_storable *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
storable
fz_key_storable_storable_get(fz_key_storable self) -> fz_storable *
 
Parameters
----------
self: fz_key_storable *
store_key_refs
fz_key_storable_store_key_refs_get(fz_key_storable self) -> short
 
Parameters
----------
self: fz_key_storable *
thisown
The membership flag

 
class fz_layout_block(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_layout_block(...)
delete_fz_layout_block(fz_layout_block self)
 
Parameters
----------
self: fz_layout_block *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
head
fz_layout_block_head_get(fz_layout_block self) -> fz_layout_line
 
Parameters
----------
self: fz_layout_block *
inv_matrix
fz_layout_block_inv_matrix_get(fz_layout_block self) -> fz_matrix
 
Parameters
----------
self: fz_layout_block *
matrix
fz_layout_block_matrix_get(fz_layout_block self) -> fz_matrix
 
Parameters
----------
self: fz_layout_block *
pool
fz_layout_block_pool_get(fz_layout_block self) -> fz_pool *
 
Parameters
----------
self: fz_layout_block *
tailp
fz_layout_block_tailp_get(fz_layout_block self) -> fz_layout_line **
 
Parameters
----------
self: fz_layout_block *
text_tailp
fz_layout_block_text_tailp_get(fz_layout_block self) -> fz_layout_char **
 
Parameters
----------
self: fz_layout_block *
thisown
The membership flag

 
class fz_layout_char(builtins.object)
    Simple text layout (for use with annotation editing primarily).
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_layout_char(...)
delete_fz_layout_char(fz_layout_char self)
 
Parameters
----------
self: fz_layout_char *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
next
fz_layout_char_next_get(fz_layout_char self) -> fz_layout_char
 
Parameters
----------
self: fz_layout_char *
p
fz_layout_char_p_get(fz_layout_char self) -> char const *
 
Parameters
----------
self: fz_layout_char *
thisown
The membership flag
w
fz_layout_char_w_get(fz_layout_char self) -> float
 
Parameters
----------
self: fz_layout_char *
x
fz_layout_char_x_get(fz_layout_char self) -> float
 
Parameters
----------
self: fz_layout_char *

 
class fz_layout_line(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_layout_line(...)
delete_fz_layout_line(fz_layout_line self)
 
Parameters
----------
self: fz_layout_line *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
h
fz_layout_line_h_get(fz_layout_line self) -> float
 
Parameters
----------
self: fz_layout_line *
next
fz_layout_line_next_get(fz_layout_line self) -> fz_layout_line
 
Parameters
----------
self: fz_layout_line *
p
fz_layout_line_p_get(fz_layout_line self) -> char const *
 
Parameters
----------
self: fz_layout_line *
text
fz_layout_line_text_get(fz_layout_line self) -> fz_layout_char
 
Parameters
----------
self: fz_layout_line *
thisown
The membership flag
x
fz_layout_line_x_get(fz_layout_line self) -> float
 
Parameters
----------
self: fz_layout_line *
y
fz_layout_line_y_get(fz_layout_line self) -> float
 
Parameters
----------
self: fz_layout_line *

 
class fz_link(builtins.object)
    fz_link is a list of interactive links on a page.
 
There is no relation between the order of the links in the
list and the order they appear on the page. The list of links
for a given page can be obtained from fz_load_links.
 
A link is reference counted. Dropping a reference to a link is
done by calling fz_drop_link.
 
rect: The hot zone. The area that can be clicked in
untransformed coordinates.
 
uri: Link destinations come in two forms: internal and external.
Internal links refer to other pages in the same document.
External links are URLs to other documents.
 
doc: Typically a pointer to the enclosing document. Note that
this pointer is opaque, and NOT a counted reference. Beware of
lifespan issues.
 
next: A pointer to the next link on the same page.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_link(...)
delete_fz_link(fz_link self)
 
Parameters
----------
self: fz_link *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
doc
fz_link_doc_get(fz_link self) -> void *
 
Parameters
----------
self: fz_link *
next
fz_link_next_get(fz_link self) -> fz_link
 
Parameters
----------
self: fz_link *
rect
fz_link_rect_get(fz_link self) -> fz_rect
 
Parameters
----------
self: fz_link *
refs
fz_link_refs_get(fz_link self) -> int
 
Parameters
----------
self: fz_link *
thisown
The membership flag
uri
fz_link_uri_get(fz_link self) -> char *
 
Parameters
----------
self: fz_link *

 
class fz_location(builtins.object)
    Locations within the document are referred to in terms of
chapter and page, rather than just a page number. For some
documents (such as epub documents with large numbers of pages
broken into many chapters) this can make navigation much faster
as only the required chapter needs to be decoded at a time.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_location(...)
delete_fz_location(fz_location self)
 
Parameters
----------
self: fz_location *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
chapter
fz_location_chapter_get(fz_location self) -> int
 
Parameters
----------
self: fz_location *
page
fz_location_page_get(fz_location self) -> int
 
Parameters
----------
self: fz_location *
thisown
The membership flag

 
class fz_locks_context(builtins.object)
    Locking functions
 
MuPDF is kept deliberately free of any knowledge of particular
threading systems. As such, in order for safe multi-threaded
operation, we rely on callbacks to client provided functions.
 
A client is expected to provide FZ_LOCK_MAX number of mutexes,
and a function to lock/unlock each of them. These may be
recursive mutexes, but do not have to be.
 
If a client does not intend to use multiple threads, then it
may pass NULL instead of a lock structure.
 
In order to avoid deadlocks, we have one simple rule
internally as to how we use locks: We can never take lock n
when we already hold any lock i, where 0 <= i <= n. In order
to verify this, we have some debugging code, that can be
enabled by defining FITZ_DEBUG_LOCKING.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_locks_context(...)
delete_fz_locks_context(fz_locks_context self)
 
Parameters
----------
self: fz_locks_context *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
lock
fz_locks_context_lock_get(fz_locks_context self) -> void (*)(void *,int)
 
Parameters
----------
self: fz_locks_context *
thisown
The membership flag
unlock
fz_locks_context_unlock_get(fz_locks_context self) -> void (*)(void *,int)
 
Parameters
----------
self: fz_locks_context *
user
fz_locks_context_user_get(fz_locks_context self) -> void *
 
Parameters
----------
self: fz_locks_context *

 
class fz_matrix(builtins.object)
        fz_matrix is a row-major 3x3 matrix used for representing
    transformations of coordinates throughout MuPDF.
 
    Since all points reside in a two-dimensional space, one vector
    is always a constant unit vector; hence only some elements may
    vary in a matrix. Below is how the elements map between
    different representations.
 
a b 0
    | c d 0 | normally represented as [ a b c d e f ].
    \ e f 1 /
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_matrix(...)
delete_fz_matrix(fz_matrix self)
 
Parameters
----------
self: fz_matrix *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
a
fz_matrix_a_get(fz_matrix self) -> float
 
Parameters
----------
self: fz_matrix *
b
fz_matrix_b_get(fz_matrix self) -> float
 
Parameters
----------
self: fz_matrix *
c
fz_matrix_c_get(fz_matrix self) -> float
 
Parameters
----------
self: fz_matrix *
d
fz_matrix_d_get(fz_matrix self) -> float
 
Parameters
----------
self: fz_matrix *
e
fz_matrix_e_get(fz_matrix self) -> float
 
Parameters
----------
self: fz_matrix *
f
fz_matrix_f_get(fz_matrix self) -> float
 
Parameters
----------
self: fz_matrix *
thisown
The membership flag

 
class fz_md5(builtins.object)
    Structure definition is public to enable stack
based allocation. Do not access the members directly.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_md5(...)
delete_fz_md5(fz_md5 self)
 
Parameters
----------
self: fz_md5 *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
buffer
fz_md5_buffer_get(fz_md5 self) -> unsigned char [64]
 
Parameters
----------
self: fz_md5 *
count
fz_md5_count_get(fz_md5 self) -> unsigned int [2]
 
Parameters
----------
self: fz_md5 *
state
fz_md5_state_get(fz_md5 self) -> unsigned int [4]
 
Parameters
----------
self: fz_md5 *
thisown
The membership flag

 
class fz_outline(builtins.object)
    fz_outline is a tree of the outline of a document (also known
as table of contents).
 
title: Title of outline item using UTF-8 encoding. May be NULL
if the outline item has no text string.
 
uri: Destination in the document to be displayed when this
outline item is activated. May be an internal or external
link, or NULL if the outline item does not have a destination.
 
page: The page number of an internal link, or -1 for external
links or links with no destination.
 
next: The next outline item at the same level as this outline
item. May be NULL if no more outline items exist at this level.
 
down: The outline items immediate children in the hierarchy.
May be NULL if no children exist.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_outline(...)
delete_fz_outline(fz_outline self)
 
Parameters
----------
self: fz_outline *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
down
fz_outline_down_get(fz_outline self) -> fz_outline
 
Parameters
----------
self: fz_outline *
is_open
fz_outline_is_open_get(fz_outline self) -> int
 
Parameters
----------
self: fz_outline *
next
fz_outline_next_get(fz_outline self) -> fz_outline
 
Parameters
----------
self: fz_outline *
page
fz_outline_page_get(fz_outline self) -> int
 
Parameters
----------
self: fz_outline *
refs
fz_outline_refs_get(fz_outline self) -> int
 
Parameters
----------
self: fz_outline *
thisown
The membership flag
title
fz_outline_title_get(fz_outline self) -> char *
 
Parameters
----------
self: fz_outline *
uri
fz_outline_uri_get(fz_outline self) -> char *
 
Parameters
----------
self: fz_outline *
x
fz_outline_x_get(fz_outline self) -> float
 
Parameters
----------
self: fz_outline *
y
fz_outline_y_get(fz_outline self) -> float
 
Parameters
----------
self: fz_outline *

 
class fz_output(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_output(...)
delete_fz_output(fz_output self)
 
Parameters
----------
self: fz_output *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
as_stream
fz_output_as_stream_get(fz_output self) -> fz_stream_from_output_fn *
 
Parameters
----------
self: fz_output *
bp
fz_output_bp_get(fz_output self) -> char *
 
Parameters
----------
self: fz_output *
close
fz_output_close_get(fz_output self) -> fz_output_close_fn *
 
Parameters
----------
self: fz_output *
drop
fz_output_drop_get(fz_output self) -> fz_output_drop_fn *
 
Parameters
----------
self: fz_output *
ep
fz_output_ep_get(fz_output self) -> char *
 
Parameters
----------
self: fz_output *
seek
fz_output_seek_get(fz_output self) -> fz_output_seek_fn *
 
Parameters
----------
self: fz_output *
state
fz_output_state_get(fz_output self) -> void *
 
Parameters
----------
self: fz_output *
tell
fz_output_tell_get(fz_output self) -> fz_output_tell_fn *
 
Parameters
----------
self: fz_output *
thisown
The membership flag
truncate
fz_output_truncate_get(fz_output self) -> fz_truncate_fn *
 
Parameters
----------
self: fz_output *
wp
fz_output_wp_get(fz_output self) -> char *
 
Parameters
----------
self: fz_output *
write
fz_output_write_get(fz_output self) -> fz_output_write_fn *
 
Parameters
----------
self: fz_output *

 
class fz_page(builtins.object)
    Structure definition is public so other classes can
derive from it. Do not access the members directly.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_page(...)
delete_fz_page(fz_page * self)
 
Parameters
----------
self: fz_page *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
bound_page
fz_page_bound_page_get(fz_page * self) -> fz_page_bound_page_fn *
 
Parameters
----------
self: fz_page *
chapter
fz_page_chapter_get(fz_page * self) -> int
 
Parameters
----------
self: fz_page *
control_separation
fz_page_control_separation_get(fz_page * self) -> fz_page_control_separation_fn *
 
Parameters
----------
self: fz_page *
drop_page
fz_page_drop_page_get(fz_page * self) -> fz_page_drop_page_fn *
 
Parameters
----------
self: fz_page *
incomplete
fz_page_incomplete_get(fz_page * self) -> int
 
Parameters
----------
self: fz_page *
load_links
fz_page_load_links_get(fz_page * self) -> fz_page_load_links_fn *
 
Parameters
----------
self: fz_page *
next
fz_page_next_get(fz_page * self) -> fz_page *
 
Parameters
----------
self: fz_page *
number
fz_page_number_get(fz_page * self) -> int
 
Parameters
----------
self: fz_page *
overprint
fz_page_overprint_get(fz_page * self) -> fz_page_uses_overprint_fn *
 
Parameters
----------
self: fz_page *
page_presentation
fz_page_page_presentation_get(fz_page * self) -> fz_page_page_presentation_fn *
 
Parameters
----------
self: fz_page *
prev
fz_page_prev_get(fz_page * self) -> fz_page **
 
Parameters
----------
self: fz_page *
refs
fz_page_refs_get(fz_page * self) -> int
 
Parameters
----------
self: fz_page *
run_page_annots
fz_page_run_page_annots_get(fz_page * self) -> fz_page_run_page_fn *
 
Parameters
----------
self: fz_page *
run_page_contents
fz_page_run_page_contents_get(fz_page * self) -> fz_page_run_page_fn *
 
Parameters
----------
self: fz_page *
run_page_widgets
fz_page_run_page_widgets_get(fz_page * self) -> fz_page_run_page_fn *
 
Parameters
----------
self: fz_page *
separation_disabled
fz_page_separation_disabled_get(fz_page * self) -> fz_page_separation_disabled_fn *
 
Parameters
----------
self: fz_page *
separations
fz_page_separations_get(fz_page * self) -> fz_page_separations_fn *
 
Parameters
----------
self: fz_page *
thisown
The membership flag

 
class fz_path_walker(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_path_walker(...)
delete_fz_path_walker(fz_path_walker self)
 
Parameters
----------
self: fz_path_walker *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
closepath
fz_path_walker_closepath_get(fz_path_walker self) -> void (*)(fz_context *,void *)
 
Parameters
----------
self: fz_path_walker *
curveto
fz_path_walker_curveto_get(fz_path_walker self) -> void (*)(fz_context *,void *,float,float,float,float,float,float)
 
Parameters
----------
self: fz_path_walker *
curvetov
fz_path_walker_curvetov_get(fz_path_walker self) -> void (*)(fz_context *,void *,float,float,float,float)
 
Parameters
----------
self: fz_path_walker *
curvetoy
fz_path_walker_curvetoy_get(fz_path_walker self) -> void (*)(fz_context *,void *,float,float,float,float)
 
Parameters
----------
self: fz_path_walker *
lineto
fz_path_walker_lineto_get(fz_path_walker self) -> void (*)(fz_context *,void *,float,float)
 
Parameters
----------
self: fz_path_walker *
moveto
fz_path_walker_moveto_get(fz_path_walker self) -> void (*)(fz_context *,void *,float,float)
 
Parameters
----------
self: fz_path_walker *
quadto
fz_path_walker_quadto_get(fz_path_walker self) -> void (*)(fz_context *,void *,float,float,float,float)
 
Parameters
----------
self: fz_path_walker *
rectto
fz_path_walker_rectto_get(fz_path_walker self) -> void (*)(fz_context *,void *,float,float,float,float)
 
Parameters
----------
self: fz_path_walker *
thisown
The membership flag

 
class fz_pcl_options(builtins.object)
    PCL output
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_pcl_options(...)
delete_fz_pcl_options(fz_pcl_options self)
 
Parameters
----------
self: fz_pcl_options *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
duplex
fz_pcl_options_duplex_get(fz_pcl_options self) -> int
 
Parameters
----------
self: fz_pcl_options *
duplex_set
fz_pcl_options_duplex_set_get(fz_pcl_options self) -> int
 
Parameters
----------
self: fz_pcl_options *
even_page_init
fz_pcl_options_even_page_init_get(fz_pcl_options self) -> char const *
 
Parameters
----------
self: fz_pcl_options *
features
fz_pcl_options_features_get(fz_pcl_options self) -> int
 
Parameters
----------
self: fz_pcl_options *
manual_feed
fz_pcl_options_manual_feed_get(fz_pcl_options self) -> int
 
Parameters
----------
self: fz_pcl_options *
manual_feed_set
fz_pcl_options_manual_feed_set_get(fz_pcl_options self) -> int
 
Parameters
----------
self: fz_pcl_options *
media_position
fz_pcl_options_media_position_get(fz_pcl_options self) -> int
 
Parameters
----------
self: fz_pcl_options *
media_position_set
fz_pcl_options_media_position_set_get(fz_pcl_options self) -> int
 
Parameters
----------
self: fz_pcl_options *
odd_page_init
fz_pcl_options_odd_page_init_get(fz_pcl_options self) -> char const *
 
Parameters
----------
self: fz_pcl_options *
orientation
fz_pcl_options_orientation_get(fz_pcl_options self) -> int
 
Parameters
----------
self: fz_pcl_options *
page_count
fz_pcl_options_page_count_get(fz_pcl_options self) -> int
 
Parameters
----------
self: fz_pcl_options *
paper_size
fz_pcl_options_paper_size_get(fz_pcl_options self) -> int
 
Parameters
----------
self: fz_pcl_options *
thisown
The membership flag
tumble
fz_pcl_options_tumble_get(fz_pcl_options self) -> int
 
Parameters
----------
self: fz_pcl_options *

 
class fz_pclm_options(builtins.object)
    PCLm output
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_pclm_options(...)
delete_fz_pclm_options(fz_pclm_options self)
 
Parameters
----------
self: fz_pclm_options *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
compress
fz_pclm_options_compress_get(fz_pclm_options self) -> int
 
Parameters
----------
self: fz_pclm_options *
page_count
fz_pclm_options_page_count_get(fz_pclm_options self) -> int
 
Parameters
----------
self: fz_pclm_options *
strip_height
fz_pclm_options_strip_height_get(fz_pclm_options self) -> int
 
Parameters
----------
self: fz_pclm_options *
thisown
The membership flag

 
class fz_pixmap(builtins.object)
    Pixmaps represent a set of pixels for a 2 dimensional region of
a plane. Each pixel has n components per pixel. The components
are in the order process-components, spot-colors, alpha, where
there can be 0 of any of those types. The data is in
premultiplied alpha when rendering, but non-premultiplied for
colorspace conversions and rescaling.
 
x, y: The minimum x and y coord of the region in pixels.
 
w, h: The width and height of the region in pixels.
 
n: The number of color components in the image.
    n = num composite colors + num spots + num alphas
 
s: The number of spot channels in the image.
 
alpha: 0 for no alpha, 1 for alpha present.
 
flags: flag bits.
    Bit 0: If set, draw the image with linear interpolation.
    Bit 1: If set, free the samples buffer when the pixmap
    is destroyed.
 
stride: The byte offset from the data for any given pixel
to the data for the same pixel on the row below.
 
seps: NULL, or a pointer to a separations structure. If NULL,
s should be 0.
 
xres, yres: Image resolution in dpi. Default is 96 dpi.
 
colorspace: Pointer to a colorspace object describing the
colorspace the pixmap is in. If NULL, the image is a mask.
 
samples: Pointer to the first byte of the pixmap sample data.
This is typically a simple block of memory w * h * n bytes of
memory in which the components are stored linearly, but with the
use of appropriate stride values, scanlines can be stored in
different orders, and have different amounts of padding. The
first n bytes are components 0 to n-1 for the pixel at (x,y).
Each successive n bytes gives another pixel in scanline order
as we move across the line. The start of each scanline is offset
the start of the previous one by stride bytes.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_pixmap(...)
delete_fz_pixmap(fz_pixmap * self)
 
Parameters
----------
self: fz_pixmap *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
alpha
fz_pixmap_alpha_get(fz_pixmap * self) -> unsigned char
 
Parameters
----------
self: fz_pixmap *
colorspace
fz_pixmap_colorspace_get(fz_pixmap * self) -> fz_colorspace *
 
Parameters
----------
self: fz_pixmap *
flags
fz_pixmap_flags_get(fz_pixmap * self) -> unsigned char
 
Parameters
----------
self: fz_pixmap *
h
fz_pixmap_h_get(fz_pixmap * self) -> int
 
Parameters
----------
self: fz_pixmap *
n
fz_pixmap_n_get(fz_pixmap * self) -> unsigned char
 
Parameters
----------
self: fz_pixmap *
s
fz_pixmap_s_get(fz_pixmap * self) -> unsigned char
 
Parameters
----------
self: fz_pixmap *
samples
fz_pixmap_samples_get(fz_pixmap * self) -> unsigned char *
 
Parameters
----------
self: fz_pixmap *
seps
fz_pixmap_seps_get(fz_pixmap * self) -> fz_separations *
 
Parameters
----------
self: fz_pixmap *
storable
fz_pixmap_storable_get(fz_pixmap * self) -> fz_storable *
 
Parameters
----------
self: fz_pixmap *
stride
fz_pixmap_stride_get(fz_pixmap * self) -> ptrdiff_t
 
Parameters
----------
self: fz_pixmap *
thisown
The membership flag
underlying
fz_pixmap_underlying_get(fz_pixmap * self) -> fz_pixmap *
 
Parameters
----------
self: fz_pixmap *
w
fz_pixmap_w_get(fz_pixmap * self) -> int
 
Parameters
----------
self: fz_pixmap *
x
fz_pixmap_x_get(fz_pixmap * self) -> int
 
Parameters
----------
self: fz_pixmap *
xres
fz_pixmap_xres_get(fz_pixmap * self) -> int
 
Parameters
----------
self: fz_pixmap *
y
fz_pixmap_y_get(fz_pixmap * self) -> int
 
Parameters
----------
self: fz_pixmap *
yres
fz_pixmap_yres_get(fz_pixmap * self) -> int
 
Parameters
----------
self: fz_pixmap *

 
class fz_point(builtins.object)
    fz_point is a point in a two-dimensional space.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_point(...)
delete_fz_point(fz_point self)
 
Parameters
----------
self: fz_point *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag
x
fz_point_x_get(fz_point self) -> float
 
Parameters
----------
self: fz_point *
y
fz_point_y_get(fz_point self) -> float
 
Parameters
----------
self: fz_point *

 
class fz_pwg_options(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_pwg_options(...)
delete_fz_pwg_options(fz_pwg_options self)
 
Parameters
----------
self: fz_pwg_options *

Data descriptors defined here:
PageSize
fz_pwg_options_PageSize_get(fz_pwg_options self) -> unsigned int [2]
 
Parameters
----------
self: fz_pwg_options *
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
advance_distance
fz_pwg_options_advance_distance_get(fz_pwg_options self) -> unsigned int
 
Parameters
----------
self: fz_pwg_options *
advance_media
fz_pwg_options_advance_media_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *
collate
fz_pwg_options_collate_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *
compression
fz_pwg_options_compression_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *
cut_media
fz_pwg_options_cut_media_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *
duplex
fz_pwg_options_duplex_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *
insert_sheet
fz_pwg_options_insert_sheet_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *
jog
fz_pwg_options_jog_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *
leading_edge
fz_pwg_options_leading_edge_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *
manual_feed
fz_pwg_options_manual_feed_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *
media_class
fz_pwg_options_media_class_get(fz_pwg_options self) -> char [64]
 
Parameters
----------
self: fz_pwg_options *
media_color
fz_pwg_options_media_color_get(fz_pwg_options self) -> char [64]
 
Parameters
----------
self: fz_pwg_options *
media_position
fz_pwg_options_media_position_get(fz_pwg_options self) -> unsigned int
 
Parameters
----------
self: fz_pwg_options *
media_type
fz_pwg_options_media_type_get(fz_pwg_options self) -> char [64]
 
Parameters
----------
self: fz_pwg_options *
media_type_num
fz_pwg_options_media_type_num_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *
media_weight
fz_pwg_options_media_weight_get(fz_pwg_options self) -> unsigned int
 
Parameters
----------
self: fz_pwg_options *
mirror_print
fz_pwg_options_mirror_print_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *
negative_print
fz_pwg_options_negative_print_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *
num_copies
fz_pwg_options_num_copies_get(fz_pwg_options self) -> unsigned int
 
Parameters
----------
self: fz_pwg_options *
orientation
fz_pwg_options_orientation_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *
output_face_up
fz_pwg_options_output_face_up_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *
output_type
fz_pwg_options_output_type_get(fz_pwg_options self) -> char [64]
 
Parameters
----------
self: fz_pwg_options *
page_size_name
fz_pwg_options_page_size_name_get(fz_pwg_options self) -> char [64]
 
Parameters
----------
self: fz_pwg_options *
rendering_intent
fz_pwg_options_rendering_intent_get(fz_pwg_options self) -> char [64]
 
Parameters
----------
self: fz_pwg_options *
row_count
fz_pwg_options_row_count_get(fz_pwg_options self) -> unsigned int
 
Parameters
----------
self: fz_pwg_options *
row_feed
fz_pwg_options_row_feed_get(fz_pwg_options self) -> unsigned int
 
Parameters
----------
self: fz_pwg_options *
row_step
fz_pwg_options_row_step_get(fz_pwg_options self) -> unsigned int
 
Parameters
----------
self: fz_pwg_options *
separations
fz_pwg_options_separations_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *
thisown
The membership flag
tray_switch
fz_pwg_options_tray_switch_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *
tumble
fz_pwg_options_tumble_get(fz_pwg_options self) -> int
 
Parameters
----------
self: fz_pwg_options *

 
class fz_quad(builtins.object)
    A representation for a region defined by 4 points.
 
The significant difference between quads and rects is that
the edges of quads are not axis aligned.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_quad(...)
delete_fz_quad(fz_quad self)
 
Parameters
----------
self: fz_quad *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
ll
fz_quad_ll_get(fz_quad self) -> fz_point
 
Parameters
----------
self: fz_quad *
lr
fz_quad_lr_get(fz_quad self) -> fz_point
 
Parameters
----------
self: fz_quad *
thisown
The membership flag
ul
fz_quad_ul_get(fz_quad self) -> fz_point
 
Parameters
----------
self: fz_quad *
ur
fz_quad_ur_get(fz_quad self) -> fz_point
 
Parameters
----------
self: fz_quad *

 
class fz_range(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_range(...)
delete_fz_range(fz_range self)
 
Parameters
----------
self: fz_range *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
length
fz_range_length_get(fz_range self) -> size_t
 
Parameters
----------
self: fz_range *
offset
fz_range_offset_get(fz_range self) -> int64_t
 
Parameters
----------
self: fz_range *
thisown
The membership flag

 
class fz_rect(builtins.object)
    fz_rect is a rectangle represented by two diagonally opposite
corners at arbitrary coordinates.
 
Rectangles are always axis-aligned with the X- and Y- axes.
The relationship between the coordinates are that x0 <= x1 and
y0 <= y1 in all cases except for infinite rectangles. The area
of a rectangle is defined as (x1 - x0) * (y1 - y0). If either
x0 > x1 or y0 > y1 is true for a given rectangle then it is
defined to be infinite.
 
To check for empty or infinite rectangles use fz_is_empty_rect
and fz_is_infinite_rect.
 
x0, y0: The top left corner.
 
x1, y1: The bottom right corner.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_rect(...)
delete_fz_rect(fz_rect self)
 
Parameters
----------
self: fz_rect *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag
x0
fz_rect_x0_get(fz_rect self) -> float
 
Parameters
----------
self: fz_rect *
x1
fz_rect_x1_get(fz_rect self) -> float
 
Parameters
----------
self: fz_rect *
y0
fz_rect_y0_get(fz_rect self) -> float
 
Parameters
----------
self: fz_rect *
y1
fz_rect_y1_get(fz_rect self) -> float
 
Parameters
----------
self: fz_rect *

 
class fz_sha256(builtins.object)
    Structure definition is public to enable stack
based allocation. Do not access the members directly.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_sha256(...)
delete_fz_sha256(fz_sha256 self)
 
Parameters
----------
self: fz_sha256 *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
count
fz_sha256_count_get(fz_sha256 self) -> unsigned int [2]
 
Parameters
----------
self: fz_sha256 *
state
fz_sha256_state_get(fz_sha256 self) -> unsigned int [8]
 
Parameters
----------
self: fz_sha256 *
thisown
The membership flag

 
class fz_sha512(builtins.object)
    Structure definition is public to enable stack
based allocation. Do not access the members directly.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_sha512(...)
delete_fz_sha512(fz_sha512 self)
 
Parameters
----------
self: fz_sha512 *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
count
fz_sha512_count_get(fz_sha512 self) -> unsigned int [2]
 
Parameters
----------
self: fz_sha512 *
state
fz_sha512_state_get(fz_sha512 self) -> uint64_t [8]
 
Parameters
----------
self: fz_sha512 *
thisown
The membership flag

 
class fz_shade(builtins.object)
    Structure is public to allow derived classes. Do not
access the members directly.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_shade(...)
delete_fz_shade(fz_shade self)
 
Parameters
----------
self: fz_shade *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
background
fz_shade_background_get(fz_shade self) -> float [FZ_MAX_COLORS]
 
Parameters
----------
self: fz_shade *
bbox
fz_shade_bbox_get(fz_shade self) -> fz_rect
 
Parameters
----------
self: fz_shade *
buffer
fz_shade_buffer_get(fz_shade self) -> fz_compressed_buffer
 
Parameters
----------
self: fz_shade *
colorspace
fz_shade_colorspace_get(fz_shade self) -> fz_colorspace *
 
Parameters
----------
self: fz_shade *
function
fz_shade_function_get(fz_shade self) -> float [256][FZ_MAX_COLORS+1]
 
Parameters
----------
self: fz_shade *
matrix
fz_shade_matrix_get(fz_shade self) -> fz_matrix
 
Parameters
----------
self: fz_shade *
storable
fz_shade_storable_get(fz_shade self) -> fz_storable *
 
Parameters
----------
self: fz_shade *
thisown
The membership flag
type
fz_shade_type_get(fz_shade self) -> int
 
Parameters
----------
self: fz_shade *
use_background
fz_shade_use_background_get(fz_shade self) -> int
 
Parameters
----------
self: fz_shade *
use_function
fz_shade_use_function_get(fz_shade self) -> int
 
Parameters
----------
self: fz_shade *

 
class fz_shaper_data_t(builtins.object)
    In order to shape a given font, we need to
declare it to a shaper library (harfbuzz, by default, but others
are possible). To avoid redeclaring it every time we need to
shape, we hold a shaper handle and the destructor for it within
the font itself. The handle is initialised by the caller when
first required and the destructor is called when the fz_font is
destroyed.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_shaper_data_t(...)
delete_fz_shaper_data_t(fz_shaper_data_t self)
 
Parameters
----------
self: fz_shaper_data_t *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
destroy
fz_shaper_data_t_destroy_get(fz_shaper_data_t self) -> void (*)(fz_context *,void *)
 
Parameters
----------
self: fz_shaper_data_t *
shaper_handle
fz_shaper_data_t_shaper_handle_get(fz_shaper_data_t self) -> void *
 
Parameters
----------
self: fz_shaper_data_t *
thisown
The membership flag

 
class fz_stext_block(builtins.object)
    A text block is a list of lines of text (typically a paragraph),
or an image.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_stext_block(...)
delete_fz_stext_block(fz_stext_block * self)
 
Parameters
----------
self: fz_stext_block *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
bbox
fz_stext_block_bbox_get(fz_stext_block * self) -> fz_rect
 
Parameters
----------
self: fz_stext_block *
next
fz_stext_block_next_get(fz_stext_block * self) -> fz_stext_block *
 
Parameters
----------
self: fz_stext_block *
prev
fz_stext_block_prev_get(fz_stext_block * self) -> fz_stext_block *
 
Parameters
----------
self: fz_stext_block *
thisown
The membership flag
type
fz_stext_block_type_get(fz_stext_block * self) -> int
 
Parameters
----------
self: fz_stext_block *

 
class fz_stext_char(builtins.object)
    A text char is a unicode character, the style in which is
appears, and the point at which it is positioned.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_stext_char(...)
delete_fz_stext_char(fz_stext_char * self)
 
Parameters
----------
self: fz_stext_char *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
c
fz_stext_char_c_get(fz_stext_char * self) -> int
 
Parameters
----------
self: fz_stext_char *
color
fz_stext_char_color_get(fz_stext_char * self) -> int
 
Parameters
----------
self: fz_stext_char *
font
fz_stext_char_font_get(fz_stext_char * self) -> fz_font *
 
Parameters
----------
self: fz_stext_char *
next
fz_stext_char_next_get(fz_stext_char * self) -> fz_stext_char *
 
Parameters
----------
self: fz_stext_char *
origin
fz_stext_char_origin_get(fz_stext_char * self) -> fz_point
 
Parameters
----------
self: fz_stext_char *
quad
fz_stext_char_quad_get(fz_stext_char * self) -> fz_quad
 
Parameters
----------
self: fz_stext_char *
size
fz_stext_char_size_get(fz_stext_char * self) -> float
 
Parameters
----------
self: fz_stext_char *
thisown
The membership flag

 
class fz_stext_line(builtins.object)
    A text line is a list of characters that share a common baseline.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_stext_line(...)
delete_fz_stext_line(fz_stext_line * self)
 
Parameters
----------
self: fz_stext_line *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
bbox
fz_stext_line_bbox_get(fz_stext_line * self) -> fz_rect
 
Parameters
----------
self: fz_stext_line *
dir
fz_stext_line_dir_get(fz_stext_line * self) -> fz_point
 
Parameters
----------
self: fz_stext_line *
first_char
fz_stext_line_first_char_get(fz_stext_line * self) -> fz_stext_char *
 
Parameters
----------
self: fz_stext_line *
last_char
fz_stext_line_last_char_get(fz_stext_line * self) -> fz_stext_char *
 
Parameters
----------
self: fz_stext_line *
next
fz_stext_line_next_get(fz_stext_line * self) -> fz_stext_line *
 
Parameters
----------
self: fz_stext_line *
prev
fz_stext_line_prev_get(fz_stext_line * self) -> fz_stext_line *
 
Parameters
----------
self: fz_stext_line *
thisown
The membership flag
wmode
fz_stext_line_wmode_get(fz_stext_line * self) -> int
 
Parameters
----------
self: fz_stext_line *

 
class fz_stext_options(builtins.object)
    Options for creating a pixmap and draw device.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_stext_options(...)
delete_fz_stext_options(fz_stext_options self)
 
Parameters
----------
self: fz_stext_options *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
flags
fz_stext_options_flags_get(fz_stext_options self) -> int
 
Parameters
----------
self: fz_stext_options *
thisown
The membership flag

 
class fz_stext_page(builtins.object)
    A text page is a list of blocks, together with an overall
bounding box.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_stext_page(...)
delete_fz_stext_page(fz_stext_page self)
 
Parameters
----------
self: fz_stext_page *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
first_block
fz_stext_page_first_block_get(fz_stext_page self) -> fz_stext_block *
 
Parameters
----------
self: fz_stext_page *
last_block
fz_stext_page_last_block_get(fz_stext_page self) -> fz_stext_block *
 
Parameters
----------
self: fz_stext_page *
mediabox
fz_stext_page_mediabox_get(fz_stext_page self) -> fz_rect
 
Parameters
----------
self: fz_stext_page *
pool
fz_stext_page_pool_get(fz_stext_page self) -> fz_pool *
 
Parameters
----------
self: fz_stext_page *
thisown
The membership flag

 
class fz_storable(builtins.object)
    Any storable object should include an fz_storable structure
at the start (by convention at least) of their structure.
(Unless it starts with an fz_key_storable, see below).
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_storable(...)
delete_fz_storable(fz_storable * self)
 
Parameters
----------
self: fz_storable *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
drop
fz_storable_drop_get(fz_storable * self) -> fz_store_drop_fn *
 
Parameters
----------
self: fz_storable *
refs
fz_storable_refs_get(fz_storable * self) -> int
 
Parameters
----------
self: fz_storable *
thisown
The membership flag

 
class fz_store_hash(builtins.object)
    The store can be seen as a dictionary that maps keys to
fz_storable values. In order to allow keys of different types to
be stored, we have a structure full of functions for each key
'type'; this fz_store_type pointer is stored with each key, and
tells the store how to perform certain operations (like taking/
dropping a reference, comparing two keys, outputting details for
debugging etc).
 
The store uses a hash table internally for speed where possible.
In order for this to work, we need a mechanism for turning a
generic 'key' into 'a hashable string'. For this purpose the
type structure contains a make_hash_key function pointer that
maps from a void * to a fz_store_hash structure. If
make_hash_key function returns 0, then the key is determined not
to be hashable, and the value is not stored in the hash table.
 
Some objects can be used both as values within the store, and as
a component of keys within the store. We refer to these objects
as "key storable" objects. In this case, we need to take
additional care to ensure that we do not end up keeping an item
within the store, purely because its value is referred to by
another key in the store.
 
An example of this are fz_images in PDF files. Each fz_image is
placed into the     store to enable it to be easily reused. When the
image is rendered, a pixmap is generated from the image, and the
pixmap is placed into the store so it can be reused on
subsequent renders. The image forms part of the key for the
pixmap.
 
When we close the pdf document (and any associated pages/display
lists etc), we drop the images from the store. This may leave us
in the position of the images having non-zero reference counts
purely because they are used as part of the keys for the
pixmaps.
 
We therefore use special reference counting functions to keep
track of these "key storable" items, and hence store the number
of references to these items that are used in keys.
 
When the number of references to an object == the number of
references to an object from keys in the store, we know that we
can remove all the items which have that object as part of the
key. This is done by running a pass over the store, 'reaping'
those items.
 
Reap passes are slower than we would like as they touch every
item in the store. We therefore provide a way to 'batch' such
reap passes together, using fz_defer_reap_start/
fz_defer_reap_end to bracket a region in which many may be
triggered.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_store_hash(...)
delete_fz_store_hash(fz_store_hash self)
 
Parameters
----------
self: fz_store_hash *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
drop
fz_store_hash_drop_get(fz_store_hash self) -> fz_store_drop_fn *
 
Parameters
----------
self: fz_store_hash *
thisown
The membership flag

 
class fz_store_type(builtins.object)
    Every type of object to be placed into the store defines an
fz_store_type. This contains the pointers to functions to
make hashes, manipulate keys, and check for needing reaping.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_store_type(...)
delete_fz_store_type(fz_store_type self)
 
Parameters
----------
self: fz_store_type *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
cmp_key
fz_store_type_cmp_key_get(fz_store_type self) -> int (*)(fz_context *,void *,void *)
 
Parameters
----------
self: fz_store_type *
drop_key
fz_store_type_drop_key_get(fz_store_type self) -> void (*)(fz_context *,void *)
 
Parameters
----------
self: fz_store_type *
format_key
fz_store_type_format_key_get(fz_store_type self) -> void (*)(fz_context *,char *,size_t,void *)
 
Parameters
----------
self: fz_store_type *
keep_key
fz_store_type_keep_key_get(fz_store_type self) -> void *(*)(fz_context *,void *)
 
Parameters
----------
self: fz_store_type *
make_hash_key
fz_store_type_make_hash_key_get(fz_store_type self) -> int (*)(fz_context *,fz_store_hash *,void *)
 
Parameters
----------
self: fz_store_type *
needs_reap
fz_store_type_needs_reap_get(fz_store_type self) -> int (*)(fz_context *,void *)
 
Parameters
----------
self: fz_store_type *
thisown
The membership flag

 
class fz_stream(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_stream(...)
delete_fz_stream(fz_stream * self)
 
Parameters
----------
self: fz_stream *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
avail
fz_stream_avail_get(fz_stream * self) -> int
 
Parameters
----------
self: fz_stream *
bits
fz_stream_bits_get(fz_stream * self) -> int
 
Parameters
----------
self: fz_stream *
drop
fz_stream_drop_get(fz_stream * self) -> fz_stream_drop_fn *
 
Parameters
----------
self: fz_stream *
eof
fz_stream_eof_get(fz_stream * self) -> int
 
Parameters
----------
self: fz_stream *
error
fz_stream_error_get(fz_stream * self) -> int
 
Parameters
----------
self: fz_stream *
next
fz_stream_next_get(fz_stream * self) -> fz_stream_next_fn *
 
Parameters
----------
self: fz_stream *
pos
fz_stream_pos_get(fz_stream * self) -> int64_t
 
Parameters
----------
self: fz_stream *
progressive
fz_stream_progressive_get(fz_stream * self) -> int
 
Parameters
----------
self: fz_stream *
refs
fz_stream_refs_get(fz_stream * self) -> int
 
Parameters
----------
self: fz_stream *
rp
fz_stream_rp_get(fz_stream * self) -> unsigned char *
 
Parameters
----------
self: fz_stream *
seek
fz_stream_seek_get(fz_stream * self) -> fz_stream_seek_fn *
 
Parameters
----------
self: fz_stream *
state
fz_stream_state_get(fz_stream * self) -> void *
 
Parameters
----------
self: fz_stream *
thisown
The membership flag
wp
fz_stream_wp_get(fz_stream * self) -> unsigned char *
 
Parameters
----------
self: fz_stream *

 
class fz_stroke_state(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_stroke_state(...)
delete_fz_stroke_state(fz_stroke_state self)
 
Parameters
----------
self: fz_stroke_state *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
dash_cap
fz_stroke_state_dash_cap_get(fz_stroke_state self) -> fz_linecap
 
Parameters
----------
self: fz_stroke_state *
dash_len
fz_stroke_state_dash_len_get(fz_stroke_state self) -> int
 
Parameters
----------
self: fz_stroke_state *
dash_list
fz_stroke_state_dash_list_get(fz_stroke_state self) -> float [32]
 
Parameters
----------
self: fz_stroke_state *
dash_phase
fz_stroke_state_dash_phase_get(fz_stroke_state self) -> float
 
Parameters
----------
self: fz_stroke_state *
end_cap
fz_stroke_state_end_cap_get(fz_stroke_state self) -> fz_linecap
 
Parameters
----------
self: fz_stroke_state *
linejoin
fz_stroke_state_linejoin_get(fz_stroke_state self) -> fz_linejoin
 
Parameters
----------
self: fz_stroke_state *
linewidth
fz_stroke_state_linewidth_get(fz_stroke_state self) -> float
 
Parameters
----------
self: fz_stroke_state *
miterlimit
fz_stroke_state_miterlimit_get(fz_stroke_state self) -> float
 
Parameters
----------
self: fz_stroke_state *
refs
fz_stroke_state_refs_get(fz_stroke_state self) -> int
 
Parameters
----------
self: fz_stroke_state *
start_cap
fz_stroke_state_start_cap_get(fz_stroke_state self) -> fz_linecap
 
Parameters
----------
self: fz_stroke_state *
thisown
The membership flag

 
class fz_text(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_text(...)
delete_fz_text(fz_text self)
 
Parameters
----------
self: fz_text *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
head
fz_text_head_get(fz_text self) -> fz_text_span
 
Parameters
----------
self: fz_text *
refs
fz_text_refs_get(fz_text self) -> int
 
Parameters
----------
self: fz_text *
tail
fz_text_tail_get(fz_text self) -> fz_text_span
 
Parameters
----------
self: fz_text *
thisown
The membership flag

 
class fz_text_item(builtins.object)
    Text buffer.
 
The trm field contains the a, b, c and d coefficients.
The e and f coefficients come from the individual elements,
together they form the transform matrix for the glyph.
 
Glyphs are referenced by glyph ID.
The Unicode text equivalent is kept in a separate array
with indexes into the glyph array.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_text_item(...)
delete_fz_text_item(fz_text_item self)
 
Parameters
----------
self: fz_text_item *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
gid
fz_text_item_gid_get(fz_text_item self) -> int
 
Parameters
----------
self: fz_text_item *
thisown
The membership flag
ucs
fz_text_item_ucs_get(fz_text_item self) -> int
 
Parameters
----------
self: fz_text_item *
x
fz_text_item_x_get(fz_text_item self) -> float
 
Parameters
----------
self: fz_text_item *
y
fz_text_item_y_get(fz_text_item self) -> float
 
Parameters
----------
self: fz_text_item *

 
class fz_text_span(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_text_span(...)
delete_fz_text_span(fz_text_span self)
 
Parameters
----------
self: fz_text_span *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
bidi_level
fz_text_span_bidi_level_get(fz_text_span self) -> unsigned int
 
Parameters
----------
self: fz_text_span *
cap
fz_text_span_cap_get(fz_text_span self) -> int
 
Parameters
----------
self: fz_text_span *
font
fz_text_span_font_get(fz_text_span self) -> fz_font *
 
Parameters
----------
self: fz_text_span *
items
fz_text_span_items_get(fz_text_span self) -> fz_text_item
 
Parameters
----------
self: fz_text_span *
language
fz_text_span_language_get(fz_text_span self) -> unsigned int
 
Parameters
----------
self: fz_text_span *
len
fz_text_span_len_get(fz_text_span self) -> int
 
Parameters
----------
self: fz_text_span *
markup_dir
fz_text_span_markup_dir_get(fz_text_span self) -> unsigned int
 
Parameters
----------
self: fz_text_span *
next
fz_text_span_next_get(fz_text_span self) -> fz_text_span
 
Parameters
----------
self: fz_text_span *
thisown
The membership flag
trm
fz_text_span_trm_get(fz_text_span self) -> fz_matrix
 
Parameters
----------
self: fz_text_span *
wmode
fz_text_span_wmode_get(fz_text_span self) -> unsigned int
 
Parameters
----------
self: fz_text_span *

 
class fz_transition(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_transition(...)
delete_fz_transition(fz_transition self)
 
Parameters
----------
self: fz_transition *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
direction
fz_transition_direction_get(fz_transition self) -> int
 
Parameters
----------
self: fz_transition *
duration
fz_transition_duration_get(fz_transition self) -> float
 
Parameters
----------
self: fz_transition *
outwards
fz_transition_outwards_get(fz_transition self) -> int
 
Parameters
----------
self: fz_transition *
state0
fz_transition_state0_get(fz_transition self) -> int
 
Parameters
----------
self: fz_transition *
state1
fz_transition_state1_get(fz_transition self) -> int
 
Parameters
----------
self: fz_transition *
thisown
The membership flag
type
fz_transition_type_get(fz_transition self) -> int
 
Parameters
----------
self: fz_transition *
vertical
fz_transition_vertical_get(fz_transition self) -> int
 
Parameters
----------
self: fz_transition *

 
class fz_vertex(builtins.object)
    Handy routine for processing mesh based shades
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_vertex(...)
delete_fz_vertex(fz_vertex self)
 
Parameters
----------
self: fz_vertex *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
c
fz_vertex_c_get(fz_vertex self) -> float [FZ_MAX_COLORS]
 
Parameters
----------
self: fz_vertex *
p
fz_vertex_p_get(fz_vertex self) -> fz_point
 
Parameters
----------
self: fz_vertex *
thisown
The membership flag

 
class fz_warn_context(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_fz_warn_context(...)
delete_fz_warn_context(fz_warn_context self)
 
Parameters
----------
self: fz_warn_context *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
count
fz_warn_context_count_get(fz_warn_context self) -> int
 
Parameters
----------
self: fz_warn_context *
message
fz_warn_context_message_get(fz_warn_context self) -> char [256]
 
Parameters
----------
self: fz_warn_context *
print_user
fz_warn_context_print_user_get(fz_warn_context self) -> void *
 
Parameters
----------
self: fz_warn_context *
thisown
The membership flag

 
class pdf_alert_event(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_alert_event(...)
delete_pdf_alert_event(pdf_alert_event self)
 
Parameters
----------
self: pdf_alert_event *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
button_group_type
pdf_alert_event_button_group_type_get(pdf_alert_event self) -> int
 
Parameters
----------
self: pdf_alert_event *
button_pressed
pdf_alert_event_button_pressed_get(pdf_alert_event self) -> int
 
Parameters
----------
self: pdf_alert_event *
check_box_message
pdf_alert_event_check_box_message_get(pdf_alert_event self) -> char const *
 
Parameters
----------
self: pdf_alert_event *
finally_checked
pdf_alert_event_finally_checked_get(pdf_alert_event self) -> int
 
Parameters
----------
self: pdf_alert_event *
icon_type
pdf_alert_event_icon_type_get(pdf_alert_event self) -> int
 
Parameters
----------
self: pdf_alert_event *
initially_checked
pdf_alert_event_initially_checked_get(pdf_alert_event self) -> int
 
Parameters
----------
self: pdf_alert_event *
message
pdf_alert_event_message_get(pdf_alert_event self) -> char const *
 
Parameters
----------
self: pdf_alert_event *
thisown
The membership flag
title
pdf_alert_event_title_get(pdf_alert_event self) -> char const *
 
Parameters
----------
self: pdf_alert_event *

 
class pdf_annot(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_annot(...)
delete_pdf_annot(pdf_annot * self)
 
Parameters
----------
self: pdf_annot *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
ap
pdf_annot_ap_get(pdf_annot * self) -> pdf_obj *
 
Parameters
----------
self: pdf_annot *
has_new_ap
pdf_annot_has_new_ap_get(pdf_annot * self) -> int
 
Parameters
----------
self: pdf_annot *
ignore_trigger_events
pdf_annot_ignore_trigger_events_get(pdf_annot * self) -> int
 
Parameters
----------
self: pdf_annot *
is_active
pdf_annot_is_active_get(pdf_annot * self) -> int
 
Parameters
----------
self: pdf_annot *
is_hot
pdf_annot_is_hot_get(pdf_annot * self) -> int
 
Parameters
----------
self: pdf_annot *
needs_new_ap
pdf_annot_needs_new_ap_get(pdf_annot * self) -> int
 
Parameters
----------
self: pdf_annot *
next
pdf_annot_next_get(pdf_annot * self) -> pdf_annot *
 
Parameters
----------
self: pdf_annot *
obj
pdf_annot_obj_get(pdf_annot * self) -> pdf_obj *
 
Parameters
----------
self: pdf_annot *
page
pdf_annot_page_get(pdf_annot * self) -> pdf_page *
 
Parameters
----------
self: pdf_annot *
refs
pdf_annot_refs_get(pdf_annot * self) -> int
 
Parameters
----------
self: pdf_annot *
thisown
The membership flag

 
class pdf_cmap(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_cmap(...)
delete_pdf_cmap(pdf_cmap self)
 
Parameters
----------
self: pdf_cmap *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
cmap_name
pdf_cmap_cmap_name_get(pdf_cmap self) -> char [32]
 
Parameters
----------
self: pdf_cmap *
codespace_len
pdf_cmap_codespace_len_get(pdf_cmap self) -> int
 
Parameters
----------
self: pdf_cmap *
dcap
pdf_cmap_dcap_get(pdf_cmap self) -> int
 
Parameters
----------
self: pdf_cmap *
dict
pdf_cmap_dict_get(pdf_cmap self) -> int *
 
Parameters
----------
self: pdf_cmap *
dlen
pdf_cmap_dlen_get(pdf_cmap self) -> int
 
Parameters
----------
self: pdf_cmap *
mcap
pdf_cmap_mcap_get(pdf_cmap self) -> int
 
Parameters
----------
self: pdf_cmap *
mlen
pdf_cmap_mlen_get(pdf_cmap self) -> int
 
Parameters
----------
self: pdf_cmap *
mranges
pdf_cmap_mranges_get(pdf_cmap self) -> pdf_mrange
 
Parameters
----------
self: pdf_cmap *
ranges
pdf_cmap_ranges_get(pdf_cmap self) -> pdf_range
 
Parameters
----------
self: pdf_cmap *
rcap
pdf_cmap_rcap_get(pdf_cmap self) -> int
 
Parameters
----------
self: pdf_cmap *
rlen
pdf_cmap_rlen_get(pdf_cmap self) -> int
 
Parameters
----------
self: pdf_cmap *
storable
pdf_cmap_storable_get(pdf_cmap self) -> fz_storable *
 
Parameters
----------
self: pdf_cmap *
tcap
pdf_cmap_tcap_get(pdf_cmap self) -> int
 
Parameters
----------
self: pdf_cmap *
thisown
The membership flag
tlen
pdf_cmap_tlen_get(pdf_cmap self) -> int
 
Parameters
----------
self: pdf_cmap *
tree
pdf_cmap_tree_get(pdf_cmap self) -> cmap_splay *
 
Parameters
----------
self: pdf_cmap *
ttop
pdf_cmap_ttop_get(pdf_cmap self) -> int
 
Parameters
----------
self: pdf_cmap *
usecmap
pdf_cmap_usecmap_get(pdf_cmap self) -> pdf_cmap
 
Parameters
----------
self: pdf_cmap *
usecmap_name
pdf_cmap_usecmap_name_get(pdf_cmap self) -> char [32]
 
Parameters
----------
self: pdf_cmap *
wmode
pdf_cmap_wmode_get(pdf_cmap self) -> int
 
Parameters
----------
self: pdf_cmap *
xcap
pdf_cmap_xcap_get(pdf_cmap self) -> int
 
Parameters
----------
self: pdf_cmap *
xlen
pdf_cmap_xlen_get(pdf_cmap self) -> int
 
Parameters
----------
self: pdf_cmap *
xranges
pdf_cmap_xranges_get(pdf_cmap self) -> pdf_xrange
 
Parameters
----------
self: pdf_cmap *

 
class pdf_csi(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_csi(...)
delete_pdf_csi(pdf_csi self)
 
Parameters
----------
self: pdf_csi *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
buf
pdf_csi_buf_get(pdf_csi self) -> pdf_lexbuf
 
Parameters
----------
self: pdf_csi *
cookie
pdf_csi_cookie_get(pdf_csi self) -> fz_cookie
 
Parameters
----------
self: pdf_csi *
d1_rect
pdf_csi_d1_rect_get(pdf_csi self) -> fz_rect
 
Parameters
----------
self: pdf_csi *
doc
pdf_csi_doc_get(pdf_csi self) -> pdf_document *
 
Parameters
----------
self: pdf_csi *
gstate
pdf_csi_gstate_get(pdf_csi self) -> int
 
Parameters
----------
self: pdf_csi *
in_text
pdf_csi_in_text_get(pdf_csi self) -> int
 
Parameters
----------
self: pdf_csi *
name
pdf_csi_name_get(pdf_csi self) -> char [256]
 
Parameters
----------
self: pdf_csi *
obj
pdf_csi_obj_get(pdf_csi self) -> pdf_obj *
 
Parameters
----------
self: pdf_csi *
rdb
pdf_csi_rdb_get(pdf_csi self) -> pdf_obj *
 
Parameters
----------
self: pdf_csi *
stack
pdf_csi_stack_get(pdf_csi self) -> float [32]
 
Parameters
----------
self: pdf_csi *
string
pdf_csi_string_get(pdf_csi self) -> char [256]
 
Parameters
----------
self: pdf_csi *
string_len
pdf_csi_string_len_get(pdf_csi self) -> size_t
 
Parameters
----------
self: pdf_csi *
thisown
The membership flag
top
pdf_csi_top_get(pdf_csi self) -> int
 
Parameters
----------
self: pdf_csi *
xbalance
pdf_csi_xbalance_get(pdf_csi self) -> int
 
Parameters
----------
self: pdf_csi *

 
class pdf_doc_event(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_doc_event(...)
delete_pdf_doc_event(pdf_doc_event * self)
 
Parameters
----------
self: pdf_doc_event *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag
type
pdf_doc_event_type_get(pdf_doc_event * self) -> int
 
Parameters
----------
self: pdf_doc_event *

 
class pdf_document(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_document(...)
delete_pdf_document(pdf_document * self)
 
Parameters
----------
self: pdf_document *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
crypt
pdf_document_crypt_get(pdf_document * self) -> pdf_crypt *
 
Parameters
----------
self: pdf_document *
dirty
pdf_document_dirty_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
disallow_new_increments
pdf_document_disallow_new_increments_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
event_cb
pdf_document_event_cb_get(pdf_document * self) -> pdf_doc_event_cb *
 
Parameters
----------
self: pdf_document *
event_cb_data
pdf_document_event_cb_data_get(pdf_document * self) -> void *
 
Parameters
----------
self: pdf_document *
file
pdf_document_file_get(pdf_document * self) -> fz_stream *
 
Parameters
----------
self: pdf_document *
file_length
pdf_document_file_length_get(pdf_document * self) -> int64_t
 
Parameters
----------
self: pdf_document *
file_reading_linearly
pdf_document_file_reading_linearly_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
file_size
pdf_document_file_size_get(pdf_document * self) -> int64_t
 
Parameters
----------
self: pdf_document *
has_linearization_object
pdf_document_has_linearization_object_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
has_old_style_xrefs
pdf_document_has_old_style_xrefs_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
has_xref_streams
pdf_document_has_xref_streams_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
hint_obj_offsets
pdf_document_hint_obj_offsets_get(pdf_document * self) -> int64_t *
 
Parameters
----------
self: pdf_document *
hint_obj_offsets_max
pdf_document_hint_obj_offsets_max_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
hint_object_length
pdf_document_hint_object_length_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
hint_object_offset
pdf_document_hint_object_offset_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
hint_page
pdf_document_hint_page_get(pdf_document * self) -> pdf_hint_page
 
Parameters
----------
self: pdf_document *
hint_shared
pdf_document_hint_shared_get(pdf_document * self) -> pdf_hint_shared
 
Parameters
----------
self: pdf_document *
hint_shared_ref
pdf_document_hint_shared_ref_get(pdf_document * self) -> int *
 
Parameters
----------
self: pdf_document *
hints_loaded
pdf_document_hints_loaded_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
js
pdf_document_js_get(pdf_document * self) -> pdf_js *
 
Parameters
----------
self: pdf_document *
lexbuf
pdf_document_lexbuf_get(pdf_document * self) -> pdf_lexbuf_large
 
Parameters
----------
self: pdf_document *
linear_obj
pdf_document_linear_obj_get(pdf_document * self) -> pdf_obj *
 
Parameters
----------
self: pdf_document *
linear_page1_obj_num
pdf_document_linear_page1_obj_num_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
linear_page_count
pdf_document_linear_page_count_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
linear_page_num
pdf_document_linear_page_num_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
linear_page_refs
pdf_document_linear_page_refs_get(pdf_document * self) -> pdf_obj **
 
Parameters
----------
self: pdf_document *
linear_pos
pdf_document_linear_pos_get(pdf_document * self) -> int64_t
 
Parameters
----------
self: pdf_document *
max_type3_fonts
pdf_document_max_type3_fonts_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
max_xref_len
pdf_document_max_xref_len_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
num_incremental_sections
pdf_document_num_incremental_sections_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
num_type3_fonts
pdf_document_num_type3_fonts_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
num_xref_sections
pdf_document_num_xref_sections_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
ocg
pdf_document_ocg_get(pdf_document * self) -> pdf_ocg_descriptor *
 
Parameters
----------
self: pdf_document *
oi
pdf_document_oi_get(pdf_document * self) -> fz_colorspace *
 
Parameters
----------
self: pdf_document *
orphans
pdf_document_orphans_get(pdf_document * self) -> pdf_obj **
 
Parameters
----------
self: pdf_document *
orphans_count
pdf_document_orphans_count_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
orphans_max
pdf_document_orphans_max_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
recalculate
pdf_document_recalculate_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
redacted
pdf_document_redacted_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
repair_attempted
pdf_document_repair_attempted_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
resources_localised
pdf_document_resources_localised_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
rev_page_count
pdf_document_rev_page_count_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
rev_page_map
pdf_document_rev_page_map_get(pdf_document * self) -> pdf_rev_page_map
 
Parameters
----------
self: pdf_document *
save_in_progress
pdf_document_save_in_progress_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
saved_num_xref_sections
pdf_document_saved_num_xref_sections_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
saved_xref_sections
pdf_document_saved_xref_sections_get(pdf_document * self) -> pdf_xref *
 
Parameters
----------
self: pdf_document *
startxref
pdf_document_startxref_get(pdf_document * self) -> int64_t
 
Parameters
----------
self: pdf_document *
super
pdf_document_super_get(pdf_document * self) -> fz_document *
 
Parameters
----------
self: pdf_document *
thisown
The membership flag
type3_fonts
pdf_document_type3_fonts_get(pdf_document * self) -> fz_font **
 
Parameters
----------
self: pdf_document *
version
pdf_document_version_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
xfa
pdf_document_xfa_get(pdf_document * self) -> pdf_xfa
 
Parameters
----------
self: pdf_document *
xref_base
pdf_document_xref_base_get(pdf_document * self) -> int
 
Parameters
----------
self: pdf_document *
xref_index
pdf_document_xref_index_get(pdf_document * self) -> int *
 
Parameters
----------
self: pdf_document *
xref_sections
pdf_document_xref_sections_get(pdf_document * self) -> pdf_xref *
 
Parameters
----------
self: pdf_document *

 
class pdf_filter_options(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_filter_options(...)
delete_pdf_filter_options(pdf_filter_options self)
 
Parameters
----------
self: pdf_filter_options *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
after_text_object
pdf_filter_options_after_text_object_get(pdf_filter_options self) -> void (*)(fz_context *,void *,pdf_document *,pdf_processor *,fz_matrix)
 
Parameters
----------
self: pdf_filter_options *
ascii
pdf_filter_options_ascii_get(pdf_filter_options self) -> int
 
Parameters
----------
self: pdf_filter_options *
end_page
pdf_filter_options_end_page_get(pdf_filter_options self) -> void (*)(fz_context *,fz_buffer *,void *)
 
Parameters
----------
self: pdf_filter_options *
image_filter
pdf_filter_options_image_filter_get(pdf_filter_options self) -> fz_image *(*)(fz_context *,void *,fz_matrix,char const *,fz_image *)
 
Parameters
----------
self: pdf_filter_options *
instance_forms
pdf_filter_options_instance_forms_get(pdf_filter_options self) -> int
 
Parameters
----------
self: pdf_filter_options *
opaque
pdf_filter_options_opaque_get(pdf_filter_options self) -> void *
 
Parameters
----------
self: pdf_filter_options *
recurse
pdf_filter_options_recurse_get(pdf_filter_options self) -> int
 
Parameters
----------
self: pdf_filter_options *
sanitize
pdf_filter_options_sanitize_get(pdf_filter_options self) -> int
 
Parameters
----------
self: pdf_filter_options *
text_filter
pdf_filter_options_text_filter_get(pdf_filter_options self) -> int (*)(fz_context *,void *,int *,int,fz_matrix,fz_matrix,fz_rect)
 
Parameters
----------
self: pdf_filter_options *
thisown
The membership flag

 
class pdf_font_desc(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_font_desc(...)
delete_pdf_font_desc(pdf_font_desc self)
 
Parameters
----------
self: pdf_font_desc *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
ascent
pdf_font_desc_ascent_get(pdf_font_desc self) -> float
 
Parameters
----------
self: pdf_font_desc *
cap_height
pdf_font_desc_cap_height_get(pdf_font_desc self) -> float
 
Parameters
----------
self: pdf_font_desc *
cid_to_gid
pdf_font_desc_cid_to_gid_get(pdf_font_desc self) -> unsigned short *
 
Parameters
----------
self: pdf_font_desc *
cid_to_gid_len
pdf_font_desc_cid_to_gid_len_get(pdf_font_desc self) -> size_t
 
Parameters
----------
self: pdf_font_desc *
cid_to_ucs
pdf_font_desc_cid_to_ucs_get(pdf_font_desc self) -> unsigned short *
 
Parameters
----------
self: pdf_font_desc *
cid_to_ucs_len
pdf_font_desc_cid_to_ucs_len_get(pdf_font_desc self) -> size_t
 
Parameters
----------
self: pdf_font_desc *
descent
pdf_font_desc_descent_get(pdf_font_desc self) -> float
 
Parameters
----------
self: pdf_font_desc *
dhmtx
pdf_font_desc_dhmtx_get(pdf_font_desc self) -> pdf_hmtx
 
Parameters
----------
self: pdf_font_desc *
dvmtx
pdf_font_desc_dvmtx_get(pdf_font_desc self) -> pdf_vmtx
 
Parameters
----------
self: pdf_font_desc *
encoding
pdf_font_desc_encoding_get(pdf_font_desc self) -> pdf_cmap
 
Parameters
----------
self: pdf_font_desc *
flags
pdf_font_desc_flags_get(pdf_font_desc self) -> int
 
Parameters
----------
self: pdf_font_desc *
font
pdf_font_desc_font_get(pdf_font_desc self) -> fz_font *
 
Parameters
----------
self: pdf_font_desc *
hmtx
pdf_font_desc_hmtx_get(pdf_font_desc self) -> pdf_hmtx
 
Parameters
----------
self: pdf_font_desc *
hmtx_cap
pdf_font_desc_hmtx_cap_get(pdf_font_desc self) -> int
 
Parameters
----------
self: pdf_font_desc *
hmtx_len
pdf_font_desc_hmtx_len_get(pdf_font_desc self) -> int
 
Parameters
----------
self: pdf_font_desc *
is_embedded
pdf_font_desc_is_embedded_get(pdf_font_desc self) -> int
 
Parameters
----------
self: pdf_font_desc *
italic_angle
pdf_font_desc_italic_angle_get(pdf_font_desc self) -> float
 
Parameters
----------
self: pdf_font_desc *
missing_width
pdf_font_desc_missing_width_get(pdf_font_desc self) -> float
 
Parameters
----------
self: pdf_font_desc *
size
pdf_font_desc_size_get(pdf_font_desc self) -> size_t
 
Parameters
----------
self: pdf_font_desc *
storable
pdf_font_desc_storable_get(pdf_font_desc self) -> fz_storable *
 
Parameters
----------
self: pdf_font_desc *
thisown
The membership flag
to_ttf_cmap
pdf_font_desc_to_ttf_cmap_get(pdf_font_desc self) -> pdf_cmap
 
Parameters
----------
self: pdf_font_desc *
to_unicode
pdf_font_desc_to_unicode_get(pdf_font_desc self) -> pdf_cmap
 
Parameters
----------
self: pdf_font_desc *
vmtx
pdf_font_desc_vmtx_get(pdf_font_desc self) -> pdf_vmtx
 
Parameters
----------
self: pdf_font_desc *
vmtx_cap
pdf_font_desc_vmtx_cap_get(pdf_font_desc self) -> int
 
Parameters
----------
self: pdf_font_desc *
vmtx_len
pdf_font_desc_vmtx_len_get(pdf_font_desc self) -> int
 
Parameters
----------
self: pdf_font_desc *
wmode
pdf_font_desc_wmode_get(pdf_font_desc self) -> int
 
Parameters
----------
self: pdf_font_desc *
x_height
pdf_font_desc_x_height_get(pdf_font_desc self) -> float
 
Parameters
----------
self: pdf_font_desc *

 
class pdf_hint_page(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_hint_page(...)
delete_pdf_hint_page(pdf_hint_page self)
 
Parameters
----------
self: pdf_hint_page *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
index
pdf_hint_page_index_get(pdf_hint_page self) -> int64_t
 
Parameters
----------
self: pdf_hint_page *
number
pdf_hint_page_number_get(pdf_hint_page self) -> int
 
Parameters
----------
self: pdf_hint_page *
offset
pdf_hint_page_offset_get(pdf_hint_page self) -> int64_t
 
Parameters
----------
self: pdf_hint_page *
thisown
The membership flag

 
class pdf_hint_shared(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_hint_shared(...)
delete_pdf_hint_shared(pdf_hint_shared self)
 
Parameters
----------
self: pdf_hint_shared *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
number
pdf_hint_shared_number_get(pdf_hint_shared self) -> int
 
Parameters
----------
self: pdf_hint_shared *
offset
pdf_hint_shared_offset_get(pdf_hint_shared self) -> int64_t
 
Parameters
----------
self: pdf_hint_shared *
thisown
The membership flag

 
class pdf_hmtx(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_hmtx(...)
delete_pdf_hmtx(pdf_hmtx self)
 
Parameters
----------
self: pdf_hmtx *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
hi
pdf_hmtx_hi_get(pdf_hmtx self) -> unsigned short
 
Parameters
----------
self: pdf_hmtx *
lo
pdf_hmtx_lo_get(pdf_hmtx self) -> unsigned short
 
Parameters
----------
self: pdf_hmtx *
thisown
The membership flag
w
pdf_hmtx_w_get(pdf_hmtx self) -> int
 
Parameters
----------
self: pdf_hmtx *

 
class pdf_keystroke_event(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_keystroke_event(...)
delete_pdf_keystroke_event(pdf_keystroke_event self)
 
Parameters
----------
self: pdf_keystroke_event *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
change
pdf_keystroke_event_change_get(pdf_keystroke_event self) -> char const *
 
Parameters
----------
self: pdf_keystroke_event *
newChange
pdf_keystroke_event_newChange_get(pdf_keystroke_event self) -> char *
 
Parameters
----------
self: pdf_keystroke_event *
selEnd
pdf_keystroke_event_selEnd_get(pdf_keystroke_event self) -> int
 
Parameters
----------
self: pdf_keystroke_event *
selStart
pdf_keystroke_event_selStart_get(pdf_keystroke_event self) -> int
 
Parameters
----------
self: pdf_keystroke_event *
thisown
The membership flag
value
pdf_keystroke_event_value_get(pdf_keystroke_event self) -> char const *
 
Parameters
----------
self: pdf_keystroke_event *
willCommit
pdf_keystroke_event_willCommit_get(pdf_keystroke_event self) -> int
 
Parameters
----------
self: pdf_keystroke_event *

 
class pdf_launch_url_event(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_launch_url_event(...)
delete_pdf_launch_url_event(pdf_launch_url_event self)
 
Parameters
----------
self: pdf_launch_url_event *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
new_frame
pdf_launch_url_event_new_frame_get(pdf_launch_url_event self) -> int
 
Parameters
----------
self: pdf_launch_url_event *
thisown
The membership flag
url
pdf_launch_url_event_url_get(pdf_launch_url_event self) -> char const *
 
Parameters
----------
self: pdf_launch_url_event *

 
class pdf_layer_config(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_layer_config(...)
delete_pdf_layer_config(pdf_layer_config self)
 
Parameters
----------
self: pdf_layer_config *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
creator
pdf_layer_config_creator_get(pdf_layer_config self) -> char const *
 
Parameters
----------
self: pdf_layer_config *
name
pdf_layer_config_name_get(pdf_layer_config self) -> char const *
 
Parameters
----------
self: pdf_layer_config *
thisown
The membership flag

 
class pdf_layer_config_ui(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_layer_config_ui(...)
delete_pdf_layer_config_ui(pdf_layer_config_ui self)
 
Parameters
----------
self: pdf_layer_config_ui *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
depth
pdf_layer_config_ui_depth_get(pdf_layer_config_ui self) -> int
 
Parameters
----------
self: pdf_layer_config_ui *
locked
pdf_layer_config_ui_locked_get(pdf_layer_config_ui self) -> int
 
Parameters
----------
self: pdf_layer_config_ui *
selected
pdf_layer_config_ui_selected_get(pdf_layer_config_ui self) -> int
 
Parameters
----------
self: pdf_layer_config_ui *
text
pdf_layer_config_ui_text_get(pdf_layer_config_ui self) -> char const *
 
Parameters
----------
self: pdf_layer_config_ui *
thisown
The membership flag
type
pdf_layer_config_ui_type_get(pdf_layer_config_ui self) -> pdf_layer_config_ui_type
 
Parameters
----------
self: pdf_layer_config_ui *

 
class pdf_lexbuf(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_lexbuf(...)
delete_pdf_lexbuf(pdf_lexbuf self)
 
Parameters
----------
self: pdf_lexbuf *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
base_size
pdf_lexbuf_base_size_get(pdf_lexbuf self) -> size_t
 
Parameters
----------
self: pdf_lexbuf *
buffer
pdf_lexbuf_buffer_get(pdf_lexbuf self) -> char [PDF_LEXBUF_SMALL]
 
Parameters
----------
self: pdf_lexbuf *
f
pdf_lexbuf_f_get(pdf_lexbuf self) -> float
 
Parameters
----------
self: pdf_lexbuf *
i
pdf_lexbuf_i_get(pdf_lexbuf self) -> int64_t
 
Parameters
----------
self: pdf_lexbuf *
len
pdf_lexbuf_len_get(pdf_lexbuf self) -> size_t
 
Parameters
----------
self: pdf_lexbuf *
scratch
pdf_lexbuf_scratch_get(pdf_lexbuf self) -> char *
 
Parameters
----------
self: pdf_lexbuf *
size
pdf_lexbuf_size_get(pdf_lexbuf self) -> size_t
 
Parameters
----------
self: pdf_lexbuf *
thisown
The membership flag

 
class pdf_lexbuf_large(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_lexbuf_large(...)
delete_pdf_lexbuf_large(pdf_lexbuf_large self)
 
Parameters
----------
self: pdf_lexbuf_large *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
base
pdf_lexbuf_large_base_get(pdf_lexbuf_large self) -> pdf_lexbuf
 
Parameters
----------
self: pdf_lexbuf_large *
buffer
pdf_lexbuf_large_buffer_get(pdf_lexbuf_large self) -> char [PDF_LEXBUF_LARGE-PDF_LEXBUF_SMALL]
 
Parameters
----------
self: pdf_lexbuf_large *
thisown
The membership flag

 
class pdf_mail_doc_event(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_mail_doc_event(...)
delete_pdf_mail_doc_event(pdf_mail_doc_event self)
 
Parameters
----------
self: pdf_mail_doc_event *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
ask_user
pdf_mail_doc_event_ask_user_get(pdf_mail_doc_event self) -> int
 
Parameters
----------
self: pdf_mail_doc_event *
bcc
pdf_mail_doc_event_bcc_get(pdf_mail_doc_event self) -> char const *
 
Parameters
----------
self: pdf_mail_doc_event *
cc
pdf_mail_doc_event_cc_get(pdf_mail_doc_event self) -> char const *
 
Parameters
----------
self: pdf_mail_doc_event *
message
pdf_mail_doc_event_message_get(pdf_mail_doc_event self) -> char const *
 
Parameters
----------
self: pdf_mail_doc_event *
subject
pdf_mail_doc_event_subject_get(pdf_mail_doc_event self) -> char const *
 
Parameters
----------
self: pdf_mail_doc_event *
thisown
The membership flag
to
pdf_mail_doc_event_to_get(pdf_mail_doc_event self) -> char const *
 
Parameters
----------
self: pdf_mail_doc_event *

 
class pdf_mrange(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_mrange(...)
delete_pdf_mrange(pdf_mrange self)
 
Parameters
----------
self: pdf_mrange *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
low
pdf_mrange_low_get(pdf_mrange self) -> unsigned int
 
Parameters
----------
self: pdf_mrange *
out
pdf_mrange_out_get(pdf_mrange self) -> unsigned int
 
Parameters
----------
self: pdf_mrange *
thisown
The membership flag

 
class pdf_page(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_page(...)
delete_pdf_page(pdf_page * self)
 
Parameters
----------
self: pdf_page *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
annot_tailp
pdf_page_annot_tailp_get(pdf_page * self) -> pdf_annot **
 
Parameters
----------
self: pdf_page *
annots
pdf_page_annots_get(pdf_page * self) -> pdf_annot *
 
Parameters
----------
self: pdf_page *
doc
pdf_page_doc_get(pdf_page * self) -> pdf_document *
 
Parameters
----------
self: pdf_page *
links
pdf_page_links_get(pdf_page * self) -> fz_link
 
Parameters
----------
self: pdf_page *
obj
pdf_page_obj_get(pdf_page * self) -> pdf_obj *
 
Parameters
----------
self: pdf_page *
overprint
pdf_page_overprint_get(pdf_page * self) -> int
 
Parameters
----------
self: pdf_page *
super
pdf_page_super_get(pdf_page * self) -> fz_page *
 
Parameters
----------
self: pdf_page *
thisown
The membership flag
transparency
pdf_page_transparency_get(pdf_page * self) -> int
 
Parameters
----------
self: pdf_page *
widget_tailp
pdf_page_widget_tailp_get(pdf_page * self) -> pdf_widget **
 
Parameters
----------
self: pdf_page *
widgets
pdf_page_widgets_get(pdf_page * self) -> pdf_widget *
 
Parameters
----------
self: pdf_page *

 
class pdf_pattern(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_pattern(...)
delete_pdf_pattern(pdf_pattern self)
 
Parameters
----------
self: pdf_pattern *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
bbox
pdf_pattern_bbox_get(pdf_pattern self) -> fz_rect
 
Parameters
----------
self: pdf_pattern *
contents
pdf_pattern_contents_get(pdf_pattern self) -> pdf_obj *
 
Parameters
----------
self: pdf_pattern *
document
pdf_pattern_document_get(pdf_pattern self) -> pdf_document *
 
Parameters
----------
self: pdf_pattern *
id
pdf_pattern_id_get(pdf_pattern self) -> int
 
Parameters
----------
self: pdf_pattern *
ismask
pdf_pattern_ismask_get(pdf_pattern self) -> int
 
Parameters
----------
self: pdf_pattern *
matrix
pdf_pattern_matrix_get(pdf_pattern self) -> fz_matrix
 
Parameters
----------
self: pdf_pattern *
resources
pdf_pattern_resources_get(pdf_pattern self) -> pdf_obj *
 
Parameters
----------
self: pdf_pattern *
storable
pdf_pattern_storable_get(pdf_pattern self) -> fz_storable *
 
Parameters
----------
self: pdf_pattern *
thisown
The membership flag
xstep
pdf_pattern_xstep_get(pdf_pattern self) -> float
 
Parameters
----------
self: pdf_pattern *
ystep
pdf_pattern_ystep_get(pdf_pattern self) -> float
 
Parameters
----------
self: pdf_pattern *

 
class pdf_pkcs7_designated_name(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_pkcs7_designated_name(...)
delete_pdf_pkcs7_designated_name(pdf_pkcs7_designated_name self)
 
Parameters
----------
self: pdf_pkcs7_designated_name *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
c
pdf_pkcs7_designated_name_c_get(pdf_pkcs7_designated_name self) -> char *
 
Parameters
----------
self: pdf_pkcs7_designated_name *
cn
pdf_pkcs7_designated_name_cn_get(pdf_pkcs7_designated_name self) -> char *
 
Parameters
----------
self: pdf_pkcs7_designated_name *
email
pdf_pkcs7_designated_name_email_get(pdf_pkcs7_designated_name self) -> char *
 
Parameters
----------
self: pdf_pkcs7_designated_name *
o
pdf_pkcs7_designated_name_o_get(pdf_pkcs7_designated_name self) -> char *
 
Parameters
----------
self: pdf_pkcs7_designated_name *
ou
pdf_pkcs7_designated_name_ou_get(pdf_pkcs7_designated_name self) -> char *
 
Parameters
----------
self: pdf_pkcs7_designated_name *
thisown
The membership flag

 
class pdf_pkcs7_signer(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_pkcs7_signer(...)
delete_pdf_pkcs7_signer(pdf_pkcs7_signer * self)
 
Parameters
----------
self: pdf_pkcs7_signer *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
create_digest
pdf_pkcs7_signer_create_digest_get(pdf_pkcs7_signer * self) -> pdf_pkcs7_create_digest_fn *
 
Parameters
----------
self: pdf_pkcs7_signer *
drop
pdf_pkcs7_signer_drop_get(pdf_pkcs7_signer * self) -> pdf_pkcs7_drop_signer_fn *
 
Parameters
----------
self: pdf_pkcs7_signer *
get_signing_name
pdf_pkcs7_signer_get_signing_name_get(pdf_pkcs7_signer * self) -> pdf_pkcs7_get_signing_name_fn *
 
Parameters
----------
self: pdf_pkcs7_signer *
keep
pdf_pkcs7_signer_keep_get(pdf_pkcs7_signer * self) -> pdf_pkcs7_keep_signer_fn *
 
Parameters
----------
self: pdf_pkcs7_signer *
max_digest_size
pdf_pkcs7_signer_max_digest_size_get(pdf_pkcs7_signer * self) -> pdf_pkcs7_max_digest_size_fn *
 
Parameters
----------
self: pdf_pkcs7_signer *
thisown
The membership flag

 
class pdf_pkcs7_verifier(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_pkcs7_verifier(...)
delete_pdf_pkcs7_verifier(pdf_pkcs7_verifier * self)
 
Parameters
----------
self: pdf_pkcs7_verifier *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
check_certificate
pdf_pkcs7_verifier_check_certificate_get(pdf_pkcs7_verifier * self) -> pdf_pkcs7_check_certificate_fn *
 
Parameters
----------
self: pdf_pkcs7_verifier *
check_digest
pdf_pkcs7_verifier_check_digest_get(pdf_pkcs7_verifier * self) -> pdf_pkcs7_check_digest_fn *
 
Parameters
----------
self: pdf_pkcs7_verifier *
drop
pdf_pkcs7_verifier_drop_get(pdf_pkcs7_verifier * self) -> pdf_pkcs7_drop_verifier_fn *
 
Parameters
----------
self: pdf_pkcs7_verifier *
get_signatory
pdf_pkcs7_verifier_get_signatory_get(pdf_pkcs7_verifier * self) -> pdf_pkcs7_get_signatory_fn *
 
Parameters
----------
self: pdf_pkcs7_verifier *
thisown
The membership flag

 
class pdf_processor(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_processor(...)
delete_pdf_processor(pdf_processor * self)
 
Parameters
----------
self: pdf_processor *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
close_processor
pdf_processor_close_processor_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
drop_processor
pdf_processor_drop_processor_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
hidden
pdf_processor_hidden_get(pdf_processor * self) -> int
 
Parameters
----------
self: pdf_processor *
op_B
pdf_processor_op_B_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_BDC
pdf_processor_op_BDC_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *,pdf_obj *,pdf_obj *)
 
Parameters
----------
self: pdf_processor *
op_BI
pdf_processor_op_BI_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,fz_image *,char const *)
 
Parameters
----------
self: pdf_processor *
op_BMC
pdf_processor_op_BMC_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *)
 
Parameters
----------
self: pdf_processor *
op_BT
pdf_processor_op_BT_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_BX
pdf_processor_op_BX_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_Bstar
pdf_processor_op_Bstar_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_CS
pdf_processor_op_CS_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *,fz_colorspace *)
 
Parameters
----------
self: pdf_processor *
op_DP
pdf_processor_op_DP_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *,pdf_obj *,pdf_obj *)
 
Parameters
----------
self: pdf_processor *
op_Do_form
pdf_processor_op_Do_form_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *,pdf_obj *,pdf_obj *)
 
Parameters
----------
self: pdf_processor *
op_Do_image
pdf_processor_op_Do_image_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *,fz_image *)
 
Parameters
----------
self: pdf_processor *
op_EMC
pdf_processor_op_EMC_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_END
pdf_processor_op_END_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_ET
pdf_processor_op_ET_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_EX
pdf_processor_op_EX_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_F
pdf_processor_op_F_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_G
pdf_processor_op_G_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float)
 
Parameters
----------
self: pdf_processor *
op_J
pdf_processor_op_J_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,int)
 
Parameters
----------
self: pdf_processor *
op_K
pdf_processor_op_K_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float,float,float)
 
Parameters
----------
self: pdf_processor *
op_M
pdf_processor_op_M_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float)
 
Parameters
----------
self: pdf_processor *
op_MP
pdf_processor_op_MP_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *)
 
Parameters
----------
self: pdf_processor *
op_Q
pdf_processor_op_Q_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_RG
pdf_processor_op_RG_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float,float)
 
Parameters
----------
self: pdf_processor *
op_S
pdf_processor_op_S_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_SC_color
pdf_processor_op_SC_color_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,int,float *)
 
Parameters
----------
self: pdf_processor *
op_SC_pattern
pdf_processor_op_SC_pattern_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *,pdf_pattern *,int,float *)
 
Parameters
----------
self: pdf_processor *
op_SC_shade
pdf_processor_op_SC_shade_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *,fz_shade *)
 
Parameters
----------
self: pdf_processor *
op_TD
pdf_processor_op_TD_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float)
 
Parameters
----------
self: pdf_processor *
op_TJ
pdf_processor_op_TJ_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,pdf_obj *)
 
Parameters
----------
self: pdf_processor *
op_TL
pdf_processor_op_TL_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float)
 
Parameters
----------
self: pdf_processor *
op_Tc
pdf_processor_op_Tc_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float)
 
Parameters
----------
self: pdf_processor *
op_Td
pdf_processor_op_Td_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float)
 
Parameters
----------
self: pdf_processor *
op_Tf
pdf_processor_op_Tf_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *,pdf_font_desc *,float)
 
Parameters
----------
self: pdf_processor *
op_Tj
pdf_processor_op_Tj_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char *,size_t)
 
Parameters
----------
self: pdf_processor *
op_Tm
pdf_processor_op_Tm_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float,float,float,float,float)
 
Parameters
----------
self: pdf_processor *
op_Tr
pdf_processor_op_Tr_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,int)
 
Parameters
----------
self: pdf_processor *
op_Ts
pdf_processor_op_Ts_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float)
 
Parameters
----------
self: pdf_processor *
op_Tstar
pdf_processor_op_Tstar_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_Tw
pdf_processor_op_Tw_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float)
 
Parameters
----------
self: pdf_processor *
op_Tz
pdf_processor_op_Tz_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float)
 
Parameters
----------
self: pdf_processor *
op_W
pdf_processor_op_W_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_Wstar
pdf_processor_op_Wstar_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_b
pdf_processor_op_b_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_bstar
pdf_processor_op_bstar_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_c
pdf_processor_op_c_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float,float,float,float,float)
 
Parameters
----------
self: pdf_processor *
op_cm
pdf_processor_op_cm_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float,float,float,float,float)
 
Parameters
----------
self: pdf_processor *
op_cs
pdf_processor_op_cs_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *,fz_colorspace *)
 
Parameters
----------
self: pdf_processor *
op_d
pdf_processor_op_d_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,pdf_obj *,float)
 
Parameters
----------
self: pdf_processor *
op_d0
pdf_processor_op_d0_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float)
 
Parameters
----------
self: pdf_processor *
op_d1
pdf_processor_op_d1_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float,float,float,float,float)
 
Parameters
----------
self: pdf_processor *
op_dquote
pdf_processor_op_dquote_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float,char *,size_t)
 
Parameters
----------
self: pdf_processor *
op_f
pdf_processor_op_f_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_fstar
pdf_processor_op_fstar_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_g
pdf_processor_op_g_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float)
 
Parameters
----------
self: pdf_processor *
op_gs_BM
pdf_processor_op_gs_BM_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *)
 
Parameters
----------
self: pdf_processor *
op_gs_CA
pdf_processor_op_gs_CA_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float)
 
Parameters
----------
self: pdf_processor *
op_gs_OP
pdf_processor_op_gs_OP_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,int)
 
Parameters
----------
self: pdf_processor *
op_gs_OPM
pdf_processor_op_gs_OPM_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,int)
 
Parameters
----------
self: pdf_processor *
op_gs_SMask
pdf_processor_op_gs_SMask_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,pdf_obj *,pdf_obj *,float *,int)
 
Parameters
----------
self: pdf_processor *
op_gs_UseBlackPtComp
pdf_processor_op_gs_UseBlackPtComp_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,pdf_obj *)
 
Parameters
----------
self: pdf_processor *
op_gs_begin
pdf_processor_op_gs_begin_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *,pdf_obj *)
 
Parameters
----------
self: pdf_processor *
op_gs_ca
pdf_processor_op_gs_ca_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float)
 
Parameters
----------
self: pdf_processor *
op_gs_end
pdf_processor_op_gs_end_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_gs_op
pdf_processor_op_gs_op_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,int)
 
Parameters
----------
self: pdf_processor *
op_h
pdf_processor_op_h_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_i
pdf_processor_op_i_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float)
 
Parameters
----------
self: pdf_processor *
op_j
pdf_processor_op_j_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,int)
 
Parameters
----------
self: pdf_processor *
op_k
pdf_processor_op_k_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float,float,float)
 
Parameters
----------
self: pdf_processor *
op_l
pdf_processor_op_l_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float)
 
Parameters
----------
self: pdf_processor *
op_m
pdf_processor_op_m_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float)
 
Parameters
----------
self: pdf_processor *
op_n
pdf_processor_op_n_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_q
pdf_processor_op_q_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_re
pdf_processor_op_re_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float,float,float)
 
Parameters
----------
self: pdf_processor *
op_rg
pdf_processor_op_rg_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float,float)
 
Parameters
----------
self: pdf_processor *
op_ri
pdf_processor_op_ri_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *)
 
Parameters
----------
self: pdf_processor *
op_s
pdf_processor_op_s_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *)
 
Parameters
----------
self: pdf_processor *
op_sc_color
pdf_processor_op_sc_color_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,int,float *)
 
Parameters
----------
self: pdf_processor *
op_sc_pattern
pdf_processor_op_sc_pattern_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *,pdf_pattern *,int,float *)
 
Parameters
----------
self: pdf_processor *
op_sc_shade
pdf_processor_op_sc_shade_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *,fz_shade *)
 
Parameters
----------
self: pdf_processor *
op_sh
pdf_processor_op_sh_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char const *,fz_shade *)
 
Parameters
----------
self: pdf_processor *
op_squote
pdf_processor_op_squote_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,char *,size_t)
 
Parameters
----------
self: pdf_processor *
op_v
pdf_processor_op_v_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float,float,float)
 
Parameters
----------
self: pdf_processor *
op_w
pdf_processor_op_w_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float)
 
Parameters
----------
self: pdf_processor *
op_y
pdf_processor_op_y_get(pdf_processor * self) -> void (*)(fz_context *,pdf_processor *,float,float,float,float)
 
Parameters
----------
self: pdf_processor *
thisown
The membership flag
usage
pdf_processor_usage_get(pdf_processor * self) -> char const *
 
Parameters
----------
self: pdf_processor *

 
class pdf_range(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_range(...)
delete_pdf_range(pdf_range self)
 
Parameters
----------
self: pdf_range *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
high
pdf_range_high_get(pdf_range self) -> unsigned short
 
Parameters
----------
self: pdf_range *
low
pdf_range_low_get(pdf_range self) -> unsigned short
 
Parameters
----------
self: pdf_range *
out
pdf_range_out_get(pdf_range self) -> unsigned short
 
Parameters
----------
self: pdf_range *
thisown
The membership flag

 
class pdf_redact_options(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_redact_options(...)
delete_pdf_redact_options(pdf_redact_options self)
 
Parameters
----------
self: pdf_redact_options *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
keep_images
pdf_redact_options_keep_images_get(pdf_redact_options self) -> int
 
Parameters
----------
self: pdf_redact_options *
no_black_boxes
pdf_redact_options_no_black_boxes_get(pdf_redact_options self) -> int
 
Parameters
----------
self: pdf_redact_options *
thisown
The membership flag

 
class pdf_rev_page_map(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_rev_page_map(...)
delete_pdf_rev_page_map(pdf_rev_page_map self)
 
Parameters
----------
self: pdf_rev_page_map *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
object
pdf_rev_page_map_object_get(pdf_rev_page_map self) -> int
 
Parameters
----------
self: pdf_rev_page_map *
page
pdf_rev_page_map_page_get(pdf_rev_page_map self) -> int
 
Parameters
----------
self: pdf_rev_page_map *
thisown
The membership flag

 
class pdf_text_object_state(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_text_object_state(...)
delete_pdf_text_object_state(pdf_text_object_state self)
 
Parameters
----------
self: pdf_text_object_state *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
char_bbox
pdf_text_object_state_char_bbox_get(pdf_text_object_state self) -> fz_rect
 
Parameters
----------
self: pdf_text_object_state *
char_tx
pdf_text_object_state_char_tx_get(pdf_text_object_state self) -> float
 
Parameters
----------
self: pdf_text_object_state *
char_ty
pdf_text_object_state_char_ty_get(pdf_text_object_state self) -> float
 
Parameters
----------
self: pdf_text_object_state *
cid
pdf_text_object_state_cid_get(pdf_text_object_state self) -> int
 
Parameters
----------
self: pdf_text_object_state *
fontdesc
pdf_text_object_state_fontdesc_get(pdf_text_object_state self) -> pdf_font_desc
 
Parameters
----------
self: pdf_text_object_state *
gid
pdf_text_object_state_gid_get(pdf_text_object_state self) -> int
 
Parameters
----------
self: pdf_text_object_state *
text
pdf_text_object_state_text_get(pdf_text_object_state self) -> fz_text
 
Parameters
----------
self: pdf_text_object_state *
text_bbox
pdf_text_object_state_text_bbox_get(pdf_text_object_state self) -> fz_rect
 
Parameters
----------
self: pdf_text_object_state *
text_mode
pdf_text_object_state_text_mode_get(pdf_text_object_state self) -> int
 
Parameters
----------
self: pdf_text_object_state *
thisown
The membership flag
tlm
pdf_text_object_state_tlm_get(pdf_text_object_state self) -> fz_matrix
 
Parameters
----------
self: pdf_text_object_state *
tm
pdf_text_object_state_tm_get(pdf_text_object_state self) -> fz_matrix
 
Parameters
----------
self: pdf_text_object_state *

 
class pdf_text_state(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_text_state(...)
delete_pdf_text_state(pdf_text_state self)
 
Parameters
----------
self: pdf_text_state *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
char_space
pdf_text_state_char_space_get(pdf_text_state self) -> float
 
Parameters
----------
self: pdf_text_state *
font
pdf_text_state_font_get(pdf_text_state self) -> pdf_font_desc
 
Parameters
----------
self: pdf_text_state *
leading
pdf_text_state_leading_get(pdf_text_state self) -> float
 
Parameters
----------
self: pdf_text_state *
render
pdf_text_state_render_get(pdf_text_state self) -> int
 
Parameters
----------
self: pdf_text_state *
rise
pdf_text_state_rise_get(pdf_text_state self) -> float
 
Parameters
----------
self: pdf_text_state *
scale
pdf_text_state_scale_get(pdf_text_state self) -> float
 
Parameters
----------
self: pdf_text_state *
size
pdf_text_state_size_get(pdf_text_state self) -> float
 
Parameters
----------
self: pdf_text_state *
thisown
The membership flag
word_space
pdf_text_state_word_space_get(pdf_text_state self) -> float
 
Parameters
----------
self: pdf_text_state *

 
class pdf_unsaved_sig(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_unsaved_sig(...)
delete_pdf_unsaved_sig(pdf_unsaved_sig self)
 
Parameters
----------
self: pdf_unsaved_sig *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
byte_range_end
pdf_unsaved_sig_byte_range_end_get(pdf_unsaved_sig self) -> size_t
 
Parameters
----------
self: pdf_unsaved_sig *
byte_range_start
pdf_unsaved_sig_byte_range_start_get(pdf_unsaved_sig self) -> size_t
 
Parameters
----------
self: pdf_unsaved_sig *
contents_end
pdf_unsaved_sig_contents_end_get(pdf_unsaved_sig self) -> size_t
 
Parameters
----------
self: pdf_unsaved_sig *
contents_start
pdf_unsaved_sig_contents_start_get(pdf_unsaved_sig self) -> size_t
 
Parameters
----------
self: pdf_unsaved_sig *
field
pdf_unsaved_sig_field_get(pdf_unsaved_sig self) -> pdf_obj *
 
Parameters
----------
self: pdf_unsaved_sig *
next
pdf_unsaved_sig_next_get(pdf_unsaved_sig self) -> pdf_unsaved_sig
 
Parameters
----------
self: pdf_unsaved_sig *
signer
pdf_unsaved_sig_signer_get(pdf_unsaved_sig self) -> pdf_pkcs7_signer *
 
Parameters
----------
self: pdf_unsaved_sig *
thisown
The membership flag

 
class pdf_vmtx(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_vmtx(...)
delete_pdf_vmtx(pdf_vmtx self)
 
Parameters
----------
self: pdf_vmtx *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
hi
pdf_vmtx_hi_get(pdf_vmtx self) -> unsigned short
 
Parameters
----------
self: pdf_vmtx *
lo
pdf_vmtx_lo_get(pdf_vmtx self) -> unsigned short
 
Parameters
----------
self: pdf_vmtx *
thisown
The membership flag
w
pdf_vmtx_w_get(pdf_vmtx self) -> short
 
Parameters
----------
self: pdf_vmtx *
x
pdf_vmtx_x_get(pdf_vmtx self) -> short
 
Parameters
----------
self: pdf_vmtx *
y
pdf_vmtx_y_get(pdf_vmtx self) -> short
 
Parameters
----------
self: pdf_vmtx *

 
class pdf_write_options(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_write_options(...)
delete_pdf_write_options(pdf_write_options self)
 
Parameters
----------
self: pdf_write_options *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
do_appearance
pdf_write_options_do_appearance_get(pdf_write_options self) -> int
 
Parameters
----------
self: pdf_write_options *
do_ascii
pdf_write_options_do_ascii_get(pdf_write_options self) -> int
 
Parameters
----------
self: pdf_write_options *
do_clean
pdf_write_options_do_clean_get(pdf_write_options self) -> int
 
Parameters
----------
self: pdf_write_options *
do_compress
pdf_write_options_do_compress_get(pdf_write_options self) -> int
 
Parameters
----------
self: pdf_write_options *
do_compress_fonts
pdf_write_options_do_compress_fonts_get(pdf_write_options self) -> int
 
Parameters
----------
self: pdf_write_options *
do_compress_images
pdf_write_options_do_compress_images_get(pdf_write_options self) -> int
 
Parameters
----------
self: pdf_write_options *
do_decompress
pdf_write_options_do_decompress_get(pdf_write_options self) -> int
 
Parameters
----------
self: pdf_write_options *
do_encrypt
pdf_write_options_do_encrypt_get(pdf_write_options self) -> int
 
Parameters
----------
self: pdf_write_options *
do_garbage
pdf_write_options_do_garbage_get(pdf_write_options self) -> int
 
Parameters
----------
self: pdf_write_options *
do_incremental
pdf_write_options_do_incremental_get(pdf_write_options self) -> int
 
Parameters
----------
self: pdf_write_options *
do_linear
pdf_write_options_do_linear_get(pdf_write_options self) -> int
 
Parameters
----------
self: pdf_write_options *
do_pretty
pdf_write_options_do_pretty_get(pdf_write_options self) -> int
 
Parameters
----------
self: pdf_write_options *
do_sanitize
pdf_write_options_do_sanitize_get(pdf_write_options self) -> int
 
Parameters
----------
self: pdf_write_options *
opwd_utf8
pdf_write_options_opwd_utf8_get(pdf_write_options self) -> char [128]
 
Parameters
----------
self: pdf_write_options *
permissions
pdf_write_options_permissions_get(pdf_write_options self) -> int
 
Parameters
----------
self: pdf_write_options *
thisown
The membership flag
upwd_utf8
pdf_write_options_upwd_utf8_get(pdf_write_options self) -> char [128]
 
Parameters
----------
self: pdf_write_options *

 
class pdf_xfa(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_xfa(...)
delete_pdf_xfa(pdf_xfa self)
 
Parameters
----------
self: pdf_xfa *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
count
pdf_xfa_count_get(pdf_xfa self) -> int
 
Parameters
----------
self: pdf_xfa *
entries
pdf_xfa_entries_get(pdf_xfa self) -> pdf_xfa_entry
 
Parameters
----------
self: pdf_xfa *
thisown
The membership flag

 
class pdf_xfa_entry(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_xfa_entry(...)
delete_pdf_xfa_entry(pdf_xfa_entry self)
 
Parameters
----------
self: pdf_xfa_entry *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
key
pdf_xfa_entry_key_get(pdf_xfa_entry self) -> char *
 
Parameters
----------
self: pdf_xfa_entry *
thisown
The membership flag
value
pdf_xfa_entry_value_get(pdf_xfa_entry self) -> fz_xml_doc *
 
Parameters
----------
self: pdf_xfa_entry *

 
class pdf_xrange(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_xrange(...)
delete_pdf_xrange(pdf_xrange self)
 
Parameters
----------
self: pdf_xrange *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
high
pdf_xrange_high_get(pdf_xrange self) -> unsigned int
 
Parameters
----------
self: pdf_xrange *
low
pdf_xrange_low_get(pdf_xrange self) -> unsigned int
 
Parameters
----------
self: pdf_xrange *
out
pdf_xrange_out_get(pdf_xrange self) -> unsigned int
 
Parameters
----------
self: pdf_xrange *
thisown
The membership flag

 
class pdf_xref(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_xref(...)
delete_pdf_xref(pdf_xref * self)
 
Parameters
----------
self: pdf_xref *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
end_ofs
pdf_xref_end_ofs_get(pdf_xref * self) -> int64_t
 
Parameters
----------
self: pdf_xref *
num_objects
pdf_xref_num_objects_get(pdf_xref * self) -> int
 
Parameters
----------
self: pdf_xref *
pre_repair_trailer
pdf_xref_pre_repair_trailer_get(pdf_xref * self) -> pdf_obj *
 
Parameters
----------
self: pdf_xref *
subsec
pdf_xref_subsec_get(pdf_xref * self) -> pdf_xref_subsec
 
Parameters
----------
self: pdf_xref *
thisown
The membership flag
trailer
pdf_xref_trailer_get(pdf_xref * self) -> pdf_obj *
 
Parameters
----------
self: pdf_xref *
unsaved_sigs
pdf_xref_unsaved_sigs_get(pdf_xref * self) -> pdf_unsaved_sig
 
Parameters
----------
self: pdf_xref *
unsaved_sigs_end
pdf_xref_unsaved_sigs_end_get(pdf_xref * self) -> pdf_unsaved_sig **
 
Parameters
----------
self: pdf_xref *

 
class pdf_xref_entry(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_xref_entry(...)
delete_pdf_xref_entry(pdf_xref_entry self)
 
Parameters
----------
self: pdf_xref_entry *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
gen
pdf_xref_entry_gen_get(pdf_xref_entry self) -> unsigned short
 
Parameters
----------
self: pdf_xref_entry *
marked
pdf_xref_entry_marked_get(pdf_xref_entry self) -> unsigned char
 
Parameters
----------
self: pdf_xref_entry *
num
pdf_xref_entry_num_get(pdf_xref_entry self) -> int
 
Parameters
----------
self: pdf_xref_entry *
obj
pdf_xref_entry_obj_get(pdf_xref_entry self) -> pdf_obj *
 
Parameters
----------
self: pdf_xref_entry *
ofs
pdf_xref_entry_ofs_get(pdf_xref_entry self) -> int64_t
 
Parameters
----------
self: pdf_xref_entry *
stm_buf
pdf_xref_entry_stm_buf_get(pdf_xref_entry self) -> fz_buffer
 
Parameters
----------
self: pdf_xref_entry *
stm_ofs
pdf_xref_entry_stm_ofs_get(pdf_xref_entry self) -> int64_t
 
Parameters
----------
self: pdf_xref_entry *
thisown
The membership flag
type
pdf_xref_entry_type_get(pdf_xref_entry self) -> char
 
Parameters
----------
self: pdf_xref_entry *

 
class pdf_xref_subsec(builtins.object)
     Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__repr__ = _swig_repr(self)

Static methods defined here:
__swig_destroy__ = delete_pdf_xref_subsec(...)
delete_pdf_xref_subsec(pdf_xref_subsec self)
 
Parameters
----------
self: pdf_xref_subsec *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
len
pdf_xref_subsec_len_get(pdf_xref_subsec self) -> int
 
Parameters
----------
self: pdf_xref_subsec *
next
pdf_xref_subsec_next_get(pdf_xref_subsec self) -> pdf_xref_subsec
 
Parameters
----------
self: pdf_xref_subsec *
start
pdf_xref_subsec_start_get(pdf_xref_subsec self) -> int
 
Parameters
----------
self: pdf_xref_subsec *
table
pdf_xref_subsec_table_get(pdf_xref_subsec self) -> pdf_xref_entry
 
Parameters
----------
self: pdf_xref_subsec *
thisown
The membership flag

 
class vectori(builtins.object)
    vectori(*args)
 

 
  Methods defined here:
__bool__(self)
__delitem__(self, *args)
__delslice__(self, i, j)
__getitem__(self, *args)
__getslice__(self, i, j)
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__iter__(self)
__len__(self)
__nonzero__(self)
__repr__ = _swig_repr(self)
__setitem__(self, *args)
__setslice__(self, *args)
append(self, x)
assign(self, n, x)
back(self)
begin(self)
capacity(self)
clear(self)
empty(self)
end(self)
erase(self, *args)
front(self)
get_allocator(self)
insert(self, *args)
iterator(self)
pop(self)
pop_back(self)
push_back(self, x)
rbegin(self)
rend(self)
reserve(self, n)
resize(self, *args)
size(self)
swap(self, v)

Static methods defined here:
__swig_destroy__ = delete_vectori(...)
delete_vectori(vectori self)
 
Parameters
----------
self: std::vector< int > *

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag

 
Functions
       
Buffer_new_buffer_from_copied_data(data, size)
Create a new buffer containing a copy of the passed data.
Device_new_draw_device_type3(transform, dest)
DisplayList_new_display_list_from_page_contents(page)
Create a display list from page contents (no annotations).
 
Ownership of the display list is returned to the caller.
Matrix_rotate(degrees)
Create a rotation matrix.
 
The returned matrix is of the form
[ cos(deg) sin(deg) -sin(deg) cos(deg) 0 0 ].
 
m: Pointer to place to store matrix
 
degrees: Degrees of counter clockwise rotation. Values less
than zero and greater than 360 are handled as expected.
 
Returns m.
Matrix_scale(sx, sy)
Create a scaling matrix.
 
The returned matrix is of the form [ sx 0 0 sy 0 0 ].
 
m: Pointer to the matrix to populate
 
sx, sy: Scaling factors along the X- and Y-axes. A scaling
factor of 1.0 will not cause any scaling along the relevant
axis.
 
Returns m.
Matrix_shear(sx, sy)
Create a shearing matrix.
 
The returned matrix is of the form [ 1 sy sx 1 0 0 ].
 
m: pointer to place to store returned matrix
 
sx, sy: Shearing factors. A shearing factor of 0.0 will not
cause any shearing along the relevant axis.
 
Returns m.
Matrix_transform_page(mediabox, resolution, rotate)
Create transform matrix to draw page
at a given resolution and rotation. Adjusts the scaling
factors so that the page covers whole number of
pixels and adjust the page origin to be at 0,0.
Matrix_translate(tx, ty)
Create a translation matrix.
 
The returned matrix is of the form [ 1 0 0 1 tx ty ].
 
m: A place to store the created matrix.
 
tx, ty: Translation distances along the X- and Y-axes. A
translation of 0 will not cause any translation along the
relevant axis.
 
Returns m.
Memento_adjustRef(blk, adjust)
Memento_breakAt(arg1)
Memento_breakOnFree(a)
Memento_breakOnRealloc(a)
Memento_breakpoint()
Memento_bt()
Memento_calloc(arg1, arg2)
Memento_check()
Memento_checkAllMemory()
Memento_checkBlock(arg1)
Memento_checkBytePointerOrNull(blk)
Memento_checkIntPointerOrNull(blk)
Memento_checkPointerOrNull(blk)
Memento_checkShortPointerOrNull(blk)
Memento_dropByteRef(blk)
Memento_dropIntRef(blk)
Memento_dropRef(blk)
Memento_dropShortRef(blk)
Memento_failAt(arg1)
Memento_failThisEvent()
Memento_fin()
Memento_find(a)
Memento_free(arg1)
Memento_getBlockNum(arg1)
Memento_info(addr)
Memento_label(arg1, arg2)
Memento_listBlockInfo()
Memento_listBlocks()
Memento_listNewBlocks()
Memento_malloc(s)
Memento_paranoidAt(arg1)
Memento_realloc(arg1, s)
Memento_reference(blk)
Memento_sequence()
Memento_setMax(arg1)
Memento_setParanoia(arg1)
Memento_squeezing()
Memento_startLeaking()
Memento_stats()
Memento_stopLeaking()
Memento_takeByteRef(blk)
Memento_takeIntRef(blk)
Memento_takeRef(blk)
Memento_takeShortRef(blk)
Memento_tick()
PdfObj_new_dict(doc, initialcap)
PdfObj_new_text_string(s)
Pixmap_new_pixmap_from_page_contents(page, ctm, cs, alpha)
Render the page contents without annotations.
 
Ownership of the pixmap is returned to the caller.
Pixmap_new_pixmap_from_page_contents_with_separations(page, ctm, cs, seps, alpha)
Point_transform_point_xy(x, y, m)
aa_level()
Get the number of bits of antialiasing we are
using (for graphics). Between 0 and 8.
abs(f)
Some standard math functions, done as static inlines for speed.
People with compilers that do not adequately implement inline
may like to reimplement these using macros.
absi(i)
add_layout_char(block, x, w, p)
Add a new char to the line at the end of the layout block.
add_layout_line(block, x, y, h, p)
Add a new line to the end of the layout block.
add_separation(sep, name, cs, cs_channel)
Add a separation (null terminated name, colorspace)
add_separation_equivalents(sep, rgba, cmyk, name)
Add a separation with equivalents (null terminated name,
colorspace)
 
(old, deprecated)
adjust_rect_for_stroke(rect, stroke, ctm)
Given a rectangle (assumed to be the bounding box for a path),
expand it to allow for the expansion of the bbox that would be
seen by stroking the path with the given stroke state and
transform.
advance_glyph(font, glyph, wmode)
Return the advance for a given glyph.
 
font: The font to look for the glyph in.
 
glyph: The glyph to find the advance for.
 
wmode: 1 for vertical mode, 0 for horizontal.
 
Returns the advance for the glyph.
aes_crypt_cbc(ctx, mode, length, iv, input, output)
AES block processing. Encrypts or Decrypts (according to mode,
which must match what was initially set up) length bytes (which
must be a multiple of 16), using (and modifying) the insertion
vector iv, reading from input, and writing to output.
 
Never throws an exception.
aes_setkey_dec(ctx, key, keysize)
AES decryption intialisation. Fills in the supplied context
and prepares for decryption using the given key.
 
Returns non-zero for error (key size other than 128/192/256).
 
Never throws an exception.
aes_setkey_enc(ctx, key, keysize)
AES encryption intialisation. Fills in the supplied context
and prepares for encryption using the given key.
 
Returns non-zero for error (key size other than 128/192/256).
 
Never throws an exception.
alpha_from_gray(gray)
append_bits(buf, value, count)
append_bits_pad(buf)
append_buffer(destination, source)
Append the contents of the source buffer onto the end of the
destination buffer, extending automatically as required.
 
Ownership of buffers does not change.
append_byte(buf, c)
append_data(buf, data, len)
fz_append_*: Append data to a buffer.
 
The buffer will automatically grow as required.
append_int16_be(buf, x)
append_int16_le(buf, x)
append_int32_be(buf, x)
append_int32_le(buf, x)
append_pdf_string(buffer, text)
fz_append_pdf_string: Append a string with PDF syntax quotes and
escapes.
 
The buffer will automatically grow as required.
append_rune(buf, c)
append_string(buf, data)
arc4_encrypt(state, dest, src, len)
RC4 block encrypt operation; encrypt src into dst (both of
length len) updating the RC4 state as we go.
 
Never throws an exception.
arc4_init(state, key, len)
RC4 initialization. Begins an RC4 operation, writing a new
context.
 
Never throws an exception.
archive_format(arch)
Return a pointer to a string describing the format of the
archive.
 
The lifetime of the string is unspecified (in current
implementations the string will persist until the archive
is closed, but this is not guaranteed).
atof(s)
Range checking atof
atoi(s)
atoi that copes with NULL
atoi64(s)
64bit atoi that copes with NULL
authenticate_password(doc, password)
Test if the given password can decrypt the document.
 
password: The password string to be checked. Some document
specifications do not specify any particular text encoding, so
neither do we.
 
Returns 0 for failure to authenticate, non-zero for success.
 
For PDF documents, further information can be given by examining
the bits in the return code.
 
    Bit 0 => No password required
    Bit 1 => User password authenticated
    Bit 2 => Owner password authenticated
available(stm, max)
Ask how many bytes are available immediately from
a given stream.
 
stm: The stream to read from.
 
max: A hint for the underlying stream; the maximum number of
bytes that we are sure we will want to read. If you do not know
this number, give 1.
 
Returns the number of bytes immediately available between the
read and write pointers. This number is guaranteed only to be 0
if we have hit EOF. The number of bytes returned here need have
no relation to max (could be larger, could be smaller).
begin_group(dev, area, cs, isolated, knockout, blendmode, alpha)
begin_layer(dev, layer_name)
begin_mask(dev, area, luminosity, colorspace, color_params)
begin_page(wri, mediabox)
Called to start the process of writing a page to
a document.
 
mediabox: page size rectangle in points.
 
Returns a borrowed fz_device to write page contents to. This
should be kept if required, and only dropped if it was kept.
begin_tile(dev, area, view, xstep, ystep, ctm)
begin_tile_id(dev, area, view, xstep, ystep, ctm, id)
bidi_fragment_text(OUTPUT, textlen, baseDir, callback, arg, flags)
    Partitions the given Unicode sequence into one or more
    unidirectional fragments and invokes the given callback
    function for each fragment.
 
    For example, if directionality of text is:
                    0123456789
                    rrlllrrrrr,
    we'll invoke callback with:
                    &text[0], length == 2
                    &text[2], length == 3
                    &text[5], length == 5
 
    :param text:    start of Unicode sequence
            :type textlen: int, in
:param textlen:   number of Unicodes to analyse
            :type baseDir: int, in
:param baseDir:   direction of paragraph (specify FZ_BIDI_NEUTRAL to force auto-detection)
            :type callback: fz_bidi_fragment_fn, in
:param callback:  function to be called for each fragment
            :type arg: void, in
:param arg: data to be passed to the callback function
            :type flags: int, in
:param flags:     flags to control operation (see fz_bidi_flags above)
bitmap_details(bitmap)
Retrieve details of a given bitmap.
 
bitmap: The bitmap to query.
 
w: Pointer to storage to retrieve width (or NULL).
 
h: Pointer to storage to retrieve height (or NULL).
 
n: Pointer to storage to retrieve number of color components (or
NULL).
 
stride: Pointer to storage to retrieve bitmap stride (or NULL).
blendmode_name(blendmode)
Map from enumeration to blend mode string.
 
The string is static, with arbitrary lifespan.
bound_display_list(list)
Return the bounding box of the page recorded in a display list.
bound_glyph(font, gid, trm)
Return a bbox for a given glyph in a font.
 
font: The font to look for the glyph in.
 
gid: The glyph to bound.
 
trm: The matrix to apply to the glyph before bounding.
 
r: Pointer to a fz_rect to use for storage.
 
Returns r, after filling it in with the bounds of the given
glyph.
bound_page(page)
Determine the size of a page at 72 dpi.
bound_path(path, stroke, ctm)
Return a bounding rectangle for a path.
 
path: The path to bound.
 
stroke: If NULL, the bounding rectangle given is for
the filled path. If non-NULL the bounding rectangle
given is for the path stroked with the given attributes.
 
ctm: The matrix to apply to the path during stroking.
 
r: Pointer to a fz_rect which will be used to hold
the result.
 
Returns r, updated to contain the bounding rectangle.
bound_shade(shade, ctm)
Bound a given shading.
 
shade: The shade to bound.
 
ctm: The transform to apply to the shade before bounding.
 
r: Pointer to storage to put the bounds in.
 
Returns r, updated to contain the bounds for the shading.
bound_text(text, stroke, ctm)
Find the bounds of a given text object.
 
text: The text object to find the bounds of.
 
stroke: Pointer to the stroke attributes (for stroked
text), or NULL (for filled text).
 
ctm: The matrix in use.
 
r: pointer to storage for the bounds.
 
Returns a pointer to r, which is updated to contain the
bounding box for the text object.
buffer_extract(buf, OUTPUT)
Take ownership of buffer contents.
 
Performs the same task as fz_buffer_storage, but ownership of
the data buffer returns with this call. The buffer is left
empty.
 
Note: Bad things may happen if this is called on a buffer with
multiple references that is being used from multiple threads.
 
data: Pointer to place to retrieve data pointer.
 
Returns length of stream.
buffer_storage(buf, OUTPUT)
Retrieve internal memory of buffer.
 
datap: Output parameter that will be pointed to the data.
 
Returns the current size of the data in bytes.
bytes_getitem(ary, index)
bytes_setitem(ary, index, value)
calloc(count, size)
Allocate array of memory of count entries of size bytes.
Clears the memory to zero.
 
Throws exception in the event of failure to allocate.
calloc_no_throw(count, size)
fz_calloc equivalent that returns NULL rather than throwing
exceptions.
caught()
caught_message()
chartorune(str)
UTF8 decode a single rune from a sequence of chars.
 
rune: Pointer to an int to assign the decoded 'rune' to.
 
str: Pointer to a UTF8 encoded string.
 
Returns the number of bytes consumed.
clamp(f, min, max)
clamp_color(cs)
Clamp the samples in a color to the correct ranges for a
given colorspace.
clamp_location(doc, loc)
Clamps a location into valid chapter/page range. (First clamps
the chapter into range, then the page into range).
clampd(d, min, max)
clampi(i, min, max)
clampp(p, min, max)
cleanname(name)
rewrite path to the shortest string that names the same path.
 
Eliminates multiple and trailing slashes, interprets "." and
"..". Overwrites the string in place.
clear_bitmap(bit)
Set the entire bitmap to 0.
 
Never throws exceptions.
clear_buffer(buf)
Empties the buffer. Storage is not freed, but is held ready
to be reused as the buffer is refilled.
 
Never throws exceptions.
clear_pixmap(pix)
Sets all components (including alpha) of
all pixels in a pixmap to 0.
 
pix: The pixmap to clear.
clear_pixmap_rect_with_value(pix, value, r)
Clears a subrect of a pixmap with the given value.
 
pix: The pixmap to clear.
 
value: Values in the range 0 to 255 are valid. Each component
sample for each pixel in the pixmap will be set to this value,
while alpha will always be set to 255 (non-transparent).
 
r: the rectangle.
clear_pixmap_with_value(pix, value)
Clears a pixmap with the given value.
 
pix: The pixmap to clear.
 
value: Values in the range 0 to 255 are valid. Each component
sample for each pixel in the pixmap will be set to this value,
while alpha will always be set to 255 (non-transparent).
 
This function is horrible, and should be removed from the
API and replaced with a less magic one.
clip_image_mask(dev, image, ctm, scissor)
clip_path(dev, path, even_odd, ctm, scissor)
clip_stroke_path(dev, path, stroke, ctm, scissor)
clip_stroke_text(dev, text, stroke, ctm, scissor)
clip_text(dev, text, ctm, scissor)
clone_context()
Make a clone of an existing context.
 
This function is meant to be used in multi-threaded
applications where each thread requires its own context, yet
parts of the global state, for example caching, are shared.
 
ctx: Context obtained from fz_new_context to make a copy of.
ctx must have had locks and lock/functions setup when created.
The two contexts will share the memory allocator, resource
store, locks and lock/unlock functions. They will each have
their own exception stacks though.
 
May return NULL.
clone_default_colorspaces(base)
Returns a reference to a newly cloned default colorspaces
structure.
 
The new clone may safely be altered without fear of race
conditions as the caller is the only reference holder.
clone_path(path)
Clone the data for a path.
 
This is used in preference to fz_keep_path when a whole
new copy of a path is required, rather than just a shared
pointer. This probably indicates that the path is about to
be modified.
 
path: path to clone.
 
Throws exceptions on failure to allocate.
clone_pixmap(old)
Clone a pixmap, copying the pixels and associated data to new
storage.
 
The reference count of 'old' is unchanged.
clone_separations_for_overprint(seps)
Return a separations object with all the spots in the input
separations object that are set to composite, reset to be
enabled. If there ARE no spots in the object, this returns
NULL. If the object already has all its spots enabled, then
just returns another handle on the same object.
clone_stroke_state(stroke)
Create an identical stroke_state structure and return a
reference to it.
 
stroke: The stroke state reference to clone.
 
Exceptions may be thrown in the event of a failure to
allocate.
close_device(dev)
Signal the end of input, and flush any buffered output.
This is NOT called implicitly on fz_drop_device. This
may throw exceptions.
close_document_writer(wri)
Called to end the process of writing
pages to a document.
 
This writes any file level trailers required. After this
completes successfully the file is up to date and complete.
close_output(arg_1)
Flush pending output and close an output stream.
close_zip_writer(zip)
Close the zip file for writing.
 
This flushes any pending data to the file. This can throw
exceptions.
closepath(path)
Close the current subpath.
 
path: The path to modify.
 
Throws exceptions on failure to allocate, attempting to modify
a packed path, and illegal path closes (i.e. closing a non open
path).
colorspace_colorant(cs, n)
Retrieve a the name for a colorant.
 
Returns a pointer with the same lifespan as the colorspace.
colorspace_device_n_has_cmyk(cs)
True if DeviceN color space has cyan magenta yellow or black as
one of its colorants.
colorspace_device_n_has_only_cmyk(cs)
True if DeviceN color space has only colorants from the CMYK set.
colorspace_is_cmyk(cs)
colorspace_is_device(cs)
colorspace_is_device_cmyk(cs)
colorspace_is_device_gray(cs)
colorspace_is_device_n(cs)
colorspace_is_gray(cs)
Tests for particular types of colorspaces
colorspace_is_indexed(cs)
colorspace_is_lab(cs)
colorspace_is_lab_icc(cs)
colorspace_is_rgb(cs)
colorspace_is_subtractive(cs)
True for CMYK, Separation and DeviceN colorspaces.
colorspace_n(cs)
Query the number of colorants in a colorspace.
colorspace_name(cs)
Query the name of a colorspace.
 
The returned string has the same lifespan as the colorspace
does. Caller should not free it.
colorspace_name_colorant(cs, n, name)
Assign a name for a given colorant in a colorspace.
 
Used while initially setting up a colorspace. The string is
copied into local storage, so need not be retained by the
caller.
colorspace_type(cs)
Query the type of colorspace.
compress_ccitt_fax_g3(data, columns, rows)
Compress bitmap data as CCITT Group 3 1D fax image.
Creates a stream assuming the default PDF parameters,
except the number of columns.
compress_ccitt_fax_g4(data, columns, rows)
Compress bitmap data as CCITT Group 4 2D fax image.
Creates a stream assuming the default PDF parameters, except
K=-1 and the number of columns.
compressed_buffer_size(buffer)
Return the storage size used for a buffer and its data.
Used in implementing store handling.
 
Never throws exceptions.
compressed_image_buffer(image)
Retrieve the underlying compressed data for an image.
 
Returns a pointer to the underlying data buffer for an image,
or NULL if this image is not based upon a compressed data
buffer.
 
This is not a reference counted structure, so no reference is
returned. Lifespan is limited to that of the image itself.
concat(left, right)
Multiply two matrices.
 
The order of the two matrices are important since matrix
multiplication is not commutative.
 
Returns result.
concat_push_drop(concat, chain)
Add a chained stream to the end of the concatenate filter.
 
Ownership of chain is passed in.
contains_rect(a, b)
Test rectangle inclusion.
 
Return true if a entirely contains b.
convert_color(ss, ds, _is, params)
Convert color values sv from colorspace ss into colorvalues dv
for colorspace ds, via an optional intervening space is,
respecting the given color_params.
convert_indexed_pixmap_to_base(src)
Convert pixmap from indexed to base colorspace.
 
This creates a new bitmap containing the converted pixmap data.
convert_pixmap(pix, cs_des, prf, default_cs, color_params, keep_alpha)
Convert an existing pixmap to a desired
colorspace. Other properties of the pixmap, such as resolution
and position are copied to the converted pixmap.
 
pix: The pixmap to convert.
 
default_cs: If NULL pix->colorspace is used. It is possible that
the data may need to be interpreted as one of the color spaces
in default_cs.
 
cs_des: Desired colorspace, may be NULL to denote alpha-only.
 
prf: Proofing color space through which we need to convert.
 
color_params: Parameters that may be used in conversion (e.g.
ri).
 
keep_alpha: If 0 any alpha component is removed, otherwise
alpha is kept if present in the pixmap.
convert_separation_colors(src_cs, dst_seps, dst_cs, color_params)
Convert a color given in terms of one colorspace,
to a color in terms of another colorspace/separations.
convert_separation_pixmap_to_base(src)
Convert pixmap from DeviceN/Separation to base colorspace.
 
This creates a new bitmap containing the converted pixmap data.
copy_option(val, dest, maxlen)
Copy an option (val) into a destination buffer (dest), of maxlen
bytes.
 
Returns the number of bytes (including terminator) that did not
fit. If val is maxlen or greater bytes in size, it will be left
unterminated.
copy_pfont(value)
copy_pint(value)
copy_rectangle(page, area, crlf)
Return a newly allocated UTF-8 string with the text for a given
selection rectangle.
 
crlf: If true, write "\r\n" style line endings (otherwise "\n"
only).
copy_selection(page, a, b, crlf)
Return a newly allocated UTF-8 string with the text for a given
selection.
 
crlf: If true, write "\r\n" style line endings (otherwise "\n"
only).
count_active_separations(seps)
Return the number of active separations.
count_archive_entries(arch)
Number of entries in archive.
 
Will always return a value >= 0.
 
May throw an exception if this type of archive cannot count the
entries (such as a directory).
count_chapter_pages(doc, chapter)
Return the number of pages in a chapter.
May return 0.
count_chapters(doc)
Return the number of chapters in the document.
At least 1.
count_pages(doc)
Return the number of pages in document
 
May return 0 for documents with no pages.
count_separations(sep)
currentpoint(path)
Return the current point that a path has
reached or (0,0) if empty.
 
path: path to return the current point of.
curveto(path, x0, y0, x1, y1, x2, y2)
Append a 'curveto' command to an open path. (For a
cubic bezier).
 
path: The path to modify.
 
x0, y0: The coordinates of the first control point for the
curve.
 
x1, y1: The coordinates of the second control point for the
curve.
 
x2, y2: The end coordinates for the curve.
 
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
curvetov(path, x1, y1, x2, y2)
Append a 'curvetov' command to an open path. (For a
cubic bezier with the first control coordinate equal to
the start point).