2019-11-23 20:27:39 +08:00
|
|
|
/****************************************************************************
|
|
|
|
Copyright (c) 2013-2016 Chukong Technologies Inc.
|
|
|
|
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
|
|
|
|
|
|
|
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 __UICHECKBOX_H__
|
|
|
|
#define __UICHECKBOX_H__
|
|
|
|
|
|
|
|
#include "ui/UIAbstractCheckButton.h"
|
|
|
|
#include "ui/GUIExport.h"
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @addtogroup ui
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
NS_CC_BEGIN
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
namespace ui
|
|
|
|
{
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Checkbox is a specific type of two-states button that can be either checked or unchecked.
|
|
|
|
*/
|
|
|
|
class CC_GUI_DLL CheckBox : public AbstractCheckButton
|
|
|
|
{
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
DECLARE_CLASS_GUI_INFO
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* CheckBox event type, currently only "selected" and "unselected" event are cared.
|
|
|
|
*/
|
|
|
|
enum class EventType
|
|
|
|
{
|
|
|
|
SELECTED,
|
|
|
|
UNSELECTED
|
|
|
|
};
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* A callback which will be called after certain CheckBox event issue.
|
|
|
|
* @see `CheckBox::EventType`
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
typedef std::function<void(Ref*, CheckBox::EventType)> ccCheckBoxCallback;
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Default constructor.
|
2021-12-25 10:04:45 +08:00
|
|
|
*
|
2019-11-23 20:27:39 +08:00
|
|
|
* @lua new
|
|
|
|
*/
|
|
|
|
CheckBox();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Default destructor.
|
2021-12-25 10:04:45 +08:00
|
|
|
*
|
2019-11-23 20:27:39 +08:00
|
|
|
* @lua NA
|
|
|
|
*/
|
|
|
|
virtual ~CheckBox();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Create and return a empty CheckBox instance pointer.
|
|
|
|
*/
|
|
|
|
static CheckBox* create();
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Create an checkbox with various images.
|
|
|
|
*
|
|
|
|
* @param backGround backGround texture.
|
|
|
|
* @param backGroundSelected backGround selected state texture.
|
|
|
|
* @param cross cross texture.
|
|
|
|
* @param backGroundDisabled backGround disabled state texture.
|
|
|
|
* @param frontCrossDisabled cross dark state texture.
|
|
|
|
* @param texType @see `Widget::TextureResType`
|
|
|
|
*
|
|
|
|
* @return A CheckBox instance pointer.
|
|
|
|
*/
|
2021-12-31 11:00:35 +08:00
|
|
|
static CheckBox* create(const std::string& backGround,
|
|
|
|
const std::string& backGroundSelected,
|
|
|
|
const std::string& cross,
|
|
|
|
const std::string& backGroundDisabled,
|
|
|
|
const std::string& frontCrossDisabled,
|
2019-11-23 20:27:39 +08:00
|
|
|
TextureResType texType = TextureResType::LOCAL);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Another factory method to create a CheckBox instance.
|
|
|
|
* This method uses less resource to create a CheckBox.
|
|
|
|
* @param backGround The background image name in `std::string`.
|
|
|
|
* @param cross The cross image name in `std::string`.
|
|
|
|
* @param texType The texture's resource type in `Widget::TextureResType`.
|
|
|
|
* @return A CheckBox instance pointer
|
|
|
|
*/
|
2021-12-31 11:00:35 +08:00
|
|
|
static CheckBox* create(const std::string& backGround,
|
|
|
|
const std::string& cross,
|
2019-11-23 20:27:39 +08:00
|
|
|
TextureResType texType = TextureResType::LOCAL);
|
|
|
|
|
|
|
|
/**
|
|
|
|
*Add a callback function which would be called when checkbox is selected or unselected.
|
|
|
|
*@param callback A std::function with type @see `ccCheckBoxCallback`
|
|
|
|
*/
|
|
|
|
void addEventListener(const ccCheckBoxCallback& callback);
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
// override functions
|
2019-11-23 20:27:39 +08:00
|
|
|
virtual std::string getDescription() const override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
|
|
|
virtual void onTouchEnded(Touch* touch, Event* unusedEvent) override;
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
protected:
|
|
|
|
virtual void dispatchSelectChangedEvent(bool selected) override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
virtual Widget* createCloneInstance() override;
|
|
|
|
virtual void copySpecialProperties(Widget* model) override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
protected:
|
2021-12-25 10:04:45 +08:00
|
|
|
// if you use the old event callback, it will retain the _checkBoxEventListener
|
|
|
|
Ref* _checkBoxEventListener;
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
ccCheckBoxCallback _checkBoxEventCallback;
|
2019-11-23 20:27:39 +08:00
|
|
|
};
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
} // namespace ui
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
NS_CC_END
|
|
|
|
// end of ui group
|
|
|
|
/// @}
|
|
|
|
|
|
|
|
#endif /* defined(__CocoGUI__CheckBox__) */
|