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.115 by root, Fri Jan 20 15:57:21 2006 UTC vs.
Revision 1.125 by root, Sun Jan 22 20:39:47 2006 UTC

91 91
92=item selection-popup (enabled by default) 92=item selection-popup (enabled by default)
93 93
94Binds a popup menu to Ctrl-Button3 that lets you convert the selection 94Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95text into various other formats/action (such as uri unescaping, perl 95text into various other formats/action (such as uri unescaping, perl
96evalution, web-browser starting etc.), depending on content. 96evaluation, web-browser starting etc.), depending on content.
97 97
98Other extensions can extend this popup menu by pushing a code reference 98Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed. 100popup is displayed.
101 101
127bottom. C<Escape> leaves search mode and returns to the point where search 127bottom. C<Escape> leaves search mode and returns to the point where search
128was started, while C<Enter> or C<Return> stay at the current position and 128was started, while C<Enter> or C<Return> stay at the current position and
129additionally stores the first match in the current line into the primary 129additionally stores the first match in the current line into the primary
130selection. 130selection.
131 131
132=item readline (enabled by default)
133
134A support package that tries to make editing with readline easier. At the
135moment, it reacts to clicking with the left mouse button by trying to
136move the text cursor to this position. It does so by generating as many
137cursor-left or cursor-right keypresses as required (the this only works
138for programs that correctly support wide characters).
139
140To avoid too many false positives, this is only done when:
141
142=over 4
143
144=item - the tty is in ICANON state.
145
146=item - the text cursor is visible.
147
148=item - the primary screen is currently being displayed.
149
150=item - the mouse is on the same (multi-row-) line as the text cursor.
151
152=back
153
154The normal selection mechanism isn't disabled, so quick successive clicks
155might interfere with selection creation in harmless ways.
156
132=item selection-autotransform 157=item selection-autotransform
133 158
134This selection allows you to do automatic transforms on a selection 159This selection allows you to do automatic transforms on a selection
135whenever a selection is made. 160whenever a selection is made.
136 161
169This transforms the terminal into a tabbar with additional terminals, that 194This transforms the terminal into a tabbar with additional terminals, that
170is, it implements what is commonly refered to as "tabbed terminal". The topmost line 195is, it implements what is commonly refered to as "tabbed terminal". The topmost line
171displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one 196displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
172button per tab. 197button per tab.
173 198
174Clicking a button will activate that tab. Pressing Shift-Left and 199Clicking a button will activate that tab. Pressing B<Shift-Left> and
175Shift-Right will switch to the tab left or right of the current one. 200B<Shift-Right> will switch to the tab left or right of the current one,
201while B<Shift-Down> creates a new tab.
176 202
177=item mark-urls 203=item mark-urls
178 204
179Uses per-line display filtering (C<on_line_update>) to underline urls and 205Uses per-line display filtering (C<on_line_update>) to underline urls and
180make them clickable. When middle-clicked, the program specified in the 206make them clickable. When middle-clicked, the program specified in the
475Called wheneever the window loses keyboard focus, before rxvt-unicode does 501Called wheneever the window loses keyboard focus, before rxvt-unicode does
476focus out processing. 502focus out processing.
477 503
478=item on_configure_notify $term, $event 504=item on_configure_notify $term, $event
479 505
506=item on_property_notify $term, $event
507
480=item on_key_press $term, $event, $keysym, $octets 508=item on_key_press $term, $event, $keysym, $octets
481 509
482=item on_key_release $term, $event, $keysym 510=item on_key_release $term, $event, $keysym
483 511
484=item on_button_press $term, $event 512=item on_button_press $term, $event
493 521
494Called whenever the corresponding X event is received for the terminal If 522Called whenever the corresponding X event is received for the terminal If
495the hook returns true, then the even will be ignored by rxvt-unicode. 523the hook returns true, then the even will be ignored by rxvt-unicode.
496 524
497The event is a hash with most values as named by Xlib (see the XEvent 525The event is a hash with most values as named by Xlib (see the XEvent
498manpage), with the additional members C<row> and C<col>, which are the row 526manpage), with the additional members C<row> and C<col>, which are the
499and column under the mouse cursor. 527(real, not screen-based) row and column under the mouse cursor.
500 528
501C<on_key_press> additionally receives the string rxvt-unicode would 529C<on_key_press> additionally receives the string rxvt-unicode would
502output, if any, in locale-specific encoding. 530output, if any, in locale-specific encoding.
503 531
504subwindow. 532subwindow.
534 562
535our $LIBDIR; 563our $LIBDIR;
536our $RESNAME; 564our $RESNAME;
537our $RESCLASS; 565our $RESCLASS;
538our $RXVTNAME; 566our $RXVTNAME;
567
568our $NOCHAR = chr 0xffff;
539 569
540=head2 Variables in the C<urxvt> Package 570=head2 Variables in the C<urxvt> Package
541 571
542=over 4 572=over 4
543 573
690 unless $msg =~ /\n$/; 720 unless $msg =~ /\n$/;
691 urxvt::warn ($msg); 721 urxvt::warn ($msg);
692 }; 722 };
693} 723}
694 724
725no warnings 'utf8';
726
695my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 727my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
696 728
697sub verbose { 729sub verbose {
698 my ($level, $msg) = @_; 730 my ($level, $msg) = @_;
699 warn "$msg\n" if $level <= $verbosity; 731 warn "$msg\n" if $level <= $verbosity;
715 747
716 open my $fh, "<:raw", $path 748 open my $fh, "<:raw", $path
717 or die "$path: $!"; 749 or die "$path: $!";
718 750
719 my $source = 751 my $source =
720 "package $pkg; use strict; use utf8;\n" 752 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
721 . "#line 1 \"$path\"\n{\n" 753 . "#line 1 \"$path\"\n{\n"
722 . (do { local $/; <$fh> }) 754 . (do { local $/; <$fh> })
723 . "\n};\n1"; 755 . "\n};\n1";
724 756
725 eval $source 757 eval $source
750 $TERM->register_package ($_) for @pkg; 782 $TERM->register_package ($_) for @pkg;
751 } 783 }
752 784
753 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 785 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
754 if ($_ eq "default") { 786 if ($_ eq "default") {
755 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 787 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
756 } elsif (/^-(.*)$/) { 788 } elsif (/^-(.*)$/) {
757 delete $ext_arg{$1}; 789 delete $ext_arg{$1};
758 } elsif (/^([^<]+)<(.*)>$/) { 790 } elsif (/^([^<]+)<(.*)>$/) {
759 push @{ $ext_arg{$1} }, $2; 791 push @{ $ext_arg{$1} }, $2;
760 } else { 792 } else {
1257 1289
1258Normally its not a good idea to use this function, as programs might be 1290Normally its not a good idea to use this function, as programs might be
1259confused by changes in cursor position or scrolling. Its useful inside a 1291confused by changes in cursor position or scrolling. Its useful inside a
1260C<on_add_lines> hook, though. 1292C<on_add_lines> hook, though.
1261 1293
1294=item $term->scr_change_screen ($screen)
1295
1296Switch to given screen - 0 primary, 1 secondary.
1297
1262=item $term->cmd_parse ($octets) 1298=item $term->cmd_parse ($octets)
1263 1299
1264Similar to C<scr_add_lines>, but the argument must be in the 1300Similar to C<scr_add_lines>, but the argument must be in the
1265locale-specific encoding of the terminal and can contain command sequences 1301locale-specific encoding of the terminal and can contain command sequences
1266(escape codes) that will be interpreted. 1302(escape codes) that will be interpreted.
1275 1311
1276Replaces the event mask of the pty watcher by the given event mask. Can 1312Replaces the event mask of the pty watcher by the given event mask. Can
1277be used to suppress input and output handling to the pty/tty. See the 1313be used to suppress input and output handling to the pty/tty. See the
1278description of C<< urxvt::timer->events >>. Make sure to always restore 1314description of C<< urxvt::timer->events >>. Make sure to always restore
1279the previous value. 1315the previous value.
1316
1317=item $fd = $term->pty_fd
1318
1319Returns the master file descriptor for the pty in use, or C<-1> if no pty
1320is used.
1280 1321
1281=item $windowid = $term->parent 1322=item $windowid = $term->parent
1282 1323
1283Return the window id of the toplevel window. 1324Return the window id of the toplevel window.
1284 1325
1349=item $modifiermask = $term->ModNumLockMask 1390=item $modifiermask = $term->ModNumLockMask
1350 1391
1351Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1392Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1352AltGr), the meta key (often Alt) and the num lock key, if applicable. 1393AltGr), the meta key (often Alt) and the num lock key, if applicable.
1353 1394
1395=item $screen = $term->current_screen
1396
1397Returns the currently displayed screen (0 primary, 1 secondary).
1398
1399=item $cursor_is_hidden = $term->hidden_cursor
1400
1401Returns wether the cursor is currently hidden or not.
1402
1354=item $view_start = $term->view_start ([$newvalue]) 1403=item $view_start = $term->view_start ([$newvalue])
1355 1404
1356Returns the row number of the topmost displayed line. Maximum value is 1405Returns the row number of the topmost displayed line. Maximum value is
1357C<0>, which displays the normal terminal contents. Lower values scroll 1406C<0>, which displays the normal terminal contents. Lower values scroll
1358this many lines into the scrollback buffer. 1407this many lines into the scrollback buffer.
1377line, starting at column C<$start_col> (default C<0>), which is useful 1426line, starting at column C<$start_col> (default C<0>), which is useful
1378to replace only parts of a line. The font index in the rendition will 1427to replace only parts of a line. The font index in the rendition will
1379automatically be updated. 1428automatically be updated.
1380 1429
1381C<$text> is in a special encoding: tabs and wide characters that use more 1430C<$text> is in a special encoding: tabs and wide characters that use more
1382than one cell when displayed are padded with urxvt::NOCHAR characters 1431than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1383(C<chr 65535>). Characters with combining characters and other characters 1432characters. Characters with combining characters and other characters that
1384that do not fit into the normal tetx encoding will be replaced with 1433do not fit into the normal tetx encoding will be replaced with characters
1385characters in the private use area. 1434in the private use area.
1386 1435
1387You have to obey this encoding when changing text. The advantage is 1436You have to obey this encoding when changing text. The advantage is
1388that C<substr> and similar functions work on screen cells and not on 1437that C<substr> and similar functions work on screen cells and not on
1389characters. 1438characters.
1390 1439
1564=item $term->ungrab 1613=item $term->ungrab
1565 1614
1566Calls XUngrab for the most recent grab. Is called automatically on 1615Calls XUngrab for the most recent grab. Is called automatically on
1567evaluation errors, as it is better to lose the grab in the error case as 1616evaluation errors, as it is better to lose the grab in the error case as
1568the session. 1617the session.
1618
1619=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1620
1621=item $atom_name = $term->XGetAtomName ($atom)
1622
1623=item @atoms = $term->XListProperties ($window)
1624
1625=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1626
1627=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1628
1629=item $term->XDeleteProperty ($window, $property)
1630
1631=item $window = $term->DefaultRootWindow
1632
1633=item $term->XReparentWindow ($window, $parent, [$x, $y])
1634
1635=item $term->XMapWindow ($window)
1636
1637=item $term->XUnmapWindow ($window)
1638
1639=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1640
1641=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1642
1643=item $term->XChangeInput ($window, $add_events[, $del_events])
1644
1645Various X or X-related functions. The C<$term> object only serves as
1646the source of the display, otherwise those functions map more-or-less
1647directory onto the X functions of the same name.
1569 1648
1570=back 1649=back
1571 1650
1572=cut 1651=cut
1573 1652

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines