Help-Site Computer Manuals
Software
Hardware
Programming
Networking
  Algorithms & Data Structures   Programming Languages   Revision Control
  Protocols
  Cameras   Computers   Displays   Keyboards & Mice   Motherboards   Networking   Printers & Scanners   Storage
  Windows   Linux & Unix   Mac

PDF::API2::Basic::PDF::Objind
PDF indirect object reference. Also acts as an abstract superclass for all elements in a PDF file.

PDF::API2::Basic::PDF::Objind - PDF indirect object reference. Also acts as an abstract superclass for all elements in a PDF file.


NAME

PDF::API2::Basic::PDF::Objind - PDF indirect object reference. Also acts as an abstract superclass for all elements in a PDF file.


INSTANCE VARIABLES

Instance variables differ from content variables in that they all start with a space.

parent
For an object which is a reference to an object in some source, this holds the reference to the source object, so that should the reference have to be de-referenced, then we know where to go and get the info.

objnum (R)
The object number in the source (only for object references)

objgen (R)
The object generation in the source

There are other instance variables which are used by the parent for file control.

isfree
This marks whether the object is in the free list and available for re-use as another object elsewhere in the file.

nextfree
Holds a direct reference to the next free object in the free list.


METHODS

uid

Returns a Unique id for this object, creating one if it didn't have one before

$r->release

Releases ALL of the memory used by this indirect object, and all of its component/child objects. This method is called automatically by 'PDF::API2::Basic::PDF::File->release' (so you don't have to call it yourself).

NOTE, that it is important that this method get called at some point prior to the actual destruction of the object. Internally, PDF files have an enormous amount of cross-references and this causes circular references within our own internal data structures. Calling 'release()' forces these circular references to be cleaned up and the entire internal data structure purged.

Developer note: As part of the brute-force cleanup done here, this method will throw a warning message whenever unexpected key values are found within the PDF::API2::Basic::PDF::Objind object. This is done to help ensure that unexpected and unfreed values are brought to your attention, so you can bug us to keep the module updated properly; otherwise the potential for memory leaks due to dangling circular references will exist.

$r->val

Returns the val of this object or reads the object and then returns its value.

Note that all direct subclasses *must* make their own versions of this subroutine otherwise we could be in for a very deep loop!

$r->realise

Makes sure that the object is fully read in, etc.

$r->outobjdeep($fh, $pdf)

If you really want to output this object, then you must need to read it first. This also means that all direct subclasses must subclass this method or loop forever!

Programminig
Wy
Wy
yW
Wy
Programming
Wy
Wy
Wy
Wy