… | |
… | |
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
|
|
33 | <li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li> |
|
|
34 | <li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li> |
33 | </ul> |
35 | </ul> |
34 | |
36 | |
35 | <li><a href="#environment">ENVIRONMENT</a></li> |
37 | <li><a href="#environment">ENVIRONMENT</a></li> |
36 | <ul> |
38 | <ul> |
37 | |
39 | |
… | |
… | |
80 | <p>This section describes the extensions delivered with this release. You can |
82 | <p>This section describes the extensions delivered with this release. You can |
81 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
83 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
82 | <p>You can activate them like this:</p> |
84 | <p>You can activate them like this:</p> |
83 | <pre> |
85 | <pre> |
84 | rxvt -pe <extensionname></pre> |
86 | rxvt -pe <extensionname></pre> |
|
|
87 | <p>Or by adding them to the resource for extensions loaded by default:</p> |
|
|
88 | <pre> |
|
|
89 | URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre> |
85 | <dl> |
90 | <dl> |
86 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
91 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
87 | </dt> |
92 | </dt> |
88 | <dd> |
93 | <dd> |
89 | (More) intelligent selection. This extension tries to be more intelligent |
94 | (More) intelligent selection. This extension tries to be more intelligent |
… | |
… | |
145 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
150 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
146 | </dt> |
151 | </dt> |
147 | <dd> |
152 | <dd> |
148 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
153 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
149 | text into various other formats/action (such as uri unescaping, perl |
154 | text into various other formats/action (such as uri unescaping, perl |
150 | evalution, web-browser starting etc.), depending on content. |
155 | evaluation, web-browser starting etc.), depending on content. |
151 | </dd> |
156 | </dd> |
152 | <dd> |
157 | <dd> |
153 | <p>Other extensions can extend this popup menu by pushing a code reference |
158 | <p>Other extensions can extend this popup menu by pushing a code reference |
154 | onto <code>@{ $term-</code>{selection_popup_hook} }>, that is called whenever the |
159 | onto <code>@{ $term-</code>{selection_popup_hook} }>, that is called whenever the |
155 | popup is displayed.</p> |
160 | popup is displayed.</p> |
… | |
… | |
190 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
195 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
191 | additionally stores the first match in the current line into the primary |
196 | additionally stores the first match in the current line into the primary |
192 | selection.</p> |
197 | selection.</p> |
193 | </dd> |
198 | </dd> |
194 | <p></p> |
199 | <p></p> |
|
|
200 | <dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br /> |
|
|
201 | </dt> |
|
|
202 | <dd> |
|
|
203 | A support package that tries to make editing with readline easier. At the |
|
|
204 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
205 | move the text cursor to this position. It does so by generating as many |
|
|
206 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
207 | for programs that correctly support wide characters). |
|
|
208 | </dd> |
|
|
209 | <dd> |
|
|
210 | <p>To avoid too many false positives, this is only done when:</p> |
|
|
211 | </dd> |
|
|
212 | <dl> |
|
|
213 | <dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br /> |
|
|
214 | </dt> |
|
|
215 | <dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br /> |
|
|
216 | </dt> |
|
|
217 | <dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br /> |
|
|
218 | </dt> |
|
|
219 | </dl> |
|
|
220 | <p>The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
221 | might interfere with selection creation in harmless ways.</p> |
195 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
222 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
196 | </dt> |
223 | </dt> |
197 | <dd> |
224 | <dd> |
198 | This selection allows you to do automatic transforms on a selection |
225 | This selection allows you to do automatic transforms on a selection |
199 | whenever a selection is made. |
226 | whenever a selection is made. |
… | |
… | |
239 | </dd> |
266 | </dd> |
240 | <dd> |
267 | <dd> |
241 | <p>The first line tells the selection code to treat the unchanging part of |
268 | <p>The first line tells the selection code to treat the unchanging part of |
242 | every error message as a selection pattern, and the second line transforms |
269 | every error message as a selection pattern, and the second line transforms |
243 | the message into vi commands to load the file.</p> |
270 | the message into vi commands to load the file.</p> |
|
|
271 | </dd> |
|
|
272 | <p></p> |
|
|
273 | <dt><strong><a name="item_tabbed">tabbed</a></strong><br /> |
|
|
274 | </dt> |
|
|
275 | <dd> |
|
|
276 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
277 | is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line |
|
|
278 | displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one |
|
|
279 | button per tab. |
|
|
280 | </dd> |
|
|
281 | <dd> |
|
|
282 | <p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and |
|
|
283 | <strong>Shift-Right</strong> will switch to the tab left or right of the current one, |
|
|
284 | while <strong>Shift-Down</strong> creates a new tab.</p> |
244 | </dd> |
285 | </dd> |
245 | <p></p> |
286 | <p></p> |
246 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
287 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
247 | </dt> |
288 | </dt> |
248 | <dd> |
289 | <dd> |
… | |
… | |
408 | <h2><a name="hooks">Hooks</a></h2> |
449 | <h2><a name="hooks">Hooks</a></h2> |
409 | <p>The following subroutines can be declared in extension files, and will be |
450 | <p>The following subroutines can be declared in extension files, and will be |
410 | called whenever the relevant event happens.</p> |
451 | called whenever the relevant event happens.</p> |
411 | <p>The first argument passed to them is an extension oject as described in |
452 | <p>The first argument passed to them is an extension oject as described in |
412 | the in the <code>Extension Objects</code> section.</p> |
453 | the in the <code>Extension Objects</code> section.</p> |
413 | <p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the |
454 | <p><strong>All</strong> of these hooks must return a boolean value. If any of the called |
414 | event counts as being <em>consumed</em>, and the invocation of other hooks is |
455 | hooks returns true, then the event counts as being <em>consumed</em>, and the |
415 | skipped, and the relevant action might not be carried out by the C++ code.</p> |
456 | relevant action might not be carried out by the C++ code.</p> |
416 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
457 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
417 | <dl> |
458 | <dl> |
418 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
459 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
419 | </dt> |
460 | </dt> |
420 | <dd> |
461 | <dd> |
421 | Called after a new terminal object has been initialized, but before |
462 | Called after a new terminal object has been initialized, but before |
422 | windows are created or the command gets run. Most methods are unsafe to |
463 | windows are created or the command gets run. Most methods are unsafe to |
423 | call or deliver senseless data, as terminal size and other characteristics |
464 | call or deliver senseless data, as terminal size and other characteristics |
424 | have not yet been determined. You can safely query and change resources, |
465 | have not yet been determined. You can safely query and change resources |
425 | though. |
466 | and options, though. For many purposes the <code>on_start</code> hook is a better |
|
|
467 | place. |
|
|
468 | </dd> |
|
|
469 | <p></p> |
|
|
470 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
|
|
471 | </dt> |
|
|
472 | <dd> |
|
|
473 | Called at the very end of initialisation of a new terminal, just before |
|
|
474 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
475 | </dd> |
|
|
476 | <p></p> |
|
|
477 | <dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> |
|
|
478 | </dt> |
|
|
479 | <dd> |
|
|
480 | Called whenever something tries to destroy terminal, before doing anything |
|
|
481 | yet. If this hook returns true, then destruction is skipped, but this is |
|
|
482 | rarely a good idea. |
426 | </dd> |
483 | </dd> |
427 | <p></p> |
484 | <p></p> |
428 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
485 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
429 | </dt> |
486 | </dt> |
430 | <dd> |
487 | <dd> |
431 | Called after the screen is ``reset'' for any reason, such as resizing or |
488 | Called after the screen is ``reset'' for any reason, such as resizing or |
432 | control sequences. Here is where you can react on changes to size-related |
489 | control sequences. Here is where you can react on changes to size-related |
433 | variables. |
490 | variables. |
434 | </dd> |
|
|
435 | <p></p> |
|
|
436 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
|
|
437 | </dt> |
|
|
438 | <dd> |
|
|
439 | Called at the very end of initialisation of a new terminal, just before |
|
|
440 | returning to the mainloop. |
|
|
441 | </dd> |
491 | </dd> |
442 | <p></p> |
492 | <p></p> |
443 | <dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br /> |
493 | <dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br /> |
444 | </dt> |
494 | </dt> |
445 | <dd> |
495 | <dd> |
… | |
… | |
607 | focus out processing. |
657 | focus out processing. |
608 | </dd> |
658 | </dd> |
609 | <p></p> |
659 | <p></p> |
610 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> |
660 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> |
611 | </dt> |
661 | </dt> |
|
|
662 | <dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br /> |
|
|
663 | </dt> |
612 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
664 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
613 | </dt> |
665 | </dt> |
614 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
666 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
615 | </dt> |
667 | </dt> |
616 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
668 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
… | |
… | |
627 | Called whenever the corresponding X event is received for the terminal If |
679 | Called whenever the corresponding X event is received for the terminal If |
628 | the hook returns true, then the even will be ignored by rxvt-unicode. |
680 | the hook returns true, then the even will be ignored by rxvt-unicode. |
629 | </dd> |
681 | </dd> |
630 | <dd> |
682 | <dd> |
631 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
683 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
632 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
684 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the |
633 | and column under the mouse cursor.</p> |
685 | (real, not screen-based) row and column under the mouse cursor.</p> |
634 | </dd> |
686 | </dd> |
635 | <dd> |
687 | <dd> |
636 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
688 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
637 | output, if any, in locale-specific encoding.</p> |
689 | output, if any, in locale-specific encoding.</p> |
638 | </dd> |
690 | </dd> |
639 | <dd> |
691 | <dd> |
640 | <p>subwindow.</p> |
692 | <p>subwindow.</p> |
|
|
693 | </dd> |
|
|
694 | <p></p> |
|
|
695 | <dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br /> |
|
|
696 | </dt> |
|
|
697 | <dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br /> |
|
|
698 | </dt> |
|
|
699 | <dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br /> |
|
|
700 | </dt> |
|
|
701 | <dd> |
|
|
702 | Called when various types of ClientMessage events are received (all with |
|
|
703 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
641 | </dd> |
704 | </dd> |
642 | <p></p></dl> |
705 | <p></p></dl> |
643 | <p> |
706 | <p> |
644 | </p> |
707 | </p> |
645 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
708 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
… | |
… | |
666 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
729 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
667 | </dt> |
730 | </dt> |
668 | <dd> |
731 | <dd> |
669 | The current terminal. This variable stores the current <code>urxvt::term</code> |
732 | The current terminal. This variable stores the current <code>urxvt::term</code> |
670 | object, whenever a callback/hook is executing. |
733 | object, whenever a callback/hook is executing. |
|
|
734 | </dd> |
|
|
735 | <p></p> |
|
|
736 | <dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br /> |
|
|
737 | </dt> |
|
|
738 | <dd> |
|
|
739 | All coderefs in this array will be called as methods of the next newly |
|
|
740 | created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array |
|
|
741 | gets cleared before the codereferences that were in it are being executed, |
|
|
742 | so coderefs can push themselves onto it again if they so desire. |
|
|
743 | </dd> |
|
|
744 | <dd> |
|
|
745 | <p>This complements to the perl-eval commandline option, but gets executed |
|
|
746 | first.</p> |
|
|
747 | </dd> |
|
|
748 | <p></p> |
|
|
749 | <dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br /> |
|
|
750 | </dt> |
|
|
751 | <dd> |
|
|
752 | Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which |
|
|
753 | get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code> |
|
|
754 | but before other extensions. Gets cleared just like <code>@TERM_INIT</code>. |
671 | </dd> |
755 | </dd> |
672 | <p></p></dl> |
756 | <p></p></dl> |
673 | <p> |
757 | <p> |
674 | </p> |
758 | </p> |
675 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
759 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
… | |
… | |
1082 | <p>Normally its not a good idea to use this function, as programs might be |
1166 | <p>Normally its not a good idea to use this function, as programs might be |
1083 | confused by changes in cursor position or scrolling. Its useful inside a |
1167 | confused by changes in cursor position or scrolling. Its useful inside a |
1084 | <code>on_add_lines</code> hook, though.</p> |
1168 | <code>on_add_lines</code> hook, though.</p> |
1085 | </dd> |
1169 | </dd> |
1086 | <p></p> |
1170 | <p></p> |
|
|
1171 | <dt><strong><a name="item_scr_change_screen">$term->scr_change_screen ($screen)</a></strong><br /> |
|
|
1172 | </dt> |
|
|
1173 | <dd> |
|
|
1174 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1175 | </dd> |
|
|
1176 | <p></p> |
1087 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
1177 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
1088 | </dt> |
1178 | </dt> |
1089 | <dd> |
1179 | <dd> |
1090 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
1180 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
1091 | locale-specific encoding of the terminal and can contain command sequences |
1181 | locale-specific encoding of the terminal and can contain command sequences |
… | |
… | |
1186 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
1276 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
1187 | </dt> |
1277 | </dt> |
1188 | <dd> |
1278 | <dd> |
1189 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
1279 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
1190 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1280 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1281 | </dd> |
|
|
1282 | <p></p> |
|
|
1283 | <dt><strong><a name="item_current_screen">$screen = $term->current_screen</a></strong><br /> |
|
|
1284 | </dt> |
|
|
1285 | <dd> |
|
|
1286 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1287 | </dd> |
|
|
1288 | <p></p> |
|
|
1289 | <dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term->hidden_cursor</a></strong><br /> |
|
|
1290 | </dt> |
|
|
1291 | <dd> |
|
|
1292 | Returns wether the cursor is currently hidden or not. |
1191 | </dd> |
1293 | </dd> |
1192 | <p></p> |
1294 | <p></p> |
1193 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1295 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1194 | </dt> |
1296 | </dt> |
1195 | <dd> |
1297 | <dd> |
… | |
… | |
1223 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
1325 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
1224 | to replace only parts of a line. The font index in the rendition will |
1326 | to replace only parts of a line. The font index in the rendition will |
1225 | automatically be updated.</p> |
1327 | automatically be updated.</p> |
1226 | </dd> |
1328 | </dd> |
1227 | <dd> |
1329 | <dd> |
1228 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
1330 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use |
1229 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1331 | more than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> |
1230 | (<code>chr 65535</code>). Characters with combining characters and other characters |
1332 | characters. Characters with combining characters and other characters that |
1231 | that do not fit into the normal tetx encoding will be replaced with |
1333 | do not fit into the normal tetx encoding will be replaced with characters |
1232 | characters in the private use area.</p> |
1334 | in the private use area.</p> |
1233 | </dd> |
1335 | </dd> |
1234 | <dd> |
1336 | <dd> |
1235 | <p>You have to obey this encoding when changing text. The advantage is |
1337 | <p>You have to obey this encoding when changing text. The advantage is |
1236 | that <code>substr</code> and similar functions work on screen cells and not on |
1338 | that <code>substr</code> and similar functions work on screen cells and not on |
1237 | characters.</p> |
1339 | characters.</p> |
… | |
… | |
1371 | </dt> |
1473 | </dt> |
1372 | <dd> |
1474 | <dd> |
1373 | Calls XUngrab for the most recent grab. Is called automatically on |
1475 | Calls XUngrab for the most recent grab. Is called automatically on |
1374 | evaluation errors, as it is better to lose the grab in the error case as |
1476 | evaluation errors, as it is better to lose the grab in the error case as |
1375 | the session. |
1477 | the session. |
|
|
1478 | </dd> |
|
|
1479 | <p></p> |
|
|
1480 | <dt><strong><a name="item_xinternatom">$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</a></strong><br /> |
|
|
1481 | </dt> |
|
|
1482 | <dt><strong><a name="item_xgetatomname">$atom_name = $term->XGetAtomName ($atom)</a></strong><br /> |
|
|
1483 | </dt> |
|
|
1484 | <dt><strong><a name="item_xlistproperties">@atoms = $term->XListProperties ($window)</a></strong><br /> |
|
|
1485 | </dt> |
|
|
1486 | <dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</a></strong><br /> |
|
|
1487 | </dt> |
|
|
1488 | <dt><strong><a name="item_xchangewindowproperty">$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br /> |
|
|
1489 | </dt> |
|
|
1490 | <dt><strong><a name="item_xdeleteproperty">$term->XDeleteProperty ($window, $property)</a></strong><br /> |
|
|
1491 | </dt> |
|
|
1492 | <dt><strong><a name="item_defaultrootwindow">$window = $term->DefaultRootWindow</a></strong><br /> |
|
|
1493 | </dt> |
|
|
1494 | <dt><strong><a name="item_xreparentwindow">$term->XReparentWindow ($window, $parent, [$x, $y])</a></strong><br /> |
|
|
1495 | </dt> |
|
|
1496 | <dt><strong><a name="item_xmapwindow">$term->XMapWindow ($window)</a></strong><br /> |
|
|
1497 | </dt> |
|
|
1498 | <dt><strong><a name="item_xunmapwindow">$term->XUnmapWindow ($window)</a></strong><br /> |
|
|
1499 | </dt> |
|
|
1500 | <dt><strong><a name="item_xmoveresizewindow">$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br /> |
|
|
1501 | </dt> |
|
|
1502 | <dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br /> |
|
|
1503 | </dt> |
|
|
1504 | <dt><strong><a name="item_xchangeinput">$term->XChangeInput ($window, $add_events[, $del_events])</a></strong><br /> |
|
|
1505 | </dt> |
|
|
1506 | <dd> |
|
|
1507 | Various X or X-related functions. The <code>$term</code> object only serves as |
|
|
1508 | the source of the display, otherwise those functions map more-or-less |
|
|
1509 | directory onto the X functions of the same name. |
1376 | </dd> |
1510 | </dd> |
1377 | <p></p></dl> |
1511 | <p></p></dl> |
1378 | <p> |
1512 | <p> |
1379 | </p> |
1513 | </p> |
1380 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1514 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
… | |
… | |
1541 | Stop watching for events on the given filehandle. |
1675 | Stop watching for events on the given filehandle. |
1542 | </dd> |
1676 | </dd> |
1543 | <p></p></dl> |
1677 | <p></p></dl> |
1544 | <p> |
1678 | <p> |
1545 | </p> |
1679 | </p> |
|
|
1680 | <h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2> |
|
|
1681 | <p>This class implements idle watchers, that get called automatically when |
|
|
1682 | the process is idle. They should return as fast as possible, after doing |
|
|
1683 | some useful work.</p> |
|
|
1684 | <dl> |
|
|
1685 | <dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br /> |
|
|
1686 | </dt> |
|
|
1687 | <dd> |
|
|
1688 | Create a new idle watcher object in stopped state. |
|
|
1689 | </dd> |
|
|
1690 | <p></p> |
|
|
1691 | <dt><strong>$iw = $iw->cb (sub { my ($iw) = @_; ... })</strong><br /> |
|
|
1692 | </dt> |
|
|
1693 | <dd> |
|
|
1694 | Set the callback to be called when the watcher triggers. |
|
|
1695 | </dd> |
|
|
1696 | <p></p> |
|
|
1697 | <dt><strong>$timer = $timer->start</strong><br /> |
|
|
1698 | </dt> |
|
|
1699 | <dd> |
|
|
1700 | Start the watcher. |
|
|
1701 | </dd> |
|
|
1702 | <p></p> |
|
|
1703 | <dt><strong>$timer = $timer->stop</strong><br /> |
|
|
1704 | </dt> |
|
|
1705 | <dd> |
|
|
1706 | Stop the watcher. |
|
|
1707 | </dd> |
|
|
1708 | <p></p></dl> |
|
|
1709 | <p> |
|
|
1710 | </p> |
|
|
1711 | <h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2> |
|
|
1712 | <p>This class implements process watchers. They create an event whenever a |
|
|
1713 | process exits, after which they stop automatically.</p> |
|
|
1714 | <pre> |
|
|
1715 | my $pid = fork; |
|
|
1716 | ... |
|
|
1717 | $term->{pw} = urxvt::pw |
|
|
1718 | ->new |
|
|
1719 | ->start ($pid) |
|
|
1720 | ->cb (sub { |
|
|
1721 | my ($pw, $exit_status) = @_; |
|
|
1722 | ... |
|
|
1723 | });</pre> |
|
|
1724 | <dl> |
|
|
1725 | <dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br /> |
|
|
1726 | </dt> |
|
|
1727 | <dd> |
|
|
1728 | Create a new process watcher in stopped state. |
|
|
1729 | </dd> |
|
|
1730 | <p></p> |
|
|
1731 | <dt><strong>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br /> |
|
|
1732 | </dt> |
|
|
1733 | <dd> |
|
|
1734 | Set the callback to be called when the timer triggers. |
|
|
1735 | </dd> |
|
|
1736 | <p></p> |
|
|
1737 | <dt><strong>$pw = $timer->start ($pid)</strong><br /> |
|
|
1738 | </dt> |
|
|
1739 | <dd> |
|
|
1740 | Tells the wqtcher to start watching for process <code>$pid</code>. |
|
|
1741 | </dd> |
|
|
1742 | <p></p> |
|
|
1743 | <dt><strong>$pw = $pw->stop</strong><br /> |
|
|
1744 | </dt> |
|
|
1745 | <dd> |
|
|
1746 | Stop the watcher. |
|
|
1747 | </dd> |
|
|
1748 | <p></p></dl> |
|
|
1749 | <p> |
|
|
1750 | </p> |
1546 | <hr /> |
1751 | <hr /> |
1547 | <h1><a name="environment">ENVIRONMENT</a></h1> |
1752 | <h1><a name="environment">ENVIRONMENT</a></h1> |
1548 | <p> |
1753 | <p> |
1549 | </p> |
1754 | </p> |
1550 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1755 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |