axmol/extensions/GUI/CCControlExtension/CCControlButton.h

253 lines
9.0 KiB
C
Raw Normal View History

/*
* Copyright (c) 2012 cocos2d-x.org
* http://www.cocos2d-x.org
*
* Copyright 2011 Yannick Loriot. All rights reserved.
* http://yannickloriot.com
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* Converted to c++ / cocos2d-x by Angus C
*/
#ifndef __CCCONTROL_BUTTON_H__
#define __CCCONTROL_BUTTON_H__
#include "CCControl.h"
#include "CCInvocation.h"
#include "CCScale9Sprite.h"
NS_CC_EXT_BEGIN
/* Define the button margin for Left/Right edge */
#define ControlButtonMarginLR 8 // px
/* Define the button margin for Top/Bottom edge */
#define ControlButtonMarginTB 2 // px
2012-06-20 18:09:11 +08:00
/**
* @addtogroup GUI
* @{
* @addtogroup control_extension
* @{
*/
/** @class ControlButton Button control for Cocos2D. */
class ControlButton : public Control
{
2012-04-16 18:58:43 +08:00
public:
ControlButton();
virtual ~ControlButton();
virtual void needsLayout(void);
2012-04-16 18:58:43 +08:00
virtual void setEnabled(bool enabled);
virtual void setSelected(bool enabled);
virtual void setHighlighted(bool enabled);
2012-04-16 18:58:43 +08:00
protected:
// RGBAProtocol
//bool _isOpacityModifyRGB;
/** The current title that is displayed on the button. */
CC_SYNTHESIZE_READONLY(String*, _currentTitle, CurrentTitle);
/** The current color used to display the title. */
CC_SYNTHESIZE_READONLY_PASS_BY_REF(Color3B, _currentTitleColor, CurrentTitleColor);
/** 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. */
bool doesAdjustBackgroundImage();
void setAdjustBackgroundImage(bool adjustBackgroundImage);
bool _doesAdjustBackgroundImage;
/** The current title label. */
CC_SYNTHESIZE_RETAIN(Node*, _titleLabel, TitleLabel);
/** The current background sprite. */
CC_SYNTHESIZE_RETAIN(Scale9Sprite*, _backgroundSprite, BackgroundSprite);
/** The prefered size of the button, if label is larger it will be expanded. */
CC_PROPERTY(Size, _preferredSize, PreferredSize);
/** Adjust the button zooming on touchdown. Default value is YES. */
CC_PROPERTY(bool, _zoomOnTouchDown, ZoomOnTouchDown);
2012-06-12 02:50:32 +08:00
CC_PROPERTY(Point, _labelAnchorPoint, LabelAnchorPoint);
/* Override setter to affect a background sprite too */
virtual GLubyte getOpacity(void) const;
virtual void setOpacity(GLubyte var);
2013-07-05 17:32:50 +08:00
virtual const Color3B& getColor(void) const;
virtual void setColor(const Color3B&);
/** Flag to know if the button is currently pushed. */
protected:
bool _isPushed;
bool _parentInited;
public:
bool isPushed() { return _isPushed; }
// <ControlState, String*>
CC_SYNTHESIZE_RETAIN(Dictionary*, _titleDispatchTable, TitleDispatchTable);
// <ControlState, Color3bObject*>
CC_SYNTHESIZE_RETAIN(Dictionary*, _titleColorDispatchTable, TitleColorDispatchTable);
// <ControlState, Node*>
CC_SYNTHESIZE_RETAIN(Dictionary*, _titleLabelDispatchTable, TitleLabelDispatchTable);
// <ControlState, Scale9Sprite*>
CC_SYNTHESIZE_RETAIN(Dictionary*, _backgroundSpriteDispatchTable, BackgroundSpriteDispatchTable);
/* Define the button margin for Top/Bottom edge */
CC_SYNTHESIZE_READONLY(int, _marginV, VerticalMargin);
/* Define the button margin for Left/Right edge */
CC_SYNTHESIZE_READONLY(int, _marginH, HorizontalOrigin);
//set the margins at once (so we only have to do one call of needsLayout)
virtual void setMargins(int marginH, int marginV);
public:
virtual bool init();
virtual bool initWithLabelAndBackgroundSprite(Node* label, Scale9Sprite* backgroundSprite);
static ControlButton* create(Node* label, Scale9Sprite* backgroundSprite);
virtual bool initWithTitleAndFontNameAndFontSize(std::string title, const char * fontName, float fontSize);
static ControlButton* create(std::string title, const char * fontName, float fontSize);
virtual bool initWithBackgroundSprite(Scale9Sprite* sprite);
static ControlButton* create(Scale9Sprite* sprite);
//events
virtual bool ccTouchBegan(Touch *pTouch, Event *pEvent);
virtual void ccTouchMoved(Touch *pTouch, Event *pEvent);
virtual void ccTouchEnded(Touch *pTouch, Event *pEvent);
virtual void ccTouchCancelled(Touch *pTouch, Event *pEvent);
/**
* Returns the title used for a state.
*
* @param state The state that uses the title. Possible values are described in
* "CCControlState".
*
* @return The title for the specified state.
*/
virtual String* getTitleForState(ControlState state);
/**
* 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 ButtonStateNormal value.
*
* @param title The title string to use for the specified state.
* @param state The state that uses the specified title. The values are described
* in "CCControlState".
*/
virtual void setTitleForState(String* title, ControlState state);
/**
* Returns the title color used for a state.
*
* @param state The state that uses the specified color. The values are described
* in "CCControlState".
*
* @return The color of the title for the specified state.
*/
virtual const Color3B getTitleColorForState(ControlState state);
/**
* Sets the color of the title to use for the specified state.
*
* @param color The color of the title to use for the specified state.
* @param state The state that uses the specified color. The values are described
* in "CCControlState".
*/
virtual void setTitleColorForState(Color3B color, ControlState state);
/**
* Returns the title label used for a state.
*
* @param state The state that uses the title label. Possible values are described
* in "CCControlState".
*/
virtual Node* getTitleLabelForState(ControlState state);
/**
* 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 ButtonStateNormal value.
*
* @param title The title label to use for the specified state.
* @param state The state that uses the specified title. The values are described
* in "CCControlState".
*/
virtual void setTitleLabelForState(Node* label, ControlState state);
virtual void setTitleTTFForState(const char * fntFile, ControlState state);
virtual const char * getTitleTTFForState(ControlState state);
virtual void setTitleTTFSizeForState(float size, ControlState state);
virtual float getTitleTTFSizeForState(ControlState state);
/**
* Sets the font of the label, changes the label to a LabelBMFont if neccessary.
* @param fntFile The name of the font to change to
* @param state The state that uses the specified fntFile. The values are described
* in "CCControlState".
*/
virtual void setTitleBMFontForState(const char * fntFile, ControlState state);
virtual const char * getTitleBMFontForState(ControlState state);
/**
* Returns the background sprite used for a state.
*
* @param state The state that uses the background sprite. Possible values are
* described in "CCControlState".
*/
virtual Scale9Sprite* getBackgroundSpriteForState(ControlState state);
/**
* Sets the background sprite to use for the specified button state.
*
* @param sprite The background sprite to use for the specified state.
* @param state The state that uses the specified image. The values are described
* in "CCControlState".
*/
virtual void setBackgroundSpriteForState(Scale9Sprite* sprite, ControlState state);
/**
* Sets the background spriteFrame to use for the specified button state.
*
* @param spriteFrame The background spriteFrame to use for the specified state.
* @param state The state that uses the specified image. The values are described
* in "CCControlState".
*/
virtual void setBackgroundSpriteFrameForState(SpriteFrame * spriteFrame, ControlState state);
static ControlButton* create();
};
2012-06-20 18:09:11 +08:00
// end of GUI group
/// @}
/// @}
NS_CC_EXT_END
2012-04-16 18:58:43 +08:00
#endif