Foxit PDF SDK

Public Member Functions | List of all members
foxit.pdf.graphics.GraphicsObjectArray Class Reference
Inheritance diagram for foxit.pdf.graphics.GraphicsObjectArray:

## Public Member Functions
| GraphicsObjectArray ()
| Construct a simple object.
| GraphicsObjectArray (GraphicsObjectArray other)
| Constructor, with another array object. More...
bool | Add (GraphicsObject newElement)
| Add an element at the tail. Potentially growing the array. More...
int | Find (GraphicsObject data, int iStart)
| Find an element from specified position to last. More...
GraphicsObject | GetAt (int nIndex)
| This method retrieves an element specified by an index number. More...
int | GetSize ()
| Get the number of elements in the array. More...
int | GetUpperBound ()
| Get the upper bound in the array, actually the maximum valid index. More...
bool | InsertAt (int nIndex, GraphicsObject newElement, int nCount)
| Inset one or more continuous element at specified position. More...
bool | InsertAt (int nStartIndex, BasicArray pNewArray)
| Inset an array at specified position. More...
void | RemoveAll ()
| Clean up the array. More...
bool | RemoveAt (int nIndex, int nCount)
| Remove a number of elements at specified position. More...
bool | SetAt (int nIndex, GraphicsObject newElement)
| This method overwrites an element specified by an index number. More...
bool | SetAtGrow (int nIndex, GraphicsObject newElement)
| Set an element value at specified position. Potentially growing the array. More...
bool | SetSize (int nNewSize, int nGrowBy)
| Change the allocated size and the grow amount. More...

## Detailed Description

This class represents an array of foxit.pdf.graphics.GraphicsObject objects.

## Constructor & Destructor Documentation

## ◆ GraphicsObjectArray()

foxit.pdf.graphics.GraphicsObjectArray.GraphicsObjectArray | ( | GraphicsObjectArray | other | ) |
| inline

Constructor, with another array object.

Parameters

  [in] | other | Another array object.

## Member Function Documentation

## ◆ Add()

bool foxit.pdf.graphics.GraphicsObjectArray.Add | ( | GraphicsObject | newElement | ) |
| inline

Add an element at the tail. Potentially growing the array.

Parameters

  [in] | newElement | The input element.

Returns
  true means success, while false means failure (such as memory error).

## ◆ Find()

int foxit.pdf.graphics.GraphicsObjectArray.Find | ( | GraphicsObject | data,
|  | int | iStart
| ) |  |
| inline

Find an element from specified position to last.

Parameters

  [in] | data | The input element.
  [in] | iStart | Specifies the zero-based index of start element to find.

Returns
  An index of the found element. -1 means found none.

## ◆ GetAt()

GraphicsObject foxit.pdf.graphics.GraphicsObjectArray.GetAt | ( | int | nIndex | ) |
| inline

This method retrieves an element specified by an index number.

Parameters

  [in] | nIndex | Specifies the zero-based index of the element.

Returns
  An element.

## ◆ GetSize()

int foxit.pdf.graphics.GraphicsObjectArray.GetSize | ( |  | ) |
| inline

Get the number of elements in the array.

Returns
  The number of elements in the array.

## ◆ GetUpperBound()

int foxit.pdf.graphics.GraphicsObjectArray.GetUpperBound | ( |  | ) |
| inline

Get the upper bound in the array, actually the maximum valid index.

Returns
  The upper bound.

## ◆ InsertAt() [1/2]

bool foxit.common.fxcrt.GraphicsObjectArray.InsertAt | ( | int | nIndex,
|  | GraphicsObject | newElement,
|  | int | nCount
| ) |  |
| inline

Inset one or more continuous element at specified position.

Parameters

  [in] | nIndex | Specifies the zero-based index in the array.
  [in] | newElement | Specifies the element value to insert.
  [in] | nCount | Specifies the count of the element to insert.

Returns
  true means success, while false means failure (such as parameter or memory error).

## ◆ InsertAt() [2/2]

bool foxit.common.fxcrt.GraphicsObjectArray.InsertAt | ( | int | nStartIndex,
|  | BasicArray | pNewArray
| ) |  |
| inline

Inset an array at specified position.

Parameters

  [in] | nStartIndex | Specifies the zero-based index of start element to insert at.
  [in] | pNewArray | The input array.

Returns
  true means success, while false means failure (such as parameter or memory error).

## ◆ RemoveAll()

void foxit.pdf.graphics.GraphicsObjectArray.RemoveAll | ( |  | ) |
| inline

Clean up the array.

Returns
  None.

## ◆ RemoveAt()

bool foxit.pdf.graphics.GraphicsObjectArray.RemoveAt | ( | int | nIndex,
|  | int | nCount
| ) |  |
| inline

Remove a number of elements at specified position.

Parameters

  [in] | nIndex | Specifies the zero-based index in the array.
  [in] | nCount | Specifies the count of element to remove.

Returns
  true means success, while false means failure (such as parameter or memory error).

## ◆ SetAt()

bool foxit.pdf.graphics.GraphicsObjectArray.SetAt | ( | int | nIndex,
|  | GraphicsObject | newElement
| ) |  |
| inline

This method overwrites an element specified by an index number.

Parameters

  [in] | nIndex | Specifies the zero-based index of the element.
  [in] | newElement | An element.

Returns
  true means success, while false means failure.

## ◆ SetAtGrow()

bool foxit.pdf.graphics.GraphicsObjectArray.SetAtGrow | ( | int | nIndex,
|  | GraphicsObject | newElement
| ) |  |
| inline

Set an element value at specified position. Potentially growing the array.

Parameters

  [in] | nIndex | Specifies the zero-based index of element in the array.
  [in] | newElement | The input element.

Returns
  true means success, while false means failure.

## ◆ SetSize()

bool foxit.pdf.graphics.GraphicsObjectArray.SetSize | ( | int | nNewSize,
|  | int | nGrowBy
| ) |  |
| inline

Change the allocated size and the grow amount.

Parameters

  [in] | nNewSize | The new size in elements expected.
  [in] | nGrowBy | The grow amount in elements expected. This can be -1 for the grow amount unchanged.

Returns
  true means success, while false means failure (such as parameter or memory error).