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.2 by root, Mon Jan 2 17:21:59 2006 UTC vs.
Revision 1.9 by root, Tue Jan 3 21:15:22 2006 UTC

… …
15 <li><a href="#name">NAME</a></li> 15 <li><a href="#name">NAME</a></li>
16 <li><a href="#synopsis">SYNOPSIS</a></li> 16 <li><a href="#synopsis">SYNOPSIS</a></li>
17 <li><a href="#description">DESCRIPTION</a></li> 17 <li><a href="#description">DESCRIPTION</a></li>
18 <ul> 18 <ul>
19 19
20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li>
21 <li><a href="#general_api_considerations">General API Considerations</a></li>
20 <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>
21 <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>
22 <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>
23 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 27 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
24 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 28 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
25 </ul> 29 </ul>
26 30
… …
35<!-- INDEX END --> 39<!-- INDEX END -->
36 40
37<hr /> 41<hr />
38<p> 42<p>
39</p> 43</p>
44<hr />
40<h1><a name="name">NAME</a></h1> 45<h1><a name="name">NAME</a></h1>
41<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> 46<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
42<p> 47<p>
43</p> 48</p>
44<hr /> 49<hr />
45<h1><a name="synopsis">SYNOPSIS</a></h1> 50<h1><a name="synopsis">SYNOPSIS</a></h1>
46<p>* Put your scripts into <em>/opt/rxvt/lib/urxvt/perl-ext/</em>, they will be loaded automatically.</p> 51<pre>
47<p>* Each script will only be loaded once, even in urxvtd, and will be valid 52 # create a file grab_test in $HOME:</pre>
48globally.</p>
49<p>* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
50thus must be encoded as UTF-8.</p>
51<pre> 53<pre>
52 sub on_sel_grab { 54 sub on_sel_grab {
53 warn &quot;you selected &quot;, $_[0]-&gt;selection; 55 warn &quot;you selected &quot;, $_[0]-&gt;selection;
54 () 56 ()
55 }</pre> 57 }</pre>
56<pre> 58<pre>
57 1</pre> 59 # start a rxvt using it:</pre>
60<pre>
61 rxvt --perl-lib $HOME -pe grab_test</pre>
58<p> 62<p>
59</p> 63</p>
60<hr /> 64<hr />
61<h1><a name="description">DESCRIPTION</a></h1> 65<h1><a name="description">DESCRIPTION</a></h1>
66<p>Everytime a terminal object gets created, scripts specified via the
67<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
69thus must be encoded as UTF-8.</p>
70<p>Each script will only ever be loaded once, even in rxvtd, where
71scripts will be shared (but not enabled) for all terminals.</p>
72<p>
73</p>
74<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2>
75<p>This section describes the extensiosn delivered with this version. You can
76find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
77<p>You can activate them like this:</p>
78<pre>
79 rxvt -pe &lt;extensionname&gt;</pre>
80<dl>
81<dt><strong><a name="item_selection">selection</a></strong><br />
82</dt>
83<dd>
84Intelligent selection. This etxension tries to be more intelligent when the user
85extends selections (double-click).
86</dd>
87<dd>
88<p>It also offers the following bindable event:</p>
89</dd>
90<dl>
91<dt><strong><a name="item_rot13">rot13</a></strong><br />
92</dt>
93<dd>
94Rot-13 the selection when activated. Used via keyboard trigger:
95</dd>
96<dd>
97<pre>
98 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
99</dd>
100<p></p></dl>
101<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
102</dt>
103<dd>
104Displays a digital clock using the built-in overlay.
105</dd>
106<p></p>
107<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
108</dt>
109<dd>
110Displays a very simple digital clock in the upper right corner of the
111window. Illustrates overwriting the refresh callbacks to create your own
112overlays or changes.
113</dd>
114<p></p></dl>
115<p>
116</p>
117<h2><a name="general_api_considerations">General API Considerations</a></h2>
118<p>All objects (such as terminals, time watchers etc.) are typical
119reference-to-hash objects. The hash can be used to store anything you
120like. All members starting with an underscore (such as <code>_ptr</code> or
121<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
122modified).</p>
123<p>When objects are destroyed on the C++ side, the perl object hashes are
124emptied, so its best to store related objects such as time watchers and
125the like inside the terminal object so they get destroyed as soon as the
126terminal is destroyed.</p>
62<p> 127<p>
63</p> 128</p>
64<h2><a name="hooks">Hooks</a></h2> 129<h2><a name="hooks">Hooks</a></h2>
65<p>The following subroutines can be declared in loaded scripts, and will be called 130<p>The following subroutines can be declared in loaded scripts, and will be
66whenever the relevant event happens.</p> 131called whenever the relevant event happens.</p>
132<p>The first argument passed to them is an object private to each terminal
133and extension package. You can call all <code>urxvt::term</code> methods on it, but
134its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
135object that is shared between all packages is stored in the <code>term</code>
136member.</p>
67<p>All of them must return a boolean value. If it is true, then the event 137<p>All of them must return a boolean value. If it is true, then the event
68counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 138counts as being <em>consumed</em>, and the invocation of other hooks is skipped,
69and the relevant action might not be carried out by the C++ code.</p> 139and the relevant action might not be carried out by the C++ code.</p>
70<p>When in doubt, return a false value (preferably <code>()</code>).</p> 140<p>When in doubt, return a false value (preferably <code>()</code>).</p>
71<dl> 141<dl>
… …
112</dd> 182</dd>
113<dd> 183<dd>
114<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 184<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p>
115</dd> 185</dd>
116<p></p> 186<p></p>
187<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
188</dt>
189<dd>
190Called whenever the user tries to extend the selection (e.g. with a double
191click) and is either supposed to return false (normal operation), or
192should extend the selection itelf and return true to suppress the built-in
193processing.
194</dd>
195<dd>
196<p>See the <em>selection</em> example extension.</p>
197</dd>
198<p></p>
117<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 199<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
118</dt> 200</dt>
119<dd> 201<dd>
120Called whenever the window gets the keyboard focus, before urxvt does 202Called whenever the window gets the keyboard focus, before urxvt does
121focus in processing. 203focus in processing.
… …
167<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> 249<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br />
168</dt> 250</dt>
169<dd> 251<dd>
170Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 252Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
171</dd> 253</dd>
254<p></p>
255<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br />
256</dt>
257<dd>
258Called whenever the user presses a key combination that has a
259<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
260resource in the <code>rxvt(1)</code> manpage).
261</dd>
262<p></p></dl>
263<p>
264</p>
265<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
266<dl>
267<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
268</dt>
269<dd>
270The current terminal. Whenever a callback/Hook is bein executed, this
271variable stores the current <code>urxvt::term</code> object.
272</dd>
172<p></p></dl> 273<p></p></dl>
173<p> 274<p>
174</p> 275</p>
175<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 276<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
176<dl> 277<dl>
… …
183</dd> 284</dd>
184<p></p> 285<p></p>
185<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br /> 286<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br />
186</dt> 287</dt>
187<dd> 288<dd>
188Calls <code>rxvt_warn</code> witht eh given string which should not include a 289Calls <code>rxvt_warn</code> with the given string which should not include a
189newline. The module also overwrites the <code>warn</code> builtin with a function 290newline. The module also overwrites the <code>warn</code> builtin with a function
190that calls this function. 291that calls this function.
191</dd> 292</dd>
192<dd> 293<dd>
193<p>Using this function has the advantage that its output ends up in the 294<p>Using this function has the advantage that its output ends up in the
194correct place, e.g. on stderr of the connecting urxvtc client.</p> 295correct place, e.g. on stderr of the connecting urxvtc client.</p>
195</dd> 296</dd>
196<p></p> 297<p></p>
197<dt><strong><a name="item__24cellwidth__3d_urxvt_3a_3awcswidth__24string">$cellwidth = urxvt::wcswidth $string</a></strong><br />
198</dt>
199<dd>
200Returns the number of screen-cells this string would need. Correctly
201accounts for wide and combining characters.
202</dd>
203<p></p>
204<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 298<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
205</dt> 299</dt>
206<dd> 300<dd>
207Returns the ``current time'' (as per the event loop). 301Returns the ``current time'' (as per the event loop).
302</dd>
303<p></p></dl>
304<p>
305</p>
306<h2><a name="rendition">RENDITION</a></h2>
307<p>Rendition bitsets contain information about colour, font, font styles and
308similar information for each screen cell.</p>
309<p>The following ``macros'' deal with changes in rendition sets. You should
310never just create a bitset, you should always modify an existing one,
311as they contain important information required for correct operation of
312rxvt-unicode.</p>
313<dl>
314<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br />
315</dt>
316<dd>
317Returns the default rendition, as used when the terminal is starting up or
318being reset. Useful as a base to start when creating renditions.
319</dd>
320<p></p>
321<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
322</dt>
323<dd>
324Return the rendition mask used for overlays by default.
325</dd>
326<p></p>
327<dt><strong><a name="item__24rendbit__3d_urxvt_3a_3ars_bold_2c_rs_italic_2c_">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong><br />
328</dt>
329<dd>
330Return the bit that enabled bold, italic, blink, reverse-video and
331underline, respectively. To enable such a style, just logically OR it into
332the bitset.
333</dd>
334<p></p>
335<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br />
336</dt>
337<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
338</dt>
339<dd>
340Return the foreground/background colour index, respectively.
341</dd>
342<p></p>
343<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br />
344</dt>
345<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br />
346</dt>
347<dd>
348Replace the foreground/background colour in the rendition mask with the
349specified one.
350</dd>
351<p></p>
352<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br />
353</dt>
354<dd>
355Return the ``custom'' value: Every rendition has 5 bits for use by
356extensions. They can be set and changed as you like and are initially
357zero.
358</dd>
359<p></p>
360<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br />
361</dt>
362<dd>
363Change the custom value.
208</dd> 364</dd>
209<p></p></dl> 365<p></p></dl>
210<p> 366<p>
211</p> 367</p>
212<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 368<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
… …
241<pre> 397<pre>
242 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 398 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
243 borderLess color cursorBlink cursorUnderline cutchars delete_key 399 borderLess color cursorBlink cursorUnderline cutchars delete_key
244 display_name embed ext_bwidth fade font geometry hold iconName 400 display_name embed ext_bwidth fade font geometry hold iconName
245 imFont imLocale inputMethod insecure int_bwidth intensityStyles 401 imFont imLocale inputMethod insecure int_bwidth intensityStyles
246 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 402 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
247 modifier mouseWheelScrollPage name pastableTabs path pointerBlank 403 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
248 pointerBlankDelay preeditType print_pipe pty_fd reverseVideo saveLines 404 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
249 scrollBar scrollBar_align scrollBar_floating scrollBar_right 405 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
250 scrollBar_thickness scrollTtyKeypress scrollTtyOutput scrollWithBuffer 406 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
251 scrollstyle secondaryScreen secondaryScroll selectstyle shade term_name 407 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
252 title transparent transparent_all tripleclickwords utmpInhibit 408 shade term_name title transparent transparent_all tripleclickwords
253 visualBell</pre> 409 utmpInhibit visualBell</pre>
254</dd> 410</dd>
255<p></p> 411<p></p>
256<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 412<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
257</dt> 413</dt>
258<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 414<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
… …
269<dd> 425<dd>
270Try to request the primary selection from the server (for example, as set 426Try to request the primary selection from the server (for example, as set
271by the next method). 427by the next method).
272</dd> 428</dd>
273<p></p> 429<p></p>
274<dt><strong><a name="item_selection">$oldtext = $term-&gt;selection ([$newtext])</a></strong><br /> 430<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
275</dt> 431</dt>
276<dd> 432<dd>
277Return the current selection text and optionally replace it by <code>$newtext</code>. 433Return the current selection text and optionally replace it by <code>$newtext</code>.
278</dd> 434</dd>
279<p></p>
280<dt><strong><a name="item_scr_overlay">$term-&gt;scr_overlay ($x, $y, $text)</a></strong><br />
281</dt>
282<dd> 435<dd>
436<p>#=item $term-&gt;overlay ($x, $y, $text)
437#
283Create a simple multi-line overlay box. See the next method for details. 438#Create a simple multi-line overlay box. See the next method for details.
439#
440#=cut</p>
441</dd>
284</dd> 442<dd>
443<p>sub urxvt::term::scr_overlay {
444die;
445 my ($self, $x, $y, $text) = @_;</p>
446</dd>
447<dd>
448<pre>
449 my @lines = split /\n/, $text;</pre>
450</dd>
451<dd>
452<pre>
453 my $w = 0;
454 for (map $self-&gt;strwidth ($_), @lines) {
455 $w = $_ if $w &lt; $_;
456 }</pre>
457</dd>
458<dd>
459<pre>
460 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
461 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
462}</pre>
463</dd>
285<p></p> 464<p></p>
286<dt><strong><a name="item_scr_overlay_new">$term-&gt;scr_overlay_new ($x, $y, $width, $height)</a></strong><br /> 465<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
287</dt> 466</dt>
288<dd> 467<dd>
289Create a new (empty) overlay at the given position with the given 468Create a new (empty) overlay at the given position with the given
290width/height. A border will be put around the box. If either <code>$x</code> or 469width/height. <code>$rstyle</code> defines the initial rendition style
291<code>$y</code> is negative, then this is counted from the right/bottom side, 470(default: <code>OVERLAY_RSTYLE</code>).
292respectively.
293</dd>
294<p></p>
295<dt><strong><a name="item_scr_overlay_off">$term-&gt;scr_overlay_off</a></strong><br />
296</dt>
297<dd> 471</dd>
298Switch the overlay off again.
299</dd> 472<dd>
300<p></p> 473<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put
301<dt><strong><a name="item_scr_overlay_set_char">$term-&gt;scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)</a></strong><br /> 474around the box.</p>
302</dt>
303<dd> 475</dd>
304Put a single character (specified numerically) at the given overlay
305position.
306</dd> 476<dd>
307<p></p> 477<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the
308<dt><strong><a name="item_scr_overlay_set">$term-&gt;scr_overlay_set ($x, $y, $text)</a></strong><br /> 478right/bottom side, respectively.</p>
309</dt>
310<dd> 479</dd>
311Write a string at the given position into the overlay. 480<dd>
481<p>This method returns an urxvt::overlay object. The overlay will be visible
482as long as the perl object is referenced.</p>
483</dd>
484<dd>
485<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
486</dd>
487<dl>
488<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
489</dt>
490<dd>
491Similar to <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> and <a href="#item_row_r"><code>$term-&gt;ROW_r</code></a> in that it puts
492text in rxvt-unicode's special encoding and an array of rendition values
493at a specific position inside the overlay.
494</dd>
495<p></p>
496<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
497</dt>
498<dd>
499If visible, hide the overlay, but do not destroy it.
500</dd>
501<p></p>
502<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
503</dt>
504<dd>
505If hidden, display the overlay again.
506</dd>
507<p></p></dl>
508<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br />
509</dt>
510<dd>
511Returns the number of screen-cells this string would need. Correctly
512accounts for wide and combining characters.
513</dd>
514<p></p>
515<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br />
516</dt>
517<dd>
518Convert the given text string into the corresponding locale encoding.
519</dd>
520<p></p>
521<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br />
522</dt>
523<dd>
524Convert the given locale-encoded octets into a perl string.
525</dd>
526<p></p>
527<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
528</dt>
529<dd>
530Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
531pass characters instead of octets, you should convert your strings first
532to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
533</dd>
534<p></p>
535<dt><strong><a name="item_nrow">$nrow = $term-&gt;nrow</a></strong><br />
536</dt>
537<dt><strong><a name="item_ncol">$ncol = $term-&gt;ncol</a></strong><br />
538</dt>
539<dd>
540Return the number of rows/columns of the terminal window (i.e. as
541specified by <code>-geometry</code>, excluding any scrollback).
542</dd>
543<p></p>
544<dt><strong><a name="item_nsaved">$nsaved = $term-&gt;nsaved</a></strong><br />
545</dt>
546<dd>
547Returns the number of lines in the scrollback buffer.
548</dd>
549<p></p>
550<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
551</dt>
552<dd>
553Returns the negative row number of the topmost line. Minimum value is
554<code>0</code>, which displays the normal terminal contents. Larger values scroll
555this many lines into the scrollback buffer.
556</dd>
557<p></p>
558<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
559</dt>
560<dd>
561Requests a screen refresh. At the next opportunity, rxvt-unicode will
562compare the on-screen display with its stored representation. If they
563differ, it redraws the differences.
564</dd>
565<dd>
566<p>Used after changing terminal contents to display them.</p>
567</dd>
568<p></p>
569<dt><strong><a name="item_row_t">$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br />
570</dt>
571<dd>
572Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
573is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
574terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
575line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line
576is requested.
577</dd>
578<dd>
579<p>If <code>$new_text</code> is specified, it will replace characters in the current
580line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
581to replace only parts of a line. The font index in the rendition will
582automatically be updated.</p>
583</dd>
584<dd>
585<p><code>$text</code> is in a special encoding: tabs and wide characters that use more
586than one cell when displayed are padded with urxvt::NOCHAR characters
587(<code>chr 65535</code>). Characters with combining characters and other characters
588that do not fit into the normal tetx encoding will be replaced with
589characters in the private use area.</p>
590</dd>
591<dd>
592<p>You have to obey this encoding when changing text. The advantage is
593that <code>substr</code> and similar functions work on screen cells and not on
594characters.</p>
595</dd>
596<dd>
597<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a>
598can be used to convert normal strings into this encoding and vice versa.</p>
599</dd>
600<p></p>
601<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
602</dt>
603<dd>
604Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition
605bitsets. Rendition bitsets contain information about colour, font, font
606styles and similar information. See also <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>.
607</dd>
608<dd>
609<p>When setting rendition, the font mask will be ignored.</p>
610</dd>
611<dd>
612<p>See the section on RENDITION, above.</p>
613</dd>
614<p></p>
615<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
616</dt>
617<dd>
618Returns the number of screen cells that are in use (``the line
619length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
620line is joined with the following one.
621</dd>
622<p></p>
623<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
624</dt>
625<dd>
626Returns true if the row is part of a multiple-row logical ``line'' (i.e.
627joined with the following row), which means all characters are in use
628and it is continued on the next row (and possibly a continuation of the
629previous row(s)).
630</dd>
631<p></p>
632<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
633</dt>
634<dd>
635Create and return a new <code>urxvt::line</code> object that stores information
636about the logical line that row <code>$row_number</code> is part of. It supports the
637following methods:
638</dd>
639<dl>
640<dt><strong><a name="item_t">$text = $line-&gt;t</a></strong><br />
641</dt>
642<dd>
643Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
644</dd>
645<p></p>
646<dt><strong><a name="item_r">$rend = $line-&gt;r</a></strong><br />
647</dt>
648<dd>
649Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
650</dd>
651<p></p>
652<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
653</dt>
654<dd>
655Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
656</dd>
657<p></p>
658<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
659</dt>
660<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
661</dt>
662<dd>
663Return the row number of the first/last row of the line, respectively.
664</dd>
665<p></p>
666<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
667</dt>
668<dd>
669Returns the character offset of the given row|col pair within the logical
670line.
671</dd>
672<p></p>
673<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
674</dt>
675<dd>
676Translates a string offset into terminal coordinates again.
677</dd>
678<p></p></dl>
679<dt><strong>($row, $col) = $line-&gt;coord_of ($offset)
680=item $text = $term-&gt;special_encode $string</strong><br />
681</dt>
682<dd>
683Converts a perl string into the special encoding used by rxvt-unicode,
684where one character corresponds to one screen cell. See
685<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
686</dd>
687<p></p>
688<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
689</dt>
690<dd>
691Converts rxvt-unicodes text reprsentation into a perl string. See
692<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
312</dd> 693</dd>
313<p></p></dl> 694<p></p></dl>
314<p> 695<p>
315</p> 696</p>
316<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 697<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
317<p>This class implements timer watchers/events. Time is represented as a 698<p>This class implements timer watchers/events. Time is represented as a
318fractional number of seconds since the epoch. Example:</p> 699fractional number of seconds since the epoch. Example:</p>
319<pre> 700<pre>
320 # create a digital clock display in upper right corner 701 $term-&gt;{overlay} = $term-&gt;overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
321 $term-&gt;{timer} = urxvt::timer 702 $term-&gt;{timer} = urxvt::timer
322 -&gt;new 703 -&gt;new
323 -&gt;start (urxvt::NOW) 704 -&gt;interval (1)
324 -&gt;cb (sub { 705 -&gt;cb (sub {
325 my ($timer) = @_;
326 my $time = $timer-&gt;at;
327 $timer-&gt;start ($time + 1);
328 $self-&gt;scr_overlay (-1, 0, 706 $term-&gt;{overlay}-&gt;set (0, 0,
329 POSIX::strftime &quot;%H:%M:%S&quot;, localtime $time); 707 sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]);
330 });</pre> 708 });</pre>
331<dl> 709<dl>
332<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> 710<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br />
333</dt> 711</dt>
334<dd> 712<dd>
335Create a new timer object in stopped state. 713Create a new timer object in started state. It is scheduled to fire
714immediately.
336</dd> 715</dd>
337<p></p> 716<p></p>
338<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br /> 717<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br />
339</dt> 718</dt>
340<dd> 719<dd>
… …
345</dt> 724</dt>
346<dd> 725<dd>
347Return the time this watcher will fire next. 726Return the time this watcher will fire next.
348</dd> 727</dd>
349<p></p> 728<p></p>
350<dt><strong><a name="item_set">$timer = $timer-&gt;set ($tstamp)</a></strong><br /> 729<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br />
351</dt> 730</dt>
352<dd> 731<dd>
353Set the time the event is generated to $tstamp. 732Set the time the event is generated to $tstamp.
733</dd>
734<p></p>
735<dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong><br />
736</dt>
737<dd>
738Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
739stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
740is automatically rescheduled at the given intervals.
354</dd> 741</dd>
355<p></p> 742<p></p>
356<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br /> 743<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br />
357</dt> 744</dt>
358<dd> 745<dd>

Diff Legend

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