… | |
… | |
108 | reference. The string will be used as button text and the code reference |
108 | reference. The string will be used as button text and the code reference |
109 | will be called when the toggle changes, with the new boolean value as |
109 | will be called when the toggle changes, with the new boolean value as |
110 | first argument. |
110 | first argument. |
111 | |
111 | |
112 | The following will add an entry C<myoption> that changes |
112 | The following will add an entry C<myoption> that changes |
113 | C<$self->{myoption}>: |
113 | C<< $self->{myoption} >>: |
114 | |
114 | |
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
117 | }; |
117 | }; |
118 | |
118 | |
… | |
… | |
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. |
… | |
… | |
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 wether xrdb is used to parse the resource file |
370 | or not. |
376 | or not. |
|
|
377 | |
|
|
378 | =item macosx-pastebin and macosx-pastebin-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<maxosx-pastebin> 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 |
… | |
… | |
541 | |
561 | |
542 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
562 | 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 |
563 | $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. |
564 | number of lines that will be in the scrollback buffer. |
545 | |
565 | |
546 | =item on_osc_seq $term, $op, $args |
566 | =item on_osc_seq $term, $op, $args, $resp |
547 | |
567 | |
548 | Called on every OSC sequence and can be used to suppress it or modify its |
568 | 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 |
569 | 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 |
570 | suppresses execution of the request completely. Make sure you don't get |
551 | confused by recursive invocations when you output an osc sequence within |
571 | confused by recursive invocations when you output an OSC sequence within |
552 | this callback. |
572 | this callback. |
553 | |
573 | |
554 | C<on_osc_seq_perl> should be used for new behaviour. |
574 | C<on_osc_seq_perl> should be used for new behaviour. |
555 | |
575 | |
556 | =item on_osc_seq_perl $term, $string |
576 | =item on_osc_seq_perl $term, $args, $resp |
557 | |
577 | |
558 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
578 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
559 | operating system command) is processed. Cursor position and other state |
579 | operating system command) is processed. Cursor position and other state |
560 | information is up-to-date when this happens. For interoperability, the |
580 | information is up-to-date when this happens. For interoperability, the |
561 | string should start with the extension name and a colon, to distinguish |
581 | 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 |
582 | to distinguish it from commands for other extensions, and this might be |
563 | future. |
583 | enforced in the future. |
|
|
584 | |
|
|
585 | For example, C<overlay-osc> uses this: |
|
|
586 | |
|
|
587 | sub on_osc_seq_perl { |
|
|
588 | my ($self, $osc, $resp) = @_; |
|
|
589 | |
|
|
590 | return unless $osc =~ s/^overlay;//; |
|
|
591 | |
|
|
592 | ... process remaining $osc string |
|
|
593 | } |
564 | |
594 | |
565 | Be careful not ever to trust (in a security sense) the data you receive, |
595 | 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 |
596 | as its source can not easily be controlled (e-mail content, messages from |
567 | other users on the same system etc.). |
597 | other users on the same system etc.). |
|
|
598 | |
|
|
599 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
600 | sender. |
568 | |
601 | |
569 | =item on_add_lines $term, $string |
602 | =item on_add_lines $term, $string |
570 | |
603 | |
571 | Called whenever text is about to be output, with the text as argument. You |
604 | 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 |
605 | can filter/change and output the text yourself by returning a true value |
… | |
… | |
593 | later with the already-modified line (e.g. if unrelated parts change), so |
626 | later with the already-modified line (e.g. if unrelated parts change), so |
594 | you cannot just toggle rendition bits, but only set them. |
627 | you cannot just toggle rendition bits, but only set them. |
595 | |
628 | |
596 | =item on_refresh_begin $term |
629 | =item on_refresh_begin $term |
597 | |
630 | |
598 | Called just before the screen gets redrawn. Can be used for overlay |
631 | 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 |
632 | similar effects by modifying the terminal contents in refresh_begin, and |
600 | restoring them in refresh_end. The built-in overlay and selection display |
633 | restoring them in refresh_end. The built-in overlay and selection display |
601 | code is run after this hook, and takes precedence. |
634 | code is run after this hook, and takes precedence. |
602 | |
635 | |
603 | =item on_refresh_end $term |
636 | =item on_refresh_end $term |
604 | |
637 | |
… | |
… | |
1091 | is that you cannot use blocking APIs, but the non-blocking variant should |
1124 | is that you cannot use blocking APIs, but the non-blocking variant should |
1092 | work. |
1125 | work. |
1093 | |
1126 | |
1094 | =cut |
1127 | =cut |
1095 | |
1128 | |
1096 | our $VERSION = '3.4'; |
1129 | our $VERSION = '5.23'; |
1097 | |
1130 | |
1098 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1131 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1099 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1132 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1100 | |
1133 | |
1101 | sub timer { |
1134 | sub timer { |
… | |
… | |
1103 | |
1136 | |
1104 | my $cb = $arg{cb}; |
1137 | my $cb = $arg{cb}; |
1105 | |
1138 | |
1106 | urxvt::timer |
1139 | urxvt::timer |
1107 | ->new |
1140 | ->new |
1108 | ->start (urxvt::NOW + $arg{after}) |
1141 | ->after ($arg{after}, $arg{interval}) |
1109 | ->cb (sub { |
1142 | ->cb ($arg{interval} ? $cb : sub { |
1110 | $_[0]->stop; # need to cancel manually |
1143 | $_[0]->stop; # need to cancel manually |
1111 | $cb->(); |
1144 | $cb->(); |
1112 | }) |
1145 | }) |
1113 | } |
1146 | } |
1114 | |
1147 | |
1115 | sub io { |
1148 | sub io { |
1116 | my ($class, %arg) = @_; |
1149 | my ($class, %arg) = @_; |
1117 | |
1150 | |
1118 | my $cb = $arg{cb}; |
1151 | my $cb = $arg{cb}; |
|
|
1152 | my $fd = fileno $arg{fh}; |
|
|
1153 | defined $fd or $fd = $arg{fh}; |
1119 | |
1154 | |
1120 | bless [$arg{fh}, urxvt::iow |
1155 | bless [$arg{fh}, urxvt::iow |
1121 | ->new |
1156 | ->new |
1122 | ->fd (fileno $arg{fh}) |
1157 | ->fd ($fd) |
1123 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1158 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1124 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1159 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1125 | ->start |
1160 | ->start |
1126 | ->cb (sub { |
1161 | ->cb ($cb) |
1127 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
1128 | . ($_[1] & 2 ? 'w' : '')); |
|
|
1129 | })], |
|
|
1130 | urxvt::anyevent:: |
1162 | ], urxvt::anyevent:: |
|
|
1163 | } |
|
|
1164 | |
|
|
1165 | sub idle { |
|
|
1166 | my ($class, %arg) = @_; |
|
|
1167 | |
|
|
1168 | my $cb = $arg{cb}; |
|
|
1169 | |
|
|
1170 | urxvt::iw |
|
|
1171 | ->new |
|
|
1172 | ->start |
|
|
1173 | ->cb ($cb) |
|
|
1174 | } |
|
|
1175 | |
|
|
1176 | sub child { |
|
|
1177 | my ($class, %arg) = @_; |
|
|
1178 | |
|
|
1179 | my $cb = $arg{cb}; |
|
|
1180 | |
|
|
1181 | urxvt::pw |
|
|
1182 | ->new |
|
|
1183 | ->start ($arg{pid}) |
|
|
1184 | ->cb (sub { |
|
|
1185 | $_[0]->stop; # need to cancel manually |
|
|
1186 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1187 | }) |
1131 | } |
1188 | } |
1132 | |
1189 | |
1133 | sub DESTROY { |
1190 | sub DESTROY { |
1134 | $_[0][1]->stop; |
1191 | $_[0][1]->stop; |
1135 | } |
1192 | } |
… | |
… | |
1265 | |
1322 | |
1266 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1323 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1267 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1324 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1268 | display_name embed ext_bwidth fade font geometry hold iconName |
1325 | display_name embed ext_bwidth fade font geometry hold iconName |
1269 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1326 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1270 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1327 | italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 |
1271 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1328 | modifier mouseWheelScrollPage name override_redirect pastableTabs path |
1272 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1329 | perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1273 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1330 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1274 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1331 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1275 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1332 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1276 | secondaryScreen secondaryScroll shade term_name title |
1333 | secondaryScreen secondaryScroll shade term_name title |
1277 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1334 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
… | |
… | |
1280 | =cut |
1337 | =cut |
1281 | |
1338 | |
1282 | sub resource($$;$) { |
1339 | sub resource($$;$) { |
1283 | my ($self, $name) = (shift, shift); |
1340 | my ($self, $name) = (shift, shift); |
1284 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1341 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1285 | &urxvt::term::_resource |
1342 | goto &urxvt::term::_resource |
1286 | } |
1343 | } |
1287 | |
1344 | |
1288 | =item $value = $term->x_resource ($pattern) |
1345 | =item $value = $term->x_resource ($pattern) |
1289 | |
1346 | |
1290 | Returns the X-Resource for the given pattern, excluding the program or |
1347 | Returns the X-Resource for the given pattern, excluding the program or |
… | |
… | |
1373 | |
1430 | |
1374 | The methods currently supported on C<urxvt::overlay> objects are: |
1431 | The methods currently supported on C<urxvt::overlay> objects are: |
1375 | |
1432 | |
1376 | =over 4 |
1433 | =over 4 |
1377 | |
1434 | |
1378 | =item $overlay->set ($x, $y, $text, $rend) |
1435 | =item $overlay->set ($x, $y, $text[, $rend]) |
1379 | |
1436 | |
1380 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1437 | 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 |
1438 | text in rxvt-unicode's special encoding and an array of rendition values |
1382 | at a specific position inside the overlay. |
1439 | at a specific position inside the overlay. |
|
|
1440 | |
|
|
1441 | If C<$rend> is missing, then the rendition will not be changed. |
1383 | |
1442 | |
1384 | =item $overlay->hide |
1443 | =item $overlay->hide |
1385 | |
1444 | |
1386 | If visible, hide the overlay, but do not destroy it. |
1445 | If visible, hide the overlay, but do not destroy it. |
1387 | |
1446 | |
… | |
… | |
1807 | |
1866 | |
1808 | =item @atoms = $term->XListProperties ($window) |
1867 | =item @atoms = $term->XListProperties ($window) |
1809 | |
1868 | |
1810 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1869 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1811 | |
1870 | |
1812 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
1871 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
1813 | |
1872 | |
1814 | =item $term->XDeleteProperty ($window, $property) |
1873 | =item $term->XDeleteProperty ($window, $property) |
1815 | |
1874 | |
1816 | =item $window = $term->DefaultRootWindow |
1875 | =item $window = $term->DefaultRootWindow |
1817 | |
1876 | |
… | |
… | |
1994 | |
2053 | |
1995 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2054 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
1996 | |
2055 | |
1997 | Set the callback to be called when the timer triggers. |
2056 | Set the callback to be called when the timer triggers. |
1998 | |
2057 | |
1999 | =item $tstamp = $timer->at |
|
|
2000 | |
|
|
2001 | Return the time this watcher will fire next. |
|
|
2002 | |
|
|
2003 | =item $timer = $timer->set ($tstamp) |
2058 | =item $timer = $timer->set ($tstamp[, $interval]) |
2004 | |
2059 | |
2005 | Set the time the event is generated to $tstamp. |
2060 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
2061 | new $interval). |
2006 | |
2062 | |
2007 | =item $timer = $timer->interval ($interval) |
2063 | =item $timer = $timer->interval ($interval) |
2008 | |
2064 | |
2009 | Normally (and when C<$interval> is C<0>), the timer will automatically |
2065 | 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 |
2066 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2011 | is automatically rescheduled at the given intervals. |
2067 | is automatically rescheduled at the given intervals. |
2012 | |
2068 | |
2013 | =item $timer = $timer->start |
2069 | =item $timer = $timer->start |
2014 | |
2070 | |
2015 | Start the timer. |
2071 | Start the timer. |
2016 | |
2072 | |
2017 | =item $timer = $timer->start ($tstamp) |
2073 | =item $timer = $timer->start ($tstamp[, $interval]) |
2018 | |
2074 | |
2019 | Set the event trigger time to C<$tstamp> and start the timer. |
2075 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2076 | also replaces the interval. |
2020 | |
2077 | |
2021 | =item $timer = $timer->after ($delay) |
2078 | =item $timer = $timer->after ($delay[, $interval]) |
2022 | |
2079 | |
2023 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2080 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2024 | |
2081 | |
2025 | =item $timer = $timer->stop |
2082 | =item $timer = $timer->stop |
2026 | |
2083 | |