mirror of
https://gitee.com/zlgopen/awtk.git
synced 2024-12-02 03:58:33 +08:00
update docs
This commit is contained in:
xianjimli
parent
a289290c2e
commit
8fb43364f7
@ -5,7 +5,7 @@
|
||||
按钮控件。
|
||||
|
||||
点击按钮之后会触发EVT\_CLICK事件，注册EVT\_CLICK事件以执行特定操作。
|
||||
|
||||
|
||||
按钮控件也可以作为容器使用，使用图片和文本作为其子控件，可以实现很多有趣的效果。
|
||||
|
||||
button\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于button\_t控件。
|
||||
@ -16,7 +16,8 @@
|
||||
<button x="c" y="m" w="80" h="30" text="OK"/>
|
||||
```
|
||||
|
||||
> 更多用法请参考：[button.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/button.xml)
|
||||
>
|
||||
更多用法请参考：[button.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/button.xml)
|
||||
|
||||
在c代码中使用函数button\_create创建按钮控件。如：
|
||||
|
||||
@ -28,7 +29,8 @@
|
||||
|
||||
> 创建之后，需要用widget\_set\_text或widget\_set\_text\_utf8设置文本内容。
|
||||
|
||||
> 完整示例请参考：[button demo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/button.c)
|
||||
> 完整示例请参考：[button
|
||||
demo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/button.c)
|
||||
|
||||
可用通过style来设置控件的显示风格，如字体的大小和颜色等等。如：
|
||||
|
||||
@ -40,8 +42,9 @@
|
||||
<disable bg_color="gray" text_color="#d0d0d0" />
|
||||
</style>
|
||||
```
|
||||
|
||||
> 更多用法请参考：[theme default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L31)
|
||||
|
||||
> 更多用法请参考：[theme
|
||||
default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L31)
|
||||
|
||||
### 函数
|
||||
<p id="button_t_methods">
|
||||
|
||||
@ -2,7 +2,74 @@
|
||||
### 概述
|
||||
|
||||
|
||||
combobox控件。
|
||||
下拉列表控件。
|
||||
|
||||
点击右边的按钮，可弹出一个下拉列表，从中选择一项作为当前的值。
|
||||
|
||||
combo\_box\_t是[edit\_t](edit_t.md)的子类控件，edit\_t的函数均适用于combo\_box\_t控件。
|
||||
|
||||
在xml中使用"combo_box"标签创建下拉列表控件。
|
||||
|
||||
列表选项可以直接写在"options"属性中。如：
|
||||
|
||||
```xml
|
||||
<combo_box readonly="true" x="10" y="bottom:5" w="200" h="30" tr_text="ok" options="1:ok;2:cancel;"/>
|
||||
```
|
||||
|
||||
列表选项也可以放在独立的窗口中，用属性"open_window"指定窗口的名称。如：
|
||||
|
||||
```xml
|
||||
<combo_box open_window="language" readonly="true" x="10" y="bottom:50" w="200" h="30" tr_text="english"/>
|
||||
```
|
||||
|
||||
language.xml:
|
||||
|
||||
```xml
|
||||
<popup close_when_click_outside="true" h="80" >
|
||||
<list_view x="0" y="0" w="100%" h="100%" item_height="30">
|
||||
<scroll_view name="view" x="0" y="0" w="-12" h="100%">
|
||||
<combo_box_item tr_text="english"/>
|
||||
<combo_box_item tr_text="chinese" />
|
||||
</scroll_view>
|
||||
<scroll_bar_d name="bar" x="right" y="0" w="12" h="100%" value="0"/>
|
||||
</list_view>
|
||||
</popup>
|
||||
```
|
||||
|
||||
>
|
||||
更多用法请参考：[combo_box.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/combo_box.xml)
|
||||
|
||||
在c代码中使用函数combo\_box\_create创建下拉列表控件。如：
|
||||
|
||||
```c
|
||||
widget_t* combo_box = combo_box_create(win, 10, 10, 128, 30);
|
||||
|
||||
combo_box_set_options(combo_box, "left;center;right;");
|
||||
combo_box_set_selected_index(combo_box, 1);
|
||||
|
||||
```
|
||||
|
||||
创建之后：
|
||||
|
||||
* 用combo\_box\_set\_options设置可选项目。
|
||||
* 用combo\_box\_set\_selected\_index设置缺省项。
|
||||
|
||||
> 完整示例请参考：[combo_box demo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/combo_box.c)
|
||||
|
||||
可用通过style来设置控件的显示风格，如字体的大小和颜色等等。如：
|
||||
|
||||
```xml
|
||||
<combo_box>
|
||||
<style name="default" border_color="#a0a0a0" text_color="black" text_align_h="left">
|
||||
<normal bg_color="#f0f0f0" />
|
||||
<focused bg_color="#f0f0f0" border_color="black"/>
|
||||
<empty bg_color="#f0f0f0" text_color="#a0a0a0" />
|
||||
</style>
|
||||
</combo_box>
|
||||
```
|
||||
|
||||
> 更多用法请参考：[theme default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L422)
|
||||
|
||||
### 函数
|
||||
<p id="combo_box_t_methods">
|
||||
|
||||
|
||||
@ -2,7 +2,11 @@
|
||||
### 概述
|
||||
|
||||
|
||||
**单行编辑器控件。**
|
||||
单行编辑器控件。
|
||||
|
||||
在基于SDL的平台，单行编辑器控件使用平台原生的输入法，对于嵌入式平台使用内置的输入法。
|
||||
|
||||
在使用内置的输入法时，软键盘由输入类型决定，开发者可以自定义软键盘的界面。
|
||||
|
||||
edit\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于edit\_t控件。
|
||||
|
||||
@ -11,16 +15,18 @@
|
||||
* 名为"inc"的按钮。点击时增加编辑器的值，用于实现类似于spinbox的功能。
|
||||
* 名为"dec"的按钮。点击时减少编辑器的值，用于实现类似于spinbox的功能。
|
||||
* 名为"clear"的按钮。点击时清除编辑器中的内容。
|
||||
|
||||
|
||||
在xml中使用"edit"标签创建编辑器控件。如：
|
||||
|
||||
```xml
|
||||
<edit x="c" y="m" w="80" h="30"
|
||||
<edit x="c" y="m" w="80" h="30"
|
||||
tips="age" input_type="uint" min="0" max="150" step="1" auto_fix="true" style="number" />
|
||||
```
|
||||
|
||||
> 更多用法请参考：[edit.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/edit.xml)
|
||||
> XXX：需要在min/max/step之前设置input\_type。
|
||||
|
||||
>
|
||||
更多用法请参考：[edit.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/edit.xml)
|
||||
|
||||
在c代码中使用函数edit\_create创建编辑器控件。如：
|
||||
|
||||
@ -44,8 +50,9 @@
|
||||
<empty bg_color="#f0f0f0" text_color="#a0a0a0" />
|
||||
</style>
|
||||
```
|
||||
|
||||
> 更多用法请参考：[theme default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L104)
|
||||
|
||||
> 更多用法请参考：[theme
|
||||
default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L104)
|
||||
|
||||
### 函数
|
||||
<p id="edit_t_methods">
|
||||
@ -75,12 +82,12 @@
|
||||
| <a href="#edit_t_bottom_margin">bottom\_margin</a> | uint8\_t | 下边距。 |
|
||||
| <a href="#edit_t_input_type">input\_type</a> | input\_type\_t | 输入类型。 |
|
||||
| <a href="#edit_t_left_margin">left\_margin</a> | uint8\_t | 左边距。 |
|
||||
| <a href="#edit_t_max">max</a> | char* | 最大值或最大长度。 |
|
||||
| <a href="#edit_t_min">min</a> | char* | 最小值或最小长度。 |
|
||||
| <a href="#edit_t_max">max</a> | float\_t | 最大值或最大长度。 |
|
||||
| <a href="#edit_t_min">min</a> | float\_t | 最小值或最小长度。 |
|
||||
| <a href="#edit_t_password_visible">password\_visible</a> | bool\_t | 密码是否可见。 |
|
||||
| <a href="#edit_t_readonly">readonly</a> | bool\_t | 编辑器是否为只读。 |
|
||||
| <a href="#edit_t_right_margin">right\_margin</a> | uint8\_t | 右边距。 |
|
||||
| <a href="#edit_t_step">step</a> | char* | 步长。 |
|
||||
| <a href="#edit_t_step">step</a> | float\_t | 步长。 |
|
||||
| <a href="#edit_t_tips">tips</a> | char* | 输入提示。 |
|
||||
| <a href="#edit_t_top_margin">top\_margin</a> | uint8\_t | 上边距。 |
|
||||
### 事件
|
||||
@ -477,7 +484,7 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);
|
||||
> <p id="edit_t_max"> 最大值或最大长度。
|
||||
|
||||
|
||||
* 类型：char*
|
||||
* 类型：float\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
@ -494,7 +501,7 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);
|
||||
> <p id="edit_t_min"> 最小值或最小长度。
|
||||
|
||||
|
||||
* 类型：char*
|
||||
* 类型：float\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
@ -563,7 +570,7 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);
|
||||
作为数值型编辑器时，一次增加和减少时的数值。
|
||||
|
||||
|
||||
* 类型：char*
|
||||
* 类型：float\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
|
||||
@ -22,7 +22,8 @@
|
||||
<image style="border" image="earth" draw_type="icon" />
|
||||
```
|
||||
|
||||
> 更多用法请参考：[image.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/images.xml)
|
||||
>
|
||||
更多用法请参考：[image.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/images.xml)
|
||||
|
||||
在c代码中使用函数image\_create创建图片控件。如：
|
||||
|
||||
@ -39,7 +40,8 @@
|
||||
|
||||
> 绘制方式请参考[image\_draw\_type\_t](image_draw_type_t.md)
|
||||
|
||||
> 绘制方式的属性值和枚举值[image\_draw\_type\_name\_value](https://github.com/zlgopen/awtk/blob/master/src/base/enums.c#L98)
|
||||
>
|
||||
绘制方式的属性值和枚举值[image\_draw\_type\_name\_value](https://github.com/zlgopen/awtk/blob/master/src/base/enums.c#L98)
|
||||
|
||||
> 完整示例请参考：[image demo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/image.c)
|
||||
|
||||
@ -52,8 +54,9 @@
|
||||
</style>
|
||||
</image>
|
||||
```
|
||||
|
||||
> 更多用法请参考：[theme default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L313)
|
||||
|
||||
> 更多用法请参考：[theme
|
||||
default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L313)
|
||||
|
||||
### 函数
|
||||
<p id="image_t_methods">
|
||||
|
||||
@ -17,7 +17,8 @@
|
||||
<label style="center" text="center"/>
|
||||
```
|
||||
|
||||
> 更多用法请参考：[label.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/label.xml)
|
||||
>
|
||||
更多用法请参考：[label.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/label.xml)
|
||||
|
||||
在c代码中使用函数label\_create创建文本控件。如：
|
||||
|
||||
@ -37,8 +38,9 @@
|
||||
<normal text_color="red" text_align_h="left" border_color="#a0a0a0" margin="4" />
|
||||
</style>
|
||||
```
|
||||
|
||||
> 更多用法请参考：[theme default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L144)
|
||||
|
||||
> 更多用法请参考：[theme
|
||||
default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L144)
|
||||
|
||||
### 函数
|
||||
<p id="label_t_methods">
|
||||
|
||||
@ -3,6 +3,54 @@
|
||||
|
||||
|
||||
spinbox控件。
|
||||
|
||||
一个特殊的数值编辑器，将edit\_t和button\_t进行组合，方便编辑数值。
|
||||
|
||||
点击向上的按钮将数值增加一个step，点击向下的按钮将数值减小一个step。
|
||||
step的值可以通过step属性进行设置。
|
||||
|
||||
spin_box\_t是[edit\_t](edit_t.md)的子类控件，edit\_t的函数均适用于spin\_box\_t控件。
|
||||
|
||||
在xml中使用"spin_box"标签创建spinbox控件。如：
|
||||
|
||||
```xml
|
||||
<spin_box w="70%" input_type="int" min="-100" max="100" step="5">
|
||||
```
|
||||
|
||||
>
|
||||
更多用法请参考：[spin_box.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/spinbox.xml)
|
||||
|
||||
在c代码中使用函数spin_box\_create创建spinbox控件。如：
|
||||
|
||||
```c
|
||||
widget_t* spin_box = spin_box_create(win, 10, 10, 128, 30);
|
||||
edit_set_input_type(spin_box, type);
|
||||
```
|
||||
|
||||
> 创建之后:
|
||||
>
|
||||
> 可以用edit相关函数去设置它的各种属性。
|
||||
|
||||
> 完整示例请参考：[spin_box
|
||||
demo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/spin_box.c)
|
||||
|
||||
可用通过style来设置控件的显示风格，如背景和边框等。如：
|
||||
|
||||
```xml
|
||||
<spin_box>
|
||||
<style name="default" border_color="#a0a0a0" text_color="black" text_align_h="left">
|
||||
<normal bg_color="#f0f0f0" />
|
||||
<focused bg_color="#f0f0f0" border_color="black"/>
|
||||
<disable bg_color="gray" text_color="#d0d0d0" />
|
||||
<error bg_color="#f0f0f0" text_color="red" />
|
||||
<empty bg_color="#f0f0f0" text_color="#a0a0a0" />
|
||||
</style>
|
||||
</spin_box>
|
||||
```
|
||||
|
||||
> 更多用法请参考：[theme
|
||||
default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L128)
|
||||
|
||||
### 函数
|
||||
<p id="spin_box_t_methods">
|
||||
|
||||
|
||||
@ -48,8 +48,9 @@
|
||||
| <a href="#widget_t_widget_equal">widget\_equal</a> | 判断两个widget是否相同。 |
|
||||
| <a href="#widget_t_widget_foreach">widget\_foreach</a> | 遍历当前控件及子控件。 |
|
||||
| <a href="#widget_t_widget_get_child">widget\_get\_child</a> | 获取指定索引的子控件。 |
|
||||
| <a href="#widget_t_widget_get_prop">widget\_get\_prop</a> | 通用的获取控件属性的函数。 |
|
||||
| <a href="#widget_t_widget_get_prop">widget\_get\_prop</a> | 获取控件指定属性的值。 |
|
||||
| <a href="#widget_t_widget_get_prop_bool">widget\_get\_prop\_bool</a> | 获取布尔格式的属性。 |
|
||||
| <a href="#widget_t_widget_get_prop_default_value">widget\_get\_prop\_default\_value</a> | 获取控件指定属性的缺省值(在持久化控件时，无需保存缺省值)。 |
|
||||
| <a href="#widget_t_widget_get_prop_int">widget\_get\_prop\_int</a> | 获取整数格式的属性。 |
|
||||
| <a href="#widget_t_widget_get_prop_str">widget\_get\_prop\_str</a> | 获取字符串格式的属性。 |
|
||||
| <a href="#widget_t_widget_get_text">widget\_get\_text</a> | 获取控件的文本。 |
|
||||
@ -87,7 +88,7 @@
|
||||
| <a href="#widget_t_widget_set_focused">widget\_set\_focused</a> | 设置控件的是否聚焦。 |
|
||||
| <a href="#widget_t_widget_set_name">widget\_set\_name</a> | 设置控件的名称。 |
|
||||
| <a href="#widget_t_widget_set_opacity">widget\_set\_opacity</a> | 设置控件的不透明度。 |
|
||||
| <a href="#widget_t_widget_set_prop">widget\_set\_prop</a> | 通用的设置控件属性的函数。 |
|
||||
| <a href="#widget_t_widget_set_prop">widget\_set\_prop</a> | 设置控件指定属性的值。 |
|
||||
| <a href="#widget_t_widget_set_prop_bool">widget\_set\_prop\_bool</a> | 设置布尔格式的属性。 |
|
||||
| <a href="#widget_t_widget_set_prop_int">widget\_set\_prop\_int</a> | 设置整数格式的属性。 |
|
||||
| <a href="#widget_t_widget_set_prop_str">widget\_set\_prop\_str</a> | 设置字符串格式的属性。 |
|
||||
@ -575,7 +576,7 @@ widget_t* widget_get_child (widget_t* widget, int32_t index);
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_t_widget_get_prop"> 通用的获取控件属性的函数。
|
||||
> <p id="widget_t_widget_get_prop"> 获取控件指定属性的值。
|
||||
|
||||
|
||||
|
||||
@ -593,7 +594,7 @@ ret_t widget_get_prop (widget_t* widget, const char* name, value_t* v);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| v | value\_t* | 属性的值。 |
|
||||
| v | value\_t* | 返回属性的值。 |
|
||||
#### widget\_get\_prop\_bool 函数
|
||||
-----------------------
|
||||
|
||||
@ -618,6 +619,30 @@ bool_t widget_get_prop_bool (widget_t* widget, const char* name, bool_t defval);
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| defval | bool\_t | 缺省值。 |
|
||||
#### widget\_get\_prop\_default\_value 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_t_widget_get_prop_default_value"> 获取控件指定属性的缺省值(在持久化控件时，无需保存缺省值)。
|
||||
|
||||
|
||||
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t widget_get_prop_default_value (widget_t* widget, const char* name, value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| v | value\_t* | 返回属性的缺省值。 |
|
||||
#### widget\_get\_prop\_int 函数
|
||||
-----------------------
|
||||
|
||||
@ -1524,7 +1549,7 @@ ret_t widget_set_opacity (widget_t* widget, uint8_t opacity);
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_t_widget_set_prop"> 通用的设置控件属性的函数。
|
||||
> <p id="widget_t_widget_set_prop"> 设置控件指定属性的值。
|
||||
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user