FBStringList Class Reference

Search for all occurrences

---

Detailed Description

String list.

Definition at line 201 of file fbstring.h.

#include <fbstring.h>

List of all members.

Public Member Functions
	FBStringList ()
	Constructor.
	~FBStringList ()
	Destructor.
KStringList *	GetInternal ()
	Get internal variable.
kReference	GetReferenceAt (int pIndex)
	Get the reference store with the string at pIndex.
void	SetReferenceAt (int pIndex, kReference pRef)
	Set the reference stored with the string at pIndex.
int	Find (kReference pRef)
	Find the index where pRef is stored.
int	Find (char *S)
	Find the index with the string S.
char *	GetAt (int pIndex)
	Get the string at pIndex.
char *	operator[] (int pIndex)
	Overloaded [] operator.
void	Sort ()
	Sort the string list (ascending)
int	GetCount ()
	Get the number of items in the list.
int	Remove (char *S)
	Remove a string from the list.
char *	AsString ()
	Get as string.
bool	SetString (char *pString)
	Set string for list.
int	Add (char *S, kReference pRef=0)
	Add a string to the list.
void	Clear ()
	Clear the list (remove all the items).
void	RemoveAt (int pIndex)
	Remove an entry at pIndex.
int	IndexOf (char *S)
	Get the index of a string.
void	InsertAt (int pIndex, char *S, kReference pRef=0)
	Insert an entry at pIndex.
bool	SetAt (int pIndex, char *pString)
	Set the string at pIndex.
Protected Attributes
KStringList *	mItems
	Internal use only - List of items.

---

Constructor & Destructor Documentation

FBStringList

(

)

Constructor.

~FBStringList

(

)

Destructor.

---

Member Function Documentation

KStringList* GetInternal

(

)

Search for all occurrences

Get internal variable.

kReference GetReferenceAt

(

int

pIndex

)

Search for all occurrences

Get the reference store with the string at pIndex.

Parameters:

pIndex

Index to get reference at.

Returns:

Reference stored with value at pIndex.

void SetReferenceAt	(	int	pIndex,
		kReference	pRef
	)

Search for all occurrences

Set the reference stored with the string at pIndex.

Parameters:

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

int Find

(

kReference

pRef

)

Search for all occurrences

Find the index where pRef is stored.

Parameters:

pRef	Reference to look for.

Returns:

Index at which pRef can be found.

int Find

(

char *

S

)

Search for all occurrences

Find the index with the string S.

Parameters:

S	String to search for.

Returns:

Index where S is stored.

char* GetAt

(

int

pIndex

)

Search for all occurrences

Get the string at pIndex.

Parameters:

pIndex

Index to get string at.

Returns:

String at pIndex.

char* operator[]

(

int

pIndex

)

Overloaded [] operator.

Returns the string at pIndex.

Parameters:

pIndex

Index to access.

Returns:

String stored in list at pIndex.

void Sort

(

)

Search for all occurrences

Sort the string list (ascending)

int GetCount

(

)

Search for all occurrences

Get the number of items in the list.

Returns:

Number of strings stored in the list.

int Remove

(

char *

S

)

Search for all occurrences

Remove a string from the list.

Parameters:

S	String to remove from the list.

Returns:

Index where item was found.

char* AsString

(

)

Search for all occurrences

Get as string.

Returns:

String list.

bool SetString

(

char *

pString

)

Search for all occurrences

Set string for list.

Parameters:

pString

String to set for list.

int Add	(	char *	S,
		kReference	pRef = 0
	)

Search for all occurrences

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.

void Clear

(

)

Search for all occurrences

Clear the list (remove all the items).

void RemoveAt

(

int

pIndex

)

Search for all occurrences

Remove an entry at pIndex.

Parameters:

pIndex

Index where item is to be removed from.

int IndexOf

(

char *

S

)

Search for all occurrences

Get the index of a string.

Parameters:

S	String to look for.

Returns:

Index where string S was found.

void InsertAt	(	int	pIndex,
		char *	S,
		kReference	pRef = 0
	)

Search for all occurrences

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

bool SetAt	(	int	pIndex,
		char *	pString
	)

Search for all occurrences

Set the string at pIndex.

Parameters:

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

---

Member Data Documentation

KStringList* mItems [protected]

Search for all occurrences

Internal use only - List of items.

Definition at line 205 of file fbstring.h.

---

The documentation for this class was generated from the following file:

• fbsdk/fbstring.h