FBPropertyStringList Class Reference

Search for all occurrences

---

Detailed Description

Property: StringList

Definition at line 836 of file fbproperties.h.

#include <fbproperties.h>

Inheritance diagram for FBPropertyStringList:

List of all members.

Public Member Functions
	FBPropertyStringList ()
	Constructor.
virtual	~FBPropertyStringList ()
	Destructor.
FBPropertyStringList *	Init (FBComponent *pComponent, char *pName)
	Property initialization function.
kReference	GetReferenceAt (int pIndex)
	Get the reference at pIndex.
void	SetReferenceAt (int pIndex, kReference pRef)
	Set reference at pIndex.
int	Find (kReference pRef)
	Find the index of a reference.
int	Find (char *S)
	Find the index of a string.
virtual char *	GetAt (int pIndex)
	Get the string stored at pIndex.
char *	operator[] (int pIndex)
	[] operator overload.
void	Sort ()
	Sort list ascending.
int	GetCount ()
	Get the number of items in the list.
int	Remove (char *S)
	Remove a string from the list.
virtual int	Add (char *S, kReference pRef=0)
	Add a string to the list.
virtual void	Clear ()
	Clear the list (remove all the items).
virtual void	RemoveAt (int pIndex)
	Remove an entry at pIndex.
virtual int	IndexOf (char *S)
	Get the index of a string.
virtual void	InsertAt (int pIndex, char *S, kReference pRef=0)
	Insert an entry at pIndex.
virtual bool	SetAt (int pIndex, char *pString)
	Set the string at pIndex.
virtual bool	IsList () override
	Is this class a list?
virtual char *	AsString () override
	Get as string.
virtual bool	SetString (char *pString) override
	Set string for list.
virtual FBPropertyType	GetPropertyType () override
	Get the property's type.

---

Constructor & Destructor Documentation

FBPropertyStringList

(

)

Constructor.

virtual ~FBPropertyStringList

(

)

[virtual]

Destructor.

---

Member Function Documentation

FBPropertyStringList* Init	(	FBComponent *	pComponent,
		char *	pName
	)

Search for all occurrences

Property initialization function.

Parameters:

pComponent	Owner component.
pName	Name of FBPropertyStringList

Returns:

Pointer to this FBPropertyStringList

kReference GetReferenceAt

(

int

pIndex

)

Search for all occurrences

Get the reference at pIndex.

Parameters:

pIndex

Index to get reference at.

Returns:

Reference stored at pIndex.

void SetReferenceAt	(	int	pIndex,
		kReference	pRef
	)

Search for all occurrences

Set reference at pIndex.

Parameters:

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

int Find

(

kReference

pRef

)

Search for all occurrences

Find the index of a reference.

Parameters:

pRef	Reference to find in list.

Returns:

Index where reference is stored.

int Find

(

char *

S

)

Search for all occurrences

Find the index of a string.

Parameters:

S	String to find in list.

Returns:

Index of string S.

virtual char* GetAt

(

int

pIndex

)

[virtual]

Search for all occurrences

Get the string stored at pIndex.

Parameters:

pIndex

Index to access

Returns:

String stored at pIndex.

char* operator[]

(

int

pIndex

)

[] operator overload.

Return the string stored at pIndex.

Parameters:

pIndex

Index to access.

Returns:

String stored at pIndex.

void Sort

(

)

Search for all occurrences

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

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

Search for all occurrences

Add a string to the list.

Parameters:

S	String to add to list.
pRef	Reference to stored with string (default = 0)

Returns:

Index where item was stored.

virtual void Clear

(

)

[virtual]

Search for all occurrences

Clear the list (remove all the items).

virtual void RemoveAt

(

int

pIndex

)

[virtual]

Search for all occurrences

Remove an entry at pIndex.

Parameters:

pIndex

Index where item is to be removed from.

virtual int IndexOf

(

char *

S

)

[virtual]

Search for all occurrences

Get the index of a string.

Parameters:

S	String to look for.

Returns:

Index where string S was found.

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

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.

virtual bool SetAt	(	int	pIndex,
		char *	pString
	)		[virtual]

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.

Returns:

true if success.

virtual bool IsList

(

)

[override, virtual]

Search for all occurrences

Is this class a list?

Returns:

true (this class is a list).

Reimplemented from FBProperty.

virtual char* AsString

(

)

[override, virtual]

Search for all occurrences

Get as string.

Returns:

String list.

Reimplemented from FBProperty.

virtual bool SetString

(

char *

pString

)

[override, virtual]

Search for all occurrences

Set string for list.

Parameters:

pString

String to set for list.

Reimplemented from FBProperty.

virtual FBPropertyType GetPropertyType

(

)

[inline, override, virtual]

Search for all occurrences

Get the property's type.

Returns:

The property's type.

Reimplemented from FBProperty.

Definition at line 957 of file fbproperties.h.

{ return kFBPT_stringlist; }

---

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

• fbsdk/fbproperties.h