Element index for package Cpdf
Package indexes
[ a ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ i ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ r ]
[ s ]
[ t ]
[ u ]
[ w ]
[ y ]
a
- $addLooseObjects
- in file class.pdf.php, variable Cpdf::$addLooseObjects
array contains infomation about how the loose objects are to be added to the document
- $arc4
- in file class.pdf.php, variable Cpdf::$arc4
the ancryption array for the document encryption is stored here
- $arc4_objnum
- in file class.pdf.php, variable Cpdf::$arc4_objnum
the object Id of the encryption information
- addDestination
- in file class.pdf.php, method Cpdf::addDestination()
create a labelled destination within the document
- addImage
- in file class.pdf.php, method Cpdf::addImage()
add an image into the document, from a GD object
- addInfo
- in file class.pdf.php, method Cpdf::addInfo()
add content to the documents info object
- addInternalLink
- in file class.pdf.php, method Cpdf::addInternalLink()
add a link in the document to an internal destination (ie. within the document)
- addJpegFromFile
- in file class.pdf.php, method Cpdf::addJpegFromFile()
add a JPEG image into the document, from a file
- addLink
- in file class.pdf.php, method Cpdf::addLink()
add a link in the document to an external URL
- addMessage
- in file class.pdf.php, method Cpdf::addMessage()
used to add messages for use in debugging
- addObject
- in file class.pdf.php, method Cpdf::addObject()
after an object has been created, it wil only show if it has been added, using this function.
- addPngFromFile
- in file class.pdf.php, method Cpdf::addPngFromFile()
add a PNG image into the document, from a file
- addText
- in file class.pdf.php, method Cpdf::addText()
add text to the document, at a specified location, size and angle on the page
- addTextWrap
- in file class.pdf.php, method Cpdf::addTextWrap()
add text to the page, but ensure that it fits within a certain width if it does not fit then put in as much as possible, splitting at word boundaries and return the remainder.
- alink
- in file class.ezpdf.php, method Cezpdf::alink()
- ARC4
- in file class.pdf.php, method Cpdf::ARC4()
ARC4 encrypt a text string
- ARC4_init
- in file class.pdf.php, method Cpdf::ARC4_init()
initialize the ARC4 encryption
c
- $callback
- in file class.pdf.php, variable Cpdf::$callback
array which forms a stack to keep track of nested callback functions
- $catalogId
- in file class.pdf.php, variable Cpdf::$catalogId
the objectId (number within the objects array) of the document catalog
- $checkpoint
- in file class.pdf.php, variable Cpdf::$checkpoint
store the stack for the transaction commands, each item in here is a record of the values of all the variables within the class, so that the user can rollback at will (from each 'start' command) note that this includes the objects array, so these can be large.
- $currentBaseFont
- in file class.pdf.php, variable Cpdf::$currentBaseFont
the current base font
- $currentColour
- in file class.pdf.php, variable Cpdf::$currentColour
current colour for fill operations, defaults to inactive value, all three components should be between 0 and 1 inclusive when active
- $currentContents
- in file class.pdf.php, variable Cpdf::$currentContents
object number of the currently active contents block
- $currentFont
- in file class.pdf.php, variable Cpdf::$currentFont
a record of the current font
- $currentFontNum
- in file class.pdf.php, variable Cpdf::$currentFontNum
the number of the current font within the font array
- $currentLineStyle
- in file class.pdf.php, variable Cpdf::$currentLineStyle
current style that lines are drawn in
- $currentNode
- in file class.pdf.php, variable Cpdf::$currentNode
- $currentPage
- in file class.pdf.php, variable Cpdf::$currentPage
object number of the current page
- $currentStrokeColour
- in file class.pdf.php, variable Cpdf::$currentStrokeColour
current colour for stroke operations (lines etc.)
- $currentTextState
- in file class.pdf.php, variable Cpdf::$currentTextState
track if the current font is bolded or italicised
- Cezpdf
- in file class.ezpdf.php, class Cezpdf
This class will take the basic interaction facilities of the Cpdf class and make more useful functions so that the user does not have to know all the ins and outs of pdf presentation to produce something pretty.
- Cezpdf
- in file class.ezpdf.php, method Cezpdf::Cezpdf()
- checkAllHere
- in file class.pdf.php, method Cpdf::checkAllHere()
should be used for internal checks, not implemented as yet
- closeObject
- in file class.pdf.php, method Cpdf::closeObject()
close an object
- Cpdf
- in file class.pdf.php, method Cpdf::Cpdf()
class constructor
- Cpdf
- in file class.pdf.php, class Cpdf
Cpdf
- curve
- in file class.pdf.php, method Cpdf::curve()
draw a bezier curve based on 4 control points
- class.ezpdf.php
- procedural page class.ezpdf.php
- class.pdf.php
- procedural page class.pdf.php
d
- $destinations
- in file class.pdf.php, variable Cpdf::$destinations
store label->id pairs for named destinations, these will be used to replace internal links
e
- $encrypted
- in file class.pdf.php, variable Cpdf::$encrypted
a flag to say if a document is to be encrypted or not
- $encryptionKey
- in file class.pdf.php, variable Cpdf::$encryptionKey
the ancryption key for the encryption of all the document content (structure is not encrypted)
- $ez
- in file class.ezpdf.php, variable Cezpdf::$ez
- $ezPageCount
- in file class.ezpdf.php, variable Cezpdf::$ezPageCount
- $ezPages
- in file class.ezpdf.php, variable Cezpdf::$ezPages
- ellipse
- in file class.pdf.php, method Cpdf::ellipse()
draw an ellipse note that the part and filled ellipse are just special cases of this function
- encryptInit
- in file class.pdf.php, method Cpdf::encryptInit()
initialize the encryption for processing a particular object
- execTemplate
- in file class.ezpdf.php, method Cezpdf::execTemplate()
- ezColumnsStart
- in file class.ezpdf.php, method Cezpdf::ezColumnsStart()
- ezColumnsStop
- in file class.ezpdf.php, method Cezpdf::ezColumnsStop()
- ezGetCurrentPageNumber
- in file class.ezpdf.php, method Cezpdf::ezGetCurrentPageNumber()
- ezImage
- in file class.ezpdf.php, method Cezpdf::ezImage()
- ezInsertMode
- in file class.ezpdf.php, method Cezpdf::ezInsertMode()
- ezNewPage
- in file class.ezpdf.php, method Cezpdf::ezNewPage()
- ezOutput
- in file class.ezpdf.php, method Cezpdf::ezOutput()
- ezProcessText
- in file class.ezpdf.php, method Cezpdf::ezProcessText()
- ezPRVTaddPageNumbers
- in file class.ezpdf.php, method Cezpdf::ezPRVTaddPageNumbers()
- ezPRVTcleanUp
- in file class.ezpdf.php, method Cezpdf::ezPRVTcleanUp()
- ezPrvtGetTextWidth
- in file class.ezpdf.php, method Cezpdf::ezPrvtGetTextWidth()
- ezPRVTpageNumberSearch
- in file class.ezpdf.php, method Cezpdf::ezPRVTpageNumberSearch()
- ezPrvtTableColumnHeadings
- in file class.ezpdf.php, method Cezpdf::ezPrvtTableColumnHeadings()
- ezPrvtTableDrawLines
- in file class.ezpdf.php, method Cezpdf::ezPrvtTableDrawLines()
- ezSetCmMargins
- in file class.ezpdf.php, method Cezpdf::ezSetCmMargins()
- ezSetDy
- in file class.ezpdf.php, method Cezpdf::ezSetDy()
- ezSetMargins
- in file class.ezpdf.php, method Cezpdf::ezSetMargins()
- ezSetY
- in file class.ezpdf.php, method Cezpdf::ezSetY()
- ezStartPageNumbers
- in file class.ezpdf.php, method Cezpdf::ezStartPageNumbers()
- ezStopPageNumbers
- in file class.ezpdf.php, method Cezpdf::ezStopPageNumbers()
- ezStream
- in file class.ezpdf.php, method Cezpdf::ezStream()
- ezTable
- in file class.ezpdf.php, method Cezpdf::ezTable()
- ezText
- in file class.ezpdf.php, method Cezpdf::ezText()
- ezWhatPageNumber
- in file class.ezpdf.php, method Cezpdf::ezWhatPageNumber()
f
- $fileIdentifier
- in file class.pdf.php, variable Cpdf::$fileIdentifier
the file identifier, used to uniquely identify a pdf document
- $firstPageId
- in file class.pdf.php, variable Cpdf::$firstPageId
the objectId of the first page of the document
- $fontFamilies
- in file class.pdf.php, variable Cpdf::$fontFamilies
store the information about the relationship between font families this used so that the code knows which font is the bold version of another font, etc.
- $fonts
- in file class.pdf.php, variable Cpdf::$fonts
array carrying information about the fonts that the system currently knows about
- filledEllipse
- in file class.pdf.php, method Cpdf::filledEllipse()
draw a filled ellipse
- filledRectangle
- in file class.pdf.php, method Cpdf::filledRectangle()
a filled rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not
g
- getFirstPageId
- in file class.pdf.php, method Cpdf::getFirstPageId()
function for the user to find out what the ID is of the first page that was created during startup - useful if they wish to add something to it later.
- getFontDecender
- in file class.pdf.php, method Cpdf::getFontDecender()
return the font decender, this will normally return a negative number
- getFontHeight
- in file class.pdf.php, method Cpdf::getFontHeight()
return the height in units of the current font in the given size
- getTextWidth
- in file class.pdf.php, method Cpdf::getTextWidth()
calculate how wide a given text string will be on a page, at a given size.
i
- $infoObject
- in file class.pdf.php, variable Cpdf::$infoObject
the objectId of the information object for the document this contains authorship, title etc.
- ilink
- in file class.ezpdf.php, method Cezpdf::ilink()
l
- $looseObjects
- in file class.pdf.php, variable Cpdf::$looseObjects
an array which contains information about the objects which are not firmly attached to pages
- line
- in file class.pdf.php, method Cpdf::line()
draw a line from one set of coordinates to another
- loadTemplate
- in file class.ezpdf.php, method Cezpdf::loadTemplate()
m
- $messages
- in file class.pdf.php, variable Cpdf::$messages
messages are stored here during processing, these can be selected afterwards to give some useful debug information
- md5_16
- in file class.pdf.php, method Cpdf::md5_16()
calculate the 16 byte version of the 128 bit md5 digest of the string
n
- $nCallback
- in file class.pdf.php, variable Cpdf::$nCallback
the number of callback functions in the callback array
- $nStack
- in file class.pdf.php, variable Cpdf::$nStack
number of elements within the object Id storage stack
- $nStateStack
- in file class.pdf.php, variable Cpdf::$nStateStack
number of elements within the state stack
- $numFonts
- in file class.pdf.php, variable Cpdf::$numFonts
number of fonts within the system
- $numImages
- in file class.pdf.php, variable Cpdf::$numImages
number of images being tracked within the document
- $numObj
- in file class.pdf.php, variable Cpdf::$numObj
the current number of pdf objects in the document
- $numPages
- in file class.pdf.php, variable Cpdf::$numPages
number of page objects within the document
- newPage
- in file class.pdf.php, method Cpdf::newPage()
add a new page to the document
o
- $objects
- in file class.pdf.php, variable Cpdf::$objects
this array contains all of the pdf objects, ready for final assembly
- $options
- in file class.pdf.php, variable Cpdf::$options
an array containing options about the document
- openHere
- in file class.pdf.php, method Cpdf::openHere()
specify where the document should open when it first starts
- openObject
- in file class.pdf.php, method Cpdf::openObject()
make a loose object, the output will go into this object, until it is closed, then will revert to the current one.
- output
- in file class.pdf.php, method Cpdf::output()
return the pdf stream as a string returned from the function
- o_action
- in file class.pdf.php, method Cpdf::o_action()
an action object, used to link to URLS initially
- o_annotation
- in file class.pdf.php, method Cpdf::o_annotation()
an annotation object, this will add an annotation to the current page.
- o_catalog
- in file class.pdf.php, method Cpdf::o_catalog()
define the document catalog, the overall controller for the document
- o_contents
- in file class.pdf.php, method Cpdf::o_contents()
the contents objects hold all of the content which appears on pages
- o_destination
- in file class.pdf.php, method Cpdf::o_destination()
destination object, used to specify the location for the user to jump to, presently on opening
- o_encryption
- in file class.pdf.php, method Cpdf::o_encryption()
encryption object.
- o_font
- in file class.pdf.php, method Cpdf::o_font()
an object to hold the font description
- o_fontDescriptor
- in file class.pdf.php, method Cpdf::o_fontDescriptor()
a font descriptor, needed for including additional fonts
- o_fontEncoding
- in file class.pdf.php, method Cpdf::o_fontEncoding()
the font encoding
- o_image
- in file class.pdf.php, method Cpdf::o_image()
an image object, will be an XObject in the document, includes description and data
- o_info
- in file class.pdf.php, method Cpdf::o_info()
define the document information
- o_outlines
- in file class.pdf.php, method Cpdf::o_outlines()
define the outlines in the doc, empty for now
- o_page
- in file class.pdf.php, method Cpdf::o_page()
a page object, it also creates a contents object to hold its contents
- o_pages
- in file class.pdf.php, method Cpdf::o_pages()
object which is a parent to the pages in the document
- o_procset
- in file class.pdf.php, method Cpdf::o_procset()
the document procset, solves some problems with printing to old PS printers
- o_viewerPreferences
- in file class.pdf.php, method Cpdf::o_viewerPreferences()
set the viewer preferences
p
- $procsetObjectId
- in file class.pdf.php, variable Cpdf::$procsetObjectId
the object Id of the procset object
- partEllipse
- in file class.pdf.php, method Cpdf::partEllipse()
draw a part of an ellipse
- polygon
- in file class.pdf.php, method Cpdf::polygon()
draw a polygon, the syntax for this is similar to the GD polygon command
r
- rectangle
- in file class.pdf.php, method Cpdf::rectangle()
draw a rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not
- reopenObject
- in file class.pdf.php, method Cpdf::reopenObject()
open an existing object for editing
- restoreState
- in file class.pdf.php, method Cpdf::restoreState()
restore a previously saved state
s
- $stack
- in file class.pdf.php, variable Cpdf::$stack
object Id storage stack
- $stateStack
- in file class.pdf.php, variable Cpdf::$stateStack
an array which is used to save the state of the document, mainly the colours and styles
- saveState
- in file class.pdf.php, method Cpdf::saveState()
this will be called at a new page to return the state to what it was on the
- selectFont
- in file class.pdf.php, method Cpdf::selectFont()
if the font is not loaded then load it and make the required object
- setColor
- in file class.pdf.php, method Cpdf::setColor()
sets the colour for fill operations
- setEncryption
- in file class.pdf.php, method Cpdf::setEncryption()
set the encryption of the document can be used to turn it on and/or set the passwords which it will have.
- setFontFamily
- in file class.pdf.php, method Cpdf::setFontFamily()
define font families, this is used to initialize the font families for the default fonts and for the user to add new ones for their fonts. The default bahavious can be overridden should that be desired.
- setLineStyle
- in file class.pdf.php, method Cpdf::setLineStyle()
this sets the line drawing style.
- setPreferences
- in file class.pdf.php, method Cpdf::setPreferences()
set the viewer preferences of the document, it is up to the browser to obey these.
- setStrokeColor
- in file class.pdf.php, method Cpdf::setStrokeColor()
sets the colour for stroke operations
- stopObject
- in file class.pdf.php, method Cpdf::stopObject()
stop an object from appearing on pages from this point on
- stream
- in file class.pdf.php, method Cpdf::stream()
output the pdf code, streaming it to the browser
t
- transaction
- in file class.pdf.php, method Cpdf::transaction()
a few functions which should allow the document to be treated transactionally.
w
- $wordSpaceAdjust
- in file class.pdf.php, variable Cpdf::$wordSpaceAdjust
used to track the last used value of the inter-word spacing, this is so that it is known when the spacing is changed.
|
|
