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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.13 by root, Tue Jan 3 00:06:57 2006 UTC vs.
Revision 1.20 by root, Tue Jan 3 04:18:47 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.
		30
		31	=head2 Prepackaged Extensions
		32
		33	This section describes the extensiosn delivered with this version. You can
		34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		35
		36	You can activate them like this:
		37
		38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	=over 4
		41
		42	=item selection
		43
		44	Miscellaneous selection modifications.
		45
		46	=over 4
		47
		48	=item rot13
		49
		50	Rot-13 the selection when activated. Used via keyboard trigger:
		51
		52	URxvt.keysym.C-M-r: perl:selection:rot13
		53
		54	=back
		55
		56	=item digital-clock
		57
		58	Displays a digital clock using the built-in overlay.
		59
		60	=item example-refresh-hooks
		61
		62	Displays a very simple digital clock in the upper right corner of the
		63	window. Illustrates overwriting the refresh callbacks to create your own
		64	overlays or changes.
		65
		66	=back
28		67
29	=head2 General API Considerations	68	=head2 General API Considerations
30		69
31	All objects (such as terminals, time watchers etc.) are typical	70	All objects (such as terminals, time watchers etc.) are typical
32	reference-to-hash objects. The hash can be used to store anything you	71	reference-to-hash objects. The hash can be used to store anything you
…		…
154	correct place, e.g. on stderr of the connecting urxvtc client.	193	correct place, e.g. on stderr of the connecting urxvtc client.
155		194
156	=item $time = urxvt::NOW	195	=item $time = urxvt::NOW
157		196
158	Returns the "current time" (as per the event loop).	197	Returns the "current time" (as per the event loop).
		198
		199	=head2 RENDITION
		200
		201	Rendition bitsets contain information about colour, font, font styles and
		202	similar information for each screen cell.
		203
		204	The following "macros" deal with changes in rendition sets. You should
		205	never just create a bitset, you should always modify an existing one,
		206	as they contain important information required for correct operation of
		207	rxvt-unicode.
		208
		209	=over 4
		210
		211	=item $rend = urxvt::DEFAULT_RSTYLE
		212
		213	Returns the default rendition, as used when the terminal is starting up or
		214	being reset. Useful as a base to start when creating renditions.
		215
		216	=item $rend = urxvt::OVERLAY_RSTYLE
		217
		218	Return the rendition mask used for overlays by default.
		219
		220	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		221
		222	Return the bit that enabled bold, italic, blink, reverse-video and
		223	underline, respectively. To enable such a style, just logically OR it into
		224	the bitset.
		225
		226	=item $foreground = urxvt::GET_BASEFG $rend
		227
		228	=item $background = urxvt::GET_BASEBG $rend
		229
		230	Return the foreground/background colour index, respectively.
		231
		232	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		233
		234	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		235
		236	Replace the foreground/background colour in the rendition mask with the
		237	specified one.
		238
		239	=item $value = urxvt::GET_CUSTOM ($rend)
		240
		241	Return the "custom" value: Every rendition has 5 bits for use by
		242	extensions. They can be set and changed as you like and are initially
		243	zero.
		244
		245	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		246
		247	Change the custom value.
		248
		249	=back
159		250
160	=cut	251	=cut
161		252
162	package urxvt;	253	package urxvt;
163		254
…		…
334		425
335	=item $oldtext = $term->selection ([$newtext])	426	=item $oldtext = $term->selection ([$newtext])
336		427
337	Return the current selection text and optionally replace it by C<$newtext>.	428	Return the current selection text and optionally replace it by C<$newtext>.
338		429
339	=item $term->scr_overlay ($x, $y, $text)	430	#=item $term->overlay ($x, $y, $text)
340		431	#
341	Create a simple multi-line overlay box. See the next method for details.	432	#Create a simple multi-line overlay box. See the next method for details.
342		433	#
343	=cut	434	#=cut
344		435
345	sub urxvt::term::scr_overlay {	436	sub urxvt::term::scr_overlay {
		437	die;
346	my ($self, $x, $y, $text) = @_;	438	my ($self, $x, $y, $text) = @_;
347		439
348	my @lines = split /\n/, $text;	440	my @lines = split /\n/, $text;
349		441
350	my $w = 0;	442	my $w = 0;
…		…
354		446
355	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	447	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
356	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	448	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
357	}	449	}
358		450
359	=item $term->scr_overlay_new ($x, $y, $width, $height)	451	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
360		452
361	Create a new (empty) overlay at the given position with the given	453	Create a new (empty) overlay at the given position with the given
362	width/height. A border will be put around the box. If either C<$x> or	454	width/height. C<$rstyle> defines the initial rendition style
363	C<$y> is negative, then this is counted from the right/bottom side,	455	(default: C<OVERLAY_RSTYLE>).
364	respectively.
365		456
366	=item $term->scr_overlay_off	457	If C<$border> is C<2> (default), then a decorative border will be put
		458	around the box.
367		459
368	Switch the overlay off again.	460	If either C<$x> or C<$y> is negative, then this is counted from the
		461	right/bottom side, respectively.
369		462
370	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	463	This method returns an urxvt::overlay object. The overlay will be visible
		464	as long as the perl object is referenced.
371		465
372	Put a single character (specified numerically) at the given overlay	466	Currently, the only method on the C<urxvt::overlay> object is C<set>:
373	position.
374		467
375	=item $term->scr_overlay_set ($x, $y, $text)	468	=item $overlay->set ($x, $y, $text, $rend)
376		469
377	Write a string at the given position into the overlay.	470	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		471	text in rxvt-unicode's special encoding and an array of rendition values
		472	at a specific position inside the overlay.
378		473
379	=item $cellwidth = $term->strwidth $string	474	=item $cellwidth = $term->strwidth $string
380		475
381	Returns the number of screen-cells this string would need. Correctly	476	Returns the number of screen-cells this string would need. Correctly
382	accounts for wide and combining characters.	477	accounts for wide and combining characters.
…		…
409	=item $view_start = $term->view_start ([$newvalue])	504	=item $view_start = $term->view_start ([$newvalue])
410		505
411	Returns the negative row number of the topmost line. Minimum value is	506	Returns the negative row number of the topmost line. Minimum value is
412	C<0>, which displays the normal terminal contents. Larger values scroll	507	C<0>, which displays the normal terminal contents. Larger values scroll
413	this many lines into the scrollback buffer.	508	this many lines into the scrollback buffer.
		509
		510	=item $term->want_refresh
		511
		512	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		513	compare the on-screen display with its stored representation. If they
		514	differ, it redraws the differences.
		515
		516	Used after changing terminal contents to display them.
414		517
415	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	518	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
416		519
417	Returns the text of the entire row with number C<$row_number>. Row C<0>	520	Returns the text of the entire row with number C<$row_number>. Row C<0>
418	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	521	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
419	terminal line. The scrollback buffer starts at line C<-1> and extends to	522	terminal line. The scrollback buffer starts at line C<-1> and extends to
420	line C<< -$term->nsaved >>.	523	line C<< -$term->nsaved >>.
421		524
422	If C<$new_text> is specified, it will replace characters in the current	525	If C<$new_text> is specified, it will replace characters in the current
423	line, starting at column C<$start_col> (default C<0>), which is useful	526	line, starting at column C<$start_col> (default C<0>), which is useful
424	to replace only parts of a line. The font iindex in the rendition will	527	to replace only parts of a line. The font index in the rendition will
425	automatically be updated.	528	automatically be updated.
426		529
427	C<$text> is in a special encoding: tabs and wide characters that use more	530	C<$text> is in a special encoding: tabs and wide characters that use more
428	than one cell when displayed are padded with urxvt::NOCHAR characters	531	than one cell when displayed are padded with urxvt::NOCHAR characters
429	(C<chr 65535>). Characters with combining characters and other characters	532	(C<chr 65535>). Characters with combining characters and other characters
…		…
443	bitsets. Rendition bitsets contain information about colour, font, font	546	bitsets. Rendition bitsets contain information about colour, font, font
444	styles and similar information. See also C<< $term->ROW_t >>.	547	styles and similar information. See also C<< $term->ROW_t >>.
445		548
446	When setting rendition, the font mask will be ignored.	549	When setting rendition, the font mask will be ignored.
447		550
448	See the section on RENDITION, below.	551	See the section on RENDITION, above.
449		552
450	=item $length = $term->ROW_l ($row_number[, $new_length])	553	=item $length = $term->ROW_l ($row_number[, $new_length])
451		554
452	Returns the number of screen cells that are in use ("the line length"). If	555	Returns the number of screen cells that are in use ("the line length"). If
453	it is C<-1>, then the line is part of a multiple-row logical "line", which	556	it is C<-1>, then the line is part of a multiple-row logical "line", which
…		…
464	Converts rxvt-unicodes text reprsentation into a perl string. See	567	Converts rxvt-unicodes text reprsentation into a perl string. See
465	C<< $term->ROW_t >> for details.	568	C<< $term->ROW_t >> for details.
466		569
467	=back	570	=back
468		571
469	=head2 RENDITION
470
471	Rendition bitsets contain information about colour, font, font styles and
472	similar information for each screen cell.
473
474	The following "macros" deal with changes in rendition sets. You should
475	never just create a bitset, you should always modify an existing one,
476	as they contain important information required for correct operation of
477	rxvt-unicode.
478
479	=over 4
480
481	=item $rend = urxvt::DEFAULT_RSTYLE
482
483	Returns the default rendition, as used when the terminal is starting up or
484	being reset. Useful as a base
485
486	=back
487
488	=cut
489
490	=head2 The C<urxvt::timer> Class	572	=head2 The C<urxvt::timer> Class
491		573
492	This class implements timer watchers/events. Time is represented as a	574	This class implements timer watchers/events. Time is represented as a
493	fractional number of seconds since the epoch. Example:	575	fractional number of seconds since the epoch. Example:
494		576
495	# create a digital clock display in upper right corner	577	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
496	$term->{timer} = urxvt::timer	578	$term->{timer} = urxvt::timer
497	->new	579	->new
498	->start (urxvt::NOW)	580	->interval (1)
499	->cb (sub {	581	->cb (sub {
500	my ($timer) = @_;
501	my $time = $timer->at;
502	$timer->start ($time + 1);
503	$self->scr_overlay (-1, 0,	582	$term->{overlay}->set (0, 0,
504	POSIX::strftime "%H:%M:%S", localtime $time);	583	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
505	});	584	});
506		585
507	=over 4	586	=over 4
508		587
509	=item $timer = new urxvt::timer	588	=item $timer = new urxvt::timer
510		589
511	Create a new timer object in stopped state.	590	Create a new timer object in started state. It is scheduled to fire
		591	immediately.
512		592
513	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	593	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
514		594
515	Set the callback to be called when the timer triggers.	595	Set the callback to be called when the timer triggers.
516		596
…		…
519	Return the time this watcher will fire next.	599	Return the time this watcher will fire next.
520		600
521	=item $timer = $timer->set ($tstamp)	601	=item $timer = $timer->set ($tstamp)
522		602
523	Set the time the event is generated to $tstamp.	603	Set the time the event is generated to $tstamp.
		604
		605	=item $timer = $timer->interval ($interval)
		606
		607	Normally (and when C<$interval> is C<0>), the timer will automatically
		608	stop after it has fired once. If C<$interval> is non-zero, then the timer
		609	is automatically rescheduled at the given intervals.
524		610
525	=item $timer = $timer->start	611	=item $timer = $timer->start
526		612
527	Start the timer.	613	Start the timer.
528		614

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.13 by root, Tue Jan 3 00:06:57 2006 UTC vs. Revision 1.20 by root, Tue Jan 3 04:18:47 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.13 by root, Tue Jan 3 00:06:57 2006 UTC vs.
Revision 1.20 by root, Tue Jan 3 04:18:47 2006 UTC