cocos2d-x  3.0alpha1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
UILayout Class Reference

#include <UILayout.h>

Inheritance diagram for UILayout:
UIWidget Object UIPageView UIRootWidget UIScrollView UIListView

Public Member Functions

 UILayout ()
virtual ~UILayout ()
 Default destructor. More...
 
virtual bool hitTest (const cocos2d::Point &pt) override
 Checks a point if is in widget's space. More...
 
local hitTest ( local pt)
 Checks a point if is in widget's space. More...
 
void setBackGroundImage (const char *fileName, TextureResType texType=UI_TEX_TYPE_LOCAL)
 Sets a background image for layout. More...
 
var setBackGroundImage ( var fileName, var UI_TEX_TYPE_LOCAL)
 Sets a background image for layout. More...
 
local setBackGroundImage ( local fileName, local UI_TEX_TYPE_LOCAL)
 Sets a background image for layout. More...
 
void setBackGroundImageCapInsets (const cocos2d::Rect &capInsets)
 Sets a background image capinsets for layout, if the background image is a scale9 render. More...
 
void setBackGroundColorType (LayoutBackGroundColorType type)
 Sets Color Type for layout. More...
 
local setBackGroundColorType ( local type)
 Sets Color Type for layout. More...
 
void setBackGroundImageScale9Enabled (bool enabled)
 Sets background iamge use scale9 renderer. More...
 
var setBackGroundImageScale9Enabled ( var enabled)
 Sets background iamge use scale9 renderer. More...
 
local setBackGroundImageScale9Enabled ( local enabled)
 Sets background iamge use scale9 renderer. More...
 
void setBackGroundColor (const cocos2d::Color3B &color)
 Sets background color for layout, if color type is LAYOUT_COLOR_SOLID. More...
 
void setBackGroundColor (const cocos2d::Color3B &startColor, const cocos2d::Color3B &endColor)
 Sets background color for layout, if color type is LAYOUT_COLOR_GRADIENT. More...
 
var setBackGroundColor ( var startColor, var endColor)
 Sets background color for layout, if color type is LAYOUT_COLOR_GRADIENT. More...
 
local setBackGroundColor ( local startColor, local endColor)
 Sets background color for layout, if color type is LAYOUT_COLOR_GRADIENT. More...
 
void setBackGroundColorOpacity (int opacity)
 Sets background opacity layout. More...
 
void setBackGroundColorVector (const cocos2d::Point &vector)
 Sets background color vector for layout, if color type is LAYOUT_COLOR_GRADIENT. More...
 
virtual void setColor (const cocos2d::Color3B &color) override
 Sets color to widget. More...
 
virtual void setOpacity (int opacity) override
 Sets opacity to widget. More...
 
void removeBackGroundImage ()
 Remove the background image of layout. More...
 
var removeBackGroundImage ()
 Remove the background image of layout. More...
 
local removeBackGroundImage ()
 Remove the background image of layout. More...
 
const cocos2d::SizegetBackGroundImageTextureSize () const
 Gets background image texture size. More...
 
var getBackGroundImageTextureSize ()
 Gets background image texture size. More...
 
local getBackGroundImageTextureSize ()
 Gets background image texture size. More...
 
virtual void setClippingEnabled (bool enabled)
 Changes if layout can clip it's content and child. More...
 
local setClippingEnabled ( local enabled)
 Changes if layout can clip it's content and child. More...
 
virtual bool isClippingEnabled ()
 Gets if layout is clipping enabled. More...
 
virtual const cocos2d::SizegetContentSize () const override
 Gets the content size of widget. More...
 
local getContentSize ()
 Gets the content size of widget. More...
 
virtual const char * getDescription () const override
 Returns the "class name" of widget. More...
 
local getDescription ()
 Returns the "class name" of widget. More...
 
virtual void setLayoutType (LayoutType type)
 Sets LayoutType. More...
 
var setLayoutType ( var type)
 Sets LayoutType. More...
 
local setLayoutType ( local type)
 Sets LayoutType. More...
 
virtual LayoutType getLayoutType () const
 Gets LayoutType. More...
 
var getLayoutType ()
 Gets LayoutType. More...
 
local getLayoutType ()
 Gets LayoutType. More...
 
virtual void doLayout ()
var doLayout ()
local doLayout ()
virtual bool addChild (UIWidget *child) override
 Adds a child to the container. More...
 
- Public Member Functions inherited from UIWidget
 UIWidget (void)
 ctor ()
virtual ~UIWidget ()
 Default destructor. More...
 
virtual void setEnabled (bool enabled)
 Sets whether the widget is enabled. More...
 
local setEnabled ( local enabled)
 Sets whether the widget is enabled. More...
 
bool isEnabled () const
 Determines if the widget is enabled. More...
 
void setVisible (bool visible)
 Sets whether the widget is visible. More...
 
var setVisible ( var visible)
 Sets whether the widget is visible. More...
 
local setVisible ( local visible)
 Sets whether the widget is visible. More...
 
bool isVisible () const
 Determines if the widget is visible. More...
 
void setBright (bool bright)
 Sets whether the widget is bright. More...
 
bool isBright () const
 Determines if the widget is bright. More...
 
virtual void setTouchEnabled (bool enabled)
 Sets whether the widget is touch enabled. More...
 
local setTouchEnabled ( local enabled)
 Sets whether the widget is touch enabled. More...
 
void setBrightStyle (BrightStyle style)
 To set the bright style of widget. More...
 
var setBrightStyle ( var style)
 To set the bright style of widget. More...
 
local setBrightStyle ( local style)
 To set the bright style of widget. More...
 
bool isTouchEnabled () const
 Determines if the widget is touch enabled. More...
 
bool isFocused () const
 Determines if the widget is on focused. More...
 
void setFocused (bool fucosed)
 Sets whether the widget is on focused. More...
 
void setZOrder (int z)
 Sets the Z order which stands for the drawing order, and reorder this widget in its parent's children array. More...
 
int getZOrder ()
 Gets the Z order of this widget. More...
 
float getLeftInParent ()
 Gets the left boundary position of this widget. More...
 
var getLeftInParent ()
 Gets the left boundary position of this widget. More...
 
local getLeftInParent ()
 Gets the left boundary position of this widget. More...
 
float getBottomInParent ()
 Gets the bottom boundary position of this widget. More...
 
var getBottomInParent ()
 Gets the bottom boundary position of this widget. More...
 
local getBottomInParent ()
 Gets the bottom boundary position of this widget. More...
 
float getRightInParent ()
 Gets the right boundary position of this widget. More...
 
var getRightInParent ()
 Gets the right boundary position of this widget. More...
 
local getRightInParent ()
 Gets the right boundary position of this widget. More...
 
float getTopInParent ()
 Gets the top boundary position of this widget. More...
 
var getTopInParent ()
 Gets the top boundary position of this widget. More...
 
local getTopInParent ()
 Gets the top boundary position of this widget. More...
 
virtual bool removeChild (UIWidget *child)
 Removes a child from the container with a cleanup. More...
 
local removeChild ( local child)
 Removes a child from the container with a cleanup. More...
 
virtual void removeFromParent ()
 Removes this widget itself from its parent widget. More...
 
local removeFromParent ()
 Removes this widget itself from its parent widget. More...
 
virtual void removeAllChildren ()
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
var removeAllChildren ()
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
local removeAllChildren ()
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
virtual void reorderChild (UIWidget *child)
 Reorders a child according to a new z value. More...
 
local reorderChild ( local child)
 Reorders a child according to a new z value. More...
 
UIWidgetgetChildByName (const char *name)
 Gets a child from the container with its name. More...
 
UIWidgetgetChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
virtual cocos2d::ArraygetChildren ()
 Return an array of children. More...
 
local getChildren ()
 Return an array of children. More...
 
cocos2d::NodegetRenderer ()
 Gets the renderer of widget. More...
 
void addRenderer (cocos2d::Node *renderer, int zOrder)
 Add a Node for rendering. More...
 
var addRenderer ( var renderer, var zOrder)
 Add a Node for rendering. More...
 
local addRenderer ( local renderer, local zOrder)
 Add a Node for rendering. More...
 
void removeRenderer (cocos2d::Node *renderer, bool cleanup)
 Remove a Node from widget. More...
 
local removeRenderer ( local renderer, local cleanup)
 Remove a Node from widget. More...
 
void setParent (UIWidget *parent)
 Sets the parent widget. More...
 
local setParent ( local parent)
 Sets the parent widget. More...
 
UIWidgetgetParent ()
 Returns a pointer to the parent widget. More...
 
void addTouchEventListener (cocos2d::Object *target, SEL_TouchEvent selector)
 Sets the touch event target/selector of the menu item. More...
 
var addTouchEventListener ( var target, var selector)
 Sets the touch event target/selector of the menu item. More...
 
local addTouchEventListener ( local target, local selector)
 Sets the touch event target/selector of the menu item. More...
 
void setPosition (const cocos2d::Point &pos)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
void setPositionPercent (const cocos2d::Point &percent)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
var setPositionPercent ( var percent)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
local setPositionPercent ( local percent)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
const cocos2d::PointgetPosition ()
 Gets the position (x,y) of the widget in OpenGL coordinates. More...
 
const cocos2d::PointgetPositionPercent ()
 Gets the percent (x,y) of the widget in OpenGL coordinates. More...
 
var getPositionPercent ()
 Gets the percent (x,y) of the widget in OpenGL coordinates. More...
 
local getPositionPercent ()
 Gets the percent (x,y) of the widget in OpenGL coordinates. More...
 
void setPositionType (PositionType type)
 Changes the position type of the widget. More...
 
PositionType getPositionType () const
 Gets the position type of the widget. More...
 
var getPositionType ()
 Gets the position type of the widget. More...
 
local getPositionType ()
 Gets the position type of the widget. More...
 
virtual void setAnchorPoint (const cocos2d::Point &pt)
 Sets the anchor point in percent. More...
 
local setAnchorPoint ( local pt)
 Sets the anchor point in percent. More...
 
const cocos2d::PointgetAnchorPoint ()
 Returns the anchor point in percent. More...
 
local getAnchorPoint ()
 Returns the anchor point in percent. More...
 
virtual void setScale (float fScale)
 Changes both X and Y scale factor of the widget. More...
 
local setScale ( local fScale)
 Changes both X and Y scale factor of the widget. More...
 
float getScale ()
 Gets the scale factor of the widget, when X and Y have the same scale factor. More...
 
virtual void setScaleX (float fScaleX)
 Changes the scale factor on X axis of this widget. More...
 
var setScaleX ( var fScaleX)
 Changes the scale factor on X axis of this widget. More...
 
local setScaleX ( local fScaleX)
 Changes the scale factor on X axis of this widget. More...
 
float getScaleX ()
 Returns the scale factor on X axis of this widget. More...
 
virtual void setScaleY (float fScaleY)
 Changes the scale factor on Y axis of this widget. More...
 
local setScaleY ( local fScaleY)
 Changes the scale factor on Y axis of this widget. More...
 
float getScaleY ()
 Returns the scale factor on Y axis of this widget. More...
 
var getScaleY ()
 Returns the scale factor on Y axis of this widget. More...
 
local getScaleY ()
 Returns the scale factor on Y axis of this widget. More...
 
void setRotation (float rotation)
 Sets the rotation (angle) of the widget in degrees. More...
 
float getRotation ()
 Returns the rotation of the widget in degrees. More...
 
void setRotationX (float rotationX)
 Sets the X rotation (angle) of the widget in degrees which performs a horizontal rotational skew. More...
 
float getRotationX ()
 Gets the X rotation (angle) of the widget in degrees which performs a horizontal rotation skew. More...
 
void setRotationY (float rotationY)
 Sets the Y rotation (angle) of the widget in degrees which performs a vertical rotational skew. More...
 
float getRotationY ()
 Gets the Y rotation (angle) of the widget in degrees which performs a vertical rotational skew. More...
 
var getRotationY ()
 Gets the Y rotation (angle) of the widget in degrees which performs a vertical rotational skew. More...
 
local getRotationY ()
 Gets the Y rotation (angle) of the widget in degrees which performs a vertical rotational skew. More...
 
virtual void setFlipX (bool flipX)
 Sets whether the widget should be flipped horizontally or not. More...
 
local setFlipX ( local flipX)
 Sets whether the widget should be flipped horizontally or not. More...
 
virtual bool isFlipX ()
 Returns the flag which indicates whether the widget is flipped horizontally or not. More...
 
virtual void setFlipY (bool flipY)
 Sets whether the widget should be flipped vertically or not. More...
 
local setFlipY ( local flipY)
 Sets whether the widget should be flipped vertically or not. More...
 
virtual bool isFlipY ()
 Return the flag which indicates whether the widget is flipped vertically or not. More...
 
virtual const cocos2d::Color3BgetColor ()
 Gets color of widget. More...
 
local getColor ()
 Gets color of widget. More...
 
virtual int getOpacity ()
 Gets opacity of widget. More...
 
virtual bool isCascadeOpacityEnabled ()
var isCascadeOpacityEnabled ()
local isCascadeOpacityEnabled ()
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual bool isCascadeColorEnabled ()
var isCascadeColorEnabled ()
local isCascadeColorEnabled ()
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
void setBlendFunc (cocos2d::BlendFunc blendFunc)
virtual void setActionManager (cocos2d::ActionManager *actionManager)
local setActionManager ( local actionManager)
virtual cocos2d::ActionManagergetActionManager ()
local getActionManager ()
cocos2d::ActionrunAction (cocos2d::Action *action)
var runAction ( var action)
local runAction ( local action)
void stopAllActions (void)
var stopAllActions ()
local stopAllActions ()
void stopAction (cocos2d::Action *action)
var stopAction ( var action)
local stopAction ( local action)
void stopActionByTag (int tag)
var stopActionByTag ( var tag)
local stopActionByTag ( local tag)
cocos2d::ActiongetActionByTag (int tag)
var getActionByTag ( var tag)
local getActionByTag ( local tag)
void didNotSelectSelf ()
 A call back function when widget lost of focus. More...
 
var didNotSelectSelf ()
 A call back function when widget lost of focus. More...
 
local didNotSelectSelf ()
 A call back function when widget lost of focus. More...
 
bool clippingParentAreaContainPoint (const cocos2d::Point &pt)
var clippingParentAreaContainPoint ( var pt)
local clippingParentAreaContainPoint ( local pt)
virtual void checkChildInfo (int handleState, UIWidget *sender, const cocos2d::Point &touchPoint)
local checkChildInfo ( local handleState, local sender, local touchPoint)
const cocos2d::PointgetTouchStartPos ()
var getTouchStartPos ()
local getTouchStartPos ()
const cocos2d::PointgetTouchMovePos ()
local getTouchMovePos ()
const cocos2d::PointgetTouchEndPos ()
void setTag (int tag)
 Changes the tag that is used to identify the widget easily. More...
 
local setTag ( local tag)
 Changes the tag that is used to identify the widget easily. More...
 
int getTag () const
 Returns a tag that is used to identify the widget easily. More...
 
var getTag ()
 Returns a tag that is used to identify the widget easily. More...
 
local getTag ()
 Returns a tag that is used to identify the widget easily. More...
 
void setName (const char *name)
 Changes the name that is used to identify the widget easily. More...
 
var setName ( var name)
 Changes the name that is used to identify the widget easily. More...
 
local setName ( local name)
 Changes the name that is used to identify the widget easily. More...
 
const char * getName () const
 Returns a name that is used to identify the widget easily. More...
 
WidgetType getWidgetType () const
 Returns a type that is widget's type. More...
 
virtual void setSize (const cocos2d::Size &size)
 Changes the size that is widget's size. More...
 
virtual void setSizePercent (const cocos2d::Point &percent)
 Changes the percent that is widget's percent size. More...
 
local setSizePercent ( local percent)
 Changes the percent that is widget's percent size. More...
 
void setSizeType (SizeType type)
 Changes the size type of widget. More...
 
var setSizeType ( var type)
 Changes the size type of widget. More...
 
local setSizeType ( local type)
 Changes the size type of widget. More...
 
SizeType getSizeType () const
 Gets the size type of widget. More...
 
var getSizeType ()
 Gets the size type of widget. More...
 
local getSizeType ()
 Gets the size type of widget. More...
 
const cocos2d::SizegetSize () const
 Returns size of widget. More...
 
const cocos2d::PointgetSizePercent () const
 Returns size percent of widget. More...
 
local getSizePercent ()
 Returns size percent of widget. More...
 
virtual bool onTouchBegan (const cocos2d::Point &touchPoint)
 A call back function called when widget is selected, and on touch began. More...
 
var onTouchBegan ( var touchPoint)
 A call back function called when widget is selected, and on touch began. More...
 
local onTouchBegan ( local touchPoint)
 A call back function called when widget is selected, and on touch began. More...
 
virtual void onTouchMoved (const cocos2d::Point &touchPoint)
 A call back function called when widget is selected, and on touch moved. More...
 
var onTouchMoved ( var touchPoint)
 A call back function called when widget is selected, and on touch moved. More...
 
local onTouchMoved ( local touchPoint)
 A call back function called when widget is selected, and on touch moved. More...
 
virtual void onTouchEnded (const cocos2d::Point &touchPoint)
 A call back function called when widget is selected, and on touch ended. More...
 
local onTouchEnded ( local touchPoint)
 A call back function called when widget is selected, and on touch ended. More...
 
virtual void onTouchCancelled (const cocos2d::Point &touchPoint)
 A call back function called when widget is selected, and on touch canceled. More...
 
var onTouchCancelled ( var touchPoint)
 A call back function called when widget is selected, and on touch canceled. More...
 
local onTouchCancelled ( local touchPoint)
 A call back function called when widget is selected, and on touch canceled. More...
 
virtual void onTouchLongClicked (const cocos2d::Point &touchPoint)
 A call back function called when widget is selected, and on touch long clicked. More...
 
var onTouchLongClicked ( var touchPoint)
 A call back function called when widget is selected, and on touch long clicked. More...
 
local onTouchLongClicked ( local touchPoint)
 A call back function called when widget is selected, and on touch long clicked. More...
 
void setLayoutParameter (UILayoutParameter *parameter)
 Sets a LayoutParameter to widget. More...
 
UILayoutParametergetLayoutParameter (LayoutParameterType type)
 Gets LayoutParameter of widget. More...
 
virtual void ignoreContentAdaptWithSize (bool ignore)
 Ignore the widget size. More...
 
var ignoreContentAdaptWithSize ( var ignore)
 Ignore the widget size. More...
 
local ignoreContentAdaptWithSize ( local ignore)
 Ignore the widget size. More...
 
bool isIgnoreContentAdaptWithSize () const
 Gets the widget if is ignore it's size. More...
 
var isIgnoreContentAdaptWithSize ()
 Gets the widget if is ignore it's size. More...
 
local isIgnoreContentAdaptWithSize ()
 Gets the widget if is ignore it's size. More...
 
cocos2d::Point getWorldPosition ()
 Gets world position of widget. More...
 
local getWorldPosition ()
 Gets world position of widget. More...
 
cocos2d::Point convertToWorldSpace (const cocos2d::Point &pt)
 Converts a Point to world space coordinates. More...
 
local convertToWorldSpace ( local pt)
 Converts a Point to world space coordinates. More...
 
virtual cocos2d::NodegetVirtualRenderer ()
 Gets the Virtual Renderer of widget. More...
 
local getVirtualRenderer ()
 Gets the Virtual Renderer of widget. More...
 
void setUpdateEnabled (bool enable)
 Schedules the "update" method. More...
 
bool isUpdateEnabled ()
 is the "update" method scheduled. More...
 
UIWidgetclone ()
var clone ()
local clone ()
virtual void onEnter ()
virtual void onExit ()
void updateSizeAndPosition ()
var updateSizeAndPosition ()
local updateSizeAndPosition ()
virtual ObjectgetUserObject ()
virtual const ObjectgetUserObject () const
virtual void setUserObject (Object *userObject)
 Returns a user assigned Object. More...
 
void setActionTag (int tag)
var setActionTag ( var tag)
local setActionTag ( local tag)
int getActionTag ()
var getActionTag ()
local getActionTag ()
- Public Member Functions inherited from Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
void release ()
 Release the ownership immediately. More...
 
void retain ()
 Retains the ownership. More...
 
Objectautorelease ()
 Release the ownership sometime soon automatically. More...
 
bool isSingleReference () const
 Returns a boolean value that indicates whether there is only one reference to the object. More...
 
unsigned int retainCount () const
 Returns the object's current reference count. More...
 
virtual bool isEqual (const Object *object)
 Returns a boolean value that indicates whether this object and a given object are equal. More...
 
virtual void acceptVisitor (DataVisitor &visitor)
virtual void update (float dt)

Static Public Member Functions

static UILayoutcreate ()
 Allocates and initializes a layout. More...
 
local create ()
 Allocates and initializes a layout. More...
 
- Static Public Member Functions inherited from UIWidget
static UIWidgetcreate ()
 Allocates and initializes a widget. More...
 
local create ()
 Allocates and initializes a widget. More...
 

Protected Member Functions

virtual bool init () override
var init ()
local init ()
virtual void initRenderer () override
local initRenderer ()
virtual void onSizeChanged () override
local onSizeChanged ()
void addBackGroundImage ()
var addBackGroundImage ()
local addBackGroundImage ()
void supplyTheLayoutParameterLackToChild (UIWidget *child)
var supplyTheLayoutParameterLackToChild ( var child)
local supplyTheLayoutParameterLackToChild ( local child)
virtual UIWidgetcreateCloneInstance () override
local createCloneInstance ()
virtual void copySpecialProperties (UIWidget *model) override
var copySpecialProperties ( var model)
local copySpecialProperties ( local model)
virtual void copyClonedWidgetChildren (UIWidget *model) override
var copyClonedWidgetChildren ( var model)
local copyClonedWidgetChildren ( local model)
- Protected Member Functions inherited from UIWidget
virtual void onPressStateChangedToNormal ()
var onPressStateChangedToNormal ()
local onPressStateChangedToNormal ()
virtual void onPressStateChangedToPressed ()
var onPressStateChangedToPressed ()
local onPressStateChangedToPressed ()
virtual void onPressStateChangedToDisabled ()
local onPressStateChangedToDisabled ()
void pushDownEvent ()
var pushDownEvent ()
local pushDownEvent ()
void moveEvent ()
var moveEvent ()
local moveEvent ()
void releaseUpEvent ()
var releaseUpEvent ()
local releaseUpEvent ()
void cancelUpEvent ()
var cancelUpEvent ()
local cancelUpEvent ()
void longClickEvent ()
var longClickEvent ()
local longClickEvent ()
void updateAnchorPoint ()
var updateAnchorPoint ()
local updateAnchorPoint ()
void copyProperties (UIWidget *model)
var copyProperties ( var model)
local copyProperties ( local model)

Protected Attributes

bool _clippingEnabled
bool _backGroundScale9Enabled
var _backGroundScale9Enabled
local _backGroundScale9Enabled
cocos2d::Node_backGroundImage
var _backGroundImage
local _backGroundImage
std::string _backGroundImageFileName
var _backGroundImageFileName
local _backGroundImageFileName
cocos2d::Rect _backGroundImageCapInsets
var _backGroundImageCapInsets
local _backGroundImageCapInsets
LayoutBackGroundColorType _colorType
var _colorType
local _colorType
TextureResType _bgImageTexType
var _bgImageTexType
local _bgImageTexType
cocos2d::LayerColor_colorRender
cocos2d::LayerGradient_gradientRender
var _gradientRender
local _gradientRender
cocos2d::Color3B _cColor
var _cColor
local _cColor
cocos2d::Color3B _gStartColor
var _gStartColor
local _gStartColor
cocos2d::Color3B _gEndColor
var _gEndColor
local _gEndColor
cocos2d::Point _alongVector
var _alongVector
local _alongVector
int _cOpacity
var _cOpacity
local _cOpacity
cocos2d::Size _backGroundImageTextureSize
var _backGroundImageTextureSize
local _backGroundImageTextureSize
LayoutType _layoutType
var _layoutType
local _layoutType
- Protected Attributes inherited from UIWidget
bool _enabled
 Highest control of widget. More...
 
bool _visible
 is this widget visible More...
 
var _visible
 is this widget visible More...
 
local _visible
 is this widget visible More...
 
bool _bright
 is this widget bright More...
 
var _bright
 is this widget bright More...
 
local _bright
 is this widget bright More...
 
bool _touchEnabled
 is this widget touch endabled More...
 
var _touchEnabled
 is this widget touch endabled More...
 
local _touchEnabled
 is this widget touch endabled More...
 
bool _touchPassedEnabled
 is the touch event should be passed More...
 
var _touchPassedEnabled
 is the touch event should be passed More...
 
local _touchPassedEnabled
 is the touch event should be passed More...
 
bool _focus
 is the widget on focus More...
 
int _widgetZOrder
 z-order value that affects the draw order and touch order More...
 
var _widgetZOrder
 z-order value that affects the draw order and touch order More...
 
local _widgetZOrder
 z-order value that affects the draw order and touch order More...
 
cocos2d::Point _anchorPoint
 anchor point normalized More...
 
var _anchorPoint
 anchor point normalized More...
 
local _anchorPoint
 anchor point normalized More...
 
UIWidget_widgetParent
 parent of widget More...
 
local _widgetParent
 parent of widget More...
 
BrightStyle _brightStyle
 bright style More...
 
var _brightStyle
 bright style More...
 
local _brightStyle
 bright style More...
 
bool _updateEnabled
 is "update" method scheduled More...
 
var _updateEnabled
 is "update" method scheduled More...
 
