#include <pdfix.h>

Inheritance diagram for PdsDictionary:

Public Member Functions
virtual bool	Known (const wchar_t *key) const =0

virtual int	GetNumKeys () const =0
	Gets the number of keys in the dictionary. More...

virtual int	GetKey (int index, wchar_t *buffer, int len) const =0
	Gets the key in the dictionary by index. More...

virtual PdsObject *	Get (const wchar_t *key)=0
	Gets the value of the specified key in the specified dictionary. More...

virtual bool	Put (const wchar_t key, PdsObject value)=0
	Method puts object to specified key in the dictionary. More...

virtual bool	PutBool (const wchar_t *key, bool value)=0
	Method puts Boolean to specified key in the dictionary. More...

virtual bool	PutName (const wchar_t key, const wchar_t value)=0
	Method puts Name to specified key in the dictionary. More...

virtual bool	PutString (const wchar_t key, const wchar_t value)=0
	Method puts string to specified key in the dictionary. More...

virtual bool	PutNumber (const wchar_t *key, float value)=0
	Method puts number to specified key in the dictionary. More...

virtual bool	GetRect (const wchar_t key, PdfRect rect)=0
	Method gets rectangle from specified key in the dictionary. More...

virtual bool	PutRect (const wchar_t key, PdfRect rect)=0
	Method puts rectangle to specified key in the dictionary. More...

virtual bool	GetMatrix (const wchar_t key, PdfMatrix matrix)=0
	Method gets matrix from specified key in the dictionary. More...

virtual bool	PutMatrix (const wchar_t key, PdfMatrix matrix)=0
	Method puts matrix to specified key in the dictionary. More...

virtual PdsDictionary *	PutDict (const wchar_t *key)=0
	Method puts new dictionary to specified key in the dictionary. More...

virtual PdsArray *	PutArray (const wchar_t *key)=0
	Method puts new array to specified key in the dictionary. More...

virtual PdsDictionary *	GetDictionary (const wchar_t *key)=0

virtual PdsArray *	GetArray (const wchar_t *key)=0

virtual PdsStream *	GetStream (const wchar_t *key)=0

virtual int	GetString (const wchar_t key, char buffer, int len) const =0

virtual int	GetText (const wchar_t key, wchar_t buffer, int len) const =0

virtual float	GetNumber (const wchar_t *key) const =0

virtual int	GetInteger (const wchar_t *key, int default_value) const =0

virtual bool	GetBoolean (const wchar_t *key, bool default_value) const =0

virtual bool	RemoveKey (const wchar_t *key)=0
	Method Removes a key-value pair from a dictionary. More...

Public Member Functions inherited from PdsObject
virtual PdfObjectType	GetObjectType () const =0
	Gets the type of an object. More...

virtual int	GetId () const =0
	Gets the object number. More...

virtual int	GetGenId () const =0
	Gets the generation number. More...

virtual PdfDoc *	GetDoc () const =0
	Gets a reference to a document. More...

virtual PdsObject *	Clone (bool clone_indirect)=0
	Clone the object. More...

virtual bool	RegisterEvent (PdfEventType type, PdsObjectEventProc proc, void *data)=0
	Registers a user-supplied procedure to call when the specified event occurs. More...

virtual bool	UnregisterEvent (PdfEventType type, PdsObjectEventProc proc, void *data)=0

Detailed Description

PdsDictionary class.

A PdsDictionary is an associative table whose elements are pairs of objects:

The first element of a pair is the key, which is always a name object, a sequence of characters beginning with the forward slash (/) character.
The second element is the PdsObject representing the value.

Member Function Documentation

◆ Get()

virtual PdsObject * PdsDictionary::Get ( const wchar_t * key )

pure virtual

Gets the value of the specified key in the specified dictionary.

Parameters

key	The key whose value is obtained.

Returns: The object associated with the specified key. If key is not present or if its value is null, returns an object of type kPdsNull.

◆ GetArray()

virtual PdsArray * PdsDictionary::GetArray ( const wchar_t * key )

pure virtual

Gets the PdsArray object from dictionary by key or null if the objecs does not exist or it's an object of the different type.

Parameters

key	The key under which the object is to be retrieved.

Returns: The object in the dictionary under specified key or null

◆ GetBoolean()

virtual bool PdsDictionary::GetBoolean	(	const wchar_t *	key,
		bool	default_value
	)		const

pure virtual

Gets the value of PdsBoolean object from array by index. Method returns default value if the objecs does not exist or it's an object of the different type.

Parameters

key	The key under which the object is to be retrieved.
default_value	The default value to be returned if the value cannot be retrieved

Returns: The object in the array under specified index or the default value

◆ GetDictionary()

virtual PdsDictionary * PdsDictionary::GetDictionary ( const wchar_t * key )

pure virtual

Gets the PdsDictionary object from dictionary by key or null if the objecs does not exist or it's an object of the different type.

Parameters

key	The key under which the object is to be retrieved.

Returns: The object in the dictionary under specified key or null

◆ GetInteger()

virtual int PdsDictionary::GetInteger	(	const wchar_t *	key,
		int	default_value
	)		const

pure virtual

Gets the integer value of the PdsNumber object from array by index. Method returns default value if the objecs does not exist or it's an object of the different type.

Parameters

key	The key under which the object is to be retrieved.
default_value	The default value to be returned if the value cannot be retrieved

Returns: The object in the array under specified index or the default value.

◆ GetKey()

virtual int PdsDictionary::GetKey	(	int	index,
		wchar_t *	buffer,
		int	len
	)		const

pure virtual

Gets the key in the dictionary by index.

Parameters

index	The index of key whose value is obtained.
buffer	(filled by method) If the buffer is null function returns required length of string
len	Length of a buffer to be filled in.

Returns: Number of characters written into buffer of required length.

◆ GetMatrix()

virtual bool PdsDictionary::GetMatrix	(	const wchar_t *	key,
		PdfMatrix *	matrix
	)

pure virtual

Method gets matrix from specified key in the dictionary.

Parameters

key	The name of the key under which the object is stored.
matrix	Pointer to matrix.

Returns: true if object was added successfully, false otherwise

◆ GetNumber()

virtual float PdsDictionary::GetNumber ( const wchar_t * key ) const

pure virtual

Gets the float value of the PdsNumber object from dictionary by key. Method returns 0 if the objecs does not exist or it's an object of the different type.

Parameters

key	The key under which the object is to be retrieved.

Returns: The object in the array under specified key or 0.

◆ GetNumKeys()

virtual int PdsDictionary::GetNumKeys ( ) const

pure virtual

Gets the number of keys in the dictionary.

Returns: Number of objects in the dictionary

◆ GetRect()

virtual bool PdsDictionary::GetRect	(	const wchar_t *	key,
		PdfRect *	rect
	)

pure virtual

Method gets rectangle from specified key in the dictionary.

Parameters

key	The name of the key under which the object is stored.
rect	Pointer to a rectangle specified in user space coordinates.

Returns: true if object was added successfully, false otherwise

◆ GetStream()

virtual PdsStream * PdsDictionary::GetStream ( const wchar_t * key )

pure virtual

Gets the PdsStream object from dictionary by key or null if the objecs does not exist or it's an object of the different type.

Parameters

key	The key under which the object is to be retrieved.

Returns: The object in the dictionary under specified key or null

◆ GetString()

virtual int PdsDictionary::GetString	(	const wchar_t *	key,
		char *	buffer,
		int	len
	)		const

pure virtual

Gets the string value of the PdsString or PdsName object from dictionary by key. Method returns 0 if the objecs does not exist or it's an object of the different type.

Parameters

key	The key under which the object is to be retrieved.
buffer	(filled by method) If the buffer is null function returns required length of string data.
len	Length of a buffer to be filled in.

Returns: Number of characters written into buffer of required length.

◆ GetText()

virtual int PdsDictionary::GetText	(	const wchar_t *	key,
		wchar_t *	buffer,
		int	len
	)		const

pure virtual

Gets the unicode value of the PdsString or PdsName object from dictionary by key. Method returns 0 if the objecs does not exist or it's an object of the different type.

Parameters

key	The key under which the object is to be retrieved.
buffer	(filled by method) If the buffer is null function returns required length of string
len	Length of a buffer to be filled in.

Returns: Number of characters written into buffer of required length.

See also: PdeWord::GetValue

◆ Known()

virtual bool PdsDictionary::Known ( const wchar_t * key ) const

pure virtual

Tests whether a specific key is found in the specified dictionary. Calling this method is equivalent to checking if the value returned from GetObject is a null object.

Parameters

key	The key to find.

Returns: true if the value of a key is known (exists and is not null) in dict; false otherwise.

◆ Put()

virtual bool PdsDictionary::Put	(	const wchar_t *	key,
		PdsObject *	value
	)

pure virtual

Method puts object to specified key in the dictionary.

Parameters

key	The name of the key under which the object is stored.

Returns: true if object was added successfully, false otherwise

◆ PutArray()

virtual PdsArray * PdsDictionary::PutArray ( const wchar_t * key )

pure virtual

Method puts new array to specified key in the dictionary.

Parameters

key	The name of the key under which the object is stored.

Returns: A newly created array or null.

◆ PutBool()

virtual bool PdsDictionary::PutBool	(	const wchar_t *	key,
		bool	value
	)

pure virtual

Method puts Boolean to specified key in the dictionary.

Parameters

key	The name of the key under which the object is stored.
value	boolean.

Returns: true if object was added successfully, false otherwise

◆ PutDict()

virtual PdsDictionary * PdsDictionary::PutDict ( const wchar_t * key )

pure virtual

Method puts new dictionary to specified key in the dictionary.

Parameters

key	The name of the key under which the object is stored.

Returns: A newly created dictionary or null.

◆ PutMatrix()

virtual bool PdsDictionary::PutMatrix	(	const wchar_t *	key,
		PdfMatrix *	matrix
	)

pure virtual

Method puts matrix to specified key in the dictionary.

Parameters

key	The name of the key under which the object is stored.
matrix	Pointer to matrix.

Returns: true if object was added successfully, false otherwise

◆ PutName()

virtual bool PdsDictionary::PutName	(	const wchar_t *	key,
		const wchar_t *	value
	)

pure virtual

Method puts Name to specified key in the dictionary.

Parameters

key	The name of the key under which the object is stored.
value	Name.

Returns: true if object was added successfully, false otherwise

◆ PutNumber()

virtual bool PdsDictionary::PutNumber	(	const wchar_t *	key,
		float	value
	)

pure virtual

Method puts number to specified key in the dictionary.

Parameters

key	The name of the key under which the object is stored.
value	Float number.

Returns: true if object was added successfully, false otherwise

◆ PutRect()

virtual bool PdsDictionary::PutRect	(	const wchar_t *	key,
		PdfRect *	rect
	)

pure virtual

Method puts rectangle to specified key in the dictionary.

Parameters

key	The name of the key under which the object is stored.
rect	Pointer to a rectangle specified in user space coordinates.

Returns: true if object was added successfully, false otherwise

◆ PutString()

virtual bool PdsDictionary::PutString	(	const wchar_t *	key,
		const wchar_t *	value
	)

pure virtual

Method puts string to specified key in the dictionary.

Parameters

key	The name of the key under which the object is stored.
value	string.

Returns: true if object was added successfully, false otherwise

◆ RemoveKey()

virtual bool PdsDictionary::RemoveKey ( const wchar_t * key )

pure virtual

Method Removes a key-value pair from a dictionary.

Parameters

key	The key of the object to remove from the dictionary.

Returns: true if object was removed successfully, false otherwise

Public Member Functions

Detailed Description

Member Function Documentation

◆ Get()

◆ GetArray()

◆ GetBoolean()

◆ GetDictionary()

◆ GetInteger()

◆ GetKey()

◆ GetMatrix()

◆ GetNumber()

◆ GetNumKeys()

◆ GetRect()

◆ GetStream()

◆ GetString()

◆ GetText()

◆ Known()

◆ Put()

◆ PutArray()

◆ PutBool()

◆ PutDict()

◆ PutMatrix()

◆ PutName()

◆ PutNumber()

◆ PutRect()

◆ PutString()

◆ RemoveKey()