iKitchenSink Struct Reference
Interface to interact with a kitchen sink. More...
#include <iutil/kitchensink.h>
Inheritance diagram for iKitchenSink:

Public Member Functions | |
virtual void | Drain ()=0 |
Drain the water from the sink. | |
virtual float | Fill (float amount)=0 |
Fill a certain amount of water into the sink. | |
virtual bool | GetShredderActive ()=0 |
Retrieve whether the shredder fitted to the drain was enabled. | |
virtual void | Insert (iBase *object)=0 |
Insert an object in the kitchen sink. | |
virtual bool | Remove (iBase *object)=0 |
Remove an object from the kitchen sink. | |
virtual void | SetShredderActive (bool enable)=0 |
Enable or disable the shredder fitted to the drain. |
Detailed Description
Interface to interact with a kitchen sink.
- Todo:
- Iterator for contained objects.
Definition at line 33 of file kitchensink.h.
Member Function Documentation
|
Drain the water from the sink.
|
|
Fill a certain amount of water into the sink.
|
|
Retrieve whether the shredder fitted to the drain was enabled.
|
|
Insert an object in the kitchen sink.
|
|
Remove an object from the kitchen sink.
|
|
Enable or disable the shredder fitted to the drain.
|
The documentation for this struct was generated from the following file:
- iutil/kitchensink.h
Generated for Crystal Space by doxygen 1.4.6