test/awtk
1
0
Fork 0
mirror of https://gitee.com/zlgopen/awtk.git synced 2024-12-01 11:39:01 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
11390f0869
awtk/docs/manual/object_t.md
xianjimli c831bfed8b update docs
2019-12-14 13:25:56 +08:00

24 KiB
Raw Blame History

object_t

概述

image

对象接口。

函数

函数名称 说明
object_can_exec 检查是否可以执行指定的命令。
object_compare 比较两个对象。
object_copy_prop 拷贝指定的属性。
object_create 创建对象。
object_eval 计算一个表达式，表达式中引用的变量从prop中获取。
object_exec 执行指定的命令。
object_foreach_prop 遍历所有属性。
object_get_desc 获取对象的描述信息。
object_get_prop 获取指定属性的值。
object_get_prop_bool 获取指定属性的bool类型的值。
object_get_prop_bool_by_path 获取指定属性的bool类型的值。
object_get_prop_by_path 获取指定path属性的值。
object_get_prop_float 获取指定属性的浮点数类型的值。
object_get_prop_float_by_path 获取指定属性的浮点数类型的值。
object_get_prop_int 获取指定属性的整数类型的值。
object_get_prop_int_by_path 获取指定属性的整数类型的值。
object_get_prop_object 获取指定属性的object类型的值。
object_get_prop_object_by_path 获取指定属性的object类型的值。
object_get_prop_pointer 获取指定属性的指针类型的值。
object_get_prop_pointer_by_path 获取指定属性的指针类型的值。
object_get_prop_str 获取指定属性的字符串类型的值。
object_get_prop_str_by_path 获取指定属性的字符串类型的值。
object_get_size 获取对象占用内存的大小。
object_get_type 获取对象的类型名称。
object_has_prop 检查是否存在指定的属性。
object_is_collection 判断对象是否是集合。
object_notify_changed 触发EVT_PROPS_CHANGED事件。
object_ref 引用计数加1。
object_remove_prop 删除指定属性。
object_set_name 设置对象的名称。
object_set_prop 设置指定属性的值。
object_set_prop_bool 设置指定属性的bool类型的值。
object_set_prop_float 设置指定属性的浮点数类型的值。
object_set_prop_int 设置指定属性的整数类型的值。
object_set_prop_object 设置指定属性的object类型的值。
object_set_prop_pointer 设置指定属性的指针类型的值。
object_set_prop_str 设置指定属性的字符串类型的值。
object_unref 引用计数减1。引用计数为0时，销毁对象。

属性

属性名称 类型 说明
name char* 对象的名称。
ref_count int32_t 引用计数。

object_can_exec 函数

  • 函数功能：

检查是否可以执行指定的命令。

  • 函数原型：
bool_t object_can_exec (object_t* obj, const char* name, const char* args);
  • 参数说明：
参数 类型 说明
返回值 bool_t 返回TRUE表示可以执行，否则表示不可以执行。
obj object_t* object对象。
name const char* 命令的名称。
args const char* 命令的参数。

object_compare 函数

  • 函数功能：

比较两个对象。

  • 函数原型：
int object_compare (object_t* obj, object_t* other);
  • 参数说明：
参数 类型 说明
返回值 int 返回比较结果。
obj object_t* object对象。
other object_t* 比较的object对象。

object_copy_prop 函数

  • 函数功能：

拷贝指定的属性。

  • 函数原型：
ret_t object_copy_prop (object_t* obj, object_t* src, const char* name);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* 目标对象。
src object_t* 源对象。
name const char* 属性的名称。

object_create 函数

  • 函数功能：

创建对象。

仅供子类调用。

  • 函数原型：
ret_t object_create (const object_vtable_t* vt);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回object对象。
vt const object_vtable_t* 虚函数表。

object_eval 函数

  • 函数功能：

计算一个表达式，表达式中引用的变量从prop中获取。

  • 函数原型：
ret_t object_eval (object_t* obj, const char* expr, value_t* v);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* object对象。
expr const char* 表达式。
v value_t* 返回计算结果。

object_exec 函数

  • 函数功能：

执行指定的命令。

  • 函数原型：
ret_t object_exec (object_t* obj, const char* name, const char* args);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* object对象。
name const char* 命令的名称。
args const char* 命令的参数。

object_foreach_prop 函数

  • 函数功能：

遍历所有属性。

  • 函数原型：
ret_t object_foreach_prop (object_t* obj, tk_visit_t on_prop, void* ctx);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* object对象。
on_prop tk_visit_t 回调函数。
ctx void* 回调函数上下文。

object_get_desc 函数

  • 函数功能：

获取对象的描述信息。

  • 函数原型：
const char* object_get_desc (object_t* obj);
  • 参数说明：
参数 类型 说明
返回值 const char* 返回对象的描述信息。
obj object_t* object对象。

object_get_prop 函数

  • 函数功能：

获取指定属性的值。

  • 函数原型：
ret_t object_get_prop (object_t* obj, const char* name, value_t* v);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* object对象。
name const char* 属性的名称。
v value_t* 返回属性的值。

object_get_prop_bool 函数

  • 函数功能：

获取指定属性的bool类型的值。

  • 函数原型：
bool_t object_get_prop_bool (object_t* obj, const char* name, bool_t defval);
  • 参数说明：
参数 类型 说明
返回值 bool_t 返回指定属性的bool类型的值。
obj object_t* object对象。
name const char* 属性的名称。
defval bool_t 缺省值。

object_get_prop_bool_by_path 函数

  • 函数功能：

获取指定属性的bool类型的值。

  • 函数原型：
bool_t object_get_prop_bool_by_path (object_t* obj, const char* path, bool_t defval);
  • 参数说明：
参数 类型 说明
返回值 bool_t 返回指定属性的bool类型的值。
obj object_t* object对象。
path const char* 属性的path。
defval bool_t 缺省值。

object_get_prop_by_path 函数

  • 函数功能：

获取指定path属性的值。

  • 函数原型：
ret_t object_get_prop_by_path (object_t* obj, const char* path, value_t* v);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* object对象。
path const char* 属性的path，各级之间用.分隔。
v value_t* 返回属性的值。

object_get_prop_float 函数

  • 函数功能：

获取指定属性的浮点数类型的值。

  • 函数原型：
float_t object_get_prop_float (object_t* obj, const char* name, float_t defval);
  • 参数说明：
参数 类型 说明
返回值 float_t 返回指定属性的浮点数类型的值。
obj object_t* object对象。
name const char* 属性的名称。
defval float_t 缺省值。

object_get_prop_float_by_path 函数

  • 函数功能：

获取指定属性的浮点数类型的值。

  • 函数原型：
float_t object_get_prop_float_by_path (object_t* obj, const char* path, float_t defval);
  • 参数说明：
参数 类型 说明
返回值 float_t 返回指定属性的浮点数类型的值。
obj object_t* object对象。
path const char* 属性的path。
defval float_t 缺省值。

object_get_prop_int 函数

  • 函数功能：

获取指定属性的整数类型的值。

  • 函数原型：
int32_t object_get_prop_int (object_t* obj, const char* name, int32_t defval);
  • 参数说明：
参数 类型 说明
返回值 int32_t 返回指定属性的整数类型的值。
obj object_t* object对象。
name const char* 属性的名称。
defval int32_t 缺省值。

object_get_prop_int_by_path 函数

  • 函数功能：

获取指定属性的整数类型的值。

  • 函数原型：
int32_t object_get_prop_int_by_path (object_t* obj, const char* path, int32_t defval);
  • 参数说明：
参数 类型 说明
返回值 int32_t 返回指定属性的整数类型的值。
obj object_t* object对象。
path const char* 属性的path。
defval int32_t 缺省值。

object_get_prop_object 函数

  • 函数功能：

获取指定属性的object类型的值。

  • 函数原型：
object_t* object_get_prop_object (object_t* obj, const char* name);
  • 参数说明：
参数 类型 说明
返回值 object_t* 返回指定属性的object类型的值。
obj object_t* object对象。
name const char* 属性的名称。

object_get_prop_object_by_path 函数

  • 函数功能：

获取指定属性的object类型的值。

  • 函数原型：
object_t* object_get_prop_object_by_path (object_t* obj, const char* path);
  • 参数说明：
参数 类型 说明
返回值 object_t* 返回指定属性的object类型的值。
obj object_t* object对象。
path const char* 属性的path。

object_get_prop_pointer 函数

  • 函数功能：

获取指定属性的指针类型的值。

  • 函数原型：
void* object_get_prop_pointer (object_t* obj, const char* name);
  • 参数说明：
参数 类型 说明
返回值 void* 返回指定属性的指针类型的值。
obj object_t* object对象。
name const char* 属性的名称。

object_get_prop_pointer_by_path 函数

  • 函数功能：

获取指定属性的指针类型的值。

  • 函数原型：
void* object_get_prop_pointer_by_path (object_t* obj, const char* path);
  • 参数说明：
参数 类型 说明
返回值 void* 返回指定属性的指针类型的值。
obj object_t* object对象。
path const char* 属性的path。

object_get_prop_str 函数

  • 函数功能：

获取指定属性的字符串类型的值。

  • 函数原型：
const char* object_get_prop_str (object_t* obj, const char* name);
  • 参数说明：
参数 类型 说明
返回值 const char* 返回指定属性的字符串类型的值。
obj object_t* object对象。
name const char* 属性的名称。

object_get_prop_str_by_path 函数

  • 函数功能：

获取指定属性的字符串类型的值。

  • 函数原型：
const char* object_get_prop_str_by_path (object_t* obj, const char* path);
  • 参数说明：
参数 类型 说明
返回值 const char* 返回指定属性的字符串类型的值。
obj object_t* object对象。
path const char* 属性的path。

object_get_size 函数

  • 函数功能：

获取对象占用内存的大小。

  • 函数原型：
uint32_t object_get_size (object_t* obj);
  • 参数说明：
参数 类型 说明
返回值 uint32_t 返回对象占用内存的大小。
obj object_t* object对象。

object_get_type 函数

  • 函数功能：

获取对象的类型名称。

  • 函数原型：
const char* object_get_type (object_t* obj);
  • 参数说明：
参数 类型 说明
返回值 const char* 返回对象的类型名称。
obj object_t* object对象。

object_has_prop 函数

  • 函数功能：

检查是否存在指定的属性。

  • 函数原型：
bool_t object_has_prop (object_t* obj, const char* name);
  • 参数说明：
参数 类型 说明
返回值 bool_t 返回TRUE表示存在，否则表示不存在。
obj object_t* object对象。
name const char* 属性的名称。

object_is_collection 函数

  • 函数功能：

判断对象是否是集合。

  • 函数原型：
bool_t object_is_collection (object_t* obj);
  • 参数说明：
参数 类型 说明
返回值 bool_t 返回TRUE表示是集合，否则不是。
obj object_t* object对象。

object_notify_changed 函数

  • 函数功能：

触发EVT_PROPS_CHANGED事件。

  • 函数原型：
ret_t object_notify_changed (object_t* obj);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* object对象。

object_ref 函数

  • 函数功能：

引用计数加1。

  • 函数原型：
object_t* object_ref (object_t* obj);
  • 参数说明：
参数 类型 说明
返回值 object_t* 返回object对象。
obj object_t* object对象。

object_remove_prop 函数

  • 函数功能：

删除指定属性。

  • 函数原型：
ret_t object_remove_prop (object_t* obj, const char* name);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* object对象。
name const char* 属性的名称。

object_set_name 函数

  • 函数功能：

设置对象的名称。

  • 函数原型：
ret_t object_set_name (object_t* obj, const char* name);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* object对象。
name const char* 对象的名称。

object_set_prop 函数

  • 函数功能：

设置指定属性的值。

  • 函数原型：
ret_t object_set_prop (object_t* obj, const char* name, value_t* value);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* object对象。
name const char* 属性的名称。
value value_t* 属性的值。

object_set_prop_bool 函数

  • 函数功能：

设置指定属性的bool类型的值。

  • 函数原型：
ret_t object_set_prop_bool (object_t* obj, const char* name, bool_t value);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* object对象。
name const char* 属性的名称。
value bool_t 属性的值。

object_set_prop_float 函数

  • 函数功能：

设置指定属性的浮点数类型的值。

  • 函数原型：
ret_t object_set_prop_float (object_t* obj, const char* name, float_t value);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* object对象。
name const char* 属性的名称。
value float_t 属性的值。

object_set_prop_int 函数

  • 函数功能：

设置指定属性的整数类型的值。

  • 函数原型：
ret_t object_set_prop_int (object_t* obj, const char* name, int32_t value);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* object对象。
name const char* 属性的名称。
value int32_t 属性的值。

object_set_prop_object 函数

  • 函数功能：

设置指定属性的object类型的值。

  • 函数原型：
ret_t object_set_prop_object (object_t* obj, const char* name, object_t* value);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* object对象。
name const char* 属性的名称。
value object_t* 属性的值。

object_set_prop_pointer 函数

  • 函数功能：

设置指定属性的指针类型的值。

  • 函数原型：
ret_t object_set_prop_pointer (object_t* obj, const char* name, void* value);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* object对象。
name const char* 属性的名称。
value void* 属性的值。

object_set_prop_str 函数

  • 函数功能：

设置指定属性的字符串类型的值。

  • 函数原型：
ret_t object_set_prop_str (object_t* obj, const char* name, const char* value);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* object对象。
name const char* 属性的名称。
value const char* 属性的值。

object_unref 函数

  • 函数功能：

引用计数减1。引用计数为0时，销毁对象。

  • 函数原型：
ret_t object_unref (object_t* obj);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
obj object_t* object对象。

name 属性

对象的名称。

  • 类型：char*
特性 是否支持
可直接读取 是
可直接修改 否
可脚本化 是

ref_count 属性

引用计数。

  • 类型：int32_t
特性 是否支持
可直接读取 是
可直接修改 否
可脚本化 是