类 XUILabel 继承关系图:

Functions
function XUITTFConfig	new () end

function XUITTFConfig	new (_strFilePath, _fontPointSize, _nOutline) end

function XUITTFConfig	new (_strFilePath, _fontPointSize, _nOutline, _eGlyphCollection, _pCustomGlyphCollection) end

function XUIIMFConfig	new (_strPlistFilePath, _fontPointSize) end

function XUIIMFConfig	new (_strPlistFilePath, _fontPointSize, _eGlyphCollection, _pCustomGlyphCollection) end

function XUILabel	CreateWithTTF () end

function XUILabel	CreateWithTTF (ttfConfig, strUtf8Text, nLineWidth, hAlignment, vAlignment) end

function XUILabel	CreateWithTTF (strUtf8Text, strFontFilePath, fontPointSize, nLineWidth, hAlignment, vAlignment) end

function XUILabel	CreateWithSystemFont () end

function XUILabel	CreateWithSystemFont (strUtf8Text, fontName, fontPointSize, hAlignment, vAlignment) end

function XUILabel	CreateWhithImageFont (ttfConfig) end

function XUILabel	new (hAlignment, vAlignment) end

function XUILabel	GetTypeID () end

function XUILabel	GetContentSize () end

function XUILabel	Draw (pWorld, unParentFlags) end

function XUILabel	UpdateImmediately () end

function XUILabel	SetTextPointSize (fPointSize) end

function XUILabel	GetTextPointSize () end

function XUILabel	SetEnableWrap (bEnableWrap) end

function XUILabel	GetEnableWrap () end

function XUILabel	SetString (strUtf8Text) end

function XUILabel	GetString () end

function XUILabel	GetStringCount () end

function XUILabel	SetAlignment (hAlign, vAlign) end

function XUILabel	SetHAlignMent (hAlign) end

function XUILabel	SetVAlignMent (vAlign) end

function XUILabel	GetHAlignment () end

function XUILabel	GetVAlignment () end

function XUILabel	SetDimensions (fWidth, fHeight) end

function XUILabel	GetDimensions () end

function XUILabel	SetTextColor (clr) end

function XUILabel	GetTextColor () end

function XUILabel	SetTextUpperColor (clr) end

function XUILabel	GetTextUpperColor () end

function XUILabel	SetTextLowerColor (clr) end

function XUILabel	GetTextLowerColor () end

function XUILabel	SetOutlineColor (clrOutLine) end

function XUILabel	GetOutlineColor () end

function XUILabel	SetOutlineSize (nOutlineSize) end

function XUILabel	GetOutlineSize () end

function XUILabel	SetAdditionalKerning (fAdditionalKerning) end

function XUILabel	GetAdditionalKerning () end

function XUILabel	SetLineSpacing (fLineSpacing) end

function XUILabel	GetLineSpacing () end

function XUILabel	SetTTFFontPath (strPath) end

function XUILabel	GetTTFFontPath () end

function XUILabel	SetFontPath (strPath) end

function XUILabel	GetFontPath () end

function XUILabel	SetPListPath (strPath) end

function XUILabel	GetImgFontPath () end

function XUILabel	SetBreakOfWesternWord (bBreakOfWesternWord) end

function XUILabel	GetBreakOfWesternWord () end

function XUILabel	ChangeToSystemFont () end

function XUILabel	SetSystemFontName (strFontName) end

function XUILabel	GetSystemFontName () end

function XUILabel	GetLabelType () end

function XUILabel	SetLabelType (type) end

Variables
	XUI_TV_TOP = 0

	XUI_TV_CENTER = 0

	XUI_TV_BOTTOM = 0

	XUI_TH_LEFT = 0

	XUI_TH_CENTER = 0

	XUI_TH_RIGHT = 0

	XUI_GC_DYNAMIC = 0

	XUI_GC_CUSTOM = 0

	XUITTFConfig = {}

Function Documentation

◆ ChangeToSystemFont()

function XUILabel ChangeToSystemFont ( )

切换到系统字体

Returns: void

◆ CreateWhithImageFont()

function XUILabel CreateWhithImageFont ( ttfConfig )

XUILabel_CreateWhithImageFont00

Parameters

ttfConfig XUIIMFConfig

Returns: XUILabel

◆ CreateWithSystemFont() [1/2]

function XUILabel CreateWithSystemFont ( )

基于平台相关的API创建一个默认的文本

Returns: XUILabel 返回创建的Label指针

◆ CreateWithSystemFont() [2/2]

function XUILabel CreateWithSystemFont	(	strUtf8Text	,
		fontName	,
		fontPointSize	,
		hAlignment	,
		vAlignment
	)

基于平台相关的API创建和初始化一个文本

Parameters

strUtf8Text	string 最初文本内容
fontName	string 一个字体文件或字体名称
fontPointSize	number 字体大小，这个值必须大于0
hAlignment	number 水平对齐方式
vAlignment	number 水平对齐方式

Returns: XUILabel 返回创建的Label指针

◆ CreateWithTTF() [1/3]

function XUILabel CreateWithTTF ( )

使用默认设置分配和初始化一个文本

Returns: XUILabel 控件指针

◆ CreateWithTTF() [2/3]

function XUILabel CreateWithTTF	(	ttfConfig	,
		strUtf8Text	,
		nLineWidth	,
		hAlignment	,
		vAlignment
	)

使用FreeType2库创建和初始化一个文本

Parameters

ttfConfig	XUITTFConfig ttf信息
strUtf8Text	string 最初文本内容
nLineWidth	number 线宽
hAlignment	number 水平对齐方式
vAlignment	number 水平对齐方式

Returns: XUILabel 返回创建的Label指针

◆ CreateWithTTF() [3/3]

function XUILabel CreateWithTTF	(	strUtf8Text	,
		strFontFilePath	,
		fontPointSize	,
		nLineWidth	,
		hAlignment	,
		vAlignment
	)

使用FreeType2库创建和初始化一个文本

Parameters

strUtf8Text	string 最初文本内容
strFontFilePath	string 一个TTF字体文件
fontPointSize	number 字体大小，这个值必须大于0
nLineWidth	number 线宽
hAlignment	number 水平对齐方式
vAlignment	number 水平对齐方式

Returns: XUILabel 返回创建的Label指针

◆ Draw()

function XUILabel Draw	(	pWorld	,
		unParentFlags
	)

重写这个方法来绘制你自己的节点

Parameters

pWorld	IXRenderSet 给定的世界指针
unParentFlags	number 渲染器标签

Returns: void

◆ GetAdditionalKerning()

function XUILabel GetAdditionalKerning ( )

获取文本的字间距, 仅TTF文字支持

Returns: number

◆ GetBreakOfWesternWord()

function XUILabel GetBreakOfWesternWord ( )

获取是否允许在西文单词中换行

Returns: boolean

◆ GetContentSize()

function XUILabel GetContentSize ( )

返回节点未变形状态下的大小

Returns: XVECTOR2 节点未变形状态下的大小

◆ GetDimensions()

function XUILabel GetDimensions ( )

获取文本区域

Returns: XVECTOR2

◆ GetEnableWrap()

function XUILabel GetEnableWrap ( )

获取是否自动换行

Returns: boolean

◆ GetFontPath()

function XUILabel GetFontPath ( )

XUILabel_GetFontPath00

Returns: string

◆ GetHAlignment()

function XUILabel GetHAlignment ( )

获取文本水平对齐方式

Returns: number 水平对齐方式

◆ GetImgFontPath()

function XUILabel GetImgFontPath ( )

XUILabel_GetImgFontPath00

Returns: string

◆ GetLabelType()

function XUILabel GetLabelType ( )

XUILabel_GetLabelType00

Returns: number

◆ GetLineSpacing()

function XUILabel GetLineSpacing ( )

获取文本的行间距, 仅TTF文字支持

Returns: number

◆ GetOutlineColor()

function XUILabel GetOutlineColor ( )

获取文本描边颜色

Returns: XCOLORBASE 返回描边颜色

◆ GetOutlineSize()

function XUILabel GetOutlineSize ( )

获取文本描边宽度

Returns: number 返回描边颜色

◆ GetString()

function XUILabel GetString ( )

获取文本内容

Returns: string

◆ GetStringCount()

function XUILabel GetStringCount ( )

获取文本大小

Returns: number

◆ GetSystemFontName()

function XUILabel GetSystemFontName ( )

获取系统字体名称

Returns: string

◆ GetTextColor()

function XUILabel GetTextColor ( )

获取文本颜色

Returns: XCOLORBASE 返回文本颜色

◆ GetTextLowerColor()

function XUILabel GetTextLowerColor ( )

XUILabel_GetTextLowerColor00

Returns: XCOLORBASE

◆ GetTextPointSize()

function XUILabel GetTextPointSize ( )

获取字体大小

Returns: number

◆ GetTextUpperColor()

function XUILabel GetTextUpperColor ( )

XUILabel_GetTextUpperColor00

Returns: XCOLORBASE

◆ GetTTFFontPath()

function XUILabel GetTTFFontPath ( )

XUILabel_GetTTFFontPath00

Returns: string

◆ GetTypeID()

function XUILabel GetTypeID ( )

获取类型ID

Returns: number

◆ GetVAlignment()

function XUILabel GetVAlignment ( )

获取文本垂直对齐方式

Returns: number 垂直对齐方式

◆ new() [1/6]

function XUITTFConfig new ( )

XUITTFConfig_new00

Returns: XUITTFConfig

XUIIMFConfig_new00

Returns: XUIIMFConfig

◆ new() [2/6]

function XUITTFConfig new	(	_strFilePath	,
		_fontPointSize	,
		_nOutline
	)

XUITTFConfig_new01

Parameters

_strFilePath	string
_fontPointSize	number
_nOutline	number

Returns: XUITTFConfig

◆ new() [3/6]

function XUITTFConfig new	(	_strFilePath	,
		_fontPointSize	,
		_nOutline	,
		_eGlyphCollection	,
		_pCustomGlyphCollection
	)

XUITTFConfig_new02

Parameters

_strFilePath	string
_fontPointSize	number
_nOutline	number
_eGlyphCollection	number
_pCustomGlyphCollection	string

Returns: XUITTFConfig

◆ new() [4/6]

function XUIIMFConfig new	(	_strPlistFilePath	,
		_fontPointSize
	)

XUIIMFConfig_new01

Parameters

_strPlistFilePath	string
_fontPointSize	number

Returns: XUIIMFConfig

◆ new() [5/6]

function XUIIMFConfig new	(	_strPlistFilePath	,
		_fontPointSize	,
		_eGlyphCollection	,
		_pCustomGlyphCollection
	)

XUIIMFConfig_new02

Parameters

_strPlistFilePath	string
_fontPointSize	number
_eGlyphCollection	number
_pCustomGlyphCollection	string

Returns: XUIIMFConfig

◆ new() [6/6]

function XUILabel new	(	hAlignment	,
		vAlignment
	)

XUILabel_new00

Parameters

hAlignment	number
vAlignment	number

Returns: XUILabel

◆ SetAdditionalKerning()

function XUILabel SetAdditionalKerning ( fAdditionalKerning )

获取文本描边宽度设置文本的字间距, 仅TTF文字支持

Parameters

fAdditionalKerning number 字间距值

Returns: void 返回描边颜色

◆ SetAlignment()

function XUILabel SetAlignment	(	hAlign	,
		vAlign
	)

设置文本对齐方式

Parameters

hAlign	number 水平对齐
vAlign	number 竖直对齐

Returns: void

◆ SetBreakOfWesternWord()

function XUILabel SetBreakOfWesternWord ( bBreakOfWesternWord )

设置是否允许在西文单词中换行, 仅TTF文字支持

Parameters

bBreakOfWesternWord boolean 是否在西文中换行

Returns: void

◆ SetDimensions()

function XUILabel SetDimensions	(	fWidth	,
		fHeight
	)

设置文本区域即Label的宽度和高度，按文字行最大宽度和高度自动调整

Parameters

fWidth	number
fHeight	number 高度当fHeight>0.0，且文字总高度超出fHeight，则截断文字。fWidth或fHeight为小于等于0.0，则表示大小自动适应。

Returns: void

◆ SetEnableWrap()

function XUILabel SetEnableWrap ( bEnableWrap )

设置是否自动换行

Parameters

bEnableWrap boolean 默认true，为false时，要求m_fLabelWidth>0.0f，才会进行自动换行处理。

Returns: void

◆ SetFontPath()

function XUILabel SetFontPath ( strPath )

XUILabel_SetFontPath00

Parameters

strPath string

Returns: void

◆ SetHAlignMent()

function XUILabel SetHAlignMent ( hAlign )

设置文本水平对齐方式

Parameters

hAlign number 水平对齐

Returns: void

◆ SetLabelType()

function XUILabel SetLabelType ( type )

XUILabel_SetLabelType00

Parameters

type number

Returns: void

◆ SetLineSpacing()

function XUILabel SetLineSpacing ( fLineSpacing )

设置文本的行间距, 仅TTF文字支持

Parameters

fLineSpacing number

Returns: void

◆ SetOutlineColor()

function XUILabel SetOutlineColor ( clrOutLine )

设置文本描边颜色

Parameters

clrOutLine XCOLORBASE 描边颜色

Returns: void

◆ SetOutlineSize()

function XUILabel SetOutlineSize ( nOutlineSize )

设置文本描边宽度

Parameters

nOutlineSize number

Returns: void

◆ SetPListPath()

function XUILabel SetPListPath ( strPath )

XUILabel_SetPListPath00

Parameters

strPath string

Returns: void

◆ SetString()

function XUILabel SetString ( strUtf8Text )

设置文本内容

Parameters

strUtf8Text string

Returns: void

◆ SetSystemFontName()

function XUILabel SetSystemFontName ( strFontName )

设置系统字体名称

Parameters

strFontName string 系统字体名称

Returns: void

◆ SetTextColor()

function XUILabel SetTextColor ( clr )

设置文本颜色

Parameters

clr	XCOLORBASE 文本颜色

Returns: void

◆ SetTextLowerColor()

function XUILabel SetTextLowerColor ( clr )

XUILabel_SetTextLowerColor00

Parameters

clr	XCOLORBASE

Returns: void

◆ SetTextPointSize()

function XUILabel SetTextPointSize ( fPointSize )

设置字体大小

Parameters

fPointSize number

Returns: void

◆ SetTextUpperColor()

function XUILabel SetTextUpperColor ( clr )

XUILabel_SetTextUpperColor00

Parameters

clr	XCOLORBASE

Returns: void

◆ SetTTFFontPath()

function XUILabel SetTTFFontPath ( strPath )

更改字体

Parameters

strPath string

Returns: void

◆ SetVAlignMent()

function XUILabel SetVAlignMent ( vAlign )

设置文本垂直对齐方式

Parameters

vAlign number 垂直对齐

Returns: void

◆ UpdateImmediately()

function XUILabel UpdateImmediately ( )

应用设置

Returns: void

Variable Documentation

◆ XUI_GC_CUSTOM

XUI_GC_CUSTOM = 0

◆ XUI_GC_DYNAMIC

XUI_GC_DYNAMIC = 0

◆ XUI_TH_CENTER

XUI_TH_CENTER = 0

◆ XUI_TH_LEFT

XUI_TH_LEFT = 0

◆ XUI_TH_RIGHT

XUI_TH_RIGHT = 0

◆ XUI_TV_BOTTOM

XUI_TV_BOTTOM = 0

◆ XUI_TV_CENTER

XUI_TV_CENTER = 0

◆ XUI_TV_TOP

XUI_TV_TOP = 0

◆ XUITTFConfig

XUITTFConfig = {}

Functions

Variables

Function Documentation

◆ ChangeToSystemFont()

◆ CreateWhithImageFont()

◆ CreateWithSystemFont() [1/2]

◆ CreateWithSystemFont() [2/2]

◆ CreateWithTTF() [1/3]

◆ CreateWithTTF() [2/3]

◆ CreateWithTTF() [3/3]

◆ Draw()

◆ GetAdditionalKerning()

◆ GetBreakOfWesternWord()

◆ GetContentSize()

◆ GetDimensions()

◆ GetEnableWrap()

◆ GetFontPath()

◆ GetHAlignment()

◆ GetImgFontPath()

◆ GetLabelType()

◆ GetLineSpacing()

◆ GetOutlineColor()

◆ GetOutlineSize()

◆ GetString()

◆ GetStringCount()

◆ GetSystemFontName()

◆ GetTextColor()

◆ GetTextLowerColor()

◆ GetTextPointSize()

◆ GetTextUpperColor()

◆ GetTTFFontPath()

◆ GetTypeID()

◆ GetVAlignment()

◆ new() [1/6]

◆ new() [2/6]

◆ new() [3/6]

◆ new() [4/6]

◆ new() [5/6]

◆ new() [6/6]

◆ SetAdditionalKerning()

◆ SetAlignment()

◆ SetBreakOfWesternWord()

◆ SetDimensions()

◆ SetEnableWrap()

◆ SetFontPath()

◆ SetHAlignMent()

◆ SetLabelType()

◆ SetLineSpacing()

◆ SetOutlineColor()

◆ SetOutlineSize()

◆ SetPListPath()

◆ SetString()

◆ SetSystemFontName()

◆ SetTextColor()

◆ SetTextLowerColor()

◆ SetTextPointSize()

◆ SetTextUpperColor()

◆ SetTTFFontPath()

◆ SetVAlignMent()

◆ UpdateImmediately()

Variable Documentation

◆ XUI_GC_CUSTOM

◆ XUI_GC_DYNAMIC

◆ XUI_TH_CENTER

◆ XUI_TH_LEFT

◆ XUI_TH_RIGHT

◆ XUI_TV_BOTTOM

◆ XUI_TV_CENTER

◆ XUI_TV_TOP

◆ XUITTFConfig