[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.9 by root, Mon Jan 2 20:40:20 2006 UTC vs.
Revision 1.13 by root, Tue Jan 3 00:06:57 2006 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	rxvtperl - rxvt-unicode's embedded perl interpreter	3	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	* Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl/>, they will be loaded automatically.	7	# create a file grab_test in $HOME:
8
9	* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
10	thus must be encoded as UTF-8.
11		8
12	sub on_sel_grab {	9	sub on_sel_grab {
13	warn "you selected ", $_[0]->selection;	10	warn "you selected ", $_[0]->selection;
14	()	11	()
15	}	12	}
16		13
17	1	14	# start a @@RXVT_NAME@@ using it:
		15
		16	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
18		17
19	=head1 DESCRIPTION	18	=head1 DESCRIPTION
20		19
21	Everytime a terminal object gets created, scripts specified via the	20	Everytime a terminal object gets created, scripts specified via the
22	C<perl> resource are associated with it.	21	C<perl> resource are loaded and associated with it.
		22
		23	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
		24	thus must be encoded as UTF-8.
23		25
24	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	26	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
25	scripts will be shared (But not enabled) for all terminals.	27	scripts will be shared (But not enabled) for all terminals.
26		28
27	=head2 General API Considerations	29	=head2 General API Considerations
121	code is run after this hook, and takes precedence.	123	code is run after this hook, and takes precedence.
122		124
123	=item on_refresh_end $term	125	=item on_refresh_end $term
124		126
125	Called just after the screen gets redrawn. See C<on_refresh_begin>.	127	Called just after the screen gets redrawn. See C<on_refresh_begin>.
		128
		129	=item on_keyboard_command $term, $string
		130
		131	Called whenever the user presses a key combination that has a
		132	C<perl:string> action bound to it (see description of the B<keysym>
		133	resource in the @@RXVT_NAME@@(1) manpage).
126		134
127	=back	135	=back
128		136
129	=head2 Functions in the C<urxvt> Package	137	=head2 Functions in the C<urxvt> Package
130		138
…		…
382	Convert the given locale-encoded octets into a perl string.	390	Convert the given locale-encoded octets into a perl string.
383		391
384	=item $term->tt_write ($octets)	392	=item $term->tt_write ($octets)
385		393
386	Write the octets given in C<$data> to the tty (i.e. as program input). To	394	Write the octets given in C<$data> to the tty (i.e. as program input). To
387	pass characters instead of octets, you should convetr you strings first to	395	pass characters instead of octets, you should convert your strings first
388	the locale-specific encoding using C<< $term->locale_encode >>.	396	to the locale-specific encoding using C<< $term->locale_encode >>.
		397
		398	=item $nrow = $term->nrow
		399
		400	=item $ncol = $term->ncol
		401
		402	Return the number of rows/columns of the terminal window (i.e. as
		403	specified by C<-geometry>, excluding any scrollback).
		404
		405	=item $nsaved = $term->nsaved
		406
		407	Returns the number of lines in the scrollback buffer.
		408
		409	=item $view_start = $term->view_start ([$newvalue])
		410
		411	Returns the negative row number of the topmost line. Minimum value is
		412	C<0>, which displays the normal terminal contents. Larger values scroll
		413	this many lines into the scrollback buffer.
		414
		415	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		416
		417	Returns the text of the entire row with number C<$row_number>. Row C<0>
		418	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		419	terminal line. The scrollback buffer starts at line C<-1> and extends to
		420	line C<< -$term->nsaved >>.
		421
		422	If C<$new_text> is specified, it will replace characters in the current
		423	line, starting at column C<$start_col> (default C<0>), which is useful
		424	to replace only parts of a line. The font iindex in the rendition will
		425	automatically be updated.
		426
		427	C<$text> is in a special encoding: tabs and wide characters that use more
		428	than one cell when displayed are padded with urxvt::NOCHAR characters
		429	(C<chr 65535>). Characters with combining characters and other characters
		430	that do not fit into the normal tetx encoding will be replaced with
		431	characters in the private use area.
		432
		433	You have to obey this encoding when changing text. The advantage is
		434	that C<substr> and similar functions work on screen cells and not on
		435	characters.
		436
		437	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		438	can be used to convert normal strings into this encoding and vice versa.
		439
		440	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		441
		442	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		443	bitsets. Rendition bitsets contain information about colour, font, font
		444	styles and similar information. See also C<< $term->ROW_t >>.
		445
		446	When setting rendition, the font mask will be ignored.
		447
		448	See the section on RENDITION, below.
		449
		450	=item $length = $term->ROW_l ($row_number[, $new_length])
		451
		452	Returns the number of screen cells that are in use ("the line length"). If
		453	it is C<-1>, then the line is part of a multiple-row logical "line", which
		454	means all characters are in use and it is continued on the next row.
		455
		456	=item $text = $term->special_encode $string
		457
		458	Converts a perl string into the special encoding used by rxvt-unicode,
		459	where one character corresponds to one screen cell. See
		460	C<< $term->ROW_t >> for details.
		461
		462	=item $string = $term->special_decode $text
		463
		464	Converts rxvt-unicodes text reprsentation into a perl string. See
		465	C<< $term->ROW_t >> for details.
389		466
390	=back	467	=back
		468
		469	=head2 RENDITION
		470
		471	Rendition bitsets contain information about colour, font, font styles and
		472	similar information for each screen cell.
		473
		474	The following "macros" deal with changes in rendition sets. You should
		475	never just create a bitset, you should always modify an existing one,
		476	as they contain important information required for correct operation of
		477	rxvt-unicode.
		478
		479	=over 4
		480
		481	=item $rend = urxvt::DEFAULT_RSTYLE
		482
		483	Returns the default rendition, as used when the terminal is starting up or
		484	being reset. Useful as a base
		485
		486	=back
		487
		488	=cut
391		489
392	=head2 The C<urxvt::timer> Class	490	=head2 The C<urxvt::timer> Class
393		491
394	This class implements timer watchers/events. Time is represented as a	492	This class implements timer watchers/events. Time is represented as a
395	fractional number of seconds since the epoch. Example:	493	fractional number of seconds since the epoch. Example:

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.9 by root, Mon Jan 2 20:40:20 2006 UTC vs. Revision 1.13 by root, Tue Jan 3 00:06:57 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.9 by root, Mon Jan 2 20:40:20 2006 UTC vs.
Revision 1.13 by root, Tue Jan 3 00:06:57 2006 UTC