PageView Class Reference

Layout manager that allows the user to flip left & right and up & down through pages of data. More...

Inherits ListView.

Public Types
enum	EventType
	Page turn event type.
enum	TouchDirection
	Touch direction type.
typedef std::function< void(Ref *, EventType)>	ccPageViewCallback
	PageView page turn event callback.
Public Types inherited from ListView
enum	Gravity
	Gravity for docking elements in ListView.
enum	EventType
	ListView element item click event.
enum	MagneticType
	ListView supports magnetic scroll. More...
typedef std::function< void(Ref *, EventType)>	ccListViewCallback
	ListView item click callback.
Public Types inherited from ScrollView
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
	PageView ()
	Default constructor. More...
virtual	~PageView ()
	Default destructor. More...
virtual void	setDirection (Direction direction) override
	Changes direction Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll. More...
var	setDirection ( var direction)
	Changes direction Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll. More...
local	setDirection ( local direction)
	Changes direction Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll. More...
void	addWidgetToPage (Widget *widget, ssize_t pageIdx, bool forceCreate)
	Add a widget as a page of PageView in a given index. More...
local	addWidgetToPage ( local widget, local pageIdx, local forceCreate)
	Add a widget as a page of PageView in a given index. More...
void	addPage (Widget *page)
	Insert a page into the end of PageView. More...
var	addPage ( var page)
	Insert a page into the end of PageView. More...
local	addPage ( local page)
	Insert a page into the end of PageView. More...
void	insertPage (Widget *page, int idx)
	Insert a page into PageView at a given index. More...
var	insertPage ( var page, var idx)
	Insert a page into PageView at a given index. More...
local	insertPage ( local page, local idx)
	Insert a page into PageView at a given index. More...
void	removePage (Widget *page)
	Remove a page of PageView. More...
var	removePage ( var page)
	Remove a page of PageView. More...
local	removePage ( local page)
	Remove a page of PageView. More...
void	removePageAtIndex (ssize_t index)
	Remove a page at a given index of PageView. More...
var	removePageAtIndex ( var index)
	Remove a page at a given index of PageView. More...
local	removePageAtIndex ( local index)
	Remove a page at a given index of PageView. More...
void	removeAllPages ()
	Remove all pages of the PageView.
var	removeAllPages ()
	Remove all pages of the PageView.
local	removeAllPages ()
	Remove all pages of the PageView.
void	scrollToPage (ssize_t idx)
	Scroll to a page with a given index. More...
void	scrollToPage (ssize_t idx, float time)
	Scroll to a page with a given index and with a given scroll time. More...
var	scrollToPage ( var idx, var time)
	Scroll to a page with a given index and with a given scroll time. More...
local	scrollToPage ( local idx, local time)
	Scroll to a page with a given index and with a given scroll time. More...
void	scrollToItem (ssize_t itemIndex)
	Scroll to a page with a given index. More...
void	scrollToItem (ssize_t idx, float time)
	Scroll to a item with a given index and with a given scroll time. More...
var	scrollToItem ( var idx, var time)
	Scroll to a item with a given index and with a given scroll time. More...
local	scrollToItem ( local idx, local time)
	Scroll to a item with a given index and with a given scroll time. More...
ssize_t	getCurPageIndex () const
	Gets current displayed page index. More...
local	getCurPageIndex ()
	Gets current displayed page index. More...
ssize_t	getCurrentPageIndex ()
	Gets current displayed page index. More...
local	getCurrentPageIndex ()
	Gets current displayed page index. More...
void	setCurPageIndex (ssize_t index)
	Jump to a page with a given index without scrolling. More...
var	setCurPageIndex ( var index)
	Jump to a page with a given index without scrolling. More...
local	setCurPageIndex ( local index)
	Jump to a page with a given index without scrolling. More...
void	setCurrentPageIndex (ssize_t index)
	Jump to a page with a given index without scrolling. More...
Vector< Layout * > &	getPages ()
	Get all the pages in the PageView. More...
Layout *	getPage (ssize_t index)
	Get a page at a given index. More...
void	addEventListenerPageView (Ref *target, SEL_PageViewEvent selector)
	Add a page turn callback to PageView, then when one page is turning, the callback will be called. More...
var	addEventListenerPageView ( var target, var selector)
	Add a page turn callback to PageView, then when one page is turning, the callback will be called. More...
local	addEventListenerPageView ( local target, local selector)
	Add a page turn callback to PageView, then when one page is turning, the callback will be called. More...
void	addEventListener (const ccPageViewCallback &callback)
	Add a page turn callback to PageView, then when one page is turning, the callback will be called. More...
virtual std::string	getDescription () const override
	Return the "class name" of widget.
var	getDescription ()
	Return the "class name" of widget.
local	getDescription ()
	Return the "class name" of widget.
void	setIndicatorEnabled (bool enabled)
	Toggle page indicator enabled. More...
var	setIndicatorEnabled ( var enabled)
	Toggle page indicator enabled. More...
local	setIndicatorEnabled ( local enabled)
	Toggle page indicator enabled. More...
bool	getIndicatorEnabled () const
	Query page indicator state. More...
var	getIndicatorEnabled ()
	Query page indicator state. More...
local	getIndicatorEnabled ()
	Query page indicator state. More...
void	setIndicatorPositionAsAnchorPoint (const Vec2 &positionAsAnchorPoint)
	Set the page indicator's position using anchor point. More...
var	setIndicatorPositionAsAnchorPoint ( var positionAsAnchorPoint)
	Set the page indicator's position using anchor point. More...
local	setIndicatorPositionAsAnchorPoint ( local positionAsAnchorPoint)
	Set the page indicator's position using anchor point. More...
const Vec2 &	getIndicatorPositionAsAnchorPoint () const
	Get the page indicator's position as anchor point. More...
void	setIndicatorPosition (const Vec2 &position)
	Set the page indicator's position in page view. More...
var	setIndicatorPosition ( var position)
	Set the page indicator's position in page view. More...
local	setIndicatorPosition ( local position)
	Set the page indicator's position in page view. More...
const Vec2 &	getIndicatorPosition () const
	Get the page indicator's position. More...
local	getIndicatorPosition ()
	Get the page indicator's position. More...
void	setIndicatorSpaceBetweenIndexNodes (float spaceBetweenIndexNodes)
	Set space between page indicator's index nodes. More...
var	setIndicatorSpaceBetweenIndexNodes ( var spaceBetweenIndexNodes)
	Set space between page indicator's index nodes. More...
local	setIndicatorSpaceBetweenIndexNodes ( local spaceBetweenIndexNodes)
	Set space between page indicator's index nodes. More...
float	getIndicatorSpaceBetweenIndexNodes () const
	Get the space between page indicator's index nodes. More...
var	getIndicatorSpaceBetweenIndexNodes ()
	Get the space between page indicator's index nodes. More...
local	getIndicatorSpaceBetweenIndexNodes ()
	Get the space between page indicator's index nodes. More...
void	setIndicatorSelectedIndexColor (const Color3B &color)
	Set color of page indicator's selected index. More...
var	setIndicatorSelectedIndexColor ( var color)
	Set color of page indicator's selected index. More...
local	setIndicatorSelectedIndexColor ( local color)
	Set color of page indicator's selected index. More...
const Color3B &	getIndicatorSelectedIndexColor () const
	Get the color of page indicator's selected index. More...
var	getIndicatorSelectedIndexColor ()
	Get the color of page indicator's selected index. More...
local	getIndicatorSelectedIndexColor ()
	Get the color of page indicator's selected index. More...
void	setIndicatorIndexNodesColor (const Color3B &color)
	Set color of page indicator's index nodes. More...
var	setIndicatorIndexNodesColor ( var color)
	Set color of page indicator's index nodes. More...
local	setIndicatorIndexNodesColor ( local color)
	Set color of page indicator's index nodes. More...
const Color3B &	getIndicatorIndexNodesColor () const
	Get the color of page indicator's index nodes. More...
local	getIndicatorIndexNodesColor ()
	Get the color of page indicator's index nodes. More...
void	setIndicatorSelectedIndexOpacity (GLubyte opacity)
	Set opacity of page indicator's selected index. More...
var	setIndicatorSelectedIndexOpacity ( var opacity)
	Set opacity of page indicator's selected index. More...
local	setIndicatorSelectedIndexOpacity ( local opacity)
	Set opacity of page indicator's selected index. More...
GLubyte	getIndicatorSelectedIndexOpacity () const
	Get the opacity of page indicator's selected index. More...
var	getIndicatorSelectedIndexOpacity ()
	Get the opacity of page indicator's selected index. More...
local	getIndicatorSelectedIndexOpacity ()
	Get the opacity of page indicator's selected index. More...
void	setIndicatorIndexNodesOpacity (GLubyte opacity)
	Set opacity of page indicator's index nodes. More...
var	setIndicatorIndexNodesOpacity ( var opacity)
	Set opacity of page indicator's index nodes. More...
local	setIndicatorIndexNodesOpacity ( local opacity)
	Set opacity of page indicator's index nodes. More...
GLubyte	getIndicatorIndexNodesOpacity () const
	Get the opacity of page indicator's index nodes. More...
var	getIndicatorIndexNodesOpacity ()
	Get the opacity of page indicator's index nodes. More...
local	getIndicatorIndexNodesOpacity ()
	Get the opacity of page indicator's index nodes. More...
void	setIndicatorIndexNodesScale (float indexNodesScale)
	Set scale of page indicator's index nodes. More...
var	setIndicatorIndexNodesScale ( var indexNodesScale)
	Set scale of page indicator's index nodes. More...
local	setIndicatorIndexNodesScale ( local indexNodesScale)
	Set scale of page indicator's index nodes. More...
void	setIndicatorIndexNodesTexture (const std::string &texName, Widget::TextureResType texType=Widget::TextureResType::LOCAL)
	sets texture for index nodes. More...
var	setIndicatorIndexNodesTexture ( var texName, var LOCAL)
	sets texture for index nodes. More...
local	setIndicatorIndexNodesTexture ( local texName, local LOCAL)
	sets texture for index nodes. More...
float	getIndicatorIndexNodesScale () const
	Get scale of page indicator's index nodes. More...
local	getIndicatorIndexNodesScale ()
	Get scale of page indicator's index nodes. More...
void	setCustomScrollThreshold (float threshold)
	If you don't specify the value, the pageView will turn page when scrolling at the half width of a page. More...
var	setCustomScrollThreshold ( var threshold)
	If you don't specify the value, the pageView will turn page when scrolling at the half width of a page. More...
local	setCustomScrollThreshold ( local threshold)
	If you don't specify the value, the pageView will turn page when scrolling at the half width of a page. More...
float	getCustomScrollThreshold () const
	Query the custom scroll threshold of the PageView. More...
void	setUsingCustomScrollThreshold (bool flag)
	Set using user defined scroll page threshold or not. More...
bool	isUsingCustomScrollThreshold () const
	Query whether use user defined scroll page threshold or not. More...
Public Member Functions inherited from ListView
	ListView ()
	Default constructor. More...
	new ()
	Default constructor. More...
virtual	~ListView ()
	Default destructor. More...
void	setItemModel (Widget *model)
	Set an item model for listview. More...
var	setItemModel ( var model)
	Set an item model for listview. More...
local	setItemModel ( local model)
	Set an item model for listview. More...
void	pushBackDefaultItem ()
	Insert a default item(create by a cloned model) at the end of the listview.
void	insertDefaultItem (ssize_t index)
	Insert a default item(create by cloning model) into listview at a give index. More...
void	pushBackCustomItem (Widget *item)
	Insert a custom item into the end of ListView. More...
local	pushBackCustomItem ( local item)
	Insert a custom item into the end of ListView. More...
void	insertCustomItem (Widget *item, ssize_t index)
	Insert a custom widget into ListView at a given index. More...
var	insertCustomItem ( var item, var index)
	Insert a custom widget into ListView at a given index. More...
local	insertCustomItem ( local item, local index)
	Insert a custom widget into ListView at a given index. More...
void	removeLastItem ()
	Removes the last item of ListView.
local	removeLastItem ()
	Removes the last item of ListView.
void	removeItem (ssize_t index)
	Remove an item at given index. More...
var	removeItem ( var index)
	Remove an item at given index. More...
local	removeItem ( local index)
	Remove an item at given index. More...
void	removeAllItems ()
	Remove all items in current ListView.
local	removeAllItems ()
	Remove all items in current ListView.
Widget *	getItem (ssize_t index) const
	Return an item at a given index. More...
var	getItem ( var index)
	Return an item at a given index. More...
local	getItem ( local index)
	Return an item at a given index. More...
Vector< Widget * > &	getItems ()
	Return all items in a ListView. More...
var	getItems ()
	Return all items in a ListView. More...
local	getItems ()
	Return all items in a ListView. More...
ssize_t	getIndex (Widget *item) const
	Return the index of specified widget. More...
var	getIndex ( var item)
	Return the index of specified widget. More...
local	getIndex ( local item)
	Return the index of specified widget. More...
void	setGravity (Gravity gravity)
	Set the gravity of ListView. More...
void	setMagneticType (MagneticType magneticType)
	Set magnetic type of ListView. More...
MagneticType	getMagneticType () const
	Get magnetic type of ListView.
local	getMagneticType ()
	Get magnetic type of ListView.
void	setMagneticAllowedOutOfBoundary (bool magneticAllowedOutOfBoundary)
	Set magnetic allowed out of boundary.
var	setMagneticAllowedOutOfBoundary ( var magneticAllowedOutOfBoundary)
	Set magnetic allowed out of boundary.
local	setMagneticAllowedOutOfBoundary ( local magneticAllowedOutOfBoundary)
	Set magnetic allowed out of boundary.
bool	getMagneticAllowedOutOfBoundary () const
	Query whether the magnetic out of boundary is allowed.
void	setItemsMargin (float margin)
	Set the margin between each item in ListView. More...
var	setItemsMargin ( var margin)
	Set the margin between each item in ListView. More...
local	setItemsMargin ( local margin)
	Set the margin between each item in ListView. More...
float	getItemsMargin () const
	Query margin between each item in ListView. More...
var	getItemsMargin ()
	Query margin between each item in ListView. More...
local	getItemsMargin ()
	Query margin between each item in ListView. More...
void	setPadding (float l, float t, float r, float b)
	Change padding with left, top, right, and bottom padding. More...
var	setPadding ( var l, var t, var r, var b)
	Change padding with left, top, right, and bottom padding. More...
local	setPadding ( local l, local t, local r, local b)
	Change padding with left, top, right, and bottom padding. More...
void	setLeftPadding (float l)
	Change padding with left padding. More...
local	setLeftPadding ( local l)
	Change padding with left padding. More...
void	setTopPadding (float t)
	Change padding with top padding. More...
var	setTopPadding ( var t)
	Change padding with top padding. More...
local	setTopPadding ( local t)
	Change padding with top padding. More...
void	setRightPadding (float r)
	Change padding with right padding. More...
var	setRightPadding ( var r)
	Change padding with right padding. More...
local	setRightPadding ( local r)
	Change padding with right padding. More...
void	setBottomPadding (float b)
	Change padding with bottom padding. More...
var	setBottomPadding ( var b)
	Change padding with bottom padding. More...
local	setBottomPadding ( local b)
	Change padding with bottom padding. More...
float	getLeftPadding () const
	Get the left padding in ListView. More...
float	getTopPadding () const
	Get the top padding in ListView. More...
var	getTopPadding ()
	Get the top padding in ListView. More...
local	getTopPadding ()
	Get the top padding in ListView. More...
float	getRightPadding () const
	Get the right padding in ListView. More...
var	getRightPadding ()
	Get the right padding in ListView. More...
local	getRightPadding ()
	Get the right padding in ListView. More...
float	getBottomPadding () const
	Get the bottom padding in ListView. More...
var	getBottomPadding ()
	Get the bottom padding in ListView. More...
local	getBottomPadding ()
	Get the bottom padding in ListView. More...
void	setScrollDuration (float time)
	Set the time in seconds to scroll between items. More...
float	getScrollDuration () const
	Get the time in seconds to scroll between items. More...
virtual void	requestDoLayout () override
	request to refresh widget layout
var	requestDoLayout ()
	request to refresh widget layout
local	requestDoLayout ()
	request to refresh widget layout
virtual void	addChild (Node *child) override
	Adds a child to the container with z-order as 0. More...
local	addChild ( local child)
	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...
virtual void	addChild (Node *child, int zOrder, int tag) override
	Adds a child to the container with z order and tag. More...
local	addChild ( local child, local zOrder, local tag)
	Adds a child to the container with z order and tag. More...
virtual void	addChild (Node *child, int zOrder, const std::string &name) override
	Adds a child to the container with z order and tag. More...
local	addChild ( local child, local zOrder, local name)
	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...
var	removeAllChildren ()
	Removes all children from the container with a cleanup. More...
local	removeAllChildren ()
	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 cleanup=true) override
	Removes a child from the container. More...
local	removeChild ( local child, local true)
	Removes a child from the container. More...
Widget *	getClosestItemToPosition (const Vec2 &targetPosition, const Vec2 &itemAnchorPoint) const
	Query the closest item to a specific position in inner container. More...
local	getClosestItemToPosition ( local targetPosition, local itemAnchorPoint)
	Query the closest item to a specific position in inner container. More...
Widget *	getClosestItemToPositionInCurrentView (const Vec2 &positionRatioInView, const Vec2 &itemAnchorPoint) const
	Query the closest item to a specific position in current view. More...
Widget *	getCenterItemInCurrentView () const
	Query the center item. More...
Widget *	getLeftmostItemInCurrentView () const
	Query the leftmost item in horizontal list. More...
var	getLeftmostItemInCurrentView ()
	Query the leftmost item in horizontal list. More...
local	getLeftmostItemInCurrentView ()
	Query the leftmost item in horizontal list. More...
Widget *	getRightmostItemInCurrentView () const
	Query the rightmost item in horizontal list. More...
var	getRightmostItemInCurrentView ()
	Query the rightmost item in horizontal list. More...
local	getRightmostItemInCurrentView ()
	Query the rightmost item in horizontal list. More...
Widget *	getTopmostItemInCurrentView () const
	Query the topmost item in horizontal list. More...
var	getTopmostItemInCurrentView ()
	Query the topmost item in horizontal list. More...
local	getTopmostItemInCurrentView ()
	Query the topmost item in horizontal list. More...
Widget *	getBottommostItemInCurrentView () const
	Query the bottommost item in horizontal list. More...
var	getBottommostItemInCurrentView ()
	Query the bottommost item in horizontal list. More...
local	getBottommostItemInCurrentView ()
	Query the bottommost item in horizontal list. More...
virtual void	jumpToBottom () override
	Override functions.
var	jumpToBottom ()
	Override functions.
local	jumpToBottom ()
	Override functions.
virtual void	jumpToTop () override
	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.
virtual void	jumpToLeft () override
	Move inner container to left boundary of scrollview.
local	jumpToLeft ()
	Move inner container to left boundary of scrollview.
virtual void	jumpToRight () override
	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.
virtual void	jumpToTopLeft () override
	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.
virtual void	jumpToTopRight () override
	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.
virtual void	jumpToBottomLeft () override
	Move inner container to bottom and left boundary of scrollview.
local	jumpToBottomLeft ()
	Move inner container to bottom and left boundary of scrollview.
virtual void	jumpToBottomRight () override
	Move inner container to bottom and right boundary of scrollview.
var	jumpToBottomRight ()
	Move inner container to bottom and right boundary of scrollview.
local	jumpToBottomRight ()
	Move inner container to bottom and right boundary of scrollview.
virtual void	jumpToPercentVertical (float percent) override
	Move inner container to vertical percent position of scrollview. More...
local	jumpToPercentVertical ( local percent)
	Move inner container to vertical percent position of scrollview. More...
virtual void	jumpToPercentHorizontal (float percent) override
	Move inner container to horizontal percent position of scrollview. More...
var	jumpToPercentHorizontal ( var percent)
	Move inner container to horizontal percent position of scrollview. More...
local	jumpToPercentHorizontal ( local percent)
	Move inner container to horizontal percent position of scrollview. More...
virtual void	jumpToPercentBothDirection (const Vec2 &percent) override
	Move inner container to both direction percent position of scrollview. More...
var	jumpToPercentBothDirection ( var percent)
	Move inner container to both direction percent position of scrollview. More...
local	jumpToPercentBothDirection ( local percent)
	Move inner container to both direction percent position of scrollview. More...
void	jumpToItem (ssize_t itemIndex, const Vec2 &positionRatioInView, const Vec2 &itemAnchorPoint)
	Jump to specific item. More...
void	scrollToItem (ssize_t itemIndex, const Vec2 &positionRatioInView, const Vec2 &itemAnchorPoint)
	Scroll to specific item. More...
ssize_t	getCurSelectedIndex () const
	Query current selected widget's index. More...
var	getCurSelectedIndex ()
	Query current selected widget's index. More...
local	getCurSelectedIndex ()
	Query current selected widget's index. More...
void	setCurSelectedIndex (int itemIndex)
	Set current selected widget's index and call TouchEventType::ENDED event. More...
void	addEventListenerListView (Ref *target, SEL_ListViewEvent selector)
	Add an event click callback to ListView, then one item of Listview is clicked, the callback will be called. More...
var	addEventListenerListView ( var target, var selector)
	Add an event click callback to ListView, then one item of Listview is clicked, the callback will be called. More...
local	addEventListenerListView ( local target, local selector)
	Add an event click callback to ListView, then one item of Listview is clicked, the callback will be called. More...
void	requestRefreshView ()
	Refresh view and layout of ListView manually. More...
var	requestRefreshView ()
	Refresh view and layout of ListView manually. More...
local	requestRefreshView ()
	Refresh view and layout of ListView manually. More...
void	refreshView ()
	Refresh content view of ListView. More...
Public Member Functions inherited from ScrollView
	ScrollView ()
	Default constructor. More...
	ctor ()
	Default constructor. More...
	new ()
	Default constructor. More...
virtual	~ScrollView ()
	Default destructor. More...
Direction	getDirection () const
	Query scroll direction of scrollview. More...
Layout *	getInnerContainer () const
	Get inner container of scrollview. More...
virtual void	stopScroll ()
	Immediately stops inner container scroll (auto scrolling is not affected).
virtual void	stopAutoScroll ()
	Immediately stops inner container scroll initiated by any of the "scrollTo*" member functions.
var	stopAutoScroll ()
	Immediately stops inner container scroll initiated by any of the "scrollTo*" member functions.
local	stopAutoScroll ()
	Immediately stops inner container scroll initiated by any of the "scrollTo*" member functions.
virtual void	stopOverallScroll ()
	Immediately stops inner container scroll if any.
local	stopOverallScroll ()
	Immediately stops inner container scroll if any.
virtual void	scrollToBottom (float timeInSec, bool attenuated)
	Scroll inner container to bottom boundary of scrollview. More...
var	scrollToBottom ( var timeInSec, var attenuated)
	Scroll inner container to bottom boundary of scrollview. More...
local	scrollToBottom ( local timeInSec, local attenuated)
	Scroll inner container to bottom boundary of scrollview. More...
virtual void	scrollToTop (float timeInSec, bool attenuated)
	Scroll inner container to top boundary of scrollview. More...
virtual void	scrollToLeft (float timeInSec, bool attenuated)
	Scroll inner container to left boundary of scrollview. More...
virtual void	scrollToRight (float timeInSec, bool attenuated)
	Scroll inner container to right boundary of scrollview. More...
var	scrollToRight ( var timeInSec, var attenuated)
	Scroll inner container to right boundary of scrollview. More...
local	scrollToRight ( local timeInSec, local attenuated)
	Scroll inner container to right boundary of scrollview. More...
virtual void	scrollToTopLeft (float timeInSec, bool attenuated)
	Scroll inner container to top and left boundary of scrollview. More...
var	scrollToTopLeft ( var timeInSec, var attenuated)
	Scroll inner container to top and left boundary of scrollview. More...
local	scrollToTopLeft ( local timeInSec, local attenuated)
	Scroll inner container to top and left boundary of scrollview. More...
virtual void	scrollToTopRight (float timeInSec, bool attenuated)
	Scroll inner container to top and right boundary of scrollview. More...
var	scrollToTopRight ( var timeInSec, var attenuated)
	Scroll inner container to top and right boundary of scrollview. More...
local	scrollToTopRight ( local timeInSec, local attenuated)
	Scroll inner container to top and right boundary of scrollview. More...
virtual void	scrollToBottomLeft (float timeInSec, bool attenuated)
	Scroll inner container to bottom and left boundary of scrollview. More...
var	scrollToBottomLeft ( var timeInSec, var attenuated)
	Scroll inner container to bottom and left boundary of scrollview. More...
local	scrollToBottomLeft ( local timeInSec, local attenuated)
	Scroll inner container to bottom and left boundary of scrollview. More...
virtual void	scrollToBottomRight (float timeInSec, bool attenuated)
	Scroll inner container to bottom and right boundary of scrollview. More...
virtual void	scrollToPercentVertical (float percent, float timeInSec, bool attenuated)
	Scroll inner container to vertical percent position of scrollview. More...
local	scrollToPercentVertical ( local percent, local timeInSec, local attenuated)
	Scroll inner container to vertical percent position of scrollview. More...
virtual void	scrollToPercentHorizontal (float percent, float timeInSec, bool attenuated)
	Scroll inner container to horizontal percent position of scrollview. More...
virtual void	scrollToPercentBothDirection (const Vec2 &percent, float timeInSec, bool attenuated)
	Scroll inner container to both direction percent position of scrollview. More...
float	getScrolledPercentVertical () const
float	getScrolledPercentHorizontal () const
Vec2	getScrolledPercentBothDirection () const
void	setInnerContainerSize (const Size &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	setInnerContainerPosition (const Vec2 &pos)
	Set inner container position. More...
var	setInnerContainerPosition ( var pos)
	Set inner container position. More...
local	setInnerContainerPosition ( local pos)
	Set inner container position. More...
const Vec2 &	getInnerContainerPosition () const
	Get inner container position. 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 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...
var	onTouchEnded ( var touch, var unusedEvent)
	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...
var	update ( var dt)
	Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More...
local	update ( local dt)
	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...
void	setScrollBarEnabled (bool enabled)
	Toggle scroll bar enabled. More...
var	setScrollBarEnabled ( var enabled)
	Toggle scroll bar enabled. More...
local	setScrollBarEnabled ( local enabled)
	Toggle scroll bar enabled. More...
bool	isScrollBarEnabled () const
	Query scroll bar state. More...
void	setScrollBarPositionFromCorner (const Vec2 &positionFromCorner)
	Set the scroll bar positions from the left-bottom corner (horizontal) and right-top corner (vertical). More...
void	setScrollBarPositionFromCornerForVertical (const Vec2 &positionFromCorner)
	Set the vertical scroll bar position from right-top corner. More...
Vec2	getScrollBarPositionFromCornerForVertical () const
	Get the vertical scroll bar's position from right-top corner. More...
void	setScrollBarPositionFromCornerForHorizontal (const Vec2 &positionFromCorner)
	Set the horizontal scroll bar position from left-bottom corner. More...
var	setScrollBarPositionFromCornerForHorizontal ( var positionFromCorner)
	Set the horizontal scroll bar position from left-bottom corner. More...
local	setScrollBarPositionFromCornerForHorizontal ( local positionFromCorner)
	Set the horizontal scroll bar position from left-bottom corner. More...
Vec2	getScrollBarPositionFromCornerForHorizontal () const
	Get the horizontal scroll bar's position from right-top corner. More...
void	setScrollBarWidth (float width)
	Set the scroll bar's width. More...
float	getScrollBarWidth () const
	Get the scroll bar's width. More...
var	getScrollBarWidth ()
	Get the scroll bar's width. More...
local	getScrollBarWidth ()
	Get the scroll bar's width. More...
void	setScrollBarColor (const Color3B &color)
	Set the scroll bar's color. More...
var	setScrollBarColor ( var color)
	Set the scroll bar's color. More...
local	setScrollBarColor ( local color)
	Set the scroll bar's color. More...
const Color3B &	getScrollBarColor () const
	Get the scroll bar's color. More...
var	getScrollBarColor ()
	Get the scroll bar's color. More...
local	getScrollBarColor ()
	Get the scroll bar's color. More...
void	setScrollBarOpacity (GLubyte opacity)
	Set the scroll bar's opacity. More...
var	setScrollBarOpacity ( var opacity)
	Set the scroll bar's opacity. More...
local	setScrollBarOpacity ( local opacity)
	Set the scroll bar's opacity. More...
GLubyte	getScrollBarOpacity () const
	Get the scroll bar's opacity. More...
var	getScrollBarOpacity ()
	Get the scroll bar's opacity. More...
local	getScrollBarOpacity ()
	Get the scroll bar's opacity. More...
void	setScrollBarAutoHideEnabled (bool autoHideEnabled)
	Set scroll bar auto hide state. More...
var	setScrollBarAutoHideEnabled ( var autoHideEnabled)
	Set scroll bar auto hide state. More...
local	setScrollBarAutoHideEnabled ( local autoHideEnabled)
	Set scroll bar auto hide state. More...
bool	isScrollBarAutoHideEnabled () const
	Query scroll bar auto hide state. More...
void	setScrollBarAutoHideTime (float autoHideTime)
	Set scroll bar auto hide time. More...
var	setScrollBarAutoHideTime ( var autoHideTime)
	Set scroll bar auto hide time. More...
local	setScrollBarAutoHideTime ( local autoHideTime)
	Set scroll bar auto hide time. More...
float	getScrollBarAutoHideTime () const
	Get the scroll bar's auto hide time. More...
void	setTouchTotalTimeThreshold (float touchTotalTimeThreshold)
	Set the touch total time threshold. More...
var	setTouchTotalTimeThreshold ( var touchTotalTimeThreshold)
	Set the touch total time threshold. More...
local	setTouchTotalTimeThreshold ( local touchTotalTimeThreshold)
	Set the touch total time threshold. More...
float	getTouchTotalTimeThreshold () const
	Get the touch total time threshold. More...
var	getTouchTotalTimeThreshold ()
	Get the touch total time threshold. More...
local	getTouchTotalTimeThreshold ()
	Get the touch total time threshold. 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...
var	getLayoutType ()
	Get the layout type for scrollview. More...
local	getLayoutType ()
	Get the layout type for scrollview. More...
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 void	onExit () override
	Event callback that is invoked every time the Node leaves the 'stage'. More...
var	onExit ()
	Event callback that is invoked every time the Node leaves 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...
bool	isScrolling () const
bool	isAutoScrolling () const
Public Member Functions inherited from Layout
	Layout ()
	Default constructor. More...
	ctor ()
	Default constructor. More...
	new ()
	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...
var	setBackGroundImageCapInsets ( var 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...
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...
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...
var	setBackGroundColor ( var color)
	Set background color for layout The color only applies to layout when it's color type is BackGroundColorType::SOLIDE. More...
local	setBackGroundColor ( local 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...
local	getBackGroundEndColor ()
	Get the gradient background end color. More...
void	setBackGroundColorOpacity (GLubyte opacity)
	Sets background color opacity of layout. More...
var	setBackGroundColorOpacity ( var 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...
var	getBackGroundImageColor ()
	Get color of layout's background image. More...
local	getBackGroundImageColor ()
	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
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
var	forceDoLayout ()
	force refresh widget layout
local	forceDoLayout ()
	force refresh widget layout
virtual void	setGlobalZOrder (float globalZOrder) override
	Defines the order in which the nodes are renderer. More...
local	setGlobalZOrder ( local globalZOrder)
	Defines the order in which the nodes are renderer. More...
void	setLoopFocus (bool loop)
	If a layout is loop focused which means that the focus movement will be inside the layout. More...
var	setLoopFocus ( var loop)
	If a layout is loop focused which means that the focus movement will be inside the layout. More...
local	setLoopFocus ( local loop)
	If a layout is loop focused which means that the focus movement will be inside the layout. More...
bool	isLoopFocus () const
var	isLoopFocus ()
local	isLoopFocus ()
void	setPassFocusToChild (bool pass)
bool	isPassFocusToChild () const
virtual void	setCameraMask (unsigned short mask, bool applyChildren=true) override
	Override function. More...
var	setCameraMask ( var mask, var true)
	Override function. More...
local	setCameraMask ( local mask, local true)
	Override function. More...
Public Member Functions inherited from Widget
	Widget (void)
	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...
var	setBrightStyle ( var style)
	To set the bright style of widget. More...
local	setBrightStyle ( local 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...
var	isHighlighted ()
	Determines if the widget is highlighted. More...
local	isHighlighted ()
	Determines if the widget is highlighted. More...
void	setHighlighted (bool highlight)
	Sets whether the widget is highlighted. More...
float	getLeftInParent ()
	Gets the left boundary position of this widget in parent's coordination system. More...
var	getLeftInParent ()
	Gets the left boundary position of this widget in parent's coordination system. More...
local	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...
var	getLeftBoundary ()
	Gets the left boundary position of this widget in parent's coordination system. More...
local	getLeftBoundary ()
	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...
var	getBottomBoundary ()
	Gets the bottom boundary position of this widget in parent's coordination system. More...
local	getBottomBoundary ()
	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...
var	getRightBoundary ()
	Gets the right boundary position of this widget in parent's coordination system. More...
local	getRightBoundary ()
	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...
var	getTopInParent ()
	Gets the top boundary position of this widget in parent's coordination system. More...
local	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...
var	getTopBoundary ()
	Gets the top boundary position of this widget in parent's coordination system. More...
local	getTopBoundary ()
	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.
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...
var	addClickEventListener ( var callback)
	Set a click event handler to the widget. More...
local	addClickEventListener ( local 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...
var	addCCSEventListener ( var 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 ()
local	isFlipX ()
void	setFlipX (bool flipX)
var	setFlipX ( var flipX)
local	setFlipX ( local flipX)
bool	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...
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...
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...
local	setScale ( local scalex, local scaley)
	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...
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...
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...
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...
var	getTouchBeganPosition ()
	Gets the touch began point of widget when widget is selected. More...
local	getTouchBeganPosition ()
	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...
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...
var	setSizeType ( var type)
	Changes the size type of widget. More...
local	setSizeType ( local 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...
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, const Camera *camera, Vec3 *p) const
	Checks a point is in widget's content space. More...
local	hitTest ( local pt, local camera, local p)
	Checks a point is in widget's content space. More...
void	setLayoutParameter (LayoutParameter *parameter)
	Sets a LayoutParameter to widget. More...
var	setLayoutParameter ( var parameter)
	Sets a LayoutParameter to widget. More...
local	setLayoutParameter ( local 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 defined 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...
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...
var	setFocusEnabled ( var enable)
	Allow widget to accept focus. More...
local	setFocusEnabled ( local 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...
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...
var	isUnifySizeEnabled ()
	Query whether unify size enable state. More...
local	isUnifySizeEnabled ()
	Query whether unify size enable state. More...
void	setCallbackName (const std::string &callbackName)
	Set callback name. More...
const std::string &	getCallbackName () const
	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...
var	getCallbackType ()
	Query callback type. More...
local	getCallbackType ()
	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...
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	updateDisplayedOpacity (GLubyte parentOpacity) override
	Update the displayed opacity of node with it's parent opacity;. More...
var	updateDisplayedOpacity ( var parentOpacity)
	Update the displayed opacity of node with it's parent opacity;. More...
local	updateDisplayedOpacity ( local parentOpacity)
	Update the displayed opacity of node with it's parent opacity;. More...
virtual void	updateDisplayedColor (const Color3B &parentColor) override
	Update node's displayed color with its parent color. More...
local	updateDisplayedColor ( local parentColor)
	Update node's displayed color with its parent color. 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...
var	removeProtectedChildByTag ( var tag, var 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...
var	isRunning ()
	Returns whether or not the node is "running". More...
local	isRunning ()
	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...
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...
var	setEventDispatcher ( var 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...
virtual GLubyte	getOpacity () const
	Return the node's opacity. More...
local	getOpacity ()
	Return the node's opacity. More...
virtual GLubyte	getDisplayedOpacity () const
	Return the node's display opacity. More...
local	getDisplayedOpacity ()
	Return the node's display opacity. More...
virtual void	setOpacity (GLubyte opacity)
	Change node opacity. More...
virtual bool	isCascadeOpacityEnabled () const
	Whether cascadeOpacity is enabled or not. More...
var	isCascadeOpacityEnabled ()
	Whether cascadeOpacity is enabled or not. More...
local	isCascadeOpacityEnabled ()
	Whether cascadeOpacity is enabled or not. More...
virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
	Change node's cascadeOpacity property. More...
local	setCascadeOpacityEnabled ( local cascadeOpacityEnabled)
	Change node's cascadeOpacity property. More...
virtual const Color3B &	getColor () const
	Query node's color value. More...
local	getColor ()
	Query node's color value. More...
virtual const Color3B &	getDisplayedColor () const
	Query node's displayed color. More...
local	getDisplayedColor ()
	Query node's displayed color. More...
virtual void	setColor (const Color3B &color)
	Change the color of node. More...
var	setColor ( var color)
	Change the color of node. More...
local	setColor ( local color)
	Change the color of node. More...
virtual bool	isCascadeColorEnabled () const
	Query whether cascadeColor is enabled or not. More...
var	isCascadeColorEnabled ()
	Query whether cascadeColor is enabled or not. More...
local	isCascadeColorEnabled ()
	Query whether cascadeColor is enabled or not. More...
virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)
	If you want node's color affect the children node's color, then set it to true. More...
virtual void	setOpacityModifyRGB (bool value)
	If you want the opacity affect the color property, then set to true. More...
local	setOpacityModifyRGB ( local value)
	If you want the opacity affect the color property, then set to true. More...
virtual bool	isOpacityModifyRGB () const
	If node opacity will modify the RGB color value, then you should override this method and return true. More...
void	setOnEnterCallback (const std::function< void()> &callback)
	Set the callback of event onEnter. More...
const std::function< void()> &	getOnEnterCallback () const
	Get the callback of event onEnter. More...
void	setOnExitCallback (const std::function< void()> &callback)
	Set the callback of event onExit. More...
var	setOnExitCallback ( var callback)
	Set the callback of event onExit. More...
local	setOnExitCallback ( local callback)
	Set the callback of event onExit. More...
const std::function< void()> &	getOnExitCallback () const
	Get the callback of event onExit. More...
local	getOnExitCallback ()
	Get the callback of event onExit. More...
void	setonEnterTransitionDidFinishCallback (const std::function< void()> &callback)
	Set the callback of event EnterTransitionDidFinish. More...
var	setonEnterTransitionDidFinishCallback ( var callback)
	Set the callback of event EnterTransitionDidFinish. More...
local	setonEnterTransitionDidFinishCallback ( local callback)
	Set the callback of event EnterTransitionDidFinish. More...
const std::function< void()> &	getonEnterTransitionDidFinishCallback () const
	Get the callback of event EnterTransitionDidFinish. More...
void	setonExitTransitionDidStartCallback (const std::function< void()> &callback)
	Set the callback of event ExitTransitionDidStart. More...
var	setonExitTransitionDidStartCallback ( var callback)
	Set the callback of event ExitTransitionDidStart. More...
local	setonExitTransitionDidStartCallback ( local callback)
	Set the callback of event ExitTransitionDidStart. More...
const std::function< void()> &	getonExitTransitionDidStartCallback () const
	Get the callback of event ExitTransitionDidStart. More...
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 (std::int32_t localZOrder)
	LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
virtual void	setZOrder (std::int32_t localZOrder)
virtual void	_setLocalZOrder (std::int32_t z)
local	_setLocalZOrder ( local z)
void	updateOrderOfArrival ()
	!!! ONLY FOR INTERNAL USE Sets the arrival order when this node has a same ZOrder with other children. More...
virtual std::int32_t	getLocalZOrder () const
	Gets the local Z order of this node. More...
virtual std::int32_t	getZOrder () const
var	getZOrder ()
local	getZOrder ()
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...
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	setPositionNormalized (const Vec2 &position)
	Sets the position (x,y) using values between 0 and 1. More...
virtual void	setNormalizedPosition (const Vec2 &position)
local	setNormalizedPosition ( local position)
virtual const Vec2 &	getPosition () const
	Gets the position (x,y) of the node in its parent's coordinate system. More...
local	getPosition ()
	Gets the position (x,y) of the node in its parent's coordinate system. More...
virtual const Vec2 &	getPositionNormalized () const
	Returns the normalized position. More...
virtual const Vec2 &	getNormalizedPosition () const
virtual void	setPosition (float x, float 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...
var	setPositionX ( var x)
	Gets/Sets x or y coordinate individually for position. More...
local	setPositionX ( local 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...
local	setPositionY ( local 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...
var	getPositionY ()
	Gets the y coordinate of the node in its parent's coordinate system. More...
local	getPositionY ()
	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...
local	setPosition3D ( local 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...
local	getPosition3D ()
	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...
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...
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...
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...
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...
virtual const Vec2 &	getAnchorPointInPoints () const
	Returns the anchorPoint in absolute pixels. More...
virtual const Size &	getContentSize () const
	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...
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...
local	getRotationQuat ()
	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...
virtual void	setRotationX (float 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...
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)
var	setRotationY ( var 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	setGLServerState (int)
var	setGLServerState ( var int)
int	getGLServerState () const
virtual void	setIgnoreAnchorPointForPosition (bool ignore)
	Sets whether the anchor point will be (0,0) when you position this node. More...
local	setIgnoreAnchorPointForPosition ( local ignore)
	Sets whether the anchor point will be (0,0) when you position this node. More...
virtual void	ignoreAnchorPointForPosition (bool ignore)
local	ignoreAnchorPointForPosition ( local ignore)
virtual bool	isIgnoreAnchorPointForPosition () const
	Gets whether the anchor point will be (0,0) when you position this node. 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 const 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...
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...
var	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...
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...
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...
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...
void	stopActionsByFlags (unsigned int flags)
	Removes all actions from the running action list by its flags. 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...
ssize_t	getNumberOfRunningActionsByTag (int tag) const
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays) with a specific tag. More...
local	getNumberOfRunningActionsByTag ( local tag)
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays) with a specific tag. More...
ssize_t	numberOfRunningActions () const
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 Scheduler object. More...
local	getScheduler ()
	Gets a Scheduler object. More...
virtual const Scheduler *	getScheduler () const
local	getScheduler ()
bool	isScheduled (SEL_SCHEDULE selector) const
	Checks whether a selector is scheduled. More...
bool	isScheduled (const std::string &key) const
	Checks whether a lambda function is scheduled. More...
void	scheduleUpdate (void)
	Schedules the "update" method. More...
var	scheduleUpdate ()
	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...
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...
var	schedule ( var callback, var 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...
void	unschedule (SEL_SCHEDULE 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...
var	resume ()
	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...
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 Mat4	getNodeToParentTransform (Node *ancestor) const
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
var	getNodeToParentTransform ( var ancestor)
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
local	getNodeToParentTransform ( local ancestor)
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
virtual AffineTransform	getNodeToParentAffineTransform (Node *ancestor) const
	Returns the affine transform matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
local	getNodeToParentAffineTransform ( local ancestor)
	Returns the affine transform matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
virtual void	setNodeToParentTransform (const Mat4 &transform)
	Sets the transformation matrix manually. More...
var	setNodeToParentTransform ( var transform)
	Sets the transformation matrix manually. More...
local	setNodeToParentTransform ( local transform)
	Sets the transformation matrix manually. More...
virtual AffineTransform	nodeToParentTransform () const
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...
var	getNodeToWorldTransform ()
	Returns the world affine transform matrix. More...
local	getNodeToWorldTransform ()
	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...
var	convertToWorldSpaceAR ( var nodePoint)
	Converts a local Vec2 to world space coordinates.The result is in Points. More...
local	convertToWorldSpaceAR ( local nodePoint)
	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...
local	convertTouchToNodeSpace ( local touch)
	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 (const Mat4 *additionalTransform)
	Sets an additional transform matrix to the node. More...
void	setAdditionalTransform (const Mat4 &additionalTransform)
var	setAdditionalTransform ( var additionalTransform)
local	setAdditionalTransform ( local additionalTransform)
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...
local	getComponent ( local name)
	Gets a component by its name. More...
virtual bool	addComponent (Component *component)
	Adds a component. More...
local	addComponent ( local component)
	Adds a component. More...
virtual bool	removeComponent (const std::string &name)
	Removes a component by its name. More...
local	removeComponent ( local name)
	Removes a component by its name. More...
virtual bool	removeComponent (Component *component)
	Removes a component by its pointer. More...
local	removeComponent ( local component)
	Removes a component by its pointer. More...
virtual void	removeAllComponents ()
	Removes all components.
template<typename T >
T	getChildByTag (int tag) const
	Gets a child from the container with its tag that can be cast to Type T. 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...
template<typename T >
var	getChildByName ( var name)
	Gets a child from the container with its name that can be cast to Type T. More...
template<typename T >
local	getChildByName ( local name)
	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
local	getParent ()
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...
var	removeChildByTag ( var tag, var 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...
virtual void	reorderChild (Node *child, int localZOrder)
	Reorders a child according to a new z value. More...
var	reorderChild ( var child, var 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...
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...
void	release ()
	Releases the ownership immediately. More...
local	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...
local	getReferenceCount ()
	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 PageView *	create ()
	Create an empty PageView. More...
var	create ()
	Create an empty PageView. More...
local	create ()
	Create an empty PageView. More...
Static Public Member Functions inherited from ListView
static ListView *	create ()
	Create an empty ListView. More...
var	create ()
	Create an empty ListView. More...
local	create ()
	Create an empty ListView. More...
Static Public Member Functions inherited from ScrollView
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.
var	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.
local	create ()
	Create and return a empty Widget instance pointer.
static Widget *	getCurrentFocusedWidget ()
	Return a current focused widget in your UI scene. More...
var	getCurrentFocusedWidget ()
	Return a current focused widget in your UI scene. More...
local	getCurrentFocusedWidget ()
	Return a current focused widget in your UI scene. More...
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...
static int	getAttachedNodeCount ()
	Gets count of nodes those are attached to scene graph.
var	getAttachedNodeCount ()
	Gets count of nodes those are attached to scene graph.
local	getAttachedNodeCount ()
	Gets count of nodes those are attached to scene graph.
template<typename _T >
static void	sortNodes (cocos2d::Vector< _T * > &nodes)
	Sorts helper function. 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
local	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.
local	_luaID
	Lua reference id.
void *	_scriptObject
	scriptObject, support for swift
local	_scriptObject
	scriptObject, support for swift
bool	_rooted
	When true, it means that the object was already rooted.
local	_rooted
	When true, it means that the object was already rooted.
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.
void	onFocusChange (Widget *widgetLostFocus, Widget *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 manager that allows the user to flip left & right and up & down through pages of data.

Constructor & Destructor Documentation

PageView

(

)

Default constructor.

var ctor

(

)

Default constructor.

local new

(

)

Default constructor.

virtual ~PageView ( )

virtual

Default destructor.

Member Function Documentation

static PageView* create ( )

static

Create an empty PageView.

Returns

A PageView instance.

var create ( )

static

Create an empty PageView.

Returns

A PageView instance.

local create ( )

static

Create an empty PageView.

Returns

A PageView instance.

virtual void setDirection ( Direction  direction )

overridevirtual

Changes direction Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll.

Parameters

direction

Set the page view's scroll direction.

Reimplemented from ListView.

var setDirection ( var  direction )

overridevirtual

Changes direction Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll.

Parameters

direction

Set the page view's scroll direction.

Reimplemented from ListView.

local setDirection ( local  direction )

overridevirtual

Changes direction Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll.

Parameters

direction

Set the page view's scroll direction.

Reimplemented from ListView.

void addWidgetToPage	(	Widget *	widget,
		ssize_t	pageIdx,
		bool	forceCreate
	)

Add a widget as a page of PageView in a given index.

Parameters

widget	Widget to be added to pageview.
pageIdx	A given index.
forceCreate	If forceCreate is true and widget isn't exists, pageview would create a default page and add it.

Since v3.9, this is deprecated. Use insertPage(Widget* page, int idx) instead.

var addWidgetToPage	(	var	widget,
		var	pageIdx,
		var	forceCreate
	)

Add a widget as a page of PageView in a given index.

Parameters

widget	Widget to be added to pageview.
pageIdx	A given index.
forceCreate	If forceCreate is true and widget isn't exists, pageview would create a default page and add it.

Since v3.9, this is deprecated. Use insertPage(Widget* page, int idx) instead.

local addWidgetToPage	(	local	widget,
		local	pageIdx,
		local	forceCreate
	)

Add a widget as a page of PageView in a given index.

Parameters

widget	Widget to be added to pageview.
pageIdx	A given index.
forceCreate	If forceCreate is true and widget isn't exists, pageview would create a default page and add it.

Since v3.9, this is deprecated. Use insertPage(Widget* page, int idx) instead.

void addPage

(

Widget *

page

)

Insert a page into the end of PageView.

Parameters

page	Page to be inserted.

var addPage

(

var

page

)

Insert a page into the end of PageView.

Parameters

page	Page to be inserted.

local addPage

(

local

page

)

Insert a page into the end of PageView.

Parameters

page	Page to be inserted.

void insertPage	(	Widget *	page,
		int	idx
	)

Insert a page into PageView at a given index.

Parameters

page	Page to be inserted.
idx	A given index.

var insertPage	(	var	page,
		var	idx
	)

Insert a page into PageView at a given index.

Parameters

page	Page to be inserted.
idx	A given index.

local insertPage	(	local	page,
		local	idx
	)

Insert a page into PageView at a given index.

Parameters

page	Page to be inserted.
idx	A given index.

void removePage

(

Widget *

page

)

Remove a page of PageView.

Parameters

page	Page to be removed.

var removePage

(

var

page

)

Remove a page of PageView.

Parameters

page	Page to be removed.

local removePage

(

local

page

)

Remove a page of PageView.

Parameters

page	Page to be removed.

void removePageAtIndex

(

ssize_t

index

)

Remove a page at a given index of PageView.

Parameters

index

A given index.

var removePageAtIndex

(

var

index

)

Remove a page at a given index of PageView.

Parameters

index

A given index.

local removePageAtIndex

(

local

index

)

Remove a page at a given index of PageView.

Parameters

index

A given index.

void scrollToPage

(

ssize_t

idx

)

Scroll to a page with a given index.

Parameters

idx	A given index in the PageView. Index start from 0 to pageCount -1.

var scrollToPage

(

var

idx

)

Scroll to a page with a given index.

Parameters

idx	A given index in the PageView. Index start from 0 to pageCount -1.

local scrollToPage

(

local

idx

)

Scroll to a page with a given index.

Parameters

idx	A given index in the PageView. Index start from 0 to pageCount -1.

void scrollToPage	(	ssize_t	idx,
		float	time
	)

Scroll to a page with a given index and with a given scroll time.

Parameters

idx	A given index in the PageView. Index start from 0 to pageCount -1.
time	Scroll time must be >= 0. Otherwise last set scroll time will be used.

var scrollToPage	(	var	idx,
		var	time
	)

Scroll to a page with a given index and with a given scroll time.

Parameters

idx	A given index in the PageView. Index start from 0 to pageCount -1.
time	Scroll time must be >= 0. Otherwise last set scroll time will be used.

local scrollToPage	(	local	idx,
		local	time
	)

Scroll to a page with a given index and with a given scroll time.

Parameters

idx	A given index in the PageView. Index start from 0 to pageCount -1.
time	Scroll time must be >= 0. Otherwise last set scroll time will be used.

void scrollToItem

(

ssize_t

itemIndex

)

Scroll to a page with a given index.

Parameters

itemIndex

A given index in the PageView. Index start from 0 to pageCount -1.

var scrollToItem

(

var

itemIndex

)

Scroll to a page with a given index.

Parameters

itemIndex

A given index in the PageView. Index start from 0 to pageCount -1.

local scrollToItem

(

local

itemIndex

)

Scroll to a page with a given index.

Parameters

itemIndex

A given index in the PageView. Index start from 0 to pageCount -1.

void scrollToItem	(	ssize_t	idx,
		float	time
	)

Scroll to a item with a given index and with a given scroll time.

Parameters

idx	A given index in the PageView. Index start from 0 to pageCount -1.
time	Scroll time must be >= 0. Otherwise last set scrolltime will be used.

var scrollToItem	(	var	idx,
		var	time
	)

Scroll to a item with a given index and with a given scroll time.

Parameters

idx	A given index in the PageView. Index start from 0 to pageCount -1.
time	Scroll time must be >= 0. Otherwise last set scrolltime will be used.

local scrollToItem	(	local	idx,
		local	time
	)

Scroll to a item with a given index and with a given scroll time.

Parameters

idx	A given index in the PageView. Index start from 0 to pageCount -1.
time	Scroll time must be >= 0. Otherwise last set scrolltime will be used.

ssize_t getCurPageIndex

(

)

const

Gets current displayed page index.

Returns

current page index.

Since v3.9, this is deprecated. Use getCurrentPageIndex() instead.

var getCurPageIndex

(

)

Gets current displayed page index.

Returns

current page index.

Since v3.9, this is deprecated. Use getCurrentPageIndex() instead.

local getCurPageIndex

(

)

Gets current displayed page index.

Returns

current page index.

Since v3.9, this is deprecated. Use getCurrentPageIndex() instead.

ssize_t getCurrentPageIndex

(

)

Gets current displayed page index.

Returns

current page index.

var getCurrentPageIndex

(

)

Gets current displayed page index.

Returns

current page index.

local getCurrentPageIndex

(

)

Gets current displayed page index.

Returns

current page index.

void setCurPageIndex

(

ssize_t

index

)

Jump to a page with a given index without scrolling.

This is the different between scrollToPage.

Parameters

index

A given index in PageView. Index start from 0 to pageCount -1.

Since v3.9, this is deprecated. Use setCurrentPageIndex() instead.

var setCurPageIndex

(

var

index

)

Jump to a page with a given index without scrolling.

This is the different between scrollToPage.

Parameters

index

A given index in PageView. Index start from 0 to pageCount -1.

Since v3.9, this is deprecated. Use setCurrentPageIndex() instead.

local setCurPageIndex

(

local

index

)

Jump to a page with a given index without scrolling.

This is the different between scrollToPage.

Parameters

index

A given index in PageView. Index start from 0 to pageCount -1.

Since v3.9, this is deprecated. Use setCurrentPageIndex() instead.

void setCurrentPageIndex

(

ssize_t

index

)

Jump to a page with a given index without scrolling.

This is the different between scrollToPage.

Parameters

index

A given index in PageView. Index start from 0 to pageCount -1.

var setCurrentPageIndex

(

var

index

)

Jump to a page with a given index without scrolling.

This is the different between scrollToPage.

Parameters

index

A given index in PageView. Index start from 0 to pageCount -1.

local setCurrentPageIndex

(

local

index

)

Jump to a page with a given index without scrolling.

This is the different between scrollToPage.

Parameters

index

A given index in PageView. Index start from 0 to pageCount -1.

Vector<Layout*>& getPages

(

)

Get all the pages in the PageView.

Returns

A vector of Layout pointers.

Since v3.9, this is obsolete. Use Vector<Widget*>& ListView::getItems() instead.

var getPages

(

)

Get all the pages in the PageView.

Returns

A vector of Layout pointers.

Since v3.9, this is obsolete. Use Vector<Widget*>& ListView::getItems() instead.

local getPages

(

)

Get all the pages in the PageView.

Returns

A vector of Layout pointers.

Since v3.9, this is obsolete. Use Vector<Widget*>& ListView::getItems() instead.

Layout* getPage

(

ssize_t

index

)

Get a page at a given index.

Parameters

index

A given index.

Returns

A layout pointer in PageView container.

Since v3.9, this is obsolete. Use Widget* ListView::getItem(index) instead.

var getPage

(

var

index

)

Get a page at a given index.

Parameters

index

A given index.

Returns

A layout pointer in PageView container.

Since v3.9, this is obsolete. Use Widget* ListView::getItem(index) instead.

local getPage

(

local

index

)

Get a page at a given index.

Parameters

index

A given index.

Returns

A layout pointer in PageView container.

Since v3.9, this is obsolete. Use Widget* ListView::getItem(index) instead.

void addEventListenerPageView	(	Ref *	target,
		SEL_PageViewEvent	selector
	)

Add a page turn callback to PageView, then when one page is turning, the callback will be called.

var addEventListenerPageView	(	var	target,
		var	selector
	)

Add a page turn callback to PageView, then when one page is turning, the callback will be called.

local addEventListenerPageView	(	local	target,
		local	selector
	)

Add a page turn callback to PageView, then when one page is turning, the callback will be called.

void addEventListener ( const ccPageViewCallback &  callback )

virtual

Add a page turn callback to PageView, then when one page is turning, the callback will be called.

Parameters

callback

A page turning callback.

Reimplemented from ListView.

var addEventListener ( var  callback )

virtual

Add a page turn callback to PageView, then when one page is turning, the callback will be called.

Parameters

callback

A page turning callback.

Reimplemented from ListView.

local addEventListener ( local  callback )

virtual

Add a page turn callback to PageView, then when one page is turning, the callback will be called.

Parameters

callback

A page turning callback.

Reimplemented from ListView.

void setIndicatorEnabled

(

bool

enabled

)

Toggle page indicator enabled.

Parameters

enabled

True if enable page indicator, false otherwise.

var setIndicatorEnabled

(

var

enabled

)

Toggle page indicator enabled.

Parameters

enabled

True if enable page indicator, false otherwise.

local setIndicatorEnabled

(

local

enabled

)

Toggle page indicator enabled.

Parameters

enabled

True if enable page indicator, false otherwise.

bool getIndicatorEnabled ( ) const

inline

Query page indicator state.

Returns

True if page indicator is enabled, false otherwise.

var getIndicatorEnabled ( )

inline

Query page indicator state.

Returns

True if page indicator is enabled, false otherwise.

local getIndicatorEnabled ( )

inline

Query page indicator state.

Returns

True if page indicator is enabled, false otherwise.

void setIndicatorPositionAsAnchorPoint

(

const Vec2 &

positionAsAnchorPoint

)

Set the page indicator's position using anchor point.

Parameters

positionAsAnchorPoint

The position as anchor point.

var setIndicatorPositionAsAnchorPoint

(

var

positionAsAnchorPoint

)

Set the page indicator's position using anchor point.

Parameters

positionAsAnchorPoint

The position as anchor point.

local setIndicatorPositionAsAnchorPoint

(

local

positionAsAnchorPoint

)

Set the page indicator's position using anchor point.

Parameters

positionAsAnchorPoint

The position as anchor point.

const Vec2& getIndicatorPositionAsAnchorPoint

(

)

const

Get the page indicator's position as anchor point.

Returns

positionAsAnchorPoint

var getIndicatorPositionAsAnchorPoint

(

)

Get the page indicator's position as anchor point.

Returns

positionAsAnchorPoint

local getIndicatorPositionAsAnchorPoint

(

)

Get the page indicator's position as anchor point.

Returns

positionAsAnchorPoint

void setIndicatorPosition

(

const Vec2 &

position

)

Set the page indicator's position in page view.

Parameters

position

The position in page view

var setIndicatorPosition

(

var

position

)

Set the page indicator's position in page view.

Parameters

position

The position in page view

local setIndicatorPosition

(

local

position

)

Set the page indicator's position in page view.

Parameters

position

The position in page view

const Vec2& getIndicatorPosition

(

)

const

Get the page indicator's position.

Returns

positionAsAnchorPoint

var getIndicatorPosition

(

)

Get the page indicator's position.

Returns

positionAsAnchorPoint

local getIndicatorPosition

(

)

Get the page indicator's position.

Returns

positionAsAnchorPoint

void setIndicatorSpaceBetweenIndexNodes

(

float

spaceBetweenIndexNodes

)

Set space between page indicator's index nodes.

Parameters

spaceBetweenIndexNodes

Space between nodes in pixel.

var setIndicatorSpaceBetweenIndexNodes

(

var

spaceBetweenIndexNodes

)

Set space between page indicator's index nodes.

Parameters

spaceBetweenIndexNodes

Space between nodes in pixel.

local setIndicatorSpaceBetweenIndexNodes

(

local

spaceBetweenIndexNodes

)

Set space between page indicator's index nodes.

Parameters

spaceBetweenIndexNodes

Space between nodes in pixel.

float getIndicatorSpaceBetweenIndexNodes

(

)

const

Get the space between page indicator's index nodes.

Returns

spaceBetweenIndexNodes

var getIndicatorSpaceBetweenIndexNodes

(

)

Get the space between page indicator's index nodes.

Returns

spaceBetweenIndexNodes

local getIndicatorSpaceBetweenIndexNodes

(

)

Get the space between page indicator's index nodes.

Returns

spaceBetweenIndexNodes

void setIndicatorSelectedIndexColor

(

const Color3B &

color

)

Set color of page indicator's selected index.

Parameters

color

New color for selected (current) index.

var setIndicatorSelectedIndexColor

(

var

color

)

Set color of page indicator's selected index.

Parameters

color

New color for selected (current) index.

local setIndicatorSelectedIndexColor

(

local

color

)

Set color of page indicator's selected index.

Parameters

color

New color for selected (current) index.

const Color3B& getIndicatorSelectedIndexColor

(

)

const

Get the color of page indicator's selected index.

Returns

color

var getIndicatorSelectedIndexColor

(

)

Get the color of page indicator's selected index.

Returns

color

local getIndicatorSelectedIndexColor

(

)

Get the color of page indicator's selected index.

Returns

color

void setIndicatorIndexNodesColor

(

const Color3B &

color

)

Set color of page indicator's index nodes.

Parameters

color

New indicator node color.

var setIndicatorIndexNodesColor

(

var

color

)

Set color of page indicator's index nodes.

Parameters

color

New indicator node color.

local setIndicatorIndexNodesColor

(

local

color

)

Set color of page indicator's index nodes.

Parameters

color

New indicator node color.

const Color3B& getIndicatorIndexNodesColor

(

)

const

Get the color of page indicator's index nodes.

Returns

color

var getIndicatorIndexNodesColor

(

)

Get the color of page indicator's index nodes.

Returns

color

local getIndicatorIndexNodesColor

(

)

Get the color of page indicator's index nodes.

Returns

color

void setIndicatorSelectedIndexOpacity

(

GLubyte

opacity

)

Set opacity of page indicator's selected index.

Parameters

color

New opacity for selected (current) index.

var setIndicatorSelectedIndexOpacity

(

var

opacity

)

Set opacity of page indicator's selected index.

Parameters

color

New opacity for selected (current) index.

local setIndicatorSelectedIndexOpacity

(

local

opacity

)

Set opacity of page indicator's selected index.

Parameters

color

New opacity for selected (current) index.

GLubyte getIndicatorSelectedIndexOpacity

(

)

const

Get the opacity of page indicator's selected index.

Returns

opacity

var getIndicatorSelectedIndexOpacity

(

)

Get the opacity of page indicator's selected index.

Returns

opacity

local getIndicatorSelectedIndexOpacity

(

)

Get the opacity of page indicator's selected index.

Returns

opacity

void setIndicatorIndexNodesOpacity

(

GLubyte

opacity

)

Set opacity of page indicator's index nodes.

Parameters

opacity

New indicator node opacity.

var setIndicatorIndexNodesOpacity

(

var

opacity

)

Set opacity of page indicator's index nodes.

Parameters

opacity

New indicator node opacity.

local setIndicatorIndexNodesOpacity

(

local

opacity

)

Set opacity of page indicator's index nodes.

Parameters

opacity

New indicator node opacity.

GLubyte getIndicatorIndexNodesOpacity

(

)

const

Get the opacity of page indicator's index nodes.

Returns

opacity

var getIndicatorIndexNodesOpacity

(

)

Get the opacity of page indicator's index nodes.

Returns

opacity

local getIndicatorIndexNodesOpacity

(

)

Get the opacity of page indicator's index nodes.

Returns

opacity

void setIndicatorIndexNodesScale

(

float

indexNodesScale

)

Set scale of page indicator's index nodes.

Parameters

indexNodesScale

Scale of index nodes.

var setIndicatorIndexNodesScale

(

var

indexNodesScale

)

Set scale of page indicator's index nodes.

Parameters

indexNodesScale

Scale of index nodes.

local setIndicatorIndexNodesScale

(

local

indexNodesScale

)

Set scale of page indicator's index nodes.

Parameters

indexNodesScale

Scale of index nodes.

void setIndicatorIndexNodesTexture	(	const std::string &	texName,
		Widget::TextureResType	texType = Widget::TextureResType::LOCAL
	)

sets texture for index nodes.

Parameters

fileName	File name of texture.
resType

See also

TextureResType .

var setIndicatorIndexNodesTexture	(	var	texName,
		var	texType = Widget::TextureResType::LOCAL
	)

sets texture for index nodes.

Parameters

fileName	File name of texture.
resType

See also

TextureResType .

local setIndicatorIndexNodesTexture	(	local	texName,
		local	texType = Widget::TextureResType::LOCAL
	)

sets texture for index nodes.

Parameters

fileName	File name of texture.
resType

See also

TextureResType .

float getIndicatorIndexNodesScale

(

)

const

Get scale of page indicator's index nodes.

Returns

indexNodesScale

var getIndicatorIndexNodesScale

(

)

Get scale of page indicator's index nodes.

Returns

indexNodesScale

local getIndicatorIndexNodesScale

(

)

Get scale of page indicator's index nodes.

Returns

indexNodesScale

void setCustomScrollThreshold

(

float

threshold

)

If you don't specify the value, the pageView will turn page when scrolling at the half width of a page.

Parameters

threshold

A threshold in float.

var setCustomScrollThreshold

(

var

threshold

)

If you don't specify the value, the pageView will turn page when scrolling at the half width of a page.

Parameters

threshold

A threshold in float.

local setCustomScrollThreshold

(

local

threshold

)

If you don't specify the value, the pageView will turn page when scrolling at the half width of a page.

Parameters

threshold

A threshold in float.

float getCustomScrollThreshold

(

)

const

Query the custom scroll threshold of the PageView.

Returns

Custom scroll threshold in float.

var getCustomScrollThreshold

(

)

Query the custom scroll threshold of the PageView.

Returns

Custom scroll threshold in float.

local getCustomScrollThreshold

(

)

Query the custom scroll threshold of the PageView.

Returns

Custom scroll threshold in float.

void setUsingCustomScrollThreshold

(

bool

flag

)

Set using user defined scroll page threshold or not.

If you set it to false, then the default scroll threshold is pageView.width / 2

Parameters

flag	True if using custom scroll threshold, false otherwise.

var setUsingCustomScrollThreshold

(

var

flag

)

Set using user defined scroll page threshold or not.

If you set it to false, then the default scroll threshold is pageView.width / 2

Parameters

flag	True if using custom scroll threshold, false otherwise.

local setUsingCustomScrollThreshold

(

local

flag

)

Set using user defined scroll page threshold or not.

If you set it to false, then the default scroll threshold is pageView.width / 2

Parameters

flag	True if using custom scroll threshold, false otherwise.

bool isUsingCustomScrollThreshold

(

)

const

Query whether use user defined scroll page threshold or not.

Returns

True if using custom scroll threshold, false otherwise.

var isUsingCustomScrollThreshold

(

)

Query whether use user defined scroll page threshold or not.

Returns

True if using custom scroll threshold, false otherwise.

local isUsingCustomScrollThreshold

(

)

Query whether use user defined scroll page threshold or not.

Returns

True if using custom scroll threshold, false otherwise.

---

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

• UIPageView.h