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.170 by root, Tue Sep 23 07:03:13 2008 UTC vs.
Revision 1.173 by root, Wed Nov 5 12:45:36 2008 UTC

… …
303extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
304 304
305If you want a quake-like animation, tell your window manager to do so 305If you want a quake-like animation, tell your window manager to do so
306(fvwm can do it). 306(fvwm can do it).
307 307
308=item overlay-osc
309
310This extension implements some OSC commands to display timed popups on the
311screen - useful for status displays from within scripts. You have to read
312the sources for more info.
313
308=item block-graphics-to-ascii 314=item block-graphics-to-ascii
309 315
310A not very useful example of filtering all text output to the terminal 316A not very useful example of filtering all text output to the terminal
311by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
312similar-looking ascii character. 318similar-looking ascii character.
… …
541 547
542It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 548It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
543$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 549$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
544number of lines that will be in the scrollback buffer. 550number of lines that will be in the scrollback buffer.
545 551
546=item on_osc_seq $term, $op, $args 552=item on_osc_seq $term, $op, $args, $resp
547 553
548Called on every OSC sequence and can be used to suppress it or modify its 554Called on every OSC sequence and can be used to suppress it or modify its
549behaviour. The default should be to return an empty list. A true value 555behaviour. The default should be to return an empty list. A true value
550suppresses execution of the request completely. Make sure you don't get 556suppresses execution of the request completely. Make sure you don't get
551confused by recursive invocations when you output an osc sequence within 557confused by recursive invocations when you output an OSC sequence within
552this callback. 558this callback.
553 559
554C<on_osc_seq_perl> should be used for new behaviour. 560C<on_osc_seq_perl> should be used for new behaviour.
555 561
556=item on_osc_seq_perl $term, $string 562=item on_osc_seq_perl $term, $args, $resp
557 563
558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 564Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559operating system command) is processed. Cursor position and other state 565operating system command) is processed. Cursor position and other state
560information is up-to-date when this happens. For interoperability, the 566information is up-to-date when this happens. For interoperability, the
561string should start with the extension name and a colon, to distinguish 567string should start with the extension name (sans -osc) and a semicolon,
562it from commands for other extensions, and this might be enforced in the 568to distinguish it from commands for other extensions, and this might be
563future. 569enforced in the future.
570
571For example, C<overlay-osc> uses this:
572
573 sub on_osc_seq_perl {
574 my ($self, $osc, $resp) = @_;
575
576 return unless $osc =~ s/^overlay;//;
577
578 ... process remaining $osc string
579 }
564 580
565Be careful not ever to trust (in a security sense) the data you receive, 581Be careful not ever to trust (in a security sense) the data you receive,
566as its source can not easily be controlled (e-mail content, messages from 582as its source can not easily be controlled (e-mail content, messages from
567other users on the same system etc.). 583other users on the same system etc.).
584
585For responses, C<$resp> contains the end-of-args separator used by the
586sender.
568 587
569=item on_add_lines $term, $string 588=item on_add_lines $term, $string
570 589
571Called whenever text is about to be output, with the text as argument. You 590Called whenever text is about to be output, with the text as argument. You
572can filter/change and output the text yourself by returning a true value 591can filter/change and output the text yourself by returning a true value
… …
593later with the already-modified line (e.g. if unrelated parts change), so 612later with the already-modified line (e.g. if unrelated parts change), so
594you cannot just toggle rendition bits, but only set them. 613you cannot just toggle rendition bits, but only set them.
595 614
596=item on_refresh_begin $term 615=item on_refresh_begin $term
597 616
598Called just before the screen gets redrawn. Can be used for overlay 617Called just before the screen gets redrawn. Can be used for overlay or
599or similar effects by modify terminal contents in refresh_begin, and 618similar effects by modifying the terminal contents in refresh_begin, and
600restoring them in refresh_end. The built-in overlay and selection display 619restoring them in refresh_end. The built-in overlay and selection display
601code is run after this hook, and takes precedence. 620code is run after this hook, and takes precedence.
602 621
603=item on_refresh_end $term 622=item on_refresh_end $term
604 623
… …
1373 1392
1374The methods currently supported on C<urxvt::overlay> objects are: 1393The methods currently supported on C<urxvt::overlay> objects are:
1375 1394
1376=over 4 1395=over 4
1377 1396
1378=item $overlay->set ($x, $y, $text, $rend) 1397=item $overlay->set ($x, $y, $text[, $rend])
1379 1398
1380Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1399Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1381text in rxvt-unicode's special encoding and an array of rendition values 1400text in rxvt-unicode's special encoding and an array of rendition values
1382at a specific position inside the overlay. 1401at a specific position inside the overlay.
1402
1403If C<$rend> is missing, then the rendition will not be changed.
1383 1404
1384=item $overlay->hide 1405=item $overlay->hide
1385 1406
1386If visible, hide the overlay, but do not destroy it. 1407If visible, hide the overlay, but do not destroy it.
1387 1408

Diff Legend

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