local _updateEnabled
 is "update" method scheduled More...
 
cocos2d::Node_renderer
 base renderer More...
 
var _renderer
 base renderer More...
 
local _renderer
 base renderer More...
 
cocos2d::Point _touchStartPos
 touch began point More...
 
var _touchStartPos
 touch began point More...
 
local _touchStartPos
 touch began point More...
 
cocos2d::Point _touchMovePos
 touch moved point More...
 
var _touchMovePos
 touch moved point More...
 
local _touchMovePos
 touch moved point More...
 
cocos2d::Point _touchEndPos
 touch ended point More...
 
var _touchEndPos
 touch ended point More...
 
local _touchEndPos
 touch ended point More...
 
Object_touchEventListener
local _touchEventListener
SEL_TouchEvent _touchEventSelector
var _touchEventSelector
local _touchEventSelector
int _widgetTag
var _widgetTag
local _widgetTag
std::string _name
var _name
local _name
WidgetType _widgetType
var _widgetType
local _widgetType
int _actionTag
var _actionTag
local _actionTag
cocos2d::Size _size
var _size
local _size
cocos2d::Size _customSize
var _customSize
local _customSize
cocos2d::Dictionary_layoutParameterDictionary
var _layoutParameterDictionary
local _layoutParameterDictionary
bool _ignoreSize
var _ignoreSize
local _ignoreSize
cocos2d::Array_children
var _children
local _children
bool _affectByClipping
var _affectByClipping
local _affectByClipping
cocos2d::Scheduler_scheduler
var _scheduler
local _scheduler
SizeType _sizeType
var _sizeType
local _sizeType
cocos2d::Point _sizePercent
var _sizePercent
local _sizePercent
PositionType _positionType
var _positionType
local _positionType
cocos2d::Point _positionPercent
var _positionPercent
local _positionPercent
bool _isRunning
var _isRunning
local _isRunning
cocos2d::Object_userObject
var _userObject
local _userObject
- Protected Attributes inherited from Object
unsigned int _reference
 count of references More...
 
unsigned int _autoReleaseCount
 count of autorelease More...
 

Additional Inherited Members

- Public Attributes inherited from Object
unsigned int _ID
 object id, ScriptSupport need public _ID More...
 
int _luaID
 Lua reference id. More...
 

Constructor & Destructor Documentation

UILayout ( )
var ctor ( )
virtual ~UILayout ( )
virtual

Default destructor.

Member Function Documentation

void addBackGroundImage ( )
protected
var addBackGroundImage ( )
protected
local addBackGroundImage ( )
protected
virtual bool addChild ( UIWidget child)
overridevirtual

Adds a child to the container.

Parameters
childA child widget

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, and UIListView.

var addChild ( var  child)
overridevirtual

Adds a child to the container.

Parameters
childA child widget

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, and UIListView.

local addChild ( local  child)
overridevirtual

Adds a child to the container.

Parameters
childA child widget

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, and UIListView.

virtual void
copyClonedWidgetChildren
( UIWidget model)
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, and UIListView.

var copyClonedWidgetChildren ( var  model)
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, and UIListView.

local copyClonedWidgetChildren ( local  model)
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, and UIListView.

virtual void copySpecialProperties ( UIWidget model)
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, and UIListView.

var copySpecialProperties ( var  model)
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, and UIListView.

local copySpecialProperties ( local  model)
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, and UIListView.

static UILayout* create ( )
static

Allocates and initializes a layout.

var create ( )
static

Allocates and initializes a layout.

local create ( )
static

Allocates and initializes a layout.

virtual UIWidget*
createCloneInstance
( )
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, and UIListView.

var createCloneInstance ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, and UIListView.

local createCloneInstance ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, and UIListView.

virtual void doLayout ( )
virtual

Reimplemented in UIScrollView, and UIPageView.

var doLayout ( )
virtual

Reimplemented in UIScrollView, and UIPageView.

local doLayout ( )
virtual

Reimplemented in UIScrollView, and UIPageView.

const cocos2d::Size&
getBackGroundImageTextureSize
( ) const

Gets background image texture size.

Returns
background image texture size.
var getBackGroundImageTextureSize ( )

Gets background image texture size.

Returns
background image texture size.
local getBackGroundImageTextureSize ( )

Gets background image texture size.

Returns
background image texture size.
virtual const cocos2d::Size&
getContentSize
( ) const
overridevirtual

Gets the content size of widget.

Content size is widget's texture size.

Reimplemented from UIWidget.

var getContentSize ( )
overridevirtual

Gets the content size of widget.

Content size is widget's texture size.

Reimplemented from UIWidget.

local getContentSize ( )
overridevirtual

Gets the content size of widget.

Content size is widget's texture size.

Reimplemented from UIWidget.

virtual const char* getDescription ( ) const
overridevirtual

Returns the "class name" of widget.

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, UIListView, and UIRootWidget.

var getDescription ( )
overridevirtual

Returns the "class name" of widget.

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, UIListView, and UIRootWidget.

local getDescription ( )
overridevirtual

Returns the "class name" of widget.

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, UIListView, and UIRootWidget.

virtual LayoutType getLayoutType ( ) const
virtual

Gets LayoutType.

See Also
LayoutType
Returns
LayoutType

Reimplemented in UIScrollView, and UIPageView.

var getLayoutType ( )
virtual

Gets LayoutType.

See Also
LayoutType
Returns
LayoutType

Reimplemented in UIScrollView, and UIPageView.

local getLayoutType ( )
virtual

Gets LayoutType.

See Also
LayoutType
Returns
LayoutType

Reimplemented in UIScrollView, and UIPageView.

virtual bool hitTest ( const cocos2d::Point pt)
overridevirtual

Checks a point if is in widget's space.

Parameters
point
Returns
true if the point is in widget's space, flase otherwise.

Reimplemented from UIWidget.

var hitTest ( var  pt)
overridevirtual

Checks a point if is in widget's space.

Parameters
point
Returns
true if the point is in widget's space, flase otherwise.

Reimplemented from UIWidget.

local hitTest ( local  pt)
overridevirtual

Checks a point if is in widget's space.

Parameters
point
Returns
true if the point is in widget's space, flase otherwise.

Reimplemented from UIWidget.

virtual bool init ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, UIListView, and UIRootWidget.

var init ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, UIListView, and UIRootWidget.

local init ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, UIListView, and UIRootWidget.

virtual void initRenderer ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView.

var initRenderer ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView.

local initRenderer ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView.

virtual bool isClippingEnabled ( )
virtual

Gets if layout is clipping enabled.

Returns
if layout is clipping enabled.
var isClippingEnabled ( )
virtual

Gets if layout is clipping enabled.

Returns
if layout is clipping enabled.
local isClippingEnabled ( )
virtual

Gets if layout is clipping enabled.

Returns
if layout is clipping enabled.
virtual void onSizeChanged ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, and UIListView.

var onSizeChanged ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, and UIListView.

local onSizeChanged ( )
overrideprotectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, and UIListView.

void removeBackGroundImage ( )

Remove the background image of layout.

var removeBackGroundImage ( )

Remove the background image of layout.

local removeBackGroundImage ( )

Remove the background image of layout.

void setBackGroundColor ( const cocos2d::Color3B color)

Sets background color for layout, if color type is LAYOUT_COLOR_SOLID.

Parameters
color
var setBackGroundColor ( var  color)

Sets background color for layout, if color type is LAYOUT_COLOR_SOLID.

Parameters
color
local setBackGroundColor ( local  color)

Sets background color for layout, if color type is LAYOUT_COLOR_SOLID.

Parameters
color
void setBackGroundColor ( const cocos2d::Color3B startColor,
const cocos2d::Color3B endColor 
)

Sets background color for layout, if color type is LAYOUT_COLOR_GRADIENT.

Parameters
startcolor
endcolor
var setBackGroundColor ( var  startColor,
var  endColor 
)

Sets background color for layout, if color type is LAYOUT_COLOR_GRADIENT.

Parameters
startcolor
endcolor
local setBackGroundColor ( local  startColor,
local  endColor 
)

Sets background color for layout, if color type is LAYOUT_COLOR_GRADIENT.

Parameters
startcolor
endcolor
void setBackGroundColorOpacity ( int  opacity)

Sets background opacity layout.

Parameters
opacity
var setBackGroundColorOpacity ( var  opacity)

Sets background opacity layout.

Parameters
opacity
local setBackGroundColorOpacity ( local  opacity)

Sets background opacity layout.

Parameters
opacity
void setBackGroundColorType ( LayoutBackGroundColorType  type)

Sets Color Type for layout.

Parameters
type@seeLayoutBackGroundColorType.
var setBackGroundColorType ( var  type)

Sets Color Type for layout.

Parameters
type@seeLayoutBackGroundColorType.
local setBackGroundColorType ( local  type)

Sets Color Type for layout.

Parameters
type@seeLayoutBackGroundColorType.
void setBackGroundColorVector ( const cocos2d::Point vector)

Sets background color vector for layout, if color type is LAYOUT_COLOR_GRADIENT.

Parameters
vector
var setBackGroundColorVector ( var  vector)

Sets background color vector for layout, if color type is LAYOUT_COLOR_GRADIENT.

Parameters
vector
local setBackGroundColorVector ( local  vector)

Sets background color vector for layout, if color type is LAYOUT_COLOR_GRADIENT.

Parameters
vector
void setBackGroundImage ( const char *  fileName,
TextureResType  texType = UI_TEX_TYPE_LOCAL 
)

Sets a background image for layout.

Parameters
fileNameimage file path.
texType@seeTextureResType. UI_TEX_TYPE_LOCAL means local file, UI_TEX_TYPE_PLIST means sprite frame.
var setBackGroundImage ( var  fileName,
var  texType = UI_TEX_TYPE_LOCAL 
)

Sets a background image for layout.

Parameters
fileNameimage file path.
texType@seeTextureResType. UI_TEX_TYPE_LOCAL means local file, UI_TEX_TYPE_PLIST means sprite frame.
local setBackGroundImage ( local  fileName,
local  texType = UI_TEX_TYPE_LOCAL 
)

Sets a background image for layout.

Parameters
fileNameimage file path.
texType@seeTextureResType. UI_TEX_TYPE_LOCAL means local file, UI_TEX_TYPE_PLIST means sprite frame.
void setBackGroundImageCapInsets ( const cocos2d::Rect capInsets)

Sets a background image capinsets for layout, if the background image is a scale9 render.

Parameters
capinsetsof background image.
var setBackGroundImageCapInsets ( var  capInsets)

Sets a background image capinsets for layout, if the background image is a scale9 render.

Parameters
capinsetsof background image.
local setBackGroundImageCapInsets ( local  capInsets)

Sets a background image capinsets for layout, if the background image is a scale9 render.

Parameters
capinsetsof background image.
void
setBackGroundImageScale9Enabled
( bool  enabled)

Sets background iamge use scale9 renderer.

Parameters
enabledtrue that use scale9 renderer, false otherwise.
var setBackGroundImageScale9Enabled ( var  enabled)

Sets background iamge use scale9 renderer.

Parameters
enabledtrue that use scale9 renderer, false otherwise.
local
setBackGroundImageScale9Enabled
( local  enabled)

Sets background iamge use scale9 renderer.

Parameters
enabledtrue that use scale9 renderer, false otherwise.
virtual void setClippingEnabled ( bool  enabled)
virtual

Changes if layout can clip it's content and child.

If you really need this, please enable it. But it would reduce the rendering efficiency.

Parameters
clippingenabled.

Reimplemented in UIScrollView, and UIPageView.

var setClippingEnabled ( var  enabled)
virtual

Changes if layout can clip it's content and child.

If you really need this, please enable it. But it would reduce the rendering efficiency.

Parameters
clippingenabled.

Reimplemented in UIScrollView, and UIPageView.

local setClippingEnabled ( local  enabled)
virtual

Changes if layout can clip it's content and child.

If you really need this, please enable it. But it would reduce the rendering efficiency.

Parameters
clippingenabled.

Reimplemented in UIScrollView, and UIPageView.

virtual void setColor ( const cocos2d::Color3B color)
overridevirtual

Sets color to widget.

It default change the color of widget's children.

Parameters
color

Reimplemented from UIWidget.

var setColor ( var  color)
overridevirtual

Sets color to widget.

It default change the color of widget's children.

Parameters
color

Reimplemented from UIWidget.

local setColor ( local  color)
overridevirtual

Sets color to widget.

It default change the color of widget's children.

Parameters
color

Reimplemented from UIWidget.

virtual void setLayoutType ( LayoutType  type)
virtual

Sets LayoutType.

See Also
LayoutType
Parameters
LayoutType

Reimplemented in UIScrollView, and UIPageView.

var setLayoutType ( var  type)
virtual

Sets LayoutType.

See Also
LayoutType
Parameters
LayoutType

Reimplemented in UIScrollView, and UIPageView.

local setLayoutType ( local  type)
virtual

Sets LayoutType.

See Also
LayoutType
Parameters
LayoutType

Reimplemented in UIScrollView, and UIPageView.

virtual void setOpacity ( int  opacity)
overridevirtual

Sets opacity to widget.

It default change the opacity of widget's children.

Parameters
color

Reimplemented from UIWidget.

var setOpacity ( var  opacity)
overridevirtual

Sets opacity to widget.

It default change the opacity of widget's children.

Parameters
color

Reimplemented from UIWidget.

local setOpacity ( local  opacity)
overridevirtual

Sets opacity to widget.

It default change the opacity of widget's children.

Parameters
color

Reimplemented from UIWidget.

void
supplyTheLayoutParameterLackToChild
( UIWidget child)
protected
var
supplyTheLayoutParameterLackToChild
( var  child)
protected
local
supplyTheLayoutParameterLackToChild
( local  child)
protected

Member Data Documentation

cocos2d::Point _alongVector
protected
var _alongVector
protected
local _alongVector
protected
cocos2d::Node* _backGroundImage
protected
var _backGroundImage
protected
local _backGroundImage
protected
cocos2d::Rect
_backGroundImageCapInsets
protected
var _backGroundImageCapInsets
protected
local _backGroundImageCapInsets
protected
std::string
_backGroundImageFileName
protected
var _backGroundImageFileName
protected
local _backGroundImageFileName
protected
cocos2d::Size
_backGroundImageTextureSize
protected
var _backGroundImageTextureSize
protected
local _backGroundImageTextureSize
protected
bool _backGroundScale9Enabled
protected
var _backGroundScale9Enabled
protected
local _backGroundScale9Enabled
protected
TextureResType _bgImageTexType
protected
var _bgImageTexType
protected
local _bgImageTexType
protected
cocos2d::Color3B _cColor
protected
var _cColor
protected
local _cColor
protected
bool _clippingEnabled
protected
var _clippingEnabled
protected
local _clippingEnabled
protected
cocos2d::LayerColor* _colorRender
protected
var _colorRender
protected
local _colorRender
protected
LayoutBackGroundColorType
_colorType
protected
var _colorType
protected
local _colorType
protected
int _cOpacity
protected
var _cOpacity
protected
local _cOpacity
protected
cocos2d::Color3B _gEndColor
protected
var _gEndColor
protected
local _gEndColor
protected
cocos2d::LayerGradient*
_gradientRender
protected
var _gradientRender
protected
local _gradientRender
protected
cocos2d::Color3B _gStartColor
protected
var _gStartColor
protected
local _gStartColor
protected
LayoutType _layoutType
protected
var _layoutType
protected
local _layoutType
protected

The documentation for this class was generated from the following file: