Public Member Functions

FBPropertyStringList Class Reference

Search for all occurrences

Detailed Description

Property: StringList

Definition at line 964 of file fbproperties.h.

#include <fbproperties.h>

Inheritance diagram for FBPropertyStringList:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBPropertyStringList ()
 Constructor.
virtual ~FBPropertyStringList ()
 Destructor.
FBPropertyStringListInit (FBComponent *pComponent, const 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 (const char *S)
 Find the index of a string.
virtual const char * GetAt (int pIndex)
 Get the string stored at pIndex.
const char * operator[] (int pIndex)
 [] operator overload.
void Sort ()
 Sort list ascending.
int GetCount ()
 Get the number of items in the list.
int Remove (const char *S)
 Remove a string from the list.
virtual int Add (const 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 (const char *S)
 Get the index of a string.
virtual void InsertAt (int pIndex, const char *S, kReference pRef=0)
 Insert an entry at pIndex.
virtual bool SetAt (int pIndex, const char *pString)
 Set the string at pIndex.
virtual bool IsList () override
 Is this class a list?
virtual const char * AsString (FBDataAsStringFlag pFlag=kFBDataAsStringUI) override
 Get as string.
virtual bool SetString (const char *pString) override
 Set string for list.
virtual FBPropertyType GetPropertyType () override
 Get the property's type.

Constructor & Destructor Documentation

Constructor.

virtual ~FBPropertyStringList ( ) [virtual]

Destructor.


Member Function Documentation

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

Property initialization function.

Parameters:
pComponentOwner component.
pNameName of FBPropertyStringList
Returns:
Pointer to this FBPropertyStringList
kReference GetReferenceAt ( int  pIndex)

Get the reference at pIndex.

Parameters:
pIndexIndex to get reference at.
Returns:
Reference stored at pIndex.
void SetReferenceAt ( int  pIndex,
kReference  pRef 
)

Set reference at pIndex.

Parameters:
pIndexIndex to set reference at.
pRefReference to store.
int Find ( kReference  pRef)

Find the index of a reference.

Parameters:
pRefReference to find in list.
Returns:
Index where reference is stored.
int Find ( const char *  S)

Find the index of a string.

Parameters:
SString to find in list.
Returns:
Index of string S.
virtual const char* GetAt ( int  pIndex) [virtual]

Get the string stored at pIndex.

Parameters:
pIndexIndex to access
Returns:
String stored at pIndex.
const char* operator[] ( int  pIndex)

[] operator overload.

Return the string stored at pIndex.

Parameters:
pIndexIndex to access.
Returns:
String stored at pIndex.
void Sort ( )

Sort list ascending.

int GetCount ( )

Get the number of items in the list.

Returns:
Number of strings stored in the list.
int Remove ( const char *  S)

Remove a string from the list.

Parameters:
SString to remove from the list.
Returns:
Index where item was found.
virtual int Add ( const char *  S,
kReference  pRef = 0 
) [virtual]

Add a string to the list.

Parameters:
SString to add to list.
pRefReference to stored with string (default = 0)
Returns:
Index where item was stored.
virtual void Clear ( ) [virtual]

Clear the list (remove all the items).

virtual void RemoveAt ( int  pIndex) [virtual]

Remove an entry at pIndex.

Parameters:
pIndexIndex where item is to be removed from.
virtual int IndexOf ( const char *  S) [virtual]

Get the index of a string.

Parameters:
SString to look for.
Returns:
Index where string S was found.
virtual void InsertAt ( int  pIndex,
const char *  S,
kReference  pRef = 0 
) [virtual]

Insert an entry at pIndex.

Parameters:
pIndexIndex where item is to be inserted.
SString to insert.
pRefReference to store with string.
virtual bool SetAt ( int  pIndex,
const char *  pString 
) [virtual]

Set the string at pIndex.

Parameters:
pIndexIndex where string is to be set.
pStringString to set value at pIndex with.
Returns:
true if success.
virtual bool IsList ( ) [override, virtual]

Is this class a list?

Returns:
true (this class is a list).

Reimplemented from FBProperty.

virtual const char* AsString ( FBDataAsStringFlag  pFlag = kFBDataAsStringUI) [override, virtual]

Get as string.

Parameters:
pFlagSpecifies the purpose of returned string it defaults to kFBDataAsStringUI.
Returns:
String list.

Reimplemented from FBProperty.

virtual bool SetString ( const char *  pString) [override, virtual]

Set string for list.

Parameters:
pStringString to set for list, with format same as AsString(kFBDataAsStringPersistence)
Returns:
True if it was possible.

Reimplemented from FBProperty.

virtual FBPropertyType GetPropertyType ( ) [inline, override, virtual]

Get the property's type.

Returns:
The property's type.

Reimplemented from FBProperty.

Definition at line 1087 of file fbproperties.h.

{ return kFBPT_stringlist; }

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

FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList
FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList