YSLib::UI::CheckBox类 参考

复选框。 更多...

#include <Selector.h>

类 YSLib::UI::CheckBox 继承关系图:

YSLib::UI::CheckBox 的协作图:

Public 类型
typedef GValueEventArgs< bool >	TickedArgs
	复选框选中状态参数类型。
typedef GHEvent< void(TickedArgs)>	HTickedEvent
	复选框选中事件委托类型。

Public 成员函数
	CheckBox (const Rect &={})
	构造：使用指定边界。
	CheckBox (CheckBox &&)=default
bool	IsTicked () const ynothrow
GEvent< void(HTickedEvent::EventArgsType)> &	GetTicked () ynothrow
	复选框选中事件。
void	SetTicked (bool)
	设置选中状态并检查复选框选中事件。
void	Tick (bool)
	设置选中状态并触发复选框选中事件。
void	Refresh (PaintEventArgs &&) override
	刷新：按指定参数绘制界面并更新状态。
Public 成员函数 继承自 YSLib::UI::Thumb
	Thumb (const Rect &={}, Drawing::Hue=180)
	构造：使用指定边界和色调。
	Thumb (Thumb &&)=default
bool	IsPressed () const ynothrow
	判断按钮当前是否处于按下状态。
Public 成员函数 继承自 YSLib::UI::Control
	Control (const Rect &={})
	构造：使用指定边界，默认背景（同 Widget 默认构造）。
	Control (const Rect &, NoBackgroundTag)
	构造：使用指定边界，无背景。
	Control (const Control &)
	复制构造：除容器为空外深复制。
	Control (Control &&)=default
virtual IWidget *	GetBoundControlPtr (const KeyInput &)
	取按键-指针设备输入默认事件组映射。
void	OnTouch_Close (TouchEventArgs &&)
	处理屏幕事件：关闭显示。
Public 成员函数 继承自 YSLib::UI::Widget
	Widget (const Rect &={}, Color=Drawing::ColorSpace::White, Color=Drawing::ColorSpace::Black)
template<typename _tView , typename _tRenderer , typename _tController >
	Widget (_tView &&pView_=make_unique< View >(), _tRenderer &&pRenderer_=make_unique< Renderer >(), _tController &&pController_={})
	构造：使用视图指针、渲染器指针和控制器指针，无背景。
	Widget (const Widget &)
	复制构造：除容器指针为空外深复制。
	Widget (Widget &&)=default
virtual	~Widget ()
	析构：虚实现。
SPos	GetX () const ynothrow
SPos	GetY () const ynothrow
SDst	GetWidth () const ynothrow
SDst	GetHeight () const ynothrow
virtual Renderer &	GetRenderer () const ynothrow
	取渲染器。
virtual View &	GetView () const ynothrow
	取部件视图。
virtual AController &	GetController () const override
	取控制器。
virtual WidgetRange	GetChildren () override
void	SetX (SDst _tempArgName)
void	SetY (SDst _tempArgName)
void	SetWidth (SDst _tempArgName)
void	SetHeight (SDst _tempArgName)
void	SetRenderer (unique_ptr< Renderer > &&)
	设置渲染器为指定指针指向的对象，同时更新渲染器状态。
void	SetView (unique_ptr< View > &&)
	设置渲染器为指定指针指向的对象，同时更新渲染器状态。
Public 成员函数 继承自 YSLib::UI::IWidget
virtual	~IWidget ()

Protected 成员函数
void	PaintBox (const Graphics &, const Rect &)
	绘制复选框。
Protected 成员函数 继承自 YSLib::UI::Thumb
	Thumb (const Rect &, NoBackgroundTag)
	无背景构造：使用指定边界。

Protected 属性
bool	bTicked
Protected 属性 继承自 YSLib::UI::Thumb
bool	bPressed
	按下状态：表示按钮当前是否处于按下状态。

Private 属性
GEvent< void(HTickedEvent::EventArgsType)>	Ticked
	复选框选中事件。

额外继承的成员函数
Public 属性 继承自 YSLib::UI::Control
std::function< IWidget *(const KeyInput &)>	BoundControlPtr
	按键-指针设备输入事件组映射。

详细描述

复选框。

自从

build 205

在文件 Selector.h 第 42 行定义.

成员类型定义说明

typedef GHEvent<void( TickedArgs )> YSLib::UI::CheckBox::HTickedEvent

复选框选中事件委托类型。

自从

build 292

在文件 Selector.h 第 55 行定义.

typedef GValueEventArgs<bool> YSLib::UI::CheckBox::TickedArgs

复选框选中状态参数类型。

注解

bool 参数表示选中后的状态。

自从

build 292

在文件 Selector.h 第 50 行定义.

构造及析构函数说明

YSLib::UI::CheckBox::CheckBox ( const Rect &  = {} )

explicit

构造：使用指定边界。

自从

build 337

YSLib::UI::CheckBox::CheckBox ( CheckBox &&  )

inlinedefault

成员函数说明

GEvent<void( HTickedEvent ::EventArgsType)>& YSLib::UI::CheckBox::GetTicked ( )

inline

复选框选中事件。

自从

build 292

在文件 Selector.h 第 82 行定义.

bool YSLib::UI::CheckBox::IsTicked ( ) const

inline

在文件 Selector.h 第 76 行定义.

void CheckBox::PaintBox ( const Graphics &  g, const Rect &  r  )

protected

绘制复选框。

自从

build 311

在文件 Selector.cpp 第 129 行定义.

参考 IsFocused(),YSLib::UI::IsFocusedByShell() , 以及 YSL_BEGIN::RectDrawCheckBox().

参考自 YSLib::UI::CheckButton::Refresh().

函数调用图:

这是这个函数的调用关系图:

void CheckBox::Refresh ( PaintEventArgs &&  e )

overridevirtual

刷新：按指定参数绘制界面并更新状态。

自从

build 311

重载 YSLib::UI::Widget .

被 YSLib::UI::CheckButton 重载.

在文件 Selector.cpp 第 136 行定义.

参考 YSLib::UI::GetSizeOf().

函数调用图:

void CheckBox::SetTicked

(

bool

b

)

设置选中状态并检查复选框选中事件。

注解

若选中状态发生改变则引起复选框选中事件。

自从

build 292

在文件 Selector.cpp 第 113 行定义.

void CheckBox::Tick

(

bool

b

)

设置选中状态并触发复选框选中事件。

注解

不检查状态改变。

自从

build 307

在文件 Selector.cpp 第 123 行定义.

类成员变量说明

bool YSLib::UI::CheckBox::bTicked

protected

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

GEvent<void( HTickedEvent ::EventArgsType)> YSLib::UI::CheckBox::Ticked

private

复选框选中事件。

自从

build 292

在文件 Selector.h 第 65 行定义.

---

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

• Selector.h
• Selector.cpp