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.119 by root, Fri Jan 20 18:59:31 2006 UTC vs.
Revision 1.123 by root, Sat Jan 21 14:49:18 2006 UTC

… …
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 mouse is on the same (multi-row-) line as the text cursor.
145
146=item - the primary screen is currently being displayed.
147
148=item - the text cursor is visible.
149
150=back
151
152The normal selection mechanism isn't disabled, so quick successive clicks
153might interfere with selection creation in harmless ways.
154
132=item selection-autotransform 155=item selection-autotransform
133 156
134This selection allows you to do automatic transforms on a selection 157This selection allows you to do automatic transforms on a selection
135whenever a selection is made. 158whenever a selection is made.
136 159
… …
496 519
497Called whenever the corresponding X event is received for the terminal If 520Called whenever the corresponding X event is received for the terminal If
498the hook returns true, then the even will be ignored by rxvt-unicode. 521the hook returns true, then the even will be ignored by rxvt-unicode.
499 522
500The event is a hash with most values as named by Xlib (see the XEvent 523The event is a hash with most values as named by Xlib (see the XEvent
501manpage), with the additional members C<row> and C<col>, which are the row 524manpage), with the additional members C<row> and C<col>, which are the
502and column under the mouse cursor. 525(real, not screen-based) row and column under the mouse cursor.
503 526
504C<on_key_press> additionally receives the string rxvt-unicode would 527C<on_key_press> additionally receives the string rxvt-unicode would
505output, if any, in locale-specific encoding. 528output, if any, in locale-specific encoding.
506 529
507subwindow. 530subwindow.
… …
537 560
538our $LIBDIR; 561our $LIBDIR;
539our $RESNAME; 562our $RESNAME;
540our $RESCLASS; 563our $RESCLASS;
541our $RXVTNAME; 564our $RXVTNAME;
565
566our $NOCHAR = chr 0xfffe;
542 567
543=head2 Variables in the C<urxvt> Package 568=head2 Variables in the C<urxvt> Package
544 569
545=over 4 570=over 4
546 571
… …
753 $TERM->register_package ($_) for @pkg; 778 $TERM->register_package ($_) for @pkg;
754 } 779 }
755 780
756 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 781 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
757 if ($_ eq "default") { 782 if ($_ eq "default") {
758 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 783 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
759 } elsif (/^-(.*)$/) { 784 } elsif (/^-(.*)$/) {
760 delete $ext_arg{$1}; 785 delete $ext_arg{$1};
761 } elsif (/^([^<]+)<(.*)>$/) { 786 } elsif (/^([^<]+)<(.*)>$/) {
762 push @{ $ext_arg{$1} }, $2; 787 push @{ $ext_arg{$1} }, $2;
763 } else { 788 } else {
… …
1260 1285
1261Normally its not a good idea to use this function, as programs might be 1286Normally its not a good idea to use this function, as programs might be
1262confused by changes in cursor position or scrolling. Its useful inside a 1287confused by changes in cursor position or scrolling. Its useful inside a
1263C<on_add_lines> hook, though. 1288C<on_add_lines> hook, though.
1264 1289
1290=item $term->scr_change_screen ($screen)
1291
1292Switch to given screen - 0 primary, 1 secondary.
1293
1265=item $term->cmd_parse ($octets) 1294=item $term->cmd_parse ($octets)
1266 1295
1267Similar to C<scr_add_lines>, but the argument must be in the 1296Similar to C<scr_add_lines>, but the argument must be in the
1268locale-specific encoding of the terminal and can contain command sequences 1297locale-specific encoding of the terminal and can contain command sequences
1269(escape codes) that will be interpreted. 1298(escape codes) that will be interpreted.
… …
1352=item $modifiermask = $term->ModNumLockMask 1381=item $modifiermask = $term->ModNumLockMask
1353 1382
1354Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1383Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1355AltGr), the meta key (often Alt) and the num lock key, if applicable. 1384AltGr), the meta key (often Alt) and the num lock key, if applicable.
1356 1385
1386=item $screen = $term->current_screen
1387
1388Returns the currently displayed screen (0 primary, 1 secondary).
1389
1390=item $cursor_is_hidden = $term->hidden_cursor
1391
1392Returns wether the cursor is currently hidden or not.
1393
1357=item $view_start = $term->view_start ([$newvalue]) 1394=item $view_start = $term->view_start ([$newvalue])
1358 1395
1359Returns the row number of the topmost displayed line. Maximum value is 1396Returns the row number of the topmost displayed line. Maximum value is
1360C<0>, which displays the normal terminal contents. Lower values scroll 1397C<0>, which displays the normal terminal contents. Lower values scroll
1361this many lines into the scrollback buffer. 1398this many lines into the scrollback buffer.
… …
1379If C<$new_text> is specified, it will replace characters in the current 1416If C<$new_text> is specified, it will replace characters in the current
1380line, starting at column C<$start_col> (default C<0>), which is useful 1417line, starting at column C<$start_col> (default C<0>), which is useful
1381to replace only parts of a line. The font index in the rendition will 1418to replace only parts of a line. The font index in the rendition will
1382automatically be updated. 1419automatically be updated.
1383 1420
1384C<$text> is in a special encoding: tabs and wide characters that use more 1421C<$text> is in a special encoding: tabs and wide characters that use
1385than one cell when displayed are padded with urxvt::NOCHAR characters 1422more than one cell when displayed are padded with C<$urxvt::NOCHAR>
1386(C<chr 65535>). Characters with combining characters and other characters 1423characters. Characters with combining characters and other characters that
1387that do not fit into the normal tetx encoding will be replaced with 1424do not fit into the normal tetx encoding will be replaced with characters
1388characters in the private use area. 1425in the private use area.
1389 1426
1390You have to obey this encoding when changing text. The advantage is 1427You have to obey this encoding when changing text. The advantage is
1391that C<substr> and similar functions work on screen cells and not on 1428that C<substr> and similar functions work on screen cells and not on
1392characters. 1429characters.
1393 1430

Diff Legend

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