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