summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2006-02-20 21:55:51 +0000
committerSebastien Helleu <flashcode@flashtux.org>2006-02-20 21:55:51 +0000
commit13ddcc3adc9ac48a00cd7aeb8f4bd5eea24126d8 (patch)
tree5fd8ebca52197c33c527c982f95710acdf51a3ed /doc/en
parent9373a7a47e4711e8db0549cec49da19db45330ae (diff)
downloadweechat-13ddcc3adc9ac48a00cd7aeb8f4bd5eea24126d8.zip
Added infobar_remove in C plugin API
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/weechat.en.xml40
1 files changed, 36 insertions, 4 deletions
diff --git a/doc/en/weechat.en.xml b/doc/en/weechat.en.xml
index b807d35e9..b4a3e4b7c 100644
--- a/doc/en/weechat.en.xml
+++ b/doc/en/weechat.en.xml
@@ -1629,6 +1629,42 @@ plugin->print_infobar (plugin, 5, "hello");
</para>
</section>
+ <section id="secAPI_infobar_remove">
+ <title>infobar_remove</title>
+
+ <para>
+ Prototype:
+ <command>
+ void infobar_remove (t_weechat_plugin *plugin, int count)
+ </command>
+ </para>
+ <para>
+ Remove one or more messages in infobar stack.
+ </para>
+ <para>
+ Arguments:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <option>plugin</option>: pointer to plugin structure
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <option>count</option>: number of messages to remove
+ (if argument is &lt;= 0, then all messages are removed)
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ Return value: none.
+ </para>
+ <para>
+ Example: <screen>plugin->infobar_remove (1);</screen>
+ </para>
+ </section>
+
<section id="secAPI_log">
<title>log</title>
@@ -3770,19 +3806,15 @@ weechat.print_infobar(5, "message")
<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>