summaryrefslogtreecommitdiff
path: root/doc/en/weechat_plugin_api.en.txt
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2009-06-10 12:40:05 +0200
committerSebastien Helleu <flashcode@flashtux.org>2009-06-10 12:40:05 +0200
commit8d58b81d83d9a5462f1b4aeb274a16a91ef213d1 (patch)
tree4bf0ef51ea845f54fa97012b1ebe9a85e24f1750 /doc/en/weechat_plugin_api.en.txt
parentfd31dbb97ec00ee49cec21c4731677c403c80564 (diff)
downloadweechat-8d58b81d83d9a5462f1b4aeb274a16a91ef213d1.zip
Add buffer merging feature, with /buffer merge/unmerge (task #7404)
Diffstat (limited to 'doc/en/weechat_plugin_api.en.txt')
-rw-r--r--doc/en/weechat_plugin_api.en.txt83
1 files changed, 80 insertions, 3 deletions
diff --git a/doc/en/weechat_plugin_api.en.txt b/doc/en/weechat_plugin_api.en.txt
index b40e91b95..546a74616 100644
--- a/doc/en/weechat_plugin_api.en.txt
+++ b/doc/en/weechat_plugin_api.en.txt
@@ -968,8 +968,8 @@ char *str = weechat_string_format_size (2097152); /* str == "2 MB" */
free (str);
----------------------------------------
-weechat_string_reove_color
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+weechat_string_remove_color
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove WeeChat colors from a string.
@@ -5066,10 +5066,33 @@ Example:
[source,C]
----------------------------------------
-struct t_gui_buffer *weechat_buffer = weechat_buffer_search ("core", "weechat");
struct t_gui_buffer *my_buffer = weechat_buffer_search ("myplugin", "my_buffer");
----------------------------------------
+weechat_buffer_search_main
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Search WeeChat main buffer ('core' buffer, first buffer displayed when WeeChat
+is starting).
+
+Prototype:
+
+[source,C]
+----------------------------------------
+struct t_gui_buffer *weechat_buffer_search_main ();
+----------------------------------------
+
+Return value:
+
+* pointer to main buffer
+
+Example:
+
+[source,C]
+----------------------------------------
+struct t_gui_buffer *weechat_buffer = weechat_buffer_search_main ();
+----------------------------------------
+
weechat_buffer_clear
^^^^^^^^^^^^^^^^^^^^
@@ -5124,6 +5147,60 @@ struct t_gui_buffer *my_buffer = weechat_buffer_new ("my_buffer",
weechat_buffer_close (my_buffer);
----------------------------------------
+weechat_buffer_merge
+^^^^^^^^^^^^^^^^^^^^
+
+Merge buffer into another buffer.
+
+Prototype:
+
+[source,C]
+----------------------------------------
+void weechat_buffer_merge (struct t_gui_buffer *buffer,
+ struct t_gui_buffer *target_buffer);
+----------------------------------------
+
+Arguments:
+
+* 'buffer': buffer pointer
+* 'target_buffer': target buffer, where buffer will be merged
+
+Example:
+
+[source,C]
+----------------------------------------
+/* merge current buffer with weechat core buffer */
+weechat_buffer_merge (weechat_current_buffer (),
+ weechat_buffer_search ("core", "weechat"));
+----------------------------------------
+
+weechat_buffer_unmerge
+^^^^^^^^^^^^^^^^^^^^^^
+
+Unmerge buffer from a group of merged buffers.
+
+Prototype:
+
+[source,C]
+----------------------------------------
+void weechat_buffer_unmerge (struct t_gui_buffer *buffer,
+ int number);
+----------------------------------------
+
+Arguments:
+
+* 'buffer': buffer pointer
+* 'number': target number for detached buffer, if it is < 1, then buffer will
+ be moved to number of 'buffer' + 1
+
+Example:
+
+[source,C]
+----------------------------------------
+/* unmerge current buffer (to number 1 in list) */
+weechat_buffer_unmerge (weechat_current_buffer (), 1);
+----------------------------------------
+
weechat_buffer_get_integer
^^^^^^^^^^^^^^^^^^^^^^^^^^