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.178 by root, Sat Dec 26 09:02:42 2009 UTC vs.
Revision 1.185 by sf-exg, Fri Jul 2 12:44:45 2010 UTC

341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343 343
344=item selection-pastebin 344=item selection-pastebin
345 345
346This is a little rarely useful extension that Uploads the selection as 346This is a little rarely useful extension that uploads the selection as
347textfile to a remote site (or does other things). (The implementation is 347textfile to a remote site (or does other things). (The implementation is
348not currently secure for use in a multiuser environment as it writes to 348not currently secure for use in a multiuser environment as it writes to
349F</tmp> directly.). 349F</tmp> directly.).
350 350
351It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 351It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
370 370
371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372 372
373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret 373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374the double C</> characters as comment start. Use C<\057\057> instead, 374the double C</> characters as comment start. Use C<\057\057> instead,
375which works regardless of wether xrdb is used to parse the resource file 375which works regardless of whether xrdb is used to parse the resource file
376or not. 376or not.
377 377
378=item macosx-pastebin and macosx-pastebin-native 378=item macosx-clipboard and macosx-clipboard-native
379 379
380These two modules implement an extended clipboard for Mac OS X. They are 380These two modules implement an extended clipboard for Mac OS X. They are
381used like this: 381used like this:
382 382
383 URxvt.perl-ext-common: default,macosx-clipboard 383 URxvt.perl-ext-common: default,macosx-clipboard
384 URxvt.keysym.M-c: perl:macosx-clipboard:copy 384 URxvt.keysym.M-c: perl:macosx-clipboard:copy
385 URxvt.keysym.M-v: perl:macosx-clipboard:paste 385 URxvt.keysym.M-v: perl:macosx-clipboard:paste
386 386
387The difference between them is that the native variant requires a 387The difference between them is that the native variant requires a
388perl from apple's devkit or so, and C<maxosx-pastebin> requires the 388perl from apple's devkit or so, and C<macosx-clipboard> requires the
389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is 389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc. 390simpler etc. etc.
391 391
392=item example-refresh-hooks 392=item example-refresh-hooks
393 393
417 417
418=over 4 418=over 4
419 419
420=item $text 420=item $text
421 421
422Rxvt-unicodes special way of encoding text, where one "unicode" character 422Rxvt-unicode's special way of encoding text, where one "unicode" character
423always represents one screen cell. See L<ROW_t> for a discussion of this format. 423always represents one screen cell. See L<ROW_t> for a discussion of this format.
424 424
425=item $string 425=item $string
426 426
427A perl text string, with an emphasis on I<text>. It can store all unicode 427A perl text string, with an emphasis on I<text>. It can store all unicode
688 688
689=item on_map_notify $term, $event 689=item on_map_notify $term, $event
690 690
691=item on_unmap_notify $term, $event 691=item on_unmap_notify $term, $event
692 692
693Called whenever the corresponding X event is received for the terminal If 693Called whenever the corresponding X event is received for the terminal. If
694the hook returns true, then the even will be ignored by rxvt-unicode. 694the hook returns true, then the event will be ignored by rxvt-unicode.
695 695
696The event is a hash with most values as named by Xlib (see the XEvent 696The event is a hash with most values as named by Xlib (see the XEvent
697manpage), with the additional members C<row> and C<col>, which are the 697manpage), with the additional members C<row> and C<col>, which are the
698(real, not screen-based) row and column under the mouse cursor. 698(real, not screen-based) row and column under the mouse cursor.
699 699
708 708
709=item on_wm_delete_window $term, $event 709=item on_wm_delete_window $term, $event
710 710
711Called when various types of ClientMessage events are received (all with 711Called when various types of ClientMessage events are received (all with
712format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 712format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
713
714=item on_bell $term
715
716Called on receipt of a bell character.
713 717
714=back 718=back
715 719
716=cut 720=cut
717 721
1136 1140
1137 my $cb = $arg{cb}; 1141 my $cb = $arg{cb};
1138 1142
1139 urxvt::timer 1143 urxvt::timer
1140 ->new 1144 ->new
1141 ->after ($arg{after}) 1145 ->after ($arg{after}, $arg{interval})
1142 ->interval ($arg{interval})
1143 ->start
1144 ->cb ($argv{interval} ? $cb : sub { 1146 ->cb ($arg{interval} ? $cb : sub {
1145 $_[0]->stop; # need to cancel manually 1147 $_[0]->stop; # need to cancel manually
1146 $cb->(); 1148 $cb->();
1147 }) 1149 })
1148} 1150}
1149 1151
1374 1376
1375=item ($row, $col) = $term->selection_beg ([$row, $col]) 1377=item ($row, $col) = $term->selection_beg ([$row, $col])
1376 1378
1377=item ($row, $col) = $term->selection_end ([$row, $col]) 1379=item ($row, $col) = $term->selection_end ([$row, $col])
1378 1380
1379Return the current values of the selection mark, begin or end positions, 1381Return the current values of the selection mark, begin or end positions.
1380and optionally set them to new values. 1382
1383When arguments are given, then the selection coordinates are set to
1384C<$row> and C<$col>, and the selection screen is set to the current
1385screen.
1386
1387=item $screen = $term->selection_screen ([$screen])
1388
1389Returns the current selection screen, and then optionally sets it.
1381 1390
1382=item $term->selection_make ($eventtime[, $rectangular]) 1391=item $term->selection_make ($eventtime[, $rectangular])
1383 1392
1384Tries to make a selection as set by C<selection_beg> and 1393Tries to make a selection as set by C<selection_beg> and
1385C<selection_end>. If C<$rectangular> is true (default: false), a 1394C<selection_end>. If C<$rectangular> is true (default: false), a
1386rectangular selection will be made. This is the prefered function to make 1395rectangular selection will be made. This is the preferred function to make
1387a selection. 1396a selection.
1388 1397
1389=item $success = $term->selection_grab ($eventtime) 1398=item $success = $term->selection_grab ($eventtime[, $clipboard])
1390 1399
1391Try to request the primary selection text from the server (for example, as 1400Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1401true) selection from the server. The corresponding text can be set
1392set by the next method). No visual feedback will be given. This function 1402with the next method. No visual feedback will be given. This function
1393is mostly useful from within C<on_sel_grab> hooks. 1403is mostly useful from within C<on_sel_grab> hooks.
1394 1404
1395=item $oldtext = $term->selection ([$newtext]) 1405=item $oldtext = $term->selection ([$newtext, $clipboard])
1396 1406
1397Return the current selection text and optionally replace it by C<$newtext>. 1407Return the current selection (clipboard if C<$clipboard> is true) text
1408and optionally replace it by C<$newtext>.
1409
1410=item $term->selection_clear ([$clipboard])
1411
1412Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1398 1413
1399=item $term->overlay_simple ($x, $y, $text) 1414=item $term->overlay_simple ($x, $y, $text)
1400 1415
1401Create a simple multi-line overlay box. See the next method for details. 1416Create a simple multi-line overlay box. See the next method for details.
1402 1417
1856Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1871Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1857recent grab. 1872recent grab.
1858 1873
1859=item $term->ungrab 1874=item $term->ungrab
1860 1875
1861Calls XUngrab for the most recent grab. Is called automatically on 1876Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1862evaluation errors, as it is better to lose the grab in the error case as 1877evaluation errors, as it is better to lose the grab in the error case as
1863the session. 1878the session.
1864 1879
1865=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1880=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1866 1881
1888 1903
1889=item $term->XChangeInput ($window, $add_events[, $del_events]) 1904=item $term->XChangeInput ($window, $add_events[, $del_events])
1890 1905
1891Various X or X-related functions. The C<$term> object only serves as 1906Various X or X-related functions. The C<$term> object only serves as
1892the source of the display, otherwise those functions map more-or-less 1907the source of the display, otherwise those functions map more-or-less
1893directory onto the X functions of the same name. 1908directly onto the X functions of the same name.
1894 1909
1895=back 1910=back
1896 1911
1897=cut 1912=cut
1898 1913
2055 2070
2056=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2071=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2057 2072
2058Set the callback to be called when the timer triggers. 2073Set the callback to be called when the timer triggers.
2059 2074
2060=item $tstamp = $timer->at
2061
2062Return the time this watcher will fire next.
2063
2064=item $timer = $timer->set ($tstamp) 2075=item $timer = $timer->set ($tstamp[, $interval])
2065 2076
2066Set the time the event is generated to $tstamp. 2077Set the time the event is generated to $tstamp (and optionally specifies a
2078new $interval).
2067 2079
2068=item $timer = $timer->interval ($interval) 2080=item $timer = $timer->interval ($interval)
2069 2081
2070Normally (and when C<$interval> is C<0>), the timer will automatically 2082By default (and when C<$interval> is C<0>), the timer will automatically
2071stop after it has fired once. If C<$interval> is non-zero, then the timer 2083stop after it has fired once. If C<$interval> is non-zero, then the timer
2072is automatically rescheduled at the given intervals. 2084is automatically rescheduled at the given intervals.
2073 2085
2074=item $timer = $timer->start 2086=item $timer = $timer->start
2075 2087
2076Start the timer. 2088Start the timer.
2077 2089
2078=item $timer = $timer->start ($tstamp) 2090=item $timer = $timer->start ($tstamp[, $interval])
2079 2091
2080Set the event trigger time to C<$tstamp> and start the timer. 2092Set the event trigger time to C<$tstamp> and start the timer. Optionally
2093also replaces the interval.
2081 2094
2082=item $timer = $timer->after ($delay) 2095=item $timer = $timer->after ($delay[, $interval])
2083 2096
2084Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2097Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2085 2098
2086=item $timer = $timer->stop 2099=item $timer = $timer->stop
2087 2100

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines