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

文本布局 更多...

#include <TextLayout.h>

类 kiwano::TextLayout 继承关系图:
kiwano::NativeObject kiwano::ObjectBase kiwano::RefObject kiwano::Serializable kiwano::Noncopyable

Public 类型

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

Public 成员函数

 TextLayout (StringView content, const TextStyle &style)
 创建文本布局 更多...
 
bool IsDirty () const
 文本布局是否陈旧
 
void Clear ()
 清空文本布局
 
void Reset (StringView content, const TextStyle &style)
 重设文本布局 更多...
 
Size GetSize () const
 获取文本布局大小
 
uint32_t GetLineCount () const
 获取文本行数
 
uint32_t GetContentLength () const
 获取文本长度
 
void SetFont (RefPtr< Font > font)
 设置字体 更多...
 
void SetUnderline (bool enable)
 设置下划线 更多...
 
void SetStrikethrough (bool enable)
 设置删除线 更多...
 
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::NativeObject
const AnyGetNative () const
 
template<class _Ty >
_Ty GetNative () const
 
void SetNative (const Any &native)
 
void ResetNative ()
 
bool IsValid () const override
 判断对象是否有效 更多...
 
- Public 成员函数 继承自 kiwano::ObjectBase
 ObjectBase ()
 构造基础对象
 
void SetName (StringView name)
 设置对象名
 
StringView GetName () const
 获取对象名
 
bool IsName (StringView name) const
 判断对象的名称是否相同 更多...
 
void * GetUserData () const
 获取用户数据
 
void SetUserData (void *data)
 设置用户数据 更多...
 
void Hold (RefPtr< ObjectBase > other)
 持有一个对象并管理其生命周期 更多...
 
void Unhold (RefPtr< ObjectBase > other)
 放弃持有的对象 更多...
 
uint64_t GetObjectID () const
 获取对象ID
 
void DoSerialize (Serializer *serializer) const override
 序列化 更多...
 
void DoDeserialize (Deserializer *deserializer) override
 反序列化 更多...
 
virtual bool IsValid () const
 判断对象是否有效 更多...
 
ObjectStatusGetStatus () const
 获取对象状态
 
void SetStatus (const ObjectStatus &status)
 设置对象状态
 
void Fail (StringView 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)
 从字节串反序列化
 
virtual void DoSerialize (Serializer *serializer) const =0
 执行序列化 更多...
 
virtual void DoDeserialize (Deserializer *deserializer)=0
 执行反序列化 更多...
 

额外继承的成员函数

- 静态 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::NativeObject
Any native_
 

详细描述

文本布局

成员枚举类型说明

◆ DirtyFlag

enum class kiwano::TextLayout::DirtyFlag : uint8_t
strong

脏布局标志

枚举值
Clean 

干净布局

Dirty 

脏布局

构造及析构函数说明

◆ TextLayout()

kiwano::TextLayout::TextLayout ( StringView  content,
const TextStyle style 
)

创建文本布局

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

成员函数说明

◆ Reset()

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

重设文本布局

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

◆ SetAlignment()

void kiwano::TextLayout::SetAlignment ( TextAlign  align)

设置对齐方式

参数
align对齐方式

◆ SetFont()

void kiwano::TextLayout::SetFont ( RefPtr< Font font)

设置字体

参数
font字体

◆ SetStrikethrough()

void kiwano::TextLayout::SetStrikethrough ( bool  enable)

设置删除线

参数
enable是否显示删除线

◆ SetUnderline()

void kiwano::TextLayout::SetUnderline ( bool  enable)

设置下划线

参数
enable是否显示下划线

◆ UpdateIfDirty()

bool kiwano::TextLayout::UpdateIfDirty ( )

更新脏布局

返回
是否需要更新