Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kCollection.h
Go to the documentation of this file.
1 
10 #ifndef K_API_COLLECTION_H
11 #define K_API_COLLECTION_H
12 
13 #include <kApi/kApiDef.h>
14 
15 kBeginHeader()
16 
17 
41 //typedef kObject kCollection; --forward-declared in kApiDef.x.h
42 
43 
53 //typedef kPointer kIterator; --forward-declared in kApiDef.x.h
54 
55 
62 kFx(kType) kCollection_ItemType(kCollection collection);
63 
71 kFx(kSize) kCollection_Count(kCollection collection);
72 
80 kFx(kIterator) kCollection_GetIterator(kCollection collection);
81 
90 kFx(kBool) kCollection_HasNext(kCollection collection, kIterator iterator);
91 
100 kFx(void*) kCollection_Next(kCollection collection, kIterator* iterator);
101 
102 kEndHeader()
103 
104 #include <kApi/Data/kCollection.x.h>
105 
106 #endif
kCollection::kCollection_ItemType
kType kCollection_ItemType(kCollection collection)
Gets the collection element type.
kCollection
Supports forward iteration over a collection of items.
kSize
Represents an unsigned integer that can store a pointer address.
kIterator
Used in conjunction with the kCollection class to iterate over elements.
kCollection::kCollection_HasNext
kBool kCollection_HasNext(kCollection collection, kIterator iterator)
Determines whether a collection has another item.
kApiDef.h
Core Zen type declarations.
kCollection::kCollection_Next
void * kCollection_Next(kCollection collection, kIterator *iterator)
Gets the next collection element and then advances the iterator.
kType
Represents metadata about a type (class, interface, or value).
kBool
Represents a boolean value.
kCollection::kCollection_Count
kSize kCollection_Count(kCollection collection)
Gets the collection element count.
kCollection::kCollection_GetIterator
kIterator kCollection_GetIterator(kCollection collection)
Returns an iterator to the first element in the collection.