Kiwano Engine  v1.2.x
kiwano::TextLayout类 参考

文本布局 更多...

#include <TextLayout.h>

类 kiwano::TextLayout 继承关系图:
kiwano::TextLayout 的协作图:

Public 类型

enum  DirtyFlag : uint8_t { DirtyFlag::Clean = 0, DirtyFlag::Dirty = 1 << 0 }
 脏布局标志 更多...
 

Public 成员函数

 TextLayout (const String &content, const TextStyle &style)
 创建文本布局 更多...
 
bool IsDirty () const
 文本布局是否陈旧
 
void Clear ()
 清空文本布局
 
void Reset (const String &content, const TextStyle &style)
 重设文本布局 更多...
 
Size GetSize () const
 获取文本布局大小
 
uint32_t GetLineCount () const
 获取文本行数
 
BrushPtr GetFillBrush () const
 获取默认填充画刷
 
BrushPtr GetOutlineBrush () const
 获取默认描边画刷
 
StrokeStylePtr GetOutlineStrokeStyle () const
 获取默认描边线条样式
 
void SetFont (FontPtr font)
 设置字体 更多...
 
void SetUnderline (bool enable)
 设置下划线 更多...
 
void SetStrikethrough (bool enable)
 设置删除线 更多...
 
void SetFillBrush (BrushPtr brush)
 设置文字填充画刷,描边画刷和描边线宽 更多...
 
void SetOutlineBrush (BrushPtr brush)
 设置文字描边画刷 更多...
 
void SetOutlineStrokeStyle (StrokeStylePtr stroke)
 设置描边线条样式 更多...
 
void SetAlignment (TextAlign align)
 设置对齐方式 更多...
 
void SetWrapWidth (float wrap_width)
 设置文本自动换行的宽度
 
void SetLineSpacing (float line_spacing)
 设置行间距(默认为 0)
 
DirtyFlag GetDirtyFlag () const
 获取脏布局标志
 
void SetDirtyFlag (DirtyFlag flag)
 设置脏布局标志
 
bool UpdateIfDirty ()
 更新脏布局 更多...
 
- Public 成员函数 继承自 kiwano::NativeObjectBase
bool IsValid () const override
 判断对象是否有效
 
void * GetNativePointer () const
 
template<typename _NativeTy >
_NativeTy * GetNativePointer () const
 
virtual void ResetNativePointer (void *native_pointer=nullptr)
 
- Public 成员函数 继承自 kiwano::ObjectBase
 ObjectBase ()
 构造基础对象
 
void SetName (const String &name)
 设置对象名
 
String GetName () const
 获取对象名
 
bool IsName (const String &name) const
 判断对象的名称是否相同 更多...
 
void * GetUserData () const
 获取用户数据
 
void SetUserData (void *data)
 设置用户数据
 
uint64_t GetObjectID () const
 获取对象ID
 
void DoSerialize (Serializer *serializer) const override
 序列化
 
void DoDeserialize (Deserializer *deserializer) override
 反序列化
 
ObjectStatusGetStatus () const
 获取对象状态
 
void SetStatus (const ObjectStatus &status)
 设置对象状态
 
void Fail (const String &msg, int code=ObjectStatus::fail)
 将对象标记为失败状态
 
void ClearStatus ()
 清除对象状态
 
- Public 成员函数 继承自 kiwano::RefObject
void Retain ()
 增加引用计数
 
void Release ()
 减少引用计数
 
uint32_t GetRefCount () const
 获取引用计数
 
- Public 成员函数 继承自 kiwano::Serializable
Vector< uint8_t > Serialize () const
 序列化为字节串
 
void Deserialize (const Vector< uint8_t > &data)
 从字节串反序列化
 

额外继承的成员函数

- 静态 Public 成员函数 继承自 kiwano::ObjectBase
static void SetObjectPolicy (const ObjectPolicyFunc &policy)
 设置对象处理策略
 
static bool IsTracingLeaks ()
 是否启用了内存泄漏追踪
 
static void StartTracingLeaks ()
 开始追踪内存泄漏
 
static void StopTracingLeaks ()
 停止追踪内存泄漏
 
static void DumpTracingObjects ()
 打印所有追踪中的对象信息
 
static Vector< ObjectBase * > & GetTracingObjects ()
 获取所有追踪中的对象
 
- 静态 Public 成员函数 继承自 kiwano::RefObject
static void * operator new (size_t size)
 
static void operator delete (void *ptr)
 
static void * operator new (size_t size, std::nothrow_t const &) noexcept
 
static void operator delete (void *ptr, std::nothrow_t const &) noexcept
 
static void * operator new (size_t size, void *ptr) noexcept
 
static void operator delete (void *ptr, void *place) noexcept
 
- Protected 属性 继承自 kiwano::NativeObjectBase
void * native_pointer_
 

详细描述

文本布局

成员枚举类型说明

enum kiwano::TextLayout::DirtyFlag : uint8_t
strong

脏布局标志

枚举值
Clean 

干净布局

Dirty 

脏布局

构造及析构函数说明

kiwano::TextLayout::TextLayout ( const String &  content,
const TextStyle style 
)

创建文本布局

参数
content文字内容
style文本样式

成员函数说明

void kiwano::TextLayout::Reset ( const String &  content,
const TextStyle style 
)

重设文本布局

参数
content文字内容
style文本样式
void kiwano::TextLayout::SetAlignment ( TextAlign  align)

设置对齐方式

参数
align对齐方式
void kiwano::TextLayout::SetFillBrush ( BrushPtr  brush)
inline

设置文字填充画刷,描边画刷和描边线宽

参数
brush画刷
void kiwano::TextLayout::SetFont ( FontPtr  font)

设置字体

参数
font字体
void kiwano::TextLayout::SetOutlineBrush ( BrushPtr  brush)
inline

设置文字描边画刷

参数
brush画刷
void kiwano::TextLayout::SetOutlineStrokeStyle ( StrokeStylePtr  stroke)
inline

设置描边线条样式

参数
stroke线条样式
void kiwano::TextLayout::SetStrikethrough ( bool  enable)

设置删除线

参数
enable是否显示删除线
void kiwano::TextLayout::SetUnderline ( bool  enable)

设置下划线

参数
enable是否显示下划线
bool kiwano::TextLayout::UpdateIfDirty ( )

更新脏布局

返回
是否需要更新