#include <Layout.h>

Inheritance diagram for Layout:

Public Member Functions
	Layout ()
	Default constructor. More...

virtual	~Layout ()
	Default destructor. More...

virtual bool	hitTest (const Point &pt)
	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 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...

void	setBackGroundImageScale9Enabled (bool enabled)
	Sets background iamge use scale9 renderer. More...

void	setBackGroundColor (const Color3B &color)
	Sets background color for layout, if color type is LAYOUT_COLOR_SOLID. More...

void	setBackGroundColor (const Color3B &startColor, const Color3B &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 Point &vector)
	Sets background color vector for layout, if color type is LAYOUT_COLOR_GRADIENT. More...

virtual void	setColor (const Color3B &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...

local	removeBackGroundImage ()
	Remove the background image of layout. More...

const Size &	getBackGroundImageTextureSize () const
	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 Size &	getContentSize () const
	Gets the content size of widget. More...

local	getContentSize ()
	Gets the content size of widget. More...

virtual void	setLayoutType (LayoutType type)
	Sets LayoutType. More...

virtual LayoutType	getLayoutType () const
	Gets LayoutType. More...

virtual void	doLayout ()
virtual const char *	getDescription () const
	Returns the "class name" of widget. More...

Public Member Functions inherited from UIWidget
	UIWidget (void)
	Default constructor. More...

	UIWidget ()
	Default constructor. More...

virtual	~UIWidget ()
	Default destructor. More...

local	~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...

local	setTouchEnabled ( local 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...

local	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	addChild (UIWidget *child)
	Adds a child to the container. 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...

virtual void	removeAllChildren ()
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

void	disableUpdate ()
	Unschedules the "update" method. 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...

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 Array *	getChildren ()
	Return an array of children. More...

Node *	getRenderer ()
	Gets the renderer of widget. More...

void	addRenderer (Node *renderer, int zOrder)
	Add a CCNode for rendering. More...

void	removeRenderer (Node *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 (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 Point &pos)
	Changes the position (x,y) of the widget in OpenGL coordinates. More...

void	setPositionPercent (const 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 Point &	getPosition ()
	Gets the position (x,y) of the widget in OpenGL coordinates. More...

const Point &	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...

virtual void	setAnchorPoint (const Point &pt)
	Sets the anchor point in percent. More...

local	setAnchorPoint ( local pt)
	Sets the anchor point in percent. More...

const Point &	getAnchorPoint ()
	Returns the anchor point in percent. More...

var	getAnchorPoint ()
	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...

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...

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...

local	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...

local	setRotationX ( local 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...

local	setRotationY ( local 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 Color3B &	getColor ()
	Gets color of widget. More...

var	getColor ()
	Gets color of widget. More...

local	getColor ()
	Gets color of widget. More...

virtual int	getOpacity ()
	Gets opacity of widget. More...

local	getOpacity ()
	Gets opacity of widget. More...

virtual bool	isCascadeOpacityEnabled ()
local	isCascadeOpacityEnabled ()
virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
local	setCascadeOpacityEnabled ( local cascadeOpacityEnabled)
virtual bool	isCascadeColorEnabled ()
virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)
local	setCascadeColorEnabled ( local cascadeColorEnabled)
void	setBlendFunc (BlendFunc blendFunc)
virtual void	setActionManager (ActionManager *actionManager)
local	setActionManager ( local actionManager)
virtual ActionManager *	getActionManager ()
local	getActionManager ()
Action *	runAction (Action *action)
void	stopAllActions (void)
void	stopAction (Action *action)
void	stopActionByTag (int tag)
Action *	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...

local	didNotSelectSelf ()
	A call back function when widget lost of focus. More...

bool	clippingParentAreaContainPoint (const Point &pt)
virtual void	checkChildInfo (int handleState, UIWidget *sender, const Point &touchPoint)
local	checkChildInfo ( local handleState, local sender, local touchPoint)
const Point &	getTouchStartPos ()
const Point &	getTouchMovePos ()
const Point &	getTouchEndPos ()
local	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...

local	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 Size &size)
	Changes the size that is widget's size. More...

local	setSize ( local size)
	Changes the size that is widget's size. More...

virtual void	setSizePercent (const Point &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...

local	getSizeType ()
	Gets the size type of widget. More...

const Size &	getSize () const
	Returns size of widget. More...

const Point &	getSizePercent () const
	Returns size percent of widget. More...

local	getSizePercent ()
	Returns size percent of widget. More...

virtual bool	onTouchBegan (const Point &touchPoint)
	A call back function called when widget is selected, and on touch began. More...

virtual void	onTouchMoved (const Point &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 Point &touchPoint)
	A call back function called when widget is selected, and on touch ended. More...

virtual void	onTouchCancelled (const Point &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 Point &touchPoint)
	A call back function called when widget is selected, and on touch long clicked. More...

void	setLayoutParameter (LayoutParameter *parameter)
	Sets a LayoutParameter to widget. More...

LayoutParameter *	getLayoutParameter ()
	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...

Point	getWorldPosition ()
	Gets world position of widget. More...

Point	convertToWorldSpace (const Point &pt)
	Converts a Point to world space coordinates. More...

virtual Node *	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...

virtual void	onEnter ()
virtual void	onExit ()
local	onExit ()
void	setActionTag (int tag)
int	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...

Object *	autorelease ()
	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 Layout *	create ()
	Allocates and initializes a layout. More...

local	create ()
	Allocates and initializes a layout. More...

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

local	create ()
	Allocates and initializes a widget. More...

Protected Member Functions
virtual bool	init ()
virtual void	initRenderer ()
local	initRenderer ()
virtual void	onSizeChanged ()
local	onSizeChanged ()
void	addBackGroundImage ()
Protected Member Functions inherited from UIWidget
virtual void	onPressStateChangedToNormal ()
local	onPressStateChangedToNormal ()
virtual void	onPressStateChangedToPressed ()
virtual void	onPressStateChangedToDisabled ()
void	pushDownEvent ()
void	moveEvent ()
void	releaseUpEvent ()
void	cancelUpEvent ()
void	longClickEvent ()
void	updateAnchorPoint ()
var	updateAnchorPoint ()
local	updateAnchorPoint ()
virtual void	releaseResoures ()
	Release texture resoures of widget. More...

var	releaseResoures ()
	Release texture resoures of widget. More...

local	releaseResoures ()
	Release texture resoures of widget. More...

void	updateSizeAndPosition ()

Protected Attributes
bool	_clippingEnabled
var	_clippingEnabled
local	_clippingEnabled
bool	_backGroundScale9Enabled
Node *	_backGroundImage
var	_backGroundImage
local	_backGroundImage
std::string	_backGroundImageFileName
var	_backGroundImageFileName
local	_backGroundImageFileName
Rect	_backGroundImageCapInsets
LayoutBackGroundColorType	_colorType
var	_colorType
local	_colorType
TextureResType	_bgImageTexType
LayerColor *	_colorRender
var	_colorRender
local	_colorRender
LayerGradient *	_gradientRender
var	_gradientRender
local	_gradientRender
Color3B	_cColor
Color3B	_gStartColor
var	_gStartColor
local	_gStartColor
Color3B	_gEndColor
var	_gEndColor
local	_gEndColor
Point	_alongVector
var	_alongVector
local	_alongVector
int	_cOpacity
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...

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...

bool	_focus
	is the widget on focus More...

int	_widgetZOrder
	z-order value that affects the draw order and touch order More...

Point	_anchorPoint
	anchor point normalized More...

var	_anchorPoint
	anchor point normalized More...

local	_anchorPoint
	anchor point normalized More...

UIWidget *	_widgetParent
	parent of widget More...

BrightStyle	_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...

Node *	_renderer
	base renderer More...

Point	_touchStartPos
	touch began point More...

var	_touchStartPos
	touch began point More...

local	_touchStartPos
	touch began point More...

Point	_touchMovePos
	touch moved point More...

var	_touchMovePos
	touch moved point More...

local	_touchMovePos
	touch moved point More...

Point	_touchEndPos
	touch ended point More...

var	_touchEndPos
	touch ended point More...

local	_touchEndPos
	touch ended point More...

Object *	_touchEventListener
SEL_TouchEvent	_touchEventSelector
var	_touchEventSelector
local	_touchEventSelector
int	_widgetTag
std::string	_name
var	_name
local	_name
WidgetType	_widgetType
var	_widgetType
local	_widgetType
int	_actionTag
var	_actionTag
local	_actionTag
Size	_size
Size	_customSize
var	_customSize
local	_customSize
LayoutParameter *	_layoutParameter
var	_layoutParameter
local	_layoutParameter
bool	_ignoreSize
Array *	_children
var	_children
local	_children
bool	_affectByClipping
var	_affectByClipping
local	_affectByClipping
Scheduler *	_scheduler
SizeType	_sizeType
var	_sizeType
local	_sizeType
Point	_sizePercent
var	_sizePercent
local	_sizePercent
PositionType	_positionType
var	_positionType
local	_positionType
Point	_positionPercent
var	_positionPercent
local	_positionPercent
bool	_isRunning
Protected Attributes inherited from Object
unsigned int	_reference
	count of references More...

var	_reference
	count of references More...

local	_reference
	count of references More...

unsigned int	_autoReleaseCount
	count of autorelease More...

var	_autoReleaseCount
	count of autorelease More...

local	_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

Layout ( )

Default constructor.

var Layout ( )

Default constructor.

local Layout ( )

Default constructor.

virtual ~Layout ( )

virtual

Default destructor.

var ~Layout ( )

virtual

Default destructor.

local ~Layout ( )

virtual

Default destructor.

Member Function Documentation

void addBackGroundImage ( )

protected

var addBackGroundImage ( )

protected

local addBackGroundImage ( )

protected

static Layout* create ( )

static

Allocates and initializes a layout.

var create ( )

static

Allocates and initializes a layout.

local create ( )

static

Allocates and initializes a layout.

virtual void doLayout ( )

virtual

Reimplemented in UIDragPanel, UIScrollView, UIListView, and UIPageView.

var doLayout ( )

virtual

Reimplemented in UIDragPanel, UIScrollView, UIListView, and UIPageView.

local doLayout ( )

virtual

Reimplemented in UIDragPanel, UIScrollView, UIListView, and UIPageView.

const 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 Size& 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.

local 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 UIDragPanel, UIScrollView, UIListView, UIPageView, and UIRootWidget.

var getDescription ( )

virtual

Returns the "class name" of widget.

Reimplemented from UIWidget.

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

local getDescription ( )

virtual

Returns the "class name" of widget.

Reimplemented from UIWidget.

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

virtual LayoutType getLayoutType ( ) const

virtual

Gets LayoutType.

See Also: LayoutType

Returns: LayoutType

Reimplemented in UIDragPanel, and UIScrollView.

var getLayoutType ( )

virtual

Gets LayoutType.

See Also: LayoutType

Returns: LayoutType

Reimplemented in UIDragPanel, and UIScrollView.

local getLayoutType ( )

virtual

Gets LayoutType.

See Also: LayoutType

Returns: LayoutType

Reimplemented in UIDragPanel, and UIScrollView.

virtual bool hitTest ( const Point & 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.

local hitTest ( local 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 UIDragPanel, UIScrollView, UIPageView, UIListView, and UIRootWidget.

var init ( )

protectedvirtual

Reimplemented from UIWidget.

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

local init ( )

protectedvirtual

Reimplemented from UIWidget.

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

virtual void initRenderer ( )

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIDragPanel, and UIScrollView.

var initRenderer ( )

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIDragPanel, and UIScrollView.

local initRenderer ( )

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIDragPanel, and 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 ( )

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIDragPanel, UIScrollView, UIPageView, and UIListView.

var onSizeChanged ( )

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIDragPanel, UIScrollView, UIPageView, and UIListView.

local onSizeChanged ( )

protectedvirtual

Reimplemented from UIWidget.

Reimplemented in UIDragPanel, 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 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 Color3B &	startColor,
		const Color3B &	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

local setBackGroundColor	(	local	startColor,
		local	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

local setBackGroundColorOpacity ( local 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.

local setBackGroundColorType ( local type)

Sets Color Type for layout.

Parameters

type@see LayoutBackGroundColorType.

void setBackGroundColorVector ( const 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

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.

local setBackGroundImage	(	local	fileName,
		local	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 Rect & 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.

local setBackGroundImageCapInsets ( local capInsets)

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

Parameters

capinsets of background image.

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.

local
setBackGroundImageScale9Enabled ( local enabled)

Sets background iamge use scale9 renderer.

Parameters

enabled true that use scale9 renderer, false otherwise.

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 UIDragPanel, 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 UIDragPanel, UIScrollView, UIListView, and UIPageView.

local setClippingEnabled ( local 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 UIDragPanel, UIScrollView, UIListView, and UIPageView.

virtual void setColor ( const Color3B & 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.

local setColor ( local 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 UIDragPanel, and UIScrollView.

var setLayoutType ( var type)

virtual

Sets LayoutType.

See Also: LayoutType

Parameters

LayoutType

Reimplemented in UIDragPanel, and UIScrollView.

local setLayoutType ( local type)

virtual

Sets LayoutType.

See Also: LayoutType

Parameters

LayoutType

Reimplemented in UIDragPanel, and UIScrollView.

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.

local setOpacity ( local opacity)

virtual

Sets opacity to widget.

It default change the opacity of widget's children.

Parameters

color

Reimplemented from UIWidget.

Member Data Documentation

Point _alongVector

protected

var _alongVector

protected

local _alongVector

protected

Node* _backGroundImage

protected

var _backGroundImage

protected

local _backGroundImage

protected

Rect _backGroundImageCapInsets

protected

var _backGroundImageCapInsets

protected

local _backGroundImageCapInsets

protected

std::string
_backGroundImageFileName

protected

var _backGroundImageFileName

protected

local _backGroundImageFileName

protected

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

Color3B _cColor

protected

var _cColor

protected

local _cColor

protected

bool _clippingEnabled

protected

var _clippingEnabled

protected

local _clippingEnabled

protected

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

Color3B _gEndColor

protected

var _gEndColor

protected

local _gEndColor

protected

LayerGradient* _gradientRender

protected

var _gradientRender

protected

local _gradientRender

protected

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:

/Users/cocos2d/MyWork/cocos2d-x-develop/extensions/CocoStudio/GUI/Layouts/Layout.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation