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.246 by root, Fri Dec 26 18:58:19 2014 UTC vs.
Revision 1.247 by root, Fri Dec 26 19:19:30 2014 UTC

… …
115Additional methods only supported for extension objects are described in 115Additional methods only supported for extension objects are described in
116the C<urxvt::extension> section below. 116the C<urxvt::extension> section below.
117 117
118=head2 META comments 118=head2 META comments
119 119
120rxvt-unicode recognizes special comments in extensions that define 120Rxvt-unicode recognizes special meta comments in extensions that define
121different types of metadata: 121different types of metadata.
122
123Currently, it recxognises only one such comment:
122 124
123=over 4 125=over 4
124 126
125=item #:META:RESOURCE:name:type:desc 127=item #:META:RESOURCE:name:type:desc
126 128
127The RESOURCE comment defines a resource used by the extension, where 129The RESOURCE comment defines a resource used by the extension, where
128C<name> is the resource name, C<type> is the resource type, C<boolean> 130C<name> is the resource name, C<type> is the resource type, C<boolean>
129or C<string>, and C<desc> is the resource description. 131or C<string>, and C<desc> is the resource description.
130
131=item #:META:BINDING:sym:action
132
133The BINDING comment defines a default binding for an action provided
134by the extension, where C<sym> is the key combination that triggers
135the action, whose format is defined in the description of the
136B<keysym> resource in the urxvt(1) manpage, and C<action> is the name
137of the action method.
138 132
139=back 133=back
140 134
141=head2 Hooks 135=head2 Hooks
142 136
… …
981 } 975 }
982 976
983 bless \%disable, "urxvt::extension::on_disable" 977 bless \%disable, "urxvt::extension::on_disable"
984} 978}
985 979
980=item $self->bind_action ($hotkey, $action)
981
986=item $self->x_resource ($pattern) 982=item $self->x_resource ($pattern)
987 983
988=item $self->x_resource_boolean ($pattern) 984=item $self->x_resource_boolean ($pattern)
989 985
990These methods support an additional C<%> prefix when called on an 986These methods support an additional C<%> prefix for C<$action> or
991extension object - see the description of these methods in the 987C<$pattern> when called on an extension object, compared to the
988C<urxvt::term> methods of the same name - see the description of these
992C<urxvt::term> class for details. 989methods in the C<urxvt::term> class for details.
993 990
994=cut 991=cut
992
993sub bind_action {
994 my ($self, $hotkey, $action) = @_;
995 $action =~ s/^%:/$_[0]{_name}:/;
996 $self->{term}->bind_action ($hotkey, $action)
997}
995 998
996sub x_resource { 999sub x_resource {
997 my ($self, $name) = @_; 1000 my ($self, $name) = @_;
998 $name =~ s/^%(\.|$)/$_[0]{_name}$1/; 1001 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
999 $self->{term}->x_resource ($name) 1002 $self->{term}->x_resource ($name)
… …
1341 my $res = &x_resource; 1344 my $res = &x_resource;
1342 1345
1343 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 1346 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1344} 1347}
1345 1348
1346=item $success = $term->bind_action ($key, $octets) 1349=item $success = $term->bind_action ($key, $action)
1347 1350
1348Adds a key binding exactly as specified via a C<keysym> resource. See the 1351Adds a key binding exactly as specified via a C<keysym> resource. See the
1349C<keysym> resource in the urxvt(1) manpage. 1352C<keysym> resource in the urxvt(1) manpage.
1353
1354To add default bindings for an extension, the extension should call C<<
1355->bind_action >> on it's C<init> hook for every such binding. Doing it
1356in the C<init> hook allows users the override or remove the the binding
1357again.
1358
1359Example: the C<searchable-scrollback> by default binds itself
1360on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1361$term->bind_action >>.
1362
1363 sub init {
1364 my ($self) = @_;
1365
1366 $self->bind_action ("M-s" => "%:start");
1367 }
1350 1368
1351=item $rend = $term->rstyle ([$new_rstyle]) 1369=item $rend = $term->rstyle ([$new_rstyle])
1352 1370
1353Return and optionally change the current rendition. Text that is output by 1371Return and optionally change the current rendition. Text that is output by
1354the terminal application will use this style. 1372the terminal application will use this style.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines