Foxit PDF SDK
|
Inherits Object.
Public Member Functions | |
NoteArray () | |
Constructor. | |
NoteArray (const NoteArray &other) | |
Constructor, with another array object. More... | |
~ NoteArray () | |
Destructor. | |
void | Add (const Note &element) |
Add an element to the end of current array. More... | |
Note | 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 Note &element) |
Insert an element before the position specified by index. More... | |
NoteArray & | operator= (const NoteArray &other) |
Assign operator. More... | |
Note & | 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... | |
This class represents an array of note annotation objects.
foxit::pdf::annots::NoteArray::NoteArray | ( | const NoteArray & | other | ) |
Constructor, with another array object.
[in] | other | Another array object. |
void foxit::pdf::annots::NoteArray::Add | ( | const Note & | element | ) |
Add an element to the end of current array.
[in] | element | New element to be added to current array. |
Note foxit::pdf::annots::NoteArray::GetAt | ( | size_t | index | ) | const |
Retrieve a copy of the element at position specified by index in current array.
[in] | index | An index to specify which element is to be retrieved. |
size_t foxit::pdf::annots::NoteArray::GetSize | ( | ) | const |
Get the size of elements in current array.
void foxit::pdf::annots::NoteArray::InsertAt | ( | size_t | index, |
const Note & | element | ||
) |
Insert an element before the position specified by index.
[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. |
Assign operator.
[in] | other | Another array object, whose value will be assigned to current object. |
Note& foxit::pdf::annots::NoteArray::operator[] | ( | size_t | index | ) | const |
Retrieve a reference to the element at position specified by index in current array.
[in] | index | An index to specify which element is to be retrieved. |
void foxit::pdf::annots::NoteArray::RemoveAll | ( | ) |
Remove all the element from current array.
void foxit::pdf::annots::NoteArray::RemoveAt | ( | size_t | index | ) |
Remove the element in position specified by index.
[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. |