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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs.
Revision 1.85 by root, Thu Jan 12 03:32:56 2006 UTC

…		…
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection (enabled by default)	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click). Right now, it tries to
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	select urls and complete shell-quoted arguments, which is very convenient,
47	if your F<ls> supports C<--quoting-style=shell>.	47	too, if your F<ls> supports C<--quoting-style=shell>.
48		48
49	It also offers the following bindable event:	49	It also offers the following bindable keyboard command:
50		50
51	=over 4	51	=over 4
52		52
53	=item rot13	53	=item rot13
54		54
…		…
64	runtime.	64	runtime.
65		65
66	=item selection-popup (enabled by default)	66	=item selection-popup (enabled by default)
67		67
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	69	text into various other formats/action (such as uri unescaping, perl
		70	evalution, web-browser starting etc.), depending on content.
70		71
71	=item searchable-scrollback (enabled by default)	72	=item searchable-scrollback<hotkey> (enabled by default)
72		73
73	Adds regex search functionality to the scrollback buffer, triggered by a	74	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	75	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		76	input/output is suspended.
		77
75	suspended, C</> starts an incremental regex search, C<n> searches further,	78	C</> starts an incremental regex search, C<n> searches further, C<p> or
76	C<p> jumps to the previous match. C<enter> leaves search mode at the	79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
77	current position and C<escape> returns to the original position.	80	history, C<enter> leaves search mode at the current position and C<escape>
		81	returns to the original position.
78		82
79	=item digital-clock	83	=item digital-clock
80		84
81	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
82		86
83	=item mark-urls	87	=item mark-urls
84		88
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	89	Uses per-line display filtering (C<on_line_update>) to underline urls and
		90	make them clickable. When middle-clicked, the program specified in the
		91	resource C<urlLauncher> (default C<x-www-browser>) will be started.
86		92
87	=item block-graphics-to-ascii	93	=item block-graphics-to-ascii
88		94
89	A not very useful example of filtering all text output to the terminal,	95	A not very useful example of filtering all text output to the terminal,
90	by replacing all line-drawing characters (U+2500 .. U+259F) by a	96	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
95	Displays a very simple digital clock in the upper right corner of the	101	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	102	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	103	overlays or changes.
98		104
99	=back	105	=back
		106
		107	=head1 API DOCUMENTATION
100		108
101	=head2 General API Considerations	109	=head2 General API Considerations
102		110
103	All objects (such as terminals, time watchers etc.) are typical	111	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	112	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	125	=over 4
118		126
119	=item $text	127	=item $text
120		128
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	129	Rxvt-unicodes special way of encoding text, where one "unicode" character
122	always represents one screen cell. See L<row_t> for a discussion of this format.	130	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		131
124	=item $string	132	=item $string
125		133
126	A perl text string, with an emphasis on I<text>. It can store all unicode	134	A perl text string, with an emphasis on I<text>. It can store all unicode
127	characters and is to be distinguished with text encoded in a specific	135	characters and is to be distinguished with text encoded in a specific
…		…
222	=item on_sel_extend $term	230	=item on_sel_extend $term
223		231
224	Called whenever the user tries to extend the selection (e.g. with a double	232	Called whenever the user tries to extend the selection (e.g. with a double
225	click) and is either supposed to return false (normal operation), or	233	click) and is either supposed to return false (normal operation), or
226	should extend the selection itelf and return true to suppress the built-in	234	should extend the selection itelf and return true to suppress the built-in
227	processing.	235	processing. This can happen multiple times, as long as the callback
		236	returns true, it will be called on every further click by the user and is
		237	supposed to enlarge the selection more and more, if possible.
228		238
229	See the F<selection> example extension.	239	See the F<selection> example extension.
230		240
231	=item on_view_change $term, $offset	241	=item on_view_change $term, $offset
232		242
…		…
337		347
338	subwindow.	348	subwindow.
339		349
340	=back	350	=back
341		351
342	=head2 Variables in the C<urxvt> Package
343
344	=over 4
345
346	=item $urxvt::TERM
347
348	The current terminal. This variable stores the current C<urxvt::term>
349	object, whenever a callback/hook is executing.
350
351	=back
352
353	=head2 Functions in the C<urxvt> Package
354
355	=over 4
356
357	=item $term = new urxvt [arg...]
358
359	Creates a new terminal, very similar as if you had started it with
360	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
361	if the new instance couldn't be created. Returns C<undef> if the new
362	instance didn't initialise perl, and the terminal object otherwise. The
363	C<init> and C<start> hooks will be called during the call.
364
365	=item urxvt::fatal $errormessage
366
367	Fatally aborts execution with the given error message. Avoid at all
368	costs! The only time this is acceptable is when the terminal process
369	starts up.
370
371	=item urxvt::warn $string
372
373	Calls C<rxvt_warn> with the given string which should not include a
374	newline. The module also overwrites the C<warn> builtin with a function
375	that calls this function.
376
377	Using this function has the advantage that its output ends up in the
378	correct place, e.g. on stderr of the connecting urxvtc client.
379
380	=item $is_safe = urxvt::safe
381
382	Returns true when it is safe to do potentially unsafe things, such as
383	evaluating perl code specified by the user. This is true when urxvt was
384	started setuid or setgid.
385
386	=item $time = urxvt::NOW
387
388	Returns the "current time" (as per the event loop).
389
390	=item urxvt::CurrentTime
391
392	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
393	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
394	Button4Mask, Button5Mask, AnyModifier
395
396	Various constants for use in X calls and event processing.
397
398	=back
399
400	=head2 RENDITION
401
402	Rendition bitsets contain information about colour, font, font styles and
403	similar information for each screen cell.
404
405	The following "macros" deal with changes in rendition sets. You should
406	never just create a bitset, you should always modify an existing one,
407	as they contain important information required for correct operation of
408	rxvt-unicode.
409
410	=over 4
411
412	=item $rend = urxvt::DEFAULT_RSTYLE
413
414	Returns the default rendition, as used when the terminal is starting up or
415	being reset. Useful as a base to start when creating renditions.
416
417	=item $rend = urxvt::OVERLAY_RSTYLE
418
419	Return the rendition mask used for overlays by default.
420
421	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
422
423	Return the bit that enabled bold, italic, blink, reverse-video and
424	underline, respectively. To enable such a style, just logically OR it into
425	the bitset.
426
427	=item $foreground = urxvt::GET_BASEFG $rend
428
429	=item $background = urxvt::GET_BASEBG $rend
430
431	Return the foreground/background colour index, respectively.
432
433	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
434
435	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
436
437	Replace the foreground/background colour in the rendition mask with the
438	specified one.
439
440	=item $value = urxvt::GET_CUSTOM ($rend)
441
442	Return the "custom" value: Every rendition has 5 bits for use by
443	extensions. They can be set and changed as you like and are initially
444	zero.
445
446	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
447
448	Change the custom value.
449
450	=back
451
452	=cut	352	=cut
453		353
454	package urxvt;	354	package urxvt;
455		355
456	use utf8;	356	use utf8;
…		…
467		367
468	our $LIBDIR;	368	our $LIBDIR;
469	our $RESNAME;	369	our $RESNAME;
470	our $RESCLASS;	370	our $RESCLASS;
471	our $RXVTNAME;	371	our $RXVTNAME;
		372
		373	=head2 Variables in the C<urxvt> Package
		374
		375	=over 4
		376
		377	=item $urxvt::LIBDIR
		378
		379	The rxvt-unicode library directory, where, among other things, the perl
		380	modules and scripts are stored.
		381
		382	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		383
		384	The resource class and name rxvt-unicode uses to look up X resources.
		385
		386	=item $urxvt::RXVTNAME
		387
		388	The basename of the installed binaries, usually C<urxvt>.
		389
		390	=item $urxvt::TERM
		391
		392	The current terminal. This variable stores the current C<urxvt::term>
		393	object, whenever a callback/hook is executing.
		394
		395	=back
		396
		397	=head2 Functions in the C<urxvt> Package
		398
		399	=over 4
		400
		401	=item urxvt::fatal $errormessage
		402
		403	Fatally aborts execution with the given error message. Avoid at all
		404	costs! The only time this is acceptable is when the terminal process
		405	starts up.
		406
		407	=item urxvt::warn $string
		408
		409	Calls C<rxvt_warn> with the given string which should not include a
		410	newline. The module also overwrites the C<warn> builtin with a function
		411	that calls this function.
		412
		413	Using this function has the advantage that its output ends up in the
		414	correct place, e.g. on stderr of the connecting urxvtc client.
		415
		416	Messages have a size limit of 1023 bytes currently.
		417
		418	=item $is_safe = urxvt::safe
		419
		420	Returns true when it is safe to do potentially unsafe things, such as
		421	evaluating perl code specified by the user. This is true when urxvt was
		422	started setuid or setgid.
		423
		424	=item $time = urxvt::NOW
		425
		426	Returns the "current time" (as per the event loop).
		427
		428	=item urxvt::CurrentTime
		429
		430	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		431	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		432	Button4Mask, Button5Mask, AnyModifier
		433
		434	Various constants for use in X calls and event processing.
		435
		436	=back
		437
		438	=head2 RENDITION
		439
		440	Rendition bitsets contain information about colour, font, font styles and
		441	similar information for each screen cell.
		442
		443	The following "macros" deal with changes in rendition sets. You should
		444	never just create a bitset, you should always modify an existing one,
		445	as they contain important information required for correct operation of
		446	rxvt-unicode.
		447
		448	=over 4
		449
		450	=item $rend = urxvt::DEFAULT_RSTYLE
		451
		452	Returns the default rendition, as used when the terminal is starting up or
		453	being reset. Useful as a base to start when creating renditions.
		454
		455	=item $rend = urxvt::OVERLAY_RSTYLE
		456
		457	Return the rendition mask used for overlays by default.
		458
		459	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		460
		461	Return the bit that enabled bold, italic, blink, reverse-video and
		462	underline, respectively. To enable such a style, just logically OR it into
		463	the bitset.
		464
		465	=item $foreground = urxvt::GET_BASEFG $rend
		466
		467	=item $background = urxvt::GET_BASEBG $rend
		468
		469	Return the foreground/background colour index, respectively.
		470
		471	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		472
		473	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		474
		475	Replace the foreground/background colour in the rendition mask with the
		476	specified one.
		477
		478	=item $value = urxvt::GET_CUSTOM $rend
		479
		480	Return the "custom" value: Every rendition has 5 bits for use by
		481	extensions. They can be set and changed as you like and are initially
		482	zero.
		483
		484	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		485
		486	Change the custom value.
		487
		488	=back
		489
		490	=cut
472		491
473	BEGIN {	492	BEGIN {
474	urxvt->bootstrap;	493	urxvt->bootstrap;
475		494
476	# overwrite perl's warn	495	# overwrite perl's warn
…		…
479	$msg .= "\n"	498	$msg .= "\n"
480	unless $msg =~ /\n$/;	499	unless $msg =~ /\n$/;
481	urxvt::warn ($msg);	500	urxvt::warn ($msg);
482	};	501	};
483		502
		503	# %ENV is the original startup environment
484	delete $ENV{IFS};	504	delete $ENV{IFS};
485	delete $ENV{CDPATH};	505	delete $ENV{CDPATH};
486	delete $ENV{BASH_ENV};	506	delete $ENV{BASH_ENV};
487	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	507	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
488	}	508	}
…		…
577	if ($@) {	597	if ($@) {
578	$TERM->ungrab; # better to lose the grab than the session	598	$TERM->ungrab; # better to lose the grab than the session
579	warn $@;	599	warn $@;
580	}	600	}
581	}	601	}
		602
		603	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		604	if $verbosity >= 11;
582	}	605	}
583		606
584	if ($htype == 1) { # DESTROY	607	if ($htype == 1) { # DESTROY
585	if (my $hook = delete $TERM->{_hook}) {	608	if (my $hook = delete $TERM->{_hook}) {
586	for my $htype (0..$#$hook) {	609	for my $htype (0..$#$hook) {
…		…
597	}	620	}
598		621
599	$retval	622	$retval
600	}	623	}
601		624
		625	sub exec_async(@) {
		626	my $pid = fork;
		627
		628	return
		629	if !defined $pid or $pid;
		630
		631	%ENV = %{ $TERM->env };
		632
		633	exec @_;
		634	_exit 255;
		635	}
		636
602	# urxvt::term::extension	637	# urxvt::term::extension
603		638
604	package urxvt::term::extension;	639	package urxvt::term::extension;
605		640
606	sub enable {	641	sub enable {
…		…
672		707
673	=head2 The C<urxvt::anyevent> Class	708	=head2 The C<urxvt::anyevent> Class
674		709
675	The sole purpose of this class is to deliver an interface to the	710	The sole purpose of this class is to deliver an interface to the
676	C<AnyEvent> module - any module using it will work inside urxvt without	711	C<AnyEvent> module - any module using it will work inside urxvt without
677	further work. The only exception is that you cannot wait on condition	712	further programming. The only exception is that you cannot wait on
678	variables, but non-blocking condvar use is ok. What this means is that you	713	condition variables, but non-blocking condvar use is ok. What this means
679	cannot use blocking APIs, but the non-blocking variant should work.	714	is that you cannot use blocking APIs, but the non-blocking variant should
		715	work.
680		716
681	=cut	717	=cut
682		718
683	our $VERSION = 1;	719	our $VERSION = 1;
684		720
…		…
761	$proxy->enable ($name => $ref);	797	$proxy->enable ($name => $ref);
762	}	798	}
763	}	799	}
764	}	800	}
765		801
		802	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		803
		804	Creates a new terminal, very similar as if you had started it with system
		805	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		806	hash which defines the environment of the new terminal.
		807
		808	Croaks (and probably outputs an error message) if the new instance
		809	couldn't be created. Returns C<undef> if the new instance didn't
		810	initialise perl, and the terminal object otherwise. The C<init> and
		811	C<start> hooks will be called during this call.
		812
		813	=cut
		814
		815	sub new {
		816	my ($class, $env, @args) = @_;
		817
		818	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		819	}
		820
766	=item $term->destroy	821	=item $term->destroy
767		822
768	Destroy the terminal object (close the window, free resources etc.).	823	Destroy the terminal object (close the window, free resources
		824	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		825	watchers (timers, io watchers) are still active.
769		826
770	=item $isset = $term->option ($optval[, $set])	827	=item $isset = $term->option ($optval[, $set])
771		828
772	Returns true if the option specified by C<$optval> is enabled, and	829	Returns true if the option specified by C<$optval> is enabled, and
773	optionally change it. All option values are stored by name in the hash	830	optionally change it. All option values are stored by name in the hash
…		…
823	my ($self, $name) = (shift, shift);	880	my ($self, $name) = (shift, shift);
824	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	881	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
825	&urxvt::term::_resource	882	&urxvt::term::_resource
826	}	883	}
827		884
		885	=item $value = $term->x_resource ($pattern)
		886
		887	Returns the X-Resource for the given pattern, excluding the program or
		888	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		889	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		890	resource with that pattern exists.
		891
		892	This method should only be called during the C<on_start> hook, as there is
		893	only one resource database per display, and later invocations might return
		894	the wrong resources.
		895
828	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	896	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
829		897
830	Adds a keymap translation exactly as specified via a resource. See the	898	Adds a keymap translation exactly as specified via a resource. See the
831	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	899	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
832		900
…		…
1031		1099
1032	=item $lines_in_scrollback = $term->nsaved	1100	=item $lines_in_scrollback = $term->nsaved
1033		1101
1034	Return various integers describing terminal characteristics.	1102	Return various integers describing terminal characteristics.
1035		1103
		1104	=item $x_display = $term->display_id
		1105
		1106	Return the DISPLAY used by rxvt-unicode.
		1107
1036	=item $lc_ctype = $term->locale	1108	=item $lc_ctype = $term->locale
1037		1109
1038	Returns the LC_CTYPE category string used by this rxvt-unicode.	1110	Returns the LC_CTYPE category string used by this rxvt-unicode.
1039		1111
1040	=item $x_display = $term->display_id	1112	=item $env = $term->env
1041		1113
1042	Return the DISPLAY used by rxvt-unicode.	1114	Returns a copy of the environment in effect for the terminal as a hashref
		1115	similar to C<\%ENV>.
		1116
		1117	=cut
		1118
		1119	sub env {
		1120	if (my $env = $_[0]->_env) {
		1121	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1122	} else {
		1123	+{ %ENV }
		1124	}
		1125	}
1043		1126
1044	=item $modifiermask = $term->ModLevel3Mask	1127	=item $modifiermask = $term->ModLevel3Mask
1045		1128
1046	=item $modifiermask = $term->ModMetaMask	1129	=item $modifiermask = $term->ModMetaMask
1047		1130
…		…
1140	Return the row number of the first/last row of the line, respectively.	1223	Return the row number of the first/last row of the line, respectively.
1141		1224
1142	=item $offset = $line->offset_of ($row, $col)	1225	=item $offset = $line->offset_of ($row, $col)
1143		1226
1144	Returns the character offset of the given row\|col pair within the logical	1227	Returns the character offset of the given row\|col pair within the logical
1145	line.	1228	line. Works for rows outside the line, too, and returns corresponding
		1229	offsets outside the string.
1146		1230
1147	=item ($row, $col) = $line->coord_of ($offset)	1231	=item ($row, $col) = $line->coord_of ($offset)
1148		1232
1149	Translates a string offset into terminal coordinates again.	1233	Translates a string offset into terminal coordinates again.
1150		1234
…		…
1287	$item->{render} \|\|= sub { $_[0]{text} };	1371	$item->{render} \|\|= sub { $_[0]{text} };
1288		1372
1289	push @{ $self->{item} }, $item;	1373	push @{ $self->{item} }, $item;
1290	}	1374	}
1291		1375
		1376	=item $popup->add_title ($title)
		1377
		1378	Adds a non-clickable title to the popup.
		1379
		1380	=cut
		1381
		1382	sub add_title {
		1383	my ($self, $title) = @_;
		1384
		1385	$self->add_item ({
		1386	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1387	text => $title,
		1388	activate => sub { },
		1389	});
		1390	}
		1391
		1392	=item $popup->add_separator ([$sepchr])
		1393
		1394	Creates a separator, optionally using the character given as C<$sepchr>.
		1395
		1396	=cut
		1397
1292	sub add_separator {	1398	sub add_separator {
1293	my ($self, $sep) = @_;	1399	my ($self, $sep) = @_;
1294		1400
1295	$sep \|\|= "=";	1401	$sep \|\|= "=";
1296		1402
…		…
1300	render => sub { $sep x $self->{term}->ncol },	1406	render => sub { $sep x $self->{term}->ncol },
1301	activate => sub { },	1407	activate => sub { },
1302	});	1408	});
1303	}	1409	}
1304		1410
1305	sub add_title {	1411	=item $popup->add_button ($text, $cb)
1306	my ($self, $title) = @_;
1307		1412
1308	$self->add_item ({	1413	Adds a clickable button to the popup. C<$cb> is called whenever it is
1309	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1414	selected.
1310	text => $title,	1415
1311	activate => sub { },	1416	=cut
1312	});
1313	}
1314		1417
1315	sub add_button {	1418	sub add_button {
1316	my ($self, $text, $cb) = @_;	1419	my ($self, $text, $cb) = @_;
1317		1420
1318	$self->add_item ({ type => "button", text => $text, activate => $cb});	1421	$self->add_item ({ type => "button", text => $text, activate => $cb});
1319	}	1422	}
		1423
		1424	=item $popup->add_toggle ($text, $cb, $initial_value)
		1425
		1426	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1427	whenever it gets toggled, with a boolean indicating its value as its first
		1428	argument.
		1429
		1430	=cut
1320		1431
1321	sub add_toggle {	1432	sub add_toggle {
1322	my ($self, $text, $cb, $value) = @_;	1433	my ($self, $text, $cb, $value) = @_;
1323		1434
1324	my $item; $item = {	1435	my $item; $item = {
1325	type => "button",	1436	type => "button",
1326	text => " $text",	1437	text => " $text",
1327	value => $value,	1438	value => $value,
1328	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1439	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1329	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1440	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1330	};	1441	};
1331		1442
1332	$self->add_item ($item);	1443	$self->add_item ($item);
1333	}	1444	}
		1445
		1446	=item $popup->show
		1447
		1448	Displays the popup (which is initially hidden).
		1449
		1450	=cut
1334		1451
1335	sub show {	1452	sub show {
1336	my ($self) = @_;	1453	my ($self) = @_;
1337		1454
1338	local $urxvt::popup::self = $self;	1455	local $urxvt::popup::self = $self;
1339		1456
		1457	my $env = $self->{term}->env;
		1458	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1459	delete $env->{LC_ALL};
1340	local $ENV{LC_ALL} = $self->{term}->locale;	1460	$env->{LC_CTYPE} = $self->{term}->locale;
1341		1461
		1462	urxvt::term->new ($env, $self->{term}->resource ("name"),
1342	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1463	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1343	"--transient-for" => $self->{term}->parent,	1464	"--transient-for" => $self->{term}->parent,
1344	"-display" => $self->{term}->display_id,	1465	"-display" => $self->{term}->display_id,
1345	"-pe" => "urxvt-popup")	1466	"-pe" => "urxvt-popup")
1346	or die "unable to create popup window\n";	1467	or die "unable to create popup window\n";
1347	}	1468	}
1348		1469
1349	sub DESTROY {	1470	sub DESTROY {
1350	my ($self) = @_;	1471	my ($self) = @_;
1351		1472
1352	delete $self->{term}{_destroy}{$self};	1473	delete $self->{term}{_destroy}{$self};
1353	$self->{term}->ungrab;	1474	$self->{term}->ungrab;
1354	}	1475	}
		1476
		1477	=back
1355		1478
1356	=head2 The C<urxvt::timer> Class	1479	=head2 The C<urxvt::timer> Class
1357		1480
1358	This class implements timer watchers/events. Time is represented as a	1481	This class implements timer watchers/events. Time is represented as a
1359	fractional number of seconds since the epoch. Example:	1482	fractional number of seconds since the epoch. Example:
…		…
1466		1589
1467	=item == 0 - fatal messages	1590	=item == 0 - fatal messages
1468		1591
1469	=item >= 3 - script loading and management	1592	=item >= 3 - script loading and management
1470		1593
1471	=item >=10 - all events received	1594	=item >=10 - all called hooks
		1595
		1596	=item >=11 - hook reutrn values
1472		1597
1473	=back	1598	=back
1474		1599
1475	=head1 AUTHOR	1600	=head1 AUTHOR
1476		1601

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs. Revision 1.85 by root, Thu Jan 12 03:32:56 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs.
Revision 1.85 by root, Thu Jan 12 03:32:56 2006 UTC