diff --git a/doc/en/dev/plugin_c_api.en.xml b/doc/en/dev/plugin_c_api.en.xml index c553d4959..097e8d80c 100644 --- a/doc/en/dev/plugin_c_api.en.xml +++ b/doc/en/dev/plugin_c_api.en.xml @@ -7164,9 +7164,361 @@ weechat_printf (NULL, "current window pointer is: %lx, buffer displayed is: %lx" Functions for buffer nicklist. - - Missing doc! - +
+ weechat_nicklist_add_group + + + Prototype: + +struct t_gui_nick_group *weechat_nicklist_add_group ( + struct t_gui_buffer *buffer, + struct t_gui_nick_group *parent_group, + const char *name, + const char *color, + int visible); + + + + Add a group in a nicklist. + + + Arguments: + + + + : buffer pointer + + + + + : pointer to parent of group, NULL + if group has no parent (nicklist root) + + + + + : group name + + + + + : 1 if group and sub-groups/nicks are + visible, 0 if they are hidden + + + + + : color option name + ("weechat.color.xxx" or "file.section.option") or color name + ("blue", "red",..) or "bar_fg"/"bar_bg"/"bar_delim" (bar + foreground/background/delimiter) + + + + + + + The group name can begin with one or more digits, followed by pipe, + and then group name. When such string is found at beginning, it's + used to sort groups in nicklist. For examples groups "1|test" and + "2|abc" will be sorted: "test" first, "abc" second, whereas "test" + and "abc" will be sorted: "abc" first, "test" second. + + + + Return value: pointer to new group, NULL if an error occured. + + + Example: + +struct t_gui_nick_group *my_group = + weechat_nicklist_add_group (my_buffer, my_parent_group, + "test_group", "weechat.color.nicklist_group", 1); + + +
+ +
+ weechat_nicklist_search_group + + + Prototype: + +struct t_gui_nick_group *weechat_nicklist_search_group ( + struct t_gui_buffer *buffer, + struct t_gui_nick_group *from_group, + const char *name); + + + + Search a group in a nicklist. + + + Arguments: + + + + : buffer pointer + + + + + : search from this group only, if NULL, + then search in whole nicklist + + + + + : group name to search + + + + + + Return value: pointer to group found, NULL if not found. + + + Example: + +struct t_gui_nick_group *ptr_group = + weechat_nicklist_search_group (my_buffer, NULL, "test_group"); + + +
+ +
+ weechat_nicklist_add_nick + + + Prototype: + +struct t_gui_nick_group *weechat_nicklist_add_nick ( + struct t_gui_buffer *buffer, + struct t_gui_nick_group *group, + const char *name, + const char *color, + char prefix, + const char *prefix_color, + int visible); + + + + Add a nick in a group. + + + Arguments: + + + + : buffer pointer + + + + + : group pointer + + + + + : nick name + + + + + : color option name + ("weechat.color.xxx" or "file.section.option") or color name + ("blue", "red",..) or "bar_fg"/"bar_bg"/"bar_delim" (bar + foreground/background/delimiter) + + + + + : prefix displayed before nick + + + + + : color option name + ("weechat.color.xxx" or "file.section.option") or color name + ("blue", "red",..) or "bar_fg"/"bar_bg"/"bar_delim" (bar + foreground/background/delimiter) + + + + + : 1 if nick is visible, 0 if it is hidden + + + + + + Return value: pointer to new nick, NULL if an error occured. + + + Example: + +struct t_gui_nick *my_nick = + weechat_nicklist_add_nick (my_buffer, my_group, + "test_nick", + (nick_away) ? "weechat.color.nicklist_away" : "bar_fg", + '@', "lightgreen", + 1); + + +
+ +
+ weechat_nicklist_search_nick + + + Prototype: + +struct t_gui_nick *weechat_nicklist_search_nick ( + struct t_gui_buffer *buffer, + struct t_gui_nick_group *from_group, + const char *name); + + + + Search a nick in a nicklist. + + + Arguments: + + + + : buffer pointer + + + + + : search from this group only, if NULL, + then search in whole nicklist + + + + + : nick name to search + + + + + + Return value: pointer to nick found, NULL if not found. + + + Example: + +struct t_gui_nick *ptr_nick = + weechat_nicklist_search_nick (my_buffer, NULL, "test_nick"); + + +
+ +
+ weechat_nicklist_remove_group + + + Prototype: + +void weechat_nicklist_remove_group ( + struct t_gui_buffer *buffer, + struct t_gui_nick_group *group); + + + + Remove a group from a nicklist. + + + Arguments: + + + + : buffer pointer + + + + + : group pointer to remove (all + sub-groups/nicks will be removed too) + + + + + + Example: + +weechat_nicklist_remove_group (my_buffer, my_group); + + +
+ +
+ weechat_nicklist_remove_nick + + + Prototype: + +void weechat_nicklist_remove_nick ( + struct t_gui_buffer *buffer, + struct t_gui_nick *nick); + + + + Remove a nick from a nicklist. + + + Arguments: + + + + : buffer pointer + + + + + : nick pointer to remove + + + + + + Example: + +weechat_nicklist_remove_nick (my_buffer, my_nick); + + +
+ +
+ weechat_nicklist_remove_all + + + Prototype: + +void weechat_nicklist_remove_all (struct t_gui_buffer *buffer); + + + + Remove all groups/nicks from a nicklist. + + + Arguments: + + + + : buffer pointer + + + + + + Example: + +weechat_nicklist_remove_all (my_buffer); + + +