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.120 by root, Fri Jan 20 22:05:41 2006 UTC vs.
Revision 1.122 by root, Sat Jan 21 08:07:38 2006 UTC

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
175To avoid too many false positives, this is only done when:
176
177=over 4
178
179=item - the mouse is on the same (multi-row-) line as the text cursor.
180
181=item - the primary screen is currently being displayed.
182
183=item - the text cursor is visible.
184
185=back
186
187The normal selection mechanism isn't disabled, so quick successive clicks
188might interfere with selection creation in harmless ways.
189
167=item tabbed 190=item tabbed
168 191
169This transforms the terminal into a tabbar with additional terminals, that 192This transforms the terminal into a tabbar with additional terminals, that
170is, it implements what is commonly refered to as "tabbed terminal". The topmost line 193is, 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 194displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
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
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