… | |
… | |
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 |
… | |
… | |
220 | the message into vi commands to load the file. |
220 | the message into vi commands to load the file. |
221 | |
221 | |
222 | =item tabbed |
222 | =item tabbed |
223 | |
223 | |
224 | This transforms the terminal into a tabbar with additional terminals, that |
224 | This transforms the terminal into a tabbar with additional terminals, that |
225 | 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 |
226 | 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 |
227 | button per tab. |
227 | button per tab. |
228 | |
228 | |
229 | 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 |
230 | 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, |
… | |
… | |
240 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
240 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
241 | |
241 | |
242 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
242 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
243 | indices. |
243 | indices. |
244 | |
244 | |
245 | =item mark-urls |
245 | =item matcher |
246 | |
246 | |
247 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
247 | Uses per-line display filtering (C<on_line_update>) to underline text |
248 | make them clickable. When middle-clicked, the program specified in the |
248 | matching a certain pattern and make it clickable. When clicked with the |
249 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
249 | mouse button specified in the C<matcher.button> resource (default 2, or |
250 | the URL as first argument. |
250 | middle), the program specified in the C<matcher.launcher> resource |
|
|
251 | (default, the C<urlLauncher> resource, C<sensible-browser>) will be started |
|
|
252 | with the matched text as first argument. The default configuration is |
|
|
253 | suitable for matching URLs and launching a web browser, like the |
|
|
254 | former "mark-urls" extension. |
|
|
255 | |
|
|
256 | The default pattern to match URLs can be overridden with the |
|
|
257 | C<matcher.pattern.0> resource, and additional patterns can be specified |
|
|
258 | with numbered patterns, in a manner similar to the "selection" extension. |
|
|
259 | The launcher can also be overridden on a per-pattern basis. |
|
|
260 | |
|
|
261 | Example configuration: |
|
|
262 | |
|
|
263 | URxvt.perl-ext: default,matcher |
|
|
264 | URxvt.urlLauncher: sensible-browser |
|
|
265 | URxvt.matcher.button: 1 |
|
|
266 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
267 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
268 | URxvt.matcher.launcher.2: gvim +$2 $1 |
251 | |
269 | |
252 | =item xim-onthespot |
270 | =item xim-onthespot |
253 | |
271 | |
254 | This (experimental) perl extension implements OnTheSpot editing. It does |
272 | This (experimental) perl extension implements OnTheSpot editing. It does |
255 | not work perfectly, and some input methods don't seem to work well with |
273 | not work perfectly, and some input methods don't seem to work well with |
… | |
… | |
272 | Initially, the window will not be shown when using this extension. |
290 | Initially, the window will not be shown when using this extension. |
273 | |
291 | |
274 | This is useful if you need a single terminal thats not using any desktop |
292 | 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. |
293 | space most of the time but is quickly available at the press of a key. |
276 | |
294 | |
277 | The accelerator key is grabbed regardless of any modifers, so this |
295 | The accelerator key is grabbed regardless of any modifiers, so this |
278 | extension will actually grab a physical key just for this function. |
296 | extension will actually grab a physical key just for this function. |
279 | |
297 | |
280 | If you want a quake-like animation, tell your window manager to do so |
298 | If you want a quake-like animation, tell your window manager to do so |
281 | (fvwm can do it). |
299 | (fvwm can do it). |
282 | |
300 | |
283 | =item automove-background |
301 | =item automove-background |
284 | |
302 | |
285 | This is basically a very small extension that dynamically changes the |
303 | This is basically a very small extension that dynamically changes the |
286 | background pixmap offset to the window position, in effect creating the |
304 | background pixmap offset to the window position, in effect creating the |
287 | same effect as pseudo transparency with a custom pixmap. No scaling is |
305 | same effect as pseudo transparency with a custom pixmap. No scaling is |
288 | supported in this mode. Exmaple: |
306 | supported in this mode. Example: |
289 | |
307 | |
290 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
308 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
291 | |
309 | |
292 | =item block-graphics-to-ascii |
310 | =item block-graphics-to-ascii |
293 | |
311 | |
… | |
… | |
345 | After a successful upload the selection will be replaced by the text given |
363 | After a successful upload the selection will be replaced by the text given |
346 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
364 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
347 | for the filename): |
365 | for the filename): |
348 | |
366 | |
349 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
367 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
368 | |
|
|
369 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
370 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
371 | which works regardless of wether xrdb is used to parse the resource file |
|
|
372 | or not. |
350 | |
373 | |
351 | =item example-refresh-hooks |
374 | =item example-refresh-hooks |
352 | |
375 | |
353 | Displays a very simple digital clock in the upper right corner of the |
376 | Displays a very simple digital clock in the upper right corner of the |
354 | window. Illustrates overwriting the refresh callbacks to create your own |
377 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
395 | =back |
418 | =back |
396 | |
419 | |
397 | =head2 Extension Objects |
420 | =head2 Extension Objects |
398 | |
421 | |
399 | Every perl extension is a perl class. A separate perl object is created |
422 | Every perl extension is a perl class. A separate perl object is created |
400 | for each terminal and each extension and passed as the first parameter to |
423 | for each terminal, and each terminal has its own set of extenion objects, |
401 | hooks. So extensions can use their C<$self> object without having to think |
424 | which are passed as the first parameter to hooks. So extensions can use |
402 | about other extensions, with the exception of methods and members that |
425 | their C<$self> object without having to think about clashes with other |
|
|
426 | extensions or other terminals, with the exception of methods and members |
403 | begin with an underscore character C<_>: these are reserved for internal |
427 | that begin with an underscore character C<_>: these are reserved for |
404 | use. |
428 | internal use. |
405 | |
429 | |
406 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
430 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
407 | C<urxvt::term> class on this object. |
431 | C<urxvt::term> class on this object. |
408 | |
432 | |
409 | It has the following methods and data members: |
433 | It has the following methods and data members: |
… | |
… | |
430 | =head2 Hooks |
454 | =head2 Hooks |
431 | |
455 | |
432 | The following subroutines can be declared in extension files, and will be |
456 | The following subroutines can be declared in extension files, and will be |
433 | called whenever the relevant event happens. |
457 | called whenever the relevant event happens. |
434 | |
458 | |
435 | The first argument passed to them is an extension oject as described in |
459 | The first argument passed to them is an extension object as described in |
436 | the in the C<Extension Objects> section. |
460 | the in the C<Extension Objects> section. |
437 | |
461 | |
438 | B<All> of these hooks must return a boolean value. If any of the called |
462 | B<All> of these hooks must return a boolean value. If any of the called |
439 | hooks returns true, then the event counts as being I<consumed>, and the |
463 | hooks returns true, then the event counts as being I<consumed>, and the |
440 | relevant action might not be carried out by the C++ code. |
464 | relevant action might not be carried out by the C++ code. |
… | |
… | |
453 | place. |
477 | place. |
454 | |
478 | |
455 | =item on_start $term |
479 | =item on_start $term |
456 | |
480 | |
457 | Called at the very end of initialisation of a new terminal, just before |
481 | Called at the very end of initialisation of a new terminal, just before |
458 | trying to map (display) the toplevel and returning to the mainloop. |
482 | trying to map (display) the toplevel and returning to the main loop. |
459 | |
483 | |
460 | =item on_destroy $term |
484 | =item on_destroy $term |
461 | |
485 | |
462 | Called whenever something tries to destroy terminal, when the terminal is |
486 | Called whenever something tries to destroy terminal, when the terminal is |
463 | still fully functional (not for long, though). |
487 | still fully functional (not for long, though). |
… | |
… | |
490 | |
514 | |
491 | Called whenever a selection has been copied, but before the selection is |
515 | Called whenever a selection has been copied, but before the selection is |
492 | requested from the server. The selection text can be queried and changed |
516 | requested from the server. The selection text can be queried and changed |
493 | by calling C<< $term->selection >>. |
517 | by calling C<< $term->selection >>. |
494 | |
518 | |
495 | Returning a true value aborts selection grabbing. It will still be hilighted. |
519 | Returning a true value aborts selection grabbing. It will still be highlighted. |
496 | |
520 | |
497 | =item on_sel_extend $term |
521 | =item on_sel_extend $term |
498 | |
522 | |
499 | Called whenever the user tries to extend the selection (e.g. with a double |
523 | Called whenever the user tries to extend the selection (e.g. with a double |
500 | click) and is either supposed to return false (normal operation), or |
524 | click) and is either supposed to return false (normal operation), or |
501 | should extend the selection itelf and return true to suppress the built-in |
525 | should extend the selection itself and return true to suppress the built-in |
502 | processing. This can happen multiple times, as long as the callback |
526 | processing. This can happen multiple times, as long as the callback |
503 | returns true, it will be called on every further click by the user and is |
527 | returns true, it will be called on every further click by the user and is |
504 | supposed to enlarge the selection more and more, if possible. |
528 | supposed to enlarge the selection more and more, if possible. |
505 | |
529 | |
506 | See the F<selection> example extension. |
530 | See the F<selection> example extension. |
507 | |
531 | |
508 | =item on_view_change $term, $offset |
532 | =item on_view_change $term, $offset |
509 | |
533 | |
510 | Called whenever the view offset changes, i..e the user or program |
534 | Called whenever the view offset changes, i.e. the user or program |
511 | scrolls. Offset C<0> means display the normal terminal, positive values |
535 | scrolls. Offset C<0> means display the normal terminal, positive values |
512 | show this many lines of scrollback. |
536 | show this many lines of scrollback. |
513 | |
537 | |
514 | =item on_scroll_back $term, $lines, $saved |
538 | =item on_scroll_back $term, $lines, $saved |
515 | |
539 | |
… | |
… | |
539 | string should start with the extension name and a colon, to distinguish |
563 | string should start with the extension name and a colon, to distinguish |
540 | it from commands for other extensions, and this might be enforced in the |
564 | it from commands for other extensions, and this might be enforced in the |
541 | future. |
565 | future. |
542 | |
566 | |
543 | Be careful not ever to trust (in a security sense) the data you receive, |
567 | Be careful not ever to trust (in a security sense) the data you receive, |
544 | as its source can not easily be controleld (e-mail content, messages from |
568 | as its source can not easily be controlled (e-mail content, messages from |
545 | other users on the same system etc.). |
569 | other users on the same system etc.). |
546 | |
570 | |
547 | =item on_add_lines $term, $string |
571 | =item on_add_lines $term, $string |
548 | |
572 | |
549 | Called whenever text is about to be output, with the text as argument. You |
573 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
582 | |
606 | |
583 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
607 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
584 | |
608 | |
585 | =item on_user_command $term, $string |
609 | =item on_user_command $term, $string |
586 | |
610 | |
587 | Called whenever the a user-configured event is being activated (e.g. via |
611 | Called whenever a user-configured event is being activated (e.g. via |
588 | a C<perl:string> action bound to a key, see description of the B<keysym> |
612 | a C<perl:string> action bound to a key, see description of the B<keysym> |
589 | resource in the @@RXVT_NAME@@(1) manpage). |
613 | resource in the @@RXVT_NAME@@(1) manpage). |
590 | |
614 | |
591 | The event is simply the action string. This interface is assumed to change |
615 | The event is simply the action string. This interface is assumed to change |
592 | slightly in the future. |
616 | slightly in the future. |
593 | |
617 | |
594 | =item on_resize_all_windows $tern, $new_width, $new_height |
618 | =item on_resize_all_windows $tern, $new_width, $new_height |
595 | |
619 | |
596 | Called just after the new window size has been calculcated, but before |
620 | Called just after the new window size has been calculated, but before |
597 | windows are actually being resized or hints are being set. If this hook |
621 | windows are actually being resized or hints are being set. If this hook |
598 | returns TRUE, setting of the window hints is being skipped. |
622 | returns TRUE, setting of the window hints is being skipped. |
599 | |
623 | |
600 | =item on_x_event $term, $event |
624 | =item on_x_event $term, $event |
601 | |
625 | |
… | |
… | |
612 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
636 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
613 | does focus in processing. |
637 | does focus in processing. |
614 | |
638 | |
615 | =item on_focus_out $term |
639 | =item on_focus_out $term |
616 | |
640 | |
617 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
641 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
618 | focus out processing. |
642 | focus out processing. |
619 | |
643 | |
620 | =item on_configure_notify $term, $event |
644 | =item on_configure_notify $term, $event |
621 | |
645 | |
622 | =item on_property_notify $term, $event |
646 | =item on_property_notify $term, $event |
… | |
… | |
705 | The current terminal. This variable stores the current C<urxvt::term> |
729 | The current terminal. This variable stores the current C<urxvt::term> |
706 | object, whenever a callback/hook is executing. |
730 | object, whenever a callback/hook is executing. |
707 | |
731 | |
708 | =item @urxvt::TERM_INIT |
732 | =item @urxvt::TERM_INIT |
709 | |
733 | |
710 | All coderefs in this array will be called as methods of the next newly |
734 | All code references in this array will be called as methods of the next newly |
711 | created C<urxvt::term> object (during the C<on_init> phase). The array |
735 | created C<urxvt::term> object (during the C<on_init> phase). The array |
712 | gets cleared before the codereferences that were in it are being executed, |
736 | gets cleared before the code references that were in it are being executed, |
713 | so coderefs can push themselves onto it again if they so desire. |
737 | so references can push themselves onto it again if they so desire. |
714 | |
738 | |
715 | This complements to the perl-eval commandline option, but gets executed |
739 | This complements to the perl-eval command line option, but gets executed |
716 | first. |
740 | first. |
717 | |
741 | |
718 | =item @urxvt::TERM_EXT |
742 | =item @urxvt::TERM_EXT |
719 | |
743 | |
720 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
744 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
745 | Messages have a size limit of 1023 bytes currently. |
769 | Messages have a size limit of 1023 bytes currently. |
746 | |
770 | |
747 | =item @terms = urxvt::termlist |
771 | =item @terms = urxvt::termlist |
748 | |
772 | |
749 | Returns all urxvt::term objects that exist in this process, regardless of |
773 | Returns all urxvt::term objects that exist in this process, regardless of |
750 | wether they are started, being destroyed etc., so be careful. Only term |
774 | whether they are started, being destroyed etc., so be careful. Only term |
751 | objects that have perl extensions attached will be returned (because there |
775 | objects that have perl extensions attached will be returned (because there |
752 | is no urxvt::term objet associated with others). |
776 | is no urxvt::term objet associated with others). |
753 | |
777 | |
754 | =item $time = urxvt::NOW |
778 | =item $time = urxvt::NOW |
755 | |
779 | |
… | |
… | |
1099 | unless (${$_[0]}) { |
1123 | unless (${$_[0]}) { |
1100 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1124 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1101 | } |
1125 | } |
1102 | } |
1126 | } |
1103 | |
1127 | |
|
|
1128 | sub urxvt::anyevent::one_event { |
|
|
1129 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
|
|
1130 | } |
|
|
1131 | |
1104 | package urxvt::term; |
1132 | package urxvt::term; |
1105 | |
1133 | |
1106 | =head2 The C<urxvt::term> Class |
1134 | =head2 The C<urxvt::term> Class |
1107 | |
1135 | |
1108 | =over 4 |
1136 | =over 4 |
… | |
… | |
1193 | |
1221 | |
1194 | Returns true if the option specified by C<$optval> is enabled, and |
1222 | Returns true if the option specified by C<$optval> is enabled, and |
1195 | optionally change it. All option values are stored by name in the hash |
1223 | optionally change it. All option values are stored by name in the hash |
1196 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1224 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1197 | |
1225 | |
1198 | Here is a a likely non-exhaustive list of option names, please see the |
1226 | Here is a likely non-exhaustive list of option names, please see the |
1199 | source file F</src/optinc.h> to see the actual list: |
1227 | source file F</src/optinc.h> to see the actual list: |
1200 | |
1228 | |
1201 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1229 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1202 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1230 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1203 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1231 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1220 | likely change). |
1248 | likely change). |
1221 | |
1249 | |
1222 | Please note that resource strings will currently only be freed when the |
1250 | Please note that resource strings will currently only be freed when the |
1223 | terminal is destroyed, so changing options frequently will eat memory. |
1251 | terminal is destroyed, so changing options frequently will eat memory. |
1224 | |
1252 | |
1225 | Here is a a likely non-exhaustive list of resource names, not all of which |
1253 | Here is a likely non-exhaustive list of resource names, not all of which |
1226 | are supported in every build, please see the source file F</src/rsinc.h> |
1254 | are supported in every build, please see the source file F</src/rsinc.h> |
1227 | to see the actual list: |
1255 | to see the actual list: |
1228 | |
1256 | |
1229 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1257 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1230 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1258 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1542 | |
1570 | |
1543 | Returns the currently displayed screen (0 primary, 1 secondary). |
1571 | Returns the currently displayed screen (0 primary, 1 secondary). |
1544 | |
1572 | |
1545 | =item $cursor_is_hidden = $term->hidden_cursor |
1573 | =item $cursor_is_hidden = $term->hidden_cursor |
1546 | |
1574 | |
1547 | Returns wether the cursor is currently hidden or not. |
1575 | Returns whether the cursor is currently hidden or not. |
1548 | |
1576 | |
1549 | =item $view_start = $term->view_start ([$newvalue]) |
1577 | =item $view_start = $term->view_start ([$newvalue]) |
1550 | |
1578 | |
1551 | Returns the row number of the topmost displayed line. Maximum value is |
1579 | Returns the row number of the topmost displayed line. Maximum value is |
1552 | C<0>, which displays the normal terminal contents. Lower values scroll |
1580 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1729 | where one character corresponds to one screen cell. See |
1757 | where one character corresponds to one screen cell. See |
1730 | C<< $term->ROW_t >> for details. |
1758 | C<< $term->ROW_t >> for details. |
1731 | |
1759 | |
1732 | =item $string = $term->special_decode $text |
1760 | =item $string = $term->special_decode $text |
1733 | |
1761 | |
1734 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1762 | Converts rxvt-unicodes text representation into a perl string. See |
1735 | C<< $term->ROW_t >> for details. |
1763 | C<< $term->ROW_t >> for details. |
1736 | |
1764 | |
1737 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1765 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1738 | |
1766 | |
1739 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
1767 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
… | |
… | |
1742 | manpage. |
1770 | manpage. |
1743 | |
1771 | |
1744 | =item $success = $term->grab ($eventtime[, $sync]) |
1772 | =item $success = $term->grab ($eventtime[, $sync]) |
1745 | |
1773 | |
1746 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1774 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1747 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1775 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1748 | |
1776 | |
1749 | =item $term->allow_events_async |
1777 | =item $term->allow_events_async |
1750 | |
1778 | |
1751 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1779 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1752 | |
1780 | |
… | |
… | |
2019 | Set the callback to be called when io events are triggered. C<$reventmask> |
2047 | Set the callback to be called when io events are triggered. C<$reventmask> |
2020 | is a bitset as described in the C<events> method. |
2048 | is a bitset as described in the C<events> method. |
2021 | |
2049 | |
2022 | =item $iow = $iow->fd ($fd) |
2050 | =item $iow = $iow->fd ($fd) |
2023 | |
2051 | |
2024 | Set the filedescriptor (not handle) to watch. |
2052 | Set the file descriptor (not handle) to watch. |
2025 | |
2053 | |
2026 | =item $iow = $iow->events ($eventmask) |
2054 | =item $iow = $iow->events ($eventmask) |
2027 | |
2055 | |
2028 | Set the event mask to watch. The only allowed values are |
2056 | Set the event mask to watch. The only allowed values are |
2029 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2057 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
… | |
… | |
2033 | |
2061 | |
2034 | Start watching for requested events on the given handle. |
2062 | Start watching for requested events on the given handle. |
2035 | |
2063 | |
2036 | =item $iow = $iow->stop |
2064 | =item $iow = $iow->stop |
2037 | |
2065 | |
2038 | Stop watching for events on the given filehandle. |
2066 | Stop watching for events on the given file handle. |
2039 | |
2067 | |
2040 | =back |
2068 | =back |
2041 | |
2069 | |
2042 | =head2 The C<urxvt::iw> Class |
2070 | =head2 The C<urxvt::iw> Class |
2043 | |
2071 | |
… | |
… | |
2090 | |
2118 | |
2091 | Set the callback to be called when the timer triggers. |
2119 | Set the callback to be called when the timer triggers. |
2092 | |
2120 | |
2093 | =item $pw = $timer->start ($pid) |
2121 | =item $pw = $timer->start ($pid) |
2094 | |
2122 | |
2095 | Tells the wqtcher to start watching for process C<$pid>. |
2123 | Tells the watcher to start watching for process C<$pid>. |
2096 | |
2124 | |
2097 | =item $pw = $pw->stop |
2125 | =item $pw = $pw->stop |
2098 | |
2126 | |
2099 | Stop the watcher. |
2127 | Stop the watcher. |
2100 | |
2128 | |
… | |
… | |
2113 | |
2141 | |
2114 | =item >= 3 - script loading and management |
2142 | =item >= 3 - script loading and management |
2115 | |
2143 | |
2116 | =item >=10 - all called hooks |
2144 | =item >=10 - all called hooks |
2117 | |
2145 | |
2118 | =item >=11 - hook reutrn values |
2146 | =item >=11 - hook return values |
2119 | |
2147 | |
2120 | =back |
2148 | =back |
2121 | |
2149 | |
2122 | =head1 AUTHOR |
2150 | =head1 AUTHOR |
2123 | |
2151 | |