comparison src/extents.c @ 1041:ffabf70273fe

[xemacs-hg @ 2002-10-08 05:44:07 by youngs] 2002-09-21 Stephen J. Turnbull <stephen@xemacs.org> * extents.c (Fset_extent_property): Document `syntax-table' property.
author youngs
date Tue, 08 Oct 2002 05:44:15 +0000
parents bb19cebf6809
children e22b0213b713
comparison
equal deleted inserted replaced
1040:5323022ae863 1041:ffabf70273fe
5386 5386
5387 initial-redisplay-function (EXPERIMENTAL) 5387 initial-redisplay-function (EXPERIMENTAL)
5388 function to be called the first time (part of) the extent 5388 function to be called the first time (part of) the extent
5389 is redisplayed. It will be called with the extent as its 5389 is redisplayed. It will be called with the extent as its
5390 first argument. 5390 first argument.
5391 Note: The function will not be called immediately 5391 Note: The function will not be called immediately
5392 during redisplay, an eval event will be dispatched. 5392 during redisplay, an eval event will be dispatched.
5393 5393
5394 detachable Whether the extent gets detached (as with 5394 detachable Whether the extent gets detached (as with
5395 `detach-extent') when all the text within the 5395 `detach-extent') when all the text within the
5396 extent is deleted. This is true by default. If 5396 extent is deleted. This is true by default. If
5397 this property is not set, the extent becomes a 5397 this property is not set, the extent becomes a
5402 extents open on both ends are not allowed.) 5402 extents open on both ends are not allowed.)
5403 5403
5404 face The face in which to display the text. Setting 5404 face The face in which to display the text. Setting
5405 this is the same as calling `set-extent-face'. 5405 this is the same as calling `set-extent-face'.
5406 5406
5407 mouse-face If non-nil, the extent will be highlighted in this 5407 mouse-face If non-nil, the extent will be highlighted in this
5408 face when the mouse moves over it. 5408 face when the mouse moves over it.
5409 5409
5410 pointer If non-nil, and a valid pointer glyph, this specifies 5410 pointer If non-nil, and a valid pointer glyph, this specifies
5411 the shape of the mouse pointer while over the extent. 5411 the shape of the mouse pointer while over the extent.
5412 5412
5413 highlight Obsolete: Setting this property is equivalent to 5413 highlight Obsolete: Setting this property is equivalent to
5414 setting a `mouse-face' property of `highlight'. 5414 setting a `mouse-face' property of `highlight'.
5415 Reading this property returns non-nil if 5415 Reading this property returns non-nil if
5416 the extent has a non-nil `mouse-face' property. 5416 the extent has a non-nil `mouse-face' property.
5417 5417
5418 duplicable Whether this extent should be copied into strings, 5418 duplicable Whether this extent should be copied into strings,
5419 so that kill, yank, and undo commands will restore 5419 so that kill, yank, and undo commands will restore
5420 or copy it. `duplicable' extents are copied from 5420 or copy it. `duplicable' extents are copied from
5421 an extent into a string when `buffer-substring' or 5421 an extent into a string when `buffer-substring' or
5486 5486
5487 begin-glyph-layout The layout policy (one of `text', `whitespace', 5487 begin-glyph-layout The layout policy (one of `text', `whitespace',
5488 `inside-margin', or `outside-margin') of the extent's 5488 `inside-margin', or `outside-margin') of the extent's
5489 begin glyph. 5489 begin glyph.
5490 5490
5491 end-glyph-layout The layout policy of the extent's end glyph. 5491 end-glyph-layout The layout policy of the extent's end glyph.
5492
5493 syntax-table A cons or a syntax table object. If a cons, the car must
5494 be an integer (interpreted as a syntax code, applicable to
5495 all characters in the extent). Otherwise, syntax of
5496 characters in the extent is looked up in the syntax table.
5497 You should use the text property API to manipulate this
5498 property. (This may be required in the future.)
5492 */ 5499 */
5493 (extent, property, value)) 5500 (extent, property, value))
5494 { 5501 {
5495 /* This function can GC if property is `keymap' */ 5502 /* This function can GC if property is `keymap' */
5496 EXTENT e = decode_extent (extent, 0); 5503 EXTENT e = decode_extent (extent, 0);