comparison man/lispref/extents.texi @ 207:e45d5e7c476e r20-4b2

Import from CVS: tag r20-4b2
author cvs
date Mon, 13 Aug 2007 10:03:52 +0200
parents 0d2f883870bc
children 78478c60bfcd
comparison
equal deleted inserted replaced
206:d3e9274cbc4e 207:e45d5e7c476e
479 @var{property} has a predefined meaning, only certain values are 479 @var{property} has a predefined meaning, only certain values are
480 allowed, and some values may be converted to others before being 480 allowed, and some values may be converted to others before being
481 stored.) 481 stored.)
482 @end defun 482 @end defun
483 483
484 @defun set-extent-properties extent plist
485 Change some properties of @var{extent}. @var{plist} is a property
486 list. This is useful to change many extent properties at once.
487 @end defun
488
484 The following table lists the properties with predefined meanings, along 489 The following table lists the properties with predefined meanings, along
485 with their allowable values. 490 with their allowable values.
486 491
487 @table @code 492 @table @code
488 @item detached 493 @item detached
592 597
593 @item end-glyph-layout 598 @item end-glyph-layout
594 (@code{text}, @code{whitespace}, @code{inside-margin}, or 599 (@code{text}, @code{whitespace}, @code{inside-margin}, or
595 @code{outside-margin}) The layout policy for this extent's end glyph. 600 @code{outside-margin}) The layout policy for this extent's end glyph.
596 Defaults to @code{text}. @xref{Annotations}. 601 Defaults to @code{text}. @xref{Annotations}.
602
603 @item initial-redisplay-function
604 (any funcallable object) The function to be called the first time (a
605 part of) the extent is redisplayed. It will be called with the extent
606 as its argument.
607
608 This is used by @code{lazy-shot} to implement lazy font-locking. The
609 functionality is still experimental, and may change without further
610 notice.
597 @end table 611 @end table
598 612
599 The following convenience functions are provided for accessing 613 The following convenience functions are provided for accessing
600 particular properties of an extent. 614 particular properties of an extent.
601 615
666 @var{face}. 680 @var{face}.
667 @end defun 681 @end defun
668 682
669 @defun set-extent-keymap extent keymap 683 @defun set-extent-keymap extent keymap
670 This function sets the @code{keymap} property of @var{extent} to 684 This function sets the @code{keymap} property of @var{extent} to
671 @var{keymap}. 685 @var{keymap}. @var{keymap} must be either a keymap object, or
686 @code{nil}.
672 @end defun 687 @end defun
673 688
674 @defun set-extent-begin-glyph-layout extent layout 689 @defun set-extent-begin-glyph-layout extent layout
675 This function sets the @code{begin-glyph-layout} property of 690 This function sets the @code{begin-glyph-layout} property of
676 @var{extent} to @var{layout}. 691 @var{extent} to @var{layout}.
689 704
690 @defun set-extent-end-glyph extent end-glyph &optional layout 705 @defun set-extent-end-glyph extent end-glyph &optional layout
691 This function sets the @code{end-glyph} and @code{glyph-layout} 706 This function sets the @code{end-glyph} and @code{glyph-layout}
692 properties of @var{extent} to @var{end-glyph} and @var{layout}, 707 properties of @var{extent} to @var{end-glyph} and @var{layout},
693 respectively. (@var{layout} defaults to @code{text} if not specified.) 708 respectively. (@var{layout} defaults to @code{text} if not specified.)
709 @end defun
710
711 @defun set-extent-initial-redisplay-function extent function
712 This function sets the @code{initial-redisplay-function} property of the
713 extent to @var{function}.
694 @end defun 714 @end defun
695 715
696 @node Detached Extents 716 @node Detached Extents
697 @section Detached Extents 717 @section Detached Extents
698 @cindex detached extent 718 @cindex detached extent