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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.17 by root, Tue Jan 3 01:45:03 2006 UTC vs.
Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC

…		…
53		53
54	=back	54	=back
55		55
56	=item digital-clock	56	=item digital-clock
57		57
		58	Displays a digital clock using the built-in overlay.
		59
		60	=item example-refresh-hooks
		61
58	Displays a very simple digital clock in the upper right corner of the	62	Displays a very simple digital clock in the upper right corner of the
59	window. Illustrates overwriting the refresh callbacks to create your own	63	window. Illustrates overwriting the refresh callbacks to create your own
60	overlays or changes.	64	overlays or changes.
61
62	=item simple-overlay-clock
63
64	Displays a digital clock using the built-in overlay (colorful, useless).
65		65
66	=back	66	=back
67		67
68	=head2 General API Considerations	68	=head2 General API Considerations
69		69
…		…
193	correct place, e.g. on stderr of the connecting urxvtc client.	193	correct place, e.g. on stderr of the connecting urxvtc client.
194		194
195	=item $time = urxvt::NOW	195	=item $time = urxvt::NOW
196		196
197	Returns the "current time" (as per the event loop).	197	Returns the "current time" (as per the event loop).
		198
		199	=back
		200
		201	=head2 RENDITION
		202
		203	Rendition bitsets contain information about colour, font, font styles and
		204	similar information for each screen cell.
		205
		206	The following "macros" deal with changes in rendition sets. You should
		207	never just create a bitset, you should always modify an existing one,
		208	as they contain important information required for correct operation of
		209	rxvt-unicode.
		210
		211	=over 4
		212
		213	=item $rend = urxvt::DEFAULT_RSTYLE
		214
		215	Returns the default rendition, as used when the terminal is starting up or
		216	being reset. Useful as a base to start when creating renditions.
		217
		218	=item $rend = urxvt::OVERLAY_RSTYLE
		219
		220	Return the rendition mask used for overlays by default.
		221
		222	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		223
		224	Return the bit that enabled bold, italic, blink, reverse-video and
		225	underline, respectively. To enable such a style, just logically OR it into
		226	the bitset.
		227
		228	=item $foreground = urxvt::GET_BASEFG $rend
		229
		230	=item $background = urxvt::GET_BASEBG $rend
		231
		232	Return the foreground/background colour index, respectively.
		233
		234	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		235
		236	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		237
		238	Replace the foreground/background colour in the rendition mask with the
		239	specified one.
		240
		241	=item $value = urxvt::GET_CUSTOM ($rend)
		242
		243	Return the "custom" value: Every rendition has 5 bits for use by
		244	extensions. They can be set and changed as you like and are initially
		245	zero.
		246
		247	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		248
		249	Change the custom value.
		250
		251	=back
198		252
199	=cut	253	=cut
200		254
201	package urxvt;	255	package urxvt;
202		256
…		…
306	return 1 if $v->($term, @_);	360	return 1 if $v->($term, @_);
307	}	361	}
308		362
309	0	363	0
310	}	364	}
311
312	=back
313		365
314	=head2 The C<urxvt::term> Class	366	=head2 The C<urxvt::term> Class
315		367
316	=over 4	368	=over 4
317		369
…		…
373		425
374	=item $oldtext = $term->selection ([$newtext])	426	=item $oldtext = $term->selection ([$newtext])
375		427
376	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>.
377		429
378	=item $term->scr_overlay ($x, $y, $text)	430	#=item $term->overlay ($x, $y, $text)
379		431	#
380	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.
381		433	#
382	=cut	434	#=cut
383		435
384	sub urxvt::term::scr_overlay {	436	sub urxvt::term::scr_overlay {
		437	die;
385	my ($self, $x, $y, $text) = @_;	438	my ($self, $x, $y, $text) = @_;
386		439
387	my @lines = split /\n/, $text;	440	my @lines = split /\n/, $text;
388		441
389	my $w = 0;	442	my $w = 0;
…		…
393		446
394	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	447	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
395	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	448	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
396	}	449	}
397		450
398	=item $term->scr_overlay_new ($x, $y, $width, $height)	451	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
399		452
400	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
401	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
402	C<$y> is negative, then this is counted from the right/bottom side,	455	(default: C<OVERLAY_RSTYLE>).
403	respectively.
404		456
405	=item $term->scr_overlay_off	457	If C<$border> is C<2> (default), then a decorative border will be put
		458	around the box.
406		459
407	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.
408		462
409	=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.
410		465
411	Put a single character (specified numerically) at the given overlay	466	Currently, the only method on the C<urxvt::overlay> object is C<set>:
412	position.
413		467
414	=item $term->scr_overlay_set ($x, $y, $text)	468	=item $overlay->set ($x, $y, $text, $rend)
415		469
416	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.
417		473
418	=item $cellwidth = $term->strwidth $string	474	=item $cellwidth = $term->strwidth $string
419		475
420	Returns the number of screen-cells this string would need. Correctly	476	Returns the number of screen-cells this string would need. Correctly
421	accounts for wide and combining characters.	477	accounts for wide and combining characters.
…		…
466	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
467	line C<< -$term->nsaved >>.	523	line C<< -$term->nsaved >>.
468		524
469	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
470	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
471	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
472	automatically be updated.	528	automatically be updated.
473		529
474	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
475	than one cell when displayed are padded with urxvt::NOCHAR characters	531	than one cell when displayed are padded with urxvt::NOCHAR characters
476	(C<chr 65535>). Characters with combining characters and other characters	532	(C<chr 65535>). Characters with combining characters and other characters
…		…
490	bitsets. Rendition bitsets contain information about colour, font, font	546	bitsets. Rendition bitsets contain information about colour, font, font
491	styles and similar information. See also C<< $term->ROW_t >>.	547	styles and similar information. See also C<< $term->ROW_t >>.
492		548
493	When setting rendition, the font mask will be ignored.	549	When setting rendition, the font mask will be ignored.
494		550
495	See the section on RENDITION, below.	551	See the section on RENDITION, above.
496		552
497	=item $length = $term->ROW_l ($row_number[, $new_length])	553	=item $length = $term->ROW_l ($row_number[, $new_length])
498		554
499	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
500	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
…		…
511	Converts rxvt-unicodes text reprsentation into a perl string. See	567	Converts rxvt-unicodes text reprsentation into a perl string. See
512	C<< $term->ROW_t >> for details.	568	C<< $term->ROW_t >> for details.
513		569
514	=back	570	=back
515		571
516	=head2 RENDITION
517
518	Rendition bitsets contain information about colour, font, font styles and
519	similar information for each screen cell.
520
521	The following "macros" deal with changes in rendition sets. You should
522	never just create a bitset, you should always modify an existing one,
523	as they contain important information required for correct operation of
524	rxvt-unicode.
525
526	=over 4
527
528	=item $rend = urxvt::DEFAULT_RSTYLE
529
530	Returns the default rendition, as used when the terminal is starting up or
531	being reset. Useful as a base
532
533	=back
534
535	=cut
536
537	=head2 The C<urxvt::timer> Class	572	=head2 The C<urxvt::timer> Class
538		573
539	This class implements timer watchers/events. Time is represented as a	574	This class implements timer watchers/events. Time is represented as a
540	fractional number of seconds since the epoch. Example:	575	fractional number of seconds since the epoch. Example:
541		576
542	# create a digital clock display in upper right corner	577	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
543	$term->{timer} = urxvt::timer	578	$term->{timer} = urxvt::timer
544	->new	579	->new
545	->start (urxvt::NOW)	580	->interval (1)
546	->cb (sub {	581	->cb (sub {
547	my ($timer) = @_;
548	my $time = $timer->at;
549	$timer->start ($time + 1);
550	$self->scr_overlay (-1, 0,	582	$term->{overlay}->set (0, 0,
551	POSIX::strftime "%H:%M:%S", localtime $time);	583	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
552	});	584	});
553		585
554	=over 4	586	=over 4
555		587
556	=item $timer = new urxvt::timer	588	=item $timer = new urxvt::timer
557		589
558	Create a new timer object in stopped state.	590	Create a new timer object in started state. It is scheduled to fire
		591	immediately.
559		592
560	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	593	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
561		594
562	Set the callback to be called when the timer triggers.	595	Set the callback to be called when the timer triggers.
563		596
…		…
566	Return the time this watcher will fire next.	599	Return the time this watcher will fire next.
567		600
568	=item $timer = $timer->set ($tstamp)	601	=item $timer = $timer->set ($tstamp)
569		602
570	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.
571		610
572	=item $timer = $timer->start	611	=item $timer = $timer->start
573		612
574	Start the timer.	613	Start the timer.
575		614

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.17 by root, Tue Jan 3 01:45:03 2006 UTC vs. Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.17 by root, Tue Jan 3 01:45:03 2006 UTC vs.
Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC