#include <CzUIWrapPanel.h>

Inheritance diagram for CzUIWrapPanel:

Public Member Functions
void	setOrientation (eCzOrientation o)
eCzOrientation	getOrientation () const
bool	setProperty (unsigned int property_name, const CzXomlProperty &data, bool delta)
	Sets the named property of the UIWrapPanel.
bool	setProperty (unsigned int property_name, const CzString &data, bool delta)
	Sets the named property of the actor.
bool	getProperty (unsigned int property_name, CzXomlProperty &prop)
	Gets the named property of the actor.
	CzUIWrapPanel ()
virtual	~CzUIWrapPanel ()
bool	Update (float dt)
	Updates this actors logic.
int	LoadFromXoml (IzXomlResource parent, bool load_children, CzXmlNode node)
	Creates an instance of this class from XML.
bool	UpdateFromAnimation (CzAnimInstance *animation)
	Updates actor property from supplied animation.
Static Public Member Functions
static void	InitClass ()
	Initialises the class.
static void	ReleaseClass ()
static bool	_setOrientation (IzXomlResource *target, const CzXomlProperty &prop, bool add)
static CzXomlProperty	_getOrientation (IzXomlResource *target)
Protected Member Functions
bool	UpdateLayout ()
	Updates the actors layout.
bool	UpdateBinding (unsigned int property_name, CzXomlVariable *var)
	Updates an actor property from the supplied XOML variable.
Protected Attributes
eCzOrientation	Orientation
	Stacking orientation.
Static Protected Attributes
static CzXomlClassDef *	UIWrapPanelClassDef = NULL

Constructor & Destructor Documentation

CzUIWrapPanel::CzUIWrapPanel ( ) [inline]

CzUIWrapPanel::~CzUIWrapPanel ( ) [virtual]

Member Function Documentation

CzXomlProperty CzUIWrapPanel::_getOrientation ( IzXomlResource * target ) [static]

bool CzUIWrapPanel::_setOrientation	(	IzXomlResource *	target,
		const CzXomlProperty &	prop,
		bool	add
	)		`[static]`

eCzOrientation CzUIWrapPanel::getOrientation ( ) const [inline]

bool CzUIWrapPanel::getProperty	(	unsigned int	property_name,
		CzXomlProperty &	prop
	)		`[virtual]`

Gets the named property of the actor.

Returns the named property of the actor. The properties value is returned in a CzXomlProperty which is a structure that contains a union of all possible property types. Note that as CzUIWrapPanel is derived from CzUIPanel, all CzUIPanel properties will also be checked against.

Parameters:

	property_name	Name of the property.
[out]	prop	The property data that.

Returns:: true if it succeeds, false if property does not exist.

Reimplemented from CzUIBase.

void CzUIWrapPanel::InitClass ( ) [static]

Initialises the class.

Sets up the classes avaiiable properties. Used by the XOML system to find, set amd get class properties.

Reimplemented from CzUIBase.

int CzUIWrapPanel::LoadFromXoml	(	IzXomlResource *	parent,
		bool	load_children,
		CzXmlNode *	node
	)		`[virtual]`

Creates an instance of this class from XML.

LoadFromXoml is the main method used by all classes that can be instantiated from XOML mark-up. This method creates an instance of this class from the supplied XML node structure specified by node. if parent is not NULL then the created instance will utilise the supplied parent to determine where it should live within the app. For example, if the parent is a scene then the actor will be placed in that scene. if the parent is another actor then this actor will be placed into the scene of the supplied actor and linked as a child to the parent actor. If load_chlldren is true then any child nodes contained within the actor will also be loaded. Note that as CzUIBase is derived from CzActorImage, CzActorImage::LoadFromXoml() will also be called to load CzActor specific properties.

Parameters:

[in]	parent	If non-null, the parent.
	load_children	true to load child nodes.
[in]	node	If non-null, the XOML markup node that defines this object

Returns:: negative value for error. if 0 then processing of further XOML will stop.

Reimplemented from CzUIBase.

void CzUIWrapPanel::ReleaseClass ( ) [static]

Reimplemented from CzUIBase.

void CzUIWrapPanel::setOrientation ( eCzOrientation o ) [inline]

bool CzUIWrapPanel::setProperty	(	unsigned int	property_name,
		const CzXomlProperty &	data,
		bool	delta
	)		`[virtual]`

Sets the named property of the UIWrapPanel.

Sets the named property of this UIWrapPanel. The properties value supplied will be converted. If delta is set to true then the existing value of the property will be added to instead of replaced.

Parameters:

	property_name	Name of the property as a string hash (faster searching).
[in]	data	The property data.
	delta	true if property should be added to instead of replaced.

Returns:: true if it succeeds, false if property does not exist.

Reimplemented from CzUIBase.

bool CzUIWrapPanel::setProperty	(	unsigned int	property_name,
		const CzString &	data,
		bool	delta
	)		`[virtual]`

Sets the named property of the actor.

Sets the named property of this actor. The properties value (data) is supplied as a string and will be converted. If delta is set to true then the existing value of the property will be added to instead of replaced. Note that as CzUIWrapPanel is derived from CzUIPanel, all CzUIPanel properties will also be checked against.

Parameters:

	property_name	Name of the property as a string hash (faster searching).
[in]	data	The property data.
	delta	true to property should be added to instead of replaced.

Returns:: true if it succeeds, false if property does not exist.

Reimplemented from CzUIBase.

bool CzUIWrapPanel::Update ( float dt ) [virtual]

Updates this actors logic.

Updates the UI actors logic, including:

Processing event actions
Processing any attached modifiers
Updating dragging state
Updating physics
Updating the attached timeline
Updating any show / hide timelines
Updating the scroller
Checking for an updating layout if dirty

This method should be overriden by derived actors to provide the UI actor specific logic.

Note that dt is used to scale actor internals that rely on time. This value enables the actor run in an environment where time (the frame rate of the device) can vary allowing animation to keep up without slowing down or speeding up when the frame rate varies.

Note that if an actor returns false then it will automatically be removed from the scene.

Parameters:

dt	The number of seconds since the app was last updated

Returns:: true if it succeeds, false if it fails.

Reimplemented from CzUIBase.

bool CzUIWrapPanel::UpdateBinding	(	unsigned int	property_name,
		CzXomlVariable *	var
	)		`[protected, virtual]`

Updates an actor property from the supplied XOML variable.

Updates a single property from the value of the bound XOML variable. Note that as CzUIWrapPanel is derived from CzUIPanel, all CzUIPanel properties will also be checked against.

Parameters:

	property_name	Name of the property.
[in,out]	var	If non-null, the variable.

Returns:: true if it succeeds, false if property does not exist.

Reimplemented from CzUIBase.

bool CzUIWrapPanel::UpdateFromAnimation ( CzAnimInstance * animation ) [virtual]

Updates actor property from supplied animation.

Updates the actors property that is specified by the supplied animation. When a timeline animation targets the property of an actor this method will be called by the animation to move the animations frame data into its target property. Note that as CzUIWrapPanel is derived from CzUIPanel, all CzUIPanel properties will also be checked against.

Parameters:

[in] animation If non-null, the animation.

Returns:: true if it succeeds, false if property does not exist.

Reimplemented from CzUIBase.

bool CzUIWrapPanel::UpdateLayout ( ) [protected, virtual]

Updates the actors layout.

Recalculates the actors layout. Used mainly by container actors to modify the layout of their child content. This method is usually overridden by a derived class in order to update the layout of its children.. See CzUIStackPanel::UpdateLayout() for a simple example.

Returns:: true if it succeeds, false if it fails.

Reimplemented from CzUIBase.

Member Data Documentation

eCzOrientation CzUIWrapPanel::Orientation [protected]

Stacking orientation.

CzXomlClassDef * CzUIWrapPanel::UIWrapPanelClassDef = NULL [static, protected]

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation