mirror of
https://github.com/mii443/AzooKeyKanaKanjiConverter.git
synced 2025-08-22 06:55:26 +00:00
70 lines
2.8 KiB
Markdown
70 lines
2.8 KiB
Markdown
# ComposingText API
|
|
|
|
AzooKeyKanaKanjiConverterにおいて、変換を要求するには`ComposingText`のAPIを使う必要があります。この`ComposingText` APIについて説明します。
|
|
|
|
## 基本的なアイデア
|
|
|
|
`ComposingText`の基本的なアイデアは「入力操作との対応」です。ユーザが日本語IMEを操作するとき、「きょうはいいてんきですね」と一文字ずつ入力することもあれば、「kyouhaiitenkidesune」のようにローマ字入力を行うこともあります。azooKeyでは前者をダイレクト入力、後者をローマ字入力と呼んでいます。`ComposingText`はこのような入力操作をうまく扱いながら、変換を逐次的に実行するために役立ちます。
|
|
|
|
## 基本的な使い方
|
|
|
|
`ComposingText`を使い始めるには、まず空の値を作ります。
|
|
|
|
```swift
|
|
var composingText = ComposingText()
|
|
```
|
|
|
|
次に、末尾に文字を追加します。このために使うのが`insertAtCursorPosition`です。
|
|
|
|
```swift
|
|
composingText.insertAtCursorPosition("あ", inputStyle: .direct)
|
|
```
|
|
|
|
|
|
このとき、`ComposingText`の内部状態は次のようになっています。
|
|
|
|
|
|
```swift
|
|
print(composingText.input) // [InputElement("あ", .direct)]
|
|
print(composingText.convertTargetCursorPosition) // 1 (あ|)
|
|
print(composingText.convertTarget) // あ
|
|
```
|
|
|
|
非常に自明です。ではローマ字入力の場合はどうなるでしょうか。
|
|
|
|
```swift
|
|
composingText.insertAtCursorPosition("o", inputStyle: .roman2kana)
|
|
```
|
|
|
|
この場合は少し異なることが起こります。`input`に`"o"`が正しく保存されるのです。
|
|
|
|
|
|
```swift
|
|
print(composingText.input) // [InputElement("あ", .direct), InputElement("o", .roman2kana)]
|
|
print(composingText.convertTargetCursorPosition) // 2 (あお|)
|
|
print(composingText.convertTarget) // あお
|
|
```
|
|
|
|
一方、`convertTarget`の方は正しくローマ字入力した仮名表記になっています。このように`convertTarget`の方はユーザに実際に見える「見かけの文字列」であり、実装側はこれが実際にユーザに見えているよう保障する必要があります。`convertTargetCursorPosition`についても同様で、実装側は`convertTargetCursorPosition`に示されたカーソル位置が実際にユーザに見えているカーソル位置と一致するよう配慮する必要があります。
|
|
|
|
## 操作するAPI
|
|
|
|
### 削除
|
|
|
|
`deleteForwardFromCursorPosition`および`deleteBackwardFromCursorPosition`が使えます。
|
|
|
|
|
|
### カーソル移動
|
|
|
|
`moveCursorFromCursorPosition`が使えます。
|
|
|
|
|
|
### 文頭の削除
|
|
|
|
`prefixComplete`が使えます。
|
|
|
|
|
|
### 置換
|
|
|
|
専用のAPIはありません。削除と挿入で代用してください。
|