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

#include <UIWidget.h>

Inheritance diagram for Widget:
ProtectedNode Node Ref Button CheckBox ImageView Layout LoadingBar RichText Slider Text TextAtlas TextBMFont 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 WidgetgetChildByName (const char *name)
 Gets a child from the container with its name. More...
 
virtual void visit (cocos2d::Renderer *renderer, const kmMat4 &parentTransform, bool parentTransformUpdated) override
 Visits this node's children and draw them recursively. More...
 
void addTouchEventListener (Ref *target, SEL_TouchEvent selector)
 Sets the touch event target/selector of the menu item. More...
 
virtual void setPosition (const Point &pos) override
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
void setPositionPercent (const Point &percent)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
const PointgetPositionPercent ()
 Gets the percent (x,y) of the widget in OpenGL coordinates. More...
 
void setPositionType (PositionType type)
 Changes the position type of the widget. More...
 
PositionType getPositionType () const
 Gets the position type of the widget. More...
 
virtual void setFlippedX (bool flippedX)
 Sets whether the widget should be flipped horizontally or not. More...
 
virtual bool isFlippedX ()
 Returns the flag which indicates whether the widget is flipped horizontally or not. More...
 
virtual void setFlippedY (bool flippedY)
 Sets whether the widget should be flipped vertically or not. More...
 
virtual bool isFlippedY ()
 Return the flag which indicates whether the widget is flipped vertically or not. More...
 
virtual void setColor (const Color3B &color) override
virtual void setOpacity (GLubyte opacity) override
const Color3BgetColor () const override
GLubyte getOpacity () const override
CC_DEPRECATED_ATTRIBUTE bool isFlipX ()
CC_DEPRECATED_ATTRIBUTE void setFlipX (bool flipX)
CC_DEPRECATED_ATTRIBUTE bool isFlipY ()
CC_DEPRECATED_ATTRIBUTE void setFlipY (bool flipY)
void didNotSelectSelf ()
 A call back function when widget lost of focus. More...
 
bool clippingParentAreaContainPoint (const Point &pt)
virtual void checkChildInfo (int handleState, Widget *sender, const Point &touchPoint)
const PointgetTouchStartPos ()
const PointgetTouchMovePos ()
const PointgetTouchEndPos ()
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 Size &size)
 Changes the size that is widget's size. More...
 
virtual void setSizePercent (const Point &percent)
 Changes the percent that is widget's percent size. More...
 
void setSizeType (SizeType type)
 Changes the size type of widget. More...
 
SizeType getSizeType () const
 Gets the size type of widget. More...
 
const SizegetSize () const
 Returns size of widget. More...
 
const SizegetCustomSize () const
virtual const SizegetLayoutSize ()
const PointgetSizePercent () const
 Returns size percent of widget. More...
 
virtual bool hitTest (const Point &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...
 
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...
 
Point getWorldPosition ()
 Gets world position of widget. More...
 
virtual NodegetVirtualRenderer ()
 Gets the Virtual Renderer of widget. More...
 
virtual const SizegetContentSize () const
 Gets the content size of widget. More...
 
virtual std::string getDescription () const override
 Returns the "class name" of widget. More...
 
Widgetclone ()
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 ()
- 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
local updateDisplayedOpacity ( local parentOpacity)
virtual void updateDisplayedColor (const Color3B &parentColor) override
var updateDisplayedColor ( var parentColor)
local updateDisplayedColor ( local parentColor)
virtual void disableCascadeColor () override
virtual ~ProtectedNode ()
virtual void addProtectedChild (Node *child)
 Adds a child to the container with z-order as 0. More...
 
local addProtectedChild ( local child)
 Adds a child to the container with z-order as 0. More...
 
virtual void addProtectedChild (Node *child, int localZOrder)
 Adds a child to the container with a local z-order. More...
 
local addProtectedChild ( local child, local localZOrder)
 Adds a child to the container with a local z-order. More...
 
virtual void addProtectedChild (Node *child, int localZOrder, int tag)
 Adds a child to the container with z order and tag. More...
 
local addProtectedChild ( local child, local localZOrder, local tag)
 Adds a child to the container with z order and tag. More...
 
virtual NodegetProtectedChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
virtual void removeProtectedChild (Node *child, bool cleanup=true)
 Removes a child from the container. More...
 
var removeProtectedChild ( var child, var 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...
 
virtual void 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...
 
virtual void reorderProtectedChild (Node *child, int localZOrder)
 Reorders a child according to a new z value. More...
 
var reorderProtectedChild ( var child, var localZOrder)
 Reorders a child according to a new z value. More...
 
local reorderProtectedChild ( local child, local localZOrder)
 Reorders a child according to a new z value. More...
 
virtual void sortAllProtectedChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
- Public Member Functions inherited from Node
virtual bool isRunning () const
 Returns whether or not the node is "running". More...
 
void scheduleUpdateWithPriorityLua (int handler, int priority)
 Schedules for lua script. More...
 
local scheduleUpdateWithPriorityLua ( local handler, local priority)
 Schedules for lua script. More...
 
virtual void draw (Renderer *renderer, const kmMat4 &transform, bool transformUpdated)
 Override this method to draw your own node. More...
 
virtual void draw () final
var draw ()
local draw ()
virtual void visit () final
var visit ()
local visit ()
virtual ScenegetScene ()
 Returns the Scene that contains the Node. More...
 
var 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...
 
var getBoundingBox ()
 Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...
 
local getBoundingBox ()
 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)
virtual EventDispatchergetEventDispatcher () const
local getEventDispatcher ()
void setPhysicsBody (PhysicsBody *body)
 set the PhysicsBody that let the sprite effect with physics More...
 
PhysicsBody * getPhysicsBody () const
 get the PhysicsBody the sprite have More...
 
virtual GLubyte getDisplayedOpacity () const
var getDisplayedOpacity ()
local getDisplayedOpacity ()
virtual bool isCascadeOpacityEnabled () const
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual const Color3BgetDisplayedColor () const
local getDisplayedColor ()
virtual bool isCascadeColorEnabled () const
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
virtual void setOpacityModifyRGB (bool bValue)
var setOpacityModifyRGB ( var bValue)
local setOpacityModifyRGB ( local bValue)
virtual bool isOpacityModifyRGB () const
virtual void setLocalZOrder (int 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)
virtual int getLocalZOrder () const
 Gets the local Z order of this node. More...
 
var getLocalZOrder ()
 Gets the local Z order of this node. More...
 
local getLocalZOrder ()
 Gets the local Z order of this node. More...
 
virtual CC_DEPRECATED_ATTRIBUTE int getZOrder () const
var getZOrder ()
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...
 
var setScaleX ( var scaleX)
 Sets the scale (x) of the node. More...
 
local setScaleX ( local scaleX)
 Sets the scale (x) of the node. More...
 
virtual 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...
 
virtual float getScaleY () const
 Returns the scale factor on Y axis of this node. More...
 
var getScaleY ()
 Returns the scale factor on Y axis of this node. More...
 
local getScaleY ()
 Returns the scale factor on Y axis of this node. More...
 
virtual 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...
 
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...
 
local getScale ()
 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 PointgetPosition () 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 Point object. More...
 
local getPosition ( local x, local y)
 Gets position in a more efficient way, returns two number instead of a Point object. More...
 
virtual void setPositionX (float x)
 Gets/Sets x or y coordinate individually for position. More...
 
virtual float getPositionX (void) const
virtual void setPositionY (float y)
local setPositionY ( local y)
virtual float getPositionY (void) const
local getPositionY ()
virtual void setPosition3D (const Vertex3F &position)
 Sets the position (X, Y, and Z) in its parent's coordinate system. More...
 
var setPosition3D ( var 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 Vertex3F getPosition3D () const
 returns the position (X,Y,Z) in its parent's coordinate system More...
 
local getPosition3D ()
 returns the position (X,Y,Z) in its parent's coordinate system More...
 
virtual void setPositionZ (float positionZ)
 Sets the 'z' coordinate in the position. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE void 
setVertexZ (float vertexZ)
local setVertexZ ( local vertexZ)
virtual float getPositionZ () const
 Gets position Z coordinate of this node. More...
 
var getPositionZ ()
 Gets position Z coordinate of this node. More...
 
local getPositionZ ()
 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...
 
var getSkewX ()
 Returns the X skew angle of the node in degrees. More...
 
local getSkewX ()
 Returns the X skew angle of the node in degrees. More...
 
virtual void setSkewY (float skewY)
 Changes the Y skew angle of the node in degrees. More...
 
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...
 
local getSkewY ()
 Returns the Y skew angle of the node in degrees. More...
 
virtual void setAnchorPoint (const Point &anchorPoint)
 Sets the anchor point in percent. More...
 
virtual const PointgetAnchorPoint () const
 Returns the anchor point in percent. More...
 
local getAnchorPoint ()
 Returns the anchor point in percent. More...
 
virtual const PointgetAnchorPointInPoints () const
 Returns the anchorPoint in absolute pixels. More...
 
local getAnchorPointInPoints ()
 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 void setVisible (bool visible)
 Sets whether the node is visible. More...
 
local setVisible ( local visible)
 Sets whether the node is visible. More...
 
virtual bool isVisible () const
 Determines if the node is visible. More...
 
virtual void setRotation (float rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
local setRotation ( local rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
virtual float getRotation () const
 Returns the rotation of the node in degrees. More...
 
virtual void setRotation3D (const Vertex3F &rotation)
 Sets the rotation (X,Y,Z) in degrees. More...
 
virtual Vertex3F 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...
 
var getRotationSkewX ()
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
local getRotationSkewX ()
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
virtual
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...
 
var addChild ( var child, var localZOrder)
 Adds a child to the container with a local z-order. More...
 
local addChild ( local child, local localZOrder)
 Adds a child to the container with a local z-order. More...
 
virtual void addChild (Node *child, int localZOrder, int tag)
 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 NodegetChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
var getChildByTag ( var tag)
 Gets a child from the container with its tag. More...
 
local getChildByTag ( local tag)
 Gets a child from the container with its tag. More...
 
virtual 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...
 
var setParent ( var parent)
 Sets the parent node. More...
 
local setParent ( local parent)
 Sets the parent node. More...
 
virtual NodegetParent ()
 Returns a pointer to the parent node. More...
 
virtual const NodegetParent () const
var getParent ()
virtual void removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
virtual void removeFromParentAndCleanup (bool cleanup)
 Removes this node itself from its parent node. More...
 
local removeFromParent ( local cleanup)
 Removes this node itself from its parent node. More...
 
virtual void removeChild (Node *child, bool cleanup=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...
 
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...
 
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 reorderChild (Node *child, int 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...
 
var sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
local sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
virtual int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
virtual void setTag (int tag)
 Changes the tag that is used to identify the node easily. More...
 
local setTag ( local tag)
 Changes the tag that is used to identify the node easily. More...
 
virtual void * getUserData ()
 Returns a custom user data pointer. More...
 
virtual const void * getUserData () const
virtual void setUserData (void *userData)
 Sets a custom user data pointer. More...
 
virtual RefgetUserObject ()
 Returns a user assigned Object. More...
 
virtual const RefgetUserObject () const
virtual void setUserObject (Ref *userObject)
 Returns a user assigned Object. More...
 
local setUserObject ( local userObject)
 Returns a user assigned Object. More...
 
virtual GLProgramgetShaderProgram ()
 Return the shader program currently used for this node. More...
 
virtual const GLProgramgetShaderProgram () const
local getShaderProgram ()
virtual void setShaderProgram (GLProgram *shaderProgram)
 Sets the shader program for this node. More...
 
local setShaderProgram ( local shaderProgram)
 Sets the shader program for this node. More...
 
virtual void setActionManager (ActionManager *actionManager)
 Sets the ActionManager object that is used by all actions. More...
 
virtual ActionManagergetActionManager ()
 Gets the ActionManager object that is used by all actions. More...
 
virtual const ActionManagergetActionManager () const
ActionrunAction (Action *action)
 Executes an action, and returns the action that is executed. More...
 
var runAction ( var action)
 Executes an action, and returns the action that is executed. More...
 
local runAction ( local action)
 Executes an action, and returns the action that is executed. More...
 
void stopAllActions ()
 Stops and removes all actions from the running action list . 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...
 
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...
 
ActiongetActionByTag (int tag)
 Gets an action from the running action list by its tag. More...
 
ssize_t getNumberOfRunningActions () const
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
CC_DEPRECATED_ATTRIBUTE ssize_t numberOfRunningActions () const
local numberOfRunningActions ()
virtual void setScheduler (Scheduler *scheduler)
 Sets a Scheduler object that is used to schedule all "updates" and timers. More...
 
virtual SchedulergetScheduler ()
 Gets a Sheduler object. More...
 
virtual const SchedulergetScheduler () const
local getScheduler ()
bool isScheduled (SEL_SCHEDULE selector)
 Checks whether a selector is scheduled. More...
 
void scheduleUpdate (void)
 Schedules the "update" method. More...
 
void scheduleUpdateWithPriority (int priority)
 Schedules the "update" method with a custom priority. More...
 
void unscheduleUpdate (void)
var unscheduleUpdate ()
local unscheduleUpdate ()
void schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
 Schedules a custom selector. More...
 
void schedule (SEL_SCHEDULE selector, float interval)
 Schedules a custom selector with an interval time in seconds. More...
 
void scheduleOnce (SEL_SCHEDULE selector, float delay)
 Schedules a selector that runs only once, with a delay of 0 or larger. More...
 
void schedule (SEL_SCHEDULE selector)
 Schedules a custom selector, the scheduled selector will be ticked every frame. More...
 
void unschedule (SEL_SCHEDULE selector)
 Unschedules a custom selector. More...
 
void unscheduleAllSelectors (void)
 Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...
 
var unscheduleAllSelectors ()
 Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...
 
void resume (void)
 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)
var update ( var delta)
local update ( local delta)
virtual void updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
virtual const kmMat4 & getNodeToParentTransform () const
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
local getNodeToParentTransform ()
 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 kmMat4 &transform)
 Sets the Transformation matrix manually. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
nodeToParentTransform () const
local nodeToParentTransform ()
virtual const kmMat4 & 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 kmMat4 getNodeToWorldTransform () const
 Returns the world affine transform matrix. More...
 
virtual AffineTransform getNodeToWorldAffineTransform () const
local getNodeToWorldAffineTransform ()
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
nodeToWorldTransform () const
local nodeToWorldTransform ()
virtual kmMat4 getWorldToNodeTransform () const
 Returns the inverse world affine transform matrix. More...
 
local getWorldToNodeTransform ()
 Returns the inverse world affine transform matrix. More...
 
virtual AffineTransform getWorldToNodeAffineTransform () const
local getWorldToNodeAffineTransform ()
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
worldToNodeTransform () const
local worldToNodeTransform ()
Point convertToNodeSpace (const Point &worldPoint) const
 Converts a Point to node (local) space coordinates. More...
 
Point convertToWorldSpace (const Point &nodePoint) const
 Converts a Point to world space coordinates. More...
 
Point convertToNodeSpaceAR (const Point &worldPoint) const
 Converts a Point to node (local) space coordinates. More...
 
var convertToNodeSpaceAR ( var worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
local convertToNodeSpaceAR ( local worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
Point convertToWorldSpaceAR (const Point &nodePoint) const
 Converts a local Point to world space coordinates.The result is in Points. More...
 
Point convertTouchToNodeSpace (Touch *touch) const
 convenience methods which take a Touch instead of Point More...
 
Point 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 (kmMat4 *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)
ComponentgetComponent (const std::string &pName)
 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 (Component *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 std::string &pName)
 removes a component by its name More...
 
var removeComponent ( var 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...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Release the ownership immediately. More...
 
local release ()
 Release the ownership immediately. More...
 
Refautorelease ()
 Release 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 Widgetcreate ()
 Allocates and initializes a widget. More...
 
- Static Public Member Functions inherited from ProtectedNode
static ProtectedNodecreate (void)
- Static Public Member Functions inherited from Node
static Nodecreate (void)
 Allocates and initializes a node. More...
 
var create ()
 Allocates and initializes a node. More...
 
local create ()
 Allocates and initializes a node. More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: virtual bool init() override
- Public Attributes inherited from ProtectedNode
CC_CONSTRUCTOR_ACCESS __pad0__: ProtectedNode()

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 ()
void updateAnchorPoint ()
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 WidgetcreateCloneInstance ()
virtual void copySpecialProperties (Widget *model)
virtual void copyClonedWidgetChildren (Widget *model)
WidgetgetWidgetParent ()
- 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
 Node ()
 Node ()
 Node ()
virtual ~Node ()
local ~Node ()
virtual bool init ()
local init ()
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...
 
var detachChild ( var child, var index, var doCleanup)
 Removes a child, call child->onExit(), do cleanup, remove it from children array. More...
 
local detachChild ( local child, local index, local doCleanup)
 Removes a child, call child->onExit(), do cleanup, remove it from children array. More...
 
Point convertToWindowSpace (const Point &nodePoint) const
 Convert cocos2d coordinates to UI windows coordinate. More...
 
var convertToWindowSpace ( var nodePoint)
 Convert cocos2d coordinates to UI windows coordinate. More...
 
local convertToWindowSpace ( local nodePoint)
 Convert cocos2d coordinates to UI windows coordinate. More...
 
kmMat4 transform (const kmMat4 &parentTransform)
virtual void updateCascadeOpacity ()
var updateCascadeOpacity ()
local updateCascadeOpacity ()
virtual void disableCascadeOpacity ()
var disableCascadeOpacity ()
local disableCascadeOpacity ()
virtual void updateCascadeColor ()
var updateCascadeColor ()
local updateCascadeColor ()
virtual void updateColor ()
var updateColor ()
local updateColor ()
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 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 _touchPassedEnabled
 is the touch event should be passed More...
 
bool _focus
 is the widget on focus More...
 
BrightStyle _brightStyle
 bright style More...
 
Point _touchStartPos
 touch began point More...
 
Point _touchMovePos
 touch moved point More...
 
Point _touchEndPos
 touch ended point More...
 
Ref_touchEventListener
SEL_TouchEvent _touchEventSelector
std::string _name
WidgetType _widgetType
int _actionTag
Size _size
Size _customSize
bool _ignoreSize
bool _affectByClipping
SizeType _sizeType
Point _sizePercent
PositionType _positionType
Point _positionPercent
bool _reorderWidgetChildDirty
bool _hitted
EventListenerTouchOneByOne_touchListener
Color3B _color
GLubyte _opacity
bool _flippedX
bool _flippedY
Map< int, LayoutParameter * > _layoutParameterDictionary
- 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...
 
Point _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...
 
Point _anchorPointInPoints
 anchor point in points More...
 
var _anchorPointInPoints
 anchor point in points More...
 
local _anchorPointInPoints
 anchor point in points More...
 
Point _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...
 
kmMat4 _modelViewTransform
 ModelView transform of the Node. More...
 
var _modelViewTransform
 ModelView transform of the Node. More...
 
local _modelViewTransform
 ModelView transform of the Node. More...
 
kmMat4 _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...
 
kmMat4 _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...
 
kmMat4 _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...
 
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...
 
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...
 
GLProgram_shaderProgram
 OpenGL shader. More...
 
var _shaderProgram
 OpenGL shader. More...
 
local _shaderProgram
 OpenGL shader. More...
 
int _orderOfArrival
 used to preserve sequence while sorting children with the same localZOrder More...
 
var _orderOfArrival
 used to preserve sequence while sorting children with the same localZOrder More...
 
local _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...
 
var _actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
local _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...
 
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 Point will be (0,0) when you position the Node, false otherwise. More...
 
var _ignoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
 
local _ignoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
 
bool _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...
 
int _scriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
var _scriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
local _scriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
int _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
var _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
local _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
ccScriptType _scriptType
 type of script binding, lua or javascript More...
 
var _scriptType
 type of script binding, lua or javascript More...
 
local _scriptType
 type of script binding, lua or javascript More...
 
ComponentContainer_componentContainer
 Dictionary of components. More...
 
var _componentContainer
 Dictionary of components. More...
 
local _componentContainer
 Dictionary of components. More...
 
PhysicsBody * _physicsBody
 the physicsBody the node have More...
 
GLubyte _displayedOpacity
var _displayedOpacity
local _displayedOpacity
GLubyte _realOpacity
var _realOpacity
local _realOpacity
Color3B _displayedColor
var _displayedColor
local _displayedColor
Color3B _realColor
var _realColor
local _realColor
bool _cascadeColorEnabled
var _cascadeColorEnabled
local _cascadeColorEnabled
bool _cascadeOpacityEnabled
var _cascadeOpacityEnabled
local _cascadeOpacityEnabled
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 

Additional Inherited Members

- Static Public Attributes inherited from Node
static const int INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
var INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
local INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
- Static Protected Attributes inherited from Node
static int s_globalOrderOfArrival
var s_globalOrderOfArrival
local s_globalOrderOfArrival

Constructor & Destructor Documentation

Widget ( void  )
virtual ~Widget ( )
virtual

Default destructor.

Member Function Documentation

void addTouchEventListener ( Ref 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 Point touchPoint 
)
virtual

Reimplemented in ScrollView, and PageView.

bool clippingParentAreaContainPoint ( const Point 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.

const Color3B& getColor ( void  ) const
inlineoverridevirtual

Reimplemented from Node.

virtual const Size& getContentSize ( ) const
virtual

Gets the content size of widget.

Content size is widget's texture size.

Reimplemented from Node.

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

const Size& getCustomSize ( ) const
virtual std::string getDescription ( ) const
overridevirtual

Returns the "class name" of widget.

Reimplemented from Node.

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

LayoutParameter* getLayoutParameter ( LayoutParameterType  type)

Gets LayoutParameter of widget.

See Also
LayoutParameter
Parameters
typeRelative 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 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.
GLubyte getOpacity ( void  ) const
inlineoverridevirtual

Reimplemented from Node.

const Point& 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.
const Size& getSize ( ) const

Returns size of widget.

Returns
size
const Point& 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 Point& getTouchEndPos ( )
const Point& getTouchMovePos ( )
const Point& 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, Button, CheckBox, TextField, LoadingBar, Text, ImageView, TextAtlas, and TextBMFont.

Widget* getWidgetParent ( )
protected
WidgetType getWidgetType ( ) const

Returns a type that is widget's type.

See Also
WidgetType
Returns
A WidgetType
Point getWorldPosition ( )

Gets world position of widget.

Returns
world position of widget.
virtual bool hitTest ( const Point 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, Slider, 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 void initRenderer ( )
protectedvirtual
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
CC_DEPRECATED_ATTRIBUTE bool
isFlipY
( )
inline
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 ( )
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.

virtual void
onPressStateChangedToDisabled
( )
protectedvirtual

Reimplemented in Slider, Button, CheckBox, and Text.

virtual void
onPressStateChangedToNormal
( )
protectedvirtual

Reimplemented in Slider, Button, CheckBox, and Text.

virtual void
onPressStateChangedToPressed
( )
protectedvirtual

Reimplemented in Slider, Button, CheckBox, and Text.

virtual void onSizeChanged ( )
protectedvirtual
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 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 Color3B color)
overridevirtual

Reimplemented from Node.

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 setFlippedX ( bool  flippedX)
virtual

Sets whether the widget should be flipped horizontally or not.

Parameters
bFlippedXtrue 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
bFlippedYtrue if the widget should be flipped vertically, flase otherwise.
CC_DEPRECATED_ATTRIBUTE void
setFlipX
( bool  flipX)
inline
CC_DEPRECATED_ATTRIBUTE void
setFlipY
( bool  flipY)
inline
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)
overridevirtual

Reimplemented from Node.

virtual void setPosition ( const Point pos)
overridevirtual

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

void setPositionPercent ( const Point 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 setSize ( const Size size)
virtual

Changes the size that is widget's size.

Parameters
sizethat is widget's size
virtual void setSizePercent ( const Point 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.
void updateAnchorPoint ( )
protected
void updateColorToRenderer ( Node renderer)
protected
virtual void updateFlippedX ( )
inlineprotectedvirtual

Reimplemented in Button, CheckBox, Text, and ImageView.

virtual void updateFlippedY ( )
inlineprotectedvirtual

Reimplemented in Button, CheckBox, Text, and ImageView.

void updateOpacityToRenderer ( Node renderer)
protected
void updateRGBAToRenderer ( Node renderer)
protected
void updateSizeAndPosition ( )
void updateSizeAndPosition ( const Size parentSize)
virtual void updateTextureColor ( )
inlineprotectedvirtual
virtual void updateTextureOpacity ( )
inlineprotectedvirtual
virtual void updateTextureRGBA ( )
inlineprotectedvirtual
virtual void visit ( cocos2d::Renderer renderer,
const kmMat4 &  parentTransform,
bool  parentTransformUpdated 
)
overridevirtual

Visits this node's children and draw them recursively.

Reimplemented from ProtectedNode.

Reimplemented in Layout, and RichText.

Member Data Documentation

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 _focus
protected

is the widget on focus

bool _hitted
protected
bool _ignoreSize
protected
Map<int, LayoutParameter*>
_layoutParameterDictionary
protected
std::string _name
protected
GLubyte _opacity
protected
Point _positionPercent
protected
PositionType _positionType
protected
bool _reorderWidgetChildDirty
protected
Size _size
protected
Point _sizePercent
protected
SizeType _sizeType
protected
bool _touchEnabled
protected

is this widget touch endabled

Point _touchEndPos
protected

touch ended point

Ref* _touchEventListener
protected
SEL_TouchEvent _touchEventSelector
protected
EventListenerTouchOneByOne*
_touchListener
protected
Point _touchMovePos
protected

touch moved point

bool _touchPassedEnabled
protected

is the touch event should be passed

Point _touchStartPos
protected

touch began point

WidgetType _widgetType
protected

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