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.13 by root, Tue Jan 3 00:06:57 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
408=item $text = $term->ROW_t ($row_number[, $new_text]) 415=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
409 416
410Returns the text of the entire row with number C<$row_number>. Row C<0> 417Returns 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 418is 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 419terminal line. The scrollback buffer starts at line C<-1> and extends to
413line C<< -$term->nsaved >>. 420line C<< -$term->nsaved >>.
414 421
415If C<$new_text> is specified, it will completely replace the current line. 422If C<$new_text> is specified, it will replace characters in the current
423line, starting at column C<$start_col> (default C<0>), which is useful
424to replace only parts of a line. The font iindex in the rendition will
425automatically be updated.
416 426
417C<$text> is in a special encoding: tabs and wide characters that use more 427C<$text> is in a special encoding: tabs and wide characters that use more
418than one cell when displayed are padded with urxvt::NOCHAR characters 428than one cell when displayed are padded with urxvt::NOCHAR characters
419(C<chr 65535>). Characters with combining characters and other characters 429(C<chr 65535>). Characters with combining characters and other characters
420that do not fit into the normal tetx encoding will be replaced with 430that do not fit into the normal tetx encoding will be replaced with
… …
425characters. 435characters.
426 436
427The methods C<< $term->special_encode >> and C<< $term->special_decode >> 437The methods C<< $term->special_encode >> and C<< $term->special_decode >>
428can be used to convert normal strings into this encoding and vice versa. 438can be used to convert normal strings into this encoding and vice versa.
429 439
430=item $rend = $term->ROW_r ($row_number[, $new_rend]) 440=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
431 441
432Like C<< $term->ROW_t >> 442Like C<< $term->ROW_t >>, but returns an arrayref with rendition
443bitsets. Rendition bitsets contain information about colour, font, font
444styles and similar information. See also C<< $term->ROW_t >>.
445
446When setting rendition, the font mask will be ignored.
447
448See the section on RENDITION, below.
449
450=item $length = $term->ROW_l ($row_number[, $new_length])
451
452Returns the number of screen cells that are in use ("the line length"). If
453it is C<-1>, then the line is part of a multiple-row logical "line", which
454means all characters are in use and it is continued on the next row.
433 455
434=item $text = $term->special_encode $string 456=item $text = $term->special_encode $string
435 457
436Converts a perl string into the special encoding used by rxvt-unicode, 458Converts a perl string into the special encoding used by rxvt-unicode,
437where one character corresponds to one screen cell. See 459where one character corresponds to one screen cell. See
… …
441 463
442Converts rxvt-unicodes text reprsentation into a perl string. See 464Converts rxvt-unicodes text reprsentation into a perl string. See
443C<< $term->ROW_t >> for details. 465C<< $term->ROW_t >> for details.
444 466
445=back 467=back
468
469=head2 RENDITION
470
471Rendition bitsets contain information about colour, font, font styles and
472similar information for each screen cell.
473
474The following "macros" deal with changes in rendition sets. You should
475never just create a bitset, you should always modify an existing one,
476as they contain important information required for correct operation of
477rxvt-unicode.
478
479=over 4
480
481=item $rend = urxvt::DEFAULT_RSTYLE
482
483Returns the default rendition, as used when the terminal is starting up or
484being reset. Useful as a base
485
486=back
487
488=cut
446 489
447=head2 The C<urxvt::timer> Class 490=head2 The C<urxvt::timer> Class
448 491
449This class implements timer watchers/events. Time is represented as a 492This class implements timer watchers/events. Time is represented as a
450fractional number of seconds since the epoch. Example: 493fractional number of seconds since the epoch. Example:

Diff Legend

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