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.187 by sf-exg, Sat Jul 24 10:20:26 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.
… …
793 798
794=over 4 799=over 4
795 800
796=item urxvt::fatal $errormessage 801=item urxvt::fatal $errormessage
797 802
798Fatally aborts execution with the given error message. Avoid at all 803Fatally aborts execution with the given error message (which should
799costs! The only time this is acceptable is when the terminal process 804include a trailing newline). Avoid at all costs! The only time this
800starts up. 805is acceptable (and useful) is in the init hook, where it prevents the
806terminal from starting up.
801 807
802=item urxvt::warn $string 808=item urxvt::warn $string
803 809
804Calls 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
805newline. The module also overwrites the C<warn> builtin with a function 811newline. The module also overwrites the C<warn> builtin with a function
806that calls this function. 812that calls this function.
807 813
808Using 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
809correct place, e.g. on stderr of the connecting urxvtc client. 815correct place, e.g. on stderr of the connecting urxvtc client.
… …
813=item @terms = urxvt::termlist 819=item @terms = urxvt::termlist
814 820
815Returns all urxvt::term objects that exist in this process, regardless of 821Returns all urxvt::term objects that exist in this process, regardless of
816whether they are started, being destroyed etc., so be careful. Only term 822whether they are started, being destroyed etc., so be careful. Only term
817objects that have perl extensions attached will be returned (because there 823objects that have perl extensions attached will be returned (because there
818is no urxvt::term objet associated with others). 824is no urxvt::term object associated with others).
819 825
820=item $time = urxvt::NOW 826=item $time = urxvt::NOW
821 827
822Returns the "current time" (as per the event loop). 828Returns the "current time" (as per the event loop).
823 829
… …
866 872
867=item $rend = urxvt::OVERLAY_RSTYLE 873=item $rend = urxvt::OVERLAY_RSTYLE
868 874
869Return the rendition mask used for overlays by default. 875Return the rendition mask used for overlays by default.
870 876
871=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
872 879
873Return the bit that enabled bold, italic, blink, reverse-video and 880Return the bit that enabled bold, italic, blink, reverse-video and
874underline, respectively. To enable such a style, just logically OR it into 881underline, respectively. To enable such a style, just logically OR it into
875the bitset. 882the bitset.
876 883
… …
2244 2251
2245=back 2252=back
2246 2253
2247=head1 AUTHOR 2254=head1 AUTHOR
2248 2255
2249 Marc Lehmann <pcg@goof.com> 2256 Marc Lehmann <schmorp@schmorp.de>
2250 http://software.schmorp.de/pkg/rxvt-unicode 2257 http://software.schmorp.de/pkg/rxvt-unicode
2251 2258
2252=cut 2259=cut
2253 2260
22541 22611

Diff Legend

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