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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.22 by root, Tue Jan 3 19:10:54 2006 UTC

…		…
		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
22		24
23	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
24	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
25		27
26	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
27	scripts will be shared (But not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
28		30
29	=head1 PACKAGED EXTENSIONS	31	=head2 Prepackaged Extensions
30		32
31	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensiosn delivered with this version. You can
32	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
33		35
34	You can activate them like this:	36	You can activate them like this:
…		…
37		39
38	=over 4	40	=over 4
39		41
40	=item selection	42	=item selection
41		43
42	Miscellaneous selection modifications.	44	Intelligent selection. This etxension tries to be more intelligent when the user
		45	extends selections (double-click).
		46
		47	It also offers the following bindable event:
43		48
44	=over 4	49	=over 4
45		50
46	=item rot13	51	=item rot13
47		52
…		…
50	URxvt.keysym.C-M-r: perl:selection:rot13	55	URxvt.keysym.C-M-r: perl:selection:rot13
51		56
52	=back	57	=back
53		58
54	=item digital-clock	59	=item digital-clock
		60
		61	Displays a digital clock using the built-in overlay.
		62
		63	=item example-refresh-hooks
55		64
56	Displays a very simple digital clock in the upper right corner of the	65	Displays a very simple digital clock in the upper right corner of the
57	window. Illustrates overwriting the refresh callbacks to create your own	66	window. Illustrates overwriting the refresh callbacks to create your own
58	overlays or changes.	67	overlays or changes.
59
60	=item simple-overlay-clock
61
62	Displays a digital clock using the built-in overlay (colorful, useless).
63		68
64	=back	69	=back
65		70
66	=head2 General API Considerations	71	=head2 General API Considerations
67		72
…		…
120	requested from the server. The selection text can be queried and changed	125	requested from the server. The selection text can be queried and changed
121	by calling C<< $term->selection >>.	126	by calling C<< $term->selection >>.
122		127
123	Returning a true value aborts selection grabbing. It will still be hilighted.	128	Returning a true value aborts selection grabbing. It will still be hilighted.
124		129
		130	=item on_sel_extend $term
		131
		132	Called whenever the user tries to extend the selection (e.g. with a double
		133	click) and is either supposed to return false (normal operation), or
		134	should extend the selection itelf and return true to suppress the built-in
		135	processing.
		136
		137	See the F<selection> example extension.
		138
125	=item on_focus_in $term	139	=item on_focus_in $term
126		140
127	Called whenever the window gets the keyboard focus, before urxvt does	141	Called whenever the window gets the keyboard focus, before urxvt does
128	focus in processing.	142	focus in processing.
129		143
…		…
191	correct place, e.g. on stderr of the connecting urxvtc client.	205	correct place, e.g. on stderr of the connecting urxvtc client.
192		206
193	=item $time = urxvt::NOW	207	=item $time = urxvt::NOW
194		208
195	Returns the "current time" (as per the event loop).	209	Returns the "current time" (as per the event loop).
		210
		211	=back
		212
		213	=head2 RENDITION
		214
		215	Rendition bitsets contain information about colour, font, font styles and
		216	similar information for each screen cell.
		217
		218	The following "macros" deal with changes in rendition sets. You should
		219	never just create a bitset, you should always modify an existing one,
		220	as they contain important information required for correct operation of
		221	rxvt-unicode.
		222
		223	=over 4
		224
		225	=item $rend = urxvt::DEFAULT_RSTYLE
		226
		227	Returns the default rendition, as used when the terminal is starting up or
		228	being reset. Useful as a base to start when creating renditions.
		229
		230	=item $rend = urxvt::OVERLAY_RSTYLE
		231
		232	Return the rendition mask used for overlays by default.
		233
		234	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		235
		236	Return the bit that enabled bold, italic, blink, reverse-video and
		237	underline, respectively. To enable such a style, just logically OR it into
		238	the bitset.
		239
		240	=item $foreground = urxvt::GET_BASEFG $rend
		241
		242	=item $background = urxvt::GET_BASEBG $rend
		243
		244	Return the foreground/background colour index, respectively.
		245
		246	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		247
		248	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		249
		250	Replace the foreground/background colour in the rendition mask with the
		251	specified one.
		252
		253	=item $value = urxvt::GET_CUSTOM ($rend)
		254
		255	Return the "custom" value: Every rendition has 5 bits for use by
		256	extensions. They can be set and changed as you like and are initially
		257	zero.
		258
		259	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		260
		261	Change the custom value.
		262
		263	=back
196		264
197	=cut	265	=cut
198		266
199	package urxvt;	267	package urxvt;
200		268
…		…
304	return 1 if $v->($term, @_);	372	return 1 if $v->($term, @_);
305	}	373	}
306		374
307	0	375	0
308	}	376	}
309
310	=back
311		377
312	=head2 The C<urxvt::term> Class	378	=head2 The C<urxvt::term> Class
313		379
314	=over 4	380	=over 4
315		381
…		…
371		437
372	=item $oldtext = $term->selection ([$newtext])	438	=item $oldtext = $term->selection ([$newtext])
373		439
374	Return the current selection text and optionally replace it by C<$newtext>.	440	Return the current selection text and optionally replace it by C<$newtext>.
375		441
376	=item $term->scr_overlay ($x, $y, $text)	442	#=item $term->overlay ($x, $y, $text)
377		443	#
378	Create a simple multi-line overlay box. See the next method for details.	444	#Create a simple multi-line overlay box. See the next method for details.
379		445	#
380	=cut	446	#=cut
381		447
382	sub urxvt::term::scr_overlay {	448	sub urxvt::term::scr_overlay {
		449	die;
383	my ($self, $x, $y, $text) = @_;	450	my ($self, $x, $y, $text) = @_;
384		451
385	my @lines = split /\n/, $text;	452	my @lines = split /\n/, $text;
386		453
387	my $w = 0;	454	my $w = 0;
…		…
391		458
392	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	459	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
393	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	460	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
394	}	461	}
395		462
396	=item $term->scr_overlay_new ($x, $y, $width, $height)	463	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
397		464
398	Create a new (empty) overlay at the given position with the given	465	Create a new (empty) overlay at the given position with the given
399	width/height. A border will be put around the box. If either C<$x> or	466	width/height. C<$rstyle> defines the initial rendition style
400	C<$y> is negative, then this is counted from the right/bottom side,	467	(default: C<OVERLAY_RSTYLE>).
401	respectively.
402		468
403	=item $term->scr_overlay_off	469	If C<$border> is C<2> (default), then a decorative border will be put
		470	around the box.
404		471
405	Switch the overlay off again.	472	If either C<$x> or C<$y> is negative, then this is counted from the
		473	right/bottom side, respectively.
406		474
407	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	475	This method returns an urxvt::overlay object. The overlay will be visible
		476	as long as the perl object is referenced.
408		477
409	Put a single character (specified numerically) at the given overlay	478	The methods currently supported on C<urxvt::overlay> objects are:
410	position.
411		479
		480	=over 4
		481
412	=item $term->scr_overlay_set ($x, $y, $text)	482	=item $overlay->set ($x, $y, $text, $rend)
413		483
414	Write a string at the given position into the overlay.	484	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		485	text in rxvt-unicode's special encoding and an array of rendition values
		486	at a specific position inside the overlay.
		487
		488	=item $overlay->hide
		489
		490	If visible, hide the overlay, but do not destroy it.
		491
		492	=item $overlay->show
		493
		494	If hidden, display the overlay again.
		495
		496	=back
415		497
416	=item $cellwidth = $term->strwidth $string	498	=item $cellwidth = $term->strwidth $string
417		499
418	Returns the number of screen-cells this string would need. Correctly	500	Returns the number of screen-cells this string would need. Correctly
419	accounts for wide and combining characters.	501	accounts for wide and combining characters.
…		…
464	terminal line. The scrollback buffer starts at line C<-1> and extends to	546	terminal line. The scrollback buffer starts at line C<-1> and extends to
465	line C<< -$term->nsaved >>.	547	line C<< -$term->nsaved >>.
466		548
467	If C<$new_text> is specified, it will replace characters in the current	549	If C<$new_text> is specified, it will replace characters in the current
468	line, starting at column C<$start_col> (default C<0>), which is useful	550	line, starting at column C<$start_col> (default C<0>), which is useful
469	to replace only parts of a line. The font iindex in the rendition will	551	to replace only parts of a line. The font index in the rendition will
470	automatically be updated.	552	automatically be updated.
471		553
472	C<$text> is in a special encoding: tabs and wide characters that use more	554	C<$text> is in a special encoding: tabs and wide characters that use more
473	than one cell when displayed are padded with urxvt::NOCHAR characters	555	than one cell when displayed are padded with urxvt::NOCHAR characters
474	(C<chr 65535>). Characters with combining characters and other characters	556	(C<chr 65535>). Characters with combining characters and other characters
…		…
488	bitsets. Rendition bitsets contain information about colour, font, font	570	bitsets. Rendition bitsets contain information about colour, font, font
489	styles and similar information. See also C<< $term->ROW_t >>.	571	styles and similar information. See also C<< $term->ROW_t >>.
490		572
491	When setting rendition, the font mask will be ignored.	573	When setting rendition, the font mask will be ignored.
492		574
493	See the section on RENDITION, below.	575	See the section on RENDITION, above.
494		576
495	=item $length = $term->ROW_l ($row_number[, $new_length])	577	=item $length = $term->ROW_l ($row_number[, $new_length])
496		578
497	Returns the number of screen cells that are in use ("the line length"). If	579	Returns the number of screen cells that are in use ("the line length"). If
498	it is C<-1>, then the line is part of a multiple-row logical "line", which	580	it is C<-1>, then the line is part of a multiple-row logical "line", which
…		…
509	Converts rxvt-unicodes text reprsentation into a perl string. See	591	Converts rxvt-unicodes text reprsentation into a perl string. See
510	C<< $term->ROW_t >> for details.	592	C<< $term->ROW_t >> for details.
511		593
512	=back	594	=back
513		595
514	=head2 RENDITION
515
516	Rendition bitsets contain information about colour, font, font styles and
517	similar information for each screen cell.
518
519	The following "macros" deal with changes in rendition sets. You should
520	never just create a bitset, you should always modify an existing one,
521	as they contain important information required for correct operation of
522	rxvt-unicode.
523
524	=over 4
525
526	=item $rend = urxvt::DEFAULT_RSTYLE
527
528	Returns the default rendition, as used when the terminal is starting up or
529	being reset. Useful as a base
530
531	=back
532
533	=cut
534
535	=head2 The C<urxvt::timer> Class	596	=head2 The C<urxvt::timer> Class
536		597
537	This class implements timer watchers/events. Time is represented as a	598	This class implements timer watchers/events. Time is represented as a
538	fractional number of seconds since the epoch. Example:	599	fractional number of seconds since the epoch. Example:
539		600
540	# create a digital clock display in upper right corner	601	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
541	$term->{timer} = urxvt::timer	602	$term->{timer} = urxvt::timer
542	->new	603	->new
543	->start (urxvt::NOW)	604	->interval (1)
544	->cb (sub {	605	->cb (sub {
545	my ($timer) = @_;
546	my $time = $timer->at;
547	$timer->start ($time + 1);
548	$self->scr_overlay (-1, 0,	606	$term->{overlay}->set (0, 0,
549	POSIX::strftime "%H:%M:%S", localtime $time);	607	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
550	});	608	});
551		609
552	=over 4	610	=over 4
553		611
554	=item $timer = new urxvt::timer	612	=item $timer = new urxvt::timer
555		613
556	Create a new timer object in stopped state.	614	Create a new timer object in started state. It is scheduled to fire
		615	immediately.
557		616
558	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	617	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
559		618
560	Set the callback to be called when the timer triggers.	619	Set the callback to be called when the timer triggers.
561		620
…		…
564	Return the time this watcher will fire next.	623	Return the time this watcher will fire next.
565		624
566	=item $timer = $timer->set ($tstamp)	625	=item $timer = $timer->set ($tstamp)
567		626
568	Set the time the event is generated to $tstamp.	627	Set the time the event is generated to $tstamp.
		628
		629	=item $timer = $timer->interval ($interval)
		630
		631	Normally (and when C<$interval> is C<0>), the timer will automatically
		632	stop after it has fired once. If C<$interval> is non-zero, then the timer
		633	is automatically rescheduled at the given intervals.
569		634
570	=item $timer = $timer->start	635	=item $timer = $timer->start
571		636
572	Start the timer.	637	Start the timer.
573		638

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs. Revision 1.22 by root, Tue Jan 3 19:10:54 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.22 by root, Tue Jan 3 19:10:54 2006 UTC