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

\ More...

#include <CCEditBox.h>

Inheritance diagram for CCEditBox:
CCControlButton CCIMEDelegate CCControl CCLayerRGBA CCLayer CCRGBAProtocol CCNode CCTouchDelegate CCAccelerometerDelegate CCKeypadDelegate CCObject CCCopying

Public Member Functions

 CCEditBox (void)
 Constructor. More...
 
virtual ~CCEditBox (void)
 Destructor. More...
 
bool initWithSizeAndBackgroundSprite (const CCSize &size, CCScale9Sprite *pNormal9SpriteBg)
 Init edit box with specified size. More...
 
void setDelegate (CCEditBoxDelegate *pDelegate)
 Gets/Sets the delegate for edit box. More...
 
CCEditBoxDelegategetDelegate ()
void registerScriptEditBoxHandler (int handler)
 Registers a script function that will be called for EditBox events. More...
 
void unregisterScriptEditBoxHandler (void)
 Unregisters a script function that will be called for EditBox events. More...
 
int getScriptEditBoxHandler (void)
 get a script Handler More...
 
void setText (const char *pText)
 Set the text entered in the edit box. More...
 
const char * getText (void)
 Get the text entered in the edit box. More...
 
void setFont (const char *pFontName, int fontSize)
 Set the font. More...
 
void setFontName (const char *pFontName)
 Set the font name. More...
 
void setFontSize (int fontSize)
 Set the font size. More...
 
void setFontColor (const ccColor3B &color)
 Set the font color of the widget's text. More...
 
void setPlaceholderFont (const char *pFontName, int fontSize)
 Set the placeholder's font. More...
 
void setPlaceholderFontName (const char *pFontName)
 Set the placeholder's font name. More...
 
void setPlaceholderFontSize (int fontSize)
 Set the placeholder's font size. More...
 
void setPlaceholderFontColor (const ccColor3B &color)
 Set the font color of the placeholder text when the edit box is empty. More...
 
void setPlaceHolder (const char *pText)
 Set a text in the edit box that acts as a placeholder when an edit box is empty. More...
 
const char * getPlaceHolder (void)
 Get a text in the edit box that acts as a placeholder when an edit box is empty. More...
 
void setInputMode (EditBoxInputMode inputMode)
 Set the input mode of the edit box. More...
 
void setMaxLength (int maxLength)
 Sets the maximum input length of the edit box. More...
 
int getMaxLength ()
 Gets the maximum input length of the edit box. More...
 
void setInputFlag (EditBoxInputFlag inputFlag)
 Set the input flags that are to be applied to the edit box. More...
 
void setReturnType (KeyboardReturnType returnType)
 Set the return type that are to be applied to the edit box. More...
 
virtual void setPosition (const CCPoint &pos)
 Changes the position (x,y) of the node in OpenGL coordinates. More...
 
virtual void setVisible (bool visible)
 Sets whether the node is visible. More...
 
virtual void setContentSize (const CCSize &size)
 Sets the untransformed size of the node. More...
 
virtual void setAnchorPoint (const CCPoint &anchorPoint)
 Sets the anchor point in percent. More...
 
virtual void visit (void)
 Visits this node's children and draw them recursively. More...
 
virtual void onEnter (void)
 Event callback that is invoked every time when CCNode enters the 'stage'. More...
 
virtual void onExit (void)
 Event callback that is invoked every time the CCNode leaves the 'stage'. More...
 
virtual void keyboardWillShow (CCIMEKeyboardNotificationInfo &info)
virtual void keyboardDidShow (CCIMEKeyboardNotificationInfo &info)
virtual void keyboardWillHide (CCIMEKeyboardNotificationInfo &info)
virtual void keyboardDidHide (CCIMEKeyboardNotificationInfo &info)
void touchDownAction (CCObject *sender, CCControlEvent controlEvent)
 callback funtions More...
 
- Public Member Functions inherited from CCControlButton
 CCControlButton ()
 CCControlButton ()
 CCControlButton ()
virtual ~CCControlButton ()
virtual void needsLayout (void)
 Updates the control layout using its current internal state. More...
 
virtual void setEnabled (bool enabled)
 Tells whether the control is enabled. More...
 
local setEnabled ( local enabled)
 Tells whether the control is enabled. More...
 
virtual void setSelected (bool enabled)
 A Boolean value that determines the control selected state. More...
 
local setSelected ( local enabled)
 A Boolean value that determines the control selected state. More...
 
virtual void setHighlighted (bool enabled)
 A Boolean value that determines whether the control is highlighted. More...
 
local setHighlighted ( local enabled)
 A Boolean value that determines whether the control is highlighted. More...
 
virtual CCStringgetCurrentTitle (void)
 getCurrentTitle More...
 
local getCurrentTitle ()
 getCurrentTitle More...
 
virtual const ccColor3BgetCurrentTitleColor (void)
 getCurrentTitleColor More...
 
local getCurrentTitleColor ()
 getCurrentTitleColor More...
 
bool doesAdjustBackgroundImage ()
 Adjust the background image. More...
 
var doesAdjustBackgroundImage ()
 Adjust the background image. More...
 
local doesAdjustBackgroundImage ()
 Adjust the background image. More...
 
void setAdjustBackgroundImage (bool adjustBackgroundImage)
virtual CCNodegetTitleLabel (void)
 getTitleLabel More...
 
virtual void setTitleLabel (CCNode *var)
 setTitleLabel More...
 
var setTitleLabel ( var var)
 setTitleLabel More...
 
local setTitleLabel ( local var)
 setTitleLabel More...
 
virtual CCScale9SpritegetBackgroundSprite (void)
 getBackgroundSprite More...
 
local getBackgroundSprite ()
 getBackgroundSprite More...
 
virtual void setBackgroundSprite (CCScale9Sprite *var)
 setBackgroundSprite More...
 
local setBackgroundSprite ( local var)
 setBackgroundSprite More...
 
virtual CCSize getPreferredSize (void)
 getPreferredSize More...
 
virtual void setPreferredSize (CCSize var)
 setPreferredSize More...
 
virtual bool getZoomOnTouchDown (void)
 getZoomOnTouchDown More...
 
virtual void setZoomOnTouchDown (bool var)
 setZoomOnTouchDown More...
 
virtual CCPoint getLabelAnchorPoint (void)
 getLabelAnchorPoint More...
 
virtual void setLabelAnchorPoint (CCPoint var)
 setLabelAnchorPoint More...
 
local setLabelAnchorPoint ( local var)
 setLabelAnchorPoint More...
 
virtual GLubyte getOpacity (void)
 Returns the opacity. More...
 
local getOpacity ()
 Returns the opacity. More...
 
virtual void setOpacity (GLubyte var)
 Changes the opacity. More...
 
local setOpacity ( local var)
 Changes the opacity. More...
 
virtual const ccColor3BgetColor (void)
 Returns color that is currently used. More...
 
var getColor ()
 Returns color that is currently used. More...
 
local getColor ()
 Returns color that is currently used. More...
 
virtual void setColor (const ccColor3B &)
 @ More...
 
local setColor ()
 @ More...
 
bool isPushed ()
virtual CCDictionarygetTitleDispatchTable (void)
 getTitleDispatchTable More...
 
virtual void setTitleDispatchTable (CCDictionary *var)
 setTitleDispatchTable More...
 
local setTitleDispatchTable ( local var)
 setTitleDispatchTable More...
 
virtual CCDictionarygetTitleColorDispatchTable (void)
 getTitleColorDispatchTable More...
 
local getTitleColorDispatchTable ()
 getTitleColorDispatchTable More...
 
virtual void setTitleColorDispatchTable (CCDictionary *var)
 setTitleColorDispatchTable More...
 
virtual CCDictionarygetTitleLabelDispatchTable (void)
 getTitleLabelDispatchTable More...
 
virtual void setTitleLabelDispatchTable (CCDictionary *var)
 setTitleLabelDispatchTable More...
 
virtual CCDictionarygetBackgroundSpriteDispatchTable (void)
 getBackgroundSpriteDispatchTable More...
 
var getBackgroundSpriteDispatchTable ()
 getBackgroundSpriteDispatchTable More...
 
local getBackgroundSpriteDispatchTable ()
 getBackgroundSpriteDispatchTable More...
 
virtual void setBackgroundSpriteDispatchTable (CCDictionary *var)
 setBackgroundSpriteDispatchTable More...
 
virtual int getVerticalMargin (void)
 getVerticalMargin More...
 
virtual int getHorizontalOrigin (void)
 getHorizontalOrigin More...
 
virtual void setMargins (int marginH, int marginV)
local setMargins ( local marginH, local marginV)
virtual bool init ()
 Initializes the instance of CCNode. More...
 
virtual bool initWithLabelAndBackgroundSprite (CCNode *label, CCScale9Sprite *backgroundSprite)
var initWithLabelAndBackgroundSprite ( var label, var backgroundSprite)
virtual bool initWithTitleAndFontNameAndFontSize (std::string title, const char *fontName, float fontSize)
local initWithTitleAndFontNameAndFontSize ( local title, local fontName, local fontSize)
virtual bool initWithBackgroundSprite (CCScale9Sprite *sprite)
virtual bool ccTouchBegan (CCTouch *pTouch, CCEvent *pEvent)
virtual void ccTouchMoved (CCTouch *pTouch, CCEvent *pEvent)
var ccTouchMoved ( var pTouch, var pEvent)
local ccTouchMoved ( local pTouch, local pEvent)
virtual void ccTouchEnded (CCTouch *pTouch, CCEvent *pEvent)
virtual void ccTouchCancelled (CCTouch *pTouch, CCEvent *pEvent)
local ccTouchCancelled ( local pTouch, local pEvent)
virtual CCStringgetTitleForState (CCControlState state)
 Returns the title used for a state. More...
 
virtual void setTitleForState (CCString *title, CCControlState state)
 Sets the title string to use for the specified state. More...
 
local setTitleForState ( local title, local state)
 Sets the title string to use for the specified state. More...
 
virtual const ccColor3B getTitleColorForState (CCControlState state)
 Returns the title color used for a state. More...
 
local getTitleColorForState ( local state)
 Returns the title color used for a state. More...
 
virtual void setTitleColorForState (ccColor3B color, CCControlState state)
 Sets the color of the title to use for the specified state. More...
 
virtual CCNodegetTitleLabelForState (CCControlState state)
 Returns the title label used for a state. More...
 
virtual void setTitleLabelForState (CCNode *label, CCControlState state)
 Sets the title label to use for the specified state. More...
 
virtual void setTitleTTFForState (const char *fntFile, CCControlState state)
var setTitleTTFForState ( var fntFile, var state)
local setTitleTTFForState ( local fntFile, local state)
virtual const char * getTitleTTFForState (CCControlState state)
local getTitleTTFForState ( local state)
virtual void setTitleTTFSizeForState (float size, CCControlState state)
virtual float getTitleTTFSizeForState (CCControlState state)
virtual void setTitleBMFontForState (const char *fntFile, CCControlState state)
 Sets the font of the label, changes the label to a CCLabelBMFont if neccessary. More...
 
local setTitleBMFontForState ( local fntFile, local state)
 Sets the font of the label, changes the label to a CCLabelBMFont if neccessary. More...
 
virtual const char * getTitleBMFontForState (CCControlState state)
virtual CCScale9SpritegetBackgroundSpriteForState (CCControlState state)
 Returns the background sprite used for a state. More...
 
local getBackgroundSpriteForState ( local state)
 Returns the background sprite used for a state. More...
 
virtual void setBackgroundSpriteForState (CCScale9Sprite *sprite, CCControlState state)
 Sets the background sprite to use for the specified button state. More...
 
local setBackgroundSpriteForState ( local sprite, local state)
 Sets the background sprite to use for the specified button state. More...
 
virtual void setBackgroundSpriteFrameForState (CCSpriteFrame *spriteFrame, CCControlState state)
 Sets the background spriteFrame to use for the specified button state. More...
 
local setBackgroundSpriteFrameForState ( local spriteFrame, local state)
 Sets the background spriteFrame to use for the specified button state. More...
 
- Public Member Functions inherited from CCControl
virtual CCControlState getState (void)
 getState More...
 
virtual bool isEnabled ()
virtual bool isSelected ()
virtual bool isHighlighted ()
bool hasVisibleParents ()
var hasVisibleParents ()
local hasVisibleParents ()
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...
 
var isOpacityModifyRGB ()
 Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity) More...
 
local isOpacityModifyRGB ()
 Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity) More...
 
virtual void setOpacityModifyRGB (bool bOpacityModifyRGB)
 Changes the OpacityModifyRGB property. More...
 
local setOpacityModifyRGB ( local bOpacityModifyRGB)
 Changes the OpacityModifyRGB property. More...
 
 CCControl ()
virtual ~CCControl ()
virtual void registerWithTouchDispatcher ()
 If isTouchEnabled, this method is called onEnter. More...
 
local registerWithTouchDispatcher ()
 If isTouchEnabled, this method is called onEnter. More...
 
virtual void sendActionsForControlEvents (CCControlEvent controlEvents)
 Sends action messages for the given control events. More...
 
virtual void addTargetWithActionForControlEvents (CCObject *target, SEL_CCControlHandler action, CCControlEvent controlEvents)
 Adds a target and action for a particular event (or events) to an internal dispatch table. More...
 
virtual void removeTargetWithActionForControlEvents (CCObject *target, SEL_CCControlHandler action, CCControlEvent controlEvents)
 Removes a target and action for a particular event (or events) from an internal dispatch table. More...
 
virtual CCPoint getTouchLocation (CCTouch *touch)
 Returns a point corresponding to the touh location converted into the control space coordinates. More...
 
virtual bool isTouchInside (CCTouch *touch)
 Returns a boolean value that indicates whether a touch is inside the bounds of the receiver. More...
 
void addHandleOfControlEvent (int nFunID, CCControlEvent controlEvent)
local addHandleOfControlEvent ( local nFunID, local controlEvent)
void removeHandleOfControlEvent (CCControlEvent controlEvent)
- Public Member Functions inherited from CCLayerRGBA
 CREATE_FUNC (CCLayerRGBA)
 CCLayerRGBA ()
virtual ~CCLayerRGBA ()
virtual GLubyte getDisplayedOpacity ()
 Returns the displayed opacity. More...
 
virtual void updateDisplayedOpacity (GLubyte parentOpacity)
 recursive method that updates the displayed opacity. More...
 
virtual bool isCascadeOpacityEnabled ()
 whether or not opacity should be propagated to its children. More...
 
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual const ccColor3BgetDisplayedColor ()
 Returns the displayed color. More...
 
virtual void updateDisplayedColor (const ccColor3B &parentColor)
 recursive method that updates display color More...
 
virtual bool isCascadeColorEnabled ()
 whether or not color should be propagated to its children. More...
 
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
- Public Member Functions inherited from CCLayer
 CCLayer ()
virtual ~CCLayer ()
virtual void onEnterTransitionDidFinish ()
 Event callback that is invoked when the CCNode enters in the 'stage'. More...
 
virtual void ccTouchesBegan (CCSet *pTouches, CCEvent *pEvent)
virtual void ccTouchesMoved (CCSet *pTouches, CCEvent *pEvent)
virtual void ccTouchesEnded (CCSet *pTouches, CCEvent *pEvent)
virtual void ccTouchesCancelled (CCSet *pTouches, CCEvent *pEvent)
var ccTouchesCancelled ( var pTouches, var pEvent)
local ccTouchesCancelled ( local pTouches, local pEvent)
virtual void didAccelerate (CCAcceleration *pAccelerationValue)
void registerScriptAccelerateHandler (int nHandler)
void unregisterScriptAccelerateHandler (void)
virtual void registerScriptTouchHandler (int nHandler, bool bIsMultiTouches=false, int nPriority=INT_MIN, bool bSwallowsTouches=false)
 Register script touch events handler. More...
 
local registerScriptTouchHandler ( local nHandler, local false, local INT_MIN, local false)
 Register script touch events handler. More...
 
virtual void unregisterScriptTouchHandler (void)
 Unregister script touch events handler. More...
 
virtual bool isTouchEnabled ()
 whether or not it will receive Touch events. More...
 
virtual void setTouchEnabled (bool value)
var setTouchEnabled ( var value)
local setTouchEnabled ( local value)
virtual void setTouchMode (ccTouchesMode mode)
local setTouchMode ( local mode)
virtual int getTouchMode ()
virtual void setTouchPriority (int priority)
 priority of the touch events. More...
 
local setTouchPriority ( local priority)
 priority of the touch events. More...
 
virtual int getTouchPriority ()
virtual bool isAccelerometerEnabled ()
 whether or not it will receive Accelerometer events You can enable / disable accelerometer events with this property. More...
 
var isAccelerometerEnabled ()
 whether or not it will receive Accelerometer events You can enable / disable accelerometer events with this property. More...
 
local isAccelerometerEnabled ()
 whether or not it will receive Accelerometer events You can enable / disable accelerometer events with this property. More...
 
virtual void setAccelerometerEnabled (bool value)
var setAccelerometerEnabled ( var value)
local setAccelerometerEnabled ( local value)
virtual void setAccelerometerInterval (double interval)
local setAccelerometerInterval ( local interval)
virtual bool isKeypadEnabled ()
 whether or not it will receive keypad events You can enable / disable accelerometer events with this property. More...
 
virtual void setKeypadEnabled (bool value)
local setKeypadEnabled ( local value)
void registerScriptKeypadHandler (int nHandler)
 Register keypad events handler. More...
 
void unregisterScriptKeypadHandler (void)
 Unregister keypad events handler. More...
 
virtual void keyBackClicked (void)
virtual void keyMenuClicked (void)
local keyMenuClicked ()
CCTouchScriptHandlerEntrygetScriptTouchHandlerEntry ()
local getScriptTouchHandlerEntry ()
CCScriptHandlerEntrygetScriptKeypadHandlerEntry ()
CCScriptHandlerEntrygetScriptAccelerateHandlerEntry ()
- Public Member Functions inherited from CCNode
virtual CCCameragetCamera ()
 Returns a camera object that lets you move the node using a gluLookAt. More...
 
virtual bool isRunning ()
 Returns whether or not the node accepts event callbacks. More...
 
virtual void cleanup (void)
 Stops all running actions and schedulers. More...
 
virtual void draw (void)
 Override this method to draw your own node. More...
 
virtual CCRect boundingBox (void)
 Returns a "local" axis aligned bounding box of the node. More...
 
virtual void setZOrder (int zOrder)
 Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...
 
virtual void _setZOrder (int z)
 Sets the z order which stands for the drawing order. More...
 
var _setZOrder ( var z)
 Sets the z order which stands for the drawing order. More...
 
local _setZOrder ( local z)
 Sets the z order which stands for the drawing order. More...
 
virtual int getZOrder ()
 Gets the Z order of this node. More...
 
virtual void setVertexZ (float vertexZ)
 Sets the real OpenGL Z vertex. More...
 
local setVertexZ ( local vertexZ)
 Sets the real OpenGL Z vertex. More...
 
virtual float getVertexZ ()
 Gets OpenGL Z vertex of this node. More...
 
var getVertexZ ()
 Gets OpenGL Z vertex of this node. More...
 
local getVertexZ ()
 Gets OpenGL Z vertex of this node. More...
 
virtual void setScaleX (float fScaleX)
 Changes the scale factor on X axis of this node. More...
 
local setScaleX ( local fScaleX)
 Changes the scale factor on X axis of this node. More...
 
virtual float getScaleX ()
 Returns the scale factor on X axis of this node. More...
 
var getScaleX ()
 Returns the scale factor on X axis of this node. More...
 
local getScaleX ()
 Returns the scale factor on X axis of this node. More...
 
virtual void setScaleY (float fScaleY)
 Changes the scale factor on Y axis of this node. More...
 
virtual float getScaleY ()
 Returns the scale factor on Y axis of this node. More...
 
virtual void setScale (float scale)
 Changes both X and Y scale factor of the node. More...
 
virtual float getScale ()
 Gets the scale factor of the node, when X and Y have the same scale factor. More...
 
virtual void setScale (float fScaleX, float fScaleY)
 Changes both X and Y scale factor of the node. More...
 
local setScale ( local fScaleX, local fScaleY)
 Changes both X and Y scale factor of the node. More...
 
virtual const CCPointgetPosition ()
 Gets the position (x,y) of the node in OpenGL coordinates. More...
 
local getPosition ()
 Gets the position (x,y) of the node in OpenGL coordinates. More...
 
virtual void setPosition (float x, float y)
 Sets position in a more efficient way. More...
 
local setPosition ( local x, local y)
 Sets position in a more efficient way. More...
 
virtual void getPosition (float *x, float *y)
 Gets position in a more efficient way, returns two number instead of a CCPoint object. More...
 
local getPosition ( local x, local y)
 Gets position in a more efficient way, returns two number instead of a CCPoint object. More...
 
virtual void setPositionX (float x)
 Gets/Sets x or y coordinate individually for position. More...
 
var setPositionX ( var x)
 Gets/Sets x or y coordinate individually for position. More...
 
local setPositionX ( local x)
 Gets/Sets x or y coordinate individually for position. More...
 
virtual float getPositionX (void)
virtual void setPositionY (float y)
var setPositionY ( var y)
local setPositionY ( local y)
virtual float getPositionY (void)
var getPositionY ()
local getPositionY ()
virtual void setSkewX (float fSkewX)
 Changes the X skew angle of the node in degrees. More...
 
local setSkewX ( local fSkewX)
 Changes the X skew angle of the node in degrees. More...
 
virtual float getSkewX ()
 Returns the X skew angle of the node in degrees. More...
 
local getSkewX ()
 Returns the X skew angle of the node in degrees. More...
 
virtual void setSkewY (float fSkewY)
 Changes the Y skew angle of the node in degrees. More...
 
virtual float getSkewY ()
 Returns the Y skew angle of the node in degrees. More...
 
var getSkewY ()
 Returns the Y skew angle of the node in degrees. More...
 
local getSkewY ()
 Returns the Y skew angle of the node in degrees. More...
 
virtual const CCPointgetAnchorPoint ()
 Returns the anchor point in percent. More...
 
local getAnchorPoint ()
 Returns the anchor point in percent. More...
 
virtual const CCPointgetAnchorPointInPoints ()
 Returns the anchorPoint in absolute pixels. More...
 
local getAnchorPointInPoints ()
 Returns the anchorPoint in absolute pixels. More...
 
virtual const CCSizegetContentSize () const
 Returns the untransformed size of the node. More...
 
virtual bool isVisible ()
 Determines if the node is visible. More...
 
virtual void setRotation (float fRotation)
 Sets the rotation (angle) of the node in degrees. More...
 
local setRotation ( local fRotation)
 Sets the rotation (angle) of the node in degrees. More...
 
virtual float getRotation ()
 Returns the rotation of the node in degrees. More...
 
virtual void setRotationX (float fRotaionX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
local setRotationX ( local fRotaionX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual float getRotationX ()
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
local getRotationX ()
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
virtual void setRotationY (float fRotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local setRotationY ( local fRotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual float getRotationY ()
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
var getRotationY ()
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local getRotationY ()
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual void setOrderOfArrival (unsigned int uOrderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
var setOrderOfArrival ( var uOrderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
local setOrderOfArrival ( local uOrderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
virtual unsigned int getOrderOfArrival ()
 Returns the arrival order, indecates which children is added previously. More...
 
virtual void setGLServerState (ccGLServerState glServerState)
 Sets the state of OpenGL server side. More...
 
local setGLServerState ( local glServerState)
 Sets the state of OpenGL server side. More...
 
virtual ccGLServerState getGLServerState ()
 Returns the state of OpenGL server side. More...
 
local getGLServerState ()
 Returns the state of OpenGL server side. More...
 
virtual void ignoreAnchorPointForPosition (bool ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
local ignoreAnchorPointForPosition ( local ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
virtual bool isIgnoreAnchorPointForPosition ()
 Gets whether the anchor point will be (0,0) when you position this node. More...
 
virtual void addChild (CCNode *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 (CCNode *child, int zOrder)
 Adds a child to the container with a z-order. More...
 
local addChild ( local child, local zOrder)
 Adds a child to the container with a z-order. More...
 
virtual void addChild (CCNode *child, int zOrder, int tag)
 Adds a child to the container with z order and tag. More...
 
var addChild ( var child, var zOrder, var tag)
 Adds a child to the container with z order and tag. More...
 
local addChild ( local child, local zOrder, local tag)
 Adds a child to the container with z order and tag. More...
 
virtual CCNodegetChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
virtual CCArraygetChildren ()
 Return an array of children. More...
 
local getChildren ()
 Return an array of children. More...
 
virtual unsigned int getChildrenCount (void) const
 Get the amount of children. More...
 
var getChildrenCount ()
 Get the amount of children. More...
 
local getChildrenCount ()
 Get the amount of children. More...
 
virtual void setParent (CCNode *parent)
 Sets the parent node. More...
 
virtual CCNodegetParent ()
 Returns a pointer to the parent node. More...
 
var getParent ()
 Returns a pointer to the parent node. More...
 
local getParent ()
 Returns a pointer to the parent node. More...
 
virtual void 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 removeFromParentAndCleanup ( local cleanup)
 Removes this node itself from its parent node. More...
 
virtual void removeChild (CCNode *child)
 Removes a child from the container with a cleanup. More...
 
virtual void removeChild (CCNode *child, bool cleanup)
 Removes a child from the container. More...
 
virtual void removeChildByTag (int tag)
 Removes a child from the container by tag value with a cleanup. More...
 
virtual void removeChildByTag (int tag, bool cleanup)
 Removes a child from the container by tag value. More...
 
local removeChildByTag ( local tag, local cleanup)
 Removes a child from the container by tag value. More...
 
virtual void removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
var removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
local removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
virtual void removeAllChildrenWithCleanup (bool cleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
var removeAllChildren ( var cleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
local removeAllChildrenWithCleanup ( 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 (CCNode *child, int zOrder)
 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 CCGridBasegetGrid ()
 Returns a grid object that is used when applying effects. More...
 
virtual void setGrid (CCGridBase *pGrid)
 Changes a grid object that is used when applying effects. More...
 
virtual int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
var getTag ()
 Returns a tag that is used to identify the node easily. More...
 
local getTag ()
 Returns a tag that is used to identify the node easily. More...
 
virtual void setTag (int nTag)
 Changes the tag that is used to identify the node easily. More...
 
local setTag ( local nTag)
 Changes the tag that is used to identify the node easily. More...
 
virtual void * getUserData ()
 Returns a custom user data pointer. More...
 
virtual void setUserData (void *pUserData)
 Sets a custom user data pointer. More...
 
local setUserData ( local pUserData)
 Sets a custom user data pointer. More...
 
virtual CCObjectgetUserObject ()
 Returns a user assigned CCObject. More...
 
local getUserObject ()
 Returns a user assigned CCObject. More...
 
virtual void setUserObject (CCObject *pUserObject)
 Returns a user assigned CCObject. More...
 
local setUserObject ( local pUserObject)
 Returns a user assigned CCObject. More...
 
virtual CCGLProgramgetShaderProgram ()
 Return the shader program currently used for this node. More...
 
virtual void setShaderProgram (CCGLProgram *pShaderProgram)
 Sets the shader program for this node. More...
 
virtual void registerScriptHandler (int handler)
 Registers a script function that will be called in onEnter() & onExit() seires functions. More...
 
local registerScriptHandler ( local handler)
 Registers a script function that will be called in onEnter() & onExit() seires functions. More...
 
virtual void unregisterScriptHandler (void)
 Unregisters a script function that will be called in onEnter() & onExit() series functions. More...
 
int getScriptHandler ()
 Gets script handler for onEnter/onExit event. More...
 
void scheduleUpdateWithPriorityLua (int nHandler, int priority)
 Schedules for lua script. More...
 
local scheduleUpdateWithPriorityLua ( local nHandler, local priority)
 Schedules for lua script. More...
 
virtual void onExitTransitionDidStart ()
 Event callback that is called every time the CCNode leaves the 'stage'. More...
 
virtual void setActionManager (CCActionManager *actionManager)
 Sets the CCActionManager object that is used by all actions. More...
 
virtual CCActionManagergetActionManager ()
 Gets the CCActionManager object that is used by all actions. More...
 
local getActionManager ()
 Gets the CCActionManager object that is used by all actions. More...
 
CCActionrunAction (CCAction *action)
 Executes an action, and returns the action that is executed. More...
 
void stopAllActions (void)
 Stops and removes all actions from the running action list . More...
 
var stopAllActions ()
 Stops and removes all actions from the running action list . More...
 
local stopAllActions ()
 Stops and removes all actions from the running action list . More...
 
void stopAction (CCAction *action)
 Stops and removes an action from the running action list. More...
 
var stopAction ( var action)
 Stops and removes an action from the running action list. More...
 
local stopAction ( local action)
 Stops and removes an action from the running action list. More...
 
void stopActionByTag (int tag)
 Removes an action from the running action list by its tag. More...
 
var stopActionByTag ( var tag)
 Removes an action from the running action list by its tag. More...
 
local stopActionByTag ( local tag)
 Removes an action from the running action list by its tag. More...
 
CCActiongetActionByTag (int tag)
 Gets an action from the running action list by its tag. More...
 
unsigned int numberOfRunningActions (void)
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
local numberOfRunningActions ()
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
virtual void setScheduler (CCScheduler *scheduler)
 Sets a CCScheduler object that is used to schedule all "updates" and timers. More...
 
virtual CCSchedulergetScheduler ()
 Gets a CCSheduler object. More...
 
local getScheduler ()
 Gets a CCSheduler object. More...
 
bool isScheduled (SEL_SCHEDULE selector)
 Checks whether a selector is scheduled. More...
 
void scheduleUpdate (void)
 Schedules the "update" method. More...
 
void scheduleUpdateWithPriority (int priority)
 Schedules the "update" method with a custom priority. More...
 
var scheduleUpdateWithPriority ( var priority)
 Schedules the "update" method with a custom priority. More...
 
void unscheduleUpdate (void)
var unscheduleUpdate ()
local unscheduleUpdate ()
void schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
 Schedules a custom selector. More...
 
void schedule (SEL_SCHEDULE selector, float interval)
 Schedules a custom selector with an interval time in seconds. More...
 
var schedule ( var selector, var interval)
 Schedules a custom selector with an interval time in seconds. More...
 
void scheduleOnce (SEL_SCHEDULE selector, float delay)
 Schedules a selector that runs only once, with a delay of 0 or larger. More...
 
void schedule (SEL_SCHEDULE selector)
 Schedules a custom selector, the scheduled selector will be ticked every frame. More...
 
void unschedule (SEL_SCHEDULE selector)
 Unschedules a custom selector. More...
 
void unscheduleAllSelectors (void)
 Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...
 
void resumeSchedulerAndActions (void)
 Resumes all scheduled selectors and actions. More...
 
void pauseSchedulerAndActions (void)
 Pauses all scheduled selectors and actions. More...
 
virtual void update (float delta)
var update ( var delta)
local update ( local delta)
void transform (void)
 Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes. More...
 
void transformAncestors (void)
 Performs OpenGL view-matrix transformation of it's ancestors. More...
 
virtual void updateTransform (void)
 Calls children's updateTransform() method recursively. More...
 
virtual CCAffineTransform nodeToParentTransform (void)
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
local nodeToParentTransform ()
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual CCAffineTransform parentToNodeTransform (void)
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
local parentToNodeTransform ()
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
virtual CCAffineTransform nodeToWorldTransform (void)
 Returns the world affine transform matrix. More...
 
local nodeToWorldTransform ()
 Returns the world affine transform matrix. More...
 
virtual CCAffineTransform worldToNodeTransform (void)
 Returns the inverse world affine transform matrix. More...
 
local worldToNodeTransform ()
 Returns the inverse world affine transform matrix. More...
 
CCPoint convertToNodeSpace (const CCPoint &worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
CCPoint convertToWorldSpace (const CCPoint &nodePoint)
 Converts a Point to world space coordinates. More...
 
var convertToWorldSpace ( var nodePoint)
 Converts a Point to world space coordinates. More...
 
local convertToWorldSpace ( local nodePoint)
 Converts a Point to world space coordinates. More...
 
CCPoint convertToNodeSpaceAR (const CCPoint &worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
CCPoint convertToWorldSpaceAR (const CCPoint &nodePoint)
 Converts a local Point to world space coordinates.The result is in Points. More...
 
CCPoint convertTouchToNodeSpace (CCTouch *touch)
 convenience methods which take a CCTouch instead of CCPoint More...
 
var convertTouchToNodeSpace ( var touch)
 convenience methods which take a CCTouch instead of CCPoint More...
 
local convertTouchToNodeSpace ( local touch)
 convenience methods which take a CCTouch instead of CCPoint More...
 
CCPoint convertTouchToNodeSpaceAR (CCTouch *touch)
 converts a CCTouch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (const CCAffineTransform &additionalTransform)
 Sets the additional transform. More...
 
var setAdditionalTransform ( var additionalTransform)
 Sets the additional transform. More...
 
local setAdditionalTransform ( local additionalTransform)
 Sets the additional transform. More...
 
CCComponentgetComponent (const char *pName) const
 gets a component by its name More...
 
var getComponent ( var pName)
 gets a component by its name More...
 
local getComponent ( local pName)
 gets a component by its name More...
 
virtual bool addComponent (CCComponent *pComponent)
 adds a component More...
 
var addComponent ( var pComponent)
 adds a component More...
 
local addComponent ( local pComponent)
 adds a component More...
 
virtual bool removeComponent (const char *pName)
 removes a component by its name More...
 
virtual bool removeComponent (CCComponent *pComponent)
 removes a component by its pointer More...
 
var removeComponent ( var pComponent)
 removes a component by its pointer More...
 
local removeComponent ( local pComponent)
 removes a component by its pointer More...
 
virtual void removeAllComponents ()
 removes all components More...
 
 CCNode (void)
 Default constructor. More...
 
virtual ~CCNode (void)
 Default destructor. More...
 
const char * description (void)
 Gets the description string. More...
 
- Public Member Functions inherited from CCObject
 CCObject (void)
virtual ~CCObject (void)
void release (void)
void retain (void)
CCObjectautorelease (void)
CCObjectcopy (void)
bool isSingleReference (void) const
unsigned int retainCount (void) const
virtual bool isEqual (const CCObject *pObject)
virtual void acceptVisitor (CCDataVisitor &visitor)
- Public Member Functions inherited from CCCopying
virtual CCObjectcopyWithZone (CCZone *pZone)
- Public Member Functions inherited from CCTouchDelegate
 CCTouchDelegate ()
virtual ~CCTouchDelegate ()
- Public Member Functions inherited from CCIMEDelegate
virtual ~CCIMEDelegate ()
virtual bool attachWithIME ()
virtual bool detachWithIME ()

Static Public Member Functions

static CCEditBoxcreate (const CCSize &size, CCScale9Sprite *pNormal9SpriteBg, CCScale9Sprite *pPressed9SpriteBg=NULL, CCScale9Sprite *pDisabled9SpriteBg=NULL)
 create a edit box with size. More...
 
- Static Public Member Functions inherited from CCControlButton
static CCControlButtoncreate (CCNode *label, CCScale9Sprite *backgroundSprite)
var create ( var label, var backgroundSprite)
local create ( local label, local backgroundSprite)
static CCControlButtoncreate (std::string title, const char *fontName, float fontSize)
local create ( local title, local fontName, local fontSize)
static CCControlButtoncreate (CCScale9Sprite *sprite)
local create ( local sprite)
static CCControlButtoncreate ()
local create ()
- Static Public Member Functions inherited from CCLayer
static CCLayercreate (void)
 create one layer More...
 
local create ()
 create one layer More...
 
- Static Public Member Functions inherited from CCNode
static CCNodecreate (void)
 Allocates and initializes a node. More...
 
local create ()
 Allocates and initializes a node. More...
 

Protected Attributes

CCEditBoxImplm_pEditBoxImpl
CCEditBoxDelegatem_pDelegate
EditBoxInputMode m_eEditBoxInputMode
EditBoxInputFlag m_eEditBoxInputFlag
KeyboardReturnType m_eKeyboardReturnType
std::string m_strText
std::string m_strPlaceHolder
std::string m_strFontName
std::string m_strPlaceholderFontName
int m_nFontSize
int m_nPlaceholderFontSize
ccColor3B m_colText
ccColor3B m_colPlaceHolder
int m_nMaxLength
float m_fAdjustHeight
int m_nScriptEditBoxHandler
- Protected Attributes inherited from CCControlButton
CCStringm_currentTitle
 The current title that is displayed on the button. More...
 
var m_currentTitle
 The current title that is displayed on the button. More...
 
local m_currentTitle
 The current title that is displayed on the button. More...
 
ccColor3B m_currentTitleColor
 The current color used to display the title. More...
 
var m_currentTitleColor
 The current color used to display the title. More...
 
local m_currentTitleColor
 The current color used to display the title. More...
 
CCNodem_titleLabel
 The current title label. More...
 
var m_titleLabel
 The current title label. More...
 
local m_titleLabel
 The current title label. More...
 
CCScale9Spritem_backgroundSprite
 The current background sprite. More...
 
var m_backgroundSprite
 The current background sprite. More...
 
local m_backgroundSprite
 The current background sprite. More...
 
CCSize m_preferredSize
 The prefered size of the button, if label is larger it will be expanded. More...
 
bool m_zoomOnTouchDown
 Adjust the button zooming on touchdown. More...
 
var m_zoomOnTouchDown
 Adjust the button zooming on touchdown. More...
 
local m_zoomOnTouchDown
 Adjust the button zooming on touchdown. More...
 
CCPoint m_labelAnchorPoint
bool m_isPushed
 Flag to know if the button is currently pushed. More...
 
var m_isPushed
 Flag to know if the button is currently pushed. More...
 
local m_isPushed
 Flag to know if the button is currently pushed. More...
 
bool m_bParentInited
CCDictionarym_titleDispatchTable
var m_titleDispatchTable
local m_titleDispatchTable
CCDictionarym_titleColorDispatchTable
CCDictionarym_titleLabelDispatchTable
local m_titleLabelDispatchTable
CCDictionarym_backgroundSpriteDispatchTable
var m_backgroundSpriteDispatchTable
local m_backgroundSpriteDispatchTable
int m_marginV
int m_marginH
- Protected Attributes inherited from CCControl
CCControlState m_eState
 The current control state constant. More...
 
var m_eState
 The current control state constant. More...
 
local m_eState
 The current control state constant. More...
 
bool m_hasVisibleParents
 True if all of the controls parents are visible. More...
 
bool m_bEnabled
bool m_bSelected
bool m_bHighlighted
CCDictionarym_pDispatchTable
 Table of connection between the CCControlEvents and their associated target-actions pairs. More...
 
- Protected Attributes inherited from CCLayerRGBA
GLubyte _displayedOpacity
GLubyte _realOpacity
ccColor3B _displayedColor
ccColor3B _realColor
bool _cascadeOpacityEnabled
bool _cascadeColorEnabled
- Protected Attributes inherited from CCLayer
bool m_bTouchEnabled
bool m_bAccelerometerEnabled
var m_bAccelerometerEnabled
local m_bAccelerometerEnabled
bool m_bKeypadEnabled
- Protected Attributes inherited from CCNode
float m_fRotationX
 rotation angle on x-axis More...
 
float m_fRotationY
 rotation angle on y-axis More...
 
var m_fRotationY
 rotation angle on y-axis More...
 
local m_fRotationY
 rotation angle on y-axis More...
 
float m_fScaleX
 scaling factor on x-axis More...
 
var m_fScaleX
 scaling factor on x-axis More...
 
local m_fScaleX
 scaling factor on x-axis More...
 
float m_fScaleY
 scaling factor on y-axis More...
 
var m_fScaleY
 scaling factor on y-axis More...
 
local m_fScaleY
 scaling factor on y-axis More...
 
float m_fVertexZ
 OpenGL real Z vertex. More...
 
var m_fVertexZ
 OpenGL real Z vertex. More...
 
local m_fVertexZ
 OpenGL real Z vertex. More...
 
CCPoint m_obPosition
 position of the node More...
 
var m_obPosition
 position of the node More...
 
local m_obPosition
 position of the node More...
 
float m_fSkewX
 skew angle on x-axis More...
 
var m_fSkewX
 skew angle on x-axis More...
 
local m_fSkewX
 skew angle on x-axis More...
 
float m_fSkewY
 skew angle on y-axis More...
 
var m_fSkewY
 skew angle on y-axis More...
 
local m_fSkewY
 skew angle on y-axis More...
 
CCPoint m_obAnchorPointInPoints
 anchor point in points More...
 
var m_obAnchorPointInPoints
 anchor point in points More...
 
local m_obAnchorPointInPoints
 anchor point in points More...
 
CCPoint m_obAnchorPoint
 anchor point normalized (NOT in points) More...
 
var m_obAnchorPoint
 anchor point normalized (NOT in points) More...
 
local m_obAnchorPoint
 anchor point normalized (NOT in points) More...
 
CCSize m_obContentSize
 untransformed size of the node More...
 
CCAffineTransform m_sAdditionalTransform
 transform More...
 
var m_sAdditionalTransform
 transform More...
 
local m_sAdditionalTransform
 transform More...
 
CCAffineTransform m_sTransform
 transform More...
 
var m_sTransform
 transform More...
 
local m_sTransform
 transform More...
 
CCAffineTransform m_sInverse
 transform More...
 
var m_sInverse
 transform More...
 
local m_sInverse
 transform More...
 
CCCameram_pCamera
 a camera More...
 
var m_pCamera
 a camera More...
 
local m_pCamera
 a camera More...
 
CCGridBasem_pGrid
 a grid More...
 
var m_pGrid
 a grid More...
 
local m_pGrid
 a grid More...
 
int m_nZOrder
 z-order value that affects the draw order More...
 
var m_nZOrder
 z-order value that affects the draw order More...
 
local m_nZOrder
 z-order value that affects the draw order More...
 
CCArraym_pChildren
 array of children nodes More...
 
var m_pChildren
 array of children nodes More...
 
local m_pChildren
 array of children nodes More...
 
CCNodem_pParent
 weak reference to parent node More...
 
var m_pParent
 weak reference to parent node More...
 
local m_pParent
 weak reference to parent node More...
 
int m_nTag
 a tag. Can be any number you assigned just to identify this node More...
 
void * m_pUserData
 A user assingned void pointer, Can be point to any cpp object. More...
 
var m_pUserData
 A user assingned void pointer, Can be point to any cpp object. More...
 
local m_pUserData
 A user assingned void pointer, Can be point to any cpp object. More...
 
CCObjectm_pUserObject
 A user assigned CCObject. More...
 
var m_pUserObject
 A user assigned CCObject. More...
 
local m_pUserObject
 A user assigned CCObject. More...
 
CCGLProgramm_pShaderProgram
 OpenGL shader. More...
 
var m_pShaderProgram
 OpenGL shader. More...
 
local m_pShaderProgram
 OpenGL shader. More...
 
ccGLServerState m_eGLServerState
 OpenGL servier side state. More...
 
var m_eGLServerState
 OpenGL servier side state. More...
 
local m_eGLServerState
 OpenGL servier side state. More...
 
unsigned int m_uOrderOfArrival
 used to preserve sequence while sorting children with the same zOrder More...
 
CCSchedulerm_pScheduler
 scheduler used to schedule timers and updates More...
 
var m_pScheduler
 scheduler used to schedule timers and updates More...
 
local m_pScheduler
 scheduler used to schedule timers and updates More...
 
CCActionManagerm_pActionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
var m_pActionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
local m_pActionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
bool m_bRunning
 is running More...
 
var m_bRunning
 is running More...
 
local m_bRunning
 is running More...
 
bool m_bTransformDirty
 transform dirty flag More...
 
var m_bTransformDirty
 transform dirty flag More...
 
local m_bTransformDirty
 transform dirty flag More...
 
bool m_bInverseDirty
 transform dirty flag More...
 
var m_bInverseDirty
 transform dirty flag More...
 
local m_bInverseDirty
 transform dirty flag More...
 
bool m_bAdditionalTransformDirty
 The flag to check whether the additional transform is dirty. More...
 
bool m_bVisible
 is this node visible More...
 
var m_bVisible
 is this node visible More...
 
local m_bVisible
 is this node visible More...
 
bool m_bIgnoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise. More...
 
var m_bIgnoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise. More...
 
local m_bIgnoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise. More...
 
bool m_bReorderChildDirty
 children order dirty flag More...
 
var m_bReorderChildDirty
 children order dirty flag More...
 
local m_bReorderChildDirty
 children order dirty flag More...
 
int m_nScriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
var m_nScriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
local m_nScriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
int m_nUpdateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
var m_nUpdateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
local m_nUpdateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
ccScriptType m_eScriptType
 type of script binding, lua or javascript More...
 
var m_eScriptType
 type of script binding, lua or javascript More...
 
local m_eScriptType
 type of script binding, lua or javascript More...
 
CCComponentContainerm_pComponentContainer
 Dictionary of components. More...
 
var m_pComponentContainer
 Dictionary of components. More...
 
local m_pComponentContainer
 Dictionary of components. More...
 
- Protected Attributes inherited from CCObject
unsigned int m_uReference
unsigned int m_uAutoReleaseCount

Additional Inherited Members

- Public Attributes inherited from CCControlButton
bool m_doesAdjustBackgroundImage
- Public Attributes inherited from CCObject
unsigned int m_uID
int m_nLuaID
- Protected Member Functions inherited from CCControl
CCInvocationinvocationWithTargetAndActionForControlEvent (CCObject *target, SEL_CCControlHandler action, CCControlEvent controlEvent)
 Returns an CCInvocation object able to construct messages using a given target-action pair. More...
 
var invocationWithTargetAndActionForControlEvent ( var target, var action, var controlEvent)
 Returns an CCInvocation object able to construct messages using a given target-action pair. More...
 
local invocationWithTargetAndActionForControlEvent ( local target, local action, local controlEvent)
 Returns an CCInvocation object able to construct messages using a given target-action pair. More...
 
CCArraydispatchListforControlEvent (CCControlEvent controlEvent)
 Returns the CCInvocation list for the given control event. More...
 
void addTargetWithActionForControlEvent (CCObject *target, SEL_CCControlHandler action, CCControlEvent controlEvent)
 Adds a target and action for a particular event to an internal dispatch table. More...
 
void removeTargetWithActionForControlEvent (CCObject *target, SEL_CCControlHandler action, CCControlEvent controlEvent)
 Removes a target and action for a particular event from an internal dispatch table. More...
 
- Protected Member Functions inherited from CCIMEDelegate
virtual bool canAttachWithIME ()
 Decide if the delegate instance is ready to receive an IME message. More...
 
virtual void didAttachWithIME ()
 When the delegate detaches from the IME, this method is called by CCIMEDispatcher. More...
 
virtual bool canDetachWithIME ()
 Decide if the delegate instance can stop receiving IME messages. More...
 
virtual void didDetachWithIME ()
 When the delegate detaches from the IME, this method is called by CCIMEDispatcher. More...
 
virtual void insertText (const char *text, int len)
 Called by CCIMEDispatcher when text input received from the IME. More...
 
virtual void deleteBackward ()
 Called by CCIMEDispatcher after the user clicks the backward key. More...
 
virtual const char * getContentText ()
 Called by CCIMEDispatcher for text stored in delegate. More...
 
 CCIMEDelegate ()
- Static Protected Member Functions inherited from CCControl
static CCControlcreate ()

Detailed Description

\

Constructor & Destructor Documentation

CCEditBox ( void  )

Constructor.

virtual ~CCEditBox ( void  )
virtual

Destructor.

Member Function Documentation

static CCEditBox* create ( const CCSize size,
CCScale9Sprite pNormal9SpriteBg,
CCScale9Sprite pPressed9SpriteBg = NULL,
CCScale9Sprite pDisabled9SpriteBg = NULL 
)
static

create a edit box with size.

Returns
An autorelease pointer of CCEditBox, you don't need to release it only if you retain it again.
CCEditBoxDelegate* getDelegate ( )
int getMaxLength ( )

Gets the maximum input length of the edit box.

Returns
Maximum input length.
const char* getPlaceHolder ( void  )

Get a text in the edit box that acts as a placeholder when an edit box is empty.

int getScriptEditBoxHandler ( void  )
inline

get a script Handler

const char* getText ( void  )

Get the text entered in the edit box.

Returns
The text entered in the edit box.
bool
initWithSizeAndBackgroundSprite
( const CCSize size,
CCScale9Sprite pNormal9SpriteBg 
)

Init edit box with specified size.

This method should be invoked right after constructor.

Parameters
sizeThe size of edit box.
virtual void keyboardDidHide ( CCIMEKeyboardNotificationInfo info)
virtual

Reimplemented from CCIMEDelegate.

virtual void keyboardDidShow ( CCIMEKeyboardNotificationInfo info)
virtual

Reimplemented from CCIMEDelegate.

virtual void keyboardWillHide ( CCIMEKeyboardNotificationInfo info)
virtual

Reimplemented from CCIMEDelegate.

virtual void keyboardWillShow ( CCIMEKeyboardNotificationInfo info)
virtual

Reimplemented from CCIMEDelegate.

virtual void onEnter ( void  )
virtual

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

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

Reimplemented from CCControl.

virtual void onExit ( void  )
virtual

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

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

Reimplemented from CCControl.

void registerScriptEditBoxHandler ( int  handler)

Registers a script function that will be called for EditBox events.

This handler will be removed automatically after onExit() called.

-- lua sample
local function editboxEventHandler(eventType)
if eventType == "began" then
-- triggered when an edit box gains focus after keyboard is shown
elseif eventType == "ended" then
-- triggered when an edit box loses focus after keyboard is hidden.
elseif eventType == "changed" then
-- triggered when the edit box text was changed.
elseif eventType == "return" then
-- triggered when the return button was pressed or the outside area of keyboard was touched.
end
end
local editbox = CCEditBox:create(CCSize(...), CCScale9Sprite:create(...))
editbox = registerScriptEditBoxHandler(editboxEventHandler)
Parameters
handlerA number that indicates a lua function.
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.

virtual void setContentSize ( const CCSize contentSize)
virtual

Sets the untransformed size of the node.

The contentSize remains the same no matter the node is scaled or rotated. All nodes has a size. Layer and Scene has the same size of the screen.

Parameters
contentSizeThe untransformed size of the node.

Reimplemented from CCNode.

void setDelegate ( CCEditBoxDelegate pDelegate)

Gets/Sets the delegate for edit box.

void setFont ( const char *  pFontName,
int  fontSize 
)

Set the font.

Parameters
pFontNameThe font name.
fontSizeThe font size.
void setFontColor ( const ccColor3B color)

Set the font color of the widget's text.

void setFontName ( const char *  pFontName)

Set the font name.

Parameters
pFontNameThe font name.
void setFontSize ( int  fontSize)

Set the font size.

Parameters
fontSizeThe font size.
void setInputFlag ( EditBoxInputFlag  inputFlag)

Set the input flags that are to be applied to the edit box.

Parameters
inputFlagOne of the EditBoxInputFlag constants.
void setInputMode ( EditBoxInputMode  inputMode)

Set the input mode of the edit box.

Parameters
inputModeOne of the EditBoxInputMode constants.
void setMaxLength ( int  maxLength)

Sets the maximum input length of the edit box.

Setting this value enables multiline input mode by default. Available on Android, iOS and Windows Phone.

Parameters
maxLengthThe maximum length.
void setPlaceHolder ( const char *  pText)

Set a text in the edit box that acts as a placeholder when an edit box is empty.

Parameters
pTextThe given text.
void setPlaceholderFont ( const char *  pFontName,
int  fontSize 
)

Set the placeholder's font.

Parameters
pFontNameThe font name.
fontSizeThe font size.
void setPlaceholderFontColor ( const ccColor3B color)

Set the font color of the placeholder text when the edit box is empty.

Not supported on IOS.

void setPlaceholderFontName ( const char *  pFontName)

Set the placeholder's font name.

Parameters
pFontNameThe font name.
void setPlaceholderFontSize ( int  fontSize)

Set the placeholder's font size.

Parameters
fontSizeThe font size.
virtual void setPosition ( const CCPoint position)
virtual

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

Usually we use ccp(x,y) to compose CCPoint object. The original point (0,0) is at the left-bottom corner of screen. For example, this codesnip sets the node in the center of screen.

node->setPosition( ccp(size.width/2, size.height/2) )
Parameters
positionThe position (x,y) of the node in OpenGL coordinates

Reimplemented from CCNode.

void setReturnType ( KeyboardReturnType  returnType)

Set the return type that are to be applied to the edit box.

Parameters
returnTypeOne of the CCKeyboardReturnType constants.
void setText ( const char *  pText)

Set the text entered in the edit box.

Parameters
pTextThe given text.
virtual void setVisible ( bool  visible)
virtual

Sets whether the node is visible.

The default value is true, a node is default to visible

Parameters
visibletrue if the node is visible, false if the node is hidden.

Reimplemented from CCNode.

void touchDownAction ( CCObject sender,
CCControlEvent  controlEvent 
)

callback funtions

void unregisterScriptEditBoxHandler ( void  )

Unregisters a script function that will be called for EditBox events.

virtual void visit ( void  )
virtual

Visits this node's children and draw them recursively.

Reimplemented from CCNode.

Member Data Documentation

ccColor3B m_colPlaceHolder
protected
ccColor3B m_colText
protected
EditBoxInputFlag
m_eEditBoxInputFlag
protected
EditBoxInputMode
m_eEditBoxInputMode
protected
KeyboardReturnType
m_eKeyboardReturnType
protected
float m_fAdjustHeight
protected
int m_nFontSize
protected
int m_nMaxLength
protected
int m_nPlaceholderFontSize
protected
int m_nScriptEditBoxHandler
protected
CCEditBoxDelegate* m_pDelegate
protected
CCEditBoxImpl* m_pEditBoxImpl
protected
std::string m_strFontName
protected
std::string m_strPlaceHolder
protected
std::string
m_strPlaceholderFontName
protected
std::string m_strText
protected

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