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.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
181=item tabbed
182
183This transforms the terminal into a tabbar with additional terminals, that
184is, it implements what is commonly refered to as "tabbed terminal". The topmost line
185displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
186button per tab.
187
188Clicking a button will activate that tab. Pressing B<Shift-Left> and
189B<Shift-Right> will switch to the tab left or right of the current one,
190while B<Shift-Down> creates a new tab.
191
167=item mark-urls 192=item mark-urls
168 193
169Uses 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
170make them clickable. When middle-clicked, the program specified in the 195make them clickable. When middle-clicked, the program specified in the
171resource C<urlLauncher> (default C<x-www-browser>) will be started with 196resource C<urlLauncher> (default C<x-www-browser>) will be started with
465Called wheneever the window loses keyboard focus, before rxvt-unicode does 490Called wheneever the window loses keyboard focus, before rxvt-unicode does
466focus out processing. 491focus out processing.
467 492
468=item on_configure_notify $term, $event 493=item on_configure_notify $term, $event
469 494
495=item on_property_notify $term, $event
496
470=item on_key_press $term, $event, $keysym, $octets 497=item on_key_press $term, $event, $keysym, $octets
471 498
472=item on_key_release $term, $event, $keysym 499=item on_key_release $term, $event, $keysym
473 500
474=item on_button_press $term, $event 501=item on_button_press $term, $event
483 510
484Called whenever the corresponding X event is received for the terminal If 511Called whenever the corresponding X event is received for the terminal If
485the 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.
486 513
487The 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
488manpage), 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
489and column under the mouse cursor. 516(real, not screen-based) row and column under the mouse cursor.
490 517
491C<on_key_press> additionally receives the string rxvt-unicode would 518C<on_key_press> additionally receives the string rxvt-unicode would
492output, if any, in locale-specific encoding. 519output, if any, in locale-specific encoding.
493 520
494subwindow. 521subwindow.
524 551
525our $LIBDIR; 552our $LIBDIR;
526our $RESNAME; 553our $RESNAME;
527our $RESCLASS; 554our $RESCLASS;
528our $RXVTNAME; 555our $RXVTNAME;
556
557our $NOCHAR = chr 0xfffe;
529 558
530=head2 Variables in the C<urxvt> Package 559=head2 Variables in the C<urxvt> Package
531 560
532=over 4 561=over 4
533 562
1247 1276
1248Normally 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
1249confused by changes in cursor position or scrolling. Its useful inside a 1278confused by changes in cursor position or scrolling. Its useful inside a
1250C<on_add_lines> hook, though. 1279C<on_add_lines> hook, though.
1251 1280
1281=item $term->scr_change_screen ($screen)
1282
1283Switch to given screen - 0 primary, 1 secondary.
1284
1252=item $term->cmd_parse ($octets) 1285=item $term->cmd_parse ($octets)
1253 1286
1254Similar 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
1255locale-specific encoding of the terminal and can contain command sequences 1288locale-specific encoding of the terminal and can contain command sequences
1256(escape codes) that will be interpreted. 1289(escape codes) that will be interpreted.
1339=item $modifiermask = $term->ModNumLockMask 1372=item $modifiermask = $term->ModNumLockMask
1340 1373
1341Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1374Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1342AltGr), 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.
1343 1376
1377=item $screen = $term->current_screen
1378
1379Returns the currently displayed screen (0 primary, 1 secondary).
1380
1344=item $view_start = $term->view_start ([$newvalue]) 1381=item $view_start = $term->view_start ([$newvalue])
1345 1382
1346Returns the row number of the topmost displayed line. Maximum value is 1383Returns the row number of the topmost displayed line. Maximum value is
1347C<0>, which displays the normal terminal contents. Lower values scroll 1384C<0>, which displays the normal terminal contents. Lower values scroll
1348this many lines into the scrollback buffer. 1385this many lines into the scrollback buffer.
1366If 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
1367line, 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
1368to 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
1369automatically be updated. 1406automatically be updated.
1370 1407
1371C<$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
1372than one cell when displayed are padded with urxvt::NOCHAR characters 1409more than one cell when displayed are padded with C<$urxvt::NOCHAR>
1373(C<chr 65535>). Characters with combining characters and other characters 1410characters. Characters with combining characters and other characters that
1374that 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
1375characters in the private use area. 1412in the private use area.
1376 1413
1377You have to obey this encoding when changing text. The advantage is 1414You have to obey this encoding when changing text. The advantage is
1378that 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
1379characters. 1416characters.
1380 1417
1554=item $term->ungrab 1591=item $term->ungrab
1555 1592
1556Calls XUngrab for the most recent grab. Is called automatically on 1593Calls 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 1594evaluation errors, as it is better to lose the grab in the error case as
1558the 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.
1559 1626
1560=back 1627=back
1561 1628
1562=cut 1629=cut
1563 1630

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines