#include <pdfix.h>

Inheritance diagram for PdsArray:

Public Member Functions
virtual int	GetNumObjects () const =0
	Gets the number of objects in the array. More...

virtual PdsObject *	Get (int index) const =0
	Gets the PdsObject from array by index. More...

virtual bool	Put (int index, PdsObject *value)=0

virtual bool	PutNumber (int index, float value)=0

virtual bool	PutName (int index, const wchar_t *value)=0

virtual bool	PutString (int index, const wchar_t *value)=0

virtual bool	Insert (int index, PdsObject *value)=0
	Method inserts object before specified position in the array. If the index is larger. More...

virtual PdsDictionary *	InsertDict (int index)=0
	Method inserts new dictionary before specified position in the array. If the index is larger. More...

virtual PdsArray *	InsertArray (int index)=0
	Method inserts new array before specified position in the array. If the index is larger. More...

virtual bool	RemoveNth (int index)=0
	Method Removes an object from the array. More...

virtual PdsDictionary *	GetDictionary (int index) const =0

virtual PdsArray *	GetArray (int index) const =0

virtual PdsStream *	GetStream (int index) const =0

virtual int	GetString (int index, char *buffer, int len) const =0

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

virtual float	GetNumber (int index) const =0

virtual int	GetInteger (int index) const =0

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

PdsArray class.

Member Function Documentation

◆ Get()

virtual PdsObject * PdsArray::Get ( int index ) const

pure virtual

Gets the PdsObject from array by index.

Parameters

index The index of object to be retrieved.

Returns: The object in the array under specified index or null

◆ GetArray()

virtual PdsArray * PdsArray::GetArray ( int index ) const

pure virtual

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

Parameters

index The index of object to be retrieved.

Returns: The object in the array under specified index or null

◆ GetDictionary()

virtual PdsDictionary * PdsArray::GetDictionary ( int index ) const

pure virtual

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

Parameters

index The index of object to be retrieved.

Returns: The object in the array under specified index or null

◆ GetInteger()

virtual int PdsArray::GetInteger ( int index ) const

pure virtual

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

Parameters

index The index of object to be retrieved.

Returns: The object in the array under specified index or 0

◆ GetNumber()

virtual float PdsArray::GetNumber ( int index ) const

pure virtual

Gets the float 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

index The index of object to be retrieved.

Returns: The object in the array under specified index or 0

◆ GetNumObjects()

virtual int PdsArray::GetNumObjects ( ) const

pure virtual

Gets the number of objects in the array.

Returns: Number of objects in the array

◆ GetStream()

virtual PdsStream * PdsArray::GetStream ( int index ) const

pure virtual

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

Parameters

index The index of object to be retrieved.

Returns: The object in the array under specified index or null

◆ GetString()

virtual int PdsArray::GetString	(	int	index,
		char *	buffer,
		int	len
	)		const

pure virtual

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

Parameters

index	The index of object 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 PdsArray::GetText	(	int	index,
		wchar_t *	buffer,
		int	len
	)		const

pure virtual

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

Parameters

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

◆ Insert()

virtual bool PdsArray::Insert	(	int	index,
		PdsObject *	value
	)

pure virtual

Method inserts object before specified position in the array. If the index is larger.

Parameters

index The index of a new position of an object.

Returns: true if object was added successfully, false otherwise

◆ InsertArray()

virtual PdsArray * PdsArray::InsertArray ( int index )

pure virtual

Method inserts new array before specified position in the array. If the index is larger.

Parameters

index The index of a new position of an array.

Returns: The new array or null

◆ InsertDict()

virtual PdsDictionary * PdsArray::InsertDict ( int index )

pure virtual

Method inserts new dictionary before specified position in the array. If the index is larger.

Parameters

index The index of a new position of an dictionary.

Returns: The new dictionary or null

◆ Put()

virtual bool PdsArray::Put	(	int	index,
		PdsObject *	value
	)

pure virtual

Method puts object to specified position in the array. The array is extended and null objects are stored in empty slots

Parameters

index The index of a new position of an object.

Returns: true if object was added successfully, false otherwise

◆ PutName()

virtual bool PdsArray::PutName	(	int	index,
		const wchar_t *	value
	)

pure virtual

Method puts text to specified position in the array. The array is extended and null objects are stored in empty slots

Parameters

index The index of a new position of an object.

Returns: true if object was added successfully, false otherwise

◆ PutNumber()

virtual bool PdsArray::PutNumber	(	int	index,
		float	value
	)

pure virtual

Method puts number to specified position in the array. The array is extended and null objects are stored in empty slots

Parameters

index The index of a new position of an object.

Returns: true if object was added successfully, false otherwise

◆ PutString()

virtual bool PdsArray::PutString	(	int	index,
		const wchar_t *	value
	)

pure virtual

Method puts string to specified position in the array.The array is extended and null objects are stored in empty slots

Parameters

index	The index of a new position of an object.
value	string.

Returns: true if object was added successfully, false otherwise

◆ RemoveNth()

virtual bool PdsArray::RemoveNth ( int index )

pure virtual

Method Removes an object from the array.

Parameters

index The index of the object to remove from the Array.

Returns: true if object was removed successfully, false otherwise

Public Member Functions

Detailed Description

Member Function Documentation

◆ Get()

◆ GetArray()

◆ GetDictionary()

◆ GetInteger()

◆ GetNumber()

◆ GetNumObjects()

◆ GetStream()

◆ GetString()

◆ GetText()

◆ Insert()

◆ InsertArray()

◆ InsertDict()

◆ Put()

◆ PutName()

◆ PutNumber()

◆ PutString()

◆ RemoveNth()