Cocos2d-x  v4
EditBox Class Reference

Class for edit box. More...

Inherits Widget, and IMEDelegate.

Public Types

enum  KeyboardReturnType
 The popup keyboard return type.
 
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,
  INITIAL_CAPS_ALL_CHARACTERS, LOWERCASE_ALL_CHARACTERS
}
 The EditBox::InputFlag defines how the input text is displayed/formatted. More...
 
- Public Types inherited from Widget
enum  FocusDirection
 Widget focus direction.
 
enum  PositionType
 Widget position type for layout.
 
enum  SizeType
 Widget size type for layout.
 
enum  TouchEventType
 Touch event type.
 
enum  TextureResType
 Texture resource type. More...
 
enum  BrightStyle
 Widget bright style.
 
typedef std::function< void(Ref *, Widget::TouchEventType)> ccWidgetTouchCallback
 Widget touch event callback.
 
typedef std::function< void(Ref *)> ccWidgetClickCallback
 Widget click event callback.
 
typedef std::function< void(Ref *, int)> ccWidgetEventCallback
 Widget custom event callback. More...
 

Public Member Functions

 EditBox ()
 Constructor. More...
 
virtual ~EditBox ()
 Destructor. More...
 
bool initWithSizeAndBackgroundSprite (const Size &size, const std::string &normal9SpriteBg, TextureResType texType=TextureResType::LOCAL)
 Init edit box with specified size. More...
 
bool initWithSizeAndBackgroundSprite (const Size &size, Scale9Sprite *normal9SpriteBg)
 Init edit box with specified size. More...
 
bool initWithSizeAndBackgroundSprite (const Size &size, Scale9Sprite *normalSprite, Scale9Sprite *pressedSprite, Scale9Sprite *disabledSprite)
 Init edit box with specified size. More...
 
bool initWithSizeAndTexture (const Size &size, const std::string &normalImage, const std::string &pressedImage="", const std::string &disabledImage="", TextureResType texType=TextureResType::LOCAL)
 Init edit box with specified size. More...
 
void loadTextures (const std::string &normal, const std::string &pressed, const std::string &disabled="", TextureResType texType=TextureResType::LOCAL)
 Load textures for edit box. More...
 
void loadTextureNormal (const std::string &normal, TextureResType texType=TextureResType::LOCAL)
 Load normal state texture for edit box. More...
 
void loadTexturePressed (const std::string &pressed, TextureResType texType=TextureResType::LOCAL)
 Load pressed state texture for edit box. More...
 
void loadTextureDisabled (const std::string &disabled, TextureResType texType=TextureResType::LOCAL)
 Load disabled state texture for edit box. More...
 
void setCapInsets (const Rect &capInsets)
 Sets capInsets for edit box. More...
 
void setCapInsetsNormalRenderer (const Rect &capInsets)
 Sets capInsets for edit box, only the normal state scale9 renderer will be affected. More...
 
const RectgetCapInsetsNormalRenderer () const
 Return the capInsets of normal state scale9sprite. More...
 
void setCapInsetsPressedRenderer (const Rect &capInsets)
 Sets capInsets for edit box, only the pressed state scale9 renderer will be affected. More...
 
const RectgetCapInsetsPressedRenderer () const
 Return the capInsets of pressed state scale9sprite. More...
 
void setCapInsetsDisabledRenderer (const Rect &capInsets)
 Sets capInsets for edit box, only the disabled state scale9 renderer will be affected. More...
 
const RectgetCapInsetsDisabledRenderer () const
 Return the capInsets of disabled state scale9sprite. More...
 
void setDelegate (EditBoxDelegate *delegate)
 Gets/Sets the delegate for edit box. More...
 
EditBoxDelegategetDelegate ()
 @js NA @lua NA
 
void registerScriptEditBoxHandler (int handler)
 Registers a script function that will be called for EditBox events. More...
 
void unregisterScriptEditBoxHandler ()
 Unregisters a script function that will be called for EditBox events. More...
 
int getScriptEditBoxHandler ()
 get a script Handler @js NA @lua NA
 
void setText (const char *pText)
 Set the text entered in the edit box. More...
 
const char * getText () const
 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...
 
const char * getFontName () const
 Get the font name. More...
 
void setFontSize (int fontSize)
 Set the font size. More...
 
int getFontSize () const
 Get the font size. More...
 
void setFontColor (const Color3B &color)
 Set the font color of the widget's text.
 
const Color4BgetFontColor () const
 Get the font color of the widget's text.
 
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...
 
const char * getPlaceholderFontName () const
 Get the placeholder's font name. More...
 
void setPlaceholderFontSize (int fontSize)
 Set the placeholder's font size. More...
 
int getPlaceholderFontSize () const
 Get 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.
 
void setPlaceholderFontColor (const Color4B &color)
 Set the font color of the placeholder text when the edit box is empty.
 
const Color4BgetPlaceholderFontColor () const
 Get the font color of the placeholder text when the edit box is empty.
 
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 () const
 Get a text in the edit box that acts as a placeholder when an edit box is empty.
 
void setInputMode (InputMode inputMode)
 Set the input mode of the edit box. More...
 
InputMode getInputMode () const
 Get 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...
 
InputFlag getInputFlag () const
 Get 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...
 
KeyboardReturnType getReturnType () const
 Get the return type that are to be applied to the edit box. More...
 
void setTextHorizontalAlignment (TextHAlignment alignment)
 Set the text horizontal alignment.
 
TextHAlignment getTextHorizontalAlignment () const
 Get the text horizontal alignment.
 
virtual void setPosition (const Vec2 &pos) override
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
virtual void setVisible (bool visible) override
 Sets whether the node is visible. More...
 
virtual void setContentSize (const Size &size) override
 Changes the size that is widget's size. More...
 
virtual void setAnchorPoint (const Vec2 &anchorPoint) override
 Sets the anchor point in percent. More...
 
virtual std::string getDescription () const override
 Returns the "class name" of widget.
 
virtual void draw (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags) override
 @js NA @lua NA
 
virtual void onEnter () override
 @js NA @lua NA
 
virtual void onExit () override
 @js NA @lua NA
 
virtual void keyboardWillShow (IMEKeyboardNotificationInfo &info) override
 @js NA @lua NA
 
virtual void keyboardDidShow (IMEKeyboardNotificationInfo &info) override
 @js NA @lua NA
 
virtual void keyboardWillHide (IMEKeyboardNotificationInfo &info) override
 @js NA @lua NA
 
virtual void keyboardDidHide (IMEKeyboardNotificationInfo &info) override
 @js NA @lua NA
 
- Public Member Functions inherited from Widget
 Widget ()
 Default constructor @js ctor @lua new.
 
virtual ~Widget ()
 Default destructor @js NA @lua NA.
 
virtual void setEnabled (bool enabled)
 Sets whether the widget is enabled. More...
 
bool isEnabled () const
 Determines if the widget is enabled or not. More...
 
void setBright (bool bright)
 Sets whether the widget is bright. More...
 
bool isBright () const
 Determines if the widget is bright. More...
 
virtual void setTouchEnabled (bool enabled)
 Sets whether the widget is touch enabled. More...
 
void setBrightStyle (BrightStyle style)
 To set the bright style of widget. More...
 
bool isTouchEnabled () const
 Determines if the widget is touch enabled. More...
 
bool isHighlighted () const
 Determines if the widget is highlighted. More...
 
void setHighlighted (bool highlight)
 Sets whether the widget is highlighted. More...
 
float getLeftBoundary () const
 Gets the left boundary position of this widget in parent's coordination system. More...
 
float getBottomBoundary () const
 Gets the bottom boundary position of this widget in parent's coordination system. More...
 
float getRightBoundary () const
 Gets the right boundary position of this widget in parent's coordination system. More...
 
float getTopBoundary () const
 Gets the top boundary position of this widget in parent's coordination system. More...
 
virtual void visit (cocos2d::Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags) override
 @js NA
 
void addTouchEventListener (const ccWidgetTouchCallback &callback)
 Set a callback to touch vent listener. More...
 
void addClickEventListener (const ccWidgetClickCallback &callback)
 Set a click event handler to the widget. More...
 
virtual void addCCSEventListener (const ccWidgetEventCallback &callback)
 Set a event handler to the widget in order to use cocostudio editor and framework. More...
 
void setPositionPercent (const Vec2 &percent)
 Set the percent(x,y) of the widget in OpenGL coordinates. More...
 
const Vec2getPositionPercent ()
 Gets the percent (x,y) of the widget in OpenGL coordinates. More...
 
void setPositionType (PositionType type)
 Changes the position type of the widget. More...
 
PositionType getPositionType () const
 Gets the position type of the widget. More...
 
virtual void setFlippedX (bool flippedX)
 Sets whether the widget should be flipped horizontally or not. More...
 
virtual bool isFlippedX () const
 Returns the flag which indicates whether the widget is flipped horizontally or not. More...
 
virtual void setFlippedY (bool flippedY)
 Sets whether the widget should be flipped vertically or not. More...
 
virtual bool isFlippedY () const
 Return the flag which indicates whether the widget is flipped vertically or not. More...
 
virtual void setScaleX (float scaleX) override
 Sets the scale (x) of the node. More...
 
virtual void setScaleY (float scaleY) override
 Sets the scale (y) of the node. More...
 
virtual void setScale (float scale) override
 Sets the scale (x,y,z) of the node. More...
 
virtual void setScale (float scalex, float scaley) override
 Sets the scale (x,y) of the node. More...
 
virtual float getScaleX () const override
 Returns the scale factor on X axis of this node. More...
 
virtual float getScaleY () const override
 Returns the scale factor on Y axis of this node. More...
 
virtual float getScale () const override
 Gets the scale factor of the node, when X and Y have the same scale factor. More...
 
bool isClippingParentContainsPoint (const Vec2 &pt)
 Checks a point if in parent's area. More...
 
const Vec2getTouchBeganPosition () const
 Gets the touch began point of widget when widget is selected. More...
 
virtual void setSizePercent (const Vec2 &percent)
 Changes the percent that is widget's percent size. More...
 
void setSizeType (SizeType type)
 Changes the size type of widget. More...
 
SizeType getSizeType () const
 Gets the size type of widget. More...
 
const Size & getCustomSize () const
 Get the user defined widget size. More...
 
virtual const Size & getLayoutSize ()
 Get the content size of widget. More...
 
const Vec2getSizePercent ()
 Get size percent of widget. More...
 
virtual bool hitTest (const Vec2 &pt, const Camera *camera, Vec3 *p) const
 Checks a point is in widget's content space. More...
 
virtual bool onTouchBegan (Touch *touch, Event *unusedEvent)
 A callback which will be called when touch began event is issued. More...
 
virtual void onTouchMoved (Touch *touch, Event *unusedEvent)
 A callback which will be called when touch moved event is issued. More...
 
virtual void onTouchEnded (Touch *touch, Event *unusedEvent)
 A callback which will be called when touch ended event is issued. More...
 
virtual void onTouchCancelled (Touch *touch, Event *unusedEvent)
 A callback which will be called when touch cancelled event is issued. More...
 
void setLayoutParameter (LayoutParameter *parameter)
 Sets a LayoutParameter to widget. More...
 
LayoutParametergetLayoutParameter () const override
 Gets LayoutParameter of widget. More...
 
virtual void ignoreContentAdaptWithSize (bool ignore)
 Toggle whether ignore user defined content size for widget. More...
 
bool isIgnoreContentAdaptWithSize () const
 Query whether the widget ignores user defined content size or not. More...
 
Vec2 getWorldPosition () const
 Gets position of widget in world space. More...
 
virtual NodegetVirtualRenderer ()
 Gets the inner Renderer node of widget. More...
 
virtual Size getVirtualRendererSize () const
 Get the virtual renderer's size. More...
 
Widgetclone ()
 Create a new widget copy of the original one. More...
 
void updateSizeAndPosition ()
 Update all children's contents size and position recursively. More...
 
void updateSizeAndPosition (const Size &parentSize)
 Update all children's contents size and position recursively.
 
void setActionTag (int tag)
 Set the tag of action. More...
 
int getActionTag () const
 Get the action tag. More...
 
void setPropagateTouchEvents (bool isPropagate)
 Allow widget touch events to propagate to its parents. More...
 
bool isPropagateTouchEvents () const
 Return whether the widget is propagate touch events to its parents or not. More...
 
void setSwallowTouches (bool swallow)
 Toggle widget swallow touch option. More...
 
bool isSwallowTouches () const
 Return whether the widget is swallowing touch or not. More...
 
bool isFocused () const
 Query whether widget is focused or not. More...
 
void setFocused (bool focus)
 Toggle widget focus status. More...
 
bool isFocusEnabled () const
 Query widget's focus enable state. More...
 
void setFocusEnabled (bool enable)
 Allow widget to accept focus. More...
 
virtual WidgetfindNextFocusedWidget (FocusDirection direction, Widget *current)
 When a widget is in a layout, you could call this method to get the next focused widget within a specified direction. More...
 
void requestFocus ()
 when a widget calls this method, it will get focus immediately.
 
void setUnifySizeEnabled (bool enable)
 Toggle use unify size. More...
 
bool isUnifySizeEnabled () const
 Query whether unify size enable state. More...
 
void setCallbackName (const std::string &callbackName)
 Set callback name. More...
 
const std::string & getCallbackName () const
 Query callback name. More...
 
void setCallbackType (const std::string &callbackType)
 Set callback type. More...
 
const std::string & getCallbackType () const
 Query callback type. More...
 
void setLayoutComponentEnabled (bool enable)
 Toggle layout component enable. More...
 
bool isLayoutComponentEnabled () const
 Query whether layout component is enabled or not. More...
 
virtual void setScaleZ (float scaleZ)
 Changes the scale factor on Z axis of this node. More...
 
virtual float getScaleZ () const
 Returns the scale factor on Z axis of this node. More...
 
- Public Member Functions inherited from ProtectedNode
virtual void cleanup () override
 Stops all running actions and schedulers.
 
virtual void onEnterTransitionDidFinish () override
 Event callback that is invoked when the Node enters in the 'stage'. More...
 
virtual void onExitTransitionDidStart () override
 Event callback that is called every time the Node leaves the 'stage'. More...
 
virtual void updateDisplayedOpacity (uint8_t parentOpacity) override
 Update the displayed opacity of node with it's parent opacity;. More...
 
virtual void updateDisplayedColor (const Color3B &parentColor) override
 Update node's displayed color with its parent color. More...
 
virtual void setCameraMask (unsigned short mask, bool applyChildren=true) override
 Modify the camera mask for current node. More...
 
virtual void setGlobalZOrder (float globalZOrder) override
 Defines the order in which the nodes are renderer. More...
 
virtual void addProtectedChild (Node *child)
 Adds a child to the container with z-order as 0. More...
 
virtual void addProtectedChild (Node *child, int localZOrder)
 Adds a child to the container with a local z-order. More...
 
virtual void addProtectedChild (Node *child, int localZOrder, int tag)
 Adds a child to the container with z order and tag. More...
 
virtual NodegetProtectedChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
virtual void removeProtectedChild (Node *child, bool cleanup=true)
 Removes a child from the container. More...
 
virtual void removeProtectedChildByTag (int tag, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
virtual void removeAllProtectedChildren ()
 Removes all children from the container with a cleanup. More...
 
virtual void removeAllProtectedChildrenWithCleanup (bool cleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
virtual void reorderProtectedChild (Node *child, int localZOrder)
 Reorders a child according to a new z value. More...
 
virtual void sortAllProtectedChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
- Public Member Functions inherited from Node
virtual bool isRunning () const
 Returns whether or not the node is "running". More...
 
void scheduleUpdateWithPriorityLua (int handler, int priority)
 Schedules for lua script. More...
 
virtual ScenegetScene () const
 Returns the Scene that contains the Node. More...
 
virtual Rect getBoundingBox () const
 Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...
 
virtual void setEventDispatcher (EventDispatcher *dispatcher)
 Set event dispatcher for scene. More...
 
virtual EventDispatchergetEventDispatcher () const
 Get the event dispatcher of scene. More...
 
virtual uint8_t getOpacity () const
 Return the node's opacity. More...
 
virtual uint8_t getDisplayedOpacity () const
 Return the node's display opacity. More...
 
virtual void setOpacity (uint8_t opacity)
 Change node opacity. More...
 
virtual bool isCascadeOpacityEnabled () const
 Whether cascadeOpacity is enabled or not. More...
 
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
 Change node's cascadeOpacity property. More...
 
virtual const Color3BgetColor () const
 Query node's color value. More...
 
virtual const Color3BgetDisplayedColor () const
 Query node's displayed color. More...
 
virtual void setColor (const Color3B &color)
 Change the color of node. More...
 
virtual bool isCascadeColorEnabled () const
 Query whether cascadeColor is enabled or not. More...
 
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
 If you want node's color affect the children node's color, then set it to true. More...
 
virtual void setOpacityModifyRGB (bool value)
 If you want the opacity affect the color property, then set to true. More...
 
virtual bool isOpacityModifyRGB () const
 If node opacity will modify the RGB color value, then you should override this method and return true. More...
 
void setOnEnterCallback (const std::function< void()> &callback)
 Set the callback of event onEnter. More...
 
const std::function< void()> & getOnEnterCallback () const
 Get the callback of event onEnter. More...
 
void setOnExitCallback (const std::function< void()> &callback)
 Set the callback of event onExit. More...
 
const std::function< void()> & getOnExitCallback () const
 Get the callback of event onExit. More...
 
void setOnEnterTransitionDidFinishCallback (const std::function< void()> &callback)
 Set the callback of event EnterTransitionDidFinish. More...
 
const std::function< void()> & getOnEnterTransitionDidFinishCallback () const
 Get the callback of event EnterTransitionDidFinish. More...
 
void setOnExitTransitionDidStartCallback (const std::function< void()> &callback)
 Set the callback of event ExitTransitionDidStart. More...
 
const std::function< void()> & getOnExitTransitionDidStartCallback () const
 Get the callback of event ExitTransitionDidStart. More...
 
unsigned short getCameraMask () const
 get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true
 
virtual void setLocalZOrder (std::int32_t localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
virtual void _setLocalZOrder (std::int32_t z)
 
void updateOrderOfArrival ()
 !!! ONLY FOR INTERNAL USE Sets the arrival order when this node has a same ZOrder with other children. More...
 
virtual std::int32_t getLocalZOrder () const
 Gets the local Z order of this node. More...
 
virtual float getGlobalZOrder () const
 Returns the Node's Global Z Order. More...
 
virtual void setScaleZ (float scaleZ)
 Changes the scale factor on Z axis of this node. More...
 
virtual float getScaleZ () const
 Returns the scale factor on Z axis of this node. More...
 
virtual void setPositionNormalized (const Vec2 &position)
 Sets the position (x,y) using values between 0 and 1. More...
 
virtual void setNormalizedPosition (const Vec2 &position)
 
virtual const Vec2getPosition () const
 Gets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual const Vec2getPositionNormalized () const
 Returns the normalized position. More...
 
virtual const Vec2getNormalizedPosition () const
 
virtual void setPosition (float x, float y)
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual void getPosition (float *x, float *y) const
 Gets position in a more efficient way, returns two number instead of a Vec2 object. More...
 
virtual void setPositionX (float x)
 Gets/Sets x or y coordinate individually for position. More...
 
virtual float getPositionX () const
 Gets the x coordinate of the node in its parent's coordinate system. More...
 
virtual void setPositionY (float y)
 Sets the y coordinate of the node in its parent's coordinate system. More...
 
virtual float getPositionY () const
 Gets the y coordinate of the node in its parent's coordinate system. More...
 
virtual void setPosition3D (const Vec3 &position)
 Sets the position (X, Y, and Z) in its parent's coordinate system. More...
 
virtual Vec3 getPosition3D () const
 Returns the position (X,Y,Z) in its parent's coordinate system. More...
 
virtual void setPositionZ (float positionZ)
 Sets the 'z' coordinate in the position. More...
 
virtual float getPositionZ () const
 Gets position Z coordinate of this node. More...
 
virtual void setSkewX (float skewX)
 Changes the X skew angle of the node in degrees. More...
 
virtual float getSkewX () const
 Returns the X skew angle of the node in degrees. More...
 
virtual void setSkewY (float skewY)
 Changes the Y skew angle of the node in degrees. More...
 
virtual float getSkewY () const
 Returns the Y skew angle of the node in degrees. More...
 
virtual const Vec2getAnchorPoint () const
 Returns the anchor point in percent. More...
 
virtual const Vec2getAnchorPointInPoints () const
 Returns the anchorPoint in absolute pixels. More...
 
virtual const Size & getContentSize () 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...
 
virtual float getRotation () const
 Returns the rotation of the node in degrees. More...
 
virtual void setRotation3D (const Vec3 &rotation)
 Sets the rotation (X,Y,Z) in degrees. More...
 
virtual Vec3 getRotation3D () const
 Returns the rotation (X,Y,Z) in degrees. More...
 
virtual void setRotationQuat (const Quaternion &quat)
 Set rotation by quaternion. More...
 
virtual Quaternion getRotationQuat () const
 Return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, it equals to RotationY * RotationX otherwise. More...
 
virtual void setRotationSkewX (float rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual float getRotationSkewX () const
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
virtual void setRotationSkewY (float rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual float getRotationSkewY () const
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual void setIgnoreAnchorPointForPosition (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 int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
virtual void setTag (int tag)
 Changes the tag that is used to identify the node easily. More...
 
virtual const std::string & getName () const
 Returns a string that is used to identify the node. More...
 
virtual void setName (const std::string &name)
 Changes the name that is used to identify the node easily. More...
 
virtual void * getUserData ()
 Returns a custom user data pointer. More...
 
virtual const void * getUserData () const
 @lua NA
 
virtual void setUserData (void *userData)
 Sets a custom user data pointer. More...
 
virtual RefgetUserObject ()
 Returns a user assigned Object. More...
 
virtual const RefgetUserObject () const
 @lua NA
 
virtual void setUserObject (Ref *userObject)
 Returns a user assigned Object. 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
 
virtual ActionrunAction (Action *action)
 Executes an action, and returns the action that is executed. More...
 
void stopAllActions ()
 Stops and removes all actions from the running action list .
 
void stopAction (Action *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...
 
void stopAllActionsByTag (int tag)
 Removes all actions from the running action list by its tag. More...
 
void stopActionsByFlags (unsigned int flags)
 Removes all actions from the running action list by its flags. More...
 
ActiongetActionByTag (int tag)
 Gets an action from the running action list by its tag. More...
 
ssize_t getNumberOfRunningActions () const
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
ssize_t getNumberOfRunningActionsByTag (int tag) const
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays) with a specific tag. More...
 
virtual void setScheduler (Scheduler *scheduler)
 Sets a Scheduler object that is used to schedule all "updates" and timers. More...
 
virtual SchedulergetScheduler ()
 Gets a Scheduler object. More...
 
virtual const SchedulergetScheduler () const
 
bool isScheduled (SEL_SCHEDULE selector) const
 Checks whether a selector is scheduled. More...
 
bool isScheduled (const std::string &key) const
 Checks whether a lambda function is scheduled. More...
 
void scheduleUpdate ()
 Schedules the "update" method. More...
 
void scheduleUpdateWithPriority (int priority)
 Schedules the "update" method with a custom priority. More...
 
void 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 scheduleOnce (const std::function< void(float)> &callback, float delay, const std::string &key)
 Schedules a lambda function 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 schedule (const std::function< void(float)> &callback, const std::string &key)
 Schedules a lambda function. More...
 
void schedule (const std::function< void(float)> &callback, float interval, const std::string &key)
 Schedules a lambda function. More...
 
void schedule (const std::function< void(float)> &callback, float interval, unsigned int repeat, float delay, const std::string &key)
 Schedules a lambda function. More...
 
void unschedule (SEL_SCHEDULE selector)
 Unschedules a custom selector. More...
 
void unschedule (const std::string &key)
 Unschedules a lambda function. More...
 
void unscheduleAllCallbacks ()
 Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions. More...
 
virtual void resume ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
virtual void pause ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
virtual void update (float delta)
 Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More...
 
virtual void updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
virtual const Mat4getNodeToParentTransform () const
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual AffineTransform getNodeToParentAffineTransform () const
 
virtual Mat4 getNodeToParentTransform (Node *ancestor) const
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual AffineTransform getNodeToParentAffineTransform (Node *ancestor) const
 Returns the affine transform matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual void setNodeToParentTransform (const Mat4 &transform)
 Sets the transformation matrix manually. More...
 
virtual const Mat4getParentToNodeTransform () const
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
virtual AffineTransform getParentToNodeAffineTransform () const
 
virtual Mat4 getNodeToWorldTransform () const
 Returns the world affine transform matrix. More...
 
virtual AffineTransform getNodeToWorldAffineTransform () const
 
virtual Mat4 getWorldToNodeTransform () const
 Returns the inverse world affine transform matrix. More...
 
virtual AffineTransform getWorldToNodeAffineTransform () const
 
Vec2 convertToNodeSpace (const Vec2 &worldPoint) const
 Converts a Vec2 to node (local) space coordinates. More...
 
Vec2 convertToWorldSpace (const Vec2 &nodePoint) const
 Converts a Vec2 to world space coordinates. More...
 
Vec2 convertToNodeSpaceAR (const Vec2 &worldPoint) const
 Converts a Vec2 to node (local) space coordinates. More...
 
Vec2 convertToWorldSpaceAR (const Vec2 &nodePoint) const
 Converts a local Vec2 to world space coordinates.The result is in Points. More...
 
Vec2 convertTouchToNodeSpace (Touch *touch) const
 convenience methods which take a Touch instead of Vec2. More...
 
Vec2 convertTouchToNodeSpaceAR (Touch *touch) const
 converts a Touch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (const Mat4 *additionalTransform)
 Sets an additional transform matrix to the node. More...
 
void setAdditionalTransform (const Mat4 &additionalTransform)
 
void setAdditionalTransform (const AffineTransform &additionalTransform)
 
Component * getComponent (const std::string &name)
 Gets a component by its name. More...
 
virtual bool addComponent (Component *component)
 Adds a component. More...
 
virtual bool removeComponent (const std::string &name)
 Removes a component by its name. More...
 
virtual bool removeComponent (Component *component)
 Removes a component by its pointer. More...
 
virtual void removeAllComponents ()
 Removes all components.
 
virtual void addChild (Node *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...
 
virtual void addChild (Node *child, int localZOrder, int tag)
 Adds a child to the container with z order and tag. More...
 
virtual void addChild (Node *child, int localZOrder, const std::string &name)
 Adds a child to the container with z order and tag. More...
 
virtual NodegetChildByTag (int tag) const
 Gets a child from the container with its tag. More...
 
template<typename T >
getChildByTag (int tag) const
 Gets a child from the container with its tag that can be cast to Type T. More...
 
virtual NodegetChildByName (const std::string &name) const
 Gets a child from the container with its name. More...
 
template<typename T >
getChildByName (const std::string &name) const
 Gets a child from the container with its name that can be cast to Type T. More...
 
virtual void enumerateChildren (const std::string &name, std::function< bool(Node *node)> callback) const
 Search the children of the receiving node to perform processing for nodes which share a name. More...
 
virtual Vector< Node * > & getChildren ()
 Returns the array of the node's children. More...
 
virtual const Vector< Node * > & getChildren () const
 
virtual ssize_t getChildrenCount () const
 Returns the amount of children. More...
 
virtual void setParent (Node *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...
 
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 removeChildByName (const std::string &name, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
virtual void removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
virtual void removeAllChildrenWithCleanup (bool cleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
virtual 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...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor. More...
 
- Public Member Functions inherited from LayoutParameterProtocol
virtual ~LayoutParameterProtocol ()
 Default destructor.
 
- Public Member Functions inherited from IMEDelegate
virtual ~IMEDelegate ()
 Default constructor. More...
 
virtual bool attachWithIME ()
 Default destructor. More...
 
virtual bool detachWithIME ()
 Determine whether the IME is detached or not. More...
 

Static Public Member Functions

static EditBoxcreate (const Size &size, Scale9Sprite *normalSprite, Scale9Sprite *pressedSprite=nullptr, Scale9Sprite *disabledSprite=nullptr)
 create a edit box with size. More...
 
static EditBoxcreate (const Size &size, const std::string &normalImage, TextureResType texType)
 create a edit box with size. More...
 
static EditBoxcreate (const Size &size, const std::string &normalImage, const std::string &pressedImage="", const std::string &disabledImage="", TextureResType texType=TextureResType::LOCAL)
 create a edit box with size. More...
 
- Static Public Member Functions inherited from Widget
static Widgetcreate ()
 Create and return a empty Widget instance pointer.
 
static WidgetgetCurrentFocusedWidget ()
 Return a current focused widget in your UI scene. More...
 
- Static Public Member Functions inherited from ProtectedNode
static ProtectedNodecreate ()
 Creates a ProtectedNode with no argument. More...
 
- Static Public Member Functions inherited from Node
static Nodecreate ()
 Allocates and initializes a node. More...
 
static int getAttachedNodeCount ()
 Gets count of nodes those are attached to scene graph.
 
template<typename _T >
static void sortNodes (cocos2d::Vector< _T * > &nodes)
 Sorts helper function. More...
 

Additional Inherited Members

- Public Attributes inherited from Widget
std::function< void(Widget *, Widget *)> onFocusChanged
 When a widget lose/get focus, this method will be called. More...
 
std::function< Widget *(FocusDirection)> onNextFocusedWidget
 use this function to manually specify the next focused widget regards to each direction
 
- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
- Static Public Attributes inherited from Node
static const int INVALID_TAG = -1
 Default tag used for all the nodes.
 
- Protected Member Functions inherited from Widget
void propagateTouchEvent (TouchEventType event, Widget *sender, Touch *touch)
 Propagate touch events to its parents.
 
void onFocusChange (Widget *widgetLostFocus, Widget *widgetGetFocus)
 This method is called when a focus change event happens. More...
 
void dispatchFocusEvent (Widget *widgetLoseFocus, Widget *widgetGetFocus)
 Dispatch a EventFocus through a EventDispatcher. More...
 

Detailed Description

Class for edit box.

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

Member Enumeration Documentation

◆ InputMode

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.

◆ InputFlag

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.

INITIAL_CAPS_ALL_CHARACTERS 

Capitalize all characters automatically.

LOWERCASE_ALL_CHARACTERS 

Lowercase all characters automatically.

Constructor & Destructor Documentation

◆ EditBox()

EditBox ( )

Constructor.

@js ctor @lua new

◆ ~EditBox()

virtual ~EditBox ( )
virtual

Destructor.

@js NA @lua NA

Member Function Documentation

◆ create() [1/3]

static EditBox* create ( const Size &  size,
Scale9Sprite normalSprite,
Scale9Sprite pressedSprite = nullptr,
Scale9Sprite disabledSprite = nullptr 
)
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.

◆ create() [2/3]

static EditBox* create ( const Size &  size,
const std::string &  normalImage,
TextureResType  texType 
)
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.

◆ create() [3/3]

static EditBox* create ( const Size &  size,
const std::string &  normalImage,
const std::string &  pressedImage = "",
const std::string &  disabledImage = "",
TextureResType  texType = TextureResType::LOCAL 
)
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.

◆ initWithSizeAndBackgroundSprite() [1/3]

bool initWithSizeAndBackgroundSprite ( const Size &  size,
const std::string &  normal9SpriteBg,
TextureResType  texType = TextureResType::LOCAL 
)

Init edit box with specified size.

This method should be invoked right after constructor.

Parameters
sizeThe size of edit box.
normal9SpriteBgbackground image of edit box.
texTypethe resource type, the default value is TextureResType::LOCAL
Returns
Whether initialization is successfully or not.

◆ initWithSizeAndBackgroundSprite() [2/3]

bool initWithSizeAndBackgroundSprite ( const Size &  size,
Scale9Sprite normal9SpriteBg 
)

Init edit box with specified size.

This method should be invoked right after constructor.

Parameters
sizeThe size of edit box.
normal9SpriteBgbackground image of edit box.
Returns
Whether initialization is successfully or not.

◆ initWithSizeAndBackgroundSprite() [3/3]

bool initWithSizeAndBackgroundSprite ( const Size &  size,
Scale9Sprite normalSprite,
Scale9Sprite pressedSprite,
Scale9Sprite disabledSprite 
)

Init edit box with specified size.

This method should be invoked right after constructor.

Parameters
sizeThe size of edit box.
normalSpritenormal state image of edit box.
pressedSpritepressed state image of edit box.
disabledSpritedisabled state image of edit box.
Returns
Whether initialization is successfully or not.

◆ initWithSizeAndTexture()

bool initWithSizeAndTexture ( const Size &  size,
const std::string &  normalImage,
const std::string &  pressedImage = "",
const std::string &  disabledImage = "",
TextureResType  texType = TextureResType::LOCAL 
)

Init edit box with specified size.

This method should be invoked right after constructor.

Parameters
sizeThe size of edit box.
normalImagenormal state texture name.
pressedImagepressed state texture name.
disabledImagedisabled state texture name.
Returns
Whether initialization is successfully or not.

◆ loadTextures()

void loadTextures ( const std::string &  normal,
const std::string &  pressed,
const std::string &  disabled = "",
TextureResType  texType = TextureResType::LOCAL 
)

Load textures for edit box.

Parameters
normalnormal state texture name.
pressedpressed state texture name.
disableddisabled state texture name.
texType
See also
TextureResType

◆ loadTextureNormal()

void loadTextureNormal ( const std::string &  normal,
TextureResType  texType = TextureResType::LOCAL 
)

Load normal state texture for edit box.

Parameters
normalnormal state texture.
texType
See also
TextureResType

◆ loadTexturePressed()

void loadTexturePressed ( const std::string &  pressed,
TextureResType  texType = TextureResType::LOCAL 
)

Load pressed state texture for edit box.

Parameters
pressedpressed state texture.
texType
See also
TextureResType

◆ loadTextureDisabled()

void loadTextureDisabled ( const std::string &  disabled,
TextureResType  texType = TextureResType::LOCAL 
)

Load disabled state texture for edit box.

Parameters
disableddark state texture.
texType
See also
TextureResType

◆ setCapInsets()

void setCapInsets ( const Rect capInsets)

Sets capInsets for edit box.

Parameters
capInsetscapInset in Rect.

◆ setCapInsetsNormalRenderer()

void setCapInsetsNormalRenderer ( const Rect capInsets)

Sets capInsets for edit box, only the normal state scale9 renderer will be affected.

Parameters
capInsetscapInsets in Rect.

◆ getCapInsetsNormalRenderer()

const Rect& getCapInsetsNormalRenderer ( ) const

Return the capInsets of normal state scale9sprite.

Returns
The normal scale9 renderer capInsets.

◆ setCapInsetsPressedRenderer()

void setCapInsetsPressedRenderer ( const Rect capInsets)

Sets capInsets for edit box, only the pressed state scale9 renderer will be affected.

Parameters
capInsetscapInsets in Rect

◆ getCapInsetsPressedRenderer()

const Rect& getCapInsetsPressedRenderer ( ) const

Return the capInsets of pressed state scale9sprite.

Returns
The pressed scale9 renderer capInsets.

◆ setCapInsetsDisabledRenderer()

void setCapInsetsDisabledRenderer ( const Rect capInsets)

Sets capInsets for edit box, only the disabled state scale9 renderer will be affected.

Parameters
capInsetscapInsets in Rect.

◆ getCapInsetsDisabledRenderer()

const Rect& getCapInsetsDisabledRenderer ( ) const

Return the capInsets of disabled state scale9sprite.

Returns
The disabled scale9 renderer capInsets.

◆ setDelegate()

void setDelegate ( EditBoxDelegate delegate)

Gets/Sets the delegate for edit box.

@lua NA

◆ registerScriptEditBoxHandler()

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. @js NA @lua NA

◆ unregisterScriptEditBoxHandler()

void unregisterScriptEditBoxHandler ( )

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

@js NA @lua NA

◆ setText()

void setText ( const char *  pText)

Set the text entered in the edit box.

Parameters
pTextThe given text.

◆ getText()

const char* getText ( ) const

Get the text entered in the edit box.

Returns
The text entered in the edit box.

◆ setFont()

void setFont ( const char *  pFontName,
int  fontSize 
)

Set the font.

Only system font is allowed.

Parameters
pFontNameThe font name.
fontSizeThe font size.

◆ setFontName()

void setFontName ( const char *  pFontName)

Set the font name.

Only system font is allowed.

Parameters
pFontNameThe font name.

◆ getFontName()

const char* getFontName ( ) const

Get the font name.

Returns
The font name.

◆ setFontSize()

void setFontSize ( int  fontSize)

Set the font size.

Parameters
fontSizeThe font size.

◆ getFontSize()

int getFontSize ( ) const

Get the font size.

Returns
The font size.

◆ setPlaceholderFont()

void setPlaceholderFont ( const char *  pFontName,
int  fontSize 
)

Set the placeholder's font.

Only system font is allowed.

Parameters
pFontNameThe font name.
fontSizeThe font size.

◆ setPlaceholderFontName()

void setPlaceholderFontName ( const char *  pFontName)

Set the placeholder's font name.

only system font is allowed.

Parameters
pFontNameThe font name.

◆ getPlaceholderFontName()

const char* getPlaceholderFontName ( ) const

Get the placeholder's font name.

only system font is allowed.

Returns
The font name.

◆ setPlaceholderFontSize()

void setPlaceholderFontSize ( int  fontSize)

Set the placeholder's font size.

Parameters
fontSizeThe font size.

◆ getPlaceholderFontSize()

int getPlaceholderFontSize ( ) const

Get the placeholder's font size.

Returns
The font size.

◆ setPlaceHolder()

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.

◆ setInputMode()

void setInputMode ( InputMode  inputMode)

Set the input mode of the edit box.

Parameters
inputModeOne of the EditBox::InputMode constants.

◆ getInputMode()

InputMode getInputMode ( ) const

Get the input mode of the edit box.

Returns
One of the EditBox::InputMode constants.

◆ setMaxLength()

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.

◆ getMaxLength()

int getMaxLength ( )

Gets the maximum input length of the edit box.

Returns
Maximum input length.

◆ setInputFlag()

void setInputFlag ( InputFlag  inputFlag)

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

Parameters
inputFlagOne of the EditBox::InputFlag constants.

◆ getInputFlag()

InputFlag getInputFlag ( ) const

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

Returns
One of the EditBox::InputFlag constants.

◆ setReturnType()

void setReturnType ( KeyboardReturnType  returnType)

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

Parameters
returnTypeOne of the EditBox::KeyboardReturnType constants.

◆ getReturnType()

KeyboardReturnType getReturnType ( ) const

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

Returns
One of the EditBox::KeyboardReturnType constants.

◆ setPosition()

virtual void setPosition ( const Vec2 pos)
overridevirtual

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

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

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

Reimplemented from Widget.

◆ setVisible()

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.

◆ setContentSize()

virtual void setContentSize ( const Size &  contentSize)
overridevirtual

Changes the size that is widget's size.

Parameters
contentSizeA content size in Size.

Reimplemented from Widget.

◆ setAnchorPoint()

virtual void setAnchorPoint ( const Vec2 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,0), so it starts in the lower left corner of the node.

Note
If node has a physics body, the anchor must be in the middle, you can't change this to other value.
Parameters
anchorPointThe anchor point of node.

Reimplemented from Node.


The documentation for this class was generated from the following file:
cocos2d::ui::Widget::create
static Widget * create()
Create and return a empty Widget instance pointer.
cocos2d::ui::EditBox::EditBox
EditBox()
Constructor.
cocos2d::ui::EditBox::registerScriptEditBoxHandler
void registerScriptEditBoxHandler(int handler)
Registers a script function that will be called for EditBox events.