summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
authorTrygve Aaberge <trygveaa@gmail.com>2020-05-09 18:06:01 +0200
committerSébastien Helleu <flashcode@flashtux.org>2020-05-09 18:07:36 +0200
commit63714855d3cbedc49747b099533a5a259cbd74c2 (patch)
tree02b320fe54b0153fcabd0eb0e51dbfb0454d528c /doc/en
parent30afb3debe18645fd8bf645a735e3c033478913b (diff)
downloadweechat-63714855d3cbedc49747b099533a5a259cbd74c2.zip
core: add an option for multiline input in a buffer (closes #984)
This allows the input callback function for a buffer to receive multiple lines at once, instead of the message being split on newline before being sent to the callback. It adds a new flag, input_multiline, to control this. This flag defaults to 0 which is the current behavior.
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/includes/autogen_api_hdata.en.adoc1
-rw-r--r--doc/en/weechat_plugin_api.en.adoc6
-rw-r--r--doc/en/weechat_relay_protocol.en.adoc1
3 files changed, 8 insertions, 0 deletions
diff --git a/doc/en/includes/autogen_api_hdata.en.adoc b/doc/en/includes/autogen_api_hdata.en.adoc
index f99216f2e..dbfcd6ae6 100644
--- a/doc/en/includes/autogen_api_hdata.en.adoc
+++ b/doc/en/includes/autogen_api_hdata.en.adoc
@@ -589,6 +589,7 @@ _input_callback_pointer_   (pointer) +
_input_callback_data_   (pointer) +
_input_get_unknown_commands_   (integer) +
_input_get_empty_   (integer) +
+_input_multiline_   (integer) +
_input_buffer_   (string) +
_input_buffer_alloc_   (integer) +
_input_buffer_size_   (integer) +
diff --git a/doc/en/weechat_plugin_api.en.adoc b/doc/en/weechat_plugin_api.en.adoc
index ed4acb541..75dd458d3 100644
--- a/doc/en/weechat_plugin_api.en.adoc
+++ b/doc/en/weechat_plugin_api.en.adoc
@@ -12782,6 +12782,8 @@ Arguments:
** _input_get_unknown_commands_: 1 if unknown commands are sent to input
callback, otherwise 0
** _input_get_empty_: 1 if empty input is sent to input callback, otherwise 0
+** _input_multiline_: 1 if multiple lines are sent as one message to input
+ callback, otherwise 0
** _input_size_: input size (in bytes)
** _input_length_: input length (number of chars)
** _input_pos_: cursor position in buffer input
@@ -13083,6 +13085,10 @@ Properties:
| input_get_empty | "0" or "1" |
"0" to disable empty input on this buffer (default behavior), "1" to get empty input.
+| input_multiline | "0" or "1" |
+ "0" to send each line separately to this buffer (default behavior), "1" to
+ send multiple lines as a single message.
+
| localvar_set_xxx | any string |
Set new value for local variable _xxx_ (variable is created if it does not
exist).
diff --git a/doc/en/weechat_relay_protocol.en.adoc b/doc/en/weechat_relay_protocol.en.adoc
index d7b9a2e62..02523670a 100644
--- a/doc/en/weechat_relay_protocol.en.adoc
+++ b/doc/en/weechat_relay_protocol.en.adoc
@@ -673,6 +673,7 @@ inl:
input: 1
input_get_unknown_commands: 0
input_get_empty: 0
+ input_multiline: 0
input_buffer: ''
input_buffer_alloc: 256
input_buffer_size: 0