mirror of https://github.com/axmolengine/axmol.git
299 lines
9.4 KiB
Lua
299 lines
9.4 KiB
Lua
|
|
--------------------------------
|
|
-- @module Text
|
|
-- @extend Widget
|
|
-- @parent_module ccui
|
|
|
|
--------------------------------
|
|
-- Enable shadow for the label.<br>
|
|
-- todo support blur for shadow effect<br>
|
|
-- param shadowColor The color of shadow effect.<br>
|
|
-- param offset The offset of shadow effect.<br>
|
|
-- param blurRadius The blur radius of shadow effect.
|
|
-- @function [parent=#Text] enableShadow
|
|
-- @param self
|
|
-- @return Text#Text self (return value: ccui.Text)
|
|
|
|
--------------------------------
|
|
-- Gets the font size of label.<br>
|
|
-- return The font size.
|
|
-- @function [parent=#Text] getFontSize
|
|
-- @param self
|
|
-- @return float#float ret (return value: float)
|
|
|
|
--------------------------------
|
|
--
|
|
-- @function [parent=#Text] getString
|
|
-- @param self
|
|
-- @return string#string ret (return value: string)
|
|
|
|
--------------------------------
|
|
-- @overload self, int
|
|
-- @overload self
|
|
-- @function [parent=#Text] disableEffect
|
|
-- @param self
|
|
-- @param #int effect
|
|
-- @return Text#Text self (return value: ccui.Text)
|
|
|
|
--------------------------------
|
|
-- Return current effect type.
|
|
-- @function [parent=#Text] getLabelEffectType
|
|
-- @param self
|
|
-- @return int#int ret (return value: int)
|
|
|
|
--------------------------------
|
|
-- Gets text color.<br>
|
|
-- return Text color.
|
|
-- @function [parent=#Text] getTextColor
|
|
-- @param self
|
|
-- @return color4b_table#color4b_table ret (return value: color4b_table)
|
|
|
|
--------------------------------
|
|
-- Sets text vertical alignment.<br>
|
|
-- param alignment vertical text alignment type
|
|
-- @function [parent=#Text] setTextVerticalAlignment
|
|
-- @param self
|
|
-- @param #int alignment
|
|
-- @return Text#Text self (return value: ccui.Text)
|
|
|
|
--------------------------------
|
|
-- 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:<br>
|
|
-- code<br>
|
|
-- create a system font UIText<br>
|
|
-- Text *text = Text::create("Hello", "Arial", 20);<br>
|
|
-- it will change the font to system font no matter the previous font type is TTF or system font<br>
|
|
-- text->setFontName("Marfelt");<br>
|
|
-- it will change the font to TTF font no matter the previous font type is TTF or system font<br>
|
|
-- text->setFontName("xxxx/xxx.ttf");<br>
|
|
-- endcode<br>
|
|
-- param name Font name.
|
|
-- @function [parent=#Text] setFontName
|
|
-- @param self
|
|
-- @param #string name
|
|
-- @return Text#Text self (return value: ccui.Text)
|
|
|
|
--------------------------------
|
|
-- Sets the touch scale enabled of label.<br>
|
|
-- param enabled Touch scale enabled of label.
|
|
-- @function [parent=#Text] setTouchScaleChangeEnabled
|
|
-- @param self
|
|
-- @param #bool enabled
|
|
-- @return Text#Text self (return value: ccui.Text)
|
|
|
|
--------------------------------
|
|
-- Return shadow effect offset value.
|
|
-- @function [parent=#Text] getShadowOffset
|
|
-- @param self
|
|
-- @return size_table#size_table ret (return value: size_table)
|
|
|
|
--------------------------------
|
|
--
|
|
-- @function [parent=#Text] setString
|
|
-- @param self
|
|
-- @param #string text
|
|
-- @return Text#Text self (return value: ccui.Text)
|
|
|
|
--------------------------------
|
|
-- Return the outline effect size value.
|
|
-- @function [parent=#Text] getOutlineSize
|
|
-- @param self
|
|
-- @return int#int ret (return value: int)
|
|
|
|
--------------------------------
|
|
--
|
|
-- @function [parent=#Text] init
|
|
-- @param self
|
|
-- @param #string textContent
|
|
-- @param #string fontName
|
|
-- @param #float fontSize
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- Return the shadow effect blur radius.
|
|
-- @function [parent=#Text] getShadowBlurRadius
|
|
-- @param self
|
|
-- @return float#float ret (return value: float)
|
|
|
|
--------------------------------
|
|
-- Gets the touch scale enabled of label.<br>
|
|
-- return Touch scale enabled of label.
|
|
-- @function [parent=#Text] isTouchScaleChangeEnabled
|
|
-- @param self
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- Gets the font name.<br>
|
|
-- return Font name.
|
|
-- @function [parent=#Text] getFontName
|
|
-- @param self
|
|
-- @return string#string ret (return value: string)
|
|
|
|
--------------------------------
|
|
-- Sets the rendering size of the text, you should call this method<br>
|
|
-- along with calling `ignoreContentAdaptWithSize(false)`, otherwise the text area<br>
|
|
-- size is calculated by the real size of the text content.<br>
|
|
-- param size The text rendering area size.
|
|
-- @function [parent=#Text] setTextAreaSize
|
|
-- @param self
|
|
-- @param #size_table size
|
|
-- @return Text#Text self (return value: ccui.Text)
|
|
|
|
--------------------------------
|
|
-- 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,<br>
|
|
-- you should call this->getString().size() instead.<br>
|
|
-- return String length.
|
|
-- @function [parent=#Text] getStringLength
|
|
-- @param self
|
|
-- @return int#int ret (return value: int)
|
|
|
|
--------------------------------
|
|
-- Gets the render size in auto mode.<br>
|
|
-- return The size of render size in auto mode.
|
|
-- @function [parent=#Text] getAutoRenderSize
|
|
-- @param self
|
|
-- @return size_table#size_table ret (return value: size_table)
|
|
|
|
--------------------------------
|
|
-- Enable outline for the label.<br>
|
|
-- It only works on IOS and Android when you use System fonts.<br>
|
|
-- param outlineColor The color of outline.<br>
|
|
-- param outlineSize The size of outline.
|
|
-- @function [parent=#Text] enableOutline
|
|
-- @param self
|
|
-- @param #color4b_table outlineColor
|
|
-- @param #int outlineSize
|
|
-- @return Text#Text self (return value: ccui.Text)
|
|
|
|
--------------------------------
|
|
-- Return current effect color value.
|
|
-- @function [parent=#Text] getEffectColor
|
|
-- @param self
|
|
-- @return color4b_table#color4b_table ret (return value: color4b_table)
|
|
|
|
--------------------------------
|
|
-- Gets the font type.<br>
|
|
-- return The font type.
|
|
-- @function [parent=#Text] getType
|
|
-- @param self
|
|
-- @return int#int ret (return value: int)
|
|
|
|
--------------------------------
|
|
-- Gets text horizontal alignment.<br>
|
|
-- return Horizontal text alignment type
|
|
-- @function [parent=#Text] getTextHorizontalAlignment
|
|
-- @param self
|
|
-- @return int#int ret (return value: int)
|
|
|
|
--------------------------------
|
|
-- Return whether the shadow effect is enabled.
|
|
-- @function [parent=#Text] isShadowEnabled
|
|
-- @param self
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- Sets the font size of label.<br>
|
|
-- param size The font size.
|
|
-- @function [parent=#Text] setFontSize
|
|
-- @param self
|
|
-- @param #float size
|
|
-- @return Text#Text self (return value: ccui.Text)
|
|
|
|
--------------------------------
|
|
-- Return the shadow effect color value.
|
|
-- @function [parent=#Text] getShadowColor
|
|
-- @param self
|
|
-- @return color4b_table#color4b_table ret (return value: color4b_table)
|
|
|
|
--------------------------------
|
|
-- Sets text color.<br>
|
|
-- param color Text color.
|
|
-- @function [parent=#Text] setTextColor
|
|
-- @param self
|
|
-- @param #color4b_table color
|
|
-- @return Text#Text self (return value: ccui.Text)
|
|
|
|
--------------------------------
|
|
-- Only support for TTF.<br>
|
|
-- param glowColor The color of glow.
|
|
-- @function [parent=#Text] enableGlow
|
|
-- @param self
|
|
-- @param #color4b_table glowColor
|
|
-- @return Text#Text self (return value: ccui.Text)
|
|
|
|
--------------------------------
|
|
-- Gets text vertical alignment.<br>
|
|
-- return Vertical text alignment type
|
|
-- @function [parent=#Text] getTextVerticalAlignment
|
|
-- @param self
|
|
-- @return int#int ret (return value: int)
|
|
|
|
--------------------------------
|
|
-- Return the text rendering area size.<br>
|
|
-- return The text rendering area size.
|
|
-- @function [parent=#Text] getTextAreaSize
|
|
-- @param self
|
|
-- @return size_table#size_table ret (return value: size_table)
|
|
|
|
--------------------------------
|
|
-- Sets text horizontal alignment.<br>
|
|
-- param alignment Horizontal text alignment type
|
|
-- @function [parent=#Text] setTextHorizontalAlignment
|
|
-- @param self
|
|
-- @param #int alignment
|
|
-- @return Text#Text self (return value: ccui.Text)
|
|
|
|
--------------------------------
|
|
-- @overload self, string, string, float
|
|
-- @overload self
|
|
-- @function [parent=#Text] create
|
|
-- @param self
|
|
-- @param #string textContent
|
|
-- @param #string fontName
|
|
-- @param #float fontSize
|
|
-- @return Text#Text ret (return value: ccui.Text)
|
|
|
|
--------------------------------
|
|
--
|
|
-- @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)
|
|
|
|
--------------------------------
|
|
--
|
|
-- @function [parent=#Text] init
|
|
-- @param self
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- 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)
|
|
|
|
--------------------------------
|
|
-- Default constructor.<br>
|
|
-- js ctor<br>
|
|
-- lua new
|
|
-- @function [parent=#Text] Text
|
|
-- @param self
|
|
-- @return Text#Text self (return value: ccui.Text)
|
|
|
|
return nil
|