-------------------------------- -- @module Widget -- @extend ProtectedNode,LayoutParameterProtocol -- @parent_module ccui -------------------------------- -- Toggle layout component enable.
-- param enable Layout Component of a widget
-- return void -- @function [parent=#Widget] setLayoutComponentEnabled -- @param self -- @param #bool enable -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Changes the percent that is widget's percent size
-- param percent that is widget's percent size -- @function [parent=#Widget] setSizePercent -- @param self -- @param #vec2_table percent -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Get the user defined widget size.
-- return User defined size. -- @function [parent=#Widget] getCustomSize -- @param self -- @return size_table#size_table ret (return value: size_table) -------------------------------- -- Gets the left boundary position of this widget in parent's coordination system.
-- return The left boundary position of this widget. -- @function [parent=#Widget] getLeftBoundary -- @param self -- @return float#float ret (return value: float) -------------------------------- -- Sets whether the widget should be flipped horizontally or not.
-- param bFlippedX true if the widget should be flipped horizaontally, false otherwise. -- @function [parent=#Widget] setFlippedX -- @param self -- @param #bool flippedX -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Set callback name.
-- param callbackName A string representation of callback name. -- @function [parent=#Widget] setCallbackName -- @param self -- @param #string callbackName -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Gets the inner Renderer node of widget.
-- For example, a button's Virtual Renderer is it's texture renderer.
-- return Node pointer. -- @function [parent=#Widget] getVirtualRenderer -- @param self -- @return Node#Node ret (return value: cc.Node) -------------------------------- -- brief Allow widget touch events to propagate to its parents. Set false will disable propagation
-- param isPropagate True to allow propagation, false otherwise.
-- since v3.3 -- @function [parent=#Widget] setPropagateTouchEvents -- @param self -- @param #bool isPropagate -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Query whether unify size enable state.
-- return true represent the widget use Unify Size, false represent the widget couldn't use Unify Size -- @function [parent=#Widget] isUnifySizeEnabled -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- Get size percent of widget.
-- return Percent size. -- @function [parent=#Widget] getSizePercent -- @param self -- @return vec2_table#vec2_table ret (return value: vec2_table) -------------------------------- -- Set the percent(x,y) of the widget in OpenGL coordinates
-- param percent The percent (x,y) of the widget in OpenGL coordinates -- @function [parent=#Widget] setPositionPercent -- @param self -- @param #vec2_table percent -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Toggle widget swallow touch option.
-- brief Specify widget to swallow touches or not
-- param swallow True to swallow touch, false otherwise.
-- since v3.3 -- @function [parent=#Widget] setSwallowTouches -- @param self -- @param #bool swallow -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Get the content size of widget.
-- warning This API exists mainly for keeping back compatibility.
-- return -- @function [parent=#Widget] getLayoutSize -- @param self -- @return size_table#size_table ret (return value: size_table) -------------------------------- -- Sets whether the widget is hilighted
-- The default value is false, a widget is default to not hilighted
-- param hilight true if the widget is hilighted, false if the widget is not hilighted. -- @function [parent=#Widget] setHighlighted -- @param self -- @param #bool hilight -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Changes the position type of the widget
-- see `PositionType`
-- param type the position type of widget -- @function [parent=#Widget] setPositionType -- @param self -- @param #int type -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Query whether the widget ignores user deinfed content size or not
-- return True means ignore user defined content size, false otherwise. -- @function [parent=#Widget] isIgnoreContentAdaptWithSize -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- Get the virtual renderer's size
-- return Widget virtual renderer size. -- @function [parent=#Widget] getVirtualRendererSize -- @param self -- @return size_table#size_table ret (return value: size_table) -------------------------------- -- Determines if the widget is highlighted
-- return true if the widget is highlighted, false if the widget is not hignlighted . -- @function [parent=#Widget] isHighlighted -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- Gets LayoutParameter of widget.
-- see LayoutParameter
-- param type Relative or Linear
-- return LayoutParameter -- @function [parent=#Widget] getLayoutParameter -- @param self -- @return LayoutParameter#LayoutParameter ret (return value: ccui.LayoutParameter) -------------------------------- -- Gets the position type of the widget
-- see `PositionType`
-- return type the position type of widget -- @function [parent=#Widget] getPositionType -- @param self -- @return int#int ret (return value: int) -------------------------------- -- Gets the top boundary position of this widget in parent's coordination system.
-- return The top boundary position of this widget. -- @function [parent=#Widget] getTopBoundary -- @param self -- @return float#float ret (return value: float) -------------------------------- -- Toggle whether ignore user defined content size for widget.
-- Set true will ignore user defined content size which means
-- the widget size is always equal to the return value of `getVirtualRendererSize`.
-- param ignore, set member variabl _ignoreSize to ignore -- @function [parent=#Widget] ignoreContentAdaptWithSize -- @param self -- @param #bool ignore -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- When a widget is in a layout, you could call this method to get the next focused widget within a specified direction.
-- If the widget is not in a layout, it will return itself
-- param dir the direction to look for the next focused widget in a layout
-- param current the current focused widget
-- return the next focused widget in a layout -- @function [parent=#Widget] findNextFocusedWidget -- @param self -- @param #int direction -- @param #ccui.Widget current -- @return Widget#Widget ret (return value: ccui.Widget) -------------------------------- -- Determines if the widget is enabled or not.
-- return true if the widget is enabled, false if the widget is disabled. -- @function [parent=#Widget] isEnabled -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- Query whether widget is focused or not.
-- return whether the widget is focused or not -- @function [parent=#Widget] isFocused -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- Gets the touch began point of widget when widget is selected.
-- return the touch began point. -- @function [parent=#Widget] getTouchBeganPosition -- @param self -- @return vec2_table#vec2_table ret (return value: vec2_table) -------------------------------- -- Determines if the widget is touch enabled
-- return true if the widget is touch enabled, false if the widget is touch disabled. -- @function [parent=#Widget] isTouchEnabled -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- Query callback name.
-- return The callback name. -- @function [parent=#Widget] getCallbackName -- @param self -- @return string#string ret (return value: string) -------------------------------- -- Get the action tag.
-- return Action tag. -- @function [parent=#Widget] getActionTag -- @param self -- @return int#int ret (return value: int) -------------------------------- -- Gets position of widget in world space.
-- return Position of widget in world space. -- @function [parent=#Widget] getWorldPosition -- @param self -- @return vec2_table#vec2_table ret (return value: vec2_table) -------------------------------- -- Query widget's focus enable state.
-- return true represent the widget could accept focus, false represent the widget couldn't accept focus -- @function [parent=#Widget] isFocusEnabled -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- Toggle widget focus status.
-- param focus pass true to let the widget get focus or pass false to let the widget lose focus
-- return void -- @function [parent=#Widget] setFocused -- @param self -- @param #bool focus -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Set the tag of action.
-- param tag A integer tag value. -- @function [parent=#Widget] setActionTag -- @param self -- @param #int tag -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Sets whether the widget is touch enabled
-- The default value is false, a widget is default to touch disabled
-- param visible true if the widget is touch enabled, false if the widget is touch disabled. -- @function [parent=#Widget] setTouchEnabled -- @param self -- @param #bool enabled -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Sets whether the widget should be flipped vertically or not.
-- param bFlippedY true if the widget should be flipped vertically, flase otherwise. -- @function [parent=#Widget] setFlippedY -- @param self -- @param #bool flippedY -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Sets whether the widget is enabled
-- true if the widget is enabled, widget may be touched , false if the widget is disabled, widget cannot be touched.
-- Note: If you want to change the widget's appearance to disabled state, you should also call `setBright(false)`.
-- The default value is true, a widget is default to enable touch.
-- param enabled Set to true to enable touch, false otherwise. -- @function [parent=#Widget] setEnabled -- @param self -- @param #bool enabled -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Gets the right boundary position of this widget in parent's coordination system.
-- return The right boundary position of this widget. -- @function [parent=#Widget] getRightBoundary -- @param self -- @return float#float ret (return value: float) -------------------------------- -- To set the bright style of widget.
-- see BrightStyle
-- param style BrightStyle::NORMAL means the widget is in normal state, BrightStyle::HIGHLIGHT means the widget is in highlight state. -- @function [parent=#Widget] setBrightStyle -- @param self -- @param #int style -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Sets a LayoutParameter to widget.
-- see LayoutParameter
-- param LayoutParameter pointer
-- param type Relative or Linear -- @function [parent=#Widget] setLayoutParameter -- @param self -- @param #ccui.LayoutParameter parameter -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Create a new widget copy of the original one.
-- return A cloned widget copy of original. -- @function [parent=#Widget] clone -- @param self -- @return Widget#Widget ret (return value: ccui.Widget) -------------------------------- -- Allow widget to accept focus.
-- param enable pass true/false to enable/disable the focus ability of a widget
-- return void -- @function [parent=#Widget] setFocusEnabled -- @param self -- @param #bool enable -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Gets the bottom boundary position of this widget in parent's coordination system.
-- return The bottom boundary position of this widget. -- @function [parent=#Widget] getBottomBoundary -- @param self -- @return float#float ret (return value: float) -------------------------------- -- Determines if the widget is bright
-- return true if the widget is bright, false if the widget is dark. -- @function [parent=#Widget] isBright -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- Toggle use unify size.
-- param enable True to use unify size, false otherwise.
-- return void -- @function [parent=#Widget] setUnifySizeEnabled -- @param self -- @param #bool enable -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Return whether the widget is propagate touch events to its parents or not
-- return whether touch event propagation is allowed or not.
-- since v3.3 -- @function [parent=#Widget] isPropagateTouchEvents -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- Return a current focused widget in your UI scene.
-- No matter what widget object you call this method on , it will return you the exact one focused widget. -- @function [parent=#Widget] getCurrentFocusedWidget -- @param self -- @return Widget#Widget ret (return value: ccui.Widget) -------------------------------- -- Checks a point is in widget's content space.
-- This function is used for determining touch area of widget.
-- param pt The point in `Vec2`.
-- return true if the point is in widget's content space, flase otherwise. -- @function [parent=#Widget] hitTest -- @param self -- @param #vec2_table pt -- @return bool#bool ret (return value: bool) -------------------------------- -- Query whether layout component is enabled or not.
-- return true represent the widget use Layout Component, false represent the widget couldn't use Layout Component. -- @function [parent=#Widget] isLayoutComponentEnabled -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- when a widget calls this method, it will get focus immediately. -- @function [parent=#Widget] requestFocus -- @param self -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- @overload self, size_table -- @overload self -- @function [parent=#Widget] updateSizeAndPosition -- @param self -- @param #size_table parentSize -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- -- @function [parent=#Widget] getTouchMovePosition -- @param self -- @return vec2_table#vec2_table ret (return value: vec2_table) -------------------------------- -- Gets the size type of widget.
-- see `SizeType`
-- param type that is widget's size type -- @function [parent=#Widget] getSizeType -- @param self -- @return int#int ret (return value: int) -------------------------------- -- Query callback type.
-- return Callback type string. -- @function [parent=#Widget] getCallbackType -- @param self -- @return string#string ret (return value: string) -------------------------------- -- -- @function [parent=#Widget] getTouchEndPosition -- @param self -- @return vec2_table#vec2_table ret (return value: vec2_table) -------------------------------- -- Gets the percent (x,y) of the widget in OpenGL coordinates
-- see setPosition(const Vec2&)
-- return The percent (x,y) of the widget in OpenGL coordinates -- @function [parent=#Widget] getPositionPercent -- @param self -- @return vec2_table#vec2_table ret (return value: vec2_table) -------------------------------- -- Returns the flag which indicates whether the widget is flipped horizontally or not.
-- It not only flips the texture of the widget, but also the texture of the widget's children.
-- Also, flipping relies on widget's anchor point.
-- Internally, it just use setScaleX(-1) to flip the widget.
-- return true if the widget is flipped horizaontally, false otherwise. -- @function [parent=#Widget] isFlippedX -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- Return the flag which indicates whether the widget is flipped vertically or not.
-- It not only flips the texture of the widget, but also the texture of the widget's children.
-- Also, flipping relies on widget's anchor point.
-- Internally, it just use setScaleY(-1) to flip the widget.
-- return true if the widget is flipped vertically, flase otherwise. -- @function [parent=#Widget] isFlippedY -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- Checks a point if in parent's area.
-- param point A point in `Vec2`.
-- return true if the point is in parent's area, flase otherwise. -- @function [parent=#Widget] isClippingParentContainsPoint -- @param self -- @param #vec2_table pt -- @return bool#bool ret (return value: bool) -------------------------------- -- Changes the size type of widget.
-- see `SizeType`
-- param type that is widget's size type -- @function [parent=#Widget] setSizeType -- @param self -- @param #int type -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Sets whether the widget is bright
-- The default value is true, a widget is default to bright
-- param visible true if the widget is bright, false if the widget is dark. -- @function [parent=#Widget] setBright -- @param self -- @param #bool bright -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Set callback type.
-- param callbackType A string representation of callback type. -- @function [parent=#Widget] setCallbackType -- @param self -- @param #string callbackType -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Return whether the widget is swallowing touch or not
-- return Whether touch is swallowed.
-- since v3.3 -- @function [parent=#Widget] isSwallowTouches -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- -- @function [parent=#Widget] enableDpadNavigation -- @param self -- @param #bool enable -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Create and return a empty Widget instance pointer. -- @function [parent=#Widget] create -- @param self -- @return Widget#Widget ret (return value: ccui.Widget) -------------------------------- -- -- @function [parent=#Widget] setScaleY -- @param self -- @param #float scaleY -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- -- @function [parent=#Widget] setScaleX -- @param self -- @param #float scaleX -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- -- @function [parent=#Widget] getScaleY -- @param self -- @return float#float ret (return value: float) -------------------------------- -- -- @function [parent=#Widget] getScaleX -- @param self -- @return float#float ret (return value: float) -------------------------------- -- Returns the string representation of widget class name
-- return get the class description. -- @function [parent=#Widget] getDescription -- @param self -- @return string#string ret (return value: string) -------------------------------- -- @overload self, float, float -- @overload self, float -- @function [parent=#Widget] setScale -- @param self -- @param #float scalex -- @param #float scaley -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Changes the position (x,y) of the widget in OpenGL coordinates
-- Usually we use p(x,y) to compose a Vec2 object.
-- The original point (0,0) is at the left-bottom corner of screen.
-- param position The position (x,y) of the widget in OpenGL coordinates -- @function [parent=#Widget] setPosition -- @param self -- @param #vec2_table pos -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- Changes the size that is widget's size
-- param contentSize A content size in `Size`. -- @function [parent=#Widget] setContentSize -- @param self -- @param #size_table contentSize -- @return Widget#Widget self (return value: ccui.Widget) -------------------------------- -- -- @function [parent=#Widget] getScale -- @param self -- @return float#float ret (return value: float) -------------------------------- -- Default constructor -- @function [parent=#Widget] Widget -- @param self -- @return Widget#Widget self (return value: ccui.Widget) return nil