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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.161 by ayin, Fri Nov 30 01:22:26 2007 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC

…		…
108	reference. The string will be used as button text and the code reference	108	reference. The string will be used as button text and the code reference
109	will be called when the toggle changes, with the new boolean value as	109	will be called when the toggle changes, with the new boolean value as
110	first argument.	110	first argument.
111		111
112	The following will add an entry C<myoption> that changes	112	The following will add an entry C<myoption> that changes
113	C<$self->{myoption}>:	113	C<< $self->{myoption} >>:
114		114
115	push @{ $self->{term}{option_popup_hook} }, sub {	115	push @{ $self->{term}{option_popup_hook} }, sub {
116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117	};	117	};
118		118
…		…
303	extension will actually grab a physical key just for this function.	303	extension will actually grab a physical key just for this function.
304		304
305	If you want a quake-like animation, tell your window manager to do so	305	If you want a quake-like animation, tell your window manager to do so
306	(fvwm can do it).	306	(fvwm can do it).
307		307
		308	=item overlay-osc
		309
		310	This extension implements some OSC commands to display timed popups on the
		311	screen - useful for status displays from within scripts. You have to read
		312	the sources for more info.
		313
308	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
309		315
310	A not very useful example of filtering all text output to the terminal	316	A not very useful example of filtering all text output to the terminal
311	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
312	similar-looking ascii character.	318	similar-looking ascii character.
…		…
335	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
336	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
337		343
338	=item selection-pastebin	344	=item selection-pastebin
339		345
340	This is a little rarely useful extension that Uploads the selection as	346	This is a little rarely useful extension that uploads the selection as
341	textfile to a remote site (or does other things). (The implementation is	347	textfile to a remote site (or does other things). (The implementation is
342	not currently secure for use in a multiuser environment as it writes to	348	not currently secure for use in a multiuser environment as it writes to
343	F</tmp> directly.).	349	F</tmp> directly.).
344		350
345	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
364		370
365	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
366		372
367	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret	373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
368	the double C</> characters as comment start. Use C<\057\057> instead,	374	the double C</> characters as comment start. Use C<\057\057> instead,
369	which works regardless of wether xrdb is used to parse the resource file	375	which works regardless of whether xrdb is used to parse the resource file
370	or not.	376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
371		391
372	=item example-refresh-hooks	392	=item example-refresh-hooks
373		393
374	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
375	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
…		…
397		417
398	=over 4	418	=over 4
399		419
400	=item $text	420	=item $text
401		421
402	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicode's special way of encoding text, where one "unicode" character
403	always represents one screen cell. See L<ROW_t> for a discussion of this format.	423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
404		424
405	=item $string	425	=item $string
406		426
407	A perl text string, with an emphasis on I<text>. It can store all unicode	427	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
541		561
542	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	562	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
543	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	563	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
544	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
545		565
546	=item on_osc_seq $term, $op, $args	566	=item on_osc_seq $term, $op, $args, $resp
547		567
548	Called on every OSC sequence and can be used to suppress it or modify its	568	Called on every OSC sequence and can be used to suppress it or modify its
549	behaviour. The default should be to return an empty list. A true value	569	behaviour. The default should be to return an empty list. A true value
550	suppresses execution of the request completely. Make sure you don't get	570	suppresses execution of the request completely. Make sure you don't get
551	confused by recursive invocations when you output an osc sequence within	571	confused by recursive invocations when you output an OSC sequence within
552	this callback.	572	this callback.
553		573
554	C<on_osc_seq_perl> should be used for new behaviour.	574	C<on_osc_seq_perl> should be used for new behaviour.
555		575
556	=item on_osc_seq_perl $term, $string	576	=item on_osc_seq_perl $term, $args, $resp
557		577
558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
560	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
561	string should start with the extension name and a colon, to distinguish	581	string should start with the extension name (sans -osc) and a semicolon,
562	it from commands for other extensions, and this might be enforced in the	582	to distinguish it from commands for other extensions, and this might be
563	future.	583	enforced in the future.
		584
		585	For example, C<overlay-osc> uses this:
		586
		587	sub on_osc_seq_perl {
		588	my ($self, $osc, $resp) = @_;
		589
		590	return unless $osc =~ s/^overlay;//;
		591
		592	... process remaining $osc string
		593	}
564		594
565	Be careful not ever to trust (in a security sense) the data you receive,	595	Be careful not ever to trust (in a security sense) the data you receive,
566	as its source can not easily be controlled (e-mail content, messages from	596	as its source can not easily be controlled (e-mail content, messages from
567	other users on the same system etc.).	597	other users on the same system etc.).
		598
		599	For responses, C<$resp> contains the end-of-args separator used by the
		600	sender.
568		601
569	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
570		603
571	Called whenever text is about to be output, with the text as argument. You	604	Called whenever text is about to be output, with the text as argument. You
572	can filter/change and output the text yourself by returning a true value	605	can filter/change and output the text yourself by returning a true value
…		…
577	=item on_tt_write $term, $octets	610	=item on_tt_write $term, $octets
578		611
579	Called whenever some data is written to the tty/pty and can be used to	612	Called whenever some data is written to the tty/pty and can be used to
580	suppress or filter tty input.	613	suppress or filter tty input.
581		614
		615	=item on_tt_paste $term, $octets
		616
		617	Called whenever text is about to be pasted, with the text as argument. You
		618	can filter/change and paste the text yourself by returning a true value
		619	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		620	locale-encoded.
		621
582	=item on_line_update $term, $row	622	=item on_line_update $term, $row
583		623
584	Called whenever a line was updated or changed. Can be used to filter	624	Called whenever a line was updated or changed. Can be used to filter
585	screen output (e.g. underline urls or other useless stuff). Only lines	625	screen output (e.g. underline urls or other useless stuff). Only lines
586	that are being shown will be filtered, and, due to performance reasons,	626	that are being shown will be filtered, and, due to performance reasons,
…		…
593	later with the already-modified line (e.g. if unrelated parts change), so	633	later with the already-modified line (e.g. if unrelated parts change), so
594	you cannot just toggle rendition bits, but only set them.	634	you cannot just toggle rendition bits, but only set them.
595		635
596	=item on_refresh_begin $term	636	=item on_refresh_begin $term
597		637
598	Called just before the screen gets redrawn. Can be used for overlay	638	Called just before the screen gets redrawn. Can be used for overlay or
599	or similar effects by modify terminal contents in refresh_begin, and	639	similar effects by modifying the terminal contents in refresh_begin, and
600	restoring them in refresh_end. The built-in overlay and selection display	640	restoring them in refresh_end. The built-in overlay and selection display
601	code is run after this hook, and takes precedence.	641	code is run after this hook, and takes precedence.
602		642
603	=item on_refresh_end $term	643	=item on_refresh_end $term
604		644
…		…
611	resource in the @@RXVT_NAME@@(1) manpage).	651	resource in the @@RXVT_NAME@@(1) manpage).
612		652
613	The event is simply the action string. This interface is assumed to change	653	The event is simply the action string. This interface is assumed to change
614	slightly in the future.	654	slightly in the future.
615		655
616	=item on_resize_all_windows $tern, $new_width, $new_height	656	=item on_resize_all_windows $term, $new_width, $new_height
617		657
618	Called just after the new window size has been calculated, but before	658	Called just after the new window size has been calculated, but before
619	windows are actually being resized or hints are being set. If this hook	659	windows are actually being resized or hints are being set. If this hook
620	returns TRUE, setting of the window hints is being skipped.	660	returns TRUE, setting of the window hints is being skipped.
621		661
…		…
655		695
656	=item on_map_notify $term, $event	696	=item on_map_notify $term, $event
657		697
658	=item on_unmap_notify $term, $event	698	=item on_unmap_notify $term, $event
659		699
660	Called whenever the corresponding X event is received for the terminal If	700	Called whenever the corresponding X event is received for the terminal. If
661	the hook returns true, then the even will be ignored by rxvt-unicode.	701	the hook returns true, then the event will be ignored by rxvt-unicode.
662		702
663	The event is a hash with most values as named by Xlib (see the XEvent	703	The event is a hash with most values as named by Xlib (see the XEvent
664	manpage), with the additional members C<row> and C<col>, which are the	704	manpage), with the additional members C<row> and C<col>, which are the
665	(real, not screen-based) row and column under the mouse cursor.	705	(real, not screen-based) row and column under the mouse cursor.
666		706
…		…
675		715
676	=item on_wm_delete_window $term, $event	716	=item on_wm_delete_window $term, $event
677		717
678	Called when various types of ClientMessage events are received (all with	718	Called when various types of ClientMessage events are received (all with
679	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	719	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		720
		721	=item on_bell $term
		722
		723	Called on receipt of a bell character.
680		724
681	=back	725	=back
682		726
683	=cut	727	=cut
684		728
…		…
1091	is that you cannot use blocking APIs, but the non-blocking variant should	1135	is that you cannot use blocking APIs, but the non-blocking variant should
1092	work.	1136	work.
1093		1137
1094	=cut	1138	=cut
1095		1139
1096	our $VERSION = 1;	1140	our $VERSION = '5.23';
1097		1141
1098	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1142	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1143	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100		1144
1101	sub timer {	1145	sub timer {
…		…
1103		1147
1104	my $cb = $arg{cb};	1148	my $cb = $arg{cb};
1105		1149
1106	urxvt::timer	1150	urxvt::timer
1107	->new	1151	->new
1108	->start (urxvt::NOW + $arg{after})	1152	->after ($arg{after}, $arg{interval})
1109	->cb (sub {	1153	->cb ($arg{interval} ? $cb : sub {
1110	$_[0]->stop; # need to cancel manually	1154	$_[0]->stop; # need to cancel manually
1111	$cb->();	1155	$cb->();
1112	})	1156	})
1113	}	1157	}
1114		1158
1115	sub io {	1159	sub io {
1116	my ($class, %arg) = @_;	1160	my ($class, %arg) = @_;
1117		1161
1118	my $cb = $arg{cb};	1162	my $cb = $arg{cb};
		1163	my $fd = fileno $arg{fh};
		1164	defined $fd or $fd = $arg{fh};
1119		1165
1120	bless [$arg{fh}, urxvt::iow	1166	bless [$arg{fh}, urxvt::iow
1121	->new	1167	->new
1122	->fd (fileno $arg{fh})	1168	->fd ($fd)
1123	->events (($arg{poll} =~ /r/ ? 1 : 0)	1169	->events (($arg{poll} =~ /r/ ? 1 : 0)
1124	\| ($arg{poll} =~ /w/ ? 2 : 0))	1170	\| ($arg{poll} =~ /w/ ? 2 : 0))
1125	->start	1171	->start
1126	->cb (sub {	1172	->cb ($cb)
1127	$cb->(($_[1] & 1 ? 'r' : '')
1128	. ($_[1] & 2 ? 'w' : ''));
1129	})],
1130	urxvt::anyevent::	1173	], urxvt::anyevent::
		1174	}
		1175
		1176	sub idle {
		1177	my ($class, %arg) = @_;
		1178
		1179	my $cb = $arg{cb};
		1180
		1181	urxvt::iw
		1182	->new
		1183	->start
		1184	->cb ($cb)
		1185	}
		1186
		1187	sub child {
		1188	my ($class, %arg) = @_;
		1189
		1190	my $cb = $arg{cb};
		1191
		1192	urxvt::pw
		1193	->new
		1194	->start ($arg{pid})
		1195	->cb (sub {
		1196	$_[0]->stop; # need to cancel manually
		1197	$cb->($_[0]->rpid, $_[0]->rstatus);
		1198	})
1131	}	1199	}
1132		1200
1133	sub DESTROY {	1201	sub DESTROY {
1134	$_[0][1]->stop;	1202	$_[0][1]->stop;
1135	}
1136
1137	sub condvar {
1138	bless \my $flag, urxvt::anyevent::
1139	}
1140
1141	sub broadcast {
1142	${$_[0]}++;
1143	}
1144
1145	sub wait {
1146	unless (${$_[0]}) {
1147	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1148	}
1149	}	1203	}
1150		1204
1151	sub one_event {	1205	sub one_event {
1152	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1206	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1153	}	1207	}
…		…
1276	Here is a likely non-exhaustive list of resource names, not all of which	1330	Here is a likely non-exhaustive list of resource names, not all of which
1277	are supported in every build, please see the source file F</src/rsinc.h>	1331	are supported in every build, please see the source file F</src/rsinc.h>
1278	to see the actual list:	1332	to see the actual list:
1279		1333
1280	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1334	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1281	borderLess color cursorBlink cursorUnderline cutchars delete_key	1335	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1282	display_name embed ext_bwidth fade font geometry hold iconName	1336	display_name embed ext_bwidth fade font geometry hold iconName
1283	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1337	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1284	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1338	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1285	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1339	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1286	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1340	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1287	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1341	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1288	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1342	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1289	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1343	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1290	secondaryScreen secondaryScroll selectstyle shade term_name title	1344	secondaryScreen secondaryScroll shade term_name title
1291	transient_for transparent transparent_all tripleclickwords utmpInhibit	1345	transient_for transparent transparent_all tripleclickwords utmpInhibit
1292	visualBell	1346	visualBell
1293		1347
1294	=cut	1348	=cut
1295		1349
1296	sub resource($$;$) {	1350	sub resource($$;$) {
1297	my ($self, $name) = (shift, shift);	1351	my ($self, $name) = (shift, shift);
1298	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1352	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1299	&urxvt::term::_resource	1353	goto &urxvt::term::_resource
1300	}	1354	}
1301		1355
1302	=item $value = $term->x_resource ($pattern)	1356	=item $value = $term->x_resource ($pattern)
1303		1357
1304	Returns the X-Resource for the given pattern, excluding the program or	1358	Returns the X-Resource for the given pattern, excluding the program or
…		…
1329		1383
1330	=item ($row, $col) = $term->selection_beg ([$row, $col])	1384	=item ($row, $col) = $term->selection_beg ([$row, $col])
1331		1385
1332	=item ($row, $col) = $term->selection_end ([$row, $col])	1386	=item ($row, $col) = $term->selection_end ([$row, $col])
1333		1387
1334	Return the current values of the selection mark, begin or end positions,	1388	Return the current values of the selection mark, begin or end positions.
1335	and optionally set them to new values.	1389
		1390	When arguments are given, then the selection coordinates are set to
		1391	C<$row> and C<$col>, and the selection screen is set to the current
		1392	screen.
		1393
		1394	=item $screen = $term->selection_screen ([$screen])
		1395
		1396	Returns the current selection screen, and then optionally sets it.
1336		1397
1337	=item $term->selection_make ($eventtime[, $rectangular])	1398	=item $term->selection_make ($eventtime[, $rectangular])
1338		1399
1339	Tries to make a selection as set by C<selection_beg> and	1400	Tries to make a selection as set by C<selection_beg> and
1340	C<selection_end>. If C<$rectangular> is true (default: false), a	1401	C<selection_end>. If C<$rectangular> is true (default: false), a
1341	rectangular selection will be made. This is the prefered function to make	1402	rectangular selection will be made. This is the preferred function to make
1342	a selection.	1403	a selection.
1343		1404
1344	=item $success = $term->selection_grab ($eventtime)	1405	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1345		1406
1346	Try to request the primary selection text from the server (for example, as	1407	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1408	true) selection from the server. The corresponding text can be set
1347	set by the next method). No visual feedback will be given. This function	1409	with the next method. No visual feedback will be given. This function
1348	is mostly useful from within C<on_sel_grab> hooks.	1410	is mostly useful from within C<on_sel_grab> hooks.
1349		1411
1350	=item $oldtext = $term->selection ([$newtext])	1412	=item $oldtext = $term->selection ([$newtext, $clipboard])
1351		1413
1352	Return the current selection text and optionally replace it by C<$newtext>.	1414	Return the current selection (clipboard if C<$clipboard> is true) text
		1415	and optionally replace it by C<$newtext>.
		1416
		1417	=item $term->selection_clear ([$clipboard])
		1418
		1419	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1353		1420
1354	=item $term->overlay_simple ($x, $y, $text)	1421	=item $term->overlay_simple ($x, $y, $text)
1355		1422
1356	Create a simple multi-line overlay box. See the next method for details.	1423	Create a simple multi-line overlay box. See the next method for details.
1357		1424
…		…
1387		1454
1388	The methods currently supported on C<urxvt::overlay> objects are:	1455	The methods currently supported on C<urxvt::overlay> objects are:
1389		1456
1390	=over 4	1457	=over 4
1391		1458
1392	=item $overlay->set ($x, $y, $text, $rend)	1459	=item $overlay->set ($x, $y, $text[, $rend])
1393		1460
1394	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1461	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1395	text in rxvt-unicode's special encoding and an array of rendition values	1462	text in rxvt-unicode's special encoding and an array of rendition values
1396	at a specific position inside the overlay.	1463	at a specific position inside the overlay.
		1464
		1465	If C<$rend> is missing, then the rendition will not be changed.
1397		1466
1398	=item $overlay->hide	1467	=item $overlay->hide
1399		1468
1400	If visible, hide the overlay, but do not destroy it.	1469	If visible, hide the overlay, but do not destroy it.
1401		1470
…		…
1483	locale-specific encoding of the terminal and can contain command sequences	1552	locale-specific encoding of the terminal and can contain command sequences
1484	(escape codes) that will be interpreted.	1553	(escape codes) that will be interpreted.
1485		1554
1486	=item $term->tt_write ($octets)	1555	=item $term->tt_write ($octets)
1487		1556
1488	Write the octets given in C<$data> to the tty (i.e. as program input). To	1557	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1489	pass characters instead of octets, you should convert your strings first	1558	pass characters instead of octets, you should convert your strings first
1490	to the locale-specific encoding using C<< $term->locale_encode >>.	1559	to the locale-specific encoding using C<< $term->locale_encode >>.
		1560
		1561	=item $term->tt_paste ($octets)
		1562
		1563	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1564	CR and bracketing the data with control sequences if bracketed paste mode
		1565	is set.
1491		1566
1492	=item $old_events = $term->pty_ev_events ([$new_events])	1567	=item $old_events = $term->pty_ev_events ([$new_events])
1493		1568
1494	Replaces the event mask of the pty watcher by the given event mask. Can	1569	Replaces the event mask of the pty watcher by the given event mask. Can
1495	be used to suppress input and output handling to the pty/tty. See the	1570	be used to suppress input and output handling to the pty/tty. See the
…		…
1611		1686
1612	Used after changing terminal contents to display them.	1687	Used after changing terminal contents to display them.
1613		1688
1614	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1689	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1615		1690
1616	Returns the text of the entire row with number C<$row_number>. Row C<0>	1691	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1617	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1692	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1618	terminal line. The scrollback buffer starts at line C<-1> and extends to
1619	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1693	terminal line. Nothing will be returned if a nonexistent line
1620	is requested.	1694	is requested.
1621		1695
1622	If C<$new_text> is specified, it will replace characters in the current	1696	If C<$new_text> is specified, it will replace characters in the current
1623	line, starting at column C<$start_col> (default C<0>), which is useful	1697	line, starting at column C<$start_col> (default C<0>), which is useful
1624	to replace only parts of a line. The font index in the rendition will	1698	to replace only parts of a line. The font index in the rendition will
1625	automatically be updated.	1699	automatically be updated.
1626		1700
1627	C<$text> is in a special encoding: tabs and wide characters that use more	1701	C<$text> is in a special encoding: tabs and wide characters that use more
1628	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1702	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1629	characters. Characters with combining characters and other characters that	1703	characters. Characters with combining characters and other characters that
1630	do not fit into the normal tetx encoding will be replaced with characters	1704	do not fit into the normal text encoding will be replaced with characters
1631	in the private use area.	1705	in the private use area.
1632		1706
1633	You have to obey this encoding when changing text. The advantage is	1707	You have to obey this encoding when changing text. The advantage is
1634	that C<substr> and similar functions work on screen cells and not on	1708	that C<substr> and similar functions work on screen cells and not on
1635	characters.	1709	characters.
…		…
1810	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1884	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1811	recent grab.	1885	recent grab.
1812		1886
1813	=item $term->ungrab	1887	=item $term->ungrab
1814		1888
1815	Calls XUngrab for the most recent grab. Is called automatically on	1889	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1816	evaluation errors, as it is better to lose the grab in the error case as	1890	evaluation errors, as it is better to lose the grab in the error case as
1817	the session.	1891	the session.
1818		1892
1819	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1893	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1820		1894
…		…
1822		1896
1823	=item @atoms = $term->XListProperties ($window)	1897	=item @atoms = $term->XListProperties ($window)
1824		1898
1825	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1899	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1826		1900
1827	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1901	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1828		1902
1829	=item $term->XDeleteProperty ($window, $property)	1903	=item $term->XDeleteProperty ($window, $property)
1830		1904
1831	=item $window = $term->DefaultRootWindow	1905	=item $window = $term->DefaultRootWindow
1832		1906
…		…
1842		1916
1843	=item $term->XChangeInput ($window, $add_events[, $del_events])	1917	=item $term->XChangeInput ($window, $add_events[, $del_events])
1844		1918
1845	Various X or X-related functions. The C<$term> object only serves as	1919	Various X or X-related functions. The C<$term> object only serves as
1846	the source of the display, otherwise those functions map more-or-less	1920	the source of the display, otherwise those functions map more-or-less
1847	directory onto the X functions of the same name.	1921	directly onto the X functions of the same name.
1848		1922
1849	=back	1923	=back
1850		1924
1851	=cut	1925	=cut
1852		1926
…		…
1954	my $env = $self->{term}->env;	2028	my $env = $self->{term}->env;
1955	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2029	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1956	delete $env->{LC_ALL};	2030	delete $env->{LC_ALL};
1957	$env->{LC_CTYPE} = $self->{term}->locale;	2031	$env->{LC_CTYPE} = $self->{term}->locale;
1958		2032
1959	urxvt::term->new ($env, "popup",	2033	my $term = urxvt::term->new (
		2034	$env, "popup",
1960	"--perl-lib" => "", "--perl-ext-common" => "",	2035	"--perl-lib" => "", "--perl-ext-common" => "",
1961	"-pty-fd" => -1, "-sl" => 0,	2036	"-pty-fd" => -1, "-sl" => 0,
1962	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2037	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1963	"--transient-for" => $self->{term}->parent,	2038	"--transient-for" => $self->{term}->parent,
1964	"-display" => $self->{term}->display_id,	2039	"-display" => $self->{term}->display_id,
1965	"-pe" => "urxvt-popup")	2040	"-pe" => "urxvt-popup",
1966	or die "unable to create popup window\n";	2041	) or die "unable to create popup window\n";
		2042
		2043	unless (delete $term->{urxvt_popup_init_done}) {
		2044	$term->ungrab;
		2045	$term->destroy;
		2046	die "unable to initialise popup window\n";
		2047	}
1967	}	2048	}
1968		2049
1969	sub DESTROY {	2050	sub DESTROY {
1970	my ($self) = @_;	2051	my ($self) = @_;
1971		2052
…		…
2002		2083
2003	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2084	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2004		2085
2005	Set the callback to be called when the timer triggers.	2086	Set the callback to be called when the timer triggers.
2006		2087
2007	=item $tstamp = $timer->at
2008
2009	Return the time this watcher will fire next.
2010
2011	=item $timer = $timer->set ($tstamp)	2088	=item $timer = $timer->set ($tstamp[, $interval])
2012		2089
2013	Set the time the event is generated to $tstamp.	2090	Set the time the event is generated to $tstamp (and optionally specifies a
		2091	new $interval).
2014		2092
2015	=item $timer = $timer->interval ($interval)	2093	=item $timer = $timer->interval ($interval)
2016		2094
2017	Normally (and when C<$interval> is C<0>), the timer will automatically	2095	By default (and when C<$interval> is C<0>), the timer will automatically
2018	stop after it has fired once. If C<$interval> is non-zero, then the timer	2096	stop after it has fired once. If C<$interval> is non-zero, then the timer
2019	is automatically rescheduled at the given intervals.	2097	is automatically rescheduled at the given intervals.
2020		2098
2021	=item $timer = $timer->start	2099	=item $timer = $timer->start
2022		2100
2023	Start the timer.	2101	Start the timer.
2024		2102
2025	=item $timer = $timer->start ($tstamp)	2103	=item $timer = $timer->start ($tstamp[, $interval])
2026		2104
2027	Set the event trigger time to C<$tstamp> and start the timer.	2105	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2106	also replaces the interval.
2028		2107
2029	=item $timer = $timer->after ($delay)	2108	=item $timer = $timer->after ($delay[, $interval])
2030		2109
2031	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2110	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2032		2111
2033	=item $timer = $timer->stop	2112	=item $timer = $timer->stop
2034		2113

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.161 by ayin, Fri Nov 30 01:22:26 2007 UTC vs. Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.161 by ayin, Fri Nov 30 01:22:26 2007 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC