for Cocos2D. More...

#include <CCControlButton.h>

Inheritance diagram for CCControlButton:

Collaboration diagram for CCControlButton:

Public Member Functions
	CCControlButton ()

virtual	~CCControlButton ()

virtual void	needsLayout (void)
	Updates the control layout using its current internal state. More...

virtual void	setEnabled (bool enabled)
	Tells whether the control is enabled. More...

virtual void	setSelected (bool enabled)
	A Boolean value that determines the control selected state. More...

virtual void	setHighlighted (bool enabled)
	A Boolean value that determines whether the control is highlighted. More...

virtual CCString *	getCurrentTitle (void)

virtual const ccColor3B &	getCurrentTitleColor (void)

bool	doesAdjustBackgroundImage ()
	Adjust the background image. More...

void	setAdjustBackgroundImage (bool adjustBackgroundImage)

virtual CCNode *	getTitleLabel (void)

virtual void	setTitleLabel (CCNode *var)

virtual CCScale9Sprite *	getBackgroundSprite (void)

virtual void	setBackgroundSprite (CCScale9Sprite *var)

virtual CCSize	getPreferredSize (void)

virtual void	setPreferredSize (CCSize var)

virtual bool	getZoomOnTouchDown (void)

virtual void	setZoomOnTouchDown (bool var)

virtual CCPoint	getLabelAnchorPoint (void)

virtual void	setLabelAnchorPoint (CCPoint var)

virtual GLubyte	getOpacity (void)
	Returns the opacity. More...

virtual void	setOpacity (GLubyte var)
	Changes the opacity. More...

virtual const ccColor3B &	getColor (void)
	Returns color that is currently used. More...

virtual void	setColor (const ccColor3B &)
	Changes the color with R,G,B bytes. More...

bool	isPushed ()

virtual CCDictionary *	getTitleDispatchTable (void)

virtual void	setTitleDispatchTable (CCDictionary *var)

virtual CCDictionary *	getTitleColorDispatchTable (void)

virtual void	setTitleColorDispatchTable (CCDictionary *var)

virtual CCDictionary *	getTitleLabelDispatchTable (void)

virtual void	setTitleLabelDispatchTable (CCDictionary *var)

virtual CCDictionary *	getBackgroundSpriteDispatchTable (void)

virtual void	setBackgroundSpriteDispatchTable (CCDictionary *var)

virtual int	getVerticalMargin (void)

virtual int	getHorizontalOrigin (void)

virtual void	setMargins (int marginH, int marginV)

virtual bool	init ()
	Initializes the instance of CCNode. More...

virtual bool	initWithLabelAndBackgroundSprite (CCNode label, CCScale9Sprite backgroundSprite)

virtual bool	initWithTitleAndFontNameAndFontSize (std::string title, const char *fontName, float fontSize)

virtual bool	initWithBackgroundSprite (CCScale9Sprite *sprite)

virtual bool	ccTouchBegan (CCTouch pTouch, CCEvent pEvent)

virtual void	ccTouchMoved (CCTouch pTouch, CCEvent pEvent)

virtual void	ccTouchEnded (CCTouch pTouch, CCEvent pEvent)

virtual void	ccTouchCancelled (CCTouch pTouch, CCEvent pEvent)

virtual CCString *	getTitleForState (CCControlState state)
	Returns the title used for a state. More...

virtual void	setTitleForState (CCString *title, CCControlState state)
	Sets the title string to use for the specified state. More...

virtual const ccColor3B	getTitleColorForState (CCControlState state)
	Returns the title color used for a state. More...

virtual void	setTitleColorForState (ccColor3B color, CCControlState state)
	Sets the color of the title to use for the specified state. More...

virtual CCNode *	getTitleLabelForState (CCControlState state)
	Returns the title label used for a state. More...

virtual void	setTitleLabelForState (CCNode *label, CCControlState state)
	Sets the title label to use for the specified state. More...

virtual void	setTitleTTFForState (const char *fntFile, CCControlState state)

virtual const char *	getTitleTTFForState (CCControlState state)

virtual void	setTitleTTFSizeForState (float size, CCControlState state)

virtual float	getTitleTTFSizeForState (CCControlState state)

virtual void	setTitleBMFontForState (const char *fntFile, CCControlState state)
	Sets the font of the label, changes the label to a CCLabelBMFont if neccessary. More...

virtual const char *	getTitleBMFontForState (CCControlState state)

virtual CCScale9Sprite *	getBackgroundSpriteForState (CCControlState state)
	Returns the background sprite used for a state. More...

virtual void	setBackgroundSpriteForState (CCScale9Sprite *sprite, CCControlState state)
	Sets the background sprite to use for the specified button state. More...

virtual void	setBackgroundSpriteFrameForState (CCSpriteFrame *spriteFrame, CCControlState state)
	Sets the background spriteFrame to use for the specified button state. More...

Public Member Functions inherited from CCControl
virtual CCControlState	getState (void)

virtual void	setEnabled (bool bEnabled)
	Tells whether the control is enabled. More...

virtual bool	isEnabled ()

virtual void	setSelected (bool bSelected)
	A Boolean value that determines the control selected state. More...

virtual bool	isSelected ()

virtual void	setHighlighted (bool bHighlighted)
	A Boolean value that determines whether the control is highlighted. More...

virtual bool	isHighlighted ()

bool	hasVisibleParents ()

virtual void	needsLayout ()
	Updates the control layout using its current internal state. More...

