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.129 by root, Wed Jan 25 15:11:31 2006 UTC vs.
Revision 1.132 by root, Mon Feb 6 05:40:15 2006 UTC

205 205
206Clicking a button will activate that tab. Pressing B<Shift-Left> and 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, 207B<Shift-Right> will switch to the tab left or right of the current one,
208while B<Shift-Down> creates a new tab. 208while B<Shift-Down> creates a new tab.
209 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.
221
210=item mark-urls 222=item mark-urls
211 223
212Uses 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
213make them clickable. When middle-clicked, the program specified in the 225make them clickable. When middle-clicked, the program specified in the
214resource C<urlLauncher> (default C<x-www-browser>) will be started with 226resource C<urlLauncher> (default C<x-www-browser>) will be started with
242 254
243=item digital-clock 255=item digital-clock
244 256
245Displays a digital clock using the built-in overlay. 257Displays a digital clock using the built-in overlay.
246 258
247=item remote-selection 259=item remote-clipboard
248 260
249Somewhat of a misnomer, this extension adds two menu entries to the 261Somewhat of a misnomer, this extension adds two menu entries to the
250selection popup that allows one ti run external commands to store the 262selection popup that allows one ti run external commands to store the
251selection somewhere and fetch it again. 263selection somewhere and fetch it again.
252 264
515 527
516=item on_refresh_end $term 528=item on_refresh_end $term
517 529
518Called just after the screen gets redrawn. See C<on_refresh_begin>. 530Called just after the screen gets redrawn. See C<on_refresh_begin>.
519 531
520=item on_keyboard_command $term, $string 532=item on_user_command $term, $string
521 533
522Called whenever the user presses a key combination that has a 534Called whenever the a user-configured event is being activated (e.g. via
523C<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>
524resource 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.
525 540
526=item on_x_event $term, $event 541=item on_x_event $term, $event
527 542
528Called 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
529windows). Should only be used as a last resort. Most event structure 544windows). Should only be used as a last resort. Most event structure
664Using 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
665correct place, e.g. on stderr of the connecting urxvtc client. 680correct place, e.g. on stderr of the connecting urxvtc client.
666 681
667Messages have a size limit of 1023 bytes currently. 682Messages have a size limit of 1023 bytes currently.
668 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).
690
669=item $time = urxvt::NOW 691=item $time = urxvt::NOW
670 692
671Returns the "current time" (as per the event loop). 693Returns the "current time" (as per the event loop).
672 694
673=item urxvt::CurrentTime 695=item urxvt::CurrentTime
730Return the foreground/background colour index, respectively. 752Return the foreground/background colour index, respectively.
731 753
732=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 754=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
733 755
734=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
735 759
736Replace the foreground/background colour in the rendition mask with the 760Replace the foreground/background colour in the rendition mask with the
737specified one. 761specified one.
738 762
739=item $value = urxvt::GET_CUSTOM $rend 763=item $value = urxvt::GET_CUSTOM $rend
877 } 901 }
878 902
879 $retval 903 $retval
880} 904}
881 905
906sub SET_COLOR($$$) {
907 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
908}
909
882# urxvt::term::extension 910# urxvt::term::extension
883 911
884package urxvt::term::extension; 912package urxvt::term::extension;
885 913
886sub enable { 914sub enable {
1053hash which defines the environment of the new terminal. 1081hash which defines the environment of the new terminal.
1054 1082
1055Croaks (and probably outputs an error message) if the new instance 1083Croaks (and probably outputs an error message) if the new instance
1056couldn'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
1057initialise perl, and the terminal object otherwise. The C<init> and 1085initialise perl, and the terminal object otherwise. The C<init> and
1058C<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).
1059 1088
1060=cut 1089=cut
1061 1090
1062sub new { 1091sub new {
1063 my ($class, $env, @args) = @_; 1092 my ($class, $env, @args) = @_;
1064 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
1065 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1097 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1066} 1098}
1067 1099
1068=item $term->destroy 1100=item $term->destroy
1069 1101
1070Destroy the terminal object (close the window, free resources 1102Destroy the terminal object (close the window, free resources
1370Adds 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
1371to receive pointer events all the times: 1403to receive pointer events all the times:
1372 1404
1373 $term->vt_emask_add (urxvt::PointerMotionMask); 1405 $term->vt_emask_add (urxvt::PointerMotionMask);
1374 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.
1416
1375=item $window_width = $term->width 1417=item $window_width = $term->width
1376 1418
1377=item $window_height = $term->height 1419=item $window_height = $term->height
1378 1420
1379=item $font_width = $term->fwidth 1421=item $font_width = $term->fwidth
1624=item $string = $term->special_decode $text 1666=item $string = $term->special_decode $text
1625 1667
1626Converts rxvt-unicodes text reprsentation into a perl string. See 1668Converts rxvt-unicodes text reprsentation into a perl string. See
1627C<< $term->ROW_t >> for details. 1669C<< $term->ROW_t >> for details.
1628 1670
1629=item $success = $term->grab_button ($button, $modifiermask) 1671=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1630 1672
1673=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1674
1631Registers a synchronous button grab. See the XGrabButton manpage. 1675Register/unregister a synchronous button grab. See the XGrabButton
1676manpage.
1632 1677
1633=item $success = $term->grab ($eventtime[, $sync]) 1678=item $success = $term->grab ($eventtime[, $sync])
1634 1679
1635Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1680Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1636synchronous (C<$sync> is true). Also remembers the grab timestampe. 1681synchronous (C<$sync> is true). Also remembers the grab timestampe.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines