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.190 by root, Fri Jan 7 21:17:08 2011 UTC vs.
Revision 1.196 by sf-exg, Wed Jun 29 22:46:48 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.
801=item urxvt::fatal $errormessage 801=item urxvt::fatal $errormessage
802 802
803Fatally aborts execution with the given error message (which should 803Fatally aborts execution with the given error message (which should
804include a trailing newline). Avoid at all costs! The only time this 804include a trailing newline). Avoid at all costs! The only time this
805is acceptable (and useful) is in the init hook, where it prevents the 805is acceptable (and useful) is in the init hook, where it prevents the
806temrinal from starting up. 806terminal from starting up.
807 807
808=item urxvt::warn $string 808=item urxvt::warn $string
809 809
810Calls C<rxvt_warn> with the given string which should include a trailing 810Calls C<rxvt_warn> with the given string which should include a trailing
811newline. The module also overwrites the C<warn> builtin with a function 811newline. The module also overwrites the C<warn> builtin with a function
819=item @terms = urxvt::termlist 819=item @terms = urxvt::termlist
820 820
821Returns all urxvt::term objects that exist in this process, regardless of 821Returns all urxvt::term objects that exist in this process, regardless of
822whether they are started, being destroyed etc., so be careful. Only term 822whether they are started, being destroyed etc., so be careful. Only term
823objects that have perl extensions attached will be returned (because there 823objects that have perl extensions attached will be returned (because there
824is no urxvt::term objet associated with others). 824is no urxvt::term object associated with others).
825 825
826=item $time = urxvt::NOW 826=item $time = urxvt::NOW
827 827
828Returns the "current time" (as per the event loop). 828Returns the "current time" (as per the event loop).
829 829
1308C<%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.
1309 1309
1310Here 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
1311source file F</src/optinc.h> to see the actual list: 1311source file F</src/optinc.h> to see the actual list:
1312 1312
1313 borderLess console cursorBlink cursorUnderline hold iconic insecure 1313 borderLess buffered console cursorBlink cursorUnderline hold iconic
1314 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1314 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1315 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1315 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1316 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1316 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1317 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1317 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1318 transparent tripleclickwords utmpInhibit visualBell 1318 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1319 urgentOnBell utmpInhibit visualBell
1319 1320
1320=item $value = $term->resource ($name[, $newval]) 1321=item $value = $term->resource ($name[, $newval])
1321 1322
1322Returns the current resource value associated with a given name and 1323Returns the current resource value associated with a given name and
1323optionally 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>
1336 1337
1337Here 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
1338are 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>
1339to see the actual list: 1340to see the actual list:
1340 1341
1341 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1342 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1342 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1343 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1343 display_name embed ext_bwidth fade font geometry hold iconName 1344 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1344 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1345 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1345 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1346 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1347 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1346 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1348 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1347 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1349 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1348 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1350 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1349 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1351 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1350 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1352 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1351 secondaryScreen secondaryScroll shade term_name title 1353 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1352 transient_for transparent transparent_all tripleclickwords utmpInhibit 1354 term_name title transient_for transparent tripleclickwords urgentOnBell
1353 visualBell 1355 utmpInhibit visualBell
1354 1356
1355=cut 1357=cut
1356 1358
1357sub resource($$;$) { 1359sub resource($$;$) {
1358 my ($self, $name) = (shift, shift); 1360 my ($self, $name) = (shift, shift);
2251 2253
2252=back 2254=back
2253 2255
2254=head1 AUTHOR 2256=head1 AUTHOR
2255 2257
2256 Marc Lehmann <pcg@goof.com> 2258 Marc Lehmann <schmorp@schmorp.de>
2257 http://software.schmorp.de/pkg/rxvt-unicode 2259 http://software.schmorp.de/pkg/rxvt-unicode
2258 2260
2259=cut 2261=cut
2260 2262
22611 22631

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines