ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.html
(Generate patch)

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.13 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.15 by root, Sun Jan 8 00:20:12 2006 UTC

… …
22 <li><a href="#hooks">Hooks</a></li> 22 <li><a href="#hooks">Hooks</a></li>
23 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> 23 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li>
24 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> 24 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li>
25 <li><a href="#rendition">RENDITION</a></li> 25 <li><a href="#rendition">RENDITION</a></li>
26 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> 26 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
27 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
27 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 28 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
28 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 29 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
29 </ul> 30 </ul>
30 31
31 <li><a href="#environment">ENVIRONMENT</a></li> 32 <li><a href="#environment">ENVIRONMENT</a></li>
… …
61 rxvt --perl-lib $HOME -pe grab_test</pre> 62 rxvt --perl-lib $HOME -pe grab_test</pre>
62<p> 63<p>
63</p> 64</p>
64<hr /> 65<hr />
65<h1><a name="description">DESCRIPTION</a></h1> 66<h1><a name="description">DESCRIPTION</a></h1>
66<p>Everytime a terminal object gets created, scripts specified via the 67<p>Everytime a terminal object gets created, extension scripts specified via
67<code>perl</code> resource are loaded and associated with it.</p> 68the <code>perl</code> resource are loaded and associated with it.</p>
68<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 69<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
69thus must be encoded as UTF-8.</p> 70thus must be encoded as UTF-8.</p>
70<p>Each script will only ever be loaded once, even in rxvtd, where 71<p>Each script will only ever be loaded once, even in rxvtd, where
71scripts will be shared (but not enabled) for all terminals.</p> 72scripts will be shared (but not enabled) for all terminals.</p>
72<p> 73<p>
… …
102<p></p></dl> 103<p></p></dl>
103<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 104<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
104</dt> 105</dt>
105<dd> 106<dd>
106Displays a digital clock using the built-in overlay. 107Displays a digital clock using the built-in overlay.
108</dd>
109<p></p>
110<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
111</dt>
112<dd>
113Uses per-line display filtering (<code>on_line_update</code>) to underline urls.
114</dd>
115<p></p>
116<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
117</dt>
118<dd>
119A not very useful example of filtering all text output to the terminal,
120by replacing all line-drawing characters (U+2500 .. U+259F) by a
121similar-looking ascii character.
107</dd> 122</dd>
108<p></p> 123<p></p>
109<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 124<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
110</dt> 125</dt>
111<dd> 126<dd>
… …
124modified).</p> 139modified).</p>
125<p>When objects are destroyed on the C++ side, the perl object hashes are 140<p>When objects are destroyed on the C++ side, the perl object hashes are
126emptied, so its best to store related objects such as time watchers and 141emptied, so its best to store related objects such as time watchers and
127the like inside the terminal object so they get destroyed as soon as the 142the like inside the terminal object so they get destroyed as soon as the
128terminal is destroyed.</p> 143terminal is destroyed.</p>
144<p>Argument names also often indicate the type of a parameter. Here are some
145hints on what they mean:</p>
146<dl>
147<dt><strong><a name="item__24text">$text</a></strong><br />
148</dt>
149<dd>
150Rxvt-unicodes special way of encoding text, where one ``unicode'' character
151always represents one screen cell. See <em>row_t</em> for a discussion of this format.
152</dd>
153<p></p>
154<dt><strong><a name="item__24string">$string</a></strong><br />
155</dt>
156<dd>
157A perl text string, with an emphasis on <em>text</em>. It can store all unicode
158characters and is to be distinguished with text encoded in a specific
159encoding (often locale-specific) and binary data.
160</dd>
161<p></p>
162<dt><strong><a name="item__24octets">$octets</a></strong><br />
163</dt>
164<dd>
165Either binary data or - more common - a text string encoded in a
166locale-specific way.
167</dd>
168<p></p></dl>
129<p> 169<p>
130</p> 170</p>
131<h2><a name="hooks">Hooks</a></h2> 171<h2><a name="hooks">Hooks</a></h2>
132<p>The following subroutines can be declared in loaded scripts, and will be 172<p>The following subroutines can be declared in extension files, and will be
133called whenever the relevant event happens.</p> 173called whenever the relevant event happens.</p>
134<p>The first argument passed to them is an object private to each terminal 174<p>The first argument passed to them is an object private to each terminal
135and extension package. You can call all <code>urxvt::term</code> methods on it, but 175and extension package. You can call all <code>urxvt::term</code> methods on it, but
136its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> 176its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
137object that is shared between all packages is stored in the <code>term</code> 177object that is shared between all packages is stored in the <code>term</code>
138member.</p> 178member. It is, however, blessed intot he package of the extension script,
179so for all practical purposes you can treat an extension script as a class.</p>
139<p>All of them must return a boolean value. If it is true, then the event 180<p>All of them must return a boolean value. If it is true, then the event
140counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 181counts as being <em>consumed</em>, and the invocation of other hooks is skipped,
141and the relevant action might not be carried out by the C++ code.</p> 182and the relevant action might not be carried out by the C++ code.</p>
142<p>When in doubt, return a false value (preferably <code>()</code>).</p> 183<p>When in doubt, return a false value (preferably <code>()</code>).</p>
143<dl> 184<dl>
144<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 185<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
145</dt> 186</dt>
146<dd> 187<dd>
147Called after a new terminal object has been initialized, but before 188Called after a new terminal object has been initialized, but before
148windows are created or the command gets run. 189windows are created or the command gets run. Most methods are unsafe to
190call or deliver senseless data, as terminal size and other characteristics
191have not yet been determined. You can safely query and change resources,
192though.
149</dd> 193</dd>
150<p></p> 194<p></p>
151<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 195<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
152</dt> 196</dt>
153<dd> 197<dd>
… …
194should extend the selection itelf and return true to suppress the built-in 238should extend the selection itelf and return true to suppress the built-in
195processing. 239processing.
196</dd> 240</dd>
197<dd> 241<dd>
198<p>See the <em>selection</em> example extension.</p> 242<p>See the <em>selection</em> example extension.</p>
199</dd>
200<p></p>
201<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
202</dt>
203<dd>
204Called whenever the window gets the keyboard focus, before urxvt does
205focus in processing.
206</dd>
207<p></p>
208<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
209</dt>
210<dd>
211Called wheneever the window loses keyboard focus, before urxvt does focus
212out processing.
213</dd> 243</dd>
214<p></p> 244<p></p>
215<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 245<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
216</dt> 246</dt>
217<dd> 247<dd>
… …
253<p>Be careful not ever to trust (in a security sense) the data you receive, 283<p>Be careful not ever to trust (in a security sense) the data you receive,
254as its source can not easily be controleld (e-mail content, messages from 284as its source can not easily be controleld (e-mail content, messages from
255other users on the same system etc.).</p> 285other users on the same system etc.).</p>
256</dd> 286</dd>
257<p></p> 287<p></p>
288<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
289</dt>
290<dd>
291Called whenever text is about to be output, with the text as argument. You
292can filter/change and output the text yourself by returning a true value
293and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
294might be very slow, however, as your hook is called for <strong>all</strong> text being
295output.
296</dd>
297<p></p>
298<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
299</dt>
300<dd>
301Called whenever a line was updated or changed. Can be used to filter
302screen output (e.g. underline urls or other useless stuff). Only lines
303that are being shown will be filtered, and, due to performance reasons,
304not always immediately.
305</dd>
306<dd>
307<p>The row number is always the topmost row of the line if the line spans
308multiple rows.</p>
309</dd>
310<dd>
311<p>Please note that, if you change the line, then the hook might get called
312later with the already-modified line (e.g. if unrelated parts change), so
313you cannot just toggle rendition bits, but only set them.</p>
314</dd>
315<p></p>
258<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 316<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
259</dt> 317</dt>
260<dd> 318<dd>
261Called just before the screen gets redrawn. Can be used for overlay 319Called just before the screen gets redrawn. Can be used for overlay
262or similar effects by modify terminal contents in refresh_begin, and 320or similar effects by modify terminal contents in refresh_begin, and
… …
275<dd> 333<dd>
276Called whenever the user presses a key combination that has a 334Called whenever the user presses a key combination that has a
277<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 335<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
278resource in the <code>rxvt(1)</code> manpage). 336resource in the <code>rxvt(1)</code> manpage).
279</dd> 337</dd>
338<p></p>
339<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
340</dt>
341<dd>
342Called whenever the window gets the keyboard focus, before rxvt-unicode
343does focus in processing.
344</dd>
345<p></p>
346<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
347</dt>
348<dd>
349Called wheneever the window loses keyboard focus, before rxvt-unicode does
350focus out processing.
351</dd>
352<p></p>
353<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br />
354</dt>
355<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br />
356</dt>
357<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
358</dt>
359<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
360</dt>
361<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
362</dt>
363<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
364</dt>
365<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
366</dt>
367<dd>
368Called whenever the corresponding X event is received for the terminal If
369the hook returns true, then the even will be ignored by rxvt-unicode.
370</dd>
371<dd>
372<p>The event is a hash with most values as named by Xlib (see the XEvent
373manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
374and column under the mouse cursor.</p>
375</dd>
376<dd>
377<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
378output, if any, in locale-specific encoding.</p>
379</dd>
380<dd>
381<p>subwindow.</p>
382</dd>
280<p></p></dl> 383<p></p></dl>
281<p> 384<p>
282</p> 385</p>
283<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 386<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
284<dl> 387<dl>
285<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 388<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
286</dt> 389</dt>
287<dd> 390<dd>
288The current terminal. Whenever a callback/Hook is bein executed, this 391The current terminal. This variable stores the current <code>urxvt::term</code>
289variable stores the current <code>urxvt::term</code> object. 392object, whenever a callback/hook is executing.
290</dd> 393</dd>
291<p></p></dl> 394<p></p></dl>
292<p> 395<p>
293</p> 396</p>
294<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 397<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
295<dl> 398<dl>
399<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
400</dt>
401<dd>
402Creates a new terminal, very similar as if you had started it with
403<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
404if the new instance couldn't be created. Returns <code>undef</code> if the new
405instance didn't initialise perl, and the terminal object otherwise. The
406<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
407</dd>
408<p></p>
296<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 409<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
297</dt> 410</dt>
298<dd> 411<dd>
299Fatally aborts execution with the given error message. Avoid at all 412Fatally aborts execution with the given error message. Avoid at all
300costs! The only time this is acceptable is when the terminal process 413costs! The only time this is acceptable is when the terminal process
… …
315<p></p> 428<p></p>
316<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 429<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
317</dt> 430</dt>
318<dd> 431<dd>
319Returns the ``current time'' (as per the event loop). 432Returns the ``current time'' (as per the event loop).
433</dd>
434<p></p>
435<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
436</dt>
437<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
438Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
439Button4Mask, Button5Mask, AnyModifier</a></strong><br />
440</dt>
441<dd>
442Various constants for use in X events.
320</dd> 443</dd>
321<p></p></dl> 444<p></p></dl>
322<p> 445<p>
323</p> 446</p>
324<h2><a name="rendition">RENDITION</a></h2> 447<h2><a name="rendition">RENDITION</a></h2>
… …
383<p></p></dl> 506<p></p></dl>
384<p> 507<p>
385</p> 508</p>
386<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 509<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
387<dl> 510<dl>
511<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
512</dt>
513<dd>
514Destroy the terminal object (close the window, free resources etc.).
515</dd>
516<p></p>
517<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
518</dt>
519<dd>
520Returns true if the option specified by <code>$optval</code> is enabled, and
521optionally change it. All option values are stored by name in the hash
522<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
523</dd>
524<dd>
525<p>Here is a a likely non-exhaustive list of option names, please see the
526source file <em>/src/optinc.h</em> to see the actual list:</p>
527</dd>
528<dd>
529<pre>
530 borderLess console cursorBlink cursorUnderline hold iconic insecure
531 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
532 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
533 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
534 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
535 tripleclickwords utmpInhibit visualBell</pre>
536</dd>
537<p></p>
388<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 538<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
389</dt> 539</dt>
390<dd> 540<dd>
391Returns the current resource value associated with a given name and 541Returns the current resource value associated with a given name and
392optionally sets a new value. Setting values is most useful in the <code>init</code> 542optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
406<p>Please note that resource strings will currently only be freed when the 556<p>Please note that resource strings will currently only be freed when the
407terminal is destroyed, so changing options frequently will eat memory.</p> 557terminal is destroyed, so changing options frequently will eat memory.</p>
408</dd> 558</dd>
409<dd> 559<dd>
410<p>Here is a a likely non-exhaustive list of resource names, not all of which 560<p>Here is a a likely non-exhaustive list of resource names, not all of which
411are supported in every build, please see the source to see the actual 561are supported in every build, please see the source file <em>/src/rsinc.h</em>
412list:</p> 562to see the actual list:</p>
413</dd> 563</dd>
414<dd> 564<dd>
415<pre> 565<pre>
416 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 566 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
417 borderLess color cursorBlink cursorUnderline cutchars delete_key 567 borderLess color cursorBlink cursorUnderline cutchars delete_key
… …
425 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 575 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
426 shade term_name title transparent transparent_all tripleclickwords 576 shade term_name title transparent transparent_all tripleclickwords
427 utmpInhibit visualBell</pre> 577 utmpInhibit visualBell</pre>
428</dd> 578</dd>
429<p></p> 579<p></p>
430<dt><strong><a name="item_screen_rstyle">$rend = $term-&gt;screen_rstyle ([$new_rstyle])</a></strong><br /> 580<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
431</dt> 581</dt>
432<dd> 582<dd>
433Return and optionally change the current rendition. Text thta is output by 583Return and optionally change the current rendition. Text that is output by
434the temrianl application will use this style. 584the terminal application will use this style.
435</dd> 585</dd>
436<p></p> 586<p></p>
437<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br /> 587<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
438</dt> 588</dt>
439<dd> 589<dd>
… …
467<dd> 617<dd>
468<p>#=item $term-&gt;overlay ($x, $y, $text) 618<p>#=item $term-&gt;overlay ($x, $y, $text)
469# 619#
470#Create a simple multi-line overlay box. See the next method for details. 620#Create a simple multi-line overlay box. See the next method for details.
471# 621#
472#=cut</p> 622#=cut
473</dd> 623#
474<dd>
475<p>sub urxvt::term::scr_overlay { 624#sub urxvt::term::scr_overlay {
476die;
477 my ($self, $x, $y, $text) = @_;</p> 625# my ($self, $x, $y, $text) = @_;
478</dd> 626#
479<dd>
480<pre>
481 my @lines = split /\n/, $text;</pre> 627# my @lines = split /\n/, $text;
482</dd> 628#
483<dd>
484<pre>
485 my $w = 0; 629# my $w = 0;
486 for (map $self-&gt;strwidth ($_), @lines) { 630# for (map $self-&gt;strwidth ($_), @lines) {
487 $w = $_ if $w &lt; $_; 631# $w = $_ if $w &lt; $_;
488 }</pre> 632# }
489</dd> 633#
490<dd>
491<pre>
492 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines); 634# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
493 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 635# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
494}</pre> 636#}</p>
495</dd> 637</dd>
496<p></p> 638<p></p>
497<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 639<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
498</dt> 640</dt>
499<dd> 641<dd>
… …
535</dt> 677</dt>
536<dd> 678<dd>
537If hidden, display the overlay again. 679If hidden, display the overlay again.
538</dd> 680</dd>
539<p></p></dl> 681<p></p></dl>
682<dt><strong><a name="item_popup">$popup = $term-&gt;popup ($event)</a></strong><br />
683</dt>
684<dd>
685Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
686<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
687currently).
688</dd>
689<p></p>
540<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 690<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
541</dt> 691</dt>
542<dd> 692<dd>
543Returns the number of screen-cells this string would need. Correctly 693Returns the number of screen-cells this string would need. Correctly
544accounts for wide and combining characters. 694accounts for wide and combining characters.
545</dd> 695</dd>
546<p></p> 696<p></p>
547<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 697<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
548</dt> 698</dt>
549<dd> 699<dd>
550Convert the given text string into the corresponding locale encoding. 700Convert the given text string into the corresponding locale encoding.
551</dd> 701</dd>
552<p></p> 702<p></p>
553<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 703<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
554</dt> 704</dt>
555<dd> 705<dd>
556Convert the given locale-encoded octets into a perl string. 706Convert the given locale-encoded octets into a perl string.
707</dd>
708<p></p>
709<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
710</dt>
711<dd>
712Write the given text string to the screen, as if output by the application
713running inside the terminal. It may not contain command sequences (escape
714codes), but is free to use line feeds, carriage returns and tabs. The
715string is a normal text string, not in locale-dependent encoding.
716</dd>
717<dd>
718<p>Normally its not a good idea to use this function, as programs might be
719confused by changes in cursor position or scrolling. Its useful inside a
720<code>on_add_lines</code> hook, though.</p>
721</dd>
722<p></p>
723<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
724</dt>
725<dd>
726Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
727locale-specific encoding of the terminal and can contain command sequences
728(escape codes) that will be interpreted.
557</dd> 729</dd>
558<p></p> 730<p></p>
559<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 731<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
560</dt> 732</dt>
561<dd> 733<dd>
562Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 734Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
563pass characters instead of octets, you should convert your strings first 735pass characters instead of octets, you should convert your strings first
564to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 736to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
565</dd> 737</dd>
566<p></p> 738<p></p>
739<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
740</dt>
741<dd>
742Return the window id of the toplevel window.
743</dd>
744<p></p>
745<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
746</dt>
747<dd>
748Return the window id of the terminal window.
749</dd>
750<p></p>
567<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 751<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
568</dt> 752</dt>
569<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 753<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
570</dt> 754</dt>
571<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 755<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
588</dt> 772</dt>
589<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 773<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
590</dt> 774</dt>
591<dd> 775<dd>
592Return various integers describing terminal characteristics. 776Return various integers describing terminal characteristics.
777</dd>
778<p></p>
779<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
780</dt>
781<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
782</dt>
783<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
784</dt>
785<dd>
786Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
787AltGr), the meta key (often Alt) and the num lock key, if applicable.
593</dd> 788</dd>
594<p></p> 789<p></p>
595<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 790<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
596</dt> 791</dt>
597<dd> 792<dd>
… …
625line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 820line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
626to replace only parts of a line. The font index in the rendition will 821to replace only parts of a line. The font index in the rendition will
627automatically be updated.</p> 822automatically be updated.</p>
628</dd> 823</dd>
629<dd> 824<dd>
630<p><code>$text</code> is in a special encoding: tabs and wide characters that use more 825<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
631than one cell when displayed are padded with urxvt::NOCHAR characters 826than one cell when displayed are padded with urxvt::NOCHAR characters
632(<code>chr 65535</code>). Characters with combining characters and other characters 827(<code>chr 65535</code>). Characters with combining characters and other characters
633that do not fit into the normal tetx encoding will be replaced with 828that do not fit into the normal tetx encoding will be replaced with
634characters in the private use area.</p> 829characters in the private use area.</p>
635</dd> 830</dd>
… …
680Create and return a new <code>urxvt::line</code> object that stores information 875Create and return a new <code>urxvt::line</code> object that stores information
681about the logical line that row <code>$row_number</code> is part of. It supports the 876about the logical line that row <code>$row_number</code> is part of. It supports the
682following methods: 877following methods:
683</dd> 878</dd>
684<dl> 879<dl>
685<dt><strong><a name="item_t">$text = $line-&gt;t</a></strong><br /> 880<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
686</dt> 881</dt>
687<dd> 882<dd>
688Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> 883Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
689</dd> 884</dd>
690<p></p> 885<p></p>
691<dt><strong><a name="item_r">$rend = $line-&gt;r</a></strong><br /> 886<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
692</dt> 887</dt>
693<dd> 888<dd>
694Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> 889Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
695</dd> 890</dd>
696<p></p> 891<p></p>
697<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br /> 892<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
698</dt> 893</dt>
699<dd> 894<dd>
… …
735<dd> 930<dd>
736Converts rxvt-unicodes text reprsentation into a perl string. See 931Converts rxvt-unicodes text reprsentation into a perl string. See
737<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 932<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
738</dd> 933</dd>
739<p></p></dl> 934<p></p></dl>
935<p>
936</p>
937<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
740<p> 938<p>
741</p> 939</p>
742<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 940<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
743<p>This class implements timer watchers/events. Time is represented as a 941<p>This class implements timer watchers/events. Time is represented as a
744fractional number of seconds since the epoch. Example:</p> 942fractional number of seconds since the epoch. Example:</p>

Diff Legend

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