axmol/cocos/scripting/lua-bindings/auto/api/Text.lua

192 lines
5.5 KiB
Lua
Raw Normal View History

2014-03-10 14:04:58 +08:00
--------------------------------
-- @module Text
-- @extend Widget
-- @parent_module ccui
2014-03-10 14:04:58 +08:00
--------------------------------
-- Enable shadow for the label<br>
-- todo support blur for shadow effect
-- @function [parent=#Text] enableShadow
2014-03-10 14:04:58 +08:00
-- @param self
--------------------------------
--
-- @function [parent=#Text] getFontSize
2014-03-10 14:04:58 +08:00
-- @param self
-- @return int#int ret (return value: int)
2014-03-10 14:04:58 +08:00
--------------------------------
--
-- @function [parent=#Text] getString
2014-03-10 14:04:58 +08:00
-- @param self
-- @return string#string ret (return value: string)
2014-03-10 14:04:58 +08:00
--------------------------------
-- disable shadow/outline/glow rendering
-- @function [parent=#Text] disableEffect
2014-03-10 14:04:58 +08:00
-- @param self
--------------------------------
--
-- @function [parent=#Text] getTextColor
-- @param self
-- @return color4b_table#color4b_table ret (return value: color4b_table)
2014-03-10 14:04:58 +08:00
--------------------------------
--
-- @function [parent=#Text] setTextVerticalAlignment
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #int alignment
2014-03-10 14:04:58 +08:00
--------------------------------
-- Sets the font name of label.<br>
-- If you are trying to use a system font, you could just pass a font name<br>
-- If you are trying to use a TTF, you should pass a file path to the TTF file<br>
-- Usage: Text *text = Text::create("Hello", "Arial", 20);create a system font UIText<br>
-- text->setFontName("Marfelt"); it will change the font to system font no matter the previous font type is TTF or system font<br>
-- text->setFontName("xxxx/xxx.ttf");it will change the font to TTF font no matter the previous font type is TTF or system font<br>
-- param name font name.
-- @function [parent=#Text] setFontName
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #string name
2014-03-10 14:04:58 +08:00
--------------------------------
-- Sets the touch scale enabled of label.<br>
-- param enabled touch scale enabled of label.
-- @function [parent=#Text] setTouchScaleChangeEnabled
-- @param self
-- @param #bool enabled
2014-03-10 14:04:58 +08:00
--------------------------------
--
-- @function [parent=#Text] setString
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #string text
2014-03-10 14:04:58 +08:00
--------------------------------
-- Gets the touch scale enabled of label.<br>
-- return touch scale enabled of label.
-- @function [parent=#Text] isTouchScaleChangeEnabled
2014-03-10 14:04:58 +08:00
-- @param self
-- @return bool#bool ret (return value: bool)
2014-03-10 14:04:58 +08:00
--------------------------------
--
-- @function [parent=#Text] getFontName
-- @param self
-- @return string#string ret (return value: string)
--------------------------------
--
-- @function [parent=#Text] setTextAreaSize
-- @param self
-- @param #size_table size
--------------------------------
-- Gets the string length of the label.<br>
-- Note: This length will be larger than the raw string length,<br>
-- if you want to get the raw string length, you should call this->getString().size() instead<br>
-- return string length.
-- @function [parent=#Text] getStringLength
-- @param self
-- @return long#long ret (return value: long)
--------------------------------
-- Enable outline for the label<br>
-- It only works on IOS and Android when you use System fonts
-- @function [parent=#Text] enableOutline
-- @param self
-- @param #color4b_table outlineColor
-- @param #int outlineSize
2014-03-10 14:04:58 +08:00
--------------------------------
--
-- @function [parent=#Text] getType
2014-03-10 14:04:58 +08:00
-- @param self
-- @return int#int ret (return value: int)
2014-03-10 14:04:58 +08:00
--------------------------------
--
-- @function [parent=#Text] getTextHorizontalAlignment
2014-03-10 14:04:58 +08:00
-- @param self
-- @return int#int ret (return value: int)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Sets the font size of label.<br>
-- param size font size.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Text] setFontSize
-- @param self
-- @param #int size
2014-03-10 14:04:58 +08:00
--------------------------------
--
-- @function [parent=#Text] setTextColor
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #color4b_table color
2014-03-10 14:04:58 +08:00
--------------------------------
-- only support for TTF
-- @function [parent=#Text] enableGlow
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #color4b_table glowColor
2014-03-10 14:04:58 +08:00
--------------------------------
--
-- @function [parent=#Text] getTextVerticalAlignment
-- @param self
-- @return int#int ret (return value: int)
2014-03-10 14:04:58 +08:00
--------------------------------
--
-- @function [parent=#Text] getTextAreaSize
2014-03-10 14:04:58 +08:00
-- @param self
-- @return size_table#size_table ret (return value: size_table)
2014-03-10 14:04:58 +08:00
--------------------------------
--
-- @function [parent=#Text] setTextHorizontalAlignment
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #int alignment
2014-03-10 14:04:58 +08:00
--------------------------------
-- @overload self, string, string, int
-- @overload self
-- @function [parent=#Text] create
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #string textContent
-- @param #string fontName
-- @param #int fontSize
-- @return Text#Text ret (retunr value: ccui.Text)
2014-03-10 14:04:58 +08:00
--------------------------------
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#Text] createInstance
-- @param self
-- @return Ref#Ref ret (return value: cc.Ref)
--------------------------------
--
-- @function [parent=#Text] getVirtualRenderer
-- @param self
-- @return Node#Node ret (return value: cc.Node)
--------------------------------
-- Returns the "class name" of widget.
-- @function [parent=#Text] getDescription
-- @param self
-- @return string#string ret (return value: string)
--------------------------------
--
-- @function [parent=#Text] getVirtualRendererSize
-- @param self
-- @return size_table#size_table ret (return value: size_table)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Default constructor
2014-03-10 14:04:58 +08:00
-- @function [parent=#Text] Text
-- @param self
return nil