mirror of https://github.com/axmolengine/axmol.git
526 lines
19 KiB
C++
526 lines
19 KiB
C++
/****************************************************************************
|
|
Copyright (c) 2010-2012 cocos2d-x.org
|
|
Copyright (c) 2008-2011 Ricardo Quesada
|
|
Copyright (c) 2011 Zynga Inc.
|
|
|
|
http://www.cocos2d-x.org
|
|
|
|
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.
|
|
****************************************************************************/
|
|
|
|
#ifndef __CCMENU_ITEM_H__
|
|
#define __CCMENU_ITEM_H__
|
|
|
|
// C++ includes
|
|
#include <functional>
|
|
|
|
// cocos2d includes
|
|
#include "CCNode.h"
|
|
#include "CCProtocols.h"
|
|
#include "CCArray.h"
|
|
|
|
NS_CC_BEGIN
|
|
|
|
typedef std::function<void(Object*)> ccMenuCallback;
|
|
|
|
class LabelTTF;
|
|
class LabelAtlas;
|
|
class Sprite;
|
|
class SpriteFrame;
|
|
#define kItemSize 32
|
|
|
|
/**
|
|
* @addtogroup GUI
|
|
* @{
|
|
* @addtogroup menu
|
|
* @{
|
|
*/
|
|
|
|
/** @brief MenuItem base class
|
|
*
|
|
* Subclass MenuItem (or any subclass) to create your custom MenuItem objects.
|
|
*/
|
|
class CC_DLL MenuItem : public NodeRGBA
|
|
{
|
|
public:
|
|
/** Creates a MenuItem with no target/selector */
|
|
static MenuItem* create();
|
|
/** Creates a MenuItem with a target/selector */
|
|
CC_DEPRECATED_ATTRIBUTE static MenuItem* create(Object *rec, SEL_MenuHandler selector);
|
|
/** Creates a MenuItem with a target/selector */
|
|
static MenuItem* create(const ccMenuCallback& callback);
|
|
/**
|
|
* @js ctor
|
|
*/
|
|
MenuItem()
|
|
: _selected(false)
|
|
, _enabled(false)
|
|
, _callback(nullptr)
|
|
, _target(NULL)
|
|
{}
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual ~MenuItem();
|
|
|
|
/** Initializes a MenuItem with a target/selector
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
bool initWithCallback(const ccMenuCallback& callback);
|
|
/** Initializes a MenuItem with a target/selector
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
CC_DEPRECATED_ATTRIBUTE bool initWithTarget( Object *rec, SEL_MenuHandler selector);
|
|
|
|
/** Returns the outside box */
|
|
Rect rect() const;
|
|
/** Activate the item */
|
|
virtual void activate();
|
|
/** The item was selected (not activated), similar to "mouse-over" */
|
|
virtual void selected();
|
|
/** The item was unselected */
|
|
virtual void unselected();
|
|
/** returns whether or not the item is enabled */
|
|
virtual bool isEnabled() const;
|
|
/** enables or disables the item */
|
|
virtual void setEnabled(bool value);
|
|
/** returns whether or not the item is selected */
|
|
virtual bool isSelected() const;
|
|
|
|
/** set the callback to the menu item
|
|
* @code
|
|
* In js,can contain two params,the second param is jsptr
|
|
* @endcode
|
|
* @lua NA
|
|
*/
|
|
void setCallback(const ccMenuCallback& callback);
|
|
/** set the target/selector of the menu item
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
CC_DEPRECATED_ATTRIBUTE void setTarget(Object *rec, SEL_MenuHandler selector);
|
|
|
|
protected:
|
|
bool _selected;
|
|
bool _enabled;
|
|
// callback
|
|
ccMenuCallback _callback;
|
|
// If using the old API, the _target needs to be retained / released
|
|
Object *_target;
|
|
};
|
|
|
|
/** @brief An abstract class for "label" MenuItemLabel items
|
|
Any Node that supports the LabelProtocol protocol can be added.
|
|
Supported nodes:
|
|
- BitmapFontAtlas
|
|
- LabelAtlas
|
|
- LabelTTF
|
|
*/
|
|
class CC_DLL MenuItemLabel : public MenuItem
|
|
{
|
|
public:
|
|
/** creates a MenuItemLabel with a Label, target and selector */
|
|
CC_DEPRECATED_ATTRIBUTE static MenuItemLabel * create(Node*label, Object* target, SEL_MenuHandler selector);
|
|
|
|
/** creates a MenuItemLabel with a Label and a callback */
|
|
static MenuItemLabel * create(Node*label, const ccMenuCallback& callback);
|
|
|
|
/** creates a MenuItemLabel with a Label. Target and selector will be nil */
|
|
static MenuItemLabel* create(Node *label);
|
|
/**
|
|
* @js ctor
|
|
*/
|
|
MenuItemLabel()
|
|
: _originalScale(0.0)
|
|
, _label(NULL)
|
|
{}
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual ~MenuItemLabel();
|
|
|
|
/** initializes a MenuItemLabel with a Label, target and selector */
|
|
bool initWithLabel(Node* label, const ccMenuCallback& callback);
|
|
|
|
/** initializes a MenuItemLabel with a Label, target and selector */
|
|
CC_DEPRECATED_ATTRIBUTE bool initWithLabel(Node* label, Object* target, SEL_MenuHandler selector);
|
|
|
|
/** sets a new string to the inner label */
|
|
void setString(const std::string& label);
|
|
|
|
/** Gets the color that will be used to disable the item */
|
|
inline const Color3B& getDisabledColor() const { return _disabledColor; };
|
|
|
|
/** Sets the color that will be used to disable the item */
|
|
inline void setDisabledColor(const Color3B& color) { _disabledColor = color; };
|
|
|
|
/** Gets the label that is rendered. */
|
|
inline Node* getLabel() const { return _label; };
|
|
|
|
/** Sets the label that is rendered. */
|
|
void setLabel(Node* node);
|
|
|
|
// Overrides
|
|
virtual void activate() override;
|
|
virtual void selected() override;
|
|
virtual void unselected() override;
|
|
virtual void setEnabled(bool enabled) override;
|
|
|
|
protected:
|
|
Color3B _colorBackup;
|
|
float _originalScale;
|
|
|
|
/** the color that will be used to disable the item */
|
|
Color3B _disabledColor;
|
|
/** Label that is rendered. It can be any Node that implements the LabelProtocol */
|
|
Node* _label;
|
|
};
|
|
|
|
|
|
/** @brief A MenuItemAtlasFont
|
|
Helper class that creates a MenuItemLabel class with a LabelAtlas
|
|
*/
|
|
class CC_DLL MenuItemAtlasFont : public MenuItemLabel
|
|
{
|
|
public:
|
|
/** creates a menu item from a string and atlas with a target/selector */
|
|
static MenuItemAtlasFont* create(const std::string& value, const std::string& charMapFile, long itemWidth, long itemHeight, char startCharMap);
|
|
/** creates a menu item from a string and atlas. Use it with MenuItemToggle */
|
|
CC_DEPRECATED_ATTRIBUTE static MenuItemAtlasFont* create(const char* value, const char* charMapFile, long itemWidth, long itemHeight, char startCharMap, Object* target, SEL_MenuHandler selector);
|
|
/** creates a menu item from a string and atlas. Use it with MenuItemToggle */
|
|
static MenuItemAtlasFont* create(const std::string& value, const std::string& charMapFile, long itemWidth, long itemHeight, char startCharMap, const ccMenuCallback& callback);
|
|
/**
|
|
* @js ctor
|
|
*/
|
|
MenuItemAtlasFont(){}
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual ~MenuItemAtlasFont(){}
|
|
|
|
/** initializes a menu item from a string and atlas with a target/selector */
|
|
CC_DEPRECATED_ATTRIBUTE bool initWithString(const char *value, const char *charMapFile, long itemWidth, long itemHeight, char startCharMap, Object* target, SEL_MenuHandler selector);
|
|
/** initializes a menu item from a string and atlas with a target/selector */
|
|
bool initWithString(const std::string& value, const std::string& charMapFile, long itemWidth, long itemHeight, char startCharMap, const ccMenuCallback& callback);
|
|
};
|
|
|
|
|
|
/** @brief A MenuItemFont
|
|
Helper class that creates a MenuItemLabel class with a Label
|
|
*/
|
|
class CC_DLL MenuItemFont : public MenuItemLabel
|
|
{
|
|
public:
|
|
/** creates a menu item from a string without target/selector. To be used with MenuItemToggle */
|
|
static MenuItemFont * create(const std::string& value);
|
|
/** creates a menu item from a string with a target/selector */
|
|
CC_DEPRECATED_ATTRIBUTE static MenuItemFont * create(const char *value, Object* target, SEL_MenuHandler selector);
|
|
/** creates a menu item from a string with a target/selector */
|
|
static MenuItemFont * create(const std::string& value, const ccMenuCallback& callback);
|
|
/**
|
|
* @js ctor
|
|
*/
|
|
MenuItemFont();
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual ~MenuItemFont();
|
|
|
|
/** initializes a menu item from a string with a target/selector */
|
|
CC_DEPRECATED_ATTRIBUTE bool initWithString(const char *value, Object* target, SEL_MenuHandler selector);
|
|
/** initializes a menu item from a string with a target/selector */
|
|
bool initWithString(const std::string& value, const ccMenuCallback& callback);
|
|
|
|
/** set default font size */
|
|
static void setFontSize(long size);
|
|
/** get default font size */
|
|
static long getFontSize();
|
|
CC_DEPRECATED_ATTRIBUTE static unsigned int fontSize() { return MenuItemFont::getFontSize(); };
|
|
/** set the default font name */
|
|
static void setFontName(const std::string& name);
|
|
/** get the default font name */
|
|
static const std::string& getFontName();
|
|
CC_DEPRECATED_ATTRIBUTE static const std::string& fontName() { return MenuItemFont::getFontName(); };
|
|
|
|
/** set font size
|
|
* c++ can not overload static and non-static member functions with the same parameter types
|
|
* so change the name to setFontSizeObj
|
|
* @js setFontSize
|
|
*/
|
|
void setFontSizeObj(long size);
|
|
|
|
/** get font size
|
|
* @js getFontSize
|
|
*/
|
|
long getFontSizeObj() const;
|
|
CC_DEPRECATED_ATTRIBUTE unsigned int fontSizeObj() const { return getFontSizeObj(); };
|
|
|
|
/** set the font name
|
|
* c++ can not overload static and non-static member functions with the same parameter types
|
|
* so change the name to setFontNameObj
|
|
* @js setFontName
|
|
*/
|
|
void setFontNameObj(const std::string& name);
|
|
|
|
/** returns the name of the Font
|
|
* @js getFontNameObj
|
|
*/
|
|
const std::string& getFontNameObj() const;
|
|
|
|
/** deprecated Use getFontNameObj() instead */
|
|
CC_DEPRECATED_ATTRIBUTE const std::string& fontNameObj() const { return getFontNameObj(); }
|
|
|
|
protected:
|
|
void recreateLabel();
|
|
|
|
long _fontSize;
|
|
std::string _fontName;
|
|
};
|
|
|
|
|
|
/** @brief MenuItemSprite accepts Node<RGBAProtocol> objects as items.
|
|
The images has 3 different states:
|
|
- unselected image
|
|
- selected image
|
|
- disabled image
|
|
|
|
@since v0.8.0
|
|
*/
|
|
class CC_DLL MenuItemSprite : public MenuItem
|
|
{
|
|
public:
|
|
/** creates a menu item with a normal, selected and disabled image*/
|
|
static MenuItemSprite * create(Node* normalSprite, Node* selectedSprite, Node* disabledSprite = NULL);
|
|
/** creates a menu item with a normal and selected image with target/selector */
|
|
CC_DEPRECATED_ATTRIBUTE static MenuItemSprite * create(Node* normalSprite, Node* selectedSprite, Object* target, SEL_MenuHandler selector);
|
|
/** creates a menu item with a normal,selected and disabled image with target/selector */
|
|
CC_DEPRECATED_ATTRIBUTE static MenuItemSprite * create(Node* normalSprite, Node* selectedSprite, Node* disabledSprite, Object* target, SEL_MenuHandler selector);
|
|
/** creates a menu item with a normal and selected image with a callable object */
|
|
static MenuItemSprite * create(Node* normalSprite, Node* selectedSprite, const ccMenuCallback& callback);
|
|
/** creates a menu item with a normal,selected and disabled image with target/selector */
|
|
static MenuItemSprite * create(Node* normalSprite, Node* selectedSprite, Node* disabledSprite, const ccMenuCallback& callback);
|
|
|
|
MenuItemSprite()
|
|
:_normalImage(NULL)
|
|
,_selectedImage(NULL)
|
|
,_disabledImage(NULL)
|
|
{}
|
|
|
|
/** initializes a menu item with a normal, selected and disabled image with target/selector */
|
|
CC_DEPRECATED_ATTRIBUTE bool initWithNormalSprite(Node* normalSprite, Node* selectedSprite, Node* disabledSprite, Object* target, SEL_MenuHandler selector);
|
|
/** initializes a menu item with a normal, selected and disabled image with a callable object */
|
|
bool initWithNormalSprite(Node* normalSprite, Node* selectedSprite, Node* disabledSprite, const ccMenuCallback& callback);
|
|
|
|
/** Gets the image used when the item is not selected */
|
|
inline Node* getNormalImage() const { return _normalImage; };
|
|
|
|
/** Sets the image used when the item is not selected */
|
|
void setNormalImage(Node* image);
|
|
|
|
/** Gets the image used when the item is selected */
|
|
inline Node* getSelectedImage() const { return _selectedImage; };
|
|
|
|
/** Sets the image used when the item is selected */
|
|
void setSelectedImage(Node* image);
|
|
|
|
/** Gets the image used when the item is disabled */
|
|
inline Node* getDisabledImage() const { return _disabledImage; };
|
|
|
|
/** Sets the image used when the item is disabled */
|
|
void setDisabledImage(Node* image);
|
|
|
|
/**
|
|
@since v0.99.5
|
|
*/
|
|
virtual void selected();
|
|
virtual void unselected();
|
|
virtual void setEnabled(bool bEnabled);
|
|
|
|
protected:
|
|
virtual void updateImagesVisibility();
|
|
|
|
/** the image used when the item is not selected */
|
|
Node* _normalImage;
|
|
/** the image used when the item is selected */
|
|
Node* _selectedImage;
|
|
/** the image used when the item is disabled */
|
|
Node* _disabledImage;
|
|
};
|
|
|
|
|
|
/** @brief MenuItemImage accepts images as items.
|
|
The images has 3 different states:
|
|
- unselected image
|
|
- selected image
|
|
- disabled image
|
|
|
|
For best results try that all images are of the same size
|
|
*/
|
|
class CC_DLL MenuItemImage : public MenuItemSprite
|
|
{
|
|
public:
|
|
/** Creates an MenuItemImage. */
|
|
static MenuItemImage* create();
|
|
/** creates a menu item with a normal and selected image*/
|
|
static MenuItemImage* create(const std::string& normalImage, const std::string& selectedImage);
|
|
/** creates a menu item with a normal,selected and disabled image*/
|
|
static MenuItemImage* create(const std::string& normalImage, const std::string& selectedImage, const std::string& disabledImage);
|
|
/** creates a menu item with a normal and selected image with target/selector */
|
|
CC_DEPRECATED_ATTRIBUTE static MenuItemImage* create(const char *normalImage, const char *selectedImage, Object* target, SEL_MenuHandler selector);
|
|
/** creates a menu item with a normal and selected image with a callable object */
|
|
static MenuItemImage* create(const std::string&normalImage, const std::string&selectedImage, const ccMenuCallback& callback);
|
|
|
|
/** creates a menu item with a normal,selected and disabled image with target/selector */
|
|
CC_DEPRECATED_ATTRIBUTE static MenuItemImage* create(const char *normalImage, const char *selectedImage, const char *disabledImage, Object* target, SEL_MenuHandler selector);
|
|
/** creates a menu item with a normal,selected and disabled image with a callable object */
|
|
static MenuItemImage* create(const std::string&normalImage, const std::string&selectedImage, const std::string&disabledImage, const ccMenuCallback& callback);
|
|
/**
|
|
* @js ctor
|
|
*/
|
|
MenuItemImage(){}
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual ~MenuItemImage(){}
|
|
|
|
bool init();
|
|
/** initializes a menu item with a normal, selected and disabled image with target/selector */
|
|
CC_DEPRECATED_ATTRIBUTE bool initWithNormalImage(const char *normalImage, const char *selectedImage, const char *disabledImage, Object* target, SEL_MenuHandler selector);
|
|
/** initializes a menu item with a normal, selected and disabled image with a callable object */
|
|
bool initWithNormalImage(const std::string& normalImage, const std::string& selectedImage, const std::string& disabledImage, const ccMenuCallback& callback);
|
|
|
|
/** sets the sprite frame for the normal image */
|
|
void setNormalSpriteFrame(SpriteFrame* frame);
|
|
/** sets the sprite frame for the selected image */
|
|
void setSelectedSpriteFrame(SpriteFrame* frame);
|
|
/** sets the sprite frame for the disabled image */
|
|
void setDisabledSpriteFrame(SpriteFrame* frame);
|
|
};
|
|
|
|
|
|
/** @brief A MenuItemToggle
|
|
A simple container class that "toggles" it's inner items
|
|
The inner items can be any MenuItem
|
|
*/
|
|
class CC_DLL MenuItemToggle : public MenuItem
|
|
{
|
|
public:
|
|
/** creates a menu item from a Array with a callable object */
|
|
static MenuItemToggle * createWithCallback(const ccMenuCallback& callback, Array* menuItems);
|
|
/** creates a menu item from a list of items with a callable object */
|
|
static MenuItemToggle* createWithCallback(const ccMenuCallback& callback, MenuItem* item, ...) CC_REQUIRES_NULL_TERMINATION;
|
|
/** creates a menu item with no target/selector and no items */
|
|
static MenuItemToggle* create();
|
|
/** creates a menu item with a item */
|
|
static MenuItemToggle* create(MenuItem *item);
|
|
/** creates a menu item from a Array with a target selector
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
CC_DEPRECATED_ATTRIBUTE static MenuItemToggle * createWithTarget(Object* target, SEL_MenuHandler selector, Array* menuItems);
|
|
/** creates a menu item from a list of items with a target/selector
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
CC_DEPRECATED_ATTRIBUTE static MenuItemToggle* createWithTarget(Object* target, SEL_MenuHandler selector, MenuItem* item, ...)CC_REQUIRES_NULL_TERMINATION;
|
|
/**
|
|
* @js ctor
|
|
*/
|
|
MenuItemToggle()
|
|
: _selectedIndex(0)
|
|
, _subItems(NULL)
|
|
{}
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual ~MenuItemToggle();
|
|
|
|
/** initializes a menu item from a list of items with a target selector
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
CC_DEPRECATED_ATTRIBUTE bool initWithTarget(Object* target, SEL_MenuHandler selector, MenuItem* item, va_list args);
|
|
/** initializes a menu item from a list of items with a callable object */
|
|
bool initWithCallback(const ccMenuCallback& callback, MenuItem* item, va_list args);
|
|
|
|
/** initializes a menu item with a item */
|
|
bool initWithItem(MenuItem *item);
|
|
/** add more menu item */
|
|
void addSubItem(MenuItem *item);
|
|
|
|
/** return the selected item */
|
|
MenuItem* getSelectedItem();
|
|
/** @deprecated Use getSelectedItem() instead */
|
|
CC_DEPRECATED_ATTRIBUTE MenuItem* selectedItem() { return getSelectedItem(); }
|
|
|
|
/** Gets the index of the selected item */
|
|
inline unsigned int getSelectedIndex() const { return _selectedIndex; };
|
|
|
|
/** Sets the index of the selected item */
|
|
void setSelectedIndex(unsigned int index);
|
|
|
|
/** Gets the array that contains the subitems.
|
|
You can add/remove items in runtime, and you can replace the array with a new one.
|
|
@since v0.7.2
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
|
|
inline Array* getSubItems() const { return _subItems; };
|
|
|
|
/** Sets the array that contains the subitems. */
|
|
inline void setSubItems(Array* items) {
|
|
CC_SAFE_RETAIN(items);
|
|
CC_SAFE_RELEASE(_subItems);
|
|
_subItems = items;
|
|
}
|
|
|
|
// Overrides
|
|
virtual void activate() override;
|
|
virtual void selected() override;
|
|
virtual void unselected() override;
|
|
virtual void setEnabled(bool var) override;
|
|
|
|
protected:
|
|
/** returns the selected item */
|
|
unsigned int _selectedIndex;
|
|
/** Array that contains the subitems. You can add/remove items in runtime, and you can replace the array with a new one.
|
|
@since v0.7.2
|
|
*/
|
|
Array* _subItems;
|
|
|
|
};
|
|
|
|
|
|
// end of GUI group
|
|
/// @}
|
|
/// @}
|
|
|
|
NS_CC_END
|
|
|
|
#endif //__CCMENU_ITEM_H__
|