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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC vs.
Revision 1.133 by root, Mon Feb 6 06:14:08 2006 UTC

…		…
67	the match. For example, the followign adds a regex that matches everything	67	the match. For example, the followign adds a regex that matches everything
68	between two vertical bars:	68	between two vertical bars:
69		69
70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
71		71
		72	Another example: Programs I use often output "absolute path: " at the
		73	beginning of a line when they process multiple files. The following
		74	pattern matches the filename (note, there is a single space at the very
		75	end):
		76
		77	URxvt.selection.pattern-0: ^(/[^:]+):\
		78
72	You can look at the source of the selection extension to see more	79	You can look at the source of the selection extension to see more
73	interesting uses, such as parsing a line from beginning to end.	80	interesting uses, such as parsing a line from beginning to end.
74		81
75	This extension also offers following bindable keyboard commands:	82	This extension also offers following bindable keyboard commands:
76		83
…		…
86		93
87	=item option-popup (enabled by default)	94	=item option-popup (enabled by default)
88		95
89	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90	runtime.	97	runtime.
		98
		99	Other extensions can extend this popup menu by pushing a code reference
		100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		101	popup is being displayed.
		102
		103	It's sole argument is the popup menu, which can be modified. It should
		104	either return nothing or a string, the initial boolean value and a code
		105	reference. The string will be used as button text and the code reference
		106	will be called when the toggle changes, with the new boolean value as
		107	first argument.
		108
		109	The following will add an entry C<myoption> that changes
		110	C<$self->{myoption}>:
		111
		112	push @{ $self->{term}{option_popup_hook} }, sub {
		113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		114	};
91		115
92	=item selection-popup (enabled by default)	116	=item selection-popup (enabled by default)
93		117
94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95	text into various other formats/action (such as uri unescaping, perl	119	text into various other formats/action (such as uri unescaping, perl
96	evaluation, web-browser starting etc.), depending on content.	120	evaluation, web-browser starting etc.), depending on content.
97		121
98	Other extensions can extend this popup menu by pushing a code reference	122	Other extensions can extend this popup menu by pushing a code reference
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
100	popup is displayed.	124	popup is being displayed.
101		125
102	It's sole argument is the popup menu, which can be modified. The selection	126	It's sole argument is the popup menu, which can be modified. The selection
103	is in C<$_>, which can be used to decide wether to add something or not.	127	is in C<$_>, which can be used to decide wether to add something or not.
104	It should either return nothing or a string and a code reference. The	128	It should either return nothing or a string and a code reference. The
105	string will be used as button text and the code reference will be called	129	string will be used as button text and the code reference will be called
…		…
127	bottom. C<Escape> leaves search mode and returns to the point where search	151	bottom. C<Escape> leaves search mode and returns to the point where search
128	was started, while C<Enter> or C<Return> stay at the current position and	152	was started, while C<Enter> or C<Return> stay at the current position and
129	additionally stores the first match in the current line into the primary	153	additionally stores the first match in the current line into the primary
130	selection.	154	selection.
131		155
132	=item selection-autotransform	156	=item readline (enabled by default)
133
134	This selection allows you to do automatic transforms on a selection
135	whenever a selection is made.
136
137	It works by specifying perl snippets (most useful is a single C<s///>
138	operator) that modify C<$_> as resources:
139
140	URxvt.selection-autotransform.0: transform
141	URxvt.selection-autotransform.1: transform
142	...
143
144	For example, the following will transform selections of the form
145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
146	$word>:
147
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
149
150	And this example matches the same,but replaces it with vi-commands you can
151	paste directly into your (vi :) editor:
152
153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
154
155	Of course, this can be modified to suit your needs and your editor :)
156
157	To expand the example above to typical perl error messages ("XXX at
158	FILENAME line YYY."), you need a slightly more elaborate solution:
159
160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162
163	The first line tells the selection code to treat the unchanging part of
164	every error message as a selection pattern, and the second line transforms
165	the message into vi commands to load the file.
166
167	=item readline
168		157
169	A support package that tries to make editing with readline easier. At the	158	A support package that tries to make editing with readline easier. At the
170	moment, it reacts to clicking with the left mouse button by trying to	159	moment, it reacts to clicking with the left mouse button by trying to
171	move the text cursor to this position. It does so by generating as many	160	move the text cursor to this position. It does so by generating as many
172	cursor-left or cursor-right keypresses as required (the this only works	161	cursor-left or cursor-right keypresses as required (the this only works
173	for programs that correctly support wide characters).	162	for programs that correctly support wide characters).
174		163
175	It only works when clicking into the same line (possibly extended over	164	To avoid too many false positives, this is only done when:
176	multiple rows) as the text cursor and on the primary screen, to reduce the	165
177	risk of misinterpreting. The normal selection isn't disabled, so quick	166	=over 4
		167
		168	=item - the tty is in ICANON state.
		169
		170	=item - the text cursor is visible.
		171
		172	=item - the primary screen is currently being displayed.
		173
		174	=item - the mouse is on the same (multi-row-) line as the text cursor.
		175
		176	=back
		177
		178	The normal selection mechanism isn't disabled, so quick successive clicks
178	successive clicks might interfere with selection creation in harmless	179	might interfere with selection creation in harmless ways.
179	ways.	180
		181	=item selection-autotransform
		182
		183	This selection allows you to do automatic transforms on a selection
		184	whenever a selection is made.
		185
		186	It works by specifying perl snippets (most useful is a single C<s///>
		187	operator) that modify C<$_> as resources:
		188
		189	URxvt.selection-autotransform.0: transform
		190	URxvt.selection-autotransform.1: transform
		191	...
		192
		193	For example, the following will transform selections of the form
		194	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		195	$word>:
		196
		197	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		198
		199	And this example matches the same,but replaces it with vi-commands you can
		200	paste directly into your (vi :) editor:
		201
		202	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		203
		204	Of course, this can be modified to suit your needs and your editor :)
		205
		206	To expand the example above to typical perl error messages ("XXX at
		207	FILENAME line YYY."), you need a slightly more elaborate solution:
		208
		209	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		210	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		211
		212	The first line tells the selection code to treat the unchanging part of
		213	every error message as a selection pattern, and the second line transforms
		214	the message into vi commands to load the file.
180		215
181	=item tabbed	216	=item tabbed
182		217
183	This transforms the terminal into a tabbar with additional terminals, that	218	This transforms the terminal into a tabbar with additional terminals, that
184	is, it implements what is commonly refered to as "tabbed terminal". The topmost line	219	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
…		…
187		222
188	Clicking a button will activate that tab. Pressing B<Shift-Left> and	223	Clicking a button will activate that tab. Pressing B<Shift-Left> and
189	B<Shift-Right> will switch to the tab left or right of the current one,	224	B<Shift-Right> will switch to the tab left or right of the current one,
190	while B<Shift-Down> creates a new tab.	225	while B<Shift-Down> creates a new tab.
191		226
		227	The tabbar itself can be configured similarly to a normal terminal, but
		228	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		229	following four resources (shown with defaults):
		230
		231	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		232	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		233	URxvt.tabbed.tab-fg: <colour-index, default 0>
		234	URxvt.tabbed.tab-bg: <colour-index, default 1>
		235
		236	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		237	indices.
		238
192	=item mark-urls	239	=item mark-urls
193		240
194	Uses per-line display filtering (C<on_line_update>) to underline urls and	241	Uses per-line display filtering (C<on_line_update>) to underline urls and
195	make them clickable. When middle-clicked, the program specified in the	242	make them clickable. When middle-clicked, the program specified in the
196	resource C<urlLauncher> (default C<x-www-browser>) will be started with	243	resource C<urlLauncher> (default C<x-www-browser>) will be started with
197	the URL as first argument.	244	the URL as first argument.
198		245
		246	=item xim-onthespot
		247
		248	This (experimental) perl extension implements OnTheSpot editing. It does
		249	not work perfectly, and some input methods don't seem to work well with
		250	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		251	kinput2.
		252
		253	You enable it by specifying this extension and a preedit style of
		254	C<OnTheSpot>, i.e.:
		255
		256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		257
199	=item automove-background	258	=item automove-background
200		259
201	This is basically a one-line extension that dynamically changes the background pixmap offset	260	This is basically a one-line extension that dynamically changes the background pixmap offset
202	to the window position, in effect creating the same effect as pseudo transparency with	261	to the window position, in effect creating the same effect as pseudo transparency with
203	a custom pixmap. No scaling is supported in this mode. Exmaple:	262	a custom pixmap. No scaling is supported in this mode. Exmaple:
…		…
212		271
213	=item digital-clock	272	=item digital-clock
214		273
215	Displays a digital clock using the built-in overlay.	274	Displays a digital clock using the built-in overlay.
216		275
217	=item example-refresh-hooks	276	=item remote-clipboard
218		277
219	Displays a very simple digital clock in the upper right corner of the	278	Somewhat of a misnomer, this extension adds two menu entries to the
220	window. Illustrates overwriting the refresh callbacks to create your own	279	selection popup that allows one ti run external commands to store the
221	overlays or changes.	280	selection somewhere and fetch it again.
		281
		282	We use it to implement a "distributed selection mechanism", which just
		283	means that one command uploads the file to a remote server, and another
		284	reads it.
		285
		286	The commands can be set using the C<URxvt.remote-selection.store> and
		287	C<URxvt.remote-selection.fetch> resources. The first should read the
		288	selection to store from STDIN (always in UTF-8), the second should provide
		289	the selection data on STDOUT (also in UTF-8).
		290
		291	The defaults (which are likely useless to you) use rsh and cat:
		292
		293	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		294	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
222		295
223	=item selection-pastebin	296	=item selection-pastebin
224		297
225	This is a little rarely useful extension that Uploads the selection as	298	This is a little rarely useful extension that Uploads the selection as
226	textfile to a remote site (or does other things). (The implementation is	299	textfile to a remote site (or does other things). (The implementation is
…		…
246	After a successful upload the selection will be replaced by the text given	319	After a successful upload the selection will be replaced by the text given
247	in the C<selection-pastebin-url> resource (again, the % is the placeholder	320	in the C<selection-pastebin-url> resource (again, the % is the placeholder
248	for the filename):	321	for the filename):
249		322
250	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	323	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		324
		325	=item example-refresh-hooks
		326
		327	Displays a very simple digital clock in the upper right corner of the
		328	window. Illustrates overwriting the refresh callbacks to create your own
		329	overlays or changes.
251		330
252	=back	331	=back
253		332
254	=head1 API DOCUMENTATION	333	=head1 API DOCUMENTATION
255		334
…		…
352	Called at the very end of initialisation of a new terminal, just before	431	Called at the very end of initialisation of a new terminal, just before
353	trying to map (display) the toplevel and returning to the mainloop.	432	trying to map (display) the toplevel and returning to the mainloop.
354		433
355	=item on_destroy $term	434	=item on_destroy $term
356		435
357	Called whenever something tries to destroy terminal, before doing anything	436	Called whenever something tries to destroy terminal, when the terminal is
358	yet. If this hook returns true, then destruction is skipped, but this is	437	still fully functional (not for long, though).
359	rarely a good idea.
360		438
361	=item on_reset $term	439	=item on_reset $term
362		440
363	Called after the screen is "reset" for any reason, such as resizing or	441	Called after the screen is "reset" for any reason, such as resizing or
364	control sequences. Here is where you can react on changes to size-related	442	control sequences. Here is where you can react on changes to size-related
…		…
466		544
467	=item on_refresh_end $term	545	=item on_refresh_end $term
468		546
469	Called just after the screen gets redrawn. See C<on_refresh_begin>.	547	Called just after the screen gets redrawn. See C<on_refresh_begin>.
470		548
471	=item on_keyboard_command $term, $string	549	=item on_user_command $term, $string
472		550
473	Called whenever the user presses a key combination that has a	551	Called whenever the a user-configured event is being activated (e.g. via
474	C<perl:string> action bound to it (see description of the B<keysym>	552	a C<perl:string> action bound to a key, see description of the B<keysym>
475	resource in the @@RXVT_NAME@@(1) manpage).	553	resource in the @@RXVT_NAME@@(1) manpage).
		554
		555	The event is simply the action string. This interface is assumed to change
		556	slightly in the future.
476		557
477	=item on_x_event $term, $event	558	=item on_x_event $term, $event
478		559
479	Called on every X event received on the vt window (and possibly other	560	Called on every X event received on the vt window (and possibly other
480	windows). Should only be used as a last resort. Most event structure	561	windows). Should only be used as a last resort. Most event structure
…		…
552	our $LIBDIR;	633	our $LIBDIR;
553	our $RESNAME;	634	our $RESNAME;
554	our $RESCLASS;	635	our $RESCLASS;
555	our $RXVTNAME;	636	our $RXVTNAME;
556		637
557	our $NOCHAR = chr 0xfffe;	638	our $NOCHAR = chr 0xffff;
558		639
559	=head2 Variables in the C<urxvt> Package	640	=head2 Variables in the C<urxvt> Package
560		641
561	=over 4	642	=over 4
562		643
…		…
614		695
615	Using this function has the advantage that its output ends up in the	696	Using this function has the advantage that its output ends up in the
616	correct place, e.g. on stderr of the connecting urxvtc client.	697	correct place, e.g. on stderr of the connecting urxvtc client.
617		698
618	Messages have a size limit of 1023 bytes currently.	699	Messages have a size limit of 1023 bytes currently.
		700
		701	=item @terms = urxvt::termlist
		702
		703	Returns all urxvt::term objects that exist in this process, regardless of
		704	wether they are started, being destroyed etc., so be careful. Only term
		705	objects that have perl extensions attached will be returned (because there
		706	is no urxvt::term objet associated with others).
619		707
620	=item $time = urxvt::NOW	708	=item $time = urxvt::NOW
621		709
622	Returns the "current time" (as per the event loop).	710	Returns the "current time" (as per the event loop).
623		711
…		…
681	Return the foreground/background colour index, respectively.	769	Return the foreground/background colour index, respectively.
682		770
683	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	771	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
684		772
685	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	773	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		774
		775	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
686		776
687	Replace the foreground/background colour in the rendition mask with the	777	Replace the foreground/background colour in the rendition mask with the
688	specified one.	778	specified one.
689		779
690	=item $value = urxvt::GET_CUSTOM $rend	780	=item $value = urxvt::GET_CUSTOM $rend
…		…
709	unless $msg =~ /\n$/;	799	unless $msg =~ /\n$/;
710	urxvt::warn ($msg);	800	urxvt::warn ($msg);
711	};	801	};
712	}	802	}
713		803
		804	no warnings 'utf8';
		805
714	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	806	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
715		807
716	sub verbose {	808	sub verbose {
717	my ($level, $msg) = @_;	809	my ($level, $msg) = @_;
718	warn "$msg\n" if $level <= $verbosity;	810	warn "$msg\n" if $level <= $verbosity;
…		…
734		826
735	open my $fh, "<:raw", $path	827	open my $fh, "<:raw", $path
736	or die "$path: $!";	828	or die "$path: $!";
737		829
738	my $source =	830	my $source =
739	"package $pkg; use strict; use utf8;\n"	831	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
740	. "#line 1 \"$path\"\n{\n"	832	. "#line 1 \"$path\"\n{\n"
741	. (do { local $/; <$fh> })	833	. (do { local $/; <$fh> })
742	. "\n};\n1";	834	. "\n};\n1";
743		835
744	eval $source	836	eval $source
…		…
769	$TERM->register_package ($_) for @pkg;	861	$TERM->register_package ($_) for @pkg;
770	}	862	}
771		863
772	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	864	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
773	if ($_ eq "default") {	865	if ($_ eq "default") {
774	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	866	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
775	} elsif (/^-(.*)$/) {	867	} elsif (/^-(.*)$/) {
776	delete $ext_arg{$1};	868	delete $ext_arg{$1};
777	} elsif (/^([^<]+)<(.*)>$/) {	869	} elsif (/^([^<]+)<(.*)>$/) {
778	push @{ $ext_arg{$1} }, $2;	870	push @{ $ext_arg{$1} }, $2;
779	} else {	871	} else {
780	$ext_arg{$_} \|\|= [];	872	$ext_arg{$_} \|\|= [];
781	}	873	}
782	}	874	}
783		875
784	while (my ($ext, $argv) = each %ext_arg) {	876	for my $ext (sort keys %ext_arg) {
785	my @files = grep -f $_, map "$_/$ext", @dirs;	877	my @files = grep -f $_, map "$_/$ext", @dirs;
786		878
787	if (@files) {	879	if (@files) {
788	$TERM->register_package (extension_package $files[0], $argv);	880	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
789	} else {	881	} else {
790	warn "perl extension '$ext' not found in perl library search path\n";	882	warn "perl extension '$ext' not found in perl library search path\n";
791	}	883	}
792	}	884	}
793		885
…		…
824	# clear package	916	# clear package
825	%$TERM = ();	917	%$TERM = ();
826	}	918	}
827		919
828	$retval	920	$retval
		921	}
		922
		923	sub SET_COLOR($$$) {
		924	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
829	}	925	}
830		926
831	# urxvt::term::extension	927	# urxvt::term::extension
832		928
833	package urxvt::term::extension;	929	package urxvt::term::extension;
…		…
1002	hash which defines the environment of the new terminal.	1098	hash which defines the environment of the new terminal.
1003		1099
1004	Croaks (and probably outputs an error message) if the new instance	1100	Croaks (and probably outputs an error message) if the new instance
1005	couldn't be created. Returns C<undef> if the new instance didn't	1101	couldn't be created. Returns C<undef> if the new instance didn't
1006	initialise perl, and the terminal object otherwise. The C<init> and	1102	initialise perl, and the terminal object otherwise. The C<init> and
1007	C<start> hooks will be called during this call.	1103	C<start> hooks will be called before this call returns, and are free to
		1104	refer to global data (which is race free).
1008		1105
1009	=cut	1106	=cut
1010		1107
1011	sub new {	1108	sub new {
1012	my ($class, $env, @args) = @_;	1109	my ($class, $env, @args) = @_;
1013		1110
		1111	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1112	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1113
1014	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1114	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1015	}	1115	}
1016		1116
1017	=item $term->destroy	1117	=item $term->destroy
1018		1118
1019	Destroy the terminal object (close the window, free resources	1119	Destroy the terminal object (close the window, free resources
…		…
1299	Replaces the event mask of the pty watcher by the given event mask. Can	1399	Replaces the event mask of the pty watcher by the given event mask. Can
1300	be used to suppress input and output handling to the pty/tty. See the	1400	be used to suppress input and output handling to the pty/tty. See the
1301	description of C<< urxvt::timer->events >>. Make sure to always restore	1401	description of C<< urxvt::timer->events >>. Make sure to always restore
1302	the previous value.	1402	the previous value.
1303		1403
		1404	=item $fd = $term->pty_fd
		1405
		1406	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1407	is used.
		1408
1304	=item $windowid = $term->parent	1409	=item $windowid = $term->parent
1305		1410
1306	Return the window id of the toplevel window.	1411	Return the window id of the toplevel window.
1307		1412
1308	=item $windowid = $term->vt	1413	=item $windowid = $term->vt
…		…
1313		1418
1314	Adds the specified events to the vt event mask. Useful e.g. when you want	1419	Adds the specified events to the vt event mask. Useful e.g. when you want
1315	to receive pointer events all the times:	1420	to receive pointer events all the times:
1316		1421
1317	$term->vt_emask_add (urxvt::PointerMotionMask);	1422	$term->vt_emask_add (urxvt::PointerMotionMask);
		1423
		1424	=item $term->focus_in
		1425
		1426	=item $term->focus_out
		1427
		1428	=item $term->key_press ($state, $keycode[, $time])
		1429
		1430	=item $term->key_release ($state, $keycode[, $time])
		1431
		1432	Deliver various fake events to to terminal.
1318		1433
1319	=item $window_width = $term->width	1434	=item $window_width = $term->width
1320		1435
1321	=item $window_height = $term->height	1436	=item $window_height = $term->height
1322		1437
…		…
1376		1491
1377	=item $screen = $term->current_screen	1492	=item $screen = $term->current_screen
1378		1493
1379	Returns the currently displayed screen (0 primary, 1 secondary).	1494	Returns the currently displayed screen (0 primary, 1 secondary).
1380		1495
		1496	=item $cursor_is_hidden = $term->hidden_cursor
		1497
		1498	Returns wether the cursor is currently hidden or not.
		1499
1381	=item $view_start = $term->view_start ([$newvalue])	1500	=item $view_start = $term->view_start ([$newvalue])
1382		1501
1383	Returns the row number of the topmost displayed line. Maximum value is	1502	Returns the row number of the topmost displayed line. Maximum value is
1384	C<0>, which displays the normal terminal contents. Lower values scroll	1503	C<0>, which displays the normal terminal contents. Lower values scroll
1385	this many lines into the scrollback buffer.	1504	this many lines into the scrollback buffer.
…		…
1403	If C<$new_text> is specified, it will replace characters in the current	1522	If C<$new_text> is specified, it will replace characters in the current
1404	line, starting at column C<$start_col> (default C<0>), which is useful	1523	line, starting at column C<$start_col> (default C<0>), which is useful
1405	to replace only parts of a line. The font index in the rendition will	1524	to replace only parts of a line. The font index in the rendition will
1406	automatically be updated.	1525	automatically be updated.
1407		1526
1408	C<$text> is in a special encoding: tabs and wide characters that use	1527	C<$text> is in a special encoding: tabs and wide characters that use more
1409	more than one cell when displayed are padded with C<$urxvt::NOCHAR>	1528	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1410	characters. Characters with combining characters and other characters that	1529	characters. Characters with combining characters and other characters that
1411	do not fit into the normal tetx encoding will be replaced with characters	1530	do not fit into the normal tetx encoding will be replaced with characters
1412	in the private use area.	1531	in the private use area.
1413		1532
1414	You have to obey this encoding when changing text. The advantage is	1533	You have to obey this encoding when changing text. The advantage is
…		…
1564	=item $string = $term->special_decode $text	1683	=item $string = $term->special_decode $text
1565		1684
1566	Converts rxvt-unicodes text reprsentation into a perl string. See	1685	Converts rxvt-unicodes text reprsentation into a perl string. See
1567	C<< $term->ROW_t >> for details.	1686	C<< $term->ROW_t >> for details.
1568		1687
1569	=item $success = $term->grab_button ($button, $modifiermask)	1688	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1570		1689
		1690	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1691
1571	Registers a synchronous button grab. See the XGrabButton manpage.	1692	Register/unregister a synchronous button grab. See the XGrabButton
		1693	manpage.
1572		1694
1573	=item $success = $term->grab ($eventtime[, $sync])	1695	=item $success = $term->grab ($eventtime[, $sync])
1574		1696
1575	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1697	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1576	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1698	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1694	my ($self, $text, $cb) = @_;	1816	my ($self, $text, $cb) = @_;
1695		1817
1696	$self->add_item ({ type => "button", text => $text, activate => $cb});	1818	$self->add_item ({ type => "button", text => $text, activate => $cb});
1697	}	1819	}
1698		1820
1699	=item $popup->add_toggle ($text, $cb, $initial_value)	1821	=item $popup->add_toggle ($text, $initial_value, $cb)
1700		1822
1701	Adds a toggle/checkbox item to the popup. Teh callback gets called	1823	Adds a toggle/checkbox item to the popup. The callback gets called
1702	whenever it gets toggled, with a boolean indicating its value as its first	1824	whenever it gets toggled, with a boolean indicating its new value as its
1703	argument.	1825	first argument.
1704		1826
1705	=cut	1827	=cut
1706		1828
1707	sub add_toggle {	1829	sub add_toggle {
1708	my ($self, $text, $cb, $value) = @_;	1830	my ($self, $text, $value, $cb) = @_;
1709		1831
1710	my $item; $item = {	1832	my $item; $item = {
1711	type => "button",	1833	type => "button",
1712	text => " $text",	1834	text => " $text",
1713	value => $value,	1835	value => $value,

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC vs. Revision 1.133 by root, Mon Feb 6 06:14:08 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC vs.
Revision 1.133 by root, Mon Feb 6 06:14:08 2006 UTC