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.171 by root, Fri Oct 10 00:11:44 2008 UTC vs.
Revision 1.179 by root, Sat Dec 26 09:23:53 2009 UTC

303extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
304 304
305If you want a quake-like animation, tell your window manager to do so 305If you want a quake-like animation, tell your window manager to do so
306(fvwm can do it). 306(fvwm can do it).
307 307
308=item overlay-osc
309
310This extension implements some OSC commands to display timed popups on the
311screen - useful for status displays from within scripts. You have to read
312the sources for more info.
313
308=item block-graphics-to-ascii 314=item block-graphics-to-ascii
309 315
310A not very useful example of filtering all text output to the terminal 316A not very useful example of filtering all text output to the terminal
311by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
312similar-looking ascii character. 318similar-looking ascii character.
366 372
367I<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
368the double C</> characters as comment start. Use C<\057\057> instead, 374the double C</> characters as comment start. Use C<\057\057> instead,
369which works regardless of wether xrdb is used to parse the resource file 375which works regardless of wether xrdb is used to parse the resource file
370or not. 376or not.
377
378=item macosx-pastebin and macosx-pastebin-native
379
380These two modules implement an extended clipboard for Mac OS X. They are
381used like this:
382
383 URxvt.perl-ext-common: default,macosx-clipboard
384 URxvt.keysym.M-c: perl:macosx-clipboard:copy
385 URxvt.keysym.M-v: perl:macosx-clipboard:paste
386
387The difference between them is that the native variant requires a
388perl from apple's devkit or so, and C<maxosx-pastebin> requires the
389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc.
371 391
372=item example-refresh-hooks 392=item example-refresh-hooks
373 393
374Displays a very simple digital clock in the upper right corner of the 394Displays a very simple digital clock in the upper right corner of the
375window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
1104is that you cannot use blocking APIs, but the non-blocking variant should 1124is that you cannot use blocking APIs, but the non-blocking variant should
1105work. 1125work.
1106 1126
1107=cut 1127=cut
1108 1128
1109our $VERSION = '3.4'; 1129our $VERSION = '5.23';
1110 1130
1111$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1131$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1132push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113 1133
1114sub timer { 1134sub timer {
1116 1136
1117 my $cb = $arg{cb}; 1137 my $cb = $arg{cb};
1118 1138
1119 urxvt::timer 1139 urxvt::timer
1120 ->new 1140 ->new
1121 ->start (urxvt::NOW + $arg{after}) 1141 ->after ($arg{after}, $arg{interval})
1122 ->cb (sub { 1142 ->cb ($arg{interval} ? $cb : sub {
1123 $_[0]->stop; # need to cancel manually 1143 $_[0]->stop; # need to cancel manually
1124 $cb->(); 1144 $cb->();
1125 }) 1145 })
1126} 1146}
1127 1147
1128sub io { 1148sub io {
1129 my ($class, %arg) = @_; 1149 my ($class, %arg) = @_;
1130 1150
1131 my $cb = $arg{cb}; 1151 my $cb = $arg{cb};
1152 my $fd = fileno $arg{fh};
1153 defined $fd or $fd = $arg{fh};
1132 1154
1133 bless [$arg{fh}, urxvt::iow 1155 bless [$arg{fh}, urxvt::iow
1134 ->new 1156 ->new
1135 ->fd (fileno $arg{fh}) 1157 ->fd ($fd)
1136 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1158 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1137 | ($arg{poll} =~ /w/ ? 2 : 0)) 1159 | ($arg{poll} =~ /w/ ? 2 : 0))
1138 ->start 1160 ->start
1139 ->cb (sub { 1161 ->cb ($cb)
1140 $cb->(($_[1] & 1 ? 'r' : '')
1141 . ($_[1] & 2 ? 'w' : ''));
1142 })],
1143 urxvt::anyevent:: 1162 ], urxvt::anyevent::
1163}
1164
1165sub idle {
1166 my ($class, %arg) = @_;
1167
1168 my $cb = $arg{cb};
1169
1170 urxvt::iw
1171 ->new
1172 ->start
1173 ->cb ($cb)
1174}
1175
1176sub child {
1177 my ($class, %arg) = @_;
1178
1179 my $cb = $arg{cb};
1180
1181 urxvt::pw
1182 ->new
1183 ->start ($arg{pid})
1184 ->cb (sub {
1185 $_[0]->stop; # need to cancel manually
1186 $cb->($_[0]->rpid, $_[0]->rstatus);
1187 })
1144} 1188}
1145 1189
1146sub DESTROY { 1190sub DESTROY {
1147 $_[0][1]->stop; 1191 $_[0][1]->stop;
1148} 1192}
1278 1322
1279 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1323 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1280 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1324 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1281 display_name embed ext_bwidth fade font geometry hold iconName 1325 display_name embed ext_bwidth fade font geometry hold iconName
1282 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1326 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1283 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1327 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1284 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1328 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1285 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1329 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1286 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1330 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1287 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1331 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1288 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1332 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1289 secondaryScreen secondaryScroll shade term_name title 1333 secondaryScreen secondaryScroll shade term_name title
1290 transient_for transparent transparent_all tripleclickwords utmpInhibit 1334 transient_for transparent transparent_all tripleclickwords utmpInhibit
1386 1430
1387The methods currently supported on C<urxvt::overlay> objects are: 1431The methods currently supported on C<urxvt::overlay> objects are:
1388 1432
1389=over 4 1433=over 4
1390 1434
1391=item $overlay->set ($x, $y, $text, $rend) 1435=item $overlay->set ($x, $y, $text[, $rend])
1392 1436
1393Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1437Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1394text in rxvt-unicode's special encoding and an array of rendition values 1438text in rxvt-unicode's special encoding and an array of rendition values
1395at a specific position inside the overlay. 1439at a specific position inside the overlay.
1440
1441If C<$rend> is missing, then the rendition will not be changed.
1396 1442
1397=item $overlay->hide 1443=item $overlay->hide
1398 1444
1399If visible, hide the overlay, but do not destroy it. 1445If visible, hide the overlay, but do not destroy it.
1400 1446
2007 2053
2008=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2054=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2009 2055
2010Set the callback to be called when the timer triggers. 2056Set the callback to be called when the timer triggers.
2011 2057
2012=item $tstamp = $timer->at
2013
2014Return the time this watcher will fire next.
2015
2016=item $timer = $timer->set ($tstamp) 2058=item $timer = $timer->set ($tstamp[, $interval])
2017 2059
2018Set the time the event is generated to $tstamp. 2060Set the time the event is generated to $tstamp (and optionally specifies a
2061new $interval).
2019 2062
2020=item $timer = $timer->interval ($interval) 2063=item $timer = $timer->interval ($interval)
2021 2064
2022Normally (and when C<$interval> is C<0>), the timer will automatically 2065By default (and when C<$interval> is C<0>), the timer will automatically
2023stop after it has fired once. If C<$interval> is non-zero, then the timer 2066stop after it has fired once. If C<$interval> is non-zero, then the timer
2024is automatically rescheduled at the given intervals. 2067is automatically rescheduled at the given intervals.
2025 2068
2026=item $timer = $timer->start 2069=item $timer = $timer->start
2027 2070
2028Start the timer. 2071Start the timer.
2029 2072
2030=item $timer = $timer->start ($tstamp) 2073=item $timer = $timer->start ($tstamp[, $interval])
2031 2074
2032Set the event trigger time to C<$tstamp> and start the timer. 2075Set the event trigger time to C<$tstamp> and start the timer. Optionally
2076also replaces the interval.
2033 2077
2034=item $timer = $timer->after ($delay) 2078=item $timer = $timer->after ($delay[, $interval])
2035 2079
2036Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2080Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2037 2081
2038=item $timer = $timer->stop 2082=item $timer = $timer->stop
2039 2083

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines