My Project
foxit::pdf::annots::MarkupArray Class Reference

Inherits Object.

Public Member Functions

 MarkupArray ()
 Constructor.
 
 MarkupArray (const MarkupArray &other)
 Constructor, with another array object. More...
 
 ~ MarkupArray ()
 Destructor.
 
void Add (Markup element)
 Add an element to the end of current array. More...
 
Markup 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, Markup element)
 Insert an element before the position specified by index. More...
 
MarkupArrayoperator= (const MarkupArray &other)
 Assign operator. More...
 
Markupoperator[] (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 markup annotation objects.

Constructor & Destructor Documentation

◆ MarkupArray()

foxit::pdf::annots::MarkupArray::MarkupArray ( const MarkupArray other)

Constructor, with another array object.

Parameters
[in]otherAnother array object.

Member Function Documentation

◆ Add()

void foxit::pdf::annots::MarkupArray::Add ( Markup  element)

Add an element to the end of current array.

Parameters
[in]elementNew element to be added to current array.
Returns
None.

◆ GetAt()

Markup foxit::pdf::annots::MarkupArray::GetAt ( size_t  index) const

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

Parameters
[in]indexAn index to specify which element is to be retrieved.
Returns
A copy of an element.

◆ GetSize()

size_t foxit::pdf::annots::MarkupArray::GetSize ( ) const

Get the size of elements in current array.

Returns
The size.

◆ InsertAt()

void foxit::pdf::annots::MarkupArray::InsertAt ( size_t  index,
Markup  element 
)

Insert an element before the position specified by index.

Parameters
[in]indexAn 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]elementNew element to be inserted to current array.
Returns
None.

◆ operator=()

MarkupArray& foxit::pdf::annots::MarkupArray::operator= ( const MarkupArray other)

Assign operator.

Parameters
[in]otherAnother array object, whose value will be assigned to current object.
Returns
Reference to current object itself.

◆ operator[]()

Markup& foxit::pdf::annots::MarkupArray::operator[] ( size_t  index) const

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

Parameters
[in]indexAn index to specify which element is to be retrieved.
Returns
Reference to an element.

◆ RemoveAll()

void foxit::pdf::annots::MarkupArray::RemoveAll ( )

Remove all the element from current array.

Returns
None.

◆ RemoveAt()

void foxit::pdf::annots::MarkupArray::RemoveAt ( size_t  index)

Remove the element in position specified by index.

Parameters
[in]indexAn 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.

Foxit Software Corporation Logo
@2019 Foxit Software Incorporated. All rights reserved.