Skip to content

Commit

Permalink
ドキュメント記載: nyagos.bindkey("キー名",function()...end)
Browse files Browse the repository at this point in the history
  • Loading branch information
hymkor committed Oct 11, 2014
1 parent 8b3d7f9 commit 5054feb
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
9 changes: 9 additions & 0 deletions nyagos_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,15 @@ FUNCNAME are:
If it succeeded, it returns true only. Failed, it returns nil and error-message.
Cases are ignores and, the character '-' is same as '\_'.

### `nyagos.bindkey("KEYNAME",function()...end)`

When the key is pressed, call the function.

The return value of function is used as below

* When it is a string, it is inserted into cursor position.
* When it is nil, it is ignored.

### `nyagos.filter = function(cmdline) ... end`

`nyagos.filter` can modify user input command-line.
Expand Down
7 changes: 7 additions & 0 deletions nyagos_ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,13 @@ UTF8
成功すると true を、失敗すると nil とエラーメッセージを返します。
大文字・小文字は区別せず、\_ のかわりに - を使うことができます。

### `nyagos.bindkey("キー名",function() ... end)`

キーが押下された時、関数を呼び出します。戻り値は次のように使われます。

* 文字列の時: カーソル位置に挿入されます。
* nil の時: 無視されます。

### `nyagos.filter`

通常ユーザが呼び出すことはありません。
Expand Down

0 comments on commit 5054feb

Please sign in to comment.