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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.174 by root, Sat May 30 08:47:07 2009 UTC vs.
Revision 1.204 by sf-exg, Mon Dec 5 12:52:57 2011 UTC

…		…
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
…		…
341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343		345
344	=item selection-pastebin	346	=item selection-pastebin
345		347
346	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
347	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
348	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
349	F</tmp> directly.).	351	F</tmp> directly.).
350		352
351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
370		372
371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372		374
373	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
374	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,
375	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
376	or not.	378	or not.
377		379
378	=item macosx-pastebin and macosx-pastebin-native	380	=item macosx-clipboard and macosx-clipboard-native
379		381
380	These two modules implement an extended clipboard for Mac OS X. They are	382	These two modules implement an extended clipboard for Mac OS X. They are
381	used like this:	383	used like this:
382		384
383	URxvt.perl-ext-common: default,macosx-clipboard	385	URxvt.perl-ext-common: default,macosx-clipboard
384	URxvt.keysym.M-c: perl:macosx-clipboard:copy	386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
385	URxvt.keysym.M-v: perl:macosx-clipboard:paste	387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
386		388
387	The difference between them is that the native variant requires a	389	The difference between them is that the native variant requires a
388	perl from apple's devkit or so, and C<maxosx-pastebin> requires the	390	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	391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390	simpler etc. etc.	392	simpler etc. etc.
391		393
392	=item example-refresh-hooks	394	=item example-refresh-hooks
393		395
394	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
395	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
396	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"
397		412
398	=back	413	=back
399		414
400	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
401		416
…		…
417		432
418	=over 4	433	=over 4
419		434
420	=item $text	435	=item $text
421		436
422	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
423	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.
424		439
425	=item $string	440	=item $string
426		441
427	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
…		…
431	=item $octets	446	=item $octets
432		447
433	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
434	locale-specific way.	449	locale-specific way.
435		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
		456
436	=back	457	=back
437		458
438	=head2 Extension Objects	459	=head2 Extension Objects
439		460
440	Every perl extension is a perl class. A separate perl object is created	461	Every perl extension is a perl class. A separate perl object is created
441	for each terminal, and each terminal has its own set of extenion objects,	462	for each terminal, and each terminal has its own set of extension objects,
442	which are passed as the first parameter to hooks. So extensions can use	463	which are passed as the first parameter to hooks. So extensions can use
443	their C<$self> object without having to think about clashes with other	464	their C<$self> object without having to think about clashes with other
444	extensions or other terminals, with the exception of methods and members	465	extensions or other terminals, with the exception of methods and members
445	that begin with an underscore character C<_>: these are reserved for	466	that begin with an underscore character C<_>: these are reserved for
446	internal use.	467	internal use.
…		…
610	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
611		632
612	Called whenever some data is written to the tty/pty and can be used to	633	Called whenever some data is written to the tty/pty and can be used to
613	suppress or filter tty input.	634	suppress or filter tty input.
614		635
		636	=item on_tt_paste $term, $octets
		637
		638	Called whenever text is about to be pasted, with the text as argument. You
		639	can filter/change and paste the text yourself by returning a true value
		640	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		641	locale-encoded.
		642
615	=item on_line_update $term, $row	643	=item on_line_update $term, $row
616		644
617	Called whenever a line was updated or changed. Can be used to filter	645	Called whenever a line was updated or changed. Can be used to filter
618	screen output (e.g. underline urls or other useless stuff). Only lines	646	screen output (e.g. underline urls or other useless stuff). Only lines
619	that are being shown will be filtered, and, due to performance reasons,	647	that are being shown will be filtered, and, due to performance reasons,
…		…
644	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
645		673
646	The event is simply the action string. This interface is assumed to change	674	The event is simply the action string. This interface is assumed to change
647	slightly in the future.	675	slightly in the future.
648		676
		677	=item on_register_command $term, $keysym, $modifiermask, $string
		678
		679	Called after parsing a keysym resource but before registering the
		680	associated binding. If this hook returns TRUE the binding is not
		681	registered. It can be used to modify a binding by calling
		682	C<register_command>.
		683
649	=item on_resize_all_windows $tern, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
650		685
651	Called just after the new window size has been calculated, but before	686	Called just after the new window size has been calculated, but before
652	windows are actually being resized or hints are being set. If this hook	687	windows are actually being resized or hints are being set. If this hook
653	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
654		689
…		…
688		723
689	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
690		725
691	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
692		727
693	Called whenever the corresponding X event is received for the terminal If	728	Called whenever the corresponding X event is received for the terminal. If
694	the hook returns true, then the even will be ignored by rxvt-unicode.	729	the hook returns true, then the event will be ignored by rxvt-unicode.
695		730
696	The event is a hash with most values as named by Xlib (see the XEvent	731	The event is a hash with most values as named by Xlib (see the XEvent
697	manpage), with the additional members C<row> and C<col>, which are the	732	manpage), with the additional members C<row> and C<col>, which are the
698	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
699		734
…		…
708		743
709	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
710		745
711	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
713		752
714	=back	753	=back
715		754
716	=cut	755	=cut
717		756
…		…
782		821
783	=over 4	822	=over 4
784		823
785	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
786		825
787	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
788	costs! The only time this is acceptable is when the terminal process	827	include a trailing newline). Avoid at all costs! The only time this
789	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
790		830
791	=item urxvt::warn $string	831	=item urxvt::warn $string
792		832
793	Calls C<rxvt_warn> with the given string which should not include a	833	Calls C<rxvt_warn> with the given string which should include a trailing
794	newline. The module also overwrites the C<warn> builtin with a function	834	newline. The module also overwrites the C<warn> builtin with a function
795	that calls this function.	835	that calls this function.
796		836
797	Using this function has the advantage that its output ends up in the	837	Using this function has the advantage that its output ends up in the
798	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
802	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
803		843
804	Returns all urxvt::term objects that exist in this process, regardless of	844	Returns all urxvt::term objects that exist in this process, regardless of
805	whether they are started, being destroyed etc., so be careful. Only term	845	whether they are started, being destroyed etc., so be careful. Only term
806	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
807	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
808		848
809	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
810		850
811	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
812		852
…		…
855		895
856	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
857		897
858	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
859		899
860	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	900	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		901	urxvt::RS_RVid, urxvt::RS_Uline
861		902
862	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
863	underline, respectively. To enable such a style, just logically OR it into	904	underline, respectively. To enable such a style, just logically OR it into
864	the bitset.	905	the bitset.
865		906
…		…
947	sub invoke {	988	sub invoke {
948	local $TERM = shift;	989	local $TERM = shift;
949	my $htype = shift;	990	my $htype = shift;
950		991
951	if ($htype == 0) { # INIT	992	if ($htype == 0) { # INIT
952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	993	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
953		994
954	my %ext_arg;	995	my %ext_arg;
955		996
956	{	997	{
957	my @init = @TERM_INIT;	998	my @init = @TERM_INIT;
…		…
1124	is that you cannot use blocking APIs, but the non-blocking variant should	1165	is that you cannot use blocking APIs, but the non-blocking variant should
1125	work.	1166	work.
1126		1167
1127	=cut	1168	=cut
1128		1169
1129	our $VERSION = '3.4';	1170	our $VERSION = '5.23';
1130		1171
1131	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1172	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1132	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1173	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1133		1174
1134	sub timer {	1175	sub timer {
…		…
1136		1177
1137	my $cb = $arg{cb};	1178	my $cb = $arg{cb};
1138		1179
1139	urxvt::timer	1180	urxvt::timer
1140	->new	1181	->new
1141	->start (urxvt::NOW + $arg{after})	1182	->after ($arg{after}, $arg{interval})
1142	->cb (sub {	1183	->cb ($arg{interval} ? $cb : sub {
1143	$_[0]->stop; # need to cancel manually	1184	$_[0]->stop; # need to cancel manually
1144	$cb->();	1185	$cb->();
1145	})	1186	})
1146	}	1187	}
1147		1188
1148	sub io {	1189	sub io {
1149	my ($class, %arg) = @_;	1190	my ($class, %arg) = @_;
1150		1191
1151	my $cb = $arg{cb};	1192	my $cb = $arg{cb};
		1193	my $fd = fileno $arg{fh};
		1194	defined $fd or $fd = $arg{fh};
1152		1195
1153	bless [$arg{fh}, urxvt::iow	1196	bless [$arg{fh}, urxvt::iow
1154	->new	1197	->new
1155	->fd (fileno $arg{fh})	1198	->fd ($fd)
1156	->events (($arg{poll} =~ /r/ ? 1 : 0)	1199	->events (($arg{poll} =~ /r/ ? 1 : 0)
1157	\| ($arg{poll} =~ /w/ ? 2 : 0))	1200	\| ($arg{poll} =~ /w/ ? 2 : 0))
1158	->start	1201	->start
1159	->cb (sub {	1202	->cb ($cb)
1160	$cb->(($_[1] & 1 ? 'r' : '')
1161	. ($_[1] & 2 ? 'w' : ''));
1162	})],
1163	urxvt::anyevent::	1203	], urxvt::anyevent::
		1204	}
		1205
		1206	sub idle {
		1207	my ($class, %arg) = @_;
		1208
		1209	my $cb = $arg{cb};
		1210
		1211	urxvt::iw
		1212	->new
		1213	->start
		1214	->cb ($cb)
		1215	}
		1216
		1217	sub child {
		1218	my ($class, %arg) = @_;
		1219
		1220	my $cb = $arg{cb};
		1221
		1222	urxvt::pw
		1223	->new
		1224	->start ($arg{pid})
		1225	->cb (sub {
		1226	$_[0]->stop; # need to cancel manually
		1227	$cb->($_[0]->rpid, $_[0]->rstatus);
		1228	})
1164	}	1229	}
1165		1230
1166	sub DESTROY {	1231	sub DESTROY {
1167	$_[0][1]->stop;	1232	$_[0][1]->stop;
1168	}	1233	}
1169		1234
		1235	# only needed for AnyEvent < 6 compatibility
1170	sub one_event {	1236	sub one_event {
1171	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1237	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1172	}	1238	}
1173		1239
1174	package urxvt::term;	1240	package urxvt::term;
…		…
1266	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1332	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1267		1333
1268	Here is a likely non-exhaustive list of option names, please see the	1334	Here is a likely non-exhaustive list of option names, please see the
1269	source file F</src/optinc.h> to see the actual list:	1335	source file F</src/optinc.h> to see the actual list:
1270		1336
1271	borderLess console cursorBlink cursorUnderline hold iconic insecure	1337	borderLess buffered console cursorBlink cursorUnderline hold iconic
1272	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1338	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1273	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1339	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1274	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1340	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1275	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1341	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1276	transparent tripleclickwords utmpInhibit visualBell	1342	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1343	urgentOnBell utmpInhibit visualBell
1277		1344
1278	=item $value = $term->resource ($name[, $newval])	1345	=item $value = $term->resource ($name[, $newval])
1279		1346
1280	Returns the current resource value associated with a given name and	1347	Returns the current resource value associated with a given name and
1281	optionally sets a new value. Setting values is most useful in the C<init>	1348	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1294		1361
1295	Here is a likely non-exhaustive list of resource names, not all of which	1362	Here is a likely non-exhaustive list of resource names, not all of which
1296	are supported in every build, please see the source file F</src/rsinc.h>	1363	are supported in every build, please see the source file F</src/rsinc.h>
1297	to see the actual list:	1364	to see the actual list:
1298		1365
1299	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1366	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1300	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1367	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1301	display_name embed ext_bwidth fade font geometry hold iconName	1368	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1302	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1369	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1370	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1303	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1371	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1304	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1372	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1305	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1373	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1306	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1374	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1307	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1375	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1308	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1376	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1309	secondaryScreen secondaryScroll shade term_name title	1377	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1310	transient_for transparent transparent_all tripleclickwords utmpInhibit	1378	term_name title transient_for transparent tripleclickwords urgentOnBell
1311	visualBell	1379	utmpInhibit visualBell
1312		1380
1313	=cut	1381	=cut
1314		1382
1315	sub resource($$;$) {	1383	sub resource($$;$) {
1316	my ($self, $name) = (shift, shift);	1384	my ($self, $name) = (shift, shift);
…		…
1327		1395
1328	This method should only be called during the C<on_start> hook, as there is	1396	This method should only be called during the C<on_start> hook, as there is
1329	only one resource database per display, and later invocations might return	1397	only one resource database per display, and later invocations might return
1330	the wrong resources.	1398	the wrong resources.
1331		1399
1332	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1400	=item $success = $term->parse_keysym ($key, $octets)
1333		1401
1334	Adds a keymap translation exactly as specified via a resource. See the	1402	Adds a key binding exactly as specified via a resource. See the
1335	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1403	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1404
		1405	=item $term->register_command ($keysym, $modifiermask, $string)
		1406
		1407	Adds a key binding. This is a lower level api compared to
		1408	C<parse_keysym>, as it expects a parsed key description, and can be
		1409	used only inside either the C<on_init> hook, to add a binding, or the
		1410	C<on_register_command> hook, to modify a parsed binding.
1336		1411
1337	=item $rend = $term->rstyle ([$new_rstyle])	1412	=item $rend = $term->rstyle ([$new_rstyle])
1338		1413
1339	Return and optionally change the current rendition. Text that is output by	1414	Return and optionally change the current rendition. Text that is output by
1340	the terminal application will use this style.	1415	the terminal application will use this style.
…		…
1348		1423
1349	=item ($row, $col) = $term->selection_beg ([$row, $col])	1424	=item ($row, $col) = $term->selection_beg ([$row, $col])
1350		1425
1351	=item ($row, $col) = $term->selection_end ([$row, $col])	1426	=item ($row, $col) = $term->selection_end ([$row, $col])
1352		1427
1353	Return the current values of the selection mark, begin or end positions,	1428	Return the current values of the selection mark, begin or end positions.
1354	and optionally set them to new values.	1429
		1430	When arguments are given, then the selection coordinates are set to
		1431	C<$row> and C<$col>, and the selection screen is set to the current
		1432	screen.
		1433
		1434	=item $screen = $term->selection_screen ([$screen])
		1435
		1436	Returns the current selection screen, and then optionally sets it.
1355		1437
1356	=item $term->selection_make ($eventtime[, $rectangular])	1438	=item $term->selection_make ($eventtime[, $rectangular])
1357		1439
1358	Tries to make a selection as set by C<selection_beg> and	1440	Tries to make a selection as set by C<selection_beg> and
1359	C<selection_end>. If C<$rectangular> is true (default: false), a	1441	C<selection_end>. If C<$rectangular> is true (default: false), a
1360	rectangular selection will be made. This is the prefered function to make	1442	rectangular selection will be made. This is the preferred function to make
1361	a selection.	1443	a selection.
1362		1444
1363	=item $success = $term->selection_grab ($eventtime)	1445	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1364		1446
1365	Try to request the primary selection text from the server (for example, as	1447	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1448	true) selection from the server. The corresponding text can be set
1366	set by the next method). No visual feedback will be given. This function	1449	with the next method. No visual feedback will be given. This function
1367	is mostly useful from within C<on_sel_grab> hooks.	1450	is mostly useful from within C<on_sel_grab> hooks.
1368		1451
1369	=item $oldtext = $term->selection ([$newtext])	1452	=item $oldtext = $term->selection ([$newtext, $clipboard])
1370		1453
1371	Return the current selection text and optionally replace it by C<$newtext>.	1454	Return the current selection (clipboard if C<$clipboard> is true) text
		1455	and optionally replace it by C<$newtext>.
		1456
		1457	=item $term->selection_clear ([$clipboard])
		1458
		1459	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1372		1460
1373	=item $term->overlay_simple ($x, $y, $text)	1461	=item $term->overlay_simple ($x, $y, $text)
1374		1462
1375	Create a simple multi-line overlay box. See the next method for details.	1463	Create a simple multi-line overlay box. See the next method for details.
1376		1464
…		…
1504	locale-specific encoding of the terminal and can contain command sequences	1592	locale-specific encoding of the terminal and can contain command sequences
1505	(escape codes) that will be interpreted.	1593	(escape codes) that will be interpreted.
1506		1594
1507	=item $term->tt_write ($octets)	1595	=item $term->tt_write ($octets)
1508		1596
1509	Write the octets given in C<$data> to the tty (i.e. as program input). To	1597	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1510	pass characters instead of octets, you should convert your strings first	1598	pass characters instead of octets, you should convert your strings first
1511	to the locale-specific encoding using C<< $term->locale_encode >>.	1599	to the locale-specific encoding using C<< $term->locale_encode >>.
		1600
		1601	=item $term->tt_paste ($octets)
		1602
		1603	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1604	CR and bracketing the data with control sequences if bracketed paste mode
		1605	is set.
1512		1606
1513	=item $old_events = $term->pty_ev_events ([$new_events])	1607	=item $old_events = $term->pty_ev_events ([$new_events])
1514		1608
1515	Replaces the event mask of the pty watcher by the given event mask. Can	1609	Replaces the event mask of the pty watcher by the given event mask. Can
1516	be used to suppress input and output handling to the pty/tty. See the	1610	be used to suppress input and output handling to the pty/tty. See the
…		…
1534		1628
1535	Adds the specified events to the vt event mask. Useful e.g. when you want	1629	Adds the specified events to the vt event mask. Useful e.g. when you want
1536	to receive pointer events all the times:	1630	to receive pointer events all the times:
1537		1631
1538	$term->vt_emask_add (urxvt::PointerMotionMask);	1632	$term->vt_emask_add (urxvt::PointerMotionMask);
		1633
		1634	=item $term->set_urgency ($set)
		1635
		1636	Enable/disable the urgency hint on the toplevel window.
1539		1637
1540	=item $term->focus_in	1638	=item $term->focus_in
1541		1639
1542	=item $term->focus_out	1640	=item $term->focus_out
1543		1641
…		…
1830	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1928	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1831	recent grab.	1929	recent grab.
1832		1930
1833	=item $term->ungrab	1931	=item $term->ungrab
1834		1932
1835	Calls XUngrab for the most recent grab. Is called automatically on	1933	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1836	evaluation errors, as it is better to lose the grab in the error case as	1934	evaluation errors, as it is better to lose the grab in the error case as
1837	the session.	1935	the session.
1838		1936
1839	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1937	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1840		1938
…		…
1860		1958
1861	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1959	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1862		1960
1863	=item $term->XChangeInput ($window, $add_events[, $del_events])	1961	=item $term->XChangeInput ($window, $add_events[, $del_events])
1864		1962
		1963	=item $keysym = $term->XStringToKeysym ($string)
		1964
		1965	=item $string = $term->XKeysymToString ($keysym)
		1966
1865	Various X or X-related functions. The C<$term> object only serves as	1967	Various X or X-related functions. The C<$term> object only serves as
1866	the source of the display, otherwise those functions map more-or-less	1968	the source of the display, otherwise those functions map more-or-less
1867	directory onto the X functions of the same name.	1969	directly onto the X functions of the same name.
1868		1970
1869	=back	1971	=back
1870		1972
1871	=cut	1973	=cut
1872		1974
…		…
2029		2131
2030	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2132	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2031		2133
2032	Set the callback to be called when the timer triggers.	2134	Set the callback to be called when the timer triggers.
2033		2135
2034	=item $tstamp = $timer->at
2035
2036	Return the time this watcher will fire next.
2037
2038	=item $timer = $timer->set ($tstamp)	2136	=item $timer = $timer->set ($tstamp[, $interval])
2039		2137
2040	Set the time the event is generated to $tstamp.	2138	Set the time the event is generated to $tstamp (and optionally specifies a
		2139	new $interval).
2041		2140
2042	=item $timer = $timer->interval ($interval)	2141	=item $timer = $timer->interval ($interval)
2043		2142
2044	Normally (and when C<$interval> is C<0>), the timer will automatically	2143	By default (and when C<$interval> is C<0>), the timer will automatically
2045	stop after it has fired once. If C<$interval> is non-zero, then the timer	2144	stop after it has fired once. If C<$interval> is non-zero, then the timer
2046	is automatically rescheduled at the given intervals.	2145	is automatically rescheduled at the given intervals.
2047		2146
2048	=item $timer = $timer->start	2147	=item $timer = $timer->start
2049		2148
2050	Start the timer.	2149	Start the timer.
2051		2150
2052	=item $timer = $timer->start ($tstamp)	2151	=item $timer = $timer->start ($tstamp[, $interval])
2053		2152
2054	Set the event trigger time to C<$tstamp> and start the timer.	2153	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2154	also replaces the interval.
2055		2155
2056	=item $timer = $timer->after ($delay)	2156	=item $timer = $timer->after ($delay[, $interval])
2057		2157
2058	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2158	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2059		2159
2060	=item $timer = $timer->stop	2160	=item $timer = $timer->stop
2061		2161
…		…
2192		2292
2193	=back	2293	=back
2194		2294
2195	=head1 AUTHOR	2295	=head1 AUTHOR
2196		2296
2197	Marc Lehmann <pcg@goof.com>	2297	Marc Lehmann <schmorp@schmorp.de>
2198	http://software.schmorp.de/pkg/rxvt-unicode	2298	http://software.schmorp.de/pkg/rxvt-unicode
2199		2299
2200	=cut	2300	=cut
2201		2301
2202	1	2302	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.174 by root, Sat May 30 08:47:07 2009 UTC vs. Revision 1.204 by sf-exg, Mon Dec 5 12:52:57 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.174 by root, Sat May 30 08:47:07 2009 UTC vs.
Revision 1.204 by sf-exg, Mon Dec 5 12:52:57 2011 UTC