ScrollView Class Reference

Layout container for a view hierarchy that can be scrolled by the user, allowing it to be larger than the physical display. More...

Inherits Layout.

Inherited by ListView.

Public Types
enum	Direction
	ScrollView scroll direction type.
enum	EventType
	Scrollview scroll event type.
typedef std::function< void(Ref *, EventType)>	ccScrollViewCallback
	A callback which would be called when a ScrollView is scrolling.
Public Types inherited from Layout
enum	Type
	Layout type, default is ABSOLUTE.
enum	ClippingType
	Clipping Type, default is STENCIL.
enum	BackGroundColorType
	Background color type, default is NONE.
Public Types inherited from Widget
enum	FocusDirection
	Widget focus direction.
enum	PositionType
	Widget position type for layout.
enum	SizeType
	Widget size type for layout.
enum	TouchEventType
	Touch event type.
enum	TextureResType
	Texture resource type. More...
enum	BrightStyle
	Widget bright style.
typedef std::function< void(Ref *, Widget::TouchEventType)>	ccWidgetTouchCallback
	Widget touch event callback.
typedef std::function< void(Ref *)>	ccWidgetClickCallback
	Widget click event callback.
typedef std::function< void(Ref *, int)>	ccWidgetEventCallback
	Widget custom event callback. More...

Public Member Functions
	ScrollView ()
	Default constructor. More...
	new ()
	Default constructor. More...
virtual	~ScrollView ()
	Default destructor. More...
virtual void	setDirection (Direction dir)
	Changes scroll direction of scrollview. More...
var	setDirection ( var dir)
	Changes scroll direction of scrollview. More...
local	setDirection ( local dir)
	Changes scroll direction of scrollview. More...
Direction	getDirection () const
	Query scroll direction of scrollview. More...
Layout *	getInnerContainer () const
	Get inner container of scrollview. More...
void	scrollToBottom (float second, bool attenuated)
	Scroll inner container to bottom boundary of scrollview. More...
var	scrollToBottom ( var second, var attenuated)
	Scroll inner container to bottom boundary of scrollview. More...
local	scrollToBottom ( local second, local attenuated)
	Scroll inner container to bottom boundary of scrollview. More...
void	scrollToTop (float second, bool attenuated)
	Scroll inner container to top boundary of scrollview. More...
void	scrollToLeft (float second, bool attenuated)
	Scroll inner container to left boundary of scrollview. More...
void	scrollToRight (float time, bool attenuated)
	Scroll inner container to right boundary of scrollview. More...
void	scrollToTopLeft (float second, bool attenuated)
	Scroll inner container to top and left boundary of scrollview. More...
void	scrollToTopRight (float time, bool attenuated)
	Scroll inner container to top and right boundary of scrollview. More...
void	scrollToBottomLeft (float second, bool attenuated)
	Scroll inner container to bottom and left boundary of scrollview. More...
void	scrollToBottomRight (float time, bool attenuated)
	Scroll inner container to bottom and right boundary of scrollview. More...
void	scrollToPercentVertical (float percent, float second, bool attenuated)
	Scroll inner container to vertical percent position of scrollview. More...
local	scrollToPercentVertical ( local percent, local second, local attenuated)
	Scroll inner container to vertical percent position of scrollview. More...
void	scrollToPercentHorizontal (float percent, float second, bool attenuated)
	Scroll inner container to horizontal percent position of scrollview. More...
var	scrollToPercentHorizontal ( var percent, var second, var attenuated)
	Scroll inner container to horizontal percent position of scrollview. More...
local	scrollToPercentHorizontal ( local percent, local second, local attenuated)
	Scroll inner container to horizontal percent position of scrollview. More...
void	scrollToPercentBothDirection (const Vec2 &percent, float second, bool attenuated)
	Scroll inner container to both direction percent position of scrollview. More...
void	jumpToBottom ()
	Move inner container to bottom boundary of scrollview.
void	jumpToTop ()
	Move inner container to top boundary of scrollview.
var	jumpToTop ()
	Move inner container to top boundary of scrollview.
local	jumpToTop ()
	Move inner container to top boundary of scrollview.
void	jumpToLeft ()
	Move inner container to left boundary of scrollview.
var	jumpToLeft ()
	Move inner container to left boundary of scrollview.
local	jumpToLeft ()
	Move inner container to left boundary of scrollview.
void	jumpToRight ()
	Move inner container to right boundary of scrollview.
var	jumpToRight ()
	Move inner container to right boundary of scrollview.
local	jumpToRight ()
	Move inner container to right boundary of scrollview.
void	jumpToTopLeft ()
	Move inner container to top and left boundary of scrollview.
var	jumpToTopLeft ()
	Move inner container to top and left boundary of scrollview.
local	jumpToTopLeft ()
	Move inner container to top and left boundary of scrollview.
void	jumpToTopRight ()
	Move inner container to top and right boundary of scrollview.
var	jumpToTopRight ()
	Move inner container to top and right boundary of scrollview.
local	jumpToTopRight ()
	Move inner container to top and right boundary of scrollview.
void	jumpToBottomLeft ()
	Move inner container to bottom and left boundary of scrollview.
void	jumpToBottomRight ()
	Move inner container to bottom and right boundary of scrollview.
void	jumpToPercentVertical (float percent)
	Move inner container to vertical percent position of scrollview. More...
var	jumpToPercentVertical ( var percent)
	Move inner container to vertical percent position of scrollview. More...
local	jumpToPercentVertical ( local percent)
	Move inner container to vertical percent position of scrollview. More...
void	jumpToPercentHorizontal (float percent)
	Move inner container to horizontal percent position of scrollview. More...
void	jumpToPercentBothDirection (const Vec2 &percent)
	Move inner container to both direction percent position of scrollview. More...
void	setInnerContainerSize (const Size &size)
	Change inner container size of scrollview. More...
var	setInnerContainerSize ( var size)
	Change inner container size of scrollview. More...
local	setInnerContainerSize ( local size)
	Change inner container size of scrollview. More...
const Size &	getInnerContainerSize () const
	Get inner container size of scrollview. More...
var	getInnerContainerSize ()
	Get inner container size of scrollview. More...
local	getInnerContainerSize ()
	Get inner container size of scrollview. More...
void	addEventListenerScrollView (Ref *target, SEL_ScrollViewEvent selector)
	Add callback function which will be called when scrollview event triggered. More...
var	addEventListenerScrollView ( var target, var selector)
	Add callback function which will be called when scrollview event triggered. More...
local	addEventListenerScrollView ( local target, local selector)
	Add callback function which will be called when scrollview event triggered. More...
virtual void	addEventListener (const ccScrollViewCallback &callback)
	Add callback function which will be called when scrollview event triggered. More...
virtual void	addChild (Node *child) override
	Adds a child to the container with z-order as 0. More...
virtual void	addChild (Node *child, int localZOrder) override
	Adds a child to the container with a local z-order. More...
var	addChild ( var child, var localZOrder)
	Adds a child to the container with a local z-order. More...
local	addChild ( local child, local localZOrder)
	Adds a child to the container with a local z-order. More...
virtual void	addChild (Node *child, int localZOrder, int tag) override
	Adds a child to the container with z order and tag. More...
local	addChild ( local child, local localZOrder, local tag)
	Adds a child to the container with z order and tag. More...
virtual void	addChild (Node *child, int localZOrder, const std::string &name) override
	Adds a child to the container with z order and tag. More...
virtual void	removeAllChildren () override
	Removes all children from the container with a cleanup. More...
virtual void	removeAllChildrenWithCleanup (bool cleanup) override
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
local	removeAllChildrenWithCleanup ( local cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
virtual void	removeChild (Node *child, bool cleaup=true) override
	Removes a child from the container. More...
var	removeChild ( var child, var true)
	Removes a child from the container. More...
local	removeChild ( local child, local true)
	Removes a child from the container. More...
virtual Vector< Node * > &	getChildren () override
	Returns the array of the node's children. More...
local	getChildren ()
	Returns the array of the node's children. More...
virtual ssize_t	getChildrenCount () const override
	Returns the amount of children. More...
local	getChildrenCount ()
	Returns the amount of children. More...
virtual Node *	getChildByTag (int tag) const override
	Gets a child from the container with its tag. More...
var	getChildByTag ( var tag)
	Gets a child from the container with its tag. More...
local	getChildByTag ( local tag)
	Gets a child from the container with its tag. More...
virtual Node *	getChildByName (const std::string &name) const override
	Gets a child from the container with its name. More...
var	getChildByName ( var name)
	Gets a child from the container with its name. More...
local	getChildByName ( local name)
	Gets a child from the container with its name. More...
virtual bool	onTouchBegan (Touch *touch, Event *unusedEvent) override
	A callback which will be called when touch began event is issued. More...
local	onTouchBegan ( local touch, local unusedEvent)
	A callback which will be called when touch began event is issued. More...
virtual void	onTouchMoved (Touch *touch, Event *unusedEvent) override
	A callback which will be called when touch moved event is issued. More...
local	onTouchMoved ( local touch, local unusedEvent)
	A callback which will be called when touch moved event is issued. More...
virtual void	onTouchEnded (Touch *touch, Event *unusedEvent) override
	A callback which will be called when touch ended event is issued. More...
local	onTouchEnded ( local touch, local unusedEvent)
	A callback which will be called when touch ended event is issued. More...
virtual void	onTouchCancelled (Touch *touch, Event *unusedEvent) override
	A callback which will be called when touch cancelled event is issued. More...
local	onTouchCancelled ( local touch, local unusedEvent)
	A callback which will be called when touch cancelled event is issued. More...
virtual void	update (float dt) override
	Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More...
void	setBounceEnabled (bool enabled)
	Toggle bounce enabled when scroll to the edge. More...
var	setBounceEnabled ( var enabled)
	Toggle bounce enabled when scroll to the edge. More...
local	setBounceEnabled ( local enabled)
	Toggle bounce enabled when scroll to the edge. More...
bool	isBounceEnabled () const
	Query bounce state. More...
var	isBounceEnabled ()
	Query bounce state. More...
local	isBounceEnabled ()
	Query bounce state. More...
void	setInertiaScrollEnabled (bool enabled)
	Toggle whether enable scroll inertia while scrolling. More...
var	setInertiaScrollEnabled ( var enabled)
	Toggle whether enable scroll inertia while scrolling. More...
local	setInertiaScrollEnabled ( local enabled)
	Toggle whether enable scroll inertia while scrolling. More...
bool	isInertiaScrollEnabled () const
	Query inertia scroll state. More...
virtual void	setLayoutType (Type type) override
	Set layout type for scrollview. More...
var	setLayoutType ( var type)
	Set layout type for scrollview. More...
local	setLayoutType ( local type)
	Set layout type for scrollview. More...
virtual Type	getLayoutType () const override
	Get the layout type for scrollview. More...
virtual std::string	getDescription () const override
	Return the "class name" of widget.
local	getDescription ()
	Return the "class name" of widget.
virtual void	onEnter () override
	Event callback that is invoked every time when Node enters the 'stage'. More...
var	onEnter ()
	Event callback that is invoked every time when Node enters the 'stage'. More...
virtual Widget *	findNextFocusedWidget (FocusDirection direction, Widget *current) override
	When a widget is in a layout, you could call this method to get the next focused widget within a specified direction. More...
Public Member Functions inherited from Layout
	Layout ()
	Default constructor. More...
virtual	~Layout ()
	Default destructor. More...
void	setBackGroundImage (const std::string &fileName, TextureResType texType=TextureResType::LOCAL)
	Sets a background image for layout. More...
var	setBackGroundImage ( var fileName, var LOCAL)
	Sets a background image for layout. More...
local	setBackGroundImage ( local fileName, local LOCAL)
	Sets a background image for layout. More...
void	setBackGroundImageCapInsets (const Rect &capInsets)
	Sets a background image capinsets for layout, it only affects the scale9 enabled background image. More...
local	setBackGroundImageCapInsets ( local capInsets)
	Sets a background image capinsets for layout, it only affects the scale9 enabled background image. More...
const Rect &	getBackGroundImageCapInsets () const
	Query background image's capInsets size. More...
var	getBackGroundImageCapInsets ()
	Query background image's capInsets size. More...
local	getBackGroundImageCapInsets ()
	Query background image's capInsets size. More...
void	setBackGroundColorType (BackGroundColorType type)
	Sets Color Type for layout's background. More...
local	setBackGroundColorType ( local type)
	Sets Color Type for layout's background. More...
BackGroundColorType	getBackGroundColorType () const
	Query the layout's background color type. More...
var	getBackGroundColorType ()
	Query the layout's background color type. More...
local	getBackGroundColorType ()
	Query the layout's background color type. More...
void	setBackGroundImageScale9Enabled (bool enabled)
	Enable background image scale9 rendering. More...
bool	isBackGroundImageScale9Enabled () const
	Query background image scale9 enable status. More...
var	isBackGroundImageScale9Enabled ()
	Query background image scale9 enable status. More...
local	isBackGroundImageScale9Enabled ()
	Query background image scale9 enable status. More...
void	setBackGroundColor (const Color3B &color)
	Set background color for layout The color only applies to layout when it's color type is BackGroundColorType::SOLIDE. More...
const Color3B &	getBackGroundColor () const
	Query the layout's background color. More...
var	getBackGroundColor ()
	Query the layout's background color. More...
local	getBackGroundColor ()
	Query the layout's background color. More...
void	setBackGroundColor (const Color3B &startColor, const Color3B &endColor)
	Set start and end background color for layout. More...
const Color3B &	getBackGroundStartColor () const
	Get the gradient background start color. More...
var	getBackGroundStartColor ()
	Get the gradient background start color. More...
local	getBackGroundStartColor ()
	Get the gradient background start color. More...
const Color3B &	getBackGroundEndColor () const
	Get the gradient background end color. More...
var	getBackGroundEndColor ()
	Get the gradient background end color. More...
local	getBackGroundEndColor ()
	Get the gradient background end color. More...
void	setBackGroundColorOpacity (GLubyte opacity)
	Sets background color opacity of layout. More...
local	setBackGroundColorOpacity ( local opacity)
	Sets background color opacity of layout. More...
GLubyte	getBackGroundColorOpacity () const
	Get the layout's background color opacity. More...
var	getBackGroundColorOpacity ()
	Get the layout's background color opacity. More...
local	getBackGroundColorOpacity ()
	Get the layout's background color opacity. More...
void	setBackGroundColorVector (const Vec2 &vector)
	Sets background color vector for layout. More...
var	setBackGroundColorVector ( var vector)
	Sets background color vector for layout. More...
local	setBackGroundColorVector ( local vector)
	Sets background color vector for layout. More...
const Vec2 &	getBackGroundColorVector () const
	Get the layout's background color vector. More...
var	getBackGroundColorVector ()
	Get the layout's background color vector. More...
local	getBackGroundColorVector ()
	Get the layout's background color vector. More...
void	setBackGroundImageColor (const Color3B &color)
	Set layout's background image color. More...
var	setBackGroundImageColor ( var color)
	Set layout's background image color. More...
local	setBackGroundImageColor ( local color)
	Set layout's background image color. More...
void	setBackGroundImageOpacity (GLubyte opacity)
	Set opacity of background image. More...
var	setBackGroundImageOpacity ( var opacity)
	Set opacity of background image. More...
local	setBackGroundImageOpacity ( local opacity)
	Set opacity of background image. More...
const Color3B &	getBackGroundImageColor () const
	Get color of layout's background image. More...
GLubyte	getBackGroundImageOpacity () const
	Get the opacity of layout's background image. More...
var	getBackGroundImageOpacity ()
	Get the opacity of layout's background image. More...
local	getBackGroundImageOpacity ()
	Get the opacity of layout's background image. More...
void	removeBackGroundImage ()
	Remove the background image of layout.
var	removeBackGroundImage ()
	Remove the background image of layout.
local	removeBackGroundImage ()
	Remove the background image of layout.
const Size &	getBackGroundImageTextureSize () const
	Gets background image texture size. More...
var	getBackGroundImageTextureSize ()
	Gets background image texture size. More...
local	getBackGroundImageTextureSize ()
	Gets background image texture size. More...
virtual void	setClippingEnabled (bool enabled)
	Toggle layout clipping. More...
var	setClippingEnabled ( var enabled)
	Toggle layout clipping. More...
local	setClippingEnabled ( local enabled)
	Toggle layout clipping. More...
void	setClippingType (ClippingType type)
	Change the clipping type of layout. More...
ClippingType	getClippingType () const
var	getClippingType ()
local	getClippingType ()
virtual bool	isClippingEnabled () const
	Gets if layout is clipping enabled. More...
local	isClippingEnabled ()
	Gets if layout is clipping enabled. More...
virtual void	visit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags) override
	Visits this node's children and draw them recursively. More...
virtual void	forceDoLayout ()
	force refresh widget layout
void	requestDoLayout ()
	request to refresh widget layout
var	requestDoLayout ()
	request to refresh widget layout
local	requestDoLayout ()
	request to refresh widget layout
virtual void	onExit () override
	Event callback that is invoked every time the Node leaves the 'stage'. More...
void	setLoopFocus (bool loop)
	If a layout is loop focused which means that the focus movement will be inside the layout. More...
bool	isLoopFocus () const
void	setPassFocusToChild (bool pass)
bool	isPassFocusToChild () const
var	isPassFocusToChild ()
local	isPassFocusToChild ()
Public Member Functions inherited from Widget
	Widget (void)
	Default constructor. More...
	ctor ()
	Default constructor. More...
	new ()
	Default constructor. More...
virtual	~Widget ()
	Default destructor. More...
virtual void	setEnabled (bool enabled)
	Sets whether the widget is enabled. More...
local	setEnabled ( local enabled)
	Sets whether the widget is enabled. More...
bool	isEnabled () const
	Determines if the widget is enabled or not. More...
void	setBright (bool bright)
	Sets whether the widget is bright. More...
var	setBright ( var bright)
	Sets whether the widget is bright. More...
local	setBright ( local bright)
	Sets whether the widget is bright. More...
bool	isBright () const
	Determines if the widget is bright. More...
virtual void	setTouchEnabled (bool enabled)
	Sets whether the widget is touch enabled. More...
local	setTouchEnabled ( local enabled)
	Sets whether the widget is touch enabled. More...
void	setBrightStyle (BrightStyle style)
	To set the bright style of widget. More...
bool	isTouchEnabled () const
	Determines if the widget is touch enabled. More...
bool	isHighlighted () const
	Determines if the widget is highlighted. More...
void	setHighlighted (bool hilight)
	Sets whether the widget is hilighted. More...
var	setHighlighted ( var hilight)
	Sets whether the widget is hilighted. More...
local	setHighlighted ( local hilight)
	Sets whether the widget is hilighted. More...
float	getLeftInParent ()
	Gets the left boundary position of this widget in parent's coordination system. More...
float	getLeftBoundary () const
	Gets the left boundary position of this widget in parent's coordination system. More...
float	getBottomInParent ()
	Gets the bottom boundary position of this widget in parent's coordination system. More...
var	getBottomInParent ()
	Gets the bottom boundary position of this widget in parent's coordination system. More...
local	getBottomInParent ()
	Gets the bottom boundary position of this widget in parent's coordination system. More...
float	getBottomBoundary () const
	Gets the bottom boundary position of this widget in parent's coordination system. More...
float	getRightInParent ()
	Gets the right boundary position of this widget in parent's coordination system. More...
var	getRightInParent ()
	Gets the right boundary position of this widget in parent's coordination system. More...
local	getRightInParent ()
	Gets the right boundary position of this widget in parent's coordination system. More...
float	getRightBoundary () const
	Gets the right boundary position of this widget in parent's coordination system. More...
float	getTopInParent ()
	Gets the top boundary position of this widget in parent's coordination system. More...
float	getTopBoundary () const
	Gets the top boundary position of this widget in parent's coordination system. More...
void	addTouchEventListener (Ref *target, SEL_TouchEvent selector)
	Sets the touch event target/selector to the widget.
var	addTouchEventListener ( var target, var selector)
	Sets the touch event target/selector to the widget.
local	addTouchEventListener ( local target, local selector)
	Sets the touch event target/selector to the widget.
void	addTouchEventListener (const ccWidgetTouchCallback &callback)
	Set a callback to touch vent listener. More...
void	addClickEventListener (const ccWidgetClickCallback &callback)
	Set a click event handler to the widget. More...
virtual void	addCCSEventListener (const ccWidgetEventCallback &callback)
	Set a event handler to the widget in order to use cocostudio editor and framework. More...
virtual void	setPosition (const Vec2 &pos) override
	Changes the position (x,y) of the widget in OpenGL coordinates. More...
void	setPositionPercent (const Vec2 &percent)
	Set the percent(x,y) of the widget in OpenGL coordinates. More...
const Vec2 &	getPositionPercent ()
	Gets the percent (x,y) of the widget in OpenGL coordinates. More...
void	setPositionType (PositionType type)
	Changes the position type of the widget. More...
PositionType	getPositionType () const
	Gets the position type of the widget. More...
virtual void	setFlippedX (bool flippedX)
	Sets whether the widget should be flipped horizontally or not. More...
local	setFlippedX ( local flippedX)
	Sets whether the widget should be flipped horizontally or not. More...
virtual bool	isFlippedX () const
	Returns the flag which indicates whether the widget is flipped horizontally or not. More...
virtual void	setFlippedY (bool flippedY)
	Sets whether the widget should be flipped vertically or not. More...
var	setFlippedY ( var flippedY)
	Sets whether the widget should be flipped vertically or not. More...
local	setFlippedY ( local flippedY)
	Sets whether the widget should be flipped vertically or not. More...
virtual bool	isFlippedY () const
	Return the flag which indicates whether the widget is flipped vertically or not. More...
bool	isFlipX ()
void	setFlipX (bool flipX)
bool	isFlipY ()
local	isFlipY ()
void	setFlipY (bool flipY)
var	setFlipY ( var flipY)
local	setFlipY ( local flipY)
virtual void	setScaleX (float scaleX) override
	Sets the scale (x) of the node. More...
var	setScaleX ( var scaleX)
	Sets the scale (x) of the node. More...
local	setScaleX ( local scaleX)
	Sets the scale (x) of the node. More...
virtual void	setScaleY (float scaleY) override
	Sets the scale (y) of the node. More...
var	setScaleY ( var scaleY)
	Sets the scale (y) of the node. More...
local	setScaleY ( local scaleY)
	Sets the scale (y) of the node. More...
virtual void	setScale (float scale) override
	Sets the scale (x,y,z) of the node. More...
var	setScale ( var scale)
	Sets the scale (x,y,z) of the node. More...
local	setScale ( local scale)
	Sets the scale (x,y,z) of the node. More...
virtual void	setScale (float scalex, float scaley) override
	Sets the scale (x,y) of the node. More...
virtual float	getScaleX () const override
	Returns the scale factor on X axis of this node. More...
var	getScaleX ()
	Returns the scale factor on X axis of this node. More...
local	getScaleX ()
	Returns the scale factor on X axis of this node. More...
virtual float	getScaleY () const override
	Returns the scale factor on Y axis of this node. More...
var	getScaleY ()
	Returns the scale factor on Y axis of this node. More...
local	getScaleY ()
	Returns the scale factor on Y axis of this node. More...
virtual float	getScale () const override
	Gets the scale factor of the node, when X and Y have the same scale factor. More...
var	getScale ()
	Gets the scale factor of the node, when X and Y have the same scale factor. More...
local	getScale ()
	Gets the scale factor of the node, when X and Y have the same scale factor. More...
bool	clippingParentAreaContainPoint (const Vec2 &pt)
	Checks a point if in parent's area. More...
var	clippingParentAreaContainPoint ( var pt)
	Checks a point if in parent's area. More...
local	clippingParentAreaContainPoint ( local pt)
	Checks a point if in parent's area. More...
bool	isClippingParentContainsPoint (const Vec2 &pt)
	Checks a point if in parent's area. More...
local	isClippingParentContainsPoint ( local pt)
	Checks a point if in parent's area. More...
const Vec2 &	getTouchStartPos () const
	Gets the touch began point of widget when widget is selected. More...
local	getTouchStartPos ()
	Gets the touch began point of widget when widget is selected. More...
const Vec2 &	getTouchBeganPosition () const
	Gets the touch began point of widget when widget is selected. More...
virtual void	setSize (const Size &size)
	Changes the size that is widget's size. More...
var	setSize ( var size)
	Changes the size that is widget's size. More...
local	setSize ( local size)
	Changes the size that is widget's size. More...
virtual void	setContentSize (const Size &contentSize) override
	Changes the size that is widget's size. More...
var	setContentSize ( var contentSize)
	Changes the size that is widget's size. More...
local	setContentSize ( local contentSize)
	Changes the size that is widget's size. More...
virtual void	setSizePercent (const Vec2 &percent)
	Changes the percent that is widget's percent size. More...
local	setSizePercent ( local percent)
	Changes the percent that is widget's percent size. More...
void	setSizeType (SizeType type)
	Changes the size type of widget. More...
SizeType	getSizeType () const
	Gets the size type of widget. More...
var	getSizeType ()
	Gets the size type of widget. More...
local	getSizeType ()
	Gets the size type of widget. More...
const Size &	getSize () const
	Get the size of widget. More...
var	getSize ()
	Get the size of widget. More...
local	getSize ()
	Get the size of widget. More...
const Size &	getCustomSize () const
	Get the user defined widget size. More...
var	getCustomSize ()
	Get the user defined widget size. More...
local	getCustomSize ()
	Get the user defined widget size. More...
virtual const Size &	getLayoutSize ()
	Get the content size of widget. More...
const Vec2 &	getSizePercent ()
	Get size percent of widget. More...
virtual bool	hitTest (const Vec2 &pt)
	Checks a point is in widget's content space. More...
var	hitTest ( var pt)
	Checks a point is in widget's content space. More...
local	hitTest ( local pt)
	Checks a point is in widget's content space. More...
void	setLayoutParameter (LayoutParameter *parameter)
	Sets a LayoutParameter to widget. More...
LayoutParameter *	getLayoutParameter () const override
	Gets LayoutParameter of widget. More...
var	getLayoutParameter ()
	Gets LayoutParameter of widget. More...
local	getLayoutParameter ()
	Gets LayoutParameter of widget. More...
LayoutParameter *	getLayoutParameter (LayoutParameter::Type type)
	Gets LayoutParameter of widget. More...
local	getLayoutParameter ( local type)
	Gets LayoutParameter of widget. More...
virtual void	ignoreContentAdaptWithSize (bool ignore)
	Toggle whether ignore user defined content size for widget. More...
bool	isIgnoreContentAdaptWithSize () const
	Query whether the widget ignores user deinfed content size or not. More...
Vec2	getWorldPosition () const
	Gets position of widget in world space. More...
virtual Node *	getVirtualRenderer ()
	Gets the inner Renderer node of widget. More...
virtual Size	getVirtualRendererSize () const
	Get the virtual renderer's size. More...
Widget *	clone ()
	Create a new widget copy of the original one. More...
var	clone ()
	Create a new widget copy of the original one. More...
local	clone ()
	Create a new widget copy of the original one. More...
void	updateSizeAndPosition ()
	Update all children's contents size and position recursively. More...
var	updateSizeAndPosition ()
	Update all children's contents size and position recursively. More...
local	updateSizeAndPosition ()
	Update all children's contents size and position recursively. More...
void	updateSizeAndPosition (const Size &parentSize)
	Update all children's contents size and position recursively.
var	updateSizeAndPosition ( var parentSize)
	Update all children's contents size and position recursively.
local	updateSizeAndPosition ( local parentSize)
	Update all children's contents size and position recursively.
void	setActionTag (int tag)
	Set the tag of action. More...
var	setActionTag ( var tag)
	Set the tag of action. More...
local	setActionTag ( local tag)
	Set the tag of action. More...
int	getActionTag () const
	Get the action tag. More...
var	getActionTag ()
	Get the action tag. More...
local	getActionTag ()
	Get the action tag. More...
void	setPropagateTouchEvents (bool isPropagate)
	Allow widget touch events to propagate to its parents. More...
var	setPropagateTouchEvents ( var isPropagate)
	Allow widget touch events to propagate to its parents. More...
local	setPropagateTouchEvents ( local isPropagate)
	Allow widget touch events to propagate to its parents. More...
bool	isPropagateTouchEvents () const
	Return whether the widget is propagate touch events to its parents or not. More...
void	setSwallowTouches (bool swallow)
	Toggle widget swallow touch option. More...
var	setSwallowTouches ( var swallow)
	Toggle widget swallow touch option. More...
local	setSwallowTouches ( local swallow)
	Toggle widget swallow touch option. More...
bool	isSwallowTouches () const
	Return whether the widget is swallowing touch or not. More...
var	isSwallowTouches ()
	Return whether the widget is swallowing touch or not. More...
local	isSwallowTouches ()
	Return whether the widget is swallowing touch or not. More...
bool	isFocused () const
	Query whether widget is focused or not. More...
var	isFocused ()
	Query whether widget is focused or not. More...
local	isFocused ()
	Query whether widget is focused or not. More...
void	setFocused (bool focus)
	Toggle widget focus status. More...
bool	isFocusEnabled () const
	Query widget's focus enable state. More...
void	setFocusEnabled (bool enable)
	Allow widget to accept focus. More...
void	requestFocus ()
	when a widget calls this method, it will get focus immediately.
Widget *	getCurrentFocusedWidget (bool isWidget)
	Return a current focused widget in your UI scene. More...
local	getCurrentFocusedWidget ( local isWidget)
	Return a current focused widget in your UI scene. More...
Widget *	getCurrentFocusedWidget () const
	Return a current focused widget in your UI scene. More...
void	setUnifySizeEnabled (bool enable)
	Toggle use unify size. More...
var	setUnifySizeEnabled ( var enable)
	Toggle use unify size. More...
local	setUnifySizeEnabled ( local enable)
	Toggle use unify size. More...
bool	isUnifySizeEnabled () const
	Query whether unify size enable state. More...
void	setCallbackName (const std::string &callbackName)
	Set callback name. More...
var	setCallbackName ( var callbackName)
	Set callback name. More...
local	setCallbackName ( local callbackName)
	Set callback name. More...
const std::string &	getCallbackName () const
	Query callback name. More...
var	getCallbackName ()
	Query callback name. More...
local	getCallbackName ()
	Query callback name. More...
void	setCallbackType (const std::string &callbackType)
	Set callback type. More...
var	setCallbackType ( var callbackType)
	Set callback type. More...
local	setCallbackType ( local callbackType)
	Set callback type. More...
const std::string &	getCallbackType () const
	Query callback type. More...
void	setLayoutComponentEnabled (bool enable)
	Toggle layout component enable. More...
var	setLayoutComponentEnabled ( var enable)
	Toggle layout component enable. More...
local	setLayoutComponentEnabled ( local enable)
	Toggle layout component enable. More...
bool	isLayoutComponentEnabled () const
	Query whether layout component is enabled or not. More...
var	isLayoutComponentEnabled ()
	Query whether layout component is enabled or not. More...
local	isLayoutComponentEnabled ()
	Query whether layout component is enabled or not. More...
Public Member Functions inherited from ProtectedNode
virtual void	cleanup () override
	Stops all running actions and schedulers.
virtual void	onEnterTransitionDidFinish () override
	Event callback that is invoked when the Node enters in the 'stage'. More...
virtual void	onExitTransitionDidStart () override
	Event callback that is called every time the Node leaves the 'stage'. More...
virtual void	addProtectedChild (Node *child)
	Adds a child to the container with z-order as 0. More...
local	addProtectedChild ( local child)
	Adds a child to the container with z-order as 0. More...
virtual void	addProtectedChild (Node *child, int localZOrder)
	Adds a child to the container with a local z-order. More...
local	addProtectedChild ( local child, local localZOrder)
	Adds a child to the container with a local z-order. More...
virtual void	addProtectedChild (Node *child, int localZOrder, int tag)
	Adds a child to the container with z order and tag. More...
var	addProtectedChild ( var child, var localZOrder, var tag)
	Adds a child to the container with z order and tag. More...
local	addProtectedChild ( local child, local localZOrder, local tag)
	Adds a child to the container with z order and tag. More...
virtual Node *	getProtectedChildByTag (int tag)
	Gets a child from the container with its tag. More...
var	getProtectedChildByTag ( var tag)
	Gets a child from the container with its tag. More...
local	getProtectedChildByTag ( local tag)
	Gets a child from the container with its tag. More...
virtual void	removeProtectedChild (Node *child, bool cleanup=true)
	Removes a child from the container. More...
local	removeProtectedChild ( local child, local true)
	Removes a child from the container. More...
virtual void	removeProtectedChildByTag (int tag, bool cleanup=true)
	Removes a child from the container by tag value. More...
local	removeProtectedChildByTag ( local tag, local true)
	Removes a child from the container by tag value. More...
virtual void	removeAllProtectedChildren ()
	Removes all children from the container with a cleanup. More...
local	removeAllProtectedChildren ()
	Removes all children from the container with a cleanup. More...
virtual void	removeAllProtectedChildrenWithCleanup (bool cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
var	removeAllChildren ( var cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
local	removeAllChildren ( local cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
virtual void	reorderProtectedChild (Node *child, int localZOrder)
	Reorders a child according to a new z value. More...
var	reorderProtectedChild ( var child, var localZOrder)
	Reorders a child according to a new z value. More...
local	reorderProtectedChild ( local child, local localZOrder)
	Reorders a child according to a new z value. More...
virtual void	sortAllProtectedChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
Public Member Functions inherited from Node
virtual bool	isRunning () const
	Returns whether or not the node is "running". More...
void	scheduleUpdateWithPriorityLua (int handler, int priority)
	Schedules for lua script. More...
virtual void	draw (Renderer *renderer, const Mat4 &transform, uint32_t flags)
	Override this method to draw your own node. More...
local	draw ( local renderer, local transform, local flags)
	Override this method to draw your own node. More...
virtual Scene *	getScene () const
	Returns the Scene that contains the Node. More...
local	getScene ()
	Returns the Scene that contains the Node. More...
virtual Rect	getBoundingBox () const
	Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...
virtual Rect	boundingBox () const
local	boundingBox ()
virtual void	setEventDispatcher (EventDispatcher *dispatcher)
	Set event dispatcher for scene. More...
local	setEventDispatcher ( local dispatcher)
	Set event dispatcher for scene. More...
virtual EventDispatcher *	getEventDispatcher () const
	Get the event dispatcher of scene. More...
local	getEventDispatcher ()
	Get the event dispatcher of scene. More...
void	setPhysicsBody (PhysicsBody *body)
	Set the PhysicsBody that let the sprite effect with physics. More...
PhysicsBody *	getPhysicsBody () const
	Get the PhysicsBody the sprite have. More...
var	getPhysicsBody ()
	Get the PhysicsBody the sprite have. More...
local	getPhysicsBody ()
	Get the PhysicsBody the sprite have. More...
void	removeFromPhysicsWorld ()
	Remove this node from physics world. More...
var	removeFromPhysicsWorld ()
	Remove this node from physics world. More...
local	removeFromPhysicsWorld ()
	Remove this node from physics world. More...
void	updateTransformFromPhysics (const Mat4 &parentTransform, uint32_t parentFlags)
	Update the transform matrix from physics.
var	updateTransformFromPhysics ( var parentTransform, var parentFlags)
	Update the transform matrix from physics.
local	updateTransformFromPhysics ( local parentTransform, local parentFlags)
	Update the transform matrix from physics.
virtual void	updatePhysicsBodyTransform (const Mat4 &parentTransform, uint32_t parentFlags, float parentScaleX, float parentScaleY)
	Update physics body transform matrix.
var	updatePhysicsBodyTransform ( var parentTransform, var parentFlags, var parentScaleX, var parentScaleY)
	Update physics body transform matrix.
local	updatePhysicsBodyTransform ( local parentTransform, local parentFlags, local parentScaleX, local parentScaleY)
	Update physics body transform matrix.
unsigned short	getCameraMask () const
	get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true
virtual void	setLocalZOrder (int localZOrder)
	LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
virtual void	setZOrder (int localZOrder)
virtual void	_setLocalZOrder (int z)
var	_setLocalZOrder ( var z)
local	_setLocalZOrder ( local z)
virtual int	getLocalZOrder () const
	Gets the local Z order of this node. More...
var	getLocalZOrder ()
	Gets the local Z order of this node. More...
local	getLocalZOrder ()
	Gets the local Z order of this node. More...
virtual int	getZOrder () const
virtual void	setGlobalZOrder (float globalZOrder)
	Defines the oder in which the nodes are renderer. More...
local	setGlobalZOrder ( local globalZOrder)
	Defines the oder in which the nodes are renderer. More...
virtual float	getGlobalZOrder () const
	Returns the Node's Global Z Order. More...
var	getGlobalZOrder ()
	Returns the Node's Global Z Order. More...
local	getGlobalZOrder ()
	Returns the Node's Global Z Order. More...
virtual void	setScaleZ (float scaleZ)
	Changes the scale factor on Z axis of this node. More...
var	setScaleZ ( var scaleZ)
	Changes the scale factor on Z axis of this node. More...
local	setScaleZ ( local scaleZ)
	Changes the scale factor on Z axis of this node. More...
virtual float	getScaleZ () const
	Returns the scale factor on Z axis of this node. More...
virtual void	setNormalizedPosition (const Vec2 &position)
	Sets the position (x,y) using values between 0 and 1. More...
var	setNormalizedPosition ( var position)
	Sets the position (x,y) using values between 0 and 1. More...
local	setNormalizedPosition ( local position)
	Sets the position (x,y) using values between 0 and 1. More...
virtual const Vec2 &	getPosition () const
	Gets the position (x,y) of the node in its parent's coordinate system. More...
virtual const Vec2 &	getNormalizedPosition () const
	Returns the normalized position. More...
local	getNormalizedPosition ()
	Returns the normalized position. More...
virtual void	setPosition (float x, float y)
	Sets the position (x,y) of the node in its parent's coordinate system. More...
var	setPosition ( var x, var y)
	Sets the position (x,y) of the node in its parent's coordinate system. More...
local	setPosition ( local x, local y)
	Sets the position (x,y) of the node in its parent's coordinate system. More...
virtual void	getPosition (float *x, float *y) const
	Gets position in a more efficient way, returns two number instead of a Vec2 object. More...
virtual void	setPositionX (float x)
	Gets/Sets x or y coordinate individually for position. More...
virtual float	getPositionX (void) const
	Gets the x coordinate of the node in its parent's coordinate system. More...
virtual void	setPositionY (float y)
	Sets the y coordinate of the node in its parent's coordinate system. More...
virtual float	getPositionY (void) const
	Gets the y coordinate of the node in its parent's coordinate system. More...
virtual void	setPosition3D (const Vec3 &position)
	Sets the position (X, Y, and Z) in its parent's coordinate system. More...
virtual Vec3	getPosition3D () const
	Returns the position (X,Y,Z) in its parent's coordinate system. More...
virtual void	setPositionZ (float positionZ)
	Sets the 'z' coordinate in the position. More...
var	setVertexZ ( var positionZ)
	Sets the 'z' coordinate in the position. More...
local	setPositionZ ( local positionZ)
	Sets the 'z' coordinate in the position. More...
virtual void	setVertexZ (float vertexZ)
var	setVertexZ ( var vertexZ)
local	setVertexZ ( local vertexZ)
virtual float	getPositionZ () const
	Gets position Z coordinate of this node. More...
var	getVertexZ ()
	Gets position Z coordinate of this node. More...
local	getPositionZ ()
	Gets position Z coordinate of this node. More...
virtual float	getVertexZ () const
virtual void	setSkewX (float skewX)
	Changes the X skew angle of the node in degrees. More...
local	setSkewX ( local skewX)
	Changes the X skew angle of the node in degrees. More...
virtual float	getSkewX () const
	Returns the X skew angle of the node in degrees. More...
var	getSkewX ()
	Returns the X skew angle of the node in degrees. More...
local	getSkewX ()
	Returns the X skew angle of the node in degrees. More...
virtual void	setSkewY (float skewY)
	Changes the Y skew angle of the node in degrees. More...
var	setSkewY ( var skewY)
	Changes the Y skew angle of the node in degrees. More...
local	setSkewY ( local skewY)
	Changes the Y skew angle of the node in degrees. More...
virtual float	getSkewY () const
	Returns the Y skew angle of the node in degrees. More...
var	getSkewY ()
	Returns the Y skew angle of the node in degrees. More...
local	getSkewY ()
	Returns the Y skew angle of the node in degrees. More...
virtual void	setAnchorPoint (const Vec2 &anchorPoint)
	Sets the anchor point in percent. More...
local	setAnchorPoint ( local anchorPoint)
	Sets the anchor point in percent. More...
virtual const Vec2 &	getAnchorPoint () const
	Returns the anchor point in percent. More...
local	getAnchorPoint ()
	Returns the anchor point in percent. More...
virtual const Vec2 &	getAnchorPointInPoints () const
	Returns the anchorPoint in absolute pixels. More...
local	getAnchorPointInPoints ()
	Returns the anchorPoint in absolute pixels. More...
virtual const Size &	getContentSize () const
	Returns the untransformed size of the node. More...
local	getContentSize ()
	Returns the untransformed size of the node. More...
virtual void	setVisible (bool visible)
	Sets whether the node is visible. More...
local	setVisible ( local visible)
	Sets whether the node is visible. More...
virtual bool	isVisible () const
	Determines if the node is visible. More...
virtual void	setRotation (float rotation)
	Sets the rotation (angle) of the node in degrees. More...
local	setRotation ( local rotation)
	Sets the rotation (angle) of the node in degrees. More...
virtual float	getRotation () const
	Returns the rotation of the node in degrees. More...
virtual void	setRotation3D (const Vec3 &rotation)
	Sets the rotation (X,Y,Z) in degrees. More...
local	setRotation3D ( local rotation)
	Sets the rotation (X,Y,Z) in degrees. More...
virtual Vec3	getRotation3D () const
	Returns the rotation (X,Y,Z) in degrees. More...
virtual void	setRotationQuat (const Quaternion &quat)
	Set rotation by quaternion. More...
local	setRotationQuat ( local quat)
	Set rotation by quaternion. More...
virtual Quaternion	getRotationQuat () const
	Return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, it equals to RotationY * RotationX otherwise. More...
virtual void	setRotationSkewX (float rotationX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
local	setRotationSkewX ( local rotationX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
virtual void	setRotationX (float rotationX)
var	setRotationX ( var rotationX)
local	setRotationX ( local rotationX)
virtual float	getRotationSkewX () const
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
var	getRotationX ()
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
local	getRotationSkewX ()
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
virtual float	getRotationX () const
var	getRotationX ()
local	getRotationX ()
virtual void	setRotationSkewY (float rotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
local	setRotationSkewY ( local rotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
virtual void	setRotationY (float rotationY)
local	setRotationY ( local rotationY)
virtual float	getRotationSkewY () const
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
local	getRotationSkewY ()
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
virtual float	getRotationY () const
void	setOrderOfArrival (int orderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...
int	getOrderOfArrival () const
	Returns the arrival order, indicates which children is added previously. More...
void	setGLServerState (int serverState)
var	setGLServerState ( var serverState)
int	getGLServerState () const
virtual void	ignoreAnchorPointForPosition (bool ignore)
	Sets whether the anchor point will be (0,0) when you position this node. More...
virtual bool	isIgnoreAnchorPointForPosition () const
	Gets whether the anchor point will be (0,0) when you position this node. More...
template<typename T >
T	getChildByName (const std::string &name) const
	Gets a child from the container with its name that can be cast to Type T. More...
virtual void	enumerateChildren (const std::string &name, std::function< bool(Node *node)> callback) const
	Search the children of the receiving node to perform processing for nodes which share a name. More...
virtual void	setParent (Node *parent)
	Sets the parent node. More...
local	setParent ( local parent)
	Sets the parent node. More...
virtual Node *	getParent ()
	Returns a pointer to the parent node. More...
virtual const Node *	getParent () const
virtual void	removeFromParent ()
	Removes this node itself from its parent node with a cleanup. More...
virtual void	removeFromParentAndCleanup (bool cleanup)
	Removes this node itself from its parent node. More...
local	removeFromParent ( local cleanup)
	Removes this node itself from its parent node. More...
virtual void	removeChildByTag (int tag, bool cleanup=true)
	Removes a child from the container by tag value. More...
local	removeChildByTag ( local tag, local true)
	Removes a child from the container by tag value. More...
virtual void	removeChildByName (const std::string &name, bool cleanup=true)
	Removes a child from the container by tag value. More...
var	removeChildByName ( var name, var true)
	Removes a child from the container by tag value. More...
local	removeChildByName ( local name, local true)
	Removes a child from the container by tag value. More...
virtual void	reorderChild (Node *child, int localZOrder)
	Reorders a child according to a new z value. More...
local	reorderChild ( local child, local localZOrder)
	Reorders a child according to a new z value. More...
virtual void	sortAllChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
virtual int	getTag () const
	Returns a tag that is used to identify the node easily. More...
virtual void	setTag (int tag)
	Changes the tag that is used to identify the node easily. More...
local	setTag ( local tag)
	Changes the tag that is used to identify the node easily. More...
virtual std::string	getName () const
	Returns a string that is used to identify the node. More...
local	getName ()
	Returns a string that is used to identify the node. More...
virtual void	setName (const std::string &name)
	Changes the name that is used to identify the node easily. More...
var	setName ( var name)
	Changes the name that is used to identify the node easily. More...
local	setName ( local name)
	Changes the name that is used to identify the node easily. More...
virtual void *	getUserData ()
	Returns a custom user data pointer. More...
virtual const void *	getUserData () const
virtual void	setUserData (void *userData)
	Sets a custom user data pointer. More...
virtual Ref *	getUserObject ()
	Returns a user assigned Object. More...
virtual const Ref *	getUserObject () const
virtual void	setUserObject (Ref *userObject)
	Returns a user assigned Object. More...
local	setUserObject ( local userObject)
	Returns a user assigned Object. More...
GLProgram *	getGLProgram () const
	Return the GLProgram (shader) currently used for this node. More...
var	getGLProgram ()
	Return the GLProgram (shader) currently used for this node. More...
local	getGLProgram ()
	Return the GLProgram (shader) currently used for this node. More...
GLProgram *	getShaderProgram () const
var	getShaderProgram ()
local	getShaderProgram ()
virtual void	setGLProgram (GLProgram *glprogram)
	Sets the shader program for this node. More...
var	setGLProgram ( var glprogram)
	Sets the shader program for this node. More...
local	setGLProgram ( local glprogram)
	Sets the shader program for this node. More...
void	setShaderProgram (GLProgram *glprogram)
var	setShaderProgram ( var glprogram)
local	setShaderProgram ( local glprogram)
GLProgramState *	getGLProgramState () const
	Return the GLProgramState currently used for this node. More...
var	getGLProgramState ()
	Return the GLProgramState currently used for this node. More...
local	getGLProgramState ()
	Return the GLProgramState currently used for this node. More...
virtual void	setGLProgramState (GLProgramState *glProgramState)
	Set the GLProgramState for this node. More...
var	setGLProgramState ( var glProgramState)
	Set the GLProgramState for this node. More...
local	setGLProgramState ( local glProgramState)
	Set the GLProgramState for this node. More...
virtual void	setActionManager (ActionManager *actionManager)
	Sets the ActionManager object that is used by all actions. More...
var	setActionManager ( var actionManager)
	Sets the ActionManager object that is used by all actions. More...
local	setActionManager ( local actionManager)
	Sets the ActionManager object that is used by all actions. More...
virtual ActionManager *	getActionManager ()
	Gets the ActionManager object that is used by all actions. More...
local	getActionManager ()
	Gets the ActionManager object that is used by all actions. More...
virtual const ActionManager *	getActionManager () const
virtual Action *	runAction (Action *action)
	Executes an action, and returns the action that is executed. More...
local	runAction ( local action)
	Executes an action, and returns the action that is executed. More...
void	stopAllActions ()
	Stops and removes all actions from the running action list .
void	stopAction (Action *action)
	Stops and removes an action from the running action list. More...
var	stopAction ( var action)
	Stops and removes an action from the running action list. More...
local	stopAction ( local action)
	Stops and removes an action from the running action list. More...
void	stopActionByTag (int tag)
	Removes an action from the running action list by its tag. More...
var	stopActionByTag ( var tag)
	Removes an action from the running action list by its tag. More...
local	stopActionByTag ( local tag)
	Removes an action from the running action list by its tag. More...
void	stopAllActionsByTag (int tag)
	Removes all actions from the running action list by its tag. More...
var	stopAllActionsByTag ( var tag)
	Removes all actions from the running action list by its tag. More...
local	stopAllActionsByTag ( local tag)
	Removes all actions from the running action list by its tag. More...
Action *	getActionByTag (int tag)
	Gets an action from the running action list by its tag. More...
ssize_t	getNumberOfRunningActions () const
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
local	getNumberOfRunningActions ()
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
ssize_t	numberOfRunningActions () const
var	numberOfRunningActions ()
local	numberOfRunningActions ()
virtual void	setScheduler (Scheduler *scheduler)
	Sets a Scheduler object that is used to schedule all "updates" and timers. More...
virtual Scheduler *	getScheduler ()
	Gets a Sheduler object. More...
local	getScheduler ()
	Gets a Sheduler object. More...
virtual const Scheduler *	getScheduler () const
bool	isScheduled (SEL_SCHEDULE selector)
	Checks whether a selector is scheduled. More...
bool	isScheduled (const std::string &key)
	Checks whether a lambda function is scheduled. More...
void	scheduleUpdate (void)
	Schedules the "update" method. More...
void	scheduleUpdateWithPriority (int priority)
	Schedules the "update" method with a custom priority. More...
var	scheduleUpdateWithPriority ( var priority)
	Schedules the "update" method with a custom priority. More...
void	unscheduleUpdate (void)
var	unscheduleUpdate ()
local	unscheduleUpdate ()
void	schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
	Schedules a custom selector. More...
void	schedule (SEL_SCHEDULE selector, float interval)
	Schedules a custom selector with an interval time in seconds. More...
void	scheduleOnce (SEL_SCHEDULE selector, float delay)
	Schedules a selector that runs only once, with a delay of 0 or larger. More...
var	scheduleOnce ( var selector, var delay)
	Schedules a selector that runs only once, with a delay of 0 or larger. More...
void	scheduleOnce (const std::function< void(float)> &callback, float delay, const std::string &key)
	Schedules a lambda function that runs only once, with a delay of 0 or larger. More...
void	schedule (SEL_SCHEDULE selector)
	Schedules a custom selector, the scheduled selector will be ticked every frame. More...
void	schedule (const std::function< void(float)> &callback, const std::string &key)
	Schedules a lambda function. More...
void	schedule (const std::function< void(float)> &callback, float interval, const std::string &key)
	Schedules a lambda function. More...
void	schedule (const std::function< void(float)> &callback, float interval, unsigned int repeat, float delay, const std::string &key)
	Schedules a lambda function. More...
var	schedule ( var callback, var interval, var repeat, var delay, var key)
	Schedules a lambda function. More...
void	unschedule (SEL_SCHEDULE selector)
	Unschedules a custom selector. More...
var	unschedule ( var selector)
	Unschedules a custom selector. More...
void	unschedule (const std::string &key)
	Unschedules a lambda function. More...
void	unscheduleAllCallbacks ()
	Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions. More...
void	unscheduleAllSelectors ()
var	unscheduleAllSelectors ()
local	unscheduleAllSelectors ()
virtual void	resume (void)
	Resumes all scheduled selectors, actions and event listeners. More...
local	resume ()
	Resumes all scheduled selectors, actions and event listeners. More...
virtual void	pause (void)
	Pauses all scheduled selectors, actions and event listeners. More...
local	pause ()
	Pauses all scheduled selectors, actions and event listeners. More...
void	resumeSchedulerAndActions ()
	Resumes all scheduled selectors, actions and event listeners. More...
void	pauseSchedulerAndActions ()
	Pauses all scheduled selectors, actions and event listeners. More...
var	pauseSchedulerAndActions ()
	Pauses all scheduled selectors, actions and event listeners. More...
local	pauseSchedulerAndActions ()
	Pauses all scheduled selectors, actions and event listeners. More...
virtual void	updateTransform ()
	Calls children's updateTransform() method recursively. More...
var	updateTransform ()
	Calls children's updateTransform() method recursively. More...
local	updateTransform ()
	Calls children's updateTransform() method recursively. More...
virtual const Mat4 &	getNodeToParentTransform () const
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
virtual AffineTransform	getNodeToParentAffineTransform () const
local	getNodeToParentAffineTransform ()
virtual void	setNodeToParentTransform (const Mat4 &transform)
	Sets the transformation matrix manually. More...
virtual AffineTransform	nodeToParentTransform () const
local	nodeToParentTransform ()
virtual const Mat4 &	getParentToNodeTransform () const
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
var	getParentToNodeTransform ()
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
local	getParentToNodeTransform ()
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
virtual AffineTransform	getParentToNodeAffineTransform () const
local	getParentToNodeAffineTransform ()
virtual AffineTransform	parentToNodeTransform () const
local	parentToNodeTransform ()
virtual Mat4	getNodeToWorldTransform () const
	Returns the world affine transform matrix. More...
virtual AffineTransform	getNodeToWorldAffineTransform () const
local	getNodeToWorldAffineTransform ()
virtual AffineTransform	nodeToWorldTransform () const
local	nodeToWorldTransform ()
virtual Mat4	getWorldToNodeTransform () const
	Returns the inverse world affine transform matrix. More...
var	getWorldToNodeTransform ()
	Returns the inverse world affine transform matrix. More...
local	getWorldToNodeTransform ()
	Returns the inverse world affine transform matrix. More...
virtual AffineTransform	getWorldToNodeAffineTransform () const
local	getWorldToNodeAffineTransform ()
virtual AffineTransform	worldToNodeTransform () const
local	worldToNodeTransform ()
Vec2	convertToNodeSpace (const Vec2 &worldPoint) const
	Converts a Vec2 to node (local) space coordinates. More...
var	convertToNodeSpace ( var worldPoint)
	Converts a Vec2 to node (local) space coordinates. More...
local	convertToNodeSpace ( local worldPoint)
	Converts a Vec2 to node (local) space coordinates. More...
Vec2	convertToWorldSpace (const Vec2 &nodePoint) const
	Converts a Vec2 to world space coordinates. More...
Vec2	convertToNodeSpaceAR (const Vec2 &worldPoint) const
	Converts a Vec2 to node (local) space coordinates. More...
Vec2	convertToWorldSpaceAR (const Vec2 &nodePoint) const
	Converts a local Vec2 to world space coordinates.The result is in Points. More...
Vec2	convertTouchToNodeSpace (Touch *touch) const
	convenience methods which take a Touch instead of Vec2. More...
Vec2	convertTouchToNodeSpaceAR (Touch *touch) const
	converts a Touch (world coordinates) into a local coordinate. More...
void	setAdditionalTransform (Mat4 *additionalTransform)
	Sets an additional transform matrix to the node. More...
void	setAdditionalTransform (const AffineTransform &additionalTransform)
var	setAdditionalTransform ( var additionalTransform)
local	setAdditionalTransform ( local additionalTransform)
Component *	getComponent (const std::string &name)
	Gets a component by its name. More...
var	getComponent ( var name)
	Gets a component by its name. More...
local	getComponent ( local name)
	Gets a component by its name. More...
virtual bool	addComponent (Component *component)
	Adds a component. More...
virtual bool	removeComponent (const std::string &name)
	Removes a component by its name. More...
virtual bool	removeComponent (Component *component)
	Removes a component by its pointer. More...
virtual void	removeAllComponents ()
	Removes all components.
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...
void	release ()
	Releases the ownership immediately. More...
Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...
virtual	~Ref ()
	Destructor. More...
Public Member Functions inherited from LayoutParameterProtocol
virtual	~LayoutParameterProtocol ()
	Default destructor.

Static Public Member Functions
static ScrollView *	create ()
	Create an empty ScrollView. More...
var	create ()
	Create an empty ScrollView. More...
local	create ()
	Create an empty ScrollView. More...
Static Public Member Functions inherited from Layout
static Layout *	create ()
	Create a empty layout.
local	create ()
	Create a empty layout.
Static Public Member Functions inherited from Widget
static Widget *	create ()
	Create and return a empty Widget instance pointer.
var	create ()
	Create and return a empty Widget instance pointer.
local	create ()
	Create and return a empty Widget instance pointer.
Static Public Member Functions inherited from ProtectedNode
static ProtectedNode *	create (void)
	Creates a ProtectedNode with no argument. More...
Static Public Member Functions inherited from Node
static Node *	create ()
	Allocates and initializes a node. More...
var	create ()
	Allocates and initializes a node. More...
local	create ()
	Allocates and initializes a node. More...

Additional Inherited Members
Public Attributes inherited from Layout
std::function< int(FocusDirection, Widget *)>	onPassFocusToChild
	To specify a user-defined functor to decide which child widget of the layout should get focused. More...
Public Attributes inherited from Widget
std::function< void(Widget *, Widget *)>	onFocusChanged
	When a widget lose/get focus, this method will be called. More...
std::function< Widget *(FocusDirection)>	onNextFocusedWidget
	use this function to manually specify the next focused widget regards to each direction
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.
void *	_scriptObject
	scriptObject, support for swift
Static Public Attributes inherited from Node
static const int	INVALID_TAG = -1
	Default tag used for all the nodes.
var	INVALID_TAG = -1
	Default tag used for all the nodes.
local	INVALID_TAG = -1
	Default tag used for all the nodes.
Protected Member Functions inherited from Widget
void	propagateTouchEvent (TouchEventType event, Widget *sender, Touch *touch)
	Propagate touch events to its parents.
var	propagateTouchEvent ( var event, var sender, var touch)
	Propagate touch events to its parents.
local	propagateTouchEvent ( local event, local sender, local touch)
	Propagate touch events to its parents.
void	onFocusChange (Widget *widgetLostFocus, Widget *widgetGetFocus)
	This method is called when a focus change event happens. More...
var	onFocusChange ( var widgetLostFocus, var widgetGetFocus)
	This method is called when a focus change event happens. More...
local	onFocusChange ( local widgetLostFocus, local widgetGetFocus)
	This method is called when a focus change event happens. More...
void	dispatchFocusEvent (Widget *widgetLoseFocus, Widget *widgetGetFocus)
	Dispatch a EventFocus through a EventDispatcher. More...

Detailed Description

Layout container for a view hierarchy that can be scrolled by the user, allowing it to be larger than the physical display.

It holds a inner Layout container for storing child items hironzontally or vertically.

Constructor & Destructor Documentation

ScrollView

(

)

Default constructor.

var ctor

(

)

Default constructor.

local new

(

)

Default constructor.

virtual ~ScrollView ( )

virtual

Default destructor.

Member Function Documentation

static ScrollView* create ( )

static

Create an empty ScrollView.

Returns

A ScrollView instance.

var create ( )

static

Create an empty ScrollView.

Returns

A ScrollView instance.

local create ( )

static

Create an empty ScrollView.

Returns

A ScrollView instance.

virtual void setDirection ( Direction  dir )

virtual

Changes scroll direction of scrollview.

See also

Direction

Parameters

dir	Scroll direction enum.

Reimplemented in ListView.

var setDirection ( var  dir )

virtual

Changes scroll direction of scrollview.

See also

Direction

Parameters

dir	Scroll direction enum.

Reimplemented in ListView.

local setDirection ( local  dir )

virtual

Changes scroll direction of scrollview.

See also

Direction

Parameters

dir	Scroll direction enum.

Reimplemented in ListView.

Direction getDirection

(

)

const

Query scroll direction of scrollview.

See also

Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll

Returns

Scrollview scroll direction.

var getDirection

(

)

Query scroll direction of scrollview.

See also

Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll

Returns

Scrollview scroll direction.

local getDirection

(

)

Query scroll direction of scrollview.

See also

Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll

Returns

Scrollview scroll direction.

Layout* getInnerContainer

(

)

const

Get inner container of scrollview.

Inner container is a child of scrollview.

Returns

Inner container pointer.

var getInnerContainer

(

)

Get inner container of scrollview.

Inner container is a child of scrollview.

Returns

Inner container pointer.

local getInnerContainer

(

)

Get inner container of scrollview.

Inner container is a child of scrollview.

Returns

Inner container pointer.

void scrollToBottom	(	float	second,
		bool	attenuated
	)

Scroll inner container to bottom boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

var scrollToBottom	(	var	second,
		var	attenuated
	)

Scroll inner container to bottom boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

local scrollToBottom	(	local	second,
		local	attenuated
	)

Scroll inner container to bottom boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

void scrollToTop	(	float	second,
		bool	attenuated
	)

Scroll inner container to top boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

var scrollToTop	(	var	second,
		var	attenuated
	)

Scroll inner container to top boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

local scrollToTop	(	local	second,
		local	attenuated
	)

Scroll inner container to top boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

void scrollToLeft	(	float	second,
		bool	attenuated
	)

Scroll inner container to left boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

var scrollToLeft	(	var	second,
		var	attenuated
	)

Scroll inner container to left boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

local scrollToLeft	(	local	second,
		local	attenuated
	)

Scroll inner container to left boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

void scrollToRight	(	float	time,
		bool	attenuated
	)

Scroll inner container to right boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

var scrollToRight	(	var	time,
		var	attenuated
	)

Scroll inner container to right boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

local scrollToRight	(	local	time,
		local	attenuated
	)

Scroll inner container to right boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

void scrollToTopLeft	(	float	second,
		bool	attenuated
	)

Scroll inner container to top and left boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

var scrollToTopLeft	(	var	second,
		var	attenuated
	)

Scroll inner container to top and left boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

local scrollToTopLeft	(	local	second,
		local	attenuated
	)

Scroll inner container to top and left boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

void scrollToTopRight	(	float	time,
		bool	attenuated
	)

Scroll inner container to top and right boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

var scrollToTopRight	(	var	time,
		var	attenuated
	)

Scroll inner container to top and right boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

local scrollToTopRight	(	local	time,
		local	attenuated
	)

Scroll inner container to top and right boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

void scrollToBottomLeft	(	float	second,
		bool	attenuated
	)

Scroll inner container to bottom and left boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

var scrollToBottomLeft	(	var	second,
		var	attenuated
	)

Scroll inner container to bottom and left boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

local scrollToBottomLeft	(	local	second,
		local	attenuated
	)

Scroll inner container to bottom and left boundary of scrollview.

Parameters

second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

void scrollToBottomRight	(	float	time,
		bool	attenuated
	)

Scroll inner container to bottom and right boundary of scrollview.

Parameters

second	Time in seconds
attenuated	Whether scroll speed attenuate or not.

var scrollToBottomRight	(	var	time,
		var	attenuated
	)

Scroll inner container to bottom and right boundary of scrollview.

Parameters

second	Time in seconds
attenuated	Whether scroll speed attenuate or not.

local scrollToBottomRight	(	local	time,
		local	attenuated
	)

Scroll inner container to bottom and right boundary of scrollview.

Parameters

second	Time in seconds
attenuated	Whether scroll speed attenuate or not.

void scrollToPercentVertical	(	float	percent,
		float	second,
		bool	attenuated
	)

Scroll inner container to vertical percent position of scrollview.

Parameters

percent	A value between 0 and 100.
second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

var scrollToPercentVertical	(	var	percent,
		var	second,
		var	attenuated
	)

Scroll inner container to vertical percent position of scrollview.

Parameters

percent	A value between 0 and 100.
second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

local scrollToPercentVertical	(	local	percent,
		local	second,
		local	attenuated
	)

Scroll inner container to vertical percent position of scrollview.

Parameters

percent	A value between 0 and 100.
second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

void scrollToPercentHorizontal	(	float	percent,
		float	second,
		bool	attenuated
	)

Scroll inner container to horizontal percent position of scrollview.

Parameters

percent	A value between 0 and 100.
second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

var scrollToPercentHorizontal	(	var	percent,
		var	second,
		var	attenuated
	)

Scroll inner container to horizontal percent position of scrollview.

Parameters

percent	A value between 0 and 100.
second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

local scrollToPercentHorizontal	(	local	percent,
		local	second,
		local	attenuated
	)

Scroll inner container to horizontal percent position of scrollview.

Parameters

percent	A value between 0 and 100.
second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

void scrollToPercentBothDirection	(	const Vec2 &	percent,
		float	second,
		bool	attenuated
	)

Scroll inner container to both direction percent position of scrollview.

Parameters

percent	A value between 0 and 100.
second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

var scrollToPercentBothDirection	(	var	percent,
		var	second,
		var	attenuated
	)

Scroll inner container to both direction percent position of scrollview.

Parameters

percent	A value between 0 and 100.
second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

local scrollToPercentBothDirection	(	local	percent,
		local	second,
		local	attenuated
	)

Scroll inner container to both direction percent position of scrollview.

Parameters

percent	A value between 0 and 100.
second	Time in seconds.
attenuated	Whether scroll speed attenuate or not.

void jumpToPercentVertical

(

float

percent

)

Move inner container to vertical percent position of scrollview.

Parameters

percent

A value between 0 and 100.

var jumpToPercentVertical

(

var

percent

)

Move inner container to vertical percent position of scrollview.

Parameters

percent

A value between 0 and 100.

local jumpToPercentVertical

(

local

percent

)

Move inner container to vertical percent position of scrollview.

Parameters

percent

A value between 0 and 100.

void jumpToPercentHorizontal

(

float

percent

)

Move inner container to horizontal percent position of scrollview.

Parameters

percent

A value between 0 and 100.

var jumpToPercentHorizontal

(

var

percent

)

Move inner container to horizontal percent position of scrollview.

Parameters

percent

A value between 0 and 100.

local jumpToPercentHorizontal

(

local

percent

)

Move inner container to horizontal percent position of scrollview.

Parameters

percent

A value between 0 and 100.

void jumpToPercentBothDirection

(

const Vec2 &

percent

)

Move inner container to both direction percent position of scrollview.

Parameters

percent

A value between 0 and 100.

var jumpToPercentBothDirection

(

var

percent

)

Move inner container to both direction percent position of scrollview.

Parameters

percent

A value between 0 and 100.

local jumpToPercentBothDirection

(

local

percent

)

Move inner container to both direction percent position of scrollview.

Parameters

percent

A value between 0 and 100.

void setInnerContainerSize

(

const Size &

size

)

Change inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Parameters

size	Inner container size.

var setInnerContainerSize

(

var

size

)

Change inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Parameters

size	Inner container size.

local setInnerContainerSize

(

local

size

)

Change inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Parameters

size	Inner container size.

const Size& getInnerContainerSize

(

)

const

Get inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Returns

The inner container size.

var getInnerContainerSize

(

)

Get inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Returns

The inner container size.

local getInnerContainerSize

(

)

Get inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Returns

The inner container size.

void addEventListenerScrollView	(	Ref *	target,
		SEL_ScrollViewEvent	selector
	)

Add callback function which will be called when scrollview event triggered.

var addEventListenerScrollView	(	var	target,
		var	selector
	)

Add callback function which will be called when scrollview event triggered.

local addEventListenerScrollView	(	local	target,
		local	selector
	)

Add callback function which will be called when scrollview event triggered.

virtual void addEventListener ( const ccScrollViewCallback &  callback )

virtual

Add callback function which will be called when scrollview event triggered.

Parameters

callback

A callback function with type of ccScrollViewCallback.

Reimplemented in ListView.

var addEventListener ( var  callback )

virtual

Add callback function which will be called when scrollview event triggered.

Parameters

callback

A callback function with type of ccScrollViewCallback.

Reimplemented in ListView.

local addEventListener ( local  callback )

virtual

Add callback function which will be called when scrollview event triggered.

Parameters

callback

A callback function with type of ccScrollViewCallback.

Reimplemented in ListView.

virtual void addChild ( Node *  child )

overridevirtual

Adds a child to the container with z-order as 0.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters

child

A child node.

Reimplemented from Layout.

Reimplemented in ListView.

var addChild ( var  child )

overridevirtual

Adds a child to the container with z-order as 0.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters

child

A child node.

Reimplemented from Layout.

Reimplemented in ListView.

local addChild ( local  child )

overridevirtual

Adds a child to the container with z-order as 0.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters

child

A child node.

Reimplemented from Layout.

Reimplemented in ListView.

virtual void addChild ( Node *  child, int  localZOrder  )

overridevirtual

Adds a child to the container with a local z-order.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters

child	A child node.
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int).

Reimplemented from Layout.

Reimplemented in ListView.

var addChild ( var  child, var  localZOrder  )

overridevirtual

Adds a child to the container with a local z-order.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters

child	A child node.
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int).

Reimplemented from Layout.

Reimplemented in ListView.

local addChild ( local  child, local  localZOrder  )

overridevirtual

Adds a child to the container with a local z-order.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters

child	A child node.
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int).

Reimplemented from Layout.

Reimplemented in ListView.

virtual void addChild ( Node *  child, int  localZOrder, int  tag  )

overridevirtual

Adds a child to the container with z order and tag.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters

child	A child node
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int)
tag	A interger to identify the node easily. Please refer to setTag(int)

Reimplemented from Layout.

Reimplemented in ListView.

var addChild ( var  child, var  localZOrder, var  tag  )

overridevirtual

Adds a child to the container with z order and tag.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters

child	A child node
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int)
tag	A interger to identify the node easily. Please refer to setTag(int)

Reimplemented from Layout.

Reimplemented in ListView.

local addChild ( local  child, local  localZOrder, local  tag  )

overridevirtual

Adds a child to the container with z order and tag.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters

child	A child node
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int)
tag	A interger to identify the node easily. Please refer to setTag(int)

Reimplemented from Layout.

Reimplemented in ListView.

virtual void addChild ( Node *  child, int  localZOrder, const std::string &  name  )

overridevirtual

Adds a child to the container with z order and tag.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters

child	A child node.
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int).
name	A string to identify the node easily. Please refer to setName(int).

Reimplemented from Layout.

Reimplemented in ListView.

var addChild ( var  child, var  localZOrder, var  name  )

overridevirtual

Adds a child to the container with z order and tag.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters

child	A child node.
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int).
name	A string to identify the node easily. Please refer to setName(int).

Reimplemented from Layout.

Reimplemented in ListView.

local addChild ( local  child, local  localZOrder, local  name  )

overridevirtual

Adds a child to the container with z order and tag.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters

child	A child node.
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int).
name	A string to identify the node easily. Please refer to setName(int).

Reimplemented from Layout.

Reimplemented in ListView.

virtual void removeAllChildren ( )

overridevirtual

Removes all children from the container with a cleanup.

See also

removeAllChildrenWithCleanup(bool)

Reimplemented from Layout.

Reimplemented in ListView.

var removeAllChildren ( )

overridevirtual

Removes all children from the container with a cleanup.

See also

removeAllChildrenWithCleanup(bool)

Reimplemented from Layout.

Reimplemented in ListView.

local removeAllChildren ( )

overridevirtual

Removes all children from the container with a cleanup.

See also

removeAllChildrenWithCleanup(bool)

Reimplemented from Layout.

Reimplemented in ListView.

virtual void removeAllChildrenWithCleanup ( bool  cleanup )

overridevirtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

Parameters

cleanup

true if all running actions on all children nodes should be cleanup, false oterwise.

Reimplemented from Layout.

Reimplemented in ListView.

var removeAllChildrenWithCleanup ( var  cleanup )

overridevirtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

Parameters

cleanup

true if all running actions on all children nodes should be cleanup, false oterwise.

Reimplemented from Layout.

Reimplemented in ListView.

local removeAllChildrenWithCleanup ( local  cleanup )

overridevirtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

Parameters

cleanup

true if all running actions on all children nodes should be cleanup, false oterwise.

Reimplemented from Layout.

Reimplemented in ListView.

virtual void removeChild ( Node *  child, bool  cleanup = true  )

overridevirtual

Removes a child from the container.

It will also cleanup all running actions depending on the cleanup parameter.

Parameters

child	The child node which will be removed.
cleanup	True if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented from Layout.

Reimplemented in ListView.

var removeChild ( var  child, var  cleanup = true  )

overridevirtual

Removes a child from the container.

It will also cleanup all running actions depending on the cleanup parameter.

Parameters

child	The child node which will be removed.
cleanup	True if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented from Layout.

Reimplemented in ListView.

local removeChild ( local  child, local  cleanup = true  )

overridevirtual

Removes a child from the container.

It will also cleanup all running actions depending on the cleanup parameter.

Parameters

child	The child node which will be removed.
cleanup	True if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented from Layout.

Reimplemented in ListView.

virtual Vector<Node*>& getChildren ( )

overridevirtual

Returns the array of the node's children.

Returns

the array the node's children.

Reimplemented from Node.

var getChildren ( )

overridevirtual

Returns the array of the node's children.

Returns

the array the node's children.

Reimplemented from Node.

local getChildren ( )

overridevirtual

Returns the array of the node's children.

Returns

the array the node's children.

Reimplemented from Node.

virtual ssize_t getChildrenCount ( ) const

overridevirtual

Returns the amount of children.

Returns

The amount of children.

Reimplemented from Node.

var getChildrenCount ( )

overridevirtual

Returns the amount of children.

Returns

The amount of children.

Reimplemented from Node.

local getChildrenCount ( )

overridevirtual

Returns the amount of children.

Returns

The amount of children.

Reimplemented from Node.

virtual Node* getChildByTag ( int  tag ) const

overridevirtual

Gets a child from the container with its tag.

Parameters

tag	An identifier to find the child node.

Returns

a Node object whose tag equals to the input parameter.

Please use getChildByName() instead.

Reimplemented from Node.

var getChildByTag ( var  tag )

overridevirtual

Gets a child from the container with its tag.

Parameters

tag	An identifier to find the child node.

Returns

a Node object whose tag equals to the input parameter.

Please use getChildByName() instead.

Reimplemented from Node.

local getChildByTag ( local  tag )

overridevirtual

Gets a child from the container with its tag.

Parameters

tag	An identifier to find the child node.

Returns

a Node object whose tag equals to the input parameter.

Please use getChildByName() instead.

Reimplemented from Node.

virtual Node* getChildByName ( const std::string &  name ) const

overridevirtual

Gets a child from the container with its name.

Parameters

name	An identifier to find the child node.

Returns

a Node object whose name equals to the input parameter.

Since

v3.2

Reimplemented from Node.

var getChildByName ( var  name )

overridevirtual

Gets a child from the container with its name.

Parameters

name	An identifier to find the child node.

Returns

a Node object whose name equals to the input parameter.

Since

v3.2

Reimplemented from Node.

local getChildByName ( local  name )

overridevirtual

Gets a child from the container with its name.

Parameters

name	An identifier to find the child node.

Returns

a Node object whose name equals to the input parameter.

Since

v3.2

Reimplemented from Node.

virtual bool onTouchBegan ( Touch *  touch, Event *  unusedEvent  )

overridevirtual

A callback which will be called when touch began event is issued.

Parameters

touch	The touch info.
unusedEvent	The touch event info.

Returns

True if user want to handle touches, false otherwise.

Reimplemented from Widget.

var onTouchBegan ( var  touch, var  unusedEvent  )

overridevirtual

A callback which will be called when touch began event is issued.

Parameters

touch	The touch info.
unusedEvent	The touch event info.

Returns

True if user want to handle touches, false otherwise.

Reimplemented from Widget.

local onTouchBegan ( local  touch, local  unusedEvent  )

overridevirtual

A callback which will be called when touch began event is issued.

Parameters

touch	The touch info.
unusedEvent	The touch event info.

Returns

True if user want to handle touches, false otherwise.

Reimplemented from Widget.

virtual void onTouchMoved ( Touch *  touch, Event *  unusedEvent  )

overridevirtual

A callback which will be called when touch moved event is issued.

Parameters

touch	The touch info.
unusedEvent	The touch event info.

Reimplemented from Widget.

var onTouchMoved ( var  touch, var  unusedEvent  )

overridevirtual

A callback which will be called when touch moved event is issued.

Parameters

touch	The touch info.
unusedEvent	The touch event info.

Reimplemented from Widget.

local onTouchMoved ( local  touch, local  unusedEvent  )

overridevirtual

A callback which will be called when touch moved event is issued.

Parameters

touch	The touch info.
unusedEvent	The touch event info.

Reimplemented from Widget.

virtual void onTouchEnded ( Touch *  touch, Event *  unusedEvent  )

overridevirtual

A callback which will be called when touch ended event is issued.

Parameters

touch	The touch info.
unusedEvent	The touch event info.

Reimplemented from Widget.

var onTouchEnded ( var  touch, var  unusedEvent  )

overridevirtual

A callback which will be called when touch ended event is issued.

Parameters

touch	The touch info.
unusedEvent	The touch event info.

Reimplemented from Widget.

local onTouchEnded ( local  touch, local  unusedEvent  )

overridevirtual

A callback which will be called when touch ended event is issued.

Parameters

touch	The touch info.
unusedEvent	The touch event info.

Reimplemented from Widget.

virtual void onTouchCancelled ( Touch *  touch, Event *  unusedEvent  )

overridevirtual

A callback which will be called when touch cancelled event is issued.

Parameters

touch	The touch info.
unusedEvent	The touch event info.

Reimplemented from Widget.

var onTouchCancelled ( var  touch, var  unusedEvent  )

overridevirtual

A callback which will be called when touch cancelled event is issued.

Parameters

touch	The touch info.
unusedEvent	The touch event info.

Reimplemented from Widget.

local onTouchCancelled ( local  touch, local  unusedEvent  )

overridevirtual

A callback which will be called when touch cancelled event is issued.

Parameters

touch	The touch info.
unusedEvent	The touch event info.

Reimplemented from Widget.

virtual void update ( float  delta )

overridevirtual

Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".

Parameters

delta

In seconds.

Reimplemented from Node.

var update ( var  delta )

overridevirtual

Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".

Parameters

delta

In seconds.

Reimplemented from Node.

local update ( local  delta )

overridevirtual

Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".

Parameters

delta

In seconds.

Reimplemented from Node.

void setBounceEnabled

(

bool

enabled

)

Toggle bounce enabled when scroll to the edge.

Parameters

enabled

True if enable bounce, false otherwise.

var setBounceEnabled

(

var

enabled

)

Toggle bounce enabled when scroll to the edge.

Parameters

enabled

True if enable bounce, false otherwise.

local setBounceEnabled

(

local

enabled

)

Toggle bounce enabled when scroll to the edge.

Parameters

enabled

True if enable bounce, false otherwise.

bool isBounceEnabled

(

)

const

Query bounce state.

Returns

True if bounce is enabled, false otherwise.

var isBounceEnabled

(

)

Query bounce state.

Returns

True if bounce is enabled, false otherwise.

local isBounceEnabled

(

)

Query bounce state.

Returns

True if bounce is enabled, false otherwise.

void setInertiaScrollEnabled

(

bool

enabled

)

Toggle whether enable scroll inertia while scrolling.

Parameters

enabled

True if enable inertia, false otherwise.

var setInertiaScrollEnabled

(

var

enabled

)

Toggle whether enable scroll inertia while scrolling.

Parameters

enabled

True if enable inertia, false otherwise.

local setInertiaScrollEnabled

(

local

enabled

)

Toggle whether enable scroll inertia while scrolling.

Parameters

enabled

True if enable inertia, false otherwise.

bool isInertiaScrollEnabled

(

)

const

Query inertia scroll state.

Returns

True if inertia is enabled, false otherwise.

var isInertiaScrollEnabled

(

)

Query inertia scroll state.

Returns

True if inertia is enabled, false otherwise.

local isInertiaScrollEnabled

(

)

Query inertia scroll state.

Returns

True if inertia is enabled, false otherwise.

virtual void setLayoutType ( Type  type )

overridevirtual

Set layout type for scrollview.

See also

Layout::Type

Parameters

type	Layout type enum.

Reimplemented from Layout.

var setLayoutType ( var  type )

overridevirtual

Set layout type for scrollview.

See also

Layout::Type

Parameters

type	Layout type enum.

Reimplemented from Layout.

local setLayoutType ( local  type )

overridevirtual

Set layout type for scrollview.

See also

Layout::Type

Parameters

type	Layout type enum.

Reimplemented from Layout.

virtual Type getLayoutType ( ) const

overridevirtual

Get the layout type for scrollview.

See also

Layout::Type

Returns

LayoutType

Reimplemented from Layout.

var getLayoutType ( )

overridevirtual

Get the layout type for scrollview.

See also

Layout::Type

Returns

LayoutType

Reimplemented from Layout.

local getLayoutType ( )

overridevirtual

Get the layout type for scrollview.

See also

Layout::Type

Returns

LayoutType

Reimplemented from Layout.

virtual void onEnter ( )

overridevirtual

Event callback that is invoked every time when Node enters the 'stage'.

If the Node enters the 'stage' with a transition, this event is called when the transition starts. During onEnter you can't access a "sister/brother" node. If you override onEnter, you shall call its parent's one, e.g., Node::onEnter().

Reimplemented from Layout.

var onEnter ( )

overridevirtual

Event callback that is invoked every time when Node enters the 'stage'.

If the Node enters the 'stage' with a transition, this event is called when the transition starts. During onEnter you can't access a "sister/brother" node. If you override onEnter, you shall call its parent's one, e.g., Node::onEnter().

Reimplemented from Layout.

virtual Widget* findNextFocusedWidget ( FocusDirection  direction, Widget *  current  )

overridevirtual

When a widget is in a layout, you could call this method to get the next focused widget within a specified direction.

If the widget is not in a layout, it will return itself

Parameters

direction	the direction to look for the next focused widget in a layout
current	the current focused widget

Returns

the next focused widget in a layout

Reimplemented from Layout.

var findNextFocusedWidget ( var  direction, var  current  )

overridevirtual

When a widget is in a layout, you could call this method to get the next focused widget within a specified direction.

If the widget is not in a layout, it will return itself

Parameters

direction	the direction to look for the next focused widget in a layout
current	the current focused widget

Returns

the next focused widget in a layout

Reimplemented from Layout.

local findNextFocusedWidget ( local  direction, local  current  )

overridevirtual

When a widget is in a layout, you could call this method to get the next focused widget within a specified direction.

If the widget is not in a layout, it will return itself

Parameters

direction	the direction to look for the next focused widget in a layout
current	the current focused widget

Returns

the next focused widget in a layout

Reimplemented from Layout.

---

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

• UIScrollView.h