[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.200 by sf-exg, Sun Nov 20 10:58:58 2011 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
…		…
259	The default pattern to match URLs can be overridden with the	259	The default pattern to match URLs can be overridden with the
260	C<matcher.pattern.0> resource, and additional patterns can be specified	260	C<matcher.pattern.0> resource, and additional patterns can be specified
261	with numbered patterns, in a manner similar to the "selection" extension.	261	with numbered patterns, in a manner similar to the "selection" extension.
262	The launcher can also be overridden on a per-pattern basis.	262	The launcher can also be overridden on a per-pattern basis.
263		263
264	It is possible to activate the most recently seen match from the keyboard.	264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
265	Simply bind a keysym to "perl:matcher" as seen in the example below.	266	"perl:matcher:list" as seen in the example below.
266		267
267	Example configuration:	268	Example configuration:
268		269
269	URxvt.perl-ext: default,matcher	270	URxvt.perl-ext: default,matcher
270	URxvt.urlLauncher: sensible-browser	271	URxvt.urlLauncher: sensible-browser
271	URxvt.keysym.C-Delete: perl:matcher	272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
272	URxvt.matcher.button: 1	274	URxvt.matcher.button: 1
273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]	275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)	276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
275	URxvt.matcher.launcher.2: gvim +$2 $1	277	URxvt.matcher.launcher.2: gvim +$2 $1
276		278
…		…
303	extension will actually grab a physical key just for this function.	305	extension will actually grab a physical key just for this function.
304		306
305	If you want a quake-like animation, tell your window manager to do so	307	If you want a quake-like animation, tell your window manager to do so
306	(fvwm can do it).	308	(fvwm can do it).
307		309
		310	=item overlay-osc
		311
		312	This extension implements some OSC commands to display timed popups on the
		313	screen - useful for status displays from within scripts. You have to read
		314	the sources for more info.
		315
308	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
309		317
310	A not very useful example of filtering all text output to the terminal	318	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	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
312	similar-looking ascii character.	320	similar-looking ascii character.
…		…
335	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
336	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
337		345
338	=item selection-pastebin	346	=item selection-pastebin
339		347
340	This is a little rarely useful extension that Uploads the selection as	348	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	349	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	350	not currently secure for use in a multiuser environment as it writes to
343	F</tmp> directly.).	351	F</tmp> directly.).
344		352
345	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
364		372
365	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
366		374
367	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret	375	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,	376	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	377	which works regardless of whether xrdb is used to parse the resource file
370	or not.	378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
371		393
372	=item example-refresh-hooks	394	=item example-refresh-hooks
373		395
374	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
375	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
376	overlays or changes.	398	overlays or changes.
		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
377		412
378	=back	413	=back
379		414
380	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
381		416
…		…
397		432
398	=over 4	433	=over 4
399		434
400	=item $text	435	=item $text
401		436
402	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	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.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
404		439
405	=item $string	440	=item $string
406		441
407	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
416	=back	451	=back
417		452
418	=head2 Extension Objects	453	=head2 Extension Objects
419		454
420	Every perl extension is a perl class. A separate perl object is created	455	Every perl extension is a perl class. A separate perl object is created
421	for each terminal, and each terminal has its own set of extenion objects,	456	for each terminal, and each terminal has its own set of extension objects,
422	which are passed as the first parameter to hooks. So extensions can use	457	which are passed as the first parameter to hooks. So extensions can use
423	their C<$self> object without having to think about clashes with other	458	their C<$self> object without having to think about clashes with other
424	extensions or other terminals, with the exception of methods and members	459	extensions or other terminals, with the exception of methods and members
425	that begin with an underscore character C<_>: these are reserved for	460	that begin with an underscore character C<_>: these are reserved for
426	internal use.	461	internal use.
…		…
541		576
542	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	577	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	578	$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.	579	number of lines that will be in the scrollback buffer.
545		580
546	=item on_osc_seq $term, $op, $args	581	=item on_osc_seq $term, $op, $args, $resp
547		582
548	Called on every OSC sequence and can be used to suppress it or modify its	583	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	584	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	585	suppresses execution of the request completely. Make sure you don't get
551	confused by recursive invocations when you output an osc sequence within	586	confused by recursive invocations when you output an OSC sequence within
552	this callback.	587	this callback.
553		588
554	C<on_osc_seq_perl> should be used for new behaviour.	589	C<on_osc_seq_perl> should be used for new behaviour.
555		590
556	=item on_osc_seq_perl $term, $string	591	=item on_osc_seq_perl $term, $args, $resp
557		592
558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	593	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559	operating system command) is processed. Cursor position and other state	594	operating system command) is processed. Cursor position and other state
560	information is up-to-date when this happens. For interoperability, the	595	information is up-to-date when this happens. For interoperability, the
561	string should start with the extension name and a colon, to distinguish	596	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	597	to distinguish it from commands for other extensions, and this might be
563	future.	598	enforced in the future.
		599
		600	For example, C<overlay-osc> uses this:
		601
		602	sub on_osc_seq_perl {
		603	my ($self, $osc, $resp) = @_;
		604
		605	return unless $osc =~ s/^overlay;//;
		606
		607	... process remaining $osc string
		608	}
564		609
565	Be careful not ever to trust (in a security sense) the data you receive,	610	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	611	as its source can not easily be controlled (e-mail content, messages from
567	other users on the same system etc.).	612	other users on the same system etc.).
		613
		614	For responses, C<$resp> contains the end-of-args separator used by the
		615	sender.
568		616
569	=item on_add_lines $term, $string	617	=item on_add_lines $term, $string
570		618
571	Called whenever text is about to be output, with the text as argument. You	619	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	620	can filter/change and output the text yourself by returning a true value
…		…
577	=item on_tt_write $term, $octets	625	=item on_tt_write $term, $octets
578		626
579	Called whenever some data is written to the tty/pty and can be used to	627	Called whenever some data is written to the tty/pty and can be used to
580	suppress or filter tty input.	628	suppress or filter tty input.
581		629
		630	=item on_tt_paste $term, $octets
		631
		632	Called whenever text is about to be pasted, with the text as argument. You
		633	can filter/change and paste the text yourself by returning a true value
		634	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		635	locale-encoded.
		636
582	=item on_line_update $term, $row	637	=item on_line_update $term, $row
583		638
584	Called whenever a line was updated or changed. Can be used to filter	639	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	640	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,	641	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	648	later with the already-modified line (e.g. if unrelated parts change), so
594	you cannot just toggle rendition bits, but only set them.	649	you cannot just toggle rendition bits, but only set them.
595		650
596	=item on_refresh_begin $term	651	=item on_refresh_begin $term
597		652
598	Called just before the screen gets redrawn. Can be used for overlay	653	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	654	similar effects by modifying the terminal contents in refresh_begin, and
600	restoring them in refresh_end. The built-in overlay and selection display	655	restoring them in refresh_end. The built-in overlay and selection display
601	code is run after this hook, and takes precedence.	656	code is run after this hook, and takes precedence.
602		657
603	=item on_refresh_end $term	658	=item on_refresh_end $term
604		659
…		…
611	resource in the @@RXVT_NAME@@(1) manpage).	666	resource in the @@RXVT_NAME@@(1) manpage).
612		667
613	The event is simply the action string. This interface is assumed to change	668	The event is simply the action string. This interface is assumed to change
614	slightly in the future.	669	slightly in the future.
615		670
616	=item on_resize_all_windows $tern, $new_width, $new_height	671	=item on_resize_all_windows $term, $new_width, $new_height
617		672
618	Called just after the new window size has been calculated, but before	673	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	674	windows are actually being resized or hints are being set. If this hook
620	returns TRUE, setting of the window hints is being skipped.	675	returns TRUE, setting of the window hints is being skipped.
621		676
…		…
655		710
656	=item on_map_notify $term, $event	711	=item on_map_notify $term, $event
657		712
658	=item on_unmap_notify $term, $event	713	=item on_unmap_notify $term, $event
659		714
660	Called whenever the corresponding X event is received for the terminal If	715	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.	716	the hook returns true, then the event will be ignored by rxvt-unicode.
662		717
663	The event is a hash with most values as named by Xlib (see the XEvent	718	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	719	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.	720	(real, not screen-based) row and column under the mouse cursor.
666		721
…		…
675		730
676	=item on_wm_delete_window $term, $event	731	=item on_wm_delete_window $term, $event
677		732
678	Called when various types of ClientMessage events are received (all with	733	Called when various types of ClientMessage events are received (all with
679	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	734	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		735
		736	=item on_bell $term
		737
		738	Called on receipt of a bell character.
680		739
681	=back	740	=back
682		741
683	=cut	742	=cut
684		743
…		…
749		808
750	=over 4	809	=over 4
751		810
752	=item urxvt::fatal $errormessage	811	=item urxvt::fatal $errormessage
753		812
754	Fatally aborts execution with the given error message. Avoid at all	813	Fatally aborts execution with the given error message (which should
755	costs! The only time this is acceptable is when the terminal process	814	include a trailing newline). Avoid at all costs! The only time this
756	starts up.	815	is acceptable (and useful) is in the init hook, where it prevents the
		816	terminal from starting up.
757		817
758	=item urxvt::warn $string	818	=item urxvt::warn $string
759		819
760	Calls C<rxvt_warn> with the given string which should not include a	820	Calls C<rxvt_warn> with the given string which should include a trailing
761	newline. The module also overwrites the C<warn> builtin with a function	821	newline. The module also overwrites the C<warn> builtin with a function
762	that calls this function.	822	that calls this function.
763		823
764	Using this function has the advantage that its output ends up in the	824	Using this function has the advantage that its output ends up in the
765	correct place, e.g. on stderr of the connecting urxvtc client.	825	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
769	=item @terms = urxvt::termlist	829	=item @terms = urxvt::termlist
770		830
771	Returns all urxvt::term objects that exist in this process, regardless of	831	Returns all urxvt::term objects that exist in this process, regardless of
772	whether they are started, being destroyed etc., so be careful. Only term	832	whether they are started, being destroyed etc., so be careful. Only term
773	objects that have perl extensions attached will be returned (because there	833	objects that have perl extensions attached will be returned (because there
774	is no urxvt::term objet associated with others).	834	is no urxvt::term object associated with others).
775		835
776	=item $time = urxvt::NOW	836	=item $time = urxvt::NOW
777		837
778	Returns the "current time" (as per the event loop).	838	Returns the "current time" (as per the event loop).
779		839
…		…
822		882
823	=item $rend = urxvt::OVERLAY_RSTYLE	883	=item $rend = urxvt::OVERLAY_RSTYLE
824		884
825	Return the rendition mask used for overlays by default.	885	Return the rendition mask used for overlays by default.
826		886
827	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	887	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		888	urxvt::RS_RVid, urxvt::RS_Uline
828		889
829	Return the bit that enabled bold, italic, blink, reverse-video and	890	Return the bit that enabled bold, italic, blink, reverse-video and
830	underline, respectively. To enable such a style, just logically OR it into	891	underline, respectively. To enable such a style, just logically OR it into
831	the bitset.	892	the bitset.
832		893
…		…
914	sub invoke {	975	sub invoke {
915	local $TERM = shift;	976	local $TERM = shift;
916	my $htype = shift;	977	my $htype = shift;
917		978
918	if ($htype == 0) { # INIT	979	if ($htype == 0) { # INIT
919	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	980	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
920		981
921	my %ext_arg;	982	my %ext_arg;
922		983
923	{	984	{
924	my @init = @TERM_INIT;	985	my @init = @TERM_INIT;
…		…
1091	is that you cannot use blocking APIs, but the non-blocking variant should	1152	is that you cannot use blocking APIs, but the non-blocking variant should
1092	work.	1153	work.
1093		1154
1094	=cut	1155	=cut
1095		1156
1096	our $VERSION = 1;	1157	our $VERSION = '5.23';
1097		1158
1098	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1159	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1160	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100		1161
1101	sub timer {	1162	sub timer {
…		…
1103		1164
1104	my $cb = $arg{cb};	1165	my $cb = $arg{cb};
1105		1166
1106	urxvt::timer	1167	urxvt::timer
1107	->new	1168	->new
1108	->start (urxvt::NOW + $arg{after})	1169	->after ($arg{after}, $arg{interval})
1109	->cb (sub {	1170	->cb ($arg{interval} ? $cb : sub {
1110	$_[0]->stop; # need to cancel manually	1171	$_[0]->stop; # need to cancel manually
1111	$cb->();	1172	$cb->();
1112	})	1173	})
1113	}	1174	}
1114		1175
1115	sub io {	1176	sub io {
1116	my ($class, %arg) = @_;	1177	my ($class, %arg) = @_;
1117		1178
1118	my $cb = $arg{cb};	1179	my $cb = $arg{cb};
		1180	my $fd = fileno $arg{fh};
		1181	defined $fd or $fd = $arg{fh};
1119		1182
1120	bless [$arg{fh}, urxvt::iow	1183	bless [$arg{fh}, urxvt::iow
1121	->new	1184	->new
1122	->fd (fileno $arg{fh})	1185	->fd ($fd)
1123	->events (($arg{poll} =~ /r/ ? 1 : 0)	1186	->events (($arg{poll} =~ /r/ ? 1 : 0)
1124	\| ($arg{poll} =~ /w/ ? 2 : 0))	1187	\| ($arg{poll} =~ /w/ ? 2 : 0))
1125	->start	1188	->start
1126	->cb (sub {	1189	->cb ($cb)
1127	$cb->(($_[1] & 1 ? 'r' : '')
1128	. ($_[1] & 2 ? 'w' : ''));
1129	})],
1130	urxvt::anyevent::	1190	], urxvt::anyevent::
		1191	}
		1192
		1193	sub idle {
		1194	my ($class, %arg) = @_;
		1195
		1196	my $cb = $arg{cb};
		1197
		1198	urxvt::iw
		1199	->new
		1200	->start
		1201	->cb ($cb)
		1202	}
		1203
		1204	sub child {
		1205	my ($class, %arg) = @_;
		1206
		1207	my $cb = $arg{cb};
		1208
		1209	urxvt::pw
		1210	->new
		1211	->start ($arg{pid})
		1212	->cb (sub {
		1213	$_[0]->stop; # need to cancel manually
		1214	$cb->($_[0]->rpid, $_[0]->rstatus);
		1215	})
1131	}	1216	}
1132		1217
1133	sub DESTROY {	1218	sub DESTROY {
1134	$_[0][1]->stop;	1219	$_[0][1]->stop;
1135	}	1220	}
1136		1221
1137	sub condvar {	1222	# only needed for AnyEvent < 6 compatibility
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	}
1150
1151	sub one_event {	1223	sub one_event {
1152	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1224	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1153	}	1225	}
1154		1226
1155	package urxvt::term;	1227	package urxvt::term;
…		…
1247	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1319	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1248		1320
1249	Here is a likely non-exhaustive list of option names, please see the	1321	Here is a likely non-exhaustive list of option names, please see the
1250	source file F</src/optinc.h> to see the actual list:	1322	source file F</src/optinc.h> to see the actual list:
1251		1323
1252	borderLess console cursorBlink cursorUnderline hold iconic insecure	1324	borderLess buffered console cursorBlink cursorUnderline hold iconic
1253	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1325	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1254	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1326	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1255	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1327	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1256	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1328	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1257	transparent tripleclickwords utmpInhibit visualBell	1329	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1330	urgentOnBell utmpInhibit visualBell
1258		1331
1259	=item $value = $term->resource ($name[, $newval])	1332	=item $value = $term->resource ($name[, $newval])
1260		1333
1261	Returns the current resource value associated with a given name and	1334	Returns the current resource value associated with a given name and
1262	optionally sets a new value. Setting values is most useful in the C<init>	1335	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1275		1348
1276	Here is a likely non-exhaustive list of resource names, not all of which	1349	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>	1350	are supported in every build, please see the source file F</src/rsinc.h>
1278	to see the actual list:	1351	to see the actual list:
1279		1352
1280	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1353	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1281	borderLess color cursorBlink cursorUnderline cutchars delete_key	1354	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1282	display_name embed ext_bwidth fade font geometry hold iconName	1355	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1283	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1356	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1357	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1284	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1358	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1285	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1359	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1286	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1360	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1287	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1361	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1288	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1362	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1289	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1363	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1290	secondaryScreen secondaryScroll selectstyle shade term_name title	1364	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1291	transient_for transparent transparent_all tripleclickwords utmpInhibit	1365	term_name title transient_for transparent tripleclickwords urgentOnBell
1292	visualBell	1366	utmpInhibit visualBell
1293		1367
1294	=cut	1368	=cut
1295		1369
1296	sub resource($$;$) {	1370	sub resource($$;$) {
1297	my ($self, $name) = (shift, shift);	1371	my ($self, $name) = (shift, shift);
1298	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1372	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1299	&urxvt::term::_resource	1373	goto &urxvt::term::_resource
1300	}	1374	}
1301		1375
1302	=item $value = $term->x_resource ($pattern)	1376	=item $value = $term->x_resource ($pattern)
1303		1377
1304	Returns the X-Resource for the given pattern, excluding the program or	1378	Returns the X-Resource for the given pattern, excluding the program or
…		…
1329		1403
1330	=item ($row, $col) = $term->selection_beg ([$row, $col])	1404	=item ($row, $col) = $term->selection_beg ([$row, $col])
1331		1405
1332	=item ($row, $col) = $term->selection_end ([$row, $col])	1406	=item ($row, $col) = $term->selection_end ([$row, $col])
1333		1407
1334	Return the current values of the selection mark, begin or end positions,	1408	Return the current values of the selection mark, begin or end positions.
1335	and optionally set them to new values.	1409
		1410	When arguments are given, then the selection coordinates are set to
		1411	C<$row> and C<$col>, and the selection screen is set to the current
		1412	screen.
		1413
		1414	=item $screen = $term->selection_screen ([$screen])
		1415
		1416	Returns the current selection screen, and then optionally sets it.
1336		1417
1337	=item $term->selection_make ($eventtime[, $rectangular])	1418	=item $term->selection_make ($eventtime[, $rectangular])
1338		1419
1339	Tries to make a selection as set by C<selection_beg> and	1420	Tries to make a selection as set by C<selection_beg> and
1340	C<selection_end>. If C<$rectangular> is true (default: false), a	1421	C<selection_end>. If C<$rectangular> is true (default: false), a
1341	rectangular selection will be made. This is the prefered function to make	1422	rectangular selection will be made. This is the preferred function to make
1342	a selection.	1423	a selection.
1343		1424
1344	=item $success = $term->selection_grab ($eventtime)	1425	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1345		1426
1346	Try to request the primary selection text from the server (for example, as	1427	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1428	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	1429	with the next method. No visual feedback will be given. This function
1348	is mostly useful from within C<on_sel_grab> hooks.	1430	is mostly useful from within C<on_sel_grab> hooks.
1349		1431
1350	=item $oldtext = $term->selection ([$newtext])	1432	=item $oldtext = $term->selection ([$newtext, $clipboard])
1351		1433
1352	Return the current selection text and optionally replace it by C<$newtext>.	1434	Return the current selection (clipboard if C<$clipboard> is true) text
		1435	and optionally replace it by C<$newtext>.
		1436
		1437	=item $term->selection_clear ([$clipboard])
		1438
		1439	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1353		1440
1354	=item $term->overlay_simple ($x, $y, $text)	1441	=item $term->overlay_simple ($x, $y, $text)
1355		1442
1356	Create a simple multi-line overlay box. See the next method for details.	1443	Create a simple multi-line overlay box. See the next method for details.
1357		1444
…		…
1387		1474
1388	The methods currently supported on C<urxvt::overlay> objects are:	1475	The methods currently supported on C<urxvt::overlay> objects are:
1389		1476
1390	=over 4	1477	=over 4
1391		1478
1392	=item $overlay->set ($x, $y, $text, $rend)	1479	=item $overlay->set ($x, $y, $text[, $rend])
1393		1480
1394	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1481	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	1482	text in rxvt-unicode's special encoding and an array of rendition values
1396	at a specific position inside the overlay.	1483	at a specific position inside the overlay.
		1484
		1485	If C<$rend> is missing, then the rendition will not be changed.
1397		1486
1398	=item $overlay->hide	1487	=item $overlay->hide
1399		1488
1400	If visible, hide the overlay, but do not destroy it.	1489	If visible, hide the overlay, but do not destroy it.
1401		1490
…		…
1483	locale-specific encoding of the terminal and can contain command sequences	1572	locale-specific encoding of the terminal and can contain command sequences
1484	(escape codes) that will be interpreted.	1573	(escape codes) that will be interpreted.
1485		1574
1486	=item $term->tt_write ($octets)	1575	=item $term->tt_write ($octets)
1487		1576
1488	Write the octets given in C<$data> to the tty (i.e. as program input). To	1577	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	1578	pass characters instead of octets, you should convert your strings first
1490	to the locale-specific encoding using C<< $term->locale_encode >>.	1579	to the locale-specific encoding using C<< $term->locale_encode >>.
		1580
		1581	=item $term->tt_paste ($octets)
		1582
		1583	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1584	CR and bracketing the data with control sequences if bracketed paste mode
		1585	is set.
1491		1586
1492	=item $old_events = $term->pty_ev_events ([$new_events])	1587	=item $old_events = $term->pty_ev_events ([$new_events])
1493		1588
1494	Replaces the event mask of the pty watcher by the given event mask. Can	1589	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	1590	be used to suppress input and output handling to the pty/tty. See the
…		…
1611		1706
1612	Used after changing terminal contents to display them.	1707	Used after changing terminal contents to display them.
1613		1708
1614	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1709	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1615		1710
1616	Returns the text of the entire row with number C<$row_number>. Row C<0>	1711	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	1712	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	1713	terminal line. Nothing will be returned if a nonexistent line
1620	is requested.	1714	is requested.
1621		1715
1622	If C<$new_text> is specified, it will replace characters in the current	1716	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	1717	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	1718	to replace only parts of a line. The font index in the rendition will
1625	automatically be updated.	1719	automatically be updated.
1626		1720
1627	C<$text> is in a special encoding: tabs and wide characters that use more	1721	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)	1722	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1629	characters. Characters with combining characters and other characters that	1723	characters. Characters with combining characters and other characters that
1630	do not fit into the normal tetx encoding will be replaced with characters	1724	do not fit into the normal text encoding will be replaced with characters
1631	in the private use area.	1725	in the private use area.
1632		1726
1633	You have to obey this encoding when changing text. The advantage is	1727	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	1728	that C<substr> and similar functions work on screen cells and not on
1635	characters.	1729	characters.
…		…
1810	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1904	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1811	recent grab.	1905	recent grab.
1812		1906
1813	=item $term->ungrab	1907	=item $term->ungrab
1814		1908
1815	Calls XUngrab for the most recent grab. Is called automatically on	1909	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	1910	evaluation errors, as it is better to lose the grab in the error case as
1817	the session.	1911	the session.
1818		1912
1819	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1913	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1820		1914
…		…
1822		1916
1823	=item @atoms = $term->XListProperties ($window)	1917	=item @atoms = $term->XListProperties ($window)
1824		1918
1825	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1919	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1826		1920
1827	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1921	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1828		1922
1829	=item $term->XDeleteProperty ($window, $property)	1923	=item $term->XDeleteProperty ($window, $property)
1830		1924
1831	=item $window = $term->DefaultRootWindow	1925	=item $window = $term->DefaultRootWindow
1832		1926
…		…
1842		1936
1843	=item $term->XChangeInput ($window, $add_events[, $del_events])	1937	=item $term->XChangeInput ($window, $add_events[, $del_events])
1844		1938
1845	Various X or X-related functions. The C<$term> object only serves as	1939	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	1940	the source of the display, otherwise those functions map more-or-less
1847	directory onto the X functions of the same name.	1941	directly onto the X functions of the same name.
1848		1942
1849	=back	1943	=back
1850		1944
1851	=cut	1945	=cut
1852		1946
…		…
1954	my $env = $self->{term}->env;	2048	my $env = $self->{term}->env;
1955	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2049	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1956	delete $env->{LC_ALL};	2050	delete $env->{LC_ALL};
1957	$env->{LC_CTYPE} = $self->{term}->locale;	2051	$env->{LC_CTYPE} = $self->{term}->locale;
1958		2052
1959	urxvt::term->new ($env, "popup",	2053	my $term = urxvt::term->new (
		2054	$env, "popup",
1960	"--perl-lib" => "", "--perl-ext-common" => "",	2055	"--perl-lib" => "", "--perl-ext-common" => "",
1961	"-pty-fd" => -1, "-sl" => 0,	2056	"-pty-fd" => -1, "-sl" => 0,
1962	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2057	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1963	"--transient-for" => $self->{term}->parent,	2058	"--transient-for" => $self->{term}->parent,
1964	"-display" => $self->{term}->display_id,	2059	"-display" => $self->{term}->display_id,
1965	"-pe" => "urxvt-popup")	2060	"-pe" => "urxvt-popup",
1966	or die "unable to create popup window\n";	2061	) or die "unable to create popup window\n";
		2062
		2063	unless (delete $term->{urxvt_popup_init_done}) {
		2064	$term->ungrab;
		2065	$term->destroy;
		2066	die "unable to initialise popup window\n";
		2067	}
1967	}	2068	}
1968		2069
1969	sub DESTROY {	2070	sub DESTROY {
1970	my ($self) = @_;	2071	my ($self) = @_;
1971		2072
…		…
2002		2103
2003	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2104	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2004		2105
2005	Set the callback to be called when the timer triggers.	2106	Set the callback to be called when the timer triggers.
2006		2107
2007	=item $tstamp = $timer->at
2008
2009	Return the time this watcher will fire next.
2010
2011	=item $timer = $timer->set ($tstamp)	2108	=item $timer = $timer->set ($tstamp[, $interval])
2012		2109
2013	Set the time the event is generated to $tstamp.	2110	Set the time the event is generated to $tstamp (and optionally specifies a
		2111	new $interval).
2014		2112
2015	=item $timer = $timer->interval ($interval)	2113	=item $timer = $timer->interval ($interval)
2016		2114
2017	Normally (and when C<$interval> is C<0>), the timer will automatically	2115	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	2116	stop after it has fired once. If C<$interval> is non-zero, then the timer
2019	is automatically rescheduled at the given intervals.	2117	is automatically rescheduled at the given intervals.
2020		2118
2021	=item $timer = $timer->start	2119	=item $timer = $timer->start
2022		2120
2023	Start the timer.	2121	Start the timer.
2024		2122
2025	=item $timer = $timer->start ($tstamp)	2123	=item $timer = $timer->start ($tstamp[, $interval])
2026		2124
2027	Set the event trigger time to C<$tstamp> and start the timer.	2125	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2126	also replaces the interval.
2028		2127
2029	=item $timer = $timer->after ($delay)	2128	=item $timer = $timer->after ($delay[, $interval])
2030		2129
2031	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2130	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2032		2131
2033	=item $timer = $timer->stop	2132	=item $timer = $timer->stop
2034		2133
…		…
2165		2264
2166	=back	2265	=back
2167		2266
2168	=head1 AUTHOR	2267	=head1 AUTHOR
2169		2268
2170	Marc Lehmann <pcg@goof.com>	2269	Marc Lehmann <schmorp@schmorp.de>
2171	http://software.schmorp.de/pkg/rxvt-unicode	2270	http://software.schmorp.de/pkg/rxvt-unicode
2172		2271
2173	=cut	2272	=cut
2174		2273
2175	1	2274	1

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.200 by sf-exg, Sun Nov 20 10:58:58 2011 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.200 by sf-exg, Sun Nov 20 10:58:58 2011 UTC