… | |
… | |
66 | contain at least one pair of capturing parentheses, which will be used for |
66 | contain at least one pair of capturing parentheses, which will be used for |
67 | the match. For example, the followign adds a regex that matches everything |
67 | the match. For example, the followign adds a regex that matches everything |
68 | between two vertical bars: |
68 | between two vertical bars: |
69 | |
69 | |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
71 | |
|
|
72 | Another example: Programs I use often output "absolute path: " at the |
|
|
73 | beginning of a line when they process multiple files. The following |
|
|
74 | pattern matches the filename (note, there is a single space at the very |
|
|
75 | end): |
|
|
76 | |
|
|
77 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
71 | |
78 | |
72 | You can look at the source of the selection extension to see more |
79 | You can look at the source of the selection extension to see more |
73 | interesting uses, such as parsing a line from beginning to end. |
80 | interesting uses, such as parsing a line from beginning to end. |
74 | |
81 | |
75 | This extension also offers following bindable keyboard commands: |
82 | This extension also offers following bindable keyboard commands: |
… | |
… | |
127 | bottom. C<Escape> leaves search mode and returns to the point where search |
134 | bottom. C<Escape> leaves search mode and returns to the point where search |
128 | was started, while C<Enter> or C<Return> stay at the current position and |
135 | was started, while C<Enter> or C<Return> stay at the current position and |
129 | additionally stores the first match in the current line into the primary |
136 | additionally stores the first match in the current line into the primary |
130 | selection. |
137 | selection. |
131 | |
138 | |
132 | =item selection-autotransform |
139 | =item readline (enabled by default) |
133 | |
|
|
134 | This selection allows you to do automatic transforms on a selection |
|
|
135 | whenever a selection is made. |
|
|
136 | |
|
|
137 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
138 | operator) that modify C<$_> as resources: |
|
|
139 | |
|
|
140 | URxvt.selection-autotransform.0: transform |
|
|
141 | URxvt.selection-autotransform.1: transform |
|
|
142 | ... |
|
|
143 | |
|
|
144 | For example, the following will transform selections of the form |
|
|
145 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
146 | $word>: |
|
|
147 | |
|
|
148 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
149 | |
|
|
150 | And this example matches the same,but replaces it with vi-commands you can |
|
|
151 | paste directly into your (vi :) editor: |
|
|
152 | |
|
|
153 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
154 | |
|
|
155 | Of course, this can be modified to suit your needs and your editor :) |
|
|
156 | |
|
|
157 | To expand the example above to typical perl error messages ("XXX at |
|
|
158 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
159 | |
|
|
160 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
161 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
162 | |
|
|
163 | The first line tells the selection code to treat the unchanging part of |
|
|
164 | every error message as a selection pattern, and the second line transforms |
|
|
165 | the message into vi commands to load the file. |
|
|
166 | |
|
|
167 | =item readline |
|
|
168 | |
140 | |
169 | A support package that tries to make editing with readline easier. At the |
141 | A support package that tries to make editing with readline easier. At the |
170 | moment, it reacts to clicking with the left mouse button by trying to |
142 | moment, it reacts to clicking with the left mouse button by trying to |
171 | move the text cursor to this position. It does so by generating as many |
143 | move the text cursor to this position. It does so by generating as many |
172 | cursor-left or cursor-right keypresses as required (the this only works |
144 | cursor-left or cursor-right keypresses as required (the this only works |
173 | for programs that correctly support wide characters). |
145 | for programs that correctly support wide characters). |
174 | |
146 | |
175 | It only works when clicking into the same line (possibly extended over |
147 | To avoid too many false positives, this is only done when: |
176 | multiple rows) as the text cursor and on the primary screen, to reduce the |
148 | |
177 | risk of misinterpreting. The normal selection isn't disabled, so quick |
149 | =over 4 |
|
|
150 | |
|
|
151 | =item - the tty is in ICANON state. |
|
|
152 | |
|
|
153 | =item - the text cursor is visible. |
|
|
154 | |
|
|
155 | =item - the primary screen is currently being displayed. |
|
|
156 | |
|
|
157 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
158 | |
|
|
159 | =back |
|
|
160 | |
|
|
161 | The normal selection mechanism isn't disabled, so quick successive clicks |
178 | successive clicks might interfere with selection creation in harmless |
162 | might interfere with selection creation in harmless ways. |
179 | ways. |
163 | |
|
|
164 | =item selection-autotransform |
|
|
165 | |
|
|
166 | This selection allows you to do automatic transforms on a selection |
|
|
167 | whenever a selection is made. |
|
|
168 | |
|
|
169 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
170 | operator) that modify C<$_> as resources: |
|
|
171 | |
|
|
172 | URxvt.selection-autotransform.0: transform |
|
|
173 | URxvt.selection-autotransform.1: transform |
|
|
174 | ... |
|
|
175 | |
|
|
176 | For example, the following will transform selections of the form |
|
|
177 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
178 | $word>: |
|
|
179 | |
|
|
180 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
181 | |
|
|
182 | And this example matches the same,but replaces it with vi-commands you can |
|
|
183 | paste directly into your (vi :) editor: |
|
|
184 | |
|
|
185 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
186 | |
|
|
187 | Of course, this can be modified to suit your needs and your editor :) |
|
|
188 | |
|
|
189 | To expand the example above to typical perl error messages ("XXX at |
|
|
190 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
191 | |
|
|
192 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
193 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
194 | |
|
|
195 | The first line tells the selection code to treat the unchanging part of |
|
|
196 | every error message as a selection pattern, and the second line transforms |
|
|
197 | the message into vi commands to load the file. |
180 | |
198 | |
181 | =item tabbed |
199 | =item tabbed |
182 | |
200 | |
183 | This transforms the terminal into a tabbar with additional terminals, that |
201 | This transforms the terminal into a tabbar with additional terminals, that |
184 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
202 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
… | |
… | |
187 | |
205 | |
188 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
206 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
189 | B<Shift-Right> will switch to the tab left or right of the current one, |
207 | B<Shift-Right> will switch to the tab left or right of the current one, |
190 | while B<Shift-Down> creates a new tab. |
208 | while B<Shift-Down> creates a new tab. |
191 | |
209 | |
|
|
210 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
211 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
212 | following four resources (shown with defaults): |
|
|
213 | |
|
|
214 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
215 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
216 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
217 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
218 | |
|
|
219 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
220 | indices. |
|
|
221 | |
192 | =item mark-urls |
222 | =item mark-urls |
193 | |
223 | |
194 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
224 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
195 | make them clickable. When middle-clicked, the program specified in the |
225 | make them clickable. When middle-clicked, the program specified in the |
196 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
226 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
197 | the URL as first argument. |
227 | the URL as first argument. |
198 | |
228 | |
|
|
229 | =item xim-onthespot |
|
|
230 | |
|
|
231 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
232 | not work perfectly, and some input methods don't seem to work well with |
|
|
233 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
234 | kinput2. |
|
|
235 | |
|
|
236 | You enable it by specifying this extension and a preedit style of |
|
|
237 | C<OnTheSpot>, i.e.: |
|
|
238 | |
|
|
239 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
240 | |
199 | =item automove-background |
241 | =item automove-background |
200 | |
242 | |
201 | This is basically a one-line extension that dynamically changes the background pixmap offset |
243 | This is basically a one-line extension that dynamically changes the background pixmap offset |
202 | to the window position, in effect creating the same effect as pseudo transparency with |
244 | to the window position, in effect creating the same effect as pseudo transparency with |
203 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
245 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
… | |
… | |
212 | |
254 | |
213 | =item digital-clock |
255 | =item digital-clock |
214 | |
256 | |
215 | Displays a digital clock using the built-in overlay. |
257 | Displays a digital clock using the built-in overlay. |
216 | |
258 | |
217 | =item example-refresh-hooks |
259 | =item remote-clipboard |
218 | |
260 | |
219 | Displays a very simple digital clock in the upper right corner of the |
261 | Somewhat of a misnomer, this extension adds two menu entries to the |
220 | window. Illustrates overwriting the refresh callbacks to create your own |
262 | selection popup that allows one ti run external commands to store the |
221 | overlays or changes. |
263 | selection somewhere and fetch it again. |
|
|
264 | |
|
|
265 | We use it to implement a "distributed selection mechanism", which just |
|
|
266 | means that one command uploads the file to a remote server, and another |
|
|
267 | reads it. |
|
|
268 | |
|
|
269 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
270 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
271 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
272 | the selection data on STDOUT (also in UTF-8). |
|
|
273 | |
|
|
274 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
275 | |
|
|
276 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
277 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
222 | |
278 | |
223 | =item selection-pastebin |
279 | =item selection-pastebin |
224 | |
280 | |
225 | This is a little rarely useful extension that Uploads the selection as |
281 | This is a little rarely useful extension that Uploads the selection as |
226 | textfile to a remote site (or does other things). (The implementation is |
282 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
246 | After a successful upload the selection will be replaced by the text given |
302 | After a successful upload the selection will be replaced by the text given |
247 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
303 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
248 | for the filename): |
304 | for the filename): |
249 | |
305 | |
250 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
306 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
307 | |
|
|
308 | =item example-refresh-hooks |
|
|
309 | |
|
|
310 | Displays a very simple digital clock in the upper right corner of the |
|
|
311 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
312 | overlays or changes. |
251 | |
313 | |
252 | =back |
314 | =back |
253 | |
315 | |
254 | =head1 API DOCUMENTATION |
316 | =head1 API DOCUMENTATION |
255 | |
317 | |
… | |
… | |
352 | Called at the very end of initialisation of a new terminal, just before |
414 | Called at the very end of initialisation of a new terminal, just before |
353 | trying to map (display) the toplevel and returning to the mainloop. |
415 | trying to map (display) the toplevel and returning to the mainloop. |
354 | |
416 | |
355 | =item on_destroy $term |
417 | =item on_destroy $term |
356 | |
418 | |
357 | Called whenever something tries to destroy terminal, before doing anything |
419 | Called whenever something tries to destroy terminal, when the terminal is |
358 | yet. If this hook returns true, then destruction is skipped, but this is |
420 | still fully functional (not for long, though). |
359 | rarely a good idea. |
|
|
360 | |
421 | |
361 | =item on_reset $term |
422 | =item on_reset $term |
362 | |
423 | |
363 | Called after the screen is "reset" for any reason, such as resizing or |
424 | Called after the screen is "reset" for any reason, such as resizing or |
364 | control sequences. Here is where you can react on changes to size-related |
425 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
466 | |
527 | |
467 | =item on_refresh_end $term |
528 | =item on_refresh_end $term |
468 | |
529 | |
469 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
530 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
470 | |
531 | |
471 | =item on_keyboard_command $term, $string |
532 | =item on_user_command $term, $string |
472 | |
533 | |
473 | Called whenever the user presses a key combination that has a |
534 | Called whenever the a user-configured event is being activated (e.g. via |
474 | C<perl:string> action bound to it (see description of the B<keysym> |
535 | a C<perl:string> action bound to a key, see description of the B<keysym> |
475 | resource in the @@RXVT_NAME@@(1) manpage). |
536 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
537 | |
|
|
538 | The event is simply the action string. This interface is assumed to change |
|
|
539 | slightly in the future. |
476 | |
540 | |
477 | =item on_x_event $term, $event |
541 | =item on_x_event $term, $event |
478 | |
542 | |
479 | Called on every X event received on the vt window (and possibly other |
543 | Called on every X event received on the vt window (and possibly other |
480 | windows). Should only be used as a last resort. Most event structure |
544 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
552 | our $LIBDIR; |
616 | our $LIBDIR; |
553 | our $RESNAME; |
617 | our $RESNAME; |
554 | our $RESCLASS; |
618 | our $RESCLASS; |
555 | our $RXVTNAME; |
619 | our $RXVTNAME; |
556 | |
620 | |
557 | our $NOCHAR = chr 0xfffe; |
621 | our $NOCHAR = chr 0xffff; |
558 | |
622 | |
559 | =head2 Variables in the C<urxvt> Package |
623 | =head2 Variables in the C<urxvt> Package |
560 | |
624 | |
561 | =over 4 |
625 | =over 4 |
562 | |
626 | |
… | |
… | |
614 | |
678 | |
615 | Using this function has the advantage that its output ends up in the |
679 | Using this function has the advantage that its output ends up in the |
616 | correct place, e.g. on stderr of the connecting urxvtc client. |
680 | correct place, e.g. on stderr of the connecting urxvtc client. |
617 | |
681 | |
618 | Messages have a size limit of 1023 bytes currently. |
682 | Messages have a size limit of 1023 bytes currently. |
|
|
683 | |
|
|
684 | =item @terms = urxvt::termlist |
|
|
685 | |
|
|
686 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
687 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
688 | objects that have perl extensions attached will be returned (because there |
|
|
689 | is no urxvt::term objet associated with others). |
619 | |
690 | |
620 | =item $time = urxvt::NOW |
691 | =item $time = urxvt::NOW |
621 | |
692 | |
622 | Returns the "current time" (as per the event loop). |
693 | Returns the "current time" (as per the event loop). |
623 | |
694 | |
… | |
… | |
681 | Return the foreground/background colour index, respectively. |
752 | Return the foreground/background colour index, respectively. |
682 | |
753 | |
683 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
754 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
684 | |
755 | |
685 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
756 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
757 | |
|
|
758 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
686 | |
759 | |
687 | Replace the foreground/background colour in the rendition mask with the |
760 | Replace the foreground/background colour in the rendition mask with the |
688 | specified one. |
761 | specified one. |
689 | |
762 | |
690 | =item $value = urxvt::GET_CUSTOM $rend |
763 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
709 | unless $msg =~ /\n$/; |
782 | unless $msg =~ /\n$/; |
710 | urxvt::warn ($msg); |
783 | urxvt::warn ($msg); |
711 | }; |
784 | }; |
712 | } |
785 | } |
713 | |
786 | |
|
|
787 | no warnings 'utf8'; |
|
|
788 | |
714 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
789 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
715 | |
790 | |
716 | sub verbose { |
791 | sub verbose { |
717 | my ($level, $msg) = @_; |
792 | my ($level, $msg) = @_; |
718 | warn "$msg\n" if $level <= $verbosity; |
793 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
734 | |
809 | |
735 | open my $fh, "<:raw", $path |
810 | open my $fh, "<:raw", $path |
736 | or die "$path: $!"; |
811 | or die "$path: $!"; |
737 | |
812 | |
738 | my $source = |
813 | my $source = |
739 | "package $pkg; use strict; use utf8;\n" |
814 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
740 | . "#line 1 \"$path\"\n{\n" |
815 | . "#line 1 \"$path\"\n{\n" |
741 | . (do { local $/; <$fh> }) |
816 | . (do { local $/; <$fh> }) |
742 | . "\n};\n1"; |
817 | . "\n};\n1"; |
743 | |
818 | |
744 | eval $source |
819 | eval $source |
… | |
… | |
769 | $TERM->register_package ($_) for @pkg; |
844 | $TERM->register_package ($_) for @pkg; |
770 | } |
845 | } |
771 | |
846 | |
772 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
847 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
773 | if ($_ eq "default") { |
848 | if ($_ eq "default") { |
774 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
849 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
775 | } elsif (/^-(.*)$/) { |
850 | } elsif (/^-(.*)$/) { |
776 | delete $ext_arg{$1}; |
851 | delete $ext_arg{$1}; |
777 | } elsif (/^([^<]+)<(.*)>$/) { |
852 | } elsif (/^([^<]+)<(.*)>$/) { |
778 | push @{ $ext_arg{$1} }, $2; |
853 | push @{ $ext_arg{$1} }, $2; |
779 | } else { |
854 | } else { |
… | |
… | |
824 | # clear package |
899 | # clear package |
825 | %$TERM = (); |
900 | %$TERM = (); |
826 | } |
901 | } |
827 | |
902 | |
828 | $retval |
903 | $retval |
|
|
904 | } |
|
|
905 | |
|
|
906 | sub SET_COLOR($$$) { |
|
|
907 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
829 | } |
908 | } |
830 | |
909 | |
831 | # urxvt::term::extension |
910 | # urxvt::term::extension |
832 | |
911 | |
833 | package urxvt::term::extension; |
912 | package urxvt::term::extension; |
… | |
… | |
1002 | hash which defines the environment of the new terminal. |
1081 | hash which defines the environment of the new terminal. |
1003 | |
1082 | |
1004 | Croaks (and probably outputs an error message) if the new instance |
1083 | Croaks (and probably outputs an error message) if the new instance |
1005 | couldn't be created. Returns C<undef> if the new instance didn't |
1084 | couldn't be created. Returns C<undef> if the new instance didn't |
1006 | initialise perl, and the terminal object otherwise. The C<init> and |
1085 | initialise perl, and the terminal object otherwise. The C<init> and |
1007 | C<start> hooks will be called during this call. |
1086 | C<start> hooks will be called before this call returns, and are free to |
|
|
1087 | refer to global data (which is race free). |
1008 | |
1088 | |
1009 | =cut |
1089 | =cut |
1010 | |
1090 | |
1011 | sub new { |
1091 | sub new { |
1012 | my ($class, $env, @args) = @_; |
1092 | my ($class, $env, @args) = @_; |
1013 | |
1093 | |
|
|
1094 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1095 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1096 | |
1014 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1097 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
1015 | } |
1098 | } |
1016 | |
1099 | |
1017 | =item $term->destroy |
1100 | =item $term->destroy |
1018 | |
1101 | |
1019 | Destroy the terminal object (close the window, free resources |
1102 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1299 | Replaces the event mask of the pty watcher by the given event mask. Can |
1382 | Replaces the event mask of the pty watcher by the given event mask. Can |
1300 | be used to suppress input and output handling to the pty/tty. See the |
1383 | be used to suppress input and output handling to the pty/tty. See the |
1301 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1384 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1302 | the previous value. |
1385 | the previous value. |
1303 | |
1386 | |
|
|
1387 | =item $fd = $term->pty_fd |
|
|
1388 | |
|
|
1389 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1390 | is used. |
|
|
1391 | |
1304 | =item $windowid = $term->parent |
1392 | =item $windowid = $term->parent |
1305 | |
1393 | |
1306 | Return the window id of the toplevel window. |
1394 | Return the window id of the toplevel window. |
1307 | |
1395 | |
1308 | =item $windowid = $term->vt |
1396 | =item $windowid = $term->vt |
… | |
… | |
1313 | |
1401 | |
1314 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1402 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1315 | to receive pointer events all the times: |
1403 | to receive pointer events all the times: |
1316 | |
1404 | |
1317 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1405 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1406 | |
|
|
1407 | =item $term->focus_in |
|
|
1408 | |
|
|
1409 | =item $term->focus_out |
|
|
1410 | |
|
|
1411 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1412 | |
|
|
1413 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1414 | |
|
|
1415 | Deliver various fake events to to terminal. |
1318 | |
1416 | |
1319 | =item $window_width = $term->width |
1417 | =item $window_width = $term->width |
1320 | |
1418 | |
1321 | =item $window_height = $term->height |
1419 | =item $window_height = $term->height |
1322 | |
1420 | |
… | |
… | |
1376 | |
1474 | |
1377 | =item $screen = $term->current_screen |
1475 | =item $screen = $term->current_screen |
1378 | |
1476 | |
1379 | Returns the currently displayed screen (0 primary, 1 secondary). |
1477 | Returns the currently displayed screen (0 primary, 1 secondary). |
1380 | |
1478 | |
|
|
1479 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1480 | |
|
|
1481 | Returns wether the cursor is currently hidden or not. |
|
|
1482 | |
1381 | =item $view_start = $term->view_start ([$newvalue]) |
1483 | =item $view_start = $term->view_start ([$newvalue]) |
1382 | |
1484 | |
1383 | Returns the row number of the topmost displayed line. Maximum value is |
1485 | Returns the row number of the topmost displayed line. Maximum value is |
1384 | C<0>, which displays the normal terminal contents. Lower values scroll |
1486 | C<0>, which displays the normal terminal contents. Lower values scroll |
1385 | this many lines into the scrollback buffer. |
1487 | this many lines into the scrollback buffer. |
… | |
… | |
1403 | If C<$new_text> is specified, it will replace characters in the current |
1505 | If C<$new_text> is specified, it will replace characters in the current |
1404 | line, starting at column C<$start_col> (default C<0>), which is useful |
1506 | line, starting at column C<$start_col> (default C<0>), which is useful |
1405 | to replace only parts of a line. The font index in the rendition will |
1507 | to replace only parts of a line. The font index in the rendition will |
1406 | automatically be updated. |
1508 | automatically be updated. |
1407 | |
1509 | |
1408 | C<$text> is in a special encoding: tabs and wide characters that use |
1510 | C<$text> is in a special encoding: tabs and wide characters that use more |
1409 | more than one cell when displayed are padded with C<$urxvt::NOCHAR> |
1511 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1410 | characters. Characters with combining characters and other characters that |
1512 | characters. Characters with combining characters and other characters that |
1411 | do not fit into the normal tetx encoding will be replaced with characters |
1513 | do not fit into the normal tetx encoding will be replaced with characters |
1412 | in the private use area. |
1514 | in the private use area. |
1413 | |
1515 | |
1414 | You have to obey this encoding when changing text. The advantage is |
1516 | You have to obey this encoding when changing text. The advantage is |
… | |
… | |
1564 | =item $string = $term->special_decode $text |
1666 | =item $string = $term->special_decode $text |
1565 | |
1667 | |
1566 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1668 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1567 | C<< $term->ROW_t >> for details. |
1669 | C<< $term->ROW_t >> for details. |
1568 | |
1670 | |
1569 | =item $success = $term->grab_button ($button, $modifiermask) |
1671 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1570 | |
1672 | |
|
|
1673 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1674 | |
1571 | Registers a synchronous button grab. See the XGrabButton manpage. |
1675 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1676 | manpage. |
1572 | |
1677 | |
1573 | =item $success = $term->grab ($eventtime[, $sync]) |
1678 | =item $success = $term->grab ($eventtime[, $sync]) |
1574 | |
1679 | |
1575 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1680 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1576 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1681 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |