test/awtk
1
0
Fork 0
mirror of https://gitee.com/zlgopen/awtk.git synced 2024-11-30 19:18:53 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
f2bdcaf114
awtk/docs/fscript_widget.md
lixianjing 008772d3d4 improve fscript
2021-09-07 11:09:38 +08:00

17 KiB
Raw Blame History

fscript 的 widget 扩展函数

1. 介绍

fscript 的 widget 扩展函数只能在 widget 的事件处理函数中使用，包括传统的 AWTK 应用程序和 AWTK-MVVM 应用程序的事件处理函数。

fscript 和其它主流脚本 (lua/js) 相比，最大的优势就是体积小巧，而且 AWTK 本身依赖于 fscript，所以使用 fscript 增加额外代码可以忽略不计数。

fscript 并不是要取代 C 或 JS 来开发 AWTK 应用程序，而是一个有益的补充，加快应用程序的开发，在 AWTK 的 UI 文件中直接嵌入 fscript, 有如下优势：

    1. 在特定情况下，可以极大简化程序的实现。

比如下面的代码，点击按钮时打开指定的窗口就非常简洁。

    <button focusable="true" focused="true" on:click="open('basic')" text="Basic" />

比如下面的代码，点击按钮时关闭当前的窗口也非常简洁。

    <button focusable="true" on:click="close()" text="Close" />
    1. 方便工具（如 designer) 生成向导代码。

一般的 IDE 都有简单的代码生成功能，比如按钮的事件处理函数可以选择打开或关闭窗口等简单的功能。不排除 designer 以后增加类似的功能。

    1. 让 MVVM 应用程序有机会去操作界面。

理论上，模型是不能操作界面的，但在特殊情况下，确实有操作界面的需求。在保持视图和模型独立的前提下，fscript 让操作界面成为可能。

    1. 方便生成自定义的组件。很多情况下，需要对现有的控件进行改进和组合，生成新的控件。

比如，我们需要用 text selector 生成一个日期选择控件，用三个 text selector 控件组合成日期选择控件，分别选择年月日。但是 text selector 之间是独立的，而年月和日则是有依赖关系，比如 1 月的天数是 31 天，2 月的天数与年份有关。当然我们可以用 C 代码来建立三者的关系，而用 fscript，不但实现要简单一些，而且由于 xml 和代码在一起，发布和重用也非常方便。

  <row x="10" y="30" w="100%" h="150" children_layout="default(row=1,col=3)">
    <text_selector name="year" options="2000-2050" selected_index="9">
      <property name="on:value_changed">
        <![CDATA[
        a = get_days_of_month(widget_get('parent.year', 'value'), widget_get('parent.month', 'value'))
        widget_set('parent.day', 'options', iformat( '1-%d', a) + '%02d')  
         ]]>
      </property>
    </text_selector>
    <text_selector name="month" options="1-12-%02d" selected_index="8" loop_options="true">
      <property name="on:value_changed">
        <![CDATA[
        a = get_days_of_month(widget_get('parent.year', 'value'), widget_get('parent.month', 'value'))
        widget_set('parent.day', 'options', iformat( '1-%d', a) + '%02d')      
        ]]>
      </property>
    </text_selector>
    <text_selector name="day" options="1-31-%02d" selected_index="9" />
  </row>
    1. 不需要重新编译代码。如果资源文件是在文件系统中，直接更新资源即可，而无需编译和下载固件。

2. 事件处理函数

添加事件处理函数，实际上是增加一些自定义的属性，属性名以 on: 开头，紧跟事件名称。如：

    <button focusable="true" on:click="close()" text="Close" />

为了方便编辑和阅读，对于比较复杂的脚本，可以把事件处理函数独立出来，放到 property 里，并用 CDATA 包装起来。

<button name="timer" focusable="true" on:click="start_timer(100)" text="Start Timer">
<property name="on:timer"><![CDATA[
        a = widget_lookup('window', 'bar', true)
        b = widget_get(a, 'value')
        if(b < 100) {
          widget_set(a, 'value', b + 1)
        } else {
          widget_set(a, 'value', 0)
          stop_timer()
        }
]]></property>
</button>

如果处理逻辑太复杂，请不要用 fscript 实现，否则不好调试。要善用 fscript 的优点而回避它的缺点。

3. 目前支持的事件

  • global_key_up
  • global_key_down
  • global_key_long_press
  • key_up
  • key_down
  • key_long_press
  • key_down_before_children
  • key_up_before_children

按键事件处理函数可以从 key 变量获取当前的键值。可以从 alt, ctrl, cmd 和 menu 变量中获取相应控制键的状态。如：

  <property name="on:global_key_down">
    print("global keydown:", key, "alt=", alt, "ctrl=", ctrl, "cmd=", cmd, "menu=", menu);
  </property>
  <property name="on:global_key_up">
    print("global keyup:", key, "alt=", alt, "ctrl=", ctrl, "cmd=", cmd, "menu=", menu);
  </property>
  <property name="on:global_key_long_press">
    print("global key_long_press:", key, "alt=", alt, "ctrl=", ctrl, "cmd=", cmd, "menu=", menu);
  </property>
  <property name="on:key_down">
    print("keydown:", key, "alt=", alt, "ctrl=", ctrl, "cmd=", cmd, "menu=", menu);
  </property>
  <property name="on:key_up">
    print("keyup:", key, "alt=", alt, "ctrl=", ctrl, "cmd=", cmd, "menu=", menu);
  </property>
  <property name="on:key_long_press">
    print("keyup:", key, "alt=", alt, "ctrl=", ctrl, "cmd=", cmd, "menu=", menu);
  </property>
  • pointer_up
  • pointer_down
  • pointer_move
  • click

指针事件处理函数可以从 x/y 变量获取当前指针的位置。可以从 alt, ctrl, cmd 和 menu 变量中获取相应控制键的状态。如：

  <property name="on:pointer_down">
    print("pointerdown:", x, y, "alt=", alt, "ctrl=", ctrl, "cmd=", cmd, "menu=", menu);
  </property>
  <property name="on:pointer_up">
    print("pointerup:", x, y, "alt=", alt, "ctrl=", ctrl, "cmd=", cmd, "menu=", menu);
  </property>
  <property name="on:click">
    print("click:", x, y, "alt=", alt, "ctrl=", ctrl, "cmd=", cmd, "menu=", menu);
  </property>
  • timer 示例：
<button name="timer" focusable="true" on:click="start_timer(100)" text="Start Timer">
<property name="on:timer"><![CDATA[
  a = widget_lookup('window', 'bar', true)
  b = widget_get(a, 'value')
    if(b < 100) {
    widget_set(a, 'value', b + 1)
  } else {
    widget_set(a, 'value', 0)
    stop_timer()
  }
]]></property>
</button>
  • window_close
  • window_open
  • window_will_open

窗口事件只适用于窗口。

  <property name="on:window_open">
    print("window_open")
  </property>
  <property name="on:window_will_open">
    print("window_will_open")
  </property>
  <property name="on:window_close">
    print("window_close")
  </property>
  • value_changed
<progress_bar name="bar" text="" value="10" on:value_changed="print(widget_get('self', 'value'))"/>
  • focus
  • blur

示例：

<edit name="edit" tips="text edit" on:focus="print(focus)" on:blur="print('blur', widget_get('self', 'value'))"/>
  • value_changed_by_ui （仅 MVVM 支持）

在 MVVM 中，除了支持以上方式编写 fscript，也可以通过 v-on: 和 v-data: 的方式使用 fscript，请参考 MVVM 的文档。

4. 事件的返回值

  • 事件缺省返回 RET_OK。

  • 如果需要在执行完成后移除事件处理函数，可以设置 RET_REMOVE 为 true。

RET_REMOVE=true
  • 如果需要在执行完成后停止后续事件处理，可以设置 RET_STOP 为 true。
RET_STOP=true

5. widget 相关的扩展函数

5.1 open

打开窗口。

原型

open(name, close_current, switch_to_if_exist)
  • name 窗口的资源名称(字符串)
  • close_current 可选。为 true 时关闭当前窗口。
  • switch_to_if_exist 可选。为 true 时，如果同名窗口存在，直接切换到指定窗口。

示例

    <button text="Open" focusable="true" focus="true" on:click="open('test_fscript')"/>
    <button text="Close" focusable="true" on:click="open('test_fscript', true)"/>
    <button text="Switch TO" focusable="true" on:click="open('test_fscript', false, true)"/>

5.2 close

关闭窗口。

原型

close(name)
  • name 窗口的名称(字符串)，可选。缺省关闭当前窗口。

示例

<button focusable="true" on:click="close()" text="Close" />

5.3 back

退到前一个窗口

原型

back()

示例

<button focusable="true" on:click="back()" text="back" />

5.4 back_to_home

退到主窗口

原型

back_to_home()

示例

<button focusable="true" on:click="back_to_home()" text="home" />

5.5 quit

退出应用程序

原型

quit()

示例

<button focusable="true" on:click="quit()" text="quit" />

5.6 tr

翻译指定字符串

原型

tr(str)

示例

<button focusable="true" on:click="print(tr('OK'))" text="tr" />

5.7 widget_lookup

查找指定的控件

原型

widget_lookup(widget, path)
widget_lookup(widget, name, recursive)
  • widget 用作锚点，后面的路径相对于该 widget。'self' 表示当前控件，'parent' 表示当前控件的父控件，'window' 表示当前的窗口，'window_manager' 表示窗口管理器。

示例

查找窗口下名为 view 控件下的名为 bar 的控件。

  a = widget_lookup('window', 'view.bar')

递归查找窗口下名为 bar 的控件。

  a = widget_lookup('window', 'bar', true)

递归查找当前控件下名为 bar 的控件。

  a = widget_lookup('self', 'bar', true)

递归查找当前控件的父控件下名为 bar 的控件。

  a = widget_lookup('self', 'bar', true)

5.8 widget_get

获取控件的属性

原型

widget_get(widget, prop)
widget_get(widget, path.prop)

  • widget 用作锚点，后面的路径相对于该 widget。'self' 表示当前控件，'parent' 表示当前控件的父控件，'window' 表示当前的窗口，'window_manager' 表示窗口管理器。

  • prop 可以是简单的属性命名，也可以是 widget 路径+属性名。

示例

获取当前控件的 value

widget_get('self', 'value')

获取当前控件下名为 bar 控件的 value

widget_get('self', 'bar.value')

获取当前控件的父控件下名为 bar 控件的 value

widget_get('self', 'bar.value')

获取当前控件的父控件下名为 bar 控件的 value

widget_get('parent', 'bar.value')

获取当前窗口下名为 bar 控件的 value

widget_get('window', 'bar.value')

获取当前窗口下名为 view 控件下名为 bar 控件的 value

widget_get('window', 'view.bar.value')

5.9 widget_set

设置控件的属性

原型

widget_set(widget, prop, value)
widget_set(widget, path.prop, value)

  • widget 用作锚点，后面的路径相对于该 widget。'self' 表示当前控件，'parent' 表示当前控件的父控件，'window' 表示当前的窗口，'window_manager' 表示窗口管理器。

  • prop 可以是简单的属性命名，也可以是 widget 路径+属性名。

示例

设置当前控件的 value

widget_set('self', 'value', 12)

设置当前控件下名为 bar 控件的 value

widget_set('self', 'bar.value', 12)

设置当前控件的父控件下名为 bar 控件的 value

widget_set('parent', 'bar.value', 1.2)

设置当前窗口下名为 bar 控件的 value

widget_set('window', 'bar.value', 'hello')

设置当前窗口下名为 view 控件下名为 bar 控件的 value

widget_set('window', 'view.bar.value', 12)

5.10 widget_create

创建控件

原型

widget_create(type, parent, x, y, w, h)
  • type 为控件的字符串名称。
  • parent 为父控件。可以是 widget 对象，也可以是 widget 的路径。

示例

  a = widget_lookup('window', 'foobar', true)
  if(value_is_null(a)) {
    a = widget_create('label', 'window.view', 0, 0, 0, 0)
    assert(!value_is_null(a))

    widget_set(a, 'text', 'Dynamic created')
    assert(widget_get(a, 'text') == 'Dynamic created')
    widget_set(a, 'name', 'foobar')
    assert(widget_get(a, 'name') == 'foobar')
  } else {
    print("foobar exist");
  }

5.10 widget_destroy

销毁控件

原型

widget_destroy(widget)
  • widget 可以是 widget 对象，也可以是 widget 的路径。

示例

  a = widget_lookup('window', 'foobar', true)
  if(!value_is_null(a)) {
    widget_destroy(a)
  } else {
    print('not found foobar');
  }

widget_destroy('self.bar')
widget_destroy('window.view.bar')

5.11 start_timer

开启一个定时器

原型

start_timer(duration)
  • duration 为定时器时间间隔。
  • 一个控件只能开启一个定时器，如果定时器存在，自动先移除之前的定时器。
  • 定时器时间到了之后，会触发控件的 timer 事件，所以对应的控件需要处理 timer 事件。

示例

<button name="timer" focusable="true" on:click="start_timer(100)" text="Start Timer">
  <property name="on:timer">
<![CDATA[
  a = widget_lookup('window', 'bar', true)
  b = widget_get(a, 'value')
  if(b < 100) {
    widget_set(a, 'value', b + 1)
  } else {
    widget_set(a, 'value', 0)
    stop_timer()
  }
]]>
  </property>
</button>

5.12 stop_timer

停止指定控件的定时器

原型

stop_timer()
stop_timer(widget)
  • 不指定 widget 是停止当前控件的定时。
  • widget 可以是 widget 对象，也可以是 widget 的路径。

示例

stop_timer('parent.timer')

5.13 send_key

向指定控件发生按键事件

原型

send_key(widget, key_name)
  • widget 可以是 widget 对象，也可以是 widget 的路径。

示例

 <button text="Backspace" on:click="send_key('window.edit', 'backspace')"/>
 <button text="Char" on:click="send_key('window.edit', 'a')"/>

5.14 widget_eval

有时，几个事件处理函数的代码是重复的，我们可以把代码放到控件的属性中，通过widget_eval来执行。

原型

```js
widget_eval(path.prop)
widget_eval(widget, prop)
widget_eval(widget, path.prop)

  • widget 用作锚点，后面的路径相对于该 widget。'self' 表示当前控件，'parent' 表示当前控件的父控件，'window' 表示当前的窗口，'window_manager' 表示窗口管理器。

  • prop 可以是简单的属性命名，也可以是 widget 路径+属性名。

示例

下面两个事件处理函数的代码是相同。

  <row x="10" y="30" w="100%" h="150" children_layout="default(row=1,col=3)">
    <text_selector name="year" options="2000-2050" selected_index="9">
      <property name="on:value_changed">
        <![CDATA[
        a = get_days_of_month(widget_get('parent.year', 'value'), widget_get('parent.month', 'value'))
        widget_set('parent.day', 'options', iformat( '1-%d', a) + '%02d')
         ]]>
      </property>
    </text_selector>
    <text_selector name="month" options="1-12-%02d" selected_index="8" loop_options="true">
      <property name="on:value_changed">
        <![CDATA[
        a = get_days_of_month(widget_get('parent.year', 'value'), widget_get('parent.month', 'value'))
        widget_set('parent.day', 'options', iformat( '1-%d', a) + '%02d')
        ]]>
      </property>
    </text_selector>
    <text_selector name="day" options="1-31-%02d" selected_index="9" />
  </row>

我们可以改造成这样：

  <row x="10" y="bottom" w="100%" h="150" children_layout="default(row=1,col=3)">
    <property name="handle_value_changed">
      <![CDATA[
      a = get_days_of_month(widget_get('parent.year', 'value'), widget_get('parent.month', 'value'))
      widget_set('parent.day', 'options', iformat( '1-%d', a) + '%02d')
       ]]>
    </property>
    <text_selector name="year" options="2000-2050" selected_index="9"
      on:value_changed="widget_eval('parent.handle_value_changed')" />
    <text_selector name="month" options="1-12-%02d" selected_index="8" loop_options="true"
      on:value_changed="widget_eval('parent.handle_value_changed')" />
    <text_selector name="day" options="1-31-%02d" selected_index="9" />
  </row>

示例参考

可以用 preview_ui 直接运行。如：

./bin/preview_ui.exe design/default/ui/main_fscript.xml