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.114 by root, Fri Jan 20 12:16:28 2006 UTC vs.
Revision 1.123 by root, Sat Jan 21 14:49:18 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 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
161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ 184 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162 185
163The first line tells the selection code to treat the unchanging part of 186The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms 187every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file. 188the message into vi commands to load the file.
189
190=item tabbed
191
192This transforms the terminal into a tabbar with additional terminals, that
193is, it implements what is commonly refered to as "tabbed terminal". The topmost line
194displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
195button per tab.
196
197Clicking a button will activate that tab. Pressing B<Shift-Left> and
198B<Shift-Right> will switch to the tab left or right of the current one,
199while B<Shift-Down> creates a new tab.
166 200
167=item mark-urls 201=item mark-urls
168 202
169Uses per-line display filtering (C<on_line_update>) to underline urls and 203Uses per-line display filtering (C<on_line_update>) to underline urls and
170make them clickable. When middle-clicked, the program specified in the 204make them clickable. When middle-clicked, the program specified in the
465Called wheneever the window loses keyboard focus, before rxvt-unicode does 499Called wheneever the window loses keyboard focus, before rxvt-unicode does
466focus out processing. 500focus out processing.
467 501
468=item on_configure_notify $term, $event 502=item on_configure_notify $term, $event
469 503
504=item on_property_notify $term, $event
505
470=item on_key_press $term, $event, $keysym, $octets 506=item on_key_press $term, $event, $keysym, $octets
471 507
472=item on_key_release $term, $event, $keysym 508=item on_key_release $term, $event, $keysym
473 509
474=item on_button_press $term, $event 510=item on_button_press $term, $event
483 519
484Called whenever the corresponding X event is received for the terminal If 520Called whenever the corresponding X event is received for the terminal If
485the 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.
486 522
487The 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
488manpage), 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
489and column under the mouse cursor. 525(real, not screen-based) row and column under the mouse cursor.
490 526
491C<on_key_press> additionally receives the string rxvt-unicode would 527C<on_key_press> additionally receives the string rxvt-unicode would
492output, if any, in locale-specific encoding. 528output, if any, in locale-specific encoding.
493 529
494subwindow. 530subwindow.
524 560
525our $LIBDIR; 561our $LIBDIR;
526our $RESNAME; 562our $RESNAME;
527our $RESCLASS; 563our $RESCLASS;
528our $RXVTNAME; 564our $RXVTNAME;
565
566our $NOCHAR = chr 0xfffe;
529 567
530=head2 Variables in the C<urxvt> Package 568=head2 Variables in the C<urxvt> Package
531 569
532=over 4 570=over 4
533 571
740 $TERM->register_package ($_) for @pkg; 778 $TERM->register_package ($_) for @pkg;
741 } 779 }
742 780
743 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 781 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
744 if ($_ eq "default") { 782 if ($_ eq "default") {
745 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 783 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
746 } elsif (/^-(.*)$/) { 784 } elsif (/^-(.*)$/) {
747 delete $ext_arg{$1}; 785 delete $ext_arg{$1};
748 } elsif (/^([^<]+)<(.*)>$/) { 786 } elsif (/^([^<]+)<(.*)>$/) {
749 push @{ $ext_arg{$1} }, $2; 787 push @{ $ext_arg{$1} }, $2;
750 } else { 788 } else {
1247 1285
1248Normally 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
1249confused by changes in cursor position or scrolling. Its useful inside a 1287confused by changes in cursor position or scrolling. Its useful inside a
1250C<on_add_lines> hook, though. 1288C<on_add_lines> hook, though.
1251 1289
1290=item $term->scr_change_screen ($screen)
1291
1292Switch to given screen - 0 primary, 1 secondary.
1293
1252=item $term->cmd_parse ($octets) 1294=item $term->cmd_parse ($octets)
1253 1295
1254Similar 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
1255locale-specific encoding of the terminal and can contain command sequences 1297locale-specific encoding of the terminal and can contain command sequences
1256(escape codes) that will be interpreted. 1298(escape codes) that will be interpreted.
1339=item $modifiermask = $term->ModNumLockMask 1381=item $modifiermask = $term->ModNumLockMask
1340 1382
1341Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1383Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1342AltGr), 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.
1343 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
1344=item $view_start = $term->view_start ([$newvalue]) 1394=item $view_start = $term->view_start ([$newvalue])
1345 1395
1346Returns the row number of the topmost displayed line. Maximum value is 1396Returns the row number of the topmost displayed line. Maximum value is
1347C<0>, which displays the normal terminal contents. Lower values scroll 1397C<0>, which displays the normal terminal contents. Lower values scroll
1348this many lines into the scrollback buffer. 1398this many lines into the scrollback buffer.
1366If 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
1367line, 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
1368to 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
1369automatically be updated. 1419automatically be updated.
1370 1420
1371C<$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
1372than one cell when displayed are padded with urxvt::NOCHAR characters 1422more than one cell when displayed are padded with C<$urxvt::NOCHAR>
1373(C<chr 65535>). Characters with combining characters and other characters 1423characters. Characters with combining characters and other characters that
1374that 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
1375characters in the private use area. 1425in the private use area.
1376 1426
1377You have to obey this encoding when changing text. The advantage is 1427You have to obey this encoding when changing text. The advantage is
1378that 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
1379characters. 1429characters.
1380 1430
1554=item $term->ungrab 1604=item $term->ungrab
1555 1605
1556Calls XUngrab for the most recent grab. Is called automatically on 1606Calls XUngrab for the most recent grab. Is called automatically on
1557evaluation errors, as it is better to lose the grab in the error case as 1607evaluation errors, as it is better to lose the grab in the error case as
1558the session. 1608the session.
1609
1610=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1611
1612=item $atom_name = $term->XGetAtomName ($atom)
1613
1614=item @atoms = $term->XListProperties ($window)
1615
1616=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1617
1618=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1619
1620=item $term->XDeleteProperty ($window, $property)
1621
1622=item $window = $term->DefaultRootWindow
1623
1624=item $term->XReparentWindow ($window, $parent, [$x, $y])
1625
1626=item $term->XMapWindow ($window)
1627
1628=item $term->XUnmapWindow ($window)
1629
1630=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1631
1632=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1633
1634=item $term->XChangeInput ($window, $add_events[, $del_events])
1635
1636Various X or X-related functions. The C<$term> object only serves as
1637the source of the display, otherwise those functions map more-or-less
1638directory onto the X functions of the same name.
1559 1639
1560=back 1640=back
1561 1641
1562=cut 1642=cut
1563 1643

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines