cocos2d-x  2.2.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Widget Class Reference

#include <UIWidget.h>

Inheritance diagram for Widget:
CCNodeRGBA CCNode CCRGBAProtocol CCObject CCCopying Button CheckBox ImageView Label LabelAtlas LabelBMFont Layout LoadingBar RichText Slider TextField

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 isFocused () const
 Determines if the widget is on focused. More...
 
void setFocused (bool fucosed)
 Sets whether the widget is on focused. 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 void addChild (CCNode *child)
 Adds a child to the container with z-order as 0. More...
 
virtual void addChild (CCNode *child, int zOrder)
 Adds a child to the container with a z-order. More...
 
virtual void addChild (CCNode *child, int zOrder, int tag)
 Adds a child to the container with z order and tag. More...
 
virtual CCNodegetChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
virtual void sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
virtual CCArraygetChildren ()
 Return an array of children. More...
 
virtual unsigned int getChildrenCount () const
 Get the amount of children. More...
 
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...
 
virtual void removeChild (CCNode *child)
 Removes a child from the container with a cleanup. More...
 
virtual void removeChild (CCNode *child, bool cleanup)
 Removes a child from the container. More...
 
virtual void removeChildByTag (int tag, bool cleanup)
 Removes a child from the container by tag value. More...
 
virtual void 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 WidgetgetChildByName (const char *name)
 Gets a child from the container with its name. More...
 
virtual void addNode (CCNode *node)
virtual void addNode (CCNode *node, int zOrder)
virtual void addNode (CCNode *node, int zOrder, int tag)
virtual CCNodegetNodeByTag (int tag)
virtual CCArraygetNodes ()
virtual void removeNode (CCNode *node)
virtual void removeNodeByTag (int tag)
virtual void removeAllNodes ()
virtual void visit ()
 Visits this node's children and draw them recursively. More...
 
void addTouchEventListener (CCObject *target, SEL_TouchEvent selector)
 Sets the touch event target/selector of the menu item. More...
 
void setPosition (const CCPoint &pos)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
void setPositionPercent (const CCPoint &percent)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
const CCPointgetPositionPercent ()
 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 setFlipX (bool flipX)
 Sets whether the widget should be flipped horizontally or not. More...
 
virtual bool isFlipX ()
 Returns the flag which indicates whether the widget is flipped horizontally or not. More...
 
virtual void setFlipY (bool flipY)
 Sets whether the widget should be flipped vertically or not. More...
 
virtual bool isFlipY ()
 Return the flag which indicates whether the widget is flipped vertically or not. More...
 
virtual void setColor (const ccColor3B &color)
 @ More...
 
virtual void setOpacity (GLubyte opacity)
 Changes the opacity. More...
 
const ccColor3BgetColor ()
 Returns color that is currently used. More...
 
GLubyte getOpacity ()
 Returns the opacity. More...
 
void didNotSelectSelf ()
 A call back function when widget lost of focus. More...
 
bool clippingParentAreaContainPoint (const CCPoint &pt)
virtual void checkChildInfo (int handleState, Widget *sender, const CCPoint &touchPoint)
const CCPointgetTouchStartPos ()
const CCPointgetTouchMovePos ()
const CCPointgetTouchEndPos ()
void setName (const char *name)
 Changes the name that is used to identify the widget easily. More...
 
const char * getName () const
 Returns a name that is used to identify the widget easily. More...
 
WidgetType getWidgetType () const
 Returns a type that is widget's type. More...
 
virtual void setSize (const CCSize &size)
 Changes the size that is widget's size. More...
 
virtual void setSizePercent (const CCPoint &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 CCSizegetSize () const
 Returns size of widget. More...
 
virtual const CCSizegetLayoutSize ()
const CCPointgetSizePercent () const
 Returns size percent of widget. More...
 
const CCSizegetCustomSize () const
virtual bool hitTest (const CCPoint &pt)
 Checks a point if is in widget's space. More...
 
virtual bool onTouchBegan (CCTouch *touch, CCEvent *unused_event)
virtual void onTouchMoved (CCTouch *touch, CCEvent *unused_event)
virtual void onTouchEnded (CCTouch *touch, CCEvent *unused_event)
virtual void onTouchCancelled (CCTouch *touch, CCEvent *unused_event)
void setLayoutParameter (LayoutParameter *parameter)
 Sets a LayoutParameter to widget. More...
 
LayoutParametergetLayoutParameter (LayoutParameterType 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...
 
CCPoint getWorldPosition ()
 Gets world position of widget. More...
 
virtual CCNodegetVirtualRenderer ()
 Gets the Virtual Renderer of widget. More...
 
virtual const CCSizegetContentSize () const
 Gets the content size of widget. More...
 
virtual std::string getDescription () const
 Returns the "class name" of widget. More...
 
Widgetclone ()
virtual void onEnter ()
 Event callback that is invoked every time when CCNode enters the 'stage'. More...
 
virtual void onExit ()
 Event callback that is invoked every time the CCNode leaves the 'stage'. More...
 
void updateSizeAndPosition ()
void updateSizeAndPosition (const CCSize &parentSize)
void setActionTag (int tag)
int getActionTag ()
virtual cocos2d::CCDictionarygetScriptObjectDict () const
 Returns a user assigned CCDictionary. More...
 
virtual void setScriptObjectDict (cocos2d::CCDictionary *scriptObjectDict)
 Returns a user assigned CCDictionary. More...
 
- Public Member Functions inherited from CCNodeRGBA
 CCNodeRGBA ()
virtual ~CCNodeRGBA ()
virtual GLubyte getDisplayedOpacity ()
 Returns the displayed opacity. More...
 
virtual void updateDisplayedOpacity (GLubyte parentOpacity)
 recursive method that updates the displayed opacity. More...
 
virtual bool isCascadeOpacityEnabled ()
 whether or not opacity should be propagated to its children. More...
 
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual const ccColor3BgetDisplayedColor ()
 Returns the displayed color. More...
 
virtual void updateDisplayedColor (const ccColor3B &parentColor)
 recursive method that updates display color More...
 
virtual bool isCascadeColorEnabled ()
 whether or not color should be propagated to its children. More...
 
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
virtual void setOpacityModifyRGB (bool bValue)
 Changes the OpacityModifyRGB property. More...
 
virtual bool isOpacityModifyRGB ()
 Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity) More...
 
- Public Member Functions inherited from CCNode
virtual CCCameragetCamera ()
 Returns a camera object that lets you move the node using a gluLookAt. More...
 
virtual bool isRunning ()
 Returns whether or not the node accepts event callbacks. More...
 
virtual void cleanup (void)
 Stops all running actions and schedulers. More...
 
virtual void draw (void)
 Override this method to draw your own node. More...
 
virtual CCRect boundingBox (void)
 Returns a "local" axis aligned bounding box of the node. More...
 
virtual void setZOrder (int zOrder)
 Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...
 
virtual void _setZOrder (int z)
 Sets the z order which stands for the drawing order. More...
 
var _setZOrder ( var z)
 Sets the z order which stands for the drawing order. More...
 
local _setZOrder ( local z)
 Sets the z order which stands for the drawing order. More...
 
virtual int getZOrder ()
 Gets the Z order of this node. More...
 
virtual void setVertexZ (float vertexZ)
 Sets the real OpenGL Z vertex. More...
 
local setVertexZ ( local vertexZ)
 Sets the real OpenGL Z vertex. More...
 
virtual float getVertexZ ()
 Gets OpenGL Z vertex of this node. More...
 
var getVertexZ ()
 Gets OpenGL Z vertex of this node. More...
 
local getVertexZ ()
 Gets OpenGL Z vertex of this node. More...
 
virtual void setScaleX (float fScaleX)
 Changes the scale factor on X axis of this node. More...
 
local setScaleX ( local fScaleX)
 Changes the scale factor on X axis of this node. More...
 
virtual float getScaleX ()
 Returns the scale factor on X axis of this node. More...
 
var getScaleX ()
 Returns the scale factor on X axis of this node. More...
 
local getScaleX ()
 Returns the scale factor on X axis of this node. More...
 
virtual void setScaleY (float fScaleY)
 Changes the scale factor on Y axis of this node. More...
 
virtual float getScaleY ()
 Returns the scale factor on Y axis of this node. More...
 
virtual void setScale (float scale)
 Changes both X and Y scale factor of the node. More...
 
virtual float getScale ()
 Gets the scale factor of the node, when X and Y have the same scale factor. More...
 
virtual void setScale (float fScaleX, float fScaleY)
 Changes both X and Y scale factor of the node. More...
 
local setScale ( local fScaleX, local fScaleY)
 Changes both X and Y scale factor of the node. More...
 
virtual const CCPointgetPosition ()
 Gets the position (x,y) of the node in OpenGL coordinates. More...
 
local getPosition ()
 Gets the position (x,y) of the node in OpenGL coordinates. More...
 
virtual void setPosition (float x, float y)
 Sets position in a more efficient way. More...
 
local setPosition ( local x, local y)
 Sets position in a more efficient way. More...
 
virtual void getPosition (float *x, float *y)
 Gets position in a more efficient way, returns two number instead of a CCPoint object. More...
 
local getPosition ( local x, local y)
 Gets position in a more efficient way, returns two number instead of a CCPoint 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)
virtual void setPositionY (float y)
var setPositionY ( var y)
local setPositionY ( local y)
virtual float getPositionY (void)
var getPositionY ()
local getPositionY ()
virtual void setSkewX (float fSkewX)
 Changes the X skew angle of the node in degrees. More...
 
local setSkewX ( local fSkewX)
 Changes the X skew angle of the node in degrees. More...
 
virtual float getSkewX ()
 Returns the X skew angle of the node in degrees. More...
 
local getSkewX ()
 Returns the X skew angle of the node in degrees. More...
 
virtual void setSkewY (float fSkewY)
 Changes the Y skew angle of the node in degrees. More...
 
virtual float getSkewY ()
 Returns the Y skew angle of the node in degrees. More...
 
var getSkewY ()
 Returns the Y skew angle of the node in degrees. More...
 
local getSkewY ()
 Returns the Y skew angle of the node in degrees. More...
 
virtual void setAnchorPoint (const CCPoint &anchorPoint)
 Sets the anchor point in percent. More...
 
local setAnchorPoint ( local anchorPoint)
 Sets the anchor point in percent. More...
 
virtual const CCPointgetAnchorPoint ()
 Returns the anchor point in percent. More...
 
local getAnchorPoint ()
 Returns the anchor point in percent. More...
 
virtual const CCPointgetAnchorPointInPoints ()
 Returns the anchorPoint in absolute pixels. More...
 
local getAnchorPointInPoints ()
 Returns the anchorPoint in absolute pixels. More...
 
virtual void setContentSize (const CCSize &contentSize)
 Sets the untransformed size of the node. More...
 
local setContentSize ( local contentSize)
 Sets 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 ()
 Determines if the node is visible. More...
 
virtual void setRotation (float fRotation)
 Sets the rotation (angle) of the node in degrees. More...
 
local setRotation ( local fRotation)
 Sets the rotation (angle) of the node in degrees. More...
 
virtual float getRotation ()
 Returns the rotation of the node in degrees. More...
 
virtual void setRotationX (float fRotaionX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
local setRotationX ( local fRotaionX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual float getRotationX ()
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
local getRotationX ()
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
virtual void setRotationY (float fRotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local setRotationY ( local fRotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual float getRotationY ()
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
var getRotationY ()
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local getRotationY ()
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual void setOrderOfArrival (unsigned int uOrderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
var setOrderOfArrival ( var uOrderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
local setOrderOfArrival ( local uOrderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
virtual unsigned int getOrderOfArrival ()
 Returns the arrival order, indecates which children is added previously. More...
 
virtual void setGLServerState (ccGLServerState glServerState)
 Sets the state of OpenGL server side. More...
 
local setGLServerState ( local glServerState)
 Sets the state of OpenGL server side. More...
 
virtual ccGLServerState getGLServerState ()
 Returns the state of OpenGL server side. More...
 
local getGLServerState ()
 Returns the state of OpenGL server side. More...
 
virtual void ignoreAnchorPointForPosition (bool ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
local ignoreAnchorPointForPosition ( local ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
virtual bool isIgnoreAnchorPointForPosition ()
 Gets whether the anchor point will be (0,0) when you position this node. More...
 
virtual void setParent (CCNode *parent)
 Sets the parent node. More...
 
virtual CCNodegetParent ()
 Returns a pointer to the parent node. More...
 
var getParent ()
 Returns a pointer to the parent node. More...
 
local getParent ()
 Returns a pointer to the parent node. More...
 
virtual void removeChildByTag (int tag)
 Removes a child from the container by tag value with a cleanup. More...
 
virtual void reorderChild (CCNode *child, int zOrder)
 Reorders a child according to a new z value. More...
 
virtual CCGridBasegetGrid ()
 Returns a grid object that is used when applying effects. More...
 
virtual void setGrid (CCGridBase *pGrid)
 Changes a grid object that is used when applying effects. More...
 
virtual int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
var getTag ()
 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 nTag)
 Changes the tag that is used to identify the node easily. More...
 
local setTag ( local nTag)
 Changes the tag that is used to identify the node easily. More...
 
virtual void * getUserData ()
 Returns a custom user data pointer. More...
 
virtual void setUserData (void *pUserData)
 Sets a custom user data pointer. More...
 
local setUserData ( local pUserData)
 Sets a custom user data pointer. More...
 
virtual CCObjectgetUserObject ()
 Returns a user assigned CCObject. More...
 
local getUserObject ()
 Returns a user assigned CCObject. More...
 
virtual void setUserObject (CCObject *pUserObject)
 Returns a user assigned CCObject. More...
 
local setUserObject ( local pUserObject)
 Returns a user assigned CCObject. More...
 
virtual CCGLProgramgetShaderProgram ()
 Return the shader program currently used for this node. More...
 
virtual void setShaderProgram (CCGLProgram *pShaderProgram)
 Sets the shader program for this node. More...
 
virtual void registerScriptHandler (int handler)
 Registers a script function that will be called in onEnter() & onExit() seires functions. More...
 
local registerScriptHandler ( local handler)
 Registers a script function that will be called in onEnter() & onExit() seires functions. More...
 
virtual void unregisterScriptHandler (void)
 Unregisters a script function that will be called in onEnter() & onExit() series functions. More...
 
int getScriptHandler ()
 Gets script handler for onEnter/onExit event. More...
 
void scheduleUpdateWithPriorityLua (int nHandler, int priority)
 Schedules for lua script. More...
 
local scheduleUpdateWithPriorityLua ( local nHandler, local priority)
 Schedules for lua script. More...
 
virtual void onEnterTransitionDidFinish ()
 Event callback that is invoked when the CCNode enters in the 'stage'. More...
 
virtual void onExitTransitionDidStart ()
 Event callback that is called every time the CCNode leaves the 'stage'. More...
 
virtual void setActionManager (CCActionManager *actionManager)
 Sets the CCActionManager object that is used by all actions. More...
 
virtual CCActionManagergetActionManager ()
 Gets the CCActionManager object that is used by all actions. More...
 
local getActionManager ()
 Gets the CCActionManager object that is used by all actions. More...
 
CCActionrunAction (CCAction *action)
 Executes an action, and returns the action that is executed. More...
 
void stopAllActions (void)
 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 (CCAction *action)
 Stops and removes an action from the running action list. More...
 
var stopAction ( var action)
 Stops and removes an action from the running action list. More...
 
local stopAction ( local action)
 Stops and removes an action from the running action list. More...
 
void stopActionByTag (int tag)
 Removes an action from the running action list by its tag. More...
 
var stopActionByTag ( var tag)
 Removes an action from the running action list by its tag. More...
 
local stopActionByTag ( local tag)
 Removes an action from the running action list by its tag. More...
 
CCActiongetActionByTag (int tag)
 Gets an action from the running action list by its tag. More...
 
unsigned int numberOfRunningActions (void)
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
local numberOfRunningActions ()
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
virtual void setScheduler (CCScheduler *scheduler)
 Sets a CCScheduler object that is used to schedule all "updates" and timers. More...
 
virtual CCSchedulergetScheduler ()
 Gets a CCSheduler object. More...
 
local getScheduler ()
 Gets a CCSheduler object. More...
 
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...
 
var scheduleUpdateWithPriority ( var priority)
 Schedules the "update" method with a custom priority. More...
 
void unscheduleUpdate (void)
var unscheduleUpdate ()
local unscheduleUpdate ()
void schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
 Schedules a custom selector. More...
 
void schedule (SEL_SCHEDULE selector, float interval)
 Schedules a custom selector with an interval time in seconds. More...
 
var schedule ( var selector, var 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 resumeSchedulerAndActions (void)
 Resumes all scheduled selectors and actions. More...
 
void pauseSchedulerAndActions (void)
 Pauses all scheduled selectors and actions. More...
 
virtual void update (float delta)
var update ( var delta)
local update ( local delta)
void transform (void)
 Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes. More...
 
void transformAncestors (void)
 Performs OpenGL view-matrix transformation of it's ancestors. More...
 
virtual void updateTransform (void)
 Calls children's updateTransform() method recursively. More...
 
virtual CCAffineTransform nodeToParentTransform (void)
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
local nodeToParentTransform ()
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual CCAffineTransform parentToNodeTransform (void)
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
local parentToNodeTransform ()
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
virtual CCAffineTransform nodeToWorldTransform (void)
 Returns the world affine transform matrix. More...
 
local nodeToWorldTransform ()
 Returns the world affine transform matrix. More...
 
virtual CCAffineTransform worldToNodeTransform (void)
 Returns the inverse world affine transform matrix. More...
 
local worldToNodeTransform ()
 Returns the inverse world affine transform matrix. More...
 
CCPoint convertToNodeSpace (const CCPoint &worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
CCPoint convertToWorldSpace (const CCPoint &nodePoint)
 Converts a Point to world space coordinates. More...
 
var convertToWorldSpace ( var nodePoint)
 Converts a Point to world space coordinates. More...
 
local convertToWorldSpace ( local nodePoint)
 Converts a Point to world space coordinates. More...
 
CCPoint convertToNodeSpaceAR (const CCPoint &worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
CCPoint convertToWorldSpaceAR (const CCPoint &nodePoint)
 Converts a local Point to world space coordinates.The result is in Points. More...
 
CCPoint convertTouchToNodeSpace (CCTouch *touch)
 convenience methods which take a CCTouch instead of CCPoint More...
 
var convertTouchToNodeSpace ( var touch)
 convenience methods which take a CCTouch instead of CCPoint More...
 
local convertTouchToNodeSpace ( local touch)
 convenience methods which take a CCTouch instead of CCPoint More...
 
CCPoint convertTouchToNodeSpaceAR (CCTouch *touch)
 converts a CCTouch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (const CCAffineTransform &additionalTransform)
 Sets the additional transform. More...
 
var setAdditionalTransform ( var additionalTransform)
 Sets the additional transform. More...
 
local setAdditionalTransform ( local additionalTransform)
 Sets the additional transform. More...
 
CCComponentgetComponent (const char *pName) const
 gets a component by its name More...
 
var getComponent ( var pName)
 gets a component by its name More...
 
local getComponent ( local pName)
 gets a component by its name More...
 
virtual bool addComponent (CCComponent *pComponent)
 adds a component More...
 
var addComponent ( var pComponent)
 adds a component More...
 
local addComponent ( local pComponent)
 adds a component More...
 
virtual bool removeComponent (const char *pName)
 removes a component by its name More...
 
virtual bool removeComponent (CCComponent *pComponent)
 removes a component by its pointer More...
 
var removeComponent ( var pComponent)
 removes a component by its pointer More...
 
local removeComponent ( local pComponent)
 removes a component by its pointer More...
 
virtual void removeAllComponents ()
 removes all components More...
 
 CCNode (void)
 Default constructor. More...
 
virtual ~CCNode (void)
 Default destructor. More...
 
const char * description (void)
 Gets the description string. More...
 
- Public Member Functions inherited from CCObject
 CCObject (void)
virtual ~CCObject (void)
void release (void)
void retain (void)
CCObjectautorelease (void)
CCObjectcopy (void)
bool isSingleReference (void) const
unsigned int retainCount (void) const
virtual bool isEqual (const CCObject *pObject)
virtual void acceptVisitor (CCDataVisitor &visitor)
- Public Member Functions inherited from CCCopying
virtual CCObjectcopyWithZone (CCZone *pZone)

Static Public Member Functions

static Widgetcreate ()
 Allocates and initializes a widget. More...
 
- Static Public Member Functions inherited from CCNodeRGBA
static CCNodeRGBAcreate (void)
 Allocates and initializes a nodergba. More...
 
- Static Public Member Functions inherited from CCNode
static CCNodecreate (void)
 Allocates and initializes a node. More...
 
local create ()
 Allocates and initializes a node. More...
 

Protected Member Functions

virtual void onSizeChanged ()
virtual bool init ()
 Initializes the instance of CCNode. More...
 
virtual void initRenderer ()
virtual void onPressStateChangedToNormal ()
virtual void onPressStateChangedToPressed ()
virtual void onPressStateChangedToDisabled ()
void pushDownEvent ()
void moveEvent ()
void releaseUpEvent ()
void cancelUpEvent ()
void updateAnchorPoint ()
virtual void updateTextureColor ()
virtual void updateTextureOpacity ()
virtual void updateTextureRGBA ()
virtual void updateFlippedX ()
virtual void updateFlippedY ()
void updateColorToRenderer (CCNode *renderer)
void updateOpacityToRenderer (CCNode *renderer)
void updateRGBAToRenderer (CCNode *renderer)
void copyProperties (Widget *model)
virtual WidgetcreateCloneInstance ()
virtual void copySpecialProperties (Widget *model)
virtual void copyClonedWidgetChildren (Widget *model)
WidgetgetWidgetParent ()

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 _touchPassedEnabled
 is the touch event should be passed More...
 
bool _focus
 is the widget on focus More...
 
BrightStyle _brightStyle
 bright style More...
 
CCPoint _touchStartPos
 touch began point More...
 
CCPoint _touchMovePos
 touch moved point More...
 
CCPoint _touchEndPos
 touch ended point More...
 
CCObject_touchEventListener
SEL_TouchEvent _touchEventSelector
std::string _name
WidgetType _widgetType
int _actionTag
CCSize _size
CCSize _customSize
bool _ignoreSize
bool _affectByClipping
SizeType _sizeType
CCPoint _sizePercent
PositionType _positionType
CCPoint _positionPercent
bool _reorderWidgetChildDirty
bool _hitted
CCArray_widgetChildren
CCDictionary_layoutParameterDictionary
CCArray_nodes
ccColor3B _color
GLubyte _opacity
bool _flippedX
bool _flippedY
cocos2d::CCDictionary_scriptObjectDict
- Protected Attributes inherited from CCNodeRGBA
GLubyte _displayedOpacity
GLubyte _realOpacity
ccColor3B _displayedColor
ccColor3B _realColor
bool _cascadeColorEnabled
bool _cascadeOpacityEnabled
- Protected Attributes inherited from CCNode
float m_fRotationX
 rotation angle on x-axis More...
 
float m_fRotationY
 rotation angle on y-axis More...
 
var m_fRotationY
 rotation angle on y-axis More...
 
local m_fRotationY
 rotation angle on y-axis More...
 
float m_fScaleX
 scaling factor on x-axis More...
 
var m_fScaleX
 scaling factor on x-axis More...
 
local m_fScaleX
 scaling factor on x-axis More...
 
float m_fScaleY
 scaling factor on y-axis More...
 
var m_fScaleY
 scaling factor on y-axis More...
 
local m_fScaleY
 scaling factor on y-axis More...
 
float m_fVertexZ
 OpenGL real Z vertex. More...
 
var m_fVertexZ
 OpenGL real Z vertex. More...
 
local m_fVertexZ
 OpenGL real Z vertex. More...
 
CCPoint m_obPosition
 position of the node More...
 
var m_obPosition
 position of the node More...
 
local m_obPosition
 position of the node More...
 
float m_fSkewX
 skew angle on x-axis More...
 
var m_fSkewX
 skew angle on x-axis More...
 
local m_fSkewX
 skew angle on x-axis More...
 
float m_fSkewY
 skew angle on y-axis More...
 
var m_fSkewY
 skew angle on y-axis More...
 
local m_fSkewY
 skew angle on y-axis More...
 
CCPoint m_obAnchorPointInPoints
 anchor point in points More...
 
var m_obAnchorPointInPoints
 anchor point in points More...
 
local m_obAnchorPointInPoints
 anchor point in points More...
 
CCPoint m_obAnchorPoint
 anchor point normalized (NOT in points) More...
 
var m_obAnchorPoint
 anchor point normalized (NOT in points) More...
 
local m_obAnchorPoint
 anchor point normalized (NOT in points) More...
 
CCSize m_obContentSize
 untransformed size of the node More...
 
CCAffineTransform m_sAdditionalTransform
 transform More...
 
var m_sAdditionalTransform
 transform More...
 
local m_sAdditionalTransform
 transform More...
 
CCAffineTransform m_sTransform
 transform More...
 
var m_sTransform
 transform More...
 
local m_sTransform
 transform More...
 
CCAffineTransform m_sInverse
 transform More...
 
var m_sInverse
 transform More...
 
local m_sInverse
 transform More...
 
CCCameram_pCamera
 a camera More...
 
var m_pCamera
 a camera More...
 
local m_pCamera
 a camera More...
 
CCGridBasem_pGrid
 a grid More...
 
var m_pGrid
 a grid More...
 
local m_pGrid
 a grid More...
 
int m_nZOrder
 z-order value that affects the draw order More...
 
var m_nZOrder
 z-order value that affects the draw order More...
 
local m_nZOrder
 z-order value that affects the draw order More...
 
CCArraym_pChildren
 array of children nodes More...
 
var m_pChildren
 array of children nodes More...
 
local m_pChildren
 array of children nodes More...
 
CCNodem_pParent
 weak reference to parent node More...
 
var m_pParent
 weak reference to parent node More...
 
local m_pParent
 weak reference to parent node More...
 
int m_nTag
 a tag. Can be any number you assigned just to identify this node More...
 
void * m_pUserData
 A user assingned void pointer, Can be point to any cpp object. More...
 
var m_pUserData
 A user assingned void pointer, Can be point to any cpp object. More...
 
local m_pUserData
 A user assingned void pointer, Can be point to any cpp object. More...
 
CCObjectm_pUserObject
 A user assigned CCObject. More...
 
var m_pUserObject
 A user assigned CCObject. More...
 
local m_pUserObject
 A user assigned CCObject. More...
 
CCGLProgramm_pShaderProgram
 OpenGL shader. More...
 
var m_pShaderProgram
 OpenGL shader. More...
 
local m_pShaderProgram
 OpenGL shader. More...
 
ccGLServerState m_eGLServerState
 OpenGL servier side state. More...
 
var m_eGLServerState
 OpenGL servier side state. More...
 
local m_eGLServerState
 OpenGL servier side state. More...
 
unsigned int m_uOrderOfArrival
 used to preserve sequence while sorting children with the same zOrder More...
 
CCSchedulerm_pScheduler
 scheduler used to schedule timers and updates More...
 
var m_pScheduler
 scheduler used to schedule timers and updates More...
 
local m_pScheduler
 scheduler used to schedule timers and updates More...
 
CCActionManagerm_pActionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
var m_pActionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
local m_pActionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
bool m_bRunning
 is running More...
 
var m_bRunning
 is running More...
 
local m_bRunning
 is running More...
 
bool m_bTransformDirty
 transform dirty flag More...
 
var m_bTransformDirty
 transform dirty flag More...
 
local m_bTransformDirty
 transform dirty flag More...
 
bool m_bInverseDirty
 transform dirty flag More...
 
var m_bInverseDirty
 transform dirty flag More...
 
local m_bInverseDirty
 transform dirty flag More...
 
bool m_bAdditionalTransformDirty
 The flag to check whether the additional transform is dirty. More...
 
bool m_bVisible
 is this node visible More...
 
var m_bVisible
 is this node visible More...
 
local m_bVisible
 is this node visible More...
 
bool m_bIgnoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise. More...
 
var m_bIgnoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise. More...
 
local m_bIgnoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise. More...
 
bool m_bReorderChildDirty
 children order dirty flag More...
 
var m_bReorderChildDirty
 children order dirty flag More...
 
local m_bReorderChildDirty
 children order dirty flag More...
 
int m_nScriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
var m_nScriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
local m_nScriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
int m_nUpdateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
var m_nUpdateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
local m_nUpdateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
ccScriptType m_eScriptType
 type of script binding, lua or javascript More...
 
var m_eScriptType
 type of script binding, lua or javascript More...
 
local m_eScriptType
 type of script binding, lua or javascript More...
 
CCComponentContainerm_pComponentContainer
 Dictionary of components. More...
 
var m_pComponentContainer
 Dictionary of components. More...
 
local m_pComponentContainer
 Dictionary of components. More...
 
- Protected Attributes inherited from CCObject
unsigned int m_uReference
unsigned int m_uAutoReleaseCount

Friends

class TouchGroup

Additional Inherited Members

- Public Attributes inherited from CCObject
unsigned int m_uID
int m_nLuaID

Constructor & Destructor Documentation

Widget ( void  )
virtual ~Widget ( )
virtual

Default destructor.

Member Function Documentation

virtual void addChild ( CCNode child)
virtual

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

Reimplemented in ScrollView, Layout, ListView, and PageView.

virtual void addChild ( CCNode child,
int  zOrder 
)
virtual

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 setZOrder(int)

Reimplemented from CCNode.

Reimplemented in ScrollView, Layout, ListView, and PageView.

virtual void addChild ( CCNode child,
int  zOrder,
int  tag 
)
virtual

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 setZOrder(int)
tagA interger to identify the node easily. Please refer to setTag(int)

Reimplemented from CCNode.

Reimplemented in ScrollView, Layout, ListView, and PageView.

virtual void addNode ( CCNode node)
virtual

Reimplemented in ScrollView.

virtual void addNode ( CCNode node,
int  zOrder 
)
virtual

Reimplemented in ScrollView.

virtual void addNode ( CCNode node,
int  zOrder,
int  tag 
)
virtual

Reimplemented in ScrollView.

void addTouchEventListener ( CCObject target,
SEL_TouchEvent  selector 
)

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

void cancelUpEvent ( )
protected
virtual void checkChildInfo ( int  handleState,
Widget sender,
const CCPoint touchPoint 
)
virtual

Reimplemented in ScrollView, and PageView.

bool clippingParentAreaContainPoint ( const CCPoint 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
static Widget* create ( )
static

Allocates and initializes a widget.

virtual Widget* createCloneInstance ( )
protectedvirtual
void didNotSelectSelf ( )

A call back function when widget lost of focus.

int getActionTag ( )
float getBottomInParent ( )

Gets the bottom boundary position of this widget.

Returns
The bottom boundary position of this widget.
virtual Widget* getChildByName ( const char *  name)
virtual

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 in ScrollView, ListView, and PageView.

virtual CCNode* getChildByTag ( int  tag)
virtual

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

Reimplemented in ScrollView, ListView, and PageView.

virtual CCArray* getChildren ( )
virtual

Return an array of children.

Composing a "tree" structure is a very important feature of Node Here's a sample code of traversing children array:

Node* node = NULL;
CCARRAY_FOREACH(parent->getChildren(), node)
{
node->setPosition(0,0);
}

This sample code traverses all children nodes, and set their position to (0,0)

Returns
An array of children

Reimplemented from CCNode.

Reimplemented in ScrollView, ListView, and PageView.

virtual unsigned int
getChildrenCount
( ) const
virtual

Get the amount of children.

Returns
The amount of children.

Reimplemented from CCNode.

Reimplemented in ScrollView, ListView, and PageView.

const ccColor3B& getColor ( )
inlinevirtual

Returns color that is currently used.

Returns
The ccColor3B contains R,G,B bytes.

Reimplemented from CCNodeRGBA.

virtual const CCSize&
getContentSize
( ) const
virtual

Gets the content size of widget.

Content size is widget's texture size.

Reimplemented from CCNode.

Reimplemented in Slider, Button, TextField, CheckBox, LoadingBar, Label, RichText, ImageView, LabelAtlas, and LabelBMFont.

const CCSize& getCustomSize ( ) const
virtual std::string getDescription ( ) const
virtual

Returns the "class name" of widget.

Reimplemented in ScrollView, Layout, Slider, ListView, Button, PageView, CheckBox, TextField, LoadingBar, Label, RichText, LabelAtlas, ImageView, and LabelBMFont.

LayoutParameter* getLayoutParameter ( LayoutParameterType  type)

Gets LayoutParameter of widget.

See also
LayoutParameter
Parameters
typeRelative or Linear
Returns
LayoutParameter
virtual const CCSize& getLayoutSize ( )
inlinevirtual

Reimplemented in ScrollInnerContainer.

float getLeftInParent ( )

Gets the left boundary position of this widget.

Returns
The left boundary position of this widget.
const char* 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 char* that identifies the widget.
virtual CCNode* getNodeByTag ( int  tag)
virtual

Reimplemented in ScrollView.

virtual CCArray* getNodes ( )
virtual

Reimplemented in ScrollView.

GLubyte getOpacity ( )
inlinevirtual

Returns the opacity.

The opacity which indicates how transparent or opaque this node is. 0 indicates fully transparent and 255 is fully opaque.

Returns
The opacity of sprite, from 0 ~ 255

Reimplemented from CCNodeRGBA.

const CCPoint& getPositionPercent ( )

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

See also
setPosition(const Point&)
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.
virtual cocos2d::CCDictionary*
getScriptObjectDict
( ) const
virtual

Returns a user assigned CCDictionary.

Returns
A user assigned CCDictionary
const CCSize& getSize ( ) const

Returns size of widget.

Returns
size
const CCPoint& getSizePercent ( ) const

Returns size percent of widget.

Returns
size percent
SizeType getSizeType ( ) const

Gets the size type of widget.

See also
SizeType
Parameters
typethat is widget's size type
float getTopInParent ( )

Gets the top boundary position of this widget.

Returns
The top boundary position of this widget.
const CCPoint& getTouchEndPos ( )
const CCPoint& getTouchMovePos ( )
const CCPoint& getTouchStartPos ( )
virtual CCNode* 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, Button, CheckBox, TextField, LoadingBar, Label, ImageView, LabelAtlas, and LabelBMFont.

Widget* getWidgetParent ( )
protected
WidgetType getWidgetType ( ) const

Returns a type that is widget's type.

See also
WidgetType
Returns
A WidgetType
CCPoint getWorldPosition ( )

Gets world position of widget.

Returns
world position of widget.
virtual bool hitTest ( const CCPoint 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 Layout, and TextField.

virtual void
ignoreContentAdaptWithSize
( bool  ignore)
virtual

Ignore the widget size.

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

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

virtual bool init ( )
protectedvirtual

Initializes the instance of CCNode.

Returns
Whether the initialization was successful.

Reimplemented from CCNodeRGBA.

Reimplemented in ScrollView, Layout, Slider, ListView, PageView, Button, TextField, CheckBox, Label, and RichText.

virtual void initRenderer ( )
inlineprotectedvirtual
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 isFlipX ( )
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 isFlipY ( )
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.
bool isFocused ( ) const

Determines if the widget is on focused.

Returns
true if the widget is on focused, false if the widget is not on focused.
bool isIgnoreContentAdaptWithSize ( ) const

Gets the widget if is ignore it's size.

Parameters
ignore,truethat 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 ( )
virtual

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

If the CCNode 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., CCNode::onEnter().

Reimplemented from CCNode.

Reimplemented in ScrollView, Layout, PageView, and TextField.

virtual void onExit ( )
virtual

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

If the CCNode 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., CCNode::onExit().

Reimplemented from CCNode.

Reimplemented in Layout.

virtual void
onPressStateChangedToDisabled
( )
protectedvirtual

Reimplemented in Slider, Button, CheckBox, and Label.

virtual void
onPressStateChangedToNormal
( )
protectedvirtual

Reimplemented in Slider, Button, CheckBox, and Label.

virtual void
onPressStateChangedToPressed
( )
protectedvirtual

Reimplemented in Slider, Button, CheckBox, and Label.

virtual void onSizeChanged ( )
protectedvirtual
virtual bool onTouchBegan ( CCTouch touch,
CCEvent unused_event 
)
virtual

Reimplemented in ScrollView, Slider, PageView, and TextField.

virtual void onTouchCancelled ( CCTouch touch,
CCEvent unused_event 
)
virtual

Reimplemented in ScrollView, Slider, and PageView.

virtual void onTouchEnded ( CCTouch touch,
CCEvent unused_event 
)
virtual

Reimplemented in ScrollView, Slider, CheckBox, and PageView.

virtual void onTouchMoved ( CCTouch touch,
CCEvent unused_event 
)
virtual

Reimplemented in ScrollView, Slider, and PageView.

void pushDownEvent ( )
protected
void releaseUpEvent ( )
protected
virtual void removeAllChildren ( )
virtual

Removes all children from the container with a cleanup.

See also
removeAllChildrenWithCleanup(bool)

Reimplemented from CCNode.

Reimplemented in ScrollView, Layout, ListView, and PageView.

virtual void
removeAllChildrenWithCleanup
( bool  cleanup)
virtual

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

Reimplemented in ScrollView, Layout, ListView, and PageView.

virtual void removeAllNodes ( )
virtual

Reimplemented in ScrollView.

virtual void removeChild ( CCNode child)
virtual

Removes a child from the container with a cleanup.

See also
removeChild(CCNode, bool)
Parameters
childThe child node which will be removed.

Reimplemented from CCNode.

Reimplemented in ScrollView, Layout, ListView, and PageView.

virtual void removeChild ( CCNode child,
bool  cleanup 
)
virtual

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

Reimplemented in ScrollView, Layout, ListView, and PageView.

virtual void removeChildByTag ( int  tag,
bool  cleanup 
)
virtual

Removes a child from the container by tag value.

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

Parameters
tagAn interger number that identifies a child node
cleanuptrue if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented from CCNode.

virtual void removeFromParent ( )
virtual

Removes this node itself from its parent node with a cleanup.

If the node orphan, then nothing happens.

See also
removeFromParentAndCleanup(bool)

Reimplemented from CCNode.

virtual void
removeFromParentAndCleanup
( bool  cleanup)
virtual

Removes this node itself from its parent node.

If the node orphan, then nothing happens.

Parameters
cleanuptrue if all actions and callbacks on this node should be removed, false otherwise.

Reimplemented from CCNode.

virtual void removeNode ( CCNode node)
virtual

Reimplemented in ScrollView.

virtual void removeNodeByTag ( int  tag)
virtual

Reimplemented in ScrollView.

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
visibletrue 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
styleBRIGHT_NORMAL the widget is normal state, BRIGHT_HIGHLIGHT the widget is height light state.
virtual void setColor ( const ccColor3B color)
virtual

@

Reimplemented from CCNodeRGBA.

virtual void setEnabled ( bool  enabled)
virtual

Sets whether the widget is enabled.

Highest control of widget. The default value is true, a widget is default to enabled

Parameters
enabledtrue if the widget is enabled, widget may be touched and visible, false if the widget is disabled, widget cannot be touched and hidden.
virtual void setFlipX ( bool  flipX)
virtual

Sets whether the widget should be flipped horizontally or not.

Parameters
bFlipXtrue if the widget should be flipped horizaontally, false otherwise.
virtual void setFlipY ( bool  flipY)
virtual

Sets whether the widget should be flipped vertically or not.

Parameters
bFlipYtrue if the widget should be flipped vertically, flase otherwise.
void setFocused ( bool  fucosed)

Sets whether the widget is on focused.

The default value is false, a widget is default to not on focused

Parameters
fucosedtrue if the widget is on focused, false if the widget is not on focused.
void setLayoutParameter ( LayoutParameter parameter)

Sets a LayoutParameter to widget.

See also
LayoutParameter
Parameters
LayoutParameterpointer
typeRelative or Linear
void setName ( const char *  name)

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

Parameters
Aconst char* that indentifies the widget.
virtual void setOpacity ( GLubyte  opacity)
virtual

Changes the opacity.

Parameters
valueGoes from 0 to 255, where 255 means fully opaque and 0 means fully transparent.

Reimplemented from CCNodeRGBA.

void setPosition ( const CCPoint pos)
virtual

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

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

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

Reimplemented from CCNode.

void setPositionPercent ( const CCPoint percent)

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

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

Parameters
percentThe percent (x,y) of the widget in OpenGL coordinates
void setPositionType ( PositionType  type)

Changes the position type of the widget.

See also
PositionType
Parameters
typethe position type of widget
virtual void setScriptObjectDict ( cocos2d::CCDictionary scriptObjectDict)
virtual

Returns a user assigned CCDictionary.

The scriptObjectDict will be retained once in this method, and the previous scriptObjectDict (if existed) will be relese. The scriptObjectDict will be released in destructure.

Parameters
Auser assigned CCObject
virtual void setSize ( const CCSize size)
virtual

Changes the size that is widget's size.

Parameters
sizethat is widget's size
virtual void setSizePercent ( const CCPoint percent)
virtual

Changes the percent that is widget's percent size.

Parameters
percentthat is widget's percent size
void setSizeType ( SizeType  type)

Changes the size type of widget.

See also
SizeType
Parameters
typethat 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
visibletrue if the widget is touch enabled, false if the widget is touch disabled.
virtual void sortAllChildren ( )
virtual

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

Reimplemented in Layout, and ListView.

void updateAnchorPoint ( )
protected
void updateColorToRenderer ( CCNode renderer)
protected
virtual void updateFlippedX ( )
inlineprotectedvirtual

Reimplemented in Button, CheckBox, Label, and ImageView.

virtual void updateFlippedY ( )
inlineprotectedvirtual

Reimplemented in Button, CheckBox, Label, and ImageView.

void updateOpacityToRenderer ( CCNode renderer)
protected
void updateRGBAToRenderer ( CCNode renderer)
protected
void updateSizeAndPosition ( )
void updateSizeAndPosition ( const CCSize parentSize)
virtual void updateTextureColor ( )
inlineprotectedvirtual
virtual void updateTextureOpacity ( )
inlineprotectedvirtual
virtual void updateTextureRGBA ( )
inlineprotectedvirtual
virtual void visit ( )
virtual

Visits this node's children and draw them recursively.

Reimplemented from CCNode.

Reimplemented in Layout, and RichText.

Friends And Related Function Documentation

friend class TouchGroup
friend

Member Data Documentation

int _actionTag
protected
bool _affectByClipping
protected
bool _bright
protected

is this widget bright

BrightStyle _brightStyle
protected

bright style

ccColor3B _color
protected
CCSize _customSize
protected
bool _enabled
protected

Highest control of widget.

bool _flippedX
protected
bool _flippedY
protected
bool _focus
protected

is the widget on focus

bool _hitted
protected
bool _ignoreSize
protected
CCDictionary*
_layoutParameterDictionary
protected
std::string _name
protected
CCArray* _nodes
protected
GLubyte _opacity
protected
CCPoint _positionPercent
protected
PositionType _positionType
protected
bool _reorderWidgetChildDirty
protected
cocos2d::CCDictionary*
_scriptObjectDict
protected
CCSize _size
protected
CCPoint _sizePercent
protected
SizeType _sizeType
protected
bool _touchEnabled
protected

is this widget touch endabled

CCPoint _touchEndPos
protected

touch ended point

CCObject* _touchEventListener
protected
SEL_TouchEvent _touchEventSelector
protected
CCPoint _touchMovePos
protected

touch moved point

bool _touchPassedEnabled
protected

is the touch event should be passed

CCPoint _touchStartPos
protected

touch began point

CCArray* _widgetChildren
protected
WidgetType _widgetType
protected

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