PDFArray Class

class PDFArray : PDFObject

Namespace:datalogics_interface

Inherits from:: PDFObject

Detailed Description

Represents an array of data elements within a PDF document.

All objects in a PDF document are built from a collection of simpler objects that represent fundamental datatypes like numbers, strings and arrays. PDFObject and its subclasses allow direct access and manipulation of these simple objects. Some subclasses represent single data elements. For example, PDFInteger represents a single integer value. Others represent a collection of PDFObjects, like PDFArray, an indexed array of data elements.

A PDFArray is a heterogenous collection object that gathers other PDFObjects (including other PDFArrays) into an indexed list.

Referenced by

OptionalContentMembershipDict ViewDestination

Uses types

PDFObject PDFObjectType

Constructor & Destructor Documentation

PDFArray(Document & doc, bool indirect)

Parameters

doc: Document &: Document object containing this PDFArray
indirect: bool: flag marking this as an indirect PDFObject

General constructor

Member Function Documentation

void add(PDFObject & value)

Parameters

value: PDFObject &: the object to append.

Returns:

void

Adds an object to the end of the array

std::unique_ptr< PDFObject > get(int index)

Parameters

index: int: the position of the object to retrieve.

Returns:

std::unique_ptr< PDFObject >

Returns the object at the given index.

int get_generation()

Returns:

int

The generation number of this indirect object.

The generation number for this object.

Only indirect objects have a generation number.

int get_id()

Returns:

int

The ID number of this indirect object.

The ID number for this object.

Only indirect objects have an ID number.

bool get_indirect()

Returns:

bool

true if this object is indirect, false if it is direct.

Indicates if this object is indirect or direct.

int get_length()

Returns:

int

The number of elements in this array.

PDFObjectType get_type()

Returns:

PDFObjectType

The underlying Cos type of this object. Prefer this over dynamic_cast/try_as chains in hot paths.

void insert(int index, PDFObject & value)

Parameters

index: int: the position at which to insert.
value: PDFObject &: the object to insert.

Returns:

void

Inserts an object at the given index, displacing existing objects. All objects following this will have their index increased by one.

bool operator!=(const PDFObject & other)

Parameters

other: const PDFObject &

Returns:

bool

true if other is not equal to this.

Inequality.

bool operator==(const PDFObject & other)

Parameters

other: const PDFObject &: The other PDFObject to compare against.

Returns:

bool

true if the two objects are equal, false otherwise.

Compare if two objects are equal.

void put(int index, PDFObject & value)

Parameters

index: int: the position at which to place the object.
value: PDFObject &: the object to place at the given index.

Returns:

void

Puts an object at the given index, replacing the existing item. The index can be greater than the current length of the array; the array will be extended and the empty slots filled with null objects.

void remove_at(int index)

Parameters

index: int: the position of the object to remove.

Returns:

void

Removes the object at the given index. The length of the array is reduced by 1.

std::string to_string()

Returns:

std::string

A string describing this PDFObject.

Returns a string representation of this PDFObject.

The string includes the object's indirect status, and if indirect, its ID and generation number.

T * try_as(typename T )

Parameters

: typename T

Returns:

T *

Attempt to downcast this object to a derived Cos type such as PDFString, PDFDict, PDFArray, PDFStream, PDFName, PDFInteger, PDFReal, or PDFBoolean. Returns nullptr if the object's actual type doesn't match T.

const T * try_as(typename T )

Parameters

: typename T

Returns:

const T *

Const overload of try_as(). Returns a const pointer, or nullptr.