aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Irssi/UI/Window.pod
blob: aa601a8dc81c690a525e703879293a1b618a1f47 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
__END__

=head1 NAME

Irssi::UI::Window

=head1 FIELDS

C<UI::Window-E<gt>{}>

  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

C<UI::TextDest-E<gt>{}>

  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

=head2 C<command $cmd>

=head2 C<print $str, [$level]>

=head2 C<items>

Return a list of items in window.


=head2 C<window_create $automatic>

=head2 C<destroy>

Destroy the window.

Irssi::Window
Windowitem::window()
  Returns parent window for window item.

=head2 C<window_find_name $name>

Find window with name.L<Irssi::UI::Window>

=head2 C<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.


=head2 C<item_add $item, $automatic>

Add specified windowitem

=head2 C<item_remove $item>

remove specified windowitem

=head2 C<item_destroy $item>

destroy specified windowitem

=head2 C<set_active>

Set window active.

=head2 C<change_server $server>

=head2 C<set_refnum $refnum>

=head2 C<set_name $name>

=head2 C<set_history $name>

=head2 C<set_level $level>

Change server/refnum/name/history/level in window.

=head2 C<item_prev>

=head2 C<item_next>

Change to previous/next window item.


=head2 C<get_active_name>

Return active item's name, or if none is active, window's name

=head2 C<item_find $server, $name>

Find window item that matches best to given arguments.