awtk/docs/manual/object_array_t.md

130 lines
3.3 KiB
Markdown
Raw Normal View History

2019-09-30 17:11:53 +08:00
## object\_array\_t
### 概述
![image](images/object_array_t_0.png)
2019-12-11 16:21:15 +08:00
简单的动态数组内部存放value对象。 访问时属性名称为: * "size"/"length" 用于获取数组的长度。 * index 用于访问属性,-1可以用来追加新元素。
2019-09-30 17:11:53 +08:00
----------------------------------
### 函数
<p id="object_array_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
2019-11-15 11:33:43 +08:00
| <a href="#object_array_t_object_array_clear_props">object\_array\_clear\_props</a> | 清除全部属性。 |
| <a href="#object_array_t_object_array_create">object\_array\_create</a> | 创建对象。 |
| <a href="#object_array_t_object_array_create">object\_array\_create</a> | 克隆对象。 |
| <a href="#object_array_t_object_array_unref">object\_array\_unref</a> | for script gc |
2019-09-30 17:11:53 +08:00
### 属性
<p id="object_array_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#object_array_t_props">props</a> | value\_t | 属性数组。 |
| <a href="#object_array_t_props_capacity">props\_capacity</a> | uint32\_t | 属性数组的容量。 |
| <a href="#object_array_t_props_size">props\_size</a> | uint32\_t | 属性个数。 |
#### object\_array\_clear\_props 函数
-----------------------
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="object_array_t_object_array_clear_props">清除全部属性。
2019-10-16 09:02:32 +08:00
2019-09-30 17:11:53 +08:00
* 函数原型:
```
ret_t object_array_clear_props (object_t* obj);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| obj | object\_t* | 对象。 |
#### object\_array\_create 函数
-----------------------
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="object_array_t_object_array_create">创建对象。
2019-10-16 09:02:32 +08:00
2019-09-30 17:11:53 +08:00
* 函数原型:
```
object_t* object_array_create ();
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | object\_t* | 返回object对象。 |
#### object\_array\_create 函数
-----------------------
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="object_array_t_object_array_create">克隆对象。
2019-10-16 09:02:32 +08:00
2019-09-30 17:11:53 +08:00
* 函数原型:
```
object_t* object_array_create (object_array_t* o);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | object\_t* | 返回object对象。 |
| o | object\_array\_t* | 被克隆的对象。 |
#### object\_array\_unref 函数
-----------------------
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="object_array_t_object_array_unref">for script gc
2019-10-16 09:02:32 +08:00
2019-09-30 17:11:53 +08:00
* 函数原型:
```
ret_t object_array_unref (object_t* obj);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| obj | object\_t* | 对象。 |
#### props 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="object_array_t_props">属性数组。
2019-10-16 09:02:32 +08:00
2019-09-30 17:11:53 +08:00
* 类型value\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
#### props\_capacity 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="object_array_t_props_capacity">属性数组的容量。
2019-10-16 09:02:32 +08:00
2019-09-30 17:11:53 +08:00
* 类型uint32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
#### props\_size 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="object_array_t_props_size">属性个数。
2019-10-16 09:02:32 +08:00
2019-09-30 17:11:53 +08:00
* 类型uint32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |