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.132 by root, Mon Feb 6 05:40:15 2006 UTC vs.
Revision 1.137 by root, Sat Mar 4 20:17:52 2006 UTC

… …
94=item option-popup (enabled by default) 94=item option-popup (enabled by default)
95 95
96Binds 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
97runtime. 97runtime.
98 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
99=item selection-popup (enabled by default) 116=item selection-popup (enabled by default)
100 117
101Binds 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
102text into various other formats/action (such as uri unescaping, perl 119text into various other formats/action (such as uri unescaping, perl
103evaluation, web-browser starting etc.), depending on content. 120evaluation, web-browser starting etc.), depending on content.
104 121
105Other extensions can extend this popup menu by pushing a code reference 122Other extensions can extend this popup menu by pushing a code reference
106onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
107popup is displayed. 124popup is being displayed.
108 125
109It'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
110is 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.
111It 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
112string 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
… …
136additionally stores the first match in the current line into the primary 153additionally stores the first match in the current line into the primary
137selection. 154selection.
138 155
139=item readline (enabled by default) 156=item readline (enabled by default)
140 157
141A support package that tries to make editing with readline easier. At the 158A support package that tries to make editing with readline easier. At
142moment, it reacts to clicking with the left mouse button by trying to 159the moment, it reacts to clicking shift-left mouse button by trying to
143move the text cursor to this position. It does so by generating as many 160move 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 161cursor-left or cursor-right keypresses as required (the this only works
145for programs that correctly support wide characters). 162for programs that correctly support wide characters).
146 163
147To avoid too many false positives, this is only done when: 164To avoid too many false positives, this is only done when:
… …
476 493
477It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 494It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
478$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 495$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
479number of lines that will be in the scrollback buffer. 496number of lines that will be in the scrollback buffer.
480 497
498=item on_osc_seq $term, $op, $args
499
500Called on every OSC sequence and can be used to suppress it or modify its
501behaviour. The default should be to return an empty list. A true value
502suppresses execution of the request completely. Make sure you don't get
503confused by recursive invocations when you output an osc sequence within
504this callback.
505
506C<on_osc_seq_perl> should be used for new behaviour.
507
481=item on_osc_seq $term, $string 508=item on_osc_seq_perl $term, $string
482 509
483Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 510Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
484operating system command) is processed. Cursor position and other state 511operating system command) is processed. Cursor position and other state
485information is up-to-date when this happens. For interoperability, the 512information is up-to-date when this happens. For interoperability, the
486string should start with the extension name and a colon, to distinguish 513string should start with the extension name and a colon, to distinguish
… …
535a C<perl:string> action bound to a key, see description of the B<keysym> 562a C<perl:string> action bound to a key, see description of the B<keysym>
536resource in the @@RXVT_NAME@@(1) manpage). 563resource in the @@RXVT_NAME@@(1) manpage).
537 564
538The event is simply the action string. This interface is assumed to change 565The event is simply the action string. This interface is assumed to change
539slightly in the future. 566slightly in the future.
567
568=item on_resize_all_windows $tern, $new_width, $new_height
569
570Called just after the new window size has been calculcated, but before
571windows are actually being resized or hints are being set. If this hook
572returns TRUE, setting of the window hints is being skipped.
540 573
541=item on_x_event $term, $event 574=item on_x_event $term, $event
542 575
543Called on every X event received on the vt window (and possibly other 576Called on every X event received on the vt window (and possibly other
544windows). Should only be used as a last resort. Most event structure 577windows). Should only be used as a last resort. Most event structure
… …
854 } else { 887 } else {
855 $ext_arg{$_} ||= []; 888 $ext_arg{$_} ||= [];
856 } 889 }
857 } 890 }
858 891
859 while (my ($ext, $argv) = each %ext_arg) { 892 for my $ext (sort keys %ext_arg) {
860 my @files = grep -f $_, map "$_/$ext", @dirs; 893 my @files = grep -f $_, map "$_/$ext", @dirs;
861 894
862 if (@files) { 895 if (@files) {
863 $TERM->register_package (extension_package $files[0], $argv); 896 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
864 } else { 897 } else {
865 warn "perl extension '$ext' not found in perl library search path\n"; 898 warn "perl extension '$ext' not found in perl library search path\n";
866 } 899 }
867 } 900 }
868 901
… …
1451=item $env = $term->env 1484=item $env = $term->env
1452 1485
1453Returns a copy of the environment in effect for the terminal as a hashref 1486Returns a copy of the environment in effect for the terminal as a hashref
1454similar to C<\%ENV>. 1487similar to C<\%ENV>.
1455 1488
1489=item @envv = $term->envv
1490
1491Returns the environment as array of strings of the form C<VAR=VALUE>.
1492
1493=item @argv = $term->argv
1494
1495Return the argument vector as this terminal, similar to @ARGV, but
1496includes the program name as first element.
1497
1456=cut 1498=cut
1457 1499
1458sub env { 1500sub env {
1459 if (my $env = $_[0]->_env) {
1460 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1501 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1461 } else {
1462 +{ %ENV }
1463 }
1464} 1502}
1465 1503
1466=item $modifiermask = $term->ModLevel3Mask 1504=item $modifiermask = $term->ModLevel3Mask
1467 1505
1468=item $modifiermask = $term->ModMetaMask 1506=item $modifiermask = $term->ModMetaMask
… …
1799 my ($self, $text, $cb) = @_; 1837 my ($self, $text, $cb) = @_;
1800 1838
1801 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1839 $self->add_item ({ type => "button", text => $text, activate => $cb});
1802} 1840}
1803 1841
1804=item $popup->add_toggle ($text, $cb, $initial_value) 1842=item $popup->add_toggle ($text, $initial_value, $cb)
1805 1843
1806Adds a toggle/checkbox item to the popup. Teh callback gets called 1844Adds a toggle/checkbox item to the popup. The callback gets called
1807whenever it gets toggled, with a boolean indicating its value as its first 1845whenever it gets toggled, with a boolean indicating its new value as its
1808argument. 1846first argument.
1809 1847
1810=cut 1848=cut
1811 1849
1812sub add_toggle { 1850sub add_toggle {
1813 my ($self, $text, $cb, $value) = @_; 1851 my ($self, $text, $value, $cb) = @_;
1814 1852
1815 my $item; $item = { 1853 my $item; $item = {
1816 type => "button", 1854 type => "button",
1817 text => " $text", 1855 text => " $text",
1818 value => $value, 1856 value => $value,

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines