… | |
… | |
303 | extension will actually grab a physical key just for this function. |
303 | extension will actually grab a physical key just for this function. |
304 | |
304 | |
305 | If you want a quake-like animation, tell your window manager to do so |
305 | If you want a quake-like animation, tell your window manager to do so |
306 | (fvwm can do it). |
306 | (fvwm can do it). |
307 | |
307 | |
|
|
308 | =item overlay-osc |
|
|
309 | |
|
|
310 | This extension implements some OSC commands to display timed popups on the |
|
|
311 | screen - useful for status displays from within scripts. You have to read |
|
|
312 | the sources for more info. |
|
|
313 | |
308 | =item block-graphics-to-ascii |
314 | =item block-graphics-to-ascii |
309 | |
315 | |
310 | A not very useful example of filtering all text output to the terminal |
316 | A not very useful example of filtering all text output to the terminal |
311 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
317 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
312 | similar-looking ascii character. |
318 | similar-looking ascii character. |
… | |
… | |
335 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
341 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
336 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
342 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
337 | |
343 | |
338 | =item selection-pastebin |
344 | =item selection-pastebin |
339 | |
345 | |
340 | This is a little rarely useful extension that Uploads the selection as |
346 | This is a little rarely useful extension that uploads the selection as |
341 | textfile to a remote site (or does other things). (The implementation is |
347 | textfile to a remote site (or does other things). (The implementation is |
342 | not currently secure for use in a multiuser environment as it writes to |
348 | not currently secure for use in a multiuser environment as it writes to |
343 | F</tmp> directly.). |
349 | F</tmp> directly.). |
344 | |
350 | |
345 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
351 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
… | |
… | |
364 | |
370 | |
365 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
371 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
366 | |
372 | |
367 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
373 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
368 | the double C</> characters as comment start. Use C<\057\057> instead, |
374 | the double C</> characters as comment start. Use C<\057\057> instead, |
369 | which works regardless of wether xrdb is used to parse the resource file |
375 | which works regardless of whether xrdb is used to parse the resource file |
370 | or not. |
376 | or not. |
|
|
377 | |
|
|
378 | =item macosx-clipboard and macosx-clipboard-native |
|
|
379 | |
|
|
380 | These two modules implement an extended clipboard for Mac OS X. They are |
|
|
381 | used like this: |
|
|
382 | |
|
|
383 | URxvt.perl-ext-common: default,macosx-clipboard |
|
|
384 | URxvt.keysym.M-c: perl:macosx-clipboard:copy |
|
|
385 | URxvt.keysym.M-v: perl:macosx-clipboard:paste |
|
|
386 | |
|
|
387 | The difference between them is that the native variant requires a |
|
|
388 | perl from apple's devkit or so, and C<macosx-clipboard> requires the |
|
|
389 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
|
|
390 | simpler etc. etc. |
371 | |
391 | |
372 | =item example-refresh-hooks |
392 | =item example-refresh-hooks |
373 | |
393 | |
374 | Displays a very simple digital clock in the upper right corner of the |
394 | Displays a very simple digital clock in the upper right corner of the |
375 | window. Illustrates overwriting the refresh callbacks to create your own |
395 | window. Illustrates overwriting the refresh callbacks to create your own |
376 | overlays or changes. |
396 | overlays or changes. |
|
|
397 | |
|
|
398 | =item confirm-paste |
|
|
399 | |
|
|
400 | Displays a confirmation dialog when a paste containing at least a full |
|
|
401 | line is detected. |
377 | |
402 | |
378 | =back |
403 | =back |
379 | |
404 | |
380 | =head1 API DOCUMENTATION |
405 | =head1 API DOCUMENTATION |
381 | |
406 | |
… | |
… | |
397 | |
422 | |
398 | =over 4 |
423 | =over 4 |
399 | |
424 | |
400 | =item $text |
425 | =item $text |
401 | |
426 | |
402 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
427 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
403 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
428 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
404 | |
429 | |
405 | =item $string |
430 | =item $string |
406 | |
431 | |
407 | A perl text string, with an emphasis on I<text>. It can store all unicode |
432 | A perl text string, with an emphasis on I<text>. It can store all unicode |
… | |
… | |
541 | |
566 | |
542 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
567 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
543 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
568 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
544 | number of lines that will be in the scrollback buffer. |
569 | number of lines that will be in the scrollback buffer. |
545 | |
570 | |
546 | =item on_osc_seq $term, $op, $args |
571 | =item on_osc_seq $term, $op, $args, $resp |
547 | |
572 | |
548 | Called on every OSC sequence and can be used to suppress it or modify its |
573 | Called on every OSC sequence and can be used to suppress it or modify its |
549 | behaviour. The default should be to return an empty list. A true value |
574 | behaviour. The default should be to return an empty list. A true value |
550 | suppresses execution of the request completely. Make sure you don't get |
575 | suppresses execution of the request completely. Make sure you don't get |
551 | confused by recursive invocations when you output an osc sequence within |
576 | confused by recursive invocations when you output an OSC sequence within |
552 | this callback. |
577 | this callback. |
553 | |
578 | |
554 | C<on_osc_seq_perl> should be used for new behaviour. |
579 | C<on_osc_seq_perl> should be used for new behaviour. |
555 | |
580 | |
556 | =item on_osc_seq_perl $term, $string |
581 | =item on_osc_seq_perl $term, $args, $resp |
557 | |
582 | |
558 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
583 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
559 | operating system command) is processed. Cursor position and other state |
584 | operating system command) is processed. Cursor position and other state |
560 | information is up-to-date when this happens. For interoperability, the |
585 | information is up-to-date when this happens. For interoperability, the |
561 | string should start with the extension name and a colon, to distinguish |
586 | string should start with the extension name (sans -osc) and a semicolon, |
562 | it from commands for other extensions, and this might be enforced in the |
587 | to distinguish it from commands for other extensions, and this might be |
563 | future. |
588 | enforced in the future. |
|
|
589 | |
|
|
590 | For example, C<overlay-osc> uses this: |
|
|
591 | |
|
|
592 | sub on_osc_seq_perl { |
|
|
593 | my ($self, $osc, $resp) = @_; |
|
|
594 | |
|
|
595 | return unless $osc =~ s/^overlay;//; |
|
|
596 | |
|
|
597 | ... process remaining $osc string |
|
|
598 | } |
564 | |
599 | |
565 | Be careful not ever to trust (in a security sense) the data you receive, |
600 | Be careful not ever to trust (in a security sense) the data you receive, |
566 | as its source can not easily be controlled (e-mail content, messages from |
601 | as its source can not easily be controlled (e-mail content, messages from |
567 | other users on the same system etc.). |
602 | other users on the same system etc.). |
|
|
603 | |
|
|
604 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
605 | sender. |
568 | |
606 | |
569 | =item on_add_lines $term, $string |
607 | =item on_add_lines $term, $string |
570 | |
608 | |
571 | Called whenever text is about to be output, with the text as argument. You |
609 | Called whenever text is about to be output, with the text as argument. You |
572 | can filter/change and output the text yourself by returning a true value |
610 | can filter/change and output the text yourself by returning a true value |
… | |
… | |
577 | =item on_tt_write $term, $octets |
615 | =item on_tt_write $term, $octets |
578 | |
616 | |
579 | Called whenever some data is written to the tty/pty and can be used to |
617 | Called whenever some data is written to the tty/pty and can be used to |
580 | suppress or filter tty input. |
618 | suppress or filter tty input. |
581 | |
619 | |
|
|
620 | =item on_tt_paste $term, $octets |
|
|
621 | |
|
|
622 | Called whenever text is about to be pasted, with the text as argument. You |
|
|
623 | can filter/change and paste the text yourself by returning a true value |
|
|
624 | and calling C<< $term->tt_paste >> yourself. C<$octets> is |
|
|
625 | locale-encoded. |
|
|
626 | |
582 | =item on_line_update $term, $row |
627 | =item on_line_update $term, $row |
583 | |
628 | |
584 | Called whenever a line was updated or changed. Can be used to filter |
629 | Called whenever a line was updated or changed. Can be used to filter |
585 | screen output (e.g. underline urls or other useless stuff). Only lines |
630 | screen output (e.g. underline urls or other useless stuff). Only lines |
586 | that are being shown will be filtered, and, due to performance reasons, |
631 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
593 | later with the already-modified line (e.g. if unrelated parts change), so |
638 | later with the already-modified line (e.g. if unrelated parts change), so |
594 | you cannot just toggle rendition bits, but only set them. |
639 | you cannot just toggle rendition bits, but only set them. |
595 | |
640 | |
596 | =item on_refresh_begin $term |
641 | =item on_refresh_begin $term |
597 | |
642 | |
598 | Called just before the screen gets redrawn. Can be used for overlay |
643 | Called just before the screen gets redrawn. Can be used for overlay or |
599 | or similar effects by modify terminal contents in refresh_begin, and |
644 | similar effects by modifying the terminal contents in refresh_begin, and |
600 | restoring them in refresh_end. The built-in overlay and selection display |
645 | restoring them in refresh_end. The built-in overlay and selection display |
601 | code is run after this hook, and takes precedence. |
646 | code is run after this hook, and takes precedence. |
602 | |
647 | |
603 | =item on_refresh_end $term |
648 | =item on_refresh_end $term |
604 | |
649 | |
… | |
… | |
611 | resource in the @@RXVT_NAME@@(1) manpage). |
656 | resource in the @@RXVT_NAME@@(1) manpage). |
612 | |
657 | |
613 | The event is simply the action string. This interface is assumed to change |
658 | The event is simply the action string. This interface is assumed to change |
614 | slightly in the future. |
659 | slightly in the future. |
615 | |
660 | |
616 | =item on_resize_all_windows $tern, $new_width, $new_height |
661 | =item on_resize_all_windows $term, $new_width, $new_height |
617 | |
662 | |
618 | Called just after the new window size has been calculated, but before |
663 | Called just after the new window size has been calculated, but before |
619 | windows are actually being resized or hints are being set. If this hook |
664 | windows are actually being resized or hints are being set. If this hook |
620 | returns TRUE, setting of the window hints is being skipped. |
665 | returns TRUE, setting of the window hints is being skipped. |
621 | |
666 | |
… | |
… | |
655 | |
700 | |
656 | =item on_map_notify $term, $event |
701 | =item on_map_notify $term, $event |
657 | |
702 | |
658 | =item on_unmap_notify $term, $event |
703 | =item on_unmap_notify $term, $event |
659 | |
704 | |
660 | Called whenever the corresponding X event is received for the terminal If |
705 | Called whenever the corresponding X event is received for the terminal. If |
661 | the hook returns true, then the even will be ignored by rxvt-unicode. |
706 | the hook returns true, then the event will be ignored by rxvt-unicode. |
662 | |
707 | |
663 | The event is a hash with most values as named by Xlib (see the XEvent |
708 | The event is a hash with most values as named by Xlib (see the XEvent |
664 | manpage), with the additional members C<row> and C<col>, which are the |
709 | manpage), with the additional members C<row> and C<col>, which are the |
665 | (real, not screen-based) row and column under the mouse cursor. |
710 | (real, not screen-based) row and column under the mouse cursor. |
666 | |
711 | |
… | |
… | |
675 | |
720 | |
676 | =item on_wm_delete_window $term, $event |
721 | =item on_wm_delete_window $term, $event |
677 | |
722 | |
678 | Called when various types of ClientMessage events are received (all with |
723 | Called when various types of ClientMessage events are received (all with |
679 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
724 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
725 | |
|
|
726 | =item on_bell $term |
|
|
727 | |
|
|
728 | Called on receipt of a bell character. |
680 | |
729 | |
681 | =back |
730 | =back |
682 | |
731 | |
683 | =cut |
732 | =cut |
684 | |
733 | |
… | |
… | |
822 | |
871 | |
823 | =item $rend = urxvt::OVERLAY_RSTYLE |
872 | =item $rend = urxvt::OVERLAY_RSTYLE |
824 | |
873 | |
825 | Return the rendition mask used for overlays by default. |
874 | Return the rendition mask used for overlays by default. |
826 | |
875 | |
827 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
876 | =item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, |
|
|
877 | urxvt::RS_RVid, urxvt::RS_Uline |
828 | |
878 | |
829 | Return the bit that enabled bold, italic, blink, reverse-video and |
879 | Return the bit that enabled bold, italic, blink, reverse-video and |
830 | underline, respectively. To enable such a style, just logically OR it into |
880 | underline, respectively. To enable such a style, just logically OR it into |
831 | the bitset. |
881 | the bitset. |
832 | |
882 | |
… | |
… | |
1091 | is that you cannot use blocking APIs, but the non-blocking variant should |
1141 | is that you cannot use blocking APIs, but the non-blocking variant should |
1092 | work. |
1142 | work. |
1093 | |
1143 | |
1094 | =cut |
1144 | =cut |
1095 | |
1145 | |
1096 | our $VERSION = '3.4'; |
1146 | our $VERSION = '5.23'; |
1097 | |
1147 | |
1098 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1148 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1099 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1149 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1100 | |
1150 | |
1101 | sub timer { |
1151 | sub timer { |
… | |
… | |
1103 | |
1153 | |
1104 | my $cb = $arg{cb}; |
1154 | my $cb = $arg{cb}; |
1105 | |
1155 | |
1106 | urxvt::timer |
1156 | urxvt::timer |
1107 | ->new |
1157 | ->new |
1108 | ->start (urxvt::NOW + $arg{after}) |
1158 | ->after ($arg{after}, $arg{interval}) |
1109 | ->cb (sub { |
1159 | ->cb ($arg{interval} ? $cb : sub { |
1110 | $_[0]->stop; # need to cancel manually |
1160 | $_[0]->stop; # need to cancel manually |
1111 | $cb->(); |
1161 | $cb->(); |
1112 | }) |
1162 | }) |
1113 | } |
1163 | } |
1114 | |
1164 | |
1115 | sub io { |
1165 | sub io { |
1116 | my ($class, %arg) = @_; |
1166 | my ($class, %arg) = @_; |
1117 | |
1167 | |
1118 | my $cb = $arg{cb}; |
1168 | my $cb = $arg{cb}; |
|
|
1169 | my $fd = fileno $arg{fh}; |
|
|
1170 | defined $fd or $fd = $arg{fh}; |
1119 | |
1171 | |
1120 | bless [$arg{fh}, urxvt::iow |
1172 | bless [$arg{fh}, urxvt::iow |
1121 | ->new |
1173 | ->new |
1122 | ->fd (fileno $arg{fh}) |
1174 | ->fd ($fd) |
1123 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1175 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1124 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1176 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1125 | ->start |
1177 | ->start |
1126 | ->cb (sub { |
1178 | ->cb ($cb) |
1127 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
1128 | . ($_[1] & 2 ? 'w' : '')); |
|
|
1129 | })], |
|
|
1130 | urxvt::anyevent:: |
1179 | ], urxvt::anyevent:: |
|
|
1180 | } |
|
|
1181 | |
|
|
1182 | sub idle { |
|
|
1183 | my ($class, %arg) = @_; |
|
|
1184 | |
|
|
1185 | my $cb = $arg{cb}; |
|
|
1186 | |
|
|
1187 | urxvt::iw |
|
|
1188 | ->new |
|
|
1189 | ->start |
|
|
1190 | ->cb ($cb) |
|
|
1191 | } |
|
|
1192 | |
|
|
1193 | sub child { |
|
|
1194 | my ($class, %arg) = @_; |
|
|
1195 | |
|
|
1196 | my $cb = $arg{cb}; |
|
|
1197 | |
|
|
1198 | urxvt::pw |
|
|
1199 | ->new |
|
|
1200 | ->start ($arg{pid}) |
|
|
1201 | ->cb (sub { |
|
|
1202 | $_[0]->stop; # need to cancel manually |
|
|
1203 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1204 | }) |
1131 | } |
1205 | } |
1132 | |
1206 | |
1133 | sub DESTROY { |
1207 | sub DESTROY { |
1134 | $_[0][1]->stop; |
1208 | $_[0][1]->stop; |
1135 | } |
1209 | } |
… | |
… | |
1265 | |
1339 | |
1266 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1340 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1267 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1341 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1268 | display_name embed ext_bwidth fade font geometry hold iconName |
1342 | display_name embed ext_bwidth fade font geometry hold iconName |
1269 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1343 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1270 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1344 | italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 |
1271 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1345 | modifier mouseWheelScrollPage name override_redirect pastableTabs path |
1272 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1346 | perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1273 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1347 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1274 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1348 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1275 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1349 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1276 | secondaryScreen secondaryScroll shade term_name title |
1350 | secondaryScreen secondaryScroll shade term_name title |
1277 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1351 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
… | |
… | |
1315 | |
1389 | |
1316 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1390 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1317 | |
1391 | |
1318 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1392 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1319 | |
1393 | |
1320 | Return the current values of the selection mark, begin or end positions, |
1394 | Return the current values of the selection mark, begin or end positions. |
1321 | and optionally set them to new values. |
1395 | |
|
|
1396 | When arguments are given, then the selection coordinates are set to |
|
|
1397 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1398 | screen. |
|
|
1399 | |
|
|
1400 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1401 | |
|
|
1402 | Returns the current selection screen, and then optionally sets it. |
1322 | |
1403 | |
1323 | =item $term->selection_make ($eventtime[, $rectangular]) |
1404 | =item $term->selection_make ($eventtime[, $rectangular]) |
1324 | |
1405 | |
1325 | Tries to make a selection as set by C<selection_beg> and |
1406 | Tries to make a selection as set by C<selection_beg> and |
1326 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1407 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1327 | rectangular selection will be made. This is the prefered function to make |
1408 | rectangular selection will be made. This is the preferred function to make |
1328 | a selection. |
1409 | a selection. |
1329 | |
1410 | |
1330 | =item $success = $term->selection_grab ($eventtime) |
1411 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
1331 | |
1412 | |
1332 | Try to request the primary selection text from the server (for example, as |
1413 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
|
|
1414 | true) selection from the server. The corresponding text can be set |
1333 | set by the next method). No visual feedback will be given. This function |
1415 | with the next method. No visual feedback will be given. This function |
1334 | is mostly useful from within C<on_sel_grab> hooks. |
1416 | is mostly useful from within C<on_sel_grab> hooks. |
1335 | |
1417 | |
1336 | =item $oldtext = $term->selection ([$newtext]) |
1418 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
1337 | |
1419 | |
1338 | Return the current selection text and optionally replace it by C<$newtext>. |
1420 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1421 | and optionally replace it by C<$newtext>. |
|
|
1422 | |
|
|
1423 | =item $term->selection_clear ([$clipboard]) |
|
|
1424 | |
|
|
1425 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
1339 | |
1426 | |
1340 | =item $term->overlay_simple ($x, $y, $text) |
1427 | =item $term->overlay_simple ($x, $y, $text) |
1341 | |
1428 | |
1342 | Create a simple multi-line overlay box. See the next method for details. |
1429 | Create a simple multi-line overlay box. See the next method for details. |
1343 | |
1430 | |
… | |
… | |
1373 | |
1460 | |
1374 | The methods currently supported on C<urxvt::overlay> objects are: |
1461 | The methods currently supported on C<urxvt::overlay> objects are: |
1375 | |
1462 | |
1376 | =over 4 |
1463 | =over 4 |
1377 | |
1464 | |
1378 | =item $overlay->set ($x, $y, $text, $rend) |
1465 | =item $overlay->set ($x, $y, $text[, $rend]) |
1379 | |
1466 | |
1380 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1467 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1381 | text in rxvt-unicode's special encoding and an array of rendition values |
1468 | text in rxvt-unicode's special encoding and an array of rendition values |
1382 | at a specific position inside the overlay. |
1469 | at a specific position inside the overlay. |
|
|
1470 | |
|
|
1471 | If C<$rend> is missing, then the rendition will not be changed. |
1383 | |
1472 | |
1384 | =item $overlay->hide |
1473 | =item $overlay->hide |
1385 | |
1474 | |
1386 | If visible, hide the overlay, but do not destroy it. |
1475 | If visible, hide the overlay, but do not destroy it. |
1387 | |
1476 | |
… | |
… | |
1469 | locale-specific encoding of the terminal and can contain command sequences |
1558 | locale-specific encoding of the terminal and can contain command sequences |
1470 | (escape codes) that will be interpreted. |
1559 | (escape codes) that will be interpreted. |
1471 | |
1560 | |
1472 | =item $term->tt_write ($octets) |
1561 | =item $term->tt_write ($octets) |
1473 | |
1562 | |
1474 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1563 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1475 | pass characters instead of octets, you should convert your strings first |
1564 | pass characters instead of octets, you should convert your strings first |
1476 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1565 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1566 | |
|
|
1567 | =item $term->tt_paste ($octets) |
|
|
1568 | |
|
|
1569 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1570 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1571 | is set. |
1477 | |
1572 | |
1478 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1573 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1479 | |
1574 | |
1480 | Replaces the event mask of the pty watcher by the given event mask. Can |
1575 | Replaces the event mask of the pty watcher by the given event mask. Can |
1481 | be used to suppress input and output handling to the pty/tty. See the |
1576 | be used to suppress input and output handling to the pty/tty. See the |
… | |
… | |
1795 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1890 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1796 | recent grab. |
1891 | recent grab. |
1797 | |
1892 | |
1798 | =item $term->ungrab |
1893 | =item $term->ungrab |
1799 | |
1894 | |
1800 | Calls XUngrab for the most recent grab. Is called automatically on |
1895 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
1801 | evaluation errors, as it is better to lose the grab in the error case as |
1896 | evaluation errors, as it is better to lose the grab in the error case as |
1802 | the session. |
1897 | the session. |
1803 | |
1898 | |
1804 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1899 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1805 | |
1900 | |
… | |
… | |
1827 | |
1922 | |
1828 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1923 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1829 | |
1924 | |
1830 | Various X or X-related functions. The C<$term> object only serves as |
1925 | Various X or X-related functions. The C<$term> object only serves as |
1831 | the source of the display, otherwise those functions map more-or-less |
1926 | the source of the display, otherwise those functions map more-or-less |
1832 | directory onto the X functions of the same name. |
1927 | directly onto the X functions of the same name. |
1833 | |
1928 | |
1834 | =back |
1929 | =back |
1835 | |
1930 | |
1836 | =cut |
1931 | =cut |
1837 | |
1932 | |
… | |
… | |
1994 | |
2089 | |
1995 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2090 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
1996 | |
2091 | |
1997 | Set the callback to be called when the timer triggers. |
2092 | Set the callback to be called when the timer triggers. |
1998 | |
2093 | |
1999 | =item $tstamp = $timer->at |
|
|
2000 | |
|
|
2001 | Return the time this watcher will fire next. |
|
|
2002 | |
|
|
2003 | =item $timer = $timer->set ($tstamp) |
2094 | =item $timer = $timer->set ($tstamp[, $interval]) |
2004 | |
2095 | |
2005 | Set the time the event is generated to $tstamp. |
2096 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
2097 | new $interval). |
2006 | |
2098 | |
2007 | =item $timer = $timer->interval ($interval) |
2099 | =item $timer = $timer->interval ($interval) |
2008 | |
2100 | |
2009 | Normally (and when C<$interval> is C<0>), the timer will automatically |
2101 | By default (and when C<$interval> is C<0>), the timer will automatically |
2010 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2102 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2011 | is automatically rescheduled at the given intervals. |
2103 | is automatically rescheduled at the given intervals. |
2012 | |
2104 | |
2013 | =item $timer = $timer->start |
2105 | =item $timer = $timer->start |
2014 | |
2106 | |
2015 | Start the timer. |
2107 | Start the timer. |
2016 | |
2108 | |
2017 | =item $timer = $timer->start ($tstamp) |
2109 | =item $timer = $timer->start ($tstamp[, $interval]) |
2018 | |
2110 | |
2019 | Set the event trigger time to C<$tstamp> and start the timer. |
2111 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2112 | also replaces the interval. |
2020 | |
2113 | |
2021 | =item $timer = $timer->after ($delay) |
2114 | =item $timer = $timer->after ($delay[, $interval]) |
2022 | |
2115 | |
2023 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2116 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2024 | |
2117 | |
2025 | =item $timer = $timer->stop |
2118 | =item $timer = $timer->stop |
2026 | |
2119 | |