diff options
Diffstat (limited to 'doc/en')
| -rw-r--r-- | doc/en/autogen/plugin_api/infolists.txt | 2 | ||||
| -rw-r--r-- | doc/en/autogen/user/weechat_commands.txt | 1 | ||||
| -rw-r--r-- | doc/en/weechat_plugin_api.en.txt | 78 |
3 files changed, 58 insertions, 23 deletions
diff --git a/doc/en/autogen/plugin_api/infolists.txt b/doc/en/autogen/plugin_api/infolists.txt index 237da84da..90f17b1dc 100644 --- a/doc/en/autogen/plugin_api/infolists.txt +++ b/doc/en/autogen/plugin_api/infolists.txt @@ -48,7 +48,7 @@ | weechat | hotlist | list of buffers in hotlist | - | - -| weechat | key | list of key bindings | - | context ("default" or "search") (optional) +| weechat | key | list of key bindings | - | context ("default", "search", "cursor" or "mouse") (optional) | weechat | nicklist | nicks in nicklist for a buffer | buffer pointer | nick_xxx or group_xxx to get only nick/group xxx (optional) diff --git a/doc/en/autogen/user/weechat_commands.txt b/doc/en/autogen/user/weechat_commands.txt index 29fd1b6cf..cbba23932 100644 --- a/doc/en/autogen/user/weechat_commands.txt +++ b/doc/en/autogen/user/weechat_commands.txt @@ -350,6 +350,7 @@ For context "mouse" (possible in context "cursor" too), key has format: "@area:k bar(xxx): bar "xxx" item(*): any bar item item(xxx): bar item "xxx" +The key can start or end with '*' to match many mouse events. Examples: key alt-x to toggle nicklist bar: diff --git a/doc/en/weechat_plugin_api.en.txt b/doc/en/weechat_plugin_api.en.txt index de7470bf1..159df6a8b 100644 --- a/doc/en/weechat_plugin_api.en.txt +++ b/doc/en/weechat_plugin_api.en.txt @@ -3267,9 +3267,12 @@ Arguments: *** 'buffer': buffer *** 'time': time ** 'keys': string with list of keys (format: "key1,key2,key3") +** 'keys_sorted': string with list of sorted keys (format: "key1,key2,key3") ** 'values': string with list of values (format: "value1,value2,value3") ** 'keys_values': string with list of keys and values (format: "key1:value1,key2:value2,key3:value3") +** 'keys_values_sorted': string with list of keys and values (sorted by keys) + (format: "key1:value1,key2:value2,key3:value3") Return value: @@ -8253,34 +8256,65 @@ Arguments: value: ** 'void *data': pointer ** 'struct t_hashtable *info': hashtable with info on focus and strings returned - by other calls to focus callbacks (with higher priority); keys and values - are of type "string"; info on focus (filled by WeeChat) are: -*** '_x': column of focus on screen (first column on the left is "0") -*** '_y': line of focus on screen (first line on top is "0") -*** '_window': pointer of window with focus ("0x0" for a bar of type "root" - or for unknown area) -*** '_window_number': number of window with focus (not set for a bar of type - "root" or for unknown area) -*** '_buffer': pointer of buffer with focus ("0x0" for a bar of type "root" - or for unknown area) -*** '_buffer_number': number of buffer with focus (not set for a bar of type - "root" or for unknown area) -*** '_buffer_plugin': plugin name of buffer with focus (not set for a bar of - type "root" or for unknown area) -*** '_buffer_name': name of buffer with focus (not set for a bar of type "root" - or for unknown area) -*** '_bar_name': name of bar with focus (NULL for chat area or for unknown - area) -*** '_bar_item_name': name of bar item with focus (NULL if focus is not in a - bar or if focus is after the end of last bar item) -*** '_item_line': line with focus in bar item (first line of bar item is "0") -*** '_item_col': column with focus in bar item (first column of bar item is "0") + by other calls to focus callbacks (with higher priority) (see table below) ** return value: either "info" pointer (hashtable completed), or pointer to a new hashtable (created by callback, with keys and values of type "string"), this new hashtable content will be added to 'info' for other calls to focus callbacks * 'callback_data': pointer given to callback when it is called by WeeChat +[IMPORTANT] +For a mouse gesture, your callback will be called two times: first time when +button is pressed (here the area always matches your area), second time when +button is released, and then the area may not match your area: so you must +*always* test in your callback if area is matching before using info in +hashtable. + +Content of hashtable sent to callback (keys and values are of type "string"): + +[width="100%",cols="4m,6,8,8",options="header"] +|======================================== +| Key ^(1)^ | Description | Value | Value if N/A +| _x | column on screen 2+| "0" ... "n" +| _y | line on screen 2+| "0" ... "n" +| _window | pointer of window | "0x12345678" | "0x0" +| _window_number | number of window | "1" ... "n" | "*" +| _chat | chat area indicator | "0" or "1" | "0" +| _buffer | pointer of buffer | "0x12345678" | "0x0" +| _buffer_number | number of buffer | "1" ... "n" | "" +| _buffer_plugin | plugin name of buffer | "core", "irc", ... | "" +| _buffer_name | name of buffer | "weechat", "freenode.#weechat", ... | "" +| _bar_name | name of bar | "title", "nicklist", ... | "" +| _bar_filling | filling of bar | "horizontal", "vertical", ... | "" +| _bar_item_name | name of bar item | "buffer_nicklist", ... | "" +| _item_line | line in bar item | "0" ... "n" | "-1" +| _item_col | column in bar item | "0" ... "n" | "-1" +| _key | key or mouse event 2+| "button1", "button2-gesture-left", ... +|======================================== + +[NOTE] +^(1)^ There are same keys suffixed with "2" (ie: "_x2", "_y2", "_window2", ...) +with info on second point (useful only for mouse gestures, to know where mouse +button has been released). + +Extra info for bar item "buffer_nicklist": + +[width="70%",cols="3m,3,8",options="header"] +|======================================== +| Key | Plugin ^(1)^ | Description +| nick | core | nick name +| prefix | core | prefix for nick +| group | core | group name +| host | irc | host for nick (if known) +| server | irc | internal name of server +| channel | irc | channel name +|======================================== + +[NOTE] +^(1)^ The name of plugin which defines a hook_focus to return info for this bar +item (so for example if plugin is "irc", such info will be available only on +irc buffers). + Return value: * pointer to new hook, NULL if error occured |