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

A simple text input field with TTF font. More...

#include <CCTextFieldTTF.h>

Inheritance diagram for TextFieldTTF:
LabelTTF IMEDelegate Sprite LabelProtocol NodeRGBA TextureProtocol Node RGBAProtocol BlendProtocol Object UICCTextField

Public Member Functions

 TextFieldTTF ()
virtual ~TextFieldTTF ()
bool initWithPlaceHolder (const char *placeholder, const Size &dimensions, TextHAlignment alignment, const char *fontName, float fontSize)
 initializes the TextFieldTTF with a font name, alignment, dimension and font size More...
 
bool initWithPlaceHolder (const char *placeholder, const char *fontName, float fontSize)
 initializes the TextFieldTTF with a font name and font size More...
 
virtual bool attachWithIME ()
 Open keyboard and receive input text. More...
 
virtual bool detachWithIME ()
 End text input and close keyboard. More...
 
TextFieldDelegategetDelegate () const
void setDelegate (TextFieldDelegate *delegate)
int getCharCount () const
virtual const Color3BgetColorSpaceHolder ()
virtual void setColorSpaceHolder (const Color3B &color)
virtual void setString (const char *text)
 changes the string to render More...
 
virtual const char * getString (void) const
 Returns the string that is currently being used in this label. More...
 
virtual void setPlaceHolder (const char *text)
virtual const char * getPlaceHolder (void)
virtual void setSecureTextEntry (bool value)
virtual bool isSecureTextEntry ()
- Public Member Functions inherited from LabelTTF
 LabelTTF ()
virtual ~LabelTTF ()
const char * description () const
bool initWithString (const char *string, const char *fontName, float fontSize)
 initializes the LabelTTF with a font name and font size More...
 
bool initWithString (const char *string, const char *fontName, float fontSize, const Size &dimensions, TextHAlignment hAlignment)
 initializes the LabelTTF with a font name, alignment, dimension and font size More...
 
local initWithString ( local string, local fontName, local fontSize, local dimensions, local hAlignment)
 initializes the LabelTTF with a font name, alignment, dimension and font size More...
 
bool initWithString (const char *string, const char *fontName, float fontSize, const Size &dimensions, TextHAlignment hAlignment, TextVAlignment vAlignment)
 initializes the LabelTTF with a font name, alignment, dimension and font size More...
 
local initWithString ( local string, local fontName, local fontSize, local dimensions, local hAlignment, local vAlignment)
 initializes the LabelTTF with a font name, alignment, dimension and font size More...
 
bool initWithStringAndTextDefinition (const char *string, FontDefinition &textDefinition)
 initializes the LabelTTF with a font name, alignment, dimension and font size More...
 
void setTextDefinition (const FontDefinition &theDefinition)
 set the text definition used by this label More...
 
FontDefinition getTextDefinition ()
 get the text definition used by this label More...
 
void enableShadow (const Size &shadowOffset, float shadowOpacity, float shadowBlur, bool mustUpdateTexture=true)
 enable or disable shadow for the label More...
 
void disableShadow (bool mustUpdateTexture=true)
 disable shadow rendering More...
 
void enableStroke (const Color3B &strokeColor, float strokeSize, bool mustUpdateTexture=true)
 enable or disable stroke More...
 
void disableStroke (bool mustUpdateTexture=true)
 disable stroke More...
 
void setFontFillColor (const Color3B &tintColor, bool mustUpdateTexture=true)
 set text tinting More...
 
var setFontFillColor ( var tintColor, var true)
 set text tinting More...
 
local setFontFillColor ( local tintColor, local true)
 set text tinting More...
 
bool init ()
 initializes the LabelTTF More...
 
TextHAlignment getHorizontalAlignment () const
local getHorizontalAlignment ()
void setHorizontalAlignment (TextHAlignment alignment)
local setHorizontalAlignment ( local alignment)
TextVAlignment getVerticalAlignment () const
void setVerticalAlignment (TextVAlignment verticalAlignment)
const SizegetDimensions () const
void setDimensions (const Size &dim)
local setDimensions ( local dim)
float getFontSize () const
void setFontSize (float fontSize)
local setFontSize ( local fontSize)
const char * getFontName () const
void setFontName (const char *fontName)
local setFontName ( local fontName)
- Public Member Functions inherited from Sprite
CC_DEPRECATED_ATTRIBUTE bool isFlipY ()
local isFlipY ()
CC_DEPRECATED_ATTRIBUTE void setFlipY (bool flippedY)
local setFlipY ( local flippedY)
 Sprite (void)
 Default constructor. More...
 
virtual ~Sprite (void)
 Default destructor. More...
 
virtual bool initWithTexture (Texture2D *texture)
 Initializes a sprite with a texture. More...
 
local initWithTexture ( local texture)
 Initializes a sprite with a texture. More...
 
virtual bool initWithTexture (Texture2D *texture, const Rect &rect)
 Initializes a sprite with a texture and a rect. More...
 
virtual bool initWithTexture (Texture2D *texture, const Rect &rect, bool rotated)
 Initializes a sprite with a texture and a rect in points, optionally rotated. More...
 
local initWithTexture ( local texture, local rect, local rotated)
 Initializes a sprite with a texture and a rect in points, optionally rotated. More...
 
virtual bool initWithSpriteFrame (SpriteFrame *pSpriteFrame)
 Initializes a sprite with an SpriteFrame. More...
 
virtual bool initWithSpriteFrameName (const char *spriteFrameName)
 Initializes a sprite with an sprite frame name. More...
 
virtual bool initWithFile (const char *filename)
 Initializes a sprite with an image filename. More...
 
var init ( var filename)
 Initializes a sprite with an image filename. More...
 
local init ( local filename)
 Initializes a sprite with an image filename. More...
 
virtual bool initWithFile (const char *filename, const Rect &rect)
 Initializes a sprite with an image filename, and a rect. More...
 
virtual void updateTransform (void)
 Updates the quad according the rotation, position, scale values. More...
 
virtual SpriteBatchNodegetBatchNode (void)
 Returns the batch node object if this sprite is rendered by SpriteBatchNode. More...
 
virtual void setBatchNode (SpriteBatchNode *spriteBatchNode)
 Sets the batch node to sprite. More...
 
local setBatchNode ( local spriteBatchNode)
 Sets the batch node to sprite. More...
 
virtual void setTextureRect (const Rect &rect)
 Updates the texture rect of the Sprite in points. More...
 
virtual void setTextureRect (const Rect &rect, bool rotated, const Size &untrimmedSize)
 Sets the texture rect, rectRotated and untrimmed size of the Sprite in points. More...
 
local setTextureRect ( local rect, local rotated, local untrimmedSize)
 Sets the texture rect, rectRotated and untrimmed size of the Sprite in points. More...
 
virtual void setVertexRect (const Rect &rect)
 Sets the vertex rect. More...
 
virtual void setDisplayFrame (SpriteFrame *pNewFrame)
 Sets a new display frame to the Sprite. More...
 
virtual bool isFrameDisplayed (SpriteFrame *pFrame) const
 Returns whether or not a SpriteFrame is being displayed. More...
 
var isFrameDisplayed ( var pFrame)
 Returns whether or not a SpriteFrame is being displayed. More...
 
local isFrameDisplayed ( local pFrame)
 Returns whether or not a SpriteFrame is being displayed. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE
SpriteFrame
displayFrame ()
local displayFrame ()
virtual SpriteFramegetDisplayFrame ()
 Returns the current displayed frame. More...
 
virtual void setDisplayFrameWithAnimationName (const char *animationName, int frameIndex)
 Changes the display frame with animation name and index. More...
 
var setDisplayFrameWithAnimationName ( var animationName, var frameIndex)
 Changes the display frame with animation name and index. More...
 
local setDisplayFrameWithAnimationName ( local animationName, local frameIndex)
 Changes the display frame with animation name and index. More...
 
virtual bool isDirty (void) const
 Whether or not the Sprite needs to be updated in the Atlas. More...
 
var isDirty ()
 Whether or not the Sprite needs to be updated in the Atlas. More...
 
local isDirty ()
 Whether or not the Sprite needs to be updated in the Atlas. More...
 
virtual void setDirty (bool bDirty)
 Makes the Sprite to be updated in the Atlas. More...
 
var setDirty ( var bDirty)
 Makes the Sprite to be updated in the Atlas. More...
 
local setDirty ( local bDirty)
 Makes the Sprite to be updated in the Atlas. More...
 
V3F_C4B_T2F_Quad getQuad (void) const
 Returns the quad (tex coords, vertex coords and color) information. More...
 
bool isTextureRectRotated (void) const
 Returns whether or not the texture rectangle is rotated. More...
 
local isTextureRectRotated ()
 Returns whether or not the texture rectangle is rotated. More...
 
int getAtlasIndex (void) const
 Returns the index used on the TextureAtlas. More...
 
void setAtlasIndex (int atlasIndex)
 Sets the index used on the TextureAtlas. More...
 
const RectgetTextureRect (void)
 Returns the rect of the Sprite in points. More...
 
var getTextureRect ()
 Returns the rect of the Sprite in points. More...
 
local getTextureRect ()
 Returns the rect of the Sprite in points. More...
 
TextureAtlasgetTextureAtlas (void)
 Gets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode. More...
 
var getTextureAtlas ()
 Gets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode. More...
 
local getTextureAtlas ()
 Gets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode. More...
 
void setTextureAtlas (TextureAtlas *pobTextureAtlas)
 Sets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode. More...
 
const PointgetOffsetPosition (void) const
 Gets the offset position of the sprite. More...
 
bool isFlippedX (void) const
 Returns the flag which indicates whether the sprite is flipped horizontally or not. More...
 
void setFlippedX (bool flippedX)
 Sets whether the sprite should be flipped horizontally or not. More...
 
CC_DEPRECATED_ATTRIBUTE bool isFlipX ()
CC_DEPRECATED_ATTRIBUTE void setFlipX (bool flippedX)
local setFlipX ( local flippedX)
bool isFlippedY (void) const
 Return the flag which indicates whether the sprite is flipped vertically or not. More...
 
void setFlippedY (bool flippedY)
 Sets whether the sprite should be flipped vertically or not. More...
 
virtual void setTexture (Texture2D *texture) override
 Sets a new texuture. More...
 
virtual Texture2DgetTexture () const override
 Returns the currently used texture. More...
 
local getTexture ()
 Returns the currently used texture. More...
 
void setBlendFunc (const BlendFunc &blendFunc) override
const BlendFuncgetBlendFunc () const override
 Returns the blending function that is currently being used. More...
 
virtual void setScaleX (float scaleX) override
 Changes the scale factor on X axis of this node. More...
 
virtual void setScaleY (float scaleY) override
 Changes the scale factor on Y axis of this node. More...
 
virtual void setPosition (const Point &pos) override
 Changes the position (x,y) of the node in OpenGL coordinates. More...
 
virtual void setRotation (float rotation) override
 Sets the rotation (angle) of the node in degrees. More...
 
virtual void setRotationX (float rotationX) override
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual void setRotationY (float rotationY) override
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual void setSkewX (float sx) override
 Changes the X skew angle of the node in degrees. More...
 
virtual void setSkewY (float sy) override
 Changes the Y skew angle of the node in degrees. More...
 
virtual void removeChild (Node *child, bool cleanup) override
 Removes a child from the container. More...
 
var removeChild ( var child, var cleanup)
 Removes a child from the container. More...
 
local removeChild ( local child, local cleanup)
 Removes a child from the container. More...
 
virtual void removeAllChildrenWithCleanup (bool cleanup) override
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
local removeAllChildrenWithCleanup ( local cleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
virtual void reorderChild (Node *child, int zOrder) override
 Reorders a child according to a new z value. More...
 
virtual void addChild (Node *child) override
 Adds a child to the container with z-order as 0. More...
 
var addChild ( var child)
 Adds a child to the container with z-order as 0. More...
 
local addChild ( local child)
 Adds a child to the container with z-order as 0. More...
 
virtual void addChild (Node *child, int zOrder) override
 Adds a child to the container with a z-order. More...
 
var addChild ( var child, var zOrder)
 Adds a child to the container with a z-order. More...
 
local addChild ( local child, local zOrder)
 Adds a child to the container with a z-order. More...
 
virtual void addChild (Node *child, int zOrder, int tag) override
 Adds a child to the container with z order and tag. More...
 
local addChild ( local child, local zOrder, local tag)
 Adds a child to the container with z order and tag. More...
 
virtual void sortAllChildren () override
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
virtual void setScale (float scale) override
 Changes both X and Y scale factor of the node. More...
 
local setScale ( local scale)
 Changes both X and Y scale factor of the node. More...
 
virtual void setVertexZ (float vertexZ) override
 Sets the real OpenGL Z vertex. More...
 
virtual void setAnchorPoint (const Point &anchor) override
 Sets the anchor point in percent. More...
 
virtual void ignoreAnchorPointForPosition (bool value) override
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
local ignoreAnchorPointForPosition ( local value)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
virtual void setVisible (bool bVisible) override
 Sets whether the node is visible. More...
 
virtual void setColor (const Color3B &color3) override
 Changes the color with R,G,B bytes. More...
 
virtual void updateDisplayedColor (const Color3B &parentColor) override
 recursive method that updates display color More...
 
var updateDisplayedColor ( var parentColor)
 recursive method that updates display color More...
 
local updateDisplayedColor ( local parentColor)
 recursive method that updates display color More...
 
virtual void setOpacity (GLubyte opacity) override
 Changes the opacity. More...
 
virtual void setOpacityModifyRGB (bool modify) override
 Changes the OpacityModifyRGB property. More...
 
local setOpacityModifyRGB ( local modify)
 Changes the OpacityModifyRGB property. More...
 
virtual bool isOpacityModifyRGB (void) const override
 Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity) More...
 
virtual void updateDisplayedOpacity (GLubyte parentOpacity) override
 recursive method that updates the displayed opacity. More...
 
- Public Member Functions inherited from NodeRGBA
 NodeRGBA ()
virtual ~NodeRGBA ()
virtual GLubyte getOpacity () const override
 Returns the opacity. More...
 
virtual GLubyte getDisplayedOpacity () const override
 Returns the displayed opacity. More...
 
virtual bool isCascadeOpacityEnabled () const override
 whether or not opacity should be propagated to its children. More...
 
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled) override
virtual const Color3BgetColor (void) const override
 Returns color that is currently used. More...
 
virtual const Color3BgetDisplayedColor () const override
 Returns the displayed color. More...
 
virtual bool isCascadeColorEnabled () const override
 whether or not color should be propagated to its children. More...
 
virtual void setCascadeColorEnabled (bool cascadeColorEnabled) override
- Public Member Functions inherited from Node
virtual CameragetCamera ()
 Returns a camera object that lets you move the node using a gluLookAt. More...
 
virtual bool isRunning () const
 Returns whether or not the node accepts event callbacks. More...
 
void scheduleUpdateWithPriorityLua (int handler, int priority)
 Schedules for lua script. More...
 
virtual void cleanup ()
 Stops all running actions and schedulers. More...
 
var cleanup ()
 Stops all running actions and schedulers. More...
 
local cleanup ()
 Stops all running actions and schedulers. More...
 
virtual void visit ()
 Visits this node's children and draw them recursively. More...
 
local visit ()
 Visits this node's children and draw them recursively. More...
 
virtual Rect getBoundingBox () const
 Returns a "local" axis aligned bounding box of the node. More...
 
local getBoundingBox ()
 Returns a "local" axis aligned bounding box of the node. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE Rect 
boundingBox () const
local boundingBox ()
virtual void setZOrder (int zOrder)
 Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...
 
local setZOrder ( local zOrder)
 Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...
 
virtual void _setZOrder (int z)
 Sets the z order which stands for the drawing order. More...
 
virtual int getZOrder () const
 Gets the Z order of this node. More...
 
virtual float getVertexZ () const
 Gets OpenGL Z vertex of this node. More...
 
virtual float getScaleX () const
 Returns the scale factor on X axis of this node. More...
 
virtual float getScaleY () const
 Returns the scale factor on Y axis of this node. More...
 
virtual float getScale () const
 Gets the scale factor of the node, when X and Y have the same scale factor. More...
 
virtual const PointgetPosition () const
 Gets the position (x,y) of the node in OpenGL coordinates. More...
 
local getPosition ()
 Gets the position (x,y) of the node in OpenGL coordinates. More...
 
virtual void setPosition (float x, float y)
 Sets position in a more efficient way. More...
 
virtual void getPosition (float *x, float *y) const
 Gets position in a more efficient way, returns two number instead of a Point object. More...
 
virtual void setPositionX (float x)
 Gets/Sets x or y coordinate individually for position. More...
 
virtual float getPositionX (void) const
local getPositionX ()
virtual void setPositionY (float y)
local setPositionY ( local y)
virtual float getPositionY (void) const
local getPositionY ()
virtual float getSkewX () const
 Returns the X skew angle of the node in degrees. More...
 
virtual float getSkewY () const
 Returns the Y skew angle of the node in degrees. More...
 
virtual const PointgetAnchorPoint () const
 Returns the anchor point in percent. More...
 
local getAnchorPoint ()
 Returns the anchor point in percent. More...
 
virtual const PointgetAnchorPointInPoints () const
 Returns the anchorPoint in absolute pixels. More...
 
virtual void setContentSize (const Size &contentSize)
 Sets the untransformed size of the node. More...
 
local setContentSize ( local contentSize)
 Sets the untransformed size of the node. More...
 
virtual const SizegetContentSize () const
 Returns the untransformed size of the node. More...
 
virtual bool isVisible () const
 Determines if the node is visible. More...
 
var isVisible ()
 Determines if the node is visible. More...
 
local isVisible ()
 Determines if the node is visible. More...
 
virtual float getRotation () const
 Returns the rotation of the node in degrees. More...
 
virtual float getRotationX () const
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
virtual float getRotationY () const
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual void setOrderOfArrival (int orderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
var setOrderOfArrival ( var orderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
local setOrderOfArrival ( local orderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
virtual int getOrderOfArrival () const
 Returns the arrival order, indecates which children is added previously. More...
 
CC_DEPRECATED_ATTRIBUTE void setGLServerState (int serverState)
CC_DEPRECATED_ATTRIBUTE int getGLServerState () const
virtual bool isIgnoreAnchorPointForPosition () const
 Gets whether the anchor point will be (0,0) when you position this node. More...
 
NodegetChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
virtual ArraygetChildren ()
 Return an array of children. More...
 
virtual const ArraygetChildren () const
unsigned int getChildrenCount () const
 Get the amount of children. More...
 
local getChildrenCount ()
 Get the amount of children. More...
 
virtual void setParent (Node *parent)
 Sets the parent node. More...
 
var setParent ( var parent)
 Sets the parent node. More...
 
local setParent ( local parent)
 Sets the parent node. More...
 
virtual NodegetParent ()
 Returns a pointer to the parent node. More...
 
var getParent ()
 Returns a pointer to the parent node. More...
 
local getParent ()
 Returns a pointer to the parent node. More...
 
virtual const NodegetParent () const
local getParent ()
virtual void removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
local removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
virtual void removeFromParentAndCleanup (bool cleanup)
 Removes this node itself from its parent node. More...
 
local removeFromParent ( local cleanup)
 Removes this node itself from its parent node. More...
 
virtual void removeChildByTag (int tag, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
local removeChildByTag ( local tag, local 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 GridBasegetGrid ()
 Returns a grid object that is used when applying effects. More...
 
local getGrid ()
 Returns a grid object that is used when applying effects. More...
 
virtual const GridBasegetGrid () const
local getGrid ()
virtual void setGrid (GridBase *grid)
 Changes a grid object that is used when applying effects. More...
 
local setGrid ( local grid)
 Changes a grid object that is used when applying effects. More...
 
virtual int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
virtual void setTag (int tag)
 Changes the tag that is used to identify the node easily. More...
 
var setTag ( var tag)
 Changes the tag that is used to identify the node easily. More...
 
local setTag ( local tag)
 Changes the tag that is used to identify the node easily. More...
 
virtual void * getUserData ()
 Returns a custom user data pointer. More...
 
virtual const void * getUserData () const
virtual void setUserData (void *userData)
 Sets a custom user data pointer. More...
 
virtual ObjectgetUserObject ()
 Returns a user assigned Object. More...
 
virtual const ObjectgetUserObject () const
virtual void setUserObject (Object *userObject)
 Returns a user assigned Object. More...
 
local setUserObject ( local userObject)
 Returns a user assigned Object. More...
 
virtual GLProgramgetShaderProgram ()
 Return the shader program currently used for this node. More...
 
virtual const GLProgramgetShaderProgram () const
local getShaderProgram ()
virtual void setShaderProgram (GLProgram *shaderProgram)
 Sets the shader program for this node. More...
 
var setShaderProgram ( var shaderProgram)
 Sets the shader program for this node. More...
 
local setShaderProgram ( local shaderProgram)
 Sets the shader program for this node. More...
 
virtual void onEnter ()
 Event callback that is invoked every time when Node enters the 'stage'. More...
 
virtual void onEnterTransitionDidFinish ()
 Event callback that is invoked when the Node enters in the 'stage'. More...
 
virtual void onExit ()
 Event callback that is invoked every time the Node leaves the 'stage'. More...
 
virtual void onExitTransitionDidStart ()
 Event callback that is called every time the Node leaves the 'stage'. More...
 
virtual void setActionManager (ActionManager *actionManager)
 Sets the ActionManager object that is used by all actions. More...
 
virtual ActionManagergetActionManager ()
 Gets the ActionManager object that is used by all actions. More...
 
local getActionManager ()
 Gets the ActionManager object that is used by all actions. More...
 
virtual const ActionManagergetActionManager () const
ActionrunAction (Action *action)
 Executes an action, and returns the action that is executed. More...
 
local runAction ( local action)
 Executes an action, and returns the action that is executed. More...
 
void stopAllActions ()
 Stops and removes all actions from the running action list . More...
 
void stopAction (Action *action)
 Stops and removes an action from the running action list. More...
 
void stopActionByTag (int tag)
 Removes an action from the running action list by its tag. More...
 
ActiongetActionByTag (int tag)
 Gets an action from the running action list by its tag. More...
 
unsigned int 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...
 
local getNumberOfRunningActions ()
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
CC_DEPRECATED_ATTRIBUTE
unsigned int 
numberOfRunningActions () const
local numberOfRunningActions ()
virtual void setScheduler (Scheduler *scheduler)
 Sets a Scheduler object that is used to schedule all "updates" and timers. More...
 
virtual SchedulergetScheduler ()
 Gets a Sheduler object. More...
 
virtual const SchedulergetScheduler () const
local getScheduler ()
bool isScheduled (SEL_SCHEDULE selector)
 Checks whether a selector is scheduled. More...
 
void scheduleUpdate (void)
 Schedules the "update" method. More...
 
void scheduleUpdateWithPriority (int priority)
 Schedules the "update" method with a custom priority. More...
 
void unscheduleUpdate (void)
void schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
 Schedules a custom selector. More...
 
void schedule (SEL_SCHEDULE selector, float interval)
 Schedules a custom selector with an interval time in seconds. More...
 
void scheduleOnce (SEL_SCHEDULE selector, float delay)
 Schedules a selector that runs only once, with a delay of 0 or larger. More...
 
void schedule (SEL_SCHEDULE selector)
 Schedules a custom selector, the scheduled selector will be ticked every frame. More...
 
void unschedule (SEL_SCHEDULE selector)
 Unschedules a custom selector. More...
 
void unscheduleAllSelectors (void)
 Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...
 
void resumeSchedulerAndActions (void)
 Resumes all scheduled selectors and actions. More...
 
local resumeSchedulerAndActions ()
 Resumes all scheduled selectors and actions. More...
 
void pauseSchedulerAndActions (void)
 Pauses all scheduled selectors and actions. More...
 
virtual void update (float delta)
local update ( local delta)
void transform ()
 Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes. More...
 
void transformAncestors ()
 Performs OpenGL view-matrix transformation of it's ancestors. More...
 
virtual const AffineTransformgetNodeToParentTransform () const
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
local getNodeToParentTransform ()
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
nodeToParentTransform () const
local nodeToParentTransform ()
virtual const AffineTransformgetParentToNodeTransform () const
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
parentToNodeTransform () const
local parentToNodeTransform ()
virtual AffineTransform getNodeToWorldTransform () const
 Returns the world affine transform matrix. More...
 
local getNodeToWorldTransform ()
 Returns the world affine transform matrix. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
nodeToWorldTransform () const
local nodeToWorldTransform ()
virtual AffineTransform getWorldToNodeTransform () const
 Returns the inverse world affine transform matrix. More...
 
local getWorldToNodeTransform ()
 Returns the inverse world affine transform matrix. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
worldToNodeTransform () const
local worldToNodeTransform ()
Point convertToNodeSpace (const Point &worldPoint) const
 Converts a Point to node (local) space coordinates. More...
 
Point convertToWorldSpace (const Point &nodePoint) const
 Converts a Point to world space coordinates. More...
 
Point convertToNodeSpaceAR (const Point &worldPoint) const
 Converts a Point to node (local) space coordinates. More...
 
Point convertToWorldSpaceAR (const Point &nodePoint) const
 Converts a local Point to world space coordinates.The result is in Points. More...
 
Point convertTouchToNodeSpace (Touch *touch) const
 convenience methods which take a Touch instead of Point More...
 
Point convertTouchToNodeSpaceAR (Touch *touch) const
 converts a Touch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (const AffineTransform &additionalTransform)
 Sets the additional transform. More...
 
ComponentgetComponent (const char *pName)
 gets a component by its name More...
 
virtual bool addComponent (Component *pComponent)
 adds a component More...
 
local addComponent ( local pComponent)
 adds a component More...
 
virtual bool removeComponent (const char *pName)
 removes a component by its name More...
 
virtual void removeAllComponents ()
 removes all components More...
 
 Node (void)
 Default constructor. More...
 
virtual ~Node (void)
 Default destructor. More...
 
const char * description (void) const
 Gets the description string. More...
 
- Public Member Functions inherited from Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
void release ()
 Release the ownership immediately. More...
 
void retain ()
 Retains the ownership. More...
 
Objectautorelease ()
 Release the ownership sometime soon automatically. More...
 
bool isSingleReference () const
 Returns a boolean value that indicates whether there is only one reference to the object. More...
 
unsigned int retainCount () const
 Returns the object's current reference count. More...
 
virtual bool isEqual (const Object *object)
 Returns a boolean value that indicates whether this object and a given object are equal. More...
 
virtual void acceptVisitor (DataVisitor &visitor)
- Public Member Functions inherited from IMEDelegate
virtual ~IMEDelegate ()

Static Public Member Functions

static TextFieldTTFtextFieldWithPlaceHolder (const char *placeholder, const Size &dimensions, TextHAlignment alignment, const char *fontName, float fontSize)
 creates a TextFieldTTF from a fontname, alignment, dimension and font size More...
 
static TextFieldTTFtextFieldWithPlaceHolder (const char *placeholder, const char *fontName, float fontSize)
 creates a LabelTTF from a fontname and font size More...
 
- Static Public Member Functions inherited from LabelTTF
static LabelTTFcreate (const char *string, const char *fontName, float fontSize)
 creates a LabelTTF with a font name and font size in points More...
 
var create ( var string, var fontName, var fontSize)
 creates a LabelTTF with a font name and font size in points More...
 
local create ( local string, local fontName, local fontSize)
 creates a LabelTTF with a font name and font size in points More...
 
static LabelTTFcreate (const char *string, const char *fontName, float fontSize, const Size &dimensions, TextHAlignment hAlignment)
 creates a LabelTTF from a fontname, horizontal alignment, dimension in points, and font size in points. More...
 
var create ( var string, var fontName, var fontSize, var dimensions, var hAlignment)
 creates a LabelTTF from a fontname, horizontal alignment, dimension in points, and font size in points. More...
 
static LabelTTFcreate (const char *string, const char *fontName, float fontSize, const Size &dimensions, TextHAlignment hAlignment, TextVAlignment vAlignment)
 creates a Label from a fontname, alignment, dimension in points and font size in points More...
 
var create ( var string, var fontName, var fontSize, var dimensions, var hAlignment, var vAlignment)
 creates a Label from a fontname, alignment, dimension in points and font size in points More...
 
static LabelTTFcreateWithFontDefinition (const char *string, FontDefinition &textDefinition)
 Create a lable with string and a font definition. More...
 
var createWithFontDefinition ( var string, var textDefinition)
 Create a lable with string and a font definition. More...
 
static LabelTTFcreate ()
 Creates an label. More...
 
local create ()
 Creates an label. More...
 
- Static Public Member Functions inherited from Sprite
static Spritecreate ()
 Creates an empty sprite without texture. More...
 
static Spritecreate (const char *filename)
 Creates a sprite with an image filename. More...
 
local create ( local filename)
 Creates a sprite with an image filename. More...
 
static Spritecreate (const char *filename, const Rect &rect)
 Creates a sprite with an image filename and a rect. More...
 
local create ( local filename, local rect)
 Creates a sprite with an image filename and a rect. More...
 
static SpritecreateWithTexture (Texture2D *texture)
 Creates a sprite with an exsiting texture contained in a Texture2D object After creation, the rect will be the size of the texture, and the offset will be (0,0). More...
 
local createWithTexture ( local texture)
 Creates a sprite with an exsiting texture contained in a Texture2D object After creation, the rect will be the size of the texture, and the offset will be (0,0). More...
 
static SpritecreateWithTexture (Texture2D *texture, const Rect &rect)
 Creates a sprite with a texture and a rect. More...
 
local createWithTexture ( local texture, local rect)
 Creates a sprite with a texture and a rect. More...
 
static SpritecreateWithSpriteFrame (SpriteFrame *pSpriteFrame)
 Creates a sprite with an sprite frame. More...
 
static SpritecreateWithSpriteFrameName (const char *spriteFrameName)
 Creates a sprite with an sprite frame name. More...
 
local createWithSpriteFrameName ( local spriteFrameName)
 Creates a sprite with an sprite frame name. More...
 

Protected Member Functions

virtual void draw ()
 Override this method to draw your own node. More...
 
virtual bool canAttachWithIME ()
 Decide if the delegate instance is ready to receive an IME message. More...
 
virtual bool canDetachWithIME ()
 Decide if the delegate instance can stop receiving IME messages. More...
 
virtual void insertText (const char *text, int len)
 Called by IMEDispatcher when text input received from the IME. More...
 
virtual void deleteBackward ()
 Called by IMEDispatcher after the user clicks the backward key. More...
 
virtual const char * getContentText ()
 Called by IMEDispatcher for text stored in delegate. More...
 
- Protected Member Functions inherited from LabelTTF
void _updateWithTextDefinition (const FontDefinition &textDefinition, bool mustUpdateTexture=true)
 set the text definition for this label More...
 
var _updateWithTextDefinition ( var textDefinition, var true)
 set the text definition for this label More...
 
local _updateWithTextDefinition ( local textDefinition, local true)
 set the text definition for this label More...
 
FontDefinition _prepareTextDefinition (bool adjustForResolution=false)
local _prepareTextDefinition ( local false)
- Protected Member Functions inherited from Sprite
void updateColor (void)
virtual void setTextureCoords (Rect rect)
local setTextureCoords ( local rect)
virtual void updateBlendFunc (void)
virtual void setReorderChildDirtyRecursively (void)
local setReorderChildDirtyRecursively ()
virtual void setDirtyRecursively (bool bValue)
- Protected Member Functions inherited from IMEDelegate
virtual void didAttachWithIME ()
 When the delegate detaches from the IME, this method is called by IMEDispatcher. More...
 
virtual void didDetachWithIME ()
 When the delegate detaches from the IME, this method is called by IMEDispatcher. More...
 
virtual void keyboardWillShow (IMEKeyboardNotificationInfo &info)
virtual void keyboardDidShow (IMEKeyboardNotificationInfo &info)
virtual void keyboardWillHide (IMEKeyboardNotificationInfo &info)
virtual void keyboardDidHide (IMEKeyboardNotificationInfo &info)
 IMEDelegate ()

Protected Attributes

TextFieldDelegate_delegate
int _charCount
std::string * _inputText
std::string * _placeHolder
Color3B _colorSpaceHolder
bool _secureTextEntry
- Protected Attributes inherited from LabelTTF
Size _dimensions
 Dimensions of the label in Points. More...
 
local _dimensions
 Dimensions of the label in Points. More...
 
TextHAlignment _alignment
 The alignment of the label. More...
 
var _alignment
 The alignment of the label. More...
 
local _alignment
 The alignment of the label. More...
 
TextVAlignment _vAlignment
 The vertical alignment of the label. More...
 
var _vAlignment
 The vertical alignment of the label. More...
 
local _vAlignment
 The vertical alignment of the label. More...
 
std::string * _fontName
 Font name used in the label. More...
 
float _fontSize
 Font size of the label. More...
 
var _fontSize
 Font size of the label. More...
 
local _fontSize
 Font size of the label. More...
 
std::string _string
 label's string More...
 
var _string
 label's string More...
 
local _string
 label's string More...
 
bool _shadowEnabled
 font shadow More...
 
var _shadowEnabled
 font shadow More...
 
local _shadowEnabled
 font shadow More...
 
Size _shadowOffset
float _shadowOpacity
var _shadowOpacity
local _shadowOpacity
float _shadowBlur
var _shadowBlur
local _shadowBlur
bool _strokeEnabled
 font stroke More...
 
var _strokeEnabled
 font stroke More...
 
local _strokeEnabled
 font stroke More...
 
Color3B _strokeColor
float _strokeSize
var _strokeSize
local _strokeSize
Color3B _textFillColor
 font tint More...
 
var _textFillColor
 font tint More...
 
local _textFillColor
 font tint More...
 
- Protected Attributes inherited from Sprite
TextureAtlas_textureAtlas
int _atlasIndex
 SpriteBatchNode texture atlas (weak reference) More...
 
var _atlasIndex
 SpriteBatchNode texture atlas (weak reference) More...
 
local _atlasIndex
 SpriteBatchNode texture atlas (weak reference) More...
 
SpriteBatchNode_batchNode
 Absolute (real) Index on the SpriteSheet. More...
 
var _batchNode
 Absolute (real) Index on the SpriteSheet. More...
 
local _batchNode
 Absolute (real) Index on the SpriteSheet. More...
 
bool _dirty
 Used batch node (weak reference) More...
 
bool _recursiveDirty
 Whether the sprite needs to be updated. More...
 
var _recursiveDirty
 Whether the sprite needs to be updated. More...
 
local _recursiveDirty
 Whether the sprite needs to be updated. More...
 
bool _hasChildren
 Whether all of the sprite's children needs to be updated. More...
 
bool _shouldBeHidden
 Whether the sprite contains children. More...
 
var _shouldBeHidden
 Whether the sprite contains children. More...
 
local _shouldBeHidden
 Whether the sprite contains children. More...
 
AffineTransform _transformToBatch
 should not be drawn because one of the ancestors is not visible More...
 
var _transformToBatch
 should not be drawn because one of the ancestors is not visible More...
 
local _transformToBatch
 should not be drawn because one of the ancestors is not visible More...
 
BlendFunc _blendFunc
Texture2D_texture
 It's required for TextureProtocol inheritance. More...
 
var _texture
 It's required for TextureProtocol inheritance. More...
 
local _texture
 It's required for TextureProtocol inheritance. More...
 
Rect _rect
 Texture2D object that is used to render the sprite. More...
 
bool _rectRotated
 Retangle of Texture2D. More...
 
Point _offsetPosition
 Whether the texture is rotated. More...
 
var _offsetPosition
 Whether the texture is rotated. More...
 
local _offsetPosition
 Whether the texture is rotated. More...
 
Point _unflippedOffsetPositionFromCenter
var _unflippedOffsetPositionFromCenter
local _unflippedOffsetPositionFromCenter
V3F_C4B_T2F_Quad _quad
bool _opacityModifyRGB
var _opacityModifyRGB
local _opacityModifyRGB
bool _flippedX
bool _flippedY
 Whether the sprite is flipped horizaontally or not. More...
 
var _flippedY
 Whether the sprite is flipped horizaontally or not. More...
 
local _flippedY
 Whether the sprite is flipped horizaontally or not. More...
 
- Protected Attributes inherited from NodeRGBA
GLubyte _displayedOpacity
GLubyte _realOpacity
Color3B _displayedColor
Color3B _realColor
bool _cascadeColorEnabled
bool _cascadeOpacityEnabled
- Protected Attributes inherited from Node
float _rotationX
 rotation angle on x-axis More...
 
float _rotationY
 rotation angle on y-axis More...
 
var _rotationY
 rotation angle on y-axis More...
 
local _rotationY
 rotation angle on y-axis More...
 
float _scaleX
 scaling factor on x-axis More...
 
var _scaleX
 scaling factor on x-axis More...
 
local _scaleX
 scaling factor on x-axis More...
 
float _scaleY
 scaling factor on y-axis More...
 
var _scaleY
 scaling factor on y-axis More...
 
local _scaleY
 scaling factor on y-axis More...
 
float _vertexZ
 OpenGL real Z vertex. More...
 
Point _position
 position of the node More...
 
float _skewX
 skew angle on x-axis More...
 
var _skewX
 skew angle on x-axis More...
 
local _skewX
 skew angle on x-axis More...
 
float _skewY
 skew angle on y-axis More...
 
var _skewY
 skew angle on y-axis More...
 
local _skewY
 skew angle on y-axis More...
 
Point _anchorPointInPoints
 anchor point in points More...
 
var _anchorPointInPoints
 anchor point in points More...
 
local _anchorPointInPoints
 anchor point in points More...
 
Point _anchorPoint
 anchor point normalized (NOT in points) More...
 
Size _contentSize
 untransformed size of the node More...
 
local _contentSize
 untransformed size of the node More...
 
AffineTransform _additionalTransform
 transform More...
 
AffineTransform _transform
 transform More...
 
var _transform
 transform More...
 
local _transform
 transform More...
 
AffineTransform _inverse
 inverse transform More...
 
var _inverse
 inverse transform More...
 
local _inverse
 inverse transform More...
 
bool _additionalTransformDirty
 The flag to check whether the additional transform is dirty. More...
 
bool _transformDirty
 transform dirty flag More...
 
var _transformDirty
 transform dirty flag More...
 
local _transformDirty
 transform dirty flag More...
 
bool _inverseDirty
 inverse transform dirty flag More...
 
var _inverseDirty
 inverse transform dirty flag More...
 
local _inverseDirty
 inverse transform dirty flag More...
 
Camera_camera
 a camera More...
 
GridBase_grid
 a grid More...
 
int _ZOrder
 z-order value that affects the draw order More...
 
Array_children
 array of children nodes More...
 
var _children
 array of children nodes More...
 
local _children
 array of children nodes More...
 
Node_parent
 weak reference to parent node More...
 
int _tag
 a tag. Can be any number you assigned just to identify this node More...
 
var _tag
 a tag. Can be any number you assigned just to identify this node More...
 
local _tag
 a tag. Can be any number you assigned just to identify this node More...
 
void * _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
Object_userObject
 A user assigned Object. More...
 
local _userObject
 A user assigned Object. More...
 
GLProgram_shaderProgram
 OpenGL shader. More...
 
int _orderOfArrival
 used to preserve sequence while sorting children with the same zOrder More...
 
Scheduler_scheduler
 scheduler used to schedule timers and updates More...
 
ActionManager_actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
var _actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
local _actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
bool _running
 is running More...
 
bool _visible
 is this node visible More...
 
bool _ignoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
 
var _ignoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
 
local _ignoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
 
bool _reorderChildDirty
 children order dirty flag More...
 
local _reorderChildDirty
 children order dirty flag More...
 
bool _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
var _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
local _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
int _scriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
int _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
var _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
local _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
ccScriptType _scriptType
 type of script binding, lua or javascript More...
 
ComponentContainer_componentContainer
 Dictionary of components. More...
 
var _componentContainer
 Dictionary of components. More...
 
local _componentContainer
 Dictionary of components. More...
 
int _eventPriority
 The scene graph based priority of event listener. More...
 
int _oldEventPriority
 The old scene graph based priority of event listener. More...
 
var _oldEventPriority
 The old scene graph based priority of event listener. More...
 
local _oldEventPriority
 The old scene graph based priority of event listener. More...
 
- Protected Attributes inherited from Object
unsigned int _reference
 count of references More...
 
var _reference
 count of references More...
 
local _reference
 count of references More...
 
unsigned int _autoReleaseCount
 count of autorelease More...
 
var _autoReleaseCount
 count of autorelease More...
 
local _autoReleaseCount
 count of autorelease More...
 

Additional Inherited Members

- Public Attributes inherited from Object
unsigned int _ID
 object id, ScriptSupport need public _ID More...
 
int _luaID
 Lua reference id. More...
 
- Static Public Attributes inherited from Sprite
static const int INDEX_NOT_INITIALIZED = -1
var INDEX_NOT_INITIALIZED = -1
local INDEX_NOT_INITIALIZED = -1
- Static Protected Attributes inherited from Node
static int _globalEventPriorityIndex
 The index of global event priority. More...
 

Detailed Description

A simple text input field with TTF font.

Constructor & Destructor Documentation

virtual ~TextFieldTTF ( )
virtual

Member Function Documentation

virtual bool attachWithIME ( )
virtual

Open keyboard and receive input text.

Reimplemented from IMEDelegate.

virtual bool canAttachWithIME ( )
protectedvirtual

Decide if the delegate instance is ready to receive an IME message.

Called by IMEDispatcher.

Reimplemented from IMEDelegate.

virtual bool canDetachWithIME ( )
protectedvirtual

Decide if the delegate instance can stop receiving IME messages.

Reimplemented from IMEDelegate.

virtual void deleteBackward ( )
protectedvirtual

Called by IMEDispatcher after the user clicks the backward key.

Reimplemented from IMEDelegate.

Reimplemented in UICCTextField.

virtual bool detachWithIME ( )
virtual

End text input and close keyboard.

Reimplemented from IMEDelegate.

virtual void draw ( )
protectedvirtual

Override this method to draw your own node.

The following GL states will be enabled by default:

  • glEnableClientState(GL_VERTEX_ARRAY);
  • glEnableClientState(GL_COLOR_ARRAY);
  • glEnableClientState(GL_TEXTURE_COORD_ARRAY);
  • glEnable(GL_TEXTURE_2D); AND YOU SHOULD NOT DISABLE THEM AFTER DRAWING YOUR NODE But if you enable any other GL state, you should disable it after drawing your node.

Reimplemented from Sprite.

int getCharCount ( ) const
inline
virtual const Color3B&
getColorSpaceHolder
( )
virtual
virtual const char* getContentText ( )
protectedvirtual

Called by IMEDispatcher for text stored in delegate.

Reimplemented from IMEDelegate.

TextFieldDelegate* getDelegate ( ) const
inline
virtual const char* getPlaceHolder ( void  )
virtual
virtual const char* getString ( void  ) const
virtual

Returns the string that is currently being used in this label.

Returns
The string that is currently being used in this label

Reimplemented from LabelTTF.

bool initWithPlaceHolder ( const char *  placeholder,
const Size dimensions,
TextHAlignment  alignment,
const char *  fontName,
float  fontSize 
)

initializes the TextFieldTTF with a font name, alignment, dimension and font size

bool initWithPlaceHolder ( const char *  placeholder,
const char *  fontName,
float  fontSize 
)

initializes the TextFieldTTF with a font name and font size

virtual void insertText ( const char *  text,
int  len 
)
protectedvirtual

Called by IMEDispatcher when text input received from the IME.

Reimplemented from IMEDelegate.

Reimplemented in UICCTextField.

virtual bool isSecureTextEntry ( )
virtual
virtual void setColorSpaceHolder ( const Color3B color)
virtual
void setDelegate ( TextFieldDelegate delegate)
inline
virtual void setPlaceHolder ( const char *  text)
virtual
virtual void setSecureTextEntry ( bool  value)
virtual
virtual void setString ( const char *  label)
virtual

changes the string to render

Warning
Changing the string is as expensive as creating a new LabelTTF. To obtain better performance use LabelAtlas

Reimplemented from LabelTTF.

static TextFieldTTF*
textFieldWithPlaceHolder
( const char *  placeholder,
const Size dimensions,
TextHAlignment  alignment,
const char *  fontName,
float  fontSize 
)
static

creates a TextFieldTTF from a fontname, alignment, dimension and font size

static TextFieldTTF*
textFieldWithPlaceHolder
( const char *  placeholder,
const char *  fontName,
float  fontSize 
)
static

creates a LabelTTF from a fontname and font size

Member Data Documentation

int _charCount
protected
Color3B _colorSpaceHolder
protected
TextFieldDelegate* _delegate
protected
std::string* _inputText
protected
std::string* _placeHolder
protected
bool _secureTextEntry
protected

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