FBStringList Class Reference
Detailed Description
String list.
- Examples
- UI/Memo.py
Public Member Functions |
|
| __init__ () | |
| Constructor. |
|
| __del__ () | |
| Destructor. |
|
| KStringList | GetInternal () |
| Get internal variable. |
|
| int | GetReferenceAt (int pIndex) |
| Get the reference store with the string at
pIndex. |
|
| SetReferenceAt (int pIndex, int pRef) | |
| Set the reference stored with the string at
pIndex. |
|
| int | Find (int pRef) |
| Find the index where pRef is
stored. |
|
| int | Find (str S) |
| Find the index with the string S.
|
|
| 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 () |
| Get as string. |
|
| bool | SetString (str pString) |
| Set string for list. |
|
| int | Add (str S, int 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, int pRef=0) | |
| Insert an entry at pIndex. |
|
| bool | SetAt (int pIndex, str pString) |
| Set the string at pIndex. |
|
| FBStringList | operator= (FBStringList pStringList) |
Protected Attributes |
|
| KStringList | mItems |
| Internal use only - List of items. |
|
Member Function Documentation
| __init__ | ( | ) |
| __del__ | ( | ) |
Destructor.
| KStringList GetInternal | ( | ) |
Get internal variable.
Get the reference store with the string at pIndex.
- Parameters:
-
pIndex Index to get reference at.
- Returns:
- Reference stored with value at pIndex.
Set the reference stored with the string at pIndex.
- Parameters:
-
pIndex Index to store reference at. pRef Reference to store at pIndex.
Find the index where pRef is stored.
- Parameters:
-
pRef Reference to look for.
- Returns:
- Index at which pRef can be found.
Find the index with the string S.
- Parameters:
-
S String to search for.
- Returns:
- Index where S is stored.
Get the string at pIndex.
- Parameters:
-
pIndex Index to get string at.
- Returns:
- String at pIndex.
Overloaded [] operator.
Returns the string at pIndex.
- Parameters:
-
pIndex Index 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.
Remove a string from the list.
- Parameters:
-
S String to remove from the list.
- Returns:
- Index where item was found.
| str AsString | ( | ) |
Add a string to the list.
- Parameters:
-
S String to add to list. pRef Reference 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:
-
pIndex Index where item is to be removed from.
Get the index of a string.
- Parameters:
-
S String to look for.
- Returns:
- Index where string S was found.
Insert an entry at pIndex.
- Parameters:
-
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.
- Parameters:
-
pIndex Index where string is to be set. pString String to set value at pIndex with.
| FBStringList operator= | ( | FBStringList | pStringList | ) |
Member Data Documentation
KStringList
mItems [protected] |
Internal use only - List of items.
