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.184 by sf-exg, Thu Jul 1 21:17:11 2010 UTC vs.
Revision 1.195 by sf-exg, Wed Jun 29 22:18:11 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.
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.
614 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.
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
619that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
644resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
645 657
646The event is simply the action string. This interface is assumed to change 658The event is simply the action string. This interface is assumed to change
647slightly in the future. 659slightly in the future.
648 660
649=item on_resize_all_windows $tern, $new_width, $new_height 661=item on_resize_all_windows $term, $new_width, $new_height
650 662
651Called just after the new window size has been calculated, but before 663Called just after the new window size has been calculated, but before
652windows are actually being resized or hints are being set. If this hook 664windows are actually being resized or hints are being set. If this hook
653returns TRUE, setting of the window hints is being skipped. 665returns TRUE, setting of the window hints is being skipped.
654 666
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
1294C<%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.
1295 1309
1296Here 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
1297source file F</src/optinc.h> to see the actual list: 1311source file F</src/optinc.h> to see the actual list:
1298 1312
1299 borderLess console cursorBlink cursorUnderline hold iconic insecure 1313 borderLess buffered console cursorBlink cursorUnderline hold iconic
1300 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1314 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1301 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1315 mapAlert meta8 mouseWheelScrollPage override-redirect pastableTabs
1302 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1316 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1303 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1317 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1304 transparent tripleclickwords utmpInhibit visualBell 1318 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1319 urgentOnBell utmpInhibit visualBell
1305 1320
1306=item $value = $term->resource ($name[, $newval]) 1321=item $value = $term->resource ($name[, $newval])
1307 1322
1308Returns the current resource value associated with a given name and 1323Returns the current resource value associated with a given name and
1309optionally 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>
1322 1337
1323Here 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
1324are 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>
1325to see the actual list: 1340to see the actual list:
1326 1341
1327 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1342 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1328 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1343 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1329 display_name embed ext_bwidth fade font geometry hold iconName 1344 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1330 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1345 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1331 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1346 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1347 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1332 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1348 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1333 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1349 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1334 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1350 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1335 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1351 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1336 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1352 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1337 secondaryScreen secondaryScroll shade term_name title 1353 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1338 transient_for transparent transparent_all tripleclickwords utmpInhibit 1354 term_name title transient_for transparent tripleclickwords urgentOnBell
1339 visualBell 1355 utmpInhibit visualBell
1340 1356
1341=cut 1357=cut
1342 1358
1343sub resource($$;$) { 1359sub resource($$;$) {
1344 my ($self, $name) = (shift, shift); 1360 my ($self, $name) = (shift, shift);
1390 1406
1391=item $term->selection_make ($eventtime[, $rectangular]) 1407=item $term->selection_make ($eventtime[, $rectangular])
1392 1408
1393Tries to make a selection as set by C<selection_beg> and 1409Tries to make a selection as set by C<selection_beg> and
1394C<selection_end>. If C<$rectangular> is true (default: false), a 1410C<selection_end>. If C<$rectangular> is true (default: false), a
1395rectangular selection will be made. This is the prefered function to make 1411rectangular selection will be made. This is the preferred function to make
1396a selection. 1412a selection.
1397 1413
1398=item $success = $term->selection_grab ($eventtime[, $clipboard]) 1414=item $success = $term->selection_grab ($eventtime[, $clipboard])
1399 1415
1400Try to acquire ownership of the primary (clipboard if C<$clipboard> is 1416Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1545locale-specific encoding of the terminal and can contain command sequences 1561locale-specific encoding of the terminal and can contain command sequences
1546(escape codes) that will be interpreted. 1562(escape codes) that will be interpreted.
1547 1563
1548=item $term->tt_write ($octets) 1564=item $term->tt_write ($octets)
1549 1565
1550Write the octets given in C<$data> to the tty (i.e. as program input). To 1566Write 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 1567pass characters instead of octets, you should convert your strings first
1552to the locale-specific encoding using C<< $term->locale_encode >>. 1568to the locale-specific encoding using C<< $term->locale_encode >>.
1569
1570=item $term->tt_paste ($octets)
1571
1572Write the octets given in C<$octets> to the tty as a paste, converting NL to
1573CR and bracketing the data with control sequences if bracketed paste mode
1574is set.
1553 1575
1554=item $old_events = $term->pty_ev_events ([$new_events]) 1576=item $old_events = $term->pty_ev_events ([$new_events])
1555 1577
1556Replaces the event mask of the pty watcher by the given event mask. Can 1578Replaces 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 1579be used to suppress input and output handling to the pty/tty. See the
2231 2253
2232=back 2254=back
2233 2255
2234=head1 AUTHOR 2256=head1 AUTHOR
2235 2257
2236 Marc Lehmann <pcg@goof.com> 2258 Marc Lehmann <schmorp@schmorp.de>
2237 http://software.schmorp.de/pkg/rxvt-unicode 2259 http://software.schmorp.de/pkg/rxvt-unicode
2238 2260
2239=cut 2261=cut
2240 2262
22411 22631

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines