Detailed Description
Property: StringList
Definition at line 964 of file fbproperties.h.
#include <fbproperties.h>
List of all members.
Constructor & Destructor Documentation
Member Function Documentation
Get the reference at pIndex
.
- Parameters:
-
pIndex | Index to get reference at. |
- Returns:
- Reference stored at
pIndex
.
void SetReferenceAt |
( |
int |
pIndex, |
|
|
kReference |
pRef |
|
) |
| |
Set reference at pIndex
.
- Parameters:
-
pIndex | Index to set reference at. |
pRef | Reference to store. |
Find the index of a reference.
- Parameters:
-
pRef | Reference to find in list. |
- Returns:
- Index where reference is stored.
int Find |
( |
const char * |
S | ) |
|
Find the index of a string.
- Parameters:
-
- Returns:
- Index of string
S
.
virtual const char* GetAt |
( |
int |
pIndex | ) |
[virtual] |
Get the string stored at pIndex
.
- Parameters:
-
- Returns:
- String stored at
pIndex
.
const char* operator[] |
( |
int |
pIndex | ) |
|
[] operator overload.
Return the string stored at pIndex
.
- Parameters:
-
- Returns:
- String stored at
pIndex
.
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:
-
S | String 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:
-
S | String to add to list. |
pRef | Reference 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:
-
pIndex | Index where item is to be removed from. |
virtual int IndexOf |
( |
const char * |
S | ) |
[virtual] |
Get the index of a string.
- Parameters:
-
- 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:
-
pIndex | Index where item is to be inserted. |
S | String to insert. |
pRef | Reference to store with string. |
virtual bool SetAt |
( |
int |
pIndex, |
|
|
const char * |
pString |
|
) |
| [virtual] |
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] |
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:
-
pFlag | Specifies 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:
-
pString | String 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] |
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