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.178 by root, Sat Dec 26 09:02:42 2009 UTC vs.
Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 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.
377 379
378=item macosx-pastebin and macosx-pastebin-native 380=item macosx-clipboard and macosx-clipboard-native
379 381
380These two modules implement an extended clipboard for Mac OS X. They are 382These two modules implement an extended clipboard for Mac OS X. They are
381used like this: 383used like this:
382 384
383 URxvt.perl-ext-common: default,macosx-clipboard 385 URxvt.perl-ext-common: default,macosx-clipboard
384 URxvt.keysym.M-c: perl:macosx-clipboard:copy 386 URxvt.keysym.M-c: perl:macosx-clipboard:copy
385 URxvt.keysym.M-v: perl:macosx-clipboard:paste 387 URxvt.keysym.M-v: perl:macosx-clipboard:paste
386 388
387The difference between them is that the native variant requires a 389The difference between them is that the native variant requires a
388perl from apple's devkit or so, and C<maxosx-pastebin> requires the 390perl from apple's devkit or so, and C<macosx-clipboard> requires the
389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is 391C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc. 392simpler etc. etc.
391 393
392=item example-refresh-hooks 394=item example-refresh-hooks
393 395
394Displays 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
395window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
396overlays 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"
397 412
398=back 413=back
399 414
400=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
401 416
417 432
418=over 4 433=over 4
419 434
420=item $text 435=item $text
421 436
422Rxvt-unicodes special way of encoding text, where one "unicode" character 437Rxvt-unicode's special way of encoding text, where one "unicode" character
423always represents one screen cell. See L<ROW_t> for a discussion of this format. 438always represents one screen cell. See L<ROW_t> for a discussion of this format.
424 439
425=item $string 440=item $string
426 441
427A 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
431=item $octets 446=item $octets
432 447
433Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
434locale-specific way. 449locale-specific way.
435 450
451=item $keysym
452
453an integer that is a valid X11 keysym code. You can convert a string
454into a keysym and viceversa by using C<XStringToKeysym> and
455C<XKeysymToString>.
456
436=back 457=back
437 458
438=head2 Extension Objects 459=head2 Extension Objects
439 460
440Every perl extension is a perl class. A separate perl object is created 461Every perl extension is a perl class. A separate perl object is created
441for each terminal, and each terminal has its own set of extenion objects, 462for each terminal, and each terminal has its own set of extension objects,
442which are passed as the first parameter to hooks. So extensions can use 463which are passed as the first parameter to hooks. So extensions can use
443their C<$self> object without having to think about clashes with other 464their C<$self> object without having to think about clashes with other
444extensions or other terminals, with the exception of methods and members 465extensions or other terminals, with the exception of methods and members
445that begin with an underscore character C<_>: these are reserved for 466that begin with an underscore character C<_>: these are reserved for
446internal use. 467internal use.
610=item on_tt_write $term, $octets 631=item on_tt_write $term, $octets
611 632
612Called whenever some data is written to the tty/pty and can be used to 633Called whenever some data is written to the tty/pty and can be used to
613suppress or filter tty input. 634suppress or filter tty input.
614 635
636=item on_tt_paste $term, $octets
637
638Called whenever text is about to be pasted, with the text as argument. You
639can filter/change and paste the text yourself by returning a true value
640and calling C<< $term->tt_paste >> yourself. C<$octets> is
641locale-encoded.
642
615=item on_line_update $term, $row 643=item on_line_update $term, $row
616 644
617Called whenever a line was updated or changed. Can be used to filter 645Called whenever a line was updated or changed. Can be used to filter
618screen output (e.g. underline urls or other useless stuff). Only lines 646screen output (e.g. underline urls or other useless stuff). Only lines
619that are being shown will be filtered, and, due to performance reasons, 647that are being shown will be filtered, and, due to performance reasons,
644resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
645 673
646The event is simply the action string. This interface is assumed to change 674The event is simply the action string. This interface is assumed to change
647slightly in the future. 675slightly in the future.
648 676
649=item on_resize_all_windows $tern, $new_width, $new_height 677=item on_resize_all_windows $term, $new_width, $new_height
650 678
651Called just after the new window size has been calculated, but before 679Called just after the new window size has been calculated, but before
652windows are actually being resized or hints are being set. If this hook 680windows are actually being resized or hints are being set. If this hook
653returns TRUE, setting of the window hints is being skipped. 681returns TRUE, setting of the window hints is being skipped.
654 682
688 716
689=item on_map_notify $term, $event 717=item on_map_notify $term, $event
690 718
691=item on_unmap_notify $term, $event 719=item on_unmap_notify $term, $event
692 720
693Called whenever the corresponding X event is received for the terminal If 721Called whenever the corresponding X event is received for the terminal. If
694the hook returns true, then the even will be ignored by rxvt-unicode. 722the hook returns true, then the event will be ignored by rxvt-unicode.
695 723
696The event is a hash with most values as named by Xlib (see the XEvent 724The event is a hash with most values as named by Xlib (see the XEvent
697manpage), with the additional members C<row> and C<col>, which are the 725manpage), with the additional members C<row> and C<col>, which are the
698(real, not screen-based) row and column under the mouse cursor. 726(real, not screen-based) row and column under the mouse cursor.
699 727
708 736
709=item on_wm_delete_window $term, $event 737=item on_wm_delete_window $term, $event
710 738
711Called when various types of ClientMessage events are received (all with 739Called when various types of ClientMessage events are received (all with
712format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 740format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
741
742=item on_bell $term
743
744Called on receipt of a bell character.
713 745
714=back 746=back
715 747
716=cut 748=cut
717 749
782 814
783=over 4 815=over 4
784 816
785=item urxvt::fatal $errormessage 817=item urxvt::fatal $errormessage
786 818
787Fatally aborts execution with the given error message. Avoid at all 819Fatally aborts execution with the given error message (which should
788costs! The only time this is acceptable is when the terminal process 820include a trailing newline). Avoid at all costs! The only time this
789starts up. 821is acceptable (and useful) is in the init hook, where it prevents the
822terminal from starting up.
790 823
791=item urxvt::warn $string 824=item urxvt::warn $string
792 825
793Calls C<rxvt_warn> with the given string which should not include a 826Calls C<rxvt_warn> with the given string which should include a trailing
794newline. The module also overwrites the C<warn> builtin with a function 827newline. The module also overwrites the C<warn> builtin with a function
795that calls this function. 828that calls this function.
796 829
797Using this function has the advantage that its output ends up in the 830Using this function has the advantage that its output ends up in the
798correct place, e.g. on stderr of the connecting urxvtc client. 831correct place, e.g. on stderr of the connecting urxvtc client.
802=item @terms = urxvt::termlist 835=item @terms = urxvt::termlist
803 836
804Returns all urxvt::term objects that exist in this process, regardless of 837Returns all urxvt::term objects that exist in this process, regardless of
805whether they are started, being destroyed etc., so be careful. Only term 838whether they are started, being destroyed etc., so be careful. Only term
806objects that have perl extensions attached will be returned (because there 839objects that have perl extensions attached will be returned (because there
807is no urxvt::term objet associated with others). 840is no urxvt::term object associated with others).
808 841
809=item $time = urxvt::NOW 842=item $time = urxvt::NOW
810 843
811Returns the "current time" (as per the event loop). 844Returns the "current time" (as per the event loop).
812 845
855 888
856=item $rend = urxvt::OVERLAY_RSTYLE 889=item $rend = urxvt::OVERLAY_RSTYLE
857 890
858Return the rendition mask used for overlays by default. 891Return the rendition mask used for overlays by default.
859 892
860=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 893=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
894urxvt::RS_RVid, urxvt::RS_Uline
861 895
862Return the bit that enabled bold, italic, blink, reverse-video and 896Return the bit that enabled bold, italic, blink, reverse-video and
863underline, respectively. To enable such a style, just logically OR it into 897underline, respectively. To enable such a style, just logically OR it into
864the bitset. 898the bitset.
865 899
947sub invoke { 981sub invoke {
948 local $TERM = shift; 982 local $TERM = shift;
949 my $htype = shift; 983 my $htype = shift;
950 984
951 if ($htype == 0) { # INIT 985 if ($htype == 0) { # INIT
952 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 986 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
953 987
954 my %ext_arg; 988 my %ext_arg;
955 989
956 { 990 {
957 my @init = @TERM_INIT; 991 my @init = @TERM_INIT;
1136 1170
1137 my $cb = $arg{cb}; 1171 my $cb = $arg{cb};
1138 1172
1139 urxvt::timer 1173 urxvt::timer
1140 ->new 1174 ->new
1141 ->after ($arg{after}) 1175 ->after ($arg{after}, $arg{interval})
1142 ->interval ($arg{interval})
1143 ->start
1144 ->cb ($argv{interval} ? $cb : sub { 1176 ->cb ($arg{interval} ? $cb : sub {
1145 $_[0]->stop; # need to cancel manually 1177 $_[0]->stop; # need to cancel manually
1146 $cb->(); 1178 $cb->();
1147 }) 1179 })
1148} 1180}
1149 1181
1191 1223
1192sub DESTROY { 1224sub DESTROY {
1193 $_[0][1]->stop; 1225 $_[0][1]->stop;
1194} 1226}
1195 1227
1228# only needed for AnyEvent < 6 compatibility
1196sub one_event { 1229sub one_event {
1197 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1230 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1198} 1231}
1199 1232
1200package urxvt::term; 1233package urxvt::term;
1292C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1325C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1293 1326
1294Here is a likely non-exhaustive list of option names, please see the 1327Here is a likely non-exhaustive list of option names, please see the
1295source file F</src/optinc.h> to see the actual list: 1328source file F</src/optinc.h> to see the actual list:
1296 1329
1297 borderLess console cursorBlink cursorUnderline hold iconic insecure 1330 borderLess buffered console cursorBlink cursorUnderline hold iconic
1298 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1331 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1299 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1332 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1300 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1333 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1301 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1334 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1302 transparent tripleclickwords utmpInhibit visualBell 1335 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1336 urgentOnBell utmpInhibit visualBell
1303 1337
1304=item $value = $term->resource ($name[, $newval]) 1338=item $value = $term->resource ($name[, $newval])
1305 1339
1306Returns the current resource value associated with a given name and 1340Returns the current resource value associated with a given name and
1307optionally sets a new value. Setting values is most useful in the C<init> 1341optionally sets a new value. Setting values is most useful in the C<init>
1320 1354
1321Here is a likely non-exhaustive list of resource names, not all of which 1355Here is a likely non-exhaustive list of resource names, not all of which
1322are supported in every build, please see the source file F</src/rsinc.h> 1356are supported in every build, please see the source file F</src/rsinc.h>
1323to see the actual list: 1357to see the actual list:
1324 1358
1325 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1359 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1326 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1360 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1327 display_name embed ext_bwidth fade font geometry hold iconName 1361 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1328 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1362 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1329 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1363 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1364 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1330 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1365 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1331 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1366 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1332 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1367 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1333 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1368 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1334 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1369 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1335 secondaryScreen secondaryScroll shade term_name title 1370 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1336 transient_for transparent transparent_all tripleclickwords utmpInhibit 1371 term_name title transient_for transparent tripleclickwords urgentOnBell
1337 visualBell 1372 utmpInhibit visualBell
1338 1373
1339=cut 1374=cut
1340 1375
1341sub resource($$;$) { 1376sub resource($$;$) {
1342 my ($self, $name) = (shift, shift); 1377 my ($self, $name) = (shift, shift);
1353 1388
1354This method should only be called during the C<on_start> hook, as there is 1389This method should only be called during the C<on_start> hook, as there is
1355only one resource database per display, and later invocations might return 1390only one resource database per display, and later invocations might return
1356the wrong resources. 1391the wrong resources.
1357 1392
1358=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1393=item $success = $term->parse_keysym ($key, $octets)
1359 1394
1360Adds a keymap translation exactly as specified via a resource. See the 1395Adds a key binding exactly as specified via a resource. See the
1361C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1396C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1362 1397
1363=item $rend = $term->rstyle ([$new_rstyle]) 1398=item $rend = $term->rstyle ([$new_rstyle])
1364 1399
1365Return and optionally change the current rendition. Text that is output by 1400Return and optionally change the current rendition. Text that is output by
1374 1409
1375=item ($row, $col) = $term->selection_beg ([$row, $col]) 1410=item ($row, $col) = $term->selection_beg ([$row, $col])
1376 1411
1377=item ($row, $col) = $term->selection_end ([$row, $col]) 1412=item ($row, $col) = $term->selection_end ([$row, $col])
1378 1413
1379Return the current values of the selection mark, begin or end positions, 1414Return the current values of the selection mark, begin or end positions.
1380and optionally set them to new values. 1415
1416When arguments are given, then the selection coordinates are set to
1417C<$row> and C<$col>, and the selection screen is set to the current
1418screen.
1419
1420=item $screen = $term->selection_screen ([$screen])
1421
1422Returns the current selection screen, and then optionally sets it.
1381 1423
1382=item $term->selection_make ($eventtime[, $rectangular]) 1424=item $term->selection_make ($eventtime[, $rectangular])
1383 1425
1384Tries to make a selection as set by C<selection_beg> and 1426Tries to make a selection as set by C<selection_beg> and
1385C<selection_end>. If C<$rectangular> is true (default: false), a 1427C<selection_end>. If C<$rectangular> is true (default: false), a
1386rectangular selection will be made. This is the prefered function to make 1428rectangular selection will be made. This is the preferred function to make
1387a selection. 1429a selection.
1388 1430
1389=item $success = $term->selection_grab ($eventtime) 1431=item $success = $term->selection_grab ($eventtime[, $clipboard])
1390 1432
1391Try to request the primary selection text from the server (for example, as 1433Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1434true) selection from the server. The corresponding text can be set
1392set by the next method). No visual feedback will be given. This function 1435with the next method. No visual feedback will be given. This function
1393is mostly useful from within C<on_sel_grab> hooks. 1436is mostly useful from within C<on_sel_grab> hooks.
1394 1437
1395=item $oldtext = $term->selection ([$newtext]) 1438=item $oldtext = $term->selection ([$newtext, $clipboard])
1396 1439
1397Return the current selection text and optionally replace it by C<$newtext>. 1440Return the current selection (clipboard if C<$clipboard> is true) text
1441and optionally replace it by C<$newtext>.
1442
1443=item $term->selection_clear ([$clipboard])
1444
1445Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1398 1446
1399=item $term->overlay_simple ($x, $y, $text) 1447=item $term->overlay_simple ($x, $y, $text)
1400 1448
1401Create a simple multi-line overlay box. See the next method for details. 1449Create a simple multi-line overlay box. See the next method for details.
1402 1450
1530locale-specific encoding of the terminal and can contain command sequences 1578locale-specific encoding of the terminal and can contain command sequences
1531(escape codes) that will be interpreted. 1579(escape codes) that will be interpreted.
1532 1580
1533=item $term->tt_write ($octets) 1581=item $term->tt_write ($octets)
1534 1582
1535Write the octets given in C<$data> to the tty (i.e. as program input). To 1583Write the octets given in C<$octets> to the tty (i.e. as program input). To
1536pass characters instead of octets, you should convert your strings first 1584pass characters instead of octets, you should convert your strings first
1537to the locale-specific encoding using C<< $term->locale_encode >>. 1585to the locale-specific encoding using C<< $term->locale_encode >>.
1586
1587=item $term->tt_paste ($octets)
1588
1589Write the octets given in C<$octets> to the tty as a paste, converting NL to
1590CR and bracketing the data with control sequences if bracketed paste mode
1591is set.
1538 1592
1539=item $old_events = $term->pty_ev_events ([$new_events]) 1593=item $old_events = $term->pty_ev_events ([$new_events])
1540 1594
1541Replaces the event mask of the pty watcher by the given event mask. Can 1595Replaces the event mask of the pty watcher by the given event mask. Can
1542be used to suppress input and output handling to the pty/tty. See the 1596be used to suppress input and output handling to the pty/tty. See the
1856Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1910Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1857recent grab. 1911recent grab.
1858 1912
1859=item $term->ungrab 1913=item $term->ungrab
1860 1914
1861Calls XUngrab for the most recent grab. Is called automatically on 1915Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1862evaluation errors, as it is better to lose the grab in the error case as 1916evaluation errors, as it is better to lose the grab in the error case as
1863the session. 1917the session.
1864 1918
1865=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1919=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1866 1920
1886 1940
1887=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1941=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1888 1942
1889=item $term->XChangeInput ($window, $add_events[, $del_events]) 1943=item $term->XChangeInput ($window, $add_events[, $del_events])
1890 1944
1945=item $keysym = $term->XStringToKeysym ($string)
1946
1947=item $string = $term->XKeysymToString ($keysym)
1948
1891Various X or X-related functions. The C<$term> object only serves as 1949Various X or X-related functions. The C<$term> object only serves as
1892the source of the display, otherwise those functions map more-or-less 1950the source of the display, otherwise those functions map more-or-less
1893directory onto the X functions of the same name. 1951directly onto the X functions of the same name.
1894 1952
1895=back 1953=back
1896 1954
1897=cut 1955=cut
1898 1956
2055 2113
2056=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2114=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2057 2115
2058Set the callback to be called when the timer triggers. 2116Set the callback to be called when the timer triggers.
2059 2117
2060=item $tstamp = $timer->at
2061
2062Return the time this watcher will fire next.
2063
2064=item $timer = $timer->set ($tstamp) 2118=item $timer = $timer->set ($tstamp[, $interval])
2065 2119
2066Set the time the event is generated to $tstamp. 2120Set the time the event is generated to $tstamp (and optionally specifies a
2121new $interval).
2067 2122
2068=item $timer = $timer->interval ($interval) 2123=item $timer = $timer->interval ($interval)
2069 2124
2070Normally (and when C<$interval> is C<0>), the timer will automatically 2125By default (and when C<$interval> is C<0>), the timer will automatically
2071stop after it has fired once. If C<$interval> is non-zero, then the timer 2126stop after it has fired once. If C<$interval> is non-zero, then the timer
2072is automatically rescheduled at the given intervals. 2127is automatically rescheduled at the given intervals.
2073 2128
2074=item $timer = $timer->start 2129=item $timer = $timer->start
2075 2130
2076Start the timer. 2131Start the timer.
2077 2132
2078=item $timer = $timer->start ($tstamp) 2133=item $timer = $timer->start ($tstamp[, $interval])
2079 2134
2080Set the event trigger time to C<$tstamp> and start the timer. 2135Set the event trigger time to C<$tstamp> and start the timer. Optionally
2136also replaces the interval.
2081 2137
2082=item $timer = $timer->after ($delay) 2138=item $timer = $timer->after ($delay[, $interval])
2083 2139
2084Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2140Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2085 2141
2086=item $timer = $timer->stop 2142=item $timer = $timer->stop
2087 2143
2218 2274
2219=back 2275=back
2220 2276
2221=head1 AUTHOR 2277=head1 AUTHOR
2222 2278
2223 Marc Lehmann <pcg@goof.com> 2279 Marc Lehmann <schmorp@schmorp.de>
2224 http://software.schmorp.de/pkg/rxvt-unicode 2280 http://software.schmorp.de/pkg/rxvt-unicode
2225 2281
2226=cut 2282=cut
2227 2283
22281 22841

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines