-------------------------------- -- @module Widget -- @extend ProtectedNode,LayoutParameterProtocol -- @parent_module ccui -------------------------------- -- 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 -------------------------------- -- -- @function [parent=#Widget] getCustomSize -- @param self -- @return size_table#size_table ret (return value: size_table) -------------------------------- -- -- @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 -------------------------------- -- callbackName getter and setter. -- @function [parent=#Widget] setCallbackName -- @param self -- @param #string callbackName -------------------------------- -- Gets the Virtual Renderer 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
-- since v3.3 -- @function [parent=#Widget] setPropagateTouchEvents -- @param self -- @param #bool isPropagate -------------------------------- -- 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) -------------------------------- -- Returns size percent of widget
-- return size percent -- @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 -------------------------------- -- brief Specify widget to swallow touches or not
-- since v3.3 -- @function [parent=#Widget] setSwallowTouches -- @param self -- @param #bool swallow -------------------------------- -- -- @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 -------------------------------- -- 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 -------------------------------- -- Query whether the widget ignores user deinfed content size or not
-- return bool -- @function [parent=#Widget] isIgnoreContentAdaptWithSize -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- -- @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) -------------------------------- -- Set a event handler to the widget in order to use cocostudio editor and framework -- @function [parent=#Widget] addCCSEventListener -- @param self -- @param #function callback -------------------------------- -- 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) -------------------------------- -- -- @function [parent=#Widget] getTopBoundary -- @param self -- @return float#float ret (return value: float) -------------------------------- -- Note: when you set _ignoreSize to true, no matther you call setContentSize or not,
-- the widget size is always equal to the return value of the member function getVirtualRendererSize.
-- param ignore, set member variabl _ignoreSize to ignore -- @function [parent=#Widget] ignoreContentAdaptWithSize -- @param self -- @param #bool ignore -------------------------------- -- 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
-- 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) -------------------------------- -- return whether the widget is focused or not -- @function [parent=#Widget] isFocused -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- -- @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) -------------------------------- -- -- @function [parent=#Widget] getCallbackName -- @param self -- @return string#string ret (return value: string) -------------------------------- -- -- @function [parent=#Widget] getActionTag -- @param self -- @return int#int ret (return value: int) -------------------------------- -- Gets world position of widget.
-- return world position of widget. -- @function [parent=#Widget] getWorldPosition -- @param self -- @return vec2_table#vec2_table ret (return value: vec2_table) -------------------------------- -- 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) -------------------------------- -- 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 -------------------------------- -- -- @function [parent=#Widget] setActionTag -- @param self -- @param #int tag -------------------------------- -- 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 -------------------------------- -- 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 -------------------------------- -- 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.
-- The default value is true, a widget is default to enabled
-- param enabled -- @function [parent=#Widget] setEnabled -- @param self -- @param #bool enabled -------------------------------- -- -- @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 -------------------------------- -- 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 -------------------------------- -- -- @function [parent=#Widget] clone -- @param self -- @return Widget#Widget ret (return value: ccui.Widget) -------------------------------- -- 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 -------------------------------- -- -- @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) -------------------------------- -- param enable Unify Size of a widget
-- return void -- @function [parent=#Widget] setUnifySizeEnabled -- @param self -- @param #bool enable -------------------------------- -- Return whether the widget is propagate touch events to its parents or not
-- since v3.3 -- @function [parent=#Widget] isPropagateTouchEvents -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- -- @function [parent=#Widget] getCurrentFocusedWidget -- @param self -- @return Widget#Widget ret (return value: ccui.Widget) -------------------------------- -- Checks a point if is in widget's space
-- param point
-- return true if the point is in widget's space, flase otherwise. -- @function [parent=#Widget] hitTest -- @param self -- @param #vec2_table pt -- @return bool#bool ret (return value: bool) -------------------------------- -- when a widget calls this method, it will get focus immediately. -- @function [parent=#Widget] requestFocus -- @param self -------------------------------- -- @overload self, size_table -- @overload self -- @function [parent=#Widget] updateSizeAndPosition -- @param self -- @param #size_table parentSize -------------------------------- -- -- @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) -------------------------------- -- -- @function [parent=#Widget] getCallbackType -- @param self -- @return string#string ret (return value: string) -------------------------------- -- -- @function [parent=#Widget] addTouchEventListener -- @param self -- @param #function callback -------------------------------- -- -- @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) -------------------------------- -- Set a click event handler to the widget -- @function [parent=#Widget] addClickEventListener -- @param self -- @param #function callback -------------------------------- -- Returns the flag which indicates whether the widget is flipped horizontally or not.
-- It only flips the texture of the widget, and not the texture of the widget's children.
-- Also, flipping the texture doesn't alter the anchorPoint.
-- If you want to flip the anchorPoint too, and/or to flip the children too use:
-- widget->setScaleX(sprite->getScaleX() * -1);
-- 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 only flips the texture of the widget, and not the texture of the widget's children.
-- Also, flipping the texture doesn't alter the anchorPoint.
-- If you want to flip the anchorPoint too, and/or to flip the children too use:
-- widget->setScaleY(widget->getScaleY() * -1);
-- return true if the widget is flipped vertically, flase otherwise. -- @function [parent=#Widget] isFlippedY -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- -- -- @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 -------------------------------- -- 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 -------------------------------- -- callbackType getter and setter. -- @function [parent=#Widget] setCallbackType -- @param self -- @param #string callbackType -------------------------------- -- Return whether the widget is swallowing touch or not
-- 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 -------------------------------- -- Allocates and initializes a widget. -- @function [parent=#Widget] create -- @param self -- @return Widget#Widget ret (return value: ccui.Widget) -------------------------------- -- -- @function [parent=#Widget] setScaleY -- @param self -- @param #float scaleY -------------------------------- -- -- @function [parent=#Widget] setScaleX -- @param self -- @param #float scaleX -------------------------------- -- -- @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 "class name" of widget. -- @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 -------------------------------- -- Changes the position (x,y) of the widget in OpenGL coordinates
-- Usually we use p(x,y) to compose 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 -------------------------------- -- -- @function [parent=#Widget] setContentSize -- @param self -- @param #size_table contentSize -------------------------------- -- -- @function [parent=#Widget] getScale -- @param self -- @return float#float ret (return value: float) -------------------------------- -- Default constructor -- @function [parent=#Widget] Widget -- @param self return nil