cocos2d-x  3.1rc0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ListView Class Reference

#include <UIListView.h>

Inheritance diagram for ListView:
ScrollView Layout UIScrollInterface Widget ProtectedNode Node Ref

Public Types

enum  Gravity {
  LEFT, RIGHT, CENTER_HORIZONTAL, TOP,
  BOTTOM, CENTER_VERTICAL
}
 
enum  EventType { ON_SELECTED_ITEM_START, ON_SELECTED_ITEM_END }
 
typedef std::function< void(Ref
*, EventType)> 
ccListViewCallback
- Public Types inherited from ScrollView
enum  Direction { NONE, VERTICAL, HORIZONTAL, BOTH }
 
enum  EventType {
  SCROLL_TO_TOP, SCROLL_TO_BOTTOM, SCROLL_TO_LEFT, SCROLL_TO_RIGHT,
  SCROLLING, BOUNCE_TOP, BOUNCE_BOTTOM, BOUNCE_LEFT,
  BOUNCE_RIGHT
}
 
typedef std::function< void(Ref
*, EventType)> 
ccScrollViewCallback
- Public Types inherited from Layout
enum  Type { ABSOLUTE, VERTICAL, HORIZONTAL, RELATIVE }
 
enum  ClippingType { STENCIL, SCISSOR }
 
enum  BackGroundColorType { NONE, SOLID, GRADIENT }
 
- Public Types inherited from Widget
enum  FocusDirection { LEFT, RIGHT, UP, DOWN }
 
enum  PositionType { ABSOLUTE, PERCENT }
 
enum  SizeType { ABSOLUTE, PERCENT }
 
enum  TouchEventType { BEGAN, MOVED, ENDED, CANCELED }
 
enum  TextureResType { LOCAL = 0, PLIST = 1 }
 
enum  BrightStyle { NONE = -1, NORMAL, HIGHLIGHT }
 
typedef std::function< void(Ref
*, Widget::TouchEventType)> 
ccWidgetTouchCallback

Public Member Functions

 ListView ()
 Default constructor. More...
 
 ListView ()
 Default constructor. More...
 
 ListView ()
 Default constructor. More...
 
virtual ~ListView ()
 Default destructor. More...
 
var ~ListView ()
 Default destructor. More...
 
local ~ListView ()
 Default destructor. More...
 
void setItemModel (Widget *model)
 Sets a item model for listview. More...
 
local setItemModel ( local model)
 Sets a item model for listview. More...
 
void pushBackDefaultItem ()
 Push back a default item(create by a cloned model) into listview. More...
 
void insertDefaultItem (ssize_t index)
 Insert a default item(create by a cloned model) into listview. More...
 
local insertDefaultItem ( local index)
 Insert a default item(create by a cloned model) into listview. More...
 
void pushBackCustomItem (Widget *item)
 Push back custom item into listview. More...
 
var pushBackCustomItem ( var item)
 Push back custom item into listview. More...
 
local pushBackCustomItem ( local item)
 Push back custom item into listview. More...
 
void insertCustomItem (Widget *item, ssize_t index)
 Insert custom item into listview. More...
 
var insertCustomItem ( var item, var index)
 Insert custom item into listview. More...
 
local insertCustomItem ( local item, local index)
 Insert custom item into listview. More...
 
void removeLastItem ()
 Removes the last item of listview. More...
 
var removeLastItem ()
 Removes the last item of listview. More...
 
void removeItem (ssize_t index)
 Removes a item whose index is same as the parameter. More...
 
void removeAllItems ()
var removeAllItems ()
local removeAllItems ()
WidgetgetItem (ssize_t index)
 Returns a item whose index is same as the parameter. More...
 
var getItem ( var index)
 Returns a item whose index is same as the parameter. More...
 
local getItem ( local index)
 Returns a item whose index is same as the parameter. More...
 
Vector< Widget * > & getItems ()
 Returns the item container. More...
 
var getItems ()
 Returns the item container. More...
 
local getItems ()
 Returns the item container. More...
 
ssize_t getIndex (Widget *item) const
 Returns the index of item. More...
 
void setGravity (Gravity gravity)
 Changes the gravity of listview. More...
 
void setItemsMargin (float margin)
 Changes the margin between each item. More...
 
var setItemsMargin ( var margin)
 Changes the margin between each item. More...
 
local setItemsMargin ( local margin)
 Changes the margin between each item. More...
 
float getItemsMargin ()
var getItemsMargin ()
local getItemsMargin ()
virtual void sortAllChildren () override
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
var sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
local sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
ssize_t getCurSelectedIndex () const
var getCurSelectedIndex ()
local getCurSelectedIndex ()
CC_DEPRECATED_ATTRIBUTE void addEventListenerListView (Ref *target, SEL_ListViewEvent selector)
local addEventListenerListView ( local target, local selector)
void addEventListener (const ccListViewCallback &callback)
var addEventListener ( var callback)
local addEventListener ( local callback)
virtual void setDirection (Direction dir) override
 Changes scroll direction of scrollview. More...
 
local setDirection ( local dir)
 Changes scroll direction of scrollview. More...
 
virtual std::string getDescription () const override
 Returns the "class name" of widget. More...
 
var getDescription ()
 Returns the "class name" of widget. More...
 
local getDescription ()
 Returns the "class name" of widget. More...
 
void requestRefreshView ()
var requestRefreshView ()
local requestRefreshView ()
void refreshView ()
var refreshView ()
local refreshView ()
- Public Member Functions inherited from ScrollView
 ScrollView ()
 Default constructor. More...
 
 ScrollView ()
 Default constructor. More...
 
 ScrollView ()
 Default constructor. More...
 
virtual ~ScrollView ()
 Default destructor. More...
 
local ~ScrollView ()
 Default destructor. More...
 
Direction getDirection ()
 Gets scroll direction of scrollview. More...
 
local getDirection ()
 Gets scroll direction of scrollview. More...
 
LayoutgetInnerContainer ()
 Gets inner container of scrollview. More...
 
local getInnerContainer ()
 Gets inner container of scrollview. More...
 
void scrollToBottom (float time, bool attenuated)
 Scroll inner container to bottom boundary of scrollview. More...
 
local scrollToBottom ( local time, local attenuated)
 Scroll inner container to bottom boundary of scrollview. More...
 
void scrollToTop (float time, bool attenuated)
 Scroll inner container to top boundary of scrollview. More...
 
local scrollToTop ( local time, local attenuated)
 Scroll inner container to top boundary of scrollview. More...
 
void scrollToLeft (float time, bool attenuated)
 Scroll inner container to left boundary of scrollview. More...
 
var scrollToLeft ( var time, var attenuated)
 Scroll inner container to left boundary of scrollview. More...
 
local scrollToLeft ( local time, local attenuated)
 Scroll inner container to left boundary of scrollview. More...
 
void scrollToRight (float time, bool attenuated)
 Scroll inner container to right boundary of scrollview. More...
 
var scrollToRight ( var time, var attenuated)
 Scroll inner container to right boundary of scrollview. More...
 
local scrollToRight ( local time, local attenuated)
 Scroll inner container to right boundary of scrollview. More...
 
void scrollToTopLeft (float time, bool attenuated)
 Scroll inner container to top and left boundary of scrollview. More...
 
var scrollToTopLeft ( var time, var attenuated)
 Scroll inner container to top and left boundary of scrollview. More...
 
local scrollToTopLeft ( local time, local attenuated)
 Scroll inner container to top and left boundary of scrollview. More...
 
void scrollToTopRight (float time, bool attenuated)
 Scroll inner container to top and right boundary of scrollview. More...
 
void scrollToBottomLeft (float time, bool attenuated)
 Scroll inner container to bottom and left boundary of scrollview. More...
 
void scrollToBottomRight (float time, bool attenuated)
 Scroll inner container to bottom and right boundary of scrollview. More...
 
void scrollToPercentVertical (float percent, float time, bool attenuated)
 Scroll inner container to vertical percent position of scrollview. More...
 
var scrollToPercentVertical ( var percent, var time, var attenuated)
 Scroll inner container to vertical percent position of scrollview. More...
 
local scrollToPercentVertical ( local percent, local time, local attenuated)
 Scroll inner container to vertical percent position of scrollview. More...
 
void scrollToPercentHorizontal (float percent, float time, bool attenuated)
 Scroll inner container to horizontal percent position of scrollview. More...
 
void scrollToPercentBothDirection (const Vec2 &percent, float time, bool attenuated)
 Scroll inner container to both direction percent position of scrollview. More...
 
void jumpToBottom ()
 Move inner container to bottom boundary of scrollview. More...
 
var jumpToBottom ()
 Move inner container to bottom boundary of scrollview. More...
 
local jumpToBottom ()
 Move inner container to bottom boundary of scrollview. More...
 
void jumpToTop ()
 Move inner container to top boundary of scrollview. More...
 
var jumpToTop ()
 Move inner container to top boundary of scrollview. More...
 
local jumpToTop ()
 Move inner container to top boundary of scrollview. More...
 
void jumpToLeft ()
 Move inner container to left boundary of scrollview. More...
 
var jumpToLeft ()
 Move inner container to left boundary of scrollview. More...
 
local jumpToLeft ()
 Move inner container to left boundary of scrollview. More...
 
void jumpToRight ()
 Move inner container to right boundary of scrollview. More...
 
var jumpToRight ()
 Move inner container to right boundary of scrollview. More...
 
local jumpToRight ()
 Move inner container to right boundary of scrollview. More...
 
void jumpToTopLeft ()
 Move inner container to top and left boundary of scrollview. More...
 
var jumpToTopLeft ()
 Move inner container to top and left boundary of scrollview. More...
 
local jumpToTopLeft ()
 Move inner container to top and left boundary of scrollview. More...
 
void jumpToTopRight ()
 Move inner container to top and right boundary of scrollview. More...
 
var jumpToTopRight ()
 Move inner container to top and right boundary of scrollview. More...
 
local jumpToTopRight ()
 Move inner container to top and right boundary of scrollview. More...
 
void jumpToBottomLeft ()
 Move inner container to bottom and left boundary of scrollview. More...
 
void jumpToBottomRight ()
 Move inner container to bottom and right boundary of scrollview. More...
 
void jumpToPercentVertical (float percent)
 Move inner container to vertical percent position of scrollview. More...
 
void jumpToPercentHorizontal (float percent)
 Move inner container to horizontal percent position of scrollview. More...
 
void jumpToPercentBothDirection (const Vec2 &percent)
 Move inner container to both direction percent position of scrollview. More...
 
void setInnerContainerSize (const Size &size)
 Changes inner container size of scrollview. More...
 
const SizegetInnerContainerSize () const
 Gets inner container size of scrollview. More...
 
var getInnerContainerSize ()
 Gets inner container size of scrollview. More...
 
local getInnerContainerSize ()
 Gets inner container size of scrollview. More...
 
CC_DEPRECATED_ATTRIBUTE void addEventListenerScrollView (Ref *target, SEL_ScrollViewEvent selector)
 Add call back function called scrollview event triggered. More...
 
local addEventListenerScrollView ( local target, local selector)
 Add call back function called scrollview event triggered. More...
 
void addEventListener (const ccScrollViewCallback &callback)
local addEventListener ( local callback)
virtual bool onTouchBegan (Touch *touch, Event *unusedEvent) override
local onTouchBegan ( local touch, local unusedEvent)
virtual void onTouchMoved (Touch *touch, Event *unusedEvent) override
local onTouchMoved ( local touch, local unusedEvent)
virtual void onTouchEnded (Touch *touch, Event *unusedEvent) override
local onTouchEnded ( local touch, local unusedEvent)
virtual void onTouchCancelled (Touch *touch, Event *unusedEvent) override
local onTouchCancelled ( local touch, local unusedEvent)
virtual void update (float dt) override
var update ( var dt)
local update ( local dt)
void setBounceEnabled (bool enabled)
var setBounceEnabled ( var enabled)
local setBounceEnabled ( local enabled)
bool isBounceEnabled () const
var isBounceEnabled ()
local isBounceEnabled ()
void setInertiaScrollEnabled (bool enabled)
var setInertiaScrollEnabled ( var enabled)
local setInertiaScrollEnabled ( local enabled)
bool isInertiaScrollEnabled () const
var isInertiaScrollEnabled ()
local isInertiaScrollEnabled ()
virtual void setLayoutType (Type type) override
 Sets LayoutType. More...
 
var setLayoutType ( var type)
 Sets LayoutType. More...
 
local setLayoutType ( local type)
 Sets LayoutType. More...
 
virtual Type getLayoutType () const override
 Gets LayoutType. More...
 
local getLayoutType ()
 Gets LayoutType. 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...
 
local onEnter ()
 Event callback that is invoked every time when Node enters the 'stage'. More...
 
- Public Member Functions inherited from Layout
 Layout ()
virtual ~Layout ()
 Default destructor. More...
 
void setBackGroundImage (const std::string &fileName, TextureResType texType=TextureResType::LOCAL)
 Sets a background image for layout. More...
 
void setBackGroundImageCapInsets (const Rect &capInsets)
 Sets a background image capinsets for layout, if the background image is a scale9 render. More...
 
const RectgetBackGroundImageCapInsets ()
void setBackGroundColorType (BackGroundColorType type)
 Sets Color Type for layout. More...
 
BackGroundColorType getBackGroundColorType ()
void setBackGroundImageScale9Enabled (bool enabled)
 Sets background iamge use scale9 renderer. More...
 
bool isBackGroundImageScale9Enabled ()
void setBackGroundColor (const Color3B &color)
 Sets background color for layout, if color type is LAYOUT_COLOR_SOLID. More...
 
const Color3BgetBackGroundColor ()
void setBackGroundColor (const Color3B &startColor, const Color3B &endColor)
 Sets background color for layout, if color type is LAYOUT_COLOR_GRADIENT. More...
 
const Color3BgetBackGroundStartColor ()
const Color3BgetBackGroundEndColor ()
void setBackGroundColorOpacity (GLubyte opacity)
 Sets background opacity layout. More...
 
GLubyte getBackGroundColorOpacity ()
void setBackGroundColorVector (const Vec2 &vector)
 Sets background color vector for layout, if color type is LAYOUT_COLOR_GRADIENT. More...
 
const Vec2getBackGroundColorVector ()
void setBackGroundImageColor (const Color3B &color)
void setBackGroundImageOpacity (GLubyte opacity)
const Color3BgetBackGroundImageColor ()
GLubyte getBackGroundImageOpacity ()
void removeBackGroundImage ()
 Remove the background image of layout. More...
 
const SizegetBackGroundImageTextureSize () const
 Gets background image texture size. More...
 
void setClippingType (ClippingType type)
ClippingType getClippingType ()
virtual bool isClippingEnabled ()
 Gets if layout is clipping enabled. More...
 
virtual void visit (Renderer *renderer, const Mat4 &parentTransform, bool parentTransformUpdated) override
 Visits this node's children and draw them recursively. More...
 
void requestDoLayout ()
virtual void onExit () override
 Event callback that is invoked every time the Node leaves the 'stage'. More...
 
void setLoopFocus (bool loop)
 If a layout is loop focused which means that the focus movement will be inside the layout. More...
 
bool isLoopFocus ()
void setPassFocusToChild (bool pass)
bool isPassFocusToChild ()
virtual WidgetfindNextFocusedWidget (FocusDirection direction, Widget *current) override
 When a widget is in a layout, you could call this method to get the next focused widget within a specified direction. More...
 
- Public Member Functions inherited from Widget
 Widget (void)
virtual ~Widget ()
 Default destructor. More...
 
virtual void setEnabled (bool enabled)
 Sets whether the widget is enabled. More...
 
bool isEnabled () const
 Determines if the widget is enabled. More...
 
void setBright (bool 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...
 
void setBrightStyle (BrightStyle style)
 To set the bright style of widget. More...
 
bool isTouchEnabled () const
 Determines if the widget is touch enabled. More...
 
bool isHighlighted () const
 Determines if the widget is highlighted. More...
 
void setHighlighted (bool hilight)
 Sets whether the widget is hilighted. More...
 
float getLeftInParent ()
 Gets the left boundary position of this widget. More...
 
float getBottomInParent ()
 Gets the bottom boundary position of this widget. More...
 
float getRightInParent ()
 Gets the right boundary position of this widget. More...
 
float getTopInParent ()
 Gets the top boundary position of this widget. More...
 
CC_DEPRECATED_ATTRIBUTE void addTouchEventListener (Ref *target, SEL_TouchEvent selector)
 Sets the touch event target/selector of the menu item. More...
 
void addTouchEventListener (ccWidgetTouchCallback callback)
virtual void setPosition (const Vec2 &pos) override
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
void setPositionPercent (const Vec2 &percent)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
const Vec2getPositionPercent ()
 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...
 
virtual bool isFlippedX ()
 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...
 
virtual bool isFlippedY ()
 Return the flag which indicates whether the widget is flipped vertically or not. More...
 
virtual void setColor (const Color3B &color) override
virtual void setOpacity (GLubyte opacity) override
const Color3BgetColor () const override
GLubyte getOpacity () const override
CC_DEPRECATED_ATTRIBUTE bool isFlipX ()
CC_DEPRECATED_ATTRIBUTE void setFlipX (bool flipX)
CC_DEPRECATED_ATTRIBUTE bool isFlipY ()
CC_DEPRECATED_ATTRIBUTE void setFlipY (bool flipY)
bool clippingParentAreaContainPoint (const Vec2 &pt)
const Vec2getTouchStartPos ()
const Vec2getTouchMovePos ()
const Vec2getTouchEndPos ()
void setName (const std::string &name)
 Changes the name that is used to identify the widget easily. More...
 
const std::string & getName () const
 Returns a name that is used to identify the widget easily. More...
 
virtual void setSize (const Size &size)
 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...
 
void setSizeType (SizeType type)
 Changes the size type of widget. More...
 
SizeType getSizeType () const
 Gets the size type of widget. More...
 
const SizegetSize () const
 Returns size of widget. More...
 
const SizegetCustomSize () const
virtual const SizegetLayoutSize ()
const Vec2getSizePercent () const
 Returns size percent of widget. More...
 
virtual bool hitTest (const Vec2 &pt)
 Checks a point if is in widget's space. More...
 
void setLayoutParameter (LayoutParameter *parameter)
 Sets a LayoutParameter to widget. More...
 
LayoutParametergetLayoutParameter (LayoutParameter::Type type)
 Gets LayoutParameter of widget. More...
 
virtual void ignoreContentAdaptWithSize (bool ignore)
 Ignore the widget size. More...
 
bool isIgnoreContentAdaptWithSize () const
 Gets the widget if is ignore it's size. More...
 
Vec2 getWorldPosition ()
 Gets world position of widget. More...
 
virtual NodegetVirtualRenderer ()
 Gets the Virtual Renderer of widget. More...
 
virtual const SizegetVirtualRendererSize () const
 Gets the content size of widget. More...
 
Widgetclone ()
void updateSizeAndPosition ()
void updateSizeAndPosition (const Size &parentSize)
void setActionTag (int tag)
int getActionTag ()
bool isFocused ()
void setFocused (bool focus)
bool isFocusEnabled ()
void setFocusEnabled (bool enable)
virtual WidgetfindNextFocusedWidget (FocusDirection direction, Widget *current)
 When a widget is in a layout, you could call this method to get the next focused widget within a specified direction. More...
 
void requestFocus ()
 when a widget calls this method, it will get focus immediately. More...
 
void onFocusChange (Widget *widgetLostFocus, Widget *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...
 
WidgetgetCurrentFocusedWidget (bool isWidget)
 no matter what widget object you call this method on , it will return you the exact one focused widget More...
 
- Public Member Functions inherited from ProtectedNode
virtual void cleanup () override
 Stops all running actions and schedulers. More...
 
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
var updateDisplayedOpacity ( var parentOpacity)
local updateDisplayedOpacity ( local parentOpacity)
virtual void updateDisplayedColor (const Color3B &parentColor) override
var updateDisplayedColor ( var parentColor)
local updateDisplayedColor ( local parentColor)
virtual void disableCascadeColor () override
var disableCascadeColor ()
local disableCascadeColor ()
virtual ~ProtectedNode ()
var ~ProtectedNode ()
local ~ProtectedNode ()
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...
 
local addProtectedChild ( local child, local localZOrder, local tag)
 Adds a child to the container with z order and tag. More...
 
virtual NodegetProtectedChildByTag (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...
 
var 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, bool transformUpdated)
 Override this method to draw your own node. More...
 
local draw ( local renderer, local transform, local transformUpdated)
 Override this method to draw your own node. More...
 
virtual void draw () final
var draw ()
local draw ()
virtual void visit () final
virtual ScenegetScene ()
 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
CC_DEPRECATED_ATTRIBUTE Rect 
boundingBox () const
local boundingBox ()
virtual void setEventDispatcher (EventDispatcher *dispatcher)
var setEventDispatcher ( var dispatcher)
local setEventDispatcher ( local dispatcher)
virtual EventDispatchergetEventDispatcher () const
local getEventDispatcher ()
virtual GLubyte getDisplayedOpacity () const
local getDisplayedOpacity ()
virtual bool isCascadeOpacityEnabled () const
var isCascadeOpacityEnabled ()
local isCascadeOpacityEnabled ()
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual const Color3BgetDisplayedColor () const
local getDisplayedColor ()
virtual bool isCascadeColorEnabled () const
var isCascadeColorEnabled ()
local isCascadeColorEnabled ()
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
virtual void setOpacityModifyRGB (bool bValue)
var setOpacityModifyRGB ( var bValue)
local setOpacityModifyRGB ( local bValue)
virtual bool isOpacityModifyRGB () const
var isOpacityModifyRGB ()
local isOpacityModifyRGB ()
virtual ~Node ()
var ~Node ()
local ~Node ()
virtual bool init ()
var init ()
local init ()
virtual void setLocalZOrder (int localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
var setLocalZOrder ( var localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
local setLocalZOrder ( local localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE void 
setZOrder (int localZOrder)
local setZOrder ( local localZOrder)
virtual void _setLocalZOrder (int z)
var _setLocalZOrder ( var z)
local _setLocalZOrder ( local z)
virtual int getLocalZOrder () const
 Gets the local Z order of this node. More...
 
local getLocalZOrder ()
 Gets the local Z order of this node. More...
 
virtual CC_DEPRECATED_ATTRIBUTE int getZOrder () const
local getZOrder ()
virtual void setGlobalZOrder (float globalZOrder)
 Defines the oder in which the nodes are renderer. More...
 
local setGlobalZOrder ( local globalZOrder)
 Defines the oder in which the nodes are renderer. More...
 
virtual float getGlobalZOrder () const
 Returns the Node's Global Z Order. More...
 
virtual void setScaleX (float scaleX)
 Sets the scale (x) of the node. More...
 
local setScaleX ( local scaleX)
 Sets the scale (x) of the node. More...
 
virtual float getScaleX () const
 Returns the scale factor on X axis of this node. More...
 
virtual void setScaleY (float scaleY)
 Sets the scale (y) of the node. More...
 
local setScaleY ( local scaleY)
 Sets the scale (y) of the node. More...
 
virtual float getScaleY () const
 Returns the scale factor on Y axis of this node. 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 setScale (float scale)
 Sets the scale (x,y,z) of the node. More...
 
var setScale ( var scale)
 Sets the scale (x,y,z) of the node. More...
 
local setScale ( local scale)
 Sets the scale (x,y,z) of the node. More...
 
virtual float getScale () const
 Gets the scale factor of the node, when X and Y have the same scale factor. More...
 
virtual void setScale (float scaleX, float scaleY)
 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 const Vec2getPosition () const
 Gets the position (x,y) of the node in its parent's coordinate system. More...
 
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...
 
var getPosition ( var x, var y)
 Gets position in a more efficient way, returns two number instead of a Vec2 object. More...
 
local getPosition ( local x, local y)
 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
var getPositionX ()
local getPositionX ()
virtual void setPositionY (float y)
local setPositionY ( local y)
virtual float getPositionY (void) const
local getPositionY ()
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...
 
virtual void setPositionZ (float positionZ)
 Sets the 'z' coordinate in the position. More...
 
local setPositionZ ( local positionZ)
 Sets the 'z' coordinate in the position. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE void 
setVertexZ (float vertexZ)
local setVertexZ ( local vertexZ)
virtual float getPositionZ () const
 Gets position Z coordinate of this node. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE float 
getVertexZ () const
local getVertexZ ()
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 Vec2getAnchorPoint () const
 Returns the anchor point in percent. More...
 
virtual const Vec2getAnchorPointInPoints () const
 Returns the anchorPoint in absolute pixels. More...
 
virtual void setContentSize (const Size &contentSize)
 Sets the untransformed size of the node. More...
 
local setContentSize ( local contentSize)
 Sets the untransformed size of the node. More...
 
virtual const SizegetContentSize () const
 Returns the untransformed size of the node. More...
 
local getContentSize ()
 Returns the untransformed size of the node. More...
 
virtual void setVisible (bool visible)
 Sets whether the node is visible. More...
 
local setVisible ( local visible)
 Sets whether the node is visible. More...
 
virtual bool isVisible () const
 Determines if the node is visible. More...
 
virtual void setRotation (float rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
var setRotation ( var 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...
 
var setRotation3D ( var 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...
 
var getRotation3D ()
 returns the rotation (X,Y,Z) in degrees. More...
 
local getRotation3D ()
 returns the rotation (X,Y,Z) in degrees. More...
 
virtual void setRotationSkewX (float rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
local setRotationSkewX ( local rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE 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
CC_DEPRECATED_ATTRIBUTE float 
getRotationX () const
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
CC_DEPRECATED_ATTRIBUTE void 
setRotationY (float rotationY)
local setRotationY ( local rotationY)
virtual float getRotationSkewY () const
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE float 
getRotationY () const
local getRotationY ()
void setOrderOfArrival (int orderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
int getOrderOfArrival () const
 Returns the arrival order, indicates which children is added previously. More...
 
CC_DEPRECATED_ATTRIBUTE void setGLServerState (int serverState)
CC_DEPRECATED_ATTRIBUTE int getGLServerState () const
virtual void ignoreAnchorPointForPosition (bool ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
virtual bool isIgnoreAnchorPointForPosition () const
 Gets whether the anchor point will be (0,0) when you position this node. More...
 
virtual void setParent (Node *parent)
 Sets the parent node. More...
 
local setParent ( local parent)
 Sets the parent node. More...
 
virtual NodegetParent ()
 Returns a pointer to the parent node. More...
 
virtual const NodegetParent () const
virtual void removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
virtual void removeFromParentAndCleanup (bool cleanup)
 Removes this node itself from its parent node. More...
 
local removeFromParent ( local cleanup)
 Removes this node itself from its parent node. More...
 
virtual void removeChildByTag (int tag, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
local removeChildByTag ( local tag, local true)
 Removes a child from the container by tag value. More...
 
virtual void 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 int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
local getTag ()
 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 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 RefgetUserObject ()
 Returns a user assigned Object. More...
 
virtual const RefgetUserObject () const
virtual void setUserObject (Ref *userObject)
 Returns a user assigned Object. More...
 
local setUserObject ( local userObject)
 Returns a user assigned Object. More...
 
GLProgramgetGLProgram ()
 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...
 
CC_DEPRECATED_ATTRIBUTE GLProgramgetShaderProgram ()
local getShaderProgram ()
GLProgramStategetGLProgramState ()
var getGLProgramState ()
local getGLProgramState ()
void setGLProgramState (GLProgramState *glProgramState)
var setGLProgramState ( var glProgramState)
local setGLProgramState ( local glProgramState)
void setGLProgram (GLProgram *glprogram)
 Sets the shader program for this node. More...
 
CC_DEPRECATED_ATTRIBUTE void setShaderProgram (GLProgram *glprogram)
local setShaderProgram ( local glprogram)
virtual void setActionManager (ActionManager *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 ActionManagergetActionManager ()
 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 ActionManagergetActionManager () const
local getActionManager ()
ActionrunAction (Action *action)
 Executes an action, and returns the action that is executed. More...
 
void stopAllActions ()
 Stops and removes all actions from the running action list . More...
 
var stopAllActions ()
 Stops and removes all actions from the running action list . More...
 
local stopAllActions ()
 Stops and removes all actions from the running action list . More...
 
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...
 
ActiongetActionByTag (int tag)
 Gets an action from the running action list by its tag. More...
 
ssize_t getNumberOfRunningActions () const
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
local getNumberOfRunningActions ()
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
CC_DEPRECATED_ATTRIBUTE 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 SchedulergetScheduler ()
 Gets a Sheduler object. More...
 
virtual const SchedulergetScheduler () const
local getScheduler ()
bool isScheduled (SEL_SCHEDULE selector)
 Checks whether a selector is scheduled. More...
 
void scheduleUpdate (void)
 Schedules the "update" method. More...
 
void scheduleUpdateWithPriority (int 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 schedule (SEL_SCHEDULE selector)
 Schedules a custom selector, the scheduled selector will be ticked every frame. More...
 
void unschedule (SEL_SCHEDULE selector)
 Unschedules a custom selector. More...
 
void unscheduleAllSelectors (void)
 Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...
 
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...
 
void pause (void)
 Pauses all scheduled selectors, actions and event listeners. More...
 
var pause ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
local pause ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
CC_DEPRECATED_ATTRIBUTE void resumeSchedulerAndActions (void)
 Resumes all scheduled selectors, actions and event listeners. More...
 
local resumeSchedulerAndActions ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
CC_DEPRECATED_ATTRIBUTE void pauseSchedulerAndActions (void)
 Pauses all scheduled selectors, actions and event listeners. More...
 
local pauseSchedulerAndActions ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
virtual void updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
var updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
local updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
virtual const Mat4getNodeToParentTransform () const
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual AffineTransform getNodeToParentAffineTransform () const
local getNodeToParentAffineTransform ()
virtual void setNodeToParentTransform (const Mat4 &transform)
 Sets the Transformation matrix manually. More...
 
local setNodeToParentTransform ( local transform)
 Sets the Transformation matrix manually. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
nodeToParentTransform () const
local nodeToParentTransform ()
virtual const Mat4getParentToNodeTransform () const
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
virtual AffineTransform getParentToNodeAffineTransform () const
local getParentToNodeAffineTransform ()
virtual
CC_DEPRECATED_ATTRIBUTE
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
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
nodeToWorldTransform () const
local nodeToWorldTransform ()
virtual Mat4 getWorldToNodeTransform () const
 Returns the inverse world affine transform matrix. More...
 
virtual AffineTransform getWorldToNodeAffineTransform () const
local getWorldToNodeAffineTransform ()
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
worldToNodeTransform () const
local worldToNodeTransform ()
Vec2 convertToNodeSpace (const Vec2 &worldPoint) const
 Converts a Vec2 to node (local) space coordinates. More...
 
Vec2 convertToWorldSpace (const Vec2 &nodePoint) const
 Converts a Vec2 to world space coordinates. More...
 
Vec2 convertToNodeSpaceAR (const Vec2 &worldPoint) const
 Converts a Vec2 to node (local) space coordinates. More...
 
Vec2 convertToWorldSpaceAR (const Vec2 &nodePoint) const
 Converts a local Vec2 to world space coordinates.The result is in Points. More...
 
Vec2 convertTouchToNodeSpace (Touch *touch) const
 convenience methods which take a Touch instead of Vec2 More...
 
Vec2 convertTouchToNodeSpaceAR (Touch *touch) const
 converts a Touch (world coordinates) into a local coordinate. More...
 
var convertTouchToNodeSpaceAR ( var touch)
 converts a Touch (world coordinates) into a local coordinate. More...
 
local convertTouchToNodeSpaceAR ( local touch)
 converts a Touch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (Mat4 *additionalTransform)
 Sets an additional transform matrix to the node. More...
 
var setAdditionalTransform ( var additionalTransform)
 Sets an additional transform matrix to the node. More...
 
local setAdditionalTransform ( local additionalTransform)
 Sets an additional transform matrix to the node. More...
 
void setAdditionalTransform (const AffineTransform &additionalTransform)
var setAdditionalTransform ( var additionalTransform)
local setAdditionalTransform ( local additionalTransform)
ComponentgetComponent (const std::string &pName)
 gets a component by its name More...
 
local getComponent ( local pName)
 gets a component by its name More...
 
virtual bool addComponent (Component *pComponent)
 adds a component More...
 
local addComponent ( local pComponent)
 adds a component More...
 
virtual bool removeComponent (const std::string &pName)
 removes a component by its name More...
 
local removeComponent ( local pName)
 removes a component by its name More...
 
virtual void removeAllComponents ()
 removes all components More...
 
var removeAllComponents ()
 removes all components More...
 
local removeAllComponents ()
 removes all components More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
- Public Member Functions inherited from UIScrollInterface
virtual ~UIScrollInterface ()
local ~UIScrollInterface ()

Static Public Member Functions

static ListViewcreate ()
 Allocates and initializes. More...
 
var create ()
 Allocates and initializes. More...
 
local create ()
 Allocates and initializes. More...
 
- Static Public Member Functions inherited from ScrollView
static ScrollViewcreate ()
 Allocates and initializes. More...
 
- Static Public Member Functions inherited from Layout
static Layoutcreate ()
 Allocates and initializes a layout. More...
 
- Static Public Member Functions inherited from Widget
static Widgetcreate ()
 Allocates and initializes a widget. More...
 
- Static Public Member Functions inherited from ProtectedNode
static ProtectedNodecreate (void)
- Static Public Member Functions inherited from Node
static Nodecreate (void)
 Allocates and initializes a node. More...
 
var create ()
 Allocates and initializes a node. More...
 
local create ()
 Allocates and initializes a node. More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: virtual bool init() override
- Public Attributes inherited from ScrollView
CC_CONSTRUCTOR_ACCESS __pad0__: virtual bool init() override
- 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...
 
CC_CONSTRUCTOR_ACCESS __pad0__: virtual bool init() override
- Public Attributes inherited from Widget
CC_CONSTRUCTOR_ACCESS __pad0__: virtual bool init() override
std::function< void(Widget
*, Widget *)> 
onFocusChanged
std::function< Widget
*(FocusDirection)> 
onNextFocusedWidget
- Public Attributes inherited from ProtectedNode
CC_CONSTRUCTOR_ACCESS __pad0__: ProtectedNode()
- Public Attributes inherited from Node
CC_CONSTRUCTOR_ACCESS __pad0__: Node()

Protected Member Functions

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 zOrder) override
 Adds a child to the container with a z-order. More...
 
local addChild ( local child, local zOrder)
 Adds a child to the container with a 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 removeChild (Node *widget, bool cleanup=true) override
 Removes a child from the container. More...
 
local removeChild ( local widget, local true)
 Removes a child from the container. 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 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 const Vector< Node * > & getChildren () const override
local getChildren ()
virtual ssize_t getChildrenCount () const override
 Returns the amount of children. More...
 
local getChildrenCount ()
 Returns the amount of children. More...
 
virtual NodegetChildByTag (int tag) override
 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 WidgetgetChildByName (const std::string &name) override
 Gets a child from the container with its name. More...
 
local getChildByName ( local name)
 Gets a child from the container with its name. More...
 
void updateInnerContainerSize ()
var updateInnerContainerSize ()
local updateInnerContainerSize ()
void remedyLayoutParameter (Widget *item)
var remedyLayoutParameter ( var item)
local remedyLayoutParameter ( local item)
virtual void onSizeChanged () override
var onSizeChanged ()
local onSizeChanged ()
virtual WidgetcreateCloneInstance () override
local createCloneInstance ()
virtual void copySpecialProperties (Widget *model) override
local copySpecialProperties ( local model)
virtual void copyClonedWidgetChildren (Widget *model) override
local copyClonedWidgetChildren ( local model)
void selectedItemEvent (int state)
var selectedItemEvent ( var state)
local selectedItemEvent ( local state)
virtual void interceptTouchEvent (int handleState, Widget *sender, const Vec2 &touchPoint) override
local interceptTouchEvent ( local handleState, local sender, local touchPoint)
- Protected Member Functions inherited from ScrollView
virtual void initRenderer () override
local initRenderer ()
void moveChildren (float offsetX, float offsetY)
var moveChildren ( var offsetX, var offsetY)
local moveChildren ( local offsetX, local offsetY)
void autoScrollChildren (float dt)
var autoScrollChildren ( var dt)
local autoScrollChildren ( local dt)
void bounceChildren (float dt)
var bounceChildren ( var dt)
local bounceChildren ( local dt)
void checkBounceBoundary ()
var checkBounceBoundary ()
local checkBounceBoundary ()
bool checkNeedBounce ()
var checkNeedBounce ()
local checkNeedBounce ()
void startAutoScrollChildrenWithOriginalSpeed (const Vec2 &dir, float v, bool attenuated, float acceleration)
void startAutoScrollChildrenWithDestination (const Vec2 &des, float time, bool attenuated)
var startAutoScrollChildrenWithDestination ( var des, var time, var attenuated)
local startAutoScrollChildrenWithDestination ( local des, local time, local attenuated)
void jumpToDestination (const Vec2 &des)
local jumpToDestination ( local des)
void stopAutoScrollChildren ()
var stopAutoScrollChildren ()
local stopAutoScrollChildren ()
void startBounceChildren (float v)
var startBounceChildren ( var v)
local startBounceChildren ( local v)
void stopBounceChildren ()
var stopBounceChildren ()
local stopBounceChildren ()
bool checkCustomScrollDestination (float *touchOffsetX, float *touchOffsetY)
var checkCustomScrollDestination ( var touchOffsetX, var touchOffsetY)
local checkCustomScrollDestination ( local touchOffsetX, local touchOffsetY)
virtual bool scrollChildren (float touchOffsetX, float touchOffsetY)
var scrollChildren ( var touchOffsetX, var touchOffsetY)
local scrollChildren ( local touchOffsetX, local touchOffsetY)
bool bounceScrollChildren (float touchOffsetX, float touchOffsetY)
var bounceScrollChildren ( var touchOffsetX, var touchOffsetY)
local bounceScrollChildren ( local touchOffsetX, local touchOffsetY)
void startRecordSlidAction ()
var startRecordSlidAction ()
local startRecordSlidAction ()
virtual void endRecordSlidAction ()
var endRecordSlidAction ()
local endRecordSlidAction ()
virtual void handlePressLogic (const Vec2 &touchPoint) override
var handlePressLogic ( var touchPoint)
local handlePressLogic ( local touchPoint)
virtual void handleMoveLogic (const Vec2 &touchPoint) override
virtual void handleReleaseLogic (const Vec2 &touchPoint) override
local handleReleaseLogic ( local touchPoint)
virtual void checkChildInfo (int handleState, Widget *sender, const Vec2 &touchPoint) override
void recordSlidTime (float dt)
var recordSlidTime ( var dt)
local recordSlidTime ( local dt)
void scrollToTopEvent ()
var scrollToTopEvent ()
local scrollToTopEvent ()
void scrollToBottomEvent ()
var scrollToBottomEvent ()
local scrollToBottomEvent ()
void scrollToLeftEvent ()
var scrollToLeftEvent ()
local scrollToLeftEvent ()
void scrollToRightEvent ()
var scrollToRightEvent ()
local scrollToRightEvent ()
void scrollingEvent ()
var scrollingEvent ()
local scrollingEvent ()
void bounceTopEvent ()
var bounceTopEvent ()
local bounceTopEvent ()
void bounceBottomEvent ()
var bounceBottomEvent ()
local bounceBottomEvent ()
void bounceLeftEvent ()
var bounceLeftEvent ()
local bounceLeftEvent ()
void bounceRightEvent ()
var bounceRightEvent ()
local bounceRightEvent ()
virtual void setClippingEnabled (bool able) override
 Changes if layout can clip it's content and child. More...
 
var setClippingEnabled ( var able)
 Changes if layout can clip it's content and child. More...
 
local setClippingEnabled ( local able)
 Changes if layout can clip it's content and child. More...
 
virtual void doLayout () override
var doLayout ()
local doLayout ()
- Protected Member Functions inherited from Layout
void addBackGroundImage ()
void supplyTheLayoutParameterLackToChild (Widget *child)
void stencilClippingVisit (Renderer *renderer, const Mat4 &parentTransform, bool parentTransformUpdated)
void scissorClippingVisit (Renderer *renderer, const Mat4 &parentTransform, bool parentTransformUpdated)
void setStencilClippingSize (const Size &size)
const RectgetClippingRect ()
void onBeforeVisitStencil ()
void onAfterDrawStencil ()
void onAfterVisitStencil ()
void onBeforeVisitScissor ()
void onAfterVisitScissor ()
void updateBackGroundImageColor ()
void updateBackGroundImageOpacity ()
void updateBackGroundImageRGBA ()
LayoutExecutant * createCurrentLayoutExecutant ()
Size getLayoutContentSize () const
 get the content size of the layout, it will accumulate all its children's content size More...
 
int findNearestChildWidgetIndex (FocusDirection direction, Widget *baseWidget)
 When the layout get focused, it the layout pass the focus to its child, it will use this method to determine which child will get the focus. More...
 
int findFarestChildWidgetIndex (FocusDirection direction, Widget *baseWidget)
 When the layout get focused, it the layout pass the focus to its child, it will use this method to determine which child will get the focus. More...
 
float caculateNearestDistance (Widget *baseWidget)
 caculate the nearest distance between the baseWidget and the children of the layout More...
 
float caculateFarestDistance (Widget *baseWidget)
 caculate the farest distance between the baseWidget and the children of the layout More...
 
void findProperSearchingFunctor (FocusDirection dir, Widget *baseWidget)
 when a layout pass the focus to it's child, use this method to determine which algorithm to use, nearest or farest distance algorithm or not More...
 
WidgetfindFirstNonLayoutWidget ()
 find the first non-layout widget in this layout More...
 
int findFirstFocusEnabledWidgetIndex ()
 find the fisrt focus enabled widget index in the layout, it will recusive searching the child widget More...
 
WidgetfindFocusEnabledChildWidgetByIndex (ssize_t index)
 find a focus enabled child Widget in the layout by index More...
 
Vec2 getWorldCenterPoint (Widget *node)
 get the center point of a widget in world space More...
 
WidgetgetNextFocusedWidget (FocusDirection direction, Widget *current)
 this method is called internally by nextFocusedWidget. More...
 
WidgetgetPreviousFocusedWidget (FocusDirection direction, Widget *current)
 this method is called internally by nextFocusedWidget. More...
 
WidgetgetChildWidgetByIndex (ssize_t index)
 find the nth elment in the _children array. More...
 
bool isLastWidgetInContainer (Widget *widget, FocusDirection direction)
 whether it is the last element according to all their parents More...
 
bool isWidgetAncestorSupportLoopFocus (Widget *widget, FocusDirection direction)
 Lookup any parent widget with a layout type as the direction, if the layout is loop focused, then return true, otherwise It returns false. More...
 
WidgetpassFocusToChild (FocusDirection direction, Widget *current)
 pass the focus to the layout's next focus enabled child More...
 
bool checkFocusEnabledChild ()
 If there are no focus enabled child in the layout, it will return false, otherwise it returns true. More...
 
- Protected Member Functions inherited from Widget
virtual void onPressStateChangedToNormal ()
virtual void onPressStateChangedToPressed ()
virtual void onPressStateChangedToDisabled ()
void pushDownEvent ()
void moveEvent ()
void releaseUpEvent ()
void cancelUpEvent ()
virtual void updateTextureColor ()
virtual void updateTextureOpacity ()
virtual void updateTextureRGBA ()
virtual void updateFlippedX ()
virtual void updateFlippedY ()
void updateColorToRenderer (Node *renderer)
void updateOpacityToRenderer (Node *renderer)
void updateRGBAToRenderer (Node *renderer)
void copyProperties (Widget *model)
WidgetgetWidgetParent ()
void updateContentSizeWithTextureSize (const Size &size)
virtual void adaptRenderers ()
bool isAncestorsEnabled ()
WidgetgetAncensterWidget (Node *node)
bool isAncestorsVisible (Node *node)
- Protected Member Functions inherited from ProtectedNode
void insertProtectedChild (Node *child, int z)
 helper that reorder a child More...
 
var insertProtectedChild ( var child, var z)
 helper that reorder a child More...
 
local insertProtectedChild ( local child, local z)
 helper that reorder a child More...
 
- Protected Member Functions inherited from Node
void childrenAlloc (void)
 lazy allocs More...
 
var childrenAlloc ()
 lazy allocs More...
 
local childrenAlloc ()
 lazy allocs More...
 
void insertChild (Node *child, int z)
 helper that reorder a child More...
 
var insertChild ( var child, var z)
 helper that reorder a child More...
 
local insertChild ( local child, local z)
 helper that reorder a child More...
 
void detachChild (Node *child, ssize_t index, bool doCleanup)
 Removes a child, call child->onExit(), do cleanup, remove it from children array. More...
 
Vec2 convertToWindowSpace (const Vec2 &nodePoint) const
 Convert cocos2d coordinates to UI windows coordinate. More...
 
Mat4 transform (const Mat4 &parentTransform)
var transform ( var parentTransform)
local transform ( local parentTransform)
virtual void updateCascadeOpacity ()
var updateCascadeOpacity ()
local updateCascadeOpacity ()
virtual void disableCascadeOpacity ()
var disableCascadeOpacity ()
local disableCascadeOpacity ()
virtual void updateCascadeColor ()
local updateCascadeColor ()
virtual void updateColor ()
var updateColor ()
local updateColor ()
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 

Protected Attributes

Widget_model
Vector< Widget * > _items
var _items
local _items
Gravity _gravity
var _gravity
local _gravity
float _itemsMargin
var _itemsMargin
local _itemsMargin
Ref_listViewEventListener
var _listViewEventListener
local _listViewEventListener
SEL_ListViewEvent _listViewEventSelector
var _listViewEventSelector
local _listViewEventSelector
ccListViewCallback _eventCallback
var _eventCallback
local _eventCallback
ssize_t _curSelectedIndex
local _curSelectedIndex
bool _refreshViewDirty
var _refreshViewDirty
local _refreshViewDirty
- Protected Attributes inherited from ScrollView
Layout_innerContainer
Direction _direction
var _direction
local _direction
Vec2 _touchBeganPoint
var _touchBeganPoint
local _touchBeganPoint
Vec2 _touchMovedPoint
var _touchMovedPoint
local _touchMovedPoint
Vec2 _touchEndedPoint
var _touchEndedPoint
local _touchEndedPoint
Vec2 _touchMovingPoint
var _touchMovingPoint
local _touchMovingPoint
Vec2 _autoScrollDir
var _autoScrollDir
local _autoScrollDir
float _topBoundary
var _topBoundary
local _topBoundary
float _bottomBoundary
var _bottomBoundary
local _bottomBoundary
float _leftBoundary
var _leftBoundary
local _leftBoundary
float _rightBoundary
var _rightBoundary
local _rightBoundary
float _bounceTopBoundary
var _bounceTopBoundary
local _bounceTopBoundary
float _bounceBottomBoundary
var _bounceBottomBoundary
local _bounceBottomBoundary
float _bounceLeftBoundary
var _bounceLeftBoundary
local _bounceLeftBoundary
float _bounceRightBoundary
var _bounceRightBoundary
local _bounceRightBoundary
bool _autoScroll
var _autoScroll
local _autoScroll
float _autoScrollAddUpTime
var _autoScrollAddUpTime
local _autoScrollAddUpTime
float _autoScrollOriginalSpeed
var _autoScrollOriginalSpeed
local _autoScrollOriginalSpeed
float _autoScrollAcceleration
var _autoScrollAcceleration
local _autoScrollAcceleration
bool _isAutoScrollSpeedAttenuated
var _isAutoScrollSpeedAttenuated
local _isAutoScrollSpeedAttenuated
bool _needCheckAutoScrollDestination
var _needCheckAutoScrollDestination
local _needCheckAutoScrollDestination
Vec2 _autoScrollDestination
var _autoScrollDestination
local _autoScrollDestination
bool _bePressed
var _bePressed
local _bePressed
float _slidTime
var _slidTime
local _slidTime
Vec2 _moveChildPoint
var _moveChildPoint
local _moveChildPoint
float _childFocusCancelOffset
var _childFocusCancelOffset
local _childFocusCancelOffset
bool _leftBounceNeeded
var _leftBounceNeeded
local _leftBounceNeeded
bool _topBounceNeeded
var _topBounceNeeded
local _topBounceNeeded
bool _rightBounceNeeded
var _rightBounceNeeded
local _rightBounceNeeded
bool _bottomBounceNeeded
var _bottomBounceNeeded
local _bottomBounceNeeded
bool _bounceEnabled
var _bounceEnabled
local _bounceEnabled
bool _bouncing
var _bouncing
local _bouncing
Vec2 _bounceDir
var _bounceDir
local _bounceDir
float _bounceOriginalSpeed
var _bounceOriginalSpeed
local _bounceOriginalSpeed
bool _inertiaScrollEnabled
var _inertiaScrollEnabled
local _inertiaScrollEnabled
Ref_scrollViewEventListener
var _scrollViewEventListener
local _scrollViewEventListener
SEL_ScrollViewEvent _scrollViewEventSelector
var _scrollViewEventSelector
local _scrollViewEventSelector
ccScrollViewCallback _eventCallback
var _eventCallback
local _eventCallback
- Protected Attributes inherited from Layout
bool _clippingEnabled
bool _backGroundScale9Enabled
Node_backGroundImage
std::string _backGroundImageFileName
Rect _backGroundImageCapInsets
BackGroundColorType _colorType
TextureResType _bgImageTexType
LayerColor_colorRender
LayerGradient_gradientRender
Color3B _cColor
Color3B _gStartColor
Color3B _gEndColor
Vec2 _alongVector
GLubyte _cOpacity
Size _backGroundImageTextureSize
Type _layoutType
ClippingType _clippingType
DrawNode_clippingStencil
bool _scissorRectDirty
Rect _clippingRect
Layout_clippingParent
bool _doLayoutDirty
bool _clippingRectDirty
GLboolean _currentStencilEnabled
GLuint _currentStencilWriteMask
GLenum _currentStencilFunc
GLint _currentStencilRef
GLuint _currentStencilValueMask
GLenum _currentStencilFail
GLenum _currentStencilPassDepthFail
GLenum _currentStencilPassDepthPass
GLboolean _currentDepthWriteMask
GLboolean _currentAlphaTestEnabled
GLenum _currentAlphaTestFunc
GLclampf _currentAlphaTestRef
Color3B _backGroundImageColor
GLubyte _backGroundImageOpacity
LayoutExecutant * _curLayoutExecutant
GLint _mask_layer_le
GroupCommand _groupCommand
CustomCommand _beforeVisitCmdStencil
CustomCommand _afterDrawStencilCmd
CustomCommand _afterVisitCmdStencil
CustomCommand _beforeVisitCmdScissor
CustomCommand _afterVisitCmdScissor
bool _loopFocus
bool _passFocusToChild
- Protected Attributes inherited from Widget
bool _enabled
 Highest control of widget. More...
 
bool _bright
 is this widget bright More...
 
bool _touchEnabled
 is this widget touch endabled More...
 
bool _highlight
 is the widget on focus More...
 
BrightStyle _brightStyle
 bright style More...
 
Vec2 _touchStartPos
 touch began point More...
 
Vec2 _touchMovePos
 touch moved point More...
 
Vec2 _touchEndPos
 touch ended point More...
 
Ref_touchEventListener
SEL_TouchEvent _touchEventSelector
ccWidgetTouchCallback _touchEventCallback
std::string _name
int _actionTag
Size _size
Size _customSize
bool _ignoreSize
bool _affectByClipping
SizeType _sizeType
Vec2 _sizePercent
PositionType _positionType
Vec2 _positionPercent
bool _reorderWidgetChildDirty
bool _hitted
EventListenerTouchOneByOne_touchListener
Color3B _color
GLubyte _opacity
bool _flippedX
bool _flippedY
Map< int, LayoutParameter * > _layoutParameterDictionary
bool _focused
bool _focusEnabled
- Protected Attributes inherited from ProtectedNode
Vector< Node * > _protectedChildren
 array of children nodes More...
 
var _protectedChildren
 array of children nodes More...
 
local _protectedChildren
 array of children nodes More...
 
bool _reorderProtectedChildDirty
- Protected Attributes inherited from Node
float _rotationX
 rotation on the X-axis More...
 
float _rotationY
 rotation on the Y-axis More...
 
var _rotationY
 rotation on the Y-axis More...
 
local _rotationY
 rotation on the Y-axis More...
 
float _rotationZ_X
 rotation angle on Z-axis, component X More...
 
var _rotationZ_X
 rotation angle on Z-axis, component X More...
 
local _rotationZ_X
 rotation angle on Z-axis, component X More...
 
float _rotationZ_Y
 rotation angle on Z-axis, component Y More...
 
var _rotationZ_Y
 rotation angle on Z-axis, component Y More...
 
local _rotationZ_Y
 rotation angle on Z-axis, component Y More...
 
float _scaleX
 scaling factor on x-axis More...
 
var _scaleX
 scaling factor on x-axis More...
 
local _scaleX
 scaling factor on x-axis More...
 
float _scaleY
 scaling factor on y-axis More...
 
var _scaleY
 scaling factor on y-axis More...
 
local _scaleY
 scaling factor on y-axis More...
 
float _scaleZ
 scaling factor on z-axis More...
 
var _scaleZ
 scaling factor on z-axis More...
 
local _scaleZ
 scaling factor on z-axis More...
 
Vec2 _position
 position of the node More...
 
var _position
 position of the node More...
 
local _position
 position of the node More...
 
float _positionZ
 OpenGL real Z position. More...
 
var _positionZ
 OpenGL real Z position. More...
 
local _positionZ
 OpenGL real Z position. More...
 
float _skewX
 skew angle on x-axis More...
 
var _skewX
 skew angle on x-axis More...
 
local _skewX
 skew angle on x-axis More...
 
float _skewY
 skew angle on y-axis More...
 
var _skewY
 skew angle on y-axis More...
 
local _skewY
 skew angle on y-axis More...
 
Vec2 _anchorPointInPoints
 anchor point in points More...
 
var _anchorPointInPoints
 anchor point in points More...
 
local _anchorPointInPoints
 anchor point in points More...
 
Vec2 _anchorPoint
 anchor point normalized (NOT in points) More...
 
var _anchorPoint
 anchor point normalized (NOT in points) More...
 
local _anchorPoint
 anchor point normalized (NOT in points) More...
 
Size _contentSize
 untransformed size of the node More...
 
var _contentSize
 untransformed size of the node More...
 
local _contentSize
 untransformed size of the node More...
 
Mat4 _modelViewTransform
 ModelView transform of the Node. More...
 
var _modelViewTransform
 ModelView transform of the Node. More...
 
local _modelViewTransform
 ModelView transform of the Node. More...
 
Mat4 _transform
 transform More...
 
var _transform
 transform More...
 
local _transform
 transform More...
 
bool _transformDirty
 transform dirty flag More...
 
var _transformDirty
 transform dirty flag More...
 
local _transformDirty
 transform dirty flag More...
 
Mat4 _inverse
 inverse transform More...
 
var _inverse
 inverse transform More...
 
local _inverse
 inverse transform More...
 
bool _inverseDirty
 inverse transform dirty flag More...
 
var _inverseDirty
 inverse transform dirty flag More...
 
local _inverseDirty
 inverse transform dirty flag More...
 
Mat4 _additionalTransform
 transform More...
 
var _additionalTransform
 transform More...
 
local _additionalTransform
 transform More...
 
bool _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
var _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
local _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
bool _transformUpdated
 Whether or not the Transform object was updated since the last frame. More...
 
var _transformUpdated
 Whether or not the Transform object was updated since the last frame. More...
 
local _transformUpdated
 Whether or not the Transform object was updated since the last frame. More...
 
int _localZOrder
 Local order (relative to its siblings) used to sort the node. More...
 
var _localZOrder
 Local order (relative to its siblings) used to sort the node. More...
 
local _localZOrder
 Local order (relative to its siblings) used to sort the node. More...
 
float _globalZOrder
 Global order used to sort the node. More...
 
var _globalZOrder
 Global order used to sort the node. More...
 
local _globalZOrder
 Global order used to sort the node. More...
 
Vector< Node * > _children
 array of children nodes More...
 
var _children
 array of children nodes More...
 
local _children
 array of children nodes More...
 
Node_parent
 weak reference to parent node More...
 
var _parent
 weak reference to parent node More...
 
local _parent
 weak reference to parent node More...
 
int _tag
 a tag. Can be any number you assigned just to identify this node More...
 
var _tag
 a tag. Can be any number you assigned just to identify this node More...
 
local _tag
 a tag. Can be any number you assigned just to identify this node More...
 
std::string _name
 a string label, an user defined string to identify this node More...
 
var _name
 a string label, an user defined string to identify this node More...
 
local _name
 a string label, an user defined string to identify this node More...
 
void * _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
var _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
local _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
Ref_userObject
 A user assigned Object. More...
 
var _userObject
 A user assigned Object. More...
 
local _userObject
 A user assigned Object. More...
 
GLProgramState_glProgramState
 OpenGL Program State. More...
 
var _glProgramState
 OpenGL Program State. More...
 
local _glProgramState
 OpenGL Program State. More...
 
int _orderOfArrival
 used to preserve sequence while sorting children with the same localZOrder More...
 
Scheduler_scheduler
 scheduler used to schedule timers and updates More...
 
var _scheduler
 scheduler used to schedule timers and updates More...
 
local _scheduler
 scheduler used to schedule timers and updates More...
 
ActionManager_actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
EventDispatcher_eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
var _eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
local _eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
bool _running
 is running More...
 
var _running
 is running More...
 
local _running
 is running More...
 
bool _visible
 is this node visible More...
 
var _visible
 is this node visible More...
 
local _visible
 is this node visible More...
 
bool _ignoreAnchorPointForPosition
 true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...
 
var _ignoreAnchorPointForPosition
 true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...
 
local _ignoreAnchorPointForPosition
 true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...
 
bool _reorderChildDirty
 children order dirty flag More...
 
var _reorderChildDirty
 children order dirty flag More...
 
local _reorderChildDirty
 children order dirty flag More...
 
bool _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
var _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
local _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
ComponentContainer_componentContainer
 Dictionary of components. More...
 
var _componentContainer
 Dictionary of components. More...
 
local _componentContainer
 Dictionary of components. More...
 
GLubyte _displayedOpacity
var _displayedOpacity
local _displayedOpacity
GLubyte _realOpacity
var _realOpacity
local _realOpacity
Color3B _displayedColor
var _displayedColor
local _displayedColor
Color3B _realColor
var _realColor
local _realColor
bool _cascadeColorEnabled
var _cascadeColorEnabled
local _cascadeColorEnabled
bool _cascadeOpacityEnabled
var _cascadeOpacityEnabled
local _cascadeOpacityEnabled
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 

Additional Inherited Members

- Static Public Attributes inherited from Node
static const int INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
var INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
local INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
- Static Protected Attributes inherited from Widget
static Widget_focusedWidget
 store the only one focued widget More...
 
static Widget_realFocusedWidget
- Static Protected Attributes inherited from Node
static int s_globalOrderOfArrival
var s_globalOrderOfArrival
local s_globalOrderOfArrival

Member Typedef Documentation

typedef std::function<void(Ref*,
EventType)> ccListViewCallback

Member Enumeration Documentation

enum EventType
strong
Enumerator
ON_SELECTED_ITEM_START 
ON_SELECTED_ITEM_END 
var EventType
strong
Enumerator
ON_SELECTED_ITEM_START 
ON_SELECTED_ITEM_END 
local EventType
strong
Enumerator
ON_SELECTED_ITEM_START 
ON_SELECTED_ITEM_END 
enum Gravity
strong
Enumerator
LEFT 
RIGHT 
CENTER_HORIZONTAL 
TOP 
BOTTOM 
CENTER_VERTICAL 
var Gravity
strong
Enumerator
LEFT 
RIGHT 
CENTER_HORIZONTAL 
TOP 
BOTTOM 
CENTER_VERTICAL 
local Gravity
strong
Enumerator
LEFT 
RIGHT 
CENTER_HORIZONTAL 
TOP 
BOTTOM 
CENTER_VERTICAL 

Constructor & Destructor Documentation

ListView ( )

Default constructor.

var ListView ( )

Default constructor.

local ListView ( )

Default constructor.

virtual ~ListView ( )
virtual

Default destructor.

var ~ListView ( )
virtual

Default destructor.

local ~ListView ( )
virtual

Default destructor.

Member Function Documentation

virtual void addChild ( Node child)
inlineoverrideprotectedvirtual

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

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

Parameters
childA child node

Reimplemented from ScrollView.

var addChild ( var  child)
inlineoverrideprotectedvirtual

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

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

Parameters
childA child node

Reimplemented from ScrollView.

local addChild ( local  child)
inlineoverrideprotectedvirtual

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

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

Parameters
childA child node

Reimplemented from ScrollView.

virtual void addChild ( Node child,
int  zOrder 
)
inlineoverrideprotectedvirtual

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

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

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)

Reimplemented from ScrollView.

var addChild ( var  child,
var  zOrder 
)
inlineoverrideprotectedvirtual

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

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

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)

Reimplemented from ScrollView.

local addChild ( local  child,
local  zOrder 
)
inlineoverrideprotectedvirtual

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

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

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)

Reimplemented from ScrollView.

virtual void addChild ( Node child,
int  zOrder,
int  tag 
)
inlineoverrideprotectedvirtual

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

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

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
tagA interger to identify the node easily. Please refer to setTag(int)

Reimplemented from ScrollView.

var addChild ( var  child,
var  zOrder,
var  tag 
)
inlineoverrideprotectedvirtual

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

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

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
tagA interger to identify the node easily. Please refer to setTag(int)

Reimplemented from ScrollView.

local addChild ( local  child,
local  zOrder,
local  tag 
)
inlineoverrideprotectedvirtual

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

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

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
tagA interger to identify the node easily. Please refer to setTag(int)

Reimplemented from ScrollView.

void addEventListener ( const ccListViewCallback callback)
var addEventListener ( var  callback)
local addEventListener ( local  callback)
CC_DEPRECATED_ATTRIBUTE void
addEventListenerListView
( Ref target,
SEL_ListViewEvent  selector 
)
var addEventListenerListView ( var  target,
var  selector 
)
local addEventListenerListView ( local  target,
local  selector 
)
virtual void
copyClonedWidgetChildren
( Widget model)
overrideprotectedvirtual

Reimplemented from ScrollView.

var copyClonedWidgetChildren ( var  model)
overrideprotectedvirtual

Reimplemented from ScrollView.

local copyClonedWidgetChildren ( local  model)
overrideprotectedvirtual

Reimplemented from ScrollView.

virtual void copySpecialProperties ( Widget model)
overrideprotectedvirtual

Reimplemented from ScrollView.

var copySpecialProperties ( var  model)
overrideprotectedvirtual

Reimplemented from ScrollView.

local copySpecialProperties ( local  model)
overrideprotectedvirtual

Reimplemented from ScrollView.

static ListView* create ( )
static

Allocates and initializes.

var create ( )
static

Allocates and initializes.

local create ( )
static

Allocates and initializes.

virtual Widget* createCloneInstance ( )
overrideprotectedvirtual

Reimplemented from ScrollView.

var createCloneInstance ( )
overrideprotectedvirtual

Reimplemented from ScrollView.

local createCloneInstance ( )
overrideprotectedvirtual

Reimplemented from ScrollView.

virtual Widget* getChildByName ( const std::string &  name)
inlineoverrideprotectedvirtual

Gets a child from the container with its name.

Parameters
nameAn key to find the child widget.
Returns
a Widget object whose name equals to the input parameter

Reimplemented from ScrollView.

var getChildByName ( var  name)
inlineoverrideprotectedvirtual

Gets a child from the container with its name.

Parameters
nameAn key to find the child widget.
Returns
a Widget object whose name equals to the input parameter

Reimplemented from ScrollView.

local getChildByName ( local  name)
inlineoverrideprotectedvirtual

Gets a child from the container with its name.

Parameters
nameAn key to find the child widget.
Returns
a Widget object whose name equals to the input parameter

Reimplemented from ScrollView.

virtual Node* getChildByTag ( int  tag)
inlineoverrideprotectedvirtual

Gets a child from the container with its tag.

Parameters
tagAn identifier to find the child node.
Returns
a Node object whose tag equals to the input parameter

Reimplemented from ScrollView.

var getChildByTag ( var  tag)
inlineoverrideprotectedvirtual

Gets a child from the container with its tag.

Parameters
tagAn identifier to find the child node.
Returns
a Node object whose tag equals to the input parameter

Reimplemented from ScrollView.

local getChildByTag ( local  tag)
inlineoverrideprotectedvirtual

Gets a child from the container with its tag.

Parameters
tagAn identifier to find the child node.
Returns
a Node object whose tag equals to the input parameter

Reimplemented from ScrollView.

virtual Vector<Node*>& getChildren ( )
inlineoverrideprotectedvirtual

Returns the array of the node's children.

Returns
the array the node's children

Reimplemented from ScrollView.

var getChildren ( )
inlineoverrideprotectedvirtual

Returns the array of the node's children.

Returns
the array the node's children

Reimplemented from ScrollView.

local getChildren ( )
inlineoverrideprotectedvirtual

Returns the array of the node's children.

Returns
the array the node's children

Reimplemented from ScrollView.

virtual const Vector<Node*>
& getChildren
( ) const
inlineoverrideprotectedvirtual

Reimplemented from ScrollView.

var getChildren ( )
inlineoverrideprotectedvirtual

Reimplemented from ScrollView.

local getChildren ( )
inlineoverrideprotectedvirtual

Reimplemented from ScrollView.

virtual ssize_t getChildrenCount ( ) const
inlineoverrideprotectedvirtual

Returns the amount of children.

Returns
The amount of children.

Reimplemented from ScrollView.

var getChildrenCount ( )
inlineoverrideprotectedvirtual

Returns the amount of children.

Returns
The amount of children.

Reimplemented from ScrollView.

local getChildrenCount ( )
inlineoverrideprotectedvirtual

Returns the amount of children.

Returns
The amount of children.

Reimplemented from ScrollView.

ssize_t getCurSelectedIndex ( ) const
var getCurSelectedIndex ( )
local getCurSelectedIndex ( )
virtual std::string getDescription ( ) const
overridevirtual

Returns the "class name" of widget.

Reimplemented from ScrollView.

var getDescription ( )
overridevirtual

Returns the "class name" of widget.

Reimplemented from ScrollView.

local getDescription ( )
overridevirtual

Returns the "class name" of widget.

Reimplemented from ScrollView.

ssize_t getIndex ( Widget item) const

Returns the index of item.

Parameters
itemthe item which need to be checked.
Returns
the index of item.
var getIndex ( var  item)

Returns the index of item.

Parameters
itemthe item which need to be checked.
Returns
the index of item.
local getIndex ( local  item)

Returns the index of item.

Parameters
itemthe item which need to be checked.
Returns
the index of item.
Widget* getItem ( ssize_t  index)

Returns a item whose index is same as the parameter.

Parameters
indexof item.
Returns
the item widget.
var getItem ( var  index)

Returns a item whose index is same as the parameter.

Parameters
indexof item.
Returns
the item widget.
local getItem ( local  index)

Returns a item whose index is same as the parameter.

Parameters
indexof item.
Returns
the item widget.
Vector<Widget*>& getItems ( )

Returns the item container.

var getItems ( )

Returns the item container.

local getItems ( )

Returns the item container.

float getItemsMargin ( )
var getItemsMargin ( )
local getItemsMargin ( )
void insertCustomItem ( Widget item,
ssize_t  index 
)

Insert custom item into listview.

var insertCustomItem ( var  item,
var  index 
)

Insert custom item into listview.

local insertCustomItem ( local  item,
local  index 
)

Insert custom item into listview.

void insertDefaultItem ( ssize_t  index)

Insert a default item(create by a cloned model) into listview.

var insertDefaultItem ( var  index)

Insert a default item(create by a cloned model) into listview.

local insertDefaultItem ( local  index)

Insert a default item(create by a cloned model) into listview.

virtual void interceptTouchEvent ( int  handleState,
Widget sender,
const Vec2 touchPoint 
)
overrideprotectedvirtual

Reimplemented from ScrollView.

var interceptTouchEvent ( var  handleState,
var  sender,
var  touchPoint 
)
overrideprotectedvirtual

Reimplemented from ScrollView.

local interceptTouchEvent ( local  handleState,
local  sender,
local  touchPoint 
)
overrideprotectedvirtual

Reimplemented from ScrollView.

virtual void onSizeChanged ( )
overrideprotectedvirtual

Reimplemented from ScrollView.

var onSizeChanged ( )
overrideprotectedvirtual

Reimplemented from ScrollView.

local onSizeChanged ( )
overrideprotectedvirtual

Reimplemented from ScrollView.

void pushBackCustomItem ( Widget item)

Push back custom item into listview.

var pushBackCustomItem ( var  item)

Push back custom item into listview.

local pushBackCustomItem ( local  item)

Push back custom item into listview.

void pushBackDefaultItem ( )

Push back a default item(create by a cloned model) into listview.

var pushBackDefaultItem ( )

Push back a default item(create by a cloned model) into listview.

local pushBackDefaultItem ( )

Push back a default item(create by a cloned model) into listview.

void refreshView ( )
var refreshView ( )
local refreshView ( )
void remedyLayoutParameter ( Widget item)
protected
var remedyLayoutParameter ( var  item)
protected
local remedyLayoutParameter ( local  item)
protected
virtual void removeAllChildren ( )
inlineoverrideprotectedvirtual

Removes all children from the container with a cleanup.

See also
removeAllChildrenWithCleanup(bool)

Reimplemented from ScrollView.

var removeAllChildren ( )
inlineoverrideprotectedvirtual

Removes all children from the container with a cleanup.

See also
removeAllChildrenWithCleanup(bool)

Reimplemented from ScrollView.

local removeAllChildren ( )
inlineoverrideprotectedvirtual

Removes all children from the container with a cleanup.

See also
removeAllChildrenWithCleanup(bool)

Reimplemented from ScrollView.

virtual void
removeAllChildrenWithCleanup
( bool  cleanup)
inlineoverrideprotectedvirtual

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

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

Reimplemented from ScrollView.

var removeAllChildrenWithCleanup ( var  cleanup)
inlineoverrideprotectedvirtual

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

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

Reimplemented from ScrollView.

local removeAllChildrenWithCleanup ( local  cleanup)
inlineoverrideprotectedvirtual

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

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

Reimplemented from ScrollView.

void removeAllItems ( )
var removeAllItems ( )
local removeAllItems ( )
virtual void removeChild ( Node child,
bool  cleanup = true 
)
inlineoverrideprotectedvirtual

Removes a child from the container.

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

Parameters
childThe child node which will be removed.
cleanuptrue if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented from ScrollView.

var removeChild ( var  child,
var  cleanup = true 
)
inlineoverrideprotectedvirtual

Removes a child from the container.

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

Parameters
childThe child node which will be removed.
cleanuptrue if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented from ScrollView.

local removeChild ( local  child,
local  cleanup = true 
)
inlineoverrideprotectedvirtual

Removes a child from the container.

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

Parameters
childThe child node which will be removed.
cleanuptrue if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented from ScrollView.

void removeItem ( ssize_t  index)

Removes a item whose index is same as the parameter.

Parameters
indexof item.
var removeItem ( var  index)

Removes a item whose index is same as the parameter.

Parameters
indexof item.
local removeItem ( local  index)

Removes a item whose index is same as the parameter.

Parameters
indexof item.
void removeLastItem ( )

Removes the last item of listview.

var removeLastItem ( )

Removes the last item of listview.

local removeLastItem ( )

Removes the last item of listview.

void requestRefreshView ( )
var requestRefreshView ( )
local requestRefreshView ( )
void selectedItemEvent ( int  state)
protected
var selectedItemEvent ( var  state)
protected
local selectedItemEvent ( local  state)
protected
virtual void setDirection ( Direction  dir)
overridevirtual

Changes scroll direction of scrollview.

See also
SCROLLVIEW_DIR SCROLLVIEW_DIR_VERTICAL means vertical scroll, SCROLLVIEW_DIR_HORIZONTAL means horizontal scroll
Parameters
SCROLLVIEW_DIR

Reimplemented from ScrollView.

var setDirection ( var  dir)
overridevirtual

Changes scroll direction of scrollview.

See also
SCROLLVIEW_DIR SCROLLVIEW_DIR_VERTICAL means vertical scroll, SCROLLVIEW_DIR_HORIZONTAL means horizontal scroll
Parameters
SCROLLVIEW_DIR

Reimplemented from ScrollView.

local setDirection ( local  dir)
overridevirtual

Changes scroll direction of scrollview.

See also
SCROLLVIEW_DIR SCROLLVIEW_DIR_VERTICAL means vertical scroll, SCROLLVIEW_DIR_HORIZONTAL means horizontal scroll
Parameters
SCROLLVIEW_DIR

Reimplemented from ScrollView.

void setGravity ( Gravity  gravity)

Changes the gravity of listview.

See also
ListViewGravity
var setGravity ( var  gravity)

Changes the gravity of listview.

See also
ListViewGravity
local setGravity ( local  gravity)

Changes the gravity of listview.

See also
ListViewGravity
void setItemModel ( Widget model)

Sets a item model for listview.

A model will be cloned for adding default item.

Parameters
modelitem model for listview
var setItemModel ( var  model)

Sets a item model for listview.

A model will be cloned for adding default item.

Parameters
modelitem model for listview
local setItemModel ( local  model)

Sets a item model for listview.

A model will be cloned for adding default item.

Parameters
modelitem model for listview
void setItemsMargin ( float  margin)

Changes the margin between each item.

Parameters
margin
var setItemsMargin ( var  margin)

Changes the margin between each item.

Parameters
margin
local setItemsMargin ( local  margin)

Changes the margin between each item.

Parameters
margin
virtual void sortAllChildren ( )
overridevirtual

Sorts the children array once before drawing, instead of every time when a child is added or reordered.

This appraoch can improves the performance massively.

Note
Don't call this manually unless a child added needs to be removed in the same frame

Reimplemented from Layout.

var sortAllChildren ( )
overridevirtual

Sorts the children array once before drawing, instead of every time when a child is added or reordered.

This appraoch can improves the performance massively.

Note
Don't call this manually unless a child added needs to be removed in the same frame

Reimplemented from Layout.

local sortAllChildren ( )
overridevirtual

Sorts the children array once before drawing, instead of every time when a child is added or reordered.

This appraoch can improves the performance massively.

Note
Don't call this manually unless a child added needs to be removed in the same frame

Reimplemented from Layout.

void updateInnerContainerSize ( )
protected
var updateInnerContainerSize ( )
protected
local updateInnerContainerSize ( )
protected

Member Data Documentation

var __pad0__
local __pad0__
ssize_t _curSelectedIndex
protected
var _curSelectedIndex
protected
local _curSelectedIndex
protected
ccListViewCallback _eventCallback
protected
var _eventCallback
protected
local _eventCallback
protected
Gravity _gravity
protected
var _gravity
protected
local _gravity
protected
Vector<Widget*> _items
protected
var _items
protected
local _items
protected
float _itemsMargin
protected
var _itemsMargin
protected
local _itemsMargin
protected
Ref* _listViewEventListener
protected
var _listViewEventListener
protected
local _listViewEventListener
protected
SEL_ListViewEvent
_listViewEventSelector
protected
var _listViewEventSelector
protected
local _listViewEventSelector
protected
Widget* _model
protected
var _model
protected
local _model
protected
bool _refreshViewDirty
protected
var _refreshViewDirty
protected
local _refreshViewDirty
protected

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