A widget which allows users to input text. More...

Inherits Widget.

Public Types
enum	EventType
	TextField event type.

typedef std::function< void(Ref *, EventType)>	ccTextFieldCallback
	A callback which would be called when a TextField event happens.

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
	TextField ()
	Default constructor.

virtual	~TextField ()
	Default destructor.

void	setTouchSize (const Size &size)
	Set the touch size The touch size is used for. More...

Size	getTouchSize () const
	Get current touch size of TextField. More...

void	setTouchAreaEnabled (bool enable)
	Toggle enable touch area. More...

virtual bool	hitTest (const Vec2 &pt, const Camera camera, Vec3 p) const override
	Checks a point is in widget's content space. More...

void	setPlaceHolder (const std::string &value)
	Set placeholder of TextField. More...

const std::string &	getPlaceHolder () const
	Get the placeholder of TextField. More...

const Color4B &	getPlaceHolderColor () const
	Query the placeholder string color. More...

void	setPlaceHolderColor (const Color3B &color)
	Change the placeholder color. More...

void	setPlaceHolderColor (const Color4B &color)
	Change the placeholder color. More...

const Color4B &	getTextColor () const
	Query the text string color. More...

void	setTextColor (const Color4B &textColor)
	Change the text color. More...

void	setFontSize (int size)
	Change font size of TextField. More...

int	getFontSize () const
	Query the font size. More...

void	setFontName (const std::string &name)
	Change the font name of TextField. More...

const std::string &	getFontName () const
	Query the TextField's font name. More...

virtual void	didNotSelectSelf ()
	Detach the IME.

void	setString (const std::string &text)
	Change content of TextField. More...

const std::string &	getString () const
	Query the content of TextField. More...

virtual bool	onTouchBegan (Touch touch, Event unusedEvent) override
	A callback which will be called when touch began event is issued. More...

void	setMaxLengthEnabled (bool enable)
	Toggle maximize length enable. More...

bool	isMaxLengthEnabled () const
	Query whether max length is enabled or not. More...

void	setMaxLength (int length)
	Change maximize input length limitation. More...

int	getMaxLength () const
	Query maximize input length of TextField. More...

int	getStringLength () const
	Query the input string length. More...

void	setPasswordEnabled (bool enable)
	Toggle enable password input mode. More...

bool	isPasswordEnabled () const
	Query whether password is enabled or not. More...

void	setPasswordStyleText (const char *styleText)
	Change password style text. More...

const char *	getPasswordStyleText () const
	Query the password style text. More...

virtual void	update (float dt) override
	Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More...

bool	getAttachWithIME () const
	Query whether the IME is attached or not. More...

void	setAttachWithIME (bool attach)
	Toggle attach with IME. More...

bool	getDetachWithIME () const
	Query whether IME is detached or not. More...

void	setDetachWithIME (bool detach)
	Toggle detach with IME. More...

bool	getInsertText () const
	Whether it is ready to get the inserted text or not. More...

void	setInsertText (bool insertText)
	Toggle enable insert text mode. More...

bool	getDeleteBackward () const
	Whether it is ready to delete backward in TextField. More...

void	setDeleteBackward (bool deleteBackward)
	Toggle enable delete backward mode. More...

void	addEventListener (const ccTextFieldCallback &callback)
	Add a event listener to TextField, when some predefined event happens, the callback will be called. More...

virtual std::string	getDescription () const override
	Returns the "class name" of widget.

virtual Size	getAutoRenderSize ()
	Get the renderer size in auto mode. More...

virtual Size	getVirtualRendererSize () const override
	Get the virtual renderer's size. More...

virtual Node *	getVirtualRenderer () override
	Gets the inner Renderer node of widget. More...

virtual void	onEnter () override
	@lua NA

void	attachWithIME ()
	Attach the IME for inputing.

void	setTextAreaSize (const Size &size)
	Change the text area size. More...

void	setTextHorizontalAlignment (TextHAlignment alignment)
	Change horizontal text alignment. More...

TextHAlignment	getTextHorizontalAlignment () const
	Inquire the horizontal alignment. More...

void	setTextVerticalAlignment (TextVAlignment alignment)
	Change the vertical text alignment. More...

TextVAlignment	getTextVerticalAlignment () const
	Inquire the horizontal alignment. More...

void	setCursorEnabled (bool enabled)
	Set enable cursor use. More...

void	setCursorChar (char cursor)
	Set char showing cursor. More...

void	setCursorPosition (std::size_t cursorPosition)
	Set cursor position, if enabled @js NA.

void	setCursorFromPoint (const Vec2 &point, const Camera *camera)
	Set cursor position to hit letter, if enabled @js 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...

virtual void	setPosition (const Vec2 &pos) override
	Changes the position (x,y) of the widget in OpenGL coordinates. More...

void	setPositionPercent (const Vec2 &percent)
	Set the percent(x,y) of the widget in OpenGL coordinates. More...

const Vec2 &	getPositionPercent ()
	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 Vec2 &	getTouchBeganPosition () const
	Gets the touch began point of widget when widget is selected. More...

virtual void	setContentSize (const Size &contentSize) override
	Changes the size that is widget's size. 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 Vec2 &	getSizePercent ()
	Get size percent of widget. 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...

LayoutParameter *	getLayoutParameter () 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...

Widget *	clone ()
	Create a new widget copy of the original one. More...

virtual void	onExit () override
	@lua NA

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 Widget *	findNextFocusedWidget (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 Node *	getProtectedChildByTag (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 void	draw (Renderer *renderer, const Mat4 &transform, uint32_t flags)
	Override this method to draw your own node. More...

virtual Scene *	getScene () 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 EventDispatcher *	getEventDispatcher () 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 Color3B &	getColor () const
	Query node's color value. More...

virtual const Color3B &	getDisplayedColor () 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 Vec2 &	getPosition () const
	Gets the position (x,y) of the node in its parent's coordinate system. More...

virtual const Vec2 &	getPositionNormalized () const
	Returns the normalized position. More...

virtual const Vec2 &	getNormalizedPosition () 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 void	setAnchorPoint (const Vec2 &anchorPoint)
	Sets the anchor point in percent. More...

virtual const Vec2 &	getAnchorPoint () const
	Returns the anchor point in percent. More...

virtual const Vec2 &	getAnchorPointInPoints () const
	Returns the anchorPoint in absolute pixels. More...

virtual const Size &	getContentSize () const
	Returns the untransformed size of the node. More...

virtual void	setVisible (bool visible)
	Sets whether the node is visible. More...

virtual bool	isVisible () const
	Determines if the node is visible. More...

virtual void	setRotation (float rotation)
	Sets the rotation (angle) of the node in degrees. More...

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 Ref *	getUserObject ()
	Returns a user assigned Object. More...

virtual const Ref *	getUserObject () 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 ActionManager *	getActionManager ()
	Gets the ActionManager object that is used by all actions. More...

virtual const ActionManager *	getActionManager () const

virtual Action *	runAction (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...

Action *	getActionByTag (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 Scheduler *	getScheduler ()
	Gets a Scheduler object. More...

virtual const Scheduler *	getScheduler () 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	updateTransform ()
	Calls children's updateTransform() method recursively. More...

virtual const Mat4 &	getNodeToParentTransform () 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 Mat4 &	getParentToNodeTransform () 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 Node *	getChildByTag (int tag) const
	Gets a child from the container with its tag. More...

template<typename T >
T	getChildByTag (int tag) const
	Gets a child from the container with its tag that can be cast to Type T. More...

virtual Node *	getChildByName (const std::string &name) const
	Gets a child from the container with its name. More...

template<typename T >
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 Node *	getParent ()
	Returns a pointer to the parent node. More...

virtual const Node *	getParent () 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...

Ref *	autorelease ()
	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.

Static Public Member Functions
static TextField *	create ()
	Create an empty TextField. More...

static TextField *	create (const std::string &placeholder, const std::string &fontName, int fontSize)
	Create a TextField with a placeholder, a font name and a font size. More...

Static Public Member Functions inherited from Widget
static Widget *	create ()
	Create and return a empty Widget instance pointer.

static Widget *	getCurrentFocusedWidget ()
	Return a current focused widget in your UI scene. More...

Static Public Member Functions inherited from ProtectedNode
static ProtectedNode *	create ()
	Creates a ProtectedNode with no argument. More...

Static Public Member Functions inherited from Node
static Node *	create ()
	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

A widget which allows users to input text.

The rendering of the input text are based on

See also: ‘TextFieldTTF’. If you want to use system control behavior, please use; EditBox instead. @js NA @lua NA

Member Function Documentation

◆ create() [1/2]

static TextField* create ( )

static

Create an empty TextField.

Returns: A TextField instance.

◆ create() [2/2]

static TextField* create	(	const std::string &	placeholder,
		const std::string &	fontName,
		int	fontSize
	)

static

Create a TextField with a placeholder, a font name and a font size.

Parameters

placeholder	The placeholder string.
fontName	The font name.
fontSize	The font size.

Returns: A TextField instance.

◆ setTouchSize()

void setTouchSize ( const Size & size )

Set the touch size The touch size is used for.

See also: hitTest.

Parameters

size	A delimitation zone.

◆ getTouchSize()

Size getTouchSize ( ) const

Get current touch size of TextField.

Returns: The TextField's touch size.

◆ setTouchAreaEnabled()

void setTouchAreaEnabled ( bool enable )

Toggle enable touch area.

Parameters

enable True if enable touch area, false otherwise.

◆ hitTest()

virtual bool hitTest	(	const Vec2 &	pt,
		const Camera *	camera,
		Vec3 *	p
	)		const

overridevirtual

Checks a point is in widget's content space.

This function is used for determining touch area of widget.

Parameters

pt	The point in `Vec2`.
camera	The camera look at widget, used to convert GL screen point to near/far plane.
p	Point to a Vec3 for store the intersect point, if don't need them set to nullptr.

Returns: true if the point is in widget's content space, false otherwise.

Reimplemented from Widget.

◆ setPlaceHolder()

void setPlaceHolder ( const std::string & value )

Set placeholder of TextField.

Parameters

value The string value of placeholder.

◆ getPlaceHolder()

const std::string& getPlaceHolder ( ) const

Get the placeholder of TextField.

Returns: A placeholder string.

◆ getPlaceHolderColor()

const Color4B& getPlaceHolderColor ( ) const

Query the placeholder string color.

Returns: The color of placeholder.

◆ setPlaceHolderColor() [1/2]

void setPlaceHolderColor ( const Color3B & color )

Change the placeholder color.

Parameters

color A color value in Color3B.

◆ setPlaceHolderColor() [2/2]

void setPlaceHolderColor ( const Color4B & color )

Change the placeholder color.

Parameters

color A color value in Color4B.

◆ getTextColor()

const Color4B& getTextColor ( ) const

Query the text string color.

Returns: The color of the text.

◆ setTextColor()

void setTextColor ( const Color4B & textColor )

Change the text color.

Parameters

textColor The color value in Color4B.

◆ setFontSize()

void setFontSize ( int size )

Change font size of TextField.

Parameters

size	The integer font size.

◆ getFontSize()

int getFontSize ( ) const

Query the font size.

Returns: The integer font size.

◆ setFontName()

void setFontName ( const std::string & name )

Change the font name of TextField.

Parameters

name	The font name string.

◆ getFontName()

const std::string& getFontName ( ) const

Query the TextField's font name.

Returns: The font name string.

◆ setString()

void setString ( const std::string & text )

Change content of TextField.

Parameters

text	A string content.

◆ getString()

const std::string& getString ( ) const

Query the content of TextField.

Returns: The string value of TextField.

◆ onTouchBegan()

virtual bool onTouchBegan	(	Touch *	touch,
		Event *	unusedEvent
	)

overridevirtual

A callback which will be called when touch began event is issued.

Parameters

touch	The touch info.
unusedEvent	The touch event info.

Returns: True if user want to handle touches, false otherwise.

Reimplemented from Widget.

◆ setMaxLengthEnabled()

void setMaxLengthEnabled ( bool enable )

Toggle maximize length enable.

Parameters

enable True if enable maximize length, false otherwise.

◆ isMaxLengthEnabled()

bool isMaxLengthEnabled ( ) const

Query whether max length is enabled or not.

Returns: True if maximize length is enabled, false otherwise.

◆ setMaxLength()

void setMaxLength ( int length )

Change maximize input length limitation.

Parameters

length A character count in integer.

◆ getMaxLength()

int getMaxLength ( ) const

Query maximize input length of TextField.

Returns: The integer value of maximize input length.

◆ getStringLength()

int getStringLength ( ) const

Query the input string length.

Returns: A integer length value.

◆ setPasswordEnabled()

void setPasswordEnabled ( bool enable )

Toggle enable password input mode.

Parameters

enable True if enable password input mode, false otherwise.

◆ isPasswordEnabled()

bool isPasswordEnabled ( ) const

Query whether password is enabled or not.

Returns: True if password is enabled, false otherwise.

◆ setPasswordStyleText()

void setPasswordStyleText ( const char * styleText )

Change password style text.

Parameters

styleText The styleText for password mask, the default value is "*".

◆ getPasswordStyleText()

const char* getPasswordStyleText ( ) const

Query the password style text.

Returns: A password style text.

◆ update()

virtual void update ( float delta )

overridevirtual

Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".

Parameters

delta In seconds.

Reimplemented from Node.

◆ getAttachWithIME()

bool getAttachWithIME ( ) const

Query whether the IME is attached or not.

Returns: True if IME is attached, false otherwise.

◆ setAttachWithIME()

void setAttachWithIME ( bool attach )

Toggle attach with IME.

Parameters

attach True if attach with IME, false otherwise.

◆ getDetachWithIME()

bool getDetachWithIME ( ) const

Query whether IME is detached or not.

Returns: True if IME is detached, false otherwise.

◆ setDetachWithIME()

void setDetachWithIME ( bool detach )

Toggle detach with IME.

Parameters

detach True if detach with IME, false otherwise.

◆ getInsertText()

bool getInsertText ( ) const

Whether it is ready to get the inserted text or not.

Returns: True if the insert text is ready, false otherwise.

◆ setInsertText()

void setInsertText ( bool insertText )

Toggle enable insert text mode.

Parameters

insertText True if enable insert text, false otherwise.

◆ getDeleteBackward()

bool getDeleteBackward ( ) const

Whether it is ready to delete backward in TextField.

Returns: True is the delete backward is enabled, false otherwise.

◆ setDeleteBackward()

void setDeleteBackward ( bool deleteBackward )

Toggle enable delete backward mode.

Parameters

deleteBackward True is delete backward is enabled, false otherwise.

◆ addEventListener()

void addEventListener ( const ccTextFieldCallback & callback )

Add a event listener to TextField, when some predefined event happens, the callback will be called.

Parameters

callback A callback function with type of ccTextFieldCallback.

◆ getAutoRenderSize()

virtual Size getAutoRenderSize ( )

virtual

Get the renderer size in auto mode.

Returns: A delimitation zone.

◆ getVirtualRendererSize()

virtual Size getVirtualRendererSize ( ) const

overridevirtual

Get the virtual renderer's size.

Returns: Widget virtual renderer size.

Reimplemented from Widget.

◆ getVirtualRenderer()

virtual Node* getVirtualRenderer ( )

overridevirtual

Gets the inner Renderer node of widget.

For example, a button's Virtual Renderer is it's texture renderer.

Returns: Node pointer.

Reimplemented from Widget.

◆ setTextAreaSize()

void setTextAreaSize ( const Size & size )

Change the text area size.

Parameters

size	A delimitation zone.

◆ setTextHorizontalAlignment()

void setTextHorizontalAlignment ( TextHAlignment alignment )

Change horizontal text alignment.

Parameters

alignment A alignment arguments in

See also: TextHAlignment.

◆ getTextHorizontalAlignment()

TextHAlignment getTextHorizontalAlignment ( ) const

Inquire the horizontal alignment.

Returns: The horizontal alignment

◆ setTextVerticalAlignment()

void setTextVerticalAlignment ( TextVAlignment alignment )

Change the vertical text alignment.

Parameters

alignment A alignment arguments in

See also: TextVAlignment.

◆ getTextVerticalAlignment()

TextVAlignment getTextVerticalAlignment ( ) const

Inquire the horizontal alignment.

Returns: The horizontal alignment

◆ setCursorEnabled()

void setCursorEnabled ( bool enabled )

Set enable cursor use.

@js NA

◆ setCursorChar()

void setCursorChar ( char cursor )

Set char showing cursor.

@js NA

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

UITextField.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create() [1/2]

◆ create() [2/2]

◆ setTouchSize()

◆ getTouchSize()

◆ setTouchAreaEnabled()

◆ hitTest()

◆ setPlaceHolder()

◆ getPlaceHolder()

◆ getPlaceHolderColor()

◆ setPlaceHolderColor() [1/2]

◆ setPlaceHolderColor() [2/2]

◆ getTextColor()

◆ setTextColor()

◆ setFontSize()

◆ getFontSize()

◆ setFontName()

◆ getFontName()

◆ setString()

◆ getString()

◆ onTouchBegan()

◆ setMaxLengthEnabled()

◆ isMaxLengthEnabled()

◆ setMaxLength()

◆ getMaxLength()

◆ getStringLength()

◆ setPasswordEnabled()

◆ isPasswordEnabled()

◆ setPasswordStyleText()

◆ getPasswordStyleText()

◆ update()

◆ getAttachWithIME()

◆ setAttachWithIME()

◆ getDetachWithIME()

◆ setDetachWithIME()

◆ getInsertText()

◆ setInsertText()

◆ getDeleteBackward()

◆ setDeleteBackward()

◆ addEventListener()

◆ getAutoRenderSize()

◆ getVirtualRendererSize()

◆ getVirtualRenderer()

◆ setTextAreaSize()

◆ setTextHorizontalAlignment()

◆ getTextHorizontalAlignment()

◆ setTextVerticalAlignment()

◆ getTextVerticalAlignment()

◆ setCursorEnabled()

◆ setCursorChar()