YSTest: YSLib::UI::ProgressBar类 参考

YSTest PreAlpha_b900_20201012 The YSLib Test Project

Public 成员函数 | Public 属性 | 所有成员列表
YSLib::UI::ProgressBar类 参考

进度条。 更多...

`#include <Progress.h>`

类 YSLib::UI::ProgressBar 继承关系图:
[图例]
YSLib::UI::ProgressBar 的协作图:
[图例]

## Public 成员函数

| ProgressBar (const Rect &={}, ValueType=0xFF)
void | SetMaxValue (ValueType)
| 设置进度关联值最大取值。 更多...
void | Refresh (PaintEventArgs &&) override
| 刷新：按指定参数绘制界面并更新状态。 更多...
Public 成员函数 继承自 YSLib::UI::Widget
| Widget (const Rect &={})
| Widget (const Rect &, HBrush)
template<typename _tView , typename _tRenderer , typename _tController >
| Widget (_tView &&pView_=make_unique< View >(), _tRenderer &&pRenderer_=make_unique< Renderer >(), _tController &&pController_={})
| 构造：使用视图指针、渲染器指针和控制器指针，无背景。 更多...
| Widget (const Widget &)
| 复制构造：除容器指针为空外深复制。 更多...
| DefDelMoveCtor (Widget) virtual ~Widget()
| since build 428 更多...
| DefGetter (ImplI(IWidget), WidgetRange, Children, WidgetRange()) static HBrush MakeBlankBrush()
| 取空白画刷。 更多...
| DefGetter (const ImplI(IWidget), AController &, Controller, Deref(controller_ptr)) DefGetterMem(const ynothrow
| GetView ()) DefGetter(const ImplI(IWidget)
Renderer | Deref (renderer_ptr)) DefGetter(const ImplI(IWidget)
Renderer AView | Deref (view_ptr)) DefGetterMem(const ynothrow
Renderer AView | GetView ()) DefGetterMem(const ynothrow
Renderer AView | GetView ()) DefGetterMem(const ynothrow
Renderer AView | GetView ()) DefSetterMem(
Renderer AView | GetView ()) DefSetterMem(
Renderer AView | GetView ()) DefSetterMem(
Renderer AView | GetView ()) DefSetterMem(
Renderer AView | GetView ()) void SetRenderer(unique_ptr< Renderer >)
| 设置渲染器为指定指针指向的对象，同时更新渲染器状态。 更多...
void | SetView (unique_ptr< AView >)
| 设置视图为指定指针指向的对象。 更多...

## Public 属性

Color | ForeColor {Drawing::ColorSpace::Black}
| 默认前景色。 更多...
Public 属性 继承自 YSLib::UI::Widget
HBrush | Background
| 背景。 更多...
| SDst
| Height
Renderer | Renderer
Renderer AView | View
Renderer AView | SDst
Renderer AView | Width
Renderer AView | SPos
Renderer AView | X
Renderer AView | Y
Renderer AView | Height

## 额外继承的成员函数

Protected 类型 继承自 YSLib::GMRange< float >
using | ValueType = float
Protected 成员函数 继承自 YSLib::UI::Control
| Control (const Rect &, HBrush)
| 构造：使用指定边界和背景画刷。 更多...
| Control (const Control &)
| 复制构造：除容器为空外深复制。 更多...
| ~Control () override
| 虚析构：类定义外默认实现。 更多...
virtual | PDefH (observer_ptr< IWidget >, GetBoundControlPtr, const KeyInput &) ImplRet(nullptr) void OnTouch_Close(CursorEventArgs &&)
| 取按键-指针设备输入默认事件组映射。 更多...
Protected 成员函数 继承自 YSLib::GMRange< float >
| GMRange (ValueType m, ValueType v)
| 构造：使用指定最大取值和值。 更多...
| DefGetter (const ynothrow, ValueType, MaxValue, max_value) DefGetter(const ynothrow
Protected 属性 继承自 YSLib::GMRange< float >
ValueType | max_value
| 最大取值。 更多...
ValueType | value
| 值。 更多...
| ValueType
| Value
相关函数 继承自 YSLib::UI::Widget
template<class _tRenderer >
_tRenderer & | WrapRenderer (Widget &wgt, unique_ptr< _tRenderer > p_renderer)
| 包装渲染器：设置渲染器并返回被设置的渲染器引用。 更多...

## 详细描述

进度条。

自从
  build 219

在文件 Progress.h 第 46 行定义.

## 构造及析构函数说明

## ◆ ProgressBar()

YSLib::UI::ProgressBar::ProgressBar | ( | const Rect & | r = `{}`,
|  | ValueType | m = `0xFF`
| ) |  |

explicit

注解
  当第二参数不是非零有限浮点数时视为 1.F 。

自从
  build 337

在文件 Progress.cpp 第 40 行定义.

引用了 YSLib::UI::Widget::Background, YSLib::UI::BoundaryPriority(), YSLib::UI::FetchGUIConfiguration(), ForeColor, YSLib::UI::Styles::HotTracking, YSLib::UI::Styles::InactiveBorder, YSLib::UI::Invalidate(), YSLib::UI::Styles::Track , 以及 yunseq.

函数调用图:

## 成员函数说明

## ◆ Refresh()

void YSLib::UI::ProgressBar::Refresh | ( | PaintEventArgs && | e | ) |

overridevirtual

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

自从
  build 294

重载 YSLib::UI::Widget .

在文件 Progress.cpp 第 70 行定义.

引用了 YSLib::UI::Widget::Background, YSLib::Drawing::bounds, YSLib::UI::e, YSLib::Drawing::FillRect(), ForeColor, YSLib::Drawing::g, YSLib::UI::GetSizeOf, YSLib::GMRange< float >::max_value, platform::p, CHRLib::s, YSLib::UI::Widget::SPos, YSLib::GMRange< float >::value, YB_LIKELY , 以及 yunseq.

函数调用图:

## ◆ SetMaxValue()

void YSLib::UI::ProgressBar::SetMaxValue | ( | ValueType | m | ) |

设置进度关联值最大取值。

注解
  当指定值非正值时无效。
  约束关联值不大于指定值。

在文件 Progress.cpp 第 59 行定义.

引用了 YSLib::GMRange< float >::max_value, YSLib::GMRange< float >::value , 以及 YB_LIKELY.

被这些函数引用 YReader::ReaderBox::UpdateData().

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

## 类成员变量说明

## ◆ ForeColor

Color YSLib::UI::ProgressBar::ForeColor {Drawing::ColorSpace::Black}

默认前景色。

自从
  build 525

在文件 Progress.h 第 53 行定义.

被这些函数引用 ProgressBar() , 以及 Refresh().

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

- Progress.h
- Progress.cpp