diff options
author | Tom Feist <shabble@cowu.be> | 2010-07-16 19:13:58 +0000 |
---|---|---|
committer | Tom Feist <shabble@cowu.be> | 2010-07-16 19:13:58 +0000 |
commit | 0d5275d51acf53e4fbfbffd392ae5b7ed53e8827 (patch) | |
tree | 6180e0faf288ba86389740cecfc07f7fa1e879b0 /docs/Irssi/Windowitem.pod | |
parent | renamed everything to .pod since they are not actually perl modules (diff) | |
download | irssi-scripts-0d5275d51acf53e4fbfbffd392ae5b7ed53e8827.tar.gz irssi-scripts-0d5275d51acf53e4fbfbffd392ae5b7ed53e8827.zip |
hmm, apparently git didn\'t notice my renaming
Diffstat (limited to '')
-rw-r--r-- | docs/Irssi/Windowitem.pod | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/Irssi/Windowitem.pod b/docs/Irssi/Windowitem.pod new file mode 100644 index 0000000..7781a44 --- /dev/null +++ b/docs/Irssi/Windowitem.pod @@ -0,0 +1,55 @@ +__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) + + + +Windowitem::set_active() + Change window item active in parent window. + + +Windowitem::change_server(server) + Change server in window item. + +Windowitem::is_active() + Returns 1 if window item is the active item in parent window. + +Dcc +Windowitem::get_dcc(item) + If `item' is a query of a =nick, return DCC chat record of nick. |