dl::UI::ButtonBase类 参考

按钮(Button、Switch、Radio） 更多...

#include <dl_ui_button_base.h>

被 dl::UI::ButtonNormal, dl::UI::ButtonSprite , 以及 dl::UI::ButtonTextColor 继承.

Public 类型
enum class	State { NORMAL , OVER , DOWN , MAX_NUM }
enum class	Mode { BUTTON , SWITCH , RADIO }

Public 成员函数
	ButtonBase ()
	ButtonBase (const ButtonBase &b)
void	Update ()
void	Render ()
bool	IsClick ()
	控件被点击 更多...
bool	IsThrough ()
	经过按钮，直到离开控件再次进入才会返回真 更多...
bool	IsRadio ()
bool	IsOpen ()
void	SetOpen (bool open)
void	SetMode (Mode mode)
void	SetDisable (bool disable)
void	SetSound (std::string_view click, std::string_view over)
	设置按钮音效 更多...
State	GetState ()
Coor *	GetCoor ()
virtual bool	IsPickup ()=0
virtual void	SetOrder (float order)=0
virtual Position	GetSize ()=0
virtual Position	GetAnchor ()=0
void	SetElementData (const Align::Direction2 &hv)
Components *	GetCpt ()
Mode	GetMode ()
virtual	~ButtonBase ()

Protected 成员函数
std::size_t	GetIndex (State state)
	返回索引 更多...

Protected 属性
Coor *	_coor

详细描述

按钮(Button、Switch、Radio）

在文件 dl_ui_button_base.h 第 27 行定义.

成员枚举类型说明

Mode

enum class dl::UI::ButtonBase::Mode

strong

枚举值
BUTTON	按钮
SWITCH	开关，按下后不会自动弹起，再次点击后弹起
RADIO	收音机按钮，按下后就不能弹起，只能通过代码弹起

在文件 dl_ui_button_base.h 第 38 行定义.

State

enum class dl::UI::ButtonBase::State

strong

枚举值
NORMAL	普通
OVER	鼠标经过
DOWN	持续按下
MAX_NUM

在文件 dl_ui_button_base.h 第 30 行定义.

构造及析构函数说明

ButtonBase() [1/2]

dl::UI::ButtonBase::ButtonBase ( )

inline

在文件 dl_ui_button_base.h 第 45 行定义.

ButtonBase() [2/2]

dl::UI::ButtonBase::ButtonBase ( const ButtonBase &  b )

inline

在文件 dl_ui_button_base.h 第 58 行定义.

~ButtonBase()

virtual dl::UI::ButtonBase::~ButtonBase ( )

inlinevirtual

在文件 dl_ui_button_base.h 第 128 行定义.

成员函数说明

GetAnchor()

virtual Position dl::UI::ButtonBase::GetAnchor ( )

pure virtual

在 dl::UI::ButtonNormal, dl::UI::ButtonSprite , 以及 dl::UI::ButtonTextColor 内被实现.

GetCoor()

Coor * dl::UI::ButtonBase::GetCoor ( )

inline

在文件 dl_ui_button_base.h 第 110 行定义.

GetCpt()

Components * dl::UI::ButtonBase::GetCpt ( )

inline

在文件 dl_ui_button_base.h 第 124 行定义.

GetIndex()

std::size_t dl::UI::ButtonBase::GetIndex ( State  state )

inlineprotected

返回索引

在文件 dl_ui_button_base.h 第 148 行定义.

GetMode()

Mode dl::UI::ButtonBase::GetMode ( )

inline

在文件 dl_ui_button_base.h 第 126 行定义.

GetSize()

virtual Position dl::UI::ButtonBase::GetSize ( )

pure virtual

在 dl::UI::ButtonNormal, dl::UI::ButtonSprite , 以及 dl::UI::ButtonTextColor 内被实现.

GetState()

State dl::UI::ButtonBase::GetState ( )

inline

在文件 dl_ui_button_base.h 第 108 行定义.

IsClick()

bool dl::UI::ButtonBase::IsClick

(

)

控件被点击

注解

对于 button来说，单击并释放才会触发

对于 switch来说，单击并释放才会触发

对于 radio来说，单击才会触发

IsOpen()

bool dl::UI::ButtonBase::IsOpen ( )

inline

在文件 dl_ui_button_base.h 第 87 行定义.

IsPickup()

virtual bool dl::UI::ButtonBase::IsPickup ( )

pure virtual

在 dl::UI::ButtonNormal, dl::UI::ButtonSprite , 以及 dl::UI::ButtonTextColor 内被实现.

IsRadio()

bool dl::UI::ButtonBase::IsRadio ( )

inline

在文件 dl_ui_button_base.h 第 85 行定义.

IsThrough()

bool dl::UI::ButtonBase::IsThrough

(

)

经过按钮，直到离开控件再次进入才会返回真

Render()

void dl::UI::ButtonBase::Render

(

)

SetDisable()

void dl::UI::ButtonBase::SetDisable ( bool  disable )

inline

在文件 dl_ui_button_base.h 第 93 行定义.

SetElementData()

void dl::UI::ButtonBase::SetElementData ( const Align::Direction2 &  hv )

inline

在文件 dl_ui_button_base.h 第 117 行定义.

SetMode()

void dl::UI::ButtonBase::SetMode

(

Mode

mode

)

SetOpen()

void dl::UI::ButtonBase::SetOpen

(

bool

open

)

SetOrder()

virtual void dl::UI::ButtonBase::SetOrder ( float  order )

pure virtual

在 dl::UI::ButtonNormal, dl::UI::ButtonSprite , 以及 dl::UI::ButtonTextColor 内被实现.

SetSound()

void dl::UI::ButtonBase::SetSound ( std::string_view  click, std::string_view  over  )

inline

设置按钮音效

参数

[in]	click	点击音效
[in]	over	经过音效

注解

默认为空字符串，为没有音效

在文件 dl_ui_button_base.h 第 102 行定义.

Update()

void dl::UI::ButtonBase::Update

(

)

类成员变量说明

_coor

Coor* dl::UI::ButtonBase::_coor

protected

在文件 dl_ui_button_base.h 第 145 行定义.

---

该类的文档由以下文件生成:

• dl/ui/dl_ui_button_base.h