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

Class for edit box. More...

#include <CCEditBox.h>

Inheritance diagram for EditBox:
ControlButton IMEDelegate Control Layer Node Object

Public Types

enum  KeyboardReturnType {
  DEFAULT, DONE, SEND, SEARCH,
  GO
}
 
enum  InputMode {
  ANY, EMAIL_ADDRESS, NUMERIC, PHONE_NUMBER,
  URL, DECIMAL, SINGLE_LINE
}
 The EditBox::InputMode defines the type of text that the user is allowed to enter. More...
 
enum  InputFlag {
  PASSWORD, SENSITIVE, INITIAL_CAPS_WORD, INITIAL_CAPS_SENTENCE,
  INTIAL_CAPS_ALL_CHARACTERS
}
 The EditBox::InputFlag defines how the input text is displayed/formatted. More...
 

Public Member Functions

 EditBox (void)
 Constructor. More...
 
virtual ~EditBox (void)
 Destructor. More...
 
bool initWithSizeAndBackgroundSprite (const Size &size, Scale9Sprite *pNormal9SpriteBg)
 Init edit box with specified size. More...
 
void setDelegate (EditBoxDelegate *pDelegate)
 Gets/Sets the delegate for edit box. More...
 
EditBoxDelegategetDelegate ()
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 Color3B &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 Color3B &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 (InputMode 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 (InputFlag inputFlag)
 Set the input flags that are to be applied to the edit box. More...
 
void setReturnType (EditBox::KeyboardReturnType returnType)
 Set the return type that are to be applied to the edit box. More...
 
virtual void setPosition (const Point &pos) override
 Changes the position (x,y) of the node in OpenGL coordinates. More...
 
virtual void setVisible (bool visible) override
 Sets whether the node is visible. More...
 
virtual void setContentSize (const Size &size) override
 Sets the untransformed size of the node. More...
 
virtual void setAnchorPoint (const Point &anchorPoint) override
 Sets the anchor point in percent. More...
 
virtual void visit (void) override
 Visits this node's children and draw them recursively. More...
 
virtual void onEnter (void) override
 Event callback that is invoked every time when Node enters the 'stage'. More...
 
virtual void onExit (void) override
 Event callback that is invoked every time the Node leaves the 'stage'. More...
 
virtual void keyboardWillShow (IMEKeyboardNotificationInfo &info) override
virtual void keyboardDidShow (IMEKeyboardNotificationInfo &info) override
virtual void keyboardWillHide (IMEKeyboardNotificationInfo &info) override
virtual void keyboardDidHide (IMEKeyboardNotificationInfo &info) override
void touchDownAction (Object *sender, Control::EventType controlEvent)
- Public Member Functions inherited from ControlButton
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...
 
var setEnabled ( var 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...
 
var setSelected ( var 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...
 
var setHighlighted ( var 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...
 
bool isPushed () const
virtual std::string getTitleForState (State state)
 Returns the title used for a state. More...
 
virtual void setTitleForState (const std::string &title, State state)
 Sets the title string to use for the specified state. More...
 
var setTitleForState ( var title, var 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 Color3B getTitleColorForState (State state) const
 Returns the title color used for a state. More...
 
var getTitleColorForState ( var 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 (const Color3B &color, State state)
 Sets the color of the title to use for the specified state. More...
 
virtual NodegetTitleLabelForState (State state)
 Returns the title label used for a state. More...
 
virtual void setTitleLabelForState (Node *label, State state)
 Sets the title label to use for the specified state. More...
 
virtual void setTitleTTFForState (const std::string &fntFile, State state)
virtual const std::string & getTitleTTFForState (State state)
local getTitleTTFForState ( local state)
virtual void setTitleTTFSizeForState (float size, State state)
virtual float getTitleTTFSizeForState (State state)
virtual void setTitleBMFontForState (const std::string &fntFile, State state)
 Sets the font of the label, changes the label to a LabelBMFont if neccessary. More...
 
var setTitleBMFontForState ( var fntFile, var state)
 Sets the font of the label, changes the label to a LabelBMFont if neccessary. More...
 
local setTitleBMFontForState ( local fntFile, local state)
 Sets the font of the label, changes the label to a LabelBMFont if neccessary. More...
 
virtual const std::string & getTitleBMFontForState (State state)
local getTitleBMFontForState ( local state)
virtual Scale9SpritegetBackgroundSpriteForState (State 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 (Scale9Sprite *sprite, State 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 (SpriteFrame *spriteFrame, State 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...
 
virtual void setMargins (int marginH, int marginV)
bool doesAdjustBackgroundImage ()
 Adjust the background image. More...
 
void setAdjustBackgroundImage (bool adjustBackgroundImage)
virtual bool onTouchBegan (Touch *touch, Event *event) override
var onTouchBegan ( var touch, var event)
local onTouchBegan ( local touch, local event)
virtual void onTouchMoved (Touch *touch, Event *event) override
var onTouchMoved ( var touch, var event)
local onTouchMoved ( local touch, local event)
virtual void onTouchEnded (Touch *touch, Event *event) override
var onTouchEnded ( var touch, var event)
local onTouchEnded ( local touch, local event)
virtual void onTouchCancelled (Touch *touch, Event *event) override
virtual GLubyte getOpacity (void) const override
virtual void setOpacity (GLubyte var) override
var setOpacity ( var var)
local setOpacity ( local var)
virtual const Color3BgetColor (void) const override
var getColor ()
local getColor ()
virtual void setColor (const Color3B &) override
var setColor ()
local setColor ()
const std::string & getCurrentTitle () const
local getCurrentTitle ()
std::string getCurrentTitle ()
virtual const Color3BgetCurrentTitleColor (void)
 getCurrentTitleColor More...
 
local getCurrentTitleColor ()
 getCurrentTitleColor More...
 
virtual NodegetTitleLabel (void)
 getTitleLabel More...
 
virtual void setTitleLabel (Node *var)
 setTitleLabel More...
 
var setTitleLabel ( var var)
 setTitleLabel More...
 
local setTitleLabel ( local var)
 setTitleLabel More...
 
virtual Scale9SpritegetBackgroundSprite (void)
 getBackgroundSprite More...
 
var getBackgroundSprite ()
 getBackgroundSprite More...
 
local getBackgroundSprite ()
 getBackgroundSprite More...
 
virtual void setBackgroundSprite (Scale9Sprite *var)
 setBackgroundSprite More...
 
local setBackgroundSprite ( local var)
 setBackgroundSprite More...
 
virtual const SizegetPreferredSize (void)
 getPreferredSize More...
 
virtual void setPreferredSize (const Size &var)
 setPreferredSize More...
 
virtual bool getZoomOnTouchDown (void)
 getZoomOnTouchDown More...
 
var getZoomOnTouchDown ()
 getZoomOnTouchDown More...
 
local getZoomOnTouchDown ()
 getZoomOnTouchDown More...
 
virtual void setZoomOnTouchDown (bool var)
 setZoomOnTouchDown More...
 
var setZoomOnTouchDown ( var var)
 setZoomOnTouchDown More...
 
local setZoomOnTouchDown ( local var)
 setZoomOnTouchDown More...
 
virtual const PointgetLabelAnchorPoint (void)
 getLabelAnchorPoint More...
 
var getLabelAnchorPoint ()
 getLabelAnchorPoint More...
 
local getLabelAnchorPoint ()
 getLabelAnchorPoint More...
 
virtual void setLabelAnchorPoint (const Point &var)
 setLabelAnchorPoint More...
 
virtual int getVerticalMargin (void)
 getVerticalMargin More...
 
virtual int getHorizontalOrigin (void)
 getHorizontalOrigin More...
 
- Public Member Functions inherited from Control
virtual bool isEnabled () const
virtual bool isSelected () const
virtual bool isHighlighted () const
bool hasVisibleParents () const
var hasVisibleParents ()
local hasVisibleParents ()
virtual void sendActionsForControlEvents (EventType controlEvents)
 Sends action messages for the given control events. More...
 
local sendActionsForControlEvents ( local controlEvents)
 Sends action messages for the given control events. More...
 
virtual void addTargetWithActionForControlEvents (Object *target, Handler action, EventType controlEvents)
 Adds a target and action for a particular event (or events) to an internal dispatch table. More...
 
local addTargetWithActionForControlEvents ( local target, local action, local controlEvents)
 Adds a target and action for a particular event (or events) to an internal dispatch table. More...
 
virtual void removeTargetWithActionForControlEvents (Object *target, Handler action, EventType controlEvents)
 Removes a target and action for a particular event (or events) from an internal dispatch table. More...
 
virtual Point getTouchLocation (Touch *touch)
 Returns a point corresponding to the touh location converted into the control space coordinates. More...
 
virtual bool isTouchInside (Touch *touch)
 Returns a boolean value that indicates whether a touch is inside the bounds of the receiver. More...
 
virtual bool isOpacityModifyRGB () const override
virtual void setOpacityModifyRGB (bool bOpacityModifyRGB) override
var setOpacityModifyRGB ( var bOpacityModifyRGB)
local setOpacityModifyRGB ( local bOpacityModifyRGB)
virtual State getState (void)
 getState More...
 
- Public Member Functions inherited from Layer
virtual
CC_DEPRECATED_ATTRIBUTE bool 
ccTouchBegan (Touch *pTouch, Event *pEvent) final
local ccTouchBegan ( local pTouch, local pEvent)
virtual
CC_DEPRECATED_ATTRIBUTE void 
ccTouchMoved (Touch *pTouch, Event *pEvent) final
local ccTouchMoved ( local pTouch, local pEvent)
virtual
CC_DEPRECATED_ATTRIBUTE void 
ccTouchEnded (Touch *pTouch, Event *pEvent) final
local ccTouchEnded ( local pTouch, local pEvent)
virtual
CC_DEPRECATED_ATTRIBUTE void 
ccTouchCancelled (Touch *pTouch, Event *pEvent) final
local ccTouchCancelled ( local pTouch, local pEvent)
virtual
CC_DEPRECATED_ATTRIBUTE void 
ccTouchesBegan (__Set *pTouches, Event *pEvent) final
var ccTouchesBegan ( var pTouches, var pEvent)
local ccTouchesBegan ( local pTouches, local pEvent)
virtual
CC_DEPRECATED_ATTRIBUTE void 
ccTouchesMoved (__Set *pTouches, Event *pEvent) final
local ccTouchesMoved ( local pTouches, local pEvent)
virtual
CC_DEPRECATED_ATTRIBUTE void 
ccTouchesEnded (__Set *pTouches, Event *pEvent) final
local ccTouchesEnded ( local pTouches, local pEvent)
virtual
CC_DEPRECATED_ATTRIBUTE void 
ccTouchesCancelled (__Set *pTouches, Event *pEvent) final
local ccTouchesCancelled ( local pTouches, local pEvent)
virtual void onTouchesBegan (const std::vector< Touch * > &touches, Event *unused_event)
virtual void onTouchesMoved (const std::vector< Touch * > &touches, Event *unused_event)
local onTouchesMoved ( local touches, local unused_event)
virtual void onTouchesEnded (const std::vector< Touch * > &touches, Event *unused_event)
local onTouchesEnded ( local touches, local unused_event)
virtual void onTouchesCancelled (const std::vector< Touch * > &touches, Event *unused_event)
virtual
CC_DEPRECATED_ATTRIBUTE void 
didAccelerate (Acceleration *accelerationValue) final
local didAccelerate ( local accelerationValue)
virtual void onAcceleration (Acceleration *acc, Event *unused_event)
var onAcceleration ( var acc, var unused_event)
local onAcceleration ( local acc, local unused_event)
virtual
CC_DEPRECATED_ATTRIBUTE void 
registerWithTouchDispatcher () final
 If isTouchEnabled, this method is called onEnter. More...
 
var registerWithTouchDispatcher ()
 If isTouchEnabled, this method is called onEnter. More...
 
local registerWithTouchDispatcher ()
 If isTouchEnabled, this method is called onEnter. More...
 
CC_DEPRECATED_ATTRIBUTE bool isTouchEnabled () const
 whether or not it will receive Touch events. More...
 
local isTouchEnabled ()
 whether or not it will receive Touch events. More...
 
CC_DEPRECATED_ATTRIBUTE void setTouchEnabled (bool value)
virtual
CC_DEPRECATED_ATTRIBUTE void 
setTouchMode (Touch::DispatchMode mode)
local setTouchMode ( local mode)
virtual
CC_DEPRECATED_ATTRIBUTE
Touch::DispatchMode 
getTouchMode () const
var getTouchMode ()
local getTouchMode ()
virtual
CC_DEPRECATED_ATTRIBUTE void 
setSwallowsTouches (bool swallowsTouches)
 swallowsTouches of the touch events. More...
 
local setSwallowsTouches ( local swallowsTouches)
 swallowsTouches of the touch events. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE bool 
isSwallowsTouches () const
local isSwallowsTouches ()
virtual
CC_DEPRECATED_ATTRIBUTE bool 
isAccelerometerEnabled () const
 
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
CC_DEPRECATED_ATTRIBUTE void 
setAccelerometerEnabled (bool value)
local setAccelerometerEnabled ( local value)
virtual
CC_DEPRECATED_ATTRIBUTE void 
setAccelerometerInterval (double interval)
local setAccelerometerInterval ( local interval)
virtual
CC_DEPRECATED_ATTRIBUTE bool 
isKeyboardEnabled () const
 
whether or not it will receive keyboard or keypad events

You can enable / disable accelerometer events with this property. More...

 
var isKeyboardEnabled ()
 
whether or not it will receive keyboard or keypad events

You can enable / disable accelerometer events with this property. More...

 
local isKeyboardEnabled ()
 
whether or not it will receive keyboard or keypad events

You can enable / disable accelerometer events with this property. More...

 
virtual
CC_DEPRECATED_ATTRIBUTE void 
setKeyboardEnabled (bool value)
var setKeyboardEnabled ( var value)
local setKeyboardEnabled ( local value)
virtual
CC_DEPRECATED_ATTRIBUTE void 
keyPressed (int keyCode) final
 Please use onKeyPressed instead. More...
 
local keyPressed ( local keyCode)
 Please use onKeyPressed instead. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE void 
keyReleased (int keyCode) final
 Please use onKeyReleased instead. More...
 
local keyReleased ( local keyCode)
 Please use onKeyReleased instead. More...
 
virtual void onKeyPressed (EventKeyboard::KeyCode keyCode, Event *event)
var onKeyPressed ( var keyCode, var event)
local onKeyPressed ( local keyCode, local event)
virtual void onKeyReleased (EventKeyboard::KeyCode keyCode, Event *event)
local onKeyReleased ( local keyCode, local event)
virtual
CC_DEPRECATED_ATTRIBUTE bool 
isKeypadEnabled () const final
local isKeypadEnabled ()
virtual
CC_DEPRECATED_ATTRIBUTE void 
setKeypadEnabled (bool value)
local setKeypadEnabled ( local value)
virtual
CC_DEPRECATED_ATTRIBUTE void 
keyBackClicked () final
var keyBackClicked ()
local keyBackClicked ()
virtual
CC_DEPRECATED_ATTRIBUTE void 
keyMenuClicked () final
local keyMenuClicked ()
virtual std::string getDescription () const override
 Gets the description string. More...
 
- Public Member Functions inherited from Node
virtual bool isRunning () const
 Returns whether or not the node accepts event callbacks. More...
 
void scheduleUpdateWithPriorityLua (int handler, int priority)
 Schedules for lua script. More...
 
local scheduleUpdateWithPriorityLua ( local handler, local priority)
 Schedules for lua script. More...
 
virtual void cleanup ()
 Stops all running actions and schedulers. More...
 
var cleanup ()
 Stops all running actions and schedulers. More...
 
local cleanup ()
 Stops all running actions and schedulers. More...
 
virtual void draw ()
 Override this method to draw your own node. More...
 
local draw ()
 Override this method to draw your own node. More...
 
virtual ScenegetScene ()
 Returns the Scene that contains the Node. More...
 
local getScene ()
 Returns the Scene that contains the Node. More...
 
virtual Rect getBoundingBox () const
 Returns a "local" axis aligned bounding box of the node. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE Rect 
boundingBox () const
local boundingBox ()
virtual void setEventDispatcher (EventDispatcher *dispatcher)
var setEventDispatcher ( var dispatcher)
local setEventDispatcher ( local dispatcher)
virtual EventDispatchergetEventDispatcher () const
local getEventDispatcher ()
void setPhysicsBody (PhysicsBody *body)
 set the PhysicsBody that let the sprite effect with physics More...
 
var setPhysicsBody ( var body)
 set the PhysicsBody that let the sprite effect with physics More...
 
local setPhysicsBody ( local body)
 set the PhysicsBody that let the sprite effect with physics More...
 
PhysicsBody * getPhysicsBody () const
 get the PhysicsBody the sprite have More...
 
var getPhysicsBody ()
 get the PhysicsBody the sprite have More...
 
local getPhysicsBody ()
 get the PhysicsBody the sprite have More...
 
virtual bool updatePhysicsTransform ()
 update rotation and position from physics body More...
 
var updatePhysicsTransform ()
 update rotation and position from physics body More...
 
local updatePhysicsTransform ()
 update rotation and position from physics body More...
 
virtual GLubyte getDisplayedOpacity () const
var getDisplayedOpacity ()
local getDisplayedOpacity ()
virtual void updateDisplayedOpacity (GLubyte parentOpacity)
var updateDisplayedOpacity ( var parentOpacity)
local updateDisplayedOpacity ( local parentOpacity)
virtual bool isCascadeOpacityEnabled () const
var isCascadeOpacityEnabled ()
local isCascadeOpacityEnabled ()
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual const Color3BgetDisplayedColor () const
local getDisplayedColor ()
virtual void updateDisplayedColor (const Color3B &parentColor)
var updateDisplayedColor ( var parentColor)
local updateDisplayedColor ( local parentColor)
virtual bool isCascadeColorEnabled () const
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
virtual void setLocalZOrder (int localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE void 
setZOrder (int localZOrder)
local setZOrder ( local localZOrder)
virtual void _setLocalZOrder (int z)
virtual int getLocalZOrder () const
 Gets the local Z order of this node. More...
 
var getLocalZOrder ()
 Gets the local Z order of this node. More...
 
local getLocalZOrder ()
 Gets the local Z order of this node. More...
 
virtual CC_DEPRECATED_ATTRIBUTE int getZOrder () const
var getZOrder ()
local getZOrder ()
virtual void setGlobalZOrder (float globalZOrder)
 Defines the oder in which the nodes are renderer. More...
 
local setGlobalZOrder ( local globalZOrder)
 Defines the oder in which the nodes are renderer. More...
 
virtual float getGlobalZOrder () const
 Returns the Node's Global Z Order. More...
 
virtual void setVertexZ (float vertexZ)
 Sets the 'z' value in the OpenGL Depth Buffer. More...
 
var setVertexZ ( var vertexZ)
 Sets the 'z' value in the OpenGL Depth Buffer. More...
 
local setVertexZ ( local vertexZ)
 Sets the 'z' value in the OpenGL Depth Buffer. More...
 
virtual float getVertexZ () const
 Gets OpenGL Z vertex of this node. More...
 
virtual void setScaleX (float scaleX)
 Changes the scale factor on X axis of this node. More...
 
local setScaleX ( local scaleX)
 Changes the scale factor on X axis of this node. More...
 
virtual float getScaleX () const
 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 scaleY)
 Changes the scale factor on Y axis of this node. More...
 
local setScaleY ( local scaleY)
 Changes the scale factor on Y axis of this node. More...
 
virtual float getScaleY () const
 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...
 
local setScale ( local scale)
 Changes both X and Y scale factor of the node. More...
 
virtual float getScale () const
 Gets the scale factor of the node, when X and Y have the same scale factor. More...
 
virtual void setScale (float scaleX, float scaleY)
 Changes both X and Y scale factor of the node. More...
 
local setScale ( local scaleX, local scaleY)
 Changes both X and Y scale factor of the node. More...
 
virtual const PointgetPosition () const
 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) const
 Gets position in a more efficient way, returns two number instead of a Point object. More...
 
var getPosition ( var x, var y)
 Gets position in a more efficient way, returns two number instead of a Point object. More...
 
local getPosition ( local x, local y)
 Gets position in a more efficient way, returns two number instead of a Point object. More...
 
virtual void setPositionX (float x)
 Gets/Sets x or y coordinate individually for position. More...
 
virtual float getPositionX (void) const
virtual void setPositionY (float y)
local setPositionY ( local y)
virtual float getPositionY (void) const
local getPositionY ()
virtual void 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 () const
 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 () const
 Returns the Y skew angle of the node in degrees. More...
 
virtual const PointgetAnchorPoint () const
 Returns the anchor point in percent. More...
 
local getAnchorPoint ()
 Returns the anchor point in percent. More...
 
virtual const PointgetAnchorPointInPoints () const
 Returns the anchorPoint in absolute pixels. More...
 
virtual const SizegetContentSize () const
 Returns the untransformed size of the node. More...
 
virtual bool isVisible () const
 Determines if the node is visible. More...
 
virtual void setRotation (float rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
local setRotation ( local rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
virtual float getRotation () const
 Returns the rotation of the node in degrees. More...
 
virtual void setRotationX (float rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
local setRotationX ( local rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual float getRotationX () const
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
virtual void setRotationY (float rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
var setRotationY ( var rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local setRotationY ( local rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual float getRotationY () const
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
void setOrderOfArrival (int orderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
int getOrderOfArrival () const
 Returns the arrival order, indecates which children is added previously. More...
 
CC_DEPRECATED_ATTRIBUTE void setGLServerState (int serverState)
CC_DEPRECATED_ATTRIBUTE int getGLServerState () const
virtual void ignoreAnchorPointForPosition (bool ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
virtual bool isIgnoreAnchorPointForPosition () const
 Gets whether the anchor point will be (0,0) when you position this node. More...
 
virtual void addChild (Node *child)
 Adds a child to the container with z-order as 0. More...
 
var addChild ( var child)
 Adds a child to the container with z-order as 0. More...
 
local addChild ( local child)
 Adds a child to the container with z-order as 0. More...
 
virtual void addChild (Node *child, int localZOrder)
 Adds a child to the container with a local z-order. More...
 
var addChild ( var child, var localZOrder)
 Adds a child to the container with a local z-order. More...
 
local addChild ( local child, local localZOrder)
 Adds a child to the container with a local z-order. More...
 
virtual void addChild (Node *child, int localZOrder, int tag)
 Adds a child to the container with z order and tag. More...
 
local addChild ( local child, local localZOrder, local tag)
 Adds a child to the container with z order and tag. More...
 
virtual NodegetChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
virtual Vector< Node * > & getChildren ()
 Return an array of children. More...
 
local getChildren ()
 Return an array of children. More...
 
virtual const Vector< Node * > & getChildren () const
local getChildren ()
virtual ssize_t getChildrenCount () const
 Get the amount of children. More...
 
virtual void setParent (Node *parent)
 Sets the parent node. More...
 
local setParent ( local parent)
 Sets the parent node. More...
 
virtual NodegetParent ()
 Returns a pointer to the parent node. More...
 
virtual const NodegetParent () const
virtual void removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
virtual void removeFromParentAndCleanup (bool cleanup)
 Removes this node itself from its parent node. More...
 
local removeFromParent ( local cleanup)
 Removes this node itself from its parent node. More...
 
virtual void removeChild (Node *child, bool cleanup=true)
 Removes a child from the container. More...
 
virtual void removeChildByTag (int tag, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
virtual void removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
virtual void removeAllChildrenWithCleanup (bool cleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
local removeAllChildren ( local cleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
virtual void reorderChild (Node *child, int localZOrder)
 Reorders a child according to a new z value. More...
 
virtual void sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
var sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
local sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
virtual int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
local getTag ()
 Returns a tag that is used to identify the node easily. More...
 
virtual void setTag (int tag)
 Changes the tag that is used to identify the node easily. More...
 
local setTag ( local tag)
 Changes the tag that is used to identify the node easily. More...
 
virtual void * getUserData ()
 Returns a custom user data pointer. More...
 
virtual const void * getUserData () const
virtual void setUserData (void *userData)
 Sets a custom user data pointer. More...
 
virtual ObjectgetUserObject ()
 Returns a user assigned Object. More...
 
virtual const ObjectgetUserObject () const
virtual void setUserObject (Object *userObject)
 Returns a user assigned Object. More...
 
local setUserObject ( local userObject)
 Returns a user assigned Object. More...
 
virtual GLProgramgetShaderProgram ()
 Return the shader program currently used for this node. More...
 
virtual const GLProgramgetShaderProgram () const
local getShaderProgram ()
virtual void setShaderProgram (GLProgram *shaderProgram)
 Sets the shader program for this node. More...
 
local setShaderProgram ( local shaderProgram)
 Sets the shader program for this node. More...
 
virtual void onEnterTransitionDidFinish ()
 Event callback that is invoked when the Node enters in the 'stage'. More...
 
virtual void onExitTransitionDidStart ()
 Event callback that is called every time the Node leaves the 'stage'. More...
 
virtual void setActionManager (ActionManager *actionManager)
 Sets the ActionManager object that is used by all actions. More...
 
virtual ActionManagergetActionManager ()
 Gets the ActionManager object that is used by all actions. More...
 
virtual const ActionManagergetActionManager () const
local getActionManager ()
ActionrunAction (Action *action)
 Executes an action, and returns the action that is executed. More...
 
var runAction ( var action)
 Executes an action, and returns the action that is executed. More...
 
local runAction ( local action)
 Executes an action, and returns the action that is executed. More...
 
void stopAllActions ()
 Stops and removes all actions from the running action list . More...
 
void stopAction (Action *action)
 Stops and removes an action from the running action list. More...
 
var stopAction ( var action)
 Stops and removes an action from the running action list. More...
 
local stopAction ( local action)
 Stops and removes an action from the running action list. More...
 
void stopActionByTag (int tag)
 Removes an action from the running action list by its tag. More...
 
var stopActionByTag ( var tag)
 Removes an action from the running action list by its tag. More...
 
local stopActionByTag ( local tag)
 Removes an action from the running action list by its tag. More...
 
ActiongetActionByTag (int tag)
 Gets an action from the running action list by its tag. More...
 
var getActionByTag ( var tag)
 Gets an action from the running action list by its tag. More...
 
local getActionByTag ( local tag)
 Gets an action from the running action list by its tag. More...
 
ssize_t getNumberOfRunningActions () const
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
CC_DEPRECATED_ATTRIBUTE ssize_t numberOfRunningActions () const
local numberOfRunningActions ()
virtual void setScheduler (Scheduler *scheduler)
 Sets a Scheduler object that is used to schedule all "updates" and timers. More...
 
virtual SchedulergetScheduler ()
 Gets a Sheduler object. More...
 
virtual const SchedulergetScheduler () const
local getScheduler ()
bool isScheduled (SEL_SCHEDULE selector)
 Checks whether a selector is scheduled. More...
 
void scheduleUpdate (void)
 Schedules the "update" method. More...
 
void scheduleUpdateWithPriority (int priority)
 Schedules the "update" method with a custom priority. More...
 
void unscheduleUpdate (void)
var unscheduleUpdate ()
local unscheduleUpdate ()
void schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
 Schedules a custom selector. More...
 
void schedule (SEL_SCHEDULE selector, float interval)
 Schedules a custom selector with an interval time in seconds. More...
 
void scheduleOnce (SEL_SCHEDULE selector, float delay)
 Schedules a selector that runs only once, with a delay of 0 or larger. More...
 
void schedule (SEL_SCHEDULE selector)
 Schedules a custom selector, the scheduled selector will be ticked every frame. More...
 
void unschedule (SEL_SCHEDULE selector)
 Unschedules a custom selector. More...
 
void unscheduleAllSelectors (void)
 Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...
 
var unscheduleAllSelectors ()
 Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...
 
void resume (void)
 Resumes all scheduled selectors, actions and event listeners. More...
 
void pause (void)
 Pauses all scheduled selectors, actions and event listeners. More...
 
var pause ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
local pause ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
CC_DEPRECATED_ATTRIBUTE void resumeSchedulerAndActions (void)
 Resumes all scheduled selectors, actions and event listeners. More...
 
local resumeSchedulerAndActions ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
CC_DEPRECATED_ATTRIBUTE void pauseSchedulerAndActions (void)
 Pauses all scheduled selectors, actions and event listeners. More...
 
local pauseSchedulerAndActions ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
virtual void update (float delta)
var update ( var delta)
local update ( local delta)
void transform ()
 Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes. More...
 
void transformAncestors ()
 Performs OpenGL view-matrix transformation of it's ancestors. More...
 
virtual void updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
var updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
local updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
virtual const kmMat4 & getNodeToParentTransform () const
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual AffineTransform getNodeToParentAffineTransform () const
local getNodeToParentAffineTransform ()
virtual void setNodeToParentTransform (const kmMat4 &transform)
 Sets the Transformation matrix manually. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
nodeToParentTransform () const
local nodeToParentTransform ()
virtual const kmMat4 & getParentToNodeTransform () const
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
local getParentToNodeTransform ()
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
virtual AffineTransform getParentToNodeAffineTransform () const
local getParentToNodeAffineTransform ()
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
parentToNodeTransform () const
local parentToNodeTransform ()
virtual kmMat4 getNodeToWorldTransform () const
 Returns the world affine transform matrix. More...
 
virtual AffineTransform getNodeToWorldAffineTransform () const
local getNodeToWorldAffineTransform ()
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
nodeToWorldTransform () const
local nodeToWorldTransform ()
virtual kmMat4 getWorldToNodeTransform () const
 Returns the inverse world affine transform matrix. More...
 
local getWorldToNodeTransform ()
 Returns the inverse world affine transform matrix. More...
 
virtual AffineTransform getWorldToNodeAffineTransform () const
local getWorldToNodeAffineTransform ()
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
worldToNodeTransform () const
local worldToNodeTransform ()
Point convertToNodeSpace (const Point &worldPoint) const
 Converts a Point to node (local) space coordinates. More...
 
Point convertToWorldSpace (const Point &nodePoint) const
 Converts a Point to world space coordinates. More...
 
Point convertToNodeSpaceAR (const Point &worldPoint) const
 Converts a Point to node (local) space coordinates. More...
 
var convertToNodeSpaceAR ( var worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
local convertToNodeSpaceAR ( local worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
Point convertToWorldSpaceAR (const Point &nodePoint) const
 Converts a local Point to world space coordinates.The result is in Points. More...
 
Point convertTouchToNodeSpace (Touch *touch) const
 convenience methods which take a Touch instead of Point More...
 
Point convertTouchToNodeSpaceAR (Touch *touch) const
 converts a Touch (world coordinates) into a local coordinate. More...
 
var convertTouchToNodeSpaceAR ( var touch)
 converts a Touch (world coordinates) into a local coordinate. More...
 
local convertTouchToNodeSpaceAR ( local touch)
 converts a Touch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (const AffineTransform &additionalTransform)
 Sets an additional transform matrix to the node. More...
 
var setAdditionalTransform ( var additionalTransform)
 Sets an additional transform matrix to the node. More...
 
local setAdditionalTransform ( local additionalTransform)
 Sets an additional transform matrix to the node. More...
 
void setAdditionalTransform (const kmMat4 &additionalTransform)
ComponentgetComponent (const std::string &pName)
 gets a component by its name More...
 
var getComponent ( var pName)
 gets a component by its name More...
 
local getComponent ( local pName)
 gets a component by its name More...
 
virtual bool addComponent (Component *pComponent)
 adds a component More...
 
var addComponent ( var pComponent)
 adds a component More...
 
local addComponent ( local pComponent)
 adds a component More...
 
virtual bool removeComponent (const std::string &pName)
 removes a component by its name More...
 
var removeComponent ( var pName)
 removes a component by its name More...
 
local removeComponent ( local pName)
 removes a component by its name More...
 
virtual void removeAllComponents ()
 removes all components More...
 
- Public Member Functions inherited from Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
void release ()
 Release the ownership immediately. More...
 
void retain ()
 Retains the ownership. More...
 
Objectautorelease ()
 Release the ownership sometime soon automatically. More...
 
bool isSingleReference () const
 Returns a boolean value that indicates whether there is only one reference to the object. More...
 
unsigned int retainCount () const
 Returns the object's current reference count. More...
 
unsigned int getReferenceCount () const
virtual bool isEqual (const Object *object)
 Returns a boolean value that indicates whether this object and a given object are equal. More...
 
virtual void acceptVisitor (DataVisitor &visitor)
- Public Member Functions inherited from IMEDelegate
virtual ~IMEDelegate ()
virtual bool attachWithIME ()
virtual bool detachWithIME ()

Static Public Member Functions

static EditBoxcreate (const Size &size, Scale9Sprite *pNormal9SpriteBg, Scale9Sprite *pPressed9SpriteBg=NULL, Scale9Sprite *pDisabled9SpriteBg=NULL)
 create a edit box with size. More...
 
- Static Public Member Functions inherited from ControlButton
static ControlButtoncreate ()
static ControlButtoncreate (Scale9Sprite *sprite)
local create ( local sprite)
static ControlButtoncreate (Node *label, Scale9Sprite *backgroundSprite)
local create ( local label, local backgroundSprite)
static ControlButtoncreate (const std::string &title, const std::string &fontName, float fontSize)
local create ( local title, local fontName, local fontSize)
- Static Public Member Functions inherited from Control
static Controlcreate ()
 Creates a Control object. More...
 
- Static Public Member Functions inherited from Layer
static Layercreate ()
 creates a fullscreen black layer More...
 
- Static Public Member Functions inherited from Node
static Nodecreate (void)
 Allocates and initializes a node. More...
 

Protected Attributes

EditBoxImpl_editBoxImpl
EditBoxDelegate_delegate
InputMode _editBoxInputMode
InputFlag _editBoxInputFlag
EditBox::KeyboardReturnType _keyboardReturnType
std::string _text
std::string _placeHolder
std::string _fontName
std::string _placeholderFontName
int _fontSize
int _placeholderFontSize
Color3B _colText
Color3B _colPlaceHolder
int _maxLength
float _adjustHeight
int _scriptEditBoxHandler
- Protected Attributes inherited from ControlButton
bool _isPushed
var _isPushed
bool _parentInited
var _parentInited
local _parentInited
bool _doesAdjustBackgroundImage
var _doesAdjustBackgroundImage
local _doesAdjustBackgroundImage
std::string _currentTitle
 The current title that is displayed on the button. More...
 
var _currentTitle
 The current title that is displayed on the button. More...
 
local _currentTitle
 The current title that is displayed on the button. More...
 
Color3B _currentTitleColor
 The current color used to display the title. More...
 
Node_titleLabel
 The current title label. More...
 
Scale9Sprite_backgroundSprite
 The current background sprite. More...
 
var _backgroundSprite
 The current background sprite. More...
 
local _backgroundSprite
 The current background sprite. More...
 
Size _preferredSize
 The prefered size of the button, if label is larger it will be expanded. More...
 
bool _zoomOnTouchDown
 Adjust the button zooming on touchdown. More...
 
float _scaleRatio
 Scale ratio button on touchdown. More...
 
var _scaleRatio
 Scale ratio button on touchdown. More...
 
local _scaleRatio
 Scale ratio button on touchdown. More...
 
Point _labelAnchorPoint
int _marginV
int _marginH
var _marginH
local _marginH
- Protected Attributes inherited from Control
bool _enabled
bool _selected
var _selected
local _selected
bool _highlighted
var _highlighted
local _highlighted
bool _hasVisibleParents
 True if all of the controls parents are visible. More...
 
var _hasVisibleParents
 True if all of the controls parents are visible. More...
 
local _hasVisibleParents
 True if all of the controls parents are visible. More...
 
std::unordered_map< int,
Vector< Invocation * > * > 
_dispatchTable
 Table of connection between the ControlEvents and their associated target-actions pairs. More...
 
bool _isOpacityModifyRGB
State _state
 The current control state constant. More...
 
- Protected Attributes inherited from Layer
bool _touchEnabled
bool _accelerometerEnabled
var _accelerometerEnabled
local _accelerometerEnabled
bool _keyboardEnabled
var _keyboardEnabled
local _keyboardEnabled
EventListener_touchListener
var _touchListener
local _touchListener
EventListenerKeyboard_keyboardListener
var _keyboardListener
local _keyboardListener
EventListenerAcceleration_accelerationListener
var _accelerationListener
local _accelerationListener
Touch::DispatchMode _touchMode
var _touchMode
local _touchMode
bool _swallowsTouches
var _swallowsTouches
local _swallowsTouches
- Protected Attributes inherited from Node
float _rotationX
 rotation angle on x-axis More...
 
float _rotationY
 rotation angle on y-axis More...
 
var _rotationY
 rotation angle on y-axis More...
 
local _rotationY
 rotation angle on y-axis More...
 
float _scaleX
 scaling factor on x-axis More...
 
var _scaleX
 scaling factor on x-axis More...
 
local _scaleX
 scaling factor on x-axis More...
 
float _scaleY
 scaling factor on y-axis More...
 
var _scaleY
 scaling factor on y-axis More...
 
local _scaleY
 scaling factor on y-axis More...
 
Point _position
 position of the node More...
 
var _position
 position of the node More...
 
local _position
 position of the node More...
 
float _skewX
 skew angle on x-axis More...
 
var _skewX
 skew angle on x-axis More...
 
local _skewX
 skew angle on x-axis More...
 
float _skewY
 skew angle on y-axis More...
 
var _skewY
 skew angle on y-axis More...
 
local _skewY
 skew angle on y-axis More...
 
Point _anchorPointInPoints
 anchor point in points More...
 
var _anchorPointInPoints
 anchor point in points More...
 
local _anchorPointInPoints
 anchor point in points More...
 
Point _anchorPoint
 anchor point normalized (NOT in points) More...
 
var _anchorPoint
 anchor point normalized (NOT in points) More...
 
local _anchorPoint
 anchor point normalized (NOT in points) More...
 
Size _contentSize
 untransformed size of the node More...
 
var _contentSize
 untransformed size of the node More...
 
local _contentSize
 untransformed size of the node More...
 
kmMat4 _modelViewTransform
 ModelView transform of the Node. More...
 
var _modelViewTransform
 ModelView transform of the Node. More...
 
local _modelViewTransform
 ModelView transform of the Node. More...
 
kmMat4 _additionalTransform
 transform More...
 
var _additionalTransform
 transform More...
 
local _additionalTransform
 transform More...
 
kmMat4 _transform
 transform More...
 
var _transform
 transform More...
 
local _transform
 transform More...
 
kmMat4 _inverse
 inverse transform More...
 
var _inverse
 inverse transform More...
 
local _inverse
 inverse transform More...
 
bool _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
var _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
local _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
bool _transformDirty
 transform dirty flag More...
 
var _transformDirty
 transform dirty flag More...
 
local _transformDirty
 transform dirty flag More...
 
bool _inverseDirty
 inverse transform dirty flag More...
 
var _inverseDirty
 inverse transform dirty flag More...
 
local _inverseDirty
 inverse transform dirty flag More...
 
int _localZOrder
 Local order (relative to its siblings) used to sort the node. More...
 
var _localZOrder
 Local order (relative to its siblings) used to sort the node. More...
 
local _localZOrder
 Local order (relative to its siblings) used to sort the node. More...
 
float _globalZOrder
 Global order used to sort the node. More...
 
var _globalZOrder
 Global order used to sort the node. More...
 
local _globalZOrder
 Global order used to sort the node. More...
 
float _vertexZ
 OpenGL real Z vertex. More...
 
var _vertexZ
 OpenGL real Z vertex. More...
 
local _vertexZ
 OpenGL real Z vertex. More...
 
Vector< Node * > _children
 array of children nodes More...
 
var _children
 array of children nodes More...
 
local _children
 array of children nodes More...
 
Node_parent
 weak reference to parent node More...
 
var _parent
 weak reference to parent node More...
 
local _parent
 weak reference to parent node More...
 
int _tag
 a tag. Can be any number you assigned just to identify this node More...
 
var _tag
 a tag. Can be any number you assigned just to identify this node More...
 
local _tag
 a tag. Can be any number you assigned just to identify this node More...
 
void * _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
var _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
local _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
Object_userObject
 A user assigned Object. More...
 
var _userObject
 A user assigned Object. More...
 
local _userObject
 A user assigned Object. More...
 
GLProgram_shaderProgram
 OpenGL shader. More...
 
var _shaderProgram
 OpenGL shader. More...
 
local _shaderProgram
 OpenGL shader. More...
 
int _orderOfArrival
 used to preserve sequence while sorting children with the same localZOrder More...
 
var _orderOfArrival
 used to preserve sequence while sorting children with the same localZOrder More...
 
local _orderOfArrival
 used to preserve sequence while sorting children with the same localZOrder More...
 
Scheduler_scheduler
 scheduler used to schedule timers and updates More...
 
var _scheduler
 scheduler used to schedule timers and updates More...
 
local _scheduler
 scheduler used to schedule timers and updates More...
 
ActionManager_actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
var _actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
local _actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
EventDispatcher_eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
var _eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
local _eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
bool _running
 is running More...
 
bool _visible
 is this node visible More...
 
var _visible
 is this node visible More...
 
local _visible
 is this node visible More...
 
bool _ignoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
 
var _ignoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
 
local _ignoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
 
bool _reorderChildDirty
 children order dirty flag More...
 
bool _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
var _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
local _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
int _scriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
var _scriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
local _scriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
int _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
var _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
local _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
ccScriptType _scriptType
 type of script binding, lua or javascript More...
 
var _scriptType
 type of script binding, lua or javascript More...
 
local _scriptType
 type of script binding, lua or javascript More...
 
ComponentContainer_componentContainer
 Dictionary of components. More...
 
var _componentContainer
 Dictionary of components. More...
 
local _componentContainer
 Dictionary of components. More...
 
PhysicsBody * _physicsBody
 the physicsBody the node have More...
 
var _physicsBody
 the physicsBody the node have More...
 
local _physicsBody
 the physicsBody the node have More...
 
GLubyte _displayedOpacity
var _displayedOpacity
local _displayedOpacity
GLubyte _realOpacity
var _realOpacity
local _realOpacity
Color3B _displayedColor
var _displayedColor
local _displayedColor
Color3B _realColor
var _realColor
local _realColor
bool _cascadeColorEnabled
var _cascadeColorEnabled
local _cascadeColorEnabled
bool _cascadeOpacityEnabled
var _cascadeOpacityEnabled
local _cascadeOpacityEnabled
- Protected Attributes inherited from Object
unsigned int _referenceCount
 count of references More...
 

Additional Inherited Members

- Public Attributes inherited from ControlButton
virtual float getScaleRatio (void)\n\n public
 getScaleRatio More...
 
var getScaleRatio ()
 getScaleRatio More...
 
local getScaleRatio ()
 getScaleRatio More...
 
std::unordered_map< int,
std::string > 
_titleDispatchTable
std::unordered_map< int, Color3B_titleColorDispatchTable
Map< int, Node * > _titleLabelDispatchTable
var _titleLabelDispatchTable
local _titleLabelDispatchTable
Map< int, Scale9Sprite * > _backgroundSpriteDispatchTable
- Static Public Attributes inherited from Node
static const int INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
var INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
local INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
- Protected Member Functions inherited from ControlButton
 ControlButton ()
virtual ~ControlButton ()
virtual bool init ()
virtual bool initWithLabelAndBackgroundSprite (Node *label, Scale9Sprite *backgroundSprite)
virtual bool initWithBackgroundSprite (Scale9Sprite *sprite)
var initWithBackgroundSprite ( var sprite)
local initWithBackgroundSprite ( local sprite)
virtual bool initWithTitleAndFontNameAndFontSize (const std::string &title, const std::string &fontName, float fontSize)
var initWithTitleAndFontNameAndFontSize ( var title, var fontName, var fontSize)
local initWithTitleAndFontNameAndFontSize ( local title, local fontName, local fontSize)
- Protected Member Functions inherited from IMEDelegate
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 IMEDispatcher. 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 IMEDispatcher. More...
 
virtual void insertText (const char *text, int len)
 Called by IMEDispatcher when text input received from the IME. More...
 
virtual void deleteBackward ()
 Called by IMEDispatcher after the user clicks the backward key. More...
 
virtual const std::string & getContentText ()
 Called by IMEDispatcher for text stored in delegate. More...
 
 IMEDelegate ()

Detailed Description

Class for edit box.

You can use this widget to gather small amounts of text from the user.

Member Enumeration Documentation

enum InputFlag
strong

The EditBox::InputFlag defines how the input text is displayed/formatted.

Enumerator
PASSWORD 

Indicates that the text entered is confidential data that should be obscured whenever possible.

This implies EDIT_BOX_INPUT_FLAG_SENSITIVE.

SENSITIVE 

Indicates that the text entered is sensitive data that the implementation must never store into a dictionary or table for use in predictive, auto-completing, or other accelerated input schemes.

A credit card number is an example of sensitive data.

INITIAL_CAPS_WORD 

This flag is a hint to the implementation that during text editing, the initial letter of each word should be capitalized.

INITIAL_CAPS_SENTENCE 

This flag is a hint to the implementation that during text editing, the initial letter of each sentence should be capitalized.

INTIAL_CAPS_ALL_CHARACTERS 

Capitalize all characters automatically.

enum InputMode
strong

The EditBox::InputMode defines the type of text that the user is allowed to enter.

Enumerator
ANY 

The user is allowed to enter any text, including line breaks.

EMAIL_ADDRESS 

The user is allowed to enter an e-mail address.

NUMERIC 

The user is allowed to enter an integer value.

PHONE_NUMBER 

The user is allowed to enter a phone number.

URL 

The user is allowed to enter a URL.

DECIMAL 

The user is allowed to enter a real number value.

This extends kEditBoxInputModeNumeric by allowing a decimal point.

SINGLE_LINE 

The user is allowed to enter any text, except for line breaks.

enum KeyboardReturnType
strong
Enumerator
DEFAULT 
DONE 
SEND 
SEARCH 
GO 

Constructor & Destructor Documentation

EditBox ( void  )

Constructor.

virtual ~EditBox ( void  )
virtual

Destructor.

Member Function Documentation

static EditBox* create ( const Size size,
Scale9Sprite pNormal9SpriteBg,
Scale9Sprite pPressed9SpriteBg = NULL,
Scale9Sprite pDisabled9SpriteBg = NULL 
)
static

create a edit box with size.

Returns
An autorelease pointer of EditBox, you don't need to release it only if you retain it again.
EditBoxDelegate* 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 Size size,
Scale9Sprite pNormal9SpriteBg 
)

Init edit box with specified size.

This method should be invoked right after constructor.

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

Reimplemented from IMEDelegate.

virtual void keyboardDidShow ( IMEKeyboardNotificationInfo info)
overridevirtual

Reimplemented from IMEDelegate.

virtual void keyboardWillHide ( IMEKeyboardNotificationInfo info)
overridevirtual

Reimplemented from IMEDelegate.

virtual void keyboardWillShow ( IMEKeyboardNotificationInfo info)
overridevirtual

Reimplemented from IMEDelegate.

virtual void onEnter ( void  )
overridevirtual

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

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

Reimplemented from Node.

virtual void onExit ( void  )
overridevirtual

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

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

Reimplemented from Node.

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 = EditBox:create(Size(...), Scale9Sprite:create(...))
editbox = registerScriptEditBoxHandler(editboxEventHandler)
Parameters
handlerA number that indicates a lua function.
virtual void setAnchorPoint ( const Point anchorPoint)
overridevirtual

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

virtual void setContentSize ( const Size contentSize)
overridevirtual

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

void setDelegate ( EditBoxDelegate 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 Color3B 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 ( InputFlag  inputFlag)

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

Parameters
inputFlagOne of the EditBox::InputFlag constants.
void setInputMode ( InputMode  inputMode)

Set the input mode of the edit box.

Parameters
inputModeOne of the EditBox::InputMode 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 Color3B 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 Point position)
overridevirtual

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

Usually we use Point(x,y) to compose Point 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( Point(size.width/2, size.height/2) )
Parameters
positionThe position (x,y) of the node in OpenGL coordinates

Reimplemented from Node.

void setReturnType ( EditBox::KeyboardReturnType  returnType)

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

Parameters
returnTypeOne of the EditBox::KeyboardReturnType constants.
void setText ( const char *  pText)

Set the text entered in the edit box.

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

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

void touchDownAction ( Object sender,
Control::EventType  controlEvent 
)
void unregisterScriptEditBoxHandler ( void  )

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

virtual void visit ( void  )
overridevirtual

Visits this node's children and draw them recursively.

Reimplemented from Node.

Member Data Documentation

float _adjustHeight
protected
Color3B _colPlaceHolder
protected
Color3B _colText
protected
EditBoxDelegate* _delegate
protected
EditBoxImpl* _editBoxImpl
protected
InputFlag _editBoxInputFlag
protected
InputMode _editBoxInputMode
protected
std::string _fontName
protected
int _fontSize
protected
EditBox::KeyboardReturnType
_keyboardReturnType
protected
int _maxLength
protected
std::string _placeHolder
protected
std::string _placeholderFontName
protected
int _placeholderFontSize
protected
int _scriptEditBoxHandler
protected
std::string _text
protected

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