summaryrefslogtreecommitdiff
path: root/doc/it/includes
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2021-03-17 21:56:07 +0100
committerSébastien Helleu <flashcode@flashtux.org>2021-03-17 21:57:16 +0100
commit8ee7d46605b70474350a20855e2ef755e6c3dc82 (patch)
tree3fd92bec9baa97726c9ea9a0982f51e35039aeff /doc/it/includes
parentc54cadace5fd262ac5c70226e98f3dd1bef4f689 (diff)
downloadweechat-8ee7d46605b70474350a20855e2ef755e6c3dc82.zip
api: add support of pointer names in function string_eval_expression (direct and in hdata)
These two formats are now supported, if "pointer_name" is present in the "pointers" hashtable: * "${pointer_name}": value of pointer (example: "0x1234abcd") * ${buffer[pointer_name].full_name}: use of a pointer name instead of pointer value or list name
Diffstat (limited to 'doc/it/includes')
-rw-r--r--doc/it/includes/autogen_user_commands.it.adoc3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/it/includes/autogen_user_commands.it.adoc b/doc/it/includes/autogen_user_commands.it.adoc
index 3edfb8f9d..c75beaaec 100644
--- a/doc/it/includes/autogen_user_commands.it.adoc
+++ b/doc/it/includes/autogen_user_commands.it.adoc
@@ -1364,11 +1364,12 @@ Some variables are replaced in expression, using the format ${variable}, variabl
20. a hdata name/variable (the value is automatically converted to string), by default "window" and "buffer" point to current window/buffer.
Format for hdata can be one of following:
hdata.var1.var2...: start with a hdata (pointer must be known), and ask variables one after one (other hdata can be followed)
- hdata[list].var1.var2...: start with a hdata using a list, for example:
+ hdata[list].var1.var2...: start with a hdata using a list/pointer/pointer name, for example:
${buffer[gui_buffers].full_name}: full name of first buffer in linked list of buffers
${plugin[weechat_plugins].name}: name of first plugin in linked list of plugins
hdata[pointer].var1.var2...: start with a hdata using a pointer, for example:
${buffer[0x1234abcd].full_name}: full name of the buffer with this pointer (can be used in triggers)
+ ${buffer[my_pointer].full_name}: full name of the buffer with this pointer name (can be used in triggers)
For name of hdata and variables, please look at "Plugin API reference", function "weechat_hdata_get".
Examples (simple strings):