… | |
… | |
284 | output, if any, in locale-specific encoding. |
284 | output, if any, in locale-specific encoding. |
285 | |
285 | |
286 | subwindow. |
286 | subwindow. |
287 | |
287 | |
288 | Variables in the "urxvt" Package |
288 | Variables in the "urxvt" Package |
|
|
289 | $urxvt::LIBDIR |
|
|
290 | The rxvt-unicode library directory, where, among other things, the |
|
|
291 | perl modules and scripts are stored. |
|
|
292 | |
|
|
293 | $urxvt::RESCLASS, $urxvt::RESCLASS |
|
|
294 | The resource class and name rxvt-unicode uses to look up X |
|
|
295 | resources. |
|
|
296 | |
|
|
297 | $urxvt::RXVTNAME |
|
|
298 | The basename of the installed binaries, usually "urxvt". |
|
|
299 | |
289 | $urxvt::TERM |
300 | $urxvt::TERM |
290 | The current terminal. This variable stores the current "urxvt::term" |
301 | The current terminal. This variable stores the current "urxvt::term" |
291 | object, whenever a callback/hook is executing. |
302 | object, whenever a callback/hook is executing. |
|
|
303 | |
|
|
304 | * |
292 | |
305 | |
293 | Functions in the "urxvt" Package |
306 | Functions in the "urxvt" Package |
294 | $term = new urxvt [arg...] |
307 | $term = new urxvt [arg...] |
295 | Creates a new terminal, very similar as if you had started it with |
308 | Creates a new terminal, very similar as if you had started it with |
296 | "system $binfile, arg...". Croaks (and probably outputs an error |
309 | "system $binfile, arg...". Croaks (and probably outputs an error |
… | |
… | |
350 | |
363 | |
351 | $foreground = urxvt::GET_BASEFG $rend |
364 | $foreground = urxvt::GET_BASEFG $rend |
352 | $background = urxvt::GET_BASEBG $rend |
365 | $background = urxvt::GET_BASEBG $rend |
353 | Return the foreground/background colour index, respectively. |
366 | Return the foreground/background colour index, respectively. |
354 | |
367 | |
355 | $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
368 | $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
356 | $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
369 | $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
357 | Replace the foreground/background colour in the rendition mask with |
370 | Replace the foreground/background colour in the rendition mask with |
358 | the specified one. |
371 | the specified one. |
359 | |
372 | |
360 | $value = urxvt::GET_CUSTOM ($rend) |
373 | $value = urxvt::GET_CUSTOM $rend |
361 | Return the "custom" value: Every rendition has 5 bits for use by |
374 | Return the "custom" value: Every rendition has 5 bits for use by |
362 | extensions. They can be set and changed as you like and are |
375 | extensions. They can be set and changed as you like and are |
363 | initially zero. |
376 | initially zero. |
364 | |
377 | |
365 | $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
378 | $rend = urxvt::SET_CUSTOM $rend, $new_value |
366 | Change the custom value. |
379 | Change the custom value. |
367 | |
380 | |
368 | The "urxvt::anyevent" Class |
381 | The "urxvt::anyevent" Class |
369 | The sole purpose of this class is to deliver an interface to the |
382 | The sole purpose of this class is to deliver an interface to the |
370 | "AnyEvent" module - any module using it will work inside urxvt without |
383 | "AnyEvent" module - any module using it will work inside urxvt without |
371 | further work. The only exception is that you cannot wait on condition |
384 | further programming. The only exception is that you cannot wait on |
372 | variables, but non-blocking condvar use is ok. What this means is that |
385 | condition variables, but non-blocking condvar use is ok. What this means |
373 | you cannot use blocking APIs, but the non-blocking variant should work. |
386 | is that you cannot use blocking APIs, but the non-blocking variant |
|
|
387 | should work. |
374 | |
388 | |
375 | The "urxvt::term" Class |
389 | The "urxvt::term" Class |
376 | $term->destroy |
390 | $term->destroy |
377 | Destroy the terminal object (close the window, free resources etc.). |
391 | Destroy the terminal object (close the window, free resources etc.). |
|
|
392 | Please note that rxvt will not exit as long as any event watchers |
|
|
393 | (timers, io watchers) are still active. |
378 | |
394 | |
379 | $isset = $term->option ($optval[, $set]) |
395 | $isset = $term->option ($optval[, $set]) |
380 | Returns true if the option specified by $optval is enabled, and |
396 | Returns true if the option specified by $optval is enabled, and |
381 | optionally change it. All option values are stored by name in the |
397 | optionally change it. All option values are stored by name in the |
382 | hash %urxvt::OPTION. Options not enabled in this binary are not in |
398 | hash %urxvt::OPTION. Options not enabled in this binary are not in |
… | |
… | |
691 | Calls XUngrab for the most recent grab. Is called automatically on |
707 | Calls XUngrab for the most recent grab. Is called automatically on |
692 | evaluation errors, as it is better to lose the grab in the error |
708 | evaluation errors, as it is better to lose the grab in the error |
693 | case as the session. |
709 | case as the session. |
694 | |
710 | |
695 | The "urxvt::popup" Class |
711 | The "urxvt::popup" Class |
|
|
712 | $popup->add_title ($title) |
|
|
713 | Adds a non-clickable title to the popup. |
|
|
714 | |
|
|
715 | $popup->add_separator ([$sepchr]) |
|
|
716 | Creates a separator, optionally using the character given as |
|
|
717 | $sepchr. |
|
|
718 | |
|
|
719 | $popup->add_button ($text, $cb) |
|
|
720 | Adds a clickable button to the popup. $cb is called whenever it is |
|
|
721 | selected. |
|
|
722 | |
|
|
723 | $popup->add_toggle ($text, $cb, $initial_value) |
|
|
724 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
725 | whenever it gets toggled, with a boolean indicating its value as its |
|
|
726 | first argument. |
|
|
727 | |
|
|
728 | $popup->show |
|
|
729 | Displays the popup (which is initially hidden). |
|
|
730 | |
696 | The "urxvt::timer" Class |
731 | The "urxvt::timer" Class |
697 | This class implements timer watchers/events. Time is represented as |
732 | This class implements timer watchers/events. Time is represented as |
698 | a fractional number of seconds since the epoch. Example: |
733 | a fractional number of seconds since the epoch. Example: |
699 | |
734 | |
700 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
735 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |