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.167 by root, Sun Jun 15 13:54:15 2008 UTC vs.
Revision 1.188 by sf-exg, Sat Jul 24 13:04:27 2010 UTC

108reference. The string will be used as button text and the code reference 108reference. The string will be used as button text and the code reference
109will be called when the toggle changes, with the new boolean value as 109will be called when the toggle changes, with the new boolean value as
110first argument. 110first argument.
111 111
112The following will add an entry C<myoption> that changes 112The following will add an entry C<myoption> that changes
113C<$self->{myoption}>: 113C<< $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
303extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
304 304
305If you want a quake-like animation, tell your window manager to do so 305If 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
310This extension implements some OSC commands to display timed popups on the
311screen - useful for status displays from within scripts. You have to read
312the sources for more info.
313
308=item block-graphics-to-ascii 314=item block-graphics-to-ascii
309 315
310A not very useful example of filtering all text output to the terminal 316A not very useful example of filtering all text output to the terminal
311by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
312similar-looking ascii character. 318similar-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
340This is a little rarely useful extension that Uploads the selection as 346This is a little rarely useful extension that uploads the selection as
341textfile to a remote site (or does other things). (The implementation is 347textfile to a remote site (or does other things). (The implementation is
342not 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
343F</tmp> directly.). 349F</tmp> directly.).
344 350
345It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 351It 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
367I<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
368the double C</> characters as comment start. Use C<\057\057> instead, 374the double C</> characters as comment start. Use C<\057\057> instead,
369which 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
370or 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.
371 391
372=item example-refresh-hooks 392=item example-refresh-hooks
373 393
374Displays 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
375window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
376overlays 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.
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
402Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-unicode's special way of encoding text, where one "unicode" character
403always 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.
404 429
405=item $string 430=item $string
406 431
407A 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
541 566
542It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 567It 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
544number of lines that will be in the scrollback buffer. 569number 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
548Called on every OSC sequence and can be used to suppress it or modify its 573Called on every OSC sequence and can be used to suppress it or modify its
549behaviour. The default should be to return an empty list. A true value 574behaviour. The default should be to return an empty list. A true value
550suppresses execution of the request completely. Make sure you don't get 575suppresses execution of the request completely. Make sure you don't get
551confused by recursive invocations when you output an osc sequence within 576confused by recursive invocations when you output an OSC sequence within
552this callback. 577this callback.
553 578
554C<on_osc_seq_perl> should be used for new behaviour. 579C<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
558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 583Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559operating system command) is processed. Cursor position and other state 584operating system command) is processed. Cursor position and other state
560information is up-to-date when this happens. For interoperability, the 585information is up-to-date when this happens. For interoperability, the
561string should start with the extension name and a colon, to distinguish 586string should start with the extension name (sans -osc) and a semicolon,
562it from commands for other extensions, and this might be enforced in the 587to distinguish it from commands for other extensions, and this might be
563future. 588enforced in the future.
589
590For 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
565Be careful not ever to trust (in a security sense) the data you receive, 600Be careful not ever to trust (in a security sense) the data you receive,
566as its source can not easily be controlled (e-mail content, messages from 601as its source can not easily be controlled (e-mail content, messages from
567other users on the same system etc.). 602other users on the same system etc.).
603
604For responses, C<$resp> contains the end-of-args separator used by the
605sender.
568 606
569=item on_add_lines $term, $string 607=item on_add_lines $term, $string
570 608
571Called whenever text is about to be output, with the text as argument. You 609Called whenever text is about to be output, with the text as argument. You
572can filter/change and output the text yourself by returning a true value 610can 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
579Called 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
580suppress or filter tty input. 618suppress or filter tty input.
581 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
582=item on_line_update $term, $row 627=item on_line_update $term, $row
583 628
584Called 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
585screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
586that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
593later with the already-modified line (e.g. if unrelated parts change), so 638later with the already-modified line (e.g. if unrelated parts change), so
594you cannot just toggle rendition bits, but only set them. 639you 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
598Called just before the screen gets redrawn. Can be used for overlay 643Called just before the screen gets redrawn. Can be used for overlay or
599or similar effects by modify terminal contents in refresh_begin, and 644similar effects by modifying the terminal contents in refresh_begin, and
600restoring them in refresh_end. The built-in overlay and selection display 645restoring them in refresh_end. The built-in overlay and selection display
601code is run after this hook, and takes precedence. 646code is run after this hook, and takes precedence.
602 647
603=item on_refresh_end $term 648=item on_refresh_end $term
604 649
611resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
612 657
613The 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
614slightly in the future. 659slightly 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
618Called just after the new window size has been calculated, but before 663Called just after the new window size has been calculated, but before
619windows 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
620returns TRUE, setting of the window hints is being skipped. 665returns 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
660Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
661the 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.
662 707
663The 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
664manpage), 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
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
678Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
679format=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.
680 729
681=back 730=back
682 731
683=cut 732=cut
684 733
1091is 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
1092work. 1141work.
1093 1142
1094=cut 1143=cut
1095 1144
1096our $VERSION = '3.4'; 1145our $VERSION = '5.23';
1097 1146
1098$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1147$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1148push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100 1149
1101sub timer { 1150sub timer {
1103 1152
1104 my $cb = $arg{cb}; 1153 my $cb = $arg{cb};
1105 1154
1106 urxvt::timer 1155 urxvt::timer
1107 ->new 1156 ->new
1108 ->start (urxvt::NOW + $arg{after}) 1157 ->after ($arg{after}, $arg{interval})
1109 ->cb (sub { 1158 ->cb ($arg{interval} ? $cb : sub {
1110 $_[0]->stop; # need to cancel manually 1159 $_[0]->stop; # need to cancel manually
1111 $cb->(); 1160 $cb->();
1112 }) 1161 })
1113} 1162}
1114 1163
1115sub io { 1164sub io {
1116 my ($class, %arg) = @_; 1165 my ($class, %arg) = @_;
1117 1166
1118 my $cb = $arg{cb}; 1167 my $cb = $arg{cb};
1168 my $fd = fileno $arg{fh};
1169 defined $fd or $fd = $arg{fh};
1119 1170
1120 bless [$arg{fh}, urxvt::iow 1171 bless [$arg{fh}, urxvt::iow
1121 ->new 1172 ->new
1122 ->fd (fileno $arg{fh}) 1173 ->fd ($fd)
1123 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1174 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1124 | ($arg{poll} =~ /w/ ? 2 : 0)) 1175 | ($arg{poll} =~ /w/ ? 2 : 0))
1125 ->start 1176 ->start
1126 ->cb (sub { 1177 ->cb ($cb)
1127 $cb->(($_[1] & 1 ? 'r' : '')
1128 . ($_[1] & 2 ? 'w' : ''));
1129 })],
1130 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 })
1131} 1204}
1132 1205
1133sub DESTROY { 1206sub DESTROY {
1134 $_[0][1]->stop; 1207 $_[0][1]->stop;
1135} 1208}
1265 1338
1266 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1339 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1267 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1340 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1268 display_name embed ext_bwidth fade font geometry hold iconName 1341 display_name embed ext_bwidth fade font geometry hold iconName
1269 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1342 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1270 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1343 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1271 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1344 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1272 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1345 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1273 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1346 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1274 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1347 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1275 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1348 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1276 secondaryScreen secondaryScroll shade term_name title 1349 secondaryScreen secondaryScroll shade term_name title
1277 transient_for transparent transparent_all tripleclickwords utmpInhibit 1350 transient_for transparent transparent_all tripleclickwords utmpInhibit
1280=cut 1353=cut
1281 1354
1282sub resource($$;$) { 1355sub resource($$;$) {
1283 my ($self, $name) = (shift, shift); 1356 my ($self, $name) = (shift, shift);
1284 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1357 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1285 &urxvt::term::_resource 1358 goto &urxvt::term::_resource
1286} 1359}
1287 1360
1288=item $value = $term->x_resource ($pattern) 1361=item $value = $term->x_resource ($pattern)
1289 1362
1290Returns the X-Resource for the given pattern, excluding the program or 1363Returns the X-Resource for the given pattern, excluding the program or
1315 1388
1316=item ($row, $col) = $term->selection_beg ([$row, $col]) 1389=item ($row, $col) = $term->selection_beg ([$row, $col])
1317 1390
1318=item ($row, $col) = $term->selection_end ([$row, $col]) 1391=item ($row, $col) = $term->selection_end ([$row, $col])
1319 1392
1320Return the current values of the selection mark, begin or end positions, 1393Return the current values of the selection mark, begin or end positions.
1321and 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.
1322 1402
1323=item $term->selection_make ($eventtime[, $rectangular]) 1403=item $term->selection_make ($eventtime[, $rectangular])
1324 1404
1325Tries to make a selection as set by C<selection_beg> and 1405Tries to make a selection as set by C<selection_beg> and
1326C<selection_end>. If C<$rectangular> is true (default: false), a 1406C<selection_end>. If C<$rectangular> is true (default: false), a
1327rectangular selection will be made. This is the prefered function to make 1407rectangular selection will be made. This is the preferred function to make
1328a selection. 1408a selection.
1329 1409
1330=item $success = $term->selection_grab ($eventtime) 1410=item $success = $term->selection_grab ($eventtime[, $clipboard])
1331 1411
1332Try 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
1333set by the next method). No visual feedback will be given. This function 1414with the next method. No visual feedback will be given. This function
1334is mostly useful from within C<on_sel_grab> hooks. 1415is mostly useful from within C<on_sel_grab> hooks.
1335 1416
1336=item $oldtext = $term->selection ([$newtext]) 1417=item $oldtext = $term->selection ([$newtext, $clipboard])
1337 1418
1338Return 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.
1339 1425
1340=item $term->overlay_simple ($x, $y, $text) 1426=item $term->overlay_simple ($x, $y, $text)
1341 1427
1342Create 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.
1343 1429
1373 1459
1374The methods currently supported on C<urxvt::overlay> objects are: 1460The methods currently supported on C<urxvt::overlay> objects are:
1375 1461
1376=over 4 1462=over 4
1377 1463
1378=item $overlay->set ($x, $y, $text, $rend) 1464=item $overlay->set ($x, $y, $text[, $rend])
1379 1465
1380Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1466Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1381text in rxvt-unicode's special encoding and an array of rendition values 1467text in rxvt-unicode's special encoding and an array of rendition values
1382at a specific position inside the overlay. 1468at a specific position inside the overlay.
1469
1470If C<$rend> is missing, then the rendition will not be changed.
1383 1471
1384=item $overlay->hide 1472=item $overlay->hide
1385 1473
1386If visible, hide the overlay, but do not destroy it. 1474If visible, hide the overlay, but do not destroy it.
1387 1475
1469locale-specific encoding of the terminal and can contain command sequences 1557locale-specific encoding of the terminal and can contain command sequences
1470(escape codes) that will be interpreted. 1558(escape codes) that will be interpreted.
1471 1559
1472=item $term->tt_write ($octets) 1560=item $term->tt_write ($octets)
1473 1561
1474Write 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
1475pass characters instead of octets, you should convert your strings first 1563pass characters instead of octets, you should convert your strings first
1476to 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.
1477 1571
1478=item $old_events = $term->pty_ev_events ([$new_events]) 1572=item $old_events = $term->pty_ev_events ([$new_events])
1479 1573
1480Replaces 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
1481be 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
1795Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1889Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1796recent grab. 1890recent grab.
1797 1891
1798=item $term->ungrab 1892=item $term->ungrab
1799 1893
1800Calls XUngrab for the most recent grab. Is called automatically on 1894Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1801evaluation 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
1802the session. 1896the session.
1803 1897
1804=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1898=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1805 1899
1807 1901
1808=item @atoms = $term->XListProperties ($window) 1902=item @atoms = $term->XListProperties ($window)
1809 1903
1810=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1904=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1811 1905
1812=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1906=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1813 1907
1814=item $term->XDeleteProperty ($window, $property) 1908=item $term->XDeleteProperty ($window, $property)
1815 1909
1816=item $window = $term->DefaultRootWindow 1910=item $window = $term->DefaultRootWindow
1817 1911
1827 1921
1828=item $term->XChangeInput ($window, $add_events[, $del_events]) 1922=item $term->XChangeInput ($window, $add_events[, $del_events])
1829 1923
1830Various 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
1831the source of the display, otherwise those functions map more-or-less 1925the source of the display, otherwise those functions map more-or-less
1832directory onto the X functions of the same name. 1926directly onto the X functions of the same name.
1833 1927
1834=back 1928=back
1835 1929
1836=cut 1930=cut
1837 1931
1994 2088
1995=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2089=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1996 2090
1997Set the callback to be called when the timer triggers. 2091Set the callback to be called when the timer triggers.
1998 2092
1999=item $tstamp = $timer->at
2000
2001Return the time this watcher will fire next.
2002
2003=item $timer = $timer->set ($tstamp) 2093=item $timer = $timer->set ($tstamp[, $interval])
2004 2094
2005Set the time the event is generated to $tstamp. 2095Set the time the event is generated to $tstamp (and optionally specifies a
2096new $interval).
2006 2097
2007=item $timer = $timer->interval ($interval) 2098=item $timer = $timer->interval ($interval)
2008 2099
2009Normally (and when C<$interval> is C<0>), the timer will automatically 2100By default (and when C<$interval> is C<0>), the timer will automatically
2010stop 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
2011is automatically rescheduled at the given intervals. 2102is automatically rescheduled at the given intervals.
2012 2103
2013=item $timer = $timer->start 2104=item $timer = $timer->start
2014 2105
2015Start the timer. 2106Start the timer.
2016 2107
2017=item $timer = $timer->start ($tstamp) 2108=item $timer = $timer->start ($tstamp[, $interval])
2018 2109
2019Set 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.
2020 2112
2021=item $timer = $timer->after ($delay) 2113=item $timer = $timer->after ($delay[, $interval])
2022 2114
2023Like 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>.
2024 2116
2025=item $timer = $timer->stop 2117=item $timer = $timer->stop
2026 2118

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines