iPcBag Struct Reference
This is a bag of strings property class. More...
#include <propclass/bag.h>
Inheritance diagram for iPcBag:

Public Member Functions | |
virtual void | AddString (const char *str)=0 |
Add an string to this bag. | |
virtual void | Clear ()=0 |
Empty the bag. | |
virtual csSet< csString > ::GlobalIterator | GetIterator ()=0 |
Return an iterator iterating over all strings. | |
virtual bool | HasString (const char *str)=0 |
Check if this bag contains the string. | |
virtual void | RemoveString (const char *str)=0 |
Remove a string from this bag. |
Detailed Description
This is a bag of strings property class.
This property class can send out the following messages to the behaviour (add prefix 'cel.parameter.' to get the ID for parameters):
- pcbag_addstring: A string is added to the bag (string).
- pcbag_removestring: A string is removed from the bag (string).
This property class supports the following actions (add prefix 'cel.action.' to get the ID of the action and add prefix 'cel.parameter.' to get the ID of the parameter):
- AddString: parameters 'value' (string).
- RemoveString: parameters 'value' (string).
- Clear: no parameters.
- HasString: parameters 'value' (string), returns bool.
Definition at line 47 of file bag.h.
Member Function Documentation
virtual void iPcBag::AddString | ( | const char * | str | ) | [pure virtual] |
Add an string to this bag.
virtual void iPcBag::Clear | ( | ) | [pure virtual] |
Empty the bag.
Return an iterator iterating over all strings.
virtual bool iPcBag::HasString | ( | const char * | str | ) | [pure virtual] |
Check if this bag contains the string.
virtual void iPcBag::RemoveString | ( | const char * | str | ) | [pure virtual] |
Remove a string from this bag.
The documentation for this struct was generated from the following file:
- propclass/bag.h
Generated for CEL: Crystal Entity Layer 1.4.1 by doxygen 1.7.1