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.115 by root, Fri Jan 20 15:57:21 2006 UTC vs.
Revision 1.135 by root, Sun Feb 12 05:31:53 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
87=item option-popup (enabled by default) 94=item option-popup (enabled by default)
88 95
89Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 96Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90runtime. 97runtime.
91 98
99Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed.
102
103It's sole argument is the popup menu, which can be modified. It should
104either return nothing or a string, the initial boolean value and a code
105reference. The string will be used as button text and the code reference
106will be called when the toggle changes, with the new boolean value as
107first argument.
108
109The following will add an entry C<myoption> that changes
110C<$self->{myoption}>:
111
112 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 };
115
92=item selection-popup (enabled by default) 116=item selection-popup (enabled by default)
93 117
94Binds a popup menu to Ctrl-Button3 that lets you convert the selection 118Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95text into various other formats/action (such as uri unescaping, perl 119text into various other formats/action (such as uri unescaping, perl
96evalution, web-browser starting etc.), depending on content. 120evaluation, web-browser starting etc.), depending on content.
97 121
98Other extensions can extend this popup menu by pushing a code reference 122Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
100popup is displayed. 124popup is being displayed.
101 125
102It's sole argument is the popup menu, which can be modified. The selection 126It's sole argument is the popup menu, which can be modified. The selection
103is in C<$_>, which can be used to decide wether to add something or not. 127is in C<$_>, which can be used to decide wether to add something or not.
104It should either return nothing or a string and a code reference. The 128It should either return nothing or a string and a code reference. The
105string will be used as button text and the code reference will be called 129string will be used as button text and the code reference will be called
127bottom. C<Escape> leaves search mode and returns to the point where search 151bottom. 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 152was 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 153additionally stores the first match in the current line into the primary
130selection. 154selection.
131 155
156=item readline (enabled by default)
157
158A support package that tries to make editing with readline easier. At
159the moment, it reacts to clicking shift-left mouse button by trying to
160move the text cursor to this position. It does so by generating as many
161cursor-left or cursor-right keypresses as required (the this only works
162for programs that correctly support wide characters).
163
164To avoid too many false positives, this is only done when:
165
166=over 4
167
168=item - the tty is in ICANON state.
169
170=item - the text cursor is visible.
171
172=item - the primary screen is currently being displayed.
173
174=item - the mouse is on the same (multi-row-) line as the text cursor.
175
176=back
177
178The normal selection mechanism isn't disabled, so quick successive clicks
179might interfere with selection creation in harmless ways.
180
132=item selection-autotransform 181=item selection-autotransform
133 182
134This selection allows you to do automatic transforms on a selection 183This selection allows you to do automatic transforms on a selection
135whenever a selection is made. 184whenever a selection is made.
136 185
169This transforms the terminal into a tabbar with additional terminals, that 218This transforms the terminal into a tabbar with additional terminals, that
170is, it implements what is commonly refered to as "tabbed terminal". The topmost line 219is, it implements what is commonly refered to as "tabbed terminal". The topmost line
171displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one 220displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
172button per tab. 221button per tab.
173 222
174Clicking a button will activate that tab. Pressing Shift-Left and 223Clicking a button will activate that tab. Pressing B<Shift-Left> and
175Shift-Right will switch to the tab left or right of the current one. 224B<Shift-Right> will switch to the tab left or right of the current one,
225while B<Shift-Down> creates a new tab.
226
227The tabbar itself can be configured similarly to a normal terminal, but
228with a resource class of C<URxvt.tabbed>. In addition, it supports the
229following four resources (shown with defaults):
230
231 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
232 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
233 URxvt.tabbed.tab-fg: <colour-index, default 0>
234 URxvt.tabbed.tab-bg: <colour-index, default 1>
235
236See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
237indices.
176 238
177=item mark-urls 239=item mark-urls
178 240
179Uses per-line display filtering (C<on_line_update>) to underline urls and 241Uses per-line display filtering (C<on_line_update>) to underline urls and
180make them clickable. When middle-clicked, the program specified in the 242make them clickable. When middle-clicked, the program specified in the
181resource C<urlLauncher> (default C<x-www-browser>) will be started with 243resource C<urlLauncher> (default C<x-www-browser>) will be started with
182the URL as first argument. 244the URL as first argument.
183 245
246=item xim-onthespot
247
248This (experimental) perl extension implements OnTheSpot editing. It does
249not work perfectly, and some input methods don't seem to work well with
250OnTheSpot editing in general, but it seems to work at leats for SCIM and
251kinput2.
252
253You enable it by specifying this extension and a preedit style of
254C<OnTheSpot>, i.e.:
255
256 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
257
184=item automove-background 258=item automove-background
185 259
186This is basically a one-line extension that dynamically changes the background pixmap offset 260This is basically a one-line extension that dynamically changes the background pixmap offset
187to the window position, in effect creating the same effect as pseudo transparency with 261to the window position, in effect creating the same effect as pseudo transparency with
188a custom pixmap. No scaling is supported in this mode. Exmaple: 262a custom pixmap. No scaling is supported in this mode. Exmaple:
197 271
198=item digital-clock 272=item digital-clock
199 273
200Displays a digital clock using the built-in overlay. 274Displays a digital clock using the built-in overlay.
201 275
202=item example-refresh-hooks 276=item remote-clipboard
203 277
204Displays a very simple digital clock in the upper right corner of the 278Somewhat of a misnomer, this extension adds two menu entries to the
205window. Illustrates overwriting the refresh callbacks to create your own 279selection popup that allows one ti run external commands to store the
206overlays or changes. 280selection somewhere and fetch it again.
281
282We use it to implement a "distributed selection mechanism", which just
283means that one command uploads the file to a remote server, and another
284reads it.
285
286The commands can be set using the C<URxvt.remote-selection.store> and
287C<URxvt.remote-selection.fetch> resources. The first should read the
288selection to store from STDIN (always in UTF-8), the second should provide
289the selection data on STDOUT (also in UTF-8).
290
291The defaults (which are likely useless to you) use rsh and cat:
292
293 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
294 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
207 295
208=item selection-pastebin 296=item selection-pastebin
209 297
210This is a little rarely useful extension that Uploads the selection as 298This is a little rarely useful extension that Uploads the selection as
211textfile to a remote site (or does other things). (The implementation is 299textfile to a remote site (or does other things). (The implementation is
231After a successful upload the selection will be replaced by the text given 319After a successful upload the selection will be replaced by the text given
232in the C<selection-pastebin-url> resource (again, the % is the placeholder 320in the C<selection-pastebin-url> resource (again, the % is the placeholder
233for the filename): 321for the filename):
234 322
235 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 323 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
324
325=item example-refresh-hooks
326
327Displays a very simple digital clock in the upper right corner of the
328window. Illustrates overwriting the refresh callbacks to create your own
329overlays or changes.
236 330
237=back 331=back
238 332
239=head1 API DOCUMENTATION 333=head1 API DOCUMENTATION
240 334
337Called at the very end of initialisation of a new terminal, just before 431Called at the very end of initialisation of a new terminal, just before
338trying to map (display) the toplevel and returning to the mainloop. 432trying to map (display) the toplevel and returning to the mainloop.
339 433
340=item on_destroy $term 434=item on_destroy $term
341 435
342Called whenever something tries to destroy terminal, before doing anything 436Called whenever something tries to destroy terminal, when the terminal is
343yet. If this hook returns true, then destruction is skipped, but this is 437still fully functional (not for long, though).
344rarely a good idea.
345 438
346=item on_reset $term 439=item on_reset $term
347 440
348Called after the screen is "reset" for any reason, such as resizing or 441Called after the screen is "reset" for any reason, such as resizing or
349control sequences. Here is where you can react on changes to size-related 442control sequences. Here is where you can react on changes to size-related
451 544
452=item on_refresh_end $term 545=item on_refresh_end $term
453 546
454Called just after the screen gets redrawn. See C<on_refresh_begin>. 547Called just after the screen gets redrawn. See C<on_refresh_begin>.
455 548
456=item on_keyboard_command $term, $string 549=item on_user_command $term, $string
457 550
458Called whenever the user presses a key combination that has a 551Called whenever the a user-configured event is being activated (e.g. via
459C<perl:string> action bound to it (see description of the B<keysym> 552a C<perl:string> action bound to a key, see description of the B<keysym>
460resource in the @@RXVT_NAME@@(1) manpage). 553resource in the @@RXVT_NAME@@(1) manpage).
554
555The event is simply the action string. This interface is assumed to change
556slightly in the future.
557
558=item on_resize_all_windows $tern, $new_width, $new_height
559
560Called just after the new window size has been calculcated, but before
561windows are actually being resized or hints are being set. If this hook
562returns TRUE, setting of the window hints is being skipped.
461 563
462=item on_x_event $term, $event 564=item on_x_event $term, $event
463 565
464Called on every X event received on the vt window (and possibly other 566Called on every X event received on the vt window (and possibly other
465windows). Should only be used as a last resort. Most event structure 567windows). Should only be used as a last resort. Most event structure
475Called wheneever the window loses keyboard focus, before rxvt-unicode does 577Called wheneever the window loses keyboard focus, before rxvt-unicode does
476focus out processing. 578focus out processing.
477 579
478=item on_configure_notify $term, $event 580=item on_configure_notify $term, $event
479 581
582=item on_property_notify $term, $event
583
480=item on_key_press $term, $event, $keysym, $octets 584=item on_key_press $term, $event, $keysym, $octets
481 585
482=item on_key_release $term, $event, $keysym 586=item on_key_release $term, $event, $keysym
483 587
484=item on_button_press $term, $event 588=item on_button_press $term, $event
493 597
494Called whenever the corresponding X event is received for the terminal If 598Called whenever the corresponding X event is received for the terminal If
495the hook returns true, then the even will be ignored by rxvt-unicode. 599the hook returns true, then the even will be ignored by rxvt-unicode.
496 600
497The event is a hash with most values as named by Xlib (see the XEvent 601The event is a hash with most values as named by Xlib (see the XEvent
498manpage), with the additional members C<row> and C<col>, which are the row 602manpage), with the additional members C<row> and C<col>, which are the
499and column under the mouse cursor. 603(real, not screen-based) row and column under the mouse cursor.
500 604
501C<on_key_press> additionally receives the string rxvt-unicode would 605C<on_key_press> additionally receives the string rxvt-unicode would
502output, if any, in locale-specific encoding. 606output, if any, in locale-specific encoding.
503 607
504subwindow. 608subwindow.
535our $LIBDIR; 639our $LIBDIR;
536our $RESNAME; 640our $RESNAME;
537our $RESCLASS; 641our $RESCLASS;
538our $RXVTNAME; 642our $RXVTNAME;
539 643
644our $NOCHAR = chr 0xffff;
645
540=head2 Variables in the C<urxvt> Package 646=head2 Variables in the C<urxvt> Package
541 647
542=over 4 648=over 4
543 649
544=item $urxvt::LIBDIR 650=item $urxvt::LIBDIR
595 701
596Using this function has the advantage that its output ends up in the 702Using this function has the advantage that its output ends up in the
597correct place, e.g. on stderr of the connecting urxvtc client. 703correct place, e.g. on stderr of the connecting urxvtc client.
598 704
599Messages have a size limit of 1023 bytes currently. 705Messages have a size limit of 1023 bytes currently.
706
707=item @terms = urxvt::termlist
708
709Returns all urxvt::term objects that exist in this process, regardless of
710wether they are started, being destroyed etc., so be careful. Only term
711objects that have perl extensions attached will be returned (because there
712is no urxvt::term objet associated with others).
600 713
601=item $time = urxvt::NOW 714=item $time = urxvt::NOW
602 715
603Returns the "current time" (as per the event loop). 716Returns the "current time" (as per the event loop).
604 717
662Return the foreground/background colour index, respectively. 775Return the foreground/background colour index, respectively.
663 776
664=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 777=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
665 778
666=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 779=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
780
781=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
667 782
668Replace the foreground/background colour in the rendition mask with the 783Replace the foreground/background colour in the rendition mask with the
669specified one. 784specified one.
670 785
671=item $value = urxvt::GET_CUSTOM $rend 786=item $value = urxvt::GET_CUSTOM $rend
690 unless $msg =~ /\n$/; 805 unless $msg =~ /\n$/;
691 urxvt::warn ($msg); 806 urxvt::warn ($msg);
692 }; 807 };
693} 808}
694 809
810no warnings 'utf8';
811
695my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 812my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
696 813
697sub verbose { 814sub verbose {
698 my ($level, $msg) = @_; 815 my ($level, $msg) = @_;
699 warn "$msg\n" if $level <= $verbosity; 816 warn "$msg\n" if $level <= $verbosity;
715 832
716 open my $fh, "<:raw", $path 833 open my $fh, "<:raw", $path
717 or die "$path: $!"; 834 or die "$path: $!";
718 835
719 my $source = 836 my $source =
720 "package $pkg; use strict; use utf8;\n" 837 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
721 . "#line 1 \"$path\"\n{\n" 838 . "#line 1 \"$path\"\n{\n"
722 . (do { local $/; <$fh> }) 839 . (do { local $/; <$fh> })
723 . "\n};\n1"; 840 . "\n};\n1";
724 841
725 eval $source 842 eval $source
750 $TERM->register_package ($_) for @pkg; 867 $TERM->register_package ($_) for @pkg;
751 } 868 }
752 869
753 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 870 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
754 if ($_ eq "default") { 871 if ($_ eq "default") {
755 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 872 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
756 } elsif (/^-(.*)$/) { 873 } elsif (/^-(.*)$/) {
757 delete $ext_arg{$1}; 874 delete $ext_arg{$1};
758 } elsif (/^([^<]+)<(.*)>$/) { 875 } elsif (/^([^<]+)<(.*)>$/) {
759 push @{ $ext_arg{$1} }, $2; 876 push @{ $ext_arg{$1} }, $2;
760 } else { 877 } else {
761 $ext_arg{$_} ||= []; 878 $ext_arg{$_} ||= [];
762 } 879 }
763 } 880 }
764 881
765 while (my ($ext, $argv) = each %ext_arg) { 882 for my $ext (sort keys %ext_arg) {
766 my @files = grep -f $_, map "$_/$ext", @dirs; 883 my @files = grep -f $_, map "$_/$ext", @dirs;
767 884
768 if (@files) { 885 if (@files) {
769 $TERM->register_package (extension_package $files[0], $argv); 886 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
770 } else { 887 } else {
771 warn "perl extension '$ext' not found in perl library search path\n"; 888 warn "perl extension '$ext' not found in perl library search path\n";
772 } 889 }
773 } 890 }
774 891
805 # clear package 922 # clear package
806 %$TERM = (); 923 %$TERM = ();
807 } 924 }
808 925
809 $retval 926 $retval
927}
928
929sub SET_COLOR($$$) {
930 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
810} 931}
811 932
812# urxvt::term::extension 933# urxvt::term::extension
813 934
814package urxvt::term::extension; 935package urxvt::term::extension;
983hash which defines the environment of the new terminal. 1104hash which defines the environment of the new terminal.
984 1105
985Croaks (and probably outputs an error message) if the new instance 1106Croaks (and probably outputs an error message) if the new instance
986couldn't be created. Returns C<undef> if the new instance didn't 1107couldn't be created. Returns C<undef> if the new instance didn't
987initialise perl, and the terminal object otherwise. The C<init> and 1108initialise perl, and the terminal object otherwise. The C<init> and
988C<start> hooks will be called during this call. 1109C<start> hooks will be called before this call returns, and are free to
1110refer to global data (which is race free).
989 1111
990=cut 1112=cut
991 1113
992sub new { 1114sub new {
993 my ($class, $env, @args) = @_; 1115 my ($class, $env, @args) = @_;
994 1116
1117 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1118 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1119
995 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1120 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
996} 1121}
997 1122
998=item $term->destroy 1123=item $term->destroy
999 1124
1000Destroy the terminal object (close the window, free resources 1125Destroy the terminal object (close the window, free resources
1257 1382
1258Normally its not a good idea to use this function, as programs might be 1383Normally its not a good idea to use this function, as programs might be
1259confused by changes in cursor position or scrolling. Its useful inside a 1384confused by changes in cursor position or scrolling. Its useful inside a
1260C<on_add_lines> hook, though. 1385C<on_add_lines> hook, though.
1261 1386
1387=item $term->scr_change_screen ($screen)
1388
1389Switch to given screen - 0 primary, 1 secondary.
1390
1262=item $term->cmd_parse ($octets) 1391=item $term->cmd_parse ($octets)
1263 1392
1264Similar to C<scr_add_lines>, but the argument must be in the 1393Similar to C<scr_add_lines>, but the argument must be in the
1265locale-specific encoding of the terminal and can contain command sequences 1394locale-specific encoding of the terminal and can contain command sequences
1266(escape codes) that will be interpreted. 1395(escape codes) that will be interpreted.
1276Replaces the event mask of the pty watcher by the given event mask. Can 1405Replaces the event mask of the pty watcher by the given event mask. Can
1277be used to suppress input and output handling to the pty/tty. See the 1406be used to suppress input and output handling to the pty/tty. See the
1278description of C<< urxvt::timer->events >>. Make sure to always restore 1407description of C<< urxvt::timer->events >>. Make sure to always restore
1279the previous value. 1408the previous value.
1280 1409
1410=item $fd = $term->pty_fd
1411
1412Returns the master file descriptor for the pty in use, or C<-1> if no pty
1413is used.
1414
1281=item $windowid = $term->parent 1415=item $windowid = $term->parent
1282 1416
1283Return the window id of the toplevel window. 1417Return the window id of the toplevel window.
1284 1418
1285=item $windowid = $term->vt 1419=item $windowid = $term->vt
1290 1424
1291Adds the specified events to the vt event mask. Useful e.g. when you want 1425Adds the specified events to the vt event mask. Useful e.g. when you want
1292to receive pointer events all the times: 1426to receive pointer events all the times:
1293 1427
1294 $term->vt_emask_add (urxvt::PointerMotionMask); 1428 $term->vt_emask_add (urxvt::PointerMotionMask);
1429
1430=item $term->focus_in
1431
1432=item $term->focus_out
1433
1434=item $term->key_press ($state, $keycode[, $time])
1435
1436=item $term->key_release ($state, $keycode[, $time])
1437
1438Deliver various fake events to to terminal.
1295 1439
1296=item $window_width = $term->width 1440=item $window_width = $term->width
1297 1441
1298=item $window_height = $term->height 1442=item $window_height = $term->height
1299 1443
1349=item $modifiermask = $term->ModNumLockMask 1493=item $modifiermask = $term->ModNumLockMask
1350 1494
1351Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1495Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1352AltGr), the meta key (often Alt) and the num lock key, if applicable. 1496AltGr), the meta key (often Alt) and the num lock key, if applicable.
1353 1497
1498=item $screen = $term->current_screen
1499
1500Returns the currently displayed screen (0 primary, 1 secondary).
1501
1502=item $cursor_is_hidden = $term->hidden_cursor
1503
1504Returns wether the cursor is currently hidden or not.
1505
1354=item $view_start = $term->view_start ([$newvalue]) 1506=item $view_start = $term->view_start ([$newvalue])
1355 1507
1356Returns the row number of the topmost displayed line. Maximum value is 1508Returns the row number of the topmost displayed line. Maximum value is
1357C<0>, which displays the normal terminal contents. Lower values scroll 1509C<0>, which displays the normal terminal contents. Lower values scroll
1358this many lines into the scrollback buffer. 1510this many lines into the scrollback buffer.
1377line, starting at column C<$start_col> (default C<0>), which is useful 1529line, starting at column C<$start_col> (default C<0>), which is useful
1378to replace only parts of a line. The font index in the rendition will 1530to replace only parts of a line. The font index in the rendition will
1379automatically be updated. 1531automatically be updated.
1380 1532
1381C<$text> is in a special encoding: tabs and wide characters that use more 1533C<$text> is in a special encoding: tabs and wide characters that use more
1382than one cell when displayed are padded with urxvt::NOCHAR characters 1534than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1383(C<chr 65535>). Characters with combining characters and other characters 1535characters. Characters with combining characters and other characters that
1384that do not fit into the normal tetx encoding will be replaced with 1536do not fit into the normal tetx encoding will be replaced with characters
1385characters in the private use area. 1537in the private use area.
1386 1538
1387You have to obey this encoding when changing text. The advantage is 1539You have to obey this encoding when changing text. The advantage is
1388that C<substr> and similar functions work on screen cells and not on 1540that C<substr> and similar functions work on screen cells and not on
1389characters. 1541characters.
1390 1542
1537=item $string = $term->special_decode $text 1689=item $string = $term->special_decode $text
1538 1690
1539Converts rxvt-unicodes text reprsentation into a perl string. See 1691Converts rxvt-unicodes text reprsentation into a perl string. See
1540C<< $term->ROW_t >> for details. 1692C<< $term->ROW_t >> for details.
1541 1693
1542=item $success = $term->grab_button ($button, $modifiermask) 1694=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1543 1695
1696=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1697
1544Registers a synchronous button grab. See the XGrabButton manpage. 1698Register/unregister a synchronous button grab. See the XGrabButton
1699manpage.
1545 1700
1546=item $success = $term->grab ($eventtime[, $sync]) 1701=item $success = $term->grab ($eventtime[, $sync])
1547 1702
1548Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1703Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1549synchronous (C<$sync> is true). Also remembers the grab timestampe. 1704synchronous (C<$sync> is true). Also remembers the grab timestampe.
1564=item $term->ungrab 1719=item $term->ungrab
1565 1720
1566Calls XUngrab for the most recent grab. Is called automatically on 1721Calls XUngrab for the most recent grab. Is called automatically on
1567evaluation errors, as it is better to lose the grab in the error case as 1722evaluation errors, as it is better to lose the grab in the error case as
1568the session. 1723the session.
1724
1725=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1726
1727=item $atom_name = $term->XGetAtomName ($atom)
1728
1729=item @atoms = $term->XListProperties ($window)
1730
1731=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1732
1733=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1734
1735=item $term->XDeleteProperty ($window, $property)
1736
1737=item $window = $term->DefaultRootWindow
1738
1739=item $term->XReparentWindow ($window, $parent, [$x, $y])
1740
1741=item $term->XMapWindow ($window)
1742
1743=item $term->XUnmapWindow ($window)
1744
1745=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1746
1747=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1748
1749=item $term->XChangeInput ($window, $add_events[, $del_events])
1750
1751Various X or X-related functions. The C<$term> object only serves as
1752the source of the display, otherwise those functions map more-or-less
1753directory onto the X functions of the same name.
1569 1754
1570=back 1755=back
1571 1756
1572=cut 1757=cut
1573 1758
1637 my ($self, $text, $cb) = @_; 1822 my ($self, $text, $cb) = @_;
1638 1823
1639 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1824 $self->add_item ({ type => "button", text => $text, activate => $cb});
1640} 1825}
1641 1826
1642=item $popup->add_toggle ($text, $cb, $initial_value) 1827=item $popup->add_toggle ($text, $initial_value, $cb)
1643 1828
1644Adds a toggle/checkbox item to the popup. Teh callback gets called 1829Adds a toggle/checkbox item to the popup. The callback gets called
1645whenever it gets toggled, with a boolean indicating its value as its first 1830whenever it gets toggled, with a boolean indicating its new value as its
1646argument. 1831first argument.
1647 1832
1648=cut 1833=cut
1649 1834
1650sub add_toggle { 1835sub add_toggle {
1651 my ($self, $text, $cb, $value) = @_; 1836 my ($self, $text, $value, $cb) = @_;
1652 1837
1653 my $item; $item = { 1838 my $item; $item = {
1654 type => "button", 1839 type => "button",
1655 text => " $text", 1840 text => " $text",
1656 value => $value, 1841 value => $value,

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines