aardio 文档

win.form 使用指南 - 如何创建窗口并添加控件

一. 窗体设计器

在 aardio 中创建窗口有以下方法:

默认将在窗体设计器中以"设计视图"打开窗体,
我们可以在开发环境左下方的"界面控件"选择和拖放控件到窗体上。
点击窗体或控件,在右侧属性面板可以设置控件的属性。

我们可以点击"代码视图"切换到代码编辑器模式,也可以直接按相同的 Ctrl + U 快捷键来回切换视图模式。在窗体设计器上直接双击控件也可以切换到代码模式并且为控件添加事件函数(默认会添加 oncommand 事件,不同的控件有所不同 )。

二. 窗体设计器生成的代码结构

我们创建窗口,添加一个按钮与一个文本框,切换到代码模式,我们看到生成了以下代码:

import win.ui;
/*DSG{{*/
var winform = win.form({ text="窗口标题";right=759;bottom=469 })
winform.add({
button1={cls="button";text="Button";left=550;top=414;right=701;bottom=458;z=1};
edit1={cls="edit";text="Edit";left=22;top=16;right=735;bottom=398;edge=1;multiline=1;z=2}
})
/*}}*/

winform.show();
win.loopMessage();

/*DSG{{*//*}}*/ 之间的代码由窗体设计器自动生成,
并且默认折叠并显示"窗体设计器生成代码(请勿修改)",通常直接修改这部分代码是不必要的,应当通过窗体设计器修改相关属性。

请注意: win.ui 库导入了 win.form 类,但是 win.form 并不在 win.ui 名字控件下面。
这在 aardio 中是唯一的特例。除了 win.form,aardio 标准库总是保持库名与名字空间的一致性。

三. 调用 win.form 类创建窗体对象

原型:

var winform = win.form(formPropertiesTable)  

说明:

参数 formPropertiesTable 是一个表对象。
formPropertiesTable 包含的键值对定义窗口的属性。
实际上 formPropertiesTable 就是我们在窗体设计器上设置的窗体属性认集合。

win.form 返回 winform 对象,在 aardio 中一般窗体通常默认命名为 winform,只有程序的第一个主窗口会命名为全局变量 mainForm。

在 aardio 的文档一般会用 winform 泛指所有 win.form 创建的窗体对象。

示例:

var winform = win.form({ text="窗口标题";right=759;bottom=469 })

在 aardio 中如果函数参数是一个表对象的构造器,
并且第一个出现的元素是用等号分隔的名值对,则可以省略外层的括号,
例如上面的代码可以简写为:

var winform = win.form( text="窗口标题";right=759;bottom=469 )

注意这不是命名参数,aardio 里没有命名参数。

对于一般的窗口我们应当指定 formPropertiesTable 的 text 属性,也就是窗体的标题。如果不指定窗口标题则窗口不会显示标题栏,没有标题栏用户就找不到窗口关闭按钮,这可能不太方便。所以通常应该指定一个标题。即使我们需要创建一个无边框无标题栏的窗口我们也应该给窗口一个合适的标题。

窗口的创建参数不指定 left,top 坐标时则使用默认值 -1,这会让窗口显示在屏幕居中的默认位置。这时候窗口的宽度与高度分别为 right + 1,bottom + 1。如果 left,top 为小于等于 -2 的值则表示以窗口显示在屏幕右下角以后取得的左上角坐标作为原点计数。如果 left,top 为大于等于 0 的值则表示自屏幕左上角正常计数。

四. 调用 winform.add 函数添加控件

1. 原型:

winform.add = function(controlsPropertiesTable) {
    /*
    controlsPropertiesTable 是一个键值对,定义控件集合 。
    键名为访问控件的名称,键名对应的值刚是描述每个控件属性的表对象。 
    格式:{控件访问名称 = {控件属性表}, ...}  
    */
}

2. 说明:

controlsPropertiesTable 参数是一个表对象。 controlsPropertiesTable 包含的键值对定义了一个或多个控件, 键名为之后通过 winform 对象访问该控件的名称,键名对应的值刚是描述每个控件属性的表对象。 每个控件的创建参数同样是一个包含描述控件属性键值对的表对象( propertiesTable ),这些属性也就是我们在窗体设计器上为控件设置的设计时属性。

3. 示例:

import win.ui; 
var winform = win.form({ text="窗口标题";right=759;bottom=469 });

winform.add({
    button1={//指定访问名称为  winform.button1
        cls="button";//指定用 win.ui.ctrl.button 类构造控件
        text="添加第一个按钮 button1 到  winform.button1";//控件显示的标题
        left=264;top=410;right=469;bottom=454;//控件位置
        z=1 //Z序
    };
    button2={//指定访问名称为  winform.button2
        cls="button";//指定用 win.ui.ctrl.button 类构造控件
        text="添加第二个按钮 button2 到 winform.button2";//控件显示的标题
        left=499;top=410;right=688;bottom=454;//控件位置
        z=2 //Z序
    };
    edit1={//指定访问名称为  winform.edit1
        cls="edit";//指定用 win.ui.ctrl.edit 类构造控件
        text="添加第一个编辑框 edit1 到  winform.edit1";//控件文本
        left=386;top=16;right=739;bottom=398;
        edge=true;multiline=true;z=3 //边框,多行,Z序
    };
    edit2={//指定访问名称为  winform.edit2
        cls="edit";//指定用 win.ui.ctrl.edit 类构造控件
        text="添加第一个编辑框 edit2  到  winform.button2";//控件文本
        left=22;top=16;right=375;bottom=398;//控件位置
        edge=true;multiline=true;z=4 //边框,多行,Z序
    }
});

上面的代码创建了 4 个控件:

controlsPropertiesTable 里的控件名称也就是添加到 winform 对象的成员名,例如 controlsPropertiesTable 里添加的控件名为 "button1" ,则之后的代码就要通过 winform.button1 访问该控件。winform.add 函数的作用就是把 "button1" 添加到 winform 对象让我们可以通过 winform.button1 访问新增的控件对象。

controlsPropertiesTable 里每个控件的参数属性为设计时属性,可以在窗本设计器视图中设计好这些控件的初始化属性,然后切换到代码视图就可以查看细节。创建控件的很多设计时属性与控件的运行时属性同名,因此也可以在控件的参考文档中查看这些属性的细节。

这里介绍几个最重要的控件设计时属性:

aardio 窗口支持自动缩放并在运行时自动调整坐标,或根据系统 DPI 缩放设置自动调整窗口与控件的位置和大小,所以控件的创建参数中指定的是设计时坐标,运行时坐标会根据设计时坐标计算出来。

4. winform.add 函数的返回值:

虽然 winform.add 有返回值,但是我们通常不使用 winform.add 的返回值。

winform.add 的返回值与传入参数的结构相同,如果传入的是 controlsPropertiesTable 则返回的与是包含控件名值对的表,只不过对应控件名字的值变成了创建好的控件对象。

通常不必要去使用 winform.add 的返回值,应当通过 winform 去访问控件。例如在代码中使用 winform.button1winform.edit1 访问被添加到 winform 窗口上的控件,这样写的好处是窗体设计器将会为这种访问方式提供更好的智能提示。

五. 创建窗口的高级用法与隐藏参数

win.form 构造参数与 winform.add 有一些不常见的用法与隐藏参数,用于解决一些不太常见的需求。关于这些参数在 aardio 自带的"范例 / Windowns 窗口 / 基础知识" 内有详细的演示与注释说明,也可以查看库参考手册,作为入门指南这里不多讲。

范例:

六. 创建窗口示例:

//自 win.ui 库中导入 win.form 窗口类
import win.ui;

/*DSG{{*/

//创建窗口
var winform = win.form(text="窗口标题不要省略";right=763;bottom=425)

//创建多个控件应当仅调用 winform.add 一次
winform.add({//如果函数的参数只有一个表对象,可省略名值对外层的 {}  。

    //指定访问控件的名字为 winform.button1 ,不可省略
    button1={
        cls="button";// 指定用类 win.ui.ctrl.button 创建按钮控件,不可省略
        text="点击我";// 按钮上的文字
        left=556;top=367;// 按钮左上角坐标
        right=689;bottom=407; // 按钮右下角坐标
        z=1 // 文本框左上角坐标
    };

    //指定访问控件的名字为 winform.edit1 ,不可省略
    edit1={
        cls="edit";// 指定用类 win.ui.ctrl.edit 创建文本框控件,不可省略
        text="输入文本";// 文本框内的文字
        left=9;top=10;// 文本框左上角坐标
        right=752;bottom=351;// 文本框右下角坐标
        multiline=1;//多行文本框
        z=2 //Z序,可省略
    }
})

/*}}*/

// 设置按钮的点击事件处理程序,winform.button1 也就是 winform.add 的参数中创建的名为 "button1" 的控件。
winform.button1.oncommand = function(id, event) {
    // 从 1 循环到 10 的数字输出到 edit 控件
    for(i=1; 10; 1) {
        //注意 edit 以 '\r\n' 换行,而 richedit 以 '\n' 换行
        winform.edit1.appendText(i,'\r\n'); //winform..edit1 也就是 winform.add 的参数中创建的名为 ".edit1" 的控件。
    }
};

//显示窗口
winform.show();

//启动界面线程消息循环
win.loopMessage();

这个代码示例首先自 win.ui 库导入了 win.form 类,然后创建了一个带有指定标题的 winform 窗口。接着,它在该窗口上添加了一个按钮和一个文本框。当按钮被点击时,会从 1 循环到 10 的数字,每个数字后跟一个换行符,然后输出到文本框中。最后,显示窗口并进入消息循环,以便响应用户的操作。

用户在点击按钮时会回调 winform.button1.oncommand 事件函数,请参考 aardio 范例:响应控件命令

Markdown 格式