1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
3 |
<head> |
4 |
<title>rxvtperl - rxvt-unicode's embedded perl interpreter</title> |
5 |
<link rev="made" href="mailto:perl-binary@plan9.de" /> |
6 |
</head> |
7 |
|
8 |
<body style="background-color: white"> |
9 |
|
10 |
<p><a name="__index__"></a></p> |
11 |
<!-- INDEX BEGIN --> |
12 |
|
13 |
<ul> |
14 |
|
15 |
<li><a href="#name">NAME</a></li> |
16 |
<li><a href="#synopsis">SYNOPSIS</a></li> |
17 |
<li><a href="#description">DESCRIPTION</a></li> |
18 |
<ul> |
19 |
|
20 |
<li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li> |
21 |
<li><a href="#general_api_considerations">General API Considerations</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> |
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> |
26 |
<li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</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> |
29 |
<li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
30 |
<li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
31 |
</ul> |
32 |
|
33 |
<li><a href="#environment">ENVIRONMENT</a></li> |
34 |
<ul> |
35 |
|
36 |
<li><a href="#urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></li> |
37 |
</ul> |
38 |
|
39 |
<li><a href="#author">AUTHOR</a></li> |
40 |
</ul> |
41 |
<!-- INDEX END --> |
42 |
|
43 |
<hr /> |
44 |
<p> |
45 |
</p> |
46 |
<hr /> |
47 |
<h1><a name="name">NAME</a></h1> |
48 |
<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> |
49 |
<p> |
50 |
</p> |
51 |
<hr /> |
52 |
<h1><a name="synopsis">SYNOPSIS</a></h1> |
53 |
<pre> |
54 |
# create a file grab_test in $HOME:</pre> |
55 |
<pre> |
56 |
sub on_sel_grab { |
57 |
warn "you selected ", $_[0]->selection; |
58 |
() |
59 |
}</pre> |
60 |
<pre> |
61 |
# start a rxvt using it:</pre> |
62 |
<pre> |
63 |
rxvt --perl-lib $HOME -pe grab_test</pre> |
64 |
<p> |
65 |
</p> |
66 |
<hr /> |
67 |
<h1><a name="description">DESCRIPTION</a></h1> |
68 |
<p>Everytime a terminal object gets created, extension scripts specified via |
69 |
the <code>perl</code> resource are loaded and associated with it.</p> |
70 |
<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
71 |
thus must be encoded as UTF-8.</p> |
72 |
<p>Each script will only ever be loaded once, even in rxvtd, where |
73 |
scripts will be shared (but not enabled) for all terminals.</p> |
74 |
<p> |
75 |
</p> |
76 |
<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> |
77 |
<p>This section describes the extensiosn delivered with this version. You can |
78 |
find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
79 |
<p>You can activate them like this:</p> |
80 |
<pre> |
81 |
rxvt -pe <extensionname></pre> |
82 |
<dl> |
83 |
<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
84 |
</dt> |
85 |
<dd> |
86 |
Intelligent selection. This extension tries to be more intelligent when |
87 |
the user extends selections (double-click). Right now, it tries to select |
88 |
urls and complete shell-quoted arguments, which is very convenient, too, |
89 |
if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
90 |
</dd> |
91 |
<dd> |
92 |
<p>It also offers the following bindable event:</p> |
93 |
</dd> |
94 |
<dl> |
95 |
<dt><strong><a name="item_rot13">rot13</a></strong><br /> |
96 |
</dt> |
97 |
<dd> |
98 |
Rot-13 the selection when activated. Used via keyboard trigger: |
99 |
</dd> |
100 |
<dd> |
101 |
<pre> |
102 |
URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
103 |
</dd> |
104 |
<p></p></dl> |
105 |
<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
106 |
</dt> |
107 |
<dd> |
108 |
Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
109 |
runtime. |
110 |
</dd> |
111 |
<p></p> |
112 |
<dt><strong>selection-popup (enabled by default)</strong><br /> |
113 |
</dt> |
114 |
<dd> |
115 |
Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
116 |
text into various other formats/action. |
117 |
</dd> |
118 |
<p></p> |
119 |
<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
120 |
</dt> |
121 |
<dd> |
122 |
Displays a digital clock using the built-in overlay. |
123 |
</dd> |
124 |
<p></p> |
125 |
<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
126 |
</dt> |
127 |
<dd> |
128 |
Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
129 |
</dd> |
130 |
<p></p> |
131 |
<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
132 |
</dt> |
133 |
<dd> |
134 |
A not very useful example of filtering all text output to the terminal, |
135 |
by replacing all line-drawing characters (U+2500 .. U+259F) by a |
136 |
similar-looking ascii character. |
137 |
</dd> |
138 |
<p></p> |
139 |
<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
140 |
</dt> |
141 |
<dd> |
142 |
Displays a very simple digital clock in the upper right corner of the |
143 |
window. Illustrates overwriting the refresh callbacks to create your own |
144 |
overlays or changes. |
145 |
</dd> |
146 |
<p></p></dl> |
147 |
<p> |
148 |
</p> |
149 |
<h2><a name="general_api_considerations">General API Considerations</a></h2> |
150 |
<p>All objects (such as terminals, time watchers etc.) are typical |
151 |
reference-to-hash objects. The hash can be used to store anything you |
152 |
like. All members starting with an underscore (such as <code>_ptr</code> or |
153 |
<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or |
154 |
modified).</p> |
155 |
<p>When objects are destroyed on the C++ side, the perl object hashes are |
156 |
emptied, so its best to store related objects such as time watchers and |
157 |
the like inside the terminal object so they get destroyed as soon as the |
158 |
terminal is destroyed.</p> |
159 |
<p>Argument names also often indicate the type of a parameter. Here are some |
160 |
hints on what they mean:</p> |
161 |
<dl> |
162 |
<dt><strong><a name="item__24text">$text</a></strong><br /> |
163 |
</dt> |
164 |
<dd> |
165 |
Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
166 |
always represents one screen cell. See <em>row_t</em> for a discussion of this format. |
167 |
</dd> |
168 |
<p></p> |
169 |
<dt><strong><a name="item__24string">$string</a></strong><br /> |
170 |
</dt> |
171 |
<dd> |
172 |
A perl text string, with an emphasis on <em>text</em>. It can store all unicode |
173 |
characters and is to be distinguished with text encoded in a specific |
174 |
encoding (often locale-specific) and binary data. |
175 |
</dd> |
176 |
<p></p> |
177 |
<dt><strong><a name="item__24octets">$octets</a></strong><br /> |
178 |
</dt> |
179 |
<dd> |
180 |
Either binary data or - more common - a text string encoded in a |
181 |
locale-specific way. |
182 |
</dd> |
183 |
<p></p></dl> |
184 |
<p> |
185 |
</p> |
186 |
<h2><a name="hooks">Hooks</a></h2> |
187 |
<p>The following subroutines can be declared in extension files, and will be |
188 |
called whenever the relevant event happens.</p> |
189 |
<p>The first argument passed to them is an object private to each terminal |
190 |
and extension package. You can call all <code>urxvt::term</code> methods on it, but |
191 |
its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
192 |
object that is shared between all packages is stored in the <code>term</code> |
193 |
member. It is, however, blessed intot he package of the extension script, |
194 |
so for all practical purposes you can treat an extension script as a class.</p> |
195 |
<p>All of them must return a boolean value. If it is true, then the event |
196 |
counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
197 |
and the relevant action might not be carried out by the C++ code.</p> |
198 |
<p>When in doubt, return a false value (preferably <code>()</code>).</p> |
199 |
<dl> |
200 |
<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
201 |
</dt> |
202 |
<dd> |
203 |
Called after a new terminal object has been initialized, but before |
204 |
windows are created or the command gets run. Most methods are unsafe to |
205 |
call or deliver senseless data, as terminal size and other characteristics |
206 |
have not yet been determined. You can safely query and change resources, |
207 |
though. |
208 |
</dd> |
209 |
<p></p> |
210 |
<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
211 |
</dt> |
212 |
<dd> |
213 |
Called after the screen is ``reset'' for any reason, such as resizing or |
214 |
control sequences. Here is where you can react on changes to size-related |
215 |
variables. |
216 |
</dd> |
217 |
<p></p> |
218 |
<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
219 |
</dt> |
220 |
<dd> |
221 |
Called at the very end of initialisation of a new terminal, just before |
222 |
returning to the mainloop. |
223 |
</dd> |
224 |
<p></p> |
225 |
<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
226 |
</dt> |
227 |
<dd> |
228 |
Called whenever a selection has been made by the user, but before the |
229 |
selection text is copied, so changes to the beginning, end or type of the |
230 |
selection will be honored. |
231 |
</dd> |
232 |
<dd> |
233 |
<p>Returning a true value aborts selection making by urxvt, in which case you |
234 |
have to make a selection yourself by calling <a href="#item_selection_grab"><code>$term->selection_grab</code></a>.</p> |
235 |
</dd> |
236 |
<p></p> |
237 |
<dt><strong><a name="item_on_sel_grab__24term_2c__24eventtime">on_sel_grab $term, $eventtime</a></strong><br /> |
238 |
</dt> |
239 |
<dd> |
240 |
Called whenever a selection has been copied, but before the selection is |
241 |
requested from the server. The selection text can be queried and changed |
242 |
by calling <a href="#item_selection"><code>$term->selection</code></a>. |
243 |
</dd> |
244 |
<dd> |
245 |
<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> |
246 |
</dd> |
247 |
<p></p> |
248 |
<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br /> |
249 |
</dt> |
250 |
<dd> |
251 |
Called whenever the user tries to extend the selection (e.g. with a double |
252 |
click) and is either supposed to return false (normal operation), or |
253 |
should extend the selection itelf and return true to suppress the built-in |
254 |
processing. |
255 |
</dd> |
256 |
<dd> |
257 |
<p>See the <em>selection</em> example extension.</p> |
258 |
</dd> |
259 |
<p></p> |
260 |
<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
261 |
</dt> |
262 |
<dd> |
263 |
Called whenever the view offset changes, i..e the user or program |
264 |
scrolls. Offset <code>0</code> means display the normal terminal, positive values |
265 |
show this many lines of scrollback. |
266 |
</dd> |
267 |
<p></p> |
268 |
<dt><strong><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a></strong><br /> |
269 |
</dt> |
270 |
<dd> |
271 |
Called whenever lines scroll out of the terminal area into the scrollback |
272 |
buffer. <code>$lines</code> is the number of lines scrolled out and may be larger |
273 |
than the scroll back buffer or the terminal. |
274 |
</dd> |
275 |
<dd> |
276 |
<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
277 |
$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
278 |
number of lines that will be in the scrollback buffer.</p> |
279 |
</dd> |
280 |
<p></p> |
281 |
<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
282 |
</dt> |
283 |
<dd> |
284 |
Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC = |
285 |
operating system command) is processed. Cursor position and other state |
286 |
information is up-to-date when this happens. For interoperability, the |
287 |
string should start with the extension name and a colon, to distinguish |
288 |
it from commands for other extensions, and this might be enforced in the |
289 |
future. |
290 |
</dd> |
291 |
<dd> |
292 |
<p>Be careful not ever to trust (in a security sense) the data you receive, |
293 |
as its source can not easily be controleld (e-mail content, messages from |
294 |
other users on the same system etc.).</p> |
295 |
</dd> |
296 |
<p></p> |
297 |
<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br /> |
298 |
</dt> |
299 |
<dd> |
300 |
Called whenever text is about to be output, with the text as argument. You |
301 |
can filter/change and output the text yourself by returning a true value |
302 |
and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
303 |
might be very slow, however, as your hook is called for <strong>all</strong> text being |
304 |
output. |
305 |
</dd> |
306 |
<p></p> |
307 |
<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
308 |
</dt> |
309 |
<dd> |
310 |
Called whenever a line was updated or changed. Can be used to filter |
311 |
screen output (e.g. underline urls or other useless stuff). Only lines |
312 |
that are being shown will be filtered, and, due to performance reasons, |
313 |
not always immediately. |
314 |
</dd> |
315 |
<dd> |
316 |
<p>The row number is always the topmost row of the line if the line spans |
317 |
multiple rows.</p> |
318 |
</dd> |
319 |
<dd> |
320 |
<p>Please note that, if you change the line, then the hook might get called |
321 |
later with the already-modified line (e.g. if unrelated parts change), so |
322 |
you cannot just toggle rendition bits, but only set them.</p> |
323 |
</dd> |
324 |
<p></p> |
325 |
<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
326 |
</dt> |
327 |
<dd> |
328 |
Called just before the screen gets redrawn. Can be used for overlay |
329 |
or similar effects by modify terminal contents in refresh_begin, and |
330 |
restoring them in refresh_end. The built-in overlay and selection display |
331 |
code is run after this hook, and takes precedence. |
332 |
</dd> |
333 |
<p></p> |
334 |
<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> |
335 |
</dt> |
336 |
<dd> |
337 |
Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
338 |
</dd> |
339 |
<p></p> |
340 |
<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> |
341 |
</dt> |
342 |
<dd> |
343 |
Called whenever the user presses a key combination that has a |
344 |
<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
345 |
resource in the <code>rxvt(1)</code> manpage). |
346 |
</dd> |
347 |
<p></p> |
348 |
<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
349 |
</dt> |
350 |
<dd> |
351 |
Called whenever the window gets the keyboard focus, before rxvt-unicode |
352 |
does focus in processing. |
353 |
</dd> |
354 |
<p></p> |
355 |
<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
356 |
</dt> |
357 |
<dd> |
358 |
Called wheneever the window loses keyboard focus, before rxvt-unicode does |
359 |
focus out processing. |
360 |
</dd> |
361 |
<p></p> |
362 |
<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> |
363 |
</dt> |
364 |
<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> |
365 |
</dt> |
366 |
<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
367 |
</dt> |
368 |
<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
369 |
</dt> |
370 |
<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br /> |
371 |
</dt> |
372 |
<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br /> |
373 |
</dt> |
374 |
<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br /> |
375 |
</dt> |
376 |
<dd> |
377 |
Called whenever the corresponding X event is received for the terminal If |
378 |
the hook returns true, then the even will be ignored by rxvt-unicode. |
379 |
</dd> |
380 |
<dd> |
381 |
<p>The event is a hash with most values as named by Xlib (see the XEvent |
382 |
manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
383 |
and column under the mouse cursor.</p> |
384 |
</dd> |
385 |
<dd> |
386 |
<p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
387 |
output, if any, in locale-specific encoding.</p> |
388 |
</dd> |
389 |
<dd> |
390 |
<p>subwindow.</p> |
391 |
</dd> |
392 |
<p></p></dl> |
393 |
<p> |
394 |
</p> |
395 |
<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
396 |
<dl> |
397 |
<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
398 |
</dt> |
399 |
<dd> |
400 |
The current terminal. This variable stores the current <code>urxvt::term</code> |
401 |
object, whenever a callback/hook is executing. |
402 |
</dd> |
403 |
<p></p></dl> |
404 |
<p> |
405 |
</p> |
406 |
<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
407 |
<dl> |
408 |
<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
409 |
</dt> |
410 |
<dd> |
411 |
Creates a new terminal, very similar as if you had started it with |
412 |
<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message) |
413 |
if the new instance couldn't be created. Returns <code>undef</code> if the new |
414 |
instance didn't initialise perl, and the terminal object otherwise. The |
415 |
<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call. |
416 |
</dd> |
417 |
<p></p> |
418 |
<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
419 |
</dt> |
420 |
<dd> |
421 |
Fatally aborts execution with the given error message. Avoid at all |
422 |
costs! The only time this is acceptable is when the terminal process |
423 |
starts up. |
424 |
</dd> |
425 |
<p></p> |
426 |
<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br /> |
427 |
</dt> |
428 |
<dd> |
429 |
Calls <code>rxvt_warn</code> with the given string which should not include a |
430 |
newline. The module also overwrites the <code>warn</code> builtin with a function |
431 |
that calls this function. |
432 |
</dd> |
433 |
<dd> |
434 |
<p>Using this function has the advantage that its output ends up in the |
435 |
correct place, e.g. on stderr of the connecting urxvtc client.</p> |
436 |
</dd> |
437 |
<p></p> |
438 |
<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
439 |
</dt> |
440 |
<dd> |
441 |
Returns true when it is safe to do potentially unsafe things, such as |
442 |
evaluating perl code specified by the user. This is true when urxvt was |
443 |
started setuid or setgid. |
444 |
</dd> |
445 |
<p></p> |
446 |
<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
447 |
</dt> |
448 |
<dd> |
449 |
Returns the ``current time'' (as per the event loop). |
450 |
</dd> |
451 |
<p></p> |
452 |
<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
453 |
</dt> |
454 |
<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
455 |
Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
456 |
Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
457 |
</dt> |
458 |
<dd> |
459 |
Various constants for use in X calls and event processing. |
460 |
</dd> |
461 |
<p></p></dl> |
462 |
<p> |
463 |
</p> |
464 |
<h2><a name="rendition">RENDITION</a></h2> |
465 |
<p>Rendition bitsets contain information about colour, font, font styles and |
466 |
similar information for each screen cell.</p> |
467 |
<p>The following ``macros'' deal with changes in rendition sets. You should |
468 |
never just create a bitset, you should always modify an existing one, |
469 |
as they contain important information required for correct operation of |
470 |
rxvt-unicode.</p> |
471 |
<dl> |
472 |
<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br /> |
473 |
</dt> |
474 |
<dd> |
475 |
Returns the default rendition, as used when the terminal is starting up or |
476 |
being reset. Useful as a base to start when creating renditions. |
477 |
</dd> |
478 |
<p></p> |
479 |
<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br /> |
480 |
</dt> |
481 |
<dd> |
482 |
Return the rendition mask used for overlays by default. |
483 |
</dd> |
484 |
<p></p> |
485 |
<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 /> |
486 |
</dt> |
487 |
<dd> |
488 |
Return the bit that enabled bold, italic, blink, reverse-video and |
489 |
underline, respectively. To enable such a style, just logically OR it into |
490 |
the bitset. |
491 |
</dd> |
492 |
<p></p> |
493 |
<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br /> |
494 |
</dt> |
495 |
<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br /> |
496 |
</dt> |
497 |
<dd> |
498 |
Return the foreground/background colour index, respectively. |
499 |
</dd> |
500 |
<p></p> |
501 |
<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> |
502 |
</dt> |
503 |
<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> |
504 |
</dt> |
505 |
<dd> |
506 |
Replace the foreground/background colour in the rendition mask with the |
507 |
specified one. |
508 |
</dd> |
509 |
<p></p> |
510 |
<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> |
511 |
</dt> |
512 |
<dd> |
513 |
Return the ``custom'' value: Every rendition has 5 bits for use by |
514 |
extensions. They can be set and changed as you like and are initially |
515 |
zero. |
516 |
</dd> |
517 |
<p></p> |
518 |
<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> |
519 |
</dt> |
520 |
<dd> |
521 |
Change the custom value. |
522 |
</dd> |
523 |
<p></p></dl> |
524 |
<p> |
525 |
</p> |
526 |
<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
527 |
<p>The sole purpose of this class is to deliver an interface to the |
528 |
<code>AnyEvent</code> module - any module using it will work inside urxvt without |
529 |
further work. The only exception is that you cannot wait on condition |
530 |
variables, but non-blocking condvar use is ok. What this means is that you |
531 |
cannot use blocking APIs, but the non-blocking variant should work.</p> |
532 |
<p> |
533 |
</p> |
534 |
<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
535 |
<dl> |
536 |
<dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
537 |
</dt> |
538 |
<dd> |
539 |
Destroy the terminal object (close the window, free resources etc.). |
540 |
</dd> |
541 |
<p></p> |
542 |
<dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
543 |
</dt> |
544 |
<dd> |
545 |
Returns true if the option specified by <code>$optval</code> is enabled, and |
546 |
optionally change it. All option values are stored by name in the hash |
547 |
<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash. |
548 |
</dd> |
549 |
<dd> |
550 |
<p>Here is a a likely non-exhaustive list of option names, please see the |
551 |
source file <em>/src/optinc.h</em> to see the actual list:</p> |
552 |
</dd> |
553 |
<dd> |
554 |
<pre> |
555 |
borderLess console cursorBlink cursorUnderline hold iconic insecure |
556 |
intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
557 |
pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
558 |
scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
559 |
secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
560 |
tripleclickwords utmpInhibit visualBell</pre> |
561 |
</dd> |
562 |
<p></p> |
563 |
<dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
564 |
</dt> |
565 |
<dd> |
566 |
Returns the current resource value associated with a given name and |
567 |
optionally sets a new value. Setting values is most useful in the <code>init</code> |
568 |
hook. Unset resources are returned and accepted as <code>undef</code>. |
569 |
</dd> |
570 |
<dd> |
571 |
<p>The new value must be properly encoded to a suitable character encoding |
572 |
before passing it to this method. Similarly, the returned value may need |
573 |
to be converted from the used encoding to text.</p> |
574 |
</dd> |
575 |
<dd> |
576 |
<p>Resource names are as defined in <em>src/rsinc.h</em>. Colours can be specified |
577 |
as resource names of the form <code>color+<index></code>, e.g. <code>color+5</code>. (will |
578 |
likely change).</p> |
579 |
</dd> |
580 |
<dd> |
581 |
<p>Please note that resource strings will currently only be freed when the |
582 |
terminal is destroyed, so changing options frequently will eat memory.</p> |
583 |
</dd> |
584 |
<dd> |
585 |
<p>Here is a a likely non-exhaustive list of resource names, not all of which |
586 |
are supported in every build, please see the source file <em>/src/rsinc.h</em> |
587 |
to see the actual list:</p> |
588 |
</dd> |
589 |
<dd> |
590 |
<pre> |
591 |
answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
592 |
borderLess color cursorBlink cursorUnderline cutchars delete_key |
593 |
display_name embed ext_bwidth fade font geometry hold iconName |
594 |
imFont imLocale inputMethod insecure int_bwidth intensityStyles |
595 |
italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
596 |
mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
597 |
perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
598 |
reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
599 |
scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
600 |
scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
601 |
shade term_name title transparent transparent_all tripleclickwords |
602 |
utmpInhibit visualBell</pre> |
603 |
</dd> |
604 |
<p></p> |
605 |
<dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
606 |
</dt> |
607 |
<dd> |
608 |
Return and optionally change the current rendition. Text that is output by |
609 |
the terminal application will use this style. |
610 |
</dd> |
611 |
<p></p> |
612 |
<dt><strong><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a></strong><br /> |
613 |
</dt> |
614 |
<dd> |
615 |
Return the current coordinates of the text cursor position and optionally |
616 |
set it (which is usually bad as applications don't expect that). |
617 |
</dd> |
618 |
<p></p> |
619 |
<dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong><br /> |
620 |
</dt> |
621 |
<dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong><br /> |
622 |
</dt> |
623 |
<dt><strong><a name="item_selection_end">($row, $col) = $term->selection_end ([$row, $col])</a></strong><br /> |
624 |
</dt> |
625 |
<dd> |
626 |
Return the current values of the selection mark, begin or end positions, |
627 |
and optionally set them to new values. |
628 |
</dd> |
629 |
<p></p> |
630 |
<dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
631 |
</dt> |
632 |
<dd> |
633 |
Try to request the primary selection from the server (for example, as set |
634 |
by the next method). |
635 |
</dd> |
636 |
<p></p> |
637 |
<dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
638 |
</dt> |
639 |
<dd> |
640 |
Return the current selection text and optionally replace it by <code>$newtext</code>. |
641 |
</dd> |
642 |
<dd> |
643 |
<p>#=item $term->overlay ($x, $y, $text) |
644 |
# |
645 |
#Create a simple multi-line overlay box. See the next method for details. |
646 |
# |
647 |
#=cut |
648 |
# |
649 |
#sub urxvt::term::scr_overlay { |
650 |
# my ($self, $x, $y, $text) = @_; |
651 |
# |
652 |
# my @lines = split /\n/, $text; |
653 |
# |
654 |
# my $w = 0; |
655 |
# for (map $self->strwidth ($_), @lines) { |
656 |
# $w = $_ if $w < $_; |
657 |
# } |
658 |
# |
659 |
# $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
660 |
# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
661 |
#}</p> |
662 |
</dd> |
663 |
<p></p> |
664 |
<dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
665 |
</dt> |
666 |
<dd> |
667 |
Create a new (empty) overlay at the given position with the given |
668 |
width/height. <code>$rstyle</code> defines the initial rendition style |
669 |
(default: <code>OVERLAY_RSTYLE</code>). |
670 |
</dd> |
671 |
<dd> |
672 |
<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put |
673 |
around the box.</p> |
674 |
</dd> |
675 |
<dd> |
676 |
<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the |
677 |
right/bottom side, respectively.</p> |
678 |
</dd> |
679 |
<dd> |
680 |
<p>This method returns an urxvt::overlay object. The overlay will be visible |
681 |
as long as the perl object is referenced.</p> |
682 |
</dd> |
683 |
<dd> |
684 |
<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p> |
685 |
</dd> |
686 |
<dl> |
687 |
<dt><strong><a name="item_set">$overlay->set ($x, $y, $text, $rend)</a></strong><br /> |
688 |
</dt> |
689 |
<dd> |
690 |
Similar to <a href="#item_row_t"><code>$term->ROW_t</code></a> and <a href="#item_row_r"><code>$term->ROW_r</code></a> in that it puts |
691 |
text in rxvt-unicode's special encoding and an array of rendition values |
692 |
at a specific position inside the overlay. |
693 |
</dd> |
694 |
<p></p> |
695 |
<dt><strong><a name="item_hide">$overlay->hide</a></strong><br /> |
696 |
</dt> |
697 |
<dd> |
698 |
If visible, hide the overlay, but do not destroy it. |
699 |
</dd> |
700 |
<p></p> |
701 |
<dt><strong><a name="item_show">$overlay->show</a></strong><br /> |
702 |
</dt> |
703 |
<dd> |
704 |
If hidden, display the overlay again. |
705 |
</dd> |
706 |
<p></p></dl> |
707 |
<dt><strong>$popup = $term->popup ($event)</strong><br /> |
708 |
</dt> |
709 |
<dd> |
710 |
Creates a new <code>urxvt::popup</code> object that implements a popup menu. The |
711 |
<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, |
712 |
currently). |
713 |
</dd> |
714 |
<p></p> |
715 |
<dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a></strong><br /> |
716 |
</dt> |
717 |
<dd> |
718 |
Returns the number of screen-cells this string would need. Correctly |
719 |
accounts for wide and combining characters. |
720 |
</dd> |
721 |
<p></p> |
722 |
<dt><strong><a name="item_locale_encode">$octets = $term->locale_encode ($string)</a></strong><br /> |
723 |
</dt> |
724 |
<dd> |
725 |
Convert the given text string into the corresponding locale encoding. |
726 |
</dd> |
727 |
<p></p> |
728 |
<dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
729 |
</dt> |
730 |
<dd> |
731 |
Convert the given locale-encoded octets into a perl string. |
732 |
</dd> |
733 |
<p></p> |
734 |
<dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
735 |
</dt> |
736 |
<dd> |
737 |
Write the given text string to the screen, as if output by the application |
738 |
running inside the terminal. It may not contain command sequences (escape |
739 |
codes), but is free to use line feeds, carriage returns and tabs. The |
740 |
string is a normal text string, not in locale-dependent encoding. |
741 |
</dd> |
742 |
<dd> |
743 |
<p>Normally its not a good idea to use this function, as programs might be |
744 |
confused by changes in cursor position or scrolling. Its useful inside a |
745 |
<code>on_add_lines</code> hook, though.</p> |
746 |
</dd> |
747 |
<p></p> |
748 |
<dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
749 |
</dt> |
750 |
<dd> |
751 |
Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
752 |
locale-specific encoding of the terminal and can contain command sequences |
753 |
(escape codes) that will be interpreted. |
754 |
</dd> |
755 |
<p></p> |
756 |
<dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
757 |
</dt> |
758 |
<dd> |
759 |
Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
760 |
pass characters instead of octets, you should convert your strings first |
761 |
to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
762 |
</dd> |
763 |
<p></p> |
764 |
<dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
765 |
</dt> |
766 |
<dd> |
767 |
Return the window id of the toplevel window. |
768 |
</dd> |
769 |
<p></p> |
770 |
<dt><strong><a name="item_vt">$windowid = $term->vt</a></strong><br /> |
771 |
</dt> |
772 |
<dd> |
773 |
Return the window id of the terminal window. |
774 |
</dd> |
775 |
<p></p> |
776 |
<dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
777 |
</dt> |
778 |
<dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
779 |
</dt> |
780 |
<dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
781 |
</dt> |
782 |
<dt><strong><a name="item_fheight">$font_height = $term->fheight</a></strong><br /> |
783 |
</dt> |
784 |
<dt><strong><a name="item_fbase">$font_ascent = $term->fbase</a></strong><br /> |
785 |
</dt> |
786 |
<dt><strong><a name="item_nrow">$terminal_rows = $term->nrow</a></strong><br /> |
787 |
</dt> |
788 |
<dt><strong><a name="item_ncol">$terminal_columns = $term->ncol</a></strong><br /> |
789 |
</dt> |
790 |
<dt><strong><a name="item_focus">$has_focus = $term->focus</a></strong><br /> |
791 |
</dt> |
792 |
<dt><strong><a name="item_mapped">$is_mapped = $term->mapped</a></strong><br /> |
793 |
</dt> |
794 |
<dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
795 |
</dt> |
796 |
<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
797 |
</dt> |
798 |
<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
799 |
</dt> |
800 |
<dd> |
801 |
Return various integers describing terminal characteristics. |
802 |
</dd> |
803 |
<p></p> |
804 |
<dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
805 |
</dt> |
806 |
<dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
807 |
</dt> |
808 |
<dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
809 |
</dt> |
810 |
<dd> |
811 |
Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
812 |
AltGr), the meta key (often Alt) and the num lock key, if applicable. |
813 |
</dd> |
814 |
<p></p> |
815 |
<dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
816 |
</dt> |
817 |
<dd> |
818 |
Returns the negative row number of the topmost line. Minimum value is |
819 |
<code>0</code>, which displays the normal terminal contents. Larger values scroll |
820 |
this many lines into the scrollback buffer. |
821 |
</dd> |
822 |
<p></p> |
823 |
<dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
824 |
</dt> |
825 |
<dd> |
826 |
Requests a screen refresh. At the next opportunity, rxvt-unicode will |
827 |
compare the on-screen display with its stored representation. If they |
828 |
differ, it redraws the differences. |
829 |
</dd> |
830 |
<dd> |
831 |
<p>Used after changing terminal contents to display them.</p> |
832 |
</dd> |
833 |
<p></p> |
834 |
<dt><strong><a name="item_row_t">$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br /> |
835 |
</dt> |
836 |
<dd> |
837 |
Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
838 |
is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
839 |
terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
840 |
line <a href="#item_nsaved"><code>-$term->nsaved</code></a>. Nothing will be returned if a nonexistent line |
841 |
is requested. |
842 |
</dd> |
843 |
<dd> |
844 |
<p>If <code>$new_text</code> is specified, it will replace characters in the current |
845 |
line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
846 |
to replace only parts of a line. The font index in the rendition will |
847 |
automatically be updated.</p> |
848 |
</dd> |
849 |
<dd> |
850 |
<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
851 |
than one cell when displayed are padded with urxvt::NOCHAR characters |
852 |
(<code>chr 65535</code>). Characters with combining characters and other characters |
853 |
that do not fit into the normal tetx encoding will be replaced with |
854 |
characters in the private use area.</p> |
855 |
</dd> |
856 |
<dd> |
857 |
<p>You have to obey this encoding when changing text. The advantage is |
858 |
that <code>substr</code> and similar functions work on screen cells and not on |
859 |
characters.</p> |
860 |
</dd> |
861 |
<dd> |
862 |
<p>The methods <a href="#item_special_encode"><code>$term->special_encode</code></a> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
863 |
can be used to convert normal strings into this encoding and vice versa.</p> |
864 |
</dd> |
865 |
<p></p> |
866 |
<dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
867 |
</dt> |
868 |
<dd> |
869 |
Like <a href="#item_row_t"><code>$term->ROW_t</code></a>, but returns an arrayref with rendition |
870 |
bitsets. Rendition bitsets contain information about colour, font, font |
871 |
styles and similar information. See also <a href="#item_row_t"><code>$term->ROW_t</code></a>. |
872 |
</dd> |
873 |
<dd> |
874 |
<p>When setting rendition, the font mask will be ignored.</p> |
875 |
</dd> |
876 |
<dd> |
877 |
<p>See the section on RENDITION, above.</p> |
878 |
</dd> |
879 |
<p></p> |
880 |
<dt><strong><a name="item_row_l">$length = $term->ROW_l ($row_number[, $new_length])</a></strong><br /> |
881 |
</dt> |
882 |
<dd> |
883 |
Returns the number of screen cells that are in use (``the line |
884 |
length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term->ncol</code></a> if the |
885 |
line is joined with the following one. |
886 |
</dd> |
887 |
<p></p> |
888 |
<dt><strong><a name="item_is_longer">$bool = $term->is_longer ($row_number)</a></strong><br /> |
889 |
</dt> |
890 |
<dd> |
891 |
Returns true if the row is part of a multiple-row logical ``line'' (i.e. |
892 |
joined with the following row), which means all characters are in use |
893 |
and it is continued on the next row (and possibly a continuation of the |
894 |
previous row(s)). |
895 |
</dd> |
896 |
<p></p> |
897 |
<dt><strong><a name="item_line">$line = $term->line ($row_number)</a></strong><br /> |
898 |
</dt> |
899 |
<dd> |
900 |
Create and return a new <code>urxvt::line</code> object that stores information |
901 |
about the logical line that row <code>$row_number</code> is part of. It supports the |
902 |
following methods: |
903 |
</dd> |
904 |
<dl> |
905 |
<dt><strong><a name="item_t">$text = $line->t ([$new_text])</a></strong><br /> |
906 |
</dt> |
907 |
<dd> |
908 |
Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
909 |
</dd> |
910 |
<p></p> |
911 |
<dt><strong><a name="item_r">$rend = $line->r ([$new_rend])</a></strong><br /> |
912 |
</dt> |
913 |
<dd> |
914 |
Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
915 |
</dd> |
916 |
<p></p> |
917 |
<dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
918 |
</dt> |
919 |
<dd> |
920 |
Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>. |
921 |
</dd> |
922 |
<p></p> |
923 |
<dt><strong><a name="item_beg">$rownum = $line->beg</a></strong><br /> |
924 |
</dt> |
925 |
<dt><strong><a name="item_end">$rownum = $line->end</a></strong><br /> |
926 |
</dt> |
927 |
<dd> |
928 |
Return the row number of the first/last row of the line, respectively. |
929 |
</dd> |
930 |
<p></p> |
931 |
<dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
932 |
</dt> |
933 |
<dd> |
934 |
Returns the character offset of the given row|col pair within the logical |
935 |
line. |
936 |
</dd> |
937 |
<p></p> |
938 |
<dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
939 |
</dt> |
940 |
<dd> |
941 |
Translates a string offset into terminal coordinates again. |
942 |
</dd> |
943 |
<p></p></dl> |
944 |
<dt><strong><a name="item_special_encode">$text = $term->special_encode $string</a></strong><br /> |
945 |
</dt> |
946 |
<dd> |
947 |
Converts a perl string into the special encoding used by rxvt-unicode, |
948 |
where one character corresponds to one screen cell. See |
949 |
<a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
950 |
</dd> |
951 |
<p></p> |
952 |
<dt><strong><a name="item_special_decode">$string = $term->special_decode $text</a></strong><br /> |
953 |
</dt> |
954 |
<dd> |
955 |
Converts rxvt-unicodes text reprsentation into a perl string. See |
956 |
<a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
957 |
</dd> |
958 |
<p></p> |
959 |
<dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
960 |
</dt> |
961 |
<dd> |
962 |
Registers a synchronous button grab. See the XGrabButton manpage. |
963 |
</dd> |
964 |
<p></p> |
965 |
<dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
966 |
</dt> |
967 |
<dd> |
968 |
Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
969 |
synchronous (<code>$sync</code> is true). Also remembers the grab timestampe. |
970 |
</dd> |
971 |
<p></p> |
972 |
<dt><strong><a name="item_allow_events_async">$term->allow_events_async</a></strong><br /> |
973 |
</dt> |
974 |
<dd> |
975 |
Calls XAllowEvents with AsyncBoth for the most recent grab. |
976 |
</dd> |
977 |
<p></p> |
978 |
<dt><strong><a name="item_allow_events_sync">$term->allow_events_sync</a></strong><br /> |
979 |
</dt> |
980 |
<dd> |
981 |
Calls XAllowEvents with SyncBoth for the most recent grab. |
982 |
</dd> |
983 |
<p></p> |
984 |
<dt><strong><a name="item_allow_events_replay">$term->allow_events_replay</a></strong><br /> |
985 |
</dt> |
986 |
<dd> |
987 |
Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
988 |
recent grab. |
989 |
</dd> |
990 |
<p></p> |
991 |
<dt><strong><a name="item_ungrab">$term->ungrab</a></strong><br /> |
992 |
</dt> |
993 |
<dd> |
994 |
Calls XUngrab for the most recent grab. Is called automatically on |
995 |
evaluation errors, as it is better to lose the grab in the error case as |
996 |
the session. |
997 |
</dd> |
998 |
<p></p></dl> |
999 |
<p> |
1000 |
</p> |
1001 |
<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1002 |
<p> |
1003 |
</p> |
1004 |
<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1005 |
<p>This class implements timer watchers/events. Time is represented as a |
1006 |
fractional number of seconds since the epoch. Example:</p> |
1007 |
<pre> |
1008 |
$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
1009 |
$term->{timer} = urxvt::timer |
1010 |
->new |
1011 |
->interval (1) |
1012 |
->cb (sub { |
1013 |
$term->{overlay}->set (0, 0, |
1014 |
sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1015 |
});</pre> |
1016 |
<dl> |
1017 |
<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> |
1018 |
</dt> |
1019 |
<dd> |
1020 |
Create a new timer object in started state. It is scheduled to fire |
1021 |
immediately. |
1022 |
</dd> |
1023 |
<p></p> |
1024 |
<dt><strong><a name="item_cb">$timer = $timer->cb (sub { my ($timer) = @_; ... })</a></strong><br /> |
1025 |
</dt> |
1026 |
<dd> |
1027 |
Set the callback to be called when the timer triggers. |
1028 |
</dd> |
1029 |
<p></p> |
1030 |
<dt><strong><a name="item_at">$tstamp = $timer->at</a></strong><br /> |
1031 |
</dt> |
1032 |
<dd> |
1033 |
Return the time this watcher will fire next. |
1034 |
</dd> |
1035 |
<p></p> |
1036 |
<dt><strong>$timer = $timer->set ($tstamp)</strong><br /> |
1037 |
</dt> |
1038 |
<dd> |
1039 |
Set the time the event is generated to $tstamp. |
1040 |
</dd> |
1041 |
<p></p> |
1042 |
<dt><strong><a name="item_interval">$timer = $timer->interval ($interval)</a></strong><br /> |
1043 |
</dt> |
1044 |
<dd> |
1045 |
Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically |
1046 |
stop after it has fired once. If <code>$interval</code> is non-zero, then the timer |
1047 |
is automatically rescheduled at the given intervals. |
1048 |
</dd> |
1049 |
<p></p> |
1050 |
<dt><strong><a name="item_start">$timer = $timer->start</a></strong><br /> |
1051 |
</dt> |
1052 |
<dd> |
1053 |
Start the timer. |
1054 |
</dd> |
1055 |
<p></p> |
1056 |
<dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
1057 |
</dt> |
1058 |
<dd> |
1059 |
Set the event trigger time to <code>$tstamp</code> and start the timer. |
1060 |
</dd> |
1061 |
<p></p> |
1062 |
<dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1063 |
</dt> |
1064 |
<dd> |
1065 |
Stop the timer. |
1066 |
</dd> |
1067 |
<p></p></dl> |
1068 |
<p> |
1069 |
</p> |
1070 |
<h2><a name="the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></h2> |
1071 |
<p>This class implements io watchers/events. Example:</p> |
1072 |
<pre> |
1073 |
$term->{socket} = ... |
1074 |
$term->{iow} = urxvt::iow |
1075 |
->new |
1076 |
->fd (fileno $term->{socket}) |
1077 |
->events (1) # wait for read data |
1078 |
->start |
1079 |
->cb (sub { |
1080 |
my ($iow, $revents) = @_; |
1081 |
# $revents must be 1 here, no need to check |
1082 |
sysread $term->{socket}, my $buf, 8192 |
1083 |
or end-of-file; |
1084 |
});</pre> |
1085 |
<dl> |
1086 |
<dt><strong><a name="item__24iow__3d_new_urxvt_3a_3aiow">$iow = new urxvt::iow</a></strong><br /> |
1087 |
</dt> |
1088 |
<dd> |
1089 |
Create a new io watcher object in stopped state. |
1090 |
</dd> |
1091 |
<p></p> |
1092 |
<dt><strong>$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })</strong><br /> |
1093 |
</dt> |
1094 |
<dd> |
1095 |
Set the callback to be called when io events are triggered. <code>$reventmask</code> |
1096 |
is a bitset as described in the <a href="#item_events"><code>events</code></a> method. |
1097 |
</dd> |
1098 |
<p></p> |
1099 |
<dt><strong><a name="item_fd">$iow = $iow->fd ($fd)</a></strong><br /> |
1100 |
</dt> |
1101 |
<dd> |
1102 |
Set the filedescriptor (not handle) to watch. |
1103 |
</dd> |
1104 |
<p></p> |
1105 |
<dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1106 |
</dt> |
1107 |
<dd> |
1108 |
Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read |
1109 |
data, Bit #1 (value <code>2</code>) enables watching for write data. |
1110 |
</dd> |
1111 |
<p></p> |
1112 |
<dt><strong>$iow = $iow->start</strong><br /> |
1113 |
</dt> |
1114 |
<dd> |
1115 |
Start watching for requested events on the given handle. |
1116 |
</dd> |
1117 |
<p></p> |
1118 |
<dt><strong>$iow = $iow->stop</strong><br /> |
1119 |
</dt> |
1120 |
<dd> |
1121 |
Stop watching for events on the given filehandle. |
1122 |
</dd> |
1123 |
<p></p></dl> |
1124 |
<p> |
1125 |
</p> |
1126 |
<hr /> |
1127 |
<h1><a name="environment">ENVIRONMENT</a></h1> |
1128 |
<p> |
1129 |
</p> |
1130 |
<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1131 |
<p>This variable controls the verbosity level of the perl extension. Higher |
1132 |
numbers indicate more verbose output.</p> |
1133 |
<dl> |
1134 |
<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1135 |
</dt> |
1136 |
<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1137 |
</dt> |
1138 |
<dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
1139 |
</dt> |
1140 |
</dl> |
1141 |
<p> |
1142 |
</p> |
1143 |
<hr /> |
1144 |
<h1><a name="author">AUTHOR</a></h1> |
1145 |
<pre> |
1146 |
Marc Lehmann <pcg@goof.com> |
1147 |
<a href="http://software.schmorp.de/pkg/rxvt-unicode">http://software.schmorp.de/pkg/rxvt-unicode</a></pre> |
1148 |
|
1149 |
</body> |
1150 |
|
1151 |
</html> |