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

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.35 by root, Fri Jan 20 22:49:34 2006 UTC vs.
Revision 1.42 by root, Mon Feb 6 06:14:55 2006 UTC

… …
121<dd> 121<dd>
122<pre> 122<pre>
123 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> 123 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
124</dd> 124</dd>
125<dd> 125<dd>
126<p>Another example: Programs I use often output ``absolute path: '' at the
127beginning of a line when they process multiple files. The following
128pattern matches the filename (note, there is a single space at the very
129end):</p>
130</dd>
131<dd>
132<pre>
133 URxvt.selection.pattern-0: ^(/[^:]+):\</pre>
134</dd>
135<dd>
126<p>You can look at the source of the selection extension to see more 136<p>You can look at the source of the selection extension to see more
127interesting uses, such as parsing a line from beginning to end.</p> 137interesting uses, such as parsing a line from beginning to end.</p>
128</dd> 138</dd>
129<dd> 139<dd>
130<p>This extension also offers following bindable keyboard commands:</p> 140<p>This extension also offers following bindable keyboard commands:</p>
… …
143<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> 153<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
144</dt> 154</dt>
145<dd> 155<dd>
146Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 156Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
147runtime. 157runtime.
158</dd>
159<dd>
160<p>Other extensions can extend this popup menu by pushing a code reference
161onto <code>@{ $term-</code>{option_popup_hook} }&gt;, which gets called whenever the
162popup is being displayed.</p>
163</dd>
164<dd>
165<p>It's sole argument is the popup menu, which can be modified. It should
166either return nothing or a string, the initial boolean value and a code
167reference. The string will be used as button text and the code reference
168will be called when the toggle changes, with the new boolean value as
169first argument.</p>
170</dd>
171<dd>
172<p>The following will add an entry <code>myoption</code> that changes
173<code>$self-</code>{myoption}&gt;:</p>
174</dd>
175<dd>
176<pre>
177 push @{ $self-&gt;{term}{option_popup_hook} }, sub {
178 (&quot;my option&quot; =&gt; $myoption, sub { $self-&gt;{myoption} = $_[0] })
179 };</pre>
148</dd> 180</dd>
149<p></p> 181<p></p>
150<dt><strong>selection-popup (enabled by default)</strong><br /> 182<dt><strong>selection-popup (enabled by default)</strong><br />
151</dt> 183</dt>
152<dd> 184<dd>
… …
154text into various other formats/action (such as uri unescaping, perl 186text into various other formats/action (such as uri unescaping, perl
155evaluation, web-browser starting etc.), depending on content. 187evaluation, web-browser starting etc.), depending on content.
156</dd> 188</dd>
157<dd> 189<dd>
158<p>Other extensions can extend this popup menu by pushing a code reference 190<p>Other extensions can extend this popup menu by pushing a code reference
159onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, that is called whenever the 191onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, which gets called whenever the
160popup is displayed.</p> 192popup is being displayed.</p>
161</dd> 193</dd>
162<dd> 194<dd>
163<p>It's sole argument is the popup menu, which can be modified. The selection 195<p>It's sole argument is the popup menu, which can be modified. The selection
164is in <code>$_</code>, which can be used to decide wether to add something or not. 196is in <code>$_</code>, which can be used to decide wether to add something or not.
165It should either return nothing or a string and a code reference. The 197It should either return nothing or a string and a code reference. The
… …
195was started, while <code>Enter</code> or <code>Return</code> stay at the current position and 227was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
196additionally stores the first match in the current line into the primary 228additionally stores the first match in the current line into the primary
197selection.</p> 229selection.</p>
198</dd> 230</dd>
199<p></p> 231<p></p>
200<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
201</dt>
202<dd>
203This selection allows you to do automatic transforms on a selection
204whenever a selection is made.
205</dd>
206<dd>
207<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
208operator) that modify <code>$_</code> as resources:</p>
209</dd>
210<dd>
211<pre>
212 URxvt.selection-autotransform.0: transform
213 URxvt.selection-autotransform.1: transform
214 ...</pre>
215</dd>
216<dd>
217<p>For example, the following will transform selections of the form
218<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
219$word</code>:</p>
220</dd>
221<dd>
222<pre>
223 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
224</dd>
225<dd>
226<p>And this example matches the same,but replaces it with vi-commands you can
227paste directly into your (vi :) editor:</p>
228</dd>
229<dd>
230<pre>
231 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
232</dd>
233<dd>
234<p>Of course, this can be modified to suit your needs and your editor :)</p>
235</dd>
236<dd>
237<p>To expand the example above to typical perl error messages (``XXX at
238FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
239</dd>
240<dd>
241<pre>
242 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
243 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre>
244</dd>
245<dd>
246<p>The first line tells the selection code to treat the unchanging part of
247every error message as a selection pattern, and the second line transforms
248the message into vi commands to load the file.</p>
249</dd>
250<p></p>
251<dt><strong><a name="item_readline">readline</a></strong><br /> 232<dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br />
252</dt> 233</dt>
253<dd> 234<dd>
254A support package that tries to make editing with readline easier. At the 235A support package that tries to make editing with readline easier. At the
255moment, it reacts to clicking with the left mouse button by trying to 236moment, it reacts to clicking with the left mouse button by trying to
256move the text cursor to this position. It does so by generating as many 237move the text cursor to this position. It does so by generating as many
257cursor-left or cursor-right keypresses as required (the this only works 238cursor-left or cursor-right keypresses as required (the this only works
258for programs that correctly support wide characters). 239for programs that correctly support wide characters).
259</dd> 240</dd>
260<dd> 241<dd>
261<p>It only works when clicking into the same line (possibly extended over 242<p>To avoid too many false positives, this is only done when:</p>
262multiple rows) as the text cursor and on the primary screen, to reduce the 243</dd>
263risk of misinterpreting. The normal selection isn't disabled, so quick 244<dl>
245<dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong><br />
246</dt>
247<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br />
248</dt>
249<dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br />
250</dt>
251<dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br />
252</dt>
253</dl>
254<p>The normal selection mechanism isn't disabled, so quick successive clicks
264successive clicks might interfere with selection creation in harmless 255might interfere with selection creation in harmless ways.</p>
265ways.</p> 256<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
257</dt>
258<dd>
259This selection allows you to do automatic transforms on a selection
260whenever a selection is made.
261</dd>
262<dd>
263<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
264operator) that modify <code>$_</code> as resources:</p>
265</dd>
266<dd>
267<pre>
268 URxvt.selection-autotransform.0: transform
269 URxvt.selection-autotransform.1: transform
270 ...</pre>
271</dd>
272<dd>
273<p>For example, the following will transform selections of the form
274<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
275$word</code>:</p>
276</dd>
277<dd>
278<pre>
279 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
280</dd>
281<dd>
282<p>And this example matches the same,but replaces it with vi-commands you can
283paste directly into your (vi :) editor:</p>
284</dd>
285<dd>
286<pre>
287 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
288</dd>
289<dd>
290<p>Of course, this can be modified to suit your needs and your editor :)</p>
291</dd>
292<dd>
293<p>To expand the example above to typical perl error messages (``XXX at
294FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
295</dd>
296<dd>
297<pre>
298 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
299 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre>
300</dd>
301<dd>
302<p>The first line tells the selection code to treat the unchanging part of
303every error message as a selection pattern, and the second line transforms
304the message into vi commands to load the file.</p>
266</dd> 305</dd>
267<p></p> 306<p></p>
268<dt><strong><a name="item_tabbed">tabbed</a></strong><br /> 307<dt><strong><a name="item_tabbed">tabbed</a></strong><br />
269</dt> 308</dt>
270<dd> 309<dd>
… …
276<dd> 315<dd>
277<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and 316<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and
278<strong>Shift-Right</strong> will switch to the tab left or right of the current one, 317<strong>Shift-Right</strong> will switch to the tab left or right of the current one,
279while <strong>Shift-Down</strong> creates a new tab.</p> 318while <strong>Shift-Down</strong> creates a new tab.</p>
280</dd> 319</dd>
320<dd>
321<p>The tabbar itself can be configured similarly to a normal terminal, but
322with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the
323following four resources (shown with defaults):</p>
324</dd>
325<dd>
326<pre>
327 URxvt.tabbed.tabbar-fg: &lt;colour-index, default 3&gt;
328 URxvt.tabbed.tabbar-bg: &lt;colour-index, default 0&gt;
329 URxvt.tabbed.tab-fg: &lt;colour-index, default 0&gt;
330 URxvt.tabbed.tab-bg: &lt;colour-index, default 1&gt;</pre>
331</dd>
332<dd>
333<p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid
334indices.</p>
335</dd>
281<p></p> 336<p></p>
282<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 337<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
283</dt> 338</dt>
284<dd> 339<dd>
285Uses per-line display filtering (<code>on_line_update</code>) to underline urls and 340Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
286make them clickable. When middle-clicked, the program specified in the 341make them clickable. When middle-clicked, the program specified in the
287resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with 342resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
288the URL as first argument. 343the URL as first argument.
289</dd> 344</dd>
290<p></p> 345<p></p>
346<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br />
347</dt>
348<dd>
349This (experimental) perl extension implements OnTheSpot editing. It does
350not work perfectly, and some input methods don't seem to work well with
351OnTheSpot editing in general, but it seems to work at leats for SCIM and
352kinput2.
353</dd>
354<dd>
355<p>You enable it by specifying this extension and a preedit style of
356<code>OnTheSpot</code>, i.e.:</p>
357</dd>
358<dd>
359<pre>
360 rxvt -pt OnTheSpot -pe xim-onthespot</pre>
361</dd>
362<p></p>
291<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> 363<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
292</dt> 364</dt>
293<dd> 365<dd>
294This is basically a one-line extension that dynamically changes the background pixmap offset 366This is basically a one-line extension that dynamically changes the background pixmap offset
295to the window position, in effect creating the same effect as pseudo transparency with 367to the window position, in effect creating the same effect as pseudo transparency with
… …
312</dt> 384</dt>
313<dd> 385<dd>
314Displays a digital clock using the built-in overlay. 386Displays a digital clock using the built-in overlay.
315</dd> 387</dd>
316<p></p> 388<p></p>
317<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 389<dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br />
318</dt> 390</dt>
391<dd>
392Somewhat of a misnomer, this extension adds two menu entries to the
393selection popup that allows one ti run external commands to store the
394selection somewhere and fetch it again.
319<dd> 395</dd>
320Displays a very simple digital clock in the upper right corner of the 396<dd>
321window. Illustrates overwriting the refresh callbacks to create your own 397<p>We use it to implement a ``distributed selection mechanism'', which just
322overlays or changes. 398means that one command uploads the file to a remote server, and another
399reads it.</p>
400</dd>
401<dd>
402<p>The commands can be set using the <code>URxvt.remote-selection.store</code> and
403<code>URxvt.remote-selection.fetch</code> resources. The first should read the
404selection to store from STDIN (always in UTF-8), the second should provide
405the selection data on STDOUT (also in UTF-8).</p>
406</dd>
407<dd>
408<p>The defaults (which are likely useless to you) use rsh and cat:</p>
409</dd>
410<dd>
411<pre>
412 URxvt.remote-selection.store: rsh ruth 'cat &gt;/tmp/distributed-selection'
413 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre>
323</dd> 414</dd>
324<p></p> 415<p></p>
325<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> 416<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
326</dt> 417</dt>
327<dd> 418<dd>
… …
360for the filename):</p> 451for the filename):</p>
361</dd> 452</dd>
362<dd> 453<dd>
363<pre> 454<pre>
364 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> 455 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
456</dd>
457<p></p>
458<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
459</dt>
460<dd>
461Displays a very simple digital clock in the upper right corner of the
462window. Illustrates overwriting the refresh callbacks to create your own
463overlays or changes.
365</dd> 464</dd>
366<p></p></dl> 465<p></p></dl>
367<p> 466<p>
368</p> 467</p>
369<hr /> 468<hr />
… …
470</dd> 569</dd>
471<p></p> 570<p></p>
472<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> 571<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br />
473</dt> 572</dt>
474<dd> 573<dd>
475Called whenever something tries to destroy terminal, before doing anything 574Called whenever something tries to destroy terminal, when the terminal is
476yet. If this hook returns true, then destruction is skipped, but this is 575still fully functional (not for long, though).
477rarely a good idea.
478</dd> 576</dd>
479<p></p> 577<p></p>
480<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 578<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
481</dt> 579</dt>
482<dd> 580<dd>
… …
620</dt> 718</dt>
621<dd> 719<dd>
622Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 720Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
623</dd> 721</dd>
624<p></p> 722<p></p>
625<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> 723<dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br />
626</dt> 724</dt>
627<dd> 725<dd>
628Called whenever the user presses a key combination that has a 726Called whenever the a user-configured event is being activated (e.g. via
629<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 727a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong>
630resource in the <code>rxvt(1)</code> manpage). 728resource in the <code>rxvt(1)</code> manpage).
729</dd>
730<dd>
731<p>The event is simply the action string. This interface is assumed to change
732slightly in the future.</p>
631</dd> 733</dd>
632<p></p> 734<p></p>
633<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> 735<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
634</dt> 736</dt>
635<dd> 737<dd>
… …
772<p>Using this function has the advantage that its output ends up in the 874<p>Using this function has the advantage that its output ends up in the
773correct place, e.g. on stderr of the connecting urxvtc client.</p> 875correct place, e.g. on stderr of the connecting urxvtc client.</p>
774</dd> 876</dd>
775<dd> 877<dd>
776<p>Messages have a size limit of 1023 bytes currently.</p> 878<p>Messages have a size limit of 1023 bytes currently.</p>
879</dd>
880<p></p>
881<dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br />
882</dt>
883<dd>
884Returns all urxvt::term objects that exist in this process, regardless of
885wether they are started, being destroyed etc., so be careful. Only term
886objects that have perl extensions attached will be returned (because there
887is no urxvt::term objet associated with others).
777</dd> 888</dd>
778<p></p> 889<p></p>
779<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 890<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
780</dt> 891</dt>
781<dd> 892<dd>
… …
849<p></p> 960<p></p>
850<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> 961<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
851</dt> 962</dt>
852<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> 963<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
853</dt> 964</dt>
965<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_color__24rend_2c__24new">$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</a></strong><br />
966</dt>
854<dd> 967<dd>
855Replace the foreground/background colour in the rendition mask with the 968Replace the foreground/background colour in the rendition mask with the
856specified one. 969specified one.
857</dd> 970</dd>
858<p></p> 971<p></p>
… …
892</dd> 1005</dd>
893<dd> 1006<dd>
894<p>Croaks (and probably outputs an error message) if the new instance 1007<p>Croaks (and probably outputs an error message) if the new instance
895couldn't be created. Returns <code>undef</code> if the new instance didn't 1008couldn't be created. Returns <code>undef</code> if the new instance didn't
896initialise perl, and the terminal object otherwise. The <code>init</code> and 1009initialise perl, and the terminal object otherwise. The <code>init</code> and
897<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> 1010<a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to
1011refer to global data (which is race free).</p>
898</dd> 1012</dd>
899<p></p> 1013<p></p>
900<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 1014<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
901</dt> 1015</dt>
902<dd> 1016<dd>
… …
1192be used to suppress input and output handling to the pty/tty. See the 1306be used to suppress input and output handling to the pty/tty. See the
1193description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore 1307description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1194the previous value. 1308the previous value.
1195</dd> 1309</dd>
1196<p></p> 1310<p></p>
1311<dt><strong><a name="item_pty_fd">$fd = $term-&gt;pty_fd</a></strong><br />
1312</dt>
1313<dd>
1314Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
1315is used.
1316</dd>
1317<p></p>
1197<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 1318<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
1198</dt> 1319</dt>
1199<dd> 1320<dd>
1200Return the window id of the toplevel window. 1321Return the window id of the toplevel window.
1201</dd> 1322</dd>
… …
1215<dd> 1336<dd>
1216<pre> 1337<pre>
1217 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre> 1338 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1218</dd> 1339</dd>
1219<p></p> 1340<p></p>
1341<dt><strong><a name="item_focus_in">$term-&gt;focus_in</a></strong><br />
1342</dt>
1343<dt><strong><a name="item_focus_out">$term-&gt;focus_out</a></strong><br />
1344</dt>
1345<dt><strong><a name="item_key_press">$term-&gt;key_press ($state, $keycode[, $time])</a></strong><br />
1346</dt>
1347<dt><strong><a name="item_key_release">$term-&gt;key_release ($state, $keycode[, $time])</a></strong><br />
1348</dt>
1349<dd>
1350Deliver various fake events to to terminal.
1351</dd>
1352<p></p>
1220<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1353<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
1221</dt> 1354</dt>
1222<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1355<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
1223</dt> 1356</dt>
1224<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1357<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
1277<p></p> 1410<p></p>
1278<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br /> 1411<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br />
1279</dt> 1412</dt>
1280<dd> 1413<dd>
1281Returns the currently displayed screen (0 primary, 1 secondary). 1414Returns the currently displayed screen (0 primary, 1 secondary).
1415</dd>
1416<p></p>
1417<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong><br />
1418</dt>
1419<dd>
1420Returns wether the cursor is currently hidden or not.
1282</dd> 1421</dd>
1283<p></p> 1422<p></p>
1284<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1423<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
1285</dt> 1424</dt>
1286<dd> 1425<dd>
… …
1314line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1453line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
1315to replace only parts of a line. The font index in the rendition will 1454to replace only parts of a line. The font index in the rendition will
1316automatically be updated.</p> 1455automatically be updated.</p>
1317</dd> 1456</dd>
1318<dd> 1457<dd>
1319<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use 1458<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
1320more than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> 1459than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
1321characters. Characters with combining characters and other characters that 1460characters. Characters with combining characters and other characters that
1322do not fit into the normal tetx encoding will be replaced with characters 1461do not fit into the normal tetx encoding will be replaced with characters
1323in the private use area.</p> 1462in the private use area.</p>
1324</dd> 1463</dd>
1325<dd> 1464<dd>
… …
1424<dd> 1563<dd>
1425Converts rxvt-unicodes text reprsentation into a perl string. See 1564Converts rxvt-unicodes text reprsentation into a perl string. See
1426<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1565<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1427</dd> 1566</dd>
1428<p></p> 1567<p></p>
1429<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br /> 1568<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1430</dt> 1569</dt>
1570<dt><strong><a name="item_ungrab_button">$term-&gt;ungrab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1571</dt>
1431<dd> 1572<dd>
1432Registers a synchronous button grab. See the XGrabButton manpage. 1573Register/unregister a synchronous button grab. See the XGrabButton
1574manpage.
1433</dd> 1575</dd>
1434<p></p> 1576<p></p>
1435<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br /> 1577<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1436</dt> 1578</dt>
1437<dd> 1579<dd>
… …
1519<dd> 1661<dd>
1520Adds a clickable button to the popup. <code>$cb</code> is called whenever it is 1662Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1521selected. 1663selected.
1522</dd> 1664</dd>
1523<p></p> 1665<p></p>
1524<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br /> 1666<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $initial_value, $cb)</a></strong><br />
1525</dt> 1667</dt>
1526<dd> 1668<dd>
1527Adds a toggle/checkbox item to the popup. Teh callback gets called 1669Adds a toggle/checkbox item to the popup. The callback gets called
1528whenever it gets toggled, with a boolean indicating its value as its first 1670whenever it gets toggled, with a boolean indicating its new value as its
1529argument. 1671first argument.
1530</dd> 1672</dd>
1531<p></p> 1673<p></p>
1532<dt><strong>$popup-&gt;show</strong><br /> 1674<dt><strong>$popup-&gt;show</strong><br />
1533</dt> 1675</dt>
1534<dd> 1676<dd>

Diff Legend

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