kzu_property_collection.h File Reference

Property collection. More...

#include <core/util/collection/kzc_dynamic_array.h>

Functions
kzsError	kzuPropertyTypeCollectionCreate (const struct KzcMemoryManager *memoryManager, struct KzuPropertyTypeCollection **out_collection)
	Creates new property type collection. More...
kzsError	kzuPropertyTypeCollectionDelete (struct KzuPropertyTypeCollection *collection)
	Deletes property type collection and properties associated to it. More...
kzsError	kzuPropertyTypeCollectionAddPropertyType (const struct KzuPropertyTypeCollection *collection, const struct KzuPropertyType *propertyType)
	Adds property type to property type collection. More...
kzsError	kzuPropertyTypeCollectionRemovePropertyType (const struct KzuPropertyTypeCollection *collection, const struct KzuPropertyType *propertyType)
	Removes property type from property type collection. More...
kzsError	kzuPropertyTypeCollectionRemoveAllPropertyTypes (const struct KzuPropertyTypeCollection *collection)
	Adds another property type collection property types to destination property collection. More...
struct KzcDynamicArrayIterator	kzuPropertyTypeCollectionGetIterator (const struct KzuPropertyTypeCollection *collection)
	Returns iterator of property type collection elements. More...
struct KzuPropertyType *	kzuPropertyTypeCollectionGetPropertyTypeByName (const struct KzuPropertyTypeCollection *collection, kzString propertyTypeName)
	Gets property type from property type collection by name. More...
void	kzuPropertyTypeCollectionClear (const struct KzuPropertyTypeCollection *collection)
	Clears all property types from property type collection. More...
kzUint	kzuPropertyTypeCollectionGetSize (const struct KzuPropertyTypeCollection *collection)
	Gets the number of stored property types from the property type collection. More...
const struct KzuPropertyType *	kzuPropertyTypeCollectionGet (const struct KzuPropertyTypeCollection *collection, kzUint index)
	Gets property type by index from collection. More...
kzBool	kzuPropertyTypeCollectionContainsPropertyType (const struct KzuPropertyTypeCollection *collection, const struct KzuPropertyType *propertyType)
	Checks if property collection contains specific property type. More...

Detailed Description

Property collection.

Copyright 2008-2020 by Rightware. All rights reserved.

Function Documentation

kzsError kzuPropertyTypeCollectionCreate	(	const struct KzcMemoryManager *	memoryManager,
		struct KzuPropertyTypeCollection **	out_collection
	)

Creates new property type collection.

kzsError kzuPropertyTypeCollectionDelete

(

struct KzuPropertyTypeCollection *

collection

)

Deletes property type collection and properties associated to it.

kzsError kzuPropertyTypeCollectionAddPropertyType	(	const struct KzuPropertyTypeCollection *	collection,
		const struct KzuPropertyType *	propertyType
	)

Adds property type to property type collection.

kzsError kzuPropertyTypeCollectionRemovePropertyType	(	const struct KzuPropertyTypeCollection *	collection,
		const struct KzuPropertyType *	propertyType
	)

Removes property type from property type collection.

kzsError kzuPropertyTypeCollectionRemoveAllPropertyTypes

(

const struct KzuPropertyTypeCollection *

collection

)

Adds another property type collection property types to destination property collection.

struct KzcDynamicArrayIterator kzuPropertyTypeCollectionGetIterator

(

const struct KzuPropertyTypeCollection *

collection

)

Returns iterator of property type collection elements.

struct KzuPropertyType* kzuPropertyTypeCollectionGetPropertyTypeByName	(	const struct KzuPropertyTypeCollection *	collection,
		kzString	propertyTypeName
	)

Gets property type from property type collection by name.

KZ_NULL if not found.

void kzuPropertyTypeCollectionClear

(

const struct KzuPropertyTypeCollection *

collection

)

Clears all property types from property type collection.

After the clear the property type collection is empty.

kzUint kzuPropertyTypeCollectionGetSize

(

const struct KzuPropertyTypeCollection *

collection

)

Gets the number of stored property types from the property type collection.

const struct KzuPropertyType* kzuPropertyTypeCollectionGet	(	const struct KzuPropertyTypeCollection *	collection,
		kzUint	index
	)

Gets property type by index from collection.

KZ_NULL if not found.

kzBool kzuPropertyTypeCollectionContainsPropertyType	(	const struct KzuPropertyTypeCollection *	collection,
		const struct KzuPropertyType *	propertyType
	)

Checks if property collection contains specific property type.