foxit::addon::accessibility::TagTreeItemDataArray Class Reference

Inherits Object.

Public Member Functions
	TagTreeItemDataArray ()
	Constructor.
	TagTreeItemDataArray (const TagTreeItemDataArray &other)
	Constructor, with another array object. More...
	~ TagTreeItemDataArray ()
	Destructor.
void	Add (const TagTreeItemData &element)
	Add an element to the end of current array. More...
TagTreeItemData	GetAt (size_t index) const
	Retrieve a copy of the element at position specified by index in current array. More...
size_t	GetSize () const
	Get the size of elements in current array. More...
void	InsertAt (size_t index, const TagTreeItemData &element)
	Insert an element before the position specified by index. More...
TagTreeItemDataArray &	operator= (const TagTreeItemDataArray &other)
	Assign operator. More...
TagTreeItemData &	operator[] (size_t index) const
	Retrieve a reference to the element at position specified by index in current array. More...
void	RemoveAll ()
	Remove all the element from current array. More...
void	RemoveAt (size_t index)
	Remove the element in position specified by index. More...

Detailed Description

This class represents an array of related resource data objects.

Constructor & Destructor Documentation

TagTreeItemDataArray()

foxit::addon::accessibility::TagTreeItemDataArray::TagTreeItemDataArray

(

const TagTreeItemDataArray &

other

)

Constructor, with another array object.

Parameters

[in]

other

Another array object.

Member Function Documentation

Add()

void foxit::addon::accessibility::TagTreeItemDataArray::Add

(

const TagTreeItemData &

element

)

Add an element to the end of current array.

Parameters

[in]

element

New element to be added to current array.

Returns

None.

GetAt()

TagTreeItemData foxit::addon::accessibility::TagTreeItemDataArray::GetAt

(

size_t

index

)

const

Retrieve a copy of the element at position specified by index in current array.

Parameters

[in]

index

An index to specify which element is to be retrieved.

Returns

A copy of an element.

GetSize()

size_t foxit::addon::accessibility::TagTreeItemDataArray::GetSize

(

)

const

Get the size of elements in current array.

Returns

The size.

InsertAt()

void foxit::addon::accessibility::TagTreeItemDataArray::InsertAt	(	size_t	index,
		const TagTreeItemData &	element
	)

Insert an element before the position specified by index.

Parameters

[in]	index	An index to specify where to insert the new element. Valid range: from 0 to (size-1). size is the size of elements in current array.
[in]	element	New element to be inserted to current array.

Returns

None.

operator=()

TagTreeItemDataArray& foxit::addon::accessibility::TagTreeItemDataArray::operator=

(

const TagTreeItemDataArray &

other

)

Assign operator.

Parameters

[in]

other

Another array object, whose value will be assigned to current object.

Returns

Reference to current object itself.

operator[]()

TagTreeItemData& foxit::addon::accessibility::TagTreeItemDataArray::operator[]

(

size_t

index

)

const

Retrieve a reference to the element at position specified by index in current array.

Parameters

[in]

index

An index to specify which element is to be retrieved.

Returns

Reference to an element.

RemoveAll()

void foxit::addon::accessibility::TagTreeItemDataArray::RemoveAll

(

)

Remove all the element from current array.

Returns

None.

RemoveAt()

void foxit::addon::accessibility::TagTreeItemDataArray::RemoveAt

(

size_t

index

)

Remove the element in position specified by index.

Parameters

[in]

index

An index to specify which element is to be removed. Valid range: from 0 to (size-1). size is the size of elements in current array.

Returns

None.