A variant data type which supports all data types supported by the PDF standard. More...

#include <PdfVariant.h>

Public Member Functions
	PdfVariant ()
	Construct an empty variant type IsNull() will return true.

	PdfVariant (bool value)
	Construct a PdfVariant that is a bool.

	PdfVariant (int64_t value)
	Construct a PdfVariant that is a number.

	PdfVariant (double value)
	Construct a PdfVariant that is a real number.

	PdfVariant (const PdfString &str)
	Construct a PdfVariant that is a string.

	PdfVariant (const PdfName &name)
	Construct a PdfVariant that is a name.

	PdfVariant (const PdfReference &ref)
	Construct a PdfVariant that is a name.

	PdfVariant (const PdfArray &arr)
	Construct a PdfVariant object with array data.

	PdfVariant (PdfArray &&arr) noexcept

	PdfVariant (const PdfDictionary &dict)
	Construct a PdfVariant that is a dictionary.

	PdfVariant (PdfDictionary &&dict) noexcept

	PdfVariant (const PdfData &data)
	Construct a PdfVariant that contains raw PDF data.

	PdfVariant (PdfData &&data) noexcept

	PdfVariant (const PdfVariant &rhs)
	Constructs a new PdfVariant which has the same contents as rhs.

	PdfVariant (PdfVariant &&rhs) noexcept

std::string_view	GetDataTypeString () const

bool	IsBool () const

bool	IsNumber () const

bool	IsRealStrict () const

bool	IsNumberOrReal () const

bool	IsString () const

bool	IsName () const

bool	IsArray () const

bool	IsDictionary () const

bool	IsRawData () const

bool	IsNull () const

bool	IsReference () const

std::string	ToString (PdfWriteFlags writeFlags=PdfWriteFlags::None) const
	Converts the current object into a string representation which can be written directly to a PDF file on disc.

void	ToString (std::string &str, PdfWriteFlags writeFlags=PdfWriteFlags::None) const

bool	GetBool () const
	Get the value if this object is a bool.

bool	TryGetBool (bool &value) const

int64_t	GetNumberLenient () const
	Get the value of the object as int64_t.

bool	TryGetNumberLenient (int64_t &value) const

int64_t	GetNumber () const
	Get the value of the object as int64_t.

bool	TryGetNumber (int64_t &value) const

double	GetReal () const
	Get the value of the object as a floating point.

bool	TryGetReal (double &value) const

double	GetRealStrict () const
	Get the value of the object as floating point number.

bool	TryGetRealStrict (double &value) const

const PdfString &	GetString () const

bool	TryGetString (PdfString &str) const

bool	TryGetString (const PdfString *&str) const

const PdfName &	GetName () const

bool	TryGetName (PdfName &name) const

bool	TryGetName (const PdfName *&name) const

PdfReference	GetReference () const
	Get the reference values of this object.

bool	TryGetReference (PdfReference &ref) const

const PdfArray &	GetArray () const
	Returns the value of the object as array.

PdfArray &	GetArray ()

bool	TryGetArray (const PdfArray *&arr) const

bool	TryGetArray (PdfArray *&arr)

const PdfDictionary &	GetDictionary () const
	Returns the dictionary value of this object.

PdfDictionary &	GetDictionary ()

bool	TryGetDictionary (const PdfDictionary *&dict) const

bool	TryGetDictionary (PdfDictionary *&dict)

void	SetBool (bool value)
	Set the value of this object as bool.

void	SetNumber (int64_t value)
	Set the value of this object as int64_t.

void	SetReal (double value)
	Set the value of this object as double.

void	SetName (const PdfName &name)
	Set the name value of this object.

void	SetString (const PdfString &str)
	Set the string value of this object.

void	SetReference (const PdfReference &ref)

void	Write (OutputStream &stream, PdfWriteFlags writeMode, const PdfStatefulEncrypt *encrypt, charbuff &buffer) const
	Write the complete variant to an output device.

PdfVariant &	operator= (const PdfVariant &rhs)
	Assign the values of another PdfVariant to this one.

PdfVariant &	operator= (PdfVariant &&rhs) noexcept

bool	operator== (const PdfVariant &rhs) const
	Test to see if the value contained by this variant is the same as the value of the other variant.

bool	operator!= (const PdfVariant &rhs) const

PdfDataType	GetDataType () const

Static Public Attributes
static const PdfVariant	Null

Friends
class	PdfObject

class	PdfArray

class	PdfDictionary

class	PdfTokenizer

class	PdfParser

Detailed Description

A variant data type which supports all data types supported by the PDF standard.

The data can be parsed directly from a string or set by one of the members. One can also convert the variant back to a string after setting the values.

Warning: All methods not marked otherwise may trigger a deferred load. This means that they are unsafe to call while a deferred load is already in progress (as recursion will occur).

Constructor & Destructor Documentation

◆ PdfVariant() [1/10]

PdfVariant::PdfVariant ( bool value )

Construct a PdfVariant that is a bool.

Parameters

value the boolean value of this PdfVariant

◆ PdfVariant() [2/10]

PdfVariant::PdfVariant ( int64_t value )

Construct a PdfVariant that is a number.

Parameters

value the value of the number.

◆ PdfVariant() [3/10]

PdfVariant::PdfVariant ( double value )

Construct a PdfVariant that is a real number.

Parameters

value the value of the real number.

◆ PdfVariant() [4/10]

PdfVariant::PdfVariant ( const PdfString & str )

Construct a PdfVariant that is a string.

The argument string will be escaped where necessary, so it should be passed in unescaped form.

Parameters

str	the value of the string

◆ PdfVariant() [5/10]

PdfVariant::PdfVariant ( const PdfName & name )

Construct a PdfVariant that is a name.

Parameters

name	the value of the name

◆ PdfVariant() [6/10]

PdfVariant::PdfVariant ( const PdfReference & ref )

Construct a PdfVariant that is a name.

Parameters

ref	the value of the name

◆ PdfVariant() [7/10]

PdfVariant::PdfVariant ( const PdfArray & arr )

Construct a PdfVariant object with array data.

The variant will automatically get the datatype PdfDataType::Array. This constructor is the fastest way to create a new PdfVariant that is an array.

Parameters

arr	a list of variants

◆ PdfVariant() [8/10]

PdfVariant::PdfVariant ( const PdfDictionary & dict )

Construct a PdfVariant that is a dictionary.

Parameters

dict	the value of the dictionary.

◆ PdfVariant() [9/10]

PdfVariant::PdfVariant ( const PdfData & data )

Construct a PdfVariant that contains raw PDF data.

Parameters

data	raw and valid PDF data.

◆ PdfVariant() [10/10]

PdfVariant::PdfVariant ( const PdfVariant & rhs )

Constructs a new PdfVariant which has the same contents as rhs.

Parameters

rhs	an existing variant which is copied.

Member Function Documentation

◆ GetArray()

const PdfArray & PdfVariant::GetArray ( ) const

Returns the value of the object as array.

Returns: a array

◆ GetBool()

bool PdfVariant::GetBool ( ) const

Get the value if this object is a bool.

Returns: the bool value.

◆ GetDataTypeString()

string_view PdfVariant::GetDataTypeString ( ) const

Returns: a human readable string representation of GetDataType() The returned string must not be free'd.

◆ GetDictionary()

const PdfDictionary & PdfVariant::GetDictionary ( ) const

Returns the dictionary value of this object.

Returns: a PdfDictionary

◆ GetName()

const PdfName & PdfVariant::GetName ( ) const

Returns: the value of the object as name

◆ GetNumber()

int64_t PdfVariant::GetNumber ( ) const

Get the value of the object as int64_t.

This method throws if the number is a floating point number

Returns: the value of the number

◆ GetNumberLenient()

int64_t PdfVariant::GetNumberLenient ( ) const

Get the value of the object as int64_t.

This method is lenient and narrows floating point numbers

Returns: the value of the number

◆ GetReal()

double PdfVariant::GetReal ( ) const

Get the value of the object as a floating point.

This method is lenient and returns also strictly integral numbers

Returns: the value of the number

◆ GetRealStrict()

double PdfVariant::GetRealStrict ( ) const

Get the value of the object as floating point number.

This method throws if the number is integer

Returns: the value of the number

◆ GetReference()

PdfReference PdfVariant::GetReference ( ) const

Get the reference values of this object.

Returns: a PdfReference

◆ GetString()

const PdfString & PdfVariant::GetString ( ) const

Returns: the value of the object as string.

◆ IsArray()

bool PdfVariant::IsArray ( ) const

Returns: true if this variant is an array

◆ IsBool()

bool PdfVariant::IsBool ( ) const

Returns: true if this variant is a bool

◆ IsDictionary()

bool PdfVariant::IsDictionary ( ) const

Returns: true if this variant is a dictionary

◆ IsName()

bool PdfVariant::IsName ( ) const

Returns: true if this variant is a name

◆ IsNull()

bool PdfVariant::IsNull ( ) const

Returns: true if this variant is null

◆ IsNumber()

bool PdfVariant::IsNumber ( ) const

Returns: true if this variant is an integer

◆ IsNumberOrReal()

bool PdfVariant::IsNumberOrReal ( ) const

Returns: true if this variant is an integer or a floating point number

◆ IsRawData()

bool PdfVariant::IsRawData ( ) const

Returns: true if this variant is raw data

◆ IsRealStrict()

bool PdfVariant::IsRealStrict ( ) const

Returns: true if this variant is a real

This method strictly check for a floating point number and return false on integer

◆ IsReference()

bool PdfVariant::IsReference ( ) const

Returns: true if this variant is a reference

◆ IsString()

bool PdfVariant::IsString ( ) const

Returns: true if this variant is a string

◆ operator!=()

bool PdfVariant::operator!= ( const PdfVariant & rhs ) const

See also: operator==

◆ operator=()

PdfVariant & PdfVariant::operator= ( const PdfVariant & rhs )

Assign the values of another PdfVariant to this one.

Parameters

rhs	an existing variant which is copied.

This will set the dirty flag of this object.

See also: IsDirty

◆ SetBool()

void PdfVariant::SetBool ( bool value )

Set the value of this object as bool.

Parameters

b	the value as bool.

This will set the dirty flag of this object.

See also: IsDirty

◆ SetName()

void PdfVariant::SetName ( const PdfName & name )

Set the name value of this object.

Parameters

d	the name value

This will set the dirty flag of this object.

See also: IsDirty

◆ SetNumber()

void PdfVariant::SetNumber ( int64_t value )

Set the value of this object as int64_t.

Parameters

l	the value as int64_t.

This will set the dirty flag of this object.

See also: IsDirty

◆ SetReal()

void PdfVariant::SetReal ( double value )

Set the value of this object as double.

Parameters

d	the value as double.

This will set the dirty flag of this object.

See also: IsDirty

◆ SetString()

void PdfVariant::SetString ( const PdfString & str )

Set the string value of this object.

Parameters

str	the string value

This will set the dirty flag of this object.

See also: IsDirty

◆ ToString()

string PdfVariant::ToString ( PdfWriteFlags writeFlags = PdfWriteFlags::None ) const

Converts the current object into a string representation which can be written directly to a PDF file on disc.

Parameters

str	the object string is returned in this object.

◆ Write()

void PdfVariant::Write	(	OutputStream &	stream,
		PdfWriteFlags	writeMode,
		const PdfStatefulEncrypt *	encrypt,
		charbuff &	buffer
	)		const

Write the complete variant to an output device.

Parameters

stream	write the object to this stream
writeMode	additional options for writing this object
encrypt	an encryption object which is used to encrypt this object or nullptr to not encrypt this object

The documentation for this class was generated from the following files:

src/podofo/main/PdfVariant.h
src/podofo/main/PdfVariant.cpp

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PdfVariant() [1/10]

◆ PdfVariant() [2/10]

◆ PdfVariant() [3/10]

◆ PdfVariant() [4/10]

◆ PdfVariant() [5/10]

◆ PdfVariant() [6/10]

◆ PdfVariant() [7/10]

◆ PdfVariant() [8/10]

◆ PdfVariant() [9/10]

◆ PdfVariant() [10/10]

Member Function Documentation

◆ GetArray()

◆ GetBool()

◆ GetDataTypeString()

◆ GetDictionary()

◆ GetName()

◆ GetNumber()

◆ GetNumberLenient()

◆ GetReal()

◆ GetRealStrict()

◆ GetReference()

◆ GetString()

◆ IsArray()

◆ IsBool()

◆ IsDictionary()

◆ IsName()

◆ IsNull()

◆ IsNumber()

◆ IsNumberOrReal()

◆ IsRawData()

◆ IsRealStrict()

◆ IsReference()

◆ IsString()

◆ operator!=()

◆ operator=()

◆ SetBool()

◆ SetName()

◆ SetNumber()

◆ SetReal()

◆ SetString()

◆ ToString()

◆ Write()