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

#include <UILabel.h>

Inheritance diagram for UILabel:
UIWidget Object

Public Member Functions

 UILabel ()
 Default constructor. More...
 
 ctor ()
 Default constructor. More...
 
 UILabel ()
 Default constructor. More...
 
virtual ~UILabel ()
 Default destructor. More...
 
void setText (const std::string &text)
 Changes the string value of label. More...
 
const std::string & getStringValue ()
 Gets the string value of label. More...
 
local getStringValue ()
 Gets the string value of label. More...
 
int getStringLength ()
 Gets the string length of label. More...
 
var getStringLength ()
 Gets the string length of label. More...
 
local getStringLength ()
 Gets the string length of label. More...
 
void setFontSize (int size)
 Sets the font size of label. More...
 
var setFontSize ( var size)
 Sets the font size of label. More...
 
local setFontSize ( local size)
 Sets the font size of label. More...
 
void setFontName (const std::string &name)
 Sets the font name of label. More...
 
var setFontName ( var name)
 Sets the font name of label. More...
 
local setFontName ( local name)
 Sets the font name of label. More...
 
void setTouchScaleChangeEnabled (bool enabled)
 Sets the touch scale enabled of label. More...
 
var setTouchScaleChangeEnabled ( var enabled)
 Sets the touch scale enabled of label. More...
 
local setTouchScaleChangeEnabled ( local enabled)
 Sets the touch scale enabled of label. More...
 
bool isTouchScaleChangeEnabled ()
 Gets the touch scale enabled of label. More...
 
virtual void setScale (float fScale) override
 Changes both X and Y scale factor of the widget. More...
 
var setScale ( var fScale)
 Changes both X and Y scale factor of the widget. More...
 
local setScale ( local fScale)
 Changes both X and Y scale factor of the widget. More...
 
virtual void setScaleX (float fScaleX) override
 Changes the scale factor on X axis of this widget. More...
 
local setScaleX ( local fScaleX)
 Changes the scale factor on X axis of this widget. More...
 
virtual void setScaleY (float fScaleY) override
 Changes the scale factor on Y axis of this widget. More...
 
local setScaleY ( local fScaleY)
 Changes the scale factor on Y axis of this widget. More...
 
virtual void setFlipX (bool flipX) override
 Sets whether the widget should be flipped horizontally or not. More...
 
var setFlipX ( var flipX)
 Sets whether the widget should be flipped horizontally or not. More...
 
local setFlipX ( local flipX)
 Sets whether the widget should be flipped horizontally or not. More...
 
virtual void setFlipY (bool flipY) override
 Sets whether the widget should be flipped vertically or not. More...
 
local setFlipY ( local flipY)
 Sets whether the widget should be flipped vertically or not. More...
 
virtual bool isFlipX () override
 Returns the flag which indicates whether the widget is flipped horizontally or not. More...
 
var isFlipX ()
 Returns the flag which indicates whether the widget is flipped horizontally or not. More...
 
local isFlipX ()
 Returns the flag which indicates whether the widget is flipped horizontally or not. More...
 
virtual bool isFlipY () override
 Return the flag which indicates whether the widget is flipped vertically or not. More...
 
local isFlipY ()
 Return the flag which indicates whether the widget is flipped vertically or not. More...
 
virtual void setAnchorPoint (const cocos2d::Point &pt) override
 Sets the anchor point in percent. More...
 
var setAnchorPoint ( var pt)
 Sets the anchor point in percent. More...
 
local setAnchorPoint ( local pt)
 Sets the anchor point in percent. More...
 
virtual const cocos2d::SizegetContentSize () const override
 Gets the content size of widget. More...
 
local getContentSize ()
 Gets the content size of widget. More...
 
virtual cocos2d::NodegetVirtualRenderer () override
 Gets the Virtual Renderer of widget. More...
 
local getVirtualRenderer ()
 Gets the Virtual Renderer of widget. More...
 
virtual const char * getDescription () const override
 Returns the "class name" of widget. More...
 
var getDescription ()
 Returns the "class name" of widget. More...
 
local getDescription ()
 Returns the "class name" of widget. More...
 
void setTextAreaSize (const cocos2d::Size &size)
var setTextAreaSize ( var size)
local setTextAreaSize ( local size)
void setTextHorizontalAlignment (cocos2d::TextHAlignment alignment)
var setTextHorizontalAlignment ( var alignment)
local setTextHorizontalAlignment ( local alignment)
void setTextVerticalAlignment (cocos2d::TextVAlignment alignment)
var setTextVerticalAlignment ( var alignment)
local setTextVerticalAlignment ( local alignment)
- Public Member Functions inherited from UIWidget
 UIWidget (void)
 ctor ()
virtual ~UIWidget ()
 Default destructor. More...
 
virtual void setEnabled (bool enabled)
 Sets whether the widget is enabled. More...
 
local setEnabled ( local enabled)
 Sets whether the widget is enabled. More...
 
bool isEnabled () const
 Determines if the widget is enabled. More...
 
void setVisible (bool visible)
 Sets whether the widget is visible. More...
 
var setVisible ( var visible)
 Sets whether the widget is visible. More...
 
local setVisible ( local visible)
 Sets whether the widget is visible. More...
 
bool isVisible () const
 Determines if the widget is visible. More...
 
void setBright (bool bright)
 Sets whether the widget is bright. More...
 
bool isBright () const
 Determines if the widget is bright. More...
 
virtual void setTouchEnabled (bool enabled)
 Sets whether the widget is touch enabled. More...
 
local setTouchEnabled ( local enabled)
 Sets whether the widget is touch enabled. More...
 
void setBrightStyle (BrightStyle style)
 To set the bright style of widget. More...
 
var setBrightStyle ( var style)
 To set the bright style of widget. More...
 
local setBrightStyle ( local style)
 To set the bright style of widget. More...
 
bool isTouchEnabled () const
 Determines if the widget is touch enabled. More...
 
bool isFocused () const
 Determines if the widget is on focused. More...
 
void setFocused (bool fucosed)
 Sets whether the widget is on focused. More...
 
void setZOrder (int z)
 Sets the Z order which stands for the drawing order, and reorder this widget in its parent's children array. More...
 
int getZOrder ()
 Gets the Z order of this widget. More...
 
float getLeftInParent ()
 Gets the left boundary position of this widget. More...
 
var getLeftInParent ()
 Gets the left boundary position of this widget. More...
 
local getLeftInParent ()
 Gets the left boundary position of this widget. More...
 
float getBottomInParent ()
 Gets the bottom boundary position of this widget. More...
 
var getBottomInParent ()
 Gets the bottom boundary position of this widget. More...
 
local getBottomInParent ()
 Gets the bottom boundary position of this widget. More...
 
float getRightInParent ()
 Gets the right boundary position of this widget. More...
 
var getRightInParent ()
 Gets the right boundary position of this widget. More...
 
local getRightInParent ()
 Gets the right boundary position of this widget. More...
 
float getTopInParent ()
 Gets the top boundary position of this widget. More...
 
var getTopInParent ()
 Gets the top boundary position of this widget. More...
 
local getTopInParent ()
 Gets the top boundary position of this widget. More...
 
virtual bool addChild (UIWidget *child)
 Adds a child to the container. More...
 
var addChild ( var child)
 Adds a child to the container. More...
 
local addChild ( local child)
 Adds a child to the container. More...
 
virtual bool removeChild (UIWidget *child)
 Removes a child from the container with a cleanup. More...
 
local removeChild ( local child)
 Removes a child from the container with a cleanup. More...
 
virtual void removeFromParent ()
 Removes this widget itself from its parent widget. More...
 
local removeFromParent ()
 Removes this widget itself from its parent widget. More...
 
virtual void removeAllChildren ()
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
var removeAllChildren ()
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
local removeAllChildren ()
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
virtual void reorderChild (UIWidget *child)
 Reorders a child according to a new z value. More...
 
local reorderChild ( local child)
 Reorders a child according to a new z value. More...
 
UIWidgetgetChildByName (const char *name)
 Gets a child from the container with its name. More...
 
UIWidgetgetChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
virtual cocos2d::ArraygetChildren ()
 Return an array of children. More...
 
local getChildren ()
 Return an array of children. More...
 
cocos2d::NodegetRenderer ()
 Gets the renderer of widget. More...
 
void addRenderer (cocos2d::Node *renderer, int zOrder)
 Add a Node for rendering. More...
 
var addRenderer ( var renderer, var zOrder)
 Add a Node for rendering. More...
 
local addRenderer ( local renderer, local zOrder)
 Add a Node for rendering. More...
 
void removeRenderer (cocos2d::Node *renderer, bool cleanup)
 Remove a Node from widget. More...
 
local removeRenderer ( local renderer, local cleanup)
 Remove a Node from widget. More...
 
void setParent (UIWidget *parent)
 Sets the parent widget. More...
 
local setParent ( local parent)
 Sets the parent widget. More...
 
UIWidgetgetParent ()
 Returns a pointer to the parent widget. More...
 
void addTouchEventListener (cocos2d::Object *target, SEL_TouchEvent selector)
 Sets the touch event target/selector of the menu item. More...
 
var addTouchEventListener ( var target, var selector)
 Sets the touch event target/selector of the menu item. More...
 
local addTouchEventListener ( local target, local selector)
 Sets the touch event target/selector of the menu item. More...
 
void setPosition (const cocos2d::Point &pos)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
void setPositionPercent (const cocos2d::Point &percent)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
var setPositionPercent ( var percent)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
local setPositionPercent ( local percent)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
const cocos2d::PointgetPosition ()
 Gets the position (x,y) of the widget in OpenGL coordinates. More...
 
const cocos2d::PointgetPositionPercent ()
 Gets the percent (x,y) of the widget in OpenGL coordinates. More...
 
var getPositionPercent ()
 Gets the percent (x,y) of the widget in OpenGL coordinates. More...
 
local getPositionPercent ()
 Gets the percent (x,y) of the widget in OpenGL coordinates. More...
 
void setPositionType (PositionType type)
 Changes the position type of the widget. More...
 
PositionType getPositionType () const
 Gets the position type of the widget. More...
 
var getPositionType ()
 Gets the position type of the widget. More...
 
local getPositionType ()
 Gets the position type of the widget. More...
 
const cocos2d::PointgetAnchorPoint ()
 Returns the anchor point in percent. More...
 
local getAnchorPoint ()
 Returns the anchor point in percent. More...
 
float getScale ()
 Gets the scale factor of the widget, when X and Y have the same scale factor. More...
 
float getScaleX ()
 Returns the scale factor on X axis of this widget. More...
 
float getScaleY ()
 Returns the scale factor on Y axis of this widget. More...
 
var getScaleY ()
 Returns the scale factor on Y axis of this widget. More...
 
local getScaleY ()
 Returns the scale factor on Y axis of this widget. More...
 
void setRotation (float rotation)
 Sets the rotation (angle) of the widget in degrees. More...
 
float getRotation ()
 Returns the rotation of the widget in degrees. More...
 
void setRotationX (float rotationX)
 Sets the X rotation (angle) of the widget in degrees which performs a horizontal rotational skew. More...
 
float getRotationX ()
 Gets the X rotation (angle) of the widget in degrees which performs a horizontal rotation skew. More...
 
void setRotationY (float rotationY)
 Sets the Y rotation (angle) of the widget in degrees which performs a vertical rotational skew. More...
 
float getRotationY ()
 Gets the Y rotation (angle) of the widget in degrees which performs a vertical rotational skew. More...
 
var getRotationY ()
 Gets the Y rotation (angle) of the widget in degrees which performs a vertical rotational skew. More...
 
local getRotationY ()
 Gets the Y rotation (angle) of the widget in degrees which performs a vertical rotational skew. More...
 
virtual void setColor (const cocos2d::Color3B &color)
 Sets color to widget. More...
 
local setColor ( local color)
 Sets color to widget. More...
 
virtual const cocos2d::Color3BgetColor ()
 Gets color of widget. More...
 
local getColor ()
 Gets color of widget. More...
 
virtual void setOpacity (int opacity)
 Sets opacity to widget. More...
 
var setOpacity ( var opacity)
 Sets opacity to widget. More...
 
local setOpacity ( local opacity)
 Sets opacity to widget. More...
 
virtual int getOpacity ()
 Gets opacity of widget. More...
 
virtual bool isCascadeOpacityEnabled ()
var isCascadeOpacityEnabled ()
local isCascadeOpacityEnabled ()
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual bool isCascadeColorEnabled ()
var isCascadeColorEnabled ()
local isCascadeColorEnabled ()
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
void setBlendFunc (cocos2d::BlendFunc blendFunc)
virtual void setActionManager (cocos2d::ActionManager *actionManager)
local setActionManager ( local actionManager)
virtual cocos2d::ActionManagergetActionManager ()
local getActionManager ()
cocos2d::ActionrunAction (cocos2d::Action *action)
var runAction ( var action)
local runAction ( local action)
void stopAllActions (void)
var stopAllActions ()
local stopAllActions ()
void stopAction (cocos2d::Action *action)
var stopAction ( var action)
local stopAction ( local action)
void stopActionByTag (int tag)
var stopActionByTag ( var tag)
local stopActionByTag ( local tag)
cocos2d::ActiongetActionByTag (int tag)
var getActionByTag ( var tag)
local getActionByTag ( local tag)
void didNotSelectSelf ()
 A call back function when widget lost of focus. More...
 
var didNotSelectSelf ()
 A call back function when widget lost of focus. More...
 
local didNotSelectSelf ()
 A call back function when widget lost of focus. More...
 
bool clippingParentAreaContainPoint (const cocos2d::Point &pt)
var clippingParentAreaContainPoint ( var pt)
local clippingParentAreaContainPoint ( local pt)
virtual void checkChildInfo (int handleState, UIWidget *sender, const cocos2d::Point &touchPoint)
local checkChildInfo ( local handleState, local sender, local touchPoint)
const cocos2d::PointgetTouchStartPos ()
var getTouchStartPos ()
local getTouchStartPos ()
const cocos2d::PointgetTouchMovePos ()
local getTouchMovePos ()
const cocos2d::PointgetTouchEndPos ()
void setTag (int tag)
 Changes the tag that is used to identify the widget easily. More...
 
local setTag ( local tag)
 Changes the tag that is used to identify the widget easily. More...
 
int getTag () const
 Returns a tag that is used to identify the widget easily. More...
 
var getTag ()
 Returns a tag that is used to identify the widget easily. More...
 
local getTag ()
 Returns a tag that is used to identify the widget easily. More...
 
void setName (const char *name)
 Changes the name that is used to identify the widget easily. More...
 
var setName ( var name)
 Changes the name that is used to identify the widget easily. More...
 
local setName ( local name)
 Changes the name that is used to identify the widget easily. More...
 
const char * getName () const
 Returns a name that is used to identify the widget easily. More...
 
WidgetType getWidgetType () const
 Returns a type that is widget's type. More...
 
virtual void setSize (const cocos2d::Size &size)
 Changes the size that is widget's size. More...
 
virtual void setSizePercent (const cocos2d::Point &percent)
 Changes the percent that is widget's percent size. More...
 
local setSizePercent ( local percent)
 Changes the percent that is widget's percent size. More...
 
void setSizeType (SizeType type)
 Changes the size type of widget. More...
 
var setSizeType ( var type)
 Changes the size type of widget. More...
 
local setSizeType ( local type)
 Changes the size type of widget. More...
 
SizeType getSizeType () const
 Gets the size type of widget. More...
 
var getSizeType ()
 Gets the size type of widget. More...
 
local getSizeType ()
 Gets the size type of widget. More...
 
const cocos2d::SizegetSize () const
 Returns size of widget. More...
 
const cocos2d::PointgetSizePercent () const
 Returns size percent of widget. More...
 
local getSizePercent ()
 Returns size percent of widget. More...
 
virtual bool hitTest (const cocos2d::Point &pt)
 Checks a point if is in widget's space. More...
 
var hitTest ( var pt)
 Checks a point if is in widget's space. More...
 
local hitTest ( local pt)
 Checks a point if is in widget's space. More...
 
virtual bool onTouchBegan (const cocos2d::Point &touchPoint)
 A call back function called when widget is selected, and on touch began. More...
 
var onTouchBegan ( var touchPoint)
 A call back function called when widget is selected, and on touch began. More...
 
local onTouchBegan ( local touchPoint)
 A call back function called when widget is selected, and on touch began. More...
 
virtual void onTouchMoved (const cocos2d::Point &touchPoint)
 A call back function called when widget is selected, and on touch moved. More...
 
var onTouchMoved ( var touchPoint)
 A call back function called when widget is selected, and on touch moved. More...
 
local onTouchMoved ( local touchPoint)
 A call back function called when widget is selected, and on touch moved. More...
 
virtual void onTouchEnded (const cocos2d::Point &touchPoint)
 A call back function called when widget is selected, and on touch ended. More...
 
local onTouchEnded ( local touchPoint)
 A call back function called when widget is selected, and on touch ended. More...
 
virtual void onTouchCancelled (const cocos2d::Point &touchPoint)
 A call back function called when widget is selected, and on touch canceled. More...
 
var onTouchCancelled ( var touchPoint)
 A call back function called when widget is selected, and on touch canceled. More...
 
local onTouchCancelled ( local touchPoint)
 A call back function called when widget is selected, and on touch canceled. More...
 
virtual void onTouchLongClicked (const cocos2d::Point &touchPoint)
 A call back function called when widget is selected, and on touch long clicked. More...
 
var onTouchLongClicked ( var touchPoint)
 A call back function called when widget is selected, and on touch long clicked. More...
 
local onTouchLongClicked ( local touchPoint)
 A call back function called when widget is selected, and on touch long clicked. More...
 
void setLayoutParameter (UILayoutParameter *parameter)
 Sets a LayoutParameter to widget. More...
 
UILayoutParametergetLayoutParameter (LayoutParameterType type)
 Gets LayoutParameter of widget. More...
 
virtual void ignoreContentAdaptWithSize (bool ignore)
 Ignore the widget size. More...
 
var ignoreContentAdaptWithSize ( var ignore)
 Ignore the widget size. More...
 
local ignoreContentAdaptWithSize ( local ignore)
 Ignore the widget size. More...
 
bool isIgnoreContentAdaptWithSize () const
 Gets the widget if is ignore it's size. More...
 
var isIgnoreContentAdaptWithSize ()
 Gets the widget if is ignore it's size. More...
 
local isIgnoreContentAdaptWithSize ()
 Gets the widget if is ignore it's size. More...
 
cocos2d::Point getWorldPosition ()
 Gets world position of widget. More...
 
local getWorldPosition ()
 Gets world position of widget. More...
 
cocos2d::Point convertToWorldSpace (const cocos2d::Point &pt)
 Converts a Point to world space coordinates. More...
 
local convertToWorldSpace ( local pt)
 Converts a Point to world space coordinates. More...
 
void setUpdateEnabled (bool enable)
 Schedules the "update" method. More...
 
bool isUpdateEnabled ()
 is the "update" method scheduled. More...
 
UIWidgetclone ()
var clone ()
local clone ()
virtual void onEnter ()
virtual void onExit ()
void updateSizeAndPosition ()
var updateSizeAndPosition ()
local updateSizeAndPosition ()
virtual ObjectgetUserObject ()
virtual const ObjectgetUserObject () const
virtual void setUserObject (Object *userObject)
 Returns a user assigned Object. More...
 
void setActionTag (int tag)
var setActionTag ( var tag)
local setActionTag ( local tag)
int getActionTag ()
var getActionTag ()
local getActionTag ()
- 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)
virtual void update (float dt)

Static Public Member Functions

static UILabelcreate ()
 Allocates and initializes. More...
 
local create ()
 Allocates and initializes. More...
 
- Static Public Member Functions inherited from UIWidget
static UIWidgetcreate ()
 Allocates and initializes a widget. More...
 
local create ()
 Allocates and initializes a widget. More...
 

Protected Member Functions

virtual bool init () override
var init ()
local init ()
virtual void initRenderer () override
local initRenderer ()
virtual void onPressStateChangedToNormal () override
var onPressStateChangedToNormal ()
local onPressStateChangedToNormal ()
virtual void onPressStateChangedToPressed () override
local onPressStateChangedToPressed ()
virtual void onPressStateChangedToDisabled () override
local onPressStateChangedToDisabled ()
virtual void onSizeChanged () override
var onSizeChanged ()
local onSizeChanged ()
void clickScale (float scaleX, float scaleY)
var clickScale ( var scaleX, var scaleY)
local clickScale ( local scaleX, local scaleY)
void labelScaleChangedWithSize ()
var labelScaleChangedWithSize ()
local labelScaleChangedWithSize ()
virtual UIWidgetcreateCloneInstance () override
virtual void copySpecialProperties (UIWidget *model) override
- Protected Member Functions inherited from UIWidget
void pushDownEvent ()
var pushDownEvent ()
local pushDownEvent ()
void moveEvent ()
var moveEvent ()
local moveEvent ()
void releaseUpEvent ()
var releaseUpEvent ()
local releaseUpEvent ()
void cancelUpEvent ()
var cancelUpEvent ()
local cancelUpEvent ()
void longClickEvent ()
var longClickEvent ()
local longClickEvent ()
void updateAnchorPoint ()
var updateAnchorPoint ()
local updateAnchorPoint ()
void copyProperties (UIWidget *model)
var copyProperties ( var model)
local copyProperties ( local model)
virtual void copyClonedWidgetChildren (UIWidget *model)

Protected Attributes

bool _touchScaleChangeEnabled
float _normalScaleValueX
var _normalScaleValueX
local _normalScaleValueX
float _normalScaleValueY
var _normalScaleValueY
local _normalScaleValueY
std::string _fontName
var _fontName
local _fontName
int _fontSize
var _fontSize
local _fontSize
float _onSelectedScaleOffset
var _onSelectedScaleOffset
local _onSelectedScaleOffset
cocos2d::LabelTTF_labelRenderer
var _labelRenderer
local _labelRenderer
- Protected Attributes inherited from UIWidget
bool _enabled
 Highest control of widget. More...
 
bool _visible
 is this widget visible More...
 
var _visible
 is this widget visible More...
 
local _visible
 is this widget visible More...
 
bool _bright
 is this widget bright More...
 
var _bright
 is this widget bright More...
 
local _bright
 is this widget bright More...
 
bool _touchEnabled
 is this widget touch endabled More...
 
var _touchEnabled
 is this widget touch endabled More...
 
local _touchEnabled
 is this widget touch endabled More...
 
bool _touchPassedEnabled
 is the touch event should be passed More...
 
var _touchPassedEnabled
 is the touch event should be passed More...
 
local _touchPassedEnabled
 is the touch event should be passed More...
 
bool _focus
 is the widget on focus More...
 
int _widgetZOrder
 z-order value that affects the draw order and touch order More...
 
var _widgetZOrder
 z-order value that affects the draw order and touch order More...
 
local _widgetZOrder
 z-order value that affects the draw order and touch order More...
 
cocos2d::Point _anchorPoint
 anchor point normalized More...
 
var _anchorPoint
 anchor point normalized More...
 
local _anchorPoint
 anchor point normalized More...
 
UIWidget_widgetParent
 parent of widget More...
 
local _widgetParent
 parent of widget More...
 
BrightStyle _brightStyle
 bright style More...
 
var _brightStyle
 bright style More...
 
local _brightStyle
 bright style More...
 
bool _updateEnabled
 is "update" method scheduled More...
 
var _updateEnabled
 is "update" method scheduled More...
 
local _updateEnabled
 is "update" method scheduled More...
 
cocos2d::Node_renderer
 base renderer More...
 
var _renderer
 base renderer More...
 
local _renderer
 base renderer More...
 
cocos2d::Point _touchStartPos
 touch began point More...
 
var _touchStartPos
 touch began point More...
 
local _touchStartPos
 touch began point More...
 
cocos2d::Point _touchMovePos
 touch moved point More...
 
var _touchMovePos
 touch moved point More...
 
local _touchMovePos
 touch moved point More...
 
cocos2d::Point _touchEndPos
 touch ended point More...
 
var _touchEndPos
 touch ended point More...
 
local _touchEndPos
 touch ended point More...
 
Object_touchEventListener
local _touchEventListener
SEL_TouchEvent _touchEventSelector
var _touchEventSelector
local _touchEventSelector
int _widgetTag
var _widgetTag
local _widgetTag
std::string _name
var _name
local _name
WidgetType _widgetType
var _widgetType
local _widgetType
int _actionTag
var _actionTag
local _actionTag
cocos2d::Size _size
var _size
local _size
cocos2d::Size _customSize
var _customSize
local _customSize
cocos2d::Dictionary_layoutParameterDictionary
var _layoutParameterDictionary
local _layoutParameterDictionary
bool _ignoreSize
var _ignoreSize
local _ignoreSize
cocos2d::Array_children
var _children
local _children
bool _affectByClipping
var _affectByClipping
local _affectByClipping
cocos2d::Scheduler_scheduler
var _scheduler
local _scheduler
SizeType _sizeType
var _sizeType
local _sizeType
cocos2d::Point _sizePercent
var _sizePercent
local _sizePercent
PositionType _positionType
var _positionType
local _positionType
cocos2d::Point _positionPercent
var _positionPercent
local _positionPercent
bool _isRunning
var _isRunning
local _isRunning
cocos2d::Object_userObject
var _userObject
local _userObject
- Protected Attributes inherited from Object
unsigned int _reference
 count of references More...
 
unsigned int _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...
 

Constructor & Destructor Documentation

UILabel ( )

Default constructor.

var ctor ( )

Default constructor.

local UILabel ( )

Default constructor.

virtual ~UILabel ( )
virtual

Default destructor.

Member Function Documentation

void clickScale ( float  scaleX,
float  scaleY 
)
protected
var clickScale ( var  scaleX,
var  scaleY 
)
protected
local clickScale ( local  scaleX,
local  scaleY 
)
protected
virtual void copySpecialProperties ( UIWidget model)
overrideprotectedvirtual

Reimplemented from UIWidget.

var copySpecialProperties ( var  model)
overrideprotectedvirtual

Reimplemented from UIWidget.

local copySpecialProperties ( local  model)
overrideprotectedvirtual

Reimplemented from UIWidget.

static UILabel* create ( )
static

Allocates and initializes.

var create ( )
static

Allocates and initializes.

local create ( )
static

Allocates and initializes.

virtual UIWidget*
createCloneInstance
( )
overrideprotectedvirtual

Reimplemented from UIWidget.

var createCloneInstance ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

local createCloneInstance ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

virtual const cocos2d::Size&
getContentSize
( ) const
overridevirtual

Gets the content size of widget.

Content size is widget's texture size.

Reimplemented from UIWidget.

var getContentSize ( )
overridevirtual

Gets the content size of widget.

Content size is widget's texture size.

Reimplemented from UIWidget.

local getContentSize ( )
overridevirtual

Gets the content size of widget.

Content size is widget's texture size.

Reimplemented from UIWidget.

virtual const char* getDescription ( ) const
overridevirtual

Returns the "class name" of widget.

Reimplemented from UIWidget.

var getDescription ( )
overridevirtual

Returns the "class name" of widget.

Reimplemented from UIWidget.

local getDescription ( )
overridevirtual

Returns the "class name" of widget.

Reimplemented from UIWidget.

int getStringLength ( )

Gets the string length of label.

Returns
string length.
var getStringLength ( )

Gets the string length of label.

Returns
string length.
local getStringLength ( )

Gets the string length of label.

Returns
string length.
const std::string& getStringValue ( )

Gets the string value of label.

Returns
text string value.
var getStringValue ( )

Gets the string value of label.

Returns
text string value.
local getStringValue ( )

Gets the string value of label.

Returns
text string value.
virtual cocos2d::Node*
getVirtualRenderer
( )
overridevirtual

Gets the Virtual Renderer of widget.

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

Returns
Node pointer.

Reimplemented from UIWidget.

var getVirtualRenderer ( )
overridevirtual

Gets the Virtual Renderer of widget.

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

Returns
Node pointer.

Reimplemented from UIWidget.

local getVirtualRenderer ( )
overridevirtual

Gets the Virtual Renderer of widget.

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

Returns
Node pointer.

Reimplemented from UIWidget.

virtual bool init ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

var init ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

local init ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

virtual void initRenderer ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

var initRenderer ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

local initRenderer ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

virtual bool isFlipX ( )
overridevirtual

Returns the flag which indicates whether the widget is flipped horizontally or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleX(sprite->getScaleX() * -1);

Returns
true if the widget is flipped horizaontally, false otherwise.

Reimplemented from UIWidget.

var isFlipX ( )
overridevirtual

Returns the flag which indicates whether the widget is flipped horizontally or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleX(sprite->getScaleX() * -1);

Returns
true if the widget is flipped horizaontally, false otherwise.

Reimplemented from UIWidget.

local isFlipX ( )
overridevirtual

Returns the flag which indicates whether the widget is flipped horizontally or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleX(sprite->getScaleX() * -1);

Returns
true if the widget is flipped horizaontally, false otherwise.

Reimplemented from UIWidget.

virtual bool isFlipY ( )
overridevirtual

Return the flag which indicates whether the widget is flipped vertically or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleY(widget->getScaleY() * -1);

Returns
true if the widget is flipped vertically, flase otherwise.

Reimplemented from UIWidget.

var isFlipY ( )
overridevirtual

Return the flag which indicates whether the widget is flipped vertically or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleY(widget->getScaleY() * -1);

Returns
true if the widget is flipped vertically, flase otherwise.

Reimplemented from UIWidget.

local isFlipY ( )
overridevirtual

Return the flag which indicates whether the widget is flipped vertically or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleY(widget->getScaleY() * -1);

Returns
true if the widget is flipped vertically, flase otherwise.

Reimplemented from UIWidget.

bool isTouchScaleChangeEnabled ( )

Gets the touch scale enabled of label.

Returns
touch scale enabled of label.
var isTouchScaleChangeEnabled ( )

Gets the touch scale enabled of label.

Returns
touch scale enabled of label.
local isTouchScaleChangeEnabled ( )

Gets the touch scale enabled of label.

Returns
touch scale enabled of label.
void labelScaleChangedWithSize ( )
protected
var labelScaleChangedWithSize ( )
protected
local labelScaleChangedWithSize ( )
protected
virtual void
onPressStateChangedToDisabled
( )
overrideprotectedvirtual

Reimplemented from UIWidget.

var onPressStateChangedToDisabled ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

local onPressStateChangedToDisabled ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

virtual void
onPressStateChangedToNormal
( )
overrideprotectedvirtual

Reimplemented from UIWidget.

var onPressStateChangedToNormal ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

local onPressStateChangedToNormal ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

virtual void
onPressStateChangedToPressed
( )
overrideprotectedvirtual

Reimplemented from UIWidget.

var onPressStateChangedToPressed ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

local onPressStateChangedToPressed ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

virtual void onSizeChanged ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

var onSizeChanged ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

local onSizeChanged ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

virtual void setAnchorPoint ( const cocos2d::Point pt)
overridevirtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the widget where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the widget.

Parameters
anchorPointThe anchor point of widget.

Reimplemented from UIWidget.

var setAnchorPoint ( var  pt)
overridevirtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the widget where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the widget.

Parameters
anchorPointThe anchor point of widget.

Reimplemented from UIWidget.

local setAnchorPoint ( local  pt)
overridevirtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the widget where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the widget.

Parameters
anchorPointThe anchor point of widget.

Reimplemented from UIWidget.

virtual void setFlipX ( bool  flipX)
overridevirtual

Sets whether the widget should be flipped horizontally or not.

Parameters
bFlipXtrue if the widget should be flipped horizaontally, false otherwise.

Reimplemented from UIWidget.

var setFlipX ( var  flipX)
overridevirtual

Sets whether the widget should be flipped horizontally or not.

Parameters
bFlipXtrue if the widget should be flipped horizaontally, false otherwise.

Reimplemented from UIWidget.

local setFlipX ( local  flipX)
overridevirtual

Sets whether the widget should be flipped horizontally or not.

Parameters
bFlipXtrue if the widget should be flipped horizaontally, false otherwise.

Reimplemented from UIWidget.

virtual void setFlipY ( bool  flipY)
overridevirtual

Sets whether the widget should be flipped vertically or not.

Parameters
bFlipYtrue if the widget should be flipped vertically, flase otherwise.

Reimplemented from UIWidget.

var setFlipY ( var  flipY)
overridevirtual

Sets whether the widget should be flipped vertically or not.

Parameters
bFlipYtrue if the widget should be flipped vertically, flase otherwise.

Reimplemented from UIWidget.

local setFlipY ( local  flipY)
overridevirtual

Sets whether the widget should be flipped vertically or not.

Parameters
bFlipYtrue if the widget should be flipped vertically, flase otherwise.

Reimplemented from UIWidget.

void setFontName ( const std::string &  name)

Sets the font name of label.

Parameters
fontname.
var setFontName ( var  name)

Sets the font name of label.

Parameters
fontname.
local setFontName ( local  name)

Sets the font name of label.

Parameters
fontname.
void setFontSize ( int  size)

Sets the font size of label.

Parameters
fontsize.
var setFontSize ( var  size)

Sets the font size of label.

Parameters
fontsize.
local setFontSize ( local  size)

Sets the font size of label.

Parameters
fontsize.
virtual void setScale ( float  fScale)
overridevirtual

Changes both X and Y scale factor of the widget.

1.0 is the default scale factor. It modifies the X and Y scale at the same time.

Parameters
scaleThe scale factor for both X and Y axis.

Reimplemented from UIWidget.

var setScale ( var  fScale)
overridevirtual

Changes both X and Y scale factor of the widget.

1.0 is the default scale factor. It modifies the X and Y scale at the same time.

Parameters
scaleThe scale factor for both X and Y axis.

Reimplemented from UIWidget.

local setScale ( local  fScale)
overridevirtual

Changes both X and Y scale factor of the widget.

1.0 is the default scale factor. It modifies the X and Y scale at the same time.

Parameters
scaleThe scale factor for both X and Y axis.

Reimplemented from UIWidget.

virtual void setScaleX ( float  fScaleX)
overridevirtual

Changes the scale factor on X axis of this widget.

The deafult value is 1.0 if you haven't changed it before

Parameters
fScaleXThe scale factor on X axis.

Reimplemented from UIWidget.

var setScaleX ( var  fScaleX)
overridevirtual

Changes the scale factor on X axis of this widget.

The deafult value is 1.0 if you haven't changed it before

Parameters
fScaleXThe scale factor on X axis.

Reimplemented from UIWidget.

local setScaleX ( local  fScaleX)
overridevirtual

Changes the scale factor on X axis of this widget.

The deafult value is 1.0 if you haven't changed it before

Parameters
fScaleXThe scale factor on X axis.

Reimplemented from UIWidget.

virtual void setScaleY ( float  fScaleY)
overridevirtual

Changes the scale factor on Y axis of this widget.

The Default value is 1.0 if you haven't changed it before.

Parameters
fScaleYThe scale factor on Y axis.

Reimplemented from UIWidget.

var setScaleY ( var  fScaleY)
overridevirtual

Changes the scale factor on Y axis of this widget.

The Default value is 1.0 if you haven't changed it before.

Parameters
fScaleYThe scale factor on Y axis.

Reimplemented from UIWidget.

local setScaleY ( local  fScaleY)
overridevirtual

Changes the scale factor on Y axis of this widget.

The Default value is 1.0 if you haven't changed it before.

Parameters
fScaleYThe scale factor on Y axis.

Reimplemented from UIWidget.

void setText ( const std::string &  text)

Changes the string value of label.

Parameters
textstring value.
var setText ( var  text)

Changes the string value of label.

Parameters
textstring value.
local setText ( local  text)

Changes the string value of label.

Parameters
textstring value.
void setTextAreaSize ( const cocos2d::Size size)
var setTextAreaSize ( var  size)
local setTextAreaSize ( local  size)
void setTextHorizontalAlignment ( cocos2d::TextHAlignment  alignment)
var setTextHorizontalAlignment ( var  alignment)
local setTextHorizontalAlignment ( local  alignment)
void setTextVerticalAlignment ( cocos2d::TextVAlignment  alignment)
var setTextVerticalAlignment ( var  alignment)
local setTextVerticalAlignment ( local  alignment)
void setTouchScaleChangeEnabled ( bool  enabled)

Sets the touch scale enabled of label.

Parameters
touchscale enabled of label.
var setTouchScaleChangeEnabled ( var  enabled)

Sets the touch scale enabled of label.

Parameters
touchscale enabled of label.
local setTouchScaleChangeEnabled ( local  enabled)

Sets the touch scale enabled of label.

Parameters
touchscale enabled of label.

Member Data Documentation

std::string _fontName
protected
var _fontName
protected
local _fontName
protected
int _fontSize
protected
var _fontSize
protected
local _fontSize
protected
cocos2d::LabelTTF* _labelRenderer
protected
var _labelRenderer
protected
local _labelRenderer
protected
float _normalScaleValueX
protected
var _normalScaleValueX
protected
local _normalScaleValueX
protected
float _normalScaleValueY
protected
var _normalScaleValueY
protected
local _normalScaleValueY
protected
float _onSelectedScaleOffset
protected
var _onSelectedScaleOffset
protected
local _onSelectedScaleOffset
protected
bool _touchScaleChangeEnabled
protected
var _touchScaleChangeEnabled
protected
local _touchScaleChangeEnabled
protected

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