aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Irssi/Windowitem.pm
diff options
context:
space:
mode:
authorTom Feist <shabble@cowu.be>2010-07-10 00:38:43 +0000
committerTom Feist <shabble@cowu.be>2010-07-10 00:38:43 +0000
commit5d4e7a3d29b438005bfcd9defd1a0e45e7c85086 (patch)
tree01d74acefcaef3f4a7c2521f1f3a635928046ef0 /docs/Irssi/Windowitem.pm
parentmigrated quite a lot of the perl.txt into individual modules (diff)
downloadirssi-scripts-5d4e7a3d29b438005bfcd9defd1a0e45e7c85086.tar.gz
irssi-scripts-5d4e7a3d29b438005bfcd9defd1a0e45e7c85086.zip
Forgot to add a whole bunch of files
Diffstat (limited to '')
-rw-r--r--docs/Irssi/Windowitem.pm41
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/Irssi/Windowitem.pm b/docs/Irssi/Windowitem.pm
new file mode 100644
index 0000000..78919cc
--- /dev/null
+++ b/docs/Irssi/Windowitem.pm
@@ -0,0 +1,41 @@
+__END__
+
+=head1 NAME
+
+Irssi::Windowitem
+
+=head1 DESCRIPTION
+
+
+The meaning of "window" should be pretty clear, but "window item" is something I
+couldn't really figure out a better name for :) They're simply something that's
+inside a window, a channel or a query usually. Windows can have multiple items
+inside them. It's possible to create non-channel/query window items too,
+currently the third possible window item is created by /EXEC -interactive.
+
+In scripts, I think you can quite safely assume that the window item is
+query or channel if the script is intended to be run in one of them.
+Stupid users won't probably have other window items, and smart users
+know where to run the script, or at least later figure out why it
+didn't work :)
+
+=head1 FIELDS
+
+Windowitem->{}
+ type - Type of the window item, for example "CHANNEL" or "QUERY"
+ chat_type - String ID of chat protocol, for example "IRC"
+
+ server - Active server for item
+ name - Name of the item
+
+ createtime - Time the window item was created
+ data_level - 0=no new data, 1=text, 2=msg, 3=highlighted text
+ hilight_color - Color of the last highlighted text
+
+=head1 METHODS
+
+Windowitem::print(str[, level])
+
+Windowitem::command(cmd)
+
+