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

224 lines
7.5 KiB
Lua
Raw Normal View History

2014-03-10 14:04:58 +08:00
--------------------------------
-- @module ListView
-- @extend ScrollView
-- @parent_module ccui
2014-03-10 14:04:58 +08:00
--------------------------------
-- Return the index of specified widget.<br>
-- param item A widget pointer.<br>
-- return The index of a given widget in ListView.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] getIndex
-- @param self
-- @param #ccui.Widget item
2014-03-10 14:04:58 +08:00
-- @return long#long ret (return value: long)
--------------------------------
-- brief Remove all items in current ListView.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] removeAllItems
-- @param self
-- @return ListView#ListView self (return value: ccui.ListView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Set the gravity of ListView.<br>
-- see `ListViewGravity`
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] setGravity
-- @param self
-- @param #int gravity
-- @return ListView#ListView self (return value: ccui.ListView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Insert a custom item into the end of ListView.<br>
-- param item A item in `Widget*`.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] pushBackCustomItem
-- @param self
-- @param #ccui.Widget item
-- @return ListView#ListView self (return value: ccui.ListView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Return all items in a ListView.<br>
-- returns A vector of widget pointers.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] getItems
-- @param self
-- @return array_table#array_table ret (return value: array_table)
--------------------------------
-- Remove a item at given index.<br>
-- param index A given index in ssize_t.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] removeItem
-- @param self
-- @param #long index
-- @return ListView#ListView self (return value: ccui.ListView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- brief Query current selected widget's idnex.<br>
-- return A index of a selected item.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] getCurSelectedIndex
-- @param self
-- @return long#long ret (return value: long)
--------------------------------
-- Insert a default item(create by cloning model) into listview at a give index.<br>
-- param index A index in ssize_t.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] insertDefaultItem
-- @param self
-- @param #long index
-- @return ListView#ListView self (return value: ccui.ListView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- brief Refresh view and layout of ListView manually.<br>
-- This method will mark ListView content as dirty and the content view will be refershed in the next frame.
-- @function [parent=#ListView] requestRefreshView
-- @param self
-- @return ListView#ListView self (return value: ccui.ListView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Set the margin between each item in ListView.<br>
-- param margin
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] setItemsMargin
-- @param self
-- @param #float margin
-- @return ListView#ListView self (return value: ccui.ListView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- brief Refresh content view of ListView.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] refreshView
-- @param self
-- @return ListView#ListView self (return value: ccui.ListView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Removes the last item of ListView.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] removeLastItem
-- @param self
-- @return ListView#ListView self (return value: ccui.ListView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- brief Query margin between each item in ListView.<br>
-- return A margin in float.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] getItemsMargin
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- Add a event click callback to ListView, then one item of Listview is clicked, the callback will be called.<br>
-- param callback A callback function with type of `ccListViewCallback`.
-- @function [parent=#ListView] addEventListener
-- @param self
-- @param #function callback
-- @return ListView#ListView self (return value: ccui.ListView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Return a item at a given index.<br>
-- param index A given index in ssize_t.<br>
-- return A widget instance.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] getItem
-- @param self
-- @param #long index
2014-03-10 14:04:58 +08:00
-- @return Widget#Widget ret (return value: ccui.Widget)
--------------------------------
-- Set a item model for listview.<br>
-- When calling @see `pushBackDefaultItem`, the model will be used as a blueprint and new model copy will be inserted into ListView.<br>
-- param model Model in `Widget*`.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] setItemModel
-- @param self
-- @param #ccui.Widget model
-- @return ListView#ListView self (return value: ccui.ListView)
2014-03-10 14:04:58 +08:00
--------------------------------
--
-- @function [parent=#ListView] doLayout
2014-03-10 14:04:58 +08:00
-- @param self
-- @return ListView#ListView self (return value: ccui.ListView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Insert a a default item(create by a cloned model) at the end of the listview.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] pushBackDefaultItem
-- @param self
-- @return ListView#ListView self (return value: ccui.ListView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- brief Insert a custom widget into ListView at a given index.<br>
-- param item A widget pointer to be inserted.<br>
-- param index A given index in ssize_t.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] insertCustomItem
-- @param self
-- @param #ccui.Widget item
-- @param #long index
-- @return ListView#ListView self (return value: ccui.ListView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Create an empty ListView.<br>
-- return A ListView instance.
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] create
-- @param self
-- @return ListView#ListView ret (return value: ccui.ListView)
--------------------------------
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] 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=#ListView] addChild
-- @param self
-- @param #cc.Node child
-- @param #int zOrder
-- @param #string name
-- @return ListView#ListView self (return value: ccui.ListView)
--------------------------------
--
-- @function [parent=#ListView] forceDoLayout
-- @param self
-- @return ListView#ListView self (return value: ccui.ListView)
--------------------------------
-- Changes scroll direction of scrollview.<br>
-- see Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll<br>
-- param dir, set the list view's scroll direction
-- @function [parent=#ListView] setDirection
-- @param self
-- @param #int dir
-- @return ListView#ListView self (return value: ccui.ListView)
--------------------------------
--
-- @function [parent=#ListView] getDescription
-- @param self
-- @return string#string ret (return value: string)
--------------------------------
--
-- @function [parent=#ListView] removeAllChildrenWithCleanup
-- @param self
-- @param #bool cleanup
-- @return ListView#ListView self (return value: ccui.ListView)
--------------------------------
--
-- @function [parent=#ListView] removeAllChildren
-- @param self
-- @return ListView#ListView self (return value: ccui.ListView)
--------------------------------
--
-- @function [parent=#ListView] removeChild
-- @param self
-- @param #cc.Node child
-- @param #bool cleaup
-- @return ListView#ListView self (return value: ccui.ListView)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Default constructor
2014-03-10 14:04:58 +08:00
-- @function [parent=#ListView] ListView
-- @param self
-- @return ListView#ListView self (return value: ccui.ListView)
2014-03-10 14:04:58 +08:00
return nil