kzu_presenter_base.h File Reference

Defines base class for items that handle scrolling of layouts. More...

#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Functions
kzsError	kzuPresenterCreate_protected (const struct KzcMemoryManager *memoryManager, const struct KzuPresenterClass *presenterClass, struct KzuPresenterData *presenterData, struct KzuPresenter **out_presenter)
	Creates base for a presenter. More...
kzsError	kzuPresenterGetItem_protected (const struct KzuObjectNode *layoutObject, kzUint presenterIndex, struct KzuObjectNode **out_objectNode)
	Finds the child of the layout object with the specified presenter index. More...
kzsError	kzuPresenterDelete_protected (const struct KzuPresenter *presenter)
	Base delete implementation. More...
kzsError	kzuPresenterSnap_protected (const struct KzuPresenter *presenter, const struct KzcVector2 *position, struct KzcVector2 *out_position, kzInt *out_itemIndex)
	Base snap implementation. More...
kzsError	kzuPresenterSetScroll_protected (const struct KzuPresenter *presenter, const struct KzcVector2 *scroll)
	Base set scroll implementation. More...
kzsError	kzuPresenterGetScrollBounds_protected (const struct KzuPresenter *presenter, kzFloat *out_scrollMinimumX, kzFloat *out_scrollMaximumX, kzFloat *out_scrollMinimumY, kzFloat *out_scrollMaximumY)
	Base get scroll bounds implementation. More...
kzsError	kzuPresenterBringItemCenter_protected (const struct KzuPresenter *presenter, kzUint itemIndex, struct KzcVector2 *out_scrollValue)
	Base implementation for bringing an item to the center. More...
kzsError	kzuPresenterUpdate_protected (const struct KzuPresenter *presenter)
	Base update implementation. More...
kzsError	kzuPresenterItemAdded_protected (const struct KzuPresenter *presenter, kzUint index, const struct KzcVector3 *newItemSize)
	Base implementation for item added callback. More...
kzsError	kzuPresenterItemRemoved_protected (const struct KzuPresenter *presenter, kzUint index, const struct KzcVector3 *oldItemSize)
	Base implementation for item removed callback. More...
kzsError	kzuPresenterItemReplaced_protected (const struct KzuPresenter *presenter, kzUint index, const struct KzcVector3 *oldItemSize, const struct KzcVector3 *newItemSize)
	Base implementation for item replaced callback. More...

Detailed Description

Defines base class for items that handle scrolling of layouts.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuPresenterCreate_protected	(	const struct KzcMemoryManager *	memoryManager,
		const struct KzuPresenterClass *	presenterClass,
		struct KzuPresenterData *	presenterData,
		struct KzuPresenter **	out_presenter
	)

Creates base for a presenter.

kzsError kzuPresenterGetItem_protected	(	const struct KzuObjectNode *	layoutObject,
		kzUint	presenterIndex,
		struct KzuObjectNode **	out_objectNode
	)

Finds the child of the layout object with the specified presenter index.

Sets out_objectNode to KZ_NULL if the child is not found.

kzsError kzuPresenterDelete_protected

(

const struct KzuPresenter *

presenter)

Base delete implementation.

kzsError kzuPresenterSnap_protected	(	const struct KzuPresenter *	presenter,
		const struct KzcVector2 *	position,
		struct KzcVector2 *	out_position,
		kzInt *	out_itemIndex
	)

Base snap implementation.

Sets snapping position to original target position and item index to -1.

kzsError kzuPresenterSetScroll_protected	(	const struct KzuPresenter *	presenter,
		const struct KzcVector2 *	scroll
	)

Base set scroll implementation.

Does nothing.

kzsError kzuPresenterGetScrollBounds_protected	(	const struct KzuPresenter *	presenter,
		kzFloat *	out_scrollMinimumX,
		kzFloat *	out_scrollMaximumX,
		kzFloat *	out_scrollMinimumY,
		kzFloat *	out_scrollMaximumY
	)

Base get scroll bounds implementation.

Does not limit scrolling.

kzsError kzuPresenterBringItemCenter_protected	(	const struct KzuPresenter *	presenter,
		kzUint	itemIndex,
		struct KzcVector2 *	out_scrollValue
	)

Base implementation for bringing an item to the center.

Outputs zero offset.

kzsError kzuPresenterUpdate_protected

(

const struct KzuPresenter *

presenter)

Base update implementation.

Does nothing.

kzsError kzuPresenterItemAdded_protected	(	const struct KzuPresenter *	presenter,
		kzUint	index,
		const struct KzcVector3 *	newItemSize
	)

Base implementation for item added callback.

Does nothing.

kzsError kzuPresenterItemRemoved_protected	(	const struct KzuPresenter *	presenter,
		kzUint	index,
		const struct KzcVector3 *	oldItemSize
	)

Base implementation for item removed callback.

Does nothing.

kzsError kzuPresenterItemReplaced_protected	(	const struct KzuPresenter *	presenter,
		kzUint	index,
		const struct KzcVector3 *	oldItemSize,
		const struct KzcVector3 *	newItemSize
	)

Base implementation for item replaced callback.

Does nothing.