… | |
… | |
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> |
69 | the <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 |
69 | thus must be encoded as UTF-8.</p> |
71 | thus 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 |
71 | scripts will be shared (but not enabled) for all terminals.</p> |
73 | scripts will be shared (but not enabled) for all terminals.</p> |
72 | <p> |
74 | <p> |
… | |
… | |
76 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
78 | find 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 <extensionname></pre> |
81 | rxvt -pe <extensionname></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> |
84 | Intelligent selection. This extension tries to be more intelligent when |
86 | Intelligent selection. This extension tries to be more intelligent when |
85 | the user extends selections (double-click). Right now, it tries to select |
87 | the user extends selections (double-click). Right now, it tries to select |
86 | urls and complete shell-quoted arguments, which is very convenient, too, |
88 | urls 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> |
|
|
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> |
103 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
119 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
104 | </dt> |
120 | </dt> |
105 | <dd> |
121 | <dd> |
106 | Displays a digital clock using the built-in overlay. |
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. |
107 | </dd> |
137 | </dd> |
108 | <p></p> |
138 | <p></p> |
109 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
139 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
110 | </dt> |
140 | </dt> |
111 | <dd> |
141 | <dd> |
… | |
… | |
124 | modified).</p> |
154 | modified).</p> |
125 | <p>When objects are destroyed on the C++ side, the perl object hashes are |
155 | <p>When objects are destroyed on the C++ side, the perl object hashes are |
126 | emptied, so its best to store related objects such as time watchers and |
156 | emptied, so its best to store related objects such as time watchers and |
127 | the like inside the terminal object so they get destroyed as soon as the |
157 | the like inside the terminal object so they get destroyed as soon as the |
128 | terminal is destroyed.</p> |
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> |
129 | <p> |
184 | <p> |
130 | </p> |
185 | </p> |
131 | <h2><a name="hooks">Hooks</a></h2> |
186 | <h2><a name="hooks">Hooks</a></h2> |
132 | <p>The following subroutines can be declared in loaded scripts, and will be |
187 | <p>The following subroutines can be declared in extension files, and will be |
133 | called whenever the relevant event happens.</p> |
188 | called whenever the relevant event happens.</p> |
134 | <p>The first argument passed to them is an object private to each terminal |
189 | <p>The first argument passed to them is an object private to each terminal |
135 | and extension package. You can call all <code>urxvt::term</code> methods on it, but |
190 | and extension package. You can call all <code>urxvt::term</code> methods on it, but |
136 | its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
191 | its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
137 | object that is shared between all packages is stored in the <code>term</code> |
192 | object that is shared between all packages is stored in the <code>term</code> |
138 | member.</p> |
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> |
139 | <p>All of them must return a boolean value. If it is true, then the event |
195 | <p>All of them must return a boolean value. If it is true, then the event |
140 | counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
196 | counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
141 | and the relevant action might not be carried out by the C++ code.</p> |
197 | and 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> |
198 | <p>When in doubt, return a false value (preferably <code>()</code>).</p> |
143 | <dl> |
199 | <dl> |
144 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
200 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
145 | </dt> |
201 | </dt> |
146 | <dd> |
202 | <dd> |
147 | Called after a new terminal object has been initialized, but before |
203 | Called after a new terminal object has been initialized, but before |
148 | windows are created or the command gets run. |
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. |
149 | </dd> |
208 | </dd> |
150 | <p></p> |
209 | <p></p> |
151 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
210 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
152 | </dt> |
211 | </dt> |
153 | <dd> |
212 | <dd> |
… | |
… | |
196 | </dd> |
255 | </dd> |
197 | <dd> |
256 | <dd> |
198 | <p>See the <em>selection</em> example extension.</p> |
257 | <p>See the <em>selection</em> example extension.</p> |
199 | </dd> |
258 | </dd> |
200 | <p></p> |
259 | <p></p> |
201 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
|
|
202 | </dt> |
|
|
203 | <dd> |
|
|
204 | Called whenever the window gets the keyboard focus, before urxvt does |
|
|
205 | focus 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> |
|
|
211 | Called wheneever the window loses keyboard focus, before urxvt does focus |
|
|
212 | out processing. |
|
|
213 | </dd> |
|
|
214 | <p></p> |
|
|
215 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
260 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
216 | </dt> |
261 | </dt> |
217 | <dd> |
262 | <dd> |
218 | Called whenever the view offset changes, i..e the user or program |
263 | Called whenever the view offset changes, i..e the user or program |
219 | scrolls. Offset <code>0</code> means display the normal terminal, positive values |
264 | scrolls. Offset <code>0</code> means display the normal terminal, positive values |
… | |
… | |
231 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
276 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
232 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
277 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
233 | number of lines that will be in the scrollback buffer.</p> |
278 | number of lines that will be in the scrollback buffer.</p> |
234 | </dd> |
279 | </dd> |
235 | <p></p> |
280 | <p></p> |
236 | <dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> |
281 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
237 | </dt> |
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. |
238 | <dd> |
290 | </dd> |
239 | Called whenever the <code>program(s)</code> running in the urxvt window send output. |
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> |
240 | </dd> |
323 | </dd> |
241 | <p></p> |
324 | <p></p> |
242 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
325 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
243 | </dt> |
326 | </dt> |
244 | <dd> |
327 | <dd> |
… | |
… | |
259 | <dd> |
342 | <dd> |
260 | Called whenever the user presses a key combination that has a |
343 | Called whenever the user presses a key combination that has a |
261 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
344 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
262 | resource in the <code>rxvt(1)</code> manpage). |
345 | resource in the <code>rxvt(1)</code> manpage). |
263 | </dd> |
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> |
264 | <p></p></dl> |
392 | <p></p></dl> |
265 | <p> |
393 | <p> |
266 | </p> |
394 | </p> |
267 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
395 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
268 | <dl> |
396 | <dl> |
269 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
397 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
270 | </dt> |
398 | </dt> |
271 | <dd> |
399 | <dd> |
272 | The current terminal. Whenever a callback/Hook is bein executed, this |
400 | The current terminal. This variable stores the current <code>urxvt::term</code> |
273 | variable stores the current <code>urxvt::term</code> object. |
401 | object, whenever a callback/hook is executing. |
274 | </dd> |
402 | </dd> |
275 | <p></p></dl> |
403 | <p></p></dl> |
276 | <p> |
404 | <p> |
277 | </p> |
405 | </p> |
278 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
406 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
279 | <dl> |
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> |
280 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
418 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
281 | </dt> |
419 | </dt> |
282 | <dd> |
420 | <dd> |
283 | Fatally aborts execution with the given error message. Avoid at all |
421 | Fatally aborts execution with the given error message. Avoid at all |
284 | costs! The only time this is acceptable is when the terminal process |
422 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
299 | <p></p> |
437 | <p></p> |
300 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
438 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
301 | </dt> |
439 | </dt> |
302 | <dd> |
440 | <dd> |
303 | Returns the ``current time'' (as per the event loop). |
441 | Returns the ``current time'' (as per the event loop). |
|
|
442 | </dd> |
|
|
443 | <p></p> |
|
|
444 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
|
|
445 | </dt> |
|
|
446 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
447 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
448 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
449 | </dt> |
|
|
450 | <dd> |
|
|
451 | Various constants for use in X calls and event processing. |
304 | </dd> |
452 | </dd> |
305 | <p></p></dl> |
453 | <p></p></dl> |
306 | <p> |
454 | <p> |
307 | </p> |
455 | </p> |
308 | <h2><a name="rendition">RENDITION</a></h2> |
456 | <h2><a name="rendition">RENDITION</a></h2> |
… | |
… | |
365 | Change the custom value. |
513 | Change the custom value. |
366 | </dd> |
514 | </dd> |
367 | <p></p></dl> |
515 | <p></p></dl> |
368 | <p> |
516 | <p> |
369 | </p> |
517 | </p> |
|
|
518 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
|
|
519 | <p>The sole purpose of this class is to deliver an interface to the |
|
|
520 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
|
|
521 | further work. The only exception is that you cannot wait on condition |
|
|
522 | variables, but non-blocking condvar use is ok. What this means is that you |
|
|
523 | cannot use blocking APIs, but the non-blocking variant should work.</p> |
|
|
524 | <p> |
|
|
525 | </p> |
370 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
526 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
371 | <dl> |
527 | <dl> |
|
|
528 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
|
|
529 | </dt> |
|
|
530 | <dd> |
|
|
531 | Destroy the terminal object (close the window, free resources etc.). |
|
|
532 | </dd> |
|
|
533 | <p></p> |
|
|
534 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
|
|
535 | </dt> |
|
|
536 | <dd> |
|
|
537 | Returns true if the option specified by <code>$optval</code> is enabled, and |
|
|
538 | optionally change it. All option values are stored by name in the hash |
|
|
539 | <code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash. |
|
|
540 | </dd> |
|
|
541 | <dd> |
|
|
542 | <p>Here is a a likely non-exhaustive list of option names, please see the |
|
|
543 | source file <em>/src/optinc.h</em> to see the actual list:</p> |
|
|
544 | </dd> |
|
|
545 | <dd> |
|
|
546 | <pre> |
|
|
547 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
|
|
548 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
|
|
549 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
|
|
550 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
|
|
551 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
|
|
552 | tripleclickwords utmpInhibit visualBell</pre> |
|
|
553 | </dd> |
|
|
554 | <p></p> |
372 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
555 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
373 | </dt> |
556 | </dt> |
374 | <dd> |
557 | <dd> |
375 | Returns the current resource value associated with a given name and |
558 | Returns the current resource value associated with a given name and |
376 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
559 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
… | |
… | |
390 | <p>Please note that resource strings will currently only be freed when the |
573 | <p>Please note that resource strings will currently only be freed when the |
391 | terminal is destroyed, so changing options frequently will eat memory.</p> |
574 | terminal is destroyed, so changing options frequently will eat memory.</p> |
392 | </dd> |
575 | </dd> |
393 | <dd> |
576 | <dd> |
394 | <p>Here is a a likely non-exhaustive list of resource names, not all of which |
577 | <p>Here is a a likely non-exhaustive list of resource names, not all of which |
395 | are supported in every build, please see the source to see the actual |
578 | are supported in every build, please see the source file <em>/src/rsinc.h</em> |
396 | list:</p> |
579 | to see the actual list:</p> |
397 | </dd> |
580 | </dd> |
398 | <dd> |
581 | <dd> |
399 | <pre> |
582 | <pre> |
400 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
583 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
401 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
584 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
402 | display_name embed ext_bwidth fade font geometry hold iconName |
585 | display_name embed ext_bwidth fade font geometry hold iconName |
403 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
586 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
404 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
587 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
405 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
588 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
406 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
589 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
407 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
590 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
408 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
591 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
409 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
592 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
410 | shade term_name title transparent transparent_all tripleclickwords |
593 | shade term_name title transparent transparent_all tripleclickwords |
411 | utmpInhibit visualBell</pre> |
594 | utmpInhibit visualBell</pre> |
412 | </dd> |
595 | </dd> |
413 | <p></p> |
596 | <p></p> |
|
|
597 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
|
|
598 | </dt> |
|
|
599 | <dd> |
|
|
600 | Return and optionally change the current rendition. Text that is output by |
|
|
601 | the terminal application will use this style. |
|
|
602 | </dd> |
|
|
603 | <p></p> |
|
|
604 | <dt><strong><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a></strong><br /> |
|
|
605 | </dt> |
|
|
606 | <dd> |
|
|
607 | Return the current coordinates of the text cursor position and optionally |
|
|
608 | set it (which is usually bad as applications don't expect that). |
|
|
609 | </dd> |
|
|
610 | <p></p> |
414 | <dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong><br /> |
611 | <dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong><br /> |
415 | </dt> |
612 | </dt> |
416 | <dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong><br /> |
613 | <dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong><br /> |
417 | </dt> |
614 | </dt> |
418 | <dt><strong><a name="item_selection_end">($row, $col) = $term->selection_end ([$row, $col])</a></strong><br /> |
615 | <dt><strong><a name="item_selection_end">($row, $col) = $term->selection_end ([$row, $col])</a></strong><br /> |
… | |
… | |
437 | <dd> |
634 | <dd> |
438 | <p>#=item $term->overlay ($x, $y, $text) |
635 | <p>#=item $term->overlay ($x, $y, $text) |
439 | # |
636 | # |
440 | #Create a simple multi-line overlay box. See the next method for details. |
637 | #Create a simple multi-line overlay box. See the next method for details. |
441 | # |
638 | # |
442 | #=cut</p> |
639 | #=cut |
443 | </dd> |
640 | # |
444 | <dd> |
|
|
445 | <p>sub urxvt::term::scr_overlay { |
641 | #sub urxvt::term::scr_overlay { |
446 | die; |
|
|
447 | my ($self, $x, $y, $text) = @_;</p> |
642 | # my ($self, $x, $y, $text) = @_; |
448 | </dd> |
643 | # |
449 | <dd> |
|
|
450 | <pre> |
|
|
451 | my @lines = split /\n/, $text;</pre> |
644 | # my @lines = split /\n/, $text; |
452 | </dd> |
645 | # |
453 | <dd> |
|
|
454 | <pre> |
|
|
455 | my $w = 0; |
646 | # my $w = 0; |
456 | for (map $self->strwidth ($_), @lines) { |
647 | # for (map $self->strwidth ($_), @lines) { |
457 | $w = $_ if $w < $_; |
648 | # $w = $_ if $w < $_; |
458 | }</pre> |
649 | # } |
459 | </dd> |
650 | # |
460 | <dd> |
|
|
461 | <pre> |
|
|
462 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
651 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
463 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
652 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
464 | }</pre> |
653 | #}</p> |
465 | </dd> |
654 | </dd> |
466 | <p></p> |
655 | <p></p> |
467 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
656 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
468 | </dt> |
657 | </dt> |
469 | <dd> |
658 | <dd> |
… | |
… | |
505 | </dt> |
694 | </dt> |
506 | <dd> |
695 | <dd> |
507 | If hidden, display the overlay again. |
696 | If hidden, display the overlay again. |
508 | </dd> |
697 | </dd> |
509 | <p></p></dl> |
698 | <p></p></dl> |
|
|
699 | <dt><strong>$popup = $term->popup ($event)</strong><br /> |
|
|
700 | </dt> |
|
|
701 | <dd> |
|
|
702 | Creates a new <code>urxvt::popup</code> object that implements a popup menu. The |
|
|
703 | <code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, |
|
|
704 | currently). |
|
|
705 | </dd> |
|
|
706 | <p></p> |
510 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth $string</a></strong><br /> |
707 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a></strong><br /> |
511 | </dt> |
708 | </dt> |
512 | <dd> |
709 | <dd> |
513 | Returns the number of screen-cells this string would need. Correctly |
710 | Returns the number of screen-cells this string would need. Correctly |
514 | accounts for wide and combining characters. |
711 | accounts for wide and combining characters. |
515 | </dd> |
712 | </dd> |
516 | <p></p> |
713 | <p></p> |
517 | <dt><strong><a name="item_locale_encode">$octets = $term->locale_encode $string</a></strong><br /> |
714 | <dt><strong><a name="item_locale_encode">$octets = $term->locale_encode ($string)</a></strong><br /> |
518 | </dt> |
715 | </dt> |
519 | <dd> |
716 | <dd> |
520 | Convert the given text string into the corresponding locale encoding. |
717 | Convert the given text string into the corresponding locale encoding. |
521 | </dd> |
718 | </dd> |
522 | <p></p> |
719 | <p></p> |
523 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode $octets</a></strong><br /> |
720 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
524 | </dt> |
721 | </dt> |
525 | <dd> |
722 | <dd> |
526 | Convert the given locale-encoded octets into a perl string. |
723 | Convert the given locale-encoded octets into a perl string. |
|
|
724 | </dd> |
|
|
725 | <p></p> |
|
|
726 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
|
|
727 | </dt> |
|
|
728 | <dd> |
|
|
729 | Write the given text string to the screen, as if output by the application |
|
|
730 | running inside the terminal. It may not contain command sequences (escape |
|
|
731 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
732 | string is a normal text string, not in locale-dependent encoding. |
|
|
733 | </dd> |
|
|
734 | <dd> |
|
|
735 | <p>Normally its not a good idea to use this function, as programs might be |
|
|
736 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
737 | <code>on_add_lines</code> hook, though.</p> |
|
|
738 | </dd> |
|
|
739 | <p></p> |
|
|
740 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
|
|
741 | </dt> |
|
|
742 | <dd> |
|
|
743 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
|
|
744 | locale-specific encoding of the terminal and can contain command sequences |
|
|
745 | (escape codes) that will be interpreted. |
527 | </dd> |
746 | </dd> |
528 | <p></p> |
747 | <p></p> |
529 | <dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
748 | <dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
530 | </dt> |
749 | </dt> |
531 | <dd> |
750 | <dd> |
532 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
751 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
533 | pass characters instead of octets, you should convert your strings first |
752 | pass characters instead of octets, you should convert your strings first |
534 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
753 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
535 | </dd> |
754 | </dd> |
536 | <p></p> |
755 | <p></p> |
|
|
756 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
|
|
757 | </dt> |
|
|
758 | <dd> |
|
|
759 | Return the window id of the toplevel window. |
|
|
760 | </dd> |
|
|
761 | <p></p> |
|
|
762 | <dt><strong><a name="item_vt">$windowid = $term->vt</a></strong><br /> |
|
|
763 | </dt> |
|
|
764 | <dd> |
|
|
765 | Return the window id of the terminal window. |
|
|
766 | </dd> |
|
|
767 | <p></p> |
|
|
768 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
|
|
769 | </dt> |
|
|
770 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
|
|
771 | </dt> |
|
|
772 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
|
|
773 | </dt> |
|
|
774 | <dt><strong><a name="item_fheight">$font_height = $term->fheight</a></strong><br /> |
|
|
775 | </dt> |
|
|
776 | <dt><strong><a name="item_fbase">$font_ascent = $term->fbase</a></strong><br /> |
|
|
777 | </dt> |
537 | <dt><strong><a name="item_nrow">$nrow = $term->nrow</a></strong><br /> |
778 | <dt><strong><a name="item_nrow">$terminal_rows = $term->nrow</a></strong><br /> |
538 | </dt> |
779 | </dt> |
539 | <dt><strong><a name="item_ncol">$ncol = $term->ncol</a></strong><br /> |
780 | <dt><strong><a name="item_ncol">$terminal_columns = $term->ncol</a></strong><br /> |
540 | </dt> |
|
|
541 | <dd> |
|
|
542 | Return the number of rows/columns of the terminal window (i.e. as |
|
|
543 | specified by <code>-geometry</code>, excluding any scrollback). |
|
|
544 | </dd> |
781 | </dt> |
545 | <p></p> |
782 | <dt><strong><a name="item_focus">$has_focus = $term->focus</a></strong><br /> |
|
|
783 | </dt> |
|
|
784 | <dt><strong><a name="item_mapped">$is_mapped = $term->mapped</a></strong><br /> |
|
|
785 | </dt> |
|
|
786 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
|
|
787 | </dt> |
|
|
788 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
|
|
789 | </dt> |
546 | <dt><strong><a name="item_nsaved">$nsaved = $term->nsaved</a></strong><br /> |
790 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
547 | </dt> |
791 | </dt> |
|
|
792 | <dd> |
|
|
793 | Return various integers describing terminal characteristics. |
548 | <dd> |
794 | </dd> |
549 | Returns the number of lines in the scrollback buffer. |
795 | <p></p> |
|
|
796 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
|
|
797 | </dt> |
|
|
798 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
|
|
799 | </dt> |
|
|
800 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
|
|
801 | </dt> |
|
|
802 | <dd> |
|
|
803 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
|
|
804 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
550 | </dd> |
805 | </dd> |
551 | <p></p> |
806 | <p></p> |
552 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
807 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
553 | </dt> |
808 | </dt> |
554 | <dd> |
809 | <dd> |
… | |
… | |
582 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
837 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
583 | to replace only parts of a line. The font index in the rendition will |
838 | to replace only parts of a line. The font index in the rendition will |
584 | automatically be updated.</p> |
839 | automatically be updated.</p> |
585 | </dd> |
840 | </dd> |
586 | <dd> |
841 | <dd> |
587 | <p><code>$text</code> is in a special encoding: tabs and wide characters that use more |
842 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
588 | than one cell when displayed are padded with urxvt::NOCHAR characters |
843 | than one cell when displayed are padded with urxvt::NOCHAR characters |
589 | (<code>chr 65535</code>). Characters with combining characters and other characters |
844 | (<code>chr 65535</code>). Characters with combining characters and other characters |
590 | that do not fit into the normal tetx encoding will be replaced with |
845 | that do not fit into the normal tetx encoding will be replaced with |
591 | characters in the private use area.</p> |
846 | characters in the private use area.</p> |
592 | </dd> |
847 | </dd> |
… | |
… | |
594 | <p>You have to obey this encoding when changing text. The advantage is |
849 | <p>You have to obey this encoding when changing text. The advantage is |
595 | that <code>substr</code> and similar functions work on screen cells and not on |
850 | that <code>substr</code> and similar functions work on screen cells and not on |
596 | characters.</p> |
851 | characters.</p> |
597 | </dd> |
852 | </dd> |
598 | <dd> |
853 | <dd> |
599 | <p>The methods <code>$term->special_encode</code> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
854 | <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> |
600 | can be used to convert normal strings into this encoding and vice versa.</p> |
855 | can be used to convert normal strings into this encoding and vice versa.</p> |
601 | </dd> |
856 | </dd> |
602 | <p></p> |
857 | <p></p> |
603 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
858 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
604 | </dt> |
859 | </dt> |
… | |
… | |
637 | Create and return a new <code>urxvt::line</code> object that stores information |
892 | Create and return a new <code>urxvt::line</code> object that stores information |
638 | about the logical line that row <code>$row_number</code> is part of. It supports the |
893 | about the logical line that row <code>$row_number</code> is part of. It supports the |
639 | following methods: |
894 | following methods: |
640 | </dd> |
895 | </dd> |
641 | <dl> |
896 | <dl> |
642 | <dt><strong><a name="item_t">$text = $line->t</a></strong><br /> |
897 | <dt><strong><a name="item_t">$text = $line->t ([$new_text])</a></strong><br /> |
643 | </dt> |
898 | </dt> |
644 | <dd> |
899 | <dd> |
645 | Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
900 | Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
646 | </dd> |
901 | </dd> |
647 | <p></p> |
902 | <p></p> |
648 | <dt><strong><a name="item_r">$rend = $line->r</a></strong><br /> |
903 | <dt><strong><a name="item_r">$rend = $line->r ([$new_rend])</a></strong><br /> |
649 | </dt> |
904 | </dt> |
650 | <dd> |
905 | <dd> |
651 | Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
906 | Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
652 | </dd> |
907 | </dd> |
653 | <p></p> |
908 | <p></p> |
654 | <dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
909 | <dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
655 | </dt> |
910 | </dt> |
656 | <dd> |
911 | <dd> |
… | |
… | |
676 | </dt> |
931 | </dt> |
677 | <dd> |
932 | <dd> |
678 | Translates a string offset into terminal coordinates again. |
933 | Translates a string offset into terminal coordinates again. |
679 | </dd> |
934 | </dd> |
680 | <p></p></dl> |
935 | <p></p></dl> |
681 | <dt><strong>($row, $col) = $line->coord_of ($offset) |
936 | <dt><strong><a name="item_special_encode">$text = $term->special_encode $string</a></strong><br /> |
682 | =item $text = $term->special_encode $string</strong><br /> |
|
|
683 | </dt> |
937 | </dt> |
684 | <dd> |
938 | <dd> |
685 | Converts a perl string into the special encoding used by rxvt-unicode, |
939 | Converts a perl string into the special encoding used by rxvt-unicode, |
686 | where one character corresponds to one screen cell. See |
940 | where one character corresponds to one screen cell. See |
687 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
941 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
… | |
… | |
691 | </dt> |
945 | </dt> |
692 | <dd> |
946 | <dd> |
693 | Converts rxvt-unicodes text reprsentation into a perl string. See |
947 | Converts rxvt-unicodes text reprsentation into a perl string. See |
694 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
948 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
695 | </dd> |
949 | </dd> |
|
|
950 | <p></p> |
|
|
951 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
|
|
952 | </dt> |
|
|
953 | <dd> |
|
|
954 | Registers a synchronous button grab. See XGrabButton. |
|
|
955 | </dd> |
|
|
956 | <p></p> |
|
|
957 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
|
|
958 | </dt> |
|
|
959 | <dd> |
|
|
960 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
961 | synchronous (<code>$sync</code> is true). Also remembers the grab timestampe. |
|
|
962 | </dd> |
|
|
963 | <p></p> |
|
|
964 | <dt><strong><a name="item_allow_events_async">$term->allow_events_async</a></strong><br /> |
|
|
965 | </dt> |
|
|
966 | <dd> |
|
|
967 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
968 | </dd> |
|
|
969 | <p></p> |
|
|
970 | <dt><strong><a name="item_allow_events_sync">$term->allow_events_sync</a></strong><br /> |
|
|
971 | </dt> |
|
|
972 | <dd> |
|
|
973 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
974 | </dd> |
|
|
975 | <p></p> |
|
|
976 | <dt><strong><a name="item_allow_events_replay">$term->allow_events_replay</a></strong><br /> |
|
|
977 | </dt> |
|
|
978 | <dd> |
|
|
979 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
980 | recent grab. |
|
|
981 | </dd> |
|
|
982 | <p></p> |
|
|
983 | <dt><strong><a name="item_ungrab">$term->ungrab</a></strong><br /> |
|
|
984 | </dt> |
|
|
985 | <dd> |
|
|
986 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
987 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
988 | the session. |
|
|
989 | </dd> |
696 | <p></p></dl> |
990 | <p></p></dl> |
|
|
991 | <p> |
|
|
992 | </p> |
|
|
993 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
697 | <p> |
994 | <p> |
698 | </p> |
995 | </p> |
699 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
996 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
700 | <p>This class implements timer watchers/events. Time is represented as a |
997 | <p>This class implements timer watchers/events. Time is represented as a |
701 | fractional number of seconds since the epoch. Example:</p> |
998 | fractional number of seconds since the epoch. Example:</p> |
… | |
… | |
824 | </p> |
1121 | </p> |
825 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1122 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
826 | <p>This variable controls the verbosity level of the perl extension. Higher |
1123 | <p>This variable controls the verbosity level of the perl extension. Higher |
827 | numbers indicate more verbose output.</p> |
1124 | numbers indicate more verbose output.</p> |
828 | <dl> |
1125 | <dl> |
829 | <dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> |
1126 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
830 | </dt> |
1127 | </dt> |
831 | <dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> |
1128 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
832 | </dt> |
1129 | </dt> |
833 | <dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> |
1130 | <dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
834 | </dt> |
1131 | </dt> |
835 | </dl> |
1132 | </dl> |
836 | <p> |
1133 | <p> |
837 | </p> |
1134 | </p> |
838 | <hr /> |
1135 | <hr /> |