PDFName Class

class PDFName : PDFObject

Namespace:datalogics_interface

Inherits from:: PDFObject

Detailed Description

Represents a name data element 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, PDFName represents a single name value. Others represent a collection of PDFObjects, such as PDFArray, an indexed array of data elements.

A PDFName represents a single indivisible name token, and may be inserted into any collection object. It may also be used as a key in a PDFDictionary.

Uses types

PDFObjectType

Constructor & Destructor Documentation

PDFName(const std::string & value, Document & doc, bool indirect)

Parameters

value: const std::string &: String value representing this PDFName
doc: Document &: Document object containing this PDFName
indirect: bool: flag marking this as an indirect PDFObject

General constructor

Member Function Documentation

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.

PDFObjectType get_type()

Returns:

PDFObjectType

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

std::string get_value()

Returns:

std::string

String value of this object.

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.

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.