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

#include <UIButton.h>

Inheritance diagram for Button:
Widget CCNodeRGBA CCNode CCRGBAProtocol CCObject CCCopying

Public Member Functions

 Button ()
virtual ~Button ()
 Default destructor. More...
 
void loadTextures (const char *normal, const char *selected, const char *disabled, TextureResType texType=UI_TEX_TYPE_LOCAL)
 Load textures for button. More...
 
void loadTextureNormal (const char *normal, TextureResType texType=UI_TEX_TYPE_LOCAL)
 Load normal state texture for button. More...
 
void loadTexturePressed (const char *selected, TextureResType texType=UI_TEX_TYPE_LOCAL)
 Load selected state texture for button. More...
 
void loadTextureDisabled (const char *disabled, TextureResType texType=UI_TEX_TYPE_LOCAL)
 Load dark state texture for button. More...
 
void setCapInsets (const CCRect &capInsets)
 Sets capinsets for button, if button is using scale9 renderer. More...
 
void setCapInsetsNormalRenderer (const CCRect &capInsets)
 Sets capinsets for button, if button is using scale9 renderer. More...
 
void setCapInsetsPressedRenderer (const CCRect &capInsets)
 Sets capinsets for button, if button is using scale9 renderer. More...
 
void setCapInsetsDisabledRenderer (const CCRect &capInsets)
 Sets capinsets for button, if button is using scale9 renderer. More...
 
virtual void setAnchorPoint (const CCPoint &pt)
 Sets the anchor point in percent. More...
 
virtual void setScale9Enabled (bool able)
 Sets if button is using scale9 renderer. More...
 
virtual void setFlipX (bool flipX)
 Sets whether the widget should be flipped horizontally or not. More...
 
virtual void setFlipY (bool flipY)
 Sets whether the widget should be flipped vertically or not. More...
 
virtual bool isFlipX ()
 Returns the flag which indicates whether the widget is flipped horizontally or not. More...
 
virtual bool isFlipY ()
 Return the flag which indicates whether the widget is flipped vertically or not. More...
 
void setPressedActionEnabled (bool enabled)
 Changes if button can be clicked zoom effect. More...
 
virtual void ignoreContentAdaptWithSize (bool ignore)
 Ignore the widget size. More...
 
virtual const CCSizegetContentSize () const
 Gets the content size of widget. More...
 
virtual CCNodegetVirtualRenderer ()
 Gets the Virtual Renderer of widget. More...
 
virtual void setColor (const ccColor3B &color)
 Sets color to widget. More...
 
virtual std::string getDescription () const
 Returns the "class name" of widget. More...
 
void setTitleText (const std::string &text)
const char * getTitleText () const
void setTitleColor (const ccColor3B &color)
const ccColor3BgetTitleColor () const
void setTitleFontSize (float size)
float getTitleFontSize () const
void setTitleFontName (const char *fontName)
const char * getTitleFontName () const
- Public Member Functions inherited from Widget
 Widget (void)
virtual ~Widget ()
 Default destructor. More...
 
virtual void setEnabled (bool enabled)
 Sets whether the widget is enabled. More...
 
bool isEnabled () const
 Determines if the widget is enabled. More...
 
void setBright (bool bright)
 Sets whether the widget is bright. More...
 
bool isBright () const
 Determines if the widget is bright. More...
 
virtual void setTouchEnabled (bool enabled)
 Sets whether the widget is touch enabled. More...
 
void setBrightStyle (BrightStyle style)
 To set the bright style of widget. More...
 
bool isTouchEnabled () const
 Determines if the widget is touch enabled. More...
 
bool 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, 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...
 
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...
 
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...
 
const CCPointgetSizePercent () const
 Returns size percent of widget. More...
 
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)
virtual void onTouchLongClicked (const CCPoint &touchPoint)
 A call back function called when widget is selected, and on touch long clicked. More...
 
void setLayoutParameter (LayoutParameter *parameter)
 Sets a LayoutParameter to widget. More...
 
LayoutParametergetLayoutParameter (LayoutParameterType type)
 Gets LayoutParameter of widget. More...
 
bool isIgnoreContentAdaptWithSize () const
 Gets the widget if is ignore it's size. More...
 
CCPoint getWorldPosition ()
 Gets world position of widget. More...
 
void setUpdateEnabled (bool enable)
 Schedules the "update" method. More...
 
bool isUpdateEnabled ()
 is the "update" method scheduled. 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 setActionTag (int tag)
int getActionTag ()
- Public Member Functions inherited from CCNodeRGBA
 CCNodeRGBA ()
virtual ~CCNodeRGBA ()
virtual GLubyte getOpacity ()
 Returns the opacity. More...
 
virtual GLubyte getDisplayedOpacity ()
 Returns the displayed opacity. More...
 
virtual void setOpacity (GLubyte opacity)
 Changes the 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 ccColor3BgetColor (void)
 Returns color that is currently used. More...
 
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...
 
local getCamera ()
 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...
 
var isRunning ()
 Returns whether or not the node accepts event callbacks. More...
 
local 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...
 
local draw ()
 Override this method to draw your own node. More...
 
CCRect boundingBox (void)
 Returns a "local" axis aligned bounding box of the node. More...
 
var getBoundingBox ()
 Returns a "local" axis aligned bounding box of the node. More...
 
local boundingBox ()
 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...
 
var getZOrder ()
 Gets the Z order of this node. More...
 
local getZOrder ()
 Gets the Z order of this node. More...
 
virtual void setVertexZ (float vertexZ)
 Sets the real OpenGL Z vertex. More...
 
var setVertexZ ( var 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...
 
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...
 
local setScaleY ( local 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...
 
local 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...
 
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...
 
virtual float getPositionX (void)
virtual void setPositionY (float y)
virtual float getPositionY (void)
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...
 
virtual void setSkewY (float fSkewY)
 Changes the Y skew angle of the node in degrees. More...
 
local setSkewY ( local 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...
 
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...
 
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...
 
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...
 
virtual void setOrderOfArrival (unsigned int 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...
 
var setParent ( var parent)
 Sets the parent node. More...
 
local setParent ( local parent)
 Sets the parent node. More...
 
virtual CCNodegetParent ()
 Returns a pointer to the parent node. More...
 
virtual void removeChild (CCNode *child)
 Removes a child from the container with a cleanup. More...
 
virtual void removeChildByTag (int tag)
 Removes a child from the container by tag value with a cleanup. More...
 
local removeChildByTag ( local 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...
 
local setGrid ( local 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...
 
var setTag ( var 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...
 
local setShaderProgram ( local 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...
 
local unregisterScriptHandler ()
 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...
 
local runAction ( local 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...
 
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)
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...
 
var scheduleOnce ( var selector, var 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...
 
var unschedule ( var selector)
 Unschedules a custom selector. More...
 
void unscheduleAllSelectors (void)
 Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...
 
local unscheduleAllSelectors ()
 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)
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...
 
local transformAncestors ()
 Performs OpenGL view-matrix transformation of it's ancestors. More...
 
virtual void updateTransform (void)
 Calls children's updateTransform() method recursively. More...
 
local updateTransform ()
 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...
 
CCPoint convertToNodeSpace (const CCPoint &worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
var convertToNodeSpace ( var worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
local convertToNodeSpace ( local 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...
 
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...
 
CCPoint convertToWorldSpaceAR (const CCPoint &nodePoint)
 Converts a local Point to world space coordinates.The result is in Points. More...
 
var convertToWorldSpaceAR ( var nodePoint)
 Converts a local Point to world space coordinates.The result is in Points. More...
 
local convertToWorldSpaceAR ( local 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...
 
CCPoint convertTouchToNodeSpaceAR (CCTouch *touch)
 converts a CCTouch (world coordinates) into a local coordinate. More...
 
var convertTouchToNodeSpaceAR ( var touch)
 converts a CCTouch (world coordinates) into a local coordinate. More...
 
local convertTouchToNodeSpaceAR ( local touch)
 converts a CCTouch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (const CCAffineTransform &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...
 
virtual bool addComponent (CCComponent *pComponent)
 adds a component More...
 
virtual bool removeComponent (const char *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...
 
 CCNode (void)
 Default constructor. More...
 
 ctor ()
 Default constructor. More...
 
 CCNode ()
 Default constructor. More...
 
virtual ~CCNode (void)
 Default destructor. More...
 
const char * description (void)
 Gets the description string. More...
 
local description ()
 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 Buttoncreate ()
 Allocates and initializes. More...
 
- Static Public Member Functions inherited from Widget
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...
 

Protected Member Functions

virtual bool init ()
 Initializes the instance of CCNode. More...
 
virtual void initRenderer ()
virtual void onPressStateChangedToNormal ()
virtual void onPressStateChangedToPressed ()
virtual void onPressStateChangedToDisabled ()
virtual void onSizeChanged ()
void normalTextureScaleChangedWithSize ()
void pressedTextureScaleChangedWithSize ()
void disabledTextureScaleChangedWithSize ()
virtual WidgetcreateCloneInstance ()
virtual void copySpecialProperties (Widget *model)
- Protected Member Functions inherited from Widget
void pushDownEvent ()
void moveEvent ()
void releaseUpEvent ()
void cancelUpEvent ()
void longClickEvent ()
void updateAnchorPoint ()
void copyProperties (Widget *model)
virtual void copyClonedWidgetChildren (Widget *model)
WidgetgetWidgetParent ()

Protected Attributes

CCNode_buttonNormalRenderer
CCNode_buttonClickedRenderer
CCNode_buttonDisableRenderer
CCLabelTTF_titleRenderer
std::string _normalFileName
std::string _clickedFileName
std::string _disabledFileName
bool _prevIgnoreSize
bool _scale9Enabled
CCRect _capInsetsNormal
CCRect _capInsetsPressed
CCRect _capInsetsDisabled
TextureResType _normalTexType
TextureResType _pressedTexType
TextureResType _disabledTexType
CCSize _normalTextureSize
CCSize _pressedTextureSize
CCSize _disabledTextureSize
bool _pressedActionEnabled
ccColor3B _titleColor
float _normalTextureScaleXInSize
float _normalTextureScaleYInSize
float _pressedTextureScaleXInSize
float _pressedTextureScaleYInSize
bool _normalTextureLoaded
bool _pressedTextureLoaded
bool _disabledTextureLoaded
- Protected Attributes inherited from Widget
bool _enabled
 Highest control of widget. More...
 
bool _bright
 is this widget bright More...
 
bool _touchEnabled
 is this widget touch endabled More...
 
bool _touchPassedEnabled
 is the touch event should be passed More...
 
bool _focus
 is the widget on focus More...
 
BrightStyle _brightStyle
 bright style More...
 
bool _updateEnabled
 is "update" method scheduled 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
- 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...
 
var m_obContentSize
 untransformed size of the node More...
 
local m_obContentSize
 untransformed size of the node More...
 
CCAffineTransform 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...
 
var m_nTag
 a tag. Can be any number you assigned just to identify this node More...
 
local 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...
 
var m_uOrderOfArrival
 used to preserve sequence while sorting children with the same zOrder More...
 
local 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...
 
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...
 
var m_bAdditionalTransformDirty
 The flag to check whether the additional transform is dirty. More...
 
local 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...
 
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...
 
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...
 
- Protected Attributes inherited from CCObject
unsigned int m_uReference
unsigned int m_uAutoReleaseCount

Additional Inherited Members

- Public Attributes inherited from CCObject
unsigned int m_uID
int m_nLuaID

Constructor & Destructor Documentation

Button ( )
virtual ~Button ( )
virtual

Default destructor.

Member Function Documentation

virtual void copySpecialProperties ( Widget model)
protectedvirtual

Reimplemented from Widget.

static Button* create ( )
static

Allocates and initializes.

virtual Widget* createCloneInstance ( )
protectedvirtual

Reimplemented from Widget.

void
disabledTextureScaleChangedWithSize
( )
protected
virtual const CCSize&
getContentSize
( ) const
virtual

Gets the content size of widget.

Content size is widget's texture size.

Reimplemented from Widget.

virtual std::string getDescription ( ) const
virtual

Returns the "class name" of widget.

Reimplemented from Widget.

const ccColor3B& getTitleColor ( ) const
const char* getTitleFontName ( ) const
float getTitleFontSize ( ) const
const char* getTitleText ( ) const
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 from Widget.

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

virtual bool init ( )
protectedvirtual

Initializes the instance of CCNode.

Returns
Whether the initialization was successful.

Reimplemented from Widget.

virtual void initRenderer ( )
protectedvirtual

Reimplemented from Widget.

virtual bool isFlipX ( )
virtual

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.

Reimplemented from Widget.

virtual bool isFlipY ( )
virtual

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.

Reimplemented from Widget.

void loadTextureDisabled ( const char *  disabled,
TextureResType  texType = UI_TEX_TYPE_LOCAL 
)

Load dark state texture for button.

Parameters
disableddark state texture.
texType@seeUI_TEX_TYPE_LOCAL
void loadTextureNormal ( const char *  normal,
TextureResType  texType = UI_TEX_TYPE_LOCAL 
)

Load normal state texture for button.

Parameters
normalnormal state texture.
texType@seeUI_TEX_TYPE_LOCAL
void loadTexturePressed ( const char *  selected,
TextureResType  texType = UI_TEX_TYPE_LOCAL 
)

Load selected state texture for button.

Parameters
selectedselected state texture.
texType@seeUI_TEX_TYPE_LOCAL
void loadTextures ( const char *  normal,
const char *  selected,
const char *  disabled,
TextureResType  texType = UI_TEX_TYPE_LOCAL 
)

Load textures for button.

Parameters
normalnormal state texture.
selectedselected state texture.
disableddark state texture.
texType@seeUI_TEX_TYPE_LOCAL
void
normalTextureScaleChangedWithSize
( )
protected
virtual void
onPressStateChangedToDisabled
( )
protectedvirtual

Reimplemented from Widget.

virtual void
onPressStateChangedToNormal
( )
protectedvirtual

Reimplemented from Widget.

virtual void
onPressStateChangedToPressed
( )
protectedvirtual

Reimplemented from Widget.

virtual void onSizeChanged ( )
protectedvirtual

Reimplemented from Widget.

void
pressedTextureScaleChangedWithSize
( )
protected
virtual void setAnchorPoint ( const CCPoint anchorPoint)
virtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the node where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the node.

Parameters
anchorPointThe anchor point of node.

Reimplemented from CCNode.

void setCapInsets ( const CCRect capInsets)

Sets capinsets for button, if button is using scale9 renderer.

Parameters
capInsetscapinsets for button
void setCapInsetsDisabledRenderer ( const CCRect capInsets)

Sets capinsets for button, if button is using scale9 renderer.

Parameters
capInsetscapinsets for button
void setCapInsetsNormalRenderer ( const CCRect capInsets)

Sets capinsets for button, if button is using scale9 renderer.

Parameters
capInsetscapinsets for button
void setCapInsetsPressedRenderer ( const CCRect capInsets)

Sets capinsets for button, if button is using scale9 renderer.

Parameters
capInsetscapinsets for button
virtual void setColor ( const ccColor3B color)
virtual

Sets color to widget.

It default change the color of widget's children.

Parameters
color

Reimplemented from CCNodeRGBA.

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.

Reimplemented from Widget.

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.

Reimplemented from Widget.

void setPressedActionEnabled ( bool  enabled)

Changes if button can be clicked zoom effect.

Parameters
truethat can be clicked zoom effect, false otherwise.
virtual void setScale9Enabled ( bool  able)
virtual

Sets if button is using scale9 renderer.

Parameters
truethat using scale9 renderer, false otherwise.
void setTitleColor ( const ccColor3B color)
void setTitleFontName ( const char *  fontName)
void setTitleFontSize ( float  size)
void setTitleText ( const std::string &  text)

Member Data Documentation

CCNode* _buttonClickedRenderer
protected
CCNode* _buttonDisableRenderer
protected
CCNode* _buttonNormalRenderer
protected
CCRect _capInsetsDisabled
protected
CCRect _capInsetsNormal
protected
CCRect _capInsetsPressed
protected
std::string _clickedFileName
protected
std::string _disabledFileName
protected
bool _disabledTextureLoaded
protected
CCSize _disabledTextureSize
protected
TextureResType _disabledTexType
protected
std::string _normalFileName
protected
bool _normalTextureLoaded
protected
float _normalTextureScaleXInSize
protected
float _normalTextureScaleYInSize
protected
CCSize _normalTextureSize
protected
TextureResType _normalTexType
protected
bool _pressedActionEnabled
protected
bool _pressedTextureLoaded
protected
float _pressedTextureScaleXInSize
protected
float _pressedTextureScaleYInSize
protected
CCSize _pressedTextureSize
protected
TextureResType _pressedTexType
protected
bool _prevIgnoreSize
protected
bool _scale9Enabled
protected
ccColor3B _titleColor
protected
CCLabelTTF* _titleRenderer
protected

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