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.121 by root, Fri Jan 20 22:49:34 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
162 162
163The first line tells the selection code to treat the unchanging part of 163The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms 164every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file. 165the message into vi commands to load the file.
166 166
167=item readline
168
169A support package that tries to make editing with readline easier. At the
170moment, it reacts to clicking with the left mouse button by trying to
171move the text cursor to this position. It does so by generating as many
172cursor-left or cursor-right keypresses as required (the this only works
173for programs that correctly support wide characters).
174
175It only works when clicking into the same line (possibly extended over
176multiple rows) as the text cursor and on the primary screen, to reduce the
177risk of misinterpreting. The normal selection isn't disabled, so quick
178successive clicks might interfere with selection creation in harmless
179ways.
180
167=item tabbed 181=item tabbed
168 182
169This transforms the terminal into a tabbar with additional terminals, that 183This transforms the terminal into a tabbar with additional terminals, that
170is, it implements what is commonly refered to as "tabbed terminal". The topmost line 184is, 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 185displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
172button per tab. 186button per tab.
173 187
174Clicking a button will activate that tab. Pressing Shift-Left and 188Clicking 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. 189B<Shift-Right> will switch to the tab left or right of the current one,
190while B<Shift-Down> creates a new tab.
176 191
177=item mark-urls 192=item mark-urls
178 193
179Uses per-line display filtering (C<on_line_update>) to underline urls and 194Uses per-line display filtering (C<on_line_update>) to underline urls and
180make them clickable. When middle-clicked, the program specified in the 195make them clickable. When middle-clicked, the program specified in the
475Called wheneever the window loses keyboard focus, before rxvt-unicode does 490Called wheneever the window loses keyboard focus, before rxvt-unicode does
476focus out processing. 491focus out processing.
477 492
478=item on_configure_notify $term, $event 493=item on_configure_notify $term, $event
479 494
495=item on_property_notify $term, $event
496
480=item on_key_press $term, $event, $keysym, $octets 497=item on_key_press $term, $event, $keysym, $octets
481 498
482=item on_key_release $term, $event, $keysym 499=item on_key_release $term, $event, $keysym
483 500
484=item on_button_press $term, $event 501=item on_button_press $term, $event
493 510
494Called whenever the corresponding X event is received for the terminal If 511Called whenever the corresponding X event is received for the terminal If
495the hook returns true, then the even will be ignored by rxvt-unicode. 512the hook returns true, then the even will be ignored by rxvt-unicode.
496 513
497The event is a hash with most values as named by Xlib (see the XEvent 514The 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 515manpage), with the additional members C<row> and C<col>, which are the
499and column under the mouse cursor. 516(real, not screen-based) row and column under the mouse cursor.
500 517
501C<on_key_press> additionally receives the string rxvt-unicode would 518C<on_key_press> additionally receives the string rxvt-unicode would
502output, if any, in locale-specific encoding. 519output, if any, in locale-specific encoding.
503 520
504subwindow. 521subwindow.
534 551
535our $LIBDIR; 552our $LIBDIR;
536our $RESNAME; 553our $RESNAME;
537our $RESCLASS; 554our $RESCLASS;
538our $RXVTNAME; 555our $RXVTNAME;
556
557our $NOCHAR = chr 0xfffe;
539 558
540=head2 Variables in the C<urxvt> Package 559=head2 Variables in the C<urxvt> Package
541 560
542=over 4 561=over 4
543 562
1257 1276
1258Normally its not a good idea to use this function, as programs might be 1277Normally 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 1278confused by changes in cursor position or scrolling. Its useful inside a
1260C<on_add_lines> hook, though. 1279C<on_add_lines> hook, though.
1261 1280
1281=item $term->scr_change_screen ($screen)
1282
1283Switch to given screen - 0 primary, 1 secondary.
1284
1262=item $term->cmd_parse ($octets) 1285=item $term->cmd_parse ($octets)
1263 1286
1264Similar to C<scr_add_lines>, but the argument must be in the 1287Similar to C<scr_add_lines>, but the argument must be in the
1265locale-specific encoding of the terminal and can contain command sequences 1288locale-specific encoding of the terminal and can contain command sequences
1266(escape codes) that will be interpreted. 1289(escape codes) that will be interpreted.
1349=item $modifiermask = $term->ModNumLockMask 1372=item $modifiermask = $term->ModNumLockMask
1350 1373
1351Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1374Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1352AltGr), the meta key (often Alt) and the num lock key, if applicable. 1375AltGr), the meta key (often Alt) and the num lock key, if applicable.
1353 1376
1377=item $screen = $term->current_screen
1378
1379Returns the currently displayed screen (0 primary, 1 secondary).
1380
1354=item $view_start = $term->view_start ([$newvalue]) 1381=item $view_start = $term->view_start ([$newvalue])
1355 1382
1356Returns the row number of the topmost displayed line. Maximum value is 1383Returns the row number of the topmost displayed line. Maximum value is
1357C<0>, which displays the normal terminal contents. Lower values scroll 1384C<0>, which displays the normal terminal contents. Lower values scroll
1358this many lines into the scrollback buffer. 1385this many lines into the scrollback buffer.
1376If C<$new_text> is specified, it will replace characters in the current 1403If C<$new_text> is specified, it will replace characters in the current
1377line, starting at column C<$start_col> (default C<0>), which is useful 1404line, 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 1405to replace only parts of a line. The font index in the rendition will
1379automatically be updated. 1406automatically be updated.
1380 1407
1381C<$text> is in a special encoding: tabs and wide characters that use more 1408C<$text> is in a special encoding: tabs and wide characters that use
1382than one cell when displayed are padded with urxvt::NOCHAR characters 1409more than one cell when displayed are padded with C<$urxvt::NOCHAR>
1383(C<chr 65535>). Characters with combining characters and other characters 1410characters. Characters with combining characters and other characters that
1384that do not fit into the normal tetx encoding will be replaced with 1411do not fit into the normal tetx encoding will be replaced with characters
1385characters in the private use area. 1412in the private use area.
1386 1413
1387You have to obey this encoding when changing text. The advantage is 1414You have to obey this encoding when changing text. The advantage is
1388that C<substr> and similar functions work on screen cells and not on 1415that C<substr> and similar functions work on screen cells and not on
1389characters. 1416characters.
1390 1417
1564=item $term->ungrab 1591=item $term->ungrab
1565 1592
1566Calls XUngrab for the most recent grab. Is called automatically on 1593Calls 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 1594evaluation errors, as it is better to lose the grab in the error case as
1568the session. 1595the session.
1596
1597=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1598
1599=item $atom_name = $term->XGetAtomName ($atom)
1600
1601=item @atoms = $term->XListProperties ($window)
1602
1603=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1604
1605=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1606
1607=item $term->XDeleteProperty ($window, $property)
1608
1609=item $window = $term->DefaultRootWindow
1610
1611=item $term->XReparentWindow ($window, $parent, [$x, $y])
1612
1613=item $term->XMapWindow ($window)
1614
1615=item $term->XUnmapWindow ($window)
1616
1617=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1618
1619=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1620
1621=item $term->XChangeInput ($window, $add_events[, $del_events])
1622
1623Various X or X-related functions. The C<$term> object only serves as
1624the source of the display, otherwise those functions map more-or-less
1625directory onto the X functions of the same name.
1569 1626
1570=back 1627=back
1571 1628
1572=cut 1629=cut
1573 1630

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines