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

#include <UITextField.h>

Inheritance diagram for UICCTextField:
TextFieldTTF TextFieldDelegate Label IMEDelegate SpriteBatchNode LabelProtocol Node TextureProtocol Ref BlendProtocol

Public Member Functions

 UICCTextField ()
 ~UICCTextField ()
virtual void onEnter () override
 Event callback that is invoked every time when Node enters the 'stage'. More...
 
virtual bool onTextFieldAttachWithIME (TextFieldTTF *pSender) override
 If the sender doesn't want to attach to the IME, return true;. More...
 
virtual bool onTextFieldDetachWithIME (TextFieldTTF *pSender) override
 If the sender doesn't want to detach from the IME, return true;. More...
 
virtual bool onTextFieldInsertText (TextFieldTTF *pSender, const char *text, size_t nLen) override
 If the sender doesn't want to insert the text, return true;. More...
 
virtual bool onTextFieldDeleteBackward (TextFieldTTF *pSender, const char *delText, size_t nLen) override
 If the sender doesn't want to delete the delText, return true;. More...
 
void insertText (const char *text, size_t len)
 Called by IMEDispatcher when text input received from the IME. More...
 
void deleteBackward ()
 Called by IMEDispatcher after the user clicks the backward key. More...
 
void openIME ()
void closeIME ()
void setMaxLengthEnabled (bool enable)
bool isMaxLengthEnabled () const
void setMaxLength (int length)
int getMaxLength () const
int getCharCount () const
void setPasswordEnabled (bool enable)
bool isPasswordEnabled () const
void setPasswordStyleText (const std::string &styleText)
void setPasswordText (const std::string &text)
void setAttachWithIME (bool attach)
bool getAttachWithIME () const
void setDetachWithIME (bool detach)
bool getDetachWithIME () const
void setInsertText (bool insert)
bool getInsertText () const
void setDeleteBackward (bool deleteBackward)
bool getDeleteBackward () const
- Public Member Functions inherited from TextFieldTTF
 TextFieldTTF ()
virtual ~TextFieldTTF ()
bool initWithPlaceHolder (const std::string &placeholder, const Size &dimensions, TextHAlignment alignment, const std::string &fontName, float fontSize)
 initializes the TextFieldTTF with a font name, alignment, dimension and font size More...
 
var initWithPlaceHolder ( var placeholder, var dimensions, var alignment, var fontName, var fontSize)
 initializes the TextFieldTTF with a font name, alignment, dimension and font size More...
 
local initWithPlaceHolder ( local placeholder, local dimensions, local alignment, local fontName, local fontSize)
 initializes the TextFieldTTF with a font name, alignment, dimension and font size More...
 
bool initWithPlaceHolder (const std::string &placeholder, const std::string &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...
 
var detachWithIME ()
 End text input and close keyboard. More...
 
local detachWithIME ()
 End text input and close keyboard. More...
 
TextFieldDelegategetDelegate () const
void setDelegate (TextFieldDelegate *delegate)
int getCharCount () const
local getCharCount ()
virtual const Color4BgetColorSpaceHolder ()
var getColorSpaceHolder ()
local getColorSpaceHolder ()
virtual void setColorSpaceHolder (const Color3B &color)
local setColorSpaceHolder ( local color)
virtual void setColorSpaceHolder (const Color4B &color)
local setColorSpaceHolder ( local color)
virtual void setTextColor (const Color4B &textColor) override
 Sets the text color of the label Only support for TTF and system font. More...
 
local setTextColor ( local textColor)
 Sets the text color of the label Only support for TTF and system font. More...
 
virtual void setString (const std::string &text) override
 changes the string to render More...
 
local setString ( local text)
 changes the string to render More...
 
virtual const std::string & getString () const override
 Returns the string that is currently being used in this label. More...
 
local getString ()
 Returns the string that is currently being used in this label. More...
 
virtual void setPlaceHolder (const std::string &text)
local setPlaceHolder ( local text)
virtual const std::string & getPlaceHolder () const
virtual void setSecureTextEntry (bool value)
local setSecureTextEntry ( local value)
virtual bool isSecureTextEntry ()
var isSecureTextEntry ()
local isSecureTextEntry ()
virtual void visit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags) override
 Visits this node's children and draw them recursively. More...
 
var visit ( var renderer, var parentTransform, var parentFlags)
 Visits this node's children and draw them recursively. More...
 
local visit ( local renderer, local parentTransform, local parentFlags)
 Visits this node's children and draw them recursively. More...
 
- Public Member Functions inherited from Label
virtual bool setTTFConfig (const TTFConfig &ttfConfig)
 set TTF configuration for Label More...
 
var setTTFConfig ( var ttfConfig)
 set TTF configuration for Label More...
 
local setTTFConfig ( local ttfConfig)
 set TTF configuration for Label More...
 
virtual const TTFConfiggetTTFConfig () const
virtual bool setBMFontFilePath (const std::string &bmfontFilePath, const Vec2 &imageOffset=Vec2::ZERO)
var setBMFontFilePath ( var bmfontFilePath, var ZERO)
local setBMFontFilePath ( local bmfontFilePath, local ZERO)
const std::string & getBMFontFilePath () const
virtual bool setCharMap (const std::string &charMapFile, int itemWidth, int itemHeight, int startCharMap)
local setCharMap ( local charMapFile, local itemWidth, local itemHeight, local startCharMap)
virtual bool setCharMap (Texture2D *texture, int itemWidth, int itemHeight, int startCharMap)
local setCharMap ( local texture, local itemWidth, local itemHeight, local startCharMap)
virtual bool setCharMap (const std::string &plistFile)
virtual void setSystemFontName (const std::string &systemFont)
local setSystemFontName ( local systemFont)
virtual const std::string & getSystemFontName () const
local getSystemFontName ()
virtual void setSystemFontSize (float fontSize)
local setSystemFontSize ( local fontSize)
virtual float getSystemFontSize () const
var getSystemFontSize ()
local getSystemFontSize ()
virtual void requestSystemFontRefresh ()
const Color4BgetTextColor () const
 Returns the text color of this label Only support for TTF and system font. More...
 
var getTextColor ()
 Returns the text color of this label Only support for TTF and system font. More...
 
local getTextColor ()
 Returns the text color of this label Only support for TTF and system font. More...
 
virtual void enableShadow (const Color4B &shadowColor=Color4B::BLACK, const Size &offset=Size(2,-2), int blurRadius=0)
 Enable shadow for the label. More...
 
virtual void enableOutline (const Color4B &outlineColor, int outlineSize=-1)
 only support for TTF More...
 
var enableOutline ( var outlineColor, var 1)
 only support for TTF More...
 
local enableOutline ( local outlineColor, local 1)
 only support for TTF More...
 
virtual void enableGlow (const Color4B &glowColor)
 only support for TTF More...
 
var enableGlow ( var glowColor)
 only support for TTF More...
 
local enableGlow ( local glowColor)
 only support for TTF More...
 
virtual void disableEffect ()
 disable shadow/outline/glow rendering More...
 
var disableEffect ()
 disable shadow/outline/glow rendering More...
 
local disableEffect ()
 disable shadow/outline/glow rendering More...
 
void setAlignment (TextHAlignment hAlignment)
var setAlignment ( var hAlignment)
local setAlignment ( local hAlignment)
TextHAlignment getTextAlignment () const
void setAlignment (TextHAlignment hAlignment, TextVAlignment vAlignment)
var setAlignment ( var hAlignment, var vAlignment)
local setAlignment ( local hAlignment, local vAlignment)
void setHorizontalAlignment (TextHAlignment hAlignment)
var setHorizontalAlignment ( var hAlignment)
local setHorizontalAlignment ( local hAlignment)
TextHAlignment getHorizontalAlignment () const
var getHorizontalAlignment ()
local getHorizontalAlignment ()
void setVerticalAlignment (TextVAlignment vAlignment)
var setVerticalAlignment ( var vAlignment)
local setVerticalAlignment ( local vAlignment)
TextVAlignment getVerticalAlignment () const
var getVerticalAlignment ()
local getVerticalAlignment ()
void setLineBreakWithoutSpace (bool breakWithoutSpace)
var setLineBreakWithoutSpace ( var breakWithoutSpace)
local setLineBreakWithoutSpace ( local breakWithoutSpace)
void setMaxLineWidth (unsigned int maxLineWidth)
 Sets the max line width of the label. More...
 
local setMaxLineWidth ( local maxLineWidth)
 Sets the max line width of the label. More...
 
unsigned int getMaxLineWidth ()
var getMaxLineWidth ()
local getMaxLineWidth ()
void setWidth (unsigned int width)
 Sets the untransformed size of the label. More...
 
unsigned int getWidth () const
var getWidth ()
local getWidth ()
void setHeight (unsigned int height)
 Sets the untransformed size of the label. More...
 
var setHeight ( var height)
 Sets the untransformed size of the label. More...
 
local setHeight ( local height)
 Sets the untransformed size of the label. More...
 
unsigned int getHeight () const
var getHeight ()
local getHeight ()
void setDimensions (unsigned int width, unsigned int height)
 Sets the untransformed size of the label in a more efficient way. More...
 
var setDimensions ( var width, var height)
 Sets the untransformed size of the label in a more efficient way. More...
 
local setDimensions ( local width, local height)
 Sets the untransformed size of the label in a more efficient way. More...
 
const SizegetDimensions () const
var getDimensions ()
local getDimensions ()
virtual void updateContent ()
 update content immediately. More...
 
local updateContent ()
 update content immediately. More...
 
virtual SpritegetLetter (int lettetIndex)
local getLetter ( local lettetIndex)
void setClipMarginEnabled (bool clipEnabled)
 clip upper and lower margin for reduce height of label. More...
 
var setClipMarginEnabled ( var clipEnabled)
 clip upper and lower margin for reduce height of label. More...
 
local setClipMarginEnabled ( local clipEnabled)
 clip upper and lower margin for reduce height of label. More...
 
bool isClipMarginEnabled () const
void setLineHeight (float height)
 Sets the line height of the label. More...
 
var setLineHeight ( var height)
 Sets the line height of the label. More...
 
local setLineHeight ( local height)
 Sets the line height of the label. More...
 
float getLineHeight () const
 Returns the line height of this label. More...
 
var getLineHeight ()
 Returns the line height of this label. More...
 
local getLineHeight ()
 Returns the line height of this label. More...
 
void setAdditionalKerning (float space)
 Sets the additional kerning of the label. More...
 
var setAdditionalKerning ( var space)
 Sets the additional kerning of the label. More...
 
local setAdditionalKerning ( local space)
 Sets the additional kerning of the label. More...
 
float getAdditionalKerning () const
 Returns the additional kerning of this label. More...
 
local getAdditionalKerning ()
 Returns the additional kerning of this label. More...
 
int getStringNumLines () const
var getStringNumLines ()
local getStringNumLines ()
int getStringLength () const
var getStringLength ()
local getStringLength ()
FontAtlasgetFontAtlas ()
local getFontAtlas ()
virtual void setBlendFunc (const BlendFunc &blendFunc) override
virtual bool isOpacityModifyRGB () const override
var isOpacityModifyRGB ()
local isOpacityModifyRGB ()
virtual void setOpacityModifyRGB (bool isOpacityModifyRGB) override
local setOpacityModifyRGB ( local isOpacityModifyRGB)
virtual void updateDisplayedColor (const Color3B &parentColor) override
local updateDisplayedColor ( local parentColor)
virtual void updateDisplayedOpacity (GLubyte parentOpacity) override
var updateDisplayedOpacity ( var parentOpacity)
local updateDisplayedOpacity ( local parentOpacity)
virtual void setScale (float scale) override
 Sets the scale (x,y,z) of the node. More...
 
local setScale ( local scale)
 Sets the scale (x,y,z) of the node. More...
 
virtual void setScaleX (float scaleX) override
 Sets the scale (x) of the node. More...
 
local setScaleX ( local scaleX)
 Sets the scale (x) of the node. More...
 
virtual void setScaleY (float scaleY) override
 Sets the scale (y) of the node. More...
 
local setScaleY ( local scaleY)
 Sets the scale (y) of the node. More...
 
virtual float getScaleX () const override
 Returns the scale factor on X axis of this node. More...
 
var getScaleX ()
 Returns the scale factor on X axis of this node. More...
 
local getScaleX ()
 Returns the scale factor on X axis of this node. More...
 
virtual float getScaleY () const override
 Returns the scale factor on Y axis of this node. More...
 
var getScaleY ()
 Returns the scale factor on Y axis of this node. More...
 
local getScaleY ()
 Returns the scale factor on Y axis of this node. More...
 
virtual void addChild (Node *child, int zOrder=0, int tag=0) override
 Adds a child to the container with z order and tag. More...
 
var addChild ( var child, var 0, var 0)
 Adds a child to the container with z order and tag. More...
 
local addChild ( local child, local 0, local 0)
 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...
 
var sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
local sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
virtual std::string getDescription () const override
 Gets the description string. More...
 
virtual const SizegetContentSize () const override
 Returns the untransformed size of the node. More...
 
local getContentSize ()
 Returns the untransformed size of the node. More...
 
virtual Rect getBoundingBox () const override
 Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...
 
local getBoundingBox ()
 Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...
 
virtual void draw (Renderer *renderer, const Mat4 &transform, uint32_t flags) override
 Override this method to draw your own node. More...
 
local draw ( local renderer, local transform, local flags)
 Override this method to draw your own node. More...
 
virtual void setFontDefinition (const FontDefinition &textDefinition)
local setFontDefinition ( local textDefinition)
const FontDefinitiongetFontDefinition () const
var getFontDefinition ()
local getFontDefinition ()
int getCommonLineHeight () const
var getCommonLineHeight ()
local getCommonLineHeight ()
virtual ~Label ()
- Public Member Functions inherited from SpriteBatchNode
TextureAtlasgetTextureAtlas ()
 returns the TextureAtlas object More...
 
void setTextureAtlas (TextureAtlas *textureAtlas)
 sets the TextureAtlas object More...
 
local setTextureAtlas ( local textureAtlas)
 sets the TextureAtlas object More...
 
const std::vector< Sprite * > & getDescendants () const
 returns an array with the descendants (children, gran children, etc.). More...
 
local getDescendants ()
 returns an array with the descendants (children, gran children, etc.). More...
 
void increaseAtlasCapacity ()
var increaseAtlasCapacity ()
local increaseAtlasCapacity ()
void removeChildAtIndex (ssize_t index, bool doCleanup)
 removes a child given a certain index. More...
 
var removeChildAtIndex ( var index, var doCleanup)
 removes a child given a certain index. More...
 
local removeChildAtIndex ( local index, local doCleanup)
 removes a child given a certain index. More...
 
void appendChild (Sprite *sprite)
local appendChild ( local sprite)
void removeSpriteFromAtlas (Sprite *sprite)
local removeSpriteFromAtlas ( local sprite)
ssize_t rebuildIndexInOrder (Sprite *parent, ssize_t index)
local rebuildIndexInOrder ( local parent, local index)
ssize_t highestAtlasIndexInChild (Sprite *sprite)
local highestAtlasIndexInChild ( local sprite)
ssize_t lowestAtlasIndexInChild (Sprite *sprite)
var lowestAtlasIndexInChild ( var sprite)
local lowestAtlasIndexInChild ( local sprite)
ssize_t atlasIndexForChild (Sprite *sprite, int z)
local atlasIndexForChild ( local sprite, local z)
void reorderBatch (bool reorder)
local reorderBatch ( local reorder)
virtual Texture2DgetTexture () const override
 Returns the currently used texture. More...
 
local getTexture ()
 Returns the currently used texture. More...
 
virtual void setTexture (Texture2D *texture) override
 Sets a new texuture. More...
 
local setTexture ( local texture)
 Sets a new texuture. More...
 
virtual const BlendFuncgetBlendFunc () const override
 Returns the blending function that is currently being used. More...
 
virtual void addChild (Node *child, int zOrder, const std::string &name) override
 Adds a child to the container with z order and tag. More...
 
var addChild ( var child, var zOrder, var name)
 Adds a child to the container with z order and tag. More...
 
local addChild ( local child, local zOrder, local name)
 Adds a child to the container with z order and tag. More...
 
virtual void reorderChild (Node *child, int zOrder) override
 Reorders a child according to a new z value. 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...
 
void insertQuadFromSprite (Sprite *sprite, ssize_t index)
 Inserts a quad at a certain index into the texture atlas. More...
 
var insertQuadFromSprite ( var sprite, var index)
 Inserts a quad at a certain index into the texture atlas. More...
 
local insertQuadFromSprite ( local sprite, local index)
 Inserts a quad at a certain index into the texture atlas. More...
 
SpriteBatchNodeaddSpriteWithoutQuad (Sprite *child, int z, int aTag)
local addSpriteWithoutQuad ( local child, local z, local aTag)
virtual ~SpriteBatchNode ()
bool initWithTexture (Texture2D *tex, ssize_t capacity)
 initializes a SpriteBatchNode with a texture2d and capacity of children. More...
 
var initWithTexture ( var tex, var capacity)
 initializes a SpriteBatchNode with a texture2d and capacity of children. More...
 
local initWithTexture ( local tex, local capacity)
 initializes a SpriteBatchNode with a texture2d and capacity of children. More...
 
bool initWithFile (const std::string &fileImage, ssize_t capacity)
 initializes a SpriteBatchNode with a file image (.png, .jpeg, .pvr, etc) and a capacity of children. More...
 
bool init ()
- Public Member Functions inherited from Node
virtual bool isRunning () const
 Returns whether or not the node is "running". More...
 
var isRunning ()
 Returns whether or not the node is "running". More...
 
local isRunning ()
 Returns whether or not the node is "running". 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 draw () final
var draw ()
local draw ()
virtual void visit () final
virtual ScenegetScene () const
 Returns the Scene that contains the Node. More...
 
local getScene ()
 Returns the Scene that contains the Node. More...
 
virtual Rect boundingBox () const
local boundingBox ()
virtual void setEventDispatcher (EventDispatcher *dispatcher)
var setEventDispatcher ( var dispatcher)
local setEventDispatcher ( local dispatcher)
virtual EventDispatchergetEventDispatcher () const
local getEventDispatcher ()
void setPhysicsBody (PhysicsBody *body)
 set the PhysicsBody that let the sprite effect with physics More...
 
var setPhysicsBody ( var body)
 set the PhysicsBody that let the sprite effect with physics More...
 
local setPhysicsBody ( local body)
 set the PhysicsBody that let the sprite effect with physics More...
 
PhysicsBodygetPhysicsBody () const
 get the PhysicsBody the sprite have More...
 
var getPhysicsBody ()
 get the PhysicsBody the sprite have More...
 
local getPhysicsBody ()
 get the PhysicsBody the sprite have More...
 
void removeFromPhysicsWorld ()
 remove this node from physics world. More...
 
virtual GLubyte getOpacity () const
var getOpacity ()
local getOpacity ()
virtual GLubyte getDisplayedOpacity () const
local getDisplayedOpacity ()
virtual void setOpacity (GLubyte opacity)
local setOpacity ( local opacity)
virtual bool isCascadeOpacityEnabled () const
var isCascadeOpacityEnabled ()
local isCascadeOpacityEnabled ()
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
local setCascadeOpacityEnabled ( local cascadeOpacityEnabled)
virtual const Color3BgetColor () const
local getColor ()
virtual const Color3BgetDisplayedColor () const
local getDisplayedColor ()
virtual void setColor (const Color3B &color)
var setColor ( var color)
local setColor ( local color)
virtual bool isCascadeColorEnabled () const
var isCascadeColorEnabled ()
local isCascadeColorEnabled ()
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
void setOnEnterCallback (const std::function< void()> &callback)
var setOnEnterCallback ( var callback)
local setOnEnterCallback ( local callback)
const std::function< void()> & getOnEnterCallback () const
local getOnEnterCallback ()
void setOnExitCallback (const std::function< void()> &callback)
var setOnExitCallback ( var callback)
local setOnExitCallback ( local callback)
const std::function< void()> & getOnExitCallback () const
local getOnExitCallback ()
void setonEnterTransitionDidFinishCallback (const std::function< void()> &callback)
var setonEnterTransitionDidFinishCallback ( var callback)
local setonEnterTransitionDidFinishCallback ( local callback)
const std::function< void()> & getonEnterTransitionDidFinishCallback () const
local getonEnterTransitionDidFinishCallback ()
void setonExitTransitionDidStartCallback (const std::function< void()> &callback)
var setonExitTransitionDidStartCallback ( var callback)
local setonExitTransitionDidStartCallback ( local callback)
const std::function< void()> & getonExitTransitionDidStartCallback () const
local getonExitTransitionDidStartCallback ()
unsigned short getCameraMask () const
 get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true More...
 
void setCameraMask (unsigned short mask, bool applyChildren=true)
var setCameraMask ( var mask, var true)
local setCameraMask ( local mask, local true)
virtual ~Node ()
virtual void setLocalZOrder (int localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
local setLocalZOrder ( local localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
virtual void setZOrder (int localZOrder)
virtual void _setLocalZOrder (int z)
local _setLocalZOrder ( local z)
virtual int getLocalZOrder () const
 Gets the local Z order of this node. More...
 
var getLocalZOrder ()
 Gets the local Z order of this node. More...
 
local getLocalZOrder ()
 Gets the local Z order of this node. More...
 
virtual int getZOrder () const
var getZOrder ()
local getZOrder ()
virtual void setGlobalZOrder (float globalZOrder)
 Defines the oder in which the nodes are renderer. More...
 
local setGlobalZOrder ( local globalZOrder)
 Defines the oder in which the nodes are renderer. More...
 
virtual float getGlobalZOrder () const
 Returns the Node's Global Z Order. More...
 
var getGlobalZOrder ()
 Returns the Node's Global Z Order. More...
 
local getGlobalZOrder ()
 Returns the Node's Global Z Order. More...
 
virtual void setScaleZ (float scaleZ)
 Changes the scale factor on Z axis of this node. More...
 
local setScaleZ ( local 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 float getScale () const
 Gets the scale factor of the node, when X and Y have the same scale factor. More...
 
virtual void setScale (float scaleX, float scaleY)
 Sets the scale (x,y) of the node. More...
 
local setScale ( local scaleX, local scaleY)
 Sets the scale (x,y) of the node. More...
 
virtual void setPosition (const Vec2 &position)
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual void setNormalizedPosition (const Vec2 &position)
 Sets the position (x,y) using values between 0 and 1. More...
 
local setNormalizedPosition ( local position)
 Sets the position (x,y) using values between 0 and 1. More...
 
virtual const Vec2getPosition () const
 Gets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual const Vec2getNormalizedPosition () const
 returns the normalized position More...
 
local getNormalizedPosition ()
 returns the normalized position More...
 
virtual void setPosition (float x, float y)
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
local setPosition ( local x, local 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 (void) const
var getPositionX ()
local getPositionX ()
virtual void setPositionY (float y)
local setPositionY ( local y)
virtual float getPositionY (void) const
local getPositionY ()
virtual void setPosition3D (const Vec3 &position)
 Sets the position (X, Y, and Z) in its parent's coordinate system. More...
 
local setPosition3D ( local 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...
 
local setPositionZ ( local positionZ)
 Sets the 'z' coordinate in the position. More...
 
virtual void setVertexZ (float vertexZ)
var setVertexZ ( var vertexZ)
local setVertexZ ( local vertexZ)
virtual float getPositionZ () const
 Gets position Z coordinate of this node. More...
 
virtual float getVertexZ () const
virtual void setSkewX (float skewX)
 Changes the X skew angle of the node in degrees. More...
 
local setSkewX ( local 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...
 
var setSkewY ( var skewY)
 Changes the Y skew angle of the node in degrees. More...
 
local setSkewY ( local 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...
 
local setAnchorPoint ( local anchorPoint)
 Sets the anchor point in percent. More...
 
virtual const Vec2getAnchorPoint () const
 Returns the anchor point in percent. More...
 
virtual const Vec2getAnchorPointInPoints () 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 void setVisible (bool visible)
 Sets whether the node is visible. More...
 
local setVisible ( local 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...
 
var setRotation ( var rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
local setRotation ( local rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
virtual float getRotation () const
 Returns the rotation of the node in degrees. More...
 
virtual void setRotation3D (const Vec3 &rotation)
 Sets the rotation (X,Y,Z) in degrees. More...
 
local setRotation3D ( local 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 setRotationSkewX (float rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual void setRotationX (float rotationX)
virtual float getRotationSkewX () const
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
var getRotationSkewX ()
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
local getRotationSkewX ()
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
virtual float getRotationX () const
virtual void setRotationSkewY (float rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local setRotationSkewY ( local rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual void setRotationY (float rotationY)
virtual float getRotationSkewY () const
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local getRotationSkewY ()
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual float getRotationY () const
void setOrderOfArrival (int orderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
int getOrderOfArrival () const
 Returns the arrival order, indicates which children is added previously. More...
 
void setGLServerState (int serverState)
int getGLServerState () const
virtual void ignoreAnchorPointForPosition (bool ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
local ignoreAnchorPointForPosition ( local ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
virtual bool isIgnoreAnchorPointForPosition () const
 Gets whether the anchor point will be (0,0) when you position this node. More...
 
virtual void addChild (Node *child)
 Adds a child to the container with z-order as 0. More...
 
local addChild ( local child)
 Adds a child to the container with z-order as 0. More...
 
virtual void addChild (Node *child, int localZOrder)
 Adds a child to the container with a local z-order. More...
 
local addChild ( local child, local localZOrder)
 Adds a child to the container with a local z-order. More...
 
virtual NodegetChildByTag (int tag) const
 Gets a child from the container with its tag. More...
 
var getChildByTag ( var tag)
 Gets a child from the container with its tag. More...
 
local getChildByTag ( local tag)
 Gets a child from the container with its tag. More...
 
virtual NodegetChildByName (const std::string &name) const
 Gets a child from the container with its name. More...
 
var getChildByName ( var name)
 Gets a child from the container with its name. More...
 
local getChildByName ( local name)
 Gets a child from the container with its name. More...
 
template<typename T >
getChildByName (const std::string &name) const
 Gets a child from the container with its name that can be cast to Type T. More...
 
virtual void enumerateChildren (const std::string &name, std::function< bool(Node *node)> callback) const
 Search the children of the receiving node to perform processing for nodes which share a name. More...
 
virtual Vector< Node * > & getChildren ()
 Returns the array of the node's children. More...
 
local getChildren ()
 Returns the array of the node's children. More...
 
virtual const Vector< Node * > & getChildren () const
local getChildren ()
virtual ssize_t getChildrenCount () const
 Returns the amount of children. More...
 
virtual void setParent (Node *parent)
 Sets the parent node. More...
 
local setParent ( local parent)
 Sets the parent node. More...
 
virtual NodegetParent ()
 Returns a pointer to the parent node. More...
 
virtual const NodegetParent () const
local getParent ()
virtual void removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
virtual void removeFromParentAndCleanup (bool cleanup)
 Removes this node itself from its parent node. More...
 
local removeFromParent ( local cleanup)
 Removes this node itself from its parent node. More...
 
virtual void 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 removeChildByName (const std::string &name, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
var removeChildByName ( var name, var true)
 Removes a child from the container by tag value. More...
 
local removeChildByName ( local name, 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...
 
var removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
local removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
virtual int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
local getTag ()
 Returns a tag that is used to identify the node easily. More...
 
virtual void setTag (int tag)
 Changes the tag that is used to identify the node easily. More...
 
local setTag ( local tag)
 Changes the tag that is used to identify the node easily. More...
 
virtual std::string getName () const
 Returns a string that is used to identify the node. More...
 
local getName ()
 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...
 
local setName ( local 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
virtual void setUserData (void *userData)
 Sets a custom user data pointer. More...
 
virtual RefgetUserObject ()
 Returns a user assigned Object. More...
 
virtual const RefgetUserObject () const
virtual void setUserObject (Ref *userObject)
 Returns a user assigned Object. More...
 
local setUserObject ( local userObject)
 Returns a user assigned Object. More...
 
GLProgramgetGLProgram () const
 Return the GLProgram (shader) currently used for this node. More...
 
var getGLProgram ()
 Return the GLProgram (shader) currently used for this node. More...
 
local getGLProgram ()
 Return the GLProgram (shader) currently used for this node. More...
 
GLProgramgetShaderProgram () const
var getShaderProgram ()
local getShaderProgram ()
GLProgramStategetGLProgramState () const
var getGLProgramState ()
local getGLProgramState ()
virtual void setGLProgramState (GLProgramState *glProgramState)
virtual void setGLProgram (GLProgram *glprogram)
 Sets the shader program for this node. More...
 
var setGLProgram ( var glprogram)
 Sets the shader program for this node. More...
 
local setGLProgram ( local glprogram)
 Sets the shader program for this node. More...
 
void setShaderProgram (GLProgram *glprogram)
var setShaderProgram ( var glprogram)
local setShaderProgram ( local glprogram)
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...
 
local setActionManager ( local 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
local getActionManager ()
ActionrunAction (Action *action)
 Executes an action, and returns the action that is executed. More...
 
void stopAllActions ()
 Stops and removes all actions from the running action list . More...
 
var stopAllActions ()
 Stops and removes all actions from the running action list . More...
 
local stopAllActions ()
 Stops and removes all actions from the running action list . More...
 
void stopAction (Action *action)
 Stops and removes an action from the running action list. More...
 
var stopAction ( var action)
 Stops and removes an action from the running action list. More...
 
local stopAction ( local action)
 Stops and removes an action from the running action list. More...
 
void stopActionByTag (int tag)
 Removes an action from the running action list by its tag. More...
 
void stopAllActionsByTag (int tag)
 Removes all actions from the running action list by its tag. More...
 
var stopAllActionsByTag ( var tag)
 Removes all actions from the running action list by its tag. More...
 
local stopAllActionsByTag ( local tag)
 Removes all actions from the running action list by its tag. More...
 
ActiongetActionByTag (int tag)
 Gets an action from the running action list by its tag. More...
 
ssize_t getNumberOfRunningActions () const
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
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...
 
ssize_t numberOfRunningActions () const
var numberOfRunningActions ()
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...
 
local getScheduler ()
 Gets a Sheduler object. More...
 
virtual const SchedulergetScheduler () const
local getScheduler ()
bool isScheduled (SEL_SCHEDULE selector)
 Checks whether a selector is scheduled. More...
 
bool isScheduled (const std::string &key)
 Checks whether a lambda function is scheduled. More...
 
void scheduleUpdate (void)
 Schedules the "update" method. More...
 
void scheduleUpdateWithPriority (int priority)
 Schedules the "update" method with a custom priority. More...
 
void unscheduleUpdate (void)
var unscheduleUpdate ()
local unscheduleUpdate ()
void schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
 Schedules a custom selector. More...
 
void schedule (SEL_SCHEDULE selector, float interval)
 Schedules a custom selector with an interval time in seconds. More...
 
void scheduleOnce (SEL_SCHEDULE selector, float delay)
 Schedules a selector that runs only once, with a delay of 0 or larger. More...
 
void 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...
 
var schedule ( var callback, var 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 Actions are not affected by this method. More...
 
void unscheduleAllSelectors ()
var unscheduleAllSelectors ()
local unscheduleAllSelectors ()
virtual void resume (void)
 Resumes all scheduled selectors, actions and event listeners. More...
 
var resume ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
local resume ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
virtual void pause (void)
 Pauses all scheduled selectors, actions and event listeners. More...
 
var pause ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
local pause ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
void resumeSchedulerAndActions ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
void pauseSchedulerAndActions ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
virtual void update (float delta)
var update ( var delta)
local update ( local delta)
virtual void updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
var updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
local updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
virtual const Mat4getNodeToParentTransform () 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 AffineTransform getNodeToParentAffineTransform () const
local getNodeToParentAffineTransform ()
virtual void setNodeToParentTransform (const Mat4 &transform)
 Sets the Transformation matrix manually. More...
 
local setNodeToParentTransform ( local transform)
 Sets the Transformation matrix manually. More...
 
virtual AffineTransform nodeToParentTransform () const
local nodeToParentTransform ()
virtual const Mat4getParentToNodeTransform () const
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
virtual AffineTransform getParentToNodeAffineTransform () const
local getParentToNodeAffineTransform ()
virtual AffineTransform parentToNodeTransform () const
local parentToNodeTransform ()
virtual Mat4 getNodeToWorldTransform () const
 Returns the world affine transform matrix. More...
 
var getNodeToWorldTransform ()
 Returns the world affine transform matrix. More...
 
local getNodeToWorldTransform ()
 Returns the world affine transform matrix. More...
 
virtual AffineTransform getNodeToWorldAffineTransform () const
local getNodeToWorldAffineTransform ()
virtual AffineTransform nodeToWorldTransform () const
local nodeToWorldTransform ()
virtual Mat4 getWorldToNodeTransform () const
 Returns the inverse world affine transform matrix. More...
 
var getWorldToNodeTransform ()
 Returns the inverse world affine transform matrix. More...
 
local getWorldToNodeTransform ()
 Returns the inverse world affine transform matrix. More...
 
virtual AffineTransform getWorldToNodeAffineTransform () const
local getWorldToNodeAffineTransform ()
virtual AffineTransform worldToNodeTransform () const
local worldToNodeTransform ()
Vec2 convertToNodeSpace (const Vec2 &worldPoint) const
 Converts a Vec2 to node (local) space coordinates. More...
 
var convertToNodeSpace ( var worldPoint)
 Converts a Vec2 to node (local) space coordinates. More...
 
local convertToNodeSpace ( local worldPoint)
 Converts a Vec2 to node (local) space coordinates. More...
 
Vec2 convertToWorldSpace (const Vec2 &nodePoint) const
 Converts a Vec2 to world space coordinates. More...
 
var convertToWorldSpace ( var nodePoint)
 Converts a Vec2 to world space coordinates. More...
 
local convertToWorldSpace ( local nodePoint)
 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...
 
var convertTouchToNodeSpaceAR ( var touch)
 converts a Touch (world coordinates) into a local coordinate. More...
 
local convertTouchToNodeSpaceAR ( local touch)
 converts a Touch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (Mat4 *additionalTransform)
 Sets an additional transform matrix to the node. More...
 
var setAdditionalTransform ( var additionalTransform)
 Sets an additional transform matrix to the node. More...
 
local setAdditionalTransform ( local additionalTransform)
 Sets an additional transform matrix to the node. More...
 
void setAdditionalTransform (const AffineTransform &additionalTransform)
var setAdditionalTransform ( var additionalTransform)
local setAdditionalTransform ( local additionalTransform)
ComponentgetComponent (const std::string &name)
 gets a component by its name More...
 
local getComponent ( local name)
 gets a component by its name More...
 
virtual bool addComponent (Component *component)
 adds a component More...
 
local addComponent ( local component)
 adds a component More...
 
virtual bool removeComponent (const std::string &name)
 removes a component by its name More...
 
local removeComponent ( local name)
 removes a component by its name More...
 
virtual bool removeComponent (Component *component)
 removes a component by its pointer More...
 
var removeComponent ( var component)
 removes a component by its pointer More...
 
local removeComponent ( local component)
 removes a component by its pointer More...
 
virtual void removeAllComponents ()
 removes all components More...
 
var removeAllComponents ()
 removes all components More...
 
local removeAllComponents ()
 removes all components More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
- Public Member Functions inherited from TextureProtocol
virtual ~TextureProtocol ()
- Public Member Functions inherited from BlendProtocol
virtual ~BlendProtocol ()
- Public Member Functions inherited from LabelProtocol
virtual ~LabelProtocol ()
- Public Member Functions inherited from IMEDelegate
virtual ~IMEDelegate ()
- Public Member Functions inherited from TextFieldDelegate
virtual ~TextFieldDelegate ()
virtual bool onVisit (TextFieldTTF *sender, Renderer *renderer, const Mat4 &transform, uint32_t flags)
 If the sender doesn't want to draw, return true. More...
 
var onVisit ( var sender, var renderer, var transform, var flags)
 If the sender doesn't want to draw, return true. More...
 
local onVisit ( local sender, local renderer, local transform, local flags)
 If the sender doesn't want to draw, return true. More...
 

Static Public Member Functions

static UICCTextFieldcreate (const std::string &placeholder, const std::string &fontName, float fontSize)
- Static Public Member Functions inherited from TextFieldTTF
static TextFieldTTFtextFieldWithPlaceHolder (const std::string &placeholder, const Size &dimensions, TextHAlignment alignment, const std::string &fontName, float fontSize)
 creates a TextFieldTTF from a fontname, alignment, dimension and font size More...
 
local textFieldWithPlaceHolder ( local placeholder, local dimensions, local alignment, local fontName, local fontSize)
 creates a TextFieldTTF from a fontname, alignment, dimension and font size More...
 
static TextFieldTTFtextFieldWithPlaceHolder (const std::string &placeholder, const std::string &fontName, float fontSize)
 creates a TextFieldTTF from a fontname and font size More...
 
var textFieldWithPlaceHolder ( var placeholder, var fontName, var fontSize)
 creates a TextFieldTTF from a fontname and font size More...
 
local textFieldWithPlaceHolder ( local placeholder, local fontName, local fontSize)
 creates a TextFieldTTF from a fontname and font size More...
 
- Static Public Member Functions inherited from Label
static Labelcreate ()
var create ()
local create ()
static LabelcreateWithSystemFont (const std::string &text, const std::string &font, float fontSize, const Size &dimensions=Size::ZERO, TextHAlignment hAlignment=TextHAlignment::LEFT, TextVAlignment vAlignment=TextVAlignment::TOP)
 Creates a label with an initial string,font[font name or font file],font size, dimension in points, horizontal alignment and vertical alignment. More...
 
var createWithSystemFont ( var text, var font, var fontSize, var ZERO, var LEFT, var TOP)
 Creates a label with an initial string,font[font name or font file],font size, dimension in points, horizontal alignment and vertical alignment. More...
 
local createWithSystemFont ( local text, local font, local fontSize, local ZERO, local LEFT, local TOP)
 Creates a label with an initial string,font[font name or font file],font size, dimension in points, horizontal alignment and vertical alignment. More...
 
static LabelcreateWithTTF (const std::string &text, const std::string &fontFile, float fontSize, const Size &dimensions=Size::ZERO, TextHAlignment hAlignment=TextHAlignment::LEFT, TextVAlignment vAlignment=TextVAlignment::TOP)
 Creates a label with an initial string,font file,font size, dimension in points, horizontal alignment and vertical alignment. More...
 
local createWithTTF ( local text, local fontFile, local fontSize, local ZERO, local LEFT, local TOP)
 Creates a label with an initial string,font file,font size, dimension in points, horizontal alignment and vertical alignment. More...
 
static LabelcreateWithTTF (const TTFConfig &ttfConfig, const std::string &text, TextHAlignment alignment=TextHAlignment::LEFT, int maxLineWidth=0)
 Create a label with TTF configuration. More...
 
var createWithTTF ( var ttfConfig, var text, var LEFT, var 0)
 Create a label with TTF configuration. More...
 
local createWithTTF ( local ttfConfig, local text, local LEFT, local 0)
 Create a label with TTF configuration. More...
 
static LabelcreateWithBMFont (const std::string &bmfontFilePath, const std::string &text, const TextHAlignment &alignment=TextHAlignment::LEFT, int maxLineWidth=0, const Vec2 &imageOffset=Vec2::ZERO)
static LabelcreateWithCharMap (const std::string &charMapFile, int itemWidth, int itemHeight, int startCharMap)
static LabelcreateWithCharMap (Texture2D *texture, int itemWidth, int itemHeight, int startCharMap)
static LabelcreateWithCharMap (const std::string &plistFile)
static Labelcreate (const std::string &text, const std::string &font, float fontSize, const Size &dimensions=Size::ZERO, TextHAlignment hAlignment=TextHAlignment::LEFT, TextVAlignment vAlignment=TextVAlignment::TOP)
- Static Public Member Functions inherited from SpriteBatchNode
static SpriteBatchNodecreateWithTexture (Texture2D *tex, ssize_t capacity=DEFAULT_CAPACITY)
 creates a SpriteBatchNode with a texture2d and capacity of children. More...
 
var createWithTexture ( var tex, var DEFAULT_CAPACITY)
 creates a SpriteBatchNode with a texture2d and capacity of children. More...
 
local createWithTexture ( local tex, local DEFAULT_CAPACITY)
 creates a SpriteBatchNode with a texture2d and capacity of children. More...
 
static SpriteBatchNodecreate (const std::string &fileImage, ssize_t capacity=DEFAULT_CAPACITY)
 creates a SpriteBatchNode with a file image (.png, .jpeg, .pvr, etc) and capacity of children. More...
 
- Static Public Member Functions inherited from Node
static Nodecreate ()
 Allocates and initializes a node. More...
 

Protected Attributes

bool _maxLengthEnabled
int _maxLength
bool _passwordEnabled
std::string _passwordStyleText
bool _attachWithIME
bool _detachWithIME
bool _insertText
bool _deleteBackward
- Protected Attributes inherited from TextFieldTTF
TextFieldDelegate_delegate
int _charCount
var _charCount
local _charCount
std::string _inputText
var _inputText
local _inputText
std::string _placeHolder
var _placeHolder
local _placeHolder
Color4B _colorSpaceHolder
var _colorSpaceHolder
local _colorSpaceHolder
Color4B _colorText
var _colorText
local _colorText
bool _secureTextEntry
var _secureTextEntry
local _secureTextEntry
- Protected Attributes inherited from Label
std::string _bmFontPath
var _bmFontPath
local _bmFontPath
bool _isOpacityModifyRGB
var _isOpacityModifyRGB
local _isOpacityModifyRGB
bool _contentDirty
var _contentDirty
local _contentDirty
bool _systemFontDirty
var _systemFontDirty
local _systemFontDirty
std::string _systemFont
var _systemFont
local _systemFont
float _systemFontSize
var _systemFontSize
local _systemFontSize
LabelType _currentLabelType
var _currentLabelType
local _currentLabelType
std::vector< SpriteBatchNode * > _batchNodes
var _batchNodes
local _batchNodes
FontAtlas_fontAtlas
var _fontAtlas
local _fontAtlas
std::vector< LetterInfo_lettersInfo
var _lettersInfo
local _lettersInfo
TTFConfig _fontConfig
var _fontConfig
local _fontConfig
Sprite_textSprite
var _textSprite
local _textSprite
FontDefinition _fontDefinition
var _fontDefinition
local _fontDefinition
bool _compatibleMode
var _compatibleMode
local _compatibleMode
Sprite_reusedLetter
 used for optimization More...
 
var _reusedLetter
 used for optimization More...
 
local _reusedLetter
 used for optimization More...
 
Rect _reusedRect
local _reusedRect
int _limitShowCount
var _limitShowCount
local _limitShowCount
float _additionalKerning
var _additionalKerning
local _additionalKerning
float _commonLineHeight
var _commonLineHeight
local _commonLineHeight
bool _lineBreakWithoutSpaces
var _lineBreakWithoutSpaces
local _lineBreakWithoutSpaces
int * _horizontalKernings
var _horizontalKernings
local _horizontalKernings
unsigned int _maxLineWidth
var _maxLineWidth
local _maxLineWidth
Size _labelDimensions
var _labelDimensions
local _labelDimensions
unsigned int _labelWidth
var _labelWidth
local _labelWidth
unsigned int _labelHeight
var _labelHeight
local _labelHeight
TextHAlignment _hAlignment
var _hAlignment
local _hAlignment
TextVAlignment _vAlignment
var _vAlignment
local _vAlignment
int _currNumLines
var _currNumLines
local _currNumLines
std::u16string _currentUTF16String
var _currentUTF16String
local _currentUTF16String
std::string _originalUTF8String
var _originalUTF8String
local _originalUTF8String
float _fontScale
var _fontScale
local _fontScale
bool _useDistanceField
var _useDistanceField
local _useDistanceField
bool _useA8Shader
var _useA8Shader
local _useA8Shader
LabelEffect _currLabelEffect
var _currLabelEffect
local _currLabelEffect
Color4B _effectColor
var _effectColor
local _effectColor
Color4F _effectColorF
var _effectColorF
local _effectColorF
GLuint _uniformEffectColor
var _uniformEffectColor
local _uniformEffectColor
GLuint _uniformTextColor
var _uniformTextColor
local _uniformTextColor
CustomCommand _customCommand
var _customCommand
local _customCommand
bool _shadowDirty
var _shadowDirty
local _shadowDirty
bool _shadowEnabled
var _shadowEnabled
local _shadowEnabled
Size _shadowOffset
var _shadowOffset
local _shadowOffset
int _shadowBlurRadius
var _shadowBlurRadius
local _shadowBlurRadius
Mat4 _shadowTransform
var _shadowTransform
local _shadowTransform
Color3B _shadowColor
var _shadowColor
local _shadowColor
float _shadowOpacity
var _shadowOpacity
local _shadowOpacity
Sprite_shadowNode
var _shadowNode
local _shadowNode
int _outlineSize
var _outlineSize
local _outlineSize
Color4B _textColor
var _textColor
local _textColor
Color4F _textColorF
var _textColorF
local _textColorF
bool _clipEnabled
var _clipEnabled
local _clipEnabled
bool _blendFuncDirty
var _blendFuncDirty
local _blendFuncDirty
bool _insideBounds
var _insideBounds
local _insideBounds
- Protected Attributes inherited from SpriteBatchNode
TextureAtlas_textureAtlas
BlendFunc _blendFunc
var _blendFunc
local _blendFunc
BatchCommand _batchCommand
var _batchCommand
local _batchCommand
std::vector< Sprite * > _descendants
var _descendants
local _descendants
- Protected Attributes inherited from Node
float _rotationX
 rotation on the X-axis More...
 
local _rotationX
 rotation on the X-axis More...
 
float _rotationY
 rotation on the Y-axis More...
 
var _rotationY
 rotation on the Y-axis More...
 
local _rotationY
 rotation on the Y-axis More...
 
float _rotationZ_X
 rotation angle on Z-axis, component X More...
 
var _rotationZ_X
 rotation angle on Z-axis, component X More...
 
local _rotationZ_X
 rotation angle on Z-axis, component X More...
 
float _rotationZ_Y
 rotation angle on Z-axis, component Y More...
 
var _rotationZ_Y
 rotation angle on Z-axis, component Y More...
 
local _rotationZ_Y
 rotation angle on Z-axis, component Y 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 _scaleZ
 scaling factor on z-axis More...
 
var _scaleZ
 scaling factor on z-axis More...
 
local _scaleZ
 scaling factor on z-axis More...
 
Vec2 _position
 position of the node More...
 
var _position
 position of the node More...
 
local _position
 position of the node More...
 
float _positionZ
 OpenGL real Z position. More...
 
var _positionZ
 OpenGL real Z position. More...
 
local _positionZ
 OpenGL real Z position. More...
 
Vec2 _normalizedPosition
var _normalizedPosition
local _normalizedPosition
bool _usingNormalizedPosition
var _usingNormalizedPosition
local _usingNormalizedPosition
bool _normalizedPositionDirty
var _normalizedPositionDirty
local _normalizedPositionDirty
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...
 
Vec2 _anchorPointInPoints
 anchor point in points More...
 
var _anchorPointInPoints
 anchor point in points More...
 
local _anchorPointInPoints
 anchor point in points More...
 
Vec2 _anchorPoint
 anchor point normalized (NOT in points) More...
 
var _anchorPoint
 anchor point normalized (NOT in points) More...
 
local _anchorPoint
 anchor point normalized (NOT in points) More...
 
Size _contentSize
 untransformed size of the node More...
 
var _contentSize
 untransformed size of the node More...
 
local _contentSize
 untransformed size of the node More...
 
bool _contentSizeDirty
 whether or not the contentSize is dirty More...
 
var _contentSizeDirty
 whether or not the contentSize is dirty More...
 
local _contentSizeDirty
 whether or not the contentSize is dirty More...
 
Mat4 _modelViewTransform
 ModelView transform of the Node. More...
 
var _modelViewTransform
 ModelView transform of the Node. More...
 
local _modelViewTransform
 ModelView transform of the Node. More...
 
Mat4 _transform
 transform More...
 
var _transform
 transform More...
 
local _transform
 transform More...
 
bool _transformDirty
 transform dirty flag More...
 
var _transformDirty
 transform dirty flag More...
 
local _transformDirty
 transform dirty flag More...
 
Mat4 _inverse
 inverse transform More...
 
var _inverse
 inverse transform More...
 
local _inverse
 inverse transform More...
 
bool _inverseDirty
 inverse transform dirty flag More...
 
var _inverseDirty
 inverse transform dirty flag More...
 
local _inverseDirty
 inverse transform dirty flag More...
 
Mat4 _additionalTransform
 transform More...
 
var _additionalTransform
 transform More...
 
local _additionalTransform
 transform More...
 
bool _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
var _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
local _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
bool _transformUpdated
 Whether or not the Transform object was updated since the last frame. More...
 
var _transformUpdated
 Whether or not the Transform object was updated since the last frame. More...
 
local _transformUpdated
 Whether or not the Transform object was updated since the last frame. More...
 
int _localZOrder
 Local order (relative to its siblings) used to sort the node. More...
 
var _localZOrder
 Local order (relative to its siblings) used to sort the node. More...
 
local _localZOrder
 Local order (relative to its siblings) used to sort the node. More...
 
float _globalZOrder
 Global order used to sort the node. More...
 
var _globalZOrder
 Global order used to sort the node. More...
 
local _globalZOrder
 Global order used to sort the node. More...
 
Vector< Node * > _children
 array of children nodes More...
 
var _children
 array of children nodes More...
 
local _children
 array of children nodes More...
 
Node_parent
 weak reference to parent node More...
 
var _parent
 weak reference to parent node More...
 
local _parent
 weak reference to parent node More...
 
int _tag
 a tag. Can be any number you assigned just to identify this node More...
 
var _tag
 a tag. Can be any number you assigned just to identify this node More...
 
local _tag
 a tag. Can be any number you assigned just to identify this node More...
 
std::string _name
 a string label, an user defined string to identify this node More...
 
var _name
 a string label, an user defined string to identify this node More...
 
local _name
 a string label, an user defined string to identify this node More...
 
size_t _hashOfName
 hash value of _name, used for speed in getChildByName More...
 
var _hashOfName
 hash value of _name, used for speed in getChildByName More...
 
local _hashOfName
 hash value of _name, used for speed in getChildByName More...
 
void * _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
var _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
local _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
Ref_userObject
 A user assigned Object. More...
 
var _userObject
 A user assigned Object. More...
 
local _userObject
 A user assigned Object. More...
 
GLProgramState_glProgramState
 OpenGL Program State. More...
 
var _glProgramState
 OpenGL Program State. More...
 
local _glProgramState
 OpenGL Program State. More...
 
int _orderOfArrival
 used to preserve sequence while sorting children with the same localZOrder More...
 
Scheduler_scheduler
 scheduler used to schedule timers and updates More...
 
var _scheduler
 scheduler used to schedule timers and updates More...
 
local _scheduler
 scheduler used to schedule timers and updates More...
 
ActionManager_actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
EventDispatcher_eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
var _eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
local _eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
bool _running
 is running More...
 
var _running
 is running More...
 
local _running
 is running More...
 
bool _visible
 is this node visible More...
 
var _visible
 is this node visible More...
 
local _visible
 is this node visible More...
 
bool _ignoreAnchorPointForPosition
 true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...
 
var _ignoreAnchorPointForPosition
 true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...
 
local _ignoreAnchorPointForPosition
 true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...
 
bool _reorderChildDirty
 children order dirty flag More...
 
var _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...
 
ComponentContainer_componentContainer
 Dictionary of components. More...
 
var _componentContainer
 Dictionary of components. More...
 
local _componentContainer
 Dictionary of components. More...
 
PhysicsBody_physicsBody
 the physicsBody the node have More...
 
var _physicsBody
 the physicsBody the node have More...
 
local _physicsBody
 the physicsBody the node have More...
 
float _physicsScaleStartX
 the scale x value when setPhysicsBody More...
 
var _physicsScaleStartX
 the scale x value when setPhysicsBody More...
 
local _physicsScaleStartX
 the scale x value when setPhysicsBody More...
 
float _physicsScaleStartY
 the scale y value when setPhysicsBody More...
 
var _physicsScaleStartY
 the scale y value when setPhysicsBody More...
 
local _physicsScaleStartY
 the scale y value when setPhysicsBody More...
 
GLubyte _displayedOpacity
GLubyte _realOpacity
var _realOpacity
local _realOpacity
Color3B _displayedColor
var _displayedColor
local _displayedColor
Color3B _realColor
var _realColor
local _realColor
bool _cascadeColorEnabled
var _cascadeColorEnabled
local _cascadeColorEnabled
bool _cascadeOpacityEnabled
var _cascadeOpacityEnabled
local _cascadeOpacityEnabled
unsigned short _cameraMask
var _cameraMask
local _cameraMask
std::function< void()> _onEnterCallback
var _onEnterCallback
local _onEnterCallback
std::function< void()> _onExitCallback
var _onExitCallback
local _onExitCallback
std::function< void()> _onEnterTransitionDidFinishCallback
var _onEnterTransitionDidFinishCallback
local _onEnterTransitionDidFinishCallback
std::function< void()> _onExitTransitionDidStartCallback
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 

Additional Inherited Members

- Public Types inherited from Node
enum  { FLAGS_TRANSFORM_DIRTY = (1 << 0), FLAGS_CONTENT_SIZE_DIRTY = (1 << 1), FLAGS_DIRTY_MASK = (FLAGS_TRANSFORM_DIRTY | FLAGS_CONTENT_SIZE_DIRTY) }
 
- Public Attributes inherited from Label
CC_CONSTRUCTOR_ACCESS __pad0__: Label(FontAtlas *atlas = nullptr
var __pad0__: Label(FontAtlas *atlas = nullptr
CC_CONSTRUCTOR_ACCESS
TextHAlignment 
hAlignment = TextHAlignment::LEFT
CC_CONSTRUCTOR_ACCESS
TextHAlignment TextVAlignment 
vAlignment = TextVAlignment::TOP
var vAlignment = TextVAlignment::TOP
local vAlignment = TextVAlignment::TOP
CC_CONSTRUCTOR_ACCESS
TextHAlignment TextVAlignment
bool 
useDistanceField = false
CC_CONSTRUCTOR_ACCESS
TextHAlignment TextVAlignment
bool bool 
useA8Shader = false)
- Public Attributes inherited from SpriteBatchNode
CC_CONSTRUCTOR_ACCESS __pad0__: SpriteBatchNode()
- Public Attributes inherited from Node
CC_CONSTRUCTOR_ACCESS __pad0__: Node()
- Static Public Attributes inherited from Label
static const int DistanceFieldFontSize
var DistanceFieldFontSize
local DistanceFieldFontSize
- Static Public Attributes inherited from Node
static const int INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
var INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
local INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
- Protected Types inherited from Label
enum  LabelType { TTF, BMFONT, CHARMAP, STRING_TEXTURE }
 
- Protected Member Functions inherited from TextFieldTTF
virtual bool canAttachWithIME () override
 Decide if the delegate instance is ready to receive an IME message. More...
 
var canAttachWithIME ()
 Decide if the delegate instance is ready to receive an IME message. More...
 
local canAttachWithIME ()
 Decide if the delegate instance is ready to receive an IME message. More...
 
virtual bool canDetachWithIME () override
 Decide if the delegate instance can stop receiving IME messages. More...
 
local canDetachWithIME ()
 Decide if the delegate instance can stop receiving IME messages. More...
 
virtual const std::string & getContentText () override
 Called by IMEDispatcher for text stored in delegate. More...
 
- Protected Member Functions inherited from Label
void onDraw (const Mat4 &transform, bool transformUpdated)
var onDraw ( var transform, var transformUpdated)
local onDraw ( local transform, local transformUpdated)
virtual void setFontAtlas (FontAtlas *atlas, bool distanceFieldEnabled=false, bool useA8Shader=false)
local setFontAtlas ( local atlas, local false, local false)
bool recordLetterInfo (const cocos2d::Vec2 &point, const FontLetterDefinition &letterDef, int spriteIndex)
local recordLetterInfo ( local point, local letterDef, local spriteIndex)
bool recordPlaceholderInfo (int spriteIndex)
var recordPlaceholderInfo ( var spriteIndex)
local recordPlaceholderInfo ( local spriteIndex)
void setFontScale (float fontScale)
var setFontScale ( var fontScale)
local setFontScale ( local fontScale)
virtual void alignText ()
var alignText ()
local alignText ()
bool computeHorizontalKernings (const std::u16string &stringToRender)
var computeHorizontalKernings ( var stringToRender)
local computeHorizontalKernings ( local stringToRender)
void computeStringNumLines ()
var computeStringNumLines ()
local computeStringNumLines ()
void updateQuads ()
var updateQuads ()
local updateQuads ()
virtual void updateColor () override
local updateColor ()
virtual void updateShaderProgram ()
var updateShaderProgram ()
local updateShaderProgram ()
void drawShadowWithoutBlur ()
var drawShadowWithoutBlur ()
local drawShadowWithoutBlur ()
void drawTextSprite (Renderer *renderer, uint32_t parentFlags)
var drawTextSprite ( var renderer, var parentFlags)
local drawTextSprite ( local renderer, local parentFlags)
void createSpriteWithFontDefinition ()
void updateFont ()
var updateFont ()
local updateFont ()
void reset ()
var reset ()
local reset ()
- Protected Member Functions inherited from SpriteBatchNode
void updateQuadFromSprite (Sprite *sprite, ssize_t index)
 Updates a quad at a certain index into the texture atlas. More...
 
var updateQuadFromSprite ( var sprite, var index)
 Updates a quad at a certain index into the texture atlas. More...
 
local updateQuadFromSprite ( local sprite, local index)
 Updates a quad at a certain index into the texture atlas. More...
 
void updateAtlasIndex (Sprite *sprite, ssize_t *curIndex)
local updateAtlasIndex ( local sprite, local curIndex)
void swap (ssize_t oldIndex, ssize_t newIndex)
var swap ( var oldIndex, var newIndex)
local swap ( local oldIndex, local newIndex)
void updateBlendFunc ()
var updateBlendFunc ()
local updateBlendFunc ()
- Protected Member Functions inherited from Node
void childrenAlloc (void)
 lazy allocs More...
 
var childrenAlloc ()
 lazy allocs More...
 
local childrenAlloc ()
 lazy allocs More...
 
void insertChild (Node *child, int z)
 helper that reorder a child More...
 
var insertChild ( var child, var z)
 helper that reorder a child More...
 
local insertChild ( local child, local z)
 helper that reorder a child More...
 
void detachChild (Node *child, ssize_t index, bool doCleanup)
 Removes a child, call child->onExit(), do cleanup, remove it from children array. More...
 
Vec2 convertToWindowSpace (const Vec2 &nodePoint) const
 Convert cocos2d coordinates to UI windows coordinate. More...
 
Mat4 transform (const Mat4 &parentTransform)
var transform ( var parentTransform)
local transform ( local parentTransform)
uint32_t processParentFlags (const Mat4 &parentTransform, uint32_t parentFlags)
var processParentFlags ( var parentTransform, var parentFlags)
local processParentFlags ( local parentTransform, local parentFlags)
virtual void updateCascadeOpacity ()
var updateCascadeOpacity ()
local updateCascadeOpacity ()
virtual void disableCascadeOpacity ()
local disableCascadeOpacity ()
virtual void updateCascadeColor ()
local updateCascadeColor ()
virtual void disableCascadeColor ()
var disableCascadeColor ()
local disableCascadeColor ()
bool doEnumerate (std::string name, std::function< bool(Node *)> callback) const
var doEnumerate ( var name, var callback)
local doEnumerate ( local name, local callback)
bool doEnumerateRecursive (const Node *node, const std::string &name, std::function< bool(Node *)> callback) const
var doEnumerateRecursive ( var node, var name, var callback)
local doEnumerateRecursive ( local node, local name, local callback)
bool isVisitableByVisitingCamera () const
var isVisitableByVisitingCamera ()
local isVisitableByVisitingCamera ()
void updatePhysicsBodyTransform (Scene *layer)
var updatePhysicsBodyTransform ( var layer)
local updatePhysicsBodyTransform ( local layer)
virtual void updatePhysicsBodyPosition (Scene *layer)
local updatePhysicsBodyPosition ( local layer)
virtual void updatePhysicsBodyRotation (Scene *layer)
var updatePhysicsBodyRotation ( var layer)
local updatePhysicsBodyRotation ( local layer)
virtual void updatePhysicsBodyScale (Scene *scene)
var updatePhysicsBodyScale ( var scene)
local updatePhysicsBodyScale ( local scene)
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
- 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 ()
- Static Protected Attributes inherited from Node
static int s_globalOrderOfArrival
var s_globalOrderOfArrival
local s_globalOrderOfArrival

Constructor & Destructor Documentation

Member Function Documentation

void closeIME ( )
static UICCTextField* create ( const std::string &  placeholder,
const std::string &  fontName,
float  fontSize 
)
static
void deleteBackward ( )
virtual

Called by IMEDispatcher after the user clicks the backward key.

Reimplemented from TextFieldTTF.

bool getAttachWithIME ( ) const
int getCharCount ( ) const
bool getDeleteBackward ( ) const
bool getDetachWithIME ( ) const
bool getInsertText ( ) const
int getMaxLength ( ) const
void insertText ( const char *  text,
size_t  len 
)
virtual

Called by IMEDispatcher when text input received from the IME.

Reimplemented from TextFieldTTF.

bool isMaxLengthEnabled ( ) const
bool isPasswordEnabled ( ) const
virtual void onEnter ( )
overridevirtual

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

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

Reimplemented from Node.

virtual bool
onTextFieldAttachWithIME
( TextFieldTTF sender)
overridevirtual

If the sender doesn't want to attach to the IME, return true;.

Reimplemented from TextFieldDelegate.

virtual bool
onTextFieldDeleteBackward
( TextFieldTTF sender,
const char *  delText,
size_t  nLen 
)
overridevirtual

If the sender doesn't want to delete the delText, return true;.

Reimplemented from TextFieldDelegate.

virtual bool
onTextFieldDetachWithIME
( TextFieldTTF sender)
overridevirtual

If the sender doesn't want to detach from the IME, return true;.

Reimplemented from TextFieldDelegate.

virtual bool onTextFieldInsertText ( TextFieldTTF sender,
const char *  text,
size_t  nLen 
)
overridevirtual

If the sender doesn't want to insert the text, return true;.

Reimplemented from TextFieldDelegate.

void openIME ( )
void setAttachWithIME ( bool  attach)
void setDeleteBackward ( bool  deleteBackward)
void setDetachWithIME ( bool  detach)
void setInsertText ( bool  insert)
void setMaxLength ( int  length)
void setMaxLengthEnabled ( bool  enable)
void setPasswordEnabled ( bool  enable)
void setPasswordStyleText ( const std::string &  styleText)
void setPasswordText ( const std::string &  text)

Member Data Documentation

bool _attachWithIME
protected
bool _deleteBackward
protected
bool _detachWithIME
protected
bool _insertText
protected
int _maxLength
protected
bool _maxLengthEnabled
protected
bool _passwordEnabled
protected
std::string _passwordStyleText
protected

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