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.196 by sf-exg, Wed Jun 29 22:46:48 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
… …
1301C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1308C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1302 1309
1303Here is a likely non-exhaustive list of option names, please see the 1310Here is a likely non-exhaustive list of option names, please see the
1304source file F</src/optinc.h> to see the actual list: 1311source file F</src/optinc.h> to see the actual list:
1305 1312
1306 borderLess console cursorBlink cursorUnderline hold iconic insecure 1313 borderLess buffered console cursorBlink cursorUnderline hold iconic
1307 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1314 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1308 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1315 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1309 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1316 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1310 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1317 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1311 transparent tripleclickwords utmpInhibit visualBell 1318 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1319 urgentOnBell utmpInhibit visualBell
1312 1320
1313=item $value = $term->resource ($name[, $newval]) 1321=item $value = $term->resource ($name[, $newval])
1314 1322
1315Returns the current resource value associated with a given name and 1323Returns the current resource value associated with a given name and
1316optionally sets a new value. Setting values is most useful in the C<init> 1324optionally sets a new value. Setting values is most useful in the C<init>
… …
1329 1337
1330Here is a likely non-exhaustive list of resource names, not all of which 1338Here is a likely non-exhaustive list of resource names, not all of which
1331are supported in every build, please see the source file F</src/rsinc.h> 1339are supported in every build, please see the source file F</src/rsinc.h>
1332to see the actual list: 1340to see the actual list:
1333 1341
1334 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1342 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1335 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1343 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1336 display_name embed ext_bwidth fade font geometry hold iconName 1344 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1337 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1345 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1338 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1346 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1347 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1339 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1348 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1340 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1349 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1341 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1350 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1342 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1351 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1343 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1352 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1344 secondaryScreen secondaryScroll shade term_name title 1353 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1345 transient_for transparent transparent_all tripleclickwords utmpInhibit 1354 term_name title transient_for transparent tripleclickwords urgentOnBell
1346 visualBell 1355 utmpInhibit visualBell
1347 1356
1348=cut 1357=cut
1349 1358
1350sub resource($$;$) { 1359sub resource($$;$) {
1351 my ($self, $name) = (shift, shift); 1360 my ($self, $name) = (shift, shift);
… …
2244 2253
2245=back 2254=back
2246 2255
2247=head1 AUTHOR 2256=head1 AUTHOR
2248 2257
2249 Marc Lehmann <pcg@goof.com> 2258 Marc Lehmann <schmorp@schmorp.de>
2250 http://software.schmorp.de/pkg/rxvt-unicode 2259 http://software.schmorp.de/pkg/rxvt-unicode
2251 2260
2252=cut 2261=cut
2253 2262
22541 22631

Diff Legend

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