Deprecated Names

This is a list of names for methods and attributes with references to their current notions. This list is a result of the effort to replace “mixedCase” names by their “snake_case” alternative.

This is a major effort, that we only can muster in a step-wise fashion. We believe we so far (v1.18.7) are done with Annot, Document, Page and TextWriter.

Names of classes and package-wide constants remain untouched. Old names remain available for some time, but will be removed in some future version. Apart from this section however, old names will no longer be mentioned in this documentation.

Document

Old Name

New Name

chapterCount

Document.chapter_count

chapterPageCount

Document.chapter_page_count()

convertToPDF

Document.convert_to_pdf()

copyPage

Document.copy_page()

deletePage

Document.delete_page()

deletePageRange

Document.delete_pages()

embeddedFileAdd

Document.embfile_add()

embeddedFileCount

Document.embfile_count()

embeddedFileDel

Document.embfile_del()

embeddedFileGet

Document.embfile_get()

embeddedFileInfo

Document.embfile_info()

embeddedFileNames

Document.embfile_names()

embeddedFileUpd

Document.embfile_upd()

findBookmark

Document.find_bookmark()

fullcopyPage

Document.fullcopy_page()

getPagePixmap

Document.get_page_pixmap()

getPageText

Document.get_page_text()

getSigFlags

Document.get_sigflags()

getToC

Document.get_toc()

getXmlMetadata

Document.get_xml_metadata()

insertPage

Document.insert_page()

insertPDF

Document.insert_pdf()

isFormPDF

Document.is_form_pdf

isPDF

Document.is_pdf

isStream

Document.is_stream

lastLocation

Document.last_location

loadPage

Document.load_page()

makeBookmark

Document.make_bookmark()

metadataXML

Document.xref_xml_metadata()

newPage

Document.new_page()

nextLocation

Document.next_location()

pageCount

Document.page_count

pageCropBox

Document.page_cropbox()

pageXref

Document.page_xref()

PDFCatalog

Document.pdf_catalog()

PDFTrailer

Document.pdf_trailer()

previousLocation

Document.prev_location()

searchPageFor

Document.search_page_for()

setMetadata

Document.set_metadata()

setToC

Document.set_toc()

updateObject

Document.update_object()

updateStream

Document.update_stream()

xrefLength

Document.xref_length()

xrefObject

Document.xref_object()

xrefStream

Document.xref_stream()

xrefStreamRaw

Document.xref_stream_raw()

Page and Shape

Old Name

New Name

_isWrapped

Page.is_wrapped

cleanContents

Page.clean_contents()

CropBox

Page.cropbox

CropBoxPosition

Page.cropbox_position

deleteAnnot

Page.delete_annot()

deleteLink

Page.delete_link()

derotationMatrix

Page.derotation_matrix

drawBezier

Page.draw_bezier(), Shape.draw_bezier()

drawCircle

Page.draw_circle(), Shape.draw_circle()

drawCurve

Page.draw_curve(), Shape.draw_curve()

drawLine

Page.draw_line(), Shape.draw_line()

drawOval

Page.draw_oval(), Shape.draw_oval()

drawPolyline

Page.draw_polyline(), Shape.draw_polyline()

drawQuad

Page.draw_quad(), Shape.draw_quad()

drawRect

Page.draw_rect(), Shape.draw_rect()

drawSector

Page.draw_sector(), Shape.draw_sector()

drawSquiggle

Page.draw_squiggle(), Shape.draw_squiggle()

drawZigzag

Page.draw_zigzag(), Shape.draw_zigzag()

firstAnnot

Page.first_annot

firstLink

Page.first_link

firstWidget

Page.first_widget

getContents

Page.get_contents()

getDisplayList

Page.get_displaylist()

getDrawings

Page.get_drawings()

getFontList

Page.get_fonts()

getImageBbox

Page.get_image_bbox()

getImageList

Page.get_images()

getPixmap

Page.get_pixmap()

getSVGimage

Page.get_svg_image()

getText

Page.get_text()

getTextBlocks

Page.get_text_blocks()

getTextbox

Page.get_textbox()

getTextPage

Page.get_textpage()

getTextSelection

Page.get_text_selection()

getTextWords

Page.get_text_words()

insertFont

Page.insert_font()

insertImage

Page.insert_image()

insertLink

Page.insert_link()

insertText

Page.insert_text()

insertTextbox

Page.insert_textbox()

loadAnnot

Page.load_annot()

loadLinks

Page.load_links()

MediaBox

Page.mediabox

MediaBoxSize

Page.mediabox_size

newShape

Page.new_shape()

rotationMatrix

Page.rotation_matrix

searchFor

Page.search_for()

setCropBox

Page.set_cropbox()

setMediaBox

Page.set_mediabox()

setRotation

Page.set_rotation()

showPDFpage

Page.show_pdf_page()

transformationMatrix

Page.transformation_matrix

updateLink

Page.update_link()

wrapContents

Page.wrap_contents()

writeText

Page.write_text()

Annot

Old Name

New Name

getText

Annot.get_text()

getTextbox

Annot.get_textbox()

fileGet

Annot.get_file()

fileUpd

Annot.update_file()

getPixmap

Annot.get_pixmap()

getTextPage

Annot.get_textpage()

lineEnds

Annot.line_ends()

setBlendMode

Annot.set_blendmode()

setBorder

Annot.set_border()

setColors

Annot.set_colors()

setFlags

Annot.set_flags()

setInfo

Annot.set_info()

setLineEnds

Annot.set_line_ends()

setName

Annot.set_name()

setOpacity

Annot.set_opacity()

setRect

Annot.set_rect()

set_rotation

Annot.set_rotation()

soundGet

Annot.get_sound()