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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.175 by root, Sat May 30 08:51:23 2009 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 UTC

…		…
341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343		343
344	=item selection-pastebin	344	=item selection-pastebin
345		345
346	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
347	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
348	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
349	F</tmp> directly.).	349	F</tmp> directly.).
350		350
351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
370		370
371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372		372
373	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
374	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,
375	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
376	or not.	376	or not.
377		377
378	=item macosx-pastebin and macosx-pastebin-native	378	=item macosx-clipboard and macosx-clipboard-native
379		379
380	These two modules implement an extended clipboard for Mac OS X. They are	380	These two modules implement an extended clipboard for Mac OS X. They are
381	used like this:	381	used like this:
382		382
383	URxvt.perl-ext-common: default,macosx-clipboard	383	URxvt.perl-ext-common: default,macosx-clipboard
384	URxvt.keysym.M-c: perl:macosx-clipboard:copy	384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
385	URxvt.keysym.M-v: perl:macosx-clipboard:paste	385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
386		386
387	The difference between them is that the native variant requires a	387	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	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	389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390	simpler etc. etc.	390	simpler etc. etc.
391		391
392	=item example-refresh-hooks	392	=item example-refresh-hooks
393		393
394	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
395	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
396	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.
397		402
398	=back	403	=back
399		404
400	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
401		406
…		…
417		422
418	=over 4	423	=over 4
419		424
420	=item $text	425	=item $text
421		426
422	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	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.	428	always represents one screen cell. See L<ROW_t> for a discussion of this format.
424		429
425	=item $string	430	=item $string
426		431
427	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
…		…
610	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
611		616
612	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
613	suppress or filter tty input.	618	suppress or filter tty input.
614		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
615	=item on_line_update $term, $row	627	=item on_line_update $term, $row
616		628
617	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
618	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
619	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,
…		…
644	resource in the @@RXVT_NAME@@(1) manpage).	656	resource in the @@RXVT_NAME@@(1) manpage).
645		657
646	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
647	slightly in the future.	659	slightly in the future.
648		660
649	=item on_resize_all_windows $tern, $new_width, $new_height	661	=item on_resize_all_windows $term, $new_width, $new_height
650		662
651	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
652	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
653	returns TRUE, setting of the window hints is being skipped.	665	returns TRUE, setting of the window hints is being skipped.
654		666
…		…
688		700
689	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
690		702
691	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
692		704
693	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
694	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.
695		707
696	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
697	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
698	(real, not screen-based) row and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
699		711
…		…
708		720
709	=item on_wm_delete_window $term, $event	721	=item on_wm_delete_window $term, $event
710		722
711	Called when various types of ClientMessage events are received (all with	723	Called when various types of ClientMessage events are received (all with
712	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.
713		729
714	=back	730	=back
715		731
716	=cut	732	=cut
717		733
…		…
855		871
856	=item $rend = urxvt::OVERLAY_RSTYLE	872	=item $rend = urxvt::OVERLAY_RSTYLE
857		873
858	Return the rendition mask used for overlays by default.	874	Return the rendition mask used for overlays by default.
859		875
860	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	876	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		877	urxvt::RS_RVid, urxvt::RS_Uline
861		878
862	Return the bit that enabled bold, italic, blink, reverse-video and	879	Return the bit that enabled bold, italic, blink, reverse-video and
863	underline, respectively. To enable such a style, just logically OR it into	880	underline, respectively. To enable such a style, just logically OR it into
864	the bitset.	881	the bitset.
865		882
…		…
1124	is that you cannot use blocking APIs, but the non-blocking variant should	1141	is that you cannot use blocking APIs, but the non-blocking variant should
1125	work.	1142	work.
1126		1143
1127	=cut	1144	=cut
1128		1145
1129	our $VERSION = '3.4';	1146	our $VERSION = '5.23';
1130		1147
1131	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1148	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1132	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1149	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1133		1150
1134	sub timer {	1151	sub timer {
…		…
1136		1153
1137	my $cb = $arg{cb};	1154	my $cb = $arg{cb};
1138		1155
1139	urxvt::timer	1156	urxvt::timer
1140	->new	1157	->new
1141	->start (urxvt::NOW + $arg{after})	1158	->after ($arg{after}, $arg{interval})
1142	->cb (sub {	1159	->cb ($arg{interval} ? $cb : sub {
1143	$_[0]->stop; # need to cancel manually	1160	$_[0]->stop; # need to cancel manually
1144	$cb->();	1161	$cb->();
1145	})	1162	})
1146	}	1163	}
1147		1164
1148	sub io {	1165	sub io {
1149	my ($class, %arg) = @_;	1166	my ($class, %arg) = @_;
1150		1167
1151	my $cb = $arg{cb};	1168	my $cb = $arg{cb};
		1169	my $fd = fileno $arg{fh};
		1170	defined $fd or $fd = $arg{fh};
1152		1171
1153	bless [$arg{fh}, urxvt::iow	1172	bless [$arg{fh}, urxvt::iow
1154	->new	1173	->new
1155	->fd (fileno $arg{fh})	1174	->fd ($fd)
1156	->events (($arg{poll} =~ /r/ ? 1 : 0)	1175	->events (($arg{poll} =~ /r/ ? 1 : 0)
1157	\| ($arg{poll} =~ /w/ ? 2 : 0))	1176	\| ($arg{poll} =~ /w/ ? 2 : 0))
1158	->start	1177	->start
1159	->cb (sub {	1178	->cb ($cb)
1160	$cb->(($_[1] & 1 ? 'r' : '')
1161	. ($_[1] & 2 ? 'w' : ''));
1162	})],
1163	urxvt::anyevent::	1179	], urxvt::anyevent::
		1180	}
		1181
		1182	sub idle {
		1183	my ($class, %arg) = @_;
		1184
		1185	my $cb = $arg{cb};
		1186
		1187	urxvt::iw
		1188	->new
		1189	->start
		1190	->cb ($cb)
		1191	}
		1192
		1193	sub child {
		1194	my ($class, %arg) = @_;
		1195
		1196	my $cb = $arg{cb};
		1197
		1198	urxvt::pw
		1199	->new
		1200	->start ($arg{pid})
		1201	->cb (sub {
		1202	$_[0]->stop; # need to cancel manually
		1203	$cb->($_[0]->rpid, $_[0]->rstatus);
		1204	})
1164	}	1205	}
1165		1206
1166	sub DESTROY {	1207	sub DESTROY {
1167	$_[0][1]->stop;	1208	$_[0][1]->stop;
1168	}	1209	}
…		…
1348		1389
1349	=item ($row, $col) = $term->selection_beg ([$row, $col])	1390	=item ($row, $col) = $term->selection_beg ([$row, $col])
1350		1391
1351	=item ($row, $col) = $term->selection_end ([$row, $col])	1392	=item ($row, $col) = $term->selection_end ([$row, $col])
1352		1393
1353	Return the current values of the selection mark, begin or end positions,	1394	Return the current values of the selection mark, begin or end positions.
1354	and optionally set them to new values.	1395
		1396	When arguments are given, then the selection coordinates are set to
		1397	C<$row> and C<$col>, and the selection screen is set to the current
		1398	screen.
		1399
		1400	=item $screen = $term->selection_screen ([$screen])
		1401
		1402	Returns the current selection screen, and then optionally sets it.
1355		1403
1356	=item $term->selection_make ($eventtime[, $rectangular])	1404	=item $term->selection_make ($eventtime[, $rectangular])
1357		1405
1358	Tries to make a selection as set by C<selection_beg> and	1406	Tries to make a selection as set by C<selection_beg> and
1359	C<selection_end>. If C<$rectangular> is true (default: false), a	1407	C<selection_end>. If C<$rectangular> is true (default: false), a
1360	rectangular selection will be made. This is the prefered function to make	1408	rectangular selection will be made. This is the preferred function to make
1361	a selection.	1409	a selection.
1362		1410
1363	=item $success = $term->selection_grab ($eventtime)	1411	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1364		1412
1365	Try to request the primary selection text from the server (for example, as	1413	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1414	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	1415	with the next method. No visual feedback will be given. This function
1367	is mostly useful from within C<on_sel_grab> hooks.	1416	is mostly useful from within C<on_sel_grab> hooks.
1368		1417
1369	=item $oldtext = $term->selection ([$newtext])	1418	=item $oldtext = $term->selection ([$newtext, $clipboard])
1370		1419
1371	Return the current selection text and optionally replace it by C<$newtext>.	1420	Return the current selection (clipboard if C<$clipboard> is true) text
		1421	and optionally replace it by C<$newtext>.
		1422
		1423	=item $term->selection_clear ([$clipboard])
		1424
		1425	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1372		1426
1373	=item $term->overlay_simple ($x, $y, $text)	1427	=item $term->overlay_simple ($x, $y, $text)
1374		1428
1375	Create a simple multi-line overlay box. See the next method for details.	1429	Create a simple multi-line overlay box. See the next method for details.
1376		1430
…		…
1504	locale-specific encoding of the terminal and can contain command sequences	1558	locale-specific encoding of the terminal and can contain command sequences
1505	(escape codes) that will be interpreted.	1559	(escape codes) that will be interpreted.
1506		1560
1507	=item $term->tt_write ($octets)	1561	=item $term->tt_write ($octets)
1508		1562
1509	Write the octets given in C<$data> to the tty (i.e. as program input). To	1563	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	1564	pass characters instead of octets, you should convert your strings first
1511	to the locale-specific encoding using C<< $term->locale_encode >>.	1565	to the locale-specific encoding using C<< $term->locale_encode >>.
		1566
		1567	=item $term->tt_paste ($octets)
		1568
		1569	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1570	CR and bracketing the data with control sequences if bracketed paste mode
		1571	is set.
1512		1572
1513	=item $old_events = $term->pty_ev_events ([$new_events])	1573	=item $old_events = $term->pty_ev_events ([$new_events])
1514		1574
1515	Replaces the event mask of the pty watcher by the given event mask. Can	1575	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	1576	be used to suppress input and output handling to the pty/tty. See the
…		…
1830	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1890	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1831	recent grab.	1891	recent grab.
1832		1892
1833	=item $term->ungrab	1893	=item $term->ungrab
1834		1894
1835	Calls XUngrab for the most recent grab. Is called automatically on	1895	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	1896	evaluation errors, as it is better to lose the grab in the error case as
1837	the session.	1897	the session.
1838		1898
1839	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1899	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1840		1900
…		…
1862		1922
1863	=item $term->XChangeInput ($window, $add_events[, $del_events])	1923	=item $term->XChangeInput ($window, $add_events[, $del_events])
1864		1924
1865	Various X or X-related functions. The C<$term> object only serves as	1925	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	1926	the source of the display, otherwise those functions map more-or-less
1867	directory onto the X functions of the same name.	1927	directly onto the X functions of the same name.
1868		1928
1869	=back	1929	=back
1870		1930
1871	=cut	1931	=cut
1872		1932
…		…
2029		2089
2030	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2090	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2031		2091
2032	Set the callback to be called when the timer triggers.	2092	Set the callback to be called when the timer triggers.
2033		2093
2034	=item $tstamp = $timer->at
2035
2036	Return the time this watcher will fire next.
2037
2038	=item $timer = $timer->set ($tstamp)	2094	=item $timer = $timer->set ($tstamp[, $interval])
2039		2095
2040	Set the time the event is generated to $tstamp.	2096	Set the time the event is generated to $tstamp (and optionally specifies a
		2097	new $interval).
2041		2098
2042	=item $timer = $timer->interval ($interval)	2099	=item $timer = $timer->interval ($interval)
2043		2100
2044	Normally (and when C<$interval> is C<0>), the timer will automatically	2101	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	2102	stop after it has fired once. If C<$interval> is non-zero, then the timer
2046	is automatically rescheduled at the given intervals.	2103	is automatically rescheduled at the given intervals.
2047		2104
2048	=item $timer = $timer->start	2105	=item $timer = $timer->start
2049		2106
2050	Start the timer.	2107	Start the timer.
2051		2108
2052	=item $timer = $timer->start ($tstamp)	2109	=item $timer = $timer->start ($tstamp[, $interval])
2053		2110
2054	Set the event trigger time to C<$tstamp> and start the timer.	2111	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2112	also replaces the interval.
2055		2113
2056	=item $timer = $timer->after ($delay)	2114	=item $timer = $timer->after ($delay[, $interval])
2057		2115
2058	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2116	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2059		2117
2060	=item $timer = $timer->stop	2118	=item $timer = $timer->stop
2061		2119

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.175 by root, Sat May 30 08:51:23 2009 UTC vs. Revision 1.189 by root, Sat Dec 18 15:37:10 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.175 by root, Sat May 30 08:51:23 2009 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 UTC