YSTest: YSLib::UI::Label类 参考

YSTest PreAlpha_b700_20160611 The YSLib Test Project

- 首页
- 相关页面
- 模块
- 命名空间
- 类
- 文件

- 类列表
- 类索引
- 类继承关系
- 类成员

Public 成员函数 | 静态 Public 成员函数 | 所有成员列表
YSLib::UI::Label类 参考

标签。 更多...

`#include <Label.h>`

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

## Public 成员函数

| Label (const Rect &r={}, const Drawing::Font &fnt={}, HBrush b=MakeBlankBrush(), Color c=Drawing::ColorSpace::Black)
| 构造：使用指定边界、字体、背景画刷和文字颜色。 更多...
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 成员函数

static Rect | CalculateBounds (const String &, Rect, const Drawing::Font &, const Drawing::Padding &={})
| 计算指定字符串、初始边界、字体和边距的单行文本需要的标签边界。 更多...

## 相关函数

(请注意: 这些不是成员函数.)
YF_API unique_ptr< Label > | MakeLabel (const String &, const Rect &=Rect::Invalid, const Drawing::Font &={}, const Drawing::Padding &=Drawing::DefaultMargin *2)
| 创建指定字符串、初始边界、字体和边距的单行文本需要的标签。 更多...
YF_API void | SetupContentsOf (Label &, const String &, const Rect &=Rect::Invalid, const Drawing::Font &={}, const Drawing::Padding &=Drawing::DefaultMargin *2)
| 设置指定字符串、初始边界、字体和边距的单行文本需要的标签。 更多...
相关函数 继承自 YSLib::UI::Widget
template<class... _tWidgets>
void | InvalidateWidgets (_tWidgets &...wgts)
| 向无效化部件。 更多...
template<class _tRenderer >
_tRenderer & | WrapRenderer (Widget &wgt, unique_ptr< _tRenderer > p_renderer)
| 包装渲染器：设置渲染器并返回被设置的渲染器引用。 更多...

## 额外继承的成员函数

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::UI::MLabel
| MLabel (const Drawing::Font &={}, Color=Drawing::ColorSpace::Black, TextAlignment=TextAlignment::Left)
| 构造：使用指定字体、文本颜色和文本对齐样式。 更多...
| DefDeMoveCtor (MLabel) void operator()(PaintEventArgs &&) const
| 描画：使用发送者的大小并调用 DrawText 绘制文本。 更多...
Point | GetAlignedPenOffset (const Size &) const
| 按参数指定的边界大小和当前状态计算笔的偏移位置。 更多...
| DefGetter (const ynothrow, SDst, ItemHeight, Font.GetHeight()+GetVerticalOf(Margin)) void DrawText(const Size &
| 绘制文本。 更多...
静态 Protected 成员函数 继承自 YSLib::UI::MLabel
static void | DefaultUpdateClippedText (const PaintContext &, Drawing::TextState &, const String &, bool)
| 绘制剪切文本：使用指定的绘制上下文和文本状态。 更多...
Protected 属性 继承自 YSLib::UI::MLabel
Drawing::GBrushUpdater< Drawing::TextState &, const String &, bool > | UpdateClippedText {DefaultUpdateClippedText}
| 当前使用的剪切文本更新器。 更多...
Color | ForeColor {Drawing::ColorSpace::Black}
| 默认前景色。 更多...
Drawing::Font | Font
| 字体。 更多...
Drawing::Padding | Margin {Drawing::DefaultMargin}
| 文本和容器的间距。 更多...
TextAlignment | HorizontalAlignment
| 文本水平和竖直对齐属性。 更多...
TextAlignment | VerticalAlignment = TextAlignment::Center
bool | AutoWrapLine = {}
| 启用自动换行。 更多...
String | Text {}
| 标签文本。 更多...
const PaintContext & | const

## 详细描述

标签。

在文件 Label.h 第 143 行定义.

## 构造及析构函数说明

YSLib::UI::Label::Label | ( | const Rect & | r = `{}`,
|  | const Drawing::Font & | fnt = `{}`,
|  | HBrush | b = `MakeBlankBrush()`,
|  | Color | c = `Drawing::ColorSpace::Black`
| ) |  |

inlineexplicit

构造：使用指定边界、字体、背景画刷和文字颜色。

自从
  build 484

在文件 Label.h 第 161 行定义.

## 成员函数说明

Rect YSLib::UI::Label::CalculateBounds | ( | const String & | text,
|  | Rect | r,
|  | const Drawing::Font & | fnt,
|  | const Drawing::Padding & | m = `{}`
| ) |  |

static

计算指定字符串、初始边界、字体和边距的单行文本需要的标签边界。

注解
  仅当初始边界的大小为 Size::Invalid 时计算新的大小。

自从
  build 573

在文件 Label.cpp 第 124 行定义.

参考 YSLib::Drawing::FetchStringWidth(), YSLib::Drawing::Font::GetHeight(), YSLib::Drawing::Size::Invalid , 以及 YSLib::Drawing::r.

参考自 YSLib::UI::MakeLabel() , 以及 YSLib::UI::SetupContentsOf().

函数调用图:

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

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

overridevirtual

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

自从
  build 294

重载 YSLib::UI::Widget .

在文件 Label.cpp 第 137 行定义.

参考 YSLib::UI::e.

## 友元及相关函数文档

YF_API unique_ptr< Label > MakeLabel | ( | const String & | ,
|  | const Rect & | = `Rect::Invalid`,
|  | const Drawing::Font & | = `{}`,
|  | const Drawing::Padding & | = `Drawing::DefaultMargin *2`
| ) |  |

related

创建指定字符串、初始边界、字体和边距的单行文本需要的标签。

参见
  Label::CalculateBounds

自从
  build 573

在文件 Label.cpp 第 143 行定义.

YF_API void SetupContentsOf | ( | Label & | ,
|  | const String & | ,
|  | const Rect & | = `Rect::Invalid`,
|  | const Drawing::Font & | = `{}`,
|  | const Drawing::Padding & | = `Drawing::DefaultMargin *2`
| ) |  |

related

设置指定字符串、初始边界、字体和边距的单行文本需要的标签。

在文件 Label.cpp 第 153 行定义.

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

- Label.h
- Label.cpp