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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.162 by ayin, Mon Dec 17 16:57:57 2007 UTC vs.
Revision 1.197 by sf-tpope, Fri Aug 19 23:08:35 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.
377		404
378	=back	405	=back
379		406
380	=head1 API DOCUMENTATION	407	=head1 API DOCUMENTATION
381		408
…		…
397		424
398	=over 4	425	=over 4
399		426
400	=item $text	427	=item $text
401		428
402	Rxvt-unicodes special way of encoding text, where one "unicode" character	429	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.	430	always represents one screen cell. See L<ROW_t> for a discussion of this format.
404		431
405	=item $string	432	=item $string
406		433
407	A perl text string, with an emphasis on I<text>. It can store all unicode	434	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
416	=back	443	=back
417		444
418	=head2 Extension Objects	445	=head2 Extension Objects
419		446
420	Every perl extension is a perl class. A separate perl object is created	447	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,	448	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	449	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	450	their C<$self> object without having to think about clashes with other
424	extensions or other terminals, with the exception of methods and members	451	extensions or other terminals, with the exception of methods and members
425	that begin with an underscore character C<_>: these are reserved for	452	that begin with an underscore character C<_>: these are reserved for
426	internal use.	453	internal use.
…		…
541		568
542	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	569	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	570	$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.	571	number of lines that will be in the scrollback buffer.
545		572
546	=item on_osc_seq $term, $op, $args	573	=item on_osc_seq $term, $op, $args, $resp
547		574
548	Called on every OSC sequence and can be used to suppress it or modify its	575	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	576	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	577	suppresses execution of the request completely. Make sure you don't get
551	confused by recursive invocations when you output an osc sequence within	578	confused by recursive invocations when you output an OSC sequence within
552	this callback.	579	this callback.
553		580
554	C<on_osc_seq_perl> should be used for new behaviour.	581	C<on_osc_seq_perl> should be used for new behaviour.
555		582
556	=item on_osc_seq_perl $term, $string	583	=item on_osc_seq_perl $term, $args, $resp
557		584
558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	585	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559	operating system command) is processed. Cursor position and other state	586	operating system command) is processed. Cursor position and other state
560	information is up-to-date when this happens. For interoperability, the	587	information is up-to-date when this happens. For interoperability, the
561	string should start with the extension name and a colon, to distinguish	588	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	589	to distinguish it from commands for other extensions, and this might be
563	future.	590	enforced in the future.
		591
		592	For example, C<overlay-osc> uses this:
		593
		594	sub on_osc_seq_perl {
		595	my ($self, $osc, $resp) = @_;
		596
		597	return unless $osc =~ s/^overlay;//;
		598
		599	... process remaining $osc string
		600	}
564		601
565	Be careful not ever to trust (in a security sense) the data you receive,	602	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	603	as its source can not easily be controlled (e-mail content, messages from
567	other users on the same system etc.).	604	other users on the same system etc.).
		605
		606	For responses, C<$resp> contains the end-of-args separator used by the
		607	sender.
568		608
569	=item on_add_lines $term, $string	609	=item on_add_lines $term, $string
570		610
571	Called whenever text is about to be output, with the text as argument. You	611	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	612	can filter/change and output the text yourself by returning a true value
…		…
577	=item on_tt_write $term, $octets	617	=item on_tt_write $term, $octets
578		618
579	Called whenever some data is written to the tty/pty and can be used to	619	Called whenever some data is written to the tty/pty and can be used to
580	suppress or filter tty input.	620	suppress or filter tty input.
581		621
		622	=item on_tt_paste $term, $octets
		623
		624	Called whenever text is about to be pasted, with the text as argument. You
		625	can filter/change and paste the text yourself by returning a true value
		626	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		627	locale-encoded.
		628
582	=item on_line_update $term, $row	629	=item on_line_update $term, $row
583		630
584	Called whenever a line was updated or changed. Can be used to filter	631	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	632	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,	633	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	640	later with the already-modified line (e.g. if unrelated parts change), so
594	you cannot just toggle rendition bits, but only set them.	641	you cannot just toggle rendition bits, but only set them.
595		642
596	=item on_refresh_begin $term	643	=item on_refresh_begin $term
597		644
598	Called just before the screen gets redrawn. Can be used for overlay	645	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	646	similar effects by modifying the terminal contents in refresh_begin, and
600	restoring them in refresh_end. The built-in overlay and selection display	647	restoring them in refresh_end. The built-in overlay and selection display
601	code is run after this hook, and takes precedence.	648	code is run after this hook, and takes precedence.
602		649
603	=item on_refresh_end $term	650	=item on_refresh_end $term
604		651
…		…
611	resource in the @@RXVT_NAME@@(1) manpage).	658	resource in the @@RXVT_NAME@@(1) manpage).
612		659
613	The event is simply the action string. This interface is assumed to change	660	The event is simply the action string. This interface is assumed to change
614	slightly in the future.	661	slightly in the future.
615		662
616	=item on_resize_all_windows $tern, $new_width, $new_height	663	=item on_resize_all_windows $term, $new_width, $new_height
617		664
618	Called just after the new window size has been calculated, but before	665	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	666	windows are actually being resized or hints are being set. If this hook
620	returns TRUE, setting of the window hints is being skipped.	667	returns TRUE, setting of the window hints is being skipped.
621		668
…		…
655		702
656	=item on_map_notify $term, $event	703	=item on_map_notify $term, $event
657		704
658	=item on_unmap_notify $term, $event	705	=item on_unmap_notify $term, $event
659		706
660	Called whenever the corresponding X event is received for the terminal If	707	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.	708	the hook returns true, then the event will be ignored by rxvt-unicode.
662		709
663	The event is a hash with most values as named by Xlib (see the XEvent	710	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	711	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.	712	(real, not screen-based) row and column under the mouse cursor.
666		713
…		…
675		722
676	=item on_wm_delete_window $term, $event	723	=item on_wm_delete_window $term, $event
677		724
678	Called when various types of ClientMessage events are received (all with	725	Called when various types of ClientMessage events are received (all with
679	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	726	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		727
		728	=item on_bell $term
		729
		730	Called on receipt of a bell character.
680		731
681	=back	732	=back
682		733
683	=cut	734	=cut
684		735
…		…
749		800
750	=over 4	801	=over 4
751		802
752	=item urxvt::fatal $errormessage	803	=item urxvt::fatal $errormessage
753		804
754	Fatally aborts execution with the given error message. Avoid at all	805	Fatally aborts execution with the given error message (which should
755	costs! The only time this is acceptable is when the terminal process	806	include a trailing newline). Avoid at all costs! The only time this
756	starts up.	807	is acceptable (and useful) is in the init hook, where it prevents the
		808	terminal from starting up.
757		809
758	=item urxvt::warn $string	810	=item urxvt::warn $string
759		811
760	Calls C<rxvt_warn> with the given string which should not include a	812	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	813	newline. The module also overwrites the C<warn> builtin with a function
762	that calls this function.	814	that calls this function.
763		815
764	Using this function has the advantage that its output ends up in the	816	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.	817	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
769	=item @terms = urxvt::termlist	821	=item @terms = urxvt::termlist
770		822
771	Returns all urxvt::term objects that exist in this process, regardless of	823	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	824	whether they are started, being destroyed etc., so be careful. Only term
773	objects that have perl extensions attached will be returned (because there	825	objects that have perl extensions attached will be returned (because there
774	is no urxvt::term objet associated with others).	826	is no urxvt::term object associated with others).
775		827
776	=item $time = urxvt::NOW	828	=item $time = urxvt::NOW
777		829
778	Returns the "current time" (as per the event loop).	830	Returns the "current time" (as per the event loop).
779		831
…		…
822		874
823	=item $rend = urxvt::OVERLAY_RSTYLE	875	=item $rend = urxvt::OVERLAY_RSTYLE
824		876
825	Return the rendition mask used for overlays by default.	877	Return the rendition mask used for overlays by default.
826		878
827	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	879	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		880	urxvt::RS_RVid, urxvt::RS_Uline
828		881
829	Return the bit that enabled bold, italic, blink, reverse-video and	882	Return the bit that enabled bold, italic, blink, reverse-video and
830	underline, respectively. To enable such a style, just logically OR it into	883	underline, respectively. To enable such a style, just logically OR it into
831	the bitset.	884	the bitset.
832		885
…		…
1091	is that you cannot use blocking APIs, but the non-blocking variant should	1144	is that you cannot use blocking APIs, but the non-blocking variant should
1092	work.	1145	work.
1093		1146
1094	=cut	1147	=cut
1095		1148
1096	our $VERSION = 1;	1149	our $VERSION = '5.23';
1097		1150
1098	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1151	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1152	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100		1153
1101	sub timer {	1154	sub timer {
…		…
1103		1156
1104	my $cb = $arg{cb};	1157	my $cb = $arg{cb};
1105		1158
1106	urxvt::timer	1159	urxvt::timer
1107	->new	1160	->new
1108	->start (urxvt::NOW + $arg{after})	1161	->after ($arg{after}, $arg{interval})
1109	->cb (sub {	1162	->cb ($arg{interval} ? $cb : sub {
1110	$_[0]->stop; # need to cancel manually	1163	$_[0]->stop; # need to cancel manually
1111	$cb->();	1164	$cb->();
1112	})	1165	})
1113	}	1166	}
1114		1167
1115	sub io {	1168	sub io {
1116	my ($class, %arg) = @_;	1169	my ($class, %arg) = @_;
1117		1170
1118	my $cb = $arg{cb};	1171	my $cb = $arg{cb};
		1172	my $fd = fileno $arg{fh};
		1173	defined $fd or $fd = $arg{fh};
1119		1174
1120	bless [$arg{fh}, urxvt::iow	1175	bless [$arg{fh}, urxvt::iow
1121	->new	1176	->new
1122	->fd (fileno $arg{fh})	1177	->fd ($fd)
1123	->events (($arg{poll} =~ /r/ ? 1 : 0)	1178	->events (($arg{poll} =~ /r/ ? 1 : 0)
1124	\| ($arg{poll} =~ /w/ ? 2 : 0))	1179	\| ($arg{poll} =~ /w/ ? 2 : 0))
1125	->start	1180	->start
1126	->cb (sub {	1181	->cb ($cb)
1127	$cb->(($_[1] & 1 ? 'r' : '')
1128	. ($_[1] & 2 ? 'w' : ''));
1129	})],
1130	urxvt::anyevent::	1182	], urxvt::anyevent::
		1183	}
		1184
		1185	sub idle {
		1186	my ($class, %arg) = @_;
		1187
		1188	my $cb = $arg{cb};
		1189
		1190	urxvt::iw
		1191	->new
		1192	->start
		1193	->cb ($cb)
		1194	}
		1195
		1196	sub child {
		1197	my ($class, %arg) = @_;
		1198
		1199	my $cb = $arg{cb};
		1200
		1201	urxvt::pw
		1202	->new
		1203	->start ($arg{pid})
		1204	->cb (sub {
		1205	$_[0]->stop; # need to cancel manually
		1206	$cb->($_[0]->rpid, $_[0]->rstatus);
		1207	})
1131	}	1208	}
1132		1209
1133	sub DESTROY {	1210	sub DESTROY {
1134	$_[0][1]->stop;	1211	$_[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	}	1212	}
1150		1213
1151	sub one_event {	1214	sub one_event {
1152	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1215	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1153	}	1216	}
…		…
1247	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1310	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1248		1311
1249	Here is a likely non-exhaustive list of option names, please see the	1312	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:	1313	source file F</src/optinc.h> to see the actual list:
1251		1314
1252	borderLess console cursorBlink cursorUnderline hold iconic insecure	1315	borderLess buffered console cursorBlink cursorUnderline hold iconic
1253	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1316	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1254	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1317	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1255	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1318	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1256	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1319	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1257	transparent tripleclickwords utmpInhibit visualBell	1320	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1321	urgentOnBell utmpInhibit visualBell
1258		1322
1259	=item $value = $term->resource ($name[, $newval])	1323	=item $value = $term->resource ($name[, $newval])
1260		1324
1261	Returns the current resource value associated with a given name and	1325	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>	1326	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1275		1339
1276	Here is a likely non-exhaustive list of resource names, not all of which	1340	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>	1341	are supported in every build, please see the source file F</src/rsinc.h>
1278	to see the actual list:	1342	to see the actual list:
1279		1343
1280	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1344	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1281	borderLess color cursorBlink cursorUnderline cutchars delete_key	1345	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1282	display_name embed ext_bwidth fade font geometry hold iconName	1346	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1283	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1347	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1348	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1284	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1349	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1285	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1350	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1286	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1351	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1287	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1352	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1288	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1353	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1289	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1354	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1290	secondaryScreen secondaryScroll selectstyle shade term_name title	1355	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1291	transient_for transparent transparent_all tripleclickwords utmpInhibit	1356	term_name title transient_for transparent tripleclickwords urgentOnBell
1292	visualBell	1357	utmpInhibit visualBell
1293		1358
1294	=cut	1359	=cut
1295		1360
1296	sub resource($$;$) {	1361	sub resource($$;$) {
1297	my ($self, $name) = (shift, shift);	1362	my ($self, $name) = (shift, shift);
1298	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1363	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1299	&urxvt::term::_resource	1364	goto &urxvt::term::_resource
1300	}	1365	}
1301		1366
1302	=item $value = $term->x_resource ($pattern)	1367	=item $value = $term->x_resource ($pattern)
1303		1368
1304	Returns the X-Resource for the given pattern, excluding the program or	1369	Returns the X-Resource for the given pattern, excluding the program or
…		…
1329		1394
1330	=item ($row, $col) = $term->selection_beg ([$row, $col])	1395	=item ($row, $col) = $term->selection_beg ([$row, $col])
1331		1396
1332	=item ($row, $col) = $term->selection_end ([$row, $col])	1397	=item ($row, $col) = $term->selection_end ([$row, $col])
1333		1398
1334	Return the current values of the selection mark, begin or end positions,	1399	Return the current values of the selection mark, begin or end positions.
1335	and optionally set them to new values.	1400
		1401	When arguments are given, then the selection coordinates are set to
		1402	C<$row> and C<$col>, and the selection screen is set to the current
		1403	screen.
		1404
		1405	=item $screen = $term->selection_screen ([$screen])
		1406
		1407	Returns the current selection screen, and then optionally sets it.
1336		1408
1337	=item $term->selection_make ($eventtime[, $rectangular])	1409	=item $term->selection_make ($eventtime[, $rectangular])
1338		1410
1339	Tries to make a selection as set by C<selection_beg> and	1411	Tries to make a selection as set by C<selection_beg> and
1340	C<selection_end>. If C<$rectangular> is true (default: false), a	1412	C<selection_end>. If C<$rectangular> is true (default: false), a
1341	rectangular selection will be made. This is the prefered function to make	1413	rectangular selection will be made. This is the preferred function to make
1342	a selection.	1414	a selection.
1343		1415
1344	=item $success = $term->selection_grab ($eventtime)	1416	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1345		1417
1346	Try to request the primary selection text from the server (for example, as	1418	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1419	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	1420	with the next method. No visual feedback will be given. This function
1348	is mostly useful from within C<on_sel_grab> hooks.	1421	is mostly useful from within C<on_sel_grab> hooks.
1349		1422
1350	=item $oldtext = $term->selection ([$newtext])	1423	=item $oldtext = $term->selection ([$newtext, $clipboard])
1351		1424
1352	Return the current selection text and optionally replace it by C<$newtext>.	1425	Return the current selection (clipboard if C<$clipboard> is true) text
		1426	and optionally replace it by C<$newtext>.
		1427
		1428	=item $term->selection_clear ([$clipboard])
		1429
		1430	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1353		1431
1354	=item $term->overlay_simple ($x, $y, $text)	1432	=item $term->overlay_simple ($x, $y, $text)
1355		1433
1356	Create a simple multi-line overlay box. See the next method for details.	1434	Create a simple multi-line overlay box. See the next method for details.
1357		1435
…		…
1387		1465
1388	The methods currently supported on C<urxvt::overlay> objects are:	1466	The methods currently supported on C<urxvt::overlay> objects are:
1389		1467
1390	=over 4	1468	=over 4
1391		1469
1392	=item $overlay->set ($x, $y, $text, $rend)	1470	=item $overlay->set ($x, $y, $text[, $rend])
1393		1471
1394	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1472	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	1473	text in rxvt-unicode's special encoding and an array of rendition values
1396	at a specific position inside the overlay.	1474	at a specific position inside the overlay.
		1475
		1476	If C<$rend> is missing, then the rendition will not be changed.
1397		1477
1398	=item $overlay->hide	1478	=item $overlay->hide
1399		1479
1400	If visible, hide the overlay, but do not destroy it.	1480	If visible, hide the overlay, but do not destroy it.
1401		1481
…		…
1483	locale-specific encoding of the terminal and can contain command sequences	1563	locale-specific encoding of the terminal and can contain command sequences
1484	(escape codes) that will be interpreted.	1564	(escape codes) that will be interpreted.
1485		1565
1486	=item $term->tt_write ($octets)	1566	=item $term->tt_write ($octets)
1487		1567
1488	Write the octets given in C<$data> to the tty (i.e. as program input). To	1568	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	1569	pass characters instead of octets, you should convert your strings first
1490	to the locale-specific encoding using C<< $term->locale_encode >>.	1570	to the locale-specific encoding using C<< $term->locale_encode >>.
		1571
		1572	=item $term->tt_paste ($octets)
		1573
		1574	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1575	CR and bracketing the data with control sequences if bracketed paste mode
		1576	is set.
1491		1577
1492	=item $old_events = $term->pty_ev_events ([$new_events])	1578	=item $old_events = $term->pty_ev_events ([$new_events])
1493		1579
1494	Replaces the event mask of the pty watcher by the given event mask. Can	1580	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	1581	be used to suppress input and output handling to the pty/tty. See the
…		…
1611		1697
1612	Used after changing terminal contents to display them.	1698	Used after changing terminal contents to display them.
1613		1699
1614	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1700	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1615		1701
1616	Returns the text of the entire row with number C<$row_number>. Row C<0>	1702	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	1703	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	1704	terminal line. Nothing will be returned if a nonexistent line
1620	is requested.	1705	is requested.
1621		1706
1622	If C<$new_text> is specified, it will replace characters in the current	1707	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	1708	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	1709	to replace only parts of a line. The font index in the rendition will
…		…
1810	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1895	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1811	recent grab.	1896	recent grab.
1812		1897
1813	=item $term->ungrab	1898	=item $term->ungrab
1814		1899
1815	Calls XUngrab for the most recent grab. Is called automatically on	1900	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	1901	evaluation errors, as it is better to lose the grab in the error case as
1817	the session.	1902	the session.
1818		1903
1819	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1904	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1820		1905
…		…
1822		1907
1823	=item @atoms = $term->XListProperties ($window)	1908	=item @atoms = $term->XListProperties ($window)
1824		1909
1825	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1910	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1826		1911
1827	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1912	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1828		1913
1829	=item $term->XDeleteProperty ($window, $property)	1914	=item $term->XDeleteProperty ($window, $property)
1830		1915
1831	=item $window = $term->DefaultRootWindow	1916	=item $window = $term->DefaultRootWindow
1832		1917
…		…
1842		1927
1843	=item $term->XChangeInput ($window, $add_events[, $del_events])	1928	=item $term->XChangeInput ($window, $add_events[, $del_events])
1844		1929
1845	Various X or X-related functions. The C<$term> object only serves as	1930	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	1931	the source of the display, otherwise those functions map more-or-less
1847	directory onto the X functions of the same name.	1932	directly onto the X functions of the same name.
1848		1933
1849	=back	1934	=back
1850		1935
1851	=cut	1936	=cut
1852		1937
…		…
1954	my $env = $self->{term}->env;	2039	my $env = $self->{term}->env;
1955	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2040	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1956	delete $env->{LC_ALL};	2041	delete $env->{LC_ALL};
1957	$env->{LC_CTYPE} = $self->{term}->locale;	2042	$env->{LC_CTYPE} = $self->{term}->locale;
1958		2043
1959	urxvt::term->new ($env, "popup",	2044	my $term = urxvt::term->new (
		2045	$env, "popup",
1960	"--perl-lib" => "", "--perl-ext-common" => "",	2046	"--perl-lib" => "", "--perl-ext-common" => "",
1961	"-pty-fd" => -1, "-sl" => 0,	2047	"-pty-fd" => -1, "-sl" => 0,
1962	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2048	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1963	"--transient-for" => $self->{term}->parent,	2049	"--transient-for" => $self->{term}->parent,
1964	"-display" => $self->{term}->display_id,	2050	"-display" => $self->{term}->display_id,
1965	"-pe" => "urxvt-popup")	2051	"-pe" => "urxvt-popup",
1966	or die "unable to create popup window\n";	2052	) or die "unable to create popup window\n";
		2053
		2054	unless (delete $term->{urxvt_popup_init_done}) {
		2055	$term->ungrab;
		2056	$term->destroy;
		2057	die "unable to initialise popup window\n";
		2058	}
1967	}	2059	}
1968		2060
1969	sub DESTROY {	2061	sub DESTROY {
1970	my ($self) = @_;	2062	my ($self) = @_;
1971		2063
…		…
2002		2094
2003	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2095	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2004		2096
2005	Set the callback to be called when the timer triggers.	2097	Set the callback to be called when the timer triggers.
2006		2098
2007	=item $tstamp = $timer->at
2008
2009	Return the time this watcher will fire next.
2010
2011	=item $timer = $timer->set ($tstamp)	2099	=item $timer = $timer->set ($tstamp[, $interval])
2012		2100
2013	Set the time the event is generated to $tstamp.	2101	Set the time the event is generated to $tstamp (and optionally specifies a
		2102	new $interval).
2014		2103
2015	=item $timer = $timer->interval ($interval)	2104	=item $timer = $timer->interval ($interval)
2016		2105
2017	Normally (and when C<$interval> is C<0>), the timer will automatically	2106	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	2107	stop after it has fired once. If C<$interval> is non-zero, then the timer
2019	is automatically rescheduled at the given intervals.	2108	is automatically rescheduled at the given intervals.
2020		2109
2021	=item $timer = $timer->start	2110	=item $timer = $timer->start
2022		2111
2023	Start the timer.	2112	Start the timer.
2024		2113
2025	=item $timer = $timer->start ($tstamp)	2114	=item $timer = $timer->start ($tstamp[, $interval])
2026		2115
2027	Set the event trigger time to C<$tstamp> and start the timer.	2116	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2117	also replaces the interval.
2028		2118
2029	=item $timer = $timer->after ($delay)	2119	=item $timer = $timer->after ($delay[, $interval])
2030		2120
2031	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2121	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2032		2122
2033	=item $timer = $timer->stop	2123	=item $timer = $timer->stop
2034		2124
…		…
2165		2255
2166	=back	2256	=back
2167		2257
2168	=head1 AUTHOR	2258	=head1 AUTHOR
2169		2259
2170	Marc Lehmann <pcg@goof.com>	2260	Marc Lehmann <schmorp@schmorp.de>
2171	http://software.schmorp.de/pkg/rxvt-unicode	2261	http://software.schmorp.de/pkg/rxvt-unicode
2172		2262
2173	=cut	2263	=cut
2174		2264
2175	1	2265	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.162 by ayin, Mon Dec 17 16:57:57 2007 UTC vs. Revision 1.197 by sf-tpope, Fri Aug 19 23:08:35 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.162 by ayin, Mon Dec 17 16:57:57 2007 UTC vs.
Revision 1.197 by sf-tpope, Fri Aug 19 23:08:35 2011 UTC