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.187 by sf-exg, Sat Jul 24 10:20:26 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
397 417
398=over 4 418=over 4
399 419
400=item $text 420=item $text
401 421
402Rxvt-unicodes special way of encoding text, where one "unicode" character 422Rxvt-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. 423always represents one screen cell. See L<ROW_t> for a discussion of this format.
404 424
405=item $string 425=item $string
406 426
407A 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
541 561
542It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 562It 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
544number of lines that will be in the scrollback buffer. 564number 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
548Called on every OSC sequence and can be used to suppress it or modify its 568Called 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 569behaviour. The default should be to return an empty list. A true value
550suppresses execution of the request completely. Make sure you don't get 570suppresses execution of the request completely. Make sure you don't get
551confused by recursive invocations when you output an osc sequence within 571confused by recursive invocations when you output an OSC sequence within
552this callback. 572this callback.
553 573
554C<on_osc_seq_perl> should be used for new behaviour. 574C<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
558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 578Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559operating system command) is processed. Cursor position and other state 579operating system command) is processed. Cursor position and other state
560information is up-to-date when this happens. For interoperability, the 580information is up-to-date when this happens. For interoperability, the
561string should start with the extension name and a colon, to distinguish 581string should start with the extension name (sans -osc) and a semicolon,
562it from commands for other extensions, and this might be enforced in the 582to distinguish it from commands for other extensions, and this might be
563future. 583enforced in the future.
584
585For 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
565Be careful not ever to trust (in a security sense) the data you receive, 595Be 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 596as its source can not easily be controlled (e-mail content, messages from
567other users on the same system etc.). 597other users on the same system etc.).
598
599For responses, C<$resp> contains the end-of-args separator used by the
600sender.
568 601
569=item on_add_lines $term, $string 602=item on_add_lines $term, $string
570 603
571Called whenever text is about to be output, with the text as argument. You 604Called 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 605can filter/change and output the text yourself by returning a true value
577=item on_tt_write $term, $octets 610=item on_tt_write $term, $octets
578 611
579Called whenever some data is written to the tty/pty and can be used to 612Called whenever some data is written to the tty/pty and can be used to
580suppress or filter tty input. 613suppress or filter tty input.
581 614
615=item on_tt_paste $term, $octets
616
617Called whenever text is about to be pasted, with the text as argument. You
618can filter/change and paste the text yourself by returning a true value
619and calling C<< $term->tt_paste >> yourself. C<$octets> is
620locale-encoded.
621
582=item on_line_update $term, $row 622=item on_line_update $term, $row
583 623
584Called whenever a line was updated or changed. Can be used to filter 624Called whenever a line was updated or changed. Can be used to filter
585screen output (e.g. underline urls or other useless stuff). Only lines 625screen output (e.g. underline urls or other useless stuff). Only lines
586that are being shown will be filtered, and, due to performance reasons, 626that are being shown will be filtered, and, due to performance reasons,
593later with the already-modified line (e.g. if unrelated parts change), so 633later with the already-modified line (e.g. if unrelated parts change), so
594you cannot just toggle rendition bits, but only set them. 634you cannot just toggle rendition bits, but only set them.
595 635
596=item on_refresh_begin $term 636=item on_refresh_begin $term
597 637
598Called just before the screen gets redrawn. Can be used for overlay 638Called just before the screen gets redrawn. Can be used for overlay or
599or similar effects by modify terminal contents in refresh_begin, and 639similar effects by modifying the terminal contents in refresh_begin, and
600restoring them in refresh_end. The built-in overlay and selection display 640restoring them in refresh_end. The built-in overlay and selection display
601code is run after this hook, and takes precedence. 641code is run after this hook, and takes precedence.
602 642
603=item on_refresh_end $term 643=item on_refresh_end $term
604 644
611resource in the @@RXVT_NAME@@(1) manpage). 651resource in the @@RXVT_NAME@@(1) manpage).
612 652
613The event is simply the action string. This interface is assumed to change 653The event is simply the action string. This interface is assumed to change
614slightly in the future. 654slightly in the future.
615 655
616=item on_resize_all_windows $tern, $new_width, $new_height 656=item on_resize_all_windows $term, $new_width, $new_height
617 657
618Called just after the new window size has been calculated, but before 658Called just after the new window size has been calculated, but before
619windows are actually being resized or hints are being set. If this hook 659windows are actually being resized or hints are being set. If this hook
620returns TRUE, setting of the window hints is being skipped. 660returns TRUE, setting of the window hints is being skipped.
621 661
655 695
656=item on_map_notify $term, $event 696=item on_map_notify $term, $event
657 697
658=item on_unmap_notify $term, $event 698=item on_unmap_notify $term, $event
659 699
660Called whenever the corresponding X event is received for the terminal If 700Called whenever the corresponding X event is received for the terminal. If
661the hook returns true, then the even will be ignored by rxvt-unicode. 701the hook returns true, then the event will be ignored by rxvt-unicode.
662 702
663The event is a hash with most values as named by Xlib (see the XEvent 703The 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 704manpage), with the additional members C<row> and C<col>, which are the
665(real, not screen-based) row and column under the mouse cursor. 705(real, not screen-based) row and column under the mouse cursor.
666 706
675 715
676=item on_wm_delete_window $term, $event 716=item on_wm_delete_window $term, $event
677 717
678Called when various types of ClientMessage events are received (all with 718Called when various types of ClientMessage events are received (all with
679format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 719format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
720
721=item on_bell $term
722
723Called on receipt of a bell character.
680 724
681=back 725=back
682 726
683=cut 727=cut
684 728
1091is that you cannot use blocking APIs, but the non-blocking variant should 1135is that you cannot use blocking APIs, but the non-blocking variant should
1092work. 1136work.
1093 1137
1094=cut 1138=cut
1095 1139
1096our $VERSION = '3.4'; 1140our $VERSION = '5.23';
1097 1141
1098$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1142$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1143push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100 1144
1101sub timer { 1145sub timer {
1103 1147
1104 my $cb = $arg{cb}; 1148 my $cb = $arg{cb};
1105 1149
1106 urxvt::timer 1150 urxvt::timer
1107 ->new 1151 ->new
1108 ->start (urxvt::NOW + $arg{after}) 1152 ->after ($arg{after}, $arg{interval})
1109 ->cb (sub { 1153 ->cb ($arg{interval} ? $cb : sub {
1110 $_[0]->stop; # need to cancel manually 1154 $_[0]->stop; # need to cancel manually
1111 $cb->(); 1155 $cb->();
1112 }) 1156 })
1113} 1157}
1114 1158
1115sub io { 1159sub io {
1116 my ($class, %arg) = @_; 1160 my ($class, %arg) = @_;
1117 1161
1118 my $cb = $arg{cb}; 1162 my $cb = $arg{cb};
1163 my $fd = fileno $arg{fh};
1164 defined $fd or $fd = $arg{fh};
1119 1165
1120 bless [$arg{fh}, urxvt::iow 1166 bless [$arg{fh}, urxvt::iow
1121 ->new 1167 ->new
1122 ->fd (fileno $arg{fh}) 1168 ->fd ($fd)
1123 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1169 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1124 | ($arg{poll} =~ /w/ ? 2 : 0)) 1170 | ($arg{poll} =~ /w/ ? 2 : 0))
1125 ->start 1171 ->start
1126 ->cb (sub { 1172 ->cb ($cb)
1127 $cb->(($_[1] & 1 ? 'r' : '')
1128 . ($_[1] & 2 ? 'w' : ''));
1129 })],
1130 urxvt::anyevent:: 1173 ], urxvt::anyevent::
1174}
1175
1176sub idle {
1177 my ($class, %arg) = @_;
1178
1179 my $cb = $arg{cb};
1180
1181 urxvt::iw
1182 ->new
1183 ->start
1184 ->cb ($cb)
1185}
1186
1187sub child {
1188 my ($class, %arg) = @_;
1189
1190 my $cb = $arg{cb};
1191
1192 urxvt::pw
1193 ->new
1194 ->start ($arg{pid})
1195 ->cb (sub {
1196 $_[0]->stop; # need to cancel manually
1197 $cb->($_[0]->rpid, $_[0]->rstatus);
1198 })
1131} 1199}
1132 1200
1133sub DESTROY { 1201sub DESTROY {
1134 $_[0][1]->stop; 1202 $_[0][1]->stop;
1135} 1203}
1265 1333
1266 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1334 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1267 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1335 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1268 display_name embed ext_bwidth fade font geometry hold iconName 1336 display_name embed ext_bwidth fade font geometry hold iconName
1269 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1337 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1270 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1338 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1271 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1339 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1272 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1340 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1273 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1341 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1274 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1342 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1275 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1343 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1276 secondaryScreen secondaryScroll shade term_name title 1344 secondaryScreen secondaryScroll shade term_name title
1277 transient_for transparent transparent_all tripleclickwords utmpInhibit 1345 transient_for transparent transparent_all tripleclickwords utmpInhibit
1280=cut 1348=cut
1281 1349
1282sub resource($$;$) { 1350sub resource($$;$) {
1283 my ($self, $name) = (shift, shift); 1351 my ($self, $name) = (shift, shift);
1284 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1352 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1285 &urxvt::term::_resource 1353 goto &urxvt::term::_resource
1286} 1354}
1287 1355
1288=item $value = $term->x_resource ($pattern) 1356=item $value = $term->x_resource ($pattern)
1289 1357
1290Returns the X-Resource for the given pattern, excluding the program or 1358Returns the X-Resource for the given pattern, excluding the program or
1315 1383
1316=item ($row, $col) = $term->selection_beg ([$row, $col]) 1384=item ($row, $col) = $term->selection_beg ([$row, $col])
1317 1385
1318=item ($row, $col) = $term->selection_end ([$row, $col]) 1386=item ($row, $col) = $term->selection_end ([$row, $col])
1319 1387
1320Return the current values of the selection mark, begin or end positions, 1388Return the current values of the selection mark, begin or end positions.
1321and optionally set them to new values. 1389
1390When arguments are given, then the selection coordinates are set to
1391C<$row> and C<$col>, and the selection screen is set to the current
1392screen.
1393
1394=item $screen = $term->selection_screen ([$screen])
1395
1396Returns the current selection screen, and then optionally sets it.
1322 1397
1323=item $term->selection_make ($eventtime[, $rectangular]) 1398=item $term->selection_make ($eventtime[, $rectangular])
1324 1399
1325Tries to make a selection as set by C<selection_beg> and 1400Tries to make a selection as set by C<selection_beg> and
1326C<selection_end>. If C<$rectangular> is true (default: false), a 1401C<selection_end>. If C<$rectangular> is true (default: false), a
1327rectangular selection will be made. This is the prefered function to make 1402rectangular selection will be made. This is the preferred function to make
1328a selection. 1403a selection.
1329 1404
1330=item $success = $term->selection_grab ($eventtime) 1405=item $success = $term->selection_grab ($eventtime[, $clipboard])
1331 1406
1332Try to request the primary selection text from the server (for example, as 1407Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1408true) selection from the server. The corresponding text can be set
1333set by the next method). No visual feedback will be given. This function 1409with the next method. No visual feedback will be given. This function
1334is mostly useful from within C<on_sel_grab> hooks. 1410is mostly useful from within C<on_sel_grab> hooks.
1335 1411
1336=item $oldtext = $term->selection ([$newtext]) 1412=item $oldtext = $term->selection ([$newtext, $clipboard])
1337 1413
1338Return the current selection text and optionally replace it by C<$newtext>. 1414Return the current selection (clipboard if C<$clipboard> is true) text
1415and optionally replace it by C<$newtext>.
1416
1417=item $term->selection_clear ([$clipboard])
1418
1419Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1339 1420
1340=item $term->overlay_simple ($x, $y, $text) 1421=item $term->overlay_simple ($x, $y, $text)
1341 1422
1342Create a simple multi-line overlay box. See the next method for details. 1423Create a simple multi-line overlay box. See the next method for details.
1343 1424
1373 1454
1374The methods currently supported on C<urxvt::overlay> objects are: 1455The methods currently supported on C<urxvt::overlay> objects are:
1375 1456
1376=over 4 1457=over 4
1377 1458
1378=item $overlay->set ($x, $y, $text, $rend) 1459=item $overlay->set ($x, $y, $text[, $rend])
1379 1460
1380Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1461Similar 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 1462text in rxvt-unicode's special encoding and an array of rendition values
1382at a specific position inside the overlay. 1463at a specific position inside the overlay.
1464
1465If C<$rend> is missing, then the rendition will not be changed.
1383 1466
1384=item $overlay->hide 1467=item $overlay->hide
1385 1468
1386If visible, hide the overlay, but do not destroy it. 1469If visible, hide the overlay, but do not destroy it.
1387 1470
1469locale-specific encoding of the terminal and can contain command sequences 1552locale-specific encoding of the terminal and can contain command sequences
1470(escape codes) that will be interpreted. 1553(escape codes) that will be interpreted.
1471 1554
1472=item $term->tt_write ($octets) 1555=item $term->tt_write ($octets)
1473 1556
1474Write the octets given in C<$data> to the tty (i.e. as program input). To 1557Write 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 1558pass characters instead of octets, you should convert your strings first
1476to the locale-specific encoding using C<< $term->locale_encode >>. 1559to the locale-specific encoding using C<< $term->locale_encode >>.
1560
1561=item $term->tt_paste ($octets)
1562
1563Write the octets given in C<$octets> to the tty as a paste, converting NL to
1564CR and bracketing the data with control sequences if bracketed paste mode
1565is set.
1477 1566
1478=item $old_events = $term->pty_ev_events ([$new_events]) 1567=item $old_events = $term->pty_ev_events ([$new_events])
1479 1568
1480Replaces the event mask of the pty watcher by the given event mask. Can 1569Replaces 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 1570be used to suppress input and output handling to the pty/tty. See the
1795Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1884Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1796recent grab. 1885recent grab.
1797 1886
1798=item $term->ungrab 1887=item $term->ungrab
1799 1888
1800Calls XUngrab for the most recent grab. Is called automatically on 1889Calls 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 1890evaluation errors, as it is better to lose the grab in the error case as
1802the session. 1891the session.
1803 1892
1804=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1893=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1805 1894
1807 1896
1808=item @atoms = $term->XListProperties ($window) 1897=item @atoms = $term->XListProperties ($window)
1809 1898
1810=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1899=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1811 1900
1812=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1901=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1813 1902
1814=item $term->XDeleteProperty ($window, $property) 1903=item $term->XDeleteProperty ($window, $property)
1815 1904
1816=item $window = $term->DefaultRootWindow 1905=item $window = $term->DefaultRootWindow
1817 1906
1827 1916
1828=item $term->XChangeInput ($window, $add_events[, $del_events]) 1917=item $term->XChangeInput ($window, $add_events[, $del_events])
1829 1918
1830Various X or X-related functions. The C<$term> object only serves as 1919Various X or X-related functions. The C<$term> object only serves as
1831the source of the display, otherwise those functions map more-or-less 1920the source of the display, otherwise those functions map more-or-less
1832directory onto the X functions of the same name. 1921directly onto the X functions of the same name.
1833 1922
1834=back 1923=back
1835 1924
1836=cut 1925=cut
1837 1926
1994 2083
1995=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2084=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1996 2085
1997Set the callback to be called when the timer triggers. 2086Set the callback to be called when the timer triggers.
1998 2087
1999=item $tstamp = $timer->at
2000
2001Return the time this watcher will fire next.
2002
2003=item $timer = $timer->set ($tstamp) 2088=item $timer = $timer->set ($tstamp[, $interval])
2004 2089
2005Set the time the event is generated to $tstamp. 2090Set the time the event is generated to $tstamp (and optionally specifies a
2091new $interval).
2006 2092
2007=item $timer = $timer->interval ($interval) 2093=item $timer = $timer->interval ($interval)
2008 2094
2009Normally (and when C<$interval> is C<0>), the timer will automatically 2095By 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 2096stop after it has fired once. If C<$interval> is non-zero, then the timer
2011is automatically rescheduled at the given intervals. 2097is automatically rescheduled at the given intervals.
2012 2098
2013=item $timer = $timer->start 2099=item $timer = $timer->start
2014 2100
2015Start the timer. 2101Start the timer.
2016 2102
2017=item $timer = $timer->start ($tstamp) 2103=item $timer = $timer->start ($tstamp[, $interval])
2018 2104
2019Set the event trigger time to C<$tstamp> and start the timer. 2105Set the event trigger time to C<$tstamp> and start the timer. Optionally
2106also replaces the interval.
2020 2107
2021=item $timer = $timer->after ($delay) 2108=item $timer = $timer->after ($delay[, $interval])
2022 2109
2023Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2110Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2024 2111
2025=item $timer = $timer->stop 2112=item $timer = $timer->stop
2026 2113

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines