This reference page is linked to from the following overview topics: MotionBuilder 2014, Instancing a Referenced Object.
#include <mobu-python-api.h>
String list.
Public Member Functions |
|
def | __reduce__ () |
def | __init__ () |
def | Add () |
def | Clear () |
def | Find () |
def | GetAt () |
def | __len__ () |
def | GetReferenceAt () |
def | IndexOf () |
def | InsertAt () |
def | __getitem__ () |
def | __setitem__ () |
def | Remove () |
def | RemoveAt () |
def | SetAt () |
def | SetReferenceAt () |
def | Sort () |
def | AsString () |
def | SetString () |
def __reduce__ | ( | ) |
def __init__ | ( | ) |
Python Docstring:
__init__( (object)arg1) -> None __init__( (object)arg1, (str)arg2 [, (str)arg3]) -> None
C++ Constructors:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def Add | ( | ) |
Python Docstring:
Add( (FBStringList)arg1, (str)arg2 [, (object)arg3]) -> int
C++ Signature:
int Add(const char * S, kReference pRef = 0)
Add a string to the list.
S | String to add to list. |
pRef | Reference to store with string (default = 0) |
def Clear | ( | ) |
Python Docstring:
Clear( (FBStringList)arg1) -> None
C++ Signature:
void Clear()
Clear the list (remove all the items).
def Find | ( | ) |
Python Docstring:
Find( (FBStringList)arg1, (object)arg2) -> int Find( (FBStringList)arg1, (str)arg2 [, (object)arg3 [, (object)arg4]]) -> int
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def GetAt | ( | ) |
Python Docstring:
GetAt( (FBStringList)arg1, (object)arg2) -> str
C++ Signature:
const char * GetAt(int pIndex)
Get the string at pIndex.
pIndex | Index to get string at. |
def __len__ | ( | ) |
def GetReferenceAt | ( | ) |
Python Docstring:
GetReferenceAt( (FBStringList)arg1, (object)arg2) -> int
C++ Signature:
kReference GetReferenceAt(int pIndex)
Get the reference store with the string at pIndex.
pIndex | Index to get reference at. |
def IndexOf | ( | ) |
Python Docstring:
IndexOf( (FBStringList)arg1, (str)arg2) -> int
C++ Signature:
int IndexOf(const char * S)
Get the index of a string.
S | String to look for. |
def InsertAt | ( | ) |
Python Docstring:
InsertAt( (FBStringList)arg1, (object)arg2, (str)arg3 [, (object)arg4]) -> None
C++ Signature:
void InsertAt(int pIndex, const char * S, kReference pRef = 0)
Insert an entry at pIndex.
pIndex | Index where item is to be inserted. |
S | String to insert. |
pRef | Reference to store with string(default=0). |
def __getitem__ | ( | ) |
def __setitem__ | ( | ) |
Python Docstring:
__setitem__( (FBStringList)arg1, (object)arg2, (str)arg3) -> bool
def Remove | ( | ) |
Python Docstring:
Remove( (FBStringList)arg1, (str)arg2) -> int
C++ Signature:
int Remove(const char * S)
Remove a string from the list.
S | String to remove from the list. |
def RemoveAt | ( | ) |
Python Docstring:
RemoveAt( (FBStringList)arg1, (object)arg2) -> None
C++ Signature:
void RemoveAt(int pIndex)
Remove an entry at pIndex.
pIndex | Index where item is to be removed from. |
def SetAt | ( | ) |
Python Docstring:
SetAt( (FBStringList)arg1, (object)arg2, (str)arg3) -> bool
C++ Signature:
bool SetAt(int pIndex, const char * pString)
Set the string at pIndex.
pIndex | Index where string is to be set. |
pString | String to set value at pIndex with. |
def SetReferenceAt | ( | ) |
Python Docstring:
SetReferenceAt( (FBStringList)arg1, (object)arg2, (object)arg3) -> None
C++ Signature:
void SetReferenceAt(int pIndex, kReference pRef)
Set the reference stored with the string at pIndex.
pIndex | Index to store reference at. |
pRef | Reference to store at pIndex. |
def Sort | ( | ) |
Python Docstring:
Sort( (FBStringList)arg1) -> None
C++ Signature:
void Sort()
Sort the string list (ascending)
def AsString | ( | ) |
Python Docstring:
AsString( (FBStringList)arg1 [, (str)arg2]) -> str
C++ Signature:
const char * AsString(const char pSeparator = '~')
Get as string.
pSeparator | the string list separator. |
def SetString | ( | ) |
Python Docstring:
SetString( (FBStringList)arg1, (str)arg2 [, (str)arg3]) -> bool
C++ Signature:
bool SetString(const char * pString, const char pSeparator = '~')
Set string for list.
pSeparator | the string list separator. |
pString | String to set for list. |