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.173 by root, Wed Nov 5 12:45:36 2008 UTC vs.
Revision 1.184 by sf-exg, Thu Jul 1 21:17:11 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
378=item macosx-clipboard and macosx-clipboard-native
379
380These two modules implement an extended clipboard for Mac OS X. They are
381used 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
387The difference between them is that the native variant requires a
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
390simpler etc. etc.
377 391
378=item example-refresh-hooks 392=item example-refresh-hooks
379 393
380Displays 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
381window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
403 417
404=over 4 418=over 4
405 419
406=item $text 420=item $text
407 421
408Rxvt-unicodes special way of encoding text, where one "unicode" character 422Rxvt-unicode's special way of encoding text, where one "unicode" character
409always represents one screen cell. See L<ROW_t> for a discussion of this format. 423always represents one screen cell. See L<ROW_t> for a discussion of this format.
410 424
411=item $string 425=item $string
412 426
413A perl text string, with an emphasis on I<text>. It can store all unicode 427A perl text string, with an emphasis on I<text>. It can store all unicode
674 688
675=item on_map_notify $term, $event 689=item on_map_notify $term, $event
676 690
677=item on_unmap_notify $term, $event 691=item on_unmap_notify $term, $event
678 692
679Called whenever the corresponding X event is received for the terminal If 693Called whenever the corresponding X event is received for the terminal. If
680the hook returns true, then the even will be ignored by rxvt-unicode. 694the hook returns true, then the event will be ignored by rxvt-unicode.
681 695
682The event is a hash with most values as named by Xlib (see the XEvent 696The event is a hash with most values as named by Xlib (see the XEvent
683manpage), with the additional members C<row> and C<col>, which are the 697manpage), with the additional members C<row> and C<col>, which are the
684(real, not screen-based) row and column under the mouse cursor. 698(real, not screen-based) row and column under the mouse cursor.
685 699
694 708
695=item on_wm_delete_window $term, $event 709=item on_wm_delete_window $term, $event
696 710
697Called when various types of ClientMessage events are received (all with 711Called when various types of ClientMessage events are received (all with
698format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 712format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
713
714=item on_bell $term
715
716Called on receipt of a bell character.
699 717
700=back 718=back
701 719
702=cut 720=cut
703 721
1110is that you cannot use blocking APIs, but the non-blocking variant should 1128is that you cannot use blocking APIs, but the non-blocking variant should
1111work. 1129work.
1112 1130
1113=cut 1131=cut
1114 1132
1115our $VERSION = '3.4'; 1133our $VERSION = '5.23';
1116 1134
1117$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1135$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1118push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1136push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1119 1137
1120sub timer { 1138sub timer {
1122 1140
1123 my $cb = $arg{cb}; 1141 my $cb = $arg{cb};
1124 1142
1125 urxvt::timer 1143 urxvt::timer
1126 ->new 1144 ->new
1127 ->start (urxvt::NOW + $arg{after}) 1145 ->after ($arg{after}, $arg{interval})
1128 ->cb (sub { 1146 ->cb ($arg{interval} ? $cb : sub {
1129 $_[0]->stop; # need to cancel manually 1147 $_[0]->stop; # need to cancel manually
1130 $cb->(); 1148 $cb->();
1131 }) 1149 })
1132} 1150}
1133 1151
1134sub io { 1152sub io {
1135 my ($class, %arg) = @_; 1153 my ($class, %arg) = @_;
1136 1154
1137 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
1156 my $fd = fileno $arg{fh};
1157 defined $fd or $fd = $arg{fh};
1138 1158
1139 bless [$arg{fh}, urxvt::iow 1159 bless [$arg{fh}, urxvt::iow
1140 ->new 1160 ->new
1141 ->fd (fileno $arg{fh}) 1161 ->fd ($fd)
1142 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1162 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1143 | ($arg{poll} =~ /w/ ? 2 : 0)) 1163 | ($arg{poll} =~ /w/ ? 2 : 0))
1144 ->start 1164 ->start
1145 ->cb (sub { 1165 ->cb ($cb)
1146 $cb->(($_[1] & 1 ? 'r' : '')
1147 . ($_[1] & 2 ? 'w' : ''));
1148 })],
1149 urxvt::anyevent:: 1166 ], urxvt::anyevent::
1167}
1168
1169sub idle {
1170 my ($class, %arg) = @_;
1171
1172 my $cb = $arg{cb};
1173
1174 urxvt::iw
1175 ->new
1176 ->start
1177 ->cb ($cb)
1178}
1179
1180sub 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 })
1150} 1192}
1151 1193
1152sub DESTROY { 1194sub DESTROY {
1153 $_[0][1]->stop; 1195 $_[0][1]->stop;
1154} 1196}
1284 1326
1285 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1327 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1286 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1328 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1287 display_name embed ext_bwidth fade font geometry hold iconName 1329 display_name embed ext_bwidth fade font geometry hold iconName
1288 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1330 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1289 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1331 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1290 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1332 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1291 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1333 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1292 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1334 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1293 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1335 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1294 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1336 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1295 secondaryScreen secondaryScroll shade term_name title 1337 secondaryScreen secondaryScroll shade term_name title
1296 transient_for transparent transparent_all tripleclickwords utmpInhibit 1338 transient_for transparent transparent_all tripleclickwords utmpInhibit
1334 1376
1335=item ($row, $col) = $term->selection_beg ([$row, $col]) 1377=item ($row, $col) = $term->selection_beg ([$row, $col])
1336 1378
1337=item ($row, $col) = $term->selection_end ([$row, $col]) 1379=item ($row, $col) = $term->selection_end ([$row, $col])
1338 1380
1339Return the current values of the selection mark, begin or end positions, 1381Return the current values of the selection mark, begin or end positions.
1340and optionally set them to new values. 1382
1383When arguments are given, then the selection coordinates are set to
1384C<$row> and C<$col>, and the selection screen is set to the current
1385screen.
1386
1387=item $screen = $term->selection_screen ([$screen])
1388
1389Returns the current selection screen, and then optionally sets it.
1341 1390
1342=item $term->selection_make ($eventtime[, $rectangular]) 1391=item $term->selection_make ($eventtime[, $rectangular])
1343 1392
1344Tries to make a selection as set by C<selection_beg> and 1393Tries to make a selection as set by C<selection_beg> and
1345C<selection_end>. If C<$rectangular> is true (default: false), a 1394C<selection_end>. If C<$rectangular> is true (default: false), a
1346rectangular selection will be made. This is the prefered function to make 1395rectangular selection will be made. This is the prefered function to make
1347a selection. 1396a selection.
1348 1397
1349=item $success = $term->selection_grab ($eventtime) 1398=item $success = $term->selection_grab ($eventtime[, $clipboard])
1350 1399
1351Try to request the primary selection text from the server (for example, as 1400Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1401true) selection from the server. The corresponding text can be set
1352set by the next method). No visual feedback will be given. This function 1402with the next method. No visual feedback will be given. This function
1353is mostly useful from within C<on_sel_grab> hooks. 1403is mostly useful from within C<on_sel_grab> hooks.
1354 1404
1355=item $oldtext = $term->selection ([$newtext]) 1405=item $oldtext = $term->selection ([$newtext, $clipboard])
1356 1406
1357Return the current selection text and optionally replace it by C<$newtext>. 1407Return the current selection (clipboard if C<$clipboard> is true) text
1408and optionally replace it by C<$newtext>.
1409
1410=item $term->selection_clear ([$clipboard])
1411
1412Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1358 1413
1359=item $term->overlay_simple ($x, $y, $text) 1414=item $term->overlay_simple ($x, $y, $text)
1360 1415
1361Create a simple multi-line overlay box. See the next method for details. 1416Create a simple multi-line overlay box. See the next method for details.
1362 1417
1816Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1871Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1817recent grab. 1872recent grab.
1818 1873
1819=item $term->ungrab 1874=item $term->ungrab
1820 1875
1821Calls XUngrab for the most recent grab. Is called automatically on 1876Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1822evaluation errors, as it is better to lose the grab in the error case as 1877evaluation errors, as it is better to lose the grab in the error case as
1823the session. 1878the session.
1824 1879
1825=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1880=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1826 1881
1848 1903
1849=item $term->XChangeInput ($window, $add_events[, $del_events]) 1904=item $term->XChangeInput ($window, $add_events[, $del_events])
1850 1905
1851Various X or X-related functions. The C<$term> object only serves as 1906Various X or X-related functions. The C<$term> object only serves as
1852the source of the display, otherwise those functions map more-or-less 1907the source of the display, otherwise those functions map more-or-less
1853directory onto the X functions of the same name. 1908directly onto the X functions of the same name.
1854 1909
1855=back 1910=back
1856 1911
1857=cut 1912=cut
1858 1913
2015 2070
2016=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2071=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017 2072
2018Set the callback to be called when the timer triggers. 2073Set the callback to be called when the timer triggers.
2019 2074
2020=item $tstamp = $timer->at
2021
2022Return the time this watcher will fire next.
2023
2024=item $timer = $timer->set ($tstamp) 2075=item $timer = $timer->set ($tstamp[, $interval])
2025 2076
2026Set the time the event is generated to $tstamp. 2077Set the time the event is generated to $tstamp (and optionally specifies a
2078new $interval).
2027 2079
2028=item $timer = $timer->interval ($interval) 2080=item $timer = $timer->interval ($interval)
2029 2081
2030Normally (and when C<$interval> is C<0>), the timer will automatically 2082By default (and when C<$interval> is C<0>), the timer will automatically
2031stop after it has fired once. If C<$interval> is non-zero, then the timer 2083stop after it has fired once. If C<$interval> is non-zero, then the timer
2032is automatically rescheduled at the given intervals. 2084is automatically rescheduled at the given intervals.
2033 2085
2034=item $timer = $timer->start 2086=item $timer = $timer->start
2035 2087
2036Start the timer. 2088Start the timer.
2037 2089
2038=item $timer = $timer->start ($tstamp) 2090=item $timer = $timer->start ($tstamp[, $interval])
2039 2091
2040Set the event trigger time to C<$tstamp> and start the timer. 2092Set the event trigger time to C<$tstamp> and start the timer. Optionally
2093also replaces the interval.
2041 2094
2042=item $timer = $timer->after ($delay) 2095=item $timer = $timer->after ($delay[, $interval])
2043 2096
2044Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2097Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045 2098
2046=item $timer = $timer->stop 2099=item $timer = $timer->stop
2047 2100

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines