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.186 by sf-exg, Fri Jul 23 17:50:41 2010 UTC vs.
Revision 1.193 by sf-exg, Wed Jun 29 15:30:28 2011 UTC

… …
393 393
394Displays a very simple digital clock in the upper right corner of the 394Displays a very simple digital clock in the upper right corner of the
395window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
396overlays or changes. 396overlays or changes.
397 397
398=item confirm-paste
399
400Displays a confirmation dialog when a paste containing at least a full
401line is detected.
402
398=back 403=back
399 404
400=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
401 406
402=head2 General API Considerations 407=head2 General API Considerations
… …
436=back 441=back
437 442
438=head2 Extension Objects 443=head2 Extension Objects
439 444
440Every perl extension is a perl class. A separate perl object is created 445Every perl extension is a perl class. A separate perl object is created
441for each terminal, and each terminal has its own set of extenion objects, 446for each terminal, and each terminal has its own set of extension objects,
442which are passed as the first parameter to hooks. So extensions can use 447which are passed as the first parameter to hooks. So extensions can use
443their C<$self> object without having to think about clashes with other 448their C<$self> object without having to think about clashes with other
444extensions or other terminals, with the exception of methods and members 449extensions or other terminals, with the exception of methods and members
445that begin with an underscore character C<_>: these are reserved for 450that begin with an underscore character C<_>: these are reserved for
446internal use. 451internal use.
… …
609 614
610=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
611 616
612Called whenever some data is written to the tty/pty and can be used to 617Called whenever some data is written to the tty/pty and can be used to
613suppress or filter tty input. 618suppress or filter tty input.
619
620=item on_tt_paste $term, $octets
621
622Called whenever text is about to be pasted, with the text as argument. You
623can filter/change and paste the text yourself by returning a true value
624and calling C<< $term->tt_paste >> yourself. C<$octets> is
625locale-encoded.
614 626
615=item on_line_update $term, $row 627=item on_line_update $term, $row
616 628
617Called whenever a line was updated or changed. Can be used to filter 629Called whenever a line was updated or changed. Can be used to filter
618screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
… …
786 798
787=over 4 799=over 4
788 800
789=item urxvt::fatal $errormessage 801=item urxvt::fatal $errormessage
790 802
791Fatally aborts execution with the given error message. Avoid at all 803Fatally aborts execution with the given error message (which should
792costs! The only time this is acceptable is when the terminal process 804include a trailing newline). Avoid at all costs! The only time this
793starts up. 805is acceptable (and useful) is in the init hook, where it prevents the
806terminal from starting up.
794 807
795=item urxvt::warn $string 808=item urxvt::warn $string
796 809
797Calls C<rxvt_warn> with the given string which should not include a 810Calls C<rxvt_warn> with the given string which should include a trailing
798newline. The module also overwrites the C<warn> builtin with a function 811newline. The module also overwrites the C<warn> builtin with a function
799that calls this function. 812that calls this function.
800 813
801Using this function has the advantage that its output ends up in the 814Using this function has the advantage that its output ends up in the
802correct place, e.g. on stderr of the connecting urxvtc client. 815correct place, e.g. on stderr of the connecting urxvtc client.
… …
806=item @terms = urxvt::termlist 819=item @terms = urxvt::termlist
807 820
808Returns all urxvt::term objects that exist in this process, regardless of 821Returns all urxvt::term objects that exist in this process, regardless of
809whether they are started, being destroyed etc., so be careful. Only term 822whether they are started, being destroyed etc., so be careful. Only term
810objects that have perl extensions attached will be returned (because there 823objects that have perl extensions attached will be returned (because there
811is no urxvt::term objet associated with others). 824is no urxvt::term object associated with others).
812 825
813=item $time = urxvt::NOW 826=item $time = urxvt::NOW
814 827
815Returns the "current time" (as per the event loop). 828Returns the "current time" (as per the event loop).
816 829
… …
859 872
860=item $rend = urxvt::OVERLAY_RSTYLE 873=item $rend = urxvt::OVERLAY_RSTYLE
861 874
862Return the rendition mask used for overlays by default. 875Return the rendition mask used for overlays by default.
863 876
864=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 877=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
878urxvt::RS_RVid, urxvt::RS_Uline
865 879
866Return the bit that enabled bold, italic, blink, reverse-video and 880Return the bit that enabled bold, italic, blink, reverse-video and
867underline, respectively. To enable such a style, just logically OR it into 881underline, respectively. To enable such a style, just logically OR it into
868the bitset. 882the bitset.
869 883
… …
1549 1563
1550Write the octets given in C<$octets> to the tty (i.e. as program input). To 1564Write the octets given in C<$octets> to the tty (i.e. as program input). To
1551pass characters instead of octets, you should convert your strings first 1565pass characters instead of octets, you should convert your strings first
1552to the locale-specific encoding using C<< $term->locale_encode >>. 1566to the locale-specific encoding using C<< $term->locale_encode >>.
1553 1567
1568=item $term->tt_paste ($octets)
1569
1570Write the octets given in C<$octets> to the tty as a paste, converting NL to
1571CR and bracketing the data with control sequences if bracketed paste mode
1572is set.
1573
1554=item $old_events = $term->pty_ev_events ([$new_events]) 1574=item $old_events = $term->pty_ev_events ([$new_events])
1555 1575
1556Replaces the event mask of the pty watcher by the given event mask. Can 1576Replaces the event mask of the pty watcher by the given event mask. Can
1557be used to suppress input and output handling to the pty/tty. See the 1577be used to suppress input and output handling to the pty/tty. See the
1558description of C<< urxvt::timer->events >>. Make sure to always restore 1578description of C<< urxvt::timer->events >>. Make sure to always restore
… …
2231 2251
2232=back 2252=back
2233 2253
2234=head1 AUTHOR 2254=head1 AUTHOR
2235 2255
2236 Marc Lehmann <pcg@goof.com> 2256 Marc Lehmann <schmorp@schmorp.de>
2237 http://software.schmorp.de/pkg/rxvt-unicode 2257 http://software.schmorp.de/pkg/rxvt-unicode
2238 2258
2239=cut 2259=cut
2240 2260
22411 22611

Diff Legend

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