Foxit PDF SDK
FoxitPDFSDKPython2.RectFArray Class Reference

An array of RectF objects.
More...

Inheritance diagram for FoxitPDFSDKPython2.RectFArray:
FoxitPDFSDKPython2.BasicArray

Public Member Functions

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

Detailed Description

An array of RectF objects.

Constructor & Destructor Documentation

◆ RectFArray()

def FoxitPDFSDKPython2.RectFArray.RectFArray (   other)

Constructor, with another array object.

Parameters
[in]otherAnother array object.

Member Function Documentation

◆ Add()

def FoxitPDFSDKPython2.RectFArray.Add (   newElement)

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

Parameters
[in]newElementThe input element.
Returns
true means success, while false means failure (such as memory error).

◆ Find()

def FoxitPDFSDKPython2.RectFArray.Find (   data,
  iStart 
)

Find an element from specified position to last.

Parameters
[in]dataThe input element.
[in]iStartSpecifies the zero-based index of start element to find.
Returns
An index of the found element. -1 means found none.

◆ GetAt()

def FoxitPDFSDKPython2.RectFArray.GetAt (   nIndex)

This method retrieves an element specified by an index number.

Parameters
[in]nIndexSpecifies the zero-based index of the element.
Returns
An element.

◆ GetSize()

def FoxitPDFSDKPython2.RectFArray.GetSize ( )

Get the number of elements in the array.

Returns
The number of elements in the array.

◆ GetUpperBound()

def FoxitPDFSDKPython2.RectFArray.GetUpperBound ( )

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

Returns
The upper bound.

◆ InsertAt()

def FoxitPDFSDKPython2.RectFArray.InsertAt (   nIndex,
  newElement,
  nCount 
)

Inset one or more continuous element at specified position.

Inset an array at specified position.

Parameters
[in]nIndexSpecifies the zero-based index in the array.
[in]newElementSpecifies the element value to insert.
[in]nCountSpecifies the count of the element to insert.
Returns
true means success, while false means failure (such as parameter or memory error).
Parameters
[in]nStartIndexSpecifies the zero-based index of start element to insert at.
[in]pNewArrayThe input array.
Returns
true means success, while false means failure (such as parameter or memory error).

◆ RemoveAll()

def FoxitPDFSDKPython2.RectFArray.RemoveAll ( )

Clean up the array.

Returns
None.

◆ RemoveAt()

def FoxitPDFSDKPython2.RectFArray.RemoveAt (   nIndex,
  nCount 
)

Remove a number of elements at specified position.

Parameters
[in]nIndexSpecifies the zero-based index in the array.
[in]nCountSpecifies the count of element to remove.
Returns
true means success, while false means failure (such as parameter or memory error).

◆ SetAt()

def FoxitPDFSDKPython2.RectFArray.SetAt (   nIndex,
  newElement 
)

This method overwrites an element specified by an index number.

Parameters
[in]nIndexSpecifies the zero-based index of the element.
[in]newElementAn element.
Returns
true means success, while false means failure.

◆ SetAtGrow()

def FoxitPDFSDKPython2.RectFArray.SetAtGrow (   nIndex,
  newElement 
)

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

Parameters
[in]nIndexSpecifies the zero-based index of element in the array.
[in]newElementThe input element.
Returns
true means success, while false means failure.

◆ SetSize()

def FoxitPDFSDKPython2.RectFArray.SetSize (   nNewSize,
  nGrowBy 
)

Change the allocated size and the grow amount.

Parameters
[in]nNewSizeThe new size in elements expected.
[in]nGrowByThe 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).