YSTest: YSLib::Drawing::TextState类 参考

YSTest PreAlpha_b400_20130424 The YSLib Test Project

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

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

全部 类 命名空间 文件 函数 变量 类型定义 枚举 枚举值 友元 宏定义 组 页
Public 成员函数 | Public 属性 | 所有成员列表
YSLib::Drawing::TextState类 参考

文本状态。 更多...

`#include <TextBase.h>`

类 YSLib::Drawing::TextState 继承关系图:
[图例]
YSLib::Drawing::TextState 的协作图:
[图例]

## Public 成员函数

| TextState (const Drawing::Font &={})
| 构造：使用指定字体。
| TextState (FontCache &)
| 构造：使用指定字体缓存。
TextState & | operator= (const PenStyle &ps)
| 赋值：笔样式。
TextState & | operator= (const Padding &ms)
| 赋值：边距。
void | PutNewline ()
| 打印换行。
void | ResetPen ()
| 复位笔：按字体大小设置笔位置为默认位置。
void | ResetPen (const Point &, const Padding &={})
| 按指定显示区域左上角位置和附加边距重新设置笔位置。

## Public 属性

Padding | Margin
| 边距：文本区域到显示区域的距离。
Point | Pen
| 笔坐标。
u8 | LineGap
| 行距。

## 额外继承的成员函数

Protected 成员函数 继承自 YSLib::Drawing::PenStyle
| PenStyle (const Drawing::Font &fnt={}, Drawing::Color c=Drawing::ColorSpace::White)
| 构造：使用指定字体家族、字体大小和颜色。
const FontFamily & | GetFontFamily () const ynothrow
FontCache & | GetCache () const ynothrow
Protected 属性 继承自 YSLib::Drawing::PenStyle
Drawing::Font | Font
| 字体。
Drawing::Color | Color
| 笔颜色。

## 详细描述

文本状态。

包含笔样式、显示区域边界、字体缓存和行距。 文本区域指文本状态描述的平面区域。 文本区域位置坐标是文本区域左上角为原点的屏幕坐标系。 笔位置以文本区域位置坐标表示。 显示区域为文本区域内部实际显示文本光栅化结果的区域。 边距描述显示区域和文本区域的位置关系。 文本状态不包含文本区域和显示区域的大小，应由外部图形接口上下文或缓冲区状态确定。

自从
  build 145

在文件 TextBase.h 第 84 行定义.

## 构造及析构函数说明

YSLib::Drawing::TextState::TextState | ( | const Drawing::Font & | = `{}` | ) |

explicit

构造：使用指定字体。

自从
  build 337

YSLib::Drawing::TextState::TextState | ( | FontCache & |  | ) |

explicit

构造：使用指定字体缓存。

## 成员函数说明

TextState& YSLib::Drawing::TextState::operator= | ( | const PenStyle & | ps | ) |

inline

赋值：笔样式。

在文件 TextBase.h 第 115 行定义.

TextState& YSLib::Drawing::TextState::operator= | ( | const Padding & | ms | ) |

inline

赋值：边距。

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

void TextState::PutNewline | ( |  | ) |

打印换行。

在文件 TextBase.cpp 第 49 行定义.

参考 YSLib::Drawing::CarriageReturn(),YSLib::Drawing::GetTextLineHeightExOf(),Pen , 以及 YSLib::Drawing::GBinaryGroup< _type >::Y.

函数调用图:

void TextState::ResetPen | ( |  | ) |

复位笔：按字体大小设置笔位置为默认位置。

注解
  默认笔位置在由边距约束的显示区域左上角。

在文件 TextBase.cpp 第 56 行定义.

参考 YSLib::Drawing::CarriageReturn(),YSLib::Drawing::GetTextLineBaseOf(),Pen , 以及 YSLib::Drawing::GBinaryGroup< _type >::Y.

参考自 YSLib::UI::MLabel::DrawText(),YSLib::Drawing::TextRegion::InitializeFont() , 以及 DualScreenReader::Reset().

函数调用图:

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

void YSLib::Drawing::TextState::ResetPen | ( | const Point & | ,
|  | const Padding & | = `{}`
| ) |  |

按指定显示区域左上角位置和附加边距重新设置笔位置。

自从
  build 372

通过已有的区域左上角坐标和附加边距的左和上分量约束新和笔位置。

## 类成员变量说明

u8 YSLib::Drawing::TextState::LineGap

行距。

在文件 TextBase.h 第 97 行定义.

参考自 DualScreenReader::Execute(),YSLib::Drawing::GetTextLineHeightExOf(),YSLib::UI::MTextList::RefreshTextState() , 以及 DualScreenReader::SetLineGap().

Padding YSLib::Drawing::TextState::Margin

边距：文本区域到显示区域的距离。

在文件 TextBase.h 第 91 行定义.

参考自 YSLib::Drawing::AdjustBottomMarginOf(),YSLib::Drawing::AdjustEndOfLine(),DualScreenReader::AdjustMargins(),YSLib::Drawing::CarriageReturn(),YSLib::UI::MLabel::DrawText(),YSLib::Drawing::GetCurrentTextLineNOf(),YSLib::Drawing::GetTextLineBaseOf(),YSLib::Drawing::TextRegion::operator()() , 以及 YSLib::Drawing::TextRegion::Scroll().

Point YSLib::Drawing::TextState::Pen

笔坐标。

自从
  build 371

在文件 TextBase.h 第 96 行定义.

参考自 YSLib::Drawing::CarriageReturn(),YSLib::UI::MLabel::DrawText(),YSLib::Drawing::FetchStringWidth(),YSLib::Drawing::GetCurrentTextLineNOf(),PutNewline(),ResetPen(),DualScreenReader::ScrollByPixel() , 以及 YSLib::Drawing::SetPenOf().

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

- TextBase.h
- TextBase.cpp