ui所需要的一些lua接口

时间:2022-08-29 21:44:34

--按钮类

--获取名字
function obj:getName()
end

--获取宽度
function obj:getWidth()
end

--获取高度
function obj:getHeight()
end

--禁用启用
function obj:setEnabled(true)
end

--获取当前禁用启用状态
function obj:isEnabled()
end

--设置触摸开始时的回调函数
--@param {function} func 回调函数,此函数接受3个参数【用户数据(默认为nil)、屏幕坐标x、屏幕坐标y】
--@param {任意数据} arg 用户数据,默认为nil
function obj:setSelectScriptFunc(func, arg)
end

--设置触摸结束时的回调函数
--@param {function} func 回调函数,此函数接受3个参数【用户数据(默认为nil)、屏幕坐标x、屏幕坐标y】
--@param {任意数据} arg 用户数据,默认为nil
function obj:setUnSelectScriptFunc(func, arg)
end

--设置点击回调函数
--@param {function} func 回调函数,此函数接受3个参数【用户数据(默认为nil)、屏幕坐标x、屏幕坐标y】
--@param {任意数据} arg 用户数据,默认为nil
function obj:setClickScriptFunc(func, arg)
end

--设置默认图片
function obj:setDefaultSkin(url)
end

--设置点击时的图片
function obj:setClickSkin(url)
end

--设置禁用时的图片
function obj:setDisableSKin(url)
end

--设置字体信息
function obj:setFontInfo(fontname, fontsize)
end

--设置文本内容
function obj:setTextString(str)
end

--设置颜色
function obj:setColorHex(colorstr)
end

--=======================================================================================================================
--复选框类

--设置选中时的图片
function obj:setSelectSkin(url)
end

--返回复选框是否被选中
function obj:isChecked()
end

--设置当前选中状态
function obj:setChecked(flag)
end

--========================================================================================================================
--图片类


--设置是否需要移动
function obj:setNeedDoMove(flag)
end

--设置当滑动时的回调函数
function obj:setOnMoveScriptFunc(func, arg)
end

--设置图片资源
function obj:setPictureByUrl(url)
end

--设置图片缩放比例
function obj:setPictureScale(scale)
end

--获取图片缩放比例
function obj:getPictureScale()
end

--=========================================================================================================================

--高亮区域

--设置高亮区域信息,注:切记已设置过此控件宽高
--@param {number} bright_width 高亮区域宽度
--@param {number} bright_height 高亮区域高度
--@param {number} bright_posx 位置x
--@param {number} bright_posy 位置y
--@param {number} backopacity 蒙板透明度,默认0.5f(0 - 1.0之间,0为全透明)
function obj:setBrightInfo(bright_width, bright_height, bright_posx, bright_posy, backopacity)
end

--按指定的图片设置高亮区域
--@param {string} url 遮罩图片url
--@param {number} bright_posx 位置x
--@param {number} bright_posy 位置y
--@param {number} backopacity 蒙板透明度,默认0.5f(0 - 1.0之间,0为全透明)
function obj:setBrightByUrl(url, bright_posx, bright_posy, backopacity)
end


--========================================================================================================================
--进度条类


--设置进度条的图片
function obj:setProgressSkin(url)
end

--设置进度条背景
function obj:setBackGround(url)
end

--设置边距
function obj:setMargin(margin_left, margin_right, margin_top, margin_bottom)
end

--设置垂直
function obj:setVertical(vertical)
end

--设置进度条当前值
function obj:setValue(value)
end

--获取进度条当前值
function obj:getValue()
end

--在指定的时间,进度值变更(当调用此接口时,进度值立即变更,之后只是进度动画效果)
--@param {number} duration 持续时间,单位:秒
--@param {number} from 进度起始,0 - 100
--@param {number} to 进度结束值,0 - 100
--@param {function} func 动画播放完毕后的回调函数
function obj:progressFromTo(duration, from, to, func)
end

--获取当前变化的进度的当前值(显示所对应的值)
--@return {number} 返回当前实时进度(0 - 100)
function obj:getNowProgressValue()
end

--=====================================================================================================================
--文本框类

--设置垂直对齐方式
function obj:setVerticalAlignment(align)
end

--设置水平对齐方式
function obj:setHorizontalAlignment(align)
end

--获取文本内容
function obj:getTextString()
end

--获取所有文本高度
function obj:getAllTextHeight()
end

--=========================================================================================================================
--html富文本框类

--设置行间距
function obj:setLeading(leading)
end

--设置文本区域大小
function obj:setSize()
end

--附加文本,返回附加此文本导致增加的行数
--@param {string} text 要附加的html格式文本
--@return {number} 返回附加的文本所增加的行数(0 - N)
function obj:appendTextString(text)
end

--从原始内容开头开始,移除指定的内容
--@param {string} deletetext 从原始文本中要删除的内容
--@return {boolean} 移除成功返回true,失败返回false
function obj:removeTextFromBegin(deletetext)
end

--移除顶部指定数量的行
--@param {number} num 要移除的数量
--@return {boolean} 移除成功返回true,失败返回false
function obj:removeTopLine(num)
end

--获取行数量
function obj:getLineNum()
end

--==================================================================================================================================
--输入框类

--是否是密码
--@return {boolean}
function obj:isPassword()
end

--设为密码类型
--@param {boolean} ispassword 为true表示密码
function obj:setIsPassword(ispassword)
end

--设置无输入内容时的显示文本
--@param {string} text
function obj:setPlaceHolder(text)
end

--设置当按下回车键时的回调函数
--@param {function} func 当按下回车键时的回调函数,此函数接受1个参数【控件名】
function obj:setEnterScriptFunc(func)
end

--打开输入法
function obj:openIME()
end

--关闭输入法
function obj:closeIME()
end

--设置光标颜色
--@param {string} colorstr 颜色字符串
function obj:setCursorColorHex(colorstr)
end


--=====================================================================================================
--滚动文本类

--获取当前是否可滑动
--@return {boolean}
function obj:getCanMove()
end

--设置当前是否可滑动
--@param {boolean} moveflag 滑动标记
function obj:setCanMove(moveflag)
end

--滑动到顶部(对水平方式来讲,为最左边)
function obj:scrollToTop()
end

--滑动到底部(相对于水平方向, 为最右边)
function obj:scrollToBottom()
end


--=======================================================
--列表类

--设置行间距
--@param {number} lineboundary 行间距
function obj:setLineBoundary(lineboundary)
end

--获取行间距
--@param {number} return 返回行间距
function obj:getLineBoundary()
end

--设置行背景
--@param {string} url 资源url
function obj:setLineItemBackGround(url)
end

--设置选中时的行图片
--@param {string} url 资源url
function obj:setLineItemSelect(url)
end

--获取行高
function obj:getLineHeight()
end

--获取显示宽度(已经减去了边距)
function obj:getShowWidth()
end

--获取显示高度(已经减去了边距)
function obj:getShowHeight()
end

--是否为垂直模式
--@return {boolean}
function obj:isVertical()
end

--\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
--获取当前是否开启滑动对齐功能
--return {boolean}\
function obj:isScrollAlign()
end

--开启/禁用滑动对齐
--@param {boolean} flag
--@retuan {boolean} 返回之前的设置
function obj:setScrollAlign(flag)
end

--可否继续向顶部继续移动(对于水平方式来讲, 为向左)
--@return {boolean}
function obj:canMoveToTop()
end

--可否继续向底部移动(对于水平方式来讲, 为向右)
function obj:canMoveToBottom()
end

--设置自动滑动时,持续减速的比率
--@param {number} rate 比率,若小于0,则是持续减速;若大于0,则是持续加速;为等于0,则速度不变
function obj:setScrollDecelerateRate(rate)
end

--获取自动滑动时,持续减速的比率
--@return {number} 返回持续减速的比率
function obj:getScrollDecelerateRate()
end

--设置自动滑动完毕时,在多少时间内移动到指定位置(例如滑动结束后的回弹)
--@param {number} time 指定时间,单位:秒
function obj:setScrollBounceDuration(time)
end

--获取自动滑动完毕时,多久移动到指定位置
--@return {number} 返回移动时间,单位:秒
function obj:getScrollBounceDuration()
end

--设置滑动的越界比率(以高度或宽度为基准)
--@param {number} rate 设置滑动时的越界比率
function obj:setScrollLimitInSetRatio(rate)
end

--获取滑动的越界比率
--@return {number} 返回滑动的越界比率 \
function obj:getScrollLimitInSetRatio()
end

--在指定的时间内使内容容器移动到指定位置
--@param {number} time 时间,单位:秒
--@param {number} posx 坐标x
--@param {number} posy 坐标y
function obj:scrollToTargetPos(time, posx, posy)
end

--获取当前是否正在自动滑动
--@return {boolean} 若当前正在自动滑动,返回true,否则返回false
function obj:isAutoMove()
end

--设置对齐处理的项判定差值
--@param {number} alignvalue
function obj:setAlignValue(alignvalue)
end
--\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\

--查找指定行中指定名称的控件
function obj:findLineControl(lineindex, controlname)
end

--获取当前选中的行号
--@return {number} 行号
function obj:getSelectLineIndex()
end

--创建新行,返回行号
function obj:createNewLine()
end

--获取行数量
--@return {number} 行的数量
function obj:getLineNum()
end

--获取指定的行对象
function obj:getLineItem(lineIndex)
end


--设置选中的指定的行此行为用户行为,不会触发相关的事件
function obj:setSelectLine(lineIndex)(此接口何用)
end

--检测指定的行是否处于显示的区域中
--@param {number} lineidx 行索引
--@return {boolean} 若此行处于显示区域,返回true,否则返回false
function obj:checkLineInShowArea(lineidx)
end

--移除指定索引的行
function obj:removeItemByIndex(index)
end

--使list中存在指定数量的行
function obj:setForRemain(num)
end

--清空所有行
function obj:clearAll()
end


--设置行被选中事件的回调函数
--@param handler 回调函数,接受1个参数【被点击的行号(有效行号为从0到maxnum-1)】
function obj:setLineSelectScriptFunc(func)
end

--设置当滑动时的回调函数
--@param {function} func 当滑动时的回调函数,此函数接受5个参数【用户数据(默认为nil)、内容区域在屏幕的当前x坐标、当前y坐标、上一次x坐标、上一次y坐标】
--@param {任意数据} arg 用户数据,默认为nil
function obj:setOnMoveScriptFunc()
end

--设置自动滑动停止时的回调函数
--@param {function} func 回调函数,此函数不接受参数
function obj:setAutoMoveStopScriptFunc(func)
end

--==================================================================
--面板类

--增加控件到面板中
--@param {LUiBase} obj 控件对象
--@return {boolean} 增加成功返回true,否则返回false
function obj:addControl(obj)
end

--查找指定名字的控件
function obj:findControl(controlname)
end

--从面板中移除指定的控件
--@param {LUiBase} uiobj 控件对象
function obj:removeControl(uiobj)
end

--从面板中移除指定名称的控件
--@param {string} controlname 控件名
function obj:removeControlByName(controlname)
end


--显示/隐藏面板
function obj:setVisible(flag)
end

--设置隐藏时的回调函数
--@param {function} func 当面板隐藏时的回调函数,此函数接受1个参数【面板名】
function obj:setHideEventScriptFunc(func)
end

--隐藏/显示指定名称的标签
--@param {string} labelname 标签名
--@param {boolean} visible 显示/隐藏
function obj:visableLabelPage(labelname, visible)
end

--================================================================================================

--UI管理器

--初始化ui管理器
--@param {EventLayer} rootlayer 根事件层
function obj:init(rootlayer)
end

--通过面板名查面板
--@param {string} panelname 面板名
--@return 若找到则返回面板对象{LPanel},否则返回nil
function obj:findPanelByeName(panelname)
end

--通过面名、控件名查找控件
--@param {string} panelname 面板名
--@param {string} controlname 控件名
--@return 若找到控件,则返回控件对象{LUiBase},否则返回nil
function obj:findControlByName(panelname, controlname)
end

--设置面板显示时的回调函数,此函数接受1个参数【面板名】
--@param {function} func 脚本回调函数
function obj:setOnPanelShowScriptFunc(func)
end

--设置面板隐藏时的回调函数,此函数接受1个参数【面板名】
--@param {function} func 脚本回调函数
function obj:setOnPanelHideScriptFunc(func)
end

--通过模板创建控件,并设置名字
--@param {string} panelname 模板面板名
--@param {string} controlname 模板控件名
--@param {string} setcontrolname 创建时使用的控件名,会把所创建的控件的名字设置为此值
--@return {LUiBase} 创建成功返回控件对象,失败返回nil
function obj:createControlFromTemplate(panelname, controlname, setcontrolname)
end

--通过模板创建面板,并设置面板名(会自动创建属于此面板的其他控件对象)
--@param {string} panelname 模板面板名
--@param {string} setpanelname 创建时使用的面板名,会把所创建的面板的名字设置为此值
--@return {LUiBase} 创建成功返回面板对象,失败返回nil
function obj:createPanelFormTempLate(panelname, setpanelname)
end

--加载面板
--@param {string} uifile ui文件路径
--@param {function} loadend_do 当加载完成后的回调函数
--@return 加载成功返回true,否则返回false
function obj:loadPanel(uifile, loadend_do)
end

--获取移动判定值
--@return {number} 返回之前的移动判定值
function obj:getMoveCompareValue()
end


--设置移动判定值(触摸开始、触摸移动事件时的距离差值大于此值则认为移动)
--@param {number} movedelay 移动判定值
function obj:setMoveCompareValue(movedelay)
end

--设置触摸开始时的hook回调函数,此时做hook处理(例如,当某个面板打开时,只要点击任何地方,此面板关闭)
--@param {function} func 当触摸开始时的回调函数,此函数接受3个参数【触摸开始时的控件所属的面板名、触摸开始的控件名、控件对象】
function obj:setSelectHookScriptFunc(func)
end

--设置触摸结束时的hook回调函数,此时做hook处理
--@param {function} func 当触摸结束时的回调函数,此函数接受3个参数【触摸结束时的控件所属的面板名、触摸结束的控件名、控件对象】
function obj:setUnSelectScriptFunc(func)
end

--取消触摸开始时的hook回调函数
function obj:unSetSelectHookScrptFunc()
end

--设置点击事件发生之前的回调函数
--@param {function} func 当ui控件点击事件发生时的回调函数,此函数接受3个参数【被点击的控件所属的面板名、被点击的控件名、控件对象】
function obj:setClickHookScriptFunc(func)
end

--取消点击事件的回调函数
function obj:unSetClickHookScriptFunc()
end

--禁用/启用所有面板的响应
--@param {boolean} enable 禁用/启用
function obj:setEnableAllVisible(enable)
end
--从UI管理器移除指定名称的面板
--@param {string} panelname 面板名
--增加面板到UI管理器中
--@param {LPanel} panel 面板对象
--@return {boolean} 返回true表示增加成功
function obj:addPanel(panel)
end

--从UI管理器中移除指定的面板
--@param {LPanel} panel 面板对象
function obj:removePanel(panel)
end

--从UI管理器移除指定名称的面板
--@param {string} panelname 面板名
function obj:removePanelByName(panelname)
end