--- rxvt-unicode/src/urxvt.pm 2006/01/03 01:39:17 1.15 +++ rxvt-unicode/src/urxvt.pm 2006/01/03 04:20:37 1.21 @@ -1,3 +1,5 @@ +=encoding utf8 + =head1 NAME @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter @@ -24,9 +26,9 @@ thus must be encoded as UTF-8. Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where -scripts will be shared (But not enabled) for all terminals. +scripts will be shared (but not enabled) for all terminals. -=head1 PACKAGED EXTENSIONS +=head2 Prepackaged Extensions This section describes the extensiosn delivered with this version. You can find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. @@ -53,14 +55,14 @@ =item digital-clock +Displays a digital clock using the built-in overlay. + +=item example-refresh-hooks + Displays a very simple digital clock in the upper right corner of the window. Illustrates overwriting the refresh callbacks to create your own overlays or changes. -=item simple-overlay-clock - -Displays a digital clock using the built-in overlay (colorful, useless). - =back =head2 General API Considerations @@ -194,6 +196,60 @@ Returns the "current time" (as per the event loop). +=back + +=head2 RENDITION + +Rendition bitsets contain information about colour, font, font styles and +similar information for each screen cell. + +The following "macros" deal with changes in rendition sets. You should +never just create a bitset, you should always modify an existing one, +as they contain important information required for correct operation of +rxvt-unicode. + +=over 4 + +=item $rend = urxvt::DEFAULT_RSTYLE + +Returns the default rendition, as used when the terminal is starting up or +being reset. Useful as a base to start when creating renditions. + +=item $rend = urxvt::OVERLAY_RSTYLE + +Return the rendition mask used for overlays by default. + +=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline + +Return the bit that enabled bold, italic, blink, reverse-video and +underline, respectively. To enable such a style, just logically OR it into +the bitset. + +=item $foreground = urxvt::GET_BASEFG $rend + +=item $background = urxvt::GET_BASEBG $rend + +Return the foreground/background colour index, respectively. + +=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) + +=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) + +Replace the foreground/background colour in the rendition mask with the +specified one. + +=item $value = urxvt::GET_CUSTOM ($rend) + +Return the "custom" value: Every rendition has 5 bits for use by +extensions. They can be set and changed as you like and are initially +zero. + +=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) + +Change the custom value. + +=back + =cut package urxvt; @@ -307,8 +363,6 @@ 0 } -=back - =head2 The C Class =over 4 @@ -373,13 +427,14 @@ Return the current selection text and optionally replace it by C<$newtext>. -=item $term->scr_overlay ($x, $y, $text) - -Create a simple multi-line overlay box. See the next method for details. - -=cut +#=item $term->overlay ($x, $y, $text) +# +#Create a simple multi-line overlay box. See the next method for details. +# +#=cut sub urxvt::term::scr_overlay { +die; my ($self, $x, $y, $text) = @_; my @lines = split /\n/, $text; @@ -393,25 +448,28 @@ $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; } -=item $term->scr_overlay_new ($x, $y, $width, $height) +=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) Create a new (empty) overlay at the given position with the given -width/height. A border will be put around the box. If either C<$x> or -C<$y> is negative, then this is counted from the right/bottom side, -respectively. +width/height. C<$rstyle> defines the initial rendition style +(default: C). -=item $term->scr_overlay_off +If C<$border> is C<2> (default), then a decorative border will be put +around the box. -Switch the overlay off again. +If either C<$x> or C<$y> is negative, then this is counted from the +right/bottom side, respectively. -=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) +This method returns an urxvt::overlay object. The overlay will be visible +as long as the perl object is referenced. -Put a single character (specified numerically) at the given overlay -position. +Currently, the only method on the C object is C: -=item $term->scr_overlay_set ($x, $y, $text) +=item $overlay->set ($x, $y, $text, $rend) -Write a string at the given position into the overlay. +Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts +text in rxvt-unicode's special encoding and an array of rendition values +at a specific position inside the overlay. =item $cellwidth = $term->strwidth $string @@ -466,7 +524,7 @@ If C<$new_text> is specified, it will replace characters in the current line, starting at column C<$start_col> (default C<0>), which is useful -to replace only parts of a line. The font iindex in the rendition will +to replace only parts of a line. The font index in the rendition will automatically be updated. C<$text> is in a special encoding: tabs and wide characters that use more @@ -490,7 +548,7 @@ When setting rendition, the font mask will be ignored. -See the section on RENDITION, below. +See the section on RENDITION, above. =item $length = $term->ROW_l ($row_number[, $new_length]) @@ -511,49 +569,26 @@ =back -=head2 RENDITION - -Rendition bitsets contain information about colour, font, font styles and -similar information for each screen cell. - -The following "macros" deal with changes in rendition sets. You should -never just create a bitset, you should always modify an existing one, -as they contain important information required for correct operation of -rxvt-unicode. - -=over 4 - -=item $rend = urxvt::DEFAULT_RSTYLE - -Returns the default rendition, as used when the terminal is starting up or -being reset. Useful as a base - -=back - -=cut - =head2 The C Class This class implements timer watchers/events. Time is represented as a fractional number of seconds since the epoch. Example: - # create a digital clock display in upper right corner + $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); $term->{timer} = urxvt::timer ->new - ->start (urxvt::NOW) + ->interval (1) ->cb (sub { - my ($timer) = @_; - my $time = $timer->at; - $timer->start ($time + 1); - $self->scr_overlay (-1, 0, - POSIX::strftime "%H:%M:%S", localtime $time); - }); + $term->{overlay}->set (0, 0, + sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); + }); =over 4 =item $timer = new urxvt::timer -Create a new timer object in stopped state. +Create a new timer object in started state. It is scheduled to fire +immediately. =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) @@ -567,6 +602,12 @@ Set the time the event is generated to $tstamp. +=item $timer = $timer->interval ($interval) + +Normally (and when C<$interval> is C<0>), the timer will automatically +stop after it has fired once. If C<$interval> is non-zero, then the timer +is automatically rescheduled at the given intervals. + =item $timer = $timer->start Start the timer.