FBStringList Class Reference


Detailed Description

String list.

Examples
UI/Memo.py

List of all members.

Public Member Functions

 __init__ ()
 Constructor.
 __init__ (str pString, str pSeparator= '~')
 Constructor.
 __init__ (FBStringList pOther)
 Copy constructor.
FBStringList operator= (FBStringList pOther)
 Overload assignment operator to support deep copy.
 __del__ ()
 Destructor.
KStringList GetInternal ()
 Get internal variable.
uintptr_t GetReferenceAt (int pIndex)
 Get the reference store with the string at pIndex.
 SetReferenceAt (int pIndex, uintptr_t pRef)
 Set the reference stored with the string at pIndex.
int Find (uintptr_t pRef)
 Find the index where pRef is stored.
int Find (str pString, bool pCaseSensitive=True, bool pStartWith=False)
 Find the index with the string pString (or start with pString).
str GetAt (int pIndex)
 Get the string at pIndex.
str operator[] (int pIndex)
 Overloaded [] operator.
 Sort ()
 Sort the string list (ascending).
int GetCount ()
 Get the number of items in the list.
int Remove (str S)
 Remove a string from the list.
str AsString (str pSeparator= '~')
 Get as string.
bool SetString (str pString, str pSeparator= '~')
 Set string for list.
int Add (str S, uintptr_t pRef=0)
 Add a string to the list.
 Clear ()
 Clear the list (remove all the items).
 RemoveAt (int pIndex)
 Remove an entry at pIndex.
int IndexOf (str S)
 Get the index of a string.
 InsertAt (int pIndex, str S, uintptr_t pRef=0)
 Insert an entry at pIndex.
bool SetAt (int pIndex, str pString)
 Set the string at pIndex.

Protected Attributes

KStringList mItems
 Internal use only - List of items.

Member Function Documentation

__init__ ( )

Constructor.

Examples
UI/Memo.py
__init__ ( str  pString,
str  pSeparator = '~' 
)

Constructor.

Parameters:
pSeparatorthe string list separator.
pStringString to set for list.
Examples
UI/Memo.py
__init__ ( FBStringList  pOther)

Copy constructor.

Examples
UI/Memo.py
FBStringList operator= ( FBStringList  pOther)

Overload assignment operator to support deep copy.

Parameters:
pOtherstring list to be copied from.
Returns:
self reference.
__del__ ( )
KStringList GetInternal ( )

Get internal variable.

uintptr_t GetReferenceAt ( int  pIndex)

Get the reference store with the string at pIndex.

Parameters:
pIndexIndex to get reference at.
Returns:
Reference stored with value at pIndex.
SetReferenceAt ( int  pIndex,
uintptr_t  pRef 
)

Set the reference stored with the string at pIndex.

Parameters:
pIndexIndex to store reference at.
pRefReference to store at pIndex.
int Find ( uintptr_t  pRef)

Find the index where pRef is stored.

Parameters:
pRefReference to look for.
Returns:
Index at which pRef can be found.
int Find ( str  pString,
bool  pCaseSensitive = True,
bool  pStartWith = False 
)

Find the index with the string pString (or start with pString).

Parameters:
pStringString to search for.
pCaseSensitivetrue if considering case.
pStartWithtrue if to find the index of the string which start with pString.
Returns:
Index where S is stored.
str GetAt ( int  pIndex)

Get the string at pIndex.

Parameters:
pIndexIndex to get string at.
Returns:
String at pIndex.
str operator[] ( int  pIndex)

Overloaded [] operator.

Returns the string at pIndex.

Parameters:
pIndexIndex to access.
Returns:
String stored in list at pIndex.
Sort ( )

Sort the string list (ascending).

int GetCount ( )

Get the number of items in the list.

Returns:
Number of strings stored in the list.
int Remove ( str  S)

Remove a string from the list.

Parameters:
SString to remove from the list.
Returns:
Index where item was found.
str AsString ( str  pSeparator = '~')

Get as string.

Parameters:
pSeparatorthe string list separator.
Returns:
String list.
bool SetString ( str  pString,
str  pSeparator = '~' 
)

Set string for list.

Parameters:
pSeparatorthe string list separator.
pStringString to set for list.
int Add ( str  S,
uintptr_t  pRef = 0 
)

Add a string to the list.

Parameters:
SString to add to list.
pRefReference to store with string (default = 0)
Returns:
Index where item was stored.
Clear ( )

Clear the list (remove all the items).

RemoveAt ( int  pIndex)

Remove an entry at pIndex.

Parameters:
pIndexIndex where item is to be removed from.
int IndexOf ( str  S)

Get the index of a string.

Parameters:
SString to look for.
Returns:
Index where string S was found.
InsertAt ( int  pIndex,
str  S,
uintptr_t  pRef = 0 
)

Insert an entry at pIndex.

Parameters:
pIndexIndex where item is to be inserted.
SString to insert.
pRefReference to store with string(default=0).
bool SetAt ( int  pIndex,
str  pString 
)

Set the string at pIndex.

Parameters:
pIndexIndex where string is to be set.
pStringString to set value at pIndex with.

Member Data Documentation

KStringList mItems [protected]

Internal use only - List of items.


FBStringList FBStringList FBStringList FBStringList FBStringList FBStringList FBStringList FBStringList FBStringList FBStringList
FBStringList FBStringList FBStringList FBStringList FBStringList FBStringList FBStringList FBStringList FBStringList FBStringList