summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/weechat_scripting.en.asciidoc374
1 files changed, 276 insertions, 98 deletions
diff --git a/doc/en/weechat_scripting.en.asciidoc b/doc/en/weechat_scripting.en.asciidoc
index 10ecb0c7a..2deff4bed 100644
--- a/doc/en/weechat_scripting.en.asciidoc
+++ b/doc/en/weechat_scripting.en.asciidoc
@@ -382,85 +382,235 @@ _WeeChat Plugin API Reference_.
List of functions in script API:
-[width="100%",cols="^1,10",options="header"]
+[width="75%",cols="1,3",options="header"]
|===
-| Category | Functions
-| general |
+| Category | Functions
+
+| general |
register
-| plugins |
+
+| plugins |
plugin_get_name
-| strings |
- charset_set, iconv_to_internal, iconv_from_internal, gettext, ngettext, +
- strlen_screen, string_match, string_has_highlight, string_has_highlight_regex,
- string_mask_to_regex, string_remove_color, string_is_command_char,
- string_input_for_buffer, string_eval_expression, string_eval_path_home
-| directories |
- mkdir_home, mkdir, mkdir_parents
-| sorted lists |
- list_new, list_add, list_search, list_search_pos, list_casesearch,
- list_casesearch_pos, list_get, list_set, list_next, list_prev, list_string,
- list_size, list_remove, list_remove_all, list_free
+
+| strings |
+ charset_set +
+ iconv_to_internal +
+ iconv_from_internal +
+ gettext +
+ ngettext +
+ strlen_screen +
+ string_match +
+ string_has_highlight +
+ string_has_highlight_regex +
+ string_mask_to_regex +
+ string_remove_color +
+ string_is_command_char +
+ string_input_for_buffer +
+ string_eval_expression +
+ string_eval_path_home
+
+| directories |
+ mkdir_home +
+ mkdir +
+ mkdir_parents
+
+| sorted lists |
+ list_new +
+ list_add +
+ list_search +
+ list_search_pos +
+ list_casesearch +
+ list_casesearch_pos +
+ list_get +
+ list_set +
+ list_next +
+ list_prev +
+ list_string +
+ list_size +
+ list_remove +
+ list_remove_all +
+ list_free
+
| configuration files |
- config_new, config_new_section, config_search_section, config_new_option,
- config_search_option, +
- config_string_to_boolean, config_option_reset, config_option_set,
- config_option_set_null, config_option_unset, config_option_rename,
- config_option_is_null, config_option_default_is_null, +
- config_boolean, config_boolean_default, config_integer, config_integer_default,
- config_string, config_string_default, config_color, config_color_default, +
- config_write_option, config_write_line, config_write, config_read,
- config_reload, +
- config_option_free, config_section_free_options, config_section_free,
- config_free, +
- config_get, config_get_plugin, config_is_set_plugin, config_set_plugin,
- config_set_desc_plugin, config_unset_plugin
-| key bindings |
- key_bind, key_unbind
-| display |
- prefix, color, print (for python: prnt), print_date_tags (for python:
- prnt_date_tags), print_y (for python: prnt_y), log_print
-| hooks |
- hook_command, hook_command_run, hook_timer, hook_fd, hook_process,
- hook_process_hashtable, hook_connect, hook_print, hook_signal,
- hook_signal_send, hook_hsignal, hook_hsignal_send, hook_config,
- hook_completion, hook_completion_list_add, hook_modifier, hook_modifier_exec,
- hook_info, hook_info_hashtable, hook_infolist, hook_focus, hook_set, unhook,
+ config_new +
+ config_new_section +
+ config_search_section +
+ config_new_option +
+ config_search_option +
+ config_string_to_boolean +
+ config_option_reset +
+ config_option_set +
+ config_option_set_null +
+ config_option_unset +
+ config_option_rename +
+ config_option_is_null +
+ config_option_default_is_null +
+ config_boolean +
+ config_boolean_default +
+ config_integer +
+ config_integer_default +
+ config_string +
+ config_string_default +
+ config_color +
+ config_color_default +
+ config_write_option +
+ config_write_line +
+ config_write +
+ config_read +
+ config_reload +
+ config_option_free +
+ config_section_free_options +
+ config_section_free +
+ config_free +
+ config_get +
+ config_get_plugin +
+ config_is_set_plugin +
+ config_set_plugin +
+ config_set_desc_plugin +
+ config_unset_plugin
+
+| key bindings |
+ key_bind +
+ key_unbind
+
+| display |
+ prefix +
+ color +
+ print (for python: prnt) +
+ print_date_tags (for python:
+ prnt_date_tags) +
+ print_y (for python: prnt_y) +
+ log_print
+
+| hooks |
+ hook_command +
+ hook_command_run +
+ hook_timer +
+ hook_fd +
+ hook_process +
+ hook_process_hashtable +
+ hook_connect +
+ hook_print +
+ hook_signal +
+ hook_signal_send +
+ hook_hsignal +
+ hook_hsignal_send +
+ hook_config +
+ hook_completion +
+ hook_completion_list_add +
+ hook_modifier +
+ hook_modifier_exec +
+ hook_info +
+ hook_info_hashtable +
+ hook_infolist +
+ hook_focus +
+ hook_set +
+ unhook +
unhook_all
-| buffers |
- buffer_new, current_buffer, buffer_search, buffer_search_main, buffer_clear,
- buffer_close, buffer_merge, buffer_unmerge, buffer_get_integer,
- buffer_get_string, buffer_get_pointer, buffer_set,
- buffer_string_replace_local_var, buffer_match_list
-| windows |
- current_window, window_search_with_buffer, window_get_integer,
- window_get_string, window_get_pointer, window_set_title
-| nicklist |
- nicklist_add_group, nicklist_search_group, nicklist_add_nick,
- nicklist_search_nick, nicklist_remove_group, nicklist_remove_nick,
- nicklist_remove_all, nicklist_group_get_integer, nicklist_group_get_string,
- nicklist_group_get_pointer, nicklist_group_set, nicklist_nick_get_integer,
- nicklist_nick_get_string, nicklist_nick_get_pointer, nicklist_nick_set
-| bars |
- bar_item_search, bar_item_new, bar_item_update, bar_item_remove, bar_search,
- bar_new, bar_set, bar_update, bar_remove
-| commands |
+
+| buffers |
+ buffer_new +
+ current_buffer +
+ buffer_search +
+ buffer_search_main +
+ buffer_clear +
+ buffer_close +
+ buffer_merge +
+ buffer_unmerge +
+ buffer_get_integer +
+ buffer_get_string +
+ buffer_get_pointer +
+ buffer_set +
+ buffer_string_replace_local_var +
+ buffer_match_list
+
+| windows |
+ current_window +
+ window_search_with_buffer +
+ window_get_integer +
+ window_get_string +
+ window_get_pointer +
+ window_set_title
+
+| nicklist |
+ nicklist_add_group +
+ nicklist_search_group +
+ nicklist_add_nick +
+ nicklist_search_nick +
+ nicklist_remove_group +
+ nicklist_remove_nick +
+ nicklist_remove_all +
+ nicklist_group_get_integer +
+ nicklist_group_get_string +
+ nicklist_group_get_pointer +
+ nicklist_group_set +
+ nicklist_nick_get_integer +
+ nicklist_nick_get_string +
+ nicklist_nick_get_pointer +
+ nicklist_nick_set
+
+| bars |
+ bar_item_search +
+ bar_item_new +
+ bar_item_update +
+ bar_item_remove +
+ bar_search +
+ bar_new +
+ bar_set +
+ bar_update +
+ bar_remove
+
+| commands |
command
-| infos |
- info_get, info_get_hashtable
-| infolists |
- infolist_new, infolist_new_item, infolist_new_var_integer,
- infolist_new_var_string, infolist_new_var_pointer, infolist_new_var_time, +
- infolist_get, infolist_next, infolist_prev, infolist_reset_item_cursor, +
- infolist_fields, infolist_integer, infolist_string, infolist_pointer, +
- infolist_time, infolist_free
-| hdata |
- hdata_get, hdata_get_var_offset, hdata_get_var_type_string,
- hdata_get_var_array_size, hdata_get_var_array_size_string,
- hdata_get_var_hdata, hdata_get_list, hdata_check_pointer, hdata_move,
- hdata_search, hdata_char, hdata_integer, hdata_long, hdata_string,
- hdata_pointer, hdata_time, hdata_hashtable, hdata_update, hdata_get_string
-| upgrade |
- upgrade_new, upgrade_write_object, upgrade_read, upgrade_close
+
+| infos |
+ info_get +
+ info_get_hashtable
+
+| infolists |
+ infolist_new +
+ infolist_new_item +
+ infolist_new_var_integer +
+ infolist_new_var_string +
+ infolist_new_var_pointer +
+ infolist_new_var_time +
+ infolist_get +
+ infolist_next +
+ infolist_prev +
+ infolist_reset_item_cursor +
+ infolist_fields +
+ infolist_integer +
+ infolist_string +
+ infolist_pointer +
+ infolist_time +
+ infolist_free
+
+| hdata |
+ hdata_get +
+ hdata_get_var_offset +
+ hdata_get_var_type_string +
+ hdata_get_var_array_size +
+ hdata_get_var_array_size_string +
+ hdata_get_var_hdata +
+ hdata_get_list +
+ hdata_check_pointer +
+ hdata_move +
+ hdata_search +
+ hdata_char +
+ hdata_integer +
+ hdata_long +
+ hdata_string +
+ hdata_pointer +
+ hdata_time +
+ hdata_hashtable +
+ hdata_update +
+ hdata_get_string
+
+| upgrade |
+ upgrade_new +
+ upgrade_write_object +
+ upgrade_read +
+ upgrade_close
|===
[[script_api_constants]]
@@ -468,35 +618,63 @@ List of functions in script API:
List of constants in script API:
-[width="100%",cols="^1,10",options="header"]
+[width="75%",cols="1,3",options="header"]
|===
-| Category | Constants
-| return codes |
- WEECHAT_RC_OK, WEECHAT_RC_OK_EAT, WEECHAT_RC_ERROR
+| Category | Constants
+
+| return codes |
+ WEECHAT_RC_OK +
+ WEECHAT_RC_OK_EAT +
+ WEECHAT_RC_ERROR
+
| configuration files |
- WEECHAT_CONFIG_READ_OK, WEECHAT_CONFIG_READ_MEMORY_ERROR,
- WEECHAT_CONFIG_READ_FILE_NOT_FOUND, WEECHAT_CONFIG_WRITE_OK,
- WEECHAT_CONFIG_WRITE_ERROR, WEECHAT_CONFIG_WRITE_MEMORY_ERROR, +
- WEECHAT_CONFIG_OPTION_SET_OK_CHANGED, WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE,
- WEECHAT_CONFIG_OPTION_SET_ERROR, WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND,
- WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET, WEECHAT_CONFIG_OPTION_UNSET_OK_RESET,
- WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED, WEECHAT_CONFIG_OPTION_UNSET_ERROR
-| sorted lists |
- WEECHAT_LIST_POS_SORT, WEECHAT_LIST_POS_BEGINNING, WEECHAT_LIST_POS_END
-| hotlist |
- WEECHAT_HOTLIST_LOW, WEECHAT_HOTLIST_MESSAGE, WEECHAT_HOTLIST_PRIVATE,
+ WEECHAT_CONFIG_READ_OK +
+ WEECHAT_CONFIG_READ_MEMORY_ERROR +
+ WEECHAT_CONFIG_READ_FILE_NOT_FOUND +
+ WEECHAT_CONFIG_WRITE_OK +
+ WEECHAT_CONFIG_WRITE_ERROR +
+ WEECHAT_CONFIG_WRITE_MEMORY_ERROR +
+ WEECHAT_CONFIG_OPTION_SET_OK_CHANGED +
+ WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE +
+ WEECHAT_CONFIG_OPTION_SET_ERROR +
+ WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND +
+ WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET +
+ WEECHAT_CONFIG_OPTION_UNSET_OK_RESET +
+ WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED +
+ WEECHAT_CONFIG_OPTION_UNSET_ERROR
+
+| sorted lists |
+ WEECHAT_LIST_POS_SORT +
+ WEECHAT_LIST_POS_BEGINNING +
+ WEECHAT_LIST_POS_END
+
+| hotlist |
+ WEECHAT_HOTLIST_LOW +
+ WEECHAT_HOTLIST_MESSAGE +
+ WEECHAT_HOTLIST_PRIVATE +
WEECHAT_HOTLIST_HIGHLIGHT
-| hook process |
- WEECHAT_HOOK_PROCESS_RUNNING, WEECHAT_HOOK_PROCESS_ERROR
-| hook connect |
- WEECHAT_HOOK_CONNECT_OK, WEECHAT_HOOK_CONNECT_ADDRESS_NOT_FOUND,
- WEECHAT_HOOK_CONNECT_IP_ADDRESS_NOT_FOUND, WEECHAT_HOOK_CONNECT_CONNECTION_REFUSED,
- WEECHAT_HOOK_CONNECT_PROXY_ERROR, WEECHAT_HOOK_CONNECT_LOCAL_HOSTNAME_ERROR,
- WEECHAT_HOOK_CONNECT_GNUTLS_INIT_ERROR, WEECHAT_HOOK_CONNECT_GNUTLS_HANDSHAKE_ERROR,
- WEECHAT_HOOK_CONNECT_MEMORY_ERROR, WEECHAT_HOOK_CONNECT_TIMEOUT,
+
+| hook process |
+ WEECHAT_HOOK_PROCESS_RUNNING +
+ WEECHAT_HOOK_PROCESS_ERROR
+
+| hook connect |
+ WEECHAT_HOOK_CONNECT_OK +
+ WEECHAT_HOOK_CONNECT_ADDRESS_NOT_FOUND +
+ WEECHAT_HOOK_CONNECT_IP_ADDRESS_NOT_FOUND +
+ WEECHAT_HOOK_CONNECT_CONNECTION_REFUSED +
+ WEECHAT_HOOK_CONNECT_PROXY_ERROR +
+ WEECHAT_HOOK_CONNECT_LOCAL_HOSTNAME_ERROR +
+ WEECHAT_HOOK_CONNECT_GNUTLS_INIT_ERROR +
+ WEECHAT_HOOK_CONNECT_GNUTLS_HANDSHAKE_ERROR +
+ WEECHAT_HOOK_CONNECT_MEMORY_ERROR +
+ WEECHAT_HOOK_CONNECT_TIMEOUT +
WEECHAT_HOOK_CONNECT_SOCKET_ERROR
-| hook signal |
- WEECHAT_HOOK_SIGNAL_STRING, WEECHAT_HOOK_SIGNAL_INT, WEECHAT_HOOK_SIGNAL_POINTER
+
+| hook signal |
+ WEECHAT_HOOK_SIGNAL_STRING +
+ WEECHAT_HOOK_SIGNAL_INT +
+ WEECHAT_HOOK_SIGNAL_POINTER
|===
[[common_tasks]]
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-06 18:45:01 +0000