Lqt 项目技术文档

本文档旨在帮助用户安装、使用和深入了解 Lqt 项目，一个将 Lua 语言绑定到 Qt 框架的自动化生成库。

1. 安装指南

在开始安装 Lqt 之前，请确保您的系统已安装以下依赖项：

• Lua 5.1
• CMake
• Qt 和对应的头文件（在 Ubuntu 系统中需要安装 libqt4-dev 包）

以下是安装 Lqt 的步骤：

1. 从 GitHub 获取 Lqt 的最新源码。

2. 创建一个源码外构建目录（例如 build 或 /dev/shm）。

3. 使用 CMake 生成 Makefile 并执行 make 命令：

   mkdir build; cd build
   cmake ..
   make -j4 # 使用并行构建，参数为您系统的核心/处理器数量
   

构建完成后，生成的 Lua 绑定库将位于 lib 目录中，您可以将它们复制到 LUA_CPATH。

2. 项目使用说明

以下是一个使用 Lqt 创建带有信号/槽处理的 "Hello World!" 按钮的简单示例：

require 'qtcore'
require 'qtgui'

app = QApplication.new(select('#', ...) + 1, {'lua', ...})

btn = QPushButton.new("Hello World!")
btn:connect('2pressed()', function(self)
    print("我即将关闭...")
    self:close()
end)
btn:setWindowTitle("一个很好的示例！")
btn:resize(300, 50)
btn:show()

app.exec()

更多示例和详细使用说明，请查看项目中的 test 文件夹和 doc 文件夹，以及 examples 页面。

3. 项目 API 使用文档

Lqt 的 API 覆盖了 Qt 框架的几乎所有类和方法。以下是部分特点：

• 自动从 Qt 头文件生成，保持与 Qt 的同步更新
• 支持的模块：QtCore, QtGui, QtNetwork, QtXml, QtXmlPatterns, QtWebKit, QtOpenGL, QtSql, QtSvg, QtUiTools
• 高 API 覆盖率，只有极少数方法不可用
• 支持以下 C++/Qt 特性：
  • 方法重载
  • 虚拟方法（包括抽象方法）
  • 多重继承
  • 在 userdata 中存储额外的 Lua 值，它们表现得像 Lua 表
  • 支持多个重载运算符
  • 部分模板类可用，如 QList<QString>
  • 信号/槽机制，可以在 Lua 中定义自定义槽
  • QObject 派生对象自动转换为正确的类型，得益于 Qt 的元对象系统
  • 隐式转换，例如在期望 QString 的地方写入 Lua 字符串，或在期望 QVariant 的地方写入数字

4. 项目安装方式

请参考本文档的 "安装指南" 部分获取项目安装方式。