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

363 lines
12 KiB
Lua
Raw Normal View History

2014-03-10 14:04:58 +08:00
--------------------------------
-- @module ScrollView
-- @extend Layout
-- @parent_module ccui
2014-03-10 14:04:58 +08:00
--------------------------------
-- Scroll inner container to top boundary of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] scrollToTop
-- @param self
-- @param #float time
-- @param #bool attenuated
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Scroll inner container to horizontal percent position of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] scrollToPercentHorizontal
-- @param self
-- @param #float percent
-- @param #float time
-- @param #bool attenuated
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] isInertiaScrollEnabled
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Scroll inner container to both direction percent position of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] scrollToPercentBothDirection
-- @param self
-- @param #vec2_table percent
-- @param #float time
-- @param #bool attenuated
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Gets scroll direction of scrollview.<br>
-- see Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll<br>
-- return Direction
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] getDirection
-- @param self
-- @return int#int ret (return value: int)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Scroll inner container to bottom and left boundary of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] scrollToBottomLeft
-- @param self
-- @param #float time
-- @param #bool attenuated
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Gets inner container of scrollview.<br>
-- Inner container is the container of scrollview's children.<br>
-- return inner container.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] getInnerContainer
-- @param self
-- @return Layout#Layout ret (return value: ccui.Layout)
--------------------------------
-- Move inner container to bottom boundary of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] jumpToBottom
-- @param self
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Changes scroll direction of scrollview.<br>
-- see Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll<br>
-- param dir
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] setDirection
-- @param self
-- @param #int dir
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Scroll inner container to top and left boundary of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] scrollToTopLeft
-- @param self
-- @param #float time
-- @param #bool attenuated
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Move inner container to top and right boundary of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] jumpToTopRight
-- @param self
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Move inner container to bottom and left boundary of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] jumpToBottomLeft
-- @param self
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Changes inner container size of scrollview.<br>
-- Inner container size must be larger than or equal scrollview's size.<br>
-- param inner container size.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] setInnerContainerSize
-- @param self
-- @param #size_table size
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Gets inner container size of scrollview.<br>
-- Inner container size must be larger than or equal scrollview's size.<br>
-- return inner container size.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] getInnerContainerSize
-- @param self
-- @return size_table#size_table ret (return value: size_table)
--------------------------------
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] isBounceEnabled
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Move inner container to vertical percent position of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] jumpToPercentVertical
-- @param self
-- @param #float percent
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
--
-- @function [parent=#ScrollView] addEventListener
-- @param self
-- @param #function callback
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] setInertiaScrollEnabled
-- @param self
-- @param #bool enabled
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Move inner container to top and left boundary of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] jumpToTopLeft
-- @param self
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Move inner container to horizontal percent position of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] jumpToPercentHorizontal
-- @param self
-- @param #float percent
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Move inner container to bottom and right boundary of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] jumpToBottomRight
-- @param self
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] setBounceEnabled
-- @param self
-- @param #bool enabled
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Move inner container to top boundary of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] jumpToTop
-- @param self
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Scroll inner container to left boundary of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] scrollToLeft
-- @param self
-- @param #float time
-- @param #bool attenuated
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Move inner container to both direction percent position of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] jumpToPercentBothDirection
-- @param self
-- @param #vec2_table percent
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Scroll inner container to vertical percent position of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] scrollToPercentVertical
-- @param self
-- @param #float percent
-- @param #float time
-- @param #bool attenuated
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Scroll inner container to bottom boundary of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] scrollToBottom
-- @param self
-- @param #float time
-- @param #bool attenuated
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Scroll inner container to bottom and right boundary of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] scrollToBottomRight
-- @param self
-- @param #float time
-- @param #bool attenuated
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Move inner container to left boundary of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] jumpToLeft
-- @param self
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Scroll inner container to right boundary of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] scrollToRight
-- @param self
-- @param #float time
-- @param #bool attenuated
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Move inner container to right boundary of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] jumpToRight
-- @param self
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Scroll inner container to top and right boundary of scrollview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] scrollToTopRight
-- @param self
-- @param #float time
-- @param #bool attenuated
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Allocates and initializes.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] create
-- @param self
-- @return ScrollView#ScrollView ret (return value: ccui.ScrollView)
--------------------------------
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] createInstance
-- @param self
-- @return Ref#Ref ret (return value: cc.Ref)
--------------------------------
-- @overload self, cc.Node, int
-- @overload self, cc.Node
-- @overload self, cc.Node, int, int
-- @overload self, cc.Node, int, string
-- @function [parent=#ScrollView] addChild
-- @param self
-- @param #cc.Node child
-- @param #int zOrder
-- @param #string name
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
--------------------------------
--
-- @function [parent=#ScrollView] getChildByName
-- @param self
-- @param #string name
-- @return Node#Node ret (return value: cc.Node)
--------------------------------
-- Returns the "class name" of widget.
-- @function [parent=#ScrollView] getDescription
-- @param self
-- @return string#string ret (return value: string)
--------------------------------
--
-- @function [parent=#ScrollView] update
-- @param self
-- @param #float dt
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
--------------------------------
-- Gets LayoutType.<br>
-- see LayoutType<br>
-- return LayoutType
-- @function [parent=#ScrollView] getLayoutType
-- @param self
-- @return int#int ret (return value: int)
--------------------------------
--
-- @function [parent=#ScrollView] removeAllChildrenWithCleanup
-- @param self
-- @param #bool cleanup
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
--------------------------------
--
-- @function [parent=#ScrollView] removeAllChildren
-- @param self
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
--------------------------------
-- When a widget is in a layout, you could call this method to get the next focused widget within a specified direction.<br>
-- If the widget is not in a layout, it will return itself<br>
-- param dir the direction to look for the next focused widget in a layout<br>
-- param current the current focused widget<br>
-- return the next focused widget in a layout
-- @function [parent=#ScrollView] findNextFocusedWidget
-- @param self
-- @param #int direction
-- @param #ccui.Widget current
-- @return Widget#Widget ret (return value: ccui.Widget)
--------------------------------
--
-- @function [parent=#ScrollView] removeChild
-- @param self
-- @param #cc.Node child
-- @param #bool cleaup
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
--------------------------------
-- @overload self
-- @overload self
-- @function [parent=#ScrollView] getChildren
-- @param self
-- @return array_table#array_table ret (return value: array_table)
--------------------------------
--
-- @function [parent=#ScrollView] getChildByTag
-- @param self
-- @param #int tag
-- @return Node#Node ret (return value: cc.Node)
--------------------------------
--
-- @function [parent=#ScrollView] getChildrenCount
-- @param self
-- @return long#long ret (return value: long)
--------------------------------
-- Sets LayoutType.<br>
-- see LayoutType<br>
-- param LayoutType
-- @function [parent=#ScrollView] setLayoutType
-- @param self
-- @param #int type
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Default constructor
2014-03-10 14:04:58 +08:00
-- @function [parent=#ScrollView] ScrollView
-- @param self
-- @return ScrollView#ScrollView self (return value: ccui.ScrollView)
2014-03-10 14:04:58 +08:00
return nil