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

#include <UIButton.h>

Inheritance diagram for UIButton:
UIWidget Object

Public Member Functions

 UIButton ()
 Default constructor. More...
 
virtual ~UIButton ()
 Default destructor. More...
 
void loadTextures (const char *normal, const char *selected, const char *disabled, TextureResType texType=UI_TEX_TYPE_LOCAL)
 Load textures for button. More...
 
void loadTextureNormal (const char *normal, TextureResType texType=UI_TEX_TYPE_LOCAL)
 Load normal state texture for button. More...
 
local loadTextureNormal ( local normal, local UI_TEX_TYPE_LOCAL)
 Load normal state texture for button. More...
 
void loadTexturePressed (const char *selected, TextureResType texType=UI_TEX_TYPE_LOCAL)
 Load selected state texture for button. More...
 
var loadTexturePressed ( var selected, var UI_TEX_TYPE_LOCAL)
 Load selected state texture for button. More...
 
local loadTexturePressed ( local selected, local UI_TEX_TYPE_LOCAL)
 Load selected state texture for button. More...
 
void loadTextureDisabled (const char *disabled, TextureResType texType=UI_TEX_TYPE_LOCAL)
 Load dark state texture for button. More...
 
void setCapInsets (const Rect &capInsets)
 Sets capinsets for button, if button is using scale9 renderer. More...
 
void setCapInsetsNormalRenderer (const Rect &capInsets)
 Sets capinsets for button, if button is using scale9 renderer. More...
 
var setCapInsetsNormalRenderer ( var capInsets)
 Sets capinsets for button, if button is using scale9 renderer. More...
 
local setCapInsetsNormalRenderer ( local capInsets)
 Sets capinsets for button, if button is using scale9 renderer. More...
 
void setCapInsetsPressedRenderer (const Rect &capInsets)
 Sets capinsets for button, if button is using scale9 renderer. More...
 
void setCapInsetsDisabledRenderer (const Rect &capInsets)
 Sets capinsets for button, if button is using scale9 renderer. More...
 
virtual void setAnchorPoint (const Point &pt)
 Sets the anchor point in percent. More...
 
virtual void setScale9Enabled (bool able)
 Sets if button is using scale9 renderer. More...
 
local setScale9Enabled ( local able)
 Sets if button is using scale9 renderer. More...
 
virtual void setFlipX (bool flipX)
 Sets whether the widget should be flipped horizontally or not. More...
 
virtual void setFlipY (bool flipY)
 Sets whether the widget should be flipped vertically or not. More...
 
local setFlipY ( local flipY)
 Sets whether the widget should be flipped vertically or not. More...
 
virtual bool isFlipX ()
 Returns the flag which indicates whether the widget is flipped horizontally or not. More...
 
local isFlipX ()
 Returns the flag which indicates whether the widget is flipped horizontally or not. More...
 
virtual bool isFlipY ()
 Return the flag which indicates whether the widget is flipped vertically or not. More...
 
local isFlipY ()
 Return the flag which indicates whether the widget is flipped vertically or not. More...
 
void setPressedActionEnabled (bool enabled)
 Changes if button can be clicked zoom effect. More...
 
var setPressedActionEnabled ( var enabled)
 Changes if button can be clicked zoom effect. More...
 
local setPressedActionEnabled ( local enabled)
 Changes if button can be clicked zoom effect. More...
 
virtual void ignoreContentAdaptWithSize (bool ignore)
 Ignore the widget size. More...
 
virtual const SizegetContentSize () const
 Gets the content size of widget. More...
 
local getContentSize ()
 Gets the content size of widget. More...
 
virtual NodegetVirtualRenderer ()
 Gets the Virtual Renderer of widget. More...
 
local getVirtualRenderer ()
 Gets the Virtual Renderer of widget. More...
 
virtual void setColor (const Color3B &color)
 Sets color to widget. More...
 
local setColor ( local color)
 Sets color to widget. More...
 
void setTitleText (const char *text)
const char * getTitleText () const
void setTitleColor (const Color3B &color)
const Color3BgetTitleColor () const
void setTitleFontSize (float size)
var setTitleFontSize ( var size)
local setTitleFontSize ( local size)
float getTitleFontSize () const
void setTitleFontName (const char *fontName)
const char * getTitleFontName () const
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...
 
UIWidgetgetChildByName (const char *name)
 Gets a child from the container with its name. More...
 
UIWidgetgetChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
virtual ArraygetChildren ()
 Return an array of children. More...
 
NodegetRenderer ()
 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...
 
UIWidgetgetParent ()
 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 PointgetPosition ()
 Gets the position (x,y) of the widget in OpenGL coordinates. More...
 
const PointgetPositionPercent ()
 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...
 
const PointgetAnchorPoint ()
 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 const Color3BgetColor ()
 Gets color of widget. More...
 
var getColor ()
 Gets color of widget. More...
 
local getColor ()
 Gets color of widget. More...
 
virtual void setOpacity (int opacity)
 Sets opacity to 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 ActionManagergetActionManager ()
local getActionManager ()
ActionrunAction (Action *action)
void stopAllActions (void)
void stopAction (Action *action)
void stopActionByTag (int tag)
ActiongetActionByTag (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 PointgetTouchStartPos ()
const PointgetTouchMovePos ()
const PointgetTouchEndPos ()
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 SizegetSize () const
 Returns size of widget. More...
 
const PointgetSizePercent () const
 Returns size percent of widget. More...
 
local getSizePercent ()
 Returns size percent of widget. More...
 
virtual bool hitTest (const Point &pt)
 Checks a point if is in widget's space. 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...
 
LayoutParametergetLayoutParameter ()
 Gets LayoutParameter of widget. 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...
 
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...
 
Objectautorelease ()
 Release the ownership sometime soon automatically. More...
 
bool isSingleReference () const
 Returns a boolean value that indicates whether there is only one reference to the object. More...
 
unsigned int retainCount () const
 Returns the object's current reference count. More...
 
virtual bool isEqual (const Object *object)
 Returns a boolean value that indicates whether this object and a given object are equal. More...
 
virtual void acceptVisitor (DataVisitor &visitor)
virtual void update (float dt)

Static Public Member Functions

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

Protected Member Functions

virtual bool init ()
virtual void initRenderer ()
local initRenderer ()
virtual void onPressStateChangedToNormal ()
local onPressStateChangedToNormal ()
virtual void onPressStateChangedToPressed ()
virtual void onPressStateChangedToDisabled ()
virtual void onSizeChanged ()
void normalTextureScaleChangedWithSize ()
var normalTextureScaleChangedWithSize ()
local normalTextureScaleChangedWithSize ()
void pressedTextureScaleChangedWithSize ()
var pressedTextureScaleChangedWithSize ()
local pressedTextureScaleChangedWithSize ()
void disabledTextureScaleChangedWithSize ()
- Protected Member Functions inherited from UIWidget
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

Node_buttonNormalRenderer
Node_buttonClickedRenderer
var _buttonClickedRenderer
local _buttonClickedRenderer
Node_buttonDisableRenderer
var _buttonDisableRenderer
local _buttonDisableRenderer
LabelTTF_titleRenderer
std::string _normalFileName
var _normalFileName
local _normalFileName
std::string _clickedFileName
var _clickedFileName
local _clickedFileName
std::string _disabledFileName
var _disabledFileName
local _disabledFileName
bool _prevIgnoreSize
bool _scale9Enabled
var _scale9Enabled
local _scale9Enabled
Rect _capInsetsNormal
var _capInsetsNormal
local _capInsetsNormal
Rect _capInsetsPressed
var _capInsetsPressed
local _capInsetsPressed
Rect _capInsetsDisabled
var _capInsetsDisabled
local _capInsetsDisabled
TextureResType _normalTexType
TextureResType _pressedTexType
var _pressedTexType
local _pressedTexType
TextureResType _disabledTexType
var _disabledTexType
local _disabledTexType
Size _normalTextureSize
var _normalTextureSize
local _normalTextureSize
Size _pressedTextureSize
var _pressedTextureSize
local _pressedTextureSize
Size _disabledTextureSize
var _disabledTextureSize
local _disabledTextureSize
bool _pressedActionEnabled
var _pressedActionEnabled
local _pressedActionEnabled
Color3B _titleColor
- 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

UIButton ( )

Default constructor.

var UIButton ( )

Default constructor.

local UIButton ( )

Default constructor.

virtual ~UIButton ( )
virtual

Default destructor.

var ~UIButton ( )
virtual

Default destructor.

local ~UIButton ( )
virtual

Default destructor.

Member Function Documentation

static UIButton* create ( )
static

Allocates and initializes.

var create ( )
static

Allocates and initializes.

local create ( )
static

Allocates and initializes.

void
disabledTextureScaleChangedWithSize
( )
protected
var
disabledTextureScaleChangedWithSize
( )
protected
local
disabledTextureScaleChangedWithSize
( )
protected
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.

var getDescription ( )
virtual

Returns the "class name" of widget.

Reimplemented from UIWidget.

local getDescription ( )
virtual

Returns the "class name" of widget.

Reimplemented from UIWidget.

const Color3B& getTitleColor ( ) const
var getTitleColor ( )
local getTitleColor ( )
const char* getTitleFontName ( ) const
var getTitleFontName ( )
local getTitleFontName ( )
float getTitleFontSize ( ) const
var getTitleFontSize ( )
local getTitleFontSize ( )
const char* getTitleText ( ) const
var getTitleText ( )
local getTitleText ( )
virtual Node* getVirtualRenderer ( )
virtual

Gets the Virtual Renderer of widget.

For example, a button's Virtual Renderer is it's texture renderer.

Returns
CCNode pointer.

Reimplemented from UIWidget.

var getVirtualRenderer ( )
virtual

Gets the Virtual Renderer of widget.

For example, a button's Virtual Renderer is it's texture renderer.

Returns
CCNode pointer.

Reimplemented from UIWidget.

local getVirtualRenderer ( )
virtual

Gets the Virtual Renderer of widget.

For example, a button's Virtual Renderer is it's texture renderer.

Returns
CCNode pointer.

Reimplemented from UIWidget.

virtual void
ignoreContentAdaptWithSize
( bool  ignore)
virtual

Ignore the widget size.

Parameters
ignore,truethat widget will ignore it's size, use texture size, false otherwise. Default value is true.

Reimplemented from UIWidget.

var ignoreContentAdaptWithSize ( var  ignore)
virtual

Ignore the widget size.

Parameters
ignore,truethat widget will ignore it's size, use texture size, false otherwise. Default value is true.

Reimplemented from UIWidget.

local ignoreContentAdaptWithSize ( local  ignore)
virtual

Ignore the widget size.

Parameters
ignore,truethat widget will ignore it's size, use texture size, false otherwise. Default value is true.

Reimplemented from UIWidget.

virtual bool init ( )
protectedvirtual

Reimplemented from UIWidget.

var init ( )
protectedvirtual

Reimplemented from UIWidget.

local init ( )
protectedvirtual

Reimplemented from UIWidget.

virtual void initRenderer ( )
protectedvirtual

Reimplemented from UIWidget.

var initRenderer ( )
protectedvirtual

Reimplemented from UIWidget.

local initRenderer ( )
protectedvirtual

Reimplemented from UIWidget.

virtual bool isFlipX ( )
virtual

Returns the flag which indicates whether the widget is flipped horizontally or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleX(sprite->getScaleX() * -1);

Returns
true if the widget is flipped horizaontally, false otherwise.

Reimplemented from UIWidget.

var isFlipX ( )
virtual

Returns the flag which indicates whether the widget is flipped horizontally or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleX(sprite->getScaleX() * -1);

Returns
true if the widget is flipped horizaontally, false otherwise.

Reimplemented from UIWidget.

local isFlipX ( )
virtual

Returns the flag which indicates whether the widget is flipped horizontally or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleX(sprite->getScaleX() * -1);

Returns
true if the widget is flipped horizaontally, false otherwise.

Reimplemented from UIWidget.

virtual bool isFlipY ( )
virtual

Return the flag which indicates whether the widget is flipped vertically or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleY(widget->getScaleY() * -1);

Returns
true if the widget is flipped vertically, flase otherwise.

Reimplemented from UIWidget.

var isFlipY ( )
virtual

Return the flag which indicates whether the widget is flipped vertically or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleY(widget->getScaleY() * -1);

Returns
true if the widget is flipped vertically, flase otherwise.

Reimplemented from UIWidget.

local isFlipY ( )
virtual

Return the flag which indicates whether the widget is flipped vertically or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleY(widget->getScaleY() * -1);

Returns
true if the widget is flipped vertically, flase otherwise.

Reimplemented from UIWidget.

void loadTextureDisabled ( const char *  disabled,
TextureResType  texType = UI_TEX_TYPE_LOCAL 
)

Load dark state texture for button.

Parameters
disableddark state texture.
texType@seeUI_TEX_TYPE_LOCAL
var loadTextureDisabled ( var  disabled,
var  texType = UI_TEX_TYPE_LOCAL 
)

Load dark state texture for button.

Parameters
disableddark state texture.
texType@seeUI_TEX_TYPE_LOCAL
local loadTextureDisabled ( local  disabled,
local  texType = UI_TEX_TYPE_LOCAL 
)

Load dark state texture for button.

Parameters
disableddark state texture.
texType@seeUI_TEX_TYPE_LOCAL
void loadTextureNormal ( const char *  normal,
TextureResType  texType = UI_TEX_TYPE_LOCAL 
)

Load normal state texture for button.

Parameters
normalnormal state texture.
texType@seeUI_TEX_TYPE_LOCAL
var loadTextureNormal ( var  normal,
var  texType = UI_TEX_TYPE_LOCAL 
)

Load normal state texture for button.

Parameters
normalnormal state texture.
texType@seeUI_TEX_TYPE_LOCAL
local loadTextureNormal ( local  normal,
local  texType = UI_TEX_TYPE_LOCAL 
)

Load normal state texture for button.

Parameters
normalnormal state texture.
texType@seeUI_TEX_TYPE_LOCAL
void loadTexturePressed ( const char *  selected,
TextureResType  texType = UI_TEX_TYPE_LOCAL 
)

Load selected state texture for button.

Parameters
selectedselected state texture.
texType@seeUI_TEX_TYPE_LOCAL
var loadTexturePressed ( var  selected,
var  texType = UI_TEX_TYPE_LOCAL 
)

Load selected state texture for button.

Parameters
selectedselected state texture.
texType@seeUI_TEX_TYPE_LOCAL
local loadTexturePressed ( local  selected,
local  texType = UI_TEX_TYPE_LOCAL 
)

Load selected state texture for button.

Parameters
selectedselected state texture.
texType@seeUI_TEX_TYPE_LOCAL
void loadTextures ( const char *  normal,
const char *  selected,
const char *  disabled,
TextureResType  texType = UI_TEX_TYPE_LOCAL 
)

Load textures for button.

Parameters
normalnormal state texture.
selectedselected state texture.
disableddark state texture.
texType@seeUI_TEX_TYPE_LOCAL
var loadTextures ( var  normal,
var  selected,
var  disabled,
var  texType = UI_TEX_TYPE_LOCAL 
)

Load textures for button.

Parameters
normalnormal state texture.
selectedselected state texture.
disableddark state texture.
texType@seeUI_TEX_TYPE_LOCAL
local loadTextures ( local  normal,
local  selected,
local  disabled,
local  texType = UI_TEX_TYPE_LOCAL 
)

Load textures for button.

Parameters
normalnormal state texture.
selectedselected state texture.
disableddark state texture.
texType@seeUI_TEX_TYPE_LOCAL
void
normalTextureScaleChangedWithSize
( )
protected
var
normalTextureScaleChangedWithSize
( )
protected
local
normalTextureScaleChangedWithSize
( )
protected
virtual void
onPressStateChangedToDisabled
( )
protectedvirtual

Reimplemented from UIWidget.

var onPressStateChangedToDisabled ( )
protectedvirtual

Reimplemented from UIWidget.

local onPressStateChangedToDisabled ( )
protectedvirtual

Reimplemented from UIWidget.

virtual void
onPressStateChangedToNormal
( )
protectedvirtual

Reimplemented from UIWidget.

var onPressStateChangedToNormal ( )
protectedvirtual

Reimplemented from UIWidget.

local onPressStateChangedToNormal ( )
protectedvirtual

Reimplemented from UIWidget.

virtual void
onPressStateChangedToPressed
( )
protectedvirtual

Reimplemented from UIWidget.

var onPressStateChangedToPressed ( )
protectedvirtual

Reimplemented from UIWidget.

local onPressStateChangedToPressed ( )
protectedvirtual

Reimplemented from UIWidget.

virtual void onSizeChanged ( )
protectedvirtual

Reimplemented from UIWidget.

var onSizeChanged ( )
protectedvirtual

Reimplemented from UIWidget.

local onSizeChanged ( )
protectedvirtual

Reimplemented from UIWidget.

void
pressedTextureScaleChangedWithSize
( )
protected
var
pressedTextureScaleChangedWithSize
( )
protected
local
pressedTextureScaleChangedWithSize
( )
protected
virtual void setAnchorPoint ( const Point pt)
virtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the widget where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the widget.

Parameters
anchorPointThe anchor point of widget.

Reimplemented from UIWidget.

var setAnchorPoint ( var  pt)
virtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the widget where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the widget.

Parameters
anchorPointThe anchor point of widget.

Reimplemented from UIWidget.

local setAnchorPoint ( local  pt)
virtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the widget where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the widget.

Parameters
anchorPointThe anchor point of widget.

Reimplemented from UIWidget.

void setCapInsets ( const Rect capInsets)

Sets capinsets for button, if button is using scale9 renderer.

Parameters
capInsetscapinsets for button
var setCapInsets ( var  capInsets)

Sets capinsets for button, if button is using scale9 renderer.

Parameters
capInsetscapinsets for button
local setCapInsets ( local  capInsets)

Sets capinsets for button, if button is using scale9 renderer.

Parameters
capInsetscapinsets for button
void setCapInsetsDisabledRenderer ( const Rect capInsets)

Sets capinsets for button, if button is using scale9 renderer.

Parameters
capInsetscapinsets for button
var setCapInsetsDisabledRenderer ( var  capInsets)

Sets capinsets for button, if button is using scale9 renderer.

Parameters
capInsetscapinsets for button
local setCapInsetsDisabledRenderer ( local  capInsets)

Sets capinsets for button, if button is using scale9 renderer.

Parameters
capInsetscapinsets for button
void setCapInsetsNormalRenderer ( const Rect capInsets)

Sets capinsets for button, if button is using scale9 renderer.

Parameters
capInsetscapinsets for button
var setCapInsetsNormalRenderer ( var  capInsets)

Sets capinsets for button, if button is using scale9 renderer.

Parameters
capInsetscapinsets for button
local setCapInsetsNormalRenderer ( local  capInsets)

Sets capinsets for button, if button is using scale9 renderer.

Parameters
capInsetscapinsets for button
void setCapInsetsPressedRenderer ( const Rect capInsets)

Sets capinsets for button, if button is using scale9 renderer.

Parameters
capInsetscapinsets for button
var setCapInsetsPressedRenderer ( var  capInsets)

Sets capinsets for button, if button is using scale9 renderer.

Parameters
capInsetscapinsets for button
local setCapInsetsPressedRenderer ( local  capInsets)

Sets capinsets for button, if button is using scale9 renderer.

Parameters
capInsetscapinsets for button
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 setFlipX ( bool  flipX)
virtual

Sets whether the widget should be flipped horizontally or not.

Parameters
bFlipXtrue if the widget should be flipped horizaontally, false otherwise.

Reimplemented from UIWidget.

var setFlipX ( var  flipX)
virtual

Sets whether the widget should be flipped horizontally or not.

Parameters
bFlipXtrue if the widget should be flipped horizaontally, false otherwise.

Reimplemented from UIWidget.

local setFlipX ( local  flipX)
virtual

Sets whether the widget should be flipped horizontally or not.

Parameters
bFlipXtrue if the widget should be flipped horizaontally, false otherwise.

Reimplemented from UIWidget.

virtual void setFlipY ( bool  flipY)
virtual

Sets whether the widget should be flipped vertically or not.

Parameters
bFlipYtrue if the widget should be flipped vertically, flase otherwise.

Reimplemented from UIWidget.

var setFlipY ( var  flipY)
virtual

Sets whether the widget should be flipped vertically or not.

Parameters
bFlipYtrue if the widget should be flipped vertically, flase otherwise.

Reimplemented from UIWidget.

local setFlipY ( local  flipY)
virtual

Sets whether the widget should be flipped vertically or not.

Parameters
bFlipYtrue if the widget should be flipped vertically, flase otherwise.

Reimplemented from UIWidget.

void setPressedActionEnabled ( bool  enabled)

Changes if button can be clicked zoom effect.

Parameters
truethat can be clicked zoom effect, false otherwise.
var setPressedActionEnabled ( var  enabled)

Changes if button can be clicked zoom effect.

Parameters
truethat can be clicked zoom effect, false otherwise.
local setPressedActionEnabled ( local  enabled)

Changes if button can be clicked zoom effect.

Parameters
truethat can be clicked zoom effect, false otherwise.
virtual void setScale9Enabled ( bool  able)
virtual

Sets if button is using scale9 renderer.

Parameters
truethat using scale9 renderer, false otherwise.
var setScale9Enabled ( var  able)
virtual

Sets if button is using scale9 renderer.

Parameters
truethat using scale9 renderer, false otherwise.
local setScale9Enabled ( local  able)
virtual

Sets if button is using scale9 renderer.

Parameters
truethat using scale9 renderer, false otherwise.
void setTitleColor ( const Color3B color)
var setTitleColor ( var  color)
local setTitleColor ( local  color)
void setTitleFontName ( const char *  fontName)
var setTitleFontName ( var  fontName)
local setTitleFontName ( local  fontName)
void setTitleFontSize ( float  size)
var setTitleFontSize ( var  size)
local setTitleFontSize ( local  size)
void setTitleText ( const char *  text)
var setTitleText ( var  text)
local setTitleText ( local  text)

Member Data Documentation

Node* _buttonClickedRenderer
protected
var _buttonClickedRenderer
protected
local _buttonClickedRenderer
protected
Node* _buttonDisableRenderer
protected
var _buttonDisableRenderer
protected
local _buttonDisableRenderer
protected
Node* _buttonNormalRenderer
protected
var _buttonNormalRenderer
protected
local _buttonNormalRenderer
protected
Rect _capInsetsDisabled
protected
var _capInsetsDisabled
protected
local _capInsetsDisabled
protected
Rect _capInsetsNormal
protected
var _capInsetsNormal
protected
local _capInsetsNormal
protected
Rect _capInsetsPressed
protected
var _capInsetsPressed
protected
local _capInsetsPressed
protected
std::string _clickedFileName
protected
var _clickedFileName
protected
local _clickedFileName
protected
std::string _disabledFileName
protected
var _disabledFileName
protected
local _disabledFileName
protected
Size _disabledTextureSize
protected
var _disabledTextureSize
protected
local _disabledTextureSize
protected
TextureResType _disabledTexType
protected
var _disabledTexType
protected
local _disabledTexType
protected
std::string _normalFileName
protected
var _normalFileName
protected
local _normalFileName
protected
Size _normalTextureSize
protected
var _normalTextureSize
protected
local _normalTextureSize
protected
TextureResType _normalTexType
protected
var _normalTexType
protected
local _normalTexType
protected
bool _pressedActionEnabled
protected
var _pressedActionEnabled
protected
local _pressedActionEnabled
protected
Size _pressedTextureSize
protected
var _pressedTextureSize
protected
local _pressedTextureSize
protected
TextureResType _pressedTexType
protected
var _pressedTexType
protected
local _pressedTexType
protected
bool _prevIgnoreSize
protected
var _prevIgnoreSize
protected
local _prevIgnoreSize
protected
bool _scale9Enabled
protected
var _scale9Enabled
protected
local _scale9Enabled
protected
Color3B _titleColor
protected
var _titleColor
protected
local _titleColor
protected
LabelTTF* _titleRenderer
protected
var _titleRenderer
protected
local _titleRenderer
protected

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