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.131 by root, Sun Jan 29 20:51:28 2006 UTC vs.
Revision 1.134 by root, Sat Feb 11 02:31:13 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
… …
205 222
206Clicking a button will activate that tab. Pressing B<Shift-Left> and 223Clicking 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, 224B<Shift-Right> will switch to the tab left or right of the current one,
208while B<Shift-Down> creates a new tab. 225while B<Shift-Down> creates a new tab.
209 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.
238
210=item mark-urls 239=item mark-urls
211 240
212Uses 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
213make them clickable. When middle-clicked, the program specified in the 242make them clickable. When middle-clicked, the program specified in the
214resource C<urlLauncher> (default C<x-www-browser>) will be started with 243resource C<urlLauncher> (default C<x-www-browser>) will be started with
… …
523a C<perl:string> action bound to a key, see description of the B<keysym> 552a C<perl:string> action bound to a key, see description of the B<keysym>
524resource in the @@RXVT_NAME@@(1) manpage). 553resource in the @@RXVT_NAME@@(1) manpage).
525 554
526The event is simply the action string. This interface is assumed to change 555The event is simply the action string. This interface is assumed to change
527slightly in the future. 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.
528 563
529=item on_x_event $term, $event 564=item on_x_event $term, $event
530 565
531Called 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
532windows). Should only be used as a last resort. Most event structure 567windows). Should only be used as a last resort. Most event structure
… …
740Return the foreground/background colour index, respectively. 775Return the foreground/background colour index, respectively.
741 776
742=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 777=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
743 778
744=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
745 782
746Replace the foreground/background colour in the rendition mask with the 783Replace the foreground/background colour in the rendition mask with the
747specified one. 784specified one.
748 785
749=item $value = urxvt::GET_CUSTOM $rend 786=item $value = urxvt::GET_CUSTOM $rend
… …
840 } else { 877 } else {
841 $ext_arg{$_} ||= []; 878 $ext_arg{$_} ||= [];
842 } 879 }
843 } 880 }
844 881
845 while (my ($ext, $argv) = each %ext_arg) { 882 for my $ext (sort keys %ext_arg) {
846 my @files = grep -f $_, map "$_/$ext", @dirs; 883 my @files = grep -f $_, map "$_/$ext", @dirs;
847 884
848 if (@files) { 885 if (@files) {
849 $TERM->register_package (extension_package $files[0], $argv); 886 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
850 } else { 887 } else {
851 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";
852 } 889 }
853 } 890 }
854 891
… …
885 # clear package 922 # clear package
886 %$TERM = (); 923 %$TERM = ();
887 } 924 }
888 925
889 $retval 926 $retval
927}
928
929sub SET_COLOR($$$) {
930 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
890} 931}
891 932
892# urxvt::term::extension 933# urxvt::term::extension
893 934
894package urxvt::term::extension; 935package urxvt::term::extension;
… …
1384Adds 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
1385to receive pointer events all the times: 1426to receive pointer events all the times:
1386 1427
1387 $term->vt_emask_add (urxvt::PointerMotionMask); 1428 $term->vt_emask_add (urxvt::PointerMotionMask);
1388 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.
1439
1389=item $window_width = $term->width 1440=item $window_width = $term->width
1390 1441
1391=item $window_height = $term->height 1442=item $window_height = $term->height
1392 1443
1393=item $font_width = $term->fwidth 1444=item $font_width = $term->fwidth
… …
1771 my ($self, $text, $cb) = @_; 1822 my ($self, $text, $cb) = @_;
1772 1823
1773 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1824 $self->add_item ({ type => "button", text => $text, activate => $cb});
1774} 1825}
1775 1826
1776=item $popup->add_toggle ($text, $cb, $initial_value) 1827=item $popup->add_toggle ($text, $initial_value, $cb)
1777 1828
1778Adds a toggle/checkbox item to the popup. Teh callback gets called 1829Adds a toggle/checkbox item to the popup. The callback gets called
1779whenever 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
1780argument. 1831first argument.
1781 1832
1782=cut 1833=cut
1783 1834
1784sub add_toggle { 1835sub add_toggle {
1785 my ($self, $text, $cb, $value) = @_; 1836 my ($self, $text, $value, $cb) = @_;
1786 1837
1787 my $item; $item = { 1838 my $item; $item = {
1788 type => "button", 1839 type => "button",
1789 text => " $text", 1840 text => " $text",
1790 value => $value, 1841 value => $value,

Diff Legend

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