mirror of https://github.com/axmolengine/axmol.git
409 lines
16 KiB
Lua
409 lines
16 KiB
Lua
|
|
--------------------------------
|
|
-- @module LayoutComponent
|
|
-- @extend Component
|
|
-- @parent_module ccui
|
|
|
|
--------------------------------
|
|
-- Toggle enable stretch width.<br>
|
|
-- param isUsed True if enable stretch width, false otherwise.
|
|
-- @function [parent=#LayoutComponent] setStretchWidthEnabled
|
|
-- @param self
|
|
-- @param #bool isUsed
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Change percent width of owner.<br>
|
|
-- param percentWidth Percent Width in float.
|
|
-- @function [parent=#LayoutComponent] setPercentWidth
|
|
-- @param self
|
|
-- @param #float percentWidth
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Query the anchor position.<br>
|
|
-- return Anchor position to it's parent
|
|
-- @function [parent=#LayoutComponent] getAnchorPosition
|
|
-- @param self
|
|
-- @return vec2_table#vec2_table ret (return value: vec2_table)
|
|
|
|
--------------------------------
|
|
-- Toggle position percentX enabled.<br>
|
|
-- param isUsed True if enable position percentX, false otherwise.
|
|
-- @function [parent=#LayoutComponent] setPositionPercentXEnabled
|
|
-- @param self
|
|
-- @param #bool isUsed
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Toggle enable stretch height.<br>
|
|
-- param isUsed True if stretch height is enabled, false otherwise.
|
|
-- @function [parent=#LayoutComponent] setStretchHeightEnabled
|
|
-- @param self
|
|
-- @param #bool isUsed
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Toggle active enabled of LayoutComponent's owner.<br>
|
|
-- param enable True if active layout component, false otherwise.
|
|
-- @function [parent=#LayoutComponent] setActiveEnabled
|
|
-- @param self
|
|
-- @param #bool enable
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Query the right margin of owner relative to its parent.<br>
|
|
-- return Right margin in float.
|
|
-- @function [parent=#LayoutComponent] getRightMargin
|
|
-- @param self
|
|
-- @return float#float ret (return value: float)
|
|
|
|
--------------------------------
|
|
-- Query owner's content size.<br>
|
|
-- return Owner's content size.
|
|
-- @function [parent=#LayoutComponent] getSize
|
|
-- @param self
|
|
-- @return size_table#size_table ret (return value: size_table)
|
|
|
|
--------------------------------
|
|
-- Change the anchor position to it's parent.<br>
|
|
-- param point A value in (x,y) format.
|
|
-- @function [parent=#LayoutComponent] setAnchorPosition
|
|
-- @param self
|
|
-- @param #vec2_table point
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Refresh layout of the owner.
|
|
-- @function [parent=#LayoutComponent] refreshLayout
|
|
-- @param self
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Query whether percent width is enabled or not.<br>
|
|
-- return True if percent width is enabled, false, otherwise.
|
|
-- @function [parent=#LayoutComponent] isPercentWidthEnabled
|
|
-- @param self
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- Change element's vertical dock type.<br>
|
|
-- param vEage Vertical dock type @see `VerticalEdge`.
|
|
-- @function [parent=#LayoutComponent] setVerticalEdge
|
|
-- @param self
|
|
-- @param #int vEage
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Query the top margin of owner relative to its parent.<br>
|
|
-- return Top margin in float.
|
|
-- @function [parent=#LayoutComponent] getTopMargin
|
|
-- @param self
|
|
-- @return float#float ret (return value: float)
|
|
|
|
--------------------------------
|
|
-- Change content size width of owner.<br>
|
|
-- param width Content size width in float.
|
|
-- @function [parent=#LayoutComponent] setSizeWidth
|
|
-- @param self
|
|
-- @param #float width
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Query the percent content size value.<br>
|
|
-- return Percet (x,y) in Vec2.
|
|
-- @function [parent=#LayoutComponent] getPercentContentSize
|
|
-- @param self
|
|
-- @return vec2_table#vec2_table ret (return value: vec2_table)
|
|
|
|
--------------------------------
|
|
-- Query element vertical dock type.<br>
|
|
-- return Vertical dock type.
|
|
-- @function [parent=#LayoutComponent] getVerticalEdge
|
|
-- @param self
|
|
-- @return int#int ret (return value: int)
|
|
|
|
--------------------------------
|
|
-- Toggle enable percent width.<br>
|
|
-- param isUsed True if percent width is enabled, false otherwise.
|
|
-- @function [parent=#LayoutComponent] setPercentWidthEnabled
|
|
-- @param self
|
|
-- @param #bool isUsed
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Query whether stretch width is enabled or not.<br>
|
|
-- return True if stretch width is enabled, false otherwise.
|
|
-- @function [parent=#LayoutComponent] isStretchWidthEnabled
|
|
-- @param self
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- Change left margin of owner relative to its parent.<br>
|
|
-- param margin Margin in float.
|
|
-- @function [parent=#LayoutComponent] setLeftMargin
|
|
-- @param self
|
|
-- @param #float margin
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Query content size width of owner.<br>
|
|
-- return Content size width in float.
|
|
-- @function [parent=#LayoutComponent] getSizeWidth
|
|
-- @param self
|
|
-- @return float#float ret (return value: float)
|
|
|
|
--------------------------------
|
|
-- Toggle position percentY enabled.<br>
|
|
-- param isUsed True if position percentY is enabled, false otherwise.
|
|
-- @function [parent=#LayoutComponent] setPositionPercentYEnabled
|
|
-- @param self
|
|
-- @param #bool isUsed
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Query size height of owner.<br>
|
|
-- return Size height in float.
|
|
-- @function [parent=#LayoutComponent] getSizeHeight
|
|
-- @param self
|
|
-- @return float#float ret (return value: float)
|
|
|
|
--------------------------------
|
|
-- Query the position percentY Y value.<br>
|
|
-- return Position percent Y value in float.
|
|
-- @function [parent=#LayoutComponent] getPositionPercentY
|
|
-- @param self
|
|
-- @return float#float ret (return value: float)
|
|
|
|
--------------------------------
|
|
-- Query the position percent X value.<br>
|
|
-- return Position percent X value in float.
|
|
-- @function [parent=#LayoutComponent] getPositionPercentX
|
|
-- @param self
|
|
-- @return float#float ret (return value: float)
|
|
|
|
--------------------------------
|
|
-- Change the top margin of owner relative to its parent.<br>
|
|
-- param margin Margin in float.
|
|
-- @function [parent=#LayoutComponent] setTopMargin
|
|
-- @param self
|
|
-- @param #float margin
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Query percent height of owner. <br>
|
|
-- return Percent height in float.
|
|
-- @function [parent=#LayoutComponent] getPercentHeight
|
|
-- @param self
|
|
-- @return float#float ret (return value: float)
|
|
|
|
--------------------------------
|
|
-- Query whether use percent content size or not.<br>
|
|
-- return True if using percent content size, false otherwise.
|
|
-- @function [parent=#LayoutComponent] getUsingPercentContentSize
|
|
-- @param self
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- Change position percentY value.<br>
|
|
-- param percentMargin Margin in float.
|
|
-- @function [parent=#LayoutComponent] setPositionPercentY
|
|
-- @param self
|
|
-- @param #float percentMargin
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Change position percent X value.<br>
|
|
-- param percentMargin Margin in float.
|
|
-- @function [parent=#LayoutComponent] setPositionPercentX
|
|
-- @param self
|
|
-- @param #float percentMargin
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Change right margin of owner relative to its parent.<br>
|
|
-- param margin Margin in float.
|
|
-- @function [parent=#LayoutComponent] setRightMargin
|
|
-- @param self
|
|
-- @param #float margin
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Whether position percentY is enabled or not.<br>
|
|
-- see `setPositionPercentYEnabled`<br>
|
|
-- return True if position percentY is enabled, false otherwise.
|
|
-- @function [parent=#LayoutComponent] isPositionPercentYEnabled
|
|
-- @param self
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- Change percent height value of owner.<br>
|
|
-- param percentHeight Percent height in float.
|
|
-- @function [parent=#LayoutComponent] setPercentHeight
|
|
-- @param self
|
|
-- @param #float percentHeight
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Toggle enable percent only.<br>
|
|
-- param enable True if percent only is enabled, false otherwise.
|
|
-- @function [parent=#LayoutComponent] setPercentOnlyEnabled
|
|
-- @param self
|
|
-- @param #bool enable
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Change element's horizontal dock type.<br>
|
|
-- param hEage Horizontal dock type @see `HorizontalEdge`
|
|
-- @function [parent=#LayoutComponent] setHorizontalEdge
|
|
-- @param self
|
|
-- @param #int hEage
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Change the position of component owner.<br>
|
|
-- param position A position in (x,y)
|
|
-- @function [parent=#LayoutComponent] setPosition
|
|
-- @param self
|
|
-- @param #vec2_table position
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Percent content size is used to adapt node's content size based on parent's content size.<br>
|
|
-- If set to true then node's content size will be changed based on the value setted by @see setPercentContentSize<br>
|
|
-- param isUsed True to enable percent content size, false otherwise.
|
|
-- @function [parent=#LayoutComponent] setUsingPercentContentSize
|
|
-- @param self
|
|
-- @param #bool isUsed
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Query left margin of owner relative to its parent.<br>
|
|
-- return Left margin in float.
|
|
-- @function [parent=#LayoutComponent] getLeftMargin
|
|
-- @param self
|
|
-- @return float#float ret (return value: float)
|
|
|
|
--------------------------------
|
|
-- Query the owner's position.<br>
|
|
-- return The owner's position.
|
|
-- @function [parent=#LayoutComponent] getPosition
|
|
-- @param self
|
|
-- @return vec2_table#vec2_table ret (return value: vec2_table)
|
|
|
|
--------------------------------
|
|
-- Change size height of owner.<br>
|
|
-- param height Size height in float.
|
|
-- @function [parent=#LayoutComponent] setSizeHeight
|
|
-- @param self
|
|
-- @param #float height
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Whether position percentX is enabled or not. <br>
|
|
-- return True if position percentX is enable, false otherwise.
|
|
-- @function [parent=#LayoutComponent] isPositionPercentXEnabled
|
|
-- @param self
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- Query the bottom margin of owner relative to its parent.<br>
|
|
-- return Bottom margin in float.
|
|
-- @function [parent=#LayoutComponent] getBottomMargin
|
|
-- @param self
|
|
-- @return float#float ret (return value: float)
|
|
|
|
--------------------------------
|
|
-- Toggle enable percent height.<br>
|
|
-- param isUsed True if percent height is enabled, false otherwise.
|
|
-- @function [parent=#LayoutComponent] setPercentHeightEnabled
|
|
-- @param self
|
|
-- @param #bool isUsed
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Set percent content size.<br>
|
|
-- The value should be [0-1], 0 means the child's content size will be 0<br>
|
|
-- and 1 means the child's content size is the same as its parents.<br>
|
|
-- param percent The percent (x,y) of the node in [0-1] scope.
|
|
-- @function [parent=#LayoutComponent] setPercentContentSize
|
|
-- @param self
|
|
-- @param #vec2_table percent
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Query whether percent height is enabled or not.<br>
|
|
-- return True if percent height is enabled, false otherwise.
|
|
-- @function [parent=#LayoutComponent] isPercentHeightEnabled
|
|
-- @param self
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- Query percent width of owner.<br>
|
|
-- return percent width in float.
|
|
-- @function [parent=#LayoutComponent] getPercentWidth
|
|
-- @param self
|
|
-- @return float#float ret (return value: float)
|
|
|
|
--------------------------------
|
|
-- Query element horizontal dock type.<br>
|
|
-- return Horizontal dock type.
|
|
-- @function [parent=#LayoutComponent] getHorizontalEdge
|
|
-- @param self
|
|
-- @return int#int ret (return value: int)
|
|
|
|
--------------------------------
|
|
-- Query whether stretch height is enabled or not.<br>
|
|
-- return True if stretch height is enabled, false otherwise.
|
|
-- @function [parent=#LayoutComponent] isStretchHeightEnabled
|
|
-- @param self
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- Change the bottom margin of owner relative to its parent.<br>
|
|
-- param margin in float.
|
|
-- @function [parent=#LayoutComponent] setBottomMargin
|
|
-- @param self
|
|
-- @param #float margin
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Change the content size of owner.<br>
|
|
-- param size Content size in @see `Size`.
|
|
-- @function [parent=#LayoutComponent] setSize
|
|
-- @param self
|
|
-- @param #size_table size
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
--
|
|
-- @function [parent=#LayoutComponent] create
|
|
-- @param self
|
|
-- @return LayoutComponent#LayoutComponent ret (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
-- Bind a LayoutComponent to a specified node.<br>
|
|
-- If the node has already binded a LayoutComponent named __LAYOUT_COMPONENT_NAME, just return the LayoutComponent.<br>
|
|
-- Otherwise, create a new LayoutComponent and bind the LayoutComponent to the node.<br>
|
|
-- param node A Node* instance pointer.<br>
|
|
-- return The binded LayoutComponent instance pointer.
|
|
-- @function [parent=#LayoutComponent] bindLayoutComponent
|
|
-- @param self
|
|
-- @param #cc.Node node
|
|
-- @return LayoutComponent#LayoutComponent ret (return value: ccui.LayoutComponent)
|
|
|
|
--------------------------------
|
|
--
|
|
-- @function [parent=#LayoutComponent] init
|
|
-- @param self
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- Default constructor<br>
|
|
-- lua new
|
|
-- @function [parent=#LayoutComponent] LayoutComponent
|
|
-- @param self
|
|
-- @return LayoutComponent#LayoutComponent self (return value: ccui.LayoutComponent)
|
|
|
|
return nil
|