ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.128 by root, Wed Jan 25 00:57:57 2006 UTC vs.
Revision 1.132 by root, Mon Feb 6 05:40:15 2006 UTC

… …
205 205
206Clicking a button will activate that tab. Pressing B<Shift-Left> and 206Clicking a button will activate that tab. Pressing B<Shift-Left> and
207B<Shift-Right> will switch to the tab left or right of the current one, 207B<Shift-Right> will switch to the tab left or right of the current one,
208while B<Shift-Down> creates a new tab. 208while B<Shift-Down> creates a new tab.
209 209
210The tabbar itself can be configured similarly to a normal terminal, but
211with a resource class of C<URxvt.tabbed>. In addition, it supports the
212following four resources (shown with defaults):
213
214 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
215 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
216 URxvt.tabbed.tab-fg: <colour-index, default 0>
217 URxvt.tabbed.tab-bg: <colour-index, default 1>
218
219See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
220indices.
221
210=item mark-urls 222=item mark-urls
211 223
212Uses per-line display filtering (C<on_line_update>) to underline urls and 224Uses per-line display filtering (C<on_line_update>) to underline urls and
213make them clickable. When middle-clicked, the program specified in the 225make them clickable. When middle-clicked, the program specified in the
214resource C<urlLauncher> (default C<x-www-browser>) will be started with 226resource C<urlLauncher> (default C<x-www-browser>) will be started with
… …
242 254
243=item digital-clock 255=item digital-clock
244 256
245Displays a digital clock using the built-in overlay. 257Displays a digital clock using the built-in overlay.
246 258
247=item example-refresh-hooks 259=item remote-clipboard
248 260
249Displays a very simple digital clock in the upper right corner of the 261Somewhat of a misnomer, this extension adds two menu entries to the
250window. Illustrates overwriting the refresh callbacks to create your own 262selection popup that allows one ti run external commands to store the
251overlays or changes. 263selection somewhere and fetch it again.
264
265We use it to implement a "distributed selection mechanism", which just
266means that one command uploads the file to a remote server, and another
267reads it.
268
269The commands can be set using the C<URxvt.remote-selection.store> and
270C<URxvt.remote-selection.fetch> resources. The first should read the
271selection to store from STDIN (always in UTF-8), the second should provide
272the selection data on STDOUT (also in UTF-8).
273
274The defaults (which are likely useless to you) use rsh and cat:
275
276 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
277 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
252 278
253=item selection-pastebin 279=item selection-pastebin
254 280
255This is a little rarely useful extension that Uploads the selection as 281This is a little rarely useful extension that Uploads the selection as
256textfile to a remote site (or does other things). (The implementation is 282textfile to a remote site (or does other things). (The implementation is
… …
276After a successful upload the selection will be replaced by the text given 302After a successful upload the selection will be replaced by the text given
277in the C<selection-pastebin-url> resource (again, the % is the placeholder 303in the C<selection-pastebin-url> resource (again, the % is the placeholder
278for the filename): 304for the filename):
279 305
280 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 306 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
307
308=item example-refresh-hooks
309
310Displays a very simple digital clock in the upper right corner of the
311window. Illustrates overwriting the refresh callbacks to create your own
312overlays or changes.
281 313
282=back 314=back
283 315
284=head1 API DOCUMENTATION 316=head1 API DOCUMENTATION
285 317
… …
495 527
496=item on_refresh_end $term 528=item on_refresh_end $term
497 529
498Called just after the screen gets redrawn. See C<on_refresh_begin>. 530Called just after the screen gets redrawn. See C<on_refresh_begin>.
499 531
500=item on_keyboard_command $term, $string 532=item on_user_command $term, $string
501 533
502Called whenever the user presses a key combination that has a 534Called whenever the a user-configured event is being activated (e.g. via
503C<perl:string> action bound to it (see description of the B<keysym> 535a C<perl:string> action bound to a key, see description of the B<keysym>
504resource in the @@RXVT_NAME@@(1) manpage). 536resource in the @@RXVT_NAME@@(1) manpage).
537
538The event is simply the action string. This interface is assumed to change
539slightly in the future.
505 540
506=item on_x_event $term, $event 541=item on_x_event $term, $event
507 542
508Called on every X event received on the vt window (and possibly other 543Called on every X event received on the vt window (and possibly other
509windows). Should only be used as a last resort. Most event structure 544windows). Should only be used as a last resort. Most event structure
… …
644Using this function has the advantage that its output ends up in the 679Using this function has the advantage that its output ends up in the
645correct place, e.g. on stderr of the connecting urxvtc client. 680correct place, e.g. on stderr of the connecting urxvtc client.
646 681
647Messages have a size limit of 1023 bytes currently. 682Messages have a size limit of 1023 bytes currently.
648 683
684=item @terms = urxvt::termlist
685
686Returns all urxvt::term objects that exist in this process, regardless of
687wether they are started, being destroyed etc., so be careful. Only term
688objects that have perl extensions attached will be returned (because there
689is no urxvt::term objet associated with others).
690
649=item $time = urxvt::NOW 691=item $time = urxvt::NOW
650 692
651Returns the "current time" (as per the event loop). 693Returns the "current time" (as per the event loop).
652 694
653=item urxvt::CurrentTime 695=item urxvt::CurrentTime
… …
710Return the foreground/background colour index, respectively. 752Return the foreground/background colour index, respectively.
711 753
712=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 754=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
713 755
714=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 756=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
757
758=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
715 759
716Replace the foreground/background colour in the rendition mask with the 760Replace the foreground/background colour in the rendition mask with the
717specified one. 761specified one.
718 762
719=item $value = urxvt::GET_CUSTOM $rend 763=item $value = urxvt::GET_CUSTOM $rend
… …
857 } 901 }
858 902
859 $retval 903 $retval
860} 904}
861 905
906sub SET_COLOR($$$) {
907 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
908}
909
862# urxvt::term::extension 910# urxvt::term::extension
863 911
864package urxvt::term::extension; 912package urxvt::term::extension;
865 913
866sub enable { 914sub enable {
… …
1033hash which defines the environment of the new terminal. 1081hash which defines the environment of the new terminal.
1034 1082
1035Croaks (and probably outputs an error message) if the new instance 1083Croaks (and probably outputs an error message) if the new instance
1036couldn't be created. Returns C<undef> if the new instance didn't 1084couldn't be created. Returns C<undef> if the new instance didn't
1037initialise perl, and the terminal object otherwise. The C<init> and 1085initialise perl, and the terminal object otherwise. The C<init> and
1038C<start> hooks will be called during this call. 1086C<start> hooks will be called before this call returns, and are free to
1087refer to global data (which is race free).
1039 1088
1040=cut 1089=cut
1041 1090
1042sub new { 1091sub new {
1043 my ($class, $env, @args) = @_; 1092 my ($class, $env, @args) = @_;
1044 1093
1094 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1095 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1096
1045 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1097 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1046} 1098}
1047 1099
1048=item $term->destroy 1100=item $term->destroy
1049 1101
1050Destroy the terminal object (close the window, free resources 1102Destroy the terminal object (close the window, free resources
… …
1350Adds the specified events to the vt event mask. Useful e.g. when you want 1402Adds the specified events to the vt event mask. Useful e.g. when you want
1351to receive pointer events all the times: 1403to receive pointer events all the times:
1352 1404
1353 $term->vt_emask_add (urxvt::PointerMotionMask); 1405 $term->vt_emask_add (urxvt::PointerMotionMask);
1354 1406
1407=item $term->focus_in
1408
1409=item $term->focus_out
1410
1411=item $term->key_press ($state, $keycode[, $time])
1412
1413=item $term->key_release ($state, $keycode[, $time])
1414
1415Deliver various fake events to to terminal.
1416
1355=item $window_width = $term->width 1417=item $window_width = $term->width
1356 1418
1357=item $window_height = $term->height 1419=item $window_height = $term->height
1358 1420
1359=item $font_width = $term->fwidth 1421=item $font_width = $term->fwidth
… …
1604=item $string = $term->special_decode $text 1666=item $string = $term->special_decode $text
1605 1667
1606Converts rxvt-unicodes text reprsentation into a perl string. See 1668Converts rxvt-unicodes text reprsentation into a perl string. See
1607C<< $term->ROW_t >> for details. 1669C<< $term->ROW_t >> for details.
1608 1670
1609=item $success = $term->grab_button ($button, $modifiermask) 1671=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1610 1672
1673=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1674
1611Registers a synchronous button grab. See the XGrabButton manpage. 1675Register/unregister a synchronous button grab. See the XGrabButton
1676manpage.
1612 1677
1613=item $success = $term->grab ($eventtime[, $sync]) 1678=item $success = $term->grab ($eventtime[, $sync])
1614 1679
1615Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1680Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1616synchronous (C<$sync> is true). Also remembers the grab timestampe. 1681synchronous (C<$sync> is true). Also remembers the grab timestampe.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines