mn-docs-mcp 0.1.0

package/src/content/docs/reference/uikit/uiwebview.md

@@ -0,0 +1,229 @@
+---
+title: UIWebView
+description: 在插件中嵌入网页或本地 HTML，支持加载 URL、执行 JS 与 delegate 回调。
+---
+
+UIWebView 用于在插件中嵌入网页或本地 HTML 页面，继承自 [UIView](/reference/uikit/uiview/)。可通过设置 `delegate` 接收加载开始/完成/失败与请求拦截（如自定义 URL Scheme 实现 WebView 内 JS 与插件 JS 的双向通信）。参见 [Cookbook：WebView 内 JS 与插件 JS 双向通信](/guides/cookbook/webview-bidirectional-js/)。
+
+## 实例成员 (Instance members)
+
+### 属性
+
+| 属性 | 类型 | 说明 |
+| :--- | :--- | :--- |
+| `delegate` | `id` | 实现 UIWebViewDelegate 的对象，通常为承载 WebView 的 ViewController（self）。 |
+| `scrollView` | `UIScrollView` | 只读，内嵌滚动视图。 |
+| `request` | `NSURLRequest` | 只读，当前请求。 |
+| `loading` | `boolean` | 只读，是否正在加载（getter 为 isLoading）。 |
+| `canGoBack` | `boolean` | 只读，是否可后退。 |
+| `canGoForward` | `boolean` | 只读，是否可前进。 |
+| `scalesPageToFit` | `boolean` | 是否按比例缩放以适应视图。 |
+| `dataDetectorTypes` | `UIDataDetectorTypes` | 检测的数据类型（如电话、链接）。 |
+| `customUserAgent` | `string` | 自定义 User-Agent。 |
+
+### 加载方法
+
+### `loadRequest`
+
+加载 URL 请求（如远程网页）。
+
+```javascript
+loadRequest(request: NSURLRequest): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `request` | `NSURLRequest` | URL 请求对象。 |
+
+### `loadHTMLStringBaseURL`
+
+加载 HTML 字符串。
+
+```javascript
+loadHTMLStringBaseURL(string: string, baseURL: NSURL | null): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `string` | `string` | HTML 内容字符串。 |
+| `baseURL` | `NSURL \| null` | 基础 URL（用于解析相对路径）。 |
+
+**Note:** 该方法对应 Objective‑C 的 `loadHTMLString:baseURL:`，JS 侧为参数标签拼接后的方法名。
+
+### `loadDataMIMETypeTextEncodingNameBaseURL`
+
+加载二进制数据。
+
+```javascript
+loadDataMIMETypeTextEncodingNameBaseURL(data: NSData, MIMEType: string, textEncodingName: string, baseURL: NSURL): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `data` | `NSData` | 数据内容。 |
+| `MIMEType` | `string` | MIME 类型（如 "text/html"）。 |
+| `textEncodingName` | `string` | 文本编码名称（如 "UTF-8"）。 |
+| `baseURL` | `NSURL` | 基础 URL。 |
+
+### `loadFileURLAllowingReadAccessToURL`
+
+加载本地文件 URL。
+
+```javascript
+loadFileURLAllowingReadAccessToURL(URL: NSURL, allowingReadAccessToURL: NSURL): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `URL` | `NSURL` | 文件 URL。 |
+| `allowingReadAccessToURL` | `NSURL` | 允许读取的访问路径（通常也是文件 URL 或其父目录）。 |
+
+### `reload`
+
+重新加载。
+
+```javascript
+reload(): void
+```
+
+### `stopLoading`
+
+停止加载。
+
+```javascript
+stopLoading(): void
+```
+
+### `goBack`
+
+后退。
+
+```javascript
+goBack(): void
+```
+
+### `goForward`
+
+前进。
+
+```javascript
+goForward(): void
+```
+
+### 脚本与截图
+
+### `evaluateJavaScript`
+
+在页面上下文中执行 JS；执行完成后调用 completionHandler（可选）。用于**插件 → WebView 内 JS** 的通信。
+
+```javascript
+evaluateJavaScript(javaScriptString: string, completionHandler: (result: any) => void | null): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `javaScriptString` | `string` | 要执行的 JavaScript 代码字符串。 |
+| `completionHandler` | `(result: any) => void \| null` | 执行完成后的回调，`result` 为执行结果。 |
+
+### `takeSnapshotWithWidth`
+
+按指定宽度截取快照，完成后回调。
+
+```javascript
+takeSnapshotWithWidth(width: number, completionHandler: (image: UIImage) => void): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `width` | `number` | 快照宽度。 |
+| `completionHandler` | `(image: UIImage) => void` | 完成回调，接收生成的图片。 |
+
+## Delegate（UIWebViewDelegate，非 UIWebView 导出方法）
+
+以下方法需在 `webView.delegate` 所指对象的**实例成员**中实现（例如承载 WebView 的 ViewController 在 `JSB.defineClass` 的第二个参数里定义）。
+
+### webViewDidStartLoad
+
+开始加载时调用。
+
+```javascript
+webViewDidStartLoad(webView: UIWebView): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `webView` | `UIWebView` | 发起回调的 WebView。 |
+
+### webViewDidFinishLoad
+
+加载完成时调用。
+
+```javascript
+webViewDidFinishLoad(webView: UIWebView): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `webView` | `UIWebView` | 发起回调的 WebView。 |
+
+### webViewDidFailLoadWithError
+
+加载失败时调用。
+
+```javascript
+webViewDidFailLoadWithError(webView: UIWebView, error: NSError): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `webView` | `UIWebView` | 发起回调的 WebView。 |
+| `error` | `NSError` | 错误信息。 |
+
+### webViewShouldStartLoadWithRequestNavigationType
+
+是否允许加载该请求。
+
+```javascript
+webViewShouldStartLoadWithRequestNavigationType(webView: UIWebView, request: NSURLRequest, type: number): boolean
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `webView` | `UIWebView` | 发起回调的 WebView。 |
+| `request` | `NSURLRequest` | 即将加载的请求。 |
+| `type` | `number` | 导航类型（如链接点击、表单提交等）。 |
+
+**Return Value:**
+
+- `boolean`: 返回 `true` 允许加载，`false` 阻止加载。
+
+**Usage:** 可在此拦截自定义 URL Scheme（如 `marginnote://...`），解析后执行插件逻辑并 `return false`，实现 **WebView 内 JS → 插件** 的通信。
+
+## 类成员 (Class members)
+
+当前运行时未额外暴露 `UIWebView` 的类成员。
+
+## 相关
+
+- [原生 UI：使用 WebView](/guides/native-ui/#使用-webview)、[Cookbook：WebView 内 JS 与插件 JS 双向通信](/guides/cookbook/webview-bidirectional-js/)
+- [UIView](/reference/uikit/uiview/)、[UIViewController](/reference/uikit/uiview-controller/)

package/src/content/docs/reference/uikit/uiwindow.md

@@ -0,0 +1,47 @@
+---
+title: UIWindow
+description: 顶层窗口。支持设置 rootViewController、windowLevel（部分平台也支持 screen），并提供坐标系转换与事件分发。
+---
+
+`UIWindow` 继承自 [UIView](/reference/uikit/uiview/)，表示一个顶层窗口。插件运行时里你会经常把它作为 `self.window` 或 controller 相关 API 的参数传递。
+
+## 实例成员 (Instance members)
+
+### 属性
+
+| 属性 | 类型 | 说明 |
+| --- | --- | --- |
+| `screen` | UIScreen | 所属屏幕（部分平台不可用，例如 xrOS 环境）。 |
+| `keyWindow` | boolean | 只读。是否为 keyWindow。 |
+| `rootViewController` | UIViewController \| null | 根控制器。 |
+| `windowLevel` | number | 窗口层级。 |
+
+### 窗口状态
+
+| 方法 | 参数 | 返回值 | 说明 |
+| --- | --- | --- | --- |
+| `becomeKeyWindow()` | — | void | 成为 key window。 |
+| `resignKeyWindow()` | — | void | 放弃 key window。 |
+| `makeKeyWindow()` | — | void | 使其成为 key window。 |
+| `makeKeyAndVisible()` | — | void | 成为 key 且可见。 |
+
+### 事件与坐标转换
+
+| 方法 | 参数 | 返回值 | 说明 |
+| --- | --- | --- | --- |
+| `sendEvent(event)` | event: UIEvent | void | 向窗口分发事件。 |
+| `convertPointToWindow(point, window)` | point: { x: number, y: number }, window: UIWindow \| null | { x: number, y: number } | 点坐标转换到另一个 window。 |
+| `convertPointFromWindow(point, window)` | point: { x: number, y: number }, window: UIWindow \| null | { x: number, y: number } | 点坐标从另一个 window 转换回来。 |
+| `convertRectToWindow(rect, window)` | rect: { x: number, y: number, width: number, height: number }, window: UIWindow \| null | { x: number, y: number, width: number, height: number } | 矩形转换到另一个 window。 |
+| `convertRectFromWindow(rect, window)` | rect: { x: number, y: number, width: number, height: number }, window: UIWindow \| null | { x: number, y: number, width: number, height: number } | 矩形从另一个 window 转换回来。 |
+
+## 类成员 (Class members)
+
+当前运行时未额外暴露 `UIWindow` 的类成员。
+
+## 相关
+
+- [UIView](/reference/uikit/uiview/)
+- [UIViewController](/reference/uikit/uiview-controller/)
+- [UIScreen](/reference/uikit/uiscreen/)
+- [UIEvent](/reference/uikit/uievent/)

package/src/content/docs/reference/utility/menu-controller.md

@@ -0,0 +1,27 @@
+---
+title: MenuController
+description: 菜单控制器，提供表格化菜单视图。
+---
+
+继承自 UIViewController，用于展示表格化菜单。属性包括 menuTableView（UITableView）、commandTable、sections、rowHeight、secHeight、fontSize 等，用于自定义菜单内容与样式。
+
+## 实例成员 (Instance members)
+
+### 属性
+
+| 属性 | 类型 | 说明 |
+|------|------|------|
+| `menuTableView` | UITableView | 菜单表格视图。 |
+| `commandTable` | NSArray | 命令表。 |
+| `sections` | NSArray | 分区。 |
+| `rowHeight` | number | 行高。 |
+| `secHeight` | number | 分区头高。 |
+| `fontSize` | number | 字体大小。 |
+
+## 类成员 (Class members)
+
+当前运行时未额外暴露 `MenuController` 的类成员。
+
+## 相关
+
+- [UIViewController](/reference/uikit/uiview-controller/)

package/src/content/docs/reference/utility/speech-manager.md

@@ -0,0 +1,118 @@
+---
+title: SpeechManager
+description: 语音朗读，朗读笔记或指定文本。
+---
+
+用于 TTS 朗读。通过 `SpeechManager.sharedInstance()` 获取单例。
+
+## 类成员 (Class members)
+
+### `sharedInstance`
+
+获取单例。
+
+```javascript
+static sharedInstance(): SpeechManager
+```
+
+**Return Value:**
+
+- `SpeechManager`: 单例对象。
+
+## 实例成员 (Instance members)
+
+### 属性
+
+| 属性 | 类型 | 说明 |
+| :--- | :--- | :--- |
+| `speaking` | `boolean` | 是否正在朗读。 |
+| `paused` | `boolean` | 是否暂停。 |
+| `sceneWindow` | `UIWindow` | 场景窗口。 |
+| `languageCode` | `string` | 语言代码。 |
+| `canPrev` | `boolean` | 是否可上一句。 |
+| `canNext` | `boolean` | 是否可下一句。 |
+
+### 方法
+
+### `startSpeechNotes`
+
+开始朗读笔记列表。
+
+```javascript
+startSpeechNotes(notes: NSArray): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `notes` | `NSArray` | 包含 `MbBookNote` 的数组。 |
+
+### `stopSpeech`
+
+停止朗读。
+
+```javascript
+stopSpeech(): void
+```
+
+### `pauseSpeech`
+
+暂停朗读。
+
+```javascript
+pauseSpeech(): void
+```
+
+### `continueSpeech`
+
+继续朗读。
+
+```javascript
+continueSpeech(): void
+```
+
+### `prevSpeech`
+
+上一句。
+
+```javascript
+prevSpeech(): void
+```
+
+### `nextSpeech`
+
+下一句。
+
+```javascript
+nextSpeech(): void
+```
+
+### `playText`
+
+朗读指定文本。
+
+```javascript
+playText(text: string): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `text` | `string` | 要朗读的文本。 |
+
+### `playText` (指定语言)
+
+指定语言朗读文本。
+
+```javascript
+playText(text: string, languageTxt: string): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `text` | `string` | 要朗读的文本。 |
+| `languageTxt` | `string` | 语言代码（如 "en-US"）。 |

package/src/content/docs/reference/utility/sqlite-database.md

@@ -0,0 +1,201 @@
+---
+title: SQLiteDatabase
+description: SQLite 数据库连接（JSBSQLiteDatabase），用于执行 SQL 与事务控制。
+---
+
+`SQLiteDatabase` 是插件环境中暴露的 SQLite 连接器。可用于打开/关闭数据库、执行查询/更新、事务控制、读取错误信息等。
+
+## 类成员 (Class members)
+
+### `databaseWithPath`
+
+从路径创建数据库实例。
+
+```javascript
+static databaseWithPath(inPath: string): SQLiteDatabase
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `inPath` | `string` | 数据库文件路径。 |
+
+**Return Value:**
+
+- `SQLiteDatabase`: 新实例（需调用 `open()` 打开）。
+
+### `isSQLiteThreadSafe`
+
+SQLite 库是否线程安全。
+
+```javascript
+static isSQLiteThreadSafe(): boolean
+```
+
+**Return Value:**
+
+- `boolean`: 是否线程安全。
+
+### `sqliteLibVersion`
+
+SQLite 库版本字符串。
+
+```javascript
+static sqliteLibVersion(): string
+```
+
+**Return Value:**
+
+- `string`: 版本字符串。
+
+## 实例成员 (Instance members)
+
+### 属性
+
+| 属性 | 类型 | 说明 |
+| :--- | :--- | :--- |
+| `traceExecution` | `boolean` | 是否跟踪执行。 |
+| `checkedOut` | `boolean` | 是否已检出。 |
+| `crashOnErrors` | `boolean` | 出错时是否崩溃。 |
+| `logsErrors` | `boolean` | 是否记录错误。 |
+| `cachedStatements` | `object` | 缓存的语句。 |
+
+### `open`
+
+打开数据库连接。
+
+```javascript
+open(): boolean
+```
+
+**Return Value:**
+
+- `boolean`: 是否成功。
+
+### `close`
+
+关闭数据库连接。
+
+```javascript
+close(): boolean
+```
+
+**Return Value:**
+
+- `boolean`: 是否成功。
+
+### `executeUpdate`
+
+执行更新语句（INSERT/UPDATE/DELETE 等）。
+
+```javascript
+executeUpdate(sql: string, withArgumentsInArray: NSArray): boolean
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `sql` | `string` | SQL 语句。 |
+| `withArgumentsInArray` | `NSArray` | 参数数组。 |
+
+**Return Value:**
+
+- `boolean`: 是否成功。
+
+### `executeQuery`
+
+执行查询语句，返回结果集。
+
+```javascript
+executeQuery(sql: string, withArgumentsInArray: NSArray): SQLiteResultSet
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `sql` | `string` | SQL 语句。 |
+| `withArgumentsInArray` | `NSArray` | 参数数组。 |
+
+**Return Value:**
+
+- `SQLiteResultSet`: 结果集。
+
+### `beginTransaction`
+
+开始事务。
+
+```javascript
+beginTransaction(): void
+```
+
+**Return Value:**
+
+- 无。
+
+### `commit`
+
+提交事务。
+
+```javascript
+commit(): void
+```
+
+**Return Value:**
+
+- 无。
+
+### `rollback`
+
+回滚事务。
+
+```javascript
+rollback(): void
+```
+
+**Return Value:**
+
+- 无。
+
+### `lastErrorMessage`
+
+最后一条错误消息。
+
+```javascript
+lastErrorMessage(): string
+```
+
+**Return Value:**
+
+- `string`: 错误消息。
+
+### `lastErrorCode`
+
+最后一条错误码。
+
+```javascript
+lastErrorCode(): number
+```
+
+**Return Value:**
+
+- `number`: 错误码。
+
+### `lastError`
+
+最后一条错误对象。
+
+```javascript
+lastError(): NSError
+```
+
+**Return Value:**
+
+- `NSError`: 错误对象。
+
+## 相关
+
+- [SQLiteResultSet](/reference/utility/sqlite-result-set/)
+- [SQLiteStatement](/reference/utility/sqlite-statement/)