| … | |
… | |
| 341 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
341 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
| 342 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
342 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
| 343 | |
343 | |
| 344 | =item selection-pastebin |
344 | =item selection-pastebin |
| 345 | |
345 | |
| 346 | 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 |
| 347 | 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 |
| 348 | 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 |
| 349 | F</tmp> directly.). |
349 | F</tmp> directly.). |
| 350 | |
350 | |
| 351 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
351 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
| … | |
… | |
| 370 | |
370 | |
| 371 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
371 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
| 372 | |
372 | |
| 373 | 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 |
| 374 | 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, |
| 375 | 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 |
| 376 | or not. |
376 | or not. |
| 377 | |
377 | |
| 378 | =item macosx-pastebin and macosx-pastebin-native |
378 | =item macosx-clipboard and macosx-clipboard-native |
| 379 | |
379 | |
| 380 | These two modules implement an extended clipboard for Mac OS X. They are |
380 | These two modules implement an extended clipboard for Mac OS X. They are |
| 381 | used like this: |
381 | used like this: |
| 382 | |
382 | |
| 383 | URxvt.perl-ext-common: default,macosx-clipboard |
383 | URxvt.perl-ext-common: default,macosx-clipboard |
| 384 | URxvt.keysym.M-c: perl:macosx-clipboard:copy |
384 | URxvt.keysym.M-c: perl:macosx-clipboard:copy |
| 385 | URxvt.keysym.M-v: perl:macosx-clipboard:paste |
385 | URxvt.keysym.M-v: perl:macosx-clipboard:paste |
| 386 | |
386 | |
| 387 | The difference between them is that the native variant requires a |
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 |
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 |
389 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
| 390 | simpler etc. etc. |
390 | simpler etc. etc. |
| 391 | |
391 | |
| 392 | =item example-refresh-hooks |
392 | =item example-refresh-hooks |
| 393 | |
393 | |
| … | |
… | |
| 417 | |
417 | |
| 418 | =over 4 |
418 | =over 4 |
| 419 | |
419 | |
| 420 | =item $text |
420 | =item $text |
| 421 | |
421 | |
| 422 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
422 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
| 423 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
423 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
| 424 | |
424 | |
| 425 | =item $string |
425 | =item $string |
| 426 | |
426 | |
| 427 | A perl text string, with an emphasis on I<text>. It can store all unicode |
427 | A perl text string, with an emphasis on I<text>. It can store all unicode |
| … | |
… | |
| 688 | |
688 | |
| 689 | =item on_map_notify $term, $event |
689 | =item on_map_notify $term, $event |
| 690 | |
690 | |
| 691 | =item on_unmap_notify $term, $event |
691 | =item on_unmap_notify $term, $event |
| 692 | |
692 | |
| 693 | Called whenever the corresponding X event is received for the terminal If |
693 | Called whenever the corresponding X event is received for the terminal. If |
| 694 | the hook returns true, then the even will be ignored by rxvt-unicode. |
694 | the hook returns true, then the event will be ignored by rxvt-unicode. |
| 695 | |
695 | |
| 696 | The event is a hash with most values as named by Xlib (see the XEvent |
696 | The event is a hash with most values as named by Xlib (see the XEvent |
| 697 | manpage), with the additional members C<row> and C<col>, which are the |
697 | manpage), with the additional members C<row> and C<col>, which are the |
| 698 | (real, not screen-based) row and column under the mouse cursor. |
698 | (real, not screen-based) row and column under the mouse cursor. |
| 699 | |
699 | |
| … | |
… | |
| 708 | |
708 | |
| 709 | =item on_wm_delete_window $term, $event |
709 | =item on_wm_delete_window $term, $event |
| 710 | |
710 | |
| 711 | Called when various types of ClientMessage events are received (all with |
711 | Called when various types of ClientMessage events are received (all with |
| 712 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
712 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
713 | |
|
|
714 | =item on_bell $term |
|
|
715 | |
|
|
716 | Called on receipt of a bell character. |
| 713 | |
717 | |
| 714 | =back |
718 | =back |
| 715 | |
719 | |
| 716 | =cut |
720 | =cut |
| 717 | |
721 | |
| … | |
… | |
| 1124 | is that you cannot use blocking APIs, but the non-blocking variant should |
1128 | is that you cannot use blocking APIs, but the non-blocking variant should |
| 1125 | work. |
1129 | work. |
| 1126 | |
1130 | |
| 1127 | =cut |
1131 | =cut |
| 1128 | |
1132 | |
| 1129 | our $VERSION = '3.4'; |
1133 | our $VERSION = '5.23'; |
| 1130 | |
1134 | |
| 1131 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1135 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
| 1132 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1136 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
| 1133 | |
1137 | |
| 1134 | sub timer { |
1138 | sub timer { |
| … | |
… | |
| 1136 | |
1140 | |
| 1137 | my $cb = $arg{cb}; |
1141 | my $cb = $arg{cb}; |
| 1138 | |
1142 | |
| 1139 | urxvt::timer |
1143 | urxvt::timer |
| 1140 | ->new |
1144 | ->new |
| 1141 | ->start (urxvt::NOW + $arg{after}) |
1145 | ->after ($arg{after}, $arg{interval}) |
| 1142 | ->cb (sub { |
1146 | ->cb ($arg{interval} ? $cb : sub { |
| 1143 | $_[0]->stop; # need to cancel manually |
1147 | $_[0]->stop; # need to cancel manually |
| 1144 | $cb->(); |
1148 | $cb->(); |
| 1145 | }) |
1149 | }) |
| 1146 | } |
1150 | } |
| 1147 | |
1151 | |
| 1148 | sub io { |
1152 | sub io { |
| 1149 | my ($class, %arg) = @_; |
1153 | my ($class, %arg) = @_; |
| 1150 | |
1154 | |
| 1151 | my $cb = $arg{cb}; |
1155 | my $cb = $arg{cb}; |
|
|
1156 | my $fd = fileno $arg{fh}; |
|
|
1157 | defined $fd or $fd = $arg{fh}; |
| 1152 | |
1158 | |
| 1153 | bless [$arg{fh}, urxvt::iow |
1159 | bless [$arg{fh}, urxvt::iow |
| 1154 | ->new |
1160 | ->new |
| 1155 | ->fd (fileno $arg{fh}) |
1161 | ->fd ($fd) |
| 1156 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1162 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
| 1157 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1163 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
| 1158 | ->start |
1164 | ->start |
| 1159 | ->cb (sub { |
1165 | ->cb ($cb) |
| 1160 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
| 1161 | . ($_[1] & 2 ? 'w' : '')); |
|
|
| 1162 | })], |
|
|
| 1163 | urxvt::anyevent:: |
1166 | ], urxvt::anyevent:: |
|
|
1167 | } |
|
|
1168 | |
|
|
1169 | sub idle { |
|
|
1170 | my ($class, %arg) = @_; |
|
|
1171 | |
|
|
1172 | my $cb = $arg{cb}; |
|
|
1173 | |
|
|
1174 | urxvt::iw |
|
|
1175 | ->new |
|
|
1176 | ->start |
|
|
1177 | ->cb ($cb) |
|
|
1178 | } |
|
|
1179 | |
|
|
1180 | sub child { |
|
|
1181 | my ($class, %arg) = @_; |
|
|
1182 | |
|
|
1183 | my $cb = $arg{cb}; |
|
|
1184 | |
|
|
1185 | urxvt::pw |
|
|
1186 | ->new |
|
|
1187 | ->start ($arg{pid}) |
|
|
1188 | ->cb (sub { |
|
|
1189 | $_[0]->stop; # need to cancel manually |
|
|
1190 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1191 | }) |
| 1164 | } |
1192 | } |
| 1165 | |
1193 | |
| 1166 | sub DESTROY { |
1194 | sub DESTROY { |
| 1167 | $_[0][1]->stop; |
1195 | $_[0][1]->stop; |
| 1168 | } |
1196 | } |
| … | |
… | |
| 1348 | |
1376 | |
| 1349 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1377 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
| 1350 | |
1378 | |
| 1351 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1379 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
| 1352 | |
1380 | |
| 1353 | Return the current values of the selection mark, begin or end positions, |
1381 | Return the current values of the selection mark, begin or end positions. |
| 1354 | and optionally set them to new values. |
1382 | |
|
|
1383 | When arguments are given, then the selection coordinates are set to |
|
|
1384 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1385 | screen. |
|
|
1386 | |
|
|
1387 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1388 | |
|
|
1389 | Returns the current selection screen, and then optionally sets it. |
| 1355 | |
1390 | |
| 1356 | =item $term->selection_make ($eventtime[, $rectangular]) |
1391 | =item $term->selection_make ($eventtime[, $rectangular]) |
| 1357 | |
1392 | |
| 1358 | Tries to make a selection as set by C<selection_beg> and |
1393 | Tries to make a selection as set by C<selection_beg> and |
| 1359 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1394 | C<selection_end>. If C<$rectangular> is true (default: false), a |
| 1360 | rectangular selection will be made. This is the prefered function to make |
1395 | rectangular selection will be made. This is the prefered function to make |
| 1361 | a selection. |
1396 | a selection. |
| 1362 | |
1397 | |
| 1363 | =item $success = $term->selection_grab ($eventtime) |
1398 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
| 1364 | |
1399 | |
| 1365 | Try to request the primary selection text from the server (for example, as |
1400 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
|
|
1401 | true) selection from the server. The corresponding text can be set |
| 1366 | set by the next method). No visual feedback will be given. This function |
1402 | with the next method. No visual feedback will be given. This function |
| 1367 | is mostly useful from within C<on_sel_grab> hooks. |
1403 | is mostly useful from within C<on_sel_grab> hooks. |
| 1368 | |
1404 | |
| 1369 | =item $oldtext = $term->selection ([$newtext]) |
1405 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
| 1370 | |
1406 | |
| 1371 | Return the current selection text and optionally replace it by C<$newtext>. |
1407 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1408 | and optionally replace it by C<$newtext>. |
|
|
1409 | |
|
|
1410 | =item $term->selection_clear ([$clipboard]) |
|
|
1411 | |
|
|
1412 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
| 1372 | |
1413 | |
| 1373 | =item $term->overlay_simple ($x, $y, $text) |
1414 | =item $term->overlay_simple ($x, $y, $text) |
| 1374 | |
1415 | |
| 1375 | Create a simple multi-line overlay box. See the next method for details. |
1416 | Create a simple multi-line overlay box. See the next method for details. |
| 1376 | |
1417 | |
| … | |
… | |
| 1830 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1871 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
| 1831 | recent grab. |
1872 | recent grab. |
| 1832 | |
1873 | |
| 1833 | =item $term->ungrab |
1874 | =item $term->ungrab |
| 1834 | |
1875 | |
| 1835 | Calls XUngrab for the most recent grab. Is called automatically on |
1876 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
| 1836 | evaluation errors, as it is better to lose the grab in the error case as |
1877 | evaluation errors, as it is better to lose the grab in the error case as |
| 1837 | the session. |
1878 | the session. |
| 1838 | |
1879 | |
| 1839 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1880 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
| 1840 | |
1881 | |
| … | |
… | |
| 1862 | |
1903 | |
| 1863 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1904 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
| 1864 | |
1905 | |
| 1865 | Various X or X-related functions. The C<$term> object only serves as |
1906 | Various X or X-related functions. The C<$term> object only serves as |
| 1866 | the source of the display, otherwise those functions map more-or-less |
1907 | the source of the display, otherwise those functions map more-or-less |
| 1867 | directory onto the X functions of the same name. |
1908 | directly onto the X functions of the same name. |
| 1868 | |
1909 | |
| 1869 | =back |
1910 | =back |
| 1870 | |
1911 | |
| 1871 | =cut |
1912 | =cut |
| 1872 | |
1913 | |
| … | |
… | |
| 2029 | |
2070 | |
| 2030 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2071 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
| 2031 | |
2072 | |
| 2032 | Set the callback to be called when the timer triggers. |
2073 | Set the callback to be called when the timer triggers. |
| 2033 | |
2074 | |
| 2034 | =item $tstamp = $timer->at |
|
|
| 2035 | |
|
|
| 2036 | Return the time this watcher will fire next. |
|
|
| 2037 | |
|
|
| 2038 | =item $timer = $timer->set ($tstamp) |
2075 | =item $timer = $timer->set ($tstamp[, $interval]) |
| 2039 | |
2076 | |
| 2040 | Set the time the event is generated to $tstamp. |
2077 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
2078 | new $interval). |
| 2041 | |
2079 | |
| 2042 | =item $timer = $timer->interval ($interval) |
2080 | =item $timer = $timer->interval ($interval) |
| 2043 | |
2081 | |
| 2044 | Normally (and when C<$interval> is C<0>), the timer will automatically |
2082 | By default (and when C<$interval> is C<0>), the timer will automatically |
| 2045 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2083 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
| 2046 | is automatically rescheduled at the given intervals. |
2084 | is automatically rescheduled at the given intervals. |
| 2047 | |
2085 | |
| 2048 | =item $timer = $timer->start |
2086 | =item $timer = $timer->start |
| 2049 | |
2087 | |
| 2050 | Start the timer. |
2088 | Start the timer. |
| 2051 | |
2089 | |
| 2052 | =item $timer = $timer->start ($tstamp) |
2090 | =item $timer = $timer->start ($tstamp[, $interval]) |
| 2053 | |
2091 | |
| 2054 | Set the event trigger time to C<$tstamp> and start the timer. |
2092 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2093 | also replaces the interval. |
| 2055 | |
2094 | |
| 2056 | =item $timer = $timer->after ($delay) |
2095 | =item $timer = $timer->after ($delay[, $interval]) |
| 2057 | |
2096 | |
| 2058 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2097 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
| 2059 | |
2098 | |
| 2060 | =item $timer = $timer->stop |
2099 | =item $timer = $timer->stop |
| 2061 | |
2100 | |
