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.12 by root, Mon Jan 2 22:23:26 2006 UTC vs.
Revision 1.14 by root, Tue Jan 3 01:15:00 2006 UTC

… …
393 393
394Write the octets given in C<$data> to the tty (i.e. as program input). To 394Write the octets given in C<$data> to the tty (i.e. as program input). To
395pass characters instead of octets, you should convert your strings first 395pass characters instead of octets, you should convert your strings first
396to the locale-specific encoding using C<< $term->locale_encode >>. 396to the locale-specific encoding using C<< $term->locale_encode >>.
397 397
398=item $nrow = $term->nrow
399
400=item $ncol = $term->ncol
401
402Return the number of rows/columns of the terminal window (i.e. as
403specified by C<-geometry>, excluding any scrollback).
404
398=item $nsaved = $term->nsaved 405=item $nsaved = $term->nsaved
399 406
400Returns the number of lines in the scrollback buffer. 407Returns the number of lines in the scrollback buffer.
401 408
402=item $view_start = $term->view_start ([$newvalue]) 409=item $view_start = $term->view_start ([$newvalue])
403 410
404Returns the negative row number of the topmost line. Minimum value is 411Returns the negative row number of the topmost line. Minimum value is
405C<0>, which displays the normal terminal contents. Larger values scroll 412C<0>, which displays the normal terminal contents. Larger values scroll
406this many lines into the scrollback buffer. 413this many lines into the scrollback buffer.
407 414
415=item $term->want_refresh
416
417Requests a screen refresh. At the next opportunity, rxvt-unicode will
418compare the on-screen display with its stored representation. If they
419differ, it redraws the differences.
420
421Used after changing terminal contents to display them.
422
408=item $text = $term->ROW_t ($row_number[, $new_text]) 423=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
409 424
410Returns the text of the entire row with number C<$row_number>. Row C<0> 425Returns the text of the entire row with number C<$row_number>. Row C<0>
411is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 426is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
412terminal line. The scrollback buffer starts at line C<-1> and extends to 427terminal line. The scrollback buffer starts at line C<-1> and extends to
413line C<< -$term->nsaved >>. 428line C<< -$term->nsaved >>.
414 429
415If C<$new_text> is specified, it will completely replace the current line. 430If C<$new_text> is specified, it will replace characters in the current
431line, starting at column C<$start_col> (default C<0>), which is useful
432to replace only parts of a line. The font iindex in the rendition will
433automatically be updated.
416 434
417C<$text> is in a special encoding: tabs and wide characters that use more 435C<$text> is in a special encoding: tabs and wide characters that use more
418than one cell when displayed are padded with urxvt::NOCHAR characters 436than one cell when displayed are padded with urxvt::NOCHAR characters
419(C<chr 65535>). Characters with combining characters and other characters 437(C<chr 65535>). Characters with combining characters and other characters
420that do not fit into the normal tetx encoding will be replaced with 438that do not fit into the normal tetx encoding will be replaced with
… …
425characters. 443characters.
426 444
427The methods C<< $term->special_encode >> and C<< $term->special_decode >> 445The methods C<< $term->special_encode >> and C<< $term->special_decode >>
428can be used to convert normal strings into this encoding and vice versa. 446can be used to convert normal strings into this encoding and vice versa.
429 447
430=item $rend = $term->ROW_r ($row_number[, $new_rend]) 448=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
431 449
432Like C<< $term->ROW_t >> 450Like C<< $term->ROW_t >>, but returns an arrayref with rendition
451bitsets. Rendition bitsets contain information about colour, font, font
452styles and similar information. See also C<< $term->ROW_t >>.
453
454When setting rendition, the font mask will be ignored.
455
456See the section on RENDITION, below.
457
458=item $length = $term->ROW_l ($row_number[, $new_length])
459
460Returns the number of screen cells that are in use ("the line length"). If
461it is C<-1>, then the line is part of a multiple-row logical "line", which
462means all characters are in use and it is continued on the next row.
433 463
434=item $text = $term->special_encode $string 464=item $text = $term->special_encode $string
435 465
436Converts a perl string into the special encoding used by rxvt-unicode, 466Converts a perl string into the special encoding used by rxvt-unicode,
437where one character corresponds to one screen cell. See 467where one character corresponds to one screen cell. See
… …
441 471
442Converts rxvt-unicodes text reprsentation into a perl string. See 472Converts rxvt-unicodes text reprsentation into a perl string. See
443C<< $term->ROW_t >> for details. 473C<< $term->ROW_t >> for details.
444 474
445=back 475=back
476
477=head2 RENDITION
478
479Rendition bitsets contain information about colour, font, font styles and
480similar information for each screen cell.
481
482The following "macros" deal with changes in rendition sets. You should
483never just create a bitset, you should always modify an existing one,
484as they contain important information required for correct operation of
485rxvt-unicode.
486
487=over 4
488
489=item $rend = urxvt::DEFAULT_RSTYLE
490
491Returns the default rendition, as used when the terminal is starting up or
492being reset. Useful as a base
493
494=back
495
496=cut
446 497
447=head2 The C<urxvt::timer> Class 498=head2 The C<urxvt::timer> Class
448 499
449This class implements timer watchers/events. Time is represented as a 500This class implements timer watchers/events. Time is represented as a
450fractional number of seconds since the epoch. Example: 501fractional number of seconds since the epoch. Example:

Diff Legend

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