Helper class for traversing children in widget tree. More...

Static Public Member Functions
static Widget *	seekWidgetByTag (Widget *root, int tag)
	Find a widget with a specific tag from root widget. More...

var	seekWidgetByTag ( var root, var tag)
	Find a widget with a specific tag from root widget. More...

local	seekWidgetByTag ( local root, local tag)
	Find a widget with a specific tag from root widget. More...

static Widget *	seekWidgetByName (Widget *root, const std::string &name)
	Find a widget with a specific name from root widget. More...

local	seekWidgetByName ( local root, local name)
	Find a widget with a specific name from root widget. More...

static Widget *	seekActionWidgetByActionTag (Widget *root, int tag)
	Find a widget with a specific action tag from root widget This search will be recursive throught all child widgets. More...

var	seekActionWidgetByActionTag ( var root, var tag)
	Find a widget with a specific action tag from root widget This search will be recursive throught all child widgets. More...

local	seekActionWidgetByActionTag ( local root, local tag)
	Find a widget with a specific action tag from root widget This search will be recursive throught all child widgets. More...

static std::string	getSubStringOfUTF8String (const std::string &str, std::string::size_type start, std::string::size_type length)
	Get a UTF8 substring from a std::string with a given start position and length Sample: std::string str = "中国中国中国"; substr = getSubStringOfUTF8String(str,0,2) will = "中国". More...

static void	doLayout (Node *rootNode)
	Refresh object and it's children layout state. More...

var	doLayout ( var rootNode)
	Refresh object and it's children layout state. More...

local	doLayout ( local rootNode)
	Refresh object and it's children layout state. More...

static void	changeLayoutSystemActiveState (bool active)
	Change the active property of Layout's. More...

var	changeLayoutSystemActiveState ( var active)
	Change the active property of Layout's. More...

local	changeLayoutSystemActiveState ( local active)
	Change the active property of Layout's. More...

static Rect	restrictCapInsetRect (const Rect &capInsets, const Size &textureSize)
	restrict capInsetSize, when the capInsets's width is larger than the textureSize, it will restrict to 0, the height goes the same way as width. More...

var	restrictCapInsetRect ( var capInsets, var textureSize)
	restrict capInsetSize, when the capInsets's width is larger than the textureSize, it will restrict to 0, the height goes the same way as width. More...

local	restrictCapInsetRect ( local capInsets, local textureSize)
	restrict capInsetSize, when the capInsets's width is larger than the textureSize, it will restrict to 0, the height goes the same way as width. More...

Detailed Description

Helper class for traversing children in widget tree.

It also provides some helper functions for layout.

Member Function Documentation

static Widget* seekWidgetByTag	(	Widget *	root,
		int	tag
	)

static

Find a widget with a specific tag from root widget.

This search will be recursive throught all child widgets.

Parameters

root	The be seached root widget.
tag	The widget tag.

Returns: Widget instance pointer.

var seekWidgetByTag	(	var	root,
		var	tag
	)

static

Find a widget with a specific tag from root widget.

This search will be recursive throught all child widgets.

Parameters

root	The be seached root widget.
tag	The widget tag.

Returns: Widget instance pointer.

local seekWidgetByTag	(	local	root,
		local	tag
	)

static

Find a widget with a specific tag from root widget.

This search will be recursive throught all child widgets.

Parameters

root	The be seached root widget.
tag	The widget tag.

Returns: Widget instance pointer.

static Widget* seekWidgetByName	(	Widget *	root,
		const std::string &	name
	)

static

Find a widget with a specific name from root widget.

This search will be recursive throught all child widgets.

Parameters

root	The be searched root widget.
name	The widget name.

Returns: Widget isntance pointer.

var seekWidgetByName	(	var	root,
		var	name
	)

static

Find a widget with a specific name from root widget.

This search will be recursive throught all child widgets.

Parameters

root	The be searched root widget.
name	The widget name.

Returns: Widget isntance pointer.

local seekWidgetByName	(	local	root,
		local	name
	)

static

Find a widget with a specific name from root widget.

This search will be recursive throught all child widgets.

Parameters

root	The be searched root widget.
name	The widget name.

Returns: Widget isntance pointer.

static Widget* seekActionWidgetByActionTag	(	Widget *	root,
		int	tag
	)

static

Find a widget with a specific action tag from root widget This search will be recursive throught all child widgets.

Parameters

root	The be searched root widget.
tag	The widget action's tag.

Returns: Widget instance pointer.

var seekActionWidgetByActionTag	(	var	root,
		var	tag
	)

static

Find a widget with a specific action tag from root widget This search will be recursive throught all child widgets.

Parameters

root	The be searched root widget.
tag	The widget action's tag.

Returns: Widget instance pointer.

local seekActionWidgetByActionTag	(	local	root,
		local	tag
	)

static

Find a widget with a specific action tag from root widget This search will be recursive throught all child widgets.

Parameters

root	The be searched root widget.
tag	The widget action's tag.

Returns: Widget instance pointer.

static std::string getSubStringOfUTF8String	(	const std::string &	str,
		std::string::size_type	start,
		std::string::size_type	length
	)

static

Get a UTF8 substring from a std::string with a given start position and length Sample: std::string str = "中国中国中国"; substr = getSubStringOfUTF8String(str,0,2) will = "中国".

Parameters

str	The source string.
start	The start position of the substring.
length	The length of the substring in UTF8 count

Returns: a UTF8 substring

local getSubStringOfUTF8String	(	local	str,
		local	start,
		local	length
	)

static

Get a UTF8 substring from a std::string with a given start position and length Sample: std::string str = "中国中国中国"; substr = getSubStringOfUTF8String(str,0,2) will = "中国".

Parameters

str	The source string.
start	The start position of the substring.
length	The length of the substring in UTF8 count

Returns: a UTF8 substring

static void doLayout ( Node * rootNode )

static

Refresh object and it's children layout state.

Parameters

rootNode A Node* or Node* descendant instance pointer.

var doLayout ( var rootNode )

static

Refresh object and it's children layout state.

Parameters

rootNode A Node* or Node* descendant instance pointer.

local doLayout ( local rootNode )

static

Refresh object and it's children layout state.

Parameters

rootNode A Node* or Node* descendant instance pointer.

static void
changeLayoutSystemActiveState ( bool active )

static

Change the active property of Layout's.

See also: LayoutComponent

Parameters

active A boolean value.

var changeLayoutSystemActiveState ( var active )

static

Change the active property of Layout's.

See also: LayoutComponent

Parameters

active A boolean value.

local changeLayoutSystemActiveState ( local active )

static

Change the active property of Layout's.

See also: LayoutComponent

Parameters

active A boolean value.

static Rect restrictCapInsetRect	(	const Rect &	capInsets,
		const Size &	textureSize
	)

static

restrict capInsetSize, when the capInsets's width is larger than the textureSize, it will restrict to 0, the height goes the same way as width.

Parameters

capInsets	A user defined capInsets.
textureSize	The size of a scale9enabled texture

Returns: a restricted capInset.

var restrictCapInsetRect	(	var	capInsets,
		var	textureSize
	)

static

restrict capInsetSize, when the capInsets's width is larger than the textureSize, it will restrict to 0, the height goes the same way as width.

Parameters

capInsets	A user defined capInsets.
textureSize	The size of a scale9enabled texture

Returns: a restricted capInset.

local restrictCapInsetRect	(	local	capInsets,
		local	textureSize
	)

static

restrict capInsetSize, when the capInsets's width is larger than the textureSize, it will restrict to 0, the height goes the same way as width.

Parameters

capInsets	A user defined capInsets.
textureSize	The size of a scale9enabled texture

Returns: a restricted capInset.

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

UIHelper.h

Static Public Member Functions

Detailed Description

Member Function Documentation