ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.man.in
(Generate patch)

Comparing rxvt-unicode/doc/rxvtperl.3.man.in (file contents):
Revision 1.43 by root, Mon Feb 6 05:55:33 2006 UTC vs.
Revision 1.44 by root, Mon Feb 6 06:14:55 2006 UTC

234.RE 234.RE
235.IP "option-popup (enabled by default)" 4 235.IP "option-popup (enabled by default)" 4
236.IX Item "option-popup (enabled by default)" 236.IX Item "option-popup (enabled by default)"
237Binds a popup menu to Ctrl\-Button2 that lets you toggle (some) options at 237Binds a popup menu to Ctrl\-Button2 that lets you toggle (some) options at
238runtime. 238runtime.
239.Sp
240Other extensions can extend this popup menu by pushing a code reference
241onto \f(CW\*(C`@{ $term\-\*(C'\fR{option_popup_hook} }>, which gets called whenever the
242popup is being displayed.
243.Sp
244It's sole argument is the popup menu, which can be modified. It should
245either return nothing or a string, the initial boolean value and a code
246reference. The string will be used as button text and the code reference
247will be called when the toggle changes, with the new boolean value as
248first argument.
249.Sp
250The following will add an entry \f(CW\*(C`myoption\*(C'\fR that changes
251\&\f(CW\*(C`$self\-\*(C'\fR{myoption}>:
252.Sp
253.Vb 3
254\& push @{ $self->{term}{option_popup_hook} }, sub {
255\& ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
256\& };
257.Ve
239.IP "selection-popup (enabled by default)" 4 258.IP "selection-popup (enabled by default)" 4
240.IX Item "selection-popup (enabled by default)" 259.IX Item "selection-popup (enabled by default)"
241Binds a popup menu to Ctrl\-Button3 that lets you convert the selection 260Binds a popup menu to Ctrl\-Button3 that lets you convert the selection
242text into various other formats/action (such as uri unescaping, perl 261text into various other formats/action (such as uri unescaping, perl
243evaluation, web-browser starting etc.), depending on content. 262evaluation, web-browser starting etc.), depending on content.
244.Sp 263.Sp
245Other extensions can extend this popup menu by pushing a code reference 264Other extensions can extend this popup menu by pushing a code reference
246onto \f(CW\*(C`@{ $term\-\*(C'\fR{selection_popup_hook} }>, that is called whenever the 265onto \f(CW\*(C`@{ $term\-\*(C'\fR{selection_popup_hook} }>, which gets called whenever the
247popup is displayed. 266popup is being displayed.
248.Sp 267.Sp
249It's sole argument is the popup menu, which can be modified. The selection 268It's sole argument is the popup menu, which can be modified. The selection
250is in \f(CW$_\fR, which can be used to decide wether to add something or not. 269is in \f(CW$_\fR, which can be used to decide wether to add something or not.
251It should either return nothing or a string and a code reference. The 270It should either return nothing or a string and a code reference. The
252string will be used as button text and the code reference will be called 271string will be used as button text and the code reference will be called
1423.ie n .IP "$popup\->add_button ($text, $cb)" 4 1442.ie n .IP "$popup\->add_button ($text, $cb)" 4
1424.el .IP "$popup\->add_button ($text, \f(CW$cb\fR)" 4 1443.el .IP "$popup\->add_button ($text, \f(CW$cb\fR)" 4
1425.IX Item "$popup->add_button ($text, $cb)" 1444.IX Item "$popup->add_button ($text, $cb)"
1426Adds a clickable button to the popup. \f(CW$cb\fR is called whenever it is 1445Adds a clickable button to the popup. \f(CW$cb\fR is called whenever it is
1427selected. 1446selected.
1428.ie n .IP "$popup\->add_toggle ($text, $cb\fR, \f(CW$initial_value)" 4 1447.ie n .IP "$popup\->add_toggle ($text, $initial_value\fR, \f(CW$cb)" 4
1429.el .IP "$popup\->add_toggle ($text, \f(CW$cb\fR, \f(CW$initial_value\fR)" 4 1448.el .IP "$popup\->add_toggle ($text, \f(CW$initial_value\fR, \f(CW$cb\fR)" 4
1430.IX Item "$popup->add_toggle ($text, $cb, $initial_value)" 1449.IX Item "$popup->add_toggle ($text, $initial_value, $cb)"
1431Adds a toggle/checkbox item to the popup. Teh callback gets called 1450Adds a toggle/checkbox item to the popup. The callback gets called
1432whenever it gets toggled, with a boolean indicating its value as its first 1451whenever it gets toggled, with a boolean indicating its new value as its
1433argument. 1452first argument.
1434.IP "$popup\->show" 4 1453.IP "$popup\->show" 4
1435.IX Item "$popup->show" 1454.IX Item "$popup->show"
1436Displays the popup (which is initially hidden). 1455Displays the popup (which is initially hidden).
1437.ie n .Sh "The ""urxvt::timer"" Class" 1456.ie n .Sh "The ""urxvt::timer"" Class"
1438.el .Sh "The \f(CWurxvt::timer\fP Class" 1457.el .Sh "The \f(CWurxvt::timer\fP Class"

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines