FBStringList Class Reference

String list. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBStringList:

Public Member Functions
	FBStringList ()
	Constructor.
	FBStringList (str pString, str pSeparator='~')
	Constructor.
	FBStringList (FBStringList pOther)
	Copy constructor.
int	Add (str S, kReference pRef=0)
	Add a string to the list.
str	AsString (str pSeparator='~')
	Get as string.
	Clear ()
	Clear the list (remove all the items).
int	Find (kReference 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.
kReference	GetReferenceAt (int pIndex)
	Get the reference store with the string at pIndex.
int	IndexOf (str S)
	Get the index of a string.
	InsertAt (int pIndex, str S, kReference pRef=0)
	Insert an entry at pIndex.
int	Remove (str S)
	Remove a string from the list.
	RemoveAt (int pIndex)
	Remove an entry at pIndex.
bool	SetAt (int pIndex, str pString)
	Set the string at pIndex.
	SetReferenceAt (int pIndex, kReference pRef)
	Set the reference stored with the string at pIndex.
bool	SetString (str pString, str pSeparator='~')
	Set string for list.
	Sort ()
	Sort the string list (ascending)

Detailed Description

String list.

See sample: Memo.py.

Constructor & Destructor Documentation

FBStringList() [1/3]

FBStringList

(

)

Constructor.

FBStringList() [2/3]

FBStringList	(	str	pString,
		str	pSeparator = '~'
	)

Constructor.

Parameters

pString	String to set for list.
pSeparator	the string list separator.

FBStringList() [3/3]

FBStringList

(

FBStringList

pOther

)

Copy constructor.

Member Function Documentation

Add()

int Add	(	str	S,
		kReference	pRef = 0
	)

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.

AsString()

str AsString

(

str

pSeparator = '~'

)

Get as string.

Parameters

pSeparator

the string list separator.

Returns

String list.

Clear()

Clear

(

)

Clear the list (remove all the items).

Find() [1/2]

int Find

(

kReference

pRef

)

Find the index where pRef is stored.

Parameters

pRef	Reference to look for.

Returns

Index at which pRef can be found.

Find() [2/2]

int Find	(	str	pString,
		bool	pCaseSensitive = True,
		bool	pStartWith = False
	)

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

Parameters

pString	String to search for.
pCaseSensitive	true if considering case.
pStartWith	true if to find the index of the string which start with pString.

Returns

Index where S is stored.

GetAt()

str GetAt

(

int

pIndex

)

Get the string at pIndex.

Parameters

pIndex

Index to get string at.

Returns

String at pIndex.

GetReferenceAt()

kReference GetReferenceAt

(

int

pIndex

)

Get the reference store with the string at pIndex.

Parameters

pIndex

Index to get reference at.

Returns

Reference stored with value at pIndex.

IndexOf()

int IndexOf

(

str

S

)

Get the index of a string.

Parameters

S	String to look for.

Returns

Index where string S was found.

InsertAt()

InsertAt	(	int	pIndex,
		str	S,
		kReference	pRef = 0
	)

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).

Remove()

int Remove

(

str

S

)

Remove a string from the list.

Parameters

S	String to remove from the list.

Returns

Index where item was found.

RemoveAt()

RemoveAt

(

int

pIndex

)

Remove an entry at pIndex.

Parameters

pIndex

Index where item is to be removed from.

SetAt()

bool SetAt	(	int	pIndex,
		str	pString
	)

Set the string at pIndex.

Parameters

pIndex	Index where string is to be set.
pString	String to set value at pIndex with.

SetReferenceAt()

SetReferenceAt	(	int	pIndex,
		kReference	pRef
	)

Set the reference stored with the string at pIndex.

Parameters

pIndex	Index to store reference at.
pRef	Reference to store at pIndex.

SetString()

bool SetString	(	str	pString,
		str	pSeparator = '~'
	)

Set string for list.

Parameters

pString	String to set for list.
pSeparator	the string list separator.

Sort()

Sort

(

)

Sort the string list (ascending)