AR_Engine_SDK
函数 | 变量
XUILayout.lua 文件参考

#include <XUILayout.h>

类 XUILayout 继承关系图:
Inheritance graph

函数

function XUILayout Create () end
 
function XUILayout GetImage () end
 
function XUILayout LoadBackGroundTexture (strTexture, eTextureType) end
 
function XUILayout GetBackGroundTexture () end
 
function XUILayout SetPadding (fLeft, fRight, fTop, fBottom) end
 
function XUILayout SetLeftPadding (fLeft) end
 
function XUILayout SetRightPadding (fRight) end
 
function XUILayout SetTopPadding (fTop) end
 
function XUILayout SetBottomPadding (fBottom) end
 
function XUILayout GetPadding () end
 
function XUILayout GetLeftPadding () end
 
function XUILayout GetRightPadding () end
 
function XUILayout GetTopPadding () end
 
function XUILayout GetBottomPadding () end
 
function XUILayout SetSpaceX (fSpaceX) end
 
function XUILayout GetSpaceX () end
 
function XUILayout SetSpaceY (fSpaceY) end
 
function XUILayout GetSpaceY () end
 
function XUILayout SetOrder (eOrder) end
 
function XUILayout GetOrder () end
 
function XUILayout SetLineIndent (fIndent) end
 
function XUILayout GetLineIndent () end
 
function XUILayout EnableClipping (bEnabled) end
 
function XUILayout IsClippingEnabled () end
 
function XUILayout SetClippingType (eType) end
 
function XUILayout GetClippingType () end
 
function XUILayout SetLayoutType (eType) end
 
function XUILayout GetLayoutType () end
 
function XUILayout ForceDoLayout () end
 
function XUILayout RequestDoLayout () end
 
function XUILayout DoLayout () end
 
function XUILayout CreateLayoutManager () end
 
function XUILayout GetLayoutContentSize () end
 
function XUILayout SetLoopFocus (bLoop) end
 
function XUILayout IsLoopFocus () end
 
function XUILayout SetPassFocusToChild (bPass) end
 
function XUILayout IsPassFocusToChild () end
 
function XUILayout RemoveAllChildrenNV (bClean) end
 
function XUILayout EnableAutoLayout (enable) end
 
function XUILayout IsAutoLayout () end
 
function XUILayout AutoFitWidthOrHeight () end
 

变量

 XUILayout = {}
 
XUILayout XUI_ABSOLUTE = 0
 
XUILayout XUI_VERTICAL = 0
 
XUILayout XUI_HORIZONTAL = 0
 
XUILayout XUI_GRID = 0
 
XUILayout XUI_TREE = 0
 
XUILayout XUI_NORMAL = 0
 
XUILayout XUI_INVERSE = 0
 
XUILayout XUI_STENCIL = 0
 
XUILayout XUI_SCISSOR = 0
 

函数说明

◆ AutoFitWidthOrHeight()

function XUILayout AutoFitWidthOrHeight ( )

子节点自适应宽高

返回
void

◆ Create()

function XUILayout Create ( )

创建并返回一个空的控件实例的指针

返回
XUILayout 控件指针

◆ CreateLayoutManager()

function XUILayout CreateLayoutManager ( )

创建一个布局管理器

返回
XUILayoutManager 返回创建的布局管理器

◆ DoLayout()

function XUILayout DoLayout ( )

刷新该XUILayout的控件布局，更新子节点的位置 当需要刷新布局时，通常情况下使用RequestDoLayout()即可。 当需要立即获取到刷新后各子节点位置时，可以调用ForceDoLayout()。 该函数通常情况下不需要直接手动调用。

返回
void

◆ EnableAutoLayout()

function XUILayout EnableAutoLayout ( enable  )

自动排版 开启后子节点不可见时，不再占据位置

参数
enableboolean 是否开启
返回
void

◆ EnableClipping()

function XUILayout EnableClipping ( bEnabled  )

切换布局剪裁。 如果你需要裁剪,你需要传递true给这个函数

参数
bEnabledboolean 是否允许被裁切
返回
void

◆ ForceDoLayout()

function XUILayout ForceDoLayout ( )

强制刷新控件的布局，会立刻调用DoLayout()刷新布局

返回
void

◆ GetBackGroundTexture()

function XUILayout GetBackGroundTexture ( )

获取背景图片的纹理路径

返回
string 纹理文件路径名

◆ GetBottomPadding()

function XUILayout GetBottomPadding ( )

获取底部的空白填充

返回
number 底部填充大小

◆ GetClippingType()

function XUILayout GetClippingType ( )

获取layout的剪裁类型。

返回
number 剪裁类型

◆ GetImage()

function XUILayout GetImage ( )

获取图片，XUILayout默认有一张图片作为XUILayout的背景。该函数会返回这张图片的实例（XUIImage）

返回
XUIImage 图片指针

◆ GetLayoutContentSize()

function XUILayout GetLayoutContentSize ( )

获取布局区域的大小

返回
XVECTOR2 返回布局区域大小

◆ GetLayoutType()

function XUILayout GetLayoutType ( )

获取布局类型

返回
number 布局类型

◆ GetLeftPadding()

function XUILayout GetLeftPadding ( )

获取左侧的空白填充

返回
number 左侧填充大小

◆ GetLineIndent()

function XUILayout GetLineIndent ( )

XUILayout_GetLineIndent00

返回
number

◆ GetOrder()

function XUILayout GetOrder ( )

获取当前排序类型

返回
number 返回当前排序类型

◆ GetPadding()

function XUILayout GetPadding ( )

获取上下左右的空白填充

返回
number
number
number
number
void

◆ GetRightPadding()

function XUILayout GetRightPadding ( )

获取右侧的空白填充

返回
number 右侧填充大小

◆ GetSpaceX()

function XUILayout GetSpaceX ( )

获取XUILayout中，两个控件之间的横向间隔

返回
number 两个控件之间的间隔值（单位像素）

◆ GetSpaceY()

function XUILayout GetSpaceY ( )

获取XUILayout中，两个控件之间的纵向间隔

返回
number 两个控件之间的间隔值（单位像素）

◆ GetTopPadding()

function XUILayout GetTopPadding ( )

获取顶部的空白填充

返回
number 顶部填充大小

◆ IsAutoLayout()

function XUILayout IsAutoLayout ( )

XUILayout_IsAutoLayout00

返回
boolean

◆ IsClippingEnabled()

function XUILayout IsClippingEnabled ( )

获取布局是否允许被裁切

返回
boolean 是否允许被裁切

◆ IsLoopFocus()

function XUILayout IsLoopFocus ( )

如果启用了焦点循环,那么它将返回true,否则返回false。默认值是false

返回
boolean

◆ IsPassFocusToChild()

function XUILayout IsPassFocusToChild ( )

获取layout是否传递焦点到它的子节点上

返回
boolean

◆ LoadBackGroundTexture()

function XUILayout LoadBackGroundTexture ( strTexture  ,
eTextureType   
)

加载一张纹理作为XUILayout的背景图片

参数
strTexturestring 纹理文件路径名
eTextureTypenumber 纹理路径类型（相对路径/全局路径）
返回
void

◆ RemoveAllChildrenNV()

function XUILayout RemoveAllChildrenNV ( bClean  )

移除所有子节点不包括protectchildren 添加此接口是为替代原有removeallchildren接口 scrollview listview调用存在bug

参数
bCleanboolean
返回
void

◆ RequestDoLayout()

function XUILayout RequestDoLayout ( )

请求刷新控件的布局，会在渲染前调用DoLayout()刷新布局

返回
void

◆ SetBottomPadding()

function XUILayout SetBottomPadding ( fBottom  )

设置底部的空白填充

参数
fBottomnumber 底部填充大小
返回
void

◆ SetClippingType()

function XUILayout SetClippingType ( eType  )

改变layout的剪裁类型。

参数
eTypenumber 剪裁类型
返回
void

◆ SetLayoutType()

function XUILayout SetLayoutType ( eType  )

改变布局类型

参数
eTypenumber 布局类型
返回
void

◆ SetLeftPadding()

function XUILayout SetLeftPadding ( fLeft  )

设置左侧的空白填充

参数
fLeftnumber 左侧填充大小
返回
void

◆ SetLineIndent()

function XUILayout SetLineIndent ( fIndent  )

XUILayout_SetLineIndent00

参数
fIndentnumber
返回
void

◆ SetLoopFocus()

function XUILayout SetLoopFocus ( bLoop  )

如果一个布局是循环获取焦点，这意味着焦点在layout中移动

参数
bLoopboolean 传入true则设置内部焦点可以循环传递
返回
void

◆ SetOrder()

function XUILayout SetOrder ( eOrder  )

设置是否逆序排序

参数
eOrdernumber XUI_INVERSE,逆序，该Layout管理的控件会逆向布局XUI_NORMAL,正常，默认为XUI_NORMAL
返回
void

◆ SetPadding()

function XUILayout SetPadding ( fLeft  ,
fRight  ,
fTop  ,
fBottom   
)

设置上下左右的空白填充（或者说叫留白）

参数
fLeftnumber 左侧填充大小
fRightnumber 右侧填充大小
fTopnumber 顶部填充大小
fBottomnumber 底部填充大小
返回
void

◆ SetPassFocusToChild()

function XUILayout SetPassFocusToChild ( bPass  )

要指定layout是否传递焦点到它的子节点上

参数
bPassboolean
返回
void

◆ SetRightPadding()

function XUILayout SetRightPadding ( fRight  )

设置右侧的空白填充

参数
fRightnumber 右侧填充大小
返回
void

◆ SetSpaceX()

function XUILayout SetSpaceX ( fSpaceX  )

设置XUILayout中，两个控件之间的横向间隔

参数
fSpaceXnumber 间隔值（单位像素）
返回
void

◆ SetSpaceY()

function XUILayout SetSpaceY ( fSpaceY  )

设置XUILayout中，两个控件之间的纵向间隔

参数
fSpaceYnumber 间隔值（单位像素）
返回
void

◆ SetTopPadding()

function XUILayout SetTopPadding ( fTop  )

设置顶部的空白填充

参数
fTopnumber 顶部填充大小
返回
void

变量说明

◆ XUI_ABSOLUTE

XUIWidget XUI_ABSOLUTE = 0

◆ XUI_GRID

XUILayout XUI_GRID = 0

◆ XUI_HORIZONTAL

XUILayout XUI_HORIZONTAL = 0

◆ XUI_INVERSE

XUILayout XUI_INVERSE = 0

◆ XUI_NORMAL

XUILayout XUI_NORMAL = 0

◆ XUI_SCISSOR

XUILayout XUI_SCISSOR = 0

◆ XUI_STENCIL

XUILayout XUI_STENCIL = 0

◆ XUI_TREE

XUILayout XUI_TREE = 0

◆ XUI_VERTICAL

XUILayout XUI_VERTICAL = 0

◆ XUILayout

XUILayout = {}
制作者 doxygen 1.9.1