ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.17 by root, Tue Jan 3 01:45:03 2006 UTC vs.
Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC

… …
59window. Illustrates overwriting the refresh callbacks to create your own 59window. Illustrates overwriting the refresh callbacks to create your own
60overlays or changes. 60overlays or changes.
61 61
62=item simple-overlay-clock 62=item simple-overlay-clock
63 63
64Displays a digital clock using the built-in overlay (colorful, useless). 64Displays a digital clock using the built-in overlay (colourful, useless).
65 65
66=back 66=back
67 67
68=head2 General API Considerations 68=head2 General API Considerations
69 69
… …
193correct place, e.g. on stderr of the connecting urxvtc client. 193correct place, e.g. on stderr of the connecting urxvtc client.
194 194
195=item $time = urxvt::NOW 195=item $time = urxvt::NOW
196 196
197Returns the "current time" (as per the event loop). 197Returns the "current time" (as per the event loop).
198
199=head2 RENDITION
200
201Rendition bitsets contain information about colour, font, font styles and
202similar information for each screen cell.
203
204The following "macros" deal with changes in rendition sets. You should
205never just create a bitset, you should always modify an existing one,
206as they contain important information required for correct operation of
207rxvt-unicode.
208
209=over 4
210
211=item $rend = urxvt::DEFAULT_RSTYLE
212
213Returns the default rendition, as used when the terminal is starting up or
214being reset. Useful as a base to start when creating renditions.
215
216=item $rend = urxvt::OVERLAY_RSTYLE
217
218Return the rendition mask used for overlays by default.
219
220=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
221
222Return the bit that enabled bold, italic, blink, reverse-video and
223underline, respectively. To enable such a style, just logically OR it into
224the bitset.
225
226=item $foreground = urxvt::GET_BASEFG $rend
227
228=item $background = urxvt::GET_BASEBG $rend
229
230Return 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
236Replace the foreground/background colour in the rendition mask with the
237specified one.
238
239=item $value = urxvt::GET_CUSTOM ($rend)
240
241Return the "custom" value: Every rendition has 5 bits for use by
242extensions. They can be set and changed as you like and are initially
243zero.
244
245=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
246
247Change the custom value.
248
249=back
198 250
199=cut 251=cut
200 252
201package urxvt; 253package urxvt;
202 254
… …
466terminal line. The scrollback buffer starts at line C<-1> and extends to 518terminal line. The scrollback buffer starts at line C<-1> and extends to
467line C<< -$term->nsaved >>. 519line C<< -$term->nsaved >>.
468 520
469If C<$new_text> is specified, it will replace characters in the current 521If C<$new_text> is specified, it will replace characters in the current
470line, starting at column C<$start_col> (default C<0>), which is useful 522line, starting at column C<$start_col> (default C<0>), which is useful
471to replace only parts of a line. The font iindex in the rendition will 523to replace only parts of a line. The font index in the rendition will
472automatically be updated. 524automatically be updated.
473 525
474C<$text> is in a special encoding: tabs and wide characters that use more 526C<$text> is in a special encoding: tabs and wide characters that use more
475than one cell when displayed are padded with urxvt::NOCHAR characters 527than one cell when displayed are padded with urxvt::NOCHAR characters
476(C<chr 65535>). Characters with combining characters and other characters 528(C<chr 65535>). Characters with combining characters and other characters
… …
490bitsets. Rendition bitsets contain information about colour, font, font 542bitsets. Rendition bitsets contain information about colour, font, font
491styles and similar information. See also C<< $term->ROW_t >>. 543styles and similar information. See also C<< $term->ROW_t >>.
492 544
493When setting rendition, the font mask will be ignored. 545When setting rendition, the font mask will be ignored.
494 546
495See the section on RENDITION, below. 547See the section on RENDITION, above.
496 548
497=item $length = $term->ROW_l ($row_number[, $new_length]) 549=item $length = $term->ROW_l ($row_number[, $new_length])
498 550
499Returns the number of screen cells that are in use ("the line length"). If 551Returns the number of screen cells that are in use ("the line length"). If
500it is C<-1>, then the line is part of a multiple-row logical "line", which 552it is C<-1>, then the line is part of a multiple-row logical "line", which
… …
510 562
511Converts rxvt-unicodes text reprsentation into a perl string. See 563Converts rxvt-unicodes text reprsentation into a perl string. See
512C<< $term->ROW_t >> for details. 564C<< $term->ROW_t >> for details.
513 565
514=back 566=back
515
516=head2 RENDITION
517
518Rendition bitsets contain information about colour, font, font styles and
519similar information for each screen cell.
520
521The following "macros" deal with changes in rendition sets. You should
522never just create a bitset, you should always modify an existing one,
523as they contain important information required for correct operation of
524rxvt-unicode.
525
526=over 4
527
528=item $rend = urxvt::DEFAULT_RSTYLE
529
530Returns the default rendition, as used when the terminal is starting up or
531being reset. Useful as a base
532
533=back
534
535=cut
536 567
537=head2 The C<urxvt::timer> Class 568=head2 The C<urxvt::timer> Class
538 569
539This class implements timer watchers/events. Time is represented as a 570This class implements timer watchers/events. Time is represented as a
540fractional number of seconds since the epoch. Example: 571fractional number of seconds since the epoch. Example:

Diff Legend

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