--- rxvt-unicode/src/perl/selection-popup 2012/06/06 15:06:41 1.25
+++ rxvt-unicode/src/perl/selection-popup 2012/09/04 22:41:12 1.28
@@ -2,6 +2,37 @@
#:META:X_RESOURCE:url-launcher:string:shell command to use
+=head1 NAME
+
+selection-popup (enabled by default)
+
+=head1 DESCRIPTION
+
+Binds a popup menu to Ctrl-Button3 that lets you convert the selection
+text into various other formats/action (such as uri unescaping, perl
+evaluation, web-browser starting etc.), depending on content.
+
+Other extensions can extend this popup menu by pushing a code reference
+onto C<< @{ $term->{selection_popup_hook} } >>, which gets called whenever
+the popup is being displayed.
+
+Its sole argument is the popup menu, which can be modified. The selection
+is in C<$_>, which can be used to decide whether to add something or not.
+It should either return nothing or a string and a code reference. The
+string will be used as button text and the code reference will be called
+when the button gets activated and should transform C<$_>.
+
+The following will add an entry C that transforms all Cs in
+the selection to Cs, but only if the selection currently contains any
+Cs:
+
+ push @{ $self->{term}{selection_popup_hook} }, sub {
+ /a/ ? ("a to b" => sub { s/a/b/g }
+ : ()
+ };
+
+=cut
+
sub msg {
my ($self, $msg) = @_;