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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.158 by ayin, Wed Oct 31 15:17:51 2007 UTC vs.
Revision 1.186 by sf-exg, Fri Jul 23 17:50:41 2010 UTC

…		…
40		40
41	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
42		42
43	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
44		44
45	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
46		46
47	=over 4	47	=over 4
48		48
49	=item selection (enabled by default)	49	=item selection (enabled by default)
50		50
…		…
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
…		…
165	=item readline (enabled by default)	165	=item readline (enabled by default)
166		166
167	A support package that tries to make editing with readline easier. At	167	A support package that tries to make editing with readline easier. At
168	the moment, it reacts to clicking shift-left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
169	move the text cursor to this position. It does so by generating as many	169	move the text cursor to this position. It does so by generating as many
170	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
171	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
172		172
173	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
174		174
175	=over 4	175	=over 4
…		…
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 automove-background	308	=item overlay-osc
309		309
310	This is basically a very small extension that dynamically changes the	310	This extension implements some OSC commands to display timed popups on the
311	background pixmap offset to the window position, in effect creating the	311	screen - useful for status displays from within scripts. You have to read
312	same effect as pseudo transparency with a custom pixmap. No scaling is	312	the sources for more info.
313	supported in this mode. Example:
314
315	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
316
317	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
318	shows how this extension can be used to implement an automatically blurred
319	transparent background.
320		313
321	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
322		315
323	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
324	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
…		…
348	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
349	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
350		343
351	=item selection-pastebin	344	=item selection-pastebin
352		345
353	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
354	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
355	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
356	F</tmp> directly.).	349	F</tmp> directly.).
357		350
358	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
377		370
378	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
379		372
380	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
381	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,
382	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
383	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.
384		391
385	=item example-refresh-hooks	392	=item example-refresh-hooks
386		393
387	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
388	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
…		…
410		417
411	=over 4	418	=over 4
412		419
413	=item $text	420	=item $text
414		421
415	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicode's special way of encoding text, where one "unicode" character
416	always represents one screen cell. See L<ROW_t> for a discussion of this format.	423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
417		424
418	=item $string	425	=item $string
419		426
420	A perl text string, with an emphasis on I<text>. It can store all unicode	427	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
554		561
555	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	562	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
556	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	563	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
557	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
558		565
559	=item on_osc_seq $term, $op, $args	566	=item on_osc_seq $term, $op, $args, $resp
560		567
561	Called on every OSC sequence and can be used to suppress it or modify its	568	Called on every OSC sequence and can be used to suppress it or modify its
562	behaviour. The default should be to return an empty list. A true value	569	behaviour. The default should be to return an empty list. A true value
563	suppresses execution of the request completely. Make sure you don't get	570	suppresses execution of the request completely. Make sure you don't get
564	confused by recursive invocations when you output an osc sequence within	571	confused by recursive invocations when you output an OSC sequence within
565	this callback.	572	this callback.
566		573
567	C<on_osc_seq_perl> should be used for new behaviour.	574	C<on_osc_seq_perl> should be used for new behaviour.
568		575
569	=item on_osc_seq_perl $term, $string	576	=item on_osc_seq_perl $term, $args, $resp
570		577
571	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
572	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
573	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
574	string should start with the extension name and a colon, to distinguish	581	string should start with the extension name (sans -osc) and a semicolon,
575	it from commands for other extensions, and this might be enforced in the	582	to distinguish it from commands for other extensions, and this might be
576	future.	583	enforced in the future.
		584
		585	For example, C<overlay-osc> uses this:
		586
		587	sub on_osc_seq_perl {
		588	my ($self, $osc, $resp) = @_;
		589
		590	return unless $osc =~ s/^overlay;//;
		591
		592	... process remaining $osc string
		593	}
577		594
578	Be careful not ever to trust (in a security sense) the data you receive,	595	Be careful not ever to trust (in a security sense) the data you receive,
579	as its source can not easily be controlled (e-mail content, messages from	596	as its source can not easily be controlled (e-mail content, messages from
580	other users on the same system etc.).	597	other users on the same system etc.).
		598
		599	For responses, C<$resp> contains the end-of-args separator used by the
		600	sender.
581		601
582	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
583		603
584	Called whenever text is about to be output, with the text as argument. You	604	Called whenever text is about to be output, with the text as argument. You
585	can filter/change and output the text yourself by returning a true value	605	can filter/change and output the text yourself by returning a true value
…		…
606	later with the already-modified line (e.g. if unrelated parts change), so	626	later with the already-modified line (e.g. if unrelated parts change), so
607	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
608		628
609	=item on_refresh_begin $term	629	=item on_refresh_begin $term
610		630
611	Called just before the screen gets redrawn. Can be used for overlay	631	Called just before the screen gets redrawn. Can be used for overlay or
612	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
613	restoring them in refresh_end. The built-in overlay and selection display	633	restoring them in refresh_end. The built-in overlay and selection display
614	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
615		635
616	=item on_refresh_end $term	636	=item on_refresh_end $term
617		637
…		…
624	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
625		645
626	The event is simply the action string. This interface is assumed to change	646	The event is simply the action string. This interface is assumed to change
627	slightly in the future.	647	slightly in the future.
628		648
629	=item on_resize_all_windows $tern, $new_width, $new_height	649	=item on_resize_all_windows $term, $new_width, $new_height
630		650
631	Called just after the new window size has been calculated, but before	651	Called just after the new window size has been calculated, but before
632	windows are actually being resized or hints are being set. If this hook	652	windows are actually being resized or hints are being set. If this hook
633	returns TRUE, setting of the window hints is being skipped.	653	returns TRUE, setting of the window hints is being skipped.
634		654
…		…
668		688
669	=item on_map_notify $term, $event	689	=item on_map_notify $term, $event
670		690
671	=item on_unmap_notify $term, $event	691	=item on_unmap_notify $term, $event
672		692
673	Called whenever the corresponding X event is received for the terminal If	693	Called whenever the corresponding X event is received for the terminal. If
674	the hook returns true, then the even will be ignored by rxvt-unicode.	694	the hook returns true, then the event will be ignored by rxvt-unicode.
675		695
676	The event is a hash with most values as named by Xlib (see the XEvent	696	The event is a hash with most values as named by Xlib (see the XEvent
677	manpage), with the additional members C<row> and C<col>, which are the	697	manpage), with the additional members C<row> and C<col>, which are the
678	(real, not screen-based) row and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
679		699
…		…
688		708
689	=item on_wm_delete_window $term, $event	709	=item on_wm_delete_window $term, $event
690		710
691	Called when various types of ClientMessage events are received (all with	711	Called when various types of ClientMessage events are received (all with
692	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		713
		714	=item on_bell $term
		715
		716	Called on receipt of a bell character.
693		717
694	=back	718	=back
695		719
696	=cut	720	=cut
697		721
…		…
1104	is that you cannot use blocking APIs, but the non-blocking variant should	1128	is that you cannot use blocking APIs, but the non-blocking variant should
1105	work.	1129	work.
1106		1130
1107	=cut	1131	=cut
1108		1132
1109	our $VERSION = 1;	1133	our $VERSION = '5.23';
1110		1134
1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1135	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1136	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113		1137
1114	sub timer {	1138	sub timer {
…		…
1116		1140
1117	my $cb = $arg{cb};	1141	my $cb = $arg{cb};
1118		1142
1119	urxvt::timer	1143	urxvt::timer
1120	->new	1144	->new
1121	->start (urxvt::NOW + $arg{after})	1145	->after ($arg{after}, $arg{interval})
1122	->cb (sub {	1146	->cb ($arg{interval} ? $cb : sub {
1123	$_[0]->stop; # need to cancel manually	1147	$_[0]->stop; # need to cancel manually
1124	$cb->();	1148	$cb->();
1125	})	1149	})
1126	}	1150	}
1127		1151
1128	sub io {	1152	sub io {
1129	my ($class, %arg) = @_;	1153	my ($class, %arg) = @_;
1130		1154
1131	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
		1156	my $fd = fileno $arg{fh};
		1157	defined $fd or $fd = $arg{fh};
1132		1158
1133	bless [$arg{fh}, urxvt::iow	1159	bless [$arg{fh}, urxvt::iow
1134	->new	1160	->new
1135	->fd (fileno $arg{fh})	1161	->fd ($fd)
1136	->events (($arg{poll} =~ /r/ ? 1 : 0)	1162	->events (($arg{poll} =~ /r/ ? 1 : 0)
1137	\| ($arg{poll} =~ /w/ ? 2 : 0))	1163	\| ($arg{poll} =~ /w/ ? 2 : 0))
1138	->start	1164	->start
1139	->cb (sub {	1165	->cb ($cb)
1140	$cb->(($_[1] & 1 ? 'r' : '')
1141	. ($_[1] & 2 ? 'w' : ''));
1142	})],
1143	urxvt::anyevent::	1166	], urxvt::anyevent::
		1167	}
		1168
		1169	sub idle {
		1170	my ($class, %arg) = @_;
		1171
		1172	my $cb = $arg{cb};
		1173
		1174	urxvt::iw
		1175	->new
		1176	->start
		1177	->cb ($cb)
		1178	}
		1179
		1180	sub child {
		1181	my ($class, %arg) = @_;
		1182
		1183	my $cb = $arg{cb};
		1184
		1185	urxvt::pw
		1186	->new
		1187	->start ($arg{pid})
		1188	->cb (sub {
		1189	$_[0]->stop; # need to cancel manually
		1190	$cb->($_[0]->rpid, $_[0]->rstatus);
		1191	})
1144	}	1192	}
1145		1193
1146	sub DESTROY {	1194	sub DESTROY {
1147	$_[0][1]->stop;	1195	$_[0][1]->stop;
1148	}
1149
1150	sub condvar {
1151	bless \my $flag, urxvt::anyevent::
1152	}
1153
1154	sub broadcast {
1155	${$_[0]}++;
1156	}
1157
1158	sub wait {
1159	unless (${$_[0]}) {
1160	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1161	}
1162	}	1196	}
1163		1197
1164	sub one_event {	1198	sub one_event {
1165	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1199	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1166	}	1200	}
…		…
1289	Here is a likely non-exhaustive list of resource names, not all of which	1323	Here is a likely non-exhaustive list of resource names, not all of which
1290	are supported in every build, please see the source file F</src/rsinc.h>	1324	are supported in every build, please see the source file F</src/rsinc.h>
1291	to see the actual list:	1325	to see the actual list:
1292		1326
1293	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1327	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1294	borderLess color cursorBlink cursorUnderline cutchars delete_key	1328	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1295	display_name embed ext_bwidth fade font geometry hold iconName	1329	display_name embed ext_bwidth fade font geometry hold iconName
1296	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1330	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1297	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1331	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1298	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1332	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1299	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1333	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1300	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1334	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1301	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1335	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1302	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1336	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1303	secondaryScreen secondaryScroll selectstyle shade term_name title	1337	secondaryScreen secondaryScroll shade term_name title
1304	transient_for transparent transparent_all tripleclickwords utmpInhibit	1338	transient_for transparent transparent_all tripleclickwords utmpInhibit
1305	visualBell	1339	visualBell
1306		1340
1307	=cut	1341	=cut
1308		1342
1309	sub resource($$;$) {	1343	sub resource($$;$) {
1310	my ($self, $name) = (shift, shift);	1344	my ($self, $name) = (shift, shift);
1311	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1345	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1312	&urxvt::term::_resource	1346	goto &urxvt::term::_resource
1313	}	1347	}
1314		1348
1315	=item $value = $term->x_resource ($pattern)	1349	=item $value = $term->x_resource ($pattern)
1316		1350
1317	Returns the X-Resource for the given pattern, excluding the program or	1351	Returns the X-Resource for the given pattern, excluding the program or
…		…
1342		1376
1343	=item ($row, $col) = $term->selection_beg ([$row, $col])	1377	=item ($row, $col) = $term->selection_beg ([$row, $col])
1344		1378
1345	=item ($row, $col) = $term->selection_end ([$row, $col])	1379	=item ($row, $col) = $term->selection_end ([$row, $col])
1346		1380
1347	Return the current values of the selection mark, begin or end positions,	1381	Return the current values of the selection mark, begin or end positions.
1348	and optionally set them to new values.	1382
		1383	When arguments are given, then the selection coordinates are set to
		1384	C<$row> and C<$col>, and the selection screen is set to the current
		1385	screen.
		1386
		1387	=item $screen = $term->selection_screen ([$screen])
		1388
		1389	Returns the current selection screen, and then optionally sets it.
1349		1390
1350	=item $term->selection_make ($eventtime[, $rectangular])	1391	=item $term->selection_make ($eventtime[, $rectangular])
1351		1392
1352	Tries to make a selection as set by C<selection_beg> and	1393	Tries to make a selection as set by C<selection_beg> and
1353	C<selection_end>. If C<$rectangular> is true (default: false), a	1394	C<selection_end>. If C<$rectangular> is true (default: false), a
1354	rectangular selection will be made. This is the prefered function to make	1395	rectangular selection will be made. This is the preferred function to make
1355	a selection.	1396	a selection.
1356		1397
1357	=item $success = $term->selection_grab ($eventtime)	1398	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1358		1399
1359	Try to request the primary selection text from the server (for example, as	1400	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1401	true) selection from the server. The corresponding text can be set
1360	set by the next method). No visual feedback will be given. This function	1402	with the next method. No visual feedback will be given. This function
1361	is mostly useful from within C<on_sel_grab> hooks.	1403	is mostly useful from within C<on_sel_grab> hooks.
1362		1404
1363	=item $oldtext = $term->selection ([$newtext])	1405	=item $oldtext = $term->selection ([$newtext, $clipboard])
1364		1406
1365	Return the current selection text and optionally replace it by C<$newtext>.	1407	Return the current selection (clipboard if C<$clipboard> is true) text
		1408	and optionally replace it by C<$newtext>.
		1409
		1410	=item $term->selection_clear ([$clipboard])
		1411
		1412	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1366		1413
1367	=item $term->overlay_simple ($x, $y, $text)	1414	=item $term->overlay_simple ($x, $y, $text)
1368		1415
1369	Create a simple multi-line overlay box. See the next method for details.	1416	Create a simple multi-line overlay box. See the next method for details.
1370		1417
…		…
1400		1447
1401	The methods currently supported on C<urxvt::overlay> objects are:	1448	The methods currently supported on C<urxvt::overlay> objects are:
1402		1449
1403	=over 4	1450	=over 4
1404		1451
1405	=item $overlay->set ($x, $y, $text, $rend)	1452	=item $overlay->set ($x, $y, $text[, $rend])
1406		1453
1407	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1454	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1408	text in rxvt-unicode's special encoding and an array of rendition values	1455	text in rxvt-unicode's special encoding and an array of rendition values
1409	at a specific position inside the overlay.	1456	at a specific position inside the overlay.
		1457
		1458	If C<$rend> is missing, then the rendition will not be changed.
1410		1459
1411	=item $overlay->hide	1460	=item $overlay->hide
1412		1461
1413	If visible, hide the overlay, but do not destroy it.	1462	If visible, hide the overlay, but do not destroy it.
1414		1463
…		…
1496	locale-specific encoding of the terminal and can contain command sequences	1545	locale-specific encoding of the terminal and can contain command sequences
1497	(escape codes) that will be interpreted.	1546	(escape codes) that will be interpreted.
1498		1547
1499	=item $term->tt_write ($octets)	1548	=item $term->tt_write ($octets)
1500		1549
1501	Write the octets given in C<$data> to the tty (i.e. as program input). To	1550	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1502	pass characters instead of octets, you should convert your strings first	1551	pass characters instead of octets, you should convert your strings first
1503	to the locale-specific encoding using C<< $term->locale_encode >>.	1552	to the locale-specific encoding using C<< $term->locale_encode >>.
1504		1553
1505	=item $old_events = $term->pty_ev_events ([$new_events])	1554	=item $old_events = $term->pty_ev_events ([$new_events])
1506		1555
…		…
1624		1673
1625	Used after changing terminal contents to display them.	1674	Used after changing terminal contents to display them.
1626		1675
1627	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1676	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1628		1677
1629	Returns the text of the entire row with number C<$row_number>. Row C<0>	1678	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1630	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1679	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1631	terminal line. The scrollback buffer starts at line C<-1> and extends to
1632	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1680	terminal line. Nothing will be returned if a nonexistent line
1633	is requested.	1681	is requested.
1634		1682
1635	If C<$new_text> is specified, it will replace characters in the current	1683	If C<$new_text> is specified, it will replace characters in the current
1636	line, starting at column C<$start_col> (default C<0>), which is useful	1684	line, starting at column C<$start_col> (default C<0>), which is useful
1637	to replace only parts of a line. The font index in the rendition will	1685	to replace only parts of a line. The font index in the rendition will
1638	automatically be updated.	1686	automatically be updated.
1639		1687
1640	C<$text> is in a special encoding: tabs and wide characters that use more	1688	C<$text> is in a special encoding: tabs and wide characters that use more
1641	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1689	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1642	characters. Characters with combining characters and other characters that	1690	characters. Characters with combining characters and other characters that
1643	do not fit into the normal tetx encoding will be replaced with characters	1691	do not fit into the normal text encoding will be replaced with characters
1644	in the private use area.	1692	in the private use area.
1645		1693
1646	You have to obey this encoding when changing text. The advantage is	1694	You have to obey this encoding when changing text. The advantage is
1647	that C<substr> and similar functions work on screen cells and not on	1695	that C<substr> and similar functions work on screen cells and not on
1648	characters.	1696	characters.
…		…
1823	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1871	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1824	recent grab.	1872	recent grab.
1825		1873
1826	=item $term->ungrab	1874	=item $term->ungrab
1827		1875
1828	Calls XUngrab for the most recent grab. Is called automatically on	1876	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1829	evaluation errors, as it is better to lose the grab in the error case as	1877	evaluation errors, as it is better to lose the grab in the error case as
1830	the session.	1878	the session.
1831		1879
1832	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1880	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1833		1881
…		…
1835		1883
1836	=item @atoms = $term->XListProperties ($window)	1884	=item @atoms = $term->XListProperties ($window)
1837		1885
1838	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1886	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1839		1887
1840	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1888	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1841		1889
1842	=item $term->XDeleteProperty ($window, $property)	1890	=item $term->XDeleteProperty ($window, $property)
1843		1891
1844	=item $window = $term->DefaultRootWindow	1892	=item $window = $term->DefaultRootWindow
1845		1893
…		…
1855		1903
1856	=item $term->XChangeInput ($window, $add_events[, $del_events])	1904	=item $term->XChangeInput ($window, $add_events[, $del_events])
1857		1905
1858	Various X or X-related functions. The C<$term> object only serves as	1906	Various X or X-related functions. The C<$term> object only serves as
1859	the source of the display, otherwise those functions map more-or-less	1907	the source of the display, otherwise those functions map more-or-less
1860	directory onto the X functions of the same name.	1908	directly onto the X functions of the same name.
1861		1909
1862	=back	1910	=back
1863		1911
1864	=cut	1912	=cut
1865		1913
…		…
1967	my $env = $self->{term}->env;	2015	my $env = $self->{term}->env;
1968	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2016	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1969	delete $env->{LC_ALL};	2017	delete $env->{LC_ALL};
1970	$env->{LC_CTYPE} = $self->{term}->locale;	2018	$env->{LC_CTYPE} = $self->{term}->locale;
1971		2019
1972	urxvt::term->new ($env, "popup",	2020	my $term = urxvt::term->new (
		2021	$env, "popup",
1973	"--perl-lib" => "", "--perl-ext-common" => "",	2022	"--perl-lib" => "", "--perl-ext-common" => "",
1974	"-pty-fd" => -1, "-sl" => 0,	2023	"-pty-fd" => -1, "-sl" => 0,
1975	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2024	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1976	"--transient-for" => $self->{term}->parent,	2025	"--transient-for" => $self->{term}->parent,
1977	"-display" => $self->{term}->display_id,	2026	"-display" => $self->{term}->display_id,
1978	"-pe" => "urxvt-popup")	2027	"-pe" => "urxvt-popup",
1979	or die "unable to create popup window\n";	2028	) or die "unable to create popup window\n";
		2029
		2030	unless (delete $term->{urxvt_popup_init_done}) {
		2031	$term->ungrab;
		2032	$term->destroy;
		2033	die "unable to initialise popup window\n";
		2034	}
1980	}	2035	}
1981		2036
1982	sub DESTROY {	2037	sub DESTROY {
1983	my ($self) = @_;	2038	my ($self) = @_;
1984		2039
…		…
2015		2070
2016	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2071	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017		2072
2018	Set the callback to be called when the timer triggers.	2073	Set the callback to be called when the timer triggers.
2019		2074
2020	=item $tstamp = $timer->at
2021
2022	Return the time this watcher will fire next.
2023
2024	=item $timer = $timer->set ($tstamp)	2075	=item $timer = $timer->set ($tstamp[, $interval])
2025		2076
2026	Set the time the event is generated to $tstamp.	2077	Set the time the event is generated to $tstamp (and optionally specifies a
		2078	new $interval).
2027		2079
2028	=item $timer = $timer->interval ($interval)	2080	=item $timer = $timer->interval ($interval)
2029		2081
2030	Normally (and when C<$interval> is C<0>), the timer will automatically	2082	By default (and when C<$interval> is C<0>), the timer will automatically
2031	stop after it has fired once. If C<$interval> is non-zero, then the timer	2083	stop after it has fired once. If C<$interval> is non-zero, then the timer
2032	is automatically rescheduled at the given intervals.	2084	is automatically rescheduled at the given intervals.
2033		2085
2034	=item $timer = $timer->start	2086	=item $timer = $timer->start
2035		2087
2036	Start the timer.	2088	Start the timer.
2037		2089
2038	=item $timer = $timer->start ($tstamp)	2090	=item $timer = $timer->start ($tstamp[, $interval])
2039		2091
2040	Set the event trigger time to C<$tstamp> and start the timer.	2092	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2093	also replaces the interval.
2041		2094
2042	=item $timer = $timer->after ($delay)	2095	=item $timer = $timer->after ($delay[, $interval])
2043		2096
2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2097	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045		2098
2046	=item $timer = $timer->stop	2099	=item $timer = $timer->stop
2047		2100
…		…
2055		2108
2056	$term->{socket} = ...	2109	$term->{socket} = ...
2057	$term->{iow} = urxvt::iow	2110	$term->{iow} = urxvt::iow
2058	->new	2111	->new
2059	->fd (fileno $term->{socket})	2112	->fd (fileno $term->{socket})
2060	->events (urxvt::EVENT_READ)	2113	->events (urxvt::EV_READ)
2061	->start	2114	->start
2062	->cb (sub {	2115	->cb (sub {
2063	my ($iow, $revents) = @_;	2116	my ($iow, $revents) = @_;
2064	# $revents must be 1 here, no need to check	2117	# $revents must be 1 here, no need to check
2065	sysread $term->{socket}, my $buf, 8192	2118	sysread $term->{socket}, my $buf, 8192
…		…
2083	Set the file descriptor (not handle) to watch.	2136	Set the file descriptor (not handle) to watch.
2084		2137
2085	=item $iow = $iow->events ($eventmask)	2138	=item $iow = $iow->events ($eventmask)
2086		2139
2087	Set the event mask to watch. The only allowed values are	2140	Set the event mask to watch. The only allowed values are
2088	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2141	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2089	together, or C<urxvt::EVENT_NONE>.	2142	together, or C<urxvt::EV_NONE>.
2090		2143
2091	=item $iow = $iow->start	2144	=item $iow = $iow->start
2092		2145
2093	Start watching for requested events on the given handle.	2146	Start watching for requested events on the given handle.
2094		2147

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.158 by ayin, Wed Oct 31 15:17:51 2007 UTC vs. Revision 1.186 by sf-exg, Fri Jul 23 17:50:41 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.158 by ayin, Wed Oct 31 15:17:51 2007 UTC vs.
Revision 1.186 by sf-exg, Fri Jul 23 17:50:41 2010 UTC