ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC vs.
Revision 1.132 by root, Mon Feb 6 05:40:15 2006 UTC

67the match. For example, the followign adds a regex that matches everything 67the match. For example, the followign adds a regex that matches everything
68between two vertical bars: 68between two vertical bars:
69 69
70 URxvt.selection.pattern-0: \\|([^|]+)\\| 70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71 71
72Another example: Programs I use often output "absolute path: " at the
73beginning of a line when they process multiple files. The following
74pattern matches the filename (note, there is a single space at the very
75end):
76
77 URxvt.selection.pattern-0: ^(/[^:]+):\
78
72You can look at the source of the selection extension to see more 79You can look at the source of the selection extension to see more
73interesting uses, such as parsing a line from beginning to end. 80interesting uses, such as parsing a line from beginning to end.
74 81
75This extension also offers following bindable keyboard commands: 82This extension also offers following bindable keyboard commands:
76 83
91 98
92=item selection-popup (enabled by default) 99=item selection-popup (enabled by default)
93 100
94Binds a popup menu to Ctrl-Button3 that lets you convert the selection 101Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95text into various other formats/action (such as uri unescaping, perl 102text into various other formats/action (such as uri unescaping, perl
96evalution, web-browser starting etc.), depending on content. 103evaluation, web-browser starting etc.), depending on content.
97 104
98Other extensions can extend this popup menu by pushing a code reference 105Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 106onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed. 107popup is displayed.
101 108
127bottom. C<Escape> leaves search mode and returns to the point where search 134bottom. C<Escape> leaves search mode and returns to the point where search
128was started, while C<Enter> or C<Return> stay at the current position and 135was started, while C<Enter> or C<Return> stay at the current position and
129additionally stores the first match in the current line into the primary 136additionally stores the first match in the current line into the primary
130selection. 137selection.
131 138
139=item readline (enabled by default)
140
141A support package that tries to make editing with readline easier. At the
142moment, it reacts to clicking with the left mouse button by trying to
143move the text cursor to this position. It does so by generating as many
144cursor-left or cursor-right keypresses as required (the this only works
145for programs that correctly support wide characters).
146
147To avoid too many false positives, this is only done when:
148
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
161The normal selection mechanism isn't disabled, so quick successive clicks
162might interfere with selection creation in harmless ways.
163
132=item selection-autotransform 164=item selection-autotransform
133 165
134This selection allows you to do automatic transforms on a selection 166This selection allows you to do automatic transforms on a selection
135whenever a selection is made. 167whenever a selection is made.
136 168
161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ 193 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162 194
163The first line tells the selection code to treat the unchanging part of 195The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms 196every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file. 197the message into vi commands to load the file.
198
199=item tabbed
200
201This transforms the terminal into a tabbar with additional terminals, that
202is, it implements what is commonly refered to as "tabbed terminal". The topmost line
203displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
204button per tab.
205
206Clicking a button will activate that tab. Pressing B<Shift-Left> and
207B<Shift-Right> will switch to the tab left or right of the current one,
208while B<Shift-Down> creates a new tab.
209
210The tabbar itself can be configured similarly to a normal terminal, but
211with a resource class of C<URxvt.tabbed>. In addition, it supports the
212following 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
219See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
220indices.
166 221
167=item mark-urls 222=item mark-urls
168 223
169Uses per-line display filtering (C<on_line_update>) to underline urls and 224Uses per-line display filtering (C<on_line_update>) to underline urls and
170make them clickable. When middle-clicked, the program specified in the 225make them clickable. When middle-clicked, the program specified in the
171resource C<urlLauncher> (default C<x-www-browser>) will be started with 226resource C<urlLauncher> (default C<x-www-browser>) will be started with
172the URL as first argument. 227the URL as first argument.
173 228
229=item xim-onthespot
230
231This (experimental) perl extension implements OnTheSpot editing. It does
232not work perfectly, and some input methods don't seem to work well with
233OnTheSpot editing in general, but it seems to work at leats for SCIM and
234kinput2.
235
236You enable it by specifying this extension and a preedit style of
237C<OnTheSpot>, i.e.:
238
239 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
240
174=item automove-background 241=item automove-background
175 242
176This is basically a one-line extension that dynamically changes the background pixmap offset 243This is basically a one-line extension that dynamically changes the background pixmap offset
177to the window position, in effect creating the same effect as pseudo transparency with 244to the window position, in effect creating the same effect as pseudo transparency with
178a custom pixmap. No scaling is supported in this mode. Exmaple: 245a custom pixmap. No scaling is supported in this mode. Exmaple:
187 254
188=item digital-clock 255=item digital-clock
189 256
190Displays a digital clock using the built-in overlay. 257Displays a digital clock using the built-in overlay.
191 258
192=item example-refresh-hooks 259=item remote-clipboard
193 260
194Displays a very simple digital clock in the upper right corner of the 261Somewhat of a misnomer, this extension adds two menu entries to the
195window. Illustrates overwriting the refresh callbacks to create your own 262selection popup that allows one ti run external commands to store the
196overlays or changes. 263selection somewhere and fetch it again.
264
265We use it to implement a "distributed selection mechanism", which just
266means that one command uploads the file to a remote server, and another
267reads it.
268
269The commands can be set using the C<URxvt.remote-selection.store> and
270C<URxvt.remote-selection.fetch> resources. The first should read the
271selection to store from STDIN (always in UTF-8), the second should provide
272the selection data on STDOUT (also in UTF-8).
273
274The 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'
197 278
198=item selection-pastebin 279=item selection-pastebin
199 280
200This is a little rarely useful extension that Uploads the selection as 281This is a little rarely useful extension that Uploads the selection as
201textfile to a remote site (or does other things). (The implementation is 282textfile to a remote site (or does other things). (The implementation is
221After a successful upload the selection will be replaced by the text given 302After a successful upload the selection will be replaced by the text given
222in the C<selection-pastebin-url> resource (again, the % is the placeholder 303in the C<selection-pastebin-url> resource (again, the % is the placeholder
223for the filename): 304for the filename):
224 305
225 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
310Displays a very simple digital clock in the upper right corner of the
311window. Illustrates overwriting the refresh callbacks to create your own
312overlays or changes.
226 313
227=back 314=back
228 315
229=head1 API DOCUMENTATION 316=head1 API DOCUMENTATION
230 317
327Called at the very end of initialisation of a new terminal, just before 414Called at the very end of initialisation of a new terminal, just before
328trying to map (display) the toplevel and returning to the mainloop. 415trying to map (display) the toplevel and returning to the mainloop.
329 416
330=item on_destroy $term 417=item on_destroy $term
331 418
332Called whenever something tries to destroy terminal, before doing anything 419Called whenever something tries to destroy terminal, when the terminal is
333yet. If this hook returns true, then destruction is skipped, but this is 420still fully functional (not for long, though).
334rarely a good idea.
335 421
336=item on_reset $term 422=item on_reset $term
337 423
338Called after the screen is "reset" for any reason, such as resizing or 424Called after the screen is "reset" for any reason, such as resizing or
339control sequences. Here is where you can react on changes to size-related 425control sequences. Here is where you can react on changes to size-related
441 527
442=item on_refresh_end $term 528=item on_refresh_end $term
443 529
444Called just after the screen gets redrawn. See C<on_refresh_begin>. 530Called just after the screen gets redrawn. See C<on_refresh_begin>.
445 531
446=item on_keyboard_command $term, $string 532=item on_user_command $term, $string
447 533
448Called whenever the user presses a key combination that has a 534Called whenever the a user-configured event is being activated (e.g. via
449C<perl:string> action bound to it (see description of the B<keysym> 535a C<perl:string> action bound to a key, see description of the B<keysym>
450resource in the @@RXVT_NAME@@(1) manpage). 536resource in the @@RXVT_NAME@@(1) manpage).
537
538The event is simply the action string. This interface is assumed to change
539slightly in the future.
451 540
452=item on_x_event $term, $event 541=item on_x_event $term, $event
453 542
454Called on every X event received on the vt window (and possibly other 543Called on every X event received on the vt window (and possibly other
455windows). Should only be used as a last resort. Most event structure 544windows). Should only be used as a last resort. Most event structure
465Called wheneever the window loses keyboard focus, before rxvt-unicode does 554Called wheneever the window loses keyboard focus, before rxvt-unicode does
466focus out processing. 555focus out processing.
467 556
468=item on_configure_notify $term, $event 557=item on_configure_notify $term, $event
469 558
559=item on_property_notify $term, $event
560
470=item on_key_press $term, $event, $keysym, $octets 561=item on_key_press $term, $event, $keysym, $octets
471 562
472=item on_key_release $term, $event, $keysym 563=item on_key_release $term, $event, $keysym
473 564
474=item on_button_press $term, $event 565=item on_button_press $term, $event
483 574
484Called whenever the corresponding X event is received for the terminal If 575Called whenever the corresponding X event is received for the terminal If
485the hook returns true, then the even will be ignored by rxvt-unicode. 576the hook returns true, then the even will be ignored by rxvt-unicode.
486 577
487The event is a hash with most values as named by Xlib (see the XEvent 578The event is a hash with most values as named by Xlib (see the XEvent
488manpage), with the additional members C<row> and C<col>, which are the row 579manpage), with the additional members C<row> and C<col>, which are the
489and column under the mouse cursor. 580(real, not screen-based) row and column under the mouse cursor.
490 581
491C<on_key_press> additionally receives the string rxvt-unicode would 582C<on_key_press> additionally receives the string rxvt-unicode would
492output, if any, in locale-specific encoding. 583output, if any, in locale-specific encoding.
493 584
494subwindow. 585subwindow.
586
587=item on_client_message $term, $event
588
589=item on_wm_protocols $term, $event
590
591=item on_wm_delete_window $term, $event
592
593Called when various types of ClientMessage events are received (all with
594format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
495 595
496=back 596=back
497 597
498=cut 598=cut
499 599
516our $LIBDIR; 616our $LIBDIR;
517our $RESNAME; 617our $RESNAME;
518our $RESCLASS; 618our $RESCLASS;
519our $RXVTNAME; 619our $RXVTNAME;
520 620
621our $NOCHAR = chr 0xffff;
622
521=head2 Variables in the C<urxvt> Package 623=head2 Variables in the C<urxvt> Package
522 624
523=over 4 625=over 4
524 626
525=item $urxvt::LIBDIR 627=item $urxvt::LIBDIR
576 678
577Using this function has the advantage that its output ends up in the 679Using this function has the advantage that its output ends up in the
578correct place, e.g. on stderr of the connecting urxvtc client. 680correct place, e.g. on stderr of the connecting urxvtc client.
579 681
580Messages have a size limit of 1023 bytes currently. 682Messages have a size limit of 1023 bytes currently.
683
684=item @terms = urxvt::termlist
685
686Returns all urxvt::term objects that exist in this process, regardless of
687wether they are started, being destroyed etc., so be careful. Only term
688objects that have perl extensions attached will be returned (because there
689is no urxvt::term objet associated with others).
581 690
582=item $time = urxvt::NOW 691=item $time = urxvt::NOW
583 692
584Returns the "current time" (as per the event loop). 693Returns the "current time" (as per the event loop).
585 694
643Return the foreground/background colour index, respectively. 752Return the foreground/background colour index, respectively.
644 753
645=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 754=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
646 755
647=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
648 759
649Replace the foreground/background colour in the rendition mask with the 760Replace the foreground/background colour in the rendition mask with the
650specified one. 761specified one.
651 762
652=item $value = urxvt::GET_CUSTOM $rend 763=item $value = urxvt::GET_CUSTOM $rend
671 unless $msg =~ /\n$/; 782 unless $msg =~ /\n$/;
672 urxvt::warn ($msg); 783 urxvt::warn ($msg);
673 }; 784 };
674} 785}
675 786
787no warnings 'utf8';
788
676my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 789my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
677 790
678sub verbose { 791sub verbose {
679 my ($level, $msg) = @_; 792 my ($level, $msg) = @_;
680 warn "$msg\n" if $level <= $verbosity; 793 warn "$msg\n" if $level <= $verbosity;
696 809
697 open my $fh, "<:raw", $path 810 open my $fh, "<:raw", $path
698 or die "$path: $!"; 811 or die "$path: $!";
699 812
700 my $source = 813 my $source =
701 "package $pkg; use strict; use utf8;\n" 814 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
702 . "#line 1 \"$path\"\n{\n" 815 . "#line 1 \"$path\"\n{\n"
703 . (do { local $/; <$fh> }) 816 . (do { local $/; <$fh> })
704 . "\n};\n1"; 817 . "\n};\n1";
705 818
706 eval $source 819 eval $source
731 $TERM->register_package ($_) for @pkg; 844 $TERM->register_package ($_) for @pkg;
732 } 845 }
733 846
734 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 847 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
735 if ($_ eq "default") { 848 if ($_ eq "default") {
736 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 849 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
737 } elsif (/^-(.*)$/) { 850 } elsif (/^-(.*)$/) {
738 delete $ext_arg{$1}; 851 delete $ext_arg{$1};
739 } elsif (/^([^<]+)<(.*)>$/) { 852 } elsif (/^([^<]+)<(.*)>$/) {
740 push @{ $ext_arg{$1} }, $2; 853 push @{ $ext_arg{$1} }, $2;
741 } else { 854 } else {
786 # clear package 899 # clear package
787 %$TERM = (); 900 %$TERM = ();
788 } 901 }
789 902
790 $retval 903 $retval
904}
905
906sub SET_COLOR($$$) {
907 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
791} 908}
792 909
793# urxvt::term::extension 910# urxvt::term::extension
794 911
795package urxvt::term::extension; 912package urxvt::term::extension;
964hash which defines the environment of the new terminal. 1081hash which defines the environment of the new terminal.
965 1082
966Croaks (and probably outputs an error message) if the new instance 1083Croaks (and probably outputs an error message) if the new instance
967couldn't be created. Returns C<undef> if the new instance didn't 1084couldn't be created. Returns C<undef> if the new instance didn't
968initialise perl, and the terminal object otherwise. The C<init> and 1085initialise perl, and the terminal object otherwise. The C<init> and
969C<start> hooks will be called during this call. 1086C<start> hooks will be called before this call returns, and are free to
1087refer to global data (which is race free).
970 1088
971=cut 1089=cut
972 1090
973sub new { 1091sub new {
974 my ($class, $env, @args) = @_; 1092 my ($class, $env, @args) = @_;
975 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
976 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1097 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
977} 1098}
978 1099
979=item $term->destroy 1100=item $term->destroy
980 1101
981Destroy the terminal object (close the window, free resources 1102Destroy the terminal object (close the window, free resources
1238 1359
1239Normally its not a good idea to use this function, as programs might be 1360Normally its not a good idea to use this function, as programs might be
1240confused by changes in cursor position or scrolling. Its useful inside a 1361confused by changes in cursor position or scrolling. Its useful inside a
1241C<on_add_lines> hook, though. 1362C<on_add_lines> hook, though.
1242 1363
1364=item $term->scr_change_screen ($screen)
1365
1366Switch to given screen - 0 primary, 1 secondary.
1367
1243=item $term->cmd_parse ($octets) 1368=item $term->cmd_parse ($octets)
1244 1369
1245Similar to C<scr_add_lines>, but the argument must be in the 1370Similar to C<scr_add_lines>, but the argument must be in the
1246locale-specific encoding of the terminal and can contain command sequences 1371locale-specific encoding of the terminal and can contain command sequences
1247(escape codes) that will be interpreted. 1372(escape codes) that will be interpreted.
1257Replaces the event mask of the pty watcher by the given event mask. Can 1382Replaces the event mask of the pty watcher by the given event mask. Can
1258be used to suppress input and output handling to the pty/tty. See the 1383be used to suppress input and output handling to the pty/tty. See the
1259description of C<< urxvt::timer->events >>. Make sure to always restore 1384description of C<< urxvt::timer->events >>. Make sure to always restore
1260the previous value. 1385the previous value.
1261 1386
1387=item $fd = $term->pty_fd
1388
1389Returns the master file descriptor for the pty in use, or C<-1> if no pty
1390is used.
1391
1262=item $windowid = $term->parent 1392=item $windowid = $term->parent
1263 1393
1264Return the window id of the toplevel window. 1394Return the window id of the toplevel window.
1265 1395
1266=item $windowid = $term->vt 1396=item $windowid = $term->vt
1271 1401
1272Adds the specified events to the vt event mask. Useful e.g. when you want 1402Adds the specified events to the vt event mask. Useful e.g. when you want
1273to receive pointer events all the times: 1403to receive pointer events all the times:
1274 1404
1275 $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
1415Deliver various fake events to to terminal.
1276 1416
1277=item $window_width = $term->width 1417=item $window_width = $term->width
1278 1418
1279=item $window_height = $term->height 1419=item $window_height = $term->height
1280 1420
1330=item $modifiermask = $term->ModNumLockMask 1470=item $modifiermask = $term->ModNumLockMask
1331 1471
1332Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1472Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1333AltGr), the meta key (often Alt) and the num lock key, if applicable. 1473AltGr), the meta key (often Alt) and the num lock key, if applicable.
1334 1474
1475=item $screen = $term->current_screen
1476
1477Returns the currently displayed screen (0 primary, 1 secondary).
1478
1479=item $cursor_is_hidden = $term->hidden_cursor
1480
1481Returns wether the cursor is currently hidden or not.
1482
1335=item $view_start = $term->view_start ([$newvalue]) 1483=item $view_start = $term->view_start ([$newvalue])
1336 1484
1337Returns the row number of the topmost displayed line. Maximum value is 1485Returns the row number of the topmost displayed line. Maximum value is
1338C<0>, which displays the normal terminal contents. Lower values scroll 1486C<0>, which displays the normal terminal contents. Lower values scroll
1339this many lines into the scrollback buffer. 1487this many lines into the scrollback buffer.
1358line, starting at column C<$start_col> (default C<0>), which is useful 1506line, starting at column C<$start_col> (default C<0>), which is useful
1359to replace only parts of a line. The font index in the rendition will 1507to replace only parts of a line. The font index in the rendition will
1360automatically be updated. 1508automatically be updated.
1361 1509
1362C<$text> is in a special encoding: tabs and wide characters that use more 1510C<$text> is in a special encoding: tabs and wide characters that use more
1363than one cell when displayed are padded with urxvt::NOCHAR characters 1511than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1364(C<chr 65535>). Characters with combining characters and other characters 1512characters. Characters with combining characters and other characters that
1365that do not fit into the normal tetx encoding will be replaced with 1513do not fit into the normal tetx encoding will be replaced with characters
1366characters in the private use area. 1514in the private use area.
1367 1515
1368You have to obey this encoding when changing text. The advantage is 1516You have to obey this encoding when changing text. The advantage is
1369that C<substr> and similar functions work on screen cells and not on 1517that C<substr> and similar functions work on screen cells and not on
1370characters. 1518characters.
1371 1519
1518=item $string = $term->special_decode $text 1666=item $string = $term->special_decode $text
1519 1667
1520Converts rxvt-unicodes text reprsentation into a perl string. See 1668Converts rxvt-unicodes text reprsentation into a perl string. See
1521C<< $term->ROW_t >> for details. 1669C<< $term->ROW_t >> for details.
1522 1670
1523=item $success = $term->grab_button ($button, $modifiermask) 1671=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1524 1672
1673=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1674
1525Registers a synchronous button grab. See the XGrabButton manpage. 1675Register/unregister a synchronous button grab. See the XGrabButton
1676manpage.
1526 1677
1527=item $success = $term->grab ($eventtime[, $sync]) 1678=item $success = $term->grab ($eventtime[, $sync])
1528 1679
1529Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1680Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1530synchronous (C<$sync> is true). Also remembers the grab timestampe. 1681synchronous (C<$sync> is true). Also remembers the grab timestampe.
1545=item $term->ungrab 1696=item $term->ungrab
1546 1697
1547Calls XUngrab for the most recent grab. Is called automatically on 1698Calls XUngrab for the most recent grab. Is called automatically on
1548evaluation errors, as it is better to lose the grab in the error case as 1699evaluation errors, as it is better to lose the grab in the error case as
1549the session. 1700the session.
1701
1702=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1703
1704=item $atom_name = $term->XGetAtomName ($atom)
1705
1706=item @atoms = $term->XListProperties ($window)
1707
1708=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1709
1710=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1711
1712=item $term->XDeleteProperty ($window, $property)
1713
1714=item $window = $term->DefaultRootWindow
1715
1716=item $term->XReparentWindow ($window, $parent, [$x, $y])
1717
1718=item $term->XMapWindow ($window)
1719
1720=item $term->XUnmapWindow ($window)
1721
1722=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1723
1724=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1725
1726=item $term->XChangeInput ($window, $add_events[, $del_events])
1727
1728Various X or X-related functions. The C<$term> object only serves as
1729the source of the display, otherwise those functions map more-or-less
1730directory onto the X functions of the same name.
1550 1731
1551=back 1732=back
1552 1733
1553=cut 1734=cut
1554 1735
1790 1971
1791Stop watching for events on the given filehandle. 1972Stop watching for events on the given filehandle.
1792 1973
1793=back 1974=back
1794 1975
1976=head2 The C<urxvt::iw> Class
1977
1978This class implements idle watchers, that get called automatically when
1979the process is idle. They should return as fast as possible, after doing
1980some useful work.
1981
1982=over 4
1983
1984=item $iw = new urxvt::iw
1985
1986Create a new idle watcher object in stopped state.
1987
1988=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
1989
1990Set the callback to be called when the watcher triggers.
1991
1992=item $timer = $timer->start
1993
1994Start the watcher.
1995
1996=item $timer = $timer->stop
1997
1998Stop the watcher.
1999
2000=back
2001
2002=head2 The C<urxvt::pw> Class
2003
2004This class implements process watchers. They create an event whenever a
2005process exits, after which they stop automatically.
2006
2007 my $pid = fork;
2008 ...
2009 $term->{pw} = urxvt::pw
2010 ->new
2011 ->start ($pid)
2012 ->cb (sub {
2013 my ($pw, $exit_status) = @_;
2014 ...
2015 });
2016
2017=over 4
2018
2019=item $pw = new urxvt::pw
2020
2021Create a new process watcher in stopped state.
2022
2023=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2024
2025Set the callback to be called when the timer triggers.
2026
2027=item $pw = $timer->start ($pid)
2028
2029Tells the wqtcher to start watching for process C<$pid>.
2030
2031=item $pw = $pw->stop
2032
2033Stop the watcher.
2034
2035=back
2036
1795=head1 ENVIRONMENT 2037=head1 ENVIRONMENT
1796 2038
1797=head2 URXVT_PERL_VERBOSITY 2039=head2 URXVT_PERL_VERBOSITY
1798 2040
1799This variable controls the verbosity level of the perl extension. Higher 2041This variable controls the verbosity level of the perl extension. Higher

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines