类 XUIRichElement 继承关系图:

类 XUIRichElementText 继承关系图:

类 XUIRichElementImage 继承关系图:

类 XUIRichElementCustomNode 继承关系图:

类 XUIRichElementNewLine 继承关系图:

类 XUIRichText 继承关系图:

Functions
function XUIRichElement	new () end

function XUIRichElement	GetType () end

function XUIRichElement	Init (tag, color) end

function XUIRichElement	EqualType (type) end

function XUIRichElement	SetColor (color) end

function XUIRichElement	Clone () end

function XUIRichElementText	Init (tag, color, strText, strfontName, fFontSize, nflags) end

function XUIRichElementText	Init (tag, color, strText, strfontName, fFontSize, nflags, outlineColor, nOutlineSize) end

function XUIRichElementText	Init (tag, color, strText, strfontName, fFontSize, nflags, outlineColor, nOutlineSize, shadowColor) end

function XUIRichElementText	Init (tag, color, strText, strfontName, fFontSize, nflags, outlineColor, nOutlineSize, shadowColor, vShadowOffset, nShadowBlurRadius) end

function XUIRichElementText	Init (tag, color, strText, strfontName, fFontSize, nflags, outlineColor, nOutlineSize, shadowColor, vShadowOffset, nShadowBlurRadius, glowColor) end

function XUIRichElementText	Create (tag, color, strText, strfontName, fFontSize, nflags) end

function XUIRichElementText	Create (tag, color, strText, strfontName, fFontSize, nflags, outlineColor, nOutlineSize) end

function XUIRichElementText	Create (tag, color, strText, strfontName, fFontSize, nflags, outlineColor, nOutlineSize, shadowColor) end

function XUIRichElementText	Create (tag, color, strText, strfontName, fFontSize, nflags, outlineColor, nOutlineSize, shadowColor, vShadowOffset, nShadowBlurRadius) end

function XUIRichElementText	Create (tag, color, strText, strfontName, fFontSize, nflags, outlineColor, nOutlineSize, shadowColor, vShadowOffset, nShadowBlurRadius, glowColor) end

function XUIRichElementImage	Init (tag, color, filePath, eTexType) end

function XUIRichElementImage	Init (tag, color, pImage) end

function XUIRichElementImage	Create (tag, color, filePath, eTexType) end

function XUIRichElementImage	Create (tag, color, pImage) end

function XUIRichElementImage	SetWidth (nWidth) end

function XUIRichElementImage	SetHeight (nHeight) end

function XUIRichElementCustomNode	Init (nTag, color, pNode) end

function XUIRichElementCustomNode	Create (nTag, color, pNode) end

function XUIRichElementNewLine	Create (nTag, color) end

function XUIRichText	Create () end

function XUIRichText	InsertElement (pElement, nIndex) end

function XUIRichText	AddElement (pElement) end

function XUIRichText	RemoveElement (nIndex, bClean) end

function XUIRichText	RemoveElement (pElement, bClean) end

function XUIRichText	NewLine () end

function XUIRichText	GetElementsNum () end

function XUIRichText	SetVerticalSpace (fSpace) end

function XUIRichText	SetWrapMode (eWrapMode) end

function XUIRichText	GetWrapMode () end

function XUIRichText	SetVAlignmentInLine (eAlignment) end

function XUIRichText	GetVAlignmentInLine () end

function XUIRichText	FormatText () end

function XUIRichText	GetActualSize () end

Variables
	XUIRichElement = {}

XUIRichElement	XUI_TEXT = 0

XUIRichElement	XUI_IMAGE = 0

XUIRichElement	XUI_CUSTOM = 0

XUIRichElement	XUI_NEWLINE = 0

Function Documentation

◆ AddElement()

function XUIRichText AddElement ( pElement )

添加一个RichElement

Parameters

pElement XUIRichElement 要添加的RichElement

Returns: void

◆ Clone()

function XUIRichElement Clone ( )

克隆一个富文本元素，并返回新得到的元素指针

Returns: XUIRichElement

◆ Create() [1/10]

function XUIRichElementText Create	(	tag	,
		color	,
		strText	,
		strfontName	,
		fFontSize	,
		nflags
	)

XUIRichElementText_Create00

Parameters

tag	number
color	XCOLORBASE
strText	string
strfontName	string
fFontSize	number
nflags	number

Returns: XUIRichElementText

◆ Create() [2/10]

function XUIRichElementText Create	(	tag	,
		color	,
		strText	,
		strfontName	,
		fFontSize	,
		nflags	,
		outlineColor	,
		nOutlineSize
	)

通过多个变量创建一个XUIRichElementImage类

Parameters

tag	number 标签值
color	XCOLORBASE 颜色
strText	string
strfontName	string
fFontSize	number
nflags	number
outlineColor	XCOLORBASE
nOutlineSize	number

Returns: XUIRichElementText 创建的指针

◆ Create() [3/10]

function XUIRichElementText Create	(	tag	,
		color	,
		strText	,
		strfontName	,
		fFontSize	,
		nflags	,
		outlineColor	,
		nOutlineSize	,
		shadowColor
	)

通过多个变量创建一个XUIRichElementImage类

Parameters

tag	number 标签值
color	XCOLORBASE 颜色
strText	string
strfontName	string
fFontSize	number
nflags	number
outlineColor	XCOLORBASE
nOutlineSize	number
shadowColor	XCOLORBASE

Returns: XUIRichElementText 创建的指针

◆ Create() [4/10]

function XUIRichElementText Create	(	tag	,
		color	,
		strText	,
		strfontName	,
		fFontSize	,
		nflags	,
		outlineColor	,
		nOutlineSize	,
		shadowColor	,
		vShadowOffset	,
		nShadowBlurRadius
	)

XUIRichElementText_Create03

Parameters

tag	number
color	XCOLORBASE
strText	string
strfontName	string
fFontSize	number
nflags	number
outlineColor	XCOLORBASE
nOutlineSize	number
shadowColor	XCOLORBASE
vShadowOffset	XVECTOR2
nShadowBlurRadius	number

Returns: XUIRichElementText

◆ Create() [5/10]

function XUIRichElementText Create	(	tag	,
		color	,
		strText	,
		strfontName	,
		fFontSize	,
		nflags	,
		outlineColor	,
		nOutlineSize	,
		shadowColor	,
		vShadowOffset	,
		nShadowBlurRadius	,
		glowColor
	)

XUIRichElementText_Create04

Parameters

tag	number
color	XCOLORBASE
strText	string
strfontName	string
fFontSize	number
nflags	number
outlineColor	XCOLORBASE
nOutlineSize	number
shadowColor	XCOLORBASE
vShadowOffset	XVECTOR2
nShadowBlurRadius	number
glowColor	XCOLORBASE

Returns: XUIRichElementText

◆ Create() [6/10]

function XUIRichElementImage Create	(	tag	,
		color	,
		filePath	,
		eTexType
	)

XUIRichElementImage_Create00

Parameters

tag	number
color	XCOLORBASE
filePath	string
eTexType	number

Returns: XUIRichElementImage

◆ Create() [7/10]

function XUIRichElementImage Create	(	tag	,
		color	,
		pImage
	)

通过多个变量创建一个XUIRichElementImage类

Parameters

tag	number 标签值
color	XCOLORBASE 颜色
pImage	XUIImage

Returns: XUIRichElementImage 创建的指针

◆ Create() [8/10]

function XUIRichElementCustomNode Create	(	nTag	,
		color	,
		pNode
	)

XUIRichElementCustomNode_Create00

Parameters

nTag	number
color	XCOLORBASE
pNode	XUINode

Returns: XUIRichElementCustomNode

◆ Create() [9/10]

function XUIRichElementNewLine Create	(	nTag	,
		color
	)

XUIRichElementNewLine_Create00

Parameters

nTag	number
color	XCOLORBASE

Returns: XUIRichElementNewLine

◆ Create() [10/10]

function XUIRichText Create ( )

XUIRichText_Create00

Returns: XUIRichText

◆ EqualType()

function XUIRichElement EqualType ( type )

判断当前富文本元素是否是type类型的富文本元素

Parameters

type number

Returns: boolean 返回是否为传入参数类型的富文本元素。

◆ FormatText()

function XUIRichText FormatText ( )

重新排列所有的RichElement。常内部调用

Returns: void

◆ GetActualSize()

function XUIRichText GetActualSize ( )

获取实际大小

Returns: XVECTOR2 实际大小

◆ GetElementsNum()

function XUIRichText GetElementsNum ( )

获取所有元素数目

Returns: number

◆ GetType()

function XUIRichElement GetType ( )

获取类型

Returns: string

◆ GetVAlignmentInLine()

function XUIRichText GetVAlignmentInLine ( )

XUIRichText_GetVAlignmentInLine00

Returns: number

◆ GetWrapMode()

function XUIRichText GetWrapMode ( )

XUIRichText_GetWrapMode00

Returns: number

◆ Init() [1/9]

function XUIRichElement Init	(	tag	,
		color
	)

通过不同的参数初始化一个富文本元素

Parameters

tag	number 标签值
color	XCOLORBASE 颜色

Returns: boolean

◆ Init() [2/9]

function XUIRichElementText Init	(	tag	,
		color	,
		strText	,
		strfontName	,
		fFontSize	,
		nflags
	)

通过不同的参数初始化一个富文本元素

Parameters

tag	number 标签值
color	XCOLORBASE 颜色
strText	string
strfontName	string
fFontSize	number
nflags	number

Returns: boolean

◆ Init() [3/9]

function XUIRichElementText Init	(	tag	,
		color	,
		strText	,
		strfontName	,
		fFontSize	,
		nflags	,
		outlineColor	,
		nOutlineSize
	)

XUIRichElementText_Init01

Parameters

tag	number
color	XCOLORBASE
strText	string
strfontName	string
fFontSize	number
nflags	number
outlineColor	XCOLORBASE
nOutlineSize	number

Returns: boolean

◆ Init() [4/9]

function XUIRichElementText Init	(	tag	,
		color	,
		strText	,
		strfontName	,
		fFontSize	,
		nflags	,
		outlineColor	,
		nOutlineSize	,
		shadowColor
	)

通过多个变量初始化一个XUIRichElementImage类

Parameters

tag	number 标签值
color	XCOLORBASE 颜色
strText	string
strfontName	string
fFontSize	number
nflags	number
outlineColor	XCOLORBASE
nOutlineSize	number
shadowColor	XCOLORBASE

Returns: boolean 是否成功

◆ Init() [5/9]

function XUIRichElementText Init	(	tag	,
		color	,
		strText	,
		strfontName	,
		fFontSize	,
		nflags	,
		outlineColor	,
		nOutlineSize	,
		shadowColor	,
		vShadowOffset	,
		nShadowBlurRadius
	)

通过多个变量初始化一个XUIRichElementImage类

Parameters

tag	number 标签值
color	XCOLORBASE 颜色
strText	string
strfontName	string
fFontSize	number
nflags	number
outlineColor	XCOLORBASE
nOutlineSize	number
shadowColor	XCOLORBASE
vShadowOffset	XVECTOR2
nShadowBlurRadius	number

Returns: boolean 是否成功

◆ Init() [6/9]

function XUIRichElementText Init	(	tag	,
		color	,
		strText	,
		strfontName	,
		fFontSize	,
		nflags	,
		outlineColor	,
		nOutlineSize	,
		shadowColor	,
		vShadowOffset	,
		nShadowBlurRadius	,
		glowColor
	)

XUIRichElementText_Init04

Parameters

tag	number
color	XCOLORBASE
strText	string
strfontName	string
fFontSize	number
nflags	number
outlineColor	XCOLORBASE
nOutlineSize	number
shadowColor	XCOLORBASE
vShadowOffset	XVECTOR2
nShadowBlurRadius	number
glowColor	XCOLORBASE

Returns: boolean

◆ Init() [7/9]

function XUIRichElementImage Init	(	tag	,
		color	,
		filePath	,
		eTexType
	)

通过不同的参数初始化一个富文本元素

Parameters

tag	number 标签值
color	XCOLORBASE 颜色
filePath	string
eTexType	number

Returns: boolean

◆ Init() [8/9]

function XUIRichElementImage Init	(	tag	,
		color	,
		pImage
	)

XUIRichElementImage_Init01

Parameters

tag	number
color	XCOLORBASE
pImage	XUIImage

Returns: boolean

◆ Init() [9/9]

function XUIRichElementCustomNode Init	(	nTag	,
		color	,
		pNode
	)

通过不同的参数初始化一个富文本元素

Parameters

nTag	number
color	XCOLORBASE 颜色
pNode	XUINode

Returns: boolean

◆ InsertElement()

function XUIRichText InsertElement	(	pElement	,
		nIndex
	)

在指定位置插入一个RichElement

Parameters

pElement	XUIRichElement 插入的RichElement
nIndex	number 指定位置

Returns: void

◆ new()

function XUIRichElement new ( )

XUIRichElement_new00

Returns: XUIRichElement

XUIRichElementText_new00

Returns: XUIRichElementText

XUIRichElementImage_new00

Returns: XUIRichElementImage

XUIRichElementCustomNode_new00

Returns: XUIRichElementCustomNode

XUIRichElementNewLine_new00

Returns: XUIRichElementNewLine

XUIRichText_new00

Returns: XUIRichText

◆ NewLine()

function XUIRichText NewLine ( )

在富文本中新启一行，相当于加了个'
'

Returns: void

◆ RemoveElement() [1/2]

function XUIRichText RemoveElement	(	nIndex	,
		bClean
	)

删除指定索引的RichElement

Parameters

nIndex	number 指定的索引
bClean	boolean

Returns: void

◆ RemoveElement() [2/2]

function XUIRichText RemoveElement	(	pElement	,
		bClean
	)

删除指定的RichElement

Parameters

pElement	XUIRichElement 指定的元素指针
bClean	boolean

Returns: void

◆ SetColor()

function XUIRichElement SetColor ( color )

设置颜色

Parameters

color XCOLORBASE

Returns: void

◆ SetHeight()

function XUIRichElementImage SetHeight ( nHeight )

设置高度

Parameters

nHeight number

Returns: void

◆ SetVAlignmentInLine()

function XUIRichText SetVAlignmentInLine ( eAlignment )

XUIRichText_SetVAlignmentInLine00

Parameters

eAlignment number

Returns: void

◆ SetVerticalSpace()

function XUIRichText SetVerticalSpace ( fSpace )

设置每个RichElement的垂直间隔

Parameters

fSpace number 间隔值

Returns: void

◆ SetWidth()

function XUIRichElementImage SetWidth ( nWidth )

设置宽度

Parameters

nWidth number

Returns: void

◆ SetWrapMode()

function XUIRichText SetWrapMode ( eWrapMode )

XUIRichText_SetWrapMode00

Parameters

eWrapMode number

Returns: void

Variable Documentation

◆ XUI_CUSTOM

XUIRichElement XUI_CUSTOM = 0

◆ XUI_IMAGE

XUIRichElement XUI_IMAGE = 0

◆ XUI_NEWLINE

XUIRichElement XUI_NEWLINE = 0

◆ XUI_TEXT

XUIRichElement XUI_TEXT = 0

◆ XUIRichElement

XUIRichElement = {}

Functions

Variables

Function Documentation

◆ AddElement()

◆ Clone()

◆ Create() [1/10]

◆ Create() [2/10]

◆ Create() [3/10]

◆ Create() [4/10]

◆ Create() [5/10]

◆ Create() [6/10]

◆ Create() [7/10]

◆ Create() [8/10]

◆ Create() [9/10]

◆ Create() [10/10]

◆ EqualType()

◆ FormatText()

◆ GetActualSize()

◆ GetElementsNum()

◆ GetType()

◆ GetVAlignmentInLine()

◆ GetWrapMode()

◆ Init() [1/9]

◆ Init() [2/9]

◆ Init() [3/9]

◆ Init() [4/9]

◆ Init() [5/9]

◆ Init() [6/9]

◆ Init() [7/9]

◆ Init() [8/9]

◆ Init() [9/9]

◆ InsertElement()

◆ new()

◆ NewLine()

◆ RemoveElement() [1/2]

◆ RemoveElement() [2/2]

◆ SetColor()

◆ SetHeight()

◆ SetVAlignmentInLine()

◆ SetVerticalSpace()

◆ SetWidth()

◆ SetWrapMode()

Variable Documentation

◆ XUI_CUSTOM

◆ XUI_IMAGE

◆ XUI_NEWLINE

◆ XUI_TEXT

◆ XUIRichElement