awtk/docs/manual/svg_image_t.md
2020-08-16 09:10:01 +08:00

115 lines
3.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## svg\_image\_t
### 概述
![image](images/svg_image_t_0.png)
SVG图片控件。
svg\_image\_t是[image\_base\_t](image_base_t.md)的子类控件image\_base\_t的函数均适用于svg\_image\_t控件。
在xml中使用"svg"标签创建SVG图片控件。如
```xml
<svg image="girl"/>
```
>更多用法请参考:[svg image](
https://github.com/zlgopen/awtk/blob/master/design/default/ui/svg_image.xml)
在c代码中使用函数svg\_image\_create创建SVG图片控件。如
```c
widget_t* image = svg_image_create(win, 10, 10, 200, 200);
image_set_image(image, "girl");
```
> 创建之后: 需要用widget\_set\_image设置图片名称。
> 完整示例请参考:[svg image demo](
https://github.com/zlgopen/awtk-c-demos/blob/master/demos/svg_image.c)
可用通过style来设置控件的显示风格如背景和边框等。如
```xml
<svg>
<style name="default">
<normal border_color="green" fg_color="red" />
</style>
</svg>
```
> 更多用法请参考:[theme default](
https://github.com/zlgopen/awtk/blob/master/design/default/styles/default.xml)
----------------------------------
### 函数
<p id="svg_image_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#svg_image_t_svg_image_cast">svg\_image\_cast</a> | 转换为svg_image对象(供脚本语言使用)。 |
| <a href="#svg_image_t_svg_image_create">svg\_image\_create</a> | 创建svg_image对象 |
| <a href="#svg_image_t_svg_image_set_image">svg\_image\_set\_image</a> | 设置控件的图片名称。 |
#### svg\_image\_cast 函数
-----------------------
* 函数功能:
> <p id="svg_image_t_svg_image_cast">转换为svg_image对象(供脚本语言使用)。
* 函数原型:
```
widget_t* svg_image_cast (widget_t* widget);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | svg\_image对象。 |
| widget | widget\_t* | svg\_image对象。 |
#### svg\_image\_create 函数
-----------------------
* 函数功能:
> <p id="svg_image_t_svg_image_create">创建svg_image对象
* 函数原型:
```
widget_t* svg_image_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | 对象。 |
| parent | widget\_t* | 父控件 |
| x | xy\_t | x坐标 |
| y | xy\_t | y坐标 |
| w | wh\_t | 宽度 |
| h | wh\_t | 高度 |
#### svg\_image\_set\_image 函数
-----------------------
* 函数功能:
> <p id="svg_image_t_svg_image_set_image">设置控件的图片名称。
> 如果需要显示文件系统中的图片,只需将图片名称换成实际的文件名,并加上"file://"前缀即可。
* 函数原型:
```
ret_t svg_image_set_image (widget_t* widget, char* name);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| widget | widget\_t* | image对象。 |
| name | char* | 图片名称,该图片必须存在于资源管理器。 |