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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.169 by root, Sun Jun 15 14:54:44 2008 UTC vs.
Revision 1.196 by sf-exg, Wed Jun 29 22:46:48 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
…		…
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
376	overlays or changes.	396	overlays or changes.
		397
		398	=item confirm-paste
		399
		400	Displays a confirmation dialog when a paste containing at least a full
		401	line is detected.
377		402
378	=back	403	=back
379		404
380	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
381		406
…		…
397		422
398	=over 4	423	=over 4
399		424
400	=item $text	425	=item $text
401		426
402	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	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.	428	always represents one screen cell. See L<ROW_t> for a discussion of this format.
404		429
405	=item $string	430	=item $string
406		431
407	A perl text string, with an emphasis on I<text>. It can store all unicode	432	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
416	=back	441	=back
417		442
418	=head2 Extension Objects	443	=head2 Extension Objects
419		444
420	Every perl extension is a perl class. A separate perl object is created	445	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,	446	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	447	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	448	their C<$self> object without having to think about clashes with other
424	extensions or other terminals, with the exception of methods and members	449	extensions or other terminals, with the exception of methods and members
425	that begin with an underscore character C<_>: these are reserved for	450	that begin with an underscore character C<_>: these are reserved for
426	internal use.	451	internal use.
…		…
541		566
542	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	567	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	568	$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.	569	number of lines that will be in the scrollback buffer.
545		570
546	=item on_osc_seq $term, $op, $args	571	=item on_osc_seq $term, $op, $args, $resp
547		572
548	Called on every OSC sequence and can be used to suppress it or modify its	573	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	574	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	575	suppresses execution of the request completely. Make sure you don't get
551	confused by recursive invocations when you output an osc sequence within	576	confused by recursive invocations when you output an OSC sequence within
552	this callback.	577	this callback.
553		578
554	C<on_osc_seq_perl> should be used for new behaviour.	579	C<on_osc_seq_perl> should be used for new behaviour.
555		580
556	=item on_osc_seq_perl $term, $string	581	=item on_osc_seq_perl $term, $args, $resp
557		582
558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
560	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
561	string should start with the extension name and a colon, to distinguish	586	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	587	to distinguish it from commands for other extensions, and this might be
563	future.	588	enforced in the future.
		589
		590	For example, C<overlay-osc> uses this:
		591
		592	sub on_osc_seq_perl {
		593	my ($self, $osc, $resp) = @_;
		594
		595	return unless $osc =~ s/^overlay;//;
		596
		597	... process remaining $osc string
		598	}
564		599
565	Be careful not ever to trust (in a security sense) the data you receive,	600	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	601	as its source can not easily be controlled (e-mail content, messages from
567	other users on the same system etc.).	602	other users on the same system etc.).
		603
		604	For responses, C<$resp> contains the end-of-args separator used by the
		605	sender.
568		606
569	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
570		608
571	Called whenever text is about to be output, with the text as argument. You	609	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	610	can filter/change and output the text yourself by returning a true value
…		…
577	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
578		616
579	Called whenever some data is written to the tty/pty and can be used to	617	Called whenever some data is written to the tty/pty and can be used to
580	suppress or filter tty input.	618	suppress or filter tty input.
581		619
		620	=item on_tt_paste $term, $octets
		621
		622	Called whenever text is about to be pasted, with the text as argument. You
		623	can filter/change and paste the text yourself by returning a true value
		624	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		625	locale-encoded.
		626
582	=item on_line_update $term, $row	627	=item on_line_update $term, $row
583		628
584	Called whenever a line was updated or changed. Can be used to filter	629	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	630	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,	631	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	638	later with the already-modified line (e.g. if unrelated parts change), so
594	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
595		640
596	=item on_refresh_begin $term	641	=item on_refresh_begin $term
597		642
598	Called just before the screen gets redrawn. Can be used for overlay	643	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	644	similar effects by modifying the terminal contents in refresh_begin, and
600	restoring them in refresh_end. The built-in overlay and selection display	645	restoring them in refresh_end. The built-in overlay and selection display
601	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
602		647
603	=item on_refresh_end $term	648	=item on_refresh_end $term
604		649
…		…
611	resource in the @@RXVT_NAME@@(1) manpage).	656	resource in the @@RXVT_NAME@@(1) manpage).
612		657
613	The event is simply the action string. This interface is assumed to change	658	The event is simply the action string. This interface is assumed to change
614	slightly in the future.	659	slightly in the future.
615		660
616	=item on_resize_all_windows $tern, $new_width, $new_height	661	=item on_resize_all_windows $term, $new_width, $new_height
617		662
618	Called just after the new window size has been calculated, but before	663	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	664	windows are actually being resized or hints are being set. If this hook
620	returns TRUE, setting of the window hints is being skipped.	665	returns TRUE, setting of the window hints is being skipped.
621		666
…		…
655		700
656	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
657		702
658	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
659		704
660	Called whenever the corresponding X event is received for the terminal If	705	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.	706	the hook returns true, then the event will be ignored by rxvt-unicode.
662		707
663	The event is a hash with most values as named by Xlib (see the XEvent	708	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	709	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.	710	(real, not screen-based) row and column under the mouse cursor.
666		711
…		…
675		720
676	=item on_wm_delete_window $term, $event	721	=item on_wm_delete_window $term, $event
677		722
678	Called when various types of ClientMessage events are received (all with	723	Called when various types of ClientMessage events are received (all with
679	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	724	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		725
		726	=item on_bell $term
		727
		728	Called on receipt of a bell character.
680		729
681	=back	730	=back
682		731
683	=cut	732	=cut
684		733
…		…
749		798
750	=over 4	799	=over 4
751		800
752	=item urxvt::fatal $errormessage	801	=item urxvt::fatal $errormessage
753		802
754	Fatally aborts execution with the given error message. Avoid at all	803	Fatally aborts execution with the given error message (which should
755	costs! The only time this is acceptable is when the terminal process	804	include a trailing newline). Avoid at all costs! The only time this
756	starts up.	805	is acceptable (and useful) is in the init hook, where it prevents the
		806	terminal from starting up.
757		807
758	=item urxvt::warn $string	808	=item urxvt::warn $string
759		809
760	Calls C<rxvt_warn> with the given string which should not include a	810	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	811	newline. The module also overwrites the C<warn> builtin with a function
762	that calls this function.	812	that calls this function.
763		813
764	Using this function has the advantage that its output ends up in the	814	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.	815	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
769	=item @terms = urxvt::termlist	819	=item @terms = urxvt::termlist
770		820
771	Returns all urxvt::term objects that exist in this process, regardless of	821	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	822	whether they are started, being destroyed etc., so be careful. Only term
773	objects that have perl extensions attached will be returned (because there	823	objects that have perl extensions attached will be returned (because there
774	is no urxvt::term objet associated with others).	824	is no urxvt::term object associated with others).
775		825
776	=item $time = urxvt::NOW	826	=item $time = urxvt::NOW
777		827
778	Returns the "current time" (as per the event loop).	828	Returns the "current time" (as per the event loop).
779		829
…		…
822		872
823	=item $rend = urxvt::OVERLAY_RSTYLE	873	=item $rend = urxvt::OVERLAY_RSTYLE
824		874
825	Return the rendition mask used for overlays by default.	875	Return the rendition mask used for overlays by default.
826		876
827	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	877	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		878	urxvt::RS_RVid, urxvt::RS_Uline
828		879
829	Return the bit that enabled bold, italic, blink, reverse-video and	880	Return the bit that enabled bold, italic, blink, reverse-video and
830	underline, respectively. To enable such a style, just logically OR it into	881	underline, respectively. To enable such a style, just logically OR it into
831	the bitset.	882	the bitset.
832		883
…		…
1091	is that you cannot use blocking APIs, but the non-blocking variant should	1142	is that you cannot use blocking APIs, but the non-blocking variant should
1092	work.	1143	work.
1093		1144
1094	=cut	1145	=cut
1095		1146
1096	our $VERSION = '3.4';	1147	our $VERSION = '5.23';
1097		1148
1098	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1149	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1150	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100		1151
1101	sub timer {	1152	sub timer {
…		…
1103		1154
1104	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
1105		1156
1106	urxvt::timer	1157	urxvt::timer
1107	->new	1158	->new
1108	->start (urxvt::NOW + $arg{after})	1159	->after ($arg{after}, $arg{interval})
1109	->cb (sub {	1160	->cb ($arg{interval} ? $cb : sub {
1110	$_[0]->stop; # need to cancel manually	1161	$_[0]->stop; # need to cancel manually
1111	$cb->();	1162	$cb->();
1112	})	1163	})
1113	}	1164	}
1114		1165
1115	sub io {	1166	sub io {
1116	my ($class, %arg) = @_;	1167	my ($class, %arg) = @_;
1117		1168
1118	my $cb = $arg{cb};	1169	my $cb = $arg{cb};
		1170	my $fd = fileno $arg{fh};
		1171	defined $fd or $fd = $arg{fh};
1119		1172
1120	bless [$arg{fh}, urxvt::iow	1173	bless [$arg{fh}, urxvt::iow
1121	->new	1174	->new
1122	->fd (fileno $arg{fh})	1175	->fd ($fd)
1123	->events (($arg{poll} =~ /r/ ? 1 : 0)	1176	->events (($arg{poll} =~ /r/ ? 1 : 0)
1124	\| ($arg{poll} =~ /w/ ? 2 : 0))	1177	\| ($arg{poll} =~ /w/ ? 2 : 0))
1125	->start	1178	->start
1126	->cb (sub {	1179	->cb ($cb)
1127	$cb->(($_[1] & 1 ? 'r' : '')
1128	. ($_[1] & 2 ? 'w' : ''));
1129	})],
1130	urxvt::anyevent::	1180	], urxvt::anyevent::
		1181	}
		1182
		1183	sub idle {
		1184	my ($class, %arg) = @_;
		1185
		1186	my $cb = $arg{cb};
		1187
		1188	urxvt::iw
		1189	->new
		1190	->start
		1191	->cb ($cb)
		1192	}
		1193
		1194	sub child {
		1195	my ($class, %arg) = @_;
		1196
		1197	my $cb = $arg{cb};
		1198
		1199	urxvt::pw
		1200	->new
		1201	->start ($arg{pid})
		1202	->cb (sub {
		1203	$_[0]->stop; # need to cancel manually
		1204	$cb->($_[0]->rpid, $_[0]->rstatus);
		1205	})
1131	}	1206	}
1132		1207
1133	sub DESTROY {	1208	sub DESTROY {
1134	$_[0][1]->stop;	1209	$_[0][1]->stop;
1135	}	1210	}
…		…
1233	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1308	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1234		1309
1235	Here is a likely non-exhaustive list of option names, please see the	1310	Here is a likely non-exhaustive list of option names, please see the
1236	source file F</src/optinc.h> to see the actual list:	1311	source file F</src/optinc.h> to see the actual list:
1237		1312
1238	borderLess console cursorBlink cursorUnderline hold iconic insecure	1313	borderLess buffered console cursorBlink cursorUnderline hold iconic
1239	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1314	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1240	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1315	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1241	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1316	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1242	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1317	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1243	transparent tripleclickwords utmpInhibit visualBell	1318	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1319	urgentOnBell utmpInhibit visualBell
1244		1320
1245	=item $value = $term->resource ($name[, $newval])	1321	=item $value = $term->resource ($name[, $newval])
1246		1322
1247	Returns the current resource value associated with a given name and	1323	Returns the current resource value associated with a given name and
1248	optionally sets a new value. Setting values is most useful in the C<init>	1324	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1261		1337
1262	Here is a likely non-exhaustive list of resource names, not all of which	1338	Here is a likely non-exhaustive list of resource names, not all of which
1263	are supported in every build, please see the source file F</src/rsinc.h>	1339	are supported in every build, please see the source file F</src/rsinc.h>
1264	to see the actual list:	1340	to see the actual list:
1265		1341
1266	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1342	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1267	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1343	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1268	display_name embed ext_bwidth fade font geometry hold iconName	1344	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1269	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1345	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1346	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1270	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1347	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1271	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1348	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1272	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1349	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1273	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1350	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1274	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1351	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1275	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1352	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1276	secondaryScreen secondaryScroll shade term_name title	1353	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1277	transient_for transparent transparent_all tripleclickwords utmpInhibit	1354	term_name title transient_for transparent tripleclickwords urgentOnBell
1278	visualBell	1355	utmpInhibit visualBell
1279		1356
1280	=cut	1357	=cut
1281		1358
1282	sub resource($$;$) {	1359	sub resource($$;$) {
1283	my ($self, $name) = (shift, shift);	1360	my ($self, $name) = (shift, shift);
…		…
1315		1392
1316	=item ($row, $col) = $term->selection_beg ([$row, $col])	1393	=item ($row, $col) = $term->selection_beg ([$row, $col])
1317		1394
1318	=item ($row, $col) = $term->selection_end ([$row, $col])	1395	=item ($row, $col) = $term->selection_end ([$row, $col])
1319		1396
1320	Return the current values of the selection mark, begin or end positions,	1397	Return the current values of the selection mark, begin or end positions.
1321	and optionally set them to new values.	1398
		1399	When arguments are given, then the selection coordinates are set to
		1400	C<$row> and C<$col>, and the selection screen is set to the current
		1401	screen.
		1402
		1403	=item $screen = $term->selection_screen ([$screen])
		1404
		1405	Returns the current selection screen, and then optionally sets it.
1322		1406
1323	=item $term->selection_make ($eventtime[, $rectangular])	1407	=item $term->selection_make ($eventtime[, $rectangular])
1324		1408
1325	Tries to make a selection as set by C<selection_beg> and	1409	Tries to make a selection as set by C<selection_beg> and
1326	C<selection_end>. If C<$rectangular> is true (default: false), a	1410	C<selection_end>. If C<$rectangular> is true (default: false), a
1327	rectangular selection will be made. This is the prefered function to make	1411	rectangular selection will be made. This is the preferred function to make
1328	a selection.	1412	a selection.
1329		1413
1330	=item $success = $term->selection_grab ($eventtime)	1414	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1331		1415
1332	Try to request the primary selection text from the server (for example, as	1416	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1417	true) selection from the server. The corresponding text can be set
1333	set by the next method). No visual feedback will be given. This function	1418	with the next method. No visual feedback will be given. This function
1334	is mostly useful from within C<on_sel_grab> hooks.	1419	is mostly useful from within C<on_sel_grab> hooks.
1335		1420
1336	=item $oldtext = $term->selection ([$newtext])	1421	=item $oldtext = $term->selection ([$newtext, $clipboard])
1337		1422
1338	Return the current selection text and optionally replace it by C<$newtext>.	1423	Return the current selection (clipboard if C<$clipboard> is true) text
		1424	and optionally replace it by C<$newtext>.
		1425
		1426	=item $term->selection_clear ([$clipboard])
		1427
		1428	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1339		1429
1340	=item $term->overlay_simple ($x, $y, $text)	1430	=item $term->overlay_simple ($x, $y, $text)
1341		1431
1342	Create a simple multi-line overlay box. See the next method for details.	1432	Create a simple multi-line overlay box. See the next method for details.
1343		1433
…		…
1373		1463
1374	The methods currently supported on C<urxvt::overlay> objects are:	1464	The methods currently supported on C<urxvt::overlay> objects are:
1375		1465
1376	=over 4	1466	=over 4
1377		1467
1378	=item $overlay->set ($x, $y, $text, $rend)	1468	=item $overlay->set ($x, $y, $text[, $rend])
1379		1469
1380	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1470	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1381	text in rxvt-unicode's special encoding and an array of rendition values	1471	text in rxvt-unicode's special encoding and an array of rendition values
1382	at a specific position inside the overlay.	1472	at a specific position inside the overlay.
		1473
		1474	If C<$rend> is missing, then the rendition will not be changed.
1383		1475
1384	=item $overlay->hide	1476	=item $overlay->hide
1385		1477
1386	If visible, hide the overlay, but do not destroy it.	1478	If visible, hide the overlay, but do not destroy it.
1387		1479
…		…
1469	locale-specific encoding of the terminal and can contain command sequences	1561	locale-specific encoding of the terminal and can contain command sequences
1470	(escape codes) that will be interpreted.	1562	(escape codes) that will be interpreted.
1471		1563
1472	=item $term->tt_write ($octets)	1564	=item $term->tt_write ($octets)
1473		1565
1474	Write the octets given in C<$data> to the tty (i.e. as program input). To	1566	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1475	pass characters instead of octets, you should convert your strings first	1567	pass characters instead of octets, you should convert your strings first
1476	to the locale-specific encoding using C<< $term->locale_encode >>.	1568	to the locale-specific encoding using C<< $term->locale_encode >>.
		1569
		1570	=item $term->tt_paste ($octets)
		1571
		1572	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1573	CR and bracketing the data with control sequences if bracketed paste mode
		1574	is set.
1477		1575
1478	=item $old_events = $term->pty_ev_events ([$new_events])	1576	=item $old_events = $term->pty_ev_events ([$new_events])
1479		1577
1480	Replaces the event mask of the pty watcher by the given event mask. Can	1578	Replaces the event mask of the pty watcher by the given event mask. Can
1481	be used to suppress input and output handling to the pty/tty. See the	1579	be used to suppress input and output handling to the pty/tty. See the
…		…
1795	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1893	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1796	recent grab.	1894	recent grab.
1797		1895
1798	=item $term->ungrab	1896	=item $term->ungrab
1799		1897
1800	Calls XUngrab for the most recent grab. Is called automatically on	1898	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1801	evaluation errors, as it is better to lose the grab in the error case as	1899	evaluation errors, as it is better to lose the grab in the error case as
1802	the session.	1900	the session.
1803		1901
1804	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1902	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1805		1903
…		…
1827		1925
1828	=item $term->XChangeInput ($window, $add_events[, $del_events])	1926	=item $term->XChangeInput ($window, $add_events[, $del_events])
1829		1927
1830	Various X or X-related functions. The C<$term> object only serves as	1928	Various X or X-related functions. The C<$term> object only serves as
1831	the source of the display, otherwise those functions map more-or-less	1929	the source of the display, otherwise those functions map more-or-less
1832	directory onto the X functions of the same name.	1930	directly onto the X functions of the same name.
1833		1931
1834	=back	1932	=back
1835		1933
1836	=cut	1934	=cut
1837		1935
…		…
1994		2092
1995	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2093	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1996		2094
1997	Set the callback to be called when the timer triggers.	2095	Set the callback to be called when the timer triggers.
1998		2096
1999	=item $tstamp = $timer->at
2000
2001	Return the time this watcher will fire next.
2002
2003	=item $timer = $timer->set ($tstamp)	2097	=item $timer = $timer->set ($tstamp[, $interval])
2004		2098
2005	Set the time the event is generated to $tstamp.	2099	Set the time the event is generated to $tstamp (and optionally specifies a
		2100	new $interval).
2006		2101
2007	=item $timer = $timer->interval ($interval)	2102	=item $timer = $timer->interval ($interval)
2008		2103
2009	Normally (and when C<$interval> is C<0>), the timer will automatically	2104	By default (and when C<$interval> is C<0>), the timer will automatically
2010	stop after it has fired once. If C<$interval> is non-zero, then the timer	2105	stop after it has fired once. If C<$interval> is non-zero, then the timer
2011	is automatically rescheduled at the given intervals.	2106	is automatically rescheduled at the given intervals.
2012		2107
2013	=item $timer = $timer->start	2108	=item $timer = $timer->start
2014		2109
2015	Start the timer.	2110	Start the timer.
2016		2111
2017	=item $timer = $timer->start ($tstamp)	2112	=item $timer = $timer->start ($tstamp[, $interval])
2018		2113
2019	Set the event trigger time to C<$tstamp> and start the timer.	2114	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2115	also replaces the interval.
2020		2116
2021	=item $timer = $timer->after ($delay)	2117	=item $timer = $timer->after ($delay[, $interval])
2022		2118
2023	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2119	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2024		2120
2025	=item $timer = $timer->stop	2121	=item $timer = $timer->stop
2026		2122
…		…
2157		2253
2158	=back	2254	=back
2159		2255
2160	=head1 AUTHOR	2256	=head1 AUTHOR
2161		2257
2162	Marc Lehmann <pcg@goof.com>	2258	Marc Lehmann <schmorp@schmorp.de>
2163	http://software.schmorp.de/pkg/rxvt-unicode	2259	http://software.schmorp.de/pkg/rxvt-unicode
2164		2260
2165	=cut	2261	=cut
2166		2262
2167	1	2263	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.169 by root, Sun Jun 15 14:54:44 2008 UTC vs. Revision 1.196 by sf-exg, Wed Jun 29 22:46:48 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.169 by root, Sun Jun 15 14:54:44 2008 UTC vs.
Revision 1.196 by sf-exg, Wed Jun 29 22:46:48 2011 UTC