… | |
… | |
62 | |
62 | |
63 | Displays a digital clock using the built-in overlay. |
63 | Displays a digital clock using the built-in overlay. |
64 | |
64 | |
65 | =item mark-urls |
65 | =item mark-urls |
66 | |
66 | |
67 | Uses per-line filtering (C<on_line_update>) to underline urls. |
67 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
|
|
68 | |
|
|
69 | =item block-graphics-to-ascii |
|
|
70 | |
|
|
71 | A not very useful example of filtering all text output to the terminal, |
|
|
72 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
73 | similar-looking ascii character. |
68 | |
74 | |
69 | =item example-refresh-hooks |
75 | =item example-refresh-hooks |
70 | |
76 | |
71 | Displays a very simple digital clock in the upper right corner of the |
77 | Displays a very simple digital clock in the upper right corner of the |
72 | window. Illustrates overwriting the refresh callbacks to create your own |
78 | window. Illustrates overwriting the refresh callbacks to create your own |
73 | overlays or changes. |
79 | overlays or changes. |
74 | |
|
|
75 | =item example-filter-input |
|
|
76 | |
|
|
77 | A not very useful example of filtering all text output to the terminal, by |
|
|
78 | underlining all urls that matches a certain regex (i.e. some urls :). It |
|
|
79 | is not very useful because urls that are output in multiple steps (e.g. |
|
|
80 | when typing them) do not get marked. |
|
|
81 | |
80 | |
82 | =back |
81 | =back |
83 | |
82 | |
84 | =head2 General API Considerations |
83 | =head2 General API Considerations |
85 | |
84 | |
… | |
… | |
117 | |
116 | |
118 | =back |
117 | =back |
119 | |
118 | |
120 | =head2 Hooks |
119 | =head2 Hooks |
121 | |
120 | |
122 | The following subroutines can be declared in loaded scripts, and will be |
121 | The following subroutines can be declared in extension files, and will be |
123 | called whenever the relevant event happens. |
122 | called whenever the relevant event happens. |
124 | |
123 | |
125 | The first argument passed to them is an object private to each terminal |
124 | The first argument passed to them is an object private to each terminal |
126 | and extension package. You can call all C<urxvt::term> methods on it, but |
125 | and extension package. You can call all C<urxvt::term> methods on it, but |
127 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
126 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
… | |
… | |
137 | =over 4 |
136 | =over 4 |
138 | |
137 | |
139 | =item on_init $term |
138 | =item on_init $term |
140 | |
139 | |
141 | Called after a new terminal object has been initialized, but before |
140 | Called after a new terminal object has been initialized, but before |
142 | windows are created or the command gets run. |
141 | windows are created or the command gets run. Most methods are unsafe to |
|
|
142 | call or deliver senseless data, as terminal size and other characteristics |
|
|
143 | have not yet been determined. You can safely query and change resources, |
|
|
144 | though. |
143 | |
145 | |
144 | =item on_reset $term |
146 | =item on_reset $term |
145 | |
147 | |
146 | Called after the screen is "reset" for any reason, such as resizing or |
148 | Called after the screen is "reset" for any reason, such as resizing or |
147 | control sequences. Here is where you can react on changes to size-related |
149 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
258 | |
260 | |
259 | Called whenever the user presses a key combination that has a |
261 | Called whenever the user presses a key combination that has a |
260 | C<perl:string> action bound to it (see description of the B<keysym> |
262 | C<perl:string> action bound to it (see description of the B<keysym> |
261 | resource in the @@RXVT_NAME@@(1) manpage). |
263 | resource in the @@RXVT_NAME@@(1) manpage). |
262 | |
264 | |
|
|
265 | =item on_key_press $term, $event, $octets |
|
|
266 | |
|
|
267 | =item on_key_release $term, $event |
|
|
268 | |
|
|
269 | =item on_button_press $term, $event |
|
|
270 | |
|
|
271 | =item on_button_release $term, $event |
|
|
272 | |
|
|
273 | =item on_motion_notify $term, $event |
|
|
274 | |
|
|
275 | Called whenever the corresponding X event is received for the terminal If |
|
|
276 | the hook returns true, then the even will be ignored by rxvt-unicode. |
|
|
277 | |
|
|
278 | The event is a hash with most values as named by Xlib (see the XEvent |
|
|
279 | manpage), with the additional members C<row> and C<col>, which are the row |
|
|
280 | and column under the mouse cursor. |
|
|
281 | |
|
|
282 | C<on_key_press> additionally receives the string rxvt-unicode would |
|
|
283 | output, if any, in locale-specific encoding. |
|
|
284 | |
|
|
285 | subwindow. |
|
|
286 | |
263 | =back |
287 | =back |
264 | |
288 | |
265 | =head2 Variables in the C<urxvt> Package |
289 | =head2 Variables in the C<urxvt> Package |
266 | |
290 | |
267 | =over 4 |
291 | =over 4 |
268 | |
292 | |
269 | =item $urxvt::TERM |
293 | =item $urxvt::TERM |
270 | |
294 | |
271 | The current terminal. Whenever a callback/Hook is bein executed, this |
295 | The current terminal. This variable stores the current C<urxvt::term> |
272 | variable stores the current C<urxvt::term> object. |
296 | object, whenever a callback/hook is executing. |
273 | |
297 | |
274 | =back |
298 | =back |
275 | |
299 | |
276 | =head2 Functions in the C<urxvt> Package |
300 | =head2 Functions in the C<urxvt> Package |
277 | |
301 | |
278 | =over 4 |
302 | =over 4 |
|
|
303 | |
|
|
304 | =item $term = new urxvt [arg...] |
|
|
305 | |
|
|
306 | Creates a new terminal, very similar as if you had started it with |
|
|
307 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
308 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
309 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
310 | C<init> and C<start> hooks will be called during the call. |
279 | |
311 | |
280 | =item urxvt::fatal $errormessage |
312 | =item urxvt::fatal $errormessage |
281 | |
313 | |
282 | Fatally aborts execution with the given error message. Avoid at all |
314 | Fatally aborts execution with the given error message. Avoid at all |
283 | costs! The only time this is acceptable is when the terminal process |
315 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
432 | my $htype = shift; |
464 | my $htype = shift; |
433 | |
465 | |
434 | if ($htype == 0) { # INIT |
466 | if ($htype == 0) { # INIT |
435 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
467 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
436 | |
468 | |
437 | for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
469 | for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
438 | my @files = grep -f $_, map "$_/$ext", @dirs; |
470 | my @files = grep -f $_, map "$_/$ext", @dirs; |
439 | |
471 | |
440 | if (@files) { |
472 | if (@files) { |
441 | register_package script_package $files[0]; |
473 | register_package script_package $files[0]; |
442 | } else { |
474 | } else { |
… | |
… | |
500 | } |
532 | } |
501 | |
533 | |
502 | =head2 The C<urxvt::term> Class |
534 | =head2 The C<urxvt::term> Class |
503 | |
535 | |
504 | =over 4 |
536 | =over 4 |
|
|
537 | |
|
|
538 | =item $term->destroy |
|
|
539 | |
|
|
540 | Destroy the terminal object (close the window, free resources etc.). |
505 | |
541 | |
506 | =item $value = $term->resource ($name[, $newval]) |
542 | =item $value = $term->resource ($name[, $newval]) |
507 | |
543 | |
508 | Returns the current resource value associated with a given name and |
544 | Returns the current resource value associated with a given name and |
509 | optionally sets a new value. Setting values is most useful in the C<init> |
545 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
626 | |
662 | |
627 | If hidden, display the overlay again. |
663 | If hidden, display the overlay again. |
628 | |
664 | |
629 | =back |
665 | =back |
630 | |
666 | |
631 | =item $cellwidth = $term->strwidth $string |
667 | =item $cellwidth = $term->strwidth ($string) |
632 | |
668 | |
633 | Returns the number of screen-cells this string would need. Correctly |
669 | Returns the number of screen-cells this string would need. Correctly |
634 | accounts for wide and combining characters. |
670 | accounts for wide and combining characters. |
635 | |
671 | |
636 | =item $octets = $term->locale_encode $string |
672 | =item $octets = $term->locale_encode ($string) |
637 | |
673 | |
638 | Convert the given text string into the corresponding locale encoding. |
674 | Convert the given text string into the corresponding locale encoding. |
639 | |
675 | |
640 | =item $string = $term->locale_decode $octets |
676 | =item $string = $term->locale_decode ($octets) |
641 | |
677 | |
642 | Convert the given locale-encoded octets into a perl string. |
678 | Convert the given locale-encoded octets into a perl string. |
643 | |
679 | |
644 | =item $term->scr_add_lines ($string) |
680 | =item $term->scr_add_lines ($string) |
645 | |
681 | |
… | |
… | |
650 | |
686 | |
651 | Normally its not a good idea to use this function, as programs might be |
687 | Normally its not a good idea to use this function, as programs might be |
652 | confused by changes in cursor position or scrolling. Its useful inside a |
688 | confused by changes in cursor position or scrolling. Its useful inside a |
653 | C<on_add_lines> hook, though. |
689 | C<on_add_lines> hook, though. |
654 | |
690 | |
|
|
691 | =item $term->cmd_parse ($octets) |
|
|
692 | |
|
|
693 | Similar to C<scr_add_lines>, but the argument must be in the |
|
|
694 | locale-specific encoding of the terminal and can contain command sequences |
|
|
695 | (escape codes) that will be interpreted. |
|
|
696 | |
655 | =item $term->tt_write ($octets) |
697 | =item $term->tt_write ($octets) |
656 | |
698 | |
657 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
699 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
658 | pass characters instead of octets, you should convert your strings first |
700 | pass characters instead of octets, you should convert your strings first |
659 | to the locale-specific encoding using C<< $term->locale_encode >>. |
701 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
702 | |
|
|
703 | =item $windowid = $term->parent |
|
|
704 | |
|
|
705 | Return the window id of the toplevel window. |
|
|
706 | |
|
|
707 | =item $windowid = $term->vt |
|
|
708 | |
|
|
709 | Return the window id of the terminal window. |
660 | |
710 | |
661 | =item $window_width = $term->width |
711 | =item $window_width = $term->width |
662 | |
712 | |
663 | =item $window_height = $term->height |
713 | =item $window_height = $term->height |
664 | |
714 | |