… | |
… | |
104 | </dt> |
104 | </dt> |
105 | <dd> |
105 | <dd> |
106 | Displays a digital clock using the built-in overlay. |
106 | Displays a digital clock using the built-in overlay. |
107 | </dd> |
107 | </dd> |
108 | <p></p> |
108 | <p></p> |
|
|
109 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
|
|
110 | </dt> |
|
|
111 | <dd> |
|
|
112 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
|
|
113 | </dd> |
|
|
114 | <p></p> |
|
|
115 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
|
|
116 | </dt> |
|
|
117 | <dd> |
|
|
118 | A not very useful example of filtering all text output to the terminal, |
|
|
119 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
120 | similar-looking ascii character. |
|
|
121 | </dd> |
|
|
122 | <p></p> |
109 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
123 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
110 | </dt> |
124 | </dt> |
111 | <dd> |
125 | <dd> |
112 | Displays a very simple digital clock in the upper right corner of the |
126 | Displays a very simple digital clock in the upper right corner of the |
113 | window. Illustrates overwriting the refresh callbacks to create your own |
127 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
124 | modified).</p> |
138 | modified).</p> |
125 | <p>When objects are destroyed on the C++ side, the perl object hashes are |
139 | <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 |
140 | 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 |
141 | the like inside the terminal object so they get destroyed as soon as the |
128 | terminal is destroyed.</p> |
142 | terminal is destroyed.</p> |
|
|
143 | <p>Argument names also often indicate the type of a parameter. Here are some |
|
|
144 | hints on what they mean:</p> |
|
|
145 | <dl> |
|
|
146 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
|
|
147 | </dt> |
|
|
148 | <dd> |
|
|
149 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
|
|
150 | always represents one screen cell. See <em>row_t</em> for a discussion of this format. |
|
|
151 | </dd> |
|
|
152 | <p></p> |
|
|
153 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
|
|
154 | </dt> |
|
|
155 | <dd> |
|
|
156 | A perl text string, with an emphasis on <em>text</em>. It can store all unicode |
|
|
157 | characters and is to be distinguished with text encoded in a specific |
|
|
158 | encoding (often locale-specific) and binary data. |
|
|
159 | </dd> |
|
|
160 | <p></p> |
|
|
161 | <dt><strong><a name="item__24octets">$octets</a></strong><br /> |
|
|
162 | </dt> |
|
|
163 | <dd> |
|
|
164 | Either binary data or - more common - a text string encoded in a |
|
|
165 | locale-specific way. |
|
|
166 | </dd> |
|
|
167 | <p></p></dl> |
129 | <p> |
168 | <p> |
130 | </p> |
169 | </p> |
131 | <h2><a name="hooks">Hooks</a></h2> |
170 | <h2><a name="hooks">Hooks</a></h2> |
132 | <p>The following subroutines can be declared in loaded scripts, and will be |
171 | <p>The following subroutines can be declared in extension files, and will be |
133 | called whenever the relevant event happens.</p> |
172 | called whenever the relevant event happens.</p> |
134 | <p>The first argument passed to them is an object private to each terminal |
173 | <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 |
174 | 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> |
175 | 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> |
176 | object that is shared between all packages is stored in the <code>term</code> |
… | |
… | |
143 | <dl> |
182 | <dl> |
144 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
183 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
145 | </dt> |
184 | </dt> |
146 | <dd> |
185 | <dd> |
147 | Called after a new terminal object has been initialized, but before |
186 | Called after a new terminal object has been initialized, but before |
148 | windows are created or the command gets run. |
187 | windows are created or the command gets run. Most methods are unsafe to |
|
|
188 | call or deliver senseless data, as terminal size and other characteristics |
|
|
189 | have not yet been determined. You can safely query and change resources, |
|
|
190 | though. |
149 | </dd> |
191 | </dd> |
150 | <p></p> |
192 | <p></p> |
151 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
193 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
152 | </dt> |
194 | </dt> |
153 | <dd> |
195 | <dd> |
… | |
… | |
237 | </dt> |
279 | </dt> |
238 | <dd> |
280 | <dd> |
239 | Called whenever the <code>program(s)</code> running in the urxvt window send output. |
281 | Called whenever the <code>program(s)</code> running in the urxvt window send output. |
240 | </dd> |
282 | </dd> |
241 | <p></p> |
283 | <p></p> |
|
|
284 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
|
|
285 | </dt> |
|
|
286 | <dd> |
|
|
287 | Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC = |
|
|
288 | operating system command) is processed. Cursor position and other state |
|
|
289 | information is up-to-date when this happens. For interoperability, the |
|
|
290 | string should start with the extension name and a colon, to distinguish |
|
|
291 | it from commands for other extensions, and this might be enforced in the |
|
|
292 | future. |
|
|
293 | </dd> |
|
|
294 | <dd> |
|
|
295 | <p>Be careful not ever to trust (in a security sense) the data you receive, |
|
|
296 | as its source can not easily be controleld (e-mail content, messages from |
|
|
297 | other users on the same system etc.).</p> |
|
|
298 | </dd> |
|
|
299 | <p></p> |
|
|
300 | <dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br /> |
|
|
301 | </dt> |
|
|
302 | <dd> |
|
|
303 | Called whenever text is about to be output, with the text as argument. You |
|
|
304 | can filter/change and output the text yourself by returning a true value |
|
|
305 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
|
|
306 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
|
|
307 | output. |
|
|
308 | </dd> |
|
|
309 | <p></p> |
|
|
310 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
|
|
311 | </dt> |
|
|
312 | <dd> |
|
|
313 | Called whenever a line was updated or changed. Can be used to filter |
|
|
314 | screen output (e.g. underline urls or other useless stuff). Only lines |
|
|
315 | that are being shown will be filtered, and, due to performance reasons, |
|
|
316 | not always immediately. |
|
|
317 | </dd> |
|
|
318 | <dd> |
|
|
319 | <p>The row number is always the topmost row of the line if the line spans |
|
|
320 | multiple rows.</p> |
|
|
321 | </dd> |
|
|
322 | <dd> |
|
|
323 | <p>Please note that, if you change the line, then the hook might get called |
|
|
324 | later with the already-modified line (e.g. if unrelated parts change), so |
|
|
325 | you cannot just toggle rendition bits, but only set them.</p> |
|
|
326 | </dd> |
|
|
327 | <p></p> |
242 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
328 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
243 | </dt> |
329 | </dt> |
244 | <dd> |
330 | <dd> |
245 | Called just before the screen gets redrawn. Can be used for overlay |
331 | Called just before the screen gets redrawn. Can be used for overlay |
246 | or similar effects by modify terminal contents in refresh_begin, and |
332 | or similar effects by modify terminal contents in refresh_begin, and |
… | |
… | |
259 | <dd> |
345 | <dd> |
260 | Called whenever the user presses a key combination that has a |
346 | 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> |
347 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
262 | resource in the <code>rxvt(1)</code> manpage). |
348 | resource in the <code>rxvt(1)</code> manpage). |
263 | </dd> |
349 | </dd> |
|
|
350 | <p></p> |
|
|
351 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> |
|
|
352 | </dt> |
|
|
353 | <dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> |
|
|
354 | </dt> |
|
|
355 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
|
|
356 | </dt> |
|
|
357 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
|
|
358 | </dt> |
|
|
359 | <dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br /> |
|
|
360 | </dt> |
|
|
361 | <dd> |
|
|
362 | Called whenever the corresponding X event is received for the terminal If |
|
|
363 | the hook returns true, then the even will be ignored by rxvt-unicode. |
|
|
364 | </dd> |
|
|
365 | <dd> |
|
|
366 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
|
|
367 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
|
|
368 | and column under the mouse cursor.</p> |
|
|
369 | </dd> |
|
|
370 | <dd> |
|
|
371 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
|
|
372 | output, if any, in locale-specific encoding.</p> |
|
|
373 | </dd> |
|
|
374 | <dd> |
|
|
375 | <p>subwindow.</p> |
|
|
376 | </dd> |
264 | <p></p></dl> |
377 | <p></p></dl> |
265 | <p> |
378 | <p> |
266 | </p> |
379 | </p> |
267 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
380 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
268 | <dl> |
381 | <dl> |
269 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
382 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
270 | </dt> |
383 | </dt> |
271 | <dd> |
384 | <dd> |
272 | The current terminal. Whenever a callback/Hook is bein executed, this |
385 | The current terminal. This variable stores the current <code>urxvt::term</code> |
273 | variable stores the current <code>urxvt::term</code> object. |
386 | object, whenever a callback/hook is executing. |
274 | </dd> |
387 | </dd> |
275 | <p></p></dl> |
388 | <p></p></dl> |
276 | <p> |
389 | <p> |
277 | </p> |
390 | </p> |
278 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
391 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
279 | <dl> |
392 | <dl> |
|
|
393 | <dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
|
|
394 | </dt> |
|
|
395 | <dd> |
|
|
396 | Creates a new terminal, very similar as if you had started it with |
|
|
397 | <code>system $binfile, arg...</code>. Croaks (and probably outputs an error message) |
|
|
398 | if the new instance couldn't be created. Returns <code>undef</code> if the new |
|
|
399 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
400 | <code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call. |
|
|
401 | </dd> |
|
|
402 | <p></p> |
280 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
403 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
281 | </dt> |
404 | </dt> |
282 | <dd> |
405 | <dd> |
283 | Fatally aborts execution with the given error message. Avoid at all |
406 | Fatally aborts execution with the given error message. Avoid at all |
284 | costs! The only time this is acceptable is when the terminal process |
407 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
367 | <p></p></dl> |
490 | <p></p></dl> |
368 | <p> |
491 | <p> |
369 | </p> |
492 | </p> |
370 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
493 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
371 | <dl> |
494 | <dl> |
|
|
495 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
|
|
496 | </dt> |
|
|
497 | <dd> |
|
|
498 | Destroy the terminal object (close the window, free resources etc.). |
|
|
499 | </dd> |
|
|
500 | <p></p> |
372 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
501 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
373 | </dt> |
502 | </dt> |
374 | <dd> |
503 | <dd> |
375 | Returns the current resource value associated with a given name and |
504 | 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> |
505 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
… | |
… | |
400 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
529 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
401 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
530 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
402 | display_name embed ext_bwidth fade font geometry hold iconName |
531 | display_name embed ext_bwidth fade font geometry hold iconName |
403 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
532 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
404 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
533 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
405 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
534 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
406 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
535 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
407 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
536 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
408 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
537 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
409 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
538 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
410 | shade term_name title transparent transparent_all tripleclickwords |
539 | shade term_name title transparent transparent_all tripleclickwords |
411 | utmpInhibit visualBell</pre> |
540 | utmpInhibit visualBell</pre> |
412 | </dd> |
541 | </dd> |
413 | <p></p> |
542 | <p></p> |
|
|
543 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
|
|
544 | </dt> |
|
|
545 | <dd> |
|
|
546 | Return and optionally change the current rendition. Text that is output by |
|
|
547 | the terminal application will use this style. |
|
|
548 | </dd> |
|
|
549 | <p></p> |
|
|
550 | <dt><strong><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a></strong><br /> |
|
|
551 | </dt> |
|
|
552 | <dd> |
|
|
553 | Return the current coordinates of the text cursor position and optionally |
|
|
554 | set it (which is usually bad as applications don't expect that). |
|
|
555 | </dd> |
|
|
556 | <p></p> |
414 | <dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong><br /> |
557 | <dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong><br /> |
415 | </dt> |
558 | </dt> |
416 | <dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong><br /> |
559 | <dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong><br /> |
417 | </dt> |
560 | </dt> |
418 | <dt><strong><a name="item_selection_end">($row, $col) = $term->selection_end ([$row, $col])</a></strong><br /> |
561 | <dt><strong><a name="item_selection_end">($row, $col) = $term->selection_end ([$row, $col])</a></strong><br /> |
… | |
… | |
437 | <dd> |
580 | <dd> |
438 | <p>#=item $term->overlay ($x, $y, $text) |
581 | <p>#=item $term->overlay ($x, $y, $text) |
439 | # |
582 | # |
440 | #Create a simple multi-line overlay box. See the next method for details. |
583 | #Create a simple multi-line overlay box. See the next method for details. |
441 | # |
584 | # |
442 | #=cut</p> |
585 | #=cut |
443 | </dd> |
586 | # |
444 | <dd> |
|
|
445 | <p>sub urxvt::term::scr_overlay { |
587 | #sub urxvt::term::scr_overlay { |
446 | die; |
|
|
447 | my ($self, $x, $y, $text) = @_;</p> |
588 | # my ($self, $x, $y, $text) = @_; |
448 | </dd> |
589 | # |
449 | <dd> |
|
|
450 | <pre> |
|
|
451 | my @lines = split /\n/, $text;</pre> |
590 | # my @lines = split /\n/, $text; |
452 | </dd> |
591 | # |
453 | <dd> |
|
|
454 | <pre> |
|
|
455 | my $w = 0; |
592 | # my $w = 0; |
456 | for (map $self->strwidth ($_), @lines) { |
593 | # for (map $self->strwidth ($_), @lines) { |
457 | $w = $_ if $w < $_; |
594 | # $w = $_ if $w < $_; |
458 | }</pre> |
595 | # } |
459 | </dd> |
596 | # |
460 | <dd> |
|
|
461 | <pre> |
|
|
462 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
597 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
463 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
598 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
464 | }</pre> |
599 | #}</p> |
465 | </dd> |
600 | </dd> |
466 | <p></p> |
601 | <p></p> |
467 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
602 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
468 | </dt> |
603 | </dt> |
469 | <dd> |
604 | <dd> |
… | |
… | |
505 | </dt> |
640 | </dt> |
506 | <dd> |
641 | <dd> |
507 | If hidden, display the overlay again. |
642 | If hidden, display the overlay again. |
508 | </dd> |
643 | </dd> |
509 | <p></p></dl> |
644 | <p></p></dl> |
510 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth $string</a></strong><br /> |
645 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a></strong><br /> |
511 | </dt> |
646 | </dt> |
512 | <dd> |
647 | <dd> |
513 | Returns the number of screen-cells this string would need. Correctly |
648 | Returns the number of screen-cells this string would need. Correctly |
514 | accounts for wide and combining characters. |
649 | accounts for wide and combining characters. |
515 | </dd> |
650 | </dd> |
516 | <p></p> |
651 | <p></p> |
517 | <dt><strong><a name="item_locale_encode">$octets = $term->locale_encode $string</a></strong><br /> |
652 | <dt><strong><a name="item_locale_encode">$octets = $term->locale_encode ($string)</a></strong><br /> |
518 | </dt> |
653 | </dt> |
519 | <dd> |
654 | <dd> |
520 | Convert the given text string into the corresponding locale encoding. |
655 | Convert the given text string into the corresponding locale encoding. |
521 | </dd> |
656 | </dd> |
522 | <p></p> |
657 | <p></p> |
523 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode $octets</a></strong><br /> |
658 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
524 | </dt> |
659 | </dt> |
525 | <dd> |
660 | <dd> |
526 | Convert the given locale-encoded octets into a perl string. |
661 | Convert the given locale-encoded octets into a perl string. |
|
|
662 | </dd> |
|
|
663 | <p></p> |
|
|
664 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
|
|
665 | </dt> |
|
|
666 | <dd> |
|
|
667 | Write the given text string to the screen, as if output by the application |
|
|
668 | running inside the terminal. It may not contain command sequences (escape |
|
|
669 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
670 | string is a normal text string, not in locale-dependent encoding. |
|
|
671 | </dd> |
|
|
672 | <dd> |
|
|
673 | <p>Normally its not a good idea to use this function, as programs might be |
|
|
674 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
675 | <code>on_add_lines</code> hook, though.</p> |
|
|
676 | </dd> |
|
|
677 | <p></p> |
|
|
678 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
|
|
679 | </dt> |
|
|
680 | <dd> |
|
|
681 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
|
|
682 | locale-specific encoding of the terminal and can contain command sequences |
|
|
683 | (escape codes) that will be interpreted. |
527 | </dd> |
684 | </dd> |
528 | <p></p> |
685 | <p></p> |
529 | <dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
686 | <dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
530 | </dt> |
687 | </dt> |
531 | <dd> |
688 | <dd> |
532 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
689 | 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 |
690 | 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>. |
691 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
535 | </dd> |
692 | </dd> |
536 | <p></p> |
693 | <p></p> |
|
|
694 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
|
|
695 | </dt> |
|
|
696 | <dd> |
|
|
697 | Return the window id of the toplevel window. |
|
|
698 | </dd> |
|
|
699 | <p></p> |
|
|
700 | <dt><strong><a name="item_vt">$windowid = $term->vt</a></strong><br /> |
|
|
701 | </dt> |
|
|
702 | <dd> |
|
|
703 | Return the window id of the terminal window. |
|
|
704 | </dd> |
|
|
705 | <p></p> |
|
|
706 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
|
|
707 | </dt> |
|
|
708 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
|
|
709 | </dt> |
|
|
710 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
|
|
711 | </dt> |
|
|
712 | <dt><strong><a name="item_fheight">$font_height = $term->fheight</a></strong><br /> |
|
|
713 | </dt> |
|
|
714 | <dt><strong><a name="item_fbase">$font_ascent = $term->fbase</a></strong><br /> |
|
|
715 | </dt> |
537 | <dt><strong><a name="item_nrow">$nrow = $term->nrow</a></strong><br /> |
716 | <dt><strong><a name="item_nrow">$terminal_rows = $term->nrow</a></strong><br /> |
538 | </dt> |
717 | </dt> |
539 | <dt><strong><a name="item_ncol">$ncol = $term->ncol</a></strong><br /> |
718 | <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> |
719 | </dt> |
545 | <p></p> |
720 | <dt><strong><a name="item_focus">$has_focus = $term->focus</a></strong><br /> |
|
|
721 | </dt> |
|
|
722 | <dt><strong><a name="item_mapped">$is_mapped = $term->mapped</a></strong><br /> |
|
|
723 | </dt> |
|
|
724 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
|
|
725 | </dt> |
|
|
726 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
|
|
727 | </dt> |
546 | <dt><strong><a name="item_nsaved">$nsaved = $term->nsaved</a></strong><br /> |
728 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
547 | </dt> |
729 | </dt> |
548 | <dd> |
730 | <dd> |
549 | Returns the number of lines in the scrollback buffer. |
731 | Return various integers describing terminal characteristics. |
550 | </dd> |
732 | </dd> |
551 | <p></p> |
733 | <p></p> |
552 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
734 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
553 | </dt> |
735 | </dt> |
554 | <dd> |
736 | <dd> |
… | |
… | |
582 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
764 | 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 |
765 | to replace only parts of a line. The font index in the rendition will |
584 | automatically be updated.</p> |
766 | automatically be updated.</p> |
585 | </dd> |
767 | </dd> |
586 | <dd> |
768 | <dd> |
587 | <p><code>$text</code> is in a special encoding: tabs and wide characters that use more |
769 | <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 |
770 | than one cell when displayed are padded with urxvt::NOCHAR characters |
589 | (<code>chr 65535</code>). Characters with combining characters and other characters |
771 | (<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 |
772 | that do not fit into the normal tetx encoding will be replaced with |
591 | characters in the private use area.</p> |
773 | characters in the private use area.</p> |
592 | </dd> |
774 | </dd> |
… | |
… | |
637 | Create and return a new <code>urxvt::line</code> object that stores information |
819 | 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 |
820 | about the logical line that row <code>$row_number</code> is part of. It supports the |
639 | following methods: |
821 | following methods: |
640 | </dd> |
822 | </dd> |
641 | <dl> |
823 | <dl> |
642 | <dt><strong><a name="item_t">$text = $line->t</a></strong><br /> |
824 | <dt><strong><a name="item_t">$text = $line->t ([$new_text])</a></strong><br /> |
643 | </dt> |
825 | </dt> |
644 | <dd> |
826 | <dd> |
645 | Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
827 | Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
646 | </dd> |
828 | </dd> |
647 | <p></p> |
829 | <p></p> |
648 | <dt><strong><a name="item_r">$rend = $line->r</a></strong><br /> |
830 | <dt><strong><a name="item_r">$rend = $line->r ([$new_rend])</a></strong><br /> |
649 | </dt> |
831 | </dt> |
650 | <dd> |
832 | <dd> |
651 | Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
833 | Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
652 | </dd> |
834 | </dd> |
653 | <p></p> |
835 | <p></p> |
654 | <dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
836 | <dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
655 | </dt> |
837 | </dt> |
656 | <dd> |
838 | <dd> |