… | |
… | |
259 | The default pattern to match URLs can be overridden with the |
259 | The default pattern to match URLs can be overridden with the |
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
261 | with numbered patterns, in a manner similar to the "selection" extension. |
261 | with numbered patterns, in a manner similar to the "selection" extension. |
262 | The launcher can also be overridden on a per-pattern basis. |
262 | The launcher can also be overridden on a per-pattern basis. |
263 | |
263 | |
264 | It is possible to activate the most recently seen match from the keyboard. |
264 | It is possible to activate the most recently seen match or a list of matches |
|
|
265 | from the keyboard. Simply bind a keysym to "perl:matcher:last" or |
265 | Simply bind a keysym to "perl:matcher" as seen in the example below. |
266 | "perl:matcher:list" as seen in the example below. |
266 | |
267 | |
267 | Example configuration: |
268 | Example 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 | |
346 | This is a little rarely useful extension that Uploads the selection as |
348 | This is a little rarely useful extension that uploads the selection as |
347 | textfile to a remote site (or does other things). (The implementation is |
349 | textfile to a remote site (or does other things). (The implementation is |
348 | not currently secure for use in a multiuser environment as it writes to |
350 | not currently secure for use in a multiuser environment as it writes to |
349 | F</tmp> directly.). |
351 | F</tmp> directly.). |
350 | |
352 | |
351 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
353 | It 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 | |
373 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
375 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
374 | the double C</> characters as comment start. Use C<\057\057> instead, |
376 | the double C</> characters as comment start. Use C<\057\057> instead, |
375 | which works regardless of wether xrdb is used to parse the resource file |
377 | which works regardless of whether xrdb is used to parse the resource file |
376 | or not. |
378 | or not. |
377 | |
379 | |
378 | =item macosx-pastebin and macosx-pastebin-native |
380 | =item macosx-clipboard and macosx-clipboard-native |
379 | |
381 | |
380 | These two modules implement an extended clipboard for Mac OS X. They are |
382 | These two modules implement an extended clipboard for Mac OS X. They are |
381 | used like this: |
383 | used 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 | |
387 | The difference between them is that the native variant requires a |
389 | The difference between them is that the native variant requires a |
388 | perl from apple's devkit or so, and C<maxosx-pastebin> requires the |
390 | perl from apple's devkit or so, and C<macosx-clipboard> requires the |
389 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
391 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
390 | simpler etc. etc. |
392 | simpler etc. etc. |
391 | |
393 | |
392 | =item example-refresh-hooks |
394 | =item example-refresh-hooks |
393 | |
395 | |
394 | Displays a very simple digital clock in the upper right corner of the |
396 | Displays a very simple digital clock in the upper right corner of the |
395 | window. Illustrates overwriting the refresh callbacks to create your own |
397 | window. Illustrates overwriting the refresh callbacks to create your own |
396 | overlays or changes. |
398 | overlays or changes. |
|
|
399 | |
|
|
400 | =item confirm-paste |
|
|
401 | |
|
|
402 | Displays a confirmation dialog when a paste containing at least a full |
|
|
403 | line is detected. |
|
|
404 | |
|
|
405 | =item bell-command |
|
|
406 | |
|
|
407 | Runs the command specified by the C<URxvt.bell-command> resource when |
|
|
408 | a bell event occurs. For example, the following pops up a notification |
|
|
409 | bubble 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 | |
422 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
437 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
423 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
438 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
424 | |
439 | |
425 | =item $string |
440 | =item $string |
426 | |
441 | |
427 | A perl text string, with an emphasis on I<text>. It can store all unicode |
442 | A perl text string, with an emphasis on I<text>. It can store all unicode |
… | |
… | |
436 | =back |
451 | =back |
437 | |
452 | |
438 | =head2 Extension Objects |
453 | =head2 Extension Objects |
439 | |
454 | |
440 | Every perl extension is a perl class. A separate perl object is created |
455 | Every perl extension is a perl class. A separate perl object is created |
441 | for each terminal, and each terminal has its own set of extenion objects, |
456 | for each terminal, and each terminal has its own set of extension objects, |
442 | which are passed as the first parameter to hooks. So extensions can use |
457 | which are passed as the first parameter to hooks. So extensions can use |
443 | their C<$self> object without having to think about clashes with other |
458 | their C<$self> object without having to think about clashes with other |
444 | extensions or other terminals, with the exception of methods and members |
459 | extensions or other terminals, with the exception of methods and members |
445 | that begin with an underscore character C<_>: these are reserved for |
460 | that begin with an underscore character C<_>: these are reserved for |
446 | internal use. |
461 | internal use. |
… | |
… | |
610 | =item on_tt_write $term, $octets |
625 | =item on_tt_write $term, $octets |
611 | |
626 | |
612 | Called whenever some data is written to the tty/pty and can be used to |
627 | Called whenever some data is written to the tty/pty and can be used to |
613 | suppress or filter tty input. |
628 | suppress or filter tty input. |
614 | |
629 | |
|
|
630 | =item on_tt_paste $term, $octets |
|
|
631 | |
|
|
632 | Called whenever text is about to be pasted, with the text as argument. You |
|
|
633 | can filter/change and paste the text yourself by returning a true value |
|
|
634 | and calling C<< $term->tt_paste >> yourself. C<$octets> is |
|
|
635 | locale-encoded. |
|
|
636 | |
615 | =item on_line_update $term, $row |
637 | =item on_line_update $term, $row |
616 | |
638 | |
617 | Called whenever a line was updated or changed. Can be used to filter |
639 | Called whenever a line was updated or changed. Can be used to filter |
618 | screen output (e.g. underline urls or other useless stuff). Only lines |
640 | screen output (e.g. underline urls or other useless stuff). Only lines |
619 | that are being shown will be filtered, and, due to performance reasons, |
641 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
644 | resource in the @@RXVT_NAME@@(1) manpage). |
666 | resource in the @@RXVT_NAME@@(1) manpage). |
645 | |
667 | |
646 | The event is simply the action string. This interface is assumed to change |
668 | The event is simply the action string. This interface is assumed to change |
647 | slightly in the future. |
669 | slightly in the future. |
648 | |
670 | |
649 | =item on_resize_all_windows $tern, $new_width, $new_height |
671 | =item on_resize_all_windows $term, $new_width, $new_height |
650 | |
672 | |
651 | Called just after the new window size has been calculated, but before |
673 | Called just after the new window size has been calculated, but before |
652 | windows are actually being resized or hints are being set. If this hook |
674 | windows are actually being resized or hints are being set. If this hook |
653 | returns TRUE, setting of the window hints is being skipped. |
675 | returns TRUE, setting of the window hints is being skipped. |
654 | |
676 | |
… | |
… | |
688 | |
710 | |
689 | =item on_map_notify $term, $event |
711 | =item on_map_notify $term, $event |
690 | |
712 | |
691 | =item on_unmap_notify $term, $event |
713 | =item on_unmap_notify $term, $event |
692 | |
714 | |
693 | Called whenever the corresponding X event is received for the terminal If |
715 | Called whenever the corresponding X event is received for the terminal. If |
694 | the hook returns true, then the even will be ignored by rxvt-unicode. |
716 | the hook returns true, then the event will be ignored by rxvt-unicode. |
695 | |
717 | |
696 | The event is a hash with most values as named by Xlib (see the XEvent |
718 | The event is a hash with most values as named by Xlib (see the XEvent |
697 | manpage), with the additional members C<row> and C<col>, which are the |
719 | manpage), with the additional members C<row> and C<col>, which are the |
698 | (real, not screen-based) row and column under the mouse cursor. |
720 | (real, not screen-based) row and column under the mouse cursor. |
699 | |
721 | |
… | |
… | |
708 | |
730 | |
709 | =item on_wm_delete_window $term, $event |
731 | =item on_wm_delete_window $term, $event |
710 | |
732 | |
711 | Called when various types of ClientMessage events are received (all with |
733 | Called when various types of ClientMessage events are received (all with |
712 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
734 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
735 | |
|
|
736 | =item on_bell $term |
|
|
737 | |
|
|
738 | Called on receipt of a bell character. |
713 | |
739 | |
714 | =back |
740 | =back |
715 | |
741 | |
716 | =cut |
742 | =cut |
717 | |
743 | |
… | |
… | |
782 | |
808 | |
783 | =over 4 |
809 | =over 4 |
784 | |
810 | |
785 | =item urxvt::fatal $errormessage |
811 | =item urxvt::fatal $errormessage |
786 | |
812 | |
787 | Fatally aborts execution with the given error message. Avoid at all |
813 | Fatally aborts execution with the given error message (which should |
788 | costs! The only time this is acceptable is when the terminal process |
814 | include a trailing newline). Avoid at all costs! The only time this |
789 | starts up. |
815 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
816 | terminal from starting up. |
790 | |
817 | |
791 | =item urxvt::warn $string |
818 | =item urxvt::warn $string |
792 | |
819 | |
793 | Calls C<rxvt_warn> with the given string which should not include a |
820 | Calls C<rxvt_warn> with the given string which should include a trailing |
794 | newline. The module also overwrites the C<warn> builtin with a function |
821 | newline. The module also overwrites the C<warn> builtin with a function |
795 | that calls this function. |
822 | that calls this function. |
796 | |
823 | |
797 | Using this function has the advantage that its output ends up in the |
824 | Using this function has the advantage that its output ends up in the |
798 | correct place, e.g. on stderr of the connecting urxvtc client. |
825 | correct place, e.g. on stderr of the connecting urxvtc client. |
… | |
… | |
802 | =item @terms = urxvt::termlist |
829 | =item @terms = urxvt::termlist |
803 | |
830 | |
804 | Returns all urxvt::term objects that exist in this process, regardless of |
831 | Returns all urxvt::term objects that exist in this process, regardless of |
805 | whether they are started, being destroyed etc., so be careful. Only term |
832 | whether they are started, being destroyed etc., so be careful. Only term |
806 | objects that have perl extensions attached will be returned (because there |
833 | objects that have perl extensions attached will be returned (because there |
807 | is no urxvt::term objet associated with others). |
834 | is no urxvt::term object associated with others). |
808 | |
835 | |
809 | =item $time = urxvt::NOW |
836 | =item $time = urxvt::NOW |
810 | |
837 | |
811 | Returns the "current time" (as per the event loop). |
838 | Returns the "current time" (as per the event loop). |
812 | |
839 | |
… | |
… | |
855 | |
882 | |
856 | =item $rend = urxvt::OVERLAY_RSTYLE |
883 | =item $rend = urxvt::OVERLAY_RSTYLE |
857 | |
884 | |
858 | Return the rendition mask used for overlays by default. |
885 | Return the rendition mask used for overlays by default. |
859 | |
886 | |
860 | =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, |
|
|
888 | urxvt::RS_RVid, urxvt::RS_Uline |
861 | |
889 | |
862 | Return the bit that enabled bold, italic, blink, reverse-video and |
890 | Return the bit that enabled bold, italic, blink, reverse-video and |
863 | underline, respectively. To enable such a style, just logically OR it into |
891 | underline, respectively. To enable such a style, just logically OR it into |
864 | the bitset. |
892 | the bitset. |
865 | |
893 | |
… | |
… | |
1124 | is that you cannot use blocking APIs, but the non-blocking variant should |
1152 | is that you cannot use blocking APIs, but the non-blocking variant should |
1125 | work. |
1153 | work. |
1126 | |
1154 | |
1127 | =cut |
1155 | =cut |
1128 | |
1156 | |
1129 | our $VERSION = '3.4'; |
1157 | our $VERSION = '5.23'; |
1130 | |
1158 | |
1131 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1159 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1132 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1160 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1133 | |
1161 | |
1134 | sub timer { |
1162 | sub timer { |
… | |
… | |
1136 | |
1164 | |
1137 | my $cb = $arg{cb}; |
1165 | my $cb = $arg{cb}; |
1138 | |
1166 | |
1139 | urxvt::timer |
1167 | urxvt::timer |
1140 | ->new |
1168 | ->new |
1141 | ->after ($arg{after}) |
1169 | ->after ($arg{after}, $arg{interval}) |
1142 | ->interval ($arg{interval}) |
1170 | ->cb ($arg{interval} ? $cb : sub { |
1143 | ->start |
|
|
1144 | ->cb (sub { |
|
|
1145 | #TODO interval? |
|
|
1146 | $_[0]->stop; # need to cancel manually |
1171 | $_[0]->stop; # need to cancel manually |
1147 | $cb->(); |
1172 | $cb->(); |
1148 | }) |
1173 | }) |
1149 | } |
1174 | } |
1150 | |
1175 | |
… | |
… | |
1171 | my $cb = $arg{cb}; |
1196 | my $cb = $arg{cb}; |
1172 | |
1197 | |
1173 | urxvt::iw |
1198 | urxvt::iw |
1174 | ->new |
1199 | ->new |
1175 | ->start |
1200 | ->start |
1176 | ->cb (sub { |
1201 | ->cb ($cb) |
1177 | #TODO really cancel? |
|
|
1178 | $_[0]->stop; # need to cancel manually |
|
|
1179 | $cb->(); |
|
|
1180 | }) |
|
|
1181 | } |
1202 | } |
1182 | |
1203 | |
1183 | sub child { |
1204 | sub child { |
1184 | my ($class, %arg) = @_; |
1205 | my ($class, %arg) = @_; |
1185 | |
1206 | |
… | |
… | |
1187 | |
1208 | |
1188 | urxvt::pw |
1209 | urxvt::pw |
1189 | ->new |
1210 | ->new |
1190 | ->start ($arg{pid}) |
1211 | ->start ($arg{pid}) |
1191 | ->cb (sub { |
1212 | ->cb (sub { |
1192 | #TODO really cancel? |
|
|
1193 | $_[0]->stop; # need to cancel manually |
1213 | $_[0]->stop; # need to cancel manually |
1194 | $cb->($_[0]->rpid, $_[0]->rstatus); |
1214 | $cb->($_[0]->rpid, $_[0]->rstatus); |
1195 | }) |
1215 | }) |
1196 | } |
1216 | } |
1197 | |
1217 | |
1198 | sub DESTROY { |
1218 | sub DESTROY { |
1199 | $_[0][1]->stop; |
1219 | $_[0][1]->stop; |
1200 | } |
1220 | } |
1201 | |
1221 | |
|
|
1222 | # only needed for AnyEvent < 6 compatibility |
1202 | sub one_event { |
1223 | sub one_event { |
1203 | 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"; |
1204 | } |
1225 | } |
1205 | |
1226 | |
1206 | package urxvt::term; |
1227 | package urxvt::term; |
… | |
… | |
1298 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1319 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1299 | |
1320 | |
1300 | Here is a likely non-exhaustive list of option names, please see the |
1321 | Here is a likely non-exhaustive list of option names, please see the |
1301 | source file F</src/optinc.h> to see the actual list: |
1322 | source file F</src/optinc.h> to see the actual list: |
1302 | |
1323 | |
1303 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1324 | borderLess buffered console cursorBlink cursorUnderline hold iconic |
1304 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1325 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1305 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1326 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1306 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
1327 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1307 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
1328 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1308 | transparent tripleclickwords utmpInhibit visualBell |
1329 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
|
|
1330 | urgentOnBell utmpInhibit visualBell |
1309 | |
1331 | |
1310 | =item $value = $term->resource ($name[, $newval]) |
1332 | =item $value = $term->resource ($name[, $newval]) |
1311 | |
1333 | |
1312 | Returns the current resource value associated with a given name and |
1334 | Returns the current resource value associated with a given name and |
1313 | optionally sets a new value. Setting values is most useful in the C<init> |
1335 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
1326 | |
1348 | |
1327 | Here is a likely non-exhaustive list of resource names, not all of which |
1349 | Here is a likely non-exhaustive list of resource names, not all of which |
1328 | are supported in every build, please see the source file F</src/rsinc.h> |
1350 | are supported in every build, please see the source file F</src/rsinc.h> |
1329 | to see the actual list: |
1351 | to see the actual list: |
1330 | |
1352 | |
1331 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1353 | answerbackstring backgroundPixmap backspace_key blendtype blurradius |
1332 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1354 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1333 | display_name embed ext_bwidth fade font geometry hold iconName |
1355 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1334 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1356 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
1335 | italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 |
1357 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
|
|
1358 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1336 | modifier mouseWheelScrollPage name override_redirect pastableTabs path |
1359 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1337 | perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1360 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1338 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1361 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1339 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1362 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1340 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1363 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1341 | secondaryScreen secondaryScroll shade term_name title |
1364 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1342 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1365 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1343 | visualBell |
1366 | utmpInhibit visualBell |
1344 | |
1367 | |
1345 | =cut |
1368 | =cut |
1346 | |
1369 | |
1347 | sub resource($$;$) { |
1370 | sub resource($$;$) { |
1348 | my ($self, $name) = (shift, shift); |
1371 | my ($self, $name) = (shift, shift); |
… | |
… | |
1380 | |
1403 | |
1381 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1404 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1382 | |
1405 | |
1383 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1406 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1384 | |
1407 | |
1385 | Return the current values of the selection mark, begin or end positions, |
1408 | Return the current values of the selection mark, begin or end positions. |
1386 | and optionally set them to new values. |
1409 | |
|
|
1410 | When arguments are given, then the selection coordinates are set to |
|
|
1411 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1412 | screen. |
|
|
1413 | |
|
|
1414 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1415 | |
|
|
1416 | Returns the current selection screen, and then optionally sets it. |
1387 | |
1417 | |
1388 | =item $term->selection_make ($eventtime[, $rectangular]) |
1418 | =item $term->selection_make ($eventtime[, $rectangular]) |
1389 | |
1419 | |
1390 | Tries to make a selection as set by C<selection_beg> and |
1420 | Tries to make a selection as set by C<selection_beg> and |
1391 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1421 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1392 | rectangular selection will be made. This is the prefered function to make |
1422 | rectangular selection will be made. This is the preferred function to make |
1393 | a selection. |
1423 | a selection. |
1394 | |
1424 | |
1395 | =item $success = $term->selection_grab ($eventtime) |
1425 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
1396 | |
1426 | |
1397 | Try to request the primary selection text from the server (for example, as |
1427 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
|
|
1428 | true) selection from the server. The corresponding text can be set |
1398 | set by the next method). No visual feedback will be given. This function |
1429 | with the next method. No visual feedback will be given. This function |
1399 | is mostly useful from within C<on_sel_grab> hooks. |
1430 | is mostly useful from within C<on_sel_grab> hooks. |
1400 | |
1431 | |
1401 | =item $oldtext = $term->selection ([$newtext]) |
1432 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
1402 | |
1433 | |
1403 | Return the current selection text and optionally replace it by C<$newtext>. |
1434 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1435 | and optionally replace it by C<$newtext>. |
|
|
1436 | |
|
|
1437 | =item $term->selection_clear ([$clipboard]) |
|
|
1438 | |
|
|
1439 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
1404 | |
1440 | |
1405 | =item $term->overlay_simple ($x, $y, $text) |
1441 | =item $term->overlay_simple ($x, $y, $text) |
1406 | |
1442 | |
1407 | Create a simple multi-line overlay box. See the next method for details. |
1443 | Create a simple multi-line overlay box. See the next method for details. |
1408 | |
1444 | |
… | |
… | |
1536 | locale-specific encoding of the terminal and can contain command sequences |
1572 | locale-specific encoding of the terminal and can contain command sequences |
1537 | (escape codes) that will be interpreted. |
1573 | (escape codes) that will be interpreted. |
1538 | |
1574 | |
1539 | =item $term->tt_write ($octets) |
1575 | =item $term->tt_write ($octets) |
1540 | |
1576 | |
1541 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1577 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1542 | pass characters instead of octets, you should convert your strings first |
1578 | pass characters instead of octets, you should convert your strings first |
1543 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1579 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1580 | |
|
|
1581 | =item $term->tt_paste ($octets) |
|
|
1582 | |
|
|
1583 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1584 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1585 | is set. |
1544 | |
1586 | |
1545 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1587 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1546 | |
1588 | |
1547 | Replaces the event mask of the pty watcher by the given event mask. Can |
1589 | Replaces the event mask of the pty watcher by the given event mask. Can |
1548 | be used to suppress input and output handling to the pty/tty. See the |
1590 | be used to suppress input and output handling to the pty/tty. See the |
… | |
… | |
1862 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1904 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1863 | recent grab. |
1905 | recent grab. |
1864 | |
1906 | |
1865 | =item $term->ungrab |
1907 | =item $term->ungrab |
1866 | |
1908 | |
1867 | Calls XUngrab for the most recent grab. Is called automatically on |
1909 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
1868 | evaluation errors, as it is better to lose the grab in the error case as |
1910 | evaluation errors, as it is better to lose the grab in the error case as |
1869 | the session. |
1911 | the session. |
1870 | |
1912 | |
1871 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1913 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1872 | |
1914 | |
… | |
… | |
1894 | |
1936 | |
1895 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1937 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1896 | |
1938 | |
1897 | Various X or X-related functions. The C<$term> object only serves as |
1939 | Various X or X-related functions. The C<$term> object only serves as |
1898 | the source of the display, otherwise those functions map more-or-less |
1940 | the source of the display, otherwise those functions map more-or-less |
1899 | directory onto the X functions of the same name. |
1941 | directly onto the X functions of the same name. |
1900 | |
1942 | |
1901 | =back |
1943 | =back |
1902 | |
1944 | |
1903 | =cut |
1945 | =cut |
1904 | |
1946 | |
… | |
… | |
2061 | |
2103 | |
2062 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2104 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2063 | |
2105 | |
2064 | Set the callback to be called when the timer triggers. |
2106 | Set the callback to be called when the timer triggers. |
2065 | |
2107 | |
2066 | =item $tstamp = $timer->at |
|
|
2067 | |
|
|
2068 | Return the time this watcher will fire next. |
|
|
2069 | |
|
|
2070 | =item $timer = $timer->set ($tstamp) |
2108 | =item $timer = $timer->set ($tstamp[, $interval]) |
2071 | |
2109 | |
2072 | Set the time the event is generated to $tstamp. |
2110 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
2111 | new $interval). |
2073 | |
2112 | |
2074 | =item $timer = $timer->interval ($interval) |
2113 | =item $timer = $timer->interval ($interval) |
2075 | |
2114 | |
2076 | Normally (and when C<$interval> is C<0>), the timer will automatically |
2115 | By default (and when C<$interval> is C<0>), the timer will automatically |
2077 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2116 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2078 | is automatically rescheduled at the given intervals. |
2117 | is automatically rescheduled at the given intervals. |
2079 | |
2118 | |
2080 | =item $timer = $timer->start |
2119 | =item $timer = $timer->start |
2081 | |
2120 | |
2082 | Start the timer. |
2121 | Start the timer. |
2083 | |
2122 | |
2084 | =item $timer = $timer->start ($tstamp) |
2123 | =item $timer = $timer->start ($tstamp[, $interval]) |
2085 | |
2124 | |
2086 | Set the event trigger time to C<$tstamp> and start the timer. |
2125 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2126 | also replaces the interval. |
2087 | |
2127 | |
2088 | =item $timer = $timer->after ($delay) |
2128 | =item $timer = $timer->after ($delay[, $interval]) |
2089 | |
2129 | |
2090 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2130 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2091 | |
2131 | |
2092 | =item $timer = $timer->stop |
2132 | =item $timer = $timer->stop |
2093 | |
2133 | |
… | |
… | |
2224 | |
2264 | |
2225 | =back |
2265 | =back |
2226 | |
2266 | |
2227 | =head1 AUTHOR |
2267 | =head1 AUTHOR |
2228 | |
2268 | |
2229 | Marc Lehmann <pcg@goof.com> |
2269 | Marc Lehmann <schmorp@schmorp.de> |
2230 | http://software.schmorp.de/pkg/rxvt-unicode |
2270 | http://software.schmorp.de/pkg/rxvt-unicode |
2231 | |
2271 | |
2232 | =cut |
2272 | =cut |
2233 | |
2273 | |
2234 | 1 |
2274 | 1 |