diff options
| author | Sebastien Helleu <flashcode@flashtux.org> | 2006-02-20 17:01:18 +0000 |
|---|---|---|
| committer | Sebastien Helleu <flashcode@flashtux.org> | 2006-02-20 17:01:18 +0000 |
| commit | 9373a7a47e4711e8db0549cec49da19db45330ae (patch) | |
| tree | 5940281d9c986998fe96daebbca9fd04fcf1f589 /doc | |
| parent | e0c97562a596bcfde406fb26dbc8f9d5f0cde111 (diff) | |
| download | weechat-9373a7a47e4711e8db0549cec49da19db45330ae.zip | |
Added new plugin API function: remove_infobar
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/en/weechat.en.xml | 67 | ||||
| -rw-r--r-- | doc/fr/weechat.fr.xml | 67 |
2 files changed, 134 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 <= 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> diff --git a/doc/fr/weechat.fr.xml b/doc/fr/weechat.fr.xml index 37f6e3478..816ca7213 100644 --- a/doc/fr/weechat.fr.xml +++ b/doc/fr/weechat.fr.xml @@ -3791,6 +3791,73 @@ weechat.print_infobar(5, "message") </section> <section> + <title>remove_infobar</title> + + <para> + Prototype Perl : + <command> + weechat::remove_infobar([nombre]); + </command> + </para> + <para> + Prototype Python : + <command> + weechat.remove_infobar([nombre]) + </command> + </para> + <para> + Prototype Ruby : + <command> + Weechat.remove_infobar([nombre]) + </command> + </para> + <para> + Prototype Lua : + <command> + weechat.remove_infobar([nombre]) + </command> + </para> + <para> + Efface un ou plusieurs messages dans la pile de la barre d'infos. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>nombre</option> : nombre de messages à supprimer + (si paramètre non présent ou <= 0, alors tous les messages + sont effacés) + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : 1 si succès, 0 si une erreur s'est produite. + </para> + <para> + Exemples : +<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> |