|
def | GraphicsObjectArray () |
| Construct a simple 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...
|
|
This class represents an array of FoxitPDFSDKPython2.GraphicsObject objects.
◆ GraphicsObjectArray()
def FoxitPDFSDKPython2.GraphicsObjectArray.GraphicsObjectArray |
( |
| ) |
|
Construct a simple object.
Constructor, with another array object.
- Parameters
-
[in] | other | Another array object. |
◆ Add()
def FoxitPDFSDKPython2.GraphicsObjectArray.Add |
( |
|
newElement | ) |
|
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()
def FoxitPDFSDKPython2.GraphicsObjectArray.Find |
( |
|
data, |
|
|
|
iStart |
|
) |
| |
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()
def FoxitPDFSDKPython2.GraphicsObjectArray.GetAt |
( |
|
nIndex | ) |
|
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()
def FoxitPDFSDKPython2.GraphicsObjectArray.GetSize |
( |
| ) |
|
Get the number of elements in the array.
- Returns
- The number of elements in the array.
◆ GetUpperBound()
def FoxitPDFSDKPython2.GraphicsObjectArray.GetUpperBound |
( |
| ) |
|
Get the upper bound in the array, actually the maximum valid index.
- Returns
- The upper bound.
◆ InsertAt()
def FoxitPDFSDKPython2.GraphicsObjectArray.InsertAt |
( |
|
nIndex, |
|
|
|
newElement, |
|
|
|
nCount |
|
) |
| |
Inset one or more continuous element at specified position.
Inset an array 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).
- 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()
def FoxitPDFSDKPython2.GraphicsObjectArray.RemoveAll |
( |
| ) |
|
Clean up the array.
- Returns
- None.
◆ RemoveAt()
def FoxitPDFSDKPython2.GraphicsObjectArray.RemoveAt |
( |
|
nIndex, |
|
|
|
nCount |
|
) |
| |
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()
def FoxitPDFSDKPython2.GraphicsObjectArray.SetAt |
( |
|
nIndex, |
|
|
|
newElement |
|
) |
| |
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()
def FoxitPDFSDKPython2.GraphicsObjectArray.SetAtGrow |
( |
|
nIndex, |
|
|
|
newElement |
|
) |
| |
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()
def FoxitPDFSDKPython2.GraphicsObjectArray.SetSize |
( |
|
nNewSize, |
|
|
|
nGrowBy |
|
) |
| |
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).