… | |
… | |
40 | =over 4 |
40 | =over 4 |
41 | |
41 | |
42 | =item selection (enabled by default) |
42 | =item selection (enabled by default) |
43 | |
43 | |
44 | (More) intelligent selection. This extension tries to be more intelligent |
44 | (More) intelligent selection. This extension tries to be more intelligent |
45 | when the user extends selections (double-click). Right now, it tries to |
45 | when the user extends selections (double-click and further clicks). Right |
46 | select urls and complete shell-quoted arguments, which is very convenient, |
46 | now, it tries to select words, urls and complete shell-quoted |
47 | too, if your F<ls> supports C<--quoting-style=shell>. |
47 | arguments, which is very convenient, too, if your F<ls> supports |
|
|
48 | C<--quoting-style=shell>. |
48 | |
49 | |
|
|
50 | A double-click usually selects the word under the cursor, further clicks |
|
|
51 | will enlarge the selection. |
|
|
52 | |
|
|
53 | The selection works by trying to match a number of regexes and displaying |
|
|
54 | them in increasing order of length. You can add your own regexes by |
|
|
55 | specifying resources of the form: |
|
|
56 | |
|
|
57 | URxvt.selection.pattern-0: perl-regex |
|
|
58 | URxvt.selection.pattern-1: perl-regex |
|
|
59 | ... |
|
|
60 | |
|
|
61 | The index number (0, 1...) must not have any holes, and each regex must |
|
|
62 | contain at least one pair of capturing parentheses, which will be used for |
|
|
63 | the match. For example, the followign adds a regex that matches everything |
|
|
64 | between two vertical bars: |
|
|
65 | |
|
|
66 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
67 | |
|
|
68 | You can look at the source of the selection extension to see more |
|
|
69 | interesting uses, such as parsing a line from beginning to end. |
|
|
70 | |
49 | It also offers the following bindable keyboard command: |
71 | This extension also offers following bindable keyboard commands: |
50 | |
72 | |
51 | =over 4 |
73 | =over 4 |
52 | |
74 | |
53 | =item rot13 |
75 | =item rot13 |
54 | |
76 | |
55 | Rot-13 the selection when activated. Used via keyboard trigger: |
77 | Rot-13 the selection when activated. Used via keyboard trigger: |
56 | |
78 | |
57 | URxvt.keysym.C-M-r: perl:selection:rot13 |
79 | URxvt.keysym.C-M-r: perl:selection:rot13 |
|
|
80 | |
|
|
81 | =item remote-pastebin |
|
|
82 | |
|
|
83 | Upload the selection as textfile to a remote site. |
|
|
84 | |
|
|
85 | URxvt.keysym.C-M-e: perl:selection:remote-pastebin |
|
|
86 | |
|
|
87 | To set the command to upload the file set this resource: |
|
|
88 | |
|
|
89 | URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
90 | |
|
|
91 | The % is the placeholder for the textfile. The name of the textfile is the hex encoded |
|
|
92 | md5 sum of the selection. |
|
|
93 | After an successful upload the selection will be replaced by the following url |
|
|
94 | (the % is the placeholder for the filename): |
|
|
95 | |
|
|
96 | URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/% |
58 | |
97 | |
59 | =back |
98 | =back |
60 | |
99 | |
61 | =item option-popup (enabled by default) |
100 | =item option-popup (enabled by default) |
62 | |
101 | |
… | |
… | |
70 | evalution, web-browser starting etc.), depending on content. |
109 | evalution, web-browser starting etc.), depending on content. |
71 | |
110 | |
72 | =item searchable-scrollback<hotkey> (enabled by default) |
111 | =item searchable-scrollback<hotkey> (enabled by default) |
73 | |
112 | |
74 | Adds regex search functionality to the scrollback buffer, triggered |
113 | Adds regex search functionality to the scrollback buffer, triggered |
75 | by a hotkey (default: C<M-s>). When in search mode, normal terminal |
114 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
76 | input/output is suspended. |
115 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
116 | screen. |
77 | |
117 | |
78 | C</> starts an incremental regex search, C<n> searches further, C<p> or |
118 | Inputting characters appends them to the regex and continues incremental |
79 | C<N> jump to the previous match, C<G> jumps to the bottom and clears the |
119 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
80 | history, C<enter> leaves search mode at the current position and C<escape> |
120 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
81 | returns to the original position. |
121 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
122 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
123 | additionally stores the first match in the current line into the primary |
|
|
124 | selection. |
82 | |
125 | |
83 | =item digital-clock |
126 | =item selection-autotransform |
84 | |
127 | |
85 | Displays a digital clock using the built-in overlay. |
128 | This selection allows you to do automatic transforms on a selection |
|
|
129 | whenever a selection is made. |
|
|
130 | |
|
|
131 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
132 | operator) that modify C<$_> as resources: |
|
|
133 | |
|
|
134 | URxvt.selection-autotransform.0: transform |
|
|
135 | URxvt.selection-autotransform.1: transform |
|
|
136 | ... |
|
|
137 | |
|
|
138 | For example, the following will transform selections of the form |
|
|
139 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
140 | $word>: |
|
|
141 | |
|
|
142 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
143 | |
|
|
144 | And this example matches the same,but replaces it with vi-commands you can |
|
|
145 | paste directly into your (vi :) editor: |
|
|
146 | |
|
|
147 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
148 | |
|
|
149 | Of course, this can be modified to suit your needs and your editor :) |
|
|
150 | |
|
|
151 | To expand the example above to typical perl error messages ("XXX at |
|
|
152 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
153 | |
|
|
154 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
|
|
155 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
156 | |
|
|
157 | The first line tells the selection code to treat the unchanging part of |
|
|
158 | every error message as a selection pattern, and the second line transforms |
|
|
159 | the message into vi commands to load the file. |
86 | |
160 | |
87 | =item mark-urls |
161 | =item mark-urls |
88 | |
162 | |
89 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
163 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
|
|
164 | make them clickable. When middle-clicked, the program specified in the |
|
|
165 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
|
|
166 | the URL as first argument. |
90 | |
167 | |
91 | =item block-graphics-to-ascii |
168 | =item block-graphics-to-ascii |
92 | |
169 | |
93 | A not very useful example of filtering all text output to the terminal, |
170 | A not very useful example of filtering all text output to the terminal, |
94 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
171 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
95 | similar-looking ascii character. |
172 | similar-looking ascii character. |
|
|
173 | |
|
|
174 | =item digital-clock |
|
|
175 | |
|
|
176 | Displays a digital clock using the built-in overlay. |
96 | |
177 | |
97 | =item example-refresh-hooks |
178 | =item example-refresh-hooks |
98 | |
179 | |
99 | Displays a very simple digital clock in the upper right corner of the |
180 | Displays a very simple digital clock in the upper right corner of the |
100 | window. Illustrates overwriting the refresh callbacks to create your own |
181 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
123 | =over 4 |
204 | =over 4 |
124 | |
205 | |
125 | =item $text |
206 | =item $text |
126 | |
207 | |
127 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
208 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
128 | always represents one screen cell. See L<row_t> for a discussion of this format. |
209 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
129 | |
210 | |
130 | =item $string |
211 | =item $string |
131 | |
212 | |
132 | A perl text string, with an emphasis on I<text>. It can store all unicode |
213 | A perl text string, with an emphasis on I<text>. It can store all unicode |
133 | characters and is to be distinguished with text encoded in a specific |
214 | characters and is to be distinguished with text encoded in a specific |
… | |
… | |
228 | =item on_sel_extend $term |
309 | =item on_sel_extend $term |
229 | |
310 | |
230 | Called whenever the user tries to extend the selection (e.g. with a double |
311 | Called whenever the user tries to extend the selection (e.g. with a double |
231 | click) and is either supposed to return false (normal operation), or |
312 | click) and is either supposed to return false (normal operation), or |
232 | should extend the selection itelf and return true to suppress the built-in |
313 | should extend the selection itelf and return true to suppress the built-in |
233 | processing. |
314 | processing. This can happen multiple times, as long as the callback |
|
|
315 | returns true, it will be called on every further click by the user and is |
|
|
316 | supposed to enlarge the selection more and more, if possible. |
234 | |
317 | |
235 | See the F<selection> example extension. |
318 | See the F<selection> example extension. |
236 | |
319 | |
237 | =item on_view_change $term, $offset |
320 | =item on_view_change $term, $offset |
238 | |
321 | |
… | |
… | |
305 | |
388 | |
306 | Called whenever the user presses a key combination that has a |
389 | Called whenever the user presses a key combination that has a |
307 | C<perl:string> action bound to it (see description of the B<keysym> |
390 | C<perl:string> action bound to it (see description of the B<keysym> |
308 | resource in the @@RXVT_NAME@@(1) manpage). |
391 | resource in the @@RXVT_NAME@@(1) manpage). |
309 | |
392 | |
|
|
393 | =item on_x_event $term, $event |
|
|
394 | |
|
|
395 | Called on every X event received on the vt window (and possibly other |
|
|
396 | windows). Should only be used as a last resort. Most event structure |
|
|
397 | members are not passed. |
|
|
398 | |
310 | =item on_focus_in $term |
399 | =item on_focus_in $term |
311 | |
400 | |
312 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
401 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
313 | does focus in processing. |
402 | does focus in processing. |
314 | |
403 | |
… | |
… | |
386 | =item $urxvt::TERM |
475 | =item $urxvt::TERM |
387 | |
476 | |
388 | The current terminal. This variable stores the current C<urxvt::term> |
477 | The current terminal. This variable stores the current C<urxvt::term> |
389 | object, whenever a callback/hook is executing. |
478 | object, whenever a callback/hook is executing. |
390 | |
479 | |
391 | =item |
|
|
392 | |
|
|
393 | =back |
480 | =back |
394 | |
481 | |
395 | =head2 Functions in the C<urxvt> Package |
482 | =head2 Functions in the C<urxvt> Package |
396 | |
483 | |
397 | =over 4 |
484 | =over 4 |
… | |
… | |
426 | =item urxvt::CurrentTime |
513 | =item urxvt::CurrentTime |
427 | |
514 | |
428 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
515 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
429 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
516 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
430 | Button4Mask, Button5Mask, AnyModifier |
517 | Button4Mask, Button5Mask, AnyModifier |
|
|
518 | |
|
|
519 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
520 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
521 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
522 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
523 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
524 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
525 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
526 | |
|
|
527 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
528 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
529 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
530 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
531 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
532 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
533 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
431 | |
534 | |
432 | Various constants for use in X calls and event processing. |
535 | Various constants for use in X calls and event processing. |
433 | |
536 | |
434 | =back |
537 | =back |
435 | |
538 | |
… | |
… | |
496 | $msg .= "\n" |
599 | $msg .= "\n" |
497 | unless $msg =~ /\n$/; |
600 | unless $msg =~ /\n$/; |
498 | urxvt::warn ($msg); |
601 | urxvt::warn ($msg); |
499 | }; |
602 | }; |
500 | |
603 | |
|
|
604 | # %ENV is the original startup environment |
501 | delete $ENV{IFS}; |
605 | delete $ENV{IFS}; |
502 | delete $ENV{CDPATH}; |
606 | delete $ENV{CDPATH}; |
503 | delete $ENV{BASH_ENV}; |
607 | delete $ENV{BASH_ENV}; |
504 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
608 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
505 | } |
609 | } |
506 | |
610 | |
507 | my @hook_count; |
|
|
508 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
611 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
509 | |
612 | |
510 | sub verbose { |
613 | sub verbose { |
511 | my ($level, $msg) = @_; |
614 | my ($level, $msg) = @_; |
512 | warn "$msg\n" if $level <= $verbosity; |
615 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
594 | if ($@) { |
697 | if ($@) { |
595 | $TERM->ungrab; # better to lose the grab than the session |
698 | $TERM->ungrab; # better to lose the grab than the session |
596 | warn $@; |
699 | warn $@; |
597 | } |
700 | } |
598 | } |
701 | } |
|
|
702 | |
|
|
703 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
|
|
704 | if $verbosity >= 11; |
599 | } |
705 | } |
600 | |
706 | |
601 | if ($htype == 1) { # DESTROY |
707 | if ($htype == 1) { # DESTROY |
602 | if (my $hook = delete $TERM->{_hook}) { |
|
|
603 | for my $htype (0..$#$hook) { |
|
|
604 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
605 | or set_should_invoke $htype, 0; |
|
|
606 | } |
|
|
607 | } |
|
|
608 | |
|
|
609 | # clear package objects |
708 | # clear package objects |
610 | %$_ = () for values %{ $TERM->{_pkg} }; |
709 | %$_ = () for values %{ $TERM->{_pkg} }; |
611 | |
710 | |
612 | # clear package |
711 | # clear package |
613 | %$TERM = (); |
712 | %$TERM = (); |
614 | } |
713 | } |
615 | |
714 | |
616 | $retval |
715 | $retval |
|
|
716 | } |
|
|
717 | |
|
|
718 | sub exec_async(@) { |
|
|
719 | my $pid = fork; |
|
|
720 | |
|
|
721 | return |
|
|
722 | if !defined $pid or $pid; |
|
|
723 | |
|
|
724 | %ENV = %{ $TERM->env }; |
|
|
725 | |
|
|
726 | exec @_; |
|
|
727 | _exit 255; |
617 | } |
728 | } |
618 | |
729 | |
619 | # urxvt::term::extension |
730 | # urxvt::term::extension |
620 | |
731 | |
621 | package urxvt::term::extension; |
732 | package urxvt::term::extension; |
… | |
… | |
627 | while (my ($name, $cb) = each %hook) { |
738 | while (my ($name, $cb) = each %hook) { |
628 | my $htype = $HOOKTYPE{uc $name}; |
739 | my $htype = $HOOKTYPE{uc $name}; |
629 | defined $htype |
740 | defined $htype |
630 | or Carp::croak "unsupported hook type '$name'"; |
741 | or Carp::croak "unsupported hook type '$name'"; |
631 | |
742 | |
|
|
743 | $self->set_should_invoke ($htype, +1) |
632 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
744 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
633 | $hook_count[$htype]++ |
|
|
634 | or urxvt::set_should_invoke $htype, 1; |
|
|
635 | } |
|
|
636 | |
745 | |
637 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
746 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
638 | } |
747 | } |
639 | } |
748 | } |
640 | |
749 | |
… | |
… | |
645 | for my $name (@hook) { |
754 | for my $name (@hook) { |
646 | my $htype = $HOOKTYPE{uc $name}; |
755 | my $htype = $HOOKTYPE{uc $name}; |
647 | defined $htype |
756 | defined $htype |
648 | or Carp::croak "unsupported hook type '$name'"; |
757 | or Carp::croak "unsupported hook type '$name'"; |
649 | |
758 | |
|
|
759 | $self->set_should_invoke ($htype, -1) |
650 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
760 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
651 | --$hook_count[$htype] |
|
|
652 | or urxvt::set_should_invoke $htype, 0; |
|
|
653 | } |
|
|
654 | } |
761 | } |
655 | } |
762 | } |
656 | |
763 | |
657 | our $AUTOLOAD; |
764 | our $AUTOLOAD; |
658 | |
765 | |
… | |
… | |
782 | } |
889 | } |
783 | |
890 | |
784 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
891 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
785 | |
892 | |
786 | Creates a new terminal, very similar as if you had started it with system |
893 | Creates a new terminal, very similar as if you had started it with system |
787 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a %ENV>-like |
894 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
788 | C<hash which defines the environment of the new terminal. |
895 | hash which defines the environment of the new terminal. |
789 | |
896 | |
790 | Croaks (and probably outputs an error message) if the new instance |
897 | Croaks (and probably outputs an error message) if the new instance |
791 | couldn't be created. Returns C<undef> if the new instance didn't |
898 | couldn't be created. Returns C<undef> if the new instance didn't |
792 | initialise perl, and the terminal object otherwise. The C<init> and |
899 | initialise perl, and the terminal object otherwise. The C<init> and |
793 | C<start> hooks will be called during this call. |
900 | C<start> hooks will be called during this call. |
… | |
… | |
862 | my ($self, $name) = (shift, shift); |
969 | my ($self, $name) = (shift, shift); |
863 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
970 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
864 | &urxvt::term::_resource |
971 | &urxvt::term::_resource |
865 | } |
972 | } |
866 | |
973 | |
|
|
974 | =item $value = $term->x_resource ($pattern) |
|
|
975 | |
|
|
976 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
977 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
|
|
978 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
|
|
979 | resource with that pattern exists. |
|
|
980 | |
|
|
981 | This method should only be called during the C<on_start> hook, as there is |
|
|
982 | only one resource database per display, and later invocations might return |
|
|
983 | the wrong resources. |
|
|
984 | |
867 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
985 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
868 | |
986 | |
869 | Adds a keymap translation exactly as specified via a resource. See the |
987 | Adds a keymap translation exactly as specified via a resource. See the |
870 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
988 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
871 | |
989 | |
… | |
… | |
886 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1004 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
887 | |
1005 | |
888 | Return the current values of the selection mark, begin or end positions, |
1006 | Return the current values of the selection mark, begin or end positions, |
889 | and optionally set them to new values. |
1007 | and optionally set them to new values. |
890 | |
1008 | |
|
|
1009 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
1010 | |
|
|
1011 | Tries to make a selection as set by C<selection_beg> and |
|
|
1012 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
1013 | rectangular selection will be made. This is the prefered function to make |
|
|
1014 | a selection. |
|
|
1015 | |
891 | =item $success = $term->selection_grab ($eventtime) |
1016 | =item $success = $term->selection_grab ($eventtime) |
892 | |
1017 | |
893 | Try to request the primary selection from the server (for example, as set |
1018 | Try to request the primary selection text from the server (for example, as |
894 | by the next method). |
1019 | set by the next method). No visual feedback will be given. This function |
|
|
1020 | is mostly useful from within C<on_sel_grab> hooks. |
895 | |
1021 | |
896 | =item $oldtext = $term->selection ([$newtext]) |
1022 | =item $oldtext = $term->selection ([$newtext]) |
897 | |
1023 | |
898 | Return the current selection text and optionally replace it by C<$newtext>. |
1024 | Return the current selection text and optionally replace it by C<$newtext>. |
899 | |
1025 | |
… | |
… | |
992 | Convert the given locale-encoded octets into a perl string. |
1118 | Convert the given locale-encoded octets into a perl string. |
993 | |
1119 | |
994 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1120 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
995 | |
1121 | |
996 | XORs the rendition values in the given span with the provided value |
1122 | XORs the rendition values in the given span with the provided value |
997 | (default: C<RS_RVid>). Useful in refresh hooks to provide effects similar |
1123 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
998 | to the selection. |
1124 | refresh hooks to provide effects similar to the selection. |
999 | |
1125 | |
1000 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1126 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1001 | |
1127 | |
1002 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1128 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1003 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1129 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1004 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1130 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1005 | it instead. |
1131 | it instead. Both styles I<MUST NOT> contain font styles. |
1006 | |
1132 | |
1007 | =item $term->scr_bell |
1133 | =item $term->scr_bell |
1008 | |
1134 | |
1009 | Ring the bell! |
1135 | Ring the bell! |
1010 | |
1136 | |
… | |
… | |
1044 | |
1170 | |
1045 | =item $windowid = $term->vt |
1171 | =item $windowid = $term->vt |
1046 | |
1172 | |
1047 | Return the window id of the terminal window. |
1173 | Return the window id of the terminal window. |
1048 | |
1174 | |
|
|
1175 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1176 | |
|
|
1177 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1178 | to receive pointer events all the times: |
|
|
1179 | |
|
|
1180 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1181 | |
1049 | =item $window_width = $term->width |
1182 | =item $window_width = $term->width |
1050 | |
1183 | |
1051 | =item $window_height = $term->height |
1184 | =item $window_height = $term->height |
1052 | |
1185 | |
1053 | =item $font_width = $term->fwidth |
1186 | =item $font_width = $term->fwidth |
… | |
… | |
1066 | |
1199 | |
1067 | =item $max_scrollback = $term->saveLines |
1200 | =item $max_scrollback = $term->saveLines |
1068 | |
1201 | |
1069 | =item $nrow_plus_saveLines = $term->total_rows |
1202 | =item $nrow_plus_saveLines = $term->total_rows |
1070 | |
1203 | |
1071 | =item $lines_in_scrollback = $term->nsaved |
1204 | =item $topmost_scrollback_row = $term->top_row |
1072 | |
1205 | |
1073 | Return various integers describing terminal characteristics. |
1206 | Return various integers describing terminal characteristics. |
1074 | |
1207 | |
1075 | =item $x_display = $term->display_id |
1208 | =item $x_display = $term->display_id |
1076 | |
1209 | |
… | |
… | |
1104 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1237 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1105 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1238 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1106 | |
1239 | |
1107 | =item $view_start = $term->view_start ([$newvalue]) |
1240 | =item $view_start = $term->view_start ([$newvalue]) |
1108 | |
1241 | |
1109 | Returns the negative row number of the topmost line. Minimum value is |
1242 | Returns the row number of the topmost displayed line. Maximum value is |
1110 | C<0>, which displays the normal terminal contents. Larger values scroll |
1243 | C<0>, which displays the normal terminal contents. Lower values scroll |
1111 | this many lines into the scrollback buffer. |
1244 | this many lines into the scrollback buffer. |
1112 | |
1245 | |
1113 | =item $term->want_refresh |
1246 | =item $term->want_refresh |
1114 | |
1247 | |
1115 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1248 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
1194 | Return the row number of the first/last row of the line, respectively. |
1327 | Return the row number of the first/last row of the line, respectively. |
1195 | |
1328 | |
1196 | =item $offset = $line->offset_of ($row, $col) |
1329 | =item $offset = $line->offset_of ($row, $col) |
1197 | |
1330 | |
1198 | Returns the character offset of the given row|col pair within the logical |
1331 | Returns the character offset of the given row|col pair within the logical |
1199 | line. |
1332 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1333 | offsets outside the string. |
1200 | |
1334 | |
1201 | =item ($row, $col) = $line->coord_of ($offset) |
1335 | =item ($row, $col) = $line->coord_of ($offset) |
1202 | |
1336 | |
1203 | Translates a string offset into terminal coordinates again. |
1337 | Translates a string offset into terminal coordinates again. |
1204 | |
1338 | |
… | |
… | |
1441 | my ($self) = @_; |
1575 | my ($self) = @_; |
1442 | |
1576 | |
1443 | delete $self->{term}{_destroy}{$self}; |
1577 | delete $self->{term}{_destroy}{$self}; |
1444 | $self->{term}->ungrab; |
1578 | $self->{term}->ungrab; |
1445 | } |
1579 | } |
|
|
1580 | |
|
|
1581 | =back |
1446 | |
1582 | |
1447 | =head2 The C<urxvt::timer> Class |
1583 | =head2 The C<urxvt::timer> Class |
1448 | |
1584 | |
1449 | This class implements timer watchers/events. Time is represented as a |
1585 | This class implements timer watchers/events. Time is represented as a |
1450 | fractional number of seconds since the epoch. Example: |
1586 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1557 | |
1693 | |
1558 | =item == 0 - fatal messages |
1694 | =item == 0 - fatal messages |
1559 | |
1695 | |
1560 | =item >= 3 - script loading and management |
1696 | =item >= 3 - script loading and management |
1561 | |
1697 | |
1562 | =item >=10 - all events received |
1698 | =item >=10 - all called hooks |
|
|
1699 | |
|
|
1700 | =item >=11 - hook reutrn values |
1563 | |
1701 | |
1564 | =back |
1702 | =back |
1565 | |
1703 | |
1566 | =head1 AUTHOR |
1704 | =head1 AUTHOR |
1567 | |
1705 | |