#include <UIWidget.h>

Inheritance diagram for Widget:

Public Types
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
	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...

virtual Widget *	getChildByName (const std::string &name)
	Gets a child from the container with its name. More...

virtual void	visit (cocos2d::Renderer *renderer, const Mat4 &parentTransform, bool parentTransformUpdated) override
	Visits this node's children and draw them recursively. 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 Vec2 &	getPositionPercent ()
	Gets the percent (x,y) of the widget in OpenGL coordinates. More...

void	setPositionType (PositionType type)
	Changes the position type of the widget. More...

PositionType	getPositionType () const
	Gets the position type of the widget. More...

virtual void	setFlippedX (bool flippedX)
	Sets whether the widget should be flipped horizontally or not. More...

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 Color3B &	getColor () 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)
virtual void	checkChildInfo (int handleState, Widget *sender, const Vec2 &touchPoint)
const Vec2 &	getTouchStartPos ()
const Vec2 &	getTouchMovePos ()
const Vec2 &	getTouchEndPos ()
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 Size &	getSize () const
	Returns size of widget. More...

const Size &	getCustomSize () const
virtual const Size &	getLayoutSize ()
const Vec2 &	getSizePercent () const
	Returns size percent of widget. More...

virtual bool	hitTest (const Vec2 &pt)
	Checks a point if is in widget's space. More...

virtual bool	onTouchBegan (Touch touch, Event unusedEvent)
virtual void	onTouchMoved (Touch touch, Event unusedEvent)
virtual void	onTouchEnded (Touch touch, Event unusedEvent)
virtual void	onTouchCancelled (Touch touch, Event unusedEvent)
void	setLayoutParameter (LayoutParameter *parameter)
	Sets a LayoutParameter to widget. More...

LayoutParameter *	getLayoutParameter (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 Node *	getVirtualRenderer ()
	Gets the Virtual Renderer of widget. More...

virtual const Size &	getVirtualRendererSize () const
	Gets the content size of widget. More...

virtual std::string	getDescription () const override
	Returns the "class name" of widget. More...

Widget *	clone ()
virtual void	onEnter () override
	Event callback that is invoked every time when Node enters the 'stage'. More...

virtual void	onExit () override
	Event callback that is invoked every time the Node leaves the 'stage'. More...

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 Widget *	findNextFocusedWidget (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...

Widget *	getCurrentFocusedWidget (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 Node *	getProtectedChildByTag (int tag)
	Gets a child from the container with its tag. More...

var	getProtectedChildByTag ( var tag)
	Gets a child from the container with its tag. More...

local	getProtectedChildByTag ( local tag)
	Gets a child from the container with its tag. More...

virtual void	removeProtectedChild (Node *child, bool cleanup=true)
	Removes a child from the container. More...

local	removeProtectedChild ( local child, local true)
	Removes a child from the container. More...

virtual void	removeProtectedChildByTag (int tag, bool cleanup=true)
	Removes a child from the container by tag value. More...

var	removeProtectedChildByTag ( var tag, var true)
	Removes a child from the container by tag value. More...

local	removeProtectedChildByTag ( local tag, local true)
	Removes a child from the container by tag value. More...

virtual void	removeAllProtectedChildren ()
	Removes all children from the container with a cleanup. More...

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 Scene *	getScene ()
	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 EventDispatcher *	getEventDispatcher () const
local	getEventDispatcher ()
virtual GLubyte	getDisplayedOpacity () const
local	getDisplayedOpacity ()
virtual bool	isCascadeOpacityEnabled () const
var	isCascadeOpacityEnabled ()
local	isCascadeOpacityEnabled ()
virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual const Color3B &	getDisplayedColor () 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 Vec2 &	getPosition () 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 Vec2 &	getAnchorPoint () const
	Returns the anchor point in percent. More...

virtual const Vec2 &	getAnchorPointInPoints () 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 Size &	getContentSize () const
	Returns the untransformed size of the node. More...

local	getContentSize ()
	Returns the untransformed size of the node. More...

virtual void	setVisible (bool visible)
	Sets whether the node is visible. More...

local	setVisible ( local visible)
	Sets whether the node is visible. More...

virtual bool	isVisible () const
	Determines if the node is visible. More...

virtual void	setRotation (float rotation)
	Sets the rotation (angle) of the node in degrees. More...

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	addChild (Node *child)
	Adds a child to the container with z-order as 0. More...

var	addChild ( var child)
	Adds a child to the container with z-order as 0. More...

local	addChild ( local child)
	Adds a child to the container with z-order as 0. More...

virtual void	addChild (Node *child, int localZOrder)
	Adds a child to the container with a local z-order. More...

local	addChild ( local child, local localZOrder)
	Adds a child to the container with a local z-order. More...

virtual void	addChild (Node *child, int localZOrder, int tag)
	Adds a child to the container with z order and tag. More...

local	addChild ( local child, local localZOrder, local tag)
	Adds a child to the container with z order and tag. More...

virtual Node *	getChildByTag (int tag)
	Gets a child from the container with its tag. More...

virtual Vector< Node * > &	getChildren ()
	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
local	getChildren ()
virtual ssize_t	getChildrenCount () const
	Returns the amount of children. More...

virtual void	setParent (Node *parent)
	Sets the parent node. More...

local	setParent ( local parent)
	Sets the parent node. More...

virtual Node *	getParent ()
	Returns a pointer to the parent node. More...

virtual const Node *	getParent () const
virtual void	removeFromParent ()
	Removes this node itself from its parent node with a cleanup. More...

virtual void	removeFromParentAndCleanup (bool cleanup)
	Removes this node itself from its parent node. More...

local	removeFromParent ( local cleanup)
	Removes this node itself from its parent node. More...

virtual void	removeChild (Node *child, bool cleanup=true)
	Removes a child from the container. More...

local	removeChild ( local child, local true)
	Removes a child from the container. 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	removeAllChildren ()
	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)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

virtual void	reorderChild (Node *child, int localZOrder)
	Reorders a child according to a new z value. More...

var	reorderChild ( var child, var localZOrder)
	Reorders a child according to a new z value. More...

local	reorderChild ( local child, local localZOrder)
	Reorders a child according to a new z value. More...

virtual void	sortAllChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...

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 Ref *	getUserObject ()
	Returns a user assigned Object. More...

virtual const Ref *	getUserObject () const
virtual void	setUserObject (Ref *userObject)
	Returns a user assigned Object. More...

local	setUserObject ( local userObject)
	Returns a user assigned Object. More...

GLProgram *	getGLProgram ()
	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 GLProgram *	getShaderProgram ()
local	getShaderProgram ()
GLProgramState *	getGLProgramState ()
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 ActionManager *	getActionManager ()
	Gets the ActionManager object that is used by all actions. More...

local	getActionManager ()
	Gets the ActionManager object that is used by all actions. More...

virtual const ActionManager *	getActionManager () const
local	getActionManager ()
Action *	runAction (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...

Action *	getActionByTag (int tag)
	Gets an action from the running action list by its tag. More...

ssize_t	getNumberOfRunningActions () const
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...

local	getNumberOfRunningActions ()
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...

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 Scheduler *	getScheduler ()
	Gets a Sheduler object. More...

virtual const Scheduler *	getScheduler () 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	update (float delta)
virtual void	updateTransform ()
	Calls children's updateTransform() method recursively. More...

var	updateTransform ()
	Calls children's updateTransform() method recursively. More...

local	updateTransform ()
	Calls children's updateTransform() method recursively. More...

virtual const Mat4 &	getNodeToParentTransform () const
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

virtual AffineTransform	getNodeToParentAffineTransform () const
local	getNodeToParentAffineTransform ()
virtual void	setNodeToParentTransform (const Mat4 &transform)
	Sets the Transformation matrix manually. More...

local	setNodeToParentTransform ( local transform)
	Sets the Transformation matrix manually. More...

virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	nodeToParentTransform () const
local	nodeToParentTransform ()
virtual const Mat4 &	getParentToNodeTransform () const
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...

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)
Component *	getComponent (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...

Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...

unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...

virtual	~Ref ()

Static Public Member Functions
static Widget *	create ()
	Allocates and initializes a widget. More...

Static Public Member Functions inherited from ProtectedNode
static ProtectedNode *	create (void)
Static Public Member Functions inherited from Node
static Node *	create (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
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	onSizeChanged ()
virtual void	initRenderer ()
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)
virtual Widget *	createCloneInstance ()
virtual void	copySpecialProperties (Widget *model)
virtual void	copyClonedWidgetChildren (Widget *model)
Widget *	getWidgetParent ()
void	updateContentSizeWithTextureSize (const Size &size)
virtual void	adaptRenderers ()
bool	isAncestorsEnabled ()
Widget *	getAncensterWidget (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
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...

Static Protected Attributes
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

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...

Member Typedef Documentation

typedef std::function<void(Ref*,Widget::TouchEventType)>
ccWidgetTouchCallback

Member Enumeration Documentation

enum BrightStyle

strong

Enumerator
NONE
NORMAL
HIGHLIGHT

enum FocusDirection

strong

Enumerator
LEFT
RIGHT
UP
DOWN

enum PositionType

strong

Enumerator
ABSOLUTE
PERCENT

enum SizeType

strong

Enumerator
ABSOLUTE
PERCENT

enum TextureResType

strong

Enumerator
LOCAL
PLIST

enum TouchEventType

strong

Enumerator
BEGAN
MOVED
ENDED
CANCELED

Constructor & Destructor Documentation

Widget ( void )

virtual ~Widget ( )

virtual

Default destructor.

Member Function Documentation

virtual void adaptRenderers ( )

inlineprotectedvirtual

Reimplemented in Slider, CheckBox, Button, TextField, Text, LoadingBar, ImageView, TextAtlas, and TextBMFont.

CC_DEPRECATED_ATTRIBUTE void addTouchEventListener	(	Ref *	target,
		SEL_TouchEvent	selector
	)

Sets the touch event target/selector of the menu item.

void addTouchEventListener ( ccWidgetTouchCallback callback )

void cancelUpEvent ( )

protected

virtual void checkChildInfo	(	int	handleState,
		Widget *	sender,
		const Vec2 &	touchPoint
	)

virtual

Reimplemented in ScrollView, and PageView.

bool clippingParentAreaContainPoint ( const Vec2 & pt )

Widget* clone ( )

virtual void
copyClonedWidgetChildren ( Widget * model )

protectedvirtual

Reimplemented in ScrollView, Layout, ListView, and PageView.

void copyProperties ( Widget * model )

protected

virtual void copySpecialProperties ( Widget * model )

protectedvirtual

Reimplemented in ScrollView, Layout, Slider, CheckBox, Button, ListView, PageView, TextField, Text, LoadingBar, ImageView, TextAtlas, and TextBMFont.

static Widget* create ( )

static

Allocates and initializes a widget.

virtual Widget* createCloneInstance ( )

protectedvirtual

Reimplemented in ScrollView, Layout, Slider, CheckBox, Button, ListView, PageView, TextField, Text, LoadingBar, ImageView, TextAtlas, and TextBMFont.

void dispatchFocusEvent	(	Widget *	widgetLoseFocus,
		Widget *	widgetGetFocus
	)

Dispatch a EventFocus through a EventDispatcher.

Parameters

widgetLoseFocus	The widget which lose its focus
widgetGetFocus	he widget whihc get its focus

Returns: void

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

virtual

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

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

Parameters

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

Returns: the next focused widget in a layout

int getActionTag ( )

Widget* getAncensterWidget ( Node * node )

protected

float getBottomInParent ( )

Gets the bottom boundary position of this widget.

Returns: The bottom boundary position of this widget.

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

virtual

Gets a child from the container with its name.

Parameters

name	An key to find the child widget.

Returns: a Widget object whose name equals to the input parameter

Reimplemented in ScrollView, ListView, and PageView.

const Color3B& getColor ( void ) const

inlineoverridevirtual

Reimplemented from Node.

Widget* getCurrentFocusedWidget ( bool isWidget )

no matter what widget object you call this method on , it will return you the exact one focused widget

Parameters

isWidget if your set isWidget to true, it will return the _realFocusedWidget which is always a widget otherwise, it will return a widget or a layout

const Size& getCustomSize ( ) const

virtual std::string getDescription ( ) const

overridevirtual

Returns the "class name" of widget.

Reimplemented from Node.

Reimplemented in ScrollView, Slider, Layout, CheckBox, ListView, Button, PageView, TextField, Text, LoadingBar, RichText, ImageView, TextAtlas, and TextBMFont.

LayoutParameter* getLayoutParameter ( LayoutParameter::Type type )

Gets LayoutParameter of widget.

See also: LayoutParameter

Parameters

type	Relative or Linear

Returns: LayoutParameter

virtual const Size& getLayoutSize ( )

inlinevirtual

Reimplemented in ScrollInnerContainer.

float getLeftInParent ( )

Gets the left boundary position of this widget.

Returns: The left boundary position of this widget.

const std::string& getName ( ) const

Returns a name that is used to identify the widget easily.

You can set tags to widget then identify them easily.

Returns: A const std::string that identifies the widget.

GLubyte getOpacity ( ) const

inlineoverridevirtual

Reimplemented from Node.

const Vec2& getPositionPercent ( )

Gets the percent (x,y) of the widget in OpenGL coordinates.

See also: setPosition(const Vec2&)

Returns: The percent (x,y) of the widget in OpenGL coordinates

PositionType getPositionType ( ) const

Gets the position type of the widget.

See also: PositionType

Returns: type the position type of widget

float getRightInParent ( )

Gets the right boundary position of this widget.

Returns: The right boundary position of this widget.

const Size& getSize ( ) const

Returns size of widget.

Returns: size

const Vec2& getSizePercent ( ) const

Returns size percent of widget.

Returns: size percent

SizeType getSizeType ( ) const

Gets the size type of widget.

See also: SizeType

Parameters

type	that is widget's size type

float getTopInParent ( )

Gets the top boundary position of this widget.

Returns: The top boundary position of this widget.

const Vec2& getTouchEndPos ( )

const Vec2& getTouchMovePos ( )

const Vec2& getTouchStartPos ( )

virtual Node* getVirtualRenderer ( )

virtual

Gets the Virtual Renderer of widget.

For example, a button's Virtual Renderer is it's texture renderer.

Returns: Node pointer.

Reimplemented in Slider, CheckBox, Button, TextField, Text, LoadingBar, ImageView, TextAtlas, and TextBMFont.

virtual const Size&
getVirtualRendererSize ( ) const

virtual

Gets the content size of widget.

Content size is widget's texture size.

Reimplemented in Slider, CheckBox, Button, TextField, Text, LoadingBar, ImageView, RichText, TextAtlas, and TextBMFont.

Widget* getWidgetParent ( )

protected

Vec2 getWorldPosition ( )

Gets world position of widget.

Returns: world position of widget.

virtual bool hitTest ( const Vec2 & pt )

virtual

Checks a point if is in widget's space.

Parameters

point

Returns: true if the point is in widget's space, flase otherwise.

Reimplemented in Slider, and TextField.

virtual void
ignoreContentAdaptWithSize ( bool ignore )

virtual

Ignore the widget size.

Parameters

ignore,true that widget will ignore it's size, use texture size, false otherwise. Default value is true.

Reimplemented in Slider, Button, LoadingBar, RichText, and ImageView.

virtual void initRenderer ( )

protectedvirtual

Reimplemented in ScrollView, Slider, CheckBox, Button, TextField, Text, LoadingBar, ImageView, RichText, TextAtlas, and TextBMFont.

bool isAncestorsEnabled ( )

protected

bool isAncestorsVisible ( Node * node )

protected

bool isBright ( ) const

Determines if the widget is bright.

Returns: true if the widget is bright, false if the widget is dark.

bool isEnabled ( ) const

Determines if the widget is enabled.

Returns: true if the widget is enabled, false if the widget is disabled.

virtual bool isFlippedX ( void )

inlinevirtual

Returns the flag which indicates whether the widget is flipped horizontally or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleX(sprite->getScaleX() * -1);

Returns: true if the widget is flipped horizaontally, false otherwise.

virtual bool isFlippedY ( void )

inlinevirtual

Return the flag which indicates whether the widget is flipped vertically or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleY(widget->getScaleY() * -1);

Returns: true if the widget is flipped vertically, flase otherwise.

CC_DEPRECATED_ATTRIBUTE bool
isFlipX ( )

inline

Deprecated:: Use isFlippedX() instead

CC_DEPRECATED_ATTRIBUTE bool
isFlipY ( )

inline

Deprecated:: Use isFlippedY() instead

bool isFocused ( )

Returns: whether the widget is focused or not

bool isFocusEnabled ( )

Returns: true represent the widget could accept focus, false represent the widget couldn't accept focus

bool isHighlighted ( ) const

Determines if the widget is highlighted.

Returns: true if the widget is highlighted, false if the widget is not hignlighted .

bool isIgnoreContentAdaptWithSize ( ) const

Gets the widget if is ignore it's size.

Parameters

ignore,true that widget will ignore it's size, use texture size, false otherwise. Default value is true.

bool isTouchEnabled ( ) const

Determines if the widget is touch enabled.

Returns: true if the widget is touch enabled, false if the widget is touch disabled.

void moveEvent ( )

protected

virtual void onEnter ( )

overridevirtual

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

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

Reimplemented from ProtectedNode.

Reimplemented in ScrollView, Layout, PageView, and TextField.

virtual void onExit ( )

overridevirtual

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

If the Node leaves the 'stage' with a transition, this event is called when the transition finishes. During onExit you can't access a sibling node. If you override onExit, you shall call its parent's one, e.g., Node::onExit().

Reimplemented from ProtectedNode.

Reimplemented in Layout.

void onFocusChange	(	Widget *	widgetLostFocus,
		Widget *	widgetGetFocus
	)

This method is called when a focus change event happens.

Parameters

widgetLostFocus	The widget which lose its focus
widgetGetFocus	The widget whihc get its focus

Returns: void

virtual void
onPressStateChangedToDisabled ( )

protectedvirtual

Reimplemented in Slider, CheckBox, Button, and Text.

virtual void
onPressStateChangedToNormal ( )

protectedvirtual

Reimplemented in Slider, CheckBox, Button, and Text.

virtual void
onPressStateChangedToPressed ( )

protectedvirtual

Reimplemented in Slider, CheckBox, Button, and Text.

virtual void onSizeChanged ( )

protectedvirtual

Reimplemented in ScrollView, Layout, Slider, CheckBox, ListView, PageView, Button, TextField, Text, LoadingBar, ImageView, TextAtlas, and TextBMFont.

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

virtual

Reimplemented in ScrollView, Slider, PageView, and TextField.

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

virtual

Reimplemented in ScrollView, Slider, and PageView.

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

virtual

Reimplemented in ScrollView, Slider, CheckBox, and PageView.

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

virtual

Reimplemented in ScrollView, Slider, and PageView.

void pushDownEvent ( )

protected

void releaseUpEvent ( )

protected

void requestFocus ( )

when a widget calls this method, it will get focus immediately.

void setActionTag ( int tag )

void setBright ( bool bright )

Sets whether the widget is bright.

The default value is true, a widget is default to bright

Parameters

visible true if the widget is bright, false if the widget is dark.

void setBrightStyle ( BrightStyle style )

To set the bright style of widget.

See also: BrightStyle

Parameters

style BRIGHT_NORMAL the widget is normal state, BRIGHT_HIGHLIGHT the widget is height light state.

virtual void setColor ( const Color3B & color )

overridevirtual

Reimplemented from Node.

virtual void setEnabled ( bool enabled )

virtual

Sets whether the widget is enabled.

true if the widget is enabled, widget may be touched , false if the widget is disabled, widget cannot be touched.

The default value is true, a widget is default to enabled

Parameters

enabled

virtual void setFlippedX ( bool flippedX )

virtual

Sets whether the widget should be flipped horizontally or not.

Parameters

bFlippedX true if the widget should be flipped horizaontally, false otherwise.

virtual void setFlippedY ( bool flippedY )

virtual

Sets whether the widget should be flipped vertically or not.

Parameters

bFlippedY true if the widget should be flipped vertically, flase otherwise.

CC_DEPRECATED_ATTRIBUTE void
setFlipX ( bool flipX )

inline

Deprecated:: Use setFlippedX() instead

CC_DEPRECATED_ATTRIBUTE void
setFlipY ( bool flipY )

inline

Deprecated:: Use setFlippedY() instead

void setFocused ( bool focus )

Parameters

focus pass true to let the widget get focus or pass false to let the widget lose focus

Returns: void

void setFocusEnabled ( bool enable )

Parameters

enable pass true/false to enable/disable the focus ability of a widget

Returns: void

void setHighlighted ( bool hilight )

Sets whether the widget is hilighted.

The default value is false, a widget is default to not hilighted

Parameters

hilight true if the widget is hilighted, false if the widget is not hilighted.

void setLayoutParameter ( LayoutParameter * parameter )

Sets a LayoutParameter to widget.

See also: LayoutParameter

Parameters

LayoutParameter	pointer
type	Relative or Linear

void setName ( const std::string & name )

Changes the name that is used to identify the widget easily.

Parameters

A	const std::string that indentifies the widget.

virtual void setOpacity ( GLubyte opacity )

overridevirtual

Reimplemented from Node.

virtual void setPosition ( const Vec2 & pos )

overridevirtual

Changes the position (x,y) of the widget in OpenGL coordinates.

Usually we use p(x,y) to compose Vec2 object. The original point (0,0) is at the left-bottom corner of screen.

Parameters

position The position (x,y) of the widget in OpenGL coordinates

Reimplemented from Node.

void setPositionPercent ( const Vec2 & percent )

Changes the position (x,y) of the widget in OpenGL coordinates.

Usually we use p(x,y) to compose Vec2 object. The original point (0,0) is at the left-bottom corner of screen.

Parameters

percent The percent (x,y) of the widget in OpenGL coordinates

void setPositionType ( PositionType type )

Changes the position type of the widget.

See also: PositionType

Parameters

type	the position type of widget

virtual void setSize ( const Size & size )

virtual

Changes the size that is widget's size.

Parameters

size	that is widget's size

virtual void setSizePercent ( const Vec2 & percent )

virtual

Changes the percent that is widget's percent size.

Parameters

percent that is widget's percent size

void setSizeType ( SizeType type )

Changes the size type of widget.

See also: SizeType

Parameters

type	that is widget's size type

virtual void setTouchEnabled ( bool enabled )

virtual

Sets whether the widget is touch enabled.

The default value is false, a widget is default to touch disabled

Parameters

visible true if the widget is touch enabled, false if the widget is touch disabled.

void updateColorToRenderer ( Node * renderer )

protected

void
updateContentSizeWithTextureSize ( const Size & size )

protected

virtual void updateFlippedX ( )

inlineprotectedvirtual

Reimplemented in CheckBox, Button, Text, and ImageView.

virtual void updateFlippedY ( )

inlineprotectedvirtual

Reimplemented in CheckBox, Button, Text, and ImageView.

void updateOpacityToRenderer ( Node * renderer )

protected

void updateRGBAToRenderer ( Node * renderer )

protected

void updateSizeAndPosition ( )

void updateSizeAndPosition ( const Size & parentSize )

virtual void updateTextureColor ( )

inlineprotectedvirtual

Reimplemented in Slider, CheckBox, Button, TextField, Text, LoadingBar, ImageView, TextAtlas, and TextBMFont.

virtual void updateTextureOpacity ( )

inlineprotectedvirtual

Reimplemented in Slider, CheckBox, Button, TextField, Text, LoadingBar, ImageView, TextAtlas, and TextBMFont.

virtual void updateTextureRGBA ( )

inlineprotectedvirtual

Reimplemented in Slider, CheckBox, Button, TextField, Text, LoadingBar, ImageView, TextAtlas, and TextBMFont.

virtual void visit	(	cocos2d::Renderer *	renderer,
		const Mat4 &	parentTransform,
		bool	parentTransformUpdated
	)

overridevirtual

Visits this node's children and draw them recursively.

Reimplemented from ProtectedNode.

Reimplemented in Layout, and RichText.

Member Data Documentation

CC_CONSTRUCTOR_ACCESS __pad0__

int _actionTag

protected

bool _affectByClipping

protected

bool _bright

protected

is this widget bright

BrightStyle _brightStyle

protected

bright style

Color3B _color

protected

Size _customSize

protected

bool _enabled

protected

Highest control of widget.

bool _flippedX

protected

bool _flippedY

protected

bool _focused

protected

Widget* _focusedWidget

staticprotected

store the only one focued widget

bool _focusEnabled

protected

bool _highlight

protected

is the widget on focus

bool _hitted

protected

bool _ignoreSize

protected

Map<int, LayoutParameter*>
_layoutParameterDictionary

protected

std::string _name

protected

GLubyte _opacity

protected

Vec2 _positionPercent

protected

PositionType _positionType

protected

Widget* _realFocusedWidget

staticprotected

bool _reorderWidgetChildDirty

protected

Size _size

protected

Vec2 _sizePercent

protected

SizeType _sizeType

protected

bool _touchEnabled

protected

is this widget touch endabled

Vec2 _touchEndPos

protected

touch ended point

ccWidgetTouchCallback
_touchEventCallback

protected

Ref* _touchEventListener

protected

SEL_TouchEvent _touchEventSelector

protected

EventListenerTouchOneByOne*
_touchListener

protected

Vec2 _touchMovePos

protected

touch moved point

Vec2 _touchStartPos

protected

touch began point

std::function<void(Widget*,Widget*)>
onFocusChanged

std::function<Widget*(FocusDirection)>
onNextFocusedWidget

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

/Users/guanghui/cocos2d-x/cocos/ui/UIWidget.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation