[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.13 by root, Tue Jan 3 00:06:57 2006 UTC vs.
Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC

…		…
		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
22		24
23	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
24	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
25		27
26	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
27	scripts will be shared (But not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
		30
		31	=head2 Prepackaged Extensions
		32
		33	This section describes the extensiosn delivered with this version. You can
		34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		35
		36	You can activate them like this:
		37
		38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	=over 4
		41
		42	=item selection
		43
		44	Miscellaneous selection modifications.
		45
		46	=over 4
		47
		48	=item rot13
		49
		50	Rot-13 the selection when activated. Used via keyboard trigger:
		51
		52	URxvt.keysym.C-M-r: perl:selection:rot13
		53
		54	=back
		55
		56	=item digital-clock
		57
		58	Displays a very simple digital clock in the upper right corner of the
		59	window. Illustrates overwriting the refresh callbacks to create your own
		60	overlays or changes.
		61
		62	=item simple-overlay-clock
		63
		64	Displays a digital clock using the built-in overlay (colourful, useless).
		65
		66	=back
28		67
29	=head2 General API Considerations	68	=head2 General API Considerations
30		69
31	All objects (such as terminals, time watchers etc.) are typical	70	All objects (such as terminals, time watchers etc.) are typical
32	reference-to-hash objects. The hash can be used to store anything you	71	reference-to-hash objects. The hash can be used to store anything you
…		…
154	correct place, e.g. on stderr of the connecting urxvtc client.	193	correct place, e.g. on stderr of the connecting urxvtc client.
155		194
156	=item $time = urxvt::NOW	195	=item $time = urxvt::NOW
157		196
158	Returns the "current time" (as per the event loop).	197	Returns the "current time" (as per the event loop).
		198
		199	=head2 RENDITION
		200
		201	Rendition bitsets contain information about colour, font, font styles and
		202	similar information for each screen cell.
		203
		204	The following "macros" deal with changes in rendition sets. You should
		205	never just create a bitset, you should always modify an existing one,
		206	as they contain important information required for correct operation of
		207	rxvt-unicode.
		208
		209	=over 4
		210
		211	=item $rend = urxvt::DEFAULT_RSTYLE
		212
		213	Returns the default rendition, as used when the terminal is starting up or
		214	being reset. Useful as a base to start when creating renditions.
		215
		216	=item $rend = urxvt::OVERLAY_RSTYLE
		217
		218	Return the rendition mask used for overlays by default.
		219
		220	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		221
		222	Return the bit that enabled bold, italic, blink, reverse-video and
		223	underline, respectively. To enable such a style, just logically OR it into
		224	the bitset.
		225
		226	=item $foreground = urxvt::GET_BASEFG $rend
		227
		228	=item $background = urxvt::GET_BASEBG $rend
		229
		230	Return the foreground/background colour index, respectively.
		231
		232	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		233
		234	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		235
		236	Replace the foreground/background colour in the rendition mask with the
		237	specified one.
		238
		239	=item $value = urxvt::GET_CUSTOM ($rend)
		240
		241	Return the "custom" value: Every rendition has 5 bits for use by
		242	extensions. They can be set and changed as you like and are initially
		243	zero.
		244
		245	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		246
		247	Change the custom value.
		248
		249	=back
159		250
160	=cut	251	=cut
161		252
162	package urxvt;	253	package urxvt;
163		254
…		…
410		501
411	Returns the negative row number of the topmost line. Minimum value is	502	Returns the negative row number of the topmost line. Minimum value is
412	C<0>, which displays the normal terminal contents. Larger values scroll	503	C<0>, which displays the normal terminal contents. Larger values scroll
413	this many lines into the scrollback buffer.	504	this many lines into the scrollback buffer.
414		505
		506	=item $term->want_refresh
		507
		508	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		509	compare the on-screen display with its stored representation. If they
		510	differ, it redraws the differences.
		511
		512	Used after changing terminal contents to display them.
		513
415	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	514	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
416		515
417	Returns the text of the entire row with number C<$row_number>. Row C<0>	516	Returns the text of the entire row with number C<$row_number>. Row C<0>
418	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	517	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
419	terminal line. The scrollback buffer starts at line C<-1> and extends to	518	terminal line. The scrollback buffer starts at line C<-1> and extends to
420	line C<< -$term->nsaved >>.	519	line C<< -$term->nsaved >>.
421		520
422	If C<$new_text> is specified, it will replace characters in the current	521	If C<$new_text> is specified, it will replace characters in the current
423	line, starting at column C<$start_col> (default C<0>), which is useful	522	line, starting at column C<$start_col> (default C<0>), which is useful
424	to replace only parts of a line. The font iindex in the rendition will	523	to replace only parts of a line. The font index in the rendition will
425	automatically be updated.	524	automatically be updated.
426		525
427	C<$text> is in a special encoding: tabs and wide characters that use more	526	C<$text> is in a special encoding: tabs and wide characters that use more
428	than one cell when displayed are padded with urxvt::NOCHAR characters	527	than one cell when displayed are padded with urxvt::NOCHAR characters
429	(C<chr 65535>). Characters with combining characters and other characters	528	(C<chr 65535>). Characters with combining characters and other characters
…		…
443	bitsets. Rendition bitsets contain information about colour, font, font	542	bitsets. Rendition bitsets contain information about colour, font, font
444	styles and similar information. See also C<< $term->ROW_t >>.	543	styles and similar information. See also C<< $term->ROW_t >>.
445		544
446	When setting rendition, the font mask will be ignored.	545	When setting rendition, the font mask will be ignored.
447		546
448	See the section on RENDITION, below.	547	See the section on RENDITION, above.
449		548
450	=item $length = $term->ROW_l ($row_number[, $new_length])	549	=item $length = $term->ROW_l ($row_number[, $new_length])
451		550
452	Returns the number of screen cells that are in use ("the line length"). If	551	Returns the number of screen cells that are in use ("the line length"). If
453	it is C<-1>, then the line is part of a multiple-row logical "line", which	552	it is C<-1>, then the line is part of a multiple-row logical "line", which
…		…
463		562
464	Converts rxvt-unicodes text reprsentation into a perl string. See	563	Converts rxvt-unicodes text reprsentation into a perl string. See
465	C<< $term->ROW_t >> for details.	564	C<< $term->ROW_t >> for details.
466		565
467	=back	566	=back
468
469	=head2 RENDITION
470
471	Rendition bitsets contain information about colour, font, font styles and
472	similar information for each screen cell.
473
474	The following "macros" deal with changes in rendition sets. You should
475	never just create a bitset, you should always modify an existing one,
476	as they contain important information required for correct operation of
477	rxvt-unicode.
478
479	=over 4
480
481	=item $rend = urxvt::DEFAULT_RSTYLE
482
483	Returns the default rendition, as used when the terminal is starting up or
484	being reset. Useful as a base
485
486	=back
487
488	=cut
489		567
490	=head2 The C<urxvt::timer> Class	568	=head2 The C<urxvt::timer> Class
491		569
492	This class implements timer watchers/events. Time is represented as a	570	This class implements timer watchers/events. Time is represented as a
493	fractional number of seconds since the epoch. Example:	571	fractional number of seconds since the epoch. Example:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.13 by root, Tue Jan 3 00:06:57 2006 UTC vs. Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.13 by root, Tue Jan 3 00:06:57 2006 UTC vs.
Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC