Foxit PDF SDK  9.1
FSPortfolioNodeArray Class Reference
Inheritance diagram for FSPortfolioNodeArray:

Instance Methods

(void) - add:
 Add an element to the end of current array.
More...
 
(void) - dealloc
 
(FSPortfolioNode *) - getAt:
 Retrieve a copy of the element at position specified by index in current array.
More...
 
(void *) - getCptr
 
(unsigned long) - getSize
 Get the size of elements in current array.
More...
 
(id) - init
 Constructor.
More...
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithOther:
 Constructor, with another array object.
More...
 
(void) - insertAt:element:
 Insert an element before the position specified by index.
More...
 
(void) - removeAll
 Remove all the element from current array.
More...
 
(void) - removeAt:
 Remove the element in position specified by index.
More...
 

Protected Attributes

BOOL swigCMemOwn
 
void * swigCPtr
 

Detailed Description

This class represents an array of FSPortfolioNode objects.

Method Documentation

◆ add:

- (void) add: (FSPortfolioNode*)  element

Add an element to the end of current array.

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

◆ dealloc

- (void) dealloc

◆ getAt:

- (FSPortfolioNode *) getAt: (unsigned long)  index

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.

◆ getCptr

- (void*) getCptr

◆ getSize

- (unsigned long) getSize

Get the size of elements in current array.

Returns
The size.

◆ init

- (id) init

Constructor.

◆ initWithCptr:swigOwnCObject:

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

◆ initWithOther:

- (id) initWithOther: (FSPortfolioNodeArray*)  other

Constructor, with another array object.

Parameters
[in]otherAnother array object.

◆ insertAt:element:

- (void) insertAt: (unsigned long)  index
element: (FSPortfolioNode*)  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.

◆ removeAll

- (void) removeAll

Remove all the element from current array.

Returns
None.

◆ removeAt:

- (void) removeAt: (unsigned long)  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.

Member Data Documentation

◆ swigCMemOwn

- (BOOL) swigCMemOwn
protected

◆ swigCPtr

- (void*) swigCPtr
protected