virtual bool	isOpacityModifyRGB ()
	Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity) More...

virtual void	setOpacityModifyRGB (bool bOpacityModifyRGB)
	Changes the OpacityModifyRGB property. More...

	CCControl ()
	ctor More...

virtual bool	init (void)
	Initializes the instance of CCNode. More...

virtual	~CCControl ()
	NA NA. More...

virtual void	onEnter ()
	NA NA. More...

virtual void	onExit ()
	NA NA. More...

virtual void	registerWithTouchDispatcher ()

virtual void	sendActionsForControlEvents (CCControlEvent controlEvents)
	Sends action messages for the given control events. More...

virtual void	addTargetWithActionForControlEvents (CCObject *target, SEL_CCControlHandler action, CCControlEvent controlEvents)
	Adds a target and action for a particular event (or events) to an internal dispatch table. More...

virtual void	removeTargetWithActionForControlEvents (CCObject *target, SEL_CCControlHandler action, CCControlEvent controlEvents)
	Removes a target and action for a particular event (or events) from an internal dispatch table. More...

virtual CCPoint	getTouchLocation (CCTouch *touch)
	Returns a point corresponding to the touh location converted into the control space coordinates. More...

virtual bool	isTouchInside (CCTouch *touch)
	Returns a boolean value that indicates whether a touch is inside the bounds of the receiver. More...

void	addHandleOfControlEvent (int nFunID, CCControlEvent controlEvent)
	NA. More...

void	removeHandleOfControlEvent (CCControlEvent controlEvent)
	NA. More...

Public Member Functions inherited from CCLayerRGBA
	CREATE_FUNC (CCLayerRGBA)

	CCLayerRGBA ()
	ctor More...

virtual	~CCLayerRGBA ()
	NA NA. More...

virtual bool	init ()
	Initializes the instance of CCNode. More...

virtual GLubyte	getOpacity ()
	Returns the opacity. More...

virtual GLubyte	getDisplayedOpacity ()
	Returns the displayed opacity. More...

virtual void	setOpacity (GLubyte opacity)
	Changes the opacity. More...

virtual void	updateDisplayedOpacity (GLubyte parentOpacity)
	recursive method that updates the displayed opacity. More...

virtual bool	isCascadeOpacityEnabled ()
	whether or not opacity should be propagated to its children. More...

virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)

virtual const ccColor3B &	getColor ()
	Returns color that is currently used. More...

virtual const ccColor3B &	getDisplayedColor ()
	Returns the displayed color. More...

virtual void	setColor (const ccColor3B &color)
	Changes the color with R,G,B bytes. More...

virtual void	updateDisplayedColor (const ccColor3B &parentColor)
	recursive method that updates display color More...

virtual bool	isCascadeColorEnabled ()
	whether or not color should be propagated to its children. More...

virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)

virtual void	setOpacityModifyRGB (bool bValue)
	Changes the OpacityModifyRGB property. More...

virtual bool	isOpacityModifyRGB ()
	Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity) More...

Public Member Functions inherited from CCNode
virtual	~CCNode (void)
	Default destructor NA NA. More...

virtual bool	init ()
	Initializes the instance of CCNode. More...

const char *	description (void)
	Gets the description string. More...

virtual void	setVisible (bool visible)
	Sets whether the node is visible. More...

virtual bool	isVisible ()
	Determines if the node is visible. More...

virtual void	setRotation (float fRotation)
	Sets the rotation (angle) of the node in degrees. More...

virtual float	getRotation ()
	Returns the rotation of the node in degrees. More...

virtual void	setRotationX (float fRotaionX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...

virtual float	getRotationX ()
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...

virtual void	setRotationY (float fRotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

virtual float	getRotationY ()
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

virtual void	setOrderOfArrival (unsigned int uOrderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...

virtual unsigned int	getOrderOfArrival ()
	Returns the arrival order, indecates which children is added previously. More...

virtual void	setGLServerState (ccGLServerState glServerState)
	Sets the state of OpenGL server side. More...

virtual ccGLServerState	getGLServerState ()
	Returns the state of OpenGL server side. More...

virtual void	ignoreAnchorPointForPosition (bool ignore)
	Sets whether the anchor point will be (0,0) when you position this node. More...

virtual bool	isIgnoreAnchorPointForPosition ()
	Gets whether the anchor point will be (0,0) when you position this node. More...

virtual void	removeChild (CCNode *child)
	Removes a child from the container with a cleanup. More...

virtual void	removeChild (CCNode *child, bool cleanup)
	Removes a child from the container. More...

virtual void	removeChildByTag (int tag)
	Removes a child from the container by tag value with a cleanup. More...

virtual void	removeChildByTag (int tag, bool cleanup)
	Removes a child from the container by tag value. More...

virtual void	removeAllChildren ()
	Removes all children from the container with a cleanup. More...

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

virtual void	reorderChild (CCNode *child, int zOrder)
	Reorders a child according to a new z value. More...

virtual void	sortAllChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...

virtual CCCamera *	getCamera ()
	Returns a camera object that lets you move the node using a gluLookAt. More...

virtual bool	isRunning ()
	Returns whether or not the node accepts event callbacks. More...

virtual void	cleanup (void)
	Stops all running actions and schedulers. More...

virtual void	draw (void)
	Override this method to draw your own node. More...

virtual void	visit (void)
	Visits this node's children and draw them recursively. More...

CCRect	boundingBox (void)
	Returns a "local" axis aligned bounding box of the node. More...

virtual CCAffineTransform	nodeToWorldTransform (void)
	Returns the world affine transform matrix. More...

virtual CCAffineTransform	worldToNodeTransform (void)
	Returns the inverse world affine transform matrix. More...

	CCNode (void)
	Default constructor ctor. More...

	CCNode (const CCNode &)

virtual void	setZOrder (int zOrder)
	Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...

virtual void	_setZOrder (int z)
	Sets the z order which stands for the drawing order. More...

virtual int	getZOrder ()
	Gets the Z order of this node. More...

virtual void	setVertexZ (float vertexZ)
	Sets the real OpenGL Z vertex. More...

virtual float	getVertexZ ()
	Gets OpenGL Z vertex of this node. More...

virtual void	setScaleX (float fScaleX)
	Changes the scale factor on X axis of this node. More...

virtual float	getScaleX ()
	Returns the scale factor on X axis of this node. More...

virtual void	setScaleY (float fScaleY)
	Changes the scale factor on Y axis of this node. More...

virtual float	getScaleY ()
	Returns the scale factor on Y axis of this node. More...

virtual void	setScale (float scale)
	Changes both X and Y scale factor of the node. More...

virtual float	getScale ()
	Gets the scale factor of the node, when X and Y have the same scale factor. More...

virtual void	setScale (float fScaleX, float fScaleY)
	Changes both X and Y scale factor of the node. More...

virtual void	setPosition (const CCPoint &position)
	Changes the position (x,y) of the node in OpenGL coordinates. More...

virtual const CCPoint &	getPosition ()
	Gets the position (x,y) of the node in OpenGL coordinates. More...

virtual void	setPosition (float x, float y)
	Sets position in a more efficient way. More...

virtual void	getPosition (float x, float y)
	Gets position in a more efficient way, returns two number instead of a CCPoint object. More...

virtual void	setPositionX (float x)
	Gets/Sets x or y coordinate individually for position. More...

virtual float	getPositionX (void)
	Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...

virtual void	setPositionY (float y)
	Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...

virtual float	getPositionY (void)
	Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...

virtual void	setSkewX (float fSkewX)
	Changes the X skew angle of the node in degrees. More...

virtual float	getSkewX ()
	Returns the X skew angle of the node in degrees. More...

virtual void	setSkewY (float fSkewY)
	Changes the Y skew angle of the node in degrees. More...

virtual float	getSkewY ()
	Returns the Y skew angle of the node in degrees. More...

virtual void	setAnchorPoint (const CCPoint &anchorPoint)
	Sets the anchor point in percent. More...

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

virtual const CCPoint &	getAnchorPointInPoints ()
	Returns the anchorPoint in absolute pixels. More...

virtual void	setContentSize (const CCSize &contentSize)
	Sets the untransformed size of the node. More...

virtual const CCSize &	getContentSize () const
	Returns the untransformed size of the node. More...

virtual CCSize	getScaledContentSize (void)

virtual void	addChild (CCNode *child)
	Adds a child to the container with z-order as 0. More...

virtual void	addChild (CCNode *child, int zOrder)
	Adds a child to the container with a z-order. More...

virtual void	addChild (CCNode *child, int zOrder, int tag)
	Adds a child to the container with z order and tag. More...

virtual CCNode *	getChildByTag (int tag)
	Gets a child from the container with its tag. More...

virtual CCArray *	getChildren ()
	Return an array of children. More...

virtual unsigned int	getChildrenCount (void) const
	Get the amount of children. More...

virtual void	setParent (CCNode *parent)
	Sets the parent node. More...

virtual CCNode *	getParent ()
	Returns a pointer to the parent node. More...

virtual void	removeFromParent ()
	Removes this node itself from its parent node with a cleanup. More...

virtual void	removeFromParentAndCleanup (bool cleanup)
	Removes this node itself from its parent node. More...

virtual void	removeMeAndCleanup (void)

virtual CCGridBase *	getGrid ()
	Returns a grid object that is used when applying effects. More...

virtual void	setGrid (CCGridBase *pGrid)
	Changes a grid object that is used when applying effects. More...

virtual void *	getUserData ()
	Returns a tag that is used to identify the node easily. More...

virtual void	setUserData (void *pUserData)
	Sets a custom user data pointer. More...

virtual CCObject *	getUserObject ()
	Returns a user assigned CCObject. More...

virtual void	setUserObject (CCObject *pUserObject)
	Returns a user assigned CCObject. More...

virtual CCGLProgram *	getShaderProgram ()
	Return the shader program currently used for this node. More...

virtual void	setShaderProgram (CCGLProgram *pShaderProgram)
	Sets the shader program for this node. More...

virtual void	registerScriptHandler (int handler)
	Registers a script function that will be called in onEnter() & onExit() seires functions. More...

virtual void	unregisterScriptHandler (void)
	Unregisters a script function that will be called in onEnter() & onExit() series functions. More...

int	getScriptHandler ()
	Gets script handler for onEnter/onExit event. More...

void	scheduleUpdateWithPriorityLua (int nHandler, int priority)
	Schedules for lua script. More...

virtual void	onEnterTransitionDidFinish ()
	Event callback that is invoked when the CCNode enters in the 'stage'. More...

virtual void	onExitTransitionDidStart ()
	Event callback that is called every time the CCNode leaves the 'stage'. More...

virtual void	setActionManager (CCActionManager *actionManager)
	Sets the CCActionManager object that is used by all actions. More...

virtual CCActionManager *	getActionManager ()
	Gets the CCActionManager object that is used by all actions. More...

CCAction *	runAction (CCAction *action)
	Executes an action, and returns the action that is executed. More...

void	stopAllActions (void)
	Stops and removes all actions from the running action list . More...

void	stopAction (CCAction *action)
	Stops and removes an action from the running action list. More...

void	stopActionByTag (int tag)
	Removes an action from the running action list by its tag. More...

CCAction *	getActionByTag (int tag)
	Gets an action from the running action list by its tag. More...

unsigned int	numberOfRunningActions (void)
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...

virtual void	setScheduler (CCScheduler *scheduler)
	Sets a CCScheduler object that is used to schedule all "updates" and timers. More...

virtual CCScheduler *	getScheduler ()
	Gets a CCSheduler object. More...

bool	isScheduled (SEL_SCHEDULE selector)
	Checks whether a selector is scheduled. More...

void	scheduleUpdate (void)
	Schedules the "update" method. More...

void	scheduleUpdateWithPriority (int priority)
	Schedules the "update" method with a custom priority. More...

void	unscheduleUpdate (void)
	Sets a CCScheduler object that is used to schedule all "updates" and timers. More...

void	schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
	Schedules a custom selector. More...

void	schedule (SEL_SCHEDULE selector, float interval)
	Schedules a custom selector with an interval time in seconds. More...

void	scheduleOnce (SEL_SCHEDULE selector, float delay)
	Schedules a selector that runs only once, with a delay of 0 or larger. More...

void	schedule (SEL_SCHEDULE selector)
	Schedules a custom selector, the scheduled selector will be ticked every frame. More...

void	unschedule (SEL_SCHEDULE selector)
	Unschedules a custom selector. More...

void	unscheduleAllSelectors (void)
	Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...

void	resumeSchedulerAndActions (void)
	Resumes all scheduled selectors and actions. More...

void	pauseSchedulerAndActions (void)
	Pauses all scheduled selectors and actions. More...

virtual void	update (float delta)
	Sets a CCScheduler object that is used to schedule all "updates" and timers. More...

void	transform (void)
	Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes. More...

void	transformAncestors (void)
	Performs OpenGL view-matrix transformation of it's ancestors. More...

virtual void	updateTransform (void)
	Calls children's updateTransform() method recursively. More...

virtual const CCAffineTransform	nodeToParentTransform (void)
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

virtual const CCAffineTransform	parentToNodeTransform (void)
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...

CCPoint	convertToNodeSpace (const CCPoint &worldPoint)
	Converts a Point to node (local) space coordinates. More...

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

CCPoint	convertToNodeSpaceAR (const CCPoint &worldPoint)
	Converts a Point to node (local) space coordinates. More...

CCPoint	convertToWorldSpaceAR (const CCPoint &nodePoint)
	Converts a local Point to world space coordinates.The result is in Points. More...

CCPoint	convertTouchToNodeSpace (CCTouch *touch)
	convenience methods which take a CCTouch instead of CCPoint More...

CCPoint	convertTouchToNodeSpaceAR (CCTouch *touch)
	converts a CCTouch (world coordinates) into a local coordinate. More...

void	setAdditionalTransform (const CCAffineTransform &additionalTransform)
	Sets the additional transform. More...

CCComponent *	getComponent (const char *pName) const
	gets a component by its name More...

virtual bool	addComponent (CCComponent *pComponent)
	adds a component More...

virtual bool	removeComponent (const char *pName)
	removes a component by its name More...

virtual bool	removeComponent (CCComponent *pComponent)
	removes a component by its pointer More...

virtual void	removeAllComponents ()
	removes all components More...

virtual void	updateTweenAction (float, const char *)

CCNode &	operator= (const CCNode &)

Public Member Functions inherited from CCObject
	CCObject (void)

virtual	~CCObject (void)
	NA. More...

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)

	CCObject (const CCObject &)

CCObject &	operator= (const CCObject &)

virtual void	encodeWithCoder (DS_Dictionary *)

virtual bool	canEncode ()

CCObjectType	getObjType () const

virtual int	getTag () const

virtual void	setTag (int nTag)

void	setObjType (CCObjectType)

Public Member Functions inherited from CCCopying
virtual CCObject *	copyWithZone (CCZone *pZone)

Public Member Functions inherited from CCTouchDelegate
	CCTouchDelegate ()

virtual	~CCTouchDelegate ()

virtual bool	ccTouchBegan (CCTouch pTouch, CCEvent pEvent)

virtual void	ccTouchMoved (CCTouch pTouch, CCEvent pEvent)

virtual void	ccTouchEnded (CCTouch pTouch, CCEvent pEvent)

virtual void	ccTouchCancelled (CCTouch pTouch, CCEvent pEvent)

virtual void	ccTouchesBegan (CCSet pTouches, CCEvent pEvent)

virtual void	ccTouchesMoved (CCSet pTouches, CCEvent pEvent)

virtual void	ccTouchesEnded (CCSet pTouches, CCEvent pEvent)

virtual void	ccTouchesCancelled (CCSet pTouches, CCEvent pEvent)

Public Member Functions inherited from CCAccelerometerDelegate
virtual void	didAccelerate (CCAcceleration *pAccelerationValue)

Public Member Functions inherited from CCKeypadDelegate
virtual void	keyBackClicked ()

virtual void	keyMenuClicked ()

Public Member Functions inherited from CCKeyboardDelegate
	CCKeyboardDelegate (const CCKeyboardDelegate &)

	CCKeyboardDelegate ()

CCKeyboardDelegate &	operator= (const CCKeyboardDelegate &)

virtual void	keyDown (enumKeyCodes key)

virtual void	keyUp (enumKeyCodes key)

virtual void	setColor (const ccColor3B &color)=0
	Changes the color with R,G,B bytes. More...

virtual const ccColor3B &	getColor (void)=0
	Returns color that is currently used. More...

virtual const ccColor3B &	getDisplayedColor (void)=0
	Returns the displayed color. More...

virtual GLubyte	getDisplayedOpacity (void)=0
	Returns the displayed opacity. More...

virtual GLubyte	getOpacity (void)=0
	Returns the opacity. More...

virtual void	setOpacity (GLubyte opacity)=0
	Changes the opacity. More...

virtual void	setOpacityModifyRGB (bool bValue)=0
	Changes the OpacityModifyRGB property. More...

virtual bool	isOpacityModifyRGB (void)=0
	Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity) More...

virtual bool	isCascadeColorEnabled (void)=0
	whether or not color should be propagated to its children. More...

virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)=0

virtual void	updateDisplayedColor (const ccColor3B &color)=0
	recursive method that updates display color More...

virtual bool	isCascadeOpacityEnabled (void)=0
	whether or not opacity should be propagated to its children. More...

virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)=0

virtual void	updateDisplayedOpacity (GLubyte opacity)=0
	recursive method that updates the displayed opacity. More...

Static Public Member Functions
static CCControlButton *	create (CCNode label, CCScale9Sprite backgroundSprite)

static CCControlButton *	create (std::string title, const char *fontName, float fontSize)

static CCControlButton *	create (CCScale9Sprite *sprite)

static CCControlButton *	create ()

Static Public Member Functions inherited from CCNode
static CCNode *	create (void)
	Allocates and initializes a node. More...

Static Public Member Functions inherited from CCObject
static CCObject *	createWithCoder (DS_Dictionary *)

Public Attributes
bool	m_doesAdjustBackgroundImage

Public Attributes inherited from CCObject
unsigned int	m_uID

int	m_nLuaID

Protected Attributes
CCString *	m_currentTitle
	The current title that is displayed on the button. More...

ccColor3B	m_currentTitleColor
	The current color used to display the title. More...

CCNode *	m_titleLabel
	The current title label. More...

CCScale9Sprite *	m_backgroundSprite
	The current background sprite. More...

CCSize	m_preferredSize
	The prefered size of the button, if label is larger it will be expanded. More...

bool	m_zoomOnTouchDown
	Adjust the button zooming on touchdown. More...

CCPoint	m_labelAnchorPoint

bool	m_isPushed
	Flag to know if the button is currently pushed. More...

bool	m_bParentInited

CCDictionary *	m_titleDispatchTable

CCDictionary *	m_titleColorDispatchTable

CCDictionary *	m_titleLabelDispatchTable

CCDictionary *	m_backgroundSpriteDispatchTable

int	m_marginV

int	m_marginH

Protected Attributes inherited from CCControl
CCControlState	m_eState
	The current control state constant. More...

bool	m_hasVisibleParents
	True if all of the controls parents are visible. More...

bool	m_bEnabled

bool	m_bSelected

bool	m_bHighlighted

CCDictionary *	m_pDispatchTable
	Table of connection between the CCControlEvents and their associated target-actions pairs. More...

Protected Attributes inherited from CCLayerRGBA
GLubyte	_displayedOpacity

GLubyte	_realOpacity

ccColor3B	_displayedColor

ccColor3B	_realColor

bool	_cascadeOpacityEnabled

bool	_cascadeColorEnabled

Protected Attributes inherited from CCNode
float	m_fRotationX
	rotation angle on x-axis More...

float	m_fRotationY
	rotation angle on y-axis More...

float	m_fScaleX
	scaling factor on x-axis More...

float	m_fScaleY
	scaling factor on y-axis More...

float	m_fVertexZ
	OpenGL real Z vertex. More...

CCPoint	m_obPosition
	position of the node More...

float	m_fSkewX
	skew angle on x-axis More...

float	m_fSkewY
	skew angle on y-axis More...

CCPoint	m_obAnchorPointInPoints
	anchor point in points More...

CCPoint	m_obAnchorPoint
	anchor point normalized (NOT in points) More...

CCSize	m_obContentSize
	untransformed size of the node More...

CCAffineTransform	m_sAdditionalTransform
	transform More...

CCAffineTransform	m_sTransform
	transform More...

CCAffineTransform	m_sInverse
	transform More...

CCCamera *	m_pCamera
	a camera More...

CCGridBase *	m_pGrid
	a grid More...

int	m_nZOrder
	z-order value that affects the draw order More...

CCArray *	m_pChildren
	array of children nodes More...

CCNode *	m_pParent
	weak reference to parent node More...

void *	m_pUserData
	A user assingned void pointer, Can be point to any cpp object. More...

CCObject *	m_pUserObject
	A user assigned CCObject. More...

CCGLProgram *	m_pShaderProgram
	OpenGL shader. More...

ccGLServerState	m_eGLServerState
	OpenGL servier side state. More...

unsigned int	m_uOrderOfArrival
	used to preserve sequence while sorting children with the same zOrder More...

CCScheduler *	m_pScheduler
	scheduler used to schedule timers and updates More...

CCActionManager *	m_pActionManager
	a pointer to ActionManager singleton, which is used to handle all the actions More...

bool	m_bRunning
	is running More...

bool	m_bTransformDirty
	transform dirty flag More...

bool	m_bInverseDirty
	transform dirty flag More...

bool	m_bAdditionalTransformDirty
	The flag to check whether the additional transform is dirty. More...

bool	m_bVisible
	is this node visible More...

bool	m_bIgnoreAnchorPointForPosition
	true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise. More...

bool	m_bReorderChildDirty
	children order dirty flag More...

int	m_nScriptHandler
	script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...

int	m_nUpdateScriptHandler
	script handler for update() callback per frame, which is invoked from lua & javascript. More...

ccScriptType	m_eScriptType
	type of script binding, lua or javascript More...

CCComponentContainer *	m_pComponentContainer
	Dictionary of components. More...

Protected Attributes inherited from CCObject
unsigned int	m_uReference

unsigned int	m_uAutoReleaseCount

int	m_nTag

int	m_eObjType

unsigned int	m_uObjectIdxInArray

Additional Inherited Members
Protected Member Functions inherited from CCControl
CCInvocation *	invocationWithTargetAndActionForControlEvent (CCObject *target, SEL_CCControlHandler action, CCControlEvent controlEvent)
	Returns an CCInvocation object able to construct messages using a given target-action pair. More...

CCArray *	dispatchListforControlEvent (CCControlEvent controlEvent)
	Returns the CCInvocation list for the given control event. More...

void	addTargetWithActionForControlEvent (CCObject *target, SEL_CCControlHandler action, CCControlEvent controlEvent)
	Adds a target and action for a particular event to an internal dispatch table. More...

void	removeTargetWithActionForControlEvent (CCObject *target, SEL_CCControlHandler action, CCControlEvent controlEvent)
	Removes a target and action for a particular event from an internal dispatch table. More...

Static Protected Member Functions inherited from CCControl
static CCControl *	create ()

Detailed Description

for Cocos2D.

Constructor & Destructor Documentation

◆ CCControlButton()

CCControlButton ( )

◆ ~CCControlButton()

virtual ~CCControlButton ( )

virtual

Member Function Documentation

◆ ccTouchBegan()

virtual bool ccTouchBegan	(	CCTouch *	pTouch,
		CCEvent *	pEvent
	)

virtual

Reimplemented from CCTouchDelegate.

◆ ccTouchCancelled()

virtual void ccTouchCancelled	(	CCTouch *	pTouch,
		CCEvent *	pEvent
	)

virtual

Reimplemented from CCTouchDelegate.

◆ ccTouchEnded()

virtual void ccTouchEnded	(	CCTouch *	pTouch,
		CCEvent *	pEvent
	)

virtual

Reimplemented from CCTouchDelegate.

◆ ccTouchMoved()

virtual void ccTouchMoved	(	CCTouch *	pTouch,
		CCEvent *	pEvent
	)

virtual

Reimplemented from CCTouchDelegate.

◆ create() [1/4]

static CCControlButton * create ( )

static

◆ create() [2/4]

static CCControlButton * create	(	CCNode *	label,
		CCScale9Sprite *	backgroundSprite
	)

static

◆ create() [3/4]

static CCControlButton * create ( CCScale9Sprite * sprite )

static

◆ create() [4/4]

static CCControlButton * create	(	std::string	title,
		const char *	fontName,
		float	fontSize
	)

static

◆ doesAdjustBackgroundImage()

bool doesAdjustBackgroundImage ( )

Adjust the background image.

YES by default. If the property is set to NO, the background will use the prefered size of the background image.

◆ getBackgroundSprite()

virtual CCScale9Sprite * getBackgroundSprite ( void )

virtual

◆ getBackgroundSpriteDispatchTable()

virtual CCDictionary * getBackgroundSpriteDispatchTable ( void )

virtual

◆ getBackgroundSpriteForState()

virtual CCScale9Sprite * getBackgroundSpriteForState ( CCControlState state )

virtual

Returns the background sprite used for a state.

Parameters

state The state that uses the background sprite. Possible values are described in "CCControlState".

◆ getColor()

virtual const ccColor3B & getColor ( void )

virtual

Returns color that is currently used.

Returns: The ccColor3B contains R,G,B bytes.

Reimplemented from CCLayerRGBA.

◆ getCurrentTitle()

virtual CCString * getCurrentTitle ( void )

virtual

◆ getCurrentTitleColor()

virtual const ccColor3B & getCurrentTitleColor ( void )

virtual

◆ getHorizontalOrigin()

virtual int getHorizontalOrigin ( void )

virtual

◆ getLabelAnchorPoint()

virtual CCPoint getLabelAnchorPoint ( void )

virtual

◆ getOpacity()

virtual GLubyte getOpacity ( void )

virtual

Returns the opacity.

The opacity which indicates how transparent or opaque this node is. 0 indicates fully transparent and 255 is fully opaque.

Returns: The opacity of sprite, from 0 ~ 255

Reimplemented from CCLayerRGBA.

◆ getPreferredSize()

virtual CCSize getPreferredSize ( void )

virtual

◆ getTitleBMFontForState()

virtual const char * getTitleBMFontForState ( CCControlState state )

virtual

◆ getTitleColorDispatchTable()

virtual CCDictionary * getTitleColorDispatchTable ( void )

virtual

◆ getTitleColorForState()

virtual const ccColor3B getTitleColorForState ( CCControlState state )

virtual

Returns the title color used for a state.

Parameters

state The state that uses the specified color. The values are described in "CCControlState".

Returns: The color of the title for the specified state.

◆ getTitleDispatchTable()

virtual CCDictionary * getTitleDispatchTable ( void )

virtual

◆ getTitleForState()

virtual CCString * getTitleForState ( CCControlState state )

virtual

Returns the title used for a state.

Parameters

state The state that uses the title. Possible values are described in "CCControlState".

Returns: The title for the specified state.

◆ getTitleLabel()

virtual CCNode * getTitleLabel ( void )

virtual

◆ getTitleLabelDispatchTable()

virtual CCDictionary * getTitleLabelDispatchTable ( void )

virtual

◆ getTitleLabelForState()

virtual CCNode * getTitleLabelForState ( CCControlState state )

virtual

Returns the title label used for a state.

Parameters

state The state that uses the title label. Possible values are described in "CCControlState".

◆ getTitleTTFForState()

virtual const char * getTitleTTFForState ( CCControlState state )

virtual

◆ getTitleTTFSizeForState()

virtual float getTitleTTFSizeForState ( CCControlState state )

virtual

◆ getVerticalMargin()

virtual int getVerticalMargin ( void )

virtual

◆ getZoomOnTouchDown()

virtual bool getZoomOnTouchDown ( void )

virtual

◆ init()

virtual bool init ( )

virtual

Initializes the instance of CCNode.

Returns: Whether the initialization was successful.

Reimplemented from CCControl.

◆ initWithBackgroundSprite()

virtual bool initWithBackgroundSprite ( CCScale9Sprite * sprite )

virtual

◆ initWithLabelAndBackgroundSprite()

virtual bool initWithLabelAndBackgroundSprite	(	CCNode *	label,
		CCScale9Sprite *	backgroundSprite
	)

virtual

◆ initWithTitleAndFontNameAndFontSize()

virtual bool initWithTitleAndFontNameAndFontSize	(	std::string	title,
		const char *	fontName,
		float	fontSize
	)

virtual

◆ isPushed()

bool isPushed ( )

inline

◆ needsLayout()

virtual void needsLayout ( void )

virtual

Updates the control layout using its current internal state.

Reimplemented from CCControl.

◆ setAdjustBackgroundImage()

void setAdjustBackgroundImage ( bool adjustBackgroundImage )

◆ setBackgroundSprite()

virtual void setBackgroundSprite ( CCScale9Sprite * var )

virtual

◆ setBackgroundSpriteDispatchTable()

virtual void setBackgroundSpriteDispatchTable ( CCDictionary * var )

virtual

◆ setBackgroundSpriteForState()

virtual void setBackgroundSpriteForState	(	CCScale9Sprite *	sprite,
		CCControlState	state
	)

virtual

Sets the background sprite to use for the specified button state.

Parameters

sprite	The background sprite to use for the specified state.
state	The state that uses the specified image. The values are described in "CCControlState".

◆ setBackgroundSpriteFrameForState()

virtual void setBackgroundSpriteFrameForState	(	CCSpriteFrame *	spriteFrame,
		CCControlState	state
	)

virtual

Sets the background spriteFrame to use for the specified button state.

Parameters

spriteFrame	The background spriteFrame to use for the specified state.
state	The state that uses the specified image. The values are described in "CCControlState".

◆ setColor()

virtual void setColor ( const ccColor3B & color )

virtual

Changes the color with R,G,B bytes.

Parameters

color Example: ccc3(255,100,0) means R=255, G=100, B=0

Reimplemented from CCLayerRGBA.

◆ setEnabled()

virtual void setEnabled ( bool bEnabled )

virtual

Tells whether the control is enabled.

Reimplemented from CCControl.

◆ setHighlighted()

virtual void setHighlighted ( bool bHighlighted )

virtual

A Boolean value that determines whether the control is highlighted.

Reimplemented from CCControl.

◆ setLabelAnchorPoint()

virtual void setLabelAnchorPoint ( CCPoint var )

virtual

◆ setMargins()

virtual void setMargins	(	int	marginH,
		int	marginV
	)

virtual

◆ setOpacity()

virtual void setOpacity ( GLubyte opacity )

virtual

Changes the opacity.

Parameters

value Goes from 0 to 255, where 255 means fully opaque and 0 means fully transparent.

Reimplemented from CCLayerRGBA.

◆ setPreferredSize()

virtual void setPreferredSize ( CCSize var )

virtual

◆ setSelected()

virtual void setSelected ( bool bSelected )

virtual

A Boolean value that determines the control selected state.

Reimplemented from CCControl.

◆ setTitleBMFontForState()

virtual void setTitleBMFontForState	(	const char *	fntFile,
		CCControlState	state
	)

virtual

Sets the font of the label, changes the label to a CCLabelBMFont if neccessary.

Parameters

fntFile	The name of the font to change to
state	The state that uses the specified fntFile. The values are described in "CCControlState".

◆ setTitleColorDispatchTable()

virtual void setTitleColorDispatchTable ( CCDictionary * var )

virtual

◆ setTitleColorForState()

virtual void setTitleColorForState	(	ccColor3B	color,
		CCControlState	state
	)

virtual

Sets the color of the title to use for the specified state.

Parameters

color	The color of the title to use for the specified state.
state	The state that uses the specified color. The values are described in "CCControlState".

◆ setTitleDispatchTable()

virtual void setTitleDispatchTable ( CCDictionary * var )

virtual

◆ setTitleForState()

virtual void setTitleForState	(	CCString *	title,
		CCControlState	state
	)

virtual

Sets the title string to use for the specified state.

If a property is not specified for a state, the default is to use the CCButtonStateNormal value.

Parameters

title	The title string to use for the specified state.
state	The state that uses the specified title. The values are described in "CCControlState".

◆ setTitleLabel()

virtual void setTitleLabel ( CCNode * var )

virtual

◆ setTitleLabelDispatchTable()

virtual void setTitleLabelDispatchTable ( CCDictionary * var )

virtual

◆ setTitleLabelForState()

virtual void setTitleLabelForState	(	CCNode *	label,
		CCControlState	state
	)

virtual

Sets the title label to use for the specified state.

If a property is not specified for a state, the default is to use the CCButtonStateNormal value.

Parameters

title	The title label to use for the specified state.
state	The state that uses the specified title. The values are described in "CCControlState".

◆ setTitleTTFForState()

virtual void setTitleTTFForState	(	const char *	fntFile,
		CCControlState	state
	)

virtual

◆ setTitleTTFSizeForState()

virtual void setTitleTTFSizeForState	(	float	size,
		CCControlState	state
	)

virtual

◆ setZoomOnTouchDown()

virtual void setZoomOnTouchDown ( bool var )

virtual

Member Data Documentation

◆ m_backgroundSprite

CCScale9Sprite* m_backgroundSprite

protected

The current background sprite.

◆ m_backgroundSpriteDispatchTable

CCDictionary* m_backgroundSpriteDispatchTable

protected

◆ m_bParentInited

bool m_bParentInited

protected

◆ m_currentTitle

CCString* m_currentTitle

protected

The current title that is displayed on the button.

◆ m_currentTitleColor

ccColor3B m_currentTitleColor

protected

The current color used to display the title.

◆ m_doesAdjustBackgroundImage

bool m_doesAdjustBackgroundImage

◆ m_isPushed

bool m_isPushed

protected

Flag to know if the button is currently pushed.

◆ m_labelAnchorPoint

CCPoint m_labelAnchorPoint

protected

◆ m_marginH

int m_marginH

protected

◆ m_marginV

int m_marginV

protected

◆ m_preferredSize

CCSize m_preferredSize

protected

The prefered size of the button, if label is larger it will be expanded.

◆ m_titleColorDispatchTable

CCDictionary* m_titleColorDispatchTable

protected

◆ m_titleDispatchTable

CCDictionary* m_titleDispatchTable

protected

◆ m_titleLabel

CCNode* m_titleLabel

protected

The current title label.

◆ m_titleLabelDispatchTable

CCDictionary* m_titleLabelDispatchTable

protected

◆ m_zoomOnTouchDown

bool m_zoomOnTouchDown

protected

Adjust the button zooming on touchdown.

Default value is YES.

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

/home/runner/work/cocos-headers/cocos-headers/extensions/GUI/CCControlExtension/CCControlButton.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CCControlButton()

◆ ~CCControlButton()

Member Function Documentation

◆ ccTouchBegan()

◆ ccTouchCancelled()

◆ ccTouchEnded()

◆ ccTouchMoved()

◆ create() [1/4]

◆ create() [2/4]

◆ create() [3/4]

◆ create() [4/4]

◆ doesAdjustBackgroundImage()

◆ getBackgroundSprite()

◆ getBackgroundSpriteDispatchTable()

◆ getBackgroundSpriteForState()

◆ getColor()

◆ getCurrentTitle()

◆ getCurrentTitleColor()

◆ getHorizontalOrigin()

◆ getLabelAnchorPoint()

◆ getOpacity()

◆ getPreferredSize()

◆ getTitleBMFontForState()

◆ getTitleColorDispatchTable()

◆ getTitleColorForState()

◆ getTitleDispatchTable()

◆ getTitleForState()

◆ getTitleLabel()

◆ getTitleLabelDispatchTable()

◆ getTitleLabelForState()

◆ getTitleTTFForState()

◆ getTitleTTFSizeForState()

◆ getVerticalMargin()

◆ getZoomOnTouchDown()

◆ init()

◆ initWithBackgroundSprite()

◆ initWithLabelAndBackgroundSprite()

◆ initWithTitleAndFontNameAndFontSize()

◆ isPushed()

◆ needsLayout()

◆ setAdjustBackgroundImage()

◆ setBackgroundSprite()

◆ setBackgroundSpriteDispatchTable()

◆ setBackgroundSpriteForState()

◆ setBackgroundSpriteFrameForState()

◆ setColor()

◆ setEnabled()

◆ setHighlighted()

◆ setLabelAnchorPoint()

◆ setMargins()

◆ setOpacity()

◆ setPreferredSize()

◆ setSelected()

◆ setTitleBMFontForState()

◆ setTitleColorDispatchTable()

◆ setTitleColorForState()

◆ setTitleDispatchTable()

◆ setTitleForState()

◆ setTitleLabel()

◆ setTitleLabelDispatchTable()

◆ setTitleLabelForState()

◆ setTitleTTFForState()

◆ setTitleTTFSizeForState()

◆ setZoomOnTouchDown()

Member Data Documentation

◆ m_backgroundSprite

◆ m_backgroundSpriteDispatchTable

◆ m_bParentInited

◆ m_currentTitle

◆ m_currentTitleColor

◆ m_doesAdjustBackgroundImage

◆ m_isPushed

◆ m_labelAnchorPoint