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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.17 by root, Tue Jan 3 01:45:03 2006 UTC vs.
Revision 1.22 by root, Tue Jan 3 19:10:54 2006 UTC

…		…
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection
43		43
44	Miscellaneous selection modifications.	44	Intelligent selection. This etxension tries to be more intelligent when the user
		45	extends selections (double-click).
		46
		47	It also offers the following bindable event:
45		48
46	=over 4	49	=over 4
47		50
48	=item rot13	51	=item rot13
49		52
…		…
52	URxvt.keysym.C-M-r: perl:selection:rot13	55	URxvt.keysym.C-M-r: perl:selection:rot13
53		56
54	=back	57	=back
55		58
56	=item digital-clock	59	=item digital-clock
		60
		61	Displays a digital clock using the built-in overlay.
		62
		63	=item example-refresh-hooks
57		64
58	Displays a very simple digital clock in the upper right corner of the	65	Displays a very simple digital clock in the upper right corner of the
59	window. Illustrates overwriting the refresh callbacks to create your own	66	window. Illustrates overwriting the refresh callbacks to create your own
60	overlays or changes.	67	overlays or changes.
61
62	=item simple-overlay-clock
63
64	Displays a digital clock using the built-in overlay (colorful, useless).
65		68
66	=back	69	=back
67		70
68	=head2 General API Considerations	71	=head2 General API Considerations
69		72
…		…
122	requested from the server. The selection text can be queried and changed	125	requested from the server. The selection text can be queried and changed
123	by calling C<< $term->selection >>.	126	by calling C<< $term->selection >>.
124		127
125	Returning a true value aborts selection grabbing. It will still be hilighted.	128	Returning a true value aborts selection grabbing. It will still be hilighted.
126		129
		130	=item on_sel_extend $term
		131
		132	Called whenever the user tries to extend the selection (e.g. with a double
		133	click) and is either supposed to return false (normal operation), or
		134	should extend the selection itelf and return true to suppress the built-in
		135	processing.
		136
		137	See the F<selection> example extension.
		138
127	=item on_focus_in $term	139	=item on_focus_in $term
128		140
129	Called whenever the window gets the keyboard focus, before urxvt does	141	Called whenever the window gets the keyboard focus, before urxvt does
130	focus in processing.	142	focus in processing.
131		143
…		…
193	correct place, e.g. on stderr of the connecting urxvtc client.	205	correct place, e.g. on stderr of the connecting urxvtc client.
194		206
195	=item $time = urxvt::NOW	207	=item $time = urxvt::NOW
196		208
197	Returns the "current time" (as per the event loop).	209	Returns the "current time" (as per the event loop).
		210
		211	=back
		212
		213	=head2 RENDITION
		214
		215	Rendition bitsets contain information about colour, font, font styles and
		216	similar information for each screen cell.
		217
		218	The following "macros" deal with changes in rendition sets. You should
		219	never just create a bitset, you should always modify an existing one,
		220	as they contain important information required for correct operation of
		221	rxvt-unicode.
		222
		223	=over 4
		224
		225	=item $rend = urxvt::DEFAULT_RSTYLE
		226
		227	Returns the default rendition, as used when the terminal is starting up or
		228	being reset. Useful as a base to start when creating renditions.
		229
		230	=item $rend = urxvt::OVERLAY_RSTYLE
		231
		232	Return the rendition mask used for overlays by default.
		233
		234	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		235
		236	Return the bit that enabled bold, italic, blink, reverse-video and
		237	underline, respectively. To enable such a style, just logically OR it into
		238	the bitset.
		239
		240	=item $foreground = urxvt::GET_BASEFG $rend
		241
		242	=item $background = urxvt::GET_BASEBG $rend
		243
		244	Return the foreground/background colour index, respectively.
		245
		246	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		247
		248	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		249
		250	Replace the foreground/background colour in the rendition mask with the
		251	specified one.
		252
		253	=item $value = urxvt::GET_CUSTOM ($rend)
		254
		255	Return the "custom" value: Every rendition has 5 bits for use by
		256	extensions. They can be set and changed as you like and are initially
		257	zero.
		258
		259	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		260
		261	Change the custom value.
		262
		263	=back
198		264
199	=cut	265	=cut
200		266
201	package urxvt;	267	package urxvt;
202		268
…		…
306	return 1 if $v->($term, @_);	372	return 1 if $v->($term, @_);
307	}	373	}
308		374
309	0	375	0
310	}	376	}
311
312	=back
313		377
314	=head2 The C<urxvt::term> Class	378	=head2 The C<urxvt::term> Class
315		379
316	=over 4	380	=over 4
317		381
…		…
373		437
374	=item $oldtext = $term->selection ([$newtext])	438	=item $oldtext = $term->selection ([$newtext])
375		439
376	Return the current selection text and optionally replace it by C<$newtext>.	440	Return the current selection text and optionally replace it by C<$newtext>.
377		441
378	=item $term->scr_overlay ($x, $y, $text)	442	#=item $term->overlay ($x, $y, $text)
379		443	#
380	Create a simple multi-line overlay box. See the next method for details.	444	#Create a simple multi-line overlay box. See the next method for details.
381		445	#
382	=cut	446	#=cut
383		447
384	sub urxvt::term::scr_overlay {	448	sub urxvt::term::scr_overlay {
		449	die;
385	my ($self, $x, $y, $text) = @_;	450	my ($self, $x, $y, $text) = @_;
386		451
387	my @lines = split /\n/, $text;	452	my @lines = split /\n/, $text;
388		453
389	my $w = 0;	454	my $w = 0;
…		…
393		458
394	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	459	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
395	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	460	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
396	}	461	}
397		462
398	=item $term->scr_overlay_new ($x, $y, $width, $height)	463	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
399		464
400	Create a new (empty) overlay at the given position with the given	465	Create a new (empty) overlay at the given position with the given
401	width/height. A border will be put around the box. If either C<$x> or	466	width/height. C<$rstyle> defines the initial rendition style
402	C<$y> is negative, then this is counted from the right/bottom side,	467	(default: C<OVERLAY_RSTYLE>).
403	respectively.
404		468
405	=item $term->scr_overlay_off	469	If C<$border> is C<2> (default), then a decorative border will be put
		470	around the box.
406		471
407	Switch the overlay off again.	472	If either C<$x> or C<$y> is negative, then this is counted from the
		473	right/bottom side, respectively.
408		474
409	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	475	This method returns an urxvt::overlay object. The overlay will be visible
		476	as long as the perl object is referenced.
410		477
411	Put a single character (specified numerically) at the given overlay	478	The methods currently supported on C<urxvt::overlay> objects are:
412	position.
413		479
		480	=over 4
		481
414	=item $term->scr_overlay_set ($x, $y, $text)	482	=item $overlay->set ($x, $y, $text, $rend)
415		483
416	Write a string at the given position into the overlay.	484	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		485	text in rxvt-unicode's special encoding and an array of rendition values
		486	at a specific position inside the overlay.
		487
		488	=item $overlay->hide
		489
		490	If visible, hide the overlay, but do not destroy it.
		491
		492	=item $overlay->show
		493
		494	If hidden, display the overlay again.
		495
		496	=back
417		497
418	=item $cellwidth = $term->strwidth $string	498	=item $cellwidth = $term->strwidth $string
419		499
420	Returns the number of screen-cells this string would need. Correctly	500	Returns the number of screen-cells this string would need. Correctly
421	accounts for wide and combining characters.	501	accounts for wide and combining characters.
…		…
466	terminal line. The scrollback buffer starts at line C<-1> and extends to	546	terminal line. The scrollback buffer starts at line C<-1> and extends to
467	line C<< -$term->nsaved >>.	547	line C<< -$term->nsaved >>.
468		548
469	If C<$new_text> is specified, it will replace characters in the current	549	If C<$new_text> is specified, it will replace characters in the current
470	line, starting at column C<$start_col> (default C<0>), which is useful	550	line, starting at column C<$start_col> (default C<0>), which is useful
471	to replace only parts of a line. The font iindex in the rendition will	551	to replace only parts of a line. The font index in the rendition will
472	automatically be updated.	552	automatically be updated.
473		553
474	C<$text> is in a special encoding: tabs and wide characters that use more	554	C<$text> is in a special encoding: tabs and wide characters that use more
475	than one cell when displayed are padded with urxvt::NOCHAR characters	555	than one cell when displayed are padded with urxvt::NOCHAR characters
476	(C<chr 65535>). Characters with combining characters and other characters	556	(C<chr 65535>). Characters with combining characters and other characters
…		…
490	bitsets. Rendition bitsets contain information about colour, font, font	570	bitsets. Rendition bitsets contain information about colour, font, font
491	styles and similar information. See also C<< $term->ROW_t >>.	571	styles and similar information. See also C<< $term->ROW_t >>.
492		572
493	When setting rendition, the font mask will be ignored.	573	When setting rendition, the font mask will be ignored.
494		574
495	See the section on RENDITION, below.	575	See the section on RENDITION, above.
496		576
497	=item $length = $term->ROW_l ($row_number[, $new_length])	577	=item $length = $term->ROW_l ($row_number[, $new_length])
498		578
499	Returns the number of screen cells that are in use ("the line length"). If	579	Returns the number of screen cells that are in use ("the line length"). If
500	it is C<-1>, then the line is part of a multiple-row logical "line", which	580	it is C<-1>, then the line is part of a multiple-row logical "line", which
…		…
511	Converts rxvt-unicodes text reprsentation into a perl string. See	591	Converts rxvt-unicodes text reprsentation into a perl string. See
512	C<< $term->ROW_t >> for details.	592	C<< $term->ROW_t >> for details.
513		593
514	=back	594	=back
515		595
516	=head2 RENDITION
517
518	Rendition bitsets contain information about colour, font, font styles and
519	similar information for each screen cell.
520
521	The following "macros" deal with changes in rendition sets. You should
522	never just create a bitset, you should always modify an existing one,
523	as they contain important information required for correct operation of
524	rxvt-unicode.
525
526	=over 4
527
528	=item $rend = urxvt::DEFAULT_RSTYLE
529
530	Returns the default rendition, as used when the terminal is starting up or
531	being reset. Useful as a base
532
533	=back
534
535	=cut
536
537	=head2 The C<urxvt::timer> Class	596	=head2 The C<urxvt::timer> Class
538		597
539	This class implements timer watchers/events. Time is represented as a	598	This class implements timer watchers/events. Time is represented as a
540	fractional number of seconds since the epoch. Example:	599	fractional number of seconds since the epoch. Example:
541		600
542	# create a digital clock display in upper right corner	601	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
543	$term->{timer} = urxvt::timer	602	$term->{timer} = urxvt::timer
544	->new	603	->new
545	->start (urxvt::NOW)	604	->interval (1)
546	->cb (sub {	605	->cb (sub {
547	my ($timer) = @_;
548	my $time = $timer->at;
549	$timer->start ($time + 1);
550	$self->scr_overlay (-1, 0,	606	$term->{overlay}->set (0, 0,
551	POSIX::strftime "%H:%M:%S", localtime $time);	607	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
552	});	608	});
553		609
554	=over 4	610	=over 4
555		611
556	=item $timer = new urxvt::timer	612	=item $timer = new urxvt::timer
557		613
558	Create a new timer object in stopped state.	614	Create a new timer object in started state. It is scheduled to fire
		615	immediately.
559		616
560	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	617	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
561		618
562	Set the callback to be called when the timer triggers.	619	Set the callback to be called when the timer triggers.
563		620
…		…
566	Return the time this watcher will fire next.	623	Return the time this watcher will fire next.
567		624
568	=item $timer = $timer->set ($tstamp)	625	=item $timer = $timer->set ($tstamp)
569		626
570	Set the time the event is generated to $tstamp.	627	Set the time the event is generated to $tstamp.
		628
		629	=item $timer = $timer->interval ($interval)
		630
		631	Normally (and when C<$interval> is C<0>), the timer will automatically
		632	stop after it has fired once. If C<$interval> is non-zero, then the timer
		633	is automatically rescheduled at the given intervals.
571		634
572	=item $timer = $timer->start	635	=item $timer = $timer->start
573		636
574	Start the timer.	637	Start the timer.
575		638

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.17 by root, Tue Jan 3 01:45:03 2006 UTC vs. Revision 1.22 by root, Tue Jan 3 19:10:54 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.17 by root, Tue Jan 3 01:45:03 2006 UTC vs.
Revision 1.22 by root, Tue Jan 3 19:10:54 2006 UTC