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.188 by sf-exg, Sat Jul 24 13:04:27 2010 UTC vs.
Revision 1.195 by sf-exg, Wed Jun 29 22:18:11 2011 UTC

… …
441=back 441=back
442 442
443=head2 Extension Objects 443=head2 Extension Objects
444 444
445Every 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
446for 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,
447which 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
448their C<$self> object without having to think about clashes with other 448their C<$self> object without having to think about clashes with other
449extensions or other terminals, with the exception of methods and members 449extensions or other terminals, with the exception of methods and members
450that begin with an underscore character C<_>: these are reserved for 450that begin with an underscore character C<_>: these are reserved for
451internal use. 451internal use.
… …
798 798
799=over 4 799=over 4
800 800
801=item urxvt::fatal $errormessage 801=item urxvt::fatal $errormessage
802 802
803Fatally aborts execution with the given error message. Avoid at all 803Fatally aborts execution with the given error message (which should
804costs! The only time this is acceptable is when the terminal process 804include a trailing newline). Avoid at all costs! The only time this
805starts up. 805is acceptable (and useful) is in the init hook, where it prevents the
806terminal from starting up.
806 807
807=item urxvt::warn $string 808=item urxvt::warn $string
808 809
809Calls 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
810newline. The module also overwrites the C<warn> builtin with a function 811newline. The module also overwrites the C<warn> builtin with a function
811that calls this function. 812that calls this function.
812 813
813Using 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
814correct place, e.g. on stderr of the connecting urxvtc client. 815correct place, e.g. on stderr of the connecting urxvtc client.
… …
818=item @terms = urxvt::termlist 819=item @terms = urxvt::termlist
819 820
820Returns all urxvt::term objects that exist in this process, regardless of 821Returns all urxvt::term objects that exist in this process, regardless of
821whether they are started, being destroyed etc., so be careful. Only term 822whether they are started, being destroyed etc., so be careful. Only term
822objects that have perl extensions attached will be returned (because there 823objects that have perl extensions attached will be returned (because there
823is no urxvt::term objet associated with others). 824is no urxvt::term object associated with others).
824 825
825=item $time = urxvt::NOW 826=item $time = urxvt::NOW
826 827
827Returns the "current time" (as per the event loop). 828Returns the "current time" (as per the event loop).
828 829
… …
871 872
872=item $rend = urxvt::OVERLAY_RSTYLE 873=item $rend = urxvt::OVERLAY_RSTYLE
873 874
874Return the rendition mask used for overlays by default. 875Return the rendition mask used for overlays by default.
875 876
876=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
877 879
878Return the bit that enabled bold, italic, blink, reverse-video and 880Return the bit that enabled bold, italic, blink, reverse-video and
879underline, respectively. To enable such a style, just logically OR it into 881underline, respectively. To enable such a style, just logically OR it into
880the bitset. 882the bitset.
881 883
… …
1306C<%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.
1307 1309
1308Here 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
1309source file F</src/optinc.h> to see the actual list: 1311source file F</src/optinc.h> to see the actual list:
1310 1312
1311 borderLess console cursorBlink cursorUnderline hold iconic insecure 1313 borderLess buffered console cursorBlink cursorUnderline hold iconic
1312 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1314 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1313 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1315 mapAlert meta8 mouseWheelScrollPage override-redirect pastableTabs
1314 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1316 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1315 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1317 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1316 transparent tripleclickwords utmpInhibit visualBell 1318 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1319 urgentOnBell utmpInhibit visualBell
1317 1320
1318=item $value = $term->resource ($name[, $newval]) 1321=item $value = $term->resource ($name[, $newval])
1319 1322
1320Returns the current resource value associated with a given name and 1323Returns the current resource value associated with a given name and
1321optionally 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>
… …
1334 1337
1335Here 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
1336are 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>
1337to see the actual list: 1340to see the actual list:
1338 1341
1339 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1342 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1340 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1343 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1341 display_name embed ext_bwidth fade font geometry hold iconName 1344 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1342 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1345 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1343 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1346 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1347 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1344 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1348 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1345 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1349 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1346 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1350 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1347 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1351 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1348 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1352 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1349 secondaryScreen secondaryScroll shade term_name title 1353 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1350 transient_for transparent transparent_all tripleclickwords utmpInhibit 1354 term_name title transient_for transparent tripleclickwords urgentOnBell
1351 visualBell 1355 utmpInhibit visualBell
1352 1356
1353=cut 1357=cut
1354 1358
1355sub resource($$;$) { 1359sub resource($$;$) {
1356 my ($self, $name) = (shift, shift); 1360 my ($self, $name) = (shift, shift);
… …
2249 2253
2250=back 2254=back
2251 2255
2252=head1 AUTHOR 2256=head1 AUTHOR
2253 2257
2254 Marc Lehmann <pcg@goof.com> 2258 Marc Lehmann <schmorp@schmorp.de>
2255 http://software.schmorp.de/pkg/rxvt-unicode 2259 http://software.schmorp.de/pkg/rxvt-unicode
2256 2260
2257=cut 2261=cut
2258 2262
22591 22631

Diff Legend

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