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.243 by sf-exg, Sat Oct 11 22:02:50 2014 UTC vs.
Revision 1.244 by sf-exg, Mon Oct 13 12:17:48 2014 UTC

… …
43 43
44Or by adding them to the resource for extensions loaded by default: 44Or by adding them to the resource for extensions loaded by default:
45 45
46 URxvt.perl-ext-common: default,selection-autotransform 46 URxvt.perl-ext-common: default,selection-autotransform
47 47
48Extensions may add resources on their own. Similarly to builtin 48Extensions may add additional resources and C<actions>, i.e., methods
49resources, these resources can also be specified on the command line 49which can be bound to a key and invoked by the user. An extension can
50as long options (with '.' replaced by '-'), in which case the 50define the resources it support and also default bindings for one or
51corresponding extension is loaded automatically. 51more actions it provides using so called META comments, described
52below. Similarly to builtin resources, extension resources can also be
53specified on the command line as long options (with C<.> replaced by
54C<->), in which case the corresponding extension is loaded
55automatically. For this to work the extension B<must> define META
56comments for its resources.
52 57
53=head1 API DOCUMENTATION 58=head1 API DOCUMENTATION
54 59
55=head2 General API Considerations 60=head2 General API Considerations
56 61
… …
108C<urxvt::term> class on this object. 113C<urxvt::term> class on this object.
109 114
110Additional methods only supported for extension objects are described in 115Additional methods only supported for extension objects are described in
111the C<urxvt::extension> section below. 116the C<urxvt::extension> section below.
112 117
118=head2 META comments
119
120rxvt-unicode recognizes special comments in extensions that define
121different types of metadata:
122
123=over 4
124
125=item #:META:RESOURCE:name:type:desc
126
127The RESOURCE comment defines a resource used by the extension, where
128C<name> is the resource name, C<type> is the resource type, C<boolean>
129or 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
139=back
140
113=head2 Hooks 141=head2 Hooks
114 142
115The following subroutines can be declared in extension files, and will be 143The following subroutines can be declared in extension files, and will be
116called whenever the relevant event happens. 144called whenever the relevant event happens.
117 145
… …
282code is run after this hook, and takes precedence. 310code is run after this hook, and takes precedence.
283 311
284=item on_refresh_end $term 312=item on_refresh_end $term
285 313
286Called just after the screen gets redrawn. See C<on_refresh_begin>. 314Called just after the screen gets redrawn. See C<on_refresh_begin>.
315
316=item on_action $term, $string
317
318Called whenever an action is invoked for the corresponding extension
319(e.g. via a C<extension:string> builtin action bound to a key, see
320description of the B<keysym> resource in the urxvt(1) manpage). The
321event is simply the action string. Note that an action event is always
322associated to a single extension.
287 323
288=item on_user_command $term, $string *DEPRECATED* 324=item on_user_command $term, $string *DEPRECATED*
289 325
290Called whenever a user-configured event is being activated (e.g. via 326Called whenever a user-configured event is being activated (e.g. via
291a C<perl:string> action bound to a key, see description of the B<keysym> 327a C<perl:string> action bound to a key, see description of the B<keysym>
… …
1282 1318
1283If the method is called on an extension object (basically, from an 1319If the method is called on an extension object (basically, from an
1284extension), then the special prefix C<%.> will be replaced by the name of 1320extension), then the special prefix C<%.> will be replaced by the name of
1285the extension and a dot, and the lone string C<%> will be replaced by the 1321the extension and a dot, and the lone string C<%> will be replaced by the
1286extension name itself. This makes it possible to code extensions so you 1322extension name itself. This makes it possible to code extensions so you
1287can rename them and get a new set of commandline switches and resources 1323can rename them and get a new set of resources without having to change
1288without having to change the actual code. 1324the actual code.
1289 1325
1290This method should only be called during the C<on_start> hook, as there is 1326This method should only be called during the C<on_start> hook, as there is
1291only one resource database per display, and later invocations might return 1327only one resource database per display, and later invocations might return
1292the wrong resources. 1328the wrong resources.
1293 1329

Diff Legend

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