summaryrefslogtreecommitdiff
path: root/doc/en/weechat.en.xml
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2006-02-20 17:01:18 +0000
committerSebastien Helleu <flashcode@flashtux.org>2006-02-20 17:01:18 +0000
commit9373a7a47e4711e8db0549cec49da19db45330ae (patch)
tree5940281d9c986998fe96daebbca9fd04fcf1f589 /doc/en/weechat.en.xml
parente0c97562a596bcfde406fb26dbc8f9d5f0cde111 (diff)
downloadweechat-9373a7a47e4711e8db0549cec49da19db45330ae.zip
Added new plugin API function: remove_infobar
Diffstat (limited to 'doc/en/weechat.en.xml')
-rw-r--r--doc/en/weechat.en.xml67
1 files changed, 67 insertions, 0 deletions
diff --git a/doc/en/weechat.en.xml b/doc/en/weechat.en.xml
index a4e6f4b60..b807d35e9 100644
--- a/doc/en/weechat.en.xml
+++ b/doc/en/weechat.en.xml
@@ -3721,6 +3721,73 @@ weechat.print_infobar(5, "message")
</section>
<section>
+ <title>remove_infobar</title>
+
+ <para>
+ Perl prototype:
+ <command>
+ weechat::remove_infobar([count]);
+ </command>
+ </para>
+ <para>
+ Python prototype:
+ <command>
+ weechat.remove_infobar([count])
+ </command>
+ </para>
+ <para>
+ Ruby prototype:
+ <command>
+ Weechat.remove_infobar([count])
+ </command>
+ </para>
+ <para>
+ Lua prototype:
+ <command>
+ weechat.remove_infobar([count])
+ </command>
+ </para>
+ <para>
+ Remove one or more messages in infobar stack.
+ </para>
+ <para>
+ Arguments:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <option>count</option>: number of messages to remove
+ (if argument not given or &lt;= 0, then all messages are
+ removed)
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ Return value: 1 if success, 0 if an error occurred.
+ </para>
+ <para>
+ Examples:
+<screen>
+# perl
+weechat::remove_infobar(1);
+weechat::remove_infobar();
+
+# python
+weechat.remove_infobar(1)
+weechat.remove_infobar()
+
+# ruby
+Weechat.remove_infobar(1)
+Weechat.remove_infobar()
+
+-- lua
+weechat.remove_infobar(1)
+weechat.remove_infobar()
+</screen>
+ </para>
+ </section>
+
+ <section>
<title>log</title>
<para>