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.199 by sf-exg, Sun Nov 20 10:49:56 2011 UTC

259The default pattern to match URLs can be overridden with the 259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified 260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension. 261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis. 262The launcher can also be overridden on a per-pattern basis.
263 263
264It is possible to activate the most recently seen match from the keyboard. 264It is possible to activate the most recently seen match or a list of matches
265from the keyboard. Simply bind a keysym to "perl:matcher:last" or
265Simply bind a keysym to "perl:matcher" as seen in the example below. 266"perl:matcher:list" as seen in the example below.
266 267
267Example configuration: 268Example configuration:
268 269
269 URxvt.perl-ext: default,matcher 270 URxvt.perl-ext: default,matcher
270 URxvt.urlLauncher: sensible-browser 271 URxvt.urlLauncher: sensible-browser
271 URxvt.keysym.C-Delete: perl:matcher 272 URxvt.keysym.C-Delete: perl:matcher:last
273 URxvt.keysym.M-Delete: perl:matcher:list
272 URxvt.matcher.button: 1 274 URxvt.matcher.button: 1
273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] 275 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) 276 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275 URxvt.matcher.launcher.2: gvim +$2 $1 277 URxvt.matcher.launcher.2: gvim +$2 $1
276 278
341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343 345
344=item selection-pastebin 346=item selection-pastebin
345 347
346This is a little rarely useful extension that Uploads the selection as 348This is a little rarely useful extension that uploads the selection as
347textfile to a remote site (or does other things). (The implementation is 349textfile to a remote site (or does other things). (The implementation is
348not currently secure for use in a multiuser environment as it writes to 350not currently secure for use in a multiuser environment as it writes to
349F</tmp> directly.). 351F</tmp> directly.).
350 352
351It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
370 372
371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372 374
373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret 375I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374the double C</> characters as comment start. Use C<\057\057> instead, 376the double C</> characters as comment start. Use C<\057\057> instead,
375which works regardless of wether xrdb is used to parse the resource file 377which works regardless of whether xrdb is used to parse the resource file
376or not. 378or not.
379
380=item macosx-clipboard and macosx-clipboard-native
381
382These two modules implement an extended clipboard for Mac OS X. They are
383used like this:
384
385 URxvt.perl-ext-common: default,macosx-clipboard
386 URxvt.keysym.M-c: perl:macosx-clipboard:copy
387 URxvt.keysym.M-v: perl:macosx-clipboard:paste
388
389The difference between them is that the native variant requires a
390perl from apple's devkit or so, and C<macosx-clipboard> requires the
391C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
392simpler etc. etc.
377 393
378=item example-refresh-hooks 394=item example-refresh-hooks
379 395
380Displays a very simple digital clock in the upper right corner of the 396Displays a very simple digital clock in the upper right corner of the
381window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
382overlays or changes. 398overlays or changes.
399
400=item confirm-paste
401
402Displays a confirmation dialog when a paste containing at least a full
403line is detected.
404
405=item bell-command
406
407Runs the command specified by the C<URxvt.bell-command> resource when
408a bell event occurs. For example, the following pops up a notification
409bubble with the text "Beep, Beep" using notify-send:
410
411 URxvt.bell-command: notify-send "Beep, Beep"
383 412
384=back 413=back
385 414
386=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
387 416
403 432
404=over 4 433=over 4
405 434
406=item $text 435=item $text
407 436
408Rxvt-unicodes special way of encoding text, where one "unicode" character 437Rxvt-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. 438always represents one screen cell. See L<ROW_t> for a discussion of this format.
410 439
411=item $string 440=item $string
412 441
413A perl text string, with an emphasis on I<text>. It can store all unicode 442A perl text string, with an emphasis on I<text>. It can store all unicode
422=back 451=back
423 452
424=head2 Extension Objects 453=head2 Extension Objects
425 454
426Every perl extension is a perl class. A separate perl object is created 455Every perl extension is a perl class. A separate perl object is created
427for each terminal, and each terminal has its own set of extenion objects, 456for each terminal, and each terminal has its own set of extension objects,
428which are passed as the first parameter to hooks. So extensions can use 457which are passed as the first parameter to hooks. So extensions can use
429their C<$self> object without having to think about clashes with other 458their C<$self> object without having to think about clashes with other
430extensions or other terminals, with the exception of methods and members 459extensions or other terminals, with the exception of methods and members
431that begin with an underscore character C<_>: these are reserved for 460that begin with an underscore character C<_>: these are reserved for
432internal use. 461internal use.
596=item on_tt_write $term, $octets 625=item on_tt_write $term, $octets
597 626
598Called whenever some data is written to the tty/pty and can be used to 627Called whenever some data is written to the tty/pty and can be used to
599suppress or filter tty input. 628suppress or filter tty input.
600 629
630=item on_tt_paste $term, $octets
631
632Called whenever text is about to be pasted, with the text as argument. You
633can filter/change and paste the text yourself by returning a true value
634and calling C<< $term->tt_paste >> yourself. C<$octets> is
635locale-encoded.
636
601=item on_line_update $term, $row 637=item on_line_update $term, $row
602 638
603Called whenever a line was updated or changed. Can be used to filter 639Called whenever a line was updated or changed. Can be used to filter
604screen output (e.g. underline urls or other useless stuff). Only lines 640screen output (e.g. underline urls or other useless stuff). Only lines
605that are being shown will be filtered, and, due to performance reasons, 641that are being shown will be filtered, and, due to performance reasons,
630resource in the @@RXVT_NAME@@(1) manpage). 666resource in the @@RXVT_NAME@@(1) manpage).
631 667
632The event is simply the action string. This interface is assumed to change 668The event is simply the action string. This interface is assumed to change
633slightly in the future. 669slightly in the future.
634 670
635=item on_resize_all_windows $tern, $new_width, $new_height 671=item on_resize_all_windows $term, $new_width, $new_height
636 672
637Called just after the new window size has been calculated, but before 673Called just after the new window size has been calculated, but before
638windows are actually being resized or hints are being set. If this hook 674windows are actually being resized or hints are being set. If this hook
639returns TRUE, setting of the window hints is being skipped. 675returns TRUE, setting of the window hints is being skipped.
640 676
674 710
675=item on_map_notify $term, $event 711=item on_map_notify $term, $event
676 712
677=item on_unmap_notify $term, $event 713=item on_unmap_notify $term, $event
678 714
679Called whenever the corresponding X event is received for the terminal If 715Called whenever the corresponding X event is received for the terminal. If
680the hook returns true, then the even will be ignored by rxvt-unicode. 716the hook returns true, then the event will be ignored by rxvt-unicode.
681 717
682The event is a hash with most values as named by Xlib (see the XEvent 718The 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 719manpage), with the additional members C<row> and C<col>, which are the
684(real, not screen-based) row and column under the mouse cursor. 720(real, not screen-based) row and column under the mouse cursor.
685 721
694 730
695=item on_wm_delete_window $term, $event 731=item on_wm_delete_window $term, $event
696 732
697Called when various types of ClientMessage events are received (all with 733Called when various types of ClientMessage events are received (all with
698format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 734format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
735
736=item on_bell $term
737
738Called on receipt of a bell character.
699 739
700=back 740=back
701 741
702=cut 742=cut
703 743
768 808
769=over 4 809=over 4
770 810
771=item urxvt::fatal $errormessage 811=item urxvt::fatal $errormessage
772 812
773Fatally aborts execution with the given error message. Avoid at all 813Fatally aborts execution with the given error message (which should
774costs! The only time this is acceptable is when the terminal process 814include a trailing newline). Avoid at all costs! The only time this
775starts up. 815is acceptable (and useful) is in the init hook, where it prevents the
816terminal from starting up.
776 817
777=item urxvt::warn $string 818=item urxvt::warn $string
778 819
779Calls C<rxvt_warn> with the given string which should not include a 820Calls C<rxvt_warn> with the given string which should include a trailing
780newline. The module also overwrites the C<warn> builtin with a function 821newline. The module also overwrites the C<warn> builtin with a function
781that calls this function. 822that calls this function.
782 823
783Using this function has the advantage that its output ends up in the 824Using this function has the advantage that its output ends up in the
784correct place, e.g. on stderr of the connecting urxvtc client. 825correct place, e.g. on stderr of the connecting urxvtc client.
788=item @terms = urxvt::termlist 829=item @terms = urxvt::termlist
789 830
790Returns all urxvt::term objects that exist in this process, regardless of 831Returns all urxvt::term objects that exist in this process, regardless of
791whether they are started, being destroyed etc., so be careful. Only term 832whether they are started, being destroyed etc., so be careful. Only term
792objects that have perl extensions attached will be returned (because there 833objects that have perl extensions attached will be returned (because there
793is no urxvt::term objet associated with others). 834is no urxvt::term object associated with others).
794 835
795=item $time = urxvt::NOW 836=item $time = urxvt::NOW
796 837
797Returns the "current time" (as per the event loop). 838Returns the "current time" (as per the event loop).
798 839
841 882
842=item $rend = urxvt::OVERLAY_RSTYLE 883=item $rend = urxvt::OVERLAY_RSTYLE
843 884
844Return the rendition mask used for overlays by default. 885Return the rendition mask used for overlays by default.
845 886
846=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 887=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
888urxvt::RS_RVid, urxvt::RS_Uline
847 889
848Return the bit that enabled bold, italic, blink, reverse-video and 890Return the bit that enabled bold, italic, blink, reverse-video and
849underline, respectively. To enable such a style, just logically OR it into 891underline, respectively. To enable such a style, just logically OR it into
850the bitset. 892the bitset.
851 893
1110is that you cannot use blocking APIs, but the non-blocking variant should 1152is that you cannot use blocking APIs, but the non-blocking variant should
1111work. 1153work.
1112 1154
1113=cut 1155=cut
1114 1156
1115our $VERSION = '3.4'; 1157our $VERSION = '5.23';
1116 1158
1117$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1159$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1118push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1160push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1119 1161
1120sub timer { 1162sub timer {
1122 1164
1123 my $cb = $arg{cb}; 1165 my $cb = $arg{cb};
1124 1166
1125 urxvt::timer 1167 urxvt::timer
1126 ->new 1168 ->new
1127 ->start (urxvt::NOW + $arg{after}) 1169 ->after ($arg{after}, $arg{interval})
1128 ->cb (sub { 1170 ->cb ($arg{interval} ? $cb : sub {
1129 $_[0]->stop; # need to cancel manually 1171 $_[0]->stop; # need to cancel manually
1130 $cb->(); 1172 $cb->();
1131 }) 1173 })
1132} 1174}
1133 1175
1134sub io { 1176sub io {
1135 my ($class, %arg) = @_; 1177 my ($class, %arg) = @_;
1136 1178
1137 my $cb = $arg{cb}; 1179 my $cb = $arg{cb};
1180 my $fd = fileno $arg{fh};
1181 defined $fd or $fd = $arg{fh};
1138 1182
1139 bless [$arg{fh}, urxvt::iow 1183 bless [$arg{fh}, urxvt::iow
1140 ->new 1184 ->new
1141 ->fd (fileno $arg{fh}) 1185 ->fd ($fd)
1142 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1186 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1143 | ($arg{poll} =~ /w/ ? 2 : 0)) 1187 | ($arg{poll} =~ /w/ ? 2 : 0))
1144 ->start 1188 ->start
1145 ->cb (sub { 1189 ->cb ($cb)
1146 $cb->(($_[1] & 1 ? 'r' : '')
1147 . ($_[1] & 2 ? 'w' : ''));
1148 })],
1149 urxvt::anyevent:: 1190 ], urxvt::anyevent::
1191}
1192
1193sub idle {
1194 my ($class, %arg) = @_;
1195
1196 my $cb = $arg{cb};
1197
1198 urxvt::iw
1199 ->new
1200 ->start
1201 ->cb ($cb)
1202}
1203
1204sub child {
1205 my ($class, %arg) = @_;
1206
1207 my $cb = $arg{cb};
1208
1209 urxvt::pw
1210 ->new
1211 ->start ($arg{pid})
1212 ->cb (sub {
1213 $_[0]->stop; # need to cancel manually
1214 $cb->($_[0]->rpid, $_[0]->rstatus);
1215 })
1150} 1216}
1151 1217
1152sub DESTROY { 1218sub DESTROY {
1153 $_[0][1]->stop; 1219 $_[0][1]->stop;
1154} 1220}
1155 1221
1222# only needed for AnyEvent < 6 compatibility
1156sub one_event { 1223sub one_event {
1157 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1224 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1158} 1225}
1159 1226
1160package urxvt::term; 1227package urxvt::term;
1252C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1319C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1253 1320
1254Here is a likely non-exhaustive list of option names, please see the 1321Here is a likely non-exhaustive list of option names, please see the
1255source file F</src/optinc.h> to see the actual list: 1322source file F</src/optinc.h> to see the actual list:
1256 1323
1257 borderLess console cursorBlink cursorUnderline hold iconic insecure 1324 borderLess buffered console cursorBlink cursorUnderline hold iconic
1258 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1325 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1259 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1326 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1260 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1327 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1261 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1328 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1262 transparent tripleclickwords utmpInhibit visualBell 1329 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1330 urgentOnBell utmpInhibit visualBell
1263 1331
1264=item $value = $term->resource ($name[, $newval]) 1332=item $value = $term->resource ($name[, $newval])
1265 1333
1266Returns the current resource value associated with a given name and 1334Returns the current resource value associated with a given name and
1267optionally sets a new value. Setting values is most useful in the C<init> 1335optionally sets a new value. Setting values is most useful in the C<init>
1280 1348
1281Here is a likely non-exhaustive list of resource names, not all of which 1349Here is a likely non-exhaustive list of resource names, not all of which
1282are supported in every build, please see the source file F</src/rsinc.h> 1350are supported in every build, please see the source file F</src/rsinc.h>
1283to see the actual list: 1351to see the actual list:
1284 1352
1285 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1353 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1286 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1354 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1287 display_name embed ext_bwidth fade font geometry hold iconName 1355 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1288 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1356 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1357 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1289 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1358 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1290 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1359 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1291 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1360 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1292 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1361 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1293 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1362 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1294 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1363 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1295 secondaryScreen secondaryScroll shade term_name title 1364 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1296 transient_for transparent transparent_all tripleclickwords utmpInhibit 1365 term_name title transient_for transparent tripleclickwords urgentOnBell
1297 visualBell 1366 utmpInhibit visualBell
1298 1367
1299=cut 1368=cut
1300 1369
1301sub resource($$;$) { 1370sub resource($$;$) {
1302 my ($self, $name) = (shift, shift); 1371 my ($self, $name) = (shift, shift);
1334 1403
1335=item ($row, $col) = $term->selection_beg ([$row, $col]) 1404=item ($row, $col) = $term->selection_beg ([$row, $col])
1336 1405
1337=item ($row, $col) = $term->selection_end ([$row, $col]) 1406=item ($row, $col) = $term->selection_end ([$row, $col])
1338 1407
1339Return the current values of the selection mark, begin or end positions, 1408Return the current values of the selection mark, begin or end positions.
1340and optionally set them to new values. 1409
1410When arguments are given, then the selection coordinates are set to
1411C<$row> and C<$col>, and the selection screen is set to the current
1412screen.
1413
1414=item $screen = $term->selection_screen ([$screen])
1415
1416Returns the current selection screen, and then optionally sets it.
1341 1417
1342=item $term->selection_make ($eventtime[, $rectangular]) 1418=item $term->selection_make ($eventtime[, $rectangular])
1343 1419
1344Tries to make a selection as set by C<selection_beg> and 1420Tries to make a selection as set by C<selection_beg> and
1345C<selection_end>. If C<$rectangular> is true (default: false), a 1421C<selection_end>. If C<$rectangular> is true (default: false), a
1346rectangular selection will be made. This is the prefered function to make 1422rectangular selection will be made. This is the preferred function to make
1347a selection. 1423a selection.
1348 1424
1349=item $success = $term->selection_grab ($eventtime) 1425=item $success = $term->selection_grab ($eventtime[, $clipboard])
1350 1426
1351Try to request the primary selection text from the server (for example, as 1427Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1428true) selection from the server. The corresponding text can be set
1352set by the next method). No visual feedback will be given. This function 1429with the next method. No visual feedback will be given. This function
1353is mostly useful from within C<on_sel_grab> hooks. 1430is mostly useful from within C<on_sel_grab> hooks.
1354 1431
1355=item $oldtext = $term->selection ([$newtext]) 1432=item $oldtext = $term->selection ([$newtext, $clipboard])
1356 1433
1357Return the current selection text and optionally replace it by C<$newtext>. 1434Return the current selection (clipboard if C<$clipboard> is true) text
1435and optionally replace it by C<$newtext>.
1436
1437=item $term->selection_clear ([$clipboard])
1438
1439Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1358 1440
1359=item $term->overlay_simple ($x, $y, $text) 1441=item $term->overlay_simple ($x, $y, $text)
1360 1442
1361Create a simple multi-line overlay box. See the next method for details. 1443Create a simple multi-line overlay box. See the next method for details.
1362 1444
1490locale-specific encoding of the terminal and can contain command sequences 1572locale-specific encoding of the terminal and can contain command sequences
1491(escape codes) that will be interpreted. 1573(escape codes) that will be interpreted.
1492 1574
1493=item $term->tt_write ($octets) 1575=item $term->tt_write ($octets)
1494 1576
1495Write the octets given in C<$data> to the tty (i.e. as program input). To 1577Write the octets given in C<$octets> to the tty (i.e. as program input). To
1496pass characters instead of octets, you should convert your strings first 1578pass characters instead of octets, you should convert your strings first
1497to the locale-specific encoding using C<< $term->locale_encode >>. 1579to the locale-specific encoding using C<< $term->locale_encode >>.
1580
1581=item $term->tt_paste ($octets)
1582
1583Write the octets given in C<$octets> to the tty as a paste, converting NL to
1584CR and bracketing the data with control sequences if bracketed paste mode
1585is set.
1498 1586
1499=item $old_events = $term->pty_ev_events ([$new_events]) 1587=item $old_events = $term->pty_ev_events ([$new_events])
1500 1588
1501Replaces the event mask of the pty watcher by the given event mask. Can 1589Replaces the event mask of the pty watcher by the given event mask. Can
1502be used to suppress input and output handling to the pty/tty. See the 1590be used to suppress input and output handling to the pty/tty. See the
1816Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1904Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1817recent grab. 1905recent grab.
1818 1906
1819=item $term->ungrab 1907=item $term->ungrab
1820 1908
1821Calls XUngrab for the most recent grab. Is called automatically on 1909Calls 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 1910evaluation errors, as it is better to lose the grab in the error case as
1823the session. 1911the session.
1824 1912
1825=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1913=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1826 1914
1848 1936
1849=item $term->XChangeInput ($window, $add_events[, $del_events]) 1937=item $term->XChangeInput ($window, $add_events[, $del_events])
1850 1938
1851Various X or X-related functions. The C<$term> object only serves as 1939Various X or X-related functions. The C<$term> object only serves as
1852the source of the display, otherwise those functions map more-or-less 1940the source of the display, otherwise those functions map more-or-less
1853directory onto the X functions of the same name. 1941directly onto the X functions of the same name.
1854 1942
1855=back 1943=back
1856 1944
1857=cut 1945=cut
1858 1946
2015 2103
2016=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2104=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017 2105
2018Set the callback to be called when the timer triggers. 2106Set the callback to be called when the timer triggers.
2019 2107
2020=item $tstamp = $timer->at
2021
2022Return the time this watcher will fire next.
2023
2024=item $timer = $timer->set ($tstamp) 2108=item $timer = $timer->set ($tstamp[, $interval])
2025 2109
2026Set the time the event is generated to $tstamp. 2110Set the time the event is generated to $tstamp (and optionally specifies a
2111new $interval).
2027 2112
2028=item $timer = $timer->interval ($interval) 2113=item $timer = $timer->interval ($interval)
2029 2114
2030Normally (and when C<$interval> is C<0>), the timer will automatically 2115By 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 2116stop after it has fired once. If C<$interval> is non-zero, then the timer
2032is automatically rescheduled at the given intervals. 2117is automatically rescheduled at the given intervals.
2033 2118
2034=item $timer = $timer->start 2119=item $timer = $timer->start
2035 2120
2036Start the timer. 2121Start the timer.
2037 2122
2038=item $timer = $timer->start ($tstamp) 2123=item $timer = $timer->start ($tstamp[, $interval])
2039 2124
2040Set the event trigger time to C<$tstamp> and start the timer. 2125Set the event trigger time to C<$tstamp> and start the timer. Optionally
2126also replaces the interval.
2041 2127
2042=item $timer = $timer->after ($delay) 2128=item $timer = $timer->after ($delay[, $interval])
2043 2129
2044Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2130Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045 2131
2046=item $timer = $timer->stop 2132=item $timer = $timer->stop
2047 2133
2178 2264
2179=back 2265=back
2180 2266
2181=head1 AUTHOR 2267=head1 AUTHOR
2182 2268
2183 Marc Lehmann <pcg@goof.com> 2269 Marc Lehmann <schmorp@schmorp.de>
2184 http://software.schmorp.de/pkg/rxvt-unicode 2270 http://software.schmorp.de/pkg/rxvt-unicode
2185 2271
2186=cut 2272=cut
2187 2273
21881 22741

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines