ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.174 by root, Sat May 30 08:47:07 2009 UTC vs.
Revision 1.188 by sf-exg, Sat Jul 24 13:04:27 2010 UTC

… …
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
346This is a little rarely useful extension that Uploads the selection as 346This is a little rarely useful extension that uploads the selection as
347textfile to a remote site (or does other things). (The implementation is 347textfile to a remote site (or does other things). (The implementation is
348not currently secure for use in a multiuser environment as it writes to 348not currently secure for use in a multiuser environment as it writes to
349F</tmp> directly.). 349F</tmp> directly.).
350 350
351It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 351It 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
373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret 373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374the double C</> characters as comment start. Use C<\057\057> instead, 374the double C</> characters as comment start. Use C<\057\057> instead,
375which works regardless of wether xrdb is used to parse the resource file 375which works regardless of whether xrdb is used to parse the resource file
376or not. 376or not.
377 377
378=item macosx-pastebin and macosx-pastebin-native 378=item macosx-clipboard and macosx-clipboard-native
379 379
380These two modules implement an extended clipboard for Mac OS X. They are 380These two modules implement an extended clipboard for Mac OS X. They are
381used like this: 381used 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
387The difference between them is that the native variant requires a 387The difference between them is that the native variant requires a
388perl from apple's devkit or so, and C<maxosx-pastebin> requires the 388perl from apple's devkit or so, and C<macosx-clipboard> requires the
389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is 389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc. 390simpler etc. etc.
391 391
392=item example-refresh-hooks 392=item example-refresh-hooks
393 393
394Displays a very simple digital clock in the upper right corner of the 394Displays a very simple digital clock in the upper right corner of the
395window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
396overlays or changes. 396overlays or changes.
397
398=item confirm-paste
399
400Displays a confirmation dialog when a paste containing at least a full
401line is detected.
397 402
398=back 403=back
399 404
400=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
401 406
… …
417 422
418=over 4 423=over 4
419 424
420=item $text 425=item $text
421 426
422Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-unicode's special way of encoding text, where one "unicode" character
423always represents one screen cell. See L<ROW_t> for a discussion of this format. 428always represents one screen cell. See L<ROW_t> for a discussion of this format.
424 429
425=item $string 430=item $string
426 431
427A perl text string, with an emphasis on I<text>. It can store all unicode 432A perl text string, with an emphasis on I<text>. It can store all unicode
… …
610=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
611 616
612Called whenever some data is written to the tty/pty and can be used to 617Called whenever some data is written to the tty/pty and can be used to
613suppress or filter tty input. 618suppress or filter tty input.
614 619
620=item on_tt_paste $term, $octets
621
622Called whenever text is about to be pasted, with the text as argument. You
623can filter/change and paste the text yourself by returning a true value
624and calling C<< $term->tt_paste >> yourself. C<$octets> is
625locale-encoded.
626
615=item on_line_update $term, $row 627=item on_line_update $term, $row
616 628
617Called whenever a line was updated or changed. Can be used to filter 629Called whenever a line was updated or changed. Can be used to filter
618screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
619that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
… …
644resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
645 657
646The event is simply the action string. This interface is assumed to change 658The event is simply the action string. This interface is assumed to change
647slightly in the future. 659slightly in the future.
648 660
649=item on_resize_all_windows $tern, $new_width, $new_height 661=item on_resize_all_windows $term, $new_width, $new_height
650 662
651Called just after the new window size has been calculated, but before 663Called just after the new window size has been calculated, but before
652windows are actually being resized or hints are being set. If this hook 664windows are actually being resized or hints are being set. If this hook
653returns TRUE, setting of the window hints is being skipped. 665returns TRUE, setting of the window hints is being skipped.
654 666
… …
688 700
689=item on_map_notify $term, $event 701=item on_map_notify $term, $event
690 702
691=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
692 704
693Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
694the hook returns true, then the even will be ignored by rxvt-unicode. 706the hook returns true, then the event will be ignored by rxvt-unicode.
695 707
696The event is a hash with most values as named by Xlib (see the XEvent 708The event is a hash with most values as named by Xlib (see the XEvent
697manpage), with the additional members C<row> and C<col>, which are the 709manpage), with the additional members C<row> and C<col>, which are the
698(real, not screen-based) row and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
699 711
… …
708 720
709=item on_wm_delete_window $term, $event 721=item on_wm_delete_window $term, $event
710 722
711Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
712format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 724format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
725
726=item on_bell $term
727
728Called on receipt of a bell character.
713 729
714=back 730=back
715 731
716=cut 732=cut
717 733
… …
1124is that you cannot use blocking APIs, but the non-blocking variant should 1140is that you cannot use blocking APIs, but the non-blocking variant should
1125work. 1141work.
1126 1142
1127=cut 1143=cut
1128 1144
1129our $VERSION = '3.4'; 1145our $VERSION = '5.23';
1130 1146
1131$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1147$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1132push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1148push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1133 1149
1134sub timer { 1150sub timer {
… …
1136 1152
1137 my $cb = $arg{cb}; 1153 my $cb = $arg{cb};
1138 1154
1139 urxvt::timer 1155 urxvt::timer
1140 ->new 1156 ->new
1141 ->start (urxvt::NOW + $arg{after}) 1157 ->after ($arg{after}, $arg{interval})
1142 ->cb (sub { 1158 ->cb ($arg{interval} ? $cb : sub {
1143 $_[0]->stop; # need to cancel manually 1159 $_[0]->stop; # need to cancel manually
1144 $cb->(); 1160 $cb->();
1145 }) 1161 })
1146} 1162}
1147 1163
1148sub io { 1164sub io {
1149 my ($class, %arg) = @_; 1165 my ($class, %arg) = @_;
1150 1166
1151 my $cb = $arg{cb}; 1167 my $cb = $arg{cb};
1168 my $fd = fileno $arg{fh};
1169 defined $fd or $fd = $arg{fh};
1152 1170
1153 bless [$arg{fh}, urxvt::iow 1171 bless [$arg{fh}, urxvt::iow
1154 ->new 1172 ->new
1155 ->fd (fileno $arg{fh}) 1173 ->fd ($fd)
1156 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1174 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1157 | ($arg{poll} =~ /w/ ? 2 : 0)) 1175 | ($arg{poll} =~ /w/ ? 2 : 0))
1158 ->start 1176 ->start
1159 ->cb (sub { 1177 ->cb ($cb)
1160 $cb->(($_[1] & 1 ? 'r' : '')
1161 . ($_[1] & 2 ? 'w' : ''));
1162 })],
1163 urxvt::anyevent:: 1178 ], urxvt::anyevent::
1179}
1180
1181sub idle {
1182 my ($class, %arg) = @_;
1183
1184 my $cb = $arg{cb};
1185
1186 urxvt::iw
1187 ->new
1188 ->start
1189 ->cb ($cb)
1190}
1191
1192sub child {
1193 my ($class, %arg) = @_;
1194
1195 my $cb = $arg{cb};
1196
1197 urxvt::pw
1198 ->new
1199 ->start ($arg{pid})
1200 ->cb (sub {
1201 $_[0]->stop; # need to cancel manually
1202 $cb->($_[0]->rpid, $_[0]->rstatus);
1203 })
1164} 1204}
1165 1205
1166sub DESTROY { 1206sub DESTROY {
1167 $_[0][1]->stop; 1207 $_[0][1]->stop;
1168} 1208}
… …
1298 1338
1299 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1339 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1300 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1340 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1301 display_name embed ext_bwidth fade font geometry hold iconName 1341 display_name embed ext_bwidth fade font geometry hold iconName
1302 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1342 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1303 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1343 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1304 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1344 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1305 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1345 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1306 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1346 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1307 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1347 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1308 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1348 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1309 secondaryScreen secondaryScroll shade term_name title 1349 secondaryScreen secondaryScroll shade term_name title
1310 transient_for transparent transparent_all tripleclickwords utmpInhibit 1350 transient_for transparent transparent_all tripleclickwords utmpInhibit
… …
1348 1388
1349=item ($row, $col) = $term->selection_beg ([$row, $col]) 1389=item ($row, $col) = $term->selection_beg ([$row, $col])
1350 1390
1351=item ($row, $col) = $term->selection_end ([$row, $col]) 1391=item ($row, $col) = $term->selection_end ([$row, $col])
1352 1392
1353Return the current values of the selection mark, begin or end positions, 1393Return the current values of the selection mark, begin or end positions.
1354and optionally set them to new values. 1394
1395When arguments are given, then the selection coordinates are set to
1396C<$row> and C<$col>, and the selection screen is set to the current
1397screen.
1398
1399=item $screen = $term->selection_screen ([$screen])
1400
1401Returns the current selection screen, and then optionally sets it.
1355 1402
1356=item $term->selection_make ($eventtime[, $rectangular]) 1403=item $term->selection_make ($eventtime[, $rectangular])
1357 1404
1358Tries to make a selection as set by C<selection_beg> and 1405Tries to make a selection as set by C<selection_beg> and
1359C<selection_end>. If C<$rectangular> is true (default: false), a 1406C<selection_end>. If C<$rectangular> is true (default: false), a
1360rectangular selection will be made. This is the prefered function to make 1407rectangular selection will be made. This is the preferred function to make
1361a selection. 1408a selection.
1362 1409
1363=item $success = $term->selection_grab ($eventtime) 1410=item $success = $term->selection_grab ($eventtime[, $clipboard])
1364 1411
1365Try to request the primary selection text from the server (for example, as 1412Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1413true) selection from the server. The corresponding text can be set
1366set by the next method). No visual feedback will be given. This function 1414with the next method. No visual feedback will be given. This function
1367is mostly useful from within C<on_sel_grab> hooks. 1415is mostly useful from within C<on_sel_grab> hooks.
1368 1416
1369=item $oldtext = $term->selection ([$newtext]) 1417=item $oldtext = $term->selection ([$newtext, $clipboard])
1370 1418
1371Return the current selection text and optionally replace it by C<$newtext>. 1419Return the current selection (clipboard if C<$clipboard> is true) text
1420and optionally replace it by C<$newtext>.
1421
1422=item $term->selection_clear ([$clipboard])
1423
1424Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1372 1425
1373=item $term->overlay_simple ($x, $y, $text) 1426=item $term->overlay_simple ($x, $y, $text)
1374 1427
1375Create a simple multi-line overlay box. See the next method for details. 1428Create a simple multi-line overlay box. See the next method for details.
1376 1429
… …
1504locale-specific encoding of the terminal and can contain command sequences 1557locale-specific encoding of the terminal and can contain command sequences
1505(escape codes) that will be interpreted. 1558(escape codes) that will be interpreted.
1506 1559
1507=item $term->tt_write ($octets) 1560=item $term->tt_write ($octets)
1508 1561
1509Write the octets given in C<$data> to the tty (i.e. as program input). To 1562Write the octets given in C<$octets> to the tty (i.e. as program input). To
1510pass characters instead of octets, you should convert your strings first 1563pass characters instead of octets, you should convert your strings first
1511to the locale-specific encoding using C<< $term->locale_encode >>. 1564to the locale-specific encoding using C<< $term->locale_encode >>.
1565
1566=item $term->tt_paste ($octets)
1567
1568Write the octets given in C<$octets> to the tty as a paste, converting NL to
1569CR and bracketing the data with control sequences if bracketed paste mode
1570is set.
1512 1571
1513=item $old_events = $term->pty_ev_events ([$new_events]) 1572=item $old_events = $term->pty_ev_events ([$new_events])
1514 1573
1515Replaces the event mask of the pty watcher by the given event mask. Can 1574Replaces the event mask of the pty watcher by the given event mask. Can
1516be used to suppress input and output handling to the pty/tty. See the 1575be used to suppress input and output handling to the pty/tty. See the
… …
1830Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1889Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1831recent grab. 1890recent grab.
1832 1891
1833=item $term->ungrab 1892=item $term->ungrab
1834 1893
1835Calls XUngrab for the most recent grab. Is called automatically on 1894Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1836evaluation errors, as it is better to lose the grab in the error case as 1895evaluation errors, as it is better to lose the grab in the error case as
1837the session. 1896the session.
1838 1897
1839=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1898=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1840 1899
… …
1862 1921
1863=item $term->XChangeInput ($window, $add_events[, $del_events]) 1922=item $term->XChangeInput ($window, $add_events[, $del_events])
1864 1923
1865Various X or X-related functions. The C<$term> object only serves as 1924Various X or X-related functions. The C<$term> object only serves as
1866the source of the display, otherwise those functions map more-or-less 1925the source of the display, otherwise those functions map more-or-less
1867directory onto the X functions of the same name. 1926directly onto the X functions of the same name.
1868 1927
1869=back 1928=back
1870 1929
1871=cut 1930=cut
1872 1931
… …
2029 2088
2030=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2089=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2031 2090
2032Set the callback to be called when the timer triggers. 2091Set the callback to be called when the timer triggers.
2033 2092
2034=item $tstamp = $timer->at
2035
2036Return the time this watcher will fire next.
2037
2038=item $timer = $timer->set ($tstamp) 2093=item $timer = $timer->set ($tstamp[, $interval])
2039 2094
2040Set the time the event is generated to $tstamp. 2095Set the time the event is generated to $tstamp (and optionally specifies a
2096new $interval).
2041 2097
2042=item $timer = $timer->interval ($interval) 2098=item $timer = $timer->interval ($interval)
2043 2099
2044Normally (and when C<$interval> is C<0>), the timer will automatically 2100By default (and when C<$interval> is C<0>), the timer will automatically
2045stop after it has fired once. If C<$interval> is non-zero, then the timer 2101stop after it has fired once. If C<$interval> is non-zero, then the timer
2046is automatically rescheduled at the given intervals. 2102is automatically rescheduled at the given intervals.
2047 2103
2048=item $timer = $timer->start 2104=item $timer = $timer->start
2049 2105
2050Start the timer. 2106Start the timer.
2051 2107
2052=item $timer = $timer->start ($tstamp) 2108=item $timer = $timer->start ($tstamp[, $interval])
2053 2109
2054Set the event trigger time to C<$tstamp> and start the timer. 2110Set the event trigger time to C<$tstamp> and start the timer. Optionally
2111also replaces the interval.
2055 2112
2056=item $timer = $timer->after ($delay) 2113=item $timer = $timer->after ($delay[, $interval])
2057 2114
2058Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2115Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2059 2116
2060=item $timer = $timer->stop 2117=item $timer = $timer->stop
2061 2118

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines