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.157 by ayin, Wed Oct 31 09:55:24 2007 UTC vs.
Revision 1.181 by sf-exg, Wed Jan 6 17:52:43 2010 UTC

40 40
41 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
42 42
43Or by adding them to the resource for extensions loaded by default: 43Or by adding them to the resource for extensions loaded by default:
44 44
45 URxvt.perl-ext-common: default,automove-background,selection-autotransform 45 URxvt.perl-ext-common: default,selection-autotransform
46 46
47=over 4 47=over 4
48 48
49=item selection (enabled by default) 49=item selection (enabled by default)
50 50
101 101
102Other extensions can extend this popup menu by pushing a code reference 102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the 103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed. 104popup is being displayed.
105 105
106It's sole argument is the popup menu, which can be modified. It should 106Its sole argument is the popup menu, which can be modified. It should
107either return nothing or a string, the initial boolean value and a code 107either return nothing or a string, the initial boolean value and a code
108reference. The string will be used as button text and the code reference 108reference. The string will be used as button text and the code reference
109will be called when the toggle changes, with the new boolean value as 109will be called when the toggle changes, with the new boolean value as
110first argument. 110first argument.
111 111
112The following will add an entry C<myoption> that changes 112The following will add an entry C<myoption> that changes
113C<$self->{myoption}>: 113C<< $self->{myoption} >>:
114 114
115 push @{ $self->{term}{option_popup_hook} }, sub { 115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) 116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 }; 117 };
118 118
124 124
125Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed. 127popup is being displayed.
128 128
129It's sole argument is the popup menu, which can be modified. The selection 129Its sole argument is the popup menu, which can be modified. The selection
130is in C<$_>, which can be used to decide whether to add something or not. 130is in C<$_>, which can be used to decide whether to add something or not.
131It should either return nothing or a string and a code reference. The 131It should either return nothing or a string and a code reference. The
132string will be used as button text and the code reference will be called 132string will be used as button text and the code reference will be called
133when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
134 134
135The following will add an entry C<a to b> that transforms all C<a>s in 135The following will add an entry C<a to b> that transforms all C<a>s in
136the selection to C<b>s, but only if the selection currently contains any 136the selection to C<b>s, but only if the selection currently contains any
137C<a>s: 137C<a>s:
138 138
139 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
140 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
141 : () 141 : ()
142 }; 142 };
143 143
144=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
145 145
165=item readline (enabled by default) 165=item readline (enabled by default)
166 166
167A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
168the moment, it reacts to clicking shift-left mouse button by trying to 168the moment, it reacts to clicking shift-left mouse button by trying to
169move the text cursor to this position. It does so by generating as many 169move the text cursor to this position. It does so by generating as many
170cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
171for programs that correctly support wide characters). 171for programs that correctly support wide characters).
172 172
173To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
174 174
175=over 4 175=over 4
276 276
277=item xim-onthespot 277=item xim-onthespot
278 278
279This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
280not work perfectly, and some input methods don't seem to work well with 280not work perfectly, and some input methods don't seem to work well with
281OnTheSpot editing in general, but it seems to work at leats for SCIM and 281OnTheSpot editing in general, but it seems to work at least for SCIM and
282kinput2. 282kinput2.
283 283
284You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
285C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
286 286
294will show or hide itself. Another press of the accelerator key will hide 294will show or hide itself. Another press of the accelerator key will hide
295or show it again. 295or show it again.
296 296
297Initially, the window will not be shown when using this extension. 297Initially, the window will not be shown when using this extension.
298 298
299This is useful if you need a single terminal thats not using any desktop 299This is useful if you need a single terminal that is not using any desktop
300space most of the time but is quickly available at the press of a key. 300space most of the time but is quickly available at the press of a key.
301 301
302The accelerator key is grabbed regardless of any modifiers, so this 302The accelerator key is grabbed regardless of any modifiers, so this
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 automove-background 308=item overlay-osc
309 309
310This is basically a very small extension that dynamically changes the 310This extension implements some OSC commands to display timed popups on the
311background pixmap offset to the window position, in effect creating the 311screen - useful for status displays from within scripts. You have to read
312same effect as pseudo transparency with a custom pixmap. No scaling is 312the sources for more info.
313supported in this mode. Example:
314
315 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
316
317L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
318shows how this extension can be used to implement an automatically blurred
319transparent background.
320 313
321=item block-graphics-to-ascii 314=item block-graphics-to-ascii
322 315
323A 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
324by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
329Displays a digital clock using the built-in overlay. 322Displays a digital clock using the built-in overlay.
330 323
331=item remote-clipboard 324=item remote-clipboard
332 325
333Somewhat of a misnomer, this extension adds two menu entries to the 326Somewhat of a misnomer, this extension adds two menu entries to the
334selection popup that allows one ti run external commands to store the 327selection popup that allows one to run external commands to store the
335selection somewhere and fetch it again. 328selection somewhere and fetch it again.
336 329
337We use it to implement a "distributed selection mechanism", which just 330We use it to implement a "distributed selection mechanism", which just
338means that one command uploads the file to a remote server, and another 331means that one command uploads the file to a remote server, and another
339reads it. 332reads it.
379 372
380I<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
381the double C</> characters as comment start. Use C<\057\057> instead, 374the double C</> characters as comment start. Use C<\057\057> instead,
382which 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
383or 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.
384 391
385=item example-refresh-hooks 392=item example-refresh-hooks
386 393
387Displays 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
388window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
554 561
555It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 562It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
556$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 563$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
557number of lines that will be in the scrollback buffer. 564number of lines that will be in the scrollback buffer.
558 565
559=item on_osc_seq $term, $op, $args 566=item on_osc_seq $term, $op, $args, $resp
560 567
561Called on every OSC sequence and can be used to suppress it or modify its 568Called on every OSC sequence and can be used to suppress it or modify its
562behaviour. The default should be to return an empty list. A true value 569behaviour. The default should be to return an empty list. A true value
563suppresses execution of the request completely. Make sure you don't get 570suppresses execution of the request completely. Make sure you don't get
564confused by recursive invocations when you output an osc sequence within 571confused by recursive invocations when you output an OSC sequence within
565this callback. 572this callback.
566 573
567C<on_osc_seq_perl> should be used for new behaviour. 574C<on_osc_seq_perl> should be used for new behaviour.
568 575
569=item on_osc_seq_perl $term, $string 576=item on_osc_seq_perl $term, $args, $resp
570 577
571Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 578Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
572operating system command) is processed. Cursor position and other state 579operating system command) is processed. Cursor position and other state
573information is up-to-date when this happens. For interoperability, the 580information is up-to-date when this happens. For interoperability, the
574string should start with the extension name and a colon, to distinguish 581string should start with the extension name (sans -osc) and a semicolon,
575it from commands for other extensions, and this might be enforced in the 582to distinguish it from commands for other extensions, and this might be
576future. 583enforced in the future.
584
585For example, C<overlay-osc> uses this:
586
587 sub on_osc_seq_perl {
588 my ($self, $osc, $resp) = @_;
589
590 return unless $osc =~ s/^overlay;//;
591
592 ... process remaining $osc string
593 }
577 594
578Be careful not ever to trust (in a security sense) the data you receive, 595Be careful not ever to trust (in a security sense) the data you receive,
579as its source can not easily be controlled (e-mail content, messages from 596as its source can not easily be controlled (e-mail content, messages from
580other users on the same system etc.). 597other users on the same system etc.).
598
599For responses, C<$resp> contains the end-of-args separator used by the
600sender.
581 601
582=item on_add_lines $term, $string 602=item on_add_lines $term, $string
583 603
584Called whenever text is about to be output, with the text as argument. You 604Called whenever text is about to be output, with the text as argument. You
585can filter/change and output the text yourself by returning a true value 605can filter/change and output the text yourself by returning a true value
606later with the already-modified line (e.g. if unrelated parts change), so 626later with the already-modified line (e.g. if unrelated parts change), so
607you cannot just toggle rendition bits, but only set them. 627you cannot just toggle rendition bits, but only set them.
608 628
609=item on_refresh_begin $term 629=item on_refresh_begin $term
610 630
611Called just before the screen gets redrawn. Can be used for overlay 631Called just before the screen gets redrawn. Can be used for overlay or
612or similar effects by modify terminal contents in refresh_begin, and 632similar effects by modifying the terminal contents in refresh_begin, and
613restoring them in refresh_end. The built-in overlay and selection display 633restoring them in refresh_end. The built-in overlay and selection display
614code is run after this hook, and takes precedence. 634code is run after this hook, and takes precedence.
615 635
616=item on_refresh_end $term 636=item on_refresh_end $term
617 637
688 708
689=item on_wm_delete_window $term, $event 709=item on_wm_delete_window $term, $event
690 710
691Called when various types of ClientMessage events are received (all with 711Called when various types of ClientMessage events are received (all with
692format=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.
693 717
694=back 718=back
695 719
696=cut 720=cut
697 721
1104is that you cannot use blocking APIs, but the non-blocking variant should 1128is that you cannot use blocking APIs, but the non-blocking variant should
1105work. 1129work.
1106 1130
1107=cut 1131=cut
1108 1132
1109our $VERSION = 1; 1133our $VERSION = '5.23';
1110 1134
1111$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1135$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1136push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113 1137
1114sub timer { 1138sub timer {
1116 1140
1117 my $cb = $arg{cb}; 1141 my $cb = $arg{cb};
1118 1142
1119 urxvt::timer 1143 urxvt::timer
1120 ->new 1144 ->new
1121 ->start (urxvt::NOW + $arg{after}) 1145 ->after ($arg{after}, $arg{interval})
1122 ->cb (sub { 1146 ->cb ($arg{interval} ? $cb : sub {
1123 $_[0]->stop; # need to cancel manually 1147 $_[0]->stop; # need to cancel manually
1124 $cb->(); 1148 $cb->();
1125 }) 1149 })
1126} 1150}
1127 1151
1128sub io { 1152sub io {
1129 my ($class, %arg) = @_; 1153 my ($class, %arg) = @_;
1130 1154
1131 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
1156 my $fd = fileno $arg{fh};
1157 defined $fd or $fd = $arg{fh};
1132 1158
1133 bless [$arg{fh}, urxvt::iow 1159 bless [$arg{fh}, urxvt::iow
1134 ->new 1160 ->new
1135 ->fd (fileno $arg{fh}) 1161 ->fd ($fd)
1136 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1162 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1137 | ($arg{poll} =~ /w/ ? 2 : 0)) 1163 | ($arg{poll} =~ /w/ ? 2 : 0))
1138 ->start 1164 ->start
1139 ->cb (sub { 1165 ->cb ($cb)
1140 $cb->(($_[1] & 1 ? 'r' : '')
1141 . ($_[1] & 2 ? 'w' : ''));
1142 })],
1143 urxvt::anyevent:: 1166 ], urxvt::anyevent::
1167}
1168
1169sub idle {
1170 my ($class, %arg) = @_;
1171
1172 my $cb = $arg{cb};
1173
1174 urxvt::iw
1175 ->new
1176 ->start
1177 ->cb ($cb)
1178}
1179
1180sub child {
1181 my ($class, %arg) = @_;
1182
1183 my $cb = $arg{cb};
1184
1185 urxvt::pw
1186 ->new
1187 ->start ($arg{pid})
1188 ->cb (sub {
1189 $_[0]->stop; # need to cancel manually
1190 $cb->($_[0]->rpid, $_[0]->rstatus);
1191 })
1144} 1192}
1145 1193
1146sub DESTROY { 1194sub DESTROY {
1147 $_[0][1]->stop; 1195 $_[0][1]->stop;
1148}
1149
1150sub condvar {
1151 bless \my $flag, urxvt::anyevent::
1152}
1153
1154sub broadcast {
1155 ${$_[0]}++;
1156}
1157
1158sub wait {
1159 unless (${$_[0]}) {
1160 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1161 }
1162} 1196}
1163 1197
1164sub one_event { 1198sub one_event {
1165 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1199 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1166} 1200}
1289Here is a likely non-exhaustive list of resource names, not all of which 1323Here is a likely non-exhaustive list of resource names, not all of which
1290are supported in every build, please see the source file F</src/rsinc.h> 1324are supported in every build, please see the source file F</src/rsinc.h>
1291to see the actual list: 1325to see the actual list:
1292 1326
1293 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1327 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1294 borderLess color cursorBlink cursorUnderline cutchars delete_key 1328 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1295 display_name embed ext_bwidth fade font geometry hold iconName 1329 display_name embed ext_bwidth fade font geometry hold iconName
1296 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1330 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1297 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1331 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1298 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1332 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1299 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1333 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1300 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1334 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1301 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1335 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1302 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1336 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1303 secondaryScreen secondaryScroll selectstyle shade term_name title 1337 secondaryScreen secondaryScroll shade term_name title
1304 transient_for transparent transparent_all tripleclickwords utmpInhibit 1338 transient_for transparent transparent_all tripleclickwords utmpInhibit
1305 visualBell 1339 visualBell
1306 1340
1307=cut 1341=cut
1308 1342
1309sub resource($$;$) { 1343sub resource($$;$) {
1310 my ($self, $name) = (shift, shift); 1344 my ($self, $name) = (shift, shift);
1311 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1345 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1312 &urxvt::term::_resource 1346 goto &urxvt::term::_resource
1313} 1347}
1314 1348
1315=item $value = $term->x_resource ($pattern) 1349=item $value = $term->x_resource ($pattern)
1316 1350
1317Returns the X-Resource for the given pattern, excluding the program or 1351Returns the X-Resource for the given pattern, excluding the program or
1342 1376
1343=item ($row, $col) = $term->selection_beg ([$row, $col]) 1377=item ($row, $col) = $term->selection_beg ([$row, $col])
1344 1378
1345=item ($row, $col) = $term->selection_end ([$row, $col]) 1379=item ($row, $col) = $term->selection_end ([$row, $col])
1346 1380
1347Return the current values of the selection mark, begin or end positions, 1381Return the current values of the selection mark, begin or end positions.
1348and 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.
1349 1390
1350=item $term->selection_make ($eventtime[, $rectangular]) 1391=item $term->selection_make ($eventtime[, $rectangular])
1351 1392
1352Tries to make a selection as set by C<selection_beg> and 1393Tries to make a selection as set by C<selection_beg> and
1353C<selection_end>. If C<$rectangular> is true (default: false), a 1394C<selection_end>. If C<$rectangular> is true (default: false), a
1400 1441
1401The methods currently supported on C<urxvt::overlay> objects are: 1442The methods currently supported on C<urxvt::overlay> objects are:
1402 1443
1403=over 4 1444=over 4
1404 1445
1405=item $overlay->set ($x, $y, $text, $rend) 1446=item $overlay->set ($x, $y, $text[, $rend])
1406 1447
1407Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1448Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1408text in rxvt-unicode's special encoding and an array of rendition values 1449text in rxvt-unicode's special encoding and an array of rendition values
1409at a specific position inside the overlay. 1450at a specific position inside the overlay.
1451
1452If C<$rend> is missing, then the rendition will not be changed.
1410 1453
1411=item $overlay->hide 1454=item $overlay->hide
1412 1455
1413If visible, hide the overlay, but do not destroy it. 1456If visible, hide the overlay, but do not destroy it.
1414 1457
1624 1667
1625Used after changing terminal contents to display them. 1668Used after changing terminal contents to display them.
1626 1669
1627=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1670=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1628 1671
1629Returns the text of the entire row with number C<$row_number>. Row C<0> 1672Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1630is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1673is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1631terminal line. The scrollback buffer starts at line C<-1> and extends to
1632line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1674terminal line. Nothing will be returned if a nonexistent line
1633is requested. 1675is requested.
1634 1676
1635If C<$new_text> is specified, it will replace characters in the current 1677If C<$new_text> is specified, it will replace characters in the current
1636line, starting at column C<$start_col> (default C<0>), which is useful 1678line, starting at column C<$start_col> (default C<0>), which is useful
1637to replace only parts of a line. The font index in the rendition will 1679to replace only parts of a line. The font index in the rendition will
1638automatically be updated. 1680automatically be updated.
1639 1681
1640C<$text> is in a special encoding: tabs and wide characters that use more 1682C<$text> is in a special encoding: tabs and wide characters that use more
1641than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1683than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1642characters. Characters with combining characters and other characters that 1684characters. Characters with combining characters and other characters that
1643do not fit into the normal tetx encoding will be replaced with characters 1685do not fit into the normal text encoding will be replaced with characters
1644in the private use area. 1686in the private use area.
1645 1687
1646You have to obey this encoding when changing text. The advantage is 1688You have to obey this encoding when changing text. The advantage is
1647that C<substr> and similar functions work on screen cells and not on 1689that C<substr> and similar functions work on screen cells and not on
1648characters. 1690characters.
1835 1877
1836=item @atoms = $term->XListProperties ($window) 1878=item @atoms = $term->XListProperties ($window)
1837 1879
1838=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1880=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1839 1881
1840=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1882=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1841 1883
1842=item $term->XDeleteProperty ($window, $property) 1884=item $term->XDeleteProperty ($window, $property)
1843 1885
1844=item $window = $term->DefaultRootWindow 1886=item $window = $term->DefaultRootWindow
1845 1887
1967 my $env = $self->{term}->env; 2009 my $env = $self->{term}->env;
1968 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2010 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1969 delete $env->{LC_ALL}; 2011 delete $env->{LC_ALL};
1970 $env->{LC_CTYPE} = $self->{term}->locale; 2012 $env->{LC_CTYPE} = $self->{term}->locale;
1971 2013
1972 urxvt::term->new ($env, "popup", 2014 my $term = urxvt::term->new (
2015 $env, "popup",
1973 "--perl-lib" => "", "--perl-ext-common" => "", 2016 "--perl-lib" => "", "--perl-ext-common" => "",
1974 "-pty-fd" => -1, "-sl" => 0, 2017 "-pty-fd" => -1, "-sl" => 0,
1975 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2018 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1976 "--transient-for" => $self->{term}->parent, 2019 "--transient-for" => $self->{term}->parent,
1977 "-display" => $self->{term}->display_id, 2020 "-display" => $self->{term}->display_id,
1978 "-pe" => "urxvt-popup") 2021 "-pe" => "urxvt-popup",
1979 or die "unable to create popup window\n"; 2022 ) or die "unable to create popup window\n";
2023
2024 unless (delete $term->{urxvt_popup_init_done}) {
2025 $term->ungrab;
2026 $term->destroy;
2027 die "unable to initialise popup window\n";
2028 }
1980} 2029}
1981 2030
1982sub DESTROY { 2031sub DESTROY {
1983 my ($self) = @_; 2032 my ($self) = @_;
1984 2033
2015 2064
2016=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2065=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017 2066
2018Set the callback to be called when the timer triggers. 2067Set the callback to be called when the timer triggers.
2019 2068
2020=item $tstamp = $timer->at
2021
2022Return the time this watcher will fire next.
2023
2024=item $timer = $timer->set ($tstamp) 2069=item $timer = $timer->set ($tstamp[, $interval])
2025 2070
2026Set the time the event is generated to $tstamp. 2071Set the time the event is generated to $tstamp (and optionally specifies a
2072new $interval).
2027 2073
2028=item $timer = $timer->interval ($interval) 2074=item $timer = $timer->interval ($interval)
2029 2075
2030Normally (and when C<$interval> is C<0>), the timer will automatically 2076By default (and when C<$interval> is C<0>), the timer will automatically
2031stop after it has fired once. If C<$interval> is non-zero, then the timer 2077stop after it has fired once. If C<$interval> is non-zero, then the timer
2032is automatically rescheduled at the given intervals. 2078is automatically rescheduled at the given intervals.
2033 2079
2034=item $timer = $timer->start 2080=item $timer = $timer->start
2035 2081
2036Start the timer. 2082Start the timer.
2037 2083
2038=item $timer = $timer->start ($tstamp) 2084=item $timer = $timer->start ($tstamp[, $interval])
2039 2085
2040Set the event trigger time to C<$tstamp> and start the timer. 2086Set the event trigger time to C<$tstamp> and start the timer. Optionally
2087also replaces the interval.
2041 2088
2042=item $timer = $timer->after ($delay) 2089=item $timer = $timer->after ($delay[, $interval])
2043 2090
2044Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2091Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045 2092
2046=item $timer = $timer->stop 2093=item $timer = $timer->stop
2047 2094
2055 2102
2056 $term->{socket} = ... 2103 $term->{socket} = ...
2057 $term->{iow} = urxvt::iow 2104 $term->{iow} = urxvt::iow
2058 ->new 2105 ->new
2059 ->fd (fileno $term->{socket}) 2106 ->fd (fileno $term->{socket})
2060 ->events (urxvt::EVENT_READ) 2107 ->events (urxvt::EV_READ)
2061 ->start 2108 ->start
2062 ->cb (sub { 2109 ->cb (sub {
2063 my ($iow, $revents) = @_; 2110 my ($iow, $revents) = @_;
2064 # $revents must be 1 here, no need to check 2111 # $revents must be 1 here, no need to check
2065 sysread $term->{socket}, my $buf, 8192 2112 sysread $term->{socket}, my $buf, 8192
2083Set the file descriptor (not handle) to watch. 2130Set the file descriptor (not handle) to watch.
2084 2131
2085=item $iow = $iow->events ($eventmask) 2132=item $iow = $iow->events ($eventmask)
2086 2133
2087Set the event mask to watch. The only allowed values are 2134Set the event mask to watch. The only allowed values are
2088C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2135C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2089together, or C<urxvt::EVENT_NONE>. 2136together, or C<urxvt::EV_NONE>.
2090 2137
2091=item $iow = $iow->start 2138=item $iow = $iow->start
2092 2139
2093Start watching for requested events on the given handle. 2140Start watching for requested events on the given handle.
2094 2141

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines