String list.
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. |
__init__ | ( | ) |
Constructor.
pSeparator | the string list separator. |
pString | String to set for list. |
__init__ | ( | FBStringList | pOther | ) |
FBStringList operator= | ( | FBStringList | pOther | ) |
Overload assignment operator to support deep copy.
pOther | string list to be copied from. |
__del__ | ( | ) |
Destructor.
KStringList GetInternal | ( | ) |
Get internal variable.
uintptr_t GetReferenceAt | ( | int | pIndex | ) |
Get the reference store with the string at pIndex.
pIndex | Index to get reference at. |
SetReferenceAt | ( | int | pIndex, |
uintptr_t | pRef | ||
) |
Set the reference stored with the string at pIndex.
pIndex | Index to store reference at. |
pRef | Reference to store at pIndex. |
int Find | ( | uintptr_t | pRef | ) |
Find the index where pRef is stored.
pRef | Reference to look for. |
Find the index with the string pString (or start with pString).
pString | String to search for. |
pCaseSensitive | true if considering case. |
pStartWith | true if to find the index of the string which start with pString. |
Get the string at pIndex.
pIndex | Index to get string at. |
Overloaded [] operator.
Returns the string at pIndex.
pIndex | Index to access. |
Sort | ( | ) |
Sort the string list (ascending).
int GetCount | ( | ) |
Get the number of items in the list.
Remove a string from the list.
S | String to remove from the list. |
Get as string.
pSeparator | the string list separator. |
Set string for list.
pSeparator | the string list separator. |
pString | String to set for list. |
Add a string to the list.
S | String to add to list. |
pRef | Reference to store with string (default = 0) |
Clear | ( | ) |
Clear the list (remove all the items).
RemoveAt | ( | int | pIndex | ) |
Remove an entry at pIndex.
pIndex | Index where item is to be removed from. |
Get the index of a string.
S | String to look for. |
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). |
Set the string at pIndex.
pIndex | Index where string is to be set. |
pString | String to set value at pIndex with. |
KStringList mItems [protected] |
Internal use only - List of items.