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.16 by root, Sun Jan 8 06:35:38 2006 UTC

… …
21 <li><a href="#general_api_considerations">General API Considerations</a></li> 21 <li><a href="#general_api_considerations">General API Considerations</a></li>
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__anyevent_class">The <code>urxvt::anyevent</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__term_class">The <code>urxvt::term</code> Class</a></li>
28 <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> 29 <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> 30 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
29 </ul> 31 </ul>
30 32
31 <li><a href="#environment">ENVIRONMENT</a></li> 33 <li><a href="#environment">ENVIRONMENT</a></li>
… …
61 rxvt --perl-lib $HOME -pe grab_test</pre> 63 rxvt --perl-lib $HOME -pe grab_test</pre>
62<p> 64<p>
63</p> 65</p>
64<hr /> 66<hr />
65<h1><a name="description">DESCRIPTION</a></h1> 67<h1><a name="description">DESCRIPTION</a></h1>
66<p>Everytime a terminal object gets created, scripts specified via the 68<p>Everytime a terminal object gets created, extension scripts specified via
67<code>perl</code> resource are loaded and associated with it.</p> 69the <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 70<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
69thus must be encoded as UTF-8.</p> 71thus must be encoded as UTF-8.</p>
70<p>Each script will only ever be loaded once, even in rxvtd, where 72<p>Each script will only ever be loaded once, even in rxvtd, where
71scripts will be shared (but not enabled) for all terminals.</p> 73scripts will be shared (but not enabled) for all terminals.</p>
72<p> 74<p>
… …
76find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 78find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
77<p>You can activate them like this:</p> 79<p>You can activate them like this:</p>
78<pre> 80<pre>
79 rxvt -pe &lt;extensionname&gt;</pre> 81 rxvt -pe &lt;extensionname&gt;</pre>
80<dl> 82<dl>
81<dt><strong><a name="item_selection">selection</a></strong><br /> 83<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
82</dt> 84</dt>
83<dd> 85<dd>
84Intelligent selection. This extension tries to be more intelligent when 86Intelligent selection. This extension tries to be more intelligent when
85the user extends selections (double-click). Right now, it tries to select 87the user extends selections (double-click). Right now, it tries to select
86urls and complete shell-quoted arguments, which is very convenient, too, 88urls and complete shell-quoted arguments, which is very convenient, too,
… …
98<dd> 100<dd>
99<pre> 101<pre>
100 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 102 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
101</dd> 103</dd>
102<p></p></dl> 104<p></p></dl>
105<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
106</dt>
107<dd>
108Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at
109runtime.
110</dd>
111<p></p>
103<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 112<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
104</dt> 113</dt>
105<dd> 114<dd>
106Displays a digital clock using the built-in overlay. 115Displays a digital clock using the built-in overlay.
116</dd>
117<p></p>
118<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
119</dt>
120<dd>
121Uses per-line display filtering (<code>on_line_update</code>) to underline urls.
122</dd>
123<p></p>
124<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
125</dt>
126<dd>
127A not very useful example of filtering all text output to the terminal,
128by replacing all line-drawing characters (U+2500 .. U+259F) by a
129similar-looking ascii character.
107</dd> 130</dd>
108<p></p> 131<p></p>
109<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 132<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
110</dt> 133</dt>
111<dd> 134<dd>
… …
124modified).</p> 147modified).</p>
125<p>When objects are destroyed on the C++ side, the perl object hashes are 148<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 149emptied, 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 150the like inside the terminal object so they get destroyed as soon as the
128terminal is destroyed.</p> 151terminal is destroyed.</p>
152<p>Argument names also often indicate the type of a parameter. Here are some
153hints on what they mean:</p>
154<dl>
155<dt><strong><a name="item__24text">$text</a></strong><br />
156</dt>
157<dd>
158Rxvt-unicodes special way of encoding text, where one ``unicode'' character
159always represents one screen cell. See <em>row_t</em> for a discussion of this format.
160</dd>
161<p></p>
162<dt><strong><a name="item__24string">$string</a></strong><br />
163</dt>
164<dd>
165A perl text string, with an emphasis on <em>text</em>. It can store all unicode
166characters and is to be distinguished with text encoded in a specific
167encoding (often locale-specific) and binary data.
168</dd>
169<p></p>
170<dt><strong><a name="item__24octets">$octets</a></strong><br />
171</dt>
172<dd>
173Either binary data or - more common - a text string encoded in a
174locale-specific way.
175</dd>
176<p></p></dl>
129<p> 177<p>
130</p> 178</p>
131<h2><a name="hooks">Hooks</a></h2> 179<h2><a name="hooks">Hooks</a></h2>
132<p>The following subroutines can be declared in loaded scripts, and will be 180<p>The following subroutines can be declared in extension files, and will be
133called whenever the relevant event happens.</p> 181called whenever the relevant event happens.</p>
134<p>The first argument passed to them is an object private to each terminal 182<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 183and 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> 184its 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> 185object that is shared between all packages is stored in the <code>term</code>
138member.</p> 186member. It is, however, blessed intot he package of the extension script,
187so 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 188<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, 189counts 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> 190and 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> 191<p>When in doubt, return a false value (preferably <code>()</code>).</p>
143<dl> 192<dl>
144<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 193<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
145</dt> 194</dt>
146<dd> 195<dd>
147Called after a new terminal object has been initialized, but before 196Called after a new terminal object has been initialized, but before
148windows are created or the command gets run. 197windows are created or the command gets run. Most methods are unsafe to
198call or deliver senseless data, as terminal size and other characteristics
199have not yet been determined. You can safely query and change resources,
200though.
149</dd> 201</dd>
150<p></p> 202<p></p>
151<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 203<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
152</dt> 204</dt>
153<dd> 205<dd>
… …
194should extend the selection itelf and return true to suppress the built-in 246should extend the selection itelf and return true to suppress the built-in
195processing. 247processing.
196</dd> 248</dd>
197<dd> 249<dd>
198<p>See the <em>selection</em> example extension.</p> 250<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> 251</dd>
214<p></p> 252<p></p>
215<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 253<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
216</dt> 254</dt>
217<dd> 255<dd>
… …
253<p>Be careful not ever to trust (in a security sense) the data you receive, 291<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 292as its source can not easily be controleld (e-mail content, messages from
255other users on the same system etc.).</p> 293other users on the same system etc.).</p>
256</dd> 294</dd>
257<p></p> 295<p></p>
296<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
297</dt>
298<dd>
299Called whenever text is about to be output, with the text as argument. You
300can filter/change and output the text yourself by returning a true value
301and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
302might be very slow, however, as your hook is called for <strong>all</strong> text being
303output.
304</dd>
305<p></p>
306<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
307</dt>
308<dd>
309Called whenever a line was updated or changed. Can be used to filter
310screen output (e.g. underline urls or other useless stuff). Only lines
311that are being shown will be filtered, and, due to performance reasons,
312not always immediately.
313</dd>
314<dd>
315<p>The row number is always the topmost row of the line if the line spans
316multiple rows.</p>
317</dd>
318<dd>
319<p>Please note that, if you change the line, then the hook might get called
320later with the already-modified line (e.g. if unrelated parts change), so
321you cannot just toggle rendition bits, but only set them.</p>
322</dd>
323<p></p>
258<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 324<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
259</dt> 325</dt>
260<dd> 326<dd>
261Called just before the screen gets redrawn. Can be used for overlay 327Called just before the screen gets redrawn. Can be used for overlay
262or similar effects by modify terminal contents in refresh_begin, and 328or similar effects by modify terminal contents in refresh_begin, and
… …
275<dd> 341<dd>
276Called whenever the user presses a key combination that has a 342Called 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> 343<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
278resource in the <code>rxvt(1)</code> manpage). 344resource in the <code>rxvt(1)</code> manpage).
279</dd> 345</dd>
346<p></p>
347<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
348</dt>
349<dd>
350Called whenever the window gets the keyboard focus, before rxvt-unicode
351does focus in processing.
352</dd>
353<p></p>
354<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
355</dt>
356<dd>
357Called wheneever the window loses keyboard focus, before rxvt-unicode does
358focus out processing.
359</dd>
360<p></p>
361<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br />
362</dt>
363<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br />
364</dt>
365<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
366</dt>
367<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
368</dt>
369<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
370</dt>
371<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
372</dt>
373<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
374</dt>
375<dd>
376Called whenever the corresponding X event is received for the terminal If
377the hook returns true, then the even will be ignored by rxvt-unicode.
378</dd>
379<dd>
380<p>The event is a hash with most values as named by Xlib (see the XEvent
381manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
382and column under the mouse cursor.</p>
383</dd>
384<dd>
385<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
386output, if any, in locale-specific encoding.</p>
387</dd>
388<dd>
389<p>subwindow.</p>
390</dd>
280<p></p></dl> 391<p></p></dl>
281<p> 392<p>
282</p> 393</p>
283<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 394<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
284<dl> 395<dl>
285<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 396<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
286</dt> 397</dt>
287<dd> 398<dd>
288The current terminal. Whenever a callback/Hook is bein executed, this 399The current terminal. This variable stores the current <code>urxvt::term</code>
289variable stores the current <code>urxvt::term</code> object. 400object, whenever a callback/hook is executing.
290</dd> 401</dd>
291<p></p></dl> 402<p></p></dl>
292<p> 403<p>
293</p> 404</p>
294<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 405<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
295<dl> 406<dl>
407<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
408</dt>
409<dd>
410Creates a new terminal, very similar as if you had started it with
411<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
412if the new instance couldn't be created. Returns <code>undef</code> if the new
413instance didn't initialise perl, and the terminal object otherwise. The
414<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
415</dd>
416<p></p>
296<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 417<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
297</dt> 418</dt>
298<dd> 419<dd>
299Fatally aborts execution with the given error message. Avoid at all 420Fatally aborts execution with the given error message. Avoid at all
300costs! The only time this is acceptable is when the terminal process 421costs! The only time this is acceptable is when the terminal process
… …
315<p></p> 436<p></p>
316<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 437<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
317</dt> 438</dt>
318<dd> 439<dd>
319Returns the ``current time'' (as per the event loop). 440Returns the ``current time'' (as per the event loop).
441</dd>
442<p></p>
443<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
444</dt>
445<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
446Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
447Button4Mask, Button5Mask, AnyModifier</a></strong><br />
448</dt>
449<dd>
450Various constants for use in X calls and event processing.
320</dd> 451</dd>
321<p></p></dl> 452<p></p></dl>
322<p> 453<p>
323</p> 454</p>
324<h2><a name="rendition">RENDITION</a></h2> 455<h2><a name="rendition">RENDITION</a></h2>
… …
381Change the custom value. 512Change the custom value.
382</dd> 513</dd>
383<p></p></dl> 514<p></p></dl>
384<p> 515<p>
385</p> 516</p>
517<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
518<p>The sole purpose of this class is to deliver an interface to the
519<code>AnyEvent</code> module - any module using it will work inside urxvt without
520further work. The only exception is that you cannot wait on condition
521variables, but non-blocking condvar use is ok. What this means is that you
522cannot use blocking APIs, but the non-blocking variant should work.</p>
523<p>
524</p>
386<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 525<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
387<dl> 526<dl>
527<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
528</dt>
529<dd>
530Destroy the terminal object (close the window, free resources etc.).
531</dd>
532<p></p>
533<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
534</dt>
535<dd>
536Returns true if the option specified by <code>$optval</code> is enabled, and
537optionally change it. All option values are stored by name in the hash
538<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
539</dd>
540<dd>
541<p>Here is a a likely non-exhaustive list of option names, please see the
542source file <em>/src/optinc.h</em> to see the actual list:</p>
543</dd>
544<dd>
545<pre>
546 borderLess console cursorBlink cursorUnderline hold iconic insecure
547 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
548 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
549 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
550 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
551 tripleclickwords utmpInhibit visualBell</pre>
552</dd>
553<p></p>
388<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 554<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
389</dt> 555</dt>
390<dd> 556<dd>
391Returns the current resource value associated with a given name and 557Returns 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> 558optionally 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 572<p>Please note that resource strings will currently only be freed when the
407terminal is destroyed, so changing options frequently will eat memory.</p> 573terminal is destroyed, so changing options frequently will eat memory.</p>
408</dd> 574</dd>
409<dd> 575<dd>
410<p>Here is a a likely non-exhaustive list of resource names, not all of which 576<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 577are supported in every build, please see the source file <em>/src/rsinc.h</em>
412list:</p> 578to see the actual list:</p>
413</dd> 579</dd>
414<dd> 580<dd>
415<pre> 581<pre>
416 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 582 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
417 borderLess color cursorBlink cursorUnderline cutchars delete_key 583 borderLess color cursorBlink cursorUnderline cutchars delete_key
… …
425 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 591 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
426 shade term_name title transparent transparent_all tripleclickwords 592 shade term_name title transparent transparent_all tripleclickwords
427 utmpInhibit visualBell</pre> 593 utmpInhibit visualBell</pre>
428</dd> 594</dd>
429<p></p> 595<p></p>
430<dt><strong><a name="item_screen_rstyle">$rend = $term-&gt;screen_rstyle ([$new_rstyle])</a></strong><br /> 596<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
431</dt> 597</dt>
432<dd> 598<dd>
433Return and optionally change the current rendition. Text thta is output by 599Return and optionally change the current rendition. Text that is output by
434the temrianl application will use this style. 600the terminal application will use this style.
435</dd> 601</dd>
436<p></p> 602<p></p>
437<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br /> 603<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
438</dt> 604</dt>
439<dd> 605<dd>
… …
467<dd> 633<dd>
468<p>#=item $term-&gt;overlay ($x, $y, $text) 634<p>#=item $term-&gt;overlay ($x, $y, $text)
469# 635#
470#Create a simple multi-line overlay box. See the next method for details. 636#Create a simple multi-line overlay box. See the next method for details.
471# 637#
472#=cut</p> 638#=cut
473</dd> 639#
474<dd>
475<p>sub urxvt::term::scr_overlay { 640#sub urxvt::term::scr_overlay {
476die;
477 my ($self, $x, $y, $text) = @_;</p> 641# my ($self, $x, $y, $text) = @_;
478</dd> 642#
479<dd>
480<pre>
481 my @lines = split /\n/, $text;</pre> 643# my @lines = split /\n/, $text;
482</dd> 644#
483<dd>
484<pre>
485 my $w = 0; 645# my $w = 0;
486 for (map $self-&gt;strwidth ($_), @lines) { 646# for (map $self-&gt;strwidth ($_), @lines) {
487 $w = $_ if $w &lt; $_; 647# $w = $_ if $w &lt; $_;
488 }</pre> 648# }
489</dd> 649#
490<dd>
491<pre>
492 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines); 650# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
493 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 651# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
494}</pre> 652#}</p>
495</dd> 653</dd>
496<p></p> 654<p></p>
497<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 655<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
498</dt> 656</dt>
499<dd> 657<dd>
… …
535</dt> 693</dt>
536<dd> 694<dd>
537If hidden, display the overlay again. 695If hidden, display the overlay again.
538</dd> 696</dd>
539<p></p></dl> 697<p></p></dl>
698<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
699</dt>
700<dd>
701Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
702<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
703currently).
704</dd>
705<p></p>
540<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 706<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
541</dt> 707</dt>
542<dd> 708<dd>
543Returns the number of screen-cells this string would need. Correctly 709Returns the number of screen-cells this string would need. Correctly
544accounts for wide and combining characters. 710accounts for wide and combining characters.
545</dd> 711</dd>
546<p></p> 712<p></p>
547<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 713<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
548</dt> 714</dt>
549<dd> 715<dd>
550Convert the given text string into the corresponding locale encoding. 716Convert the given text string into the corresponding locale encoding.
551</dd> 717</dd>
552<p></p> 718<p></p>
553<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 719<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
554</dt> 720</dt>
555<dd> 721<dd>
556Convert the given locale-encoded octets into a perl string. 722Convert the given locale-encoded octets into a perl string.
723</dd>
724<p></p>
725<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
726</dt>
727<dd>
728Write the given text string to the screen, as if output by the application
729running inside the terminal. It may not contain command sequences (escape
730codes), but is free to use line feeds, carriage returns and tabs. The
731string is a normal text string, not in locale-dependent encoding.
732</dd>
733<dd>
734<p>Normally its not a good idea to use this function, as programs might be
735confused by changes in cursor position or scrolling. Its useful inside a
736<code>on_add_lines</code> hook, though.</p>
737</dd>
738<p></p>
739<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
740</dt>
741<dd>
742Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
743locale-specific encoding of the terminal and can contain command sequences
744(escape codes) that will be interpreted.
557</dd> 745</dd>
558<p></p> 746<p></p>
559<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 747<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
560</dt> 748</dt>
561<dd> 749<dd>
562Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 750Write 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 751pass 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>. 752to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
565</dd> 753</dd>
566<p></p> 754<p></p>
755<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
756</dt>
757<dd>
758Return the window id of the toplevel window.
759</dd>
760<p></p>
761<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
762</dt>
763<dd>
764Return the window id of the terminal window.
765</dd>
766<p></p>
567<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 767<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
568</dt> 768</dt>
569<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 769<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
570</dt> 770</dt>
571<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 771<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
588</dt> 788</dt>
589<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 789<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
590</dt> 790</dt>
591<dd> 791<dd>
592Return various integers describing terminal characteristics. 792Return various integers describing terminal characteristics.
793</dd>
794<p></p>
795<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
796</dt>
797<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
798</dt>
799<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
800</dt>
801<dd>
802Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
803AltGr), the meta key (often Alt) and the num lock key, if applicable.
593</dd> 804</dd>
594<p></p> 805<p></p>
595<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 806<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
596</dt> 807</dt>
597<dd> 808<dd>
… …
625line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 836line, 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 837to replace only parts of a line. The font index in the rendition will
627automatically be updated.</p> 838automatically be updated.</p>
628</dd> 839</dd>
629<dd> 840<dd>
630<p><code>$text</code> is in a special encoding: tabs and wide characters that use more 841<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 842than one cell when displayed are padded with urxvt::NOCHAR characters
632(<code>chr 65535</code>). Characters with combining characters and other characters 843(<code>chr 65535</code>). Characters with combining characters and other characters
633that do not fit into the normal tetx encoding will be replaced with 844that do not fit into the normal tetx encoding will be replaced with
634characters in the private use area.</p> 845characters in the private use area.</p>
635</dd> 846</dd>
… …
680Create and return a new <code>urxvt::line</code> object that stores information 891Create 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 892about the logical line that row <code>$row_number</code> is part of. It supports the
682following methods: 893following methods:
683</dd> 894</dd>
684<dl> 895<dl>
685<dt><strong><a name="item_t">$text = $line-&gt;t</a></strong><br /> 896<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
686</dt> 897</dt>
687<dd> 898<dd>
688Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> 899Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
689</dd> 900</dd>
690<p></p> 901<p></p>
691<dt><strong><a name="item_r">$rend = $line-&gt;r</a></strong><br /> 902<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
692</dt> 903</dt>
693<dd> 904<dd>
694Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> 905Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
695</dd> 906</dd>
696<p></p> 907<p></p>
697<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br /> 908<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
698</dt> 909</dt>
699<dd> 910<dd>
… …
735<dd> 946<dd>
736Converts rxvt-unicodes text reprsentation into a perl string. See 947Converts rxvt-unicodes text reprsentation into a perl string. See
737<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 948<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
738</dd> 949</dd>
739<p></p></dl> 950<p></p></dl>
951<p>
952</p>
953<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
740<p> 954<p>
741</p> 955</p>
742<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 956<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 957<p>This class implements timer watchers/events. Time is represented as a
744fractional number of seconds since the epoch. Example:</p> 958fractional number of seconds since the epoch. Example:</p>

Diff Legend

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