… | |
… | |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Everytime a terminal object gets created, extension scripts specified via |
22 | Every time a terminal object gets created, extension scripts specified via |
23 | the C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
… | |
… | |
62 | URxvt.selection.pattern-1: perl-regex |
62 | URxvt.selection.pattern-1: perl-regex |
63 | ... |
63 | ... |
64 | |
64 | |
65 | The index number (0, 1...) must not have any holes, and each regex must |
65 | The index number (0, 1...) must not have any holes, and each regex must |
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 following 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 | |
71 | |
72 | Another example: Programs I use often output "absolute path: " at the |
72 | Another example: Programs I use often output "absolute path: " at the |
… | |
… | |
122 | Other extensions can extend this popup menu by pushing a code reference |
122 | Other extensions can extend this popup menu by pushing a code reference |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
124 | popup is being displayed. |
124 | popup is being displayed. |
125 | |
125 | |
126 | It's sole argument is the popup menu, which can be modified. The selection |
126 | It's sole argument is the popup menu, which can be modified. The selection |
127 | is in C<$_>, which can be used to decide wether to add something or not. |
127 | is in C<$_>, which can be used to decide whether to add something or not. |
128 | It should either return nothing or a string and a code reference. The |
128 | It should either return nothing or a string and a code reference. The |
129 | string will be used as button text and the code reference will be called |
129 | string will be used as button text and the code reference will be called |
130 | when the button gets activated and should transform C<$_>. |
130 | when the button gets activated and should transform C<$_>. |
131 | |
131 | |
132 | The following will add an entry C<a to b> that transforms all C<a>s in |
132 | The following will add an entry C<a to b> that transforms all C<a>s in |
… | |
… | |
151 | bottom. C<Escape> leaves search mode and returns to the point where search |
151 | bottom. C<Escape> leaves search mode and returns to the point where search |
152 | was started, while C<Enter> or C<Return> stay at the current position and |
152 | was started, while C<Enter> or C<Return> stay at the current position and |
153 | additionally stores the first match in the current line into the primary |
153 | additionally stores the first match in the current line into the primary |
154 | selection. |
154 | selection. |
155 | |
155 | |
|
|
156 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
|
|
157 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
|
|
158 | or simply use an uppercase character which removes the "(?i)" prefix. |
|
|
159 | |
|
|
160 | See L<perlre> for more info about perl regular expression syntax. |
|
|
161 | |
156 | =item readline (enabled by default) |
162 | =item readline (enabled by default) |
157 | |
163 | |
158 | A support package that tries to make editing with readline easier. At |
164 | A support package that tries to make editing with readline easier. At |
159 | the moment, it reacts to clicking shift-left mouse button by trying to |
165 | the moment, it reacts to clicking shift-left mouse button by trying to |
160 | move the text cursor to this position. It does so by generating as many |
166 | move the text cursor to this position. It does so by generating as many |
… | |
… | |
214 | the message into vi commands to load the file. |
220 | the message into vi commands to load the file. |
215 | |
221 | |
216 | =item tabbed |
222 | =item tabbed |
217 | |
223 | |
218 | This transforms the terminal into a tabbar with additional terminals, that |
224 | This transforms the terminal into a tabbar with additional terminals, that |
219 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
225 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
220 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
226 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
221 | button per tab. |
227 | button per tab. |
222 | |
228 | |
223 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
229 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
224 | B<Shift-Right> will switch to the tab left or right of the current one, |
230 | B<Shift-Right> will switch to the tab left or right of the current one, |
… | |
… | |
253 | You enable it by specifying this extension and a preedit style of |
259 | You enable it by specifying this extension and a preedit style of |
254 | C<OnTheSpot>, i.e.: |
260 | C<OnTheSpot>, i.e.: |
255 | |
261 | |
256 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
262 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
257 | |
263 | |
|
|
264 | =item kuake<hotkey> |
|
|
265 | |
|
|
266 | A very primitive quake-console-like extension. It was inspired by a |
|
|
267 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
268 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
269 | will show or hide itself. Another press of the accelerator key will hide |
|
|
270 | or show it again. |
|
|
271 | |
|
|
272 | Initially, the window will not be shown when using this extension. |
|
|
273 | |
|
|
274 | This is useful if you need a single terminal thats not using any desktop |
|
|
275 | space most of the time but is quickly available at the press of a key. |
|
|
276 | |
|
|
277 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
278 | extension will actually grab a physical key just for this function. |
|
|
279 | |
|
|
280 | If you want a quake-like animation, tell your window manager to do so |
|
|
281 | (fvwm can do it). |
|
|
282 | |
258 | =item automove-background |
283 | =item automove-background |
259 | |
284 | |
260 | This is basically a one-line extension that dynamically changes the background pixmap offset |
285 | This is basically a very small extension that dynamically changes the |
261 | to the window position, in effect creating the same effect as pseudo transparency with |
286 | background pixmap offset to the window position, in effect creating the |
262 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
287 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
288 | supported in this mode. Example: |
263 | |
289 | |
264 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
290 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
265 | |
291 | |
266 | =item block-graphics-to-ascii |
292 | =item block-graphics-to-ascii |
267 | |
293 | |
268 | A not very useful example of filtering all text output to the terminal, |
294 | A not very useful example of filtering all text output to the terminal |
269 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
295 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
270 | similar-looking ascii character. |
296 | similar-looking ascii character. |
271 | |
297 | |
272 | =item digital-clock |
298 | =item digital-clock |
273 | |
299 | |
… | |
… | |
319 | After a successful upload the selection will be replaced by the text given |
345 | After a successful upload the selection will be replaced by the text given |
320 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
346 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
321 | for the filename): |
347 | for the filename): |
322 | |
348 | |
323 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
349 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
350 | |
|
|
351 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
352 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
353 | which works regardless of wether xrdb is used to parse the resource file |
|
|
354 | or not. |
324 | |
355 | |
325 | =item example-refresh-hooks |
356 | =item example-refresh-hooks |
326 | |
357 | |
327 | Displays a very simple digital clock in the upper right corner of the |
358 | Displays a very simple digital clock in the upper right corner of the |
328 | window. Illustrates overwriting the refresh callbacks to create your own |
359 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
368 | |
399 | |
369 | =back |
400 | =back |
370 | |
401 | |
371 | =head2 Extension Objects |
402 | =head2 Extension Objects |
372 | |
403 | |
373 | Very perl extension is a perl class. A separate perl object is created |
404 | Every perl extension is a perl class. A separate perl object is created |
374 | for each terminal and each extension and passed as the first parameter to |
405 | for each terminal, and each terminal has its own set of extenion objects, |
375 | hooks. So extensions can use their C<$self> object without having to think |
406 | which are passed as the first parameter to hooks. So extensions can use |
376 | about other extensions, with the exception of methods and members that |
407 | their C<$self> object without having to think about clashes with other |
|
|
408 | extensions or other terminals, with the exception of methods and members |
377 | begin with an underscore character C<_>: these are reserved for internal |
409 | that begin with an underscore character C<_>: these are reserved for |
378 | use. |
410 | internal use. |
379 | |
411 | |
380 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
412 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
381 | C<urxvt::term> class on this object. |
413 | C<urxvt::term> class on this object. |
382 | |
414 | |
383 | It has the following methods and data members: |
415 | It has the following methods and data members: |
… | |
… | |
404 | =head2 Hooks |
436 | =head2 Hooks |
405 | |
437 | |
406 | The following subroutines can be declared in extension files, and will be |
438 | The following subroutines can be declared in extension files, and will be |
407 | called whenever the relevant event happens. |
439 | called whenever the relevant event happens. |
408 | |
440 | |
409 | The first argument passed to them is an extension oject as described in |
441 | The first argument passed to them is an extension object as described in |
410 | the in the C<Extension Objects> section. |
442 | the in the C<Extension Objects> section. |
411 | |
443 | |
412 | B<All> of these hooks must return a boolean value. If any of the called |
444 | B<All> of these hooks must return a boolean value. If any of the called |
413 | hooks returns true, then the event counts as being I<consumed>, and the |
445 | hooks returns true, then the event counts as being I<consumed>, and the |
414 | relevant action might not be carried out by the C++ code. |
446 | relevant action might not be carried out by the C++ code. |
… | |
… | |
427 | place. |
459 | place. |
428 | |
460 | |
429 | =item on_start $term |
461 | =item on_start $term |
430 | |
462 | |
431 | Called at the very end of initialisation of a new terminal, just before |
463 | Called at the very end of initialisation of a new terminal, just before |
432 | trying to map (display) the toplevel and returning to the mainloop. |
464 | trying to map (display) the toplevel and returning to the main loop. |
433 | |
465 | |
434 | =item on_destroy $term |
466 | =item on_destroy $term |
435 | |
467 | |
436 | Called whenever something tries to destroy terminal, when the terminal is |
468 | Called whenever something tries to destroy terminal, when the terminal is |
437 | still fully functional (not for long, though). |
469 | still fully functional (not for long, though). |
… | |
… | |
464 | |
496 | |
465 | Called whenever a selection has been copied, but before the selection is |
497 | Called whenever a selection has been copied, but before the selection is |
466 | requested from the server. The selection text can be queried and changed |
498 | requested from the server. The selection text can be queried and changed |
467 | by calling C<< $term->selection >>. |
499 | by calling C<< $term->selection >>. |
468 | |
500 | |
469 | Returning a true value aborts selection grabbing. It will still be hilighted. |
501 | Returning a true value aborts selection grabbing. It will still be highlighted. |
470 | |
502 | |
471 | =item on_sel_extend $term |
503 | =item on_sel_extend $term |
472 | |
504 | |
473 | Called whenever the user tries to extend the selection (e.g. with a double |
505 | Called whenever the user tries to extend the selection (e.g. with a double |
474 | click) and is either supposed to return false (normal operation), or |
506 | click) and is either supposed to return false (normal operation), or |
475 | should extend the selection itelf and return true to suppress the built-in |
507 | should extend the selection itself and return true to suppress the built-in |
476 | processing. This can happen multiple times, as long as the callback |
508 | processing. This can happen multiple times, as long as the callback |
477 | returns true, it will be called on every further click by the user and is |
509 | returns true, it will be called on every further click by the user and is |
478 | supposed to enlarge the selection more and more, if possible. |
510 | supposed to enlarge the selection more and more, if possible. |
479 | |
511 | |
480 | See the F<selection> example extension. |
512 | See the F<selection> example extension. |
481 | |
513 | |
482 | =item on_view_change $term, $offset |
514 | =item on_view_change $term, $offset |
483 | |
515 | |
484 | Called whenever the view offset changes, i..e the user or program |
516 | Called whenever the view offset changes, i.e. the user or program |
485 | scrolls. Offset C<0> means display the normal terminal, positive values |
517 | scrolls. Offset C<0> means display the normal terminal, positive values |
486 | show this many lines of scrollback. |
518 | show this many lines of scrollback. |
487 | |
519 | |
488 | =item on_scroll_back $term, $lines, $saved |
520 | =item on_scroll_back $term, $lines, $saved |
489 | |
521 | |
… | |
… | |
513 | string should start with the extension name and a colon, to distinguish |
545 | string should start with the extension name and a colon, to distinguish |
514 | it from commands for other extensions, and this might be enforced in the |
546 | it from commands for other extensions, and this might be enforced in the |
515 | future. |
547 | future. |
516 | |
548 | |
517 | Be careful not ever to trust (in a security sense) the data you receive, |
549 | Be careful not ever to trust (in a security sense) the data you receive, |
518 | as its source can not easily be controleld (e-mail content, messages from |
550 | as its source can not easily be controlled (e-mail content, messages from |
519 | other users on the same system etc.). |
551 | other users on the same system etc.). |
520 | |
552 | |
521 | =item on_add_lines $term, $string |
553 | =item on_add_lines $term, $string |
522 | |
554 | |
523 | Called whenever text is about to be output, with the text as argument. You |
555 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
556 | |
588 | |
557 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
589 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
558 | |
590 | |
559 | =item on_user_command $term, $string |
591 | =item on_user_command $term, $string |
560 | |
592 | |
561 | Called whenever the a user-configured event is being activated (e.g. via |
593 | Called whenever a user-configured event is being activated (e.g. via |
562 | a C<perl:string> action bound to a key, see description of the B<keysym> |
594 | a C<perl:string> action bound to a key, see description of the B<keysym> |
563 | resource in the @@RXVT_NAME@@(1) manpage). |
595 | resource in the @@RXVT_NAME@@(1) manpage). |
564 | |
596 | |
565 | The event is simply the action string. This interface is assumed to change |
597 | The event is simply the action string. This interface is assumed to change |
566 | slightly in the future. |
598 | slightly in the future. |
567 | |
599 | |
568 | =item on_resize_all_windows $tern, $new_width, $new_height |
600 | =item on_resize_all_windows $tern, $new_width, $new_height |
569 | |
601 | |
570 | Called just after the new window size has been calculcated, but before |
602 | Called just after the new window size has been calculated, but before |
571 | windows are actually being resized or hints are being set. If this hook |
603 | windows are actually being resized or hints are being set. If this hook |
572 | returns TRUE, setting of the window hints is being skipped. |
604 | returns TRUE, setting of the window hints is being skipped. |
573 | |
605 | |
574 | =item on_x_event $term, $event |
606 | =item on_x_event $term, $event |
575 | |
607 | |
576 | Called on every X event received on the vt window (and possibly other |
608 | Called on every X event received on the vt window (and possibly other |
577 | windows). Should only be used as a last resort. Most event structure |
609 | windows). Should only be used as a last resort. Most event structure |
578 | members are not passed. |
610 | members are not passed. |
579 | |
611 | |
|
|
612 | =item on_root_event $term, $event |
|
|
613 | |
|
|
614 | Like C<on_x_event>, but is called for events on the root window. |
|
|
615 | |
580 | =item on_focus_in $term |
616 | =item on_focus_in $term |
581 | |
617 | |
582 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
618 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
583 | does focus in processing. |
619 | does focus in processing. |
584 | |
620 | |
585 | =item on_focus_out $term |
621 | =item on_focus_out $term |
586 | |
622 | |
587 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
623 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
588 | focus out processing. |
624 | focus out processing. |
589 | |
625 | |
590 | =item on_configure_notify $term, $event |
626 | =item on_configure_notify $term, $event |
591 | |
627 | |
592 | =item on_property_notify $term, $event |
628 | =item on_property_notify $term, $event |
… | |
… | |
675 | The current terminal. This variable stores the current C<urxvt::term> |
711 | The current terminal. This variable stores the current C<urxvt::term> |
676 | object, whenever a callback/hook is executing. |
712 | object, whenever a callback/hook is executing. |
677 | |
713 | |
678 | =item @urxvt::TERM_INIT |
714 | =item @urxvt::TERM_INIT |
679 | |
715 | |
680 | All coderefs in this array will be called as methods of the next newly |
716 | All code references in this array will be called as methods of the next newly |
681 | created C<urxvt::term> object (during the C<on_init> phase). The array |
717 | created C<urxvt::term> object (during the C<on_init> phase). The array |
682 | gets cleared before the codereferences that were in it are being executed, |
718 | gets cleared before the code references that were in it are being executed, |
683 | so coderefs can push themselves onto it again if they so desire. |
719 | so references can push themselves onto it again if they so desire. |
684 | |
720 | |
685 | This complements to the perl-eval commandline option, but gets executed |
721 | This complements to the perl-eval command line option, but gets executed |
686 | first. |
722 | first. |
687 | |
723 | |
688 | =item @urxvt::TERM_EXT |
724 | =item @urxvt::TERM_EXT |
689 | |
725 | |
690 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
726 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
715 | Messages have a size limit of 1023 bytes currently. |
751 | Messages have a size limit of 1023 bytes currently. |
716 | |
752 | |
717 | =item @terms = urxvt::termlist |
753 | =item @terms = urxvt::termlist |
718 | |
754 | |
719 | Returns all urxvt::term objects that exist in this process, regardless of |
755 | Returns all urxvt::term objects that exist in this process, regardless of |
720 | wether they are started, being destroyed etc., so be careful. Only term |
756 | whether they are started, being destroyed etc., so be careful. Only term |
721 | objects that have perl extensions attached will be returned (because there |
757 | objects that have perl extensions attached will be returned (because there |
722 | is no urxvt::term objet associated with others). |
758 | is no urxvt::term objet associated with others). |
723 | |
759 | |
724 | =item $time = urxvt::NOW |
760 | =item $time = urxvt::NOW |
725 | |
761 | |
… | |
… | |
907 | |
943 | |
908 | if (my $cb = $TERM->{_hook}[$htype]) { |
944 | if (my $cb = $TERM->{_hook}[$htype]) { |
909 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
945 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
910 | if $verbosity >= 10; |
946 | if $verbosity >= 10; |
911 | |
947 | |
912 | keys %$cb; |
948 | for my $pkg (keys %$cb) { |
913 | |
|
|
914 | while (my ($pkg, $cb) = each %$cb) { |
|
|
915 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
949 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
916 | $retval ||= $retval_; |
950 | $retval ||= $retval_; |
917 | |
951 | |
918 | if ($@) { |
952 | if ($@) { |
919 | $TERM->ungrab; # better to lose the grab than the session |
953 | $TERM->ungrab; # better to lose the grab than the session |
920 | warn $@; |
954 | warn $@; |
… | |
… | |
1165 | |
1199 | |
1166 | Returns true if the option specified by C<$optval> is enabled, and |
1200 | Returns true if the option specified by C<$optval> is enabled, and |
1167 | optionally change it. All option values are stored by name in the hash |
1201 | optionally change it. All option values are stored by name in the hash |
1168 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1202 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1169 | |
1203 | |
1170 | Here is a a likely non-exhaustive list of option names, please see the |
1204 | Here is a likely non-exhaustive list of option names, please see the |
1171 | source file F</src/optinc.h> to see the actual list: |
1205 | source file F</src/optinc.h> to see the actual list: |
1172 | |
1206 | |
1173 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1207 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1174 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1208 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1175 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1209 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1192 | likely change). |
1226 | likely change). |
1193 | |
1227 | |
1194 | Please note that resource strings will currently only be freed when the |
1228 | Please note that resource strings will currently only be freed when the |
1195 | terminal is destroyed, so changing options frequently will eat memory. |
1229 | terminal is destroyed, so changing options frequently will eat memory. |
1196 | |
1230 | |
1197 | Here is a a likely non-exhaustive list of resource names, not all of which |
1231 | Here is a likely non-exhaustive list of resource names, not all of which |
1198 | are supported in every build, please see the source file F</src/rsinc.h> |
1232 | are supported in every build, please see the source file F</src/rsinc.h> |
1199 | to see the actual list: |
1233 | to see the actual list: |
1200 | |
1234 | |
1201 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1235 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1202 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1236 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1514 | |
1548 | |
1515 | Returns the currently displayed screen (0 primary, 1 secondary). |
1549 | Returns the currently displayed screen (0 primary, 1 secondary). |
1516 | |
1550 | |
1517 | =item $cursor_is_hidden = $term->hidden_cursor |
1551 | =item $cursor_is_hidden = $term->hidden_cursor |
1518 | |
1552 | |
1519 | Returns wether the cursor is currently hidden or not. |
1553 | Returns whether the cursor is currently hidden or not. |
1520 | |
1554 | |
1521 | =item $view_start = $term->view_start ([$newvalue]) |
1555 | =item $view_start = $term->view_start ([$newvalue]) |
1522 | |
1556 | |
1523 | Returns the row number of the topmost displayed line. Maximum value is |
1557 | Returns the row number of the topmost displayed line. Maximum value is |
1524 | C<0>, which displays the normal terminal contents. Lower values scroll |
1558 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1701 | where one character corresponds to one screen cell. See |
1735 | where one character corresponds to one screen cell. See |
1702 | C<< $term->ROW_t >> for details. |
1736 | C<< $term->ROW_t >> for details. |
1703 | |
1737 | |
1704 | =item $string = $term->special_decode $text |
1738 | =item $string = $term->special_decode $text |
1705 | |
1739 | |
1706 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1740 | Converts rxvt-unicodes text representation into a perl string. See |
1707 | C<< $term->ROW_t >> for details. |
1741 | C<< $term->ROW_t >> for details. |
1708 | |
1742 | |
1709 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1743 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1710 | |
1744 | |
1711 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
1745 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
… | |
… | |
1714 | manpage. |
1748 | manpage. |
1715 | |
1749 | |
1716 | =item $success = $term->grab ($eventtime[, $sync]) |
1750 | =item $success = $term->grab ($eventtime[, $sync]) |
1717 | |
1751 | |
1718 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1752 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1719 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1753 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1720 | |
1754 | |
1721 | =item $term->allow_events_async |
1755 | =item $term->allow_events_async |
1722 | |
1756 | |
1723 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1757 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1724 | |
1758 | |
… | |
… | |
1991 | Set the callback to be called when io events are triggered. C<$reventmask> |
2025 | Set the callback to be called when io events are triggered. C<$reventmask> |
1992 | is a bitset as described in the C<events> method. |
2026 | is a bitset as described in the C<events> method. |
1993 | |
2027 | |
1994 | =item $iow = $iow->fd ($fd) |
2028 | =item $iow = $iow->fd ($fd) |
1995 | |
2029 | |
1996 | Set the filedescriptor (not handle) to watch. |
2030 | Set the file descriptor (not handle) to watch. |
1997 | |
2031 | |
1998 | =item $iow = $iow->events ($eventmask) |
2032 | =item $iow = $iow->events ($eventmask) |
1999 | |
2033 | |
2000 | Set the event mask to watch. The only allowed values are |
2034 | Set the event mask to watch. The only allowed values are |
2001 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2035 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
… | |
… | |
2005 | |
2039 | |
2006 | Start watching for requested events on the given handle. |
2040 | Start watching for requested events on the given handle. |
2007 | |
2041 | |
2008 | =item $iow = $iow->stop |
2042 | =item $iow = $iow->stop |
2009 | |
2043 | |
2010 | Stop watching for events on the given filehandle. |
2044 | Stop watching for events on the given file handle. |
2011 | |
2045 | |
2012 | =back |
2046 | =back |
2013 | |
2047 | |
2014 | =head2 The C<urxvt::iw> Class |
2048 | =head2 The C<urxvt::iw> Class |
2015 | |
2049 | |
… | |
… | |
2062 | |
2096 | |
2063 | Set the callback to be called when the timer triggers. |
2097 | Set the callback to be called when the timer triggers. |
2064 | |
2098 | |
2065 | =item $pw = $timer->start ($pid) |
2099 | =item $pw = $timer->start ($pid) |
2066 | |
2100 | |
2067 | Tells the wqtcher to start watching for process C<$pid>. |
2101 | Tells the watcher to start watching for process C<$pid>. |
2068 | |
2102 | |
2069 | =item $pw = $pw->stop |
2103 | =item $pw = $pw->stop |
2070 | |
2104 | |
2071 | Stop the watcher. |
2105 | Stop the watcher. |
2072 | |
2106 | |
… | |
… | |
2085 | |
2119 | |
2086 | =item >= 3 - script loading and management |
2120 | =item >= 3 - script loading and management |
2087 | |
2121 | |
2088 | =item >=10 - all called hooks |
2122 | =item >=10 - all called hooks |
2089 | |
2123 | |
2090 | =item >=11 - hook reutrn values |
2124 | =item >=11 - hook return values |
2091 | |
2125 | |
2092 | =back |
2126 | =back |
2093 | |
2127 | |
2094 | =head1 AUTHOR |
2128 | =head1 AUTHOR |
2095 | |
2129 | |