From f2bc0b1a81f88b0bca18c6e7892282ec55257223 Mon Sep 17 00:00:00 2001 From: Charlotte Meyer Date: Thu, 9 Jan 2020 13:53:23 +0000 Subject: [PATCH] Add extra information to docs --- lua_docs.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/lua_docs.md b/lua_docs.md index 1c8d6ee..580d372 100644 --- a/lua_docs.md +++ b/lua_docs.md @@ -81,11 +81,17 @@ Returns the view at the cursor position, or `nil` if there is none. A mouse button got pressed. Callback receives the ID of the button (i.e. LMB is 1, RMB is 2, ...). +The callback is supposed to return `true` if the event was handled. +The compositor will not forward it to the view under the cursor. + #### button_up A mouse button got released. Callback receives the ID of the button (i.e. LMB is 1, RMB is 2, ...). +The callback is supposed to return `true` if the event was handled. +The compositor will not forward it to the view under the cursor. + #### motion The cursor got moved. @@ -113,11 +119,17 @@ Used to register event listeners. A key got pressed. Callback receives a table containing the `key` and the `keyboard`). +The callback is supposed to return `true` if the event was handled. +The compositor will not forward it to the focused view in that case. + #### key_up A key got released. Callback receives a table containing the `key` and the `keyboard`). +The callback is supposed to return `true` if the event was handled. +The compositor will not forward it to the focused view in that case. + ## kiwmi_lua_callback A handle to a registered callback. @@ -219,6 +231,8 @@ Unhides the view. Returns the size of the view. +**NOTE**: Used directly after `view:resize()`, this still returns the old size. + #### view:tiled(edges) Takes a table containing all edges that are tiled, or a bool to indicate all 4 edges.