diff options
Diffstat (limited to 'doc/en/weechat_plugin_api.en.txt')
| -rw-r--r-- | doc/en/weechat_plugin_api.en.txt | 116 |
1 files changed, 66 insertions, 50 deletions
diff --git a/doc/en/weechat_plugin_api.en.txt b/doc/en/weechat_plugin_api.en.txt index 7599bee6c..93844de12 100644 --- a/doc/en/weechat_plugin_api.en.txt +++ b/doc/en/weechat_plugin_api.en.txt @@ -6076,7 +6076,14 @@ const char *weechat_prefix (const char *prefix); Arguments: -* 'prefix': name of prefix: +* 'prefix': name of prefix (see table below) + +Return value: + +* prefix value (string with prefix and color codes), empty string if prefix is + not found + +List of prefixes: [width="70%",cols="^2e,^1,^3,5",options="header"] |=== @@ -6091,11 +6098,6 @@ Arguments: [NOTE] Values and colors can be customized with command `/set`. -Return value: - -* prefix value (string with prefix and color codes), empty string if prefix is - not found - C example: [source,C] @@ -6854,8 +6856,8 @@ struct t_hook *weechat_hook_process (const char *command, Arguments: -* 'command': command to launch in child process or URL _(WeeChat ≥ 0.3.7)_, - see below +* 'command': command to launch in child process or URL _(WeeChat ≥ 0.3.7)_ + (see below) * 'timeout': timeout for command (in milliseconds): after this timeout, child process is killed (0 means no timeout) * 'callback': function called when data from child is available, or when child @@ -7437,7 +7439,8 @@ struct t_hook *weechat_hook_signal (const char *signal, Arguments: * 'signal': signal to catch, can begin or end with "*" - (priority allowed, see note about <<hook_priority,priority>>), see table below + (priority allowed, see note about <<hook_priority,priority>>) + (see table below) * 'callback': function called when signal is received, arguments and return value: ** 'void *data': pointer @@ -8229,7 +8232,25 @@ struct t_hook *weechat_hook_hsignal (const char *signal, Arguments: * 'signal': signal to catch, can begin or end with "*" - (priority allowed, see note about <<hook_priority,priority>>): + (priority allowed, see note about <<hook_priority,priority>>) + (see table below) +* 'callback': function called when signal is received, arguments and return + value: +** 'void *data': pointer +** 'const char *signal': signal received +** 'struct t_hashtable *hashtable': hashtable +** return value: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_OK_EAT' (stop sending the signal immediately) + _(WeeChat ≥ 0.4.0)_ +*** 'WEECHAT_RC_ERROR' +* 'callback_data': pointer given to callback when it is called by WeeChat + +Return value: + +* pointer to new hook, NULL if error occurred + +List of hsignals: [width="100%",cols="^1,^3,5,5",options="header"] |=== @@ -8287,22 +8308,6 @@ Arguments: ^(1)^ 'xxx' is signal argument used in redirection, 'yyy' is redirection pattern. -* 'callback': function called when signal is received, arguments and return - value: -** 'void *data': pointer -** 'const char *signal': signal received -** 'struct t_hashtable *hashtable': hashtable -** return value: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_OK_EAT' (stop sending the signal immediately) - _(WeeChat ≥ 0.4.0)_ -*** 'WEECHAT_RC_ERROR' -* 'callback_data': pointer given to callback when it is called by WeeChat - -Return value: - -* pointer to new hook, NULL if error occurred - C example: [source,C] @@ -8824,7 +8829,21 @@ struct t_hook *weechat_hook_modifier (const char *modifier, Arguments: * 'modifier': modifier name, list of modifiers used by Weechat or plugins - (priority allowed, see note about <<hook_priority,priority>>): + (priority allowed, see note about <<hook_priority,priority>>) + (see table below) +* 'callback': function called when modifier is used, arguments and return value: +** 'void *data': pointer +** 'const char *modifier': name of modifier +** 'const char *modifier_data': data for modifier +** 'const char *string': string to modify +** return value: new string +* 'callback_data': pointer given to callback when it is called by WeeChat + +Return value: + +* pointer to new hook, NULL if error occurred + +List of modifiers used by WeeChat and plugins: [width="100%",cols="^2,3,4,4",options="header"] |=== @@ -8926,18 +8945,6 @@ Arguments: ^(1)^ 'xxx' is IRC command name. + ^(2)^ 'yyy' is bar name. -* 'callback': function called when modifier is used, arguments and return value: -** 'void *data': pointer -** 'const char *modifier': name of modifier -** 'const char *modifier_data': data for modifier -** 'const char *string': string to modify -** return value: new string -* 'callback_data': pointer given to callback when it is called by WeeChat - -Return value: - -* pointer to new hook, NULL if error occurred - C example: [source,C] @@ -12109,8 +12116,7 @@ const char *weechat_info_get (const char *info_name, const char *arguments); Arguments: -* 'info_name': name of info to read: -include::autogen/plugin_api/infos.txt[] +* 'info_name': name of info to read (see table below) * 'arguments': arguments for info asked (optional, NULL if no argument is needed) @@ -12118,6 +12124,10 @@ Return value: * string with info asked, NULL if an error occurred +Infos: + +include::autogen/plugin_api/infos.txt[] + C example: [source,C] @@ -12158,8 +12168,7 @@ struct t_hashtable *weechat_info_get_hashtable (const char *info_name, Arguments: -* 'info_name': name of info to read: -include::autogen/plugin_api/infos_hashtable.txt[] +* 'info_name': name of info to read (see table below) * 'hashtable': hashtable with arguments (depends on info asked) (optional, NULL if no argument is needed) @@ -12167,6 +12176,10 @@ Return value: * hashtable with info asked, NULL if an error occurred +Infos: + +include::autogen/plugin_api/infos_hashtable.txt[] + C example: [source,C] @@ -12531,8 +12544,7 @@ struct t_infolist *weechat_infolist_get (const char *infolist_name, Arguments: -* 'infolist_name': name of infolist to read: -include::autogen/plugin_api/infolists.txt[] +* 'infolist_name': name of infolist to read (see table below) * 'pointer': pointer to an item, to get only this item in infolist (optional, can be NULL) * 'arguments': arguments for infolist asked (optional, NULL if no argument is @@ -12542,6 +12554,10 @@ Return value: * pointer to infolist, NULL if an error occurred +Infolists: + +include::autogen/plugin_api/infolists.txt[] + C example: [source,C] @@ -13198,16 +13214,16 @@ struct t_hdata *weechat_hdata_get (const char *hdata_name); Arguments: -* 'hdata_name': name of hdata - -List of hdata: - -include::autogen/plugin_api/hdata.txt[] +* 'hdata_name': name of hdata (see list below) Return value: * pointer to hdata, NULL if an error occurred +List of hdata: + +include::autogen/plugin_api/hdata.txt[] + C example: [source,C] |