aardio 文档

global 库模块帮助文档

ide 成员列表

aardio 开发环境扩展支持库,仅适用于编写开发环境插件,
需要使用 import ide 语句导入才能使用,

import ide作为程序第一个import语句时，插件在IDE进程内以线程模式运行,
否则插件在IDE进程外以独立进程模式运行，请优先使用独立进程模式

ide.compile()

编译当前视图源码;

ide.createProcess

创建运行 aardio 代码的新进程。

ide.createProcess(代码文件路径,代码,动词,命令行参数...)

在IDE中创建进程启动参数 @1 或参数 @2 指定的代码。
动词参数可省略，可选值例如 open,runas 等。

可选指定一个或多个命令行参数（字符串或表）。
命令行参数使用 string.args.join 合并。
代码中用 _ARGV 接收解析后的参数。
返回进程 ID

ide.createProcess(代码文件路径,代码,动词,父窗口句柄,命令行参数...)

在IDE中创建进程启动参数 @1 或参数 @2 指定的代码。
动词参数可省略，可选值例如 open,runas 等。
参数 @4 指定父窗口或父窗口句柄，在运行代码中用 ... 参数接收窗口句柄。

可选指定一个或多个命令行参数（字符串或表）。
命令行参数使用 string.args.join 合并。
代码中用 _ARGV 接收解析后的参数。
返回进程 ID

ide.createProcess(代码文件路径,全局变量表,动词,命令行参数...)

在IDE中创建进程启动参数 @1 指定的代码文件。
参数@2用一个表（table）参数指定全局变量或常量。
动词参数可省略，可选值例如 open,runas 等。

可选指定一个或多个命令行参数（字符串或表）。
命令行参数使用 string.args.join 合并。
代码中用 _ARGV 接收解析后的参数。
返回进程 ID

ide.createProcessEx(应用根目录,应用图标路径,代码文件路径,代码,动词,父窗口句柄,命令行参数)

创建进程。
可自定义应用根目录，应用图标路径。命令行参数只能是单个字符串。
其他参数用法与 ide.createProcess 相同。

ide.createThread("字符串参数")

运行指定 aardio 文件。
参数指定 aardio 文件路径。
为避免影响开发环境主进程，尽量不要使用这个函数。
更好的选择是改用 ide.createProcess 函数。

ide.getActiveCode()

如果当前打开的是源码或窗体设计器,返回正在编辑的源代码,
失败返回null

ide.getActiveCodeEditor()

返回当前代码编辑器控件

返回对象:editObject

ide.getActiveCodeEditorHwnd()

返回当前代码编辑器控件句柄

ide.getActiveDocPath()

获取活动文档路径,
如果文档未保存为文件,则返回值为空

ide.getActiveForm()

返回当前的文档窗口是否窗体设计器

ide.getActiveViewHwnd()

获取活动视图句柄
其父窗口为MDI子窗口,子窗口为编辑器窗口
在IDE进程内运行时第二个返回值为当前文档路径

ide.getConfig("字符串参数")

返回IDE配置文件 ("/Config/USE.CFG") 指定字段值,
返回值为字符串,失败返回空字符串

ide.getControlParam(控件名)

获取控件参数,
参数中的font属性作为::LOGFONT的参数才能转换为字体对象

ide.getExtLibs()

返回已安装的扩展库列表

ide.getMainHwnd()

获取IDE顶层主窗口句柄

ide.getProjectDir()

获取当前工程所在目录,
如果未打开工程,返回空字符串

ide.getProjectIcon()

返回工程图标路径。

ide.getProjectMainFile()

工程启动代码文件路径

ide.getProjectPath()

获取当前工程路径,
如果未打开工程,返回空字符串

ide.getProjectProperty("publishDir")

返回工程属性,
失败返回空字符串

ide.getPublisDir()

返回发布目录

ide.getPublishName()

返回生成文件名

ide.getPublishPath()

返回生成文件路径

ide.getSelectedControl()

返回当前窗体设计器选中的控件名称,失败返回null

ide.getVersion()

major,minor,build = ide.getVersion();

ide.gotoLine()

跳转到参数指定的代码行

ide.insertCode()

在当前代码编辑器光标位置插入代码,
支持智能提示模板语法,自动插入新行,自动缩进,
并将双下划线转换为光标位置,其后的块注释显示为汽泡提示。
成功返回true

ide.installLib

安装远程扩展库

ide.installLib(libName,libUrl,askTitle)

参数@libName指定扩展库名称,
参数@libUrl可选,可指定 *.tar.lzma 格式安装包 或 *.aardio 格式库文件地址,
*.tar.lzma 格式安装包请使用「工具 / 开发环境 / 扩展库发布工具」生成,
参数@askTitle可选,用于指定安装询问对话框标题,省略则直接安装

如果不使用@libUrl参数指定网址，自官方扩展库查找高于已安装版本的安装包。
而指定@libUrl参数时总是重新安装扩展库

ide.isInProject()

检查参数 @1 指定的路径是否当前打开工程内的路径。
如果参数不是字符串则直接返回 null ，否则返回布尔值。

ide.killOnExit()

IDE 进程退出时自动关闭参数 @1 指定进程 ID 的进程

ide.libMan()

打开库参考手册，并搜索参数 @1 指定的关键字

ide.loadPrivateFont("字体路径")

在开发环境中加载字体文件,
使窗体设计器中的控件可以显示该字体

ide.mdiActivate

激活文档窗口

ide.mdiActivate("标题","类名")

激活窗口

ide.mdiActivate(句柄)

激活窗口

ide.newDocument()

在编辑器中新建 aardio 源码,可选在参数中指定源代码

ide.newForm()

在编辑器中新建新建窗体设计器,可选在参数中指定窗口源代码

ide.newProject()

打开新建工程向导

ide.openCode(aardio代码)

新建文档窗口并写入aardio代码
参数指定aardio代码

ide.openDocument("/输入文件路径")

打开 .aardio 源文件、.aproj 工程文件、*.md 文档。

如果打开单个源码文件,此函数会等待操作完成。
如果打开工程文件,此函数会立即返回并发送异步命令。
发送后立即关闭发送线程可能导致异步命令发送失败。
工程打开后会调用 ide.command 的 onProjectOpened 事件。
如果用于打开 *.md 文件，则在文档浏览器中显示 Markdown 格式文档，
支持 https://www.aardio.com/zh-cn/doc/ 协议的 URL ，例如： https://www.aardio.com/zh-cn/doc/language-reference/datatype/table/_

ide.processGroup()

返回当前开发进程群组名,可在参数中指定后缀名
该名字包含IDE主进程的进程ID，可用于process.command,thread.event等

ide.processList()

IDE启动的调试进程列表

ide.projectIsOpened()

返回当前是否已经打开工程

ide.publish()

编译当前工程生成exe文件

ide.redrawCodeEditor()

重新读入配色与字体设置,
重绘代码编辑器窗口,
成功返回 true

ide.refreshStdLib()

刷新标准库视图,
并更新标准库智能提示数据

ide.refreshUserLib()

刷新当前工程用户库节点,
并更新用户库智能提示数据

ide.requestLibInfo("all")

查询服务端扩展库信息

ide.run()

运行当前视图源码;

ide.save()

保存当前文档

ide.saveAll()

保存所有文档,并保存工程文件

ide.setActiveCode()

如果当前打开的是源码或窗体设计器,重新设置正在编辑的源代码,
此函数会覆盖正在编辑的源码，且无法撤消，请谨慎使用,
成功返回true,失败或当前编辑的不是源码文档或窗体设计器返回false

ide.setConfig("字符串参数","字符串参数")

修改IDE配置文件 ("/Config/USE.CFG") 指定字段值,
参数必须都是字符串

ide.setControlParam(控件名,参数表)

更新控件参数,成功返回true，失败返回false

ide.setProjectProperty("publishDir","字符串参数")

设置工程属性,
返回布尔值表示是否成功

ide.setPublishName("输出文件名")

插件可以使用此函数修改输出文件名
因此所有插件请尽可能使用getPublishPath函数获取当前输出路径

ide.setSelectedControl()

在窗体设计器中选中指定名称的控件,
并取消选中其他控件,
成功返回true

ide.show

在 IDE 窗口的前面显示参数 @1 指定的窗口。
此函数在显示前临时设置窗口的所有者窗口（owner window）为 IDE 主窗口，
在显示窗口后再将所有者窗口设为空。

ide.show(hwnd,flags)

在 IDE 窗口的前面显示参数 @1 指定的窗口。
参数 @1 指定窗口对象或窗口句柄。
参数 @2 可选指定调用 win.show 的第 2 个选项参数，可使用 _SW 前缀常量。

ide.showStatus(消息,进度)

在IDE状态栏显示削息和进度
参数@1使用字符串指定消息,
参数@2使用数值指定进度
所有参数可选
不指定进度时重置进度为初始状态

ide.startpage()

切换到开始页

ide.switchActiveForm（true)

用于切换窗体设计器的视图,
参数为true时切换到设计器视图,参数为false切换到源码视图,
成功返回true

ide.switchDesignView()

切换当前窗体设计视图;

ide.updateVersion()

更新版本

自动完成常量

_IDE_ID_BUILD_COMPILE=0x8315
_IDE_ID_BUILD_PUBLISH=0x8317
_IDE_ID_BUILD_RUN=0x831D
_IDE_ID_DESIGN_SWITCHTO=0x831A

Markdown 格式