diff options
Diffstat (limited to 'doc/en/weechat_plugin_api.en.asciidoc')
| -rw-r--r-- | doc/en/weechat_plugin_api.en.asciidoc | 549 |
1 files changed, 275 insertions, 274 deletions
diff --git a/doc/en/weechat_plugin_api.en.asciidoc b/doc/en/weechat_plugin_api.en.asciidoc index c451ef3ce..8b71bf8ce 100644 --- a/doc/en/weechat_plugin_api.en.asciidoc +++ b/doc/en/weechat_plugin_api.en.asciidoc @@ -2,8 +2,9 @@ :author: Sébastien Helleu :email: flashcode@flashtux.org :lang: en -:toc: +:toc2: :toclevels: 4 +:max-width: 100% This manual documents WeeChat chat client, it is part of WeeChat. @@ -221,7 +222,7 @@ For each function, we give: Functions to get infos about plugins. -==== weechat_plugin_get_name +==== plugin_get_name Get plugin name. @@ -266,7 +267,7 @@ Many string functions below are already available thru standard C functions, but it's recommended to use functions in this API because they are OK with UTF-8 and locale. -==== weechat_charset_set +==== charset_set Set new plugin charset (default charset is 'UTF-8', so if your plugin uses 'UTF-8', you don't need to call this function). @@ -300,7 +301,7 @@ weechat.charset_set(charset) weechat.charset_set("iso-8859-1") ---- -==== weechat_iconv_to_internal +==== iconv_to_internal Convert string to WeeChat internal charset (UTF-8). @@ -340,7 +341,7 @@ str = weechat.iconv_to_internal(charset, string) str = weechat.iconv_to_internal("iso-8859-1", "iso string: é à") ---- -==== weechat_iconv_from_internal +==== iconv_from_internal Convert string from internal WeeChat charset (UTF-8) to another. @@ -380,7 +381,7 @@ str = weechat.iconv_from_internal(charset, string) str = weechat.iconv_from_internal("iso-8859-1", "utf-8 string: é à") ---- -==== weechat_gettext +==== gettext Return translated string (depends on local language). @@ -417,7 +418,7 @@ str = weechat.gettext(string) str = weechat.gettext("hello") ---- -==== weechat_ngettext +==== ngettext Return translated string, using single or plural form, according to 'count' argument. @@ -460,7 +461,7 @@ num_files = 2 str = weechat.ngettext("file", "files", num_files) ---- -==== weechat_strndup +==== strndup Return duplicated string, with 'length' chars max. @@ -492,7 +493,7 @@ free (str); [NOTE] This function is not available in scripting API. -==== weechat_string_tolower +==== string_tolower Convert UTF-8 string to lower case. @@ -518,7 +519,7 @@ weechat_string_tolower (str); /* str is now: "abcdé" */ [NOTE] This function is not available in scripting API. -==== weechat_string_toupper +==== string_toupper Convert UTF-8 string to upper case. @@ -544,7 +545,7 @@ weechat_string_toupper (str); /* str is now: "ABCDé" */ [NOTE] This function is not available in scripting API. -==== weechat_strcasecmp +==== strcasecmp _Updated in 1.0._ @@ -578,7 +579,7 @@ int diff = weechat_strcasecmp ("aaa", "CCC"); /* == -2 */ [NOTE] This function is not available in scripting API. -==== weechat_strcasecmp_range +==== strcasecmp_range _WeeChat ≥ 0.3.7, updated in 1.0._ @@ -620,7 +621,7 @@ int diff = weechat_strcasecmp_range ("nick{away}", "NICK[away]", 29); /* == 0 * [NOTE] This function is not available in scripting API. -==== weechat_strncasecmp +==== strncasecmp _Updated in 1.0._ @@ -655,7 +656,7 @@ int diff = weechat_strncasecmp ("aabb", "aacc", 2); /* == 0 */ [NOTE] This function is not available in scripting API. -==== weechat_strncasecmp_range +==== strncasecmp_range _WeeChat ≥ 0.3.7, updated in 1.0._ @@ -698,7 +699,7 @@ int diff = weechat_strncasecmp_range ("nick{away}", "NICK[away]", 6, 29); /* == [NOTE] This function is not available in scripting API. -==== weechat_strcmp_ignore_chars +==== strcmp_ignore_chars _Updated in 1.0._ @@ -737,7 +738,7 @@ int diff = weechat_strcmp_ignore_chars ("a-b", "--a-e", "-", 1); /* == -3 */ [NOTE] This function is not available in scripting API. -==== weechat_strcasestr +==== strcasestr Locale and case independent string search. @@ -767,7 +768,7 @@ char *pos = weechat_strcasestr ("aBcDeF", "de"); /* result: pointer to "DeF" */ [NOTE] This function is not available in scripting API. -==== weechat_strlen_screen +==== strlen_screen _WeeChat ≥ 0.4.2._ @@ -808,7 +809,7 @@ length = weechat.strlen_screen(string) length = weechat.strlen_screen("é") # 1 ---- -==== weechat_string_match +==== string_match _Updated in 1.0._ @@ -863,7 +864,7 @@ match4 = weechat.string_match("abcdef", "*de*", 0) # 1 match5 = weechat.string_match("abcdef", "*b*d*", 0) # 1 ---- -==== weechat_string_expand_home +==== string_expand_home _WeeChat ≥ 0.3.3._ @@ -899,7 +900,7 @@ free (str); [NOTE] This function is not available in scripting API. -==== weechat_string_remove_quotes +==== string_remove_quotes Remove quotes at beginning and end of string (ignore spaces if there are before first quote or after last quote). @@ -934,7 +935,7 @@ free (str); [NOTE] This function is not available in scripting API. -==== weechat_string_strip +==== string_strip Strip chars at beginning and/or end of string. @@ -969,7 +970,7 @@ free (str); [NOTE] This function is not available in scripting API. -==== weechat_string_convert_escaped_chars +==== string_convert_escaped_chars _WeeChat ≥ 1.0._ @@ -1019,7 +1020,7 @@ free (str); [NOTE] This function is not available in scripting API. -==== weechat_string_mask_to_regex +==== string_mask_to_regex Return a regex, built with a mask, where only special char is "`*`". All other special chars for regex are escaped. @@ -1060,7 +1061,7 @@ regex = weechat.string_mask_to_regex(mask) regex = weechat.string_mask_to_regex("test*mask") # "test.*mask" ---- -==== weechat_string_regex_flags +==== string_regex_flags _WeeChat ≥ 0.3.7._ @@ -1112,7 +1113,7 @@ const char *ptr_regex = weechat_string_regex_flags (regex, REG_EXTENDED, &flags) [NOTE] This function is not available in scripting API. -==== weechat_string_regcomp +==== string_regcomp _WeeChat ≥ 0.3.7._ @@ -1156,7 +1157,7 @@ if (weechat_string_regcomp (&my_regex, "(?i)test", REG_EXTENDED) != 0) [NOTE] This function is not available in scripting API. -==== weechat_string_has_highlight +==== string_has_highlight Check if a string has one or more highlights, using list of highlight words. @@ -1195,7 +1196,7 @@ highlight = weechat.string_has_highlight(string, highlight_words) highlight = weechat.string_has_highlight("my test string", "test,word2") # 1 ---- -==== weechat_string_has_highlight_regex +==== string_has_highlight_regex _WeeChat ≥ 0.3.4._ @@ -1238,7 +1239,7 @@ highlight = weechat.string_has_highlight_regex(string, regex) highlight = weechat.string_has_highlight_regex("my test string", "test|word2") # 1 ---- -==== weechat_string_replace +==== string_replace Replace all occurrences of a string by another string. @@ -1273,7 +1274,7 @@ free (str); [NOTE] This function is not available in scripting API. -==== weechat_string_replace_regex +==== string_replace_regex _WeeChat ≥ 1.0._ @@ -1337,7 +1338,7 @@ if (weechat_string_regcomp (&my_regex, "([0-9]{4})-([0-9]{2})-([0-9]{2})", [NOTE] This function is not available in scripting API. -==== weechat_string_split +==== string_split Split a string according to one or more delimiter(s). @@ -1395,7 +1396,7 @@ weechat_string_free_split (argv); [NOTE] This function is not available in scripting API. -==== weechat_string_split_shell +==== string_split_shell _WeeChat ≥ 1.0._ @@ -1440,7 +1441,7 @@ weechat_string_free_split (argv); [NOTE] This function is not available in scripting API. -==== weechat_string_free_split +==== string_free_split Free memory used by a split string. @@ -1470,7 +1471,7 @@ weechat_string_free_split (argv); [NOTE] This function is not available in scripting API. -==== weechat_string_build_with_split_string +==== string_build_with_split_string Build a string with a split string. @@ -1508,7 +1509,7 @@ free (str); [NOTE] This function is not available in scripting API. -==== weechat_string_split_command +==== string_split_command Split a list of commands separated by 'separator' (which can be escaped by "\" in string). @@ -1544,7 +1545,7 @@ weechat_free_split_command (argv); [NOTE] This function is not available in scripting API. -==== weechat_string_free_split_command +==== string_free_split_command Free memory used by a split command. @@ -1572,7 +1573,7 @@ weechat_free_split_command (argv); [NOTE] This function is not available in scripting API. -==== weechat_string_format_size +==== string_format_size Build a string with formatted file size and a unit translated to local language. @@ -1622,7 +1623,7 @@ free (str); [NOTE] This function is not available in scripting API. -==== weechat_string_remove_color +==== string_remove_color Remove WeeChat colors from a string. @@ -1671,7 +1672,7 @@ str = weechat.string_remove_color(string, replacement) str = weechat.string_remove_color(my_string, "?") ---- -==== weechat_string_encode_base64 +==== string_encode_base64 _WeeChat ≥ 0.3.2._ @@ -1703,7 +1704,7 @@ weechat_string_encode_base64 (string, strlen (string), result); [NOTE] This function is not available in scripting API. -==== weechat_string_decode_base64 +==== string_decode_base64 _WeeChat ≥ 0.3.2._ @@ -1739,7 +1740,7 @@ length = weechat_string_decode_base64 (string, result); [NOTE] This function is not available in scripting API. -==== weechat_string_is_command_char +==== string_is_command_char _WeeChat ≥ 0.3.2._ @@ -1780,7 +1781,7 @@ command_char1 = weechat.string_is_command_char("/test") # == 1 command_char2 = weechat.string_is_command_char("test") # == 0 ---- -==== weechat_string_input_for_buffer +==== string_input_for_buffer _WeeChat ≥ 0.3.2._ @@ -1824,7 +1825,7 @@ str2 = weechat.string_input_for_buffer("/test") # "" str3 = weechat.string_input_for_buffer("//test") # "/test" ---- -==== weechat_string_eval_expression +==== string_eval_expression _WeeChat ≥ 0.4.0, updated in 0.4.2 and 1.1._ @@ -2014,7 +2015,7 @@ str5 = weechat.string_eval_expression("password=abc password=def", {}, {}, optio Some UTF-8 string functions. -==== weechat_utf8_has_8bits +==== utf8_has_8bits Check if a string has 8-bits chars. @@ -2046,7 +2047,7 @@ if (weechat_utf8_has_8bits (string)) [NOTE] This function is not available in scripting API. -==== weechat_utf8_is_valid +==== utf8_is_valid Check if a string is UTF-8 valid. @@ -2085,7 +2086,7 @@ else [NOTE] This function is not available in scripting API. -==== weechat_utf8_normalize +==== utf8_normalize Normalize UTF-8 string: remove non UTF-8 chars and replace them by a char. @@ -2111,7 +2112,7 @@ weechat_utf8_normalize (string, '?'); [NOTE] This function is not available in scripting API. -==== weechat_utf8_prev_char +==== utf8_prev_char Return pointer to previous UTF-8 char in a string. @@ -2142,7 +2143,7 @@ char *prev_char = weechat_utf8_prev_char (string, ptr_in_string); [NOTE] This function is not available in scripting API. -==== weechat_utf8_next_char +==== utf8_next_char Return pointer to next UTF-8 char in a string. @@ -2171,7 +2172,7 @@ char *next_char = weechat_utf8_next_char (string); [NOTE] This function is not available in scripting API. -==== weechat_utf8_char_int +==== utf8_char_int Return UTF-8 char as integer. @@ -2200,7 +2201,7 @@ int char_int = weechat_utf8_char_int ("être"); /* "ê" as integer */ [NOTE] This function is not available in scripting API. -==== weechat_utf8_char_size +==== utf8_char_size Return UTF-8 char size (in bytes). @@ -2229,7 +2230,7 @@ int char_size = weechat_utf8_char_size ("être"); /* == 2 */ [NOTE] This function is not available in scripting API. -==== weechat_utf8_strlen +==== utf8_strlen Return UTF-8 string length (in UTF-8 chars). @@ -2258,7 +2259,7 @@ int length = weechat_utf8_strlen ("chêne"); /* == 5 */ [NOTE] This function is not available in scripting API. -==== weechat_utf8_strnlen +==== utf8_strnlen Return UTF-8 string length (in UTF-8 chars), for max 'bytes' in string. @@ -2288,7 +2289,7 @@ int length = weechat_utf8_strnlen ("chêne", 4); /* == 3 */ [NOTE] This function is not available in scripting API. -==== weechat_utf8_strlen_screen +==== utf8_strlen_screen Return number of chars needed on screen to display UTF-8 string. @@ -2317,7 +2318,7 @@ int length_on_screen = weechat_utf8_strlen_screen ("é"); /* == 1 */ [NOTE] This function is not available in scripting API. -==== weechat_utf8_charcmp +==== utf8_charcmp _Updated in 1.0._ @@ -2351,7 +2352,7 @@ int diff = weechat_utf8_charcmp ("aaa", "ccc"); /* == -2 */ [NOTE] This function is not available in scripting API. -==== weechat_utf8_charcasecmp +==== utf8_charcasecmp _Updated in 1.0._ @@ -2385,7 +2386,7 @@ int diff = weechat_utf8_charcasecmp ("aaa", "CCC"); /* == -2 */ [NOTE] This function is not available in scripting API. -==== weechat_utf8_char_size_screen +==== utf8_char_size_screen Return number of chars needed on screen to display UTF-8 char. @@ -2414,7 +2415,7 @@ int length_on_screen = weechat_utf8_char_size_screen ("é"); /* == 1 */ [NOTE] This function is not available in scripting API. -==== weechat_utf8_add_offset +==== utf8_add_offset Move forward N chars in an UTF-8 string. @@ -2445,7 +2446,7 @@ char *str2 = weechat_utf8_add_offset (str, 3); /* points to "ne" */ [NOTE] This function is not available in scripting API. -==== weechat_utf8_real_pos +==== utf8_real_pos Return real position in UTF-8 string. @@ -2475,7 +2476,7 @@ int pos = weechat_utf8_real_pos ("chêne", 3); /* == 4 */ [NOTE] This function is not available in scripting API. -==== weechat_utf8_pos +==== utf8_pos Return position in UTF-8 string. @@ -2505,7 +2506,7 @@ int pos = weechat_utf8_pos ("chêne", 4); /* == 3 */ [NOTE] This function is not available in scripting API. -==== weechat_utf8_strndup +==== utf8_strndup Return duplicate string, with 'length' chars max. @@ -2542,7 +2543,7 @@ This function is not available in scripting API. Some functions related to directories. -==== weechat_mkdir_home +==== mkdir_home Create a directory in WeeChat home. @@ -2583,7 +2584,7 @@ weechat.mkdir_home(directory, mode) weechat.mkdir_home("temp", 0755) ---- -==== weechat_mkdir +==== mkdir Create a directory. @@ -2624,7 +2625,7 @@ weechat.mkdir(directory, mode) weechat.mkdir("/tmp/mydir", 0755) ---- -==== weechat_mkdir_parents +==== mkdir_parents Create a directory and make parent directories as needed. @@ -2665,7 +2666,7 @@ weechat.mkdir_parents(directory, mode) weechat.mkdir_parents("/tmp/my/dir", 0755) ---- -==== weechat_exec_on_files +==== exec_on_files Find files in a directory and execute a callback on each file. @@ -2704,7 +2705,7 @@ weechat_exec_on_files ("/tmp", 0, NULL, &callback); [NOTE] This function is not available in scripting API. -==== weechat_file_get_content +==== file_get_content _WeeChat ≥ 0.3.1._ @@ -2744,7 +2745,7 @@ This function is not available in scripting API. Some useful functions. -==== weechat_util_timeval_cmp +==== util_timeval_cmp Compare two "timeval" structures. @@ -2779,7 +2780,7 @@ if (weechat_util_timeval_cmp (&tv1, &tv2) > 0) [NOTE] This function is not available in scripting API. -==== weechat_util_timeval_diff +==== util_timeval_diff _Updated in 1.1._ @@ -2814,7 +2815,7 @@ long long diff = weechat_util_timeval_diff (&tv1, &tv2); [NOTE] This function is not available in scripting API. -==== weechat_util_timeval_add +==== util_timeval_add _Updated in 1.1._ @@ -2845,7 +2846,7 @@ weechat_util_timeval_add (&tv, 2000000); /* add 2 seconds */ [NOTE] This function is not available in scripting API. -==== weechat_util_get_time_string +==== util_get_time_string _WeeChat ≥ 0.3.2._ @@ -2874,7 +2875,7 @@ weechat_printf (NULL, "date: %s", [NOTE] This function is not available in scripting API. -==== weechat_util_version_number +==== util_version_number _WeeChat ≥ 0.3.9._ @@ -2909,7 +2910,7 @@ This function is not available in scripting API. Sorted list functions. -==== weechat_list_new +==== list_new Create a new list. @@ -2942,7 +2943,7 @@ list = weechat.list_new() list = weechat.list_new() ---- -==== weechat_list_add +==== list_add Add an item in a list. @@ -2989,7 +2990,7 @@ item = weechat.list_add(list, data, where, user_data) item = weechat.list_add(list, "my data", weechat.WEECHAT_LIST_POS_SORT, "") ---- -==== weechat_list_search +==== list_search Search an item in a list. @@ -3028,7 +3029,7 @@ item = weechat.list_search(list, data) item = weechat.list_search(list, "my data") ---- -==== weechat_list_search_pos +==== list_search_pos _WeeChat ≥ 0.3.4._ @@ -3069,7 +3070,7 @@ pos_item = weechat.list_search_pos(list, data) pos_item = weechat.list_search_pos(list, "my data") ---- -==== weechat_list_casesearch +==== list_casesearch Search an item in a list, ignoring case. @@ -3108,7 +3109,7 @@ item = weechat.list_casesearch(list, data) item = weechat.list_casesearch(list, "my data") ---- -==== weechat_list_casesearch_pos +==== list_casesearch_pos _WeeChat ≥ 0.3.4._ @@ -3149,7 +3150,7 @@ pos_item = weechat.list_casesearch_pos(list, data) pos_item = weechat.list_casesearch_pos(list, "my data") ---- -==== weechat_list_get +==== list_get Return an item in a list by position. @@ -3188,7 +3189,7 @@ item = weechat.list_get(list, position) item = weechat.list_get(list, 0) ---- -==== weechat_list_set +==== list_set Set new value for an item. @@ -3222,7 +3223,7 @@ weechat.list_set(item, value) weechat.list_set(item, "new data") ---- -==== weechat_list_next +==== list_next Return next item in list. @@ -3259,7 +3260,7 @@ item = weechat.list_next(item) item = weechat.list_next(item) ---- -==== weechat_list_prev +==== list_prev Return previous item in list. @@ -3296,7 +3297,7 @@ item = weechat.list_prev(item) item = weechat.list_prev(item) ---- -==== weechat_list_string +==== list_string Return string value of an item. @@ -3333,7 +3334,7 @@ value = weechat.list_string(item) weechat.prnt("", "value of item: %s" % weechat.list_string(item)) ---- -==== weechat_list_size +==== list_size Return size of list (number of items). @@ -3370,7 +3371,7 @@ size = weechat.list_size(list) weechat.prnt("", "size of list: %d" % weechat.list_size(list)) ---- -==== weechat_list_remove +==== list_remove Remove an item in a list. @@ -3405,7 +3406,7 @@ weechat.list_remove(list, item) weechat.list_remove(list, item) ---- -==== weechat_list_remove_all +==== list_remove_all Remove all items in a list. @@ -3438,7 +3439,7 @@ weechat.list_remove_all(list) weechat.list_remove_all(list) ---- -==== weechat_list_free +==== list_free Free a list. @@ -3476,7 +3477,7 @@ weechat.list_free(list) Hashtable functions. -==== weechat_hashtable_new +==== hashtable_new _WeeChat ≥ 0.3.3._ @@ -3548,7 +3549,7 @@ struct t_hashtable *hashtable = weechat_hashtable_new (8, [NOTE] This function is not available in scripting API. -==== weechat_hashtable_set_with_size +==== hashtable_set_with_size _WeeChat ≥ 0.3.3, updated in 0.4.2._ @@ -3588,7 +3589,7 @@ weechat_hashtable_set_with_size (hashtable, "my_key", 0, [NOTE] This function is not available in scripting API. -==== weechat_hashtable_set +==== hashtable_set _WeeChat ≥ 0.3.3, updated in 0.4.2._ @@ -3622,7 +3623,7 @@ weechat_hashtable_set (hashtable, "my_key", "my_value"); [NOTE] This function is not available in scripting API. -==== weechat_hashtable_get +==== hashtable_get _WeeChat ≥ 0.3.3._ @@ -3654,7 +3655,7 @@ void *value = weechat_hashtable_get (hashtable, "my_key"); [NOTE] This function is not available in scripting API. -==== weechat_hashtable_has_key +==== hashtable_has_key _WeeChat ≥ 0.3.4._ @@ -3690,7 +3691,7 @@ if (weechat_hashtable_has_key (hashtable, "my_key")) [NOTE] This function is not available in scripting API. -==== weechat_hashtable_map +==== hashtable_map _WeeChat ≥ 0.3.3._ @@ -3734,7 +3735,7 @@ weechat_hashtable_map (hashtable, &map_cb, NULL); [NOTE] This function is not available in scripting API. -==== weechat_hashtable_map_string +==== hashtable_map_string _WeeChat ≥ 0.3.7._ @@ -3781,7 +3782,7 @@ weechat_hashtable_map_string (hashtable, &map_cb, NULL); [NOTE] This function is not available in scripting API. -==== weechat_hashtable_dup +==== hashtable_dup _WeeChat ≥ 1.0._ @@ -3812,7 +3813,7 @@ struct t_hashtable *new_hashtable = weechat_hashtable_dup (hashtable); [NOTE] This function is not available in scripting API. -==== weechat_hashtable_get_integer +==== hashtable_get_integer _WeeChat ≥ 0.3.3._ @@ -3847,7 +3848,7 @@ int items_count = weechat_hashtable_get_integer (hashtable, "items_count"); [NOTE] This function is not available in scripting API. -==== weechat_hashtable_get_string +==== hashtable_get_string _WeeChat ≥ 0.3.4._ @@ -3902,7 +3903,7 @@ weechat_printf (NULL, "list of keys: %s", [NOTE] This function is not available in scripting API. -==== weechat_hashtable_set_pointer +==== hashtable_set_pointer _WeeChat ≥ 0.3.4._ @@ -3948,7 +3949,7 @@ weechat_hashtable_set_pointer (hashtable, "callback_free_key", &my_free_key_cb); [NOTE] This function is not available in scripting API. -==== weechat_hashtable_add_to_infolist +==== hashtable_add_to_infolist _WeeChat ≥ 0.3.3._ @@ -3993,7 +3994,7 @@ weechat_hashtable_add_to_infolist (hashtable, infolist_item, "testhash"); [NOTE] This function is not available in scripting API. -==== weechat_hashtable_remove +==== hashtable_remove _WeeChat ≥ 0.3.3._ @@ -4021,7 +4022,7 @@ weechat_hashtable_remove (hashtable, "my_key"); [NOTE] This function is not available in scripting API. -==== weechat_hashtable_remove_all +==== hashtable_remove_all _WeeChat ≥ 0.3.3._ @@ -4048,7 +4049,7 @@ weechat_hashtable_remove_all (hashtable); [NOTE] This function is not available in scripting API. -==== weechat_hashtable_free +==== hashtable_free _WeeChat ≥ 0.3.3._ @@ -4080,7 +4081,7 @@ This function is not available in scripting API. Functions for configuration files. -==== weechat_config_new +==== config_new Create a new configuration file. @@ -4151,7 +4152,7 @@ def my_config_reload_cb(data, config_file): config_file = weechat.config_new("test", "my_config_reload_cb", "") ---- -==== weechat_config_new_section +==== config_new_section Create a new section in configuration file. @@ -4392,7 +4393,7 @@ section = weechat.config_new_section(config_file, "section1", 1, 1, "my_section_delete_option_cb", "") ---- -==== weechat_config_search_section +==== config_search_section Search a section in a configuration file. @@ -4433,7 +4434,7 @@ section = weechat.config_search_section(config_file, section_name) section = weechat.config_search_section(config_file, "section") ---- -==== weechat_config_new_option +==== config_new_option Create a new option in a section of a configuration file. @@ -4646,7 +4647,7 @@ In Ruby, the 3 callbacks + data (6 strings) must be given in an array of 6 strings (due to a Ruby limitation of 15 arguments by function), see the 'WeeChat Scripting Guide' for more info _(fixed in version 0.4.1)_. -==== weechat_config_search_option +==== config_search_option Search an option in a section of a configuration file. @@ -4689,7 +4690,7 @@ option = weechat.config_search_option(config_file, section, option_name) option = weechat.config_search_option(config_file, section, "option") ---- -==== weechat_config_search_section_option +==== config_search_section_option Search a section and an option in a configuration file or section. @@ -4739,7 +4740,7 @@ else [NOTE] This function is not available in scripting API. -==== weechat_config_search_with_string +==== config_search_with_string Get file/section/option info about an option with full name. @@ -4793,7 +4794,7 @@ else [NOTE] This function is not available in scripting API. -==== weechat_config_string_to_boolean +==== config_string_to_boolean Check if a text is "true" or "false", as boolean value. @@ -4839,7 +4840,7 @@ if weechat.config_string_to_boolean(text): # ... ---- -==== weechat_config_option_reset +==== config_option_reset Reset an option to its default value. @@ -4898,7 +4899,7 @@ elif rc == weechat.WEECHAT_CONFIG_OPTION_SET_ERROR: # ... ---- -==== weechat_config_option_set +==== config_option_set Set new value for an option. @@ -4958,7 +4959,7 @@ elif rc == weechat.WEECHAT_CONFIG_OPTION_SET_ERROR: # ... ---- -==== weechat_config_option_set_null +==== config_option_set_null Set null (undefined value) for an option. @@ -5021,7 +5022,7 @@ elif rc == weechat.WEECHAT_CONFIG_OPTION_SET_ERROR: # ... ---- -==== weechat_config_option_unset +==== config_option_unset Unset/reset option. @@ -5083,7 +5084,7 @@ elif rc == weechat.WEECHAT_CONFIG_OPTION_UNSET_ERROR: # ... ---- -==== weechat_config_option_rename +==== config_option_rename Rename an option. @@ -5118,7 +5119,7 @@ weechat.config_option_rename(option, new_name) weechat.config_option_rename(option, "new_name") ---- -==== weechat_config_option_get_pointer +==== config_option_get_pointer Return a pointer on an option property. @@ -5161,7 +5162,7 @@ char *description = weechat_config_option_get_pointer (option, "description"); [NOTE] This function is not available in scripting API. -==== weechat_config_option_is_null +==== config_option_is_null Check if an option is "null" (undefined value). @@ -5207,7 +5208,7 @@ if weechat.config_option_is_null(option): # ... ---- -==== weechat_config_option_default_is_null +==== config_option_default_is_null Check if default value for an option is "null" (undefined value). @@ -5253,7 +5254,7 @@ if weechat.config_option_default_is_null(option): # ... ---- -==== weechat_config_boolean +==== config_boolean Return boolean value of option. @@ -5300,7 +5301,7 @@ if weechat.config_boolean(option): # ... ---- -==== weechat_config_boolean_default +==== config_boolean_default Return default boolean value of option. @@ -5347,7 +5348,7 @@ if weechat.config_boolean_default(option): # ... ---- -==== weechat_config_integer +==== config_integer Return integer value of option. @@ -5386,7 +5387,7 @@ option = weechat.config_get("plugin.section.option") value = weechat.config_integer(option) ---- -==== weechat_config_integer_default +==== config_integer_default Return default integer value of option. @@ -5425,7 +5426,7 @@ option = weechat.config_get("plugin.section.option") value = weechat.config_integer_default(option) ---- -==== weechat_config_string +==== config_string Return string value of option. @@ -5464,7 +5465,7 @@ option = weechat.config_get("plugin.section.option") value = weechat.config_string(option) ---- -==== weechat_config_string_default +==== config_string_default Return default string value of option. @@ -5503,7 +5504,7 @@ option = weechat.config_get("plugin.section.option") value = weechat.config_string_default(option) ---- -==== weechat_config_color +==== config_color Return color value of option. @@ -5542,7 +5543,7 @@ option = weechat.config_get("plugin.section.option") value = weechat.config_color(option) ---- -==== weechat_config_color_default +==== config_color_default Return default color value of option. @@ -5581,7 +5582,7 @@ option = weechat.config_get("plugin.section.option") value = weechat.config_color_default(option) ---- -==== weechat_config_write_option +==== config_write_option Write a line in a configuration file with option and its value (this function should be called only in "write" or "write_default" callbacks for a section). @@ -5629,7 +5630,7 @@ def my_section_write_cb(data, config_file, section_name): return weechat.WEECHAT_RC_OK ---- -==== weechat_config_write_line +==== config_write_line Write a line in a configuration file (this function should be called only in "write" or "write_default" callbacks for a section). @@ -5681,7 +5682,7 @@ def my_section_write_cb(data, config_file, section_name): return weechat.WEECHAT_RC_OK ---- -==== weechat_config_write +==== config_write Write configuration file to disk. @@ -5737,7 +5738,7 @@ elif rc == weechat.WEECHAT_CONFIG_WRITE_ERROR: # ... ---- -==== weechat_config_read +==== config_read Read configuration file from disk. @@ -5793,7 +5794,7 @@ elif rc == weechat.WEECHAT_CONFIG_READ_FILE_NOT_FOUND: # ... ---- -==== weechat_config_reload +==== config_reload Reload configuration file from disk. @@ -5849,7 +5850,7 @@ elif rc == weechat.WEECHAT_CONFIG_READ_FILE_NOT_FOUND: # ... ---- -==== weechat_config_option_free +==== config_option_free Free an option. @@ -5882,7 +5883,7 @@ weechat.config_option_free(option) weechat.config_option_free(option) ---- -==== weechat_config_section_free_options +==== config_section_free_options Free all options in a section. @@ -5915,7 +5916,7 @@ weechat.config_section_free_options(section) weechat.config_section_free_options(section) ---- -==== weechat_config_section_free +==== config_section_free Free a section. @@ -5948,7 +5949,7 @@ weechat.config_section_free(section) weechat.config_section_free(section) ---- -==== weechat_config_free +==== config_free Free a configuration file. @@ -5981,7 +5982,7 @@ weechat.config_free(config_file) weechat.config_free(config_file) ---- -==== weechat_config_get +==== config_get Search an option with full name. @@ -6018,7 +6019,7 @@ option = weechat.config_get(option_name) option = weechat.config_get("weechat.look.item_time_format") ---- -==== weechat_config_get_plugin +==== config_get_plugin Search an option in plugins configuration file (plugins.conf). @@ -6058,7 +6059,7 @@ value = weechat.config_get_plugin(option_name) value = weechat.config_get_plugin("option") ---- -==== weechat_config_is_set_plugin +==== config_is_set_plugin Check if option is set in plugins configuration file (plugins.conf). @@ -6108,7 +6109,7 @@ else: # ... ---- -==== weechat_config_set_plugin +==== config_set_plugin Set new value for option in plugins configuration file (plugins.conf). @@ -6172,7 +6173,7 @@ elif rc == weechat.WEECHAT_CONFIG_OPTION_SET_ERROR: # ... ---- -==== weechat_config_set_desc_plugin +==== config_set_desc_plugin _WeeChat ≥ 0.3.5._ @@ -6216,7 +6217,7 @@ if int(version) >= 0x00030500: weechat.config_set_desc_plugin("option", "description of option") ---- -==== weechat_config_unset_plugin +==== config_unset_plugin Unset option in plugins configuration file (plugins.conf). @@ -6284,7 +6285,7 @@ elif rc == weechat.WEECHAT_CONFIG_OPTION_UNSET_ERROR: Functions for key bindings. -==== weechat_key_bind +==== key_bind _WeeChat ≥ 0.3.6._ @@ -6348,7 +6349,7 @@ keys = {"@chat(python.test):button1": "hsignal:test_mouse", weechat.key_bind("mouse", keys) ---- -==== weechat_key_unbind +==== key_unbind _WeeChat ≥ 0.3.6._ @@ -6406,7 +6407,7 @@ weechat.key_unbind("mouse", "area:chat(python.test)") Functions to display text in buffers. -==== weechat_prefix +==== prefix Return a prefix. @@ -6459,7 +6460,7 @@ value = weechat.prefix(prefix) weechat.prnt("", "%sThis is an error..." % weechat.prefix("error")) ---- -==== weechat_color +==== color Return a string color code for display. @@ -6539,7 +6540,7 @@ weechat.prnt("", "Color: %sblue %sdefault color %syellow on red" % (weechat.color("blue"), weechat.color("chat"), weechat.color("yellow,red"))) ---- -==== weechat_printf +==== printf Display a message on a buffer. @@ -6597,7 +6598,7 @@ weechat.prnt(buffer, "\t\t") # empty line (without time) [NOTE] Function is called "print" in scripts ("prnt" in Python). -==== weechat_printf_date +==== printf_date Display a message on a buffer, using a custom date. @@ -6625,7 +6626,7 @@ weechat_printf_date (NULL, time (NULL) - 120, "Hello, 2 minutes ago"); [NOTE] This function is not available in scripting API. -==== weechat_printf_tags +==== printf_tags Display a message on a buffer, using a custom tags. @@ -6654,7 +6655,7 @@ weechat_printf_tags (NULL, "notify_message", [NOTE] This function is not available in scripting API. -==== weechat_printf_date_tags +==== printf_date_tags Display a message on a buffer, using a custom date and tags. @@ -6723,7 +6724,7 @@ weechat.prnt_date_tags("", time - 120, "notify_message", [NOTE] Function is called "print_date_tags" in scripts ("prnt_date_tags" in Python). -==== weechat_printf_y +==== printf_y Display a message on a line of a buffer with free content. @@ -6765,7 +6766,7 @@ weechat.prnt_y("", 2, "My message on third line") [NOTE] Function is called "print_y" in scripts ("prnt_y" in Python). -==== weechat_log_printf +==== log_printf Write a message in WeeChat log file (weechat.log). @@ -6832,7 +6833,7 @@ weechat_hook_modifier ("2000|input_text_display", &modifier_cb, NULL); Following hook types allow priority: command, command_run, signal, hsignal, config, completion, modifier, info, info_hashtable, infolist, hdata, focus. -==== weechat_hook_command +==== hook_command Hook a command. @@ -6968,7 +6969,7 @@ hook = weechat.hook_command("myfilter", "description of myfilter", "my_command_cb", "") ---- -==== weechat_hook_command_run +==== hook_command_run Hook a command when WeeChat runs it. @@ -7038,7 +7039,7 @@ def my_command_run_cb(data, buffer, command): hook = weechat.hook_command_run("/input complete*", "my_command_run_cb", "") ---- -==== weechat_hook_timer +==== hook_timer Hook a timer. @@ -7105,7 +7106,7 @@ def my_timer_cb(data, remaining_calls): hook = weechat.hook_timer(20 * 1000, 0, 0, "my_timer_cb", "") ---- -==== weechat_hook_fd +==== hook_fd Hook a file descriptor (file or socket). @@ -7174,7 +7175,7 @@ sock = ... hook = weechat.hook_fd(sock, 1, 0, 0, "my_fd_cb", "") ---- -==== weechat_hook_process +==== hook_process Hook a process (launched with fork), and catch output. @@ -7313,7 +7314,7 @@ def my_process_cb(data, command, return_code, out, err): hook = weechat.hook_process("ls", 5000, "my_process_cb", "") ---- -==== weechat_hook_process_hashtable +==== hook_process_hashtable _WeeChat ≥ 0.3.7._ @@ -7518,7 +7519,7 @@ hook3 = weechat.hook_process_hashtable("sh", 20000, "my_process_cb", "") ---- -==== weechat_hook_connect +==== hook_connect Hook a connection (background connection to a remote host). @@ -7688,7 +7689,7 @@ hook = weechat.hook_connect("", "my.server.org", 1234, 1, 0, "", "my_connect_cb", "") ---- -==== weechat_hook_print +==== hook_print _Updated in 0.4.3 and 1.0._ @@ -7789,7 +7790,7 @@ def my_print_cb(data, buffer, date, tags, displayed, highlight, prefix, message) hook = weechat.hook_print("", "", "", 1, "my_print_cb", "") ---- -==== weechat_hook_signal +==== hook_signal Hook a signal. @@ -8468,7 +8469,7 @@ def my_signal_cb(data, signal, signal_data): hook = weechat.hook_signal("quit", "my_signal_cb", "") ---- -==== weechat_hook_signal_send +==== hook_signal_send _Updated in 1.0._ @@ -8659,7 +8660,7 @@ weechat.hook_signal_send("irc_input_send", weechat.WEECHAT_HOOK_SIGNAL_STRING, "freenode;;2;;/whois FlashCode") ---- -==== weechat_hook_hsignal +==== hook_hsignal _WeeChat ≥ 0.3.4._ @@ -8785,7 +8786,7 @@ def my_hsignal_cb(data, signal, hashtable): hook = weechat.hook_hsignal("test", "my_hsignal_cb", "") ---- -==== weechat_hook_hsignal_send +==== hook_hsignal_send _WeeChat ≥ 0.3.4, updated in 1.0._ @@ -9016,7 +9017,7 @@ weechat.hook_hsignal_send("irc_redirect_pattern", # ... ---- -==== weechat_hook_config +==== hook_config Hook a configuration option. @@ -9082,7 +9083,7 @@ def my_config_cb(data, option, value): hook = weechat.hook_config("weechat.look.item_time_format", "my_config_cb", "") ---- -==== weechat_hook_completion +==== hook_completion Hook a completion. @@ -9174,7 +9175,7 @@ hook = weechat.hook_completion("plugin_item", "my custom completion!", "my_completion_cb", "") ---- -==== weechat_hook_completion_get_string +==== hook_completion_get_string _WeeChat ≥ 0.3.4._ @@ -9231,7 +9232,7 @@ def my_completion_cb(data, completion_item, buffer, completion): return weechat.WEECHAT_RC_OK ---- -==== weechat_hook_completion_list_add +==== hook_completion_list_add Add a word for a completion. @@ -9267,7 +9268,7 @@ weechat.hook_completion_list_add(completion, word, nick_completion, where) # example: see function hook_completion above ---- -==== weechat_hook_modifier +==== hook_modifier Hook a modifier. @@ -9460,7 +9461,7 @@ def my_modifier_cb(data, modifier, modifier_data, string): hook = weechat.hook_modifier("weechat_print", "my_modifier_cb", "") ---- -==== weechat_hook_modifier_exec +==== hook_modifier_exec Execute modifier(s). @@ -9502,7 +9503,7 @@ weechat.hook_modifier_exec(modifier, modifier_data, string) weechat.hook_modifier_exec("my_modifier", my_data, my_string) ---- -==== weechat_hook_info +==== hook_info Hook an information (callback takes and returns a string). @@ -9569,7 +9570,7 @@ hook = weechat.hook_info("my_info", "Some info", "Info about arguments", "my_info_cb", "") ---- -==== weechat_hook_info_hashtable +==== hook_info_hashtable _WeeChat ≥ 0.3.4._ @@ -9645,7 +9646,7 @@ hook = weechat.hook_info_hashtable("my_info_hashtable", "Some info", "my_info_hashtable_cb", "") ---- -==== weechat_hook_infolist +==== hook_infolist Hook an infolist: callback will return pointer to infolist asked. @@ -9728,7 +9729,7 @@ hook = weechat.hook_infolist("my_infolist", "Infolist with some data", "my_infolist_cb", "") ---- -==== weechat_hook_hdata +==== hook_hdata Hook a hdata: callback will return pointer to hdata asked. @@ -9783,7 +9784,7 @@ struct t_hook *my_hdata = weechat_hook_hdata ("my_hdata", [NOTE] This function is not available in scripting API. -==== weechat_hook_focus +==== hook_focus Hook a focus: mouse event or key pressed in cursor mode (free movement of cursor). @@ -9919,7 +9920,7 @@ def my_focus_nicklist_cb(data, info): hook = weechat.hook_focus("buffer_nicklist", "my_focus_nicklist_cb", "") ---- -==== weechat_hook_set +==== hook_set _WeeChat ≥ 0.3.9 (script: WeeChat ≥ 0.4.3)._ @@ -9996,7 +9997,7 @@ weechat.hook_set(hook, "stdin", "data sent to stdin of child process") weechat.hook_set(hook, "stdin_close", "") # optional ---- -==== weechat_unhook +==== unhook Unhook something hooked. @@ -10031,7 +10032,7 @@ weechat.unhook(hook) weechat.unhook(my_hook) ---- -==== weechat_unhook_all +==== unhook_all Unhook everything that has been hooked by current plugin. @@ -10065,7 +10066,7 @@ weechat.unhook_all() Functions to create/query/close buffers. -==== weechat_buffer_new +==== buffer_new Open a new buffer. @@ -10152,7 +10153,7 @@ def my_close_cb(data, buffer): buffer = weechat.buffer_new("my_buffer", "my_input_cb", "", "my_close_cb", "") ---- -==== weechat_current_buffer +==== current_buffer Return pointer to current buffer (buffer displayed by current window). @@ -10185,7 +10186,7 @@ buffer = weechat.current_buffer() weechat.prnt(weechat.current_buffer(), "Text on current buffer") ---- -==== weechat_buffer_search +==== buffer_search _Updated in 1.0._ @@ -10232,7 +10233,7 @@ buffer = weechat.buffer_search(plugin, name) buffer = weechat.buffer_search("my_plugin", "my_buffer") ---- -==== weechat_buffer_search_main +==== buffer_search_main Search WeeChat main buffer ('core' buffer, first buffer displayed when WeeChat is starting). @@ -10266,7 +10267,7 @@ buffer = weechat.buffer_search_main() buffer = weechat.buffer_search_main() ---- -==== weechat_buffer_clear +==== buffer_clear Clear content of a buffer. @@ -10306,7 +10307,7 @@ if buffer != "": weechat.buffer_clear(buffer) ---- -==== weechat_buffer_close +==== buffer_close Close a buffer. @@ -10345,7 +10346,7 @@ buffer = weechat.buffer_new("my_buffer", "my_input_cb", "", "my_close_cb", "") weechat.buffer_close(buffer) ---- -==== weechat_buffer_merge +==== buffer_merge Merge buffer into another buffer: both buffers will still exist separately, but with same number, and WeeChat will display lines from both buffers (mixed @@ -10385,7 +10386,7 @@ weechat.buffer_merge(buffer, target_buffer) weechat.buffer_merge(weechat.current_buffer(), weechat.buffer_search_main()) ---- -==== weechat_buffer_unmerge +==== buffer_unmerge Unmerge buffer from a group of merged buffers. @@ -10421,7 +10422,7 @@ weechat.buffer_unmerge(buffer, number) weechat.buffer_unmerge(weechat.current_buffer(), 1) ---- -==== weechat_buffer_get_integer +==== buffer_get_integer Return integer value of a buffer property. @@ -10508,7 +10509,7 @@ value = weechat.buffer_get_integer(buffer, property) weechat.prnt("", "my buffer number is: %d" % weechat.buffer_get_integer(my_buffer, "number")) ---- -==== weechat_buffer_get_string +==== buffer_get_string Return string value of a buffer property. @@ -10568,7 +10569,7 @@ weechat.prnt("", "name / short name of buffer are: %s / %s" weechat.buffer_get_string(my_buffer, "short_name"))) ---- -==== weechat_buffer_get_pointer +==== buffer_get_pointer Return pointer value of a buffer property. @@ -10611,7 +10612,7 @@ value = weechat.buffer_get_pointer(buffer, property) weechat.prnt("", "plugin pointer of my buffer: %s" % weechat.buffer_get_pointer(my_buffer, "plugin")) ---- -==== weechat_buffer_set +==== buffer_set Set string value of a buffer property. @@ -10824,7 +10825,7 @@ weechat.buffer_set(my_buffer, "localvar_set_toto", "abc") weechat.buffer_set(my_buffer, "localvar_del_toto", "") ---- -==== weechat_buffer_set_pointer +==== buffer_set_pointer Set pointer value of a buffer property. @@ -10878,7 +10879,7 @@ weechat_buffer_set_pointer (my_buffer, "close_callback", &my_close_cb); [NOTE] This function is not available in scripting API. -==== weechat_buffer_string_replace_local_var +==== buffer_string_replace_local_var Replace local variables in a string by their values, using buffer local variables. @@ -10924,7 +10925,7 @@ str = weechat.buffer_string_replace_local_var(my_buffer, "test with $toto") # str contains "test with abc" ---- -==== weechat_buffer_match_list +==== buffer_match_list _WeeChat ≥ 0.3.5._ @@ -10984,7 +10985,7 @@ if buffer: Functions to query windows. -==== weechat_current_window +==== current_window Return pointer to current window. @@ -11017,7 +11018,7 @@ window = weechat.current_window() current_window = weechat.current_window() ---- -==== weechat_window_search_with_buffer +==== window_search_with_buffer _WeeChat ≥ 0.3.5._ @@ -11059,7 +11060,7 @@ weechat.prnt("", "window displaying core buffer: %s" % weechat.window_search_with_buffer(weechat.buffer_search_main())) ---- -==== weechat_window_get_integer +==== window_get_integer Return integer value of a window property. @@ -11120,7 +11121,7 @@ weechat.prnt("", "current window is at position (x,y): (%d,%d)" weechat.window_get_integer(weechat.current_window(), "win_y"))) ---- -==== weechat_window_get_string +==== window_get_string Return string value of a window property. @@ -11144,7 +11145,7 @@ Return value: * string value of property -==== weechat_window_get_pointer +==== window_get_pointer Return pointer value of a window property. @@ -11188,7 +11189,7 @@ weechat.prnt("", "buffer displayed in current window: %s" % weechat.window_get_pointer(weechat.current_window(), "buffer")) ---- -==== weechat_window_set_title +==== window_set_title Set title for terminal. @@ -11226,7 +11227,7 @@ weechat.window_set_title("new title here") Functions for buffer nicklist. -==== weechat_nicklist_add_group +==== nicklist_add_group Add a group in a nicklist. @@ -11292,7 +11293,7 @@ group = weechat.nicklist_add_group(my_buffer, my_parent_group, "test_group", "weechat.color.nicklist_group", 1) ---- -==== weechat_nicklist_search_group +==== nicklist_search_group Search a group in a nicklist. @@ -11335,7 +11336,7 @@ group = weechat.nicklist_search_group(buffer, from_group, name) group = weechat.nicklist_search_group(my_buffer, "", "test_group") ---- -==== weechat_nicklist_add_nick +==== nicklist_add_nick Add a nick in a group. @@ -11407,7 +11408,7 @@ else: nick = weechat.nicklist_add_nick(my_buffer, my_group, "test_nick", color, "@", "lightgreen", 1) ---- -==== weechat_nicklist_search_nick +==== nicklist_search_nick Search a nick in a nicklist. @@ -11450,7 +11451,7 @@ nick = weechat.nicklist_search_nick(buffer, from_group, name) nick = weechat.nicklist_search_nick(my_buffer, "", "test_nick") ---- -==== weechat_nicklist_remove_group +==== nicklist_remove_group Remove a group from a nicklist. @@ -11485,7 +11486,7 @@ weechat.nicklist_remove_group(buffer, group) weechat.nicklist_remove_group(my_buffer, my_group) ---- -==== weechat_nicklist_remove_nick +==== nicklist_remove_nick Remove a nick from a nicklist. @@ -11520,7 +11521,7 @@ weechat.nicklist_remove_nick(buffer, nick) weechat.nicklist_remove_nick(my_buffer, my_nick) ---- -==== weechat_nicklist_remove_all +==== nicklist_remove_all Remove all groups/nicks from a nicklist. @@ -11553,7 +11554,7 @@ weechat.nicklist_remove_all(buffer) weechat.nicklist_remove_all(my_buffer) ---- -==== weechat_nicklist_get_next_item +==== nicklist_get_next_item _WeeChat ≥ 0.3.7._ @@ -11603,7 +11604,7 @@ while (ptr_group || ptr_nick) [NOTE] This function is not available in scripting API. -==== weechat_nicklist_group_get_integer +==== nicklist_group_get_integer _WeeChat ≥ 0.3.4._ @@ -11648,7 +11649,7 @@ value = weechat.nicklist_group_get_integer(buffer, group, property) visible = weechat.nicklist_group_get_integer(buffer, group, "visible") ---- -==== weechat_nicklist_group_get_string +==== nicklist_group_get_string _WeeChat ≥ 0.3.4._ @@ -11693,7 +11694,7 @@ value = weechat.nicklist_group_get_string(buffer, group, property) color = weechat.nicklist_group_get_string(buffer, group, "color") ---- -==== weechat_nicklist_group_get_pointer +==== nicklist_group_get_pointer _WeeChat ≥ 0.3.4._ @@ -11737,7 +11738,7 @@ value = weechat.nicklist_group_get_pointer(buffer, group, property) parent = weechat.nicklist_group_get_pointer(buffer, group, "parent") ---- -==== weechat_nicklist_group_set +==== nicklist_group_set _WeeChat ≥ 0.3.4._ @@ -11807,7 +11808,7 @@ weechat.nicklist_group_set(buffer, group, "color", "yellow") weechat.nicklist_group_set(buffer, group, "visible", "0") ---- -==== weechat_nicklist_nick_get_integer +==== nicklist_nick_get_integer _WeeChat ≥ 0.3.4._ @@ -11851,7 +11852,7 @@ value = weechat.nicklist_nick_get_integer(buffer, nick, property) visible = weechat.nicklist_nick_get_integer(buffer, nick, "visible") ---- -==== weechat_nicklist_nick_get_string +==== nicklist_nick_get_string _WeeChat ≥ 0.3.4._ @@ -11898,7 +11899,7 @@ value = weechat.nicklist_nick_get_string(buffer, nick, property) color = weechat.nicklist_nick_get_string(buffer, nick, "color") ---- -==== weechat_nicklist_nick_get_pointer +==== nicklist_nick_get_pointer _WeeChat ≥ 0.3.4._ @@ -11942,7 +11943,7 @@ value = weechat.nicklist_nick_get_pointer(buffer, nick, property) group = weechat.nicklist_nick_get_pointer(buffer, nick, "group") ---- -==== weechat_nicklist_nick_set +==== nicklist_nick_set _WeeChat ≥ 0.3.4._ @@ -12030,7 +12031,7 @@ weechat.nicklist_nick_set(buffer, nick, "visible", "0") Functions for bars. -==== weechat_bar_item_search +==== bar_item_search Search a bar item. @@ -12067,7 +12068,7 @@ bar_item = weechat.bar_item_search(name) bar_item = weechat.bar_item_search("myitem") ---- -==== weechat_bar_item_new +==== bar_item_new _Updated in 0.4.2._ @@ -12153,7 +12154,7 @@ def my_build_callback2(data, item, window, buffer, extra_info): bar_item2 = weechat.bar_item_new("(extra)myitem2", "my_build_callback2", "") # WeeChat ≥ 0.4.2 ---- -==== weechat_bar_item_update +==== bar_item_update Update content of a bar item, by calling its build callback. @@ -12186,7 +12187,7 @@ weechat.bar_item_update(name) weechat.bar_item_update("myitem") ---- -==== weechat_bar_item_remove +==== bar_item_remove Remove a bar item. @@ -12219,7 +12220,7 @@ weechat.bar_item_remove(item) weechat.bar_item_remove(myitem) ---- -==== weechat_bar_search +==== bar_search Search a bar. @@ -12256,7 +12257,7 @@ bar = weechat.bar_search(name) bar = weechat.bar_search("mybar") ---- -==== weechat_bar_new +==== bar_new Create a new bar. @@ -12357,7 +12358,7 @@ bar = weechat.bar_new("mybar", "off", "100", "window", "", "top", "horizontal", "0", "5", "default", "cyan", "blue", "off", "time,buffer_number+buffer_name") ---- -==== weechat_bar_set +==== bar_set Set a new value for a bar property. @@ -12399,7 +12400,7 @@ weechat.bar_set(bar, property, value) weechat.bar_set(my_bar, "position", "bottom") ---- -==== weechat_bar_update +==== bar_update Refresh content of a bar on screen. @@ -12432,7 +12433,7 @@ weechat.bar_update(name) weechat.bar_update("mybar") ---- -==== weechat_bar_remove +==== bar_remove Remove a bar. @@ -12470,7 +12471,7 @@ weechat.bar_remove(my_bar) Functions for executing WeeChat commands. -==== weechat_command +==== command _Updated in 1.1._ @@ -12520,7 +12521,7 @@ rc = weechat.command(weechat.buffer_search("irc", "freenode.#weechat"), "/whois Network functions. -==== weechat_network_pass_proxy +==== network_pass_proxy Establish a connection/authentication to a proxy. @@ -12566,7 +12567,7 @@ else [NOTE] This function is not available in scripting API. -==== weechat_network_connect_to +==== network_connect_to _Updated in 0.4.3._ @@ -12625,7 +12626,7 @@ This function is not available in scripting API. Functions to get infos. -==== weechat_info_get +==== info_get Return info, as string, from WeeChat or a plugin. @@ -12674,7 +12675,7 @@ weechat.prnt("", "Current WeeChat version is: %s (compiled on %s)" weechat.prnt("", "WeeChat home is: %s" % weechat.info_get("weechat_dir", "")) ---- -==== weechat_info_get_hashtable +==== info_get_hashtable _WeeChat ≥ 0.3.4._ @@ -12762,7 +12763,7 @@ Each variable has a type and a value. Possible types are: * 'buffer': buffer with fixed length, containing any data * 'time': time value -==== weechat_infolist_new +==== infolist_new Create a new infolist. @@ -12795,7 +12796,7 @@ infolist = weechat.infolist_new() infolist = weechat.infolist_new() ---- -==== weechat_infolist_new_item +==== infolist_new_item Add an item in an infolist. @@ -12832,7 +12833,7 @@ item = weechat.infolist_new_item(infolist) item = weechat.infolist_new_item(infolist) ---- -==== weechat_infolist_new_var_integer +==== infolist_new_var_integer Add an integer variable to an infolist item. @@ -12875,7 +12876,7 @@ var = weechat.infolist_new_var_integer(item, name, value) var = weechat.infolist_new_var_integer(item, "my_integer", 123) ---- -==== weechat_infolist_new_var_string +==== infolist_new_var_string Add a string variable to an infolist item. @@ -12918,7 +12919,7 @@ var = weechat.infolist_new_var_string(item, name, value) var = weechat.infolist_new_var_string(item, "my_string", "value") ---- -==== weechat_infolist_new_var_pointer +==== infolist_new_var_pointer Add a pointer variable to an infolist item. @@ -12961,7 +12962,7 @@ var = weechat.infolist_new_var_pointer(item, name, pointer) var = weechat.infolist_new_var_pointer(item, "my_pointer", pointer) ---- -==== weechat_infolist_new_var_buffer +==== infolist_new_var_buffer Add a buffer variable to an infolist item. @@ -13001,7 +13002,7 @@ struct t_infolist_var *var = weechat_infolist_new_var_buffer (item, [NOTE] This function is not available in scripting API. -==== weechat_infolist_new_var_time +==== infolist_new_var_time Add a time variable to an infolist item. @@ -13044,7 +13045,7 @@ var = weechat.infolist_new_var_time(item, name, time) var = weechat.infolist_new_var_time(item, "my_time", int(time.time())) ---- -==== weechat_infolist_get +==== infolist_get Return infolist from WeeChat or a plugin. @@ -13098,7 +13099,7 @@ infolist = weechat.infolist_get(infolist_name, pointer, arguments) infolist = weechat.infolist_get("irc_server", "", "") ---- -==== weechat_infolist_next +==== infolist_next Move "cursor" to next item in an infolist. The first call to this function for an infolist moves cursor to first item in infolist. @@ -13147,7 +13148,7 @@ else: # no more item available ---- -==== weechat_infolist_prev +==== infolist_prev Move "cursor" to previous item in an infolist. The first call to this function for an infolist moves cursor to last item in infolist. @@ -13197,7 +13198,7 @@ else: # no more item available ---- -==== weechat_infolist_reset_item_cursor +==== infolist_reset_item_cursor Reset "cursor" for infolist. @@ -13230,7 +13231,7 @@ weechat.infolist_reset_item_cursor(infolist) weechat.infolist_reset_item_cursor(infolist) ---- -==== weechat_infolist_search_var +==== infolist_search_var _WeeChat ≥ 0.4.3._ @@ -13277,7 +13278,7 @@ if weechat.infolist_search_var(infolist, "name"): # ... ---- -==== weechat_infolist_fields +==== infolist_fields Return list of fields for current infolist item. @@ -13320,7 +13321,7 @@ fields = weechat.infolist_fields(infolist) # "i:my_integer,s:my_string,p:my_pointer,b:my_buffer,t:my_time" ---- -==== weechat_infolist_integer +==== infolist_integer Return value of integer variable in current infolist item. @@ -13359,7 +13360,7 @@ value = weechat.infolist_integer(infolist, var) weechat.prnt("", "integer = %d" % weechat.infolist_integer(infolist, "my_integer")) ---- -==== weechat_infolist_string +==== infolist_string Return value of string variable in current infolist item. @@ -13398,7 +13399,7 @@ value = weechat.infolist_string(infolist, var) weechat.prnt("", "string = %s" % weechat.infolist_string(infolist, "my_string")) ---- -==== weechat_infolist_pointer +==== infolist_pointer Return value of pointer variable in current infolist item. @@ -13437,7 +13438,7 @@ value = weechat.infolist_pointer(infolist, var) weechat.prnt("", "pointer = 0x%s" % weechat.infolist_pointer(infolist, "my_pointer")) ---- -==== weechat_infolist_buffer +==== infolist_buffer Return value of buffer variable in current infolist item. @@ -13472,7 +13473,7 @@ weechat_printf (NULL, "buffer = 0x%lx, size = %d", [NOTE] This function is not available in scripting API. -==== weechat_infolist_time +==== infolist_time Return value of time variable in current infolist item. @@ -13511,7 +13512,7 @@ value = weechat.infolist_time(infolist, var) weechat.prnt("", "time = %ld" % weechat.infolist_time(infolist, "my_time")) ---- -==== weechat_infolist_free +==== infolist_free Free an infolist. @@ -13555,7 +13556,7 @@ something in memory pointed by hdata variables. + The only way to update data is to call function <<_weechat_hdata_update,weechat_hdata_update>>. -==== weechat_hdata_new +==== hdata_new _WeeChat ≥ 0.3.6, updated in 0.3.9 and 0.4.0._ @@ -13620,7 +13621,7 @@ struct t_hdata *hdata = weechat_hdata_new ("myplugin_list", "prev", "next", 0, 0 [NOTE] This function is not available in scripting API. -==== weechat_hdata_new_var +==== hdata_new_var _WeeChat ≥ 0.3.6, updated in 0.3.9._ @@ -13703,7 +13704,7 @@ WEECHAT_HDATA_VAR(struct t_myplugin_list, next, POINTER, 0, NULL, "myplugin_list [NOTE] This function is not available in scripting API. -==== weechat_hdata_new_list +==== hdata_new_list _WeeChat ≥ 0.3.6, updated in 1.0._ @@ -13765,7 +13766,7 @@ WEECHAT_HDATA_LIST(last_buffer, 0); [NOTE] This function is not available in scripting API. -==== weechat_hdata_get +==== hdata_get _WeeChat ≥ 0.3.6._ @@ -13813,7 +13814,7 @@ hdata = weechat.hdata_get(hdata_name) hdata = weechat.hdata_get("irc_server") ---- -==== weechat_hdata_get_var_offset +==== hdata_get_var_offset _WeeChat ≥ 0.3.6._ @@ -13853,7 +13854,7 @@ offset = weechat.hdata_get_var_offset(hdata, name) offset = weechat.hdata_get_var_offset(hdata, "name") ---- -==== weechat_hdata_get_var_type +==== hdata_get_var_type _WeeChat ≥ 0.3.6._ @@ -13918,7 +13919,7 @@ switch (type) [NOTE] This function is not available in scripting API. -==== weechat_hdata_get_var_type_string +==== hdata_get_var_type_string _WeeChat ≥ 0.3.6._ @@ -13958,7 +13959,7 @@ type = weechat.hdata_get_var_type_string(hdata, name) weechat.prnt("", "type = %s" % weechat.hdata_get_var_type_string("name")) ---- -==== weechat_hdata_get_var_array_size +==== hdata_get_var_array_size _WeeChat ≥ 0.3.9._ @@ -13999,7 +14000,7 @@ array_size = weechat.hdata_get_var_array_size(hdata, pointer, name) array_size = weechat.hdata_get_var_array_size(hdata, pointer, "name") ---- -==== weechat_hdata_get_var_array_size_string +==== hdata_get_var_array_size_string _WeeChat ≥ 0.3.9._ @@ -14042,7 +14043,7 @@ array_size = weechat.hdata_get_var_array_size_string(hdata, pointer, name) array_size = weechat.hdata_get_var_array_size_string(hdata, pointer, "name") ---- -==== weechat_hdata_get_var_hdata +==== hdata_get_var_hdata _WeeChat ≥ 0.3.6._ @@ -14082,7 +14083,7 @@ hdata_name = weechat.hdata_get_var_hdata(hdata, name) weechat.prnt("", "hdata = %s" % weechat.hdata_get_var_hdata(hdata, "name")) ---- -==== weechat_hdata_get_var +==== hdata_get_var _WeeChat ≥ 0.3.6._ @@ -14117,7 +14118,7 @@ void *pointer = weechat_hdata_get_var (hdata, buffer, "name"); [NOTE] This function is not available in scripting API. -==== weechat_hdata_get_var_at_offset +==== hdata_get_var_at_offset _WeeChat ≥ 0.3.6._ @@ -14153,7 +14154,7 @@ void *pointer = weechat_hdata_get_var_at_offset (hdata, buffer, offset); [NOTE] This function is not available in scripting API. -==== weechat_hdata_get_list +==== hdata_get_list _WeeChat ≥ 0.3.6._ @@ -14195,7 +14196,7 @@ hdata = weechat.hdata_get("buffer") buffers = weechat.hdata_get_list(hdata, "gui_buffers") ---- -==== weechat_hdata_check_pointer +==== hdata_check_pointer _WeeChat ≥ 0.3.7, updated in 1.0._ @@ -14256,7 +14257,7 @@ else: # ... ---- -==== weechat_hdata_move +==== hdata_move _WeeChat ≥ 0.3.6._ @@ -14314,7 +14315,7 @@ if buffer: buffer = weechat.hdata_move(hdata, buffer, -1) ---- -==== weechat_hdata_search +==== hdata_search _WeeChat ≥ 0.4.1._ @@ -14374,7 +14375,7 @@ if server: # ... ---- -==== weechat_hdata_char +==== hdata_char _WeeChat ≥ 0.3.7._ @@ -14416,7 +14417,7 @@ value = weechat.hdata_char(hdata, pointer, name) weechat.prnt("", "letter = %c" % weechat.hdata_char(hdata, pointer, "letter")) ---- -==== weechat_hdata_integer +==== hdata_integer _WeeChat ≥ 0.3.6._ @@ -14462,7 +14463,7 @@ buffer = weechat.buffer_search_main() weechat.prnt("", "number = %d" % weechat.hdata_integer(hdata, buffer, "number")) ---- -==== weechat_hdata_long +==== hdata_long _WeeChat ≥ 0.3.6._ @@ -14504,7 +14505,7 @@ value = weechat.hdata_long(hdata, pointer, name) weechat.prnt("", "longvar = %ld" % weechat.hdata_long(hdata, pointer, "longvar")) ---- -==== weechat_hdata_string +==== hdata_string _WeeChat ≥ 0.3.6._ @@ -14550,7 +14551,7 @@ buffer = weechat.buffer_search_main() weechat.prnt("", "name = %s" % weechat.hdata_string(hdata, buffer, "name")) ---- -==== weechat_hdata_pointer +==== hdata_pointer _WeeChat ≥ 0.3.6._ @@ -14596,7 +14597,7 @@ buffer = weechat.buffer_search_main() weechat.prnt("", "lines = %lx" % weechat.hdata_pointer(hdata, buffer, "lines")) ---- -==== weechat_hdata_time +==== hdata_time _WeeChat ≥ 0.3.6._ @@ -14664,7 +14665,7 @@ if ptr: weechat.prnt("", "time of first line displayed = %s" % time.strftime("%F %T", time.localtime(int(date)))) ---- -==== weechat_hdata_hashtable +==== hdata_hashtable _WeeChat ≥ 0.3.7._ @@ -14715,7 +14716,7 @@ for key in hash: weechat.prnt("", " %s == %s" % (key, hash[key])) ---- -==== weechat_hdata_set +==== hdata_set _WeeChat ≥ 0.3.9._ @@ -14755,7 +14756,7 @@ weechat_hdata_set (hdata, pointer, "message", "test"); [NOTE] This function is not available in scripting API. -==== weechat_hdata_update +==== hdata_update _WeeChat ≥ 0.3.9._ @@ -14841,7 +14842,7 @@ if own_lines: weechat.hdata_update(hdata, line_data, {"date": str(weechat.hdata_time(hdata, line_data, "date") - 3600)}) ---- -==== weechat_hdata_get_string +==== hdata_get_string _WeeChat ≥ 0.3.6._ @@ -14904,7 +14905,7 @@ weechat.prnt("", "lists in hdata: %s" % weechat.hdata_get_string(hdata, "list_ke Functions for upgrading WeeChat (command "/upgrade"). -==== weechat_upgrade_new +==== upgrade_new Create or read a file for upgrade. @@ -14945,7 +14946,7 @@ upgrade_file = weechat.upgrade_new(filename, write) upgrade_file = weechat.upgrade_new("my_file", 1) ---- -==== weechat_upgrade_write_object +==== upgrade_write_object Write an object in upgrade file. @@ -14993,7 +14994,7 @@ rc = weechat.upgrade_write_object(upgrade_file, object_id, infolist) weechat.upgrade_write_object(upgrade_file, 1, infolist) ---- -==== weechat_upgrade_read +==== upgrade_read Read an upgrade file. @@ -15059,7 +15060,7 @@ def my_upgrade_read_cb(upgrade_file, object_id, infolist): weechat.upgrade_read(upgrade_file, "my_upgrade_read_cb", "")) ---- -==== weechat_upgrade_close +==== upgrade_close Close an upgrade file. |