Foxit PDF SDK  9.1
FSRectFArray Class Reference

An array of RectF objects.
More...

Inheritance diagram for FSRectFArray:
FSBasicArray

Instance Methods

(BOOL) - add:
 Add an element at the tail. Potentially growing the array.
More...
 
(void) - dealloc
 
(int) - find:
 Find an element from specified position to last.
More...
 
(int) - find:iStart:
 Find an element from specified position to last.
More...
 
(FSRectF *) - getAt:
 This method retrieves an element specified by an index number.
More...
 
(void *) - getCptr
 
(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...
 
(id) - init
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithOther:
 
(BOOL) - insertAt:newElement:
 
(BOOL) - insertAt:newElement:nCount:
 
(BOOL) - insertAt:pNewArray:
 
(void) - removeAll
 Clean up the array.
More...
 
(BOOL) - removeAt:
 Remove a number of elements at specified position.
More...
 
(BOOL) - removeAt:nCount:
 Remove a number of elements at specified position.
More...
 
(BOOL) - setAt:newElement:
 This method overwrites an element specified by an index number.
More...
 
(BOOL) - setAtGrow:newElement:
 Set an element value at specified position. Potentially growing the array.
More...
 
(BOOL) - setSize:
 Change the allocated size and the grow amount.
More...
 
(BOOL) - setSize:nGrowBy:
 Change the allocated size and the grow amount.
More...
 

Additional Inherited Members

- Protected Attributes inherited from FSBasicArray
BOOL swigCMemOwn
 
void * swigCPtr
 

Detailed Description

An array of RectF objects.

Method Documentation

◆ add:

- (BOOL) add: (FSRectF*)  newElement

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

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

◆ dealloc

- (void) dealloc

Reimplemented from FSBasicArray.

◆ find:

- (int) find: (FSRectF*)  data

Find an element from specified position to last.

Parameters
[in]dataThe input element.
Returns
An index of the found element. -1 means found none.

◆ find:iStart:

- (int) find: (FSRectF*)  data
iStart: (int)  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:

- (FSRectF *) getAt: (int)  nIndex

This method retrieves an element specified by an index number.

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

◆ getCptr

- (void*) getCptr

Reimplemented from FSBasicArray.

◆ getSize

- (int) getSize

Get the number of elements in the array.

Returns
The number of elements in the array.

◆ getUpperBound

- (int) getUpperBound

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

Returns
The upper bound.

◆ init

- (id) init

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

Reimplemented from FSBasicArray.

◆ initWithOther:

- (id) initWithOther: (FSRectFArray *)  other

◆ insertAt:newElement:

- (BOOL) insertAt: (int)  nIndex
newElement: (FSRectF *)  newElement 

◆ insertAt:newElement:nCount:

- (BOOL) insertAt: (int)  nIndex
newElement: (FSRectF *)  newElement
nCount: (int)  nCount 

◆ insertAt:pNewArray:

- (BOOL) insertAt: (int)  nStartIndex
pNewArray: (FSBasicArray *)  pNewArray 

◆ removeAll

- (void) removeAll

Clean up the array.

Returns
None.

◆ removeAt:

- (BOOL) removeAt: (int)  nIndex

Remove a number of elements at specified position.

Parameters
[in]nIndexSpecifies the zero-based index in the array.
Returns
YES means success, while NO means failure (such as parameter or memory error).

◆ removeAt:nCount:

- (BOOL) removeAt: (int)  nIndex
nCount: (int)  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
YES means success, while NO means failure (such as parameter or memory error).

◆ setAt:newElement:

- (BOOL) setAt: (int)  nIndex
newElement: (FSRectF*)  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
YES means success, while NO means failure.

◆ setAtGrow:newElement:

- (BOOL) setAtGrow: (int)  nIndex
newElement: (FSRectF*)  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
YES means success, while NO means failure.

◆ setSize:

- (BOOL) setSize: (int)  nNewSize

Change the allocated size and the grow amount.

Parameters
[in]nNewSizeThe new size in elements expected.
Returns
YES means success, while NO means failure (such as parameter or memory error).

◆ setSize:nGrowBy:

- (BOOL) setSize: (int)  nNewSize
nGrowBy: (int)  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
YES means success, while NO means failure (such as parameter or memory error).