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.182 by sf-exg, Wed Feb 17 08:27:56 2010 UTC vs.
Revision 1.194 by sf-exg, Wed Jun 29 21:59:36 2011 UTC

370 370
371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372 372
373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret 373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374the double C</> characters as comment start. Use C<\057\057> instead, 374the double C</> characters as comment start. Use C<\057\057> instead,
375which works regardless of wether xrdb is used to parse the resource file 375which works regardless of whether xrdb is used to parse the resource file
376or not. 376or not.
377 377
378=item macosx-clipboard and macosx-clipboard-native 378=item macosx-clipboard and macosx-clipboard-native
379 379
380These two modules implement an extended clipboard for Mac OS X. They are 380These two modules implement an extended clipboard for Mac OS X. They are
392=item example-refresh-hooks 392=item example-refresh-hooks
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
398=item confirm-paste
399
400Displays a confirmation dialog when a paste containing at least a full
401line is detected.
397 402
398=back 403=back
399 404
400=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
401 406
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
1322 1336
1323Here is a likely non-exhaustive list of resource names, not all of which 1337Here 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> 1338are supported in every build, please see the source file F</src/rsinc.h>
1325to see the actual list: 1339to see the actual list:
1326 1340
1327 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1341 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1328 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1342 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1329 display_name embed ext_bwidth fade font geometry hold iconName 1343 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1330 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1344 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1331 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1345 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1346 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1332 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1347 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1333 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1348 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1334 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1349 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1335 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1350 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1336 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1351 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1337 secondaryScreen secondaryScroll shade term_name title 1352 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1338 transient_for transparent transparent_all tripleclickwords utmpInhibit 1353 term_name title transient_for transparent tripleclickwords urgentOnBell
1339 visualBell 1354 utmpInhibit visualBell
1340 1355
1341=cut 1356=cut
1342 1357
1343sub resource($$;$) { 1358sub resource($$;$) {
1344 my ($self, $name) = (shift, shift); 1359 my ($self, $name) = (shift, shift);
1390 1405
1391=item $term->selection_make ($eventtime[, $rectangular]) 1406=item $term->selection_make ($eventtime[, $rectangular])
1392 1407
1393Tries to make a selection as set by C<selection_beg> and 1408Tries to make a selection as set by C<selection_beg> and
1394C<selection_end>. If C<$rectangular> is true (default: false), a 1409C<selection_end>. If C<$rectangular> is true (default: false), a
1395rectangular selection will be made. This is the prefered function to make 1410rectangular selection will be made. This is the preferred function to make
1396a selection. 1411a selection.
1397 1412
1398=item $success = $term->selection_grab ($eventtime) 1413=item $success = $term->selection_grab ($eventtime[, $clipboard])
1399 1414
1400Try to request the primary selection text from the server (for example, as 1415Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1416true) selection from the server. The corresponding text can be set
1401set by the next method). No visual feedback will be given. This function 1417with the next method. No visual feedback will be given. This function
1402is mostly useful from within C<on_sel_grab> hooks. 1418is mostly useful from within C<on_sel_grab> hooks.
1403 1419
1404=item $oldtext = $term->selection ([$newtext]) 1420=item $oldtext = $term->selection ([$newtext, $clipboard])
1405 1421
1406Return the current selection text and optionally replace it by C<$newtext>. 1422Return the current selection (clipboard if C<$clipboard> is true) text
1423and optionally replace it by C<$newtext>.
1424
1425=item $term->selection_clear ([$clipboard])
1426
1427Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1407 1428
1408=item $term->overlay_simple ($x, $y, $text) 1429=item $term->overlay_simple ($x, $y, $text)
1409 1430
1410Create a simple multi-line overlay box. See the next method for details. 1431Create a simple multi-line overlay box. See the next method for details.
1411 1432
1539locale-specific encoding of the terminal and can contain command sequences 1560locale-specific encoding of the terminal and can contain command sequences
1540(escape codes) that will be interpreted. 1561(escape codes) that will be interpreted.
1541 1562
1542=item $term->tt_write ($octets) 1563=item $term->tt_write ($octets)
1543 1564
1544Write the octets given in C<$data> to the tty (i.e. as program input). To 1565Write the octets given in C<$octets> to the tty (i.e. as program input). To
1545pass characters instead of octets, you should convert your strings first 1566pass characters instead of octets, you should convert your strings first
1546to the locale-specific encoding using C<< $term->locale_encode >>. 1567to the locale-specific encoding using C<< $term->locale_encode >>.
1568
1569=item $term->tt_paste ($octets)
1570
1571Write the octets given in C<$octets> to the tty as a paste, converting NL to
1572CR and bracketing the data with control sequences if bracketed paste mode
1573is set.
1547 1574
1548=item $old_events = $term->pty_ev_events ([$new_events]) 1575=item $old_events = $term->pty_ev_events ([$new_events])
1549 1576
1550Replaces the event mask of the pty watcher by the given event mask. Can 1577Replaces the event mask of the pty watcher by the given event mask. Can
1551be used to suppress input and output handling to the pty/tty. See the 1578be used to suppress input and output handling to the pty/tty. See the
2225 2252
2226=back 2253=back
2227 2254
2228=head1 AUTHOR 2255=head1 AUTHOR
2229 2256
2230 Marc Lehmann <pcg@goof.com> 2257 Marc Lehmann <schmorp@schmorp.de>
2231 http://software.schmorp.de/pkg/rxvt-unicode 2258 http://software.schmorp.de/pkg/rxvt-unicode
2232 2259
2233=cut 2260=cut
2234 2261
22351 22621

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines