… | |
… | |
94 | =item option-popup (enabled by default) |
94 | =item option-popup (enabled by default) |
95 | |
95 | |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
97 | runtime. |
97 | runtime. |
98 | |
98 | |
|
|
99 | Other extensions can extend this popup menu by pushing a code reference |
|
|
100 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
|
|
101 | popup is being displayed. |
|
|
102 | |
|
|
103 | It's sole argument is the popup menu, which can be modified. It should |
|
|
104 | either return nothing or a string, the initial boolean value and a code |
|
|
105 | reference. The string will be used as button text and the code reference |
|
|
106 | will be called when the toggle changes, with the new boolean value as |
|
|
107 | first argument. |
|
|
108 | |
|
|
109 | The following will add an entry C<myoption> that changes |
|
|
110 | C<$self->{myoption}>: |
|
|
111 | |
|
|
112 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
113 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
114 | }; |
|
|
115 | |
99 | =item selection-popup (enabled by default) |
116 | =item selection-popup (enabled by default) |
100 | |
117 | |
101 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
118 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
102 | text into various other formats/action (such as uri unescaping, perl |
119 | text into various other formats/action (such as uri unescaping, perl |
103 | evaluation, web-browser starting etc.), depending on content. |
120 | evaluation, web-browser starting etc.), depending on content. |
104 | |
121 | |
105 | Other extensions can extend this popup menu by pushing a code reference |
122 | Other extensions can extend this popup menu by pushing a code reference |
106 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
107 | popup is displayed. |
124 | popup is being displayed. |
108 | |
125 | |
109 | It's sole argument is the popup menu, which can be modified. The selection |
126 | It's sole argument is the popup menu, which can be modified. The selection |
110 | is in C<$_>, which can be used to decide wether to add something or not. |
127 | is in C<$_>, which can be used to decide wether to add something or not. |
111 | It should either return nothing or a string and a code reference. The |
128 | It should either return nothing or a string and a code reference. The |
112 | string will be used as button text and the code reference will be called |
129 | string will be used as button text and the code reference will be called |
… | |
… | |
205 | |
222 | |
206 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
223 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
207 | B<Shift-Right> will switch to the tab left or right of the current one, |
224 | B<Shift-Right> will switch to the tab left or right of the current one, |
208 | while B<Shift-Down> creates a new tab. |
225 | while B<Shift-Down> creates a new tab. |
209 | |
226 | |
|
|
227 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
228 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
229 | following four resources (shown with defaults): |
|
|
230 | |
|
|
231 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
232 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
233 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
234 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
235 | |
|
|
236 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
237 | indices. |
|
|
238 | |
210 | =item mark-urls |
239 | =item mark-urls |
211 | |
240 | |
212 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
241 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
213 | make them clickable. When middle-clicked, the program specified in the |
242 | make them clickable. When middle-clicked, the program specified in the |
214 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
243 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
215 | the URL as first argument. |
244 | the URL as first argument. |
216 | |
245 | |
|
|
246 | =item xim-onthespot |
|
|
247 | |
|
|
248 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
249 | not work perfectly, and some input methods don't seem to work well with |
|
|
250 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
251 | kinput2. |
|
|
252 | |
|
|
253 | You enable it by specifying this extension and a preedit style of |
|
|
254 | C<OnTheSpot>, i.e.: |
|
|
255 | |
|
|
256 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
257 | |
217 | =item automove-background |
258 | =item automove-background |
218 | |
259 | |
219 | This is basically a one-line extension that dynamically changes the background pixmap offset |
260 | This is basically a one-line extension that dynamically changes the background pixmap offset |
220 | to the window position, in effect creating the same effect as pseudo transparency with |
261 | to the window position, in effect creating the same effect as pseudo transparency with |
221 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
262 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
… | |
… | |
230 | |
271 | |
231 | =item digital-clock |
272 | =item digital-clock |
232 | |
273 | |
233 | Displays a digital clock using the built-in overlay. |
274 | Displays a digital clock using the built-in overlay. |
234 | |
275 | |
235 | =item example-refresh-hooks |
276 | =item remote-clipboard |
236 | |
277 | |
237 | Displays a very simple digital clock in the upper right corner of the |
278 | Somewhat of a misnomer, this extension adds two menu entries to the |
238 | window. Illustrates overwriting the refresh callbacks to create your own |
279 | selection popup that allows one ti run external commands to store the |
239 | overlays or changes. |
280 | selection somewhere and fetch it again. |
|
|
281 | |
|
|
282 | We use it to implement a "distributed selection mechanism", which just |
|
|
283 | means that one command uploads the file to a remote server, and another |
|
|
284 | reads it. |
|
|
285 | |
|
|
286 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
287 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
288 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
289 | the selection data on STDOUT (also in UTF-8). |
|
|
290 | |
|
|
291 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
292 | |
|
|
293 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
294 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
240 | |
295 | |
241 | =item selection-pastebin |
296 | =item selection-pastebin |
242 | |
297 | |
243 | This is a little rarely useful extension that Uploads the selection as |
298 | This is a little rarely useful extension that Uploads the selection as |
244 | textfile to a remote site (or does other things). (The implementation is |
299 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
264 | After a successful upload the selection will be replaced by the text given |
319 | After a successful upload the selection will be replaced by the text given |
265 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
320 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
266 | for the filename): |
321 | for the filename): |
267 | |
322 | |
268 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
323 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
324 | |
|
|
325 | =item example-refresh-hooks |
|
|
326 | |
|
|
327 | Displays a very simple digital clock in the upper right corner of the |
|
|
328 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
329 | overlays or changes. |
269 | |
330 | |
270 | =back |
331 | =back |
271 | |
332 | |
272 | =head1 API DOCUMENTATION |
333 | =head1 API DOCUMENTATION |
273 | |
334 | |
… | |
… | |
370 | Called at the very end of initialisation of a new terminal, just before |
431 | Called at the very end of initialisation of a new terminal, just before |
371 | trying to map (display) the toplevel and returning to the mainloop. |
432 | trying to map (display) the toplevel and returning to the mainloop. |
372 | |
433 | |
373 | =item on_destroy $term |
434 | =item on_destroy $term |
374 | |
435 | |
375 | Called whenever something tries to destroy terminal, before doing anything |
436 | Called whenever something tries to destroy terminal, when the terminal is |
376 | yet. If this hook returns true, then destruction is skipped, but this is |
437 | still fully functional (not for long, though). |
377 | rarely a good idea. |
|
|
378 | |
438 | |
379 | =item on_reset $term |
439 | =item on_reset $term |
380 | |
440 | |
381 | Called after the screen is "reset" for any reason, such as resizing or |
441 | Called after the screen is "reset" for any reason, such as resizing or |
382 | control sequences. Here is where you can react on changes to size-related |
442 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
484 | |
544 | |
485 | =item on_refresh_end $term |
545 | =item on_refresh_end $term |
486 | |
546 | |
487 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
547 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
488 | |
548 | |
489 | =item on_keyboard_command $term, $string |
549 | =item on_user_command $term, $string |
490 | |
550 | |
491 | Called whenever the user presses a key combination that has a |
551 | Called whenever the a user-configured event is being activated (e.g. via |
492 | C<perl:string> action bound to it (see description of the B<keysym> |
552 | a C<perl:string> action bound to a key, see description of the B<keysym> |
493 | resource in the @@RXVT_NAME@@(1) manpage). |
553 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
554 | |
|
|
555 | The event is simply the action string. This interface is assumed to change |
|
|
556 | slightly in the future. |
|
|
557 | |
|
|
558 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
559 | |
|
|
560 | Called just after the new window size has been calculcated, but before |
|
|
561 | windows are actually being resized or hints are being set. If this hook |
|
|
562 | returns TRUE, setting of the window hints is being skipped. |
494 | |
563 | |
495 | =item on_x_event $term, $event |
564 | =item on_x_event $term, $event |
496 | |
565 | |
497 | Called on every X event received on the vt window (and possibly other |
566 | Called on every X event received on the vt window (and possibly other |
498 | windows). Should only be used as a last resort. Most event structure |
567 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
633 | Using this function has the advantage that its output ends up in the |
702 | Using this function has the advantage that its output ends up in the |
634 | correct place, e.g. on stderr of the connecting urxvtc client. |
703 | correct place, e.g. on stderr of the connecting urxvtc client. |
635 | |
704 | |
636 | Messages have a size limit of 1023 bytes currently. |
705 | Messages have a size limit of 1023 bytes currently. |
637 | |
706 | |
|
|
707 | =item @terms = urxvt::termlist |
|
|
708 | |
|
|
709 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
710 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
711 | objects that have perl extensions attached will be returned (because there |
|
|
712 | is no urxvt::term objet associated with others). |
|
|
713 | |
638 | =item $time = urxvt::NOW |
714 | =item $time = urxvt::NOW |
639 | |
715 | |
640 | Returns the "current time" (as per the event loop). |
716 | Returns the "current time" (as per the event loop). |
641 | |
717 | |
642 | =item urxvt::CurrentTime |
718 | =item urxvt::CurrentTime |
… | |
… | |
699 | Return the foreground/background colour index, respectively. |
775 | Return the foreground/background colour index, respectively. |
700 | |
776 | |
701 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
777 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
702 | |
778 | |
703 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
779 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
780 | |
|
|
781 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
704 | |
782 | |
705 | Replace the foreground/background colour in the rendition mask with the |
783 | Replace the foreground/background colour in the rendition mask with the |
706 | specified one. |
784 | specified one. |
707 | |
785 | |
708 | =item $value = urxvt::GET_CUSTOM $rend |
786 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
799 | } else { |
877 | } else { |
800 | $ext_arg{$_} ||= []; |
878 | $ext_arg{$_} ||= []; |
801 | } |
879 | } |
802 | } |
880 | } |
803 | |
881 | |
804 | while (my ($ext, $argv) = each %ext_arg) { |
882 | for my $ext (sort keys %ext_arg) { |
805 | my @files = grep -f $_, map "$_/$ext", @dirs; |
883 | my @files = grep -f $_, map "$_/$ext", @dirs; |
806 | |
884 | |
807 | if (@files) { |
885 | if (@files) { |
808 | $TERM->register_package (extension_package $files[0], $argv); |
886 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
809 | } else { |
887 | } else { |
810 | warn "perl extension '$ext' not found in perl library search path\n"; |
888 | warn "perl extension '$ext' not found in perl library search path\n"; |
811 | } |
889 | } |
812 | } |
890 | } |
813 | |
891 | |
… | |
… | |
844 | # clear package |
922 | # clear package |
845 | %$TERM = (); |
923 | %$TERM = (); |
846 | } |
924 | } |
847 | |
925 | |
848 | $retval |
926 | $retval |
|
|
927 | } |
|
|
928 | |
|
|
929 | sub SET_COLOR($$$) { |
|
|
930 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
849 | } |
931 | } |
850 | |
932 | |
851 | # urxvt::term::extension |
933 | # urxvt::term::extension |
852 | |
934 | |
853 | package urxvt::term::extension; |
935 | package urxvt::term::extension; |
… | |
… | |
1022 | hash which defines the environment of the new terminal. |
1104 | hash which defines the environment of the new terminal. |
1023 | |
1105 | |
1024 | Croaks (and probably outputs an error message) if the new instance |
1106 | Croaks (and probably outputs an error message) if the new instance |
1025 | couldn't be created. Returns C<undef> if the new instance didn't |
1107 | couldn't be created. Returns C<undef> if the new instance didn't |
1026 | initialise perl, and the terminal object otherwise. The C<init> and |
1108 | initialise perl, and the terminal object otherwise. The C<init> and |
1027 | C<start> hooks will be called during this call. |
1109 | C<start> hooks will be called before this call returns, and are free to |
|
|
1110 | refer to global data (which is race free). |
1028 | |
1111 | |
1029 | =cut |
1112 | =cut |
1030 | |
1113 | |
1031 | sub new { |
1114 | sub new { |
1032 | my ($class, $env, @args) = @_; |
1115 | my ($class, $env, @args) = @_; |
1033 | |
1116 | |
|
|
1117 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1118 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1119 | |
1034 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1120 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
1035 | } |
1121 | } |
1036 | |
1122 | |
1037 | =item $term->destroy |
1123 | =item $term->destroy |
1038 | |
1124 | |
1039 | Destroy the terminal object (close the window, free resources |
1125 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1339 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1425 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1340 | to receive pointer events all the times: |
1426 | to receive pointer events all the times: |
1341 | |
1427 | |
1342 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1428 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1343 | |
1429 | |
|
|
1430 | =item $term->focus_in |
|
|
1431 | |
|
|
1432 | =item $term->focus_out |
|
|
1433 | |
|
|
1434 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1435 | |
|
|
1436 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1437 | |
|
|
1438 | Deliver various fake events to to terminal. |
|
|
1439 | |
1344 | =item $window_width = $term->width |
1440 | =item $window_width = $term->width |
1345 | |
1441 | |
1346 | =item $window_height = $term->height |
1442 | =item $window_height = $term->height |
1347 | |
1443 | |
1348 | =item $font_width = $term->fwidth |
1444 | =item $font_width = $term->fwidth |
… | |
… | |
1593 | =item $string = $term->special_decode $text |
1689 | =item $string = $term->special_decode $text |
1594 | |
1690 | |
1595 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1691 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1596 | C<< $term->ROW_t >> for details. |
1692 | C<< $term->ROW_t >> for details. |
1597 | |
1693 | |
1598 | =item $success = $term->grab_button ($button, $modifiermask) |
1694 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1599 | |
1695 | |
|
|
1696 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1697 | |
1600 | Registers a synchronous button grab. See the XGrabButton manpage. |
1698 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1699 | manpage. |
1601 | |
1700 | |
1602 | =item $success = $term->grab ($eventtime[, $sync]) |
1701 | =item $success = $term->grab ($eventtime[, $sync]) |
1603 | |
1702 | |
1604 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1703 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1605 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1704 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
… | |
… | |
1723 | my ($self, $text, $cb) = @_; |
1822 | my ($self, $text, $cb) = @_; |
1724 | |
1823 | |
1725 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1824 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1726 | } |
1825 | } |
1727 | |
1826 | |
1728 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1827 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1729 | |
1828 | |
1730 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1829 | Adds a toggle/checkbox item to the popup. The callback gets called |
1731 | whenever it gets toggled, with a boolean indicating its value as its first |
1830 | whenever it gets toggled, with a boolean indicating its new value as its |
1732 | argument. |
1831 | first argument. |
1733 | |
1832 | |
1734 | =cut |
1833 | =cut |
1735 | |
1834 | |
1736 | sub add_toggle { |
1835 | sub add_toggle { |
1737 | my ($self, $text, $cb, $value) = @_; |
1836 | my ($self, $text, $value, $cb) = @_; |
1738 | |
1837 | |
1739 | my $item; $item = { |
1838 | my $item; $item = { |
1740 | type => "button", |
1839 | type => "button", |
1741 | text => " $text", |
1840 | text => " $text", |
1742 | value => $value, |
1841 | value => $value, |