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.130 by root, Wed Jan 25 15:32:48 2006 UTC vs.
Revision 1.133 by root, Mon Feb 6 06:14:08 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
667Using this function has the advantage that its output ends up in the 696Using this function has the advantage that its output ends up in the
668correct place, e.g. on stderr of the connecting urxvtc client. 697correct place, e.g. on stderr of the connecting urxvtc client.
669 698
670Messages have a size limit of 1023 bytes currently. 699Messages have a size limit of 1023 bytes currently.
671 700
701=item @terms = urxvt::termlist
702
703Returns all urxvt::term objects that exist in this process, regardless of
704wether they are started, being destroyed etc., so be careful. Only term
705objects that have perl extensions attached will be returned (because there
706is no urxvt::term objet associated with others).
707
672=item $time = urxvt::NOW 708=item $time = urxvt::NOW
673 709
674Returns the "current time" (as per the event loop). 710Returns the "current time" (as per the event loop).
675 711
676=item urxvt::CurrentTime 712=item urxvt::CurrentTime
733Return the foreground/background colour index, respectively. 769Return the foreground/background colour index, respectively.
734 770
735=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 771=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
736 772
737=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 773=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
774
775=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
738 776
739Replace the foreground/background colour in the rendition mask with the 777Replace the foreground/background colour in the rendition mask with the
740specified one. 778specified one.
741 779
742=item $value = urxvt::GET_CUSTOM $rend 780=item $value = urxvt::GET_CUSTOM $rend
833 } else { 871 } else {
834 $ext_arg{$_} ||= []; 872 $ext_arg{$_} ||= [];
835 } 873 }
836 } 874 }
837 875
838 while (my ($ext, $argv) = each %ext_arg) { 876 for my $ext (sort keys %ext_arg) {
839 my @files = grep -f $_, map "$_/$ext", @dirs; 877 my @files = grep -f $_, map "$_/$ext", @dirs;
840 878
841 if (@files) { 879 if (@files) {
842 $TERM->register_package (extension_package $files[0], $argv); 880 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
843 } else { 881 } else {
844 warn "perl extension '$ext' not found in perl library search path\n"; 882 warn "perl extension '$ext' not found in perl library search path\n";
845 } 883 }
846 } 884 }
847 885
878 # clear package 916 # clear package
879 %$TERM = (); 917 %$TERM = ();
880 } 918 }
881 919
882 $retval 920 $retval
921}
922
923sub SET_COLOR($$$) {
924 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
883} 925}
884 926
885# urxvt::term::extension 927# urxvt::term::extension
886 928
887package urxvt::term::extension; 929package urxvt::term::extension;
1056hash which defines the environment of the new terminal. 1098hash which defines the environment of the new terminal.
1057 1099
1058Croaks (and probably outputs an error message) if the new instance 1100Croaks (and probably outputs an error message) if the new instance
1059couldn't be created. Returns C<undef> if the new instance didn't 1101couldn't be created. Returns C<undef> if the new instance didn't
1060initialise perl, and the terminal object otherwise. The C<init> and 1102initialise perl, and the terminal object otherwise. The C<init> and
1061C<start> hooks will be called during this call. 1103C<start> hooks will be called before this call returns, and are free to
1104refer to global data (which is race free).
1062 1105
1063=cut 1106=cut
1064 1107
1065sub new { 1108sub new {
1066 my ($class, $env, @args) = @_; 1109 my ($class, $env, @args) = @_;
1067 1110
1111 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1112 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1113
1068 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1114 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1069} 1115}
1070 1116
1071=item $term->destroy 1117=item $term->destroy
1072 1118
1073Destroy the terminal object (close the window, free resources 1119Destroy the terminal object (close the window, free resources
1373Adds the specified events to the vt event mask. Useful e.g. when you want 1419Adds the specified events to the vt event mask. Useful e.g. when you want
1374to receive pointer events all the times: 1420to receive pointer events all the times:
1375 1421
1376 $term->vt_emask_add (urxvt::PointerMotionMask); 1422 $term->vt_emask_add (urxvt::PointerMotionMask);
1377 1423
1424=item $term->focus_in
1425
1426=item $term->focus_out
1427
1428=item $term->key_press ($state, $keycode[, $time])
1429
1430=item $term->key_release ($state, $keycode[, $time])
1431
1432Deliver various fake events to to terminal.
1433
1378=item $window_width = $term->width 1434=item $window_width = $term->width
1379 1435
1380=item $window_height = $term->height 1436=item $window_height = $term->height
1381 1437
1382=item $font_width = $term->fwidth 1438=item $font_width = $term->fwidth
1627=item $string = $term->special_decode $text 1683=item $string = $term->special_decode $text
1628 1684
1629Converts rxvt-unicodes text reprsentation into a perl string. See 1685Converts rxvt-unicodes text reprsentation into a perl string. See
1630C<< $term->ROW_t >> for details. 1686C<< $term->ROW_t >> for details.
1631 1687
1632=item $success = $term->grab_button ($button, $modifiermask) 1688=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1633 1689
1690=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1691
1634Registers a synchronous button grab. See the XGrabButton manpage. 1692Register/unregister a synchronous button grab. See the XGrabButton
1693manpage.
1635 1694
1636=item $success = $term->grab ($eventtime[, $sync]) 1695=item $success = $term->grab ($eventtime[, $sync])
1637 1696
1638Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1697Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1639synchronous (C<$sync> is true). Also remembers the grab timestampe. 1698synchronous (C<$sync> is true). Also remembers the grab timestampe.
1757 my ($self, $text, $cb) = @_; 1816 my ($self, $text, $cb) = @_;
1758 1817
1759 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1818 $self->add_item ({ type => "button", text => $text, activate => $cb});
1760} 1819}
1761 1820
1762=item $popup->add_toggle ($text, $cb, $initial_value) 1821=item $popup->add_toggle ($text, $initial_value, $cb)
1763 1822
1764Adds a toggle/checkbox item to the popup. Teh callback gets called 1823Adds a toggle/checkbox item to the popup. The callback gets called
1765whenever it gets toggled, with a boolean indicating its value as its first 1824whenever it gets toggled, with a boolean indicating its new value as its
1766argument. 1825first argument.
1767 1826
1768=cut 1827=cut
1769 1828
1770sub add_toggle { 1829sub add_toggle {
1771 my ($self, $text, $cb, $value) = @_; 1830 my ($self, $text, $value, $cb) = @_;
1772 1831
1773 my $item; $item = { 1832 my $item; $item = {
1774 type => "button", 1833 type => "button",
1775 text => " $text", 1834 text => " $text",
1776 value => $value, 1835 value => $value,

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines