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