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.131 by root, Sun Jan 29 20:51:28 2006 UTC

… …
242 242
243=item digital-clock 243=item digital-clock
244 244
245Displays a digital clock using the built-in overlay. 245Displays a digital clock using the built-in overlay.
246 246
247=item remote-selection 247=item remote-clipboard
248 248
249Somewhat of a misnomer, this extension adds two menu entries to the 249Somewhat of a misnomer, this extension adds two menu entries to the
250selection popup that allows one ti run external commands to store the 250selection popup that allows one ti run external commands to store the
251selection somewhere and fetch it again. 251selection somewhere and fetch it again.
252 252
… …
515 515
516=item on_refresh_end $term 516=item on_refresh_end $term
517 517
518Called just after the screen gets redrawn. See C<on_refresh_begin>. 518Called just after the screen gets redrawn. See C<on_refresh_begin>.
519 519
520=item on_keyboard_command $term, $string 520=item on_user_command $term, $string
521 521
522Called whenever the user presses a key combination that has a 522Called 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> 523a C<perl:string> action bound to a key, see description of the B<keysym>
524resource in the @@RXVT_NAME@@(1) manpage). 524resource in the @@RXVT_NAME@@(1) manpage).
525
526The event is simply the action string. This interface is assumed to change
527slightly in the future.
525 528
526=item on_x_event $term, $event 529=item on_x_event $term, $event
527 530
528Called on every X event received on the vt window (and possibly other 531Called on every X event received on the vt window (and possibly other
529windows). Should only be used as a last resort. Most event structure 532windows). Should only be used as a last resort. Most event structure
… …
663 666
664Using this function has the advantage that its output ends up in the 667Using this function has the advantage that its output ends up in the
665correct place, e.g. on stderr of the connecting urxvtc client. 668correct place, e.g. on stderr of the connecting urxvtc client.
666 669
667Messages have a size limit of 1023 bytes currently. 670Messages have a size limit of 1023 bytes currently.
671
672=item @terms = urxvt::termlist
673
674Returns all urxvt::term objects that exist in this process, regardless of
675wether they are started, being destroyed etc., so be careful. Only term
676objects that have perl extensions attached will be returned (because there
677is no urxvt::term objet associated with others).
668 678
669=item $time = urxvt::NOW 679=item $time = urxvt::NOW
670 680
671Returns the "current time" (as per the event loop). 681Returns the "current time" (as per the event loop).
672 682
… …
1053hash which defines the environment of the new terminal. 1063hash which defines the environment of the new terminal.
1054 1064
1055Croaks (and probably outputs an error message) if the new instance 1065Croaks (and probably outputs an error message) if the new instance
1056couldn't be created. Returns C<undef> if the new instance didn't 1066couldn't be created. Returns C<undef> if the new instance didn't
1057initialise perl, and the terminal object otherwise. The C<init> and 1067initialise perl, and the terminal object otherwise. The C<init> and
1058C<start> hooks will be called during this call. 1068C<start> hooks will be called before this call returns, and are free to
1069refer to global data (which is race free).
1059 1070
1060=cut 1071=cut
1061 1072
1062sub new { 1073sub new {
1063 my ($class, $env, @args) = @_; 1074 my ($class, $env, @args) = @_;
1064 1075
1076 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1077 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1078
1065 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1079 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1066} 1080}
1067 1081
1068=item $term->destroy 1082=item $term->destroy
1069 1083
1070Destroy the terminal object (close the window, free resources 1084Destroy the terminal object (close the window, free resources
… …
1624=item $string = $term->special_decode $text 1638=item $string = $term->special_decode $text
1625 1639
1626Converts rxvt-unicodes text reprsentation into a perl string. See 1640Converts rxvt-unicodes text reprsentation into a perl string. See
1627C<< $term->ROW_t >> for details. 1641C<< $term->ROW_t >> for details.
1628 1642
1629=item $success = $term->grab_button ($button, $modifiermask) 1643=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1630 1644
1645=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1646
1631Registers a synchronous button grab. See the XGrabButton manpage. 1647Register/unregister a synchronous button grab. See the XGrabButton
1648manpage.
1632 1649
1633=item $success = $term->grab ($eventtime[, $sync]) 1650=item $success = $term->grab ($eventtime[, $sync])
1634 1651
1635Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1652Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1636synchronous (C<$sync> is true). Also remembers the grab timestampe. 1653synchronous (C<$sync> is true). Also remembers the grab timestampe.

Diff Legend

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