aboutsummaryrefslogtreecommitdiffstats
path: root/typings
diff options
context:
space:
mode:
authorTrygve Aaberge <trygveaa@gmail.com>2023-08-24 21:05:27 +0200
committerTrygve Aaberge <trygveaa@gmail.com>2024-02-18 11:32:54 +0100
commit711f1e10211f02be2190c22efbaf297ead70af4a (patch)
tree7206f8bf9429c7968b8c360cdd6fb01abfe9826f /typings
parent2df26d96ec689b965b925709c5ca223c2094d9e7 (diff)
downloadwee-slack-711f1e10211f02be2190c22efbaf297ead70af4a.tar.gz
Update weechat stub file
Diffstat (limited to 'typings')
-rw-r--r--typings/weechat.pyi535
1 files changed, 307 insertions, 228 deletions
diff --git a/typings/weechat.pyi b/typings/weechat.pyi
index ce72b2a..49191fa 100644
--- a/typings/weechat.pyi
+++ b/typings/weechat.pyi
@@ -3,7 +3,7 @@
# DO NOT EDIT BY HAND!
#
-from typing import Dict
+from typing import Dict, Union
WEECHAT_RC_OK: int = 0
WEECHAT_RC_OK_EAT: int = 1
@@ -48,13 +48,13 @@ WEECHAT_HOOK_SIGNAL_POINTER: str = "pointer"
def register(name: str, author: str, version: str, license: str, description: str, shutdown_function: str, charset: str) -> int:
- """`register in WeeChat plugin API reference <https://weechat.org/doc/api/#_register>`_
+ """`register in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_register>`_
"""
...
def plugin_get_name(plugin: str) -> str:
- """`plugin_get_name in WeeChat plugin API reference <https://weechat.org/doc/api/#_plugin_get_name>`_
+ """`plugin_get_name in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_plugin_get_name>`_
::
# example
@@ -65,7 +65,7 @@ def plugin_get_name(plugin: str) -> str:
def charset_set(charset: str) -> int:
- """`charset_set in WeeChat plugin API reference <https://weechat.org/doc/api/#_charset_set>`_
+ """`charset_set in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_charset_set>`_
::
# example
@@ -75,7 +75,7 @@ def charset_set(charset: str) -> int:
def iconv_to_internal(charset: str, string: str) -> str:
- """`iconv_to_internal in WeeChat plugin API reference <https://weechat.org/doc/api/#_iconv_to_internal>`_
+ """`iconv_to_internal in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_iconv_to_internal>`_
::
# example
@@ -85,7 +85,7 @@ def iconv_to_internal(charset: str, string: str) -> str:
def iconv_from_internal(charset: str, string: str) -> str:
- """`iconv_from_internal in WeeChat plugin API reference <https://weechat.org/doc/api/#_iconv_from_internal>`_
+ """`iconv_from_internal in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_iconv_from_internal>`_
::
# example
@@ -95,7 +95,7 @@ def iconv_from_internal(charset: str, string: str) -> str:
def gettext(string: str) -> str:
- """`gettext in WeeChat plugin API reference <https://weechat.org/doc/api/#_gettext>`_
+ """`gettext in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_gettext>`_
::
# example
@@ -105,7 +105,7 @@ def gettext(string: str) -> str:
def ngettext(string: str, plural: str, count: int) -> str:
- """`ngettext in WeeChat plugin API reference <https://weechat.org/doc/api/#_ngettext>`_
+ """`ngettext in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_ngettext>`_
::
# example
@@ -116,7 +116,7 @@ def ngettext(string: str, plural: str, count: int) -> str:
def strlen_screen(string: str) -> int:
- """`strlen_screen in WeeChat plugin API reference <https://weechat.org/doc/api/#_strlen_screen>`_
+ """`strlen_screen in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_strlen_screen>`_
::
# example
@@ -126,7 +126,7 @@ def strlen_screen(string: str) -> int:
def string_match(string: str, mask: str, case_sensitive: int) -> int:
- """`string_match in WeeChat plugin API reference <https://weechat.org/doc/api/#_string_match>`_
+ """`string_match in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_string_match>`_
::
# examples
@@ -140,7 +140,7 @@ def string_match(string: str, mask: str, case_sensitive: int) -> int:
def string_match_list(string: str, masks: str, case_sensitive: int) -> int:
- """`string_match_list in WeeChat plugin API reference <https://weechat.org/doc/api/#_string_match_list>`_
+ """`string_match_list in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_string_match_list>`_
::
# examples
@@ -152,7 +152,7 @@ def string_match_list(string: str, masks: str, case_sensitive: int) -> int:
def string_eval_path_home(path: str, pointers: Dict[str, str], extra_vars: Dict[str, str], options: Dict[str, str]) -> str:
- """`string_eval_path_home in WeeChat plugin API reference <https://weechat.org/doc/api/#_string_eval_path_home>`_
+ """`string_eval_path_home in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_string_eval_path_home>`_
::
# example
@@ -163,7 +163,7 @@ def string_eval_path_home(path: str, pointers: Dict[str, str], extra_vars: Dict[
def string_mask_to_regex(mask: str) -> str:
- """`string_mask_to_regex in WeeChat plugin API reference <https://weechat.org/doc/api/#_string_mask_to_regex>`_
+ """`string_mask_to_regex in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_string_mask_to_regex>`_
::
# example
@@ -173,7 +173,7 @@ def string_mask_to_regex(mask: str) -> str:
def string_has_highlight(string: str, highlight_words: str) -> int:
- """`string_has_highlight in WeeChat plugin API reference <https://weechat.org/doc/api/#_string_has_highlight>`_
+ """`string_has_highlight in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_string_has_highlight>`_
::
# example
@@ -183,7 +183,7 @@ def string_has_highlight(string: str, highlight_words: str) -> int:
def string_has_highlight_regex(string: str, regex: str) -> int:
- """`string_has_highlight_regex in WeeChat plugin API reference <https://weechat.org/doc/api/#_string_has_highlight_regex>`_
+ """`string_has_highlight_regex in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_string_has_highlight_regex>`_
::
# example
@@ -193,7 +193,7 @@ def string_has_highlight_regex(string: str, regex: str) -> int:
def string_format_size(size: int) -> str:
- """`string_format_size in WeeChat plugin API reference <https://weechat.org/doc/api/#_string_format_size>`_
+ """`string_format_size in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_string_format_size>`_
::
# example
@@ -203,7 +203,7 @@ def string_format_size(size: int) -> str:
def string_parse_size(size: str) -> int:
- """`string_parse_size in WeeChat plugin API reference <https://weechat.org/doc/api/#_string_parse_size>`_
+ """`string_parse_size in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_string_parse_size>`_
::
# example
@@ -213,7 +213,7 @@ def string_parse_size(size: str) -> int:
def string_color_code_size(string: str) -> int:
- """`string_color_code_size in WeeChat plugin API reference <https://weechat.org/doc/api/#_string_color_code_size>`_
+ """`string_color_code_size in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_string_color_code_size>`_
::
# examples
@@ -225,7 +225,7 @@ def string_color_code_size(string: str) -> int:
def string_remove_color(string: str, replacement: str) -> str:
- """`string_remove_color in WeeChat plugin API reference <https://weechat.org/doc/api/#_string_remove_color>`_
+ """`string_remove_color in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_string_remove_color>`_
::
# example
@@ -235,7 +235,7 @@ def string_remove_color(string: str, replacement: str) -> str:
def string_is_command_char(string: str) -> int:
- """`string_is_command_char in WeeChat plugin API reference <https://weechat.org/doc/api/#_string_is_command_char>`_
+ """`string_is_command_char in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_string_is_command_char>`_
::
# examples
@@ -246,7 +246,7 @@ def string_is_command_char(string: str) -> int:
def string_input_for_buffer(string: str) -> str:
- """`string_input_for_buffer in WeeChat plugin API reference <https://weechat.org/doc/api/#_string_input_for_buffer>`_
+ """`string_input_for_buffer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_string_input_for_buffer>`_
::
# examples
@@ -258,7 +258,7 @@ def string_input_for_buffer(string: str) -> str:
def string_eval_expression(expr: str, pointers: Dict[str, str], extra_vars: Dict[str, str], options: Dict[str, str]) -> str:
- """`string_eval_expression in WeeChat plugin API reference <https://weechat.org/doc/api/#_string_eval_expression>`_
+ """`string_eval_expression in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_string_eval_expression>`_
::
# examples
@@ -288,7 +288,7 @@ def string_eval_expression(expr: str, pointers: Dict[str, str], extra_vars: Dict
def mkdir_home(directory: str, mode: int) -> int:
- """`mkdir_home in WeeChat plugin API reference <https://weechat.org/doc/api/#_mkdir_home>`_
+ """`mkdir_home in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_mkdir_home>`_
::
# example
@@ -298,7 +298,7 @@ def mkdir_home(directory: str, mode: int) -> int:
def mkdir(directory: str, mode: int) -> int:
- """`mkdir in WeeChat plugin API reference <https://weechat.org/doc/api/#_mkdir>`_
+ """`mkdir in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_mkdir>`_
::
# example
@@ -308,7 +308,7 @@ def mkdir(directory: str, mode: int) -> int:
def mkdir_parents(directory: str, mode: int) -> int:
- """`mkdir_parents in WeeChat plugin API reference <https://weechat.org/doc/api/#_mkdir_parents>`_
+ """`mkdir_parents in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_mkdir_parents>`_
::
# example
@@ -318,7 +318,7 @@ def mkdir_parents(directory: str, mode: int) -> int:
def list_new() -> str:
- """`list_new in WeeChat plugin API reference <https://weechat.org/doc/api/#_list_new>`_
+ """`list_new in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_list_new>`_
::
# example
@@ -328,7 +328,7 @@ def list_new() -> str:
def list_add(list: str, data: str, where: str, user_data: str) -> str:
- """`list_add in WeeChat plugin API reference <https://weechat.org/doc/api/#_list_add>`_
+ """`list_add in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_list_add>`_
::
# example
@@ -338,7 +338,7 @@ def list_add(list: str, data: str, where: str, user_data: str) -> str:
def list_search(list: str, data: str) -> str:
- """`list_search in WeeChat plugin API reference <https://weechat.org/doc/api/#_list_search>`_
+ """`list_search in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_list_search>`_
::
# example
@@ -348,7 +348,7 @@ def list_search(list: str, data: str) -> str:
def list_search_pos(list: str, data: str) -> int:
- """`list_search_pos in WeeChat plugin API reference <https://weechat.org/doc/api/#_list_search_pos>`_
+ """`list_search_pos in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_list_search_pos>`_
::
# example
@@ -358,7 +358,7 @@ def list_search_pos(list: str, data: str) -> int:
def list_casesearch(list: str, data: str) -> str:
- """`list_casesearch in WeeChat plugin API reference <https://weechat.org/doc/api/#_list_casesearch>`_
+ """`list_casesearch in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_list_casesearch>`_
::
# example
@@ -368,7 +368,7 @@ def list_casesearch(list: str, data: str) -> str:
def list_casesearch_pos(list: str, data: str) -> int:
- """`list_casesearch_pos in WeeChat plugin API reference <https://weechat.org/doc/api/#_list_casesearch_pos>`_
+ """`list_casesearch_pos in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_list_casesearch_pos>`_
::
# example
@@ -378,7 +378,7 @@ def list_casesearch_pos(list: str, data: str) -> int:
def list_get(list: str, position: int) -> str:
- """`list_get in WeeChat plugin API reference <https://weechat.org/doc/api/#_list_get>`_
+ """`list_get in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_list_get>`_
::
# example
@@ -388,7 +388,7 @@ def list_get(list: str, position: int) -> str:
def list_set(item: str, value: str) -> int:
- """`list_set in WeeChat plugin API reference <https://weechat.org/doc/api/#_list_set>`_
+ """`list_set in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_list_set>`_
::
# example
@@ -398,7 +398,7 @@ def list_set(item: str, value: str) -> int:
def list_next(item: str) -> str:
- """`list_next in WeeChat plugin API reference <https://weechat.org/doc/api/#_list_next>`_
+ """`list_next in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_list_next>`_
::
# example
@@ -408,7 +408,7 @@ def list_next(item: str) -> str:
def list_prev(item: str) -> str:
- """`list_prev in WeeChat plugin API reference <https://weechat.org/doc/api/#_list_prev>`_
+ """`list_prev in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_list_prev>`_
::
# example
@@ -418,7 +418,7 @@ def list_prev(item: str) -> str:
def list_string(item: str) -> str:
- """`list_string in WeeChat plugin API reference <https://weechat.org/doc/api/#_list_string>`_
+ """`list_string in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_list_string>`_
::
# example
@@ -428,7 +428,7 @@ def list_string(item: str) -> str:
def list_size(list: str) -> int:
- """`list_size in WeeChat plugin API reference <https://weechat.org/doc/api/#_list_size>`_
+ """`list_size in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_list_size>`_
::
# example
@@ -438,7 +438,7 @@ def list_size(list: str) -> int:
def list_remove(list: str, item: str) -> int:
- """`list_remove in WeeChat plugin API reference <https://weechat.org/doc/api/#_list_remove>`_
+ """`list_remove in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_list_remove>`_
::
# example
@@ -448,7 +448,7 @@ def list_remove(list: str, item: str) -> int:
def list_remove_all(list: str) -> int:
- """`list_remove_all in WeeChat plugin API reference <https://weechat.org/doc/api/#_list_remove_all>`_
+ """`list_remove_all in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_list_remove_all>`_
::
# example
@@ -458,7 +458,7 @@ def list_remove_all(list: str) -> int:
def list_free(list: str) -> int:
- """`list_free in WeeChat plugin API reference <https://weechat.org/doc/api/#_list_free>`_
+ """`list_free in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_list_free>`_
::
# example
@@ -468,7 +468,7 @@ def list_free(list: str) -> int:
def config_new(name: str, callback_reload: str, callback_reload_data: str) -> str:
- """`config_new in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_new>`_
+ """`config_new in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_new>`_
::
# example
@@ -481,6 +481,53 @@ def config_new(name: str, callback_reload: str, callback_reload_data: str) -> st
...
+def config_set_version(config_file: str, version: int, callback_update: str, callback_update_data: str) -> int:
+ """`config_set_version in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_set_version>`_
+ ::
+
+ # example
+ def my_config_update_cb(data: str, config_file: str, version_read: int, data_read: Dict[str, str]) -> Dict[str, str]:
+ # return now if version is already up-to-date
+ if version_read >= 2:
+ return {}
+
+ section = data_read.get("section")
+ option = data_read.get("option")
+
+ # rename section "abc" to "def"
+ if section and not option and section == "abc":
+ data_read["section"] = "def"
+ return data_read
+
+ # limit other changes to section "test"
+ if not section or not option or section != "test":
+ return {}
+
+ # rename option "test1" to "test2"
+ if option == "test1":
+ data_read["option"] = "test2"
+ return data_read
+
+ # set value to "xxx" for option "test"
+ if option == "test":
+ data_read["value"] = "xxx"
+ return data_read
+
+ # set value to NULL for option "test_null"
+ if option == "test_null":
+ data_read["value_null"] = "1"
+ return data_read
+
+ # no changes
+ return {}
+
+ config_file = weechat.config_new("test", "", "")
+ weechat.config_set_version(config_file, 2, "my_config_update_cb", "")
+ weechat.config_read(config_file)
+ """
+ ...
+
+
def config_new_section(config_file: str, name: str,
user_can_add_options: int, user_can_delete_options: int,
callback_read: str, callback_read_data: str,
@@ -488,32 +535,42 @@ def config_new_section(config_file: str, name: str,
callback_write_default: str, callback_write_default_data: str,
callback_create_option: str, callback_create_option_data: str,
callback_delete_option: str, callback_delete_option_data: str) -> str:
- """`config_new_section in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_new_section>`_
+ """`config_new_section in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_new_section>`_
::
# example
- def my_section_read_cb(data: str, config_file: str, section: str, option_name: str, value: str) -> int:
+ def my_section_read_cb(data: str, config_file: str, section: str, option_name: str, value: Union[str, None]) -> int:
# ...
return weechat.WEECHAT_CONFIG_OPTION_SET_OK_CHANGED
# return weechat.WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE
- # return weechat.WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND
# return weechat.WEECHAT_CONFIG_OPTION_SET_ERROR
+ # return weechat.WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND
def my_section_write_cb(data: str, config_file: str, section_name: str) -> int:
# ...
return weechat.WEECHAT_CONFIG_WRITE_OK
+ # return weechat.WEECHAT_CONFIG_WRITE_ERROR
+ # return weechat.WEECHAT_CONFIG_WRITE_MEMORY_ERROR
def my_section_write_default_cb(data: str, config_file: str, section_name: str) -> int:
# ...
return weechat.WEECHAT_CONFIG_WRITE_OK
+ # return weechat.WEECHAT_CONFIG_WRITE_ERROR
+ # return weechat.WEECHAT_CONFIG_WRITE_MEMORY_ERROR
- def my_section_create_option_cb(data: str, config_file: str, section: str, option_name: str, value: str) -> int:
+ def my_section_create_option_cb(data: str, config_file: str, section: str, option_name: str, value: Union[str, None]) -> int:
# ...
- return weechat.WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE
+ return weechat.WEECHAT_CONFIG_OPTION_SET_OK_CHANGED
+ # return weechat.WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE
+ # return weechat.WEECHAT_CONFIG_OPTION_SET_ERROR
+ # return weechat.WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND
def my_section_delete_option_cb(data: str, config_file: str, section: str, option: str) -> int:
# ...
return weechat.WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED
+ # return weechat.WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET
+ # return weechat.WEECHAT_CONFIG_OPTION_UNSET_OK_RESET
+ # return weechat.WEECHAT_CONFIG_OPTION_UNSET_ERROR
section = weechat.config_new_section(config_file, "section1", 1, 1,
"my_section_read_cb", "",
@@ -526,7 +583,7 @@ def config_new_section(config_file: str, name: str,
def config_search_section(config_file: str, section_name: str) -> str:
- """`config_search_section in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_search_section>`_
+ """`config_search_section in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_search_section>`_
::
# example
@@ -537,66 +594,66 @@ def config_search_section(config_file: str, section_name: str) -> str:
def config_new_option(config_file: str, section: str, name: str, type: str, description: str,
string_values: str, min: int, max: int,
- default_value: str | None, value: str | None, null_value_allowed: int,
+ default_value: Union[str, None], value: Union[str, None], null_value_allowed: int,
callback_check_value: str, callback_check_value_data: str,
callback_change: str, callback_change_data: str,
callback_delete: str, callback_delete_data: str) -> str:
- """`config_new_option in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_new_option>`_
+ """`config_new_option in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_new_option>`_
::
# example
- def option4_check_value_cb(data: str, option: str, value: str) -> int:
+ def option_str_check_value_cb(data: str, option: str, value: str) -> int:
# ...
return 1
# return 0
- def option4_change_cb(data: str, option: str) -> None:
+ def option_str_change_cb(data: str, option: str) -> None:
# ...
- def option4_delete_cb(data: str, option: str) -> None:
+ def option_str_delete_cb(data: str, option: str) -> None:
# ...
- option1 = weechat.config_new_option(config_file, section, "option1", "boolean",
+ option_bool = weechat.config_new_option(config_file, section, "option_bool", "boolean",
"My option, type boolean",
"", 0, 0, "on", "on", 0,
"", "",
"", "",
"", "")
- option2 = weechat.config_new_option(config_file, section, "option2", "integer",
+ option_int = weechat.config_new_option(config_file, section, "option_int", "integer",
"My option, type integer",
"", 0, 100, "15", "15", 0,
"", "",
"", "",
"", "")
- option3 = weechat.config_new_option(config_file, section, "option3", "integer",
- "My option, type integer (with string values)",
- "top|bottom|left|right",
- 0, 0, "bottom", "bottom", 0,
- "", "",
- "", "",
- "", "")
-
- option4 = weechat.config_new_option(config_file, section, "option4", "string",
+ option_str = weechat.config_new_option(config_file, section, "option_str", "string",
"My option, type string",
"", 0, 0, "test", "test", 1,
- "option4_check_value_cb", "",
- "option4_change_cb", "",
- "option4_delete_cb", "")
+ "option_str_check_value_cb", "",
+ "option_str_change_cb", "",
+ "option_str_delete_cb", "")
- option5 = weechat.config_new_option(config_file, section, "option5", "color",
+ option_col = weechat.config_new_option(config_file, section, "option_col", "color",
"My option, type color",
"", 0, 0, "lightblue", "lightblue", 0,
"", "",
"", "",
"", "")
+
+ option_enum = weechat.config_new_option(config_file, section, "option_enum", "enum",
+ "My option, type enum",
+ "top|bottom|left|right",
+ 0, 0, "bottom", "bottom", 0,
+ "", "",
+ "", "",
+ "", "")
"""
...
def config_search_option(config_file: str, section: str, option_name: str) -> str:
- """`config_search_option in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_search_option>`_
+ """`config_search_option in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_search_option>`_
::
# example
@@ -606,7 +663,7 @@ def config_search_option(config_file: str, section: str, option_name: str) -> st
def config_string_to_boolean(text: str) -> int:
- """`config_string_to_boolean in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_string_to_boolean>`_
+ """`config_string_to_boolean in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_string_to_boolean>`_
::
# example
@@ -617,7 +674,7 @@ def config_string_to_boolean(text: str) -> int:
def config_option_reset(option: str, run_callback: int) -> int:
- """`config_option_reset in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_option_reset>`_
+ """`config_option_reset in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_option_reset>`_
::
# example
@@ -633,7 +690,7 @@ def config_option_reset(option: str, run_callback: int) -> int:
def config_option_set(option: str, value: str, run_callback: int) -> int:
- """`config_option_set in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_option_set>`_
+ """`config_option_set in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_option_set>`_
::
# example
@@ -649,7 +706,7 @@ def config_option_set(option: str, value: str, run_callback: int) -> int:
def config_option_set_null(option: str, run_callback: int) -> int:
- """`config_option_set_null in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_option_set_null>`_
+ """`config_option_set_null in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_option_set_null>`_
::
# example
@@ -665,7 +722,7 @@ def config_option_set_null(option: str, run_callback: int) -> int:
def config_option_unset(option: str) -> int:
- """`config_option_unset in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_option_unset>`_
+ """`config_option_unset in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_option_unset>`_
::
# example
@@ -683,7 +740,7 @@ def config_option_unset(option: str) -> int:
def config_option_rename(option: str, new_name: str) -> int:
- """`config_option_rename in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_option_rename>`_
+ """`config_option_rename in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_option_rename>`_
::
# example
@@ -693,7 +750,7 @@ def config_option_rename(option: str, new_name: str) -> int:
def config_option_is_null(option: str) -> int:
- """`config_option_is_null in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_option_is_null>`_
+ """`config_option_is_null in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_option_is_null>`_
::
# example
@@ -704,7 +761,7 @@ def config_option_is_null(option: str) -> int:
def config_option_default_is_null(option: str) -> int:
- """`config_option_default_is_null in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_option_default_is_null>`_
+ """`config_option_default_is_null in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_option_default_is_null>`_
::
# example
@@ -715,7 +772,7 @@ def config_option_default_is_null(option: str) -> int:
def config_boolean(option: str) -> int:
- """`config_boolean in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_boolean>`_
+ """`config_boolean in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_boolean>`_
::
# example
@@ -727,7 +784,7 @@ def config_boolean(option: str) -> int:
def config_boolean_default(option: str) -> int:
- """`config_boolean_default in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_boolean_default>`_
+ """`config_boolean_default in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_boolean_default>`_
::
# example
@@ -739,7 +796,7 @@ def config_boolean_default(option: str) -> int:
def config_integer(option: str) -> int:
- """`config_integer in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_integer>`_
+ """`config_integer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_integer>`_
::
# example
@@ -750,7 +807,7 @@ def config_integer(option: str) -> int:
def config_integer_default(option: str) -> int:
- """`config_integer_default in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_integer_default>`_
+ """`config_integer_default in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_integer_default>`_
::
# example
@@ -761,7 +818,7 @@ def config_integer_default(option: str) -> int:
def config_string(option: str) -> str:
- """`config_string in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_string>`_
+ """`config_string in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_string>`_
::
# example
@@ -772,7 +829,7 @@ def config_string(option: str) -> str:
def config_string_default(option: str) -> str:
- """`config_string_default in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_string_default>`_
+ """`config_string_default in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_string_default>`_
::
# example
@@ -783,7 +840,7 @@ def config_string_default(option: str) -> str:
def config_color(option: str) -> str:
- """`config_color in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_color>`_
+ """`config_color in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_color>`_
::
# example
@@ -794,7 +851,7 @@ def config_color(option: str) -> str:
def config_color_default(option: str) -> str:
- """`config_color_default in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_color_default>`_
+ """`config_color_default in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_color_default>`_
::
# example
@@ -804,8 +861,30 @@ def config_color_default(option: str) -> str:
...
+def config_enum(option: str) -> int:
+ """`config_enum in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_enum>`_
+ ::
+
+ # example
+ option = weechat.config_get("plugin.section.option")
+ value = weechat.config_enum(option)
+ """
+ ...
+
+
+def config_enum_default(option: str) -> int:
+ """`config_enum_default in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_enum_default>`_
+ ::
+
+ # example
+ option = weechat.config_get("plugin.section.option")
+ value = weechat.config_enum_default(option)
+ """
+ ...
+
+
def config_write_option(config_file: str, option: str) -> int:
- """`config_write_option in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_write_option>`_
+ """`config_write_option in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_write_option>`_
::
# example
@@ -818,7 +897,7 @@ def config_write_option(config_file: str, option: str) -> int:
def config_write_line(config_file: str, option_name: str, value: str) -> int:
- """`config_write_line in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_write_line>`_
+ """`config_write_line in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_write_line>`_
::
# example
@@ -831,7 +910,7 @@ def config_write_line(config_file: str, option_name: str, value: str) -> int:
def config_write(config_file: str) -> int:
- """`config_write in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_write>`_
+ """`config_write in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_write>`_
::
# example
@@ -847,7 +926,7 @@ def config_write(config_file: str) -> int:
def config_read(config_file: str) -> int:
- """`config_read in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_read>`_
+ """`config_read in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_read>`_
::
# example
@@ -863,7 +942,7 @@ def config_read(config_file: str) -> int:
def config_reload(config_file: str) -> int:
- """`config_reload in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_reload>`_
+ """`config_reload in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_reload>`_
::
# example
@@ -879,7 +958,7 @@ def config_reload(config_file: str) -> int:
def config_option_free(option: str) -> int:
- """`config_option_free in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_option_free>`_
+ """`config_option_free in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_option_free>`_
::
# example
@@ -889,7 +968,7 @@ def config_option_free(option: str) -> int:
def config_section_free_options(section: str) -> int:
- """`config_section_free_options in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_section_free_options>`_
+ """`config_section_free_options in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_section_free_options>`_
::
# example
@@ -899,7 +978,7 @@ def config_section_free_options(section: str) -> int:
def config_section_free(section: str) -> int:
- """`config_section_free in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_section_free>`_
+ """`config_section_free in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_section_free>`_
::
# example
@@ -909,7 +988,7 @@ def config_section_free(section: str) -> int:
def config_free(config_file: str) -> int:
- """`config_free in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_free>`_
+ """`config_free in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_free>`_
::
# example
@@ -919,7 +998,7 @@ def config_free(config_file: str) -> int:
def config_get(option_name: str) -> str:
- """`config_get in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_get>`_
+ """`config_get in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_get>`_
::
# example
@@ -929,7 +1008,7 @@ def config_get(option_name: str) -> str:
def config_get_plugin(option_name: str) -> str:
- """`config_get_plugin in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_get_plugin>`_
+ """`config_get_plugin in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_get_plugin>`_
::
# example
@@ -939,7 +1018,7 @@ def config_get_plugin(option_name: str) -> str:
def config_is_set_plugin(option_name: str) -> int:
- """`config_is_set_plugin in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_is_set_plugin>`_
+ """`config_is_set_plugin in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_is_set_plugin>`_
::
# example
@@ -954,7 +1033,7 @@ def config_is_set_plugin(option_name: str) -> int:
def config_set_plugin(option_name: str, value: str) -> int:
- """`config_set_plugin in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_set_plugin>`_
+ """`config_set_plugin in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_set_plugin>`_
::
# example
@@ -972,7 +1051,7 @@ def config_set_plugin(option_name: str, value: str) -> int:
def config_set_desc_plugin(option_name: str, description: str) -> int:
- """`config_set_desc_plugin in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_set_desc_plugin>`_
+ """`config_set_desc_plugin in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_set_desc_plugin>`_
::
# example
@@ -984,7 +1063,7 @@ def config_set_desc_plugin(option_name: str, description: str) -> int:
def config_unset_plugin(option_name: str) -> int:
- """`config_unset_plugin in WeeChat plugin API reference <https://weechat.org/doc/api/#_config_unset_plugin>`_
+ """`config_unset_plugin in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_config_unset_plugin>`_
::
# example
@@ -1002,7 +1081,7 @@ def config_unset_plugin(option_name: str) -> int:
def key_bind(context: str, keys: Dict[str, str]) -> int:
- """`key_bind in WeeChat plugin API reference <https://weechat.org/doc/api/#_key_bind>`_
+ """`key_bind in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_key_bind>`_
::
# example
@@ -1015,7 +1094,7 @@ def key_bind(context: str, keys: Dict[str, str]) -> int:
def key_unbind(context: str, key: str) -> int:
- """`key_unbind in WeeChat plugin API reference <https://weechat.org/doc/api/#_key_unbind>`_
+ """`key_unbind in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_key_unbind>`_
::
# examples
@@ -1030,7 +1109,7 @@ def key_unbind(context: str, key: str) -> int:
def prefix(prefix: str) -> str:
- """`prefix in WeeChat plugin API reference <https://weechat.org/doc/api/#_prefix>`_
+ """`prefix in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_prefix>`_
::
# example
@@ -1040,7 +1119,7 @@ def prefix(prefix: str) -> str:
def color(color_name: str) -> str:
- """`color in WeeChat plugin API reference <https://weechat.org/doc/api/#_color>`_
+ """`color in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_color>`_
::
# example
@@ -1051,7 +1130,7 @@ def color(color_name: str) -> str:
def prnt(buffer: str, message: str) -> int:
- """`prnt in WeeChat plugin API reference <https://weechat.org/doc/api/#_prnt>`_
+ """`prnt in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_prnt>`_
::
# example
@@ -1066,7 +1145,7 @@ def prnt(buffer: str, message: str) -> int:
def prnt_date_tags(buffer: str, date: int, tags: str, message: str) -> int:
- """`prnt_date_tags in WeeChat plugin API reference <https://weechat.org/doc/api/#_prnt_date_tags>`_
+ """`prnt_date_tags in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_prnt_date_tags>`_
::
# example
@@ -1078,7 +1157,7 @@ def prnt_date_tags(buffer: str, date: int, tags: str, message: str) -> int:
def prnt_y(buffer: str, y: int, message: str) -> int:
- """`prnt_y in WeeChat plugin API reference <https://weechat.org/doc/api/#_prnt_y>`_
+ """`prnt_y in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_prnt_y>`_
::
# example
@@ -1088,7 +1167,7 @@ def prnt_y(buffer: str, y: int, message: str) -> int:
def prnt_y_date_tags(buffer: str, y: int, date: int, tags: str, message: str) -> int:
- """`prnt_y_date_tags in WeeChat plugin API reference <https://weechat.org/doc/api/#_prnt_y_date_tags>`_
+ """`prnt_y_date_tags in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_prnt_y_date_tags>`_
::
# example
@@ -1098,7 +1177,7 @@ def prnt_y_date_tags(buffer: str, y: int, date: int, tags: str, message: str) ->
def log_print(message: str) -> int:
- """`log_print in WeeChat plugin API reference <https://weechat.org/doc/api/#_log_print>`_
+ """`log_print in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_log_print>`_
::
# example
@@ -1109,7 +1188,7 @@ def log_print(message: str) -> int:
def hook_command(command: str, description: str, args: str, args_description: str,
completion: str, callback: str, callback_data: str) -> str:
- """`hook_command in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_command>`_
+ """`hook_command in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_command>`_
::
# example
@@ -1132,7 +1211,7 @@ def hook_command(command: str, description: str, args: str, args_description: st
def hook_completion(completion_item: str, description: str, callback: str, callback_data: str) -> str:
- """`hook_completion in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_completion>`_
+ """`hook_completion in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_completion>`_
::
# example
@@ -1148,7 +1227,7 @@ def hook_completion(completion_item: str, description: str, callback: str, callb
def hook_command_run(command: str, callback: str, callback_data: str) -> str:
- """`hook_command_run in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_command_run>`_
+ """`hook_command_run in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_command_run>`_
::
# example
@@ -1162,7 +1241,7 @@ def hook_command_run(command: str, callback: str, callback_data: str) -> str:
def hook_timer(interval: int, align_second: int, max_calls: int, callback: str, callback_data: str) -> str:
- """`hook_timer in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_timer>`_
+ """`hook_timer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_timer>`_
::
# example
@@ -1177,7 +1256,7 @@ def hook_timer(interval: int, align_second: int, max_calls: int, callback: str,
def hook_fd(fd: int, flag_read: int, flag_write: int, flag_exception: int, callback: str, callback_data: str) -> str:
- """`hook_fd in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_fd>`_
+ """`hook_fd in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_fd>`_
::
# example
@@ -1192,7 +1271,7 @@ def hook_fd(fd: int, flag_read: int, flag_write: int, flag_exception: int, callb
def hook_process(command: str, timeout: int, callback: str, callback_data: str) -> str:
- """`hook_process in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_process>`_
+ """`hook_process in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_process>`_
::
# example with an external command
@@ -1234,7 +1313,7 @@ def hook_process(command: str, timeout: int, callback: str, callback_data: str)
def hook_process_hashtable(command: str, options: Dict[str, str], timeout: int, callback: str, callback_data: str) -> str:
- """`hook_process_hashtable in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_process_hashtable>`_
+ """`hook_process_hashtable in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_process_hashtable>`_
::
# example
@@ -1285,7 +1364,7 @@ def hook_process_hashtable(command: str, options: Dict[str, str], timeout: int,
def hook_connect(proxy: str, address: str, port: int, ipv6: int, retry: int, local_hostname: str,
callback: str, callback_data: str) -> str:
- """`hook_connect in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_connect>`_
+ """`hook_connect in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_connect>`_
::
# example
@@ -1321,7 +1400,7 @@ def hook_connect(proxy: str, address: str, port: int, ipv6: int, retry: int, loc
def hook_line(buffer_type: str, buffer_name: str, tags: str, callback: str, callback_data: str) -> str:
- """`hook_line in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_line>`_
+ """`hook_line in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_line>`_
::
# example
@@ -1336,7 +1415,7 @@ def hook_line(buffer_type: str, buffer_name: str, tags: str, callback: str, call
def hook_print(buffer: str, tags: str, message: str, strip_colors: int, callback: str, callback_data: str) -> str:
- """`hook_print in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_print>`_
+ """`hook_print in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_print>`_
::
# example
@@ -1352,7 +1431,7 @@ def hook_print(buffer: str, tags: str, message: str, strip_colors: int, callback
def hook_signal(signal: str, callback: str, callback_data: str) -> str:
- """`hook_signal in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_signal>`_
+ """`hook_signal in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_signal>`_
::
# example
@@ -1367,7 +1446,7 @@ def hook_signal(signal: str, callback: str, callback_data: str) -> str:
def hook_signal_send(signal: str, type_data: str, signal_data: str) -> int:
- """`hook_signal_send in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_signal_send>`_
+ """`hook_signal_send in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_signal_send>`_
::
# example
@@ -1377,7 +1456,7 @@ def hook_signal_send(signal: str, type_data: str, signal_data: str) -> int:
def hook_hsignal(signal: str, callback: str, callback_data: str) -> str:
- """`hook_hsignal in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_hsignal>`_
+ """`hook_hsignal in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_hsignal>`_
::
# example
@@ -1391,7 +1470,7 @@ def hook_hsignal(signal: str, callback: str, callback_data: str) -> str:
def hook_hsignal_send(signal: str, hashtable: Dict[str, str]) -> int:
- """`hook_hsignal_send in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_hsignal_send>`_
+ """`hook_hsignal_send in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_hsignal_send>`_
::
# example
@@ -1401,7 +1480,7 @@ def hook_hsignal_send(signal: str, hashtable: Dict[str, str]) -> int:
def hook_config(option: str, callback: str, callback_data: str) -> str:
- """`hook_config in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_config>`_
+ """`hook_config in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_config>`_
::
# example
@@ -1416,7 +1495,7 @@ def hook_config(option: str, callback: str, callback_data: str) -> str:
def hook_modifier(modifier: str, callback: str, callback_data: str) -> str:
- """`hook_modifier in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_modifier>`_
+ """`hook_modifier in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_modifier>`_
::
# example
@@ -1429,7 +1508,7 @@ def hook_modifier(modifier: str, callback: str, callback_data: str) -> str:
def hook_modifier_exec(modifier: str, modifier_data: str, string: str) -> str:
- """`hook_modifier_exec in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_modifier_exec>`_
+ """`hook_modifier_exec in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_modifier_exec>`_
::
# example
@@ -1440,7 +1519,7 @@ def hook_modifier_exec(modifier: str, modifier_data: str, string: str) -> str:
def hook_info(info_name: str, description: str, args_description: str,
callback: str, callback_data: str) -> str:
- """`hook_info in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_info>`_
+ """`hook_info in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_info>`_
::
# example
@@ -1455,7 +1534,7 @@ def hook_info(info_name: str, description: str, args_description: str,
def hook_info_hashtable(info_name: str, description: str, args_description: str,
output_description: str, callback: str, callback_data: str) -> str:
- """`hook_info_hashtable in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_info_hashtable>`_
+ """`hook_info_hashtable in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_info_hashtable>`_
::
# example
@@ -1472,7 +1551,7 @@ def hook_info_hashtable(info_name: str, description: str, args_description: str,
def hook_infolist(infolist_name: str, description: str, pointer_description: str,
args_description: str, callback: str, callback_data: str) -> str:
- """`hook_infolist in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_infolist>`_
+ """`hook_infolist in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_infolist>`_
::
# example
@@ -1489,7 +1568,7 @@ def hook_infolist(infolist_name: str, description: str, pointer_description: str
def hook_focus(area: str, callback: str, callback_data: str) -> str:
- """`hook_focus in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_focus>`_
+ """`hook_focus in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_focus>`_
::
# example
@@ -1504,7 +1583,7 @@ def hook_focus(area: str, callback: str, callback_data: str) -> str:
def hook_set(hook: str, property: str, value: str) -> int:
- """`hook_set in WeeChat plugin API reference <https://weechat.org/doc/api/#_hook_set>`_
+ """`hook_set in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hook_set>`_
::
# example
@@ -1521,7 +1600,7 @@ def hook_set(hook: str, property: str, value: str) -> int:
def unhook(hook: str) -> int:
- """`unhook in WeeChat plugin API reference <https://weechat.org/doc/api/#_unhook>`_
+ """`unhook in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_unhook>`_
::
# example
@@ -1531,7 +1610,7 @@ def unhook(hook: str) -> int:
def unhook_all() -> int:
- """`unhook_all in WeeChat plugin API reference <https://weechat.org/doc/api/#_unhook_all>`_
+ """`unhook_all in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_unhook_all>`_
::
# example
@@ -1542,7 +1621,7 @@ def unhook_all() -> int:
def buffer_new(name: str, input_callback: str, input_callback_data: str,
close_callback: str, close_callback_data: str) -> str:
- """`buffer_new in WeeChat plugin API reference <https://weechat.org/doc/api/#_buffer_new>`_
+ """`buffer_new in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_buffer_new>`_
::
# example
@@ -1562,7 +1641,7 @@ def buffer_new(name: str, input_callback: str, input_callback_data: str,
def buffer_new_props(name: str, properties: Dict[str, str],
input_callback: str, input_callback_data: str,
close_callback: str, close_callback_data: str) -> str:
- """`buffer_new_props in WeeChat plugin API reference <https://weechat.org/doc/api/#_buffer_new_props>`_
+ """`buffer_new_props in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_buffer_new_props>`_
::
# example
@@ -1585,7 +1664,7 @@ def buffer_new_props(name: str, properties: Dict[str, str],
def current_buffer() -> str:
- """`current_buffer in WeeChat plugin API reference <https://weechat.org/doc/api/#_current_buffer>`_
+ """`current_buffer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_current_buffer>`_
::
# example
@@ -1595,7 +1674,7 @@ def current_buffer() -> str:
def buffer_search(plugin: str, name: str) -> str:
- """`buffer_search in WeeChat plugin API reference <https://weechat.org/doc/api/#_buffer_search>`_
+ """`buffer_search in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_buffer_search>`_
::
# example
@@ -1605,7 +1684,7 @@ def buffer_search(plugin: str, name: str) -> str:
def buffer_search_main() -> str:
- """`buffer_search_main in WeeChat plugin API reference <https://weechat.org/doc/api/#_buffer_search_main>`_
+ """`buffer_search_main in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_buffer_search_main>`_
::
# example
@@ -1615,7 +1694,7 @@ def buffer_search_main() -> str:
def buffer_clear(buffer: str) -> int:
- """`buffer_clear in WeeChat plugin API reference <https://weechat.org/doc/api/#_buffer_clear>`_
+ """`buffer_clear in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_buffer_clear>`_
::
# example
@@ -1627,7 +1706,7 @@ def buffer_clear(buffer: str) -> int:
def buffer_close(buffer: str) -> int:
- """`buffer_close in WeeChat plugin API reference <https://weechat.org/doc/api/#_buffer_close>`_
+ """`buffer_close in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_buffer_close>`_
::
# example
@@ -1639,7 +1718,7 @@ def buffer_close(buffer: str) -> int:
def buffer_merge(buffer: str, target_buffer: str) -> int:
- """`buffer_merge in WeeChat plugin API reference <https://weechat.org/doc/api/#_buffer_merge>`_
+ """`buffer_merge in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_buffer_merge>`_
::
# example
@@ -1650,7 +1729,7 @@ def buffer_merge(buffer: str, target_buffer: str) -> int:
def buffer_unmerge(buffer: str, number: int) -> int:
- """`buffer_unmerge in WeeChat plugin API reference <https://weechat.org/doc/api/#_buffer_unmerge>`_
+ """`buffer_unmerge in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_buffer_unmerge>`_
::
# example
@@ -1660,7 +1739,7 @@ def buffer_unmerge(buffer: str, number: int) -> int:
def buffer_get_integer(buffer: str, property: str) -> int:
- """`buffer_get_integer in WeeChat plugin API reference <https://weechat.org/doc/api/#_buffer_get_integer>`_
+ """`buffer_get_integer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_buffer_get_integer>`_
::
# example
@@ -1670,7 +1749,7 @@ def buffer_get_integer(buffer: str, property: str) -> int:
def buffer_get_string(buffer: str, property: str) -> str:
- """`buffer_get_string in WeeChat plugin API reference <https://weechat.org/doc/api/#_buffer_get_string>`_
+ """`buffer_get_string in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_buffer_get_string>`_
::
# example
@@ -1682,7 +1761,7 @@ def buffer_get_string(buffer: str, property: str) -> str:
def buffer_get_pointer(buffer: str, property: str) -> str:
- """`buffer_get_pointer in WeeChat plugin API reference <https://weechat.org/doc/api/#_buffer_get_pointer>`_
+ """`buffer_get_pointer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_buffer_get_pointer>`_
::
# example
@@ -1692,7 +1771,7 @@ def buffer_get_pointer(buffer: str, property: str) -> str:
def buffer_set(buffer: str, property: str, value: str) -> int:
- """`buffer_set in WeeChat plugin API reference <https://weechat.org/doc/api/#_buffer_set>`_
+ """`buffer_set in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_buffer_set>`_
::
# examples
@@ -1716,7 +1795,7 @@ def buffer_set(buffer: str, property: str, value: str) -> int:
def buffer_string_replace_local_var(buffer: str, string: str) -> str:
- """`buffer_string_replace_local_var in WeeChat plugin API reference <https://weechat.org/doc/api/#_buffer_string_replace_local_var>`_
+ """`buffer_string_replace_local_var in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_buffer_string_replace_local_var>`_
::
# example
@@ -1728,7 +1807,7 @@ def buffer_string_replace_local_var(buffer: str, string: str) -> str:
def buffer_match_list(buffer: str, string: str) -> int:
- """`buffer_match_list in WeeChat plugin API reference <https://weechat.org/doc/api/#_buffer_match_list>`_
+ """`buffer_match_list in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_buffer_match_list>`_
::
# example
@@ -1736,14 +1815,14 @@ def buffer_match_list(buffer: str, string: str) -> int:
if buffer:
weechat.prnt("", "%d" % weechat.buffer_match_list(buffer, "*")) # 1
weechat.prnt("", "%d" % weechat.buffer_match_list(buffer, "*,!*#weechat*")) # 0
- weechat.prnt("", "%d" % weechat.buffer_match_list(buffer, "irc.libera.*")) # 1
+ weechat.prnt("", "%d" % weechat.buffer_match_list(buffer, "irc.libera.*")) # 1
weechat.prnt("", "%d" % weechat.buffer_match_list(buffer, "irc.oftc.*,python.*")) # 0
"""
...
def current_window() -> str:
- """`current_window in WeeChat plugin API reference <https://weechat.org/doc/api/#_current_window>`_
+ """`current_window in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_current_window>`_
::
# example
@@ -1753,7 +1832,7 @@ def current_window() -> str:
def window_search_with_buffer(buffer: str) -> str:
- """`window_search_with_buffer in WeeChat plugin API reference <https://weechat.org/doc/api/#_window_search_with_buffer>`_
+ """`window_search_with_buffer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_window_search_with_buffer>`_
::
# example
@@ -1764,7 +1843,7 @@ def window_search_with_buffer(buffer: str) -> str:
def window_get_integer(window: str, property: str) -> int:
- """`window_get_integer in WeeChat plugin API reference <https://weechat.org/doc/api/#_window_get_integer>`_
+ """`window_get_integer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_window_get_integer>`_
::
# example
@@ -1776,13 +1855,13 @@ def window_get_integer(window: str, property: str) -> int:
def window_get_string(window: str, property: str) -> str:
- """`window_get_string in WeeChat plugin API reference <https://weechat.org/doc/api/#_window_get_string>`_
+ """`window_get_string in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_window_get_string>`_
"""
...
def window_get_pointer(window: str, property: str) -> str:
- """`window_get_pointer in WeeChat plugin API reference <https://weechat.org/doc/api/#_window_get_pointer>`_
+ """`window_get_pointer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_window_get_pointer>`_
::
# example
@@ -1793,7 +1872,7 @@ def window_get_pointer(window: str, property: str) -> str:
def window_set_title(title: str) -> int:
- """`window_set_title in WeeChat plugin API reference <https://weechat.org/doc/api/#_window_set_title>`_
+ """`window_set_title in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_window_set_title>`_
::
# example
@@ -1803,7 +1882,7 @@ def window_set_title(title: str) -> int:
def nicklist_add_group(buffer: str, parent_group: str, name: str, color: str, visible: int) -> str:
- """`nicklist_add_group in WeeChat plugin API reference <https://weechat.org/doc/api/#_nicklist_add_group>`_
+ """`nicklist_add_group in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_nicklist_add_group>`_
::
# example
@@ -1814,7 +1893,7 @@ def nicklist_add_group(buffer: str, parent_group: str, name: str, color: str, vi
def nicklist_search_group(buffer: str, from_group: str, name: str) -> str:
- """`nicklist_search_group in WeeChat plugin API reference <https://weechat.org/doc/api/#_nicklist_search_group>`_
+ """`nicklist_search_group in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_nicklist_search_group>`_
::
# example
@@ -1824,7 +1903,7 @@ def nicklist_search_group(buffer: str, from_group: str, name: str) -> str:
def nicklist_add_nick(buffer: str, group: str, name: str, color: str, prefix: str, prefix_color: str, visible: int) -> str:
- """`nicklist_add_nick in WeeChat plugin API reference <https://weechat.org/doc/api/#_nicklist_add_nick>`_
+ """`nicklist_add_nick in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_nicklist_add_nick>`_
::
# example
@@ -1838,7 +1917,7 @@ def nicklist_add_nick(buffer: str, group: str, name: str, color: str, prefix: st
def nicklist_search_nick(buffer: str, from_group: str, name: str) -> str:
- """`nicklist_search_nick in WeeChat plugin API reference <https://weechat.org/doc/api/#_nicklist_search_nick>`_
+ """`nicklist_search_nick in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_nicklist_search_nick>`_
::
# example
@@ -1848,7 +1927,7 @@ def nicklist_search_nick(buffer: str, from_group: str, name: str) -> str:
def nicklist_remove_group(buffer: str, group: str) -> int:
- """`nicklist_remove_group in WeeChat plugin API reference <https://weechat.org/doc/api/#_nicklist_remove_group>`_
+ """`nicklist_remove_group in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_nicklist_remove_group>`_
::
# example
@@ -1858,7 +1937,7 @@ def nicklist_remove_group(buffer: str, group: str) -> int:
def nicklist_remove_nick(buffer: str, nick: str) -> int:
- """`nicklist_remove_nick in WeeChat plugin API reference <https://weechat.org/doc/api/#_nicklist_remove_nick>`_
+ """`nicklist_remove_nick in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_nicklist_remove_nick>`_
::
# example
@@ -1868,7 +1947,7 @@ def nicklist_remove_nick(buffer: str, nick: str) -> int:
def nicklist_remove_all(buffer: str) -> int:
- """`nicklist_remove_all in WeeChat plugin API reference <https://weechat.org/doc/api/#_nicklist_remove_all>`_
+ """`nicklist_remove_all in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_nicklist_remove_all>`_
::
# example
@@ -1878,7 +1957,7 @@ def nicklist_remove_all(buffer: str) -> int:
def nicklist_group_get_integer(buffer: str, group: str, property: str) -> int:
- """`nicklist_group_get_integer in WeeChat plugin API reference <https://weechat.org/doc/api/#_nicklist_group_get_integer>`_
+ """`nicklist_group_get_integer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_nicklist_group_get_integer>`_
::
# example
@@ -1888,7 +1967,7 @@ def nicklist_group_get_integer(buffer: str, group: str, property: str) -> int:
def nicklist_group_get_string(buffer: str, group: str, property: str) -> str:
- """`nicklist_group_get_string in WeeChat plugin API reference <https://weechat.org/doc/api/#_nicklist_group_get_string>`_
+ """`nicklist_group_get_string in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_nicklist_group_get_string>`_
::
# example
@@ -1898,7 +1977,7 @@ def nicklist_group_get_string(buffer: str, group: str, property: str) -> str:
def nicklist_group_get_pointer(buffer: str, group: str, property: str) -> str:
- """`nicklist_group_get_pointer in WeeChat plugin API reference <https://weechat.org/doc/api/#_nicklist_group_get_pointer>`_
+ """`nicklist_group_get_pointer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_nicklist_group_get_pointer>`_
::
# example
@@ -1908,7 +1987,7 @@ def nicklist_group_get_pointer(buffer: str, group: str, property: str) -> str:
def nicklist_group_set(buffer: str, group: str, property: str, value: str) -> int:
- """`nicklist_group_set in WeeChat plugin API reference <https://weechat.org/doc/api/#_nicklist_group_set>`_
+ """`nicklist_group_set in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_nicklist_group_set>`_
::
# examples
@@ -1926,7 +2005,7 @@ def nicklist_group_set(buffer: str, group: str, property: str, value: str) -> in
def nicklist_nick_get_integer(buffer: str, nick: str, property: str) -> int:
- """`nicklist_nick_get_integer in WeeChat plugin API reference <https://weechat.org/doc/api/#_nicklist_nick_get_integer>`_
+ """`nicklist_nick_get_integer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_nicklist_nick_get_integer>`_
::
# example
@@ -1936,7 +2015,7 @@ def nicklist_nick_get_integer(buffer: str, nick: str, property: str) -> int:
def nicklist_nick_get_string(buffer: str, nick: str, property: str) -> str:
- """`nicklist_nick_get_string in WeeChat plugin API reference <https://weechat.org/doc/api/#_nicklist_nick_get_string>`_
+ """`nicklist_nick_get_string in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_nicklist_nick_get_string>`_
::
# example
@@ -1946,7 +2025,7 @@ def nicklist_nick_get_string(buffer: str, nick: str, property: str) -> str:
def nicklist_nick_get_pointer(buffer: str, nick: str, property: str) -> str:
- """`nicklist_nick_get_pointer in WeeChat plugin API reference <https://weechat.org/doc/api/#_nicklist_nick_get_pointer>`_
+ """`nicklist_nick_get_pointer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_nicklist_nick_get_pointer>`_
::
# example
@@ -1956,7 +2035,7 @@ def nicklist_nick_get_pointer(buffer: str, nick: str, property: str) -> str:
def nicklist_nick_set(buffer: str, nick: str, property: str, value: str) -> int:
- """`nicklist_nick_set in WeeChat plugin API reference <https://weechat.org/doc/api/#_nicklist_nick_set>`_
+ """`nicklist_nick_set in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_nicklist_nick_set>`_
::
# examples
@@ -1977,7 +2056,7 @@ def nicklist_nick_set(buffer: str, nick: str, property: str, value: str) -> int:
def bar_item_search(name: str) -> str:
- """`bar_item_search in WeeChat plugin API reference <https://weechat.org/doc/api/#_bar_item_search>`_
+ """`bar_item_search in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_bar_item_search>`_
::
# example
@@ -1987,7 +2066,7 @@ def bar_item_search(name: str) -> str:
def bar_item_new(name: str, build_callback: str, build_callback_data: str) -> str:
- """`bar_item_new in WeeChat plugin API reference <https://weechat.org/doc/api/#_bar_item_new>`_
+ """`bar_item_new in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_bar_item_new>`_
::
# example (callback without "buffer" and "extra_info")
@@ -2006,7 +2085,7 @@ def bar_item_new(name: str, build_callback: str, build_callback_data: str) -> st
def bar_item_update(name: str) -> int:
- """`bar_item_update in WeeChat plugin API reference <https://weechat.org/doc/api/#_bar_item_update>`_
+ """`bar_item_update in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_bar_item_update>`_
::
# example
@@ -2016,7 +2095,7 @@ def bar_item_update(name: str) -> int:
def bar_item_remove(item: str) -> int:
- """`bar_item_remove in WeeChat plugin API reference <https://weechat.org/doc/api/#_bar_item_remove>`_
+ """`bar_item_remove in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_bar_item_remove>`_
::
# example
@@ -2026,7 +2105,7 @@ def bar_item_remove(item: str) -> int:
def bar_search(name: str) -> str:
- """`bar_search in WeeChat plugin API reference <https://weechat.org/doc/api/#_bar_search>`_
+ """`bar_search in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_bar_search>`_
::
# example
@@ -2039,7 +2118,7 @@ def bar_new(name: str, hidden: str, priority: str, type: str, condition: str, po
filling_top_bottom: str, filling_left_right: str, size: str, size_max: str,
color_fg: str, color_delim: str, color_bg: str, color_bg_inactive: str,
separator: str, items: str) -> str:
- """`bar_new in WeeChat plugin API reference <https://weechat.org/doc/api/#_bar_new>`_
+ """`bar_new in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_bar_new>`_
::
# example
@@ -2050,7 +2129,7 @@ def bar_new(name: str, hidden: str, priority: str, type: str, condition: str, po
def bar_set(bar: str, property: str, value: str) -> int:
- """`bar_set in WeeChat plugin API reference <https://weechat.org/doc/api/#_bar_set>`_
+ """`bar_set in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_bar_set>`_
::
# example
@@ -2060,7 +2139,7 @@ def bar_set(bar: str, property: str, value: str) -> int:
def bar_update(name: str) -> int:
- """`bar_update in WeeChat plugin API reference <https://weechat.org/doc/api/#_bar_update>`_
+ """`bar_update in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_bar_update>`_
::
# example
@@ -2070,7 +2149,7 @@ def bar_update(name: str) -> int:
def bar_remove(bar: str) -> int:
- """`bar_remove in WeeChat plugin API reference <https://weechat.org/doc/api/#_bar_remove>`_
+ """`bar_remove in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_bar_remove>`_
::
# example
@@ -2080,7 +2159,7 @@ def bar_remove(bar: str) -> int:
def command(buffer: str, command: str) -> int:
- """`command in WeeChat plugin API reference <https://weechat.org/doc/api/#_command>`_
+ """`command in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_command>`_
::
# example
@@ -2090,7 +2169,7 @@ def command(buffer: str, command: str) -> int:
def command_options(buffer: str, command: str, options: Dict[str, str]) -> int:
- """`command_options in WeeChat plugin API reference <https://weechat.org/doc/api/#_command_options>`_
+ """`command_options in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_command_options>`_
::
# example: allow any command except /exec
@@ -2100,7 +2179,7 @@ def command_options(buffer: str, command: str, options: Dict[str, str]) -> int:
def completion_new(buffer: str) -> str:
- """`completion_new in WeeChat plugin API reference <https://weechat.org/doc/api/#_completion_new>`_
+ """`completion_new in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_completion_new>`_
::
# example
@@ -2110,7 +2189,7 @@ def completion_new(buffer: str) -> str:
def completion_search(completion: str, data: str, position: int, direction: int) -> int:
- """`completion_search in WeeChat plugin API reference <https://weechat.org/doc/api/#_completion_search>`_
+ """`completion_search in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_completion_search>`_
::
# example
@@ -2122,7 +2201,7 @@ def completion_search(completion: str, data: str, position: int, direction: int)
def completion_get_string(completion: str, property: str) -> str:
- """`completion_get_string in WeeChat plugin API reference <https://weechat.org/doc/api/#_completion_get_string>`_
+ """`completion_get_string in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_completion_get_string>`_
::
# example
@@ -2137,7 +2216,7 @@ def completion_get_string(completion: str, property: str) -> str:
def completion_list_add(completion: str, word: str, nick_completion: int, where: str) -> int:
- """`completion_list_add in WeeChat plugin API reference <https://weechat.org/doc/api/#_completion_list_add>`_
+ """`completion_list_add in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_completion_list_add>`_
::
# example: see function hook_completion
@@ -2146,7 +2225,7 @@ def completion_list_add(completion: str, word: str, nick_completion: int, where:
def completion_free(completion: str) -> int:
- """`completion_free in WeeChat plugin API reference <https://weechat.org/doc/api/#_completion_free>`_
+ """`completion_free in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_completion_free>`_
::
# example
@@ -2156,7 +2235,7 @@ def completion_free(completion: str) -> int:
def info_get(info_name: str, arguments: str) -> str:
- """`info_get in WeeChat plugin API reference <https://weechat.org/doc/api/#_info_get>`_
+ """`info_get in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_info_get>`_
::
# example
@@ -2168,7 +2247,7 @@ def info_get(info_name: str, arguments: str) -> str:
def info_get_hashtable(info_name: str, dict_in: Dict[str, str]) -> Dict[str, str]:
- """`info_get_hashtable in WeeChat plugin API reference <https://weechat.org/doc/api/#_info_get_hashtable>`_
+ """`info_get_hashtable in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_info_get_hashtable>`_
::
# example
@@ -2180,7 +2259,7 @@ def info_get_hashtable(info_name: str, dict_in: Dict[str, str]) -> Dict[str, str
def infolist_new() -> str:
- """`infolist_new in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_new>`_
+ """`infolist_new in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_new>`_
::
# example
@@ -2190,7 +2269,7 @@ def infolist_new() -> str:
def infolist_new_item(infolist: str) -> str:
- """`infolist_new_item in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_new_item>`_
+ """`infolist_new_item in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_new_item>`_
::
# example
@@ -2200,7 +2279,7 @@ def infolist_new_item(infolist: str) -> str:
def infolist_new_var_integer(item: str, name: str, value: int) -> str:
- """`infolist_new_var_integer in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_new_var_integer>`_
+ """`infolist_new_var_integer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_new_var_integer>`_
::
# example
@@ -2210,7 +2289,7 @@ def infolist_new_var_integer(item: str, name: str, value: int) -> str:
def infolist_new_var_string(item: str, name: str, value: str) -> str:
- """`infolist_new_var_string in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_new_var_string>`_
+ """`infolist_new_var_string in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_new_var_string>`_
::
# example
@@ -2220,7 +2299,7 @@ def infolist_new_var_string(item: str, name: str, value: str) -> str:
def infolist_new_var_pointer(item: str, name: str, pointer: str) -> str:
- """`infolist_new_var_pointer in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_new_var_pointer>`_
+ """`infolist_new_var_pointer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_new_var_pointer>`_
::
# example
@@ -2230,7 +2309,7 @@ def infolist_new_var_pointer(item: str, name: str, pointer: str) -> str:
def infolist_new_var_time(item: str, name: str, time: int) -> str:
- """`infolist_new_var_time in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_new_var_time>`_
+ """`infolist_new_var_time in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_new_var_time>`_
::
# example
@@ -2240,7 +2319,7 @@ def infolist_new_var_time(item: str, name: str, time: int) -> str:
def infolist_get(infolist_name: str, pointer: str, arguments: str) -> str:
- """`infolist_get in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_get>`_
+ """`infolist_get in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_get>`_
::
# example
@@ -2250,7 +2329,7 @@ def infolist_get(infolist_name: str, pointer: str, arguments: str) -> str:
def infolist_next(infolist: str) -> int:
- """`infolist_next in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_next>`_
+ """`infolist_next in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_next>`_
::
# example
@@ -2264,7 +2343,7 @@ def infolist_next(infolist: str) -> int:
def infolist_prev(infolist: str) -> int:
- """`infolist_prev in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_prev>`_
+ """`infolist_prev in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_prev>`_
::
# example
@@ -2278,7 +2357,7 @@ def infolist_prev(infolist: str) -> int:
def infolist_reset_item_cursor(infolist: str) -> int:
- """`infolist_reset_item_cursor in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_reset_item_cursor>`_
+ """`infolist_reset_item_cursor in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_reset_item_cursor>`_
::
# example
@@ -2288,7 +2367,7 @@ def infolist_reset_item_cursor(infolist: str) -> int:
def infolist_search_var(infolist: str, name: str) -> str:
- """`infolist_search_var in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_search_var>`_
+ """`infolist_search_var in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_search_var>`_
::
# example
@@ -2300,7 +2379,7 @@ def infolist_search_var(infolist: str, name: str) -> str:
def infolist_fields(infolist: str) -> str:
- """`infolist_fields in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_fields>`_
+ """`infolist_fields in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_fields>`_
::
# example
@@ -2312,7 +2391,7 @@ def infolist_fields(infolist: str) -> str:
def infolist_integer(infolist: str, var: str) -> int:
- """`infolist_integer in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_integer>`_
+ """`infolist_integer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_integer>`_
::
# example
@@ -2322,7 +2401,7 @@ def infolist_integer(infolist: str, var: str) -> int:
def infolist_string(infolist: str, var: str) -> str:
- """`infolist_string in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_string>`_
+ """`infolist_string in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_string>`_
::
# example
@@ -2332,7 +2411,7 @@ def infolist_string(infolist: str, var: str) -> str:
def infolist_pointer(infolist: str, var: str) -> str:
- """`infolist_pointer in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_pointer>`_
+ """`infolist_pointer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_pointer>`_
::
# example
@@ -2342,7 +2421,7 @@ def infolist_pointer(infolist: str, var: str) -> str:
def infolist_time(infolist: str, var: str) -> int:
- """`infolist_time in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_time>`_
+ """`infolist_time in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_time>`_
::
# example
@@ -2352,7 +2431,7 @@ def infolist_time(infolist: str, var: str) -> int:
def infolist_free(infolist: str) -> int:
- """`infolist_free in WeeChat plugin API reference <https://weechat.org/doc/api/#_infolist_free>`_
+ """`infolist_free in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_infolist_free>`_
::
# example
@@ -2362,7 +2441,7 @@ def infolist_free(infolist: str) -> int:
def hdata_get(hdata_name: str) -> str:
- """`hdata_get in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_get>`_
+ """`hdata_get in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_get>`_
::
# example
@@ -2372,7 +2451,7 @@ def hdata_get(hdata_name: str) -> str:
def hdata_get_var_offset(hdata: str, name: str) -> int:
- """`hdata_get_var_offset in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_get_var_offset>`_
+ """`hdata_get_var_offset in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_get_var_offset>`_
::
# example
@@ -2382,7 +2461,7 @@ def hdata_get_var_offset(hdata: str, name: str) -> int:
def hdata_get_var_type_string(hdata: str, name: str) -> str:
- """`hdata_get_var_type_string in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_get_var_type_string>`_
+ """`hdata_get_var_type_string in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_get_var_type_string>`_
::
# example
@@ -2392,7 +2471,7 @@ def hdata_get_var_type_string(hdata: str, name: str) -> str:
def hdata_get_var_array_size(hdata: str, pointer: str, name: str) -> int:
- """`hdata_get_var_array_size in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_get_var_array_size>`_
+ """`hdata_get_var_array_size in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_get_var_array_size>`_
::
# example
@@ -2402,7 +2481,7 @@ def hdata_get_var_array_size(hdata: str, pointer: str, name: str) -> int:
def hdata_get_var_array_size_string(hdata: str, pointer: str, name: str) -> str:
- """`hdata_get_var_array_size_string in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_get_var_array_size_string>`_
+ """`hdata_get_var_array_size_string in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_get_var_array_size_string>`_
::
# example
@@ -2412,7 +2491,7 @@ def hdata_get_var_array_size_string(hdata: str, pointer: str, name: str) -> str:
def hdata_get_var_hdata(hdata: str, name: str) -> str:
- """`hdata_get_var_hdata in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_get_var_hdata>`_
+ """`hdata_get_var_hdata in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_get_var_hdata>`_
::
# example
@@ -2422,7 +2501,7 @@ def hdata_get_var_hdata(hdata: str, name: str) -> str:
def hdata_get_list(hdata: str, name: str) -> str:
- """`hdata_get_list in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_get_list>`_
+ """`hdata_get_list in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_get_list>`_
::
# example
@@ -2433,7 +2512,7 @@ def hdata_get_list(hdata: str, name: str) -> str:
def hdata_check_pointer(hdata: str, list: str, pointer: str) -> int:
- """`hdata_check_pointer in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_check_pointer>`_
+ """`hdata_check_pointer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_check_pointer>`_
::
# example
@@ -2449,7 +2528,7 @@ def hdata_check_pointer(hdata: str, list: str, pointer: str) -> int:
def hdata_move(hdata: str, pointer: str, count: int) -> str:
- """`hdata_move in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_move>`_
+ """`hdata_move in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_move>`_
::
# example
@@ -2469,7 +2548,7 @@ def hdata_move(hdata: str, pointer: str, count: int) -> str:
def hdata_search(hdata: str, pointer: str, search: str,
pointers: Dict[str, str], extra_vars: Dict[str, str], options: Dict[str, str],
count: int) -> str:
- """`hdata_search in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_search>`_
+ """`hdata_search in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_search>`_
::
# example
@@ -2486,7 +2565,7 @@ def hdata_search(hdata: str, pointer: str, search: str,
def hdata_char(hdata: str, pointer: str, name: str) -> int:
- """`hdata_char in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_char>`_
+ """`hdata_char in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_char>`_
::
# example
@@ -2496,7 +2575,7 @@ def hdata_char(hdata: str, pointer: str, name: str) -> int:
def hdata_integer(hdata: str, pointer: str, name: str) -> int:
- """`hdata_integer in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_integer>`_
+ """`hdata_integer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_integer>`_
::
# example
@@ -2508,7 +2587,7 @@ def hdata_integer(hdata: str, pointer: str, name: str) -> int:
def hdata_long(hdata: str, pointer: str, name: str) -> int:
- """`hdata_long in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_long>`_
+ """`hdata_long in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_long>`_
::
# example
@@ -2518,7 +2597,7 @@ def hdata_long(hdata: str, pointer: str, name: str) -> int:
def hdata_string(hdata: str, pointer: str, name: str) -> str:
- """`hdata_string in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_string>`_
+ """`hdata_string in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_string>`_
::
# example
@@ -2530,7 +2609,7 @@ def hdata_string(hdata: str, pointer: str, name: str) -> str:
def hdata_pointer(hdata: str, pointer: str, name: str) -> str:
- """`hdata_pointer in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_pointer>`_
+ """`hdata_pointer in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_pointer>`_
::
# example
@@ -2542,7 +2621,7 @@ def hdata_pointer(hdata: str, pointer: str, name: str) -> str:
def hdata_time(hdata: str, pointer: str, name: str) -> int:
- """`hdata_time in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_time>`_
+ """`hdata_time in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_time>`_
::
# example
@@ -2560,7 +2639,7 @@ def hdata_time(hdata: str, pointer: str, name: str) -> int:
def hdata_hashtable(hdata: str, pointer: str, name: str) -> Dict[str, str]:
- """`hdata_hashtable in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_hashtable>`_
+ """`hdata_hashtable in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_hashtable>`_
::
# example
@@ -2575,7 +2654,7 @@ def hdata_hashtable(hdata: str, pointer: str, name: str) -> Dict[str, str]:
def hdata_compare(hdata: str, pointer1: str, pointer2: str, name: str, case_sensitive: int) -> int:
- """`hdata_compare in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_compare>`_
+ """`hdata_compare in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_compare>`_
::
# example
@@ -2588,7 +2667,7 @@ def hdata_compare(hdata: str, pointer1: str, pointer2: str, name: str, case_sens
def hdata_update(hdata: str, pointer: str, hashtable: Dict[str, str]) -> int:
- """`hdata_update in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_update>`_
+ """`hdata_update in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_update>`_
::
# example: subtract one hour on last message displayed in current buffer
@@ -2604,7 +2683,7 @@ def hdata_update(hdata: str, pointer: str, hashtable: Dict[str, str]) -> int:
def hdata_get_string(hdata: str, property: str) -> str:
- """`hdata_get_string in WeeChat plugin API reference <https://weechat.org/doc/api/#_hdata_get_string>`_
+ """`hdata_get_string in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_hdata_get_string>`_
::
# example
@@ -2615,7 +2694,7 @@ def hdata_get_string(hdata: str, property: str) -> str:
def upgrade_new(filename: str, callback_read: str, callback_read_data: str) -> str:
- """`upgrade_new in WeeChat plugin API reference <https://weechat.org/doc/api/#_upgrade_new>`_
+ """`upgrade_new in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_upgrade_new>`_
::
# example
@@ -2625,7 +2704,7 @@ def upgrade_new(filename: str, callback_read: str, callback_read_data: str) -> s
def upgrade_write_object(upgrade_file: str, object_id: int, infolist: str) -> int:
- """`upgrade_write_object in WeeChat plugin API reference <https://weechat.org/doc/api/#_upgrade_write_object>`_
+ """`upgrade_write_object in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_upgrade_write_object>`_
::
# example
@@ -2635,7 +2714,7 @@ def upgrade_write_object(upgrade_file: str, object_id: int, infolist: str) -> in
def upgrade_read(upgrade_file: str) -> int:
- """`upgrade_read in WeeChat plugin API reference <https://weechat.org/doc/api/#_upgrade_read>`_
+ """`upgrade_read in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_upgrade_read>`_
::
# example
@@ -2645,7 +2724,7 @@ def upgrade_read(upgrade_file: str) -> int:
def upgrade_close(upgrade_file: str) -> int:
- """`upgrade_close in WeeChat plugin API reference <https://weechat.org/doc/api/#_upgrade_close>`_
+ """`upgrade_close in WeeChat plugin API reference <https://weechat.org/doc/weechat/api/#_upgrade_close>`_
::
# example