aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Irssi
diff options
context:
space:
mode:
authorTom Feist <shabble@cowu.be>2010-07-16 19:00:13 +0000
committerTom Feist <shabble@cowu.be>2010-07-16 19:00:13 +0000
commit3255a19112b99c39ae45049cf2d00ee20e60ad75 (patch)
tree668aa867fab4413ff92e885f6b8bd511dbf0353b /docs/Irssi
parentreformatting of signals into more useful format for parsing, work on teh sign... (diff)
downloadirssi-scripts-3255a19112b99c39ae45049cf2d00ee20e60ad75.tar.gz
irssi-scripts-3255a19112b99c39ae45049cf2d00ee20e60ad75.zip
signals maybe finished!
Diffstat (limited to '')
-rw-r--r--docs/Irssi.pm10
-rw-r--r--docs/Irssi/Theme.pm9
-rw-r--r--docs/Irssi/UI/Theme.pm8
-rw-r--r--docs/Irssi/UI/Window.pm116
-rw-r--r--docs/Irssi/Window.pm115
5 files changed, 136 insertions, 122 deletions
diff --git a/docs/Irssi.pm b/docs/Irssi.pm
index 2c93256..11837d4 100644
--- a/docs/Irssi.pm
+++ b/docs/Irssi.pm
@@ -71,6 +71,16 @@ additional pages.
=back
+
+=head1 EXPORTS
+
+Nothing by default, but passing a list of function names when C<use>ing the module
+will import them into the current namespace.
+
+For example:
+
+ use Irssi qw/signal_emit signal_add .../;
+
=head1 METHODS
=head2 Accessors
diff --git a/docs/Irssi/Theme.pm b/docs/Irssi/Theme.pm
index f9efc85..72ab9e1 100644
--- a/docs/Irssi/Theme.pm
+++ b/docs/Irssi/Theme.pm
@@ -1,11 +1,4 @@
__END__
-=head1 NAME
-
-Irssi::Theme
-
-=head1 FIELDS
-
-
-=head1 METHODS
+=head1 Deprecated
diff --git a/docs/Irssi/UI/Theme.pm b/docs/Irssi/UI/Theme.pm
new file mode 100644
index 0000000..56e3a3f
--- /dev/null
+++ b/docs/Irssi/UI/Theme.pm
@@ -0,0 +1,8 @@
+=head1 NAME
+
+Irssi::UI::Theme
+
+=head1 FIELDS
+
+=head1 METHODS
+
diff --git a/docs/Irssi/UI/Window.pm b/docs/Irssi/UI/Window.pm
index e69de29..a00827e 100644
--- a/docs/Irssi/UI/Window.pm
+++ b/docs/Irssi/UI/Window.pm
@@ -0,0 +1,116 @@
+__END__
+
+=head1 NAME
+
+Irssi::UI::Window
+
+=head1 FIELDS
+
+UI::Window->{}
+ refnum - Reference number
+ name - Name
+
+ width - Width
+ height - Height
+
+ history_name - Name of named historylist for this window
+
+ active - Active window item
+ active_server - Active server
+
+ servertag - active_server must be either undef or have this same tag
+ (unless there's items in this window). This is used by
+ /WINDOW SERVER -sticky
+ level - Current window level
+
+ sticky_refnum - 1 if reference number is sticky
+
+ data_level - Current data level
+ hilight_color - Current activity hilight color
+
+ last_timestamp - Last time timestamp was written in window
+ last_line - Last time text was written in window
+
+ theme_name - Active theme in window, undef = default
+
+UI::TextDest->{}
+ window - Window where the text will be written
+ server - Target server
+ target - Target channel/query/etc name
+ level - Text level
+
+ hilight_priority - Priority for the hilighted text
+ hilight_color - Color for the hilighted text
+
+
+=head1 METHODS
+
+Window::command(cmd)
+Window::print(str[, level])
+
+
+Window::items()
+ Return a list of items in window.
+
+Window
+window_create(automatic)
+Windowitem::window_create(automatic)
+ Create a new window.
+
+Window::destroy()
+ Destroy the window.
+
+Irssi::Window
+Windowitem::window()
+ Returns parent window for window item.
+
+Window
+window_find_name(name)
+ Find window with name.
+
+Window
+window_find_refnum(refnum)
+ Find window with reference number.
+
+Window
+window_find_level(level)
+Server::window_find_level(level)
+ Find window with level.
+
+Window
+window_find_closest(name, level)
+Server::window_find_closest(name, level)
+ Find window that matches best to given arguments. `name' can be either
+ window name or name of one of the window items.
+
+Window
+window_find_item(name)
+Server::window_find_item(name)
+ Find window which contains window item with specified name/server.
+
+
+Window::item_add(item, automatic)
+Window::item_remove(item)
+Window::item_destroy(item)
+ Add/remove/destroy window item
+
+Window::set_active()
+ Set window active.
+
+Window::change_server(server)
+Window::set_refnum(refnum)
+Window::set_name(name)
+Window::set_history(name)
+Window::set_level(level)
+ Change server/refnum/name/history/level in window.
+
+Window::item_prev()
+Window::item_next()
+ Change to previous/next window item.
+
+
+Window::get_active_name()
+ Return active item's name, or if none is active, window's name
+
+Window::item_find(server, name)
+ Find window item that matches best to given arguments.
diff --git a/docs/Irssi/Window.pm b/docs/Irssi/Window.pm
index 540fae2..981a524 100644
--- a/docs/Irssi/Window.pm
+++ b/docs/Irssi/Window.pm
@@ -1,116 +1,3 @@
__END__
-=head1 NAME
-
-Irssi::Window
-
-=head1 FIELDS
-
-UI::Window->{}
- refnum - Reference number
- name - Name
-
- width - Width
- height - Height
-
- history_name - Name of named historylist for this window
-
- active - Active window item
- active_server - Active server
-
- servertag - active_server must be either undef or have this same tag
- (unless there's items in this window). This is used by
- /WINDOW SERVER -sticky
- level - Current window level
-
- sticky_refnum - 1 if reference number is sticky
-
- data_level - Current data level
- hilight_color - Current activity hilight color
-
- last_timestamp - Last time timestamp was written in window
- last_line - Last time text was written in window
-
- theme_name - Active theme in window, undef = default
-
-UI::TextDest->{}
- window - Window where the text will be written
- server - Target server
- target - Target channel/query/etc name
- level - Text level
-
- hilight_priority - Priority for the hilighted text
- hilight_color - Color for the hilighted text
-
-
-=head1 METHODS
-
-Window::command(cmd)
-Window::print(str[, level])
-
-
-Window::items()
- Return a list of items in window.
-
-Window
-window_create(automatic)
-Windowitem::window_create(automatic)
- Create a new window.
-
-Window::destroy()
- Destroy the window.
-
-Irssi::Window
-Windowitem::window()
- Returns parent window for window item.
-
-Window
-window_find_name(name)
- Find window with name.
-
-Window
-window_find_refnum(refnum)
- Find window with reference number.
-
-Window
-window_find_level(level)
-Server::window_find_level(level)
- Find window with level.
-
-Window
-window_find_closest(name, level)
-Server::window_find_closest(name, level)
- Find window that matches best to given arguments. `name' can be either
- window name or name of one of the window items.
-
-Window
-window_find_item(name)
-Server::window_find_item(name)
- Find window which contains window item with specified name/server.
-
-
-Window::item_add(item, automatic)
-Window::item_remove(item)
-Window::item_destroy(item)
- Add/remove/destroy window item
-
-Window::set_active()
- Set window active.
-
-Window::change_server(server)
-Window::set_refnum(refnum)
-Window::set_name(name)
-Window::set_history(name)
-Window::set_level(level)
- Change server/refnum/name/history/level in window.
-
-Window::item_prev()
-Window::item_next()
- Change to previous/next window item.
-
-
-Window::get_active_name()
- Return active item's name, or if none is active, window's name
-
-Window::item_find(server, name)
- Find window item that matches best to given arguments.
+=head1 DEPRECATED.