UILayout Class Reference

#include <UILayout.h>

Inheritance diagram for UILayout:

Public Member Functions
	UILayout ()
virtual	~UILayout ()
	Default destructor. More...
virtual bool	hitTest (const CCPoint &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...
void	setBackGroundImageCapInsets (const CCRect &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...
void	setBackGroundImageScale9Enabled (bool enabled)
	Sets background iamge use scale9 renderer. More...
void	setBackGroundColor (const ccColor3B &color)
	Sets background color for layout, if color type is LAYOUT_COLOR_SOLID. More...
void	setBackGroundColor (const ccColor3B &startColor, const ccColor3B &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 CCPoint &vector)
	Sets background color vector for layout, if color type is LAYOUT_COLOR_GRADIENT. More...
virtual void	setColor (const ccColor3B &color)
	Sets color to widget. More...
virtual void	setOpacity (int opacity)
	Sets opacity to widget. More...
void	removeBackGroundImage ()
	Remove the background image of layout. More...
var	removeBackGroundImage ()
	Remove the background image of layout. More...
const CCSize &	getBackGroundImageTextureSize () const
	Gets background image texture size. More...
var	getBackGroundImageTextureSize ()
	Gets background image texture size. More...
virtual void	setClippingEnabled (bool able)
	Changes if layout can clip it's content and child. More...
virtual bool	isClippingEnabled ()
	Gets if layout is clipping enabled. More...
virtual const CCSize &	getContentSize () const
	Gets the content size of widget. More...
virtual const char *	getDescription () const
	Returns the "class name" of widget. More...
virtual void	setLayoutType (LayoutType type)
	Sets LayoutType. More...
virtual LayoutType	getLayoutType () const
	Gets LayoutType. More...
virtual void	doLayout ()
virtual bool	addChild (UIWidget *child)
	Adds a child to the container. More...
void	setBackGroundImageScale9Enable (bool is)
	These methods will be removed. More...
virtual void	setClippingEnable (bool is)
Public Member Functions inherited from UIWidget
	UIWidget (void)
virtual	~UIWidget ()
	Default destructor. More...
virtual void	setEnabled (bool 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...
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...
void	setBrightStyle (BrightStyle 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...
float	getBottomInParent ()
	Gets the bottom boundary position of this widget. More...
var	getBottomInParent ()
	Gets the bottom boundary position of this widget. More...
float	getRightInParent ()
	Gets the right boundary position of this widget. More...
float	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...
virtual void	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...
virtual void	reorderChild (UIWidget *child)
	Reorders a child according to a new z value. More...
UIWidget *	getChildByName (const char *name)
	Gets a child from the container with its name. More...
UIWidget *	getChildByTag (int tag)
	Gets a child from the container with its tag. More...
virtual CCArray *	getChildren ()
	Return an array of children. More...
CCNode *	getRenderer ()
	Gets the renderer of widget. More...
void	addRenderer (CCNode *renderer, int zOrder)
	Add a CCNode for rendering. More...
void	removeRenderer (CCNode *renderer, bool cleanup)
	Remove a CCNode from widget. More...
void	setParent (UIWidget *parent)
	Sets the parent widget. More...
UIWidget *	getParent ()
	Returns a pointer to the parent widget. More...
void	addTouchEventListener (CCObject *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...
void	setPosition (const CCPoint &pos)
	Changes the position (x,y) of the widget in OpenGL coordinates. More...
void	setPositionPercent (const CCPoint &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...
const CCPoint &	getPosition ()
	Gets the position (x,y) of the widget in OpenGL coordinates. More...
const CCPoint &	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...
virtual void	setAnchorPoint (const CCPoint &pt)
	Sets the anchor point in percent. More...
const CCPoint &	getAnchorPoint ()
	Returns the anchor point in percent. More...
virtual void	setScale (float 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...
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...
float	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...
virtual void	setFlipX (bool 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...
virtual bool	isFlipY ()
	Return the flag which indicates whether the widget is flipped vertically or not. More...
virtual const ccColor3B &	getColor ()
	Gets color of widget. More...
virtual int	getOpacity ()
	Gets opacity of widget. More...
virtual bool	isCascadeOpacityEnabled ()
virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual bool	isCascadeColorEnabled ()
virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)
void	setBlendFunc (ccBlendFunc blendFunc)
virtual void	setActionManager (CCActionManager *actionManager)
virtual CCActionManager *	getActionManager ()
CCAction *	runAction (CCAction *action)
void	stopAllActions (void)
void	stopAction (CCAction *action)
void	stopActionByTag (int tag)
CCAction *	getActionByTag (int 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...
bool	clippingParentAreaContainPoint (const CCPoint &pt)
virtual void	checkChildInfo (int handleState, UIWidget *sender, const CCPoint &touchPoint)
const CCPoint &	getTouchStartPos ()
const CCPoint &	getTouchMovePos ()
const CCPoint &	getTouchEndPos ()
void	setTag (int 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...
void	setName (const char *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...
var	getName ()
	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 CCSize &size)
	Changes the size that is widget's size. More...
virtual void	setSizePercent (const CCPoint &percent)
	Changes the percent that is widget's percent size. More...
void	setSizeType (SizeType type)
	Changes the size type of widget. More...
SizeType	getSizeType () const
	Gets the size type of widget. More...
const CCSize &	getSize () const
	Returns size of widget. More...
const CCPoint &	getSizePercent () const
	Returns size percent of widget. More...
virtual bool	onTouchBegan (const CCPoint &touchPoint)
	A call back function called when widget is selected, and on touch began. More...
virtual void	onTouchMoved (const CCPoint &touchPoint)
	A call back function called when widget is selected, and on touch moved. More...
virtual void	onTouchEnded (const CCPoint &touchPoint)
	A call back function called when widget is selected, and on touch ended. More...
virtual void	onTouchCancelled (const CCPoint &touchPoint)
	A call back function called when widget is selected, and on touch canceled. More...
virtual void	onTouchLongClicked (const CCPoint &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...
void	setLayoutParameter (UILayoutParameter *parameter)
	Sets a LayoutParameter to widget. More...
UILayoutParameter *	getLayoutParameter (LayoutParameterType type)
	Gets LayoutParameter of widget. More...
virtual void	ignoreContentAdaptWithSize (bool ignore)
	Ignore the widget size. More...
bool	isIgnoreContentAdaptWithSize () const
	Gets the widget if is ignore it's size. More...
CCPoint	getWorldPosition ()
	Gets world position of widget. More...
CCPoint	convertToWorldSpace (const CCPoint &pt)
	Converts a Point to world space coordinates. More...
virtual CCNode *	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...
UIWidget *	clone ()
virtual void	onEnter ()
virtual void	onExit ()
virtual CCObject *	getUserObject ()
	Returns a user assigned CCObject. More...
virtual void	setUserObject (CCObject *pUserObject)
	Returns a user assigned CCObject. More...
void	setTouchEnable (bool enabled, bool containChildren=false)
	These methods will be removed. More...
void	disable (bool containChildren=false)
void	active (bool containChildren=false)
bool	isActive ()
var	isActive ()
void	setBright (bool bright, bool containChild)
CCRect	getRect ()
CCNode *	getValidNode ()
void	setWidgetZOrder (int z)
int	getWidgetZOrder ()
float	getRelativeLeftPos ()
var	getRelativeLeftPos ()
float	getRelativeBottomPos ()
float	getRelativeRightPos ()
float	getRelativeTopPos ()
CCNode *	getContainerNode ()
void	setWidgetParent (UIWidget *parent)
UIWidget *	getWidgetParent ()
void	setWidgetTag (int tag)
int	getWidgetTag ()
void	addCCNode (CCNode *node)
void	addPushDownEvent (CCObject *target, SEL_PushEvent selector)
var	addPushDownEvent ( var target, var selector)
void	addMoveEvent (CCObject *target, SEL_MoveEvent selector)
void	addReleaseEvent (CCObject *target, SEL_ReleaseEvent selector)
void	addCancelEvent (CCObject *target, SEL_CancelEvent selector)
bool	removeChild (UIWidget *child, bool cleanup)
void	removeFromParentAndCleanup (bool cleanup)
void	removeAllChildrenAndCleanUp (bool cleanup)
void	setActionTag (int tag)
int	getActionTag ()
void	updateSizeAndPosition ()
var	updateSizeAndPosition ()
Public Member Functions inherited from CCObject
	CCObject (void)
virtual	~CCObject (void)
void	release (void)
void	retain (void)
CCObject *	autorelease (void)
CCObject *	copy (void)
bool	isSingleReference (void) const
unsigned int	retainCount (void) const
virtual bool	isEqual (const CCObject *pObject)
virtual void	acceptVisitor (CCDataVisitor &visitor)
virtual void	update (float dt)
Public Member Functions inherited from CCCopying
virtual CCObject *	copyWithZone (CCZone *pZone)

Static Public Member Functions
static UILayout *	create ()
	Allocates and initializes a layout. More...
Static Public Member Functions inherited from UIWidget
static UIWidget *	create ()
	Allocates and initializes a widget. More...

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

Protected Attributes
bool	m_bClippingEnabled
var	m_bClippingEnabled
bool	m_bBackGroundScale9Enabled
CCNode *	m_pBackGroundImage
var	m_pBackGroundImage
std::string	m_strBackGroundImageFileName
CCRect	m_backGroundImageCapInsets
LayoutBackGroundColorType	m_colorType
var	m_colorType
TextureResType	m_eBGImageTexType
CCLayerColor *	m_pColorRender
CCLayerGradient *	m_pGradientRender
var	m_pGradientRender
ccColor3B	m_cColor
ccColor3B	m_gStartColor
var	m_gStartColor
ccColor3B	m_gEndColor
var	m_gEndColor
CCPoint	m_AlongVector
var	m_AlongVector
int	m_nCOpacity
CCSize	m_backGroundImageTextureSize
var	m_backGroundImageTextureSize
LayoutType	m_eLayoutType
Protected Attributes inherited from UIWidget
bool	m_bEnabled
	Highest control of widget. More...
bool	m_bVisible
	is this widget visible More...
bool	m_bBright
	is this widget bright More...
bool	m_bTouchEnabled
	is this widget touch endabled More...
var	m_bTouchEnabled
	is this widget touch endabled More...
bool	m_bTouchPassedEnabled
	is the touch event should be passed More...
bool	m_bFocus
	is the widget on focus More...
int	m_nWidgetZOrder
	z-order value that affects the draw order and touch order More...
CCPoint	m_anchorPoint
	anchor point normalized More...
UIWidget *	m_pWidgetParent
	parent of widget More...
var	m_pWidgetParent
	parent of widget More...
BrightStyle	m_eBrightStyle
	bright style More...
bool	m_bUpdateEnabled
	is "update" method scheduled More...
var	m_bUpdateEnabled
	is "update" method scheduled More...
CCNode *	m_pRenderer
	base renderer More...
CCPoint	m_touchStartPos
	touch began point More...
var	m_touchStartPos
	touch began point More...
CCPoint	m_touchMovePos
	touch moved point More...
CCPoint	m_touchEndPos
	touch ended point More...
var	m_touchEndPos
	touch ended point More...
CCObject *	m_pTouchEventListener
SEL_TouchEvent	m_pfnTouchEventSelector
var	m_pfnTouchEventSelector
int	m_nWidgetTag
std::string	m_strName
var	m_strName
WidgetType	m_WidgetType
var	m_WidgetType
int	m_nActionTag
var	m_nActionTag
CCSize	m_size
var	m_size
CCSize	m_customSize
var	m_customSize
CCDictionary *	m_pLayoutParameterDictionary
var	m_pLayoutParameterDictionary
bool	m_bIgnoreSize
var	m_bIgnoreSize
CCArray *	m_children
var	m_children
bool	m_bAffectByClipping
var	m_bAffectByClipping
CCScheduler *	m_pScheduler
SizeType	m_eSizeType
var	m_eSizeType
CCPoint	m_sizePercent
var	m_sizePercent
PositionType	m_ePositionType
var	m_ePositionType
CCPoint	m_positionPercent
var	m_positionPercent
bool	m_bIsRunning
CCObject *	m_pUserObject
var	m_pUserObject
CCObject *	m_pPushListener
var	m_pPushListener
SEL_PushEvent	m_pfnPushSelector
var	m_pfnPushSelector
CCObject *	m_pMoveListener
SEL_MoveEvent	m_pfnMoveSelector
var	m_pfnMoveSelector
CCObject *	m_pReleaseListener
SEL_ReleaseEvent	m_pfnReleaseSelector
var	m_pfnReleaseSelector
CCObject *	m_pCancelListener
var	m_pCancelListener
SEL_ReleaseEvent	m_pfnCancelSelector
var	m_pfnCancelSelector
Protected Attributes inherited from CCObject
unsigned int	m_uReference
unsigned int	m_uAutoReleaseCount

Additional Inherited Members
Public Attributes inherited from CCObject
unsigned int	m_uID
int	m_nLuaID

Constructor & Destructor Documentation

UILayout

(

)

var ctor

(

)

virtual ~UILayout ( )

virtual

Default destructor.

Member Function Documentation

void addBackGroundImage ( )

protected

var addBackGroundImage ( )

protected

virtual bool addChild ( UIWidget *  child)

virtual

Adds a child to the container.

Parameters

child

A child widget

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, UIListViewEx, and UIListView.

var addChild ( var  child)

virtual

Adds a child to the container.

Parameters

child

A child widget

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, UIListViewEx, and UIListView.

virtual void copyClonedWidgetChildren ( UIWidget *  model)

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIListView, UIPageView, and UIListViewEx.

var copyClonedWidgetChildren ( var  model)

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIListView, UIPageView, and UIListViewEx.

virtual void copySpecialProperties ( UIWidget *  model)

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIListView, UIPageView, and UIListViewEx.

var copySpecialProperties ( var  model)

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIListView, UIPageView, and UIListViewEx.

static UILayout* create ( )

static

Allocates and initializes a layout.

var create ( )

static

Allocates and initializes a layout.

virtual UIWidget* createCloneInstance ( )

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIListView, UIPageView, and UIListViewEx.

var createCloneInstance ( )

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIListView, UIPageView, and UIListViewEx.

virtual void doLayout ( )

virtual

Reimplemented in UIScrollView, UIListView, and UIPageView.

var doLayout ( )

virtual

Reimplemented in UIScrollView, UIListView, and UIPageView.

const CCSize& getBackGroundImageTextureSize

(

)

const

Gets background image texture size.

Returns

background image texture size.

var getBackGroundImageTextureSize

(

)

Gets background image texture size.

Returns

background image texture size.

virtual const CCSize& getContentSize ( ) const

virtual

Gets the content size of widget.

Content size is widget's texture size.

Reimplemented from UIWidget.

var getContentSize ( )

virtual

Gets the content size of widget.

Content size is widget's texture size.

Reimplemented from UIWidget.

virtual const char* getDescription ( ) const

virtual

Returns the "class name" of widget.

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, UIListViewEx, UIListView, and UIRootWidget.

var getDescription ( )

virtual

Returns the "class name" of widget.

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, UIListViewEx, 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.

virtual bool hitTest ( const CCPoint &  pt)

virtual

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)

virtual

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 ( )

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, UIListViewEx, UIListView, UIDragPanel, and UIRootWidget.

var init ( )

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, UIListViewEx, UIListView, UIDragPanel, and UIRootWidget.

virtual void initRenderer ( )

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView.

var initRenderer ( )

protectedvirtual

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.

virtual void onSizeChanged ( )

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, UIListViewEx, and UIListView.

var onSizeChanged ( )

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIScrollView, UIPageView, UIListViewEx, and UIListView.

void removeBackGroundImage

(

)

Remove the background image of layout.

var removeBackGroundImage

(

)

Remove the background image of layout.

void setBackGroundColor

(

const ccColor3B &

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

void setBackGroundColor	(	const ccColor3B &	startColor,
		const ccColor3B &	endColor
	)

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

Parameters

start	color
end	color

var setBackGroundColor	(	var	startColor,
		var	endColor
	)

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

Parameters

start	color
end	color

void setBackGroundColorOpacity

(

int

opacity)

Sets background opacity layout.

Parameters

opacity

var setBackGroundColorOpacity

(

var

opacity)

Sets background opacity layout.

Parameters

opacity

void setBackGroundColorType

(

LayoutBackGroundColorType

type)

Sets Color Type for layout.

Parameters

type@see

LayoutBackGroundColorType.

var setBackGroundColorType

(

var

type)

Sets Color Type for layout.

Parameters

type@see

LayoutBackGroundColorType.

void setBackGroundColorVector

(

const CCPoint &

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

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

Sets a background image for layout.

Parameters

fileName	image file path.
texType@see	TextureResType. 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

fileName	image file path.
texType@see	TextureResType. UI_TEX_TYPE_LOCAL means local file, UI_TEX_TYPE_PLIST means sprite frame.

void setBackGroundImageCapInsets

(

const CCRect &

capInsets)

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

Parameters

capinsets

of background image.

var setBackGroundImageCapInsets

(

var

capInsets)

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

Parameters

capinsets

of background image.

void setBackGroundImageScale9Enable ( bool  is)

inline

These methods will be removed.

var setBackGroundImageScale9Enable ( var  is)

inline

These methods will be removed.

void setBackGroundImageScale9Enabled

(

bool

enabled)

Sets background iamge use scale9 renderer.

Parameters

enabled

true that use scale9 renderer, false otherwise.

var setBackGroundImageScale9Enabled

(

var

enabled)

Sets background iamge use scale9 renderer.

Parameters

enabled

true that use scale9 renderer, false otherwise.

virtual void setClippingEnable ( bool  is)

inlinevirtual

Reimplemented in UIScrollView, UIListView, and UIPageView.

var setClippingEnable ( var  is)

inlinevirtual

Reimplemented in UIScrollView, UIListView, and UIPageView.

virtual void setClippingEnabled ( bool  able)

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

clipping

enabled.

Reimplemented in UIScrollView, UIListView, and UIPageView.

var setClippingEnabled ( var  able)

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

clipping

enabled.

Reimplemented in UIScrollView, UIListView, and UIPageView.

virtual void setColor ( const ccColor3B &  color)

virtual

Sets color to widget.

It default change the color of widget's children.

Parameters

color

Reimplemented from UIWidget.

var setColor ( var  color)

virtual

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.

virtual void setOpacity ( int  opacity)

virtual

Sets opacity to widget.

It default change the opacity of widget's children.

Parameters

color

Reimplemented from UIWidget.

var setOpacity ( var  opacity)

virtual

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

Member Data Documentation

CCPoint m_AlongVector

protected

var m_AlongVector

protected

CCRect m_backGroundImageCapInsets

protected

var m_backGroundImageCapInsets

protected

CCSize m_backGroundImageTextureSize

protected

var m_backGroundImageTextureSize

protected

bool m_bBackGroundScale9Enabled

protected

var m_bBackGroundScale9Enabled

protected

bool m_bClippingEnabled

protected

var m_bClippingEnabled

protected

ccColor3B m_cColor

protected

var m_cColor

protected

LayoutBackGroundColorType m_colorType

protected

var m_colorType

protected

TextureResType m_eBGImageTexType

protected

var m_eBGImageTexType

protected

LayoutType m_eLayoutType

protected

var m_eLayoutType

protected

ccColor3B m_gEndColor

protected

var m_gEndColor

protected

ccColor3B m_gStartColor

protected

var m_gStartColor

protected

int m_nCOpacity

protected

var m_nCOpacity

protected

CCNode* m_pBackGroundImage

protected

var m_pBackGroundImage

protected

CCLayerColor* m_pColorRender

protected

var m_pColorRender

protected

CCLayerGradient* m_pGradientRender

protected

var m_pGradientRender

protected

std::string m_strBackGroundImageFileName

protected

var m_strBackGroundImageFileName

protected

---

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

• /Users/cocos2d/MyWork/cocos2d-x/extensions/CocoStudio/GUI/Layouts/UILayout.h