axmol/cocos/scripting/lua-bindings/auto/api/PageView.lua

169 lines
5.3 KiB
Lua
Raw Normal View History

2014-03-10 14:04:58 +08:00
--------------------------------
-- @module PageView
-- @extend Layout
-- @parent_module ccui
--------------------------------
-- brief Return user defined scroll page threshold
-- @function [parent=#PageView] getCustomScrollThreshold
-- @param self
-- @return float#float ret (return value: float)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Gets current page index.<br>
-- return current page index.
2014-03-10 14:04:58 +08:00
-- @function [parent=#PageView] getCurPageIndex
-- @param self
-- @return long#long ret (return value: long)
--------------------------------
-- Add a widget to a page of pageview.<br>
-- param widget widget to be added to pageview.<br>
-- param pageIdx index of page.<br>
-- param forceCreate if force create and there is no page exsit, pageview would create a default page for adding widget.
2014-03-10 14:04:58 +08:00
-- @function [parent=#PageView] addWidgetToPage
-- @param self
-- @param #ccui.Widget widget
-- @param #long pageIdx
-- @param #bool forceCreate
-- @return PageView#PageView self (return value: ccui.PageView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- brief Query whether we are using user defined scroll page threshold or not
-- @function [parent=#PageView] isUsingCustomScrollThreshold
-- @param self
-- @return bool#bool ret (return value: bool)
2014-03-10 14:04:58 +08:00
--------------------------------
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#PageView] getPage
-- @param self
-- @param #long index
2014-03-10 14:04:58 +08:00
-- @return Layout#Layout ret (return value: ccui.Layout)
--------------------------------
-- Remove a page of pageview.<br>
-- param page page which will be removed.
2014-03-10 14:04:58 +08:00
-- @function [parent=#PageView] removePage
-- @param self
-- @param #ccui.Layout page
-- @return PageView#PageView self (return value: ccui.PageView)
2014-03-10 14:04:58 +08:00
--------------------------------
--
-- @function [parent=#PageView] addEventListener
-- @param self
-- @param #function callback
-- @return PageView#PageView self (return value: ccui.PageView)
--------------------------------
-- brief Set using user defined scroll page threshold or not<br>
-- If you set it to false, then the default scroll threshold is pageView.width / 2
-- @function [parent=#PageView] setUsingCustomScrollThreshold
-- @param self
-- @param #bool flag
-- @return PageView#PageView self (return value: ccui.PageView)
--------------------------------
-- brief If you don't specify the value, the pageView will scroll when half pageview width reached
-- @function [parent=#PageView] setCustomScrollThreshold
-- @param self
-- @param #float threshold
-- @return PageView#PageView self (return value: ccui.PageView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Insert a page to pageview.<br>
-- param page page to be added to pageview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#PageView] insertPage
-- @param self
-- @param #ccui.Layout page
-- @param #int idx
-- @return PageView#PageView self (return value: ccui.PageView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- scroll pageview to index.<br>
-- param idx index of page.
2014-03-10 14:04:58 +08:00
-- @function [parent=#PageView] scrollToPage
-- @param self
-- @param #long idx
-- @return PageView#PageView self (return value: ccui.PageView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Remove a page at index of pageview.<br>
-- param index index of page.
2014-03-10 14:04:58 +08:00
-- @function [parent=#PageView] removePageAtIndex
-- @param self
-- @param #long index
-- @return PageView#PageView self (return value: ccui.PageView)
2014-03-10 14:04:58 +08:00
--------------------------------
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#PageView] getPages
-- @param self
-- @return array_table#array_table ret (return value: array_table)
--------------------------------
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#PageView] removeAllPages
-- @param self
-- @return PageView#PageView self (return value: ccui.PageView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Push back a page to pageview.<br>
-- param page page to be added to pageview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#PageView] addPage
-- @param self
-- @param #ccui.Layout page
-- @return PageView#PageView self (return value: ccui.PageView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Allocates and initializes.
2014-03-10 14:04:58 +08:00
-- @function [parent=#PageView] create
-- @param self
-- @return PageView#PageView ret (return value: ccui.PageView)
--------------------------------
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#PageView] createInstance
-- @param self
-- @return Ref#Ref ret (return value: cc.Ref)
--------------------------------
-- Gets LayoutType.<br>
-- see LayoutType<br>
-- return LayoutType
-- @function [parent=#PageView] getLayoutType
-- @param self
-- @return int#int ret (return value: int)
--------------------------------
-- Returns the "class name" of widget.
-- @function [parent=#PageView] getDescription
-- @param self
-- @return string#string ret (return value: string)
--------------------------------
--
-- @function [parent=#PageView] update
-- @param self
-- @param #float dt
-- @return PageView#PageView self (return value: ccui.PageView)
--------------------------------
-- Sets LayoutType.<br>
-- see LayoutType<br>
-- param type LayoutType
-- @function [parent=#PageView] setLayoutType
-- @param self
-- @param #int type
-- @return PageView#PageView self (return value: ccui.PageView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Default constructor
2014-03-10 14:04:58 +08:00
-- @function [parent=#PageView] PageView
-- @param self
-- @return PageView#PageView self (return value: ccui.PageView)
2014-03-10 14:04:58 +08:00
return nil