{
    "content": [
        {
            "type": "text",
            "text": "# PDF::API2::Basic::PDF::Objind (perldoc)\n\n## NAME\n\nPDF::API2::Basic::PDF::Objind - Low-level PDF indirect object\n\n## Sections\n\n- **NAME**\n- **INSTANCE VARIABLES**\n- **METHODS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "PDF::API2::Basic::PDF::Objind",
        "section": "",
        "mode": "perldoc",
        "summary": "PDF::API2::Basic::PDF::Objind - Low-level PDF indirect object",
        "synopsis": null,
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "INSTANCE VARIABLES",
                "lines": 22,
                "subsections": []
            },
            {
                "name": "METHODS",
                "lines": 60,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "PDF::API2::Basic::PDF::Objind - Low-level PDF indirect object\n",
                "subsections": []
            },
            "INSTANCE VARIABLES": {
                "content": "Instance variables differ from content variables in that they all start with a space.\n\nparent\nFor an object which is a reference to an object in some source, this holds the reference to\nthe source object, so that should the reference have to be de-referenced, then we know where\nto go and get the info.\n\nobjnum (R)\nThe object number in the source (only for object references)\n\nobjgen (R)\nThe object generation in the source\n\nThere are other instance variables which are used by the parent for file control.\n\nisfree\nThis marks whether the object is in the free list and available for re-use as another object\nelsewhere in the file.\n\nnextfree\nHolds a direct reference to the next free object in the free list.\n",
                "subsections": []
            },
            "METHODS": {
                "content": "PDF::API2::Basic::PDF::Objind->new()\nCreates a new indirect object\n\nuid\nReturns a Unique id for this object, creating one if it didn't have one before\n\n$r->release\nReleases ALL of the memory used by this indirect object, and all of its component/child objects.\nThis method is called automatically by '\"PDF::API2::Basic::PDF::File->release\"' (so you don't\nhave to call it yourself).\n\nNote: it is important that this method get called at some point prior to the actual destruction\nof the object. Internally, PDF files have an enormous amount of cross-references and this causes\ncircular references within our own internal data structures. Calling '\"release()\"' forces these\ncircular references to be cleaned up and the entire internal data structure purged.\n\n$r->val\nReturns the value of this object or reads the object and then returns its value.\n\nNote that all direct subclasses *must* make their own versions of this subroutine otherwise we\ncould be in for a very deep loop!\n\n$r->realise\nMakes sure that the object is fully read in, etc.\n\n$r->outobjdeep($fh, $pdf)\nIf you really want to output this object, then you must need to read it first. This also means\nthat all direct subclasses must subclass this method or loop forever!\n\n$r->outobj($fh)\nIf this is a full object then outputs a reference to the object, otherwise calls outobjdeep to\noutput the contents of the object at this point.\n\n$r->elements\nAbstract superclass function filler. Returns self here but should return something more useful\nif an array.\n\n$r->empty\nEmpties all content from this object to free up memory or to be read to pass the object into the\nfree list. Simplistically undefs all instance variables other than object number and generation.\n\n$r->merge($objind)\nThis merges content information into an object reference place-holder. This occurs when an\nobject reference is read before the object definition and the information in the read data needs\nto be merged into the object place-holder\n\n$r->isobj($pdf)\nReturns whether this object is a full object with its own object number or whether it is purely\na sub-object. $pdf indicates which output file we are concerned that the object is an object in.\n\n$r->copy($pdf, $res)\nReturns a new copy of this object. The object is assumed to be some kind of associative array\nand the copy is a deep copy for elements which are not PDF objects, according to $pdf, and\nshallow copy for those that are. Notice that calling \"copy\" on an object forces at least a one\nlevel copy even if it is a PDF object. The returned object loses its PDF object status though.\n\nIf $res is defined then the copy goes into that object rather than creating a new one. It is up\nto the caller to bless $res, etc. Notice that elements from $self are not copied into $res if\nthere is already an entry for them existing in $res.\n",
                "subsections": []
            }
        }
    }
}