From a5f5201e9cacb1587b0101e2e182307b638e172f Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Wed, 6 Oct 2010 18:21:24 +0100 Subject: documentation improvements --- docs/Irssi/TextUI/StatusbarItem.pod | 17 +++++++++++++- feature-tests/sbar_test.pl | 44 +++++++++++++++++++++++++++++++++++++ 2 files changed, 60 insertions(+), 1 deletion(-) diff --git a/docs/Irssi/TextUI/StatusbarItem.pod b/docs/Irssi/TextUI/StatusbarItem.pod index 87de288..b62890c 100644 --- a/docs/Irssi/TextUI/StatusbarItem.pod +++ b/docs/Irssi/TextUI/StatusbarItem.pod @@ -4,11 +4,26 @@ __END__ Irssi::TextUI::StatusbarItem +=head1 DESCRIPTION + =head1 FIELDS =head1 METHODS =head2 C -I +=over + +=item C<$item> + +=item C<$get_size_only> + +=item C<$str> + +=item C<$data> + +=item C<$escape_vars> - defaults to C + +=back + diff --git a/feature-tests/sbar_test.pl b/feature-tests/sbar_test.pl index 6523842..121bc52 100644 --- a/feature-tests/sbar_test.pl +++ b/feature-tests/sbar_test.pl @@ -29,3 +29,47 @@ sub foo_sb { } Irssi::statusbar_item_register ('foo_bar', 0, 'foo_sb'); + +__END__ +# Name Type Placement Position Visible +# window window bottom 1 active +# window_inact window bottom 1 inactive +# prompt root bottom 0 always +# topic root top 1 always + +# Statusbar: prompt +# Type : root +# Placement: bottom +# Position : 0 +# Visible : always +# Items : Name Priority Alignment +# : prompt 0 left +# : prompt_empty 0 left +# : input 10 left +# +# STATUSBAR ENABLE +# STATUSBAR DISABLE +# STATUSBAR RESET +# STATUSBAR TYPE window|root +# STATUSBAR PLACEMENT top|bottom +# STATUSBAR POSITION +# STATUSBAR VISIBLE always|active|inactive +# STATUSBAR ADD +# [-before | -after ] [-priority #] +# [-alignment left|right] +# +# STATUSBAR REMOVE +# +# Commands for modifying the statusbar. +# +# /STATUSBAR +# - Display all statusbars. +# +# /STATUSBAR +# - display elements of statusbar +# +# Irssi commands: +# statusbar add statusbar enable statusbar position statusbar reset +# statusbar visible statusbar disable statusbar placement statusbar remove +# statusbar type + -- cgit v1.2.3