Mercurial > emacs
comparison doc/lispref/display.texi @ 85004:b516a4e62b87
(Overlay Properties): Explain nil as priority. Explain that conflicts
are unpredictable if not resolved by priorities.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Mon, 01 Oct 2007 21:19:18 +0000 |
parents | 0ba80d073e27 |
children | bbb0d5d8d60f |
comparison
equal
deleted
inserted
replaced
85003:155b89cb60fb | 85004:b516a4e62b87 |
---|---|
1289 Changing a buffer's text properties marks the buffer as modified, | 1289 Changing a buffer's text properties marks the buffer as modified, |
1290 while moving an overlay or changing its properties does not. Unlike | 1290 while moving an overlay or changing its properties does not. Unlike |
1291 text property changes, overlay property changes are not recorded in | 1291 text property changes, overlay property changes are not recorded in |
1292 the buffer's undo list. | 1292 the buffer's undo list. |
1293 | 1293 |
1294 Since more than one overlay can specify a property value for the | |
1295 same character, Emacs lets you specify a priority value of each | |
1296 overlay. You should not make assumptions about which overlay will | |
1297 prevail when there is a conflict and they have the same priority. | |
1298 | |
1294 These functions read and set the properties of an overlay: | 1299 These functions read and set the properties of an overlay: |
1295 | 1300 |
1296 @defun overlay-get overlay prop | 1301 @defun overlay-get overlay prop |
1297 This function returns the value of property @var{prop} recorded in | 1302 This function returns the value of property @var{prop} recorded in |
1298 @var{overlay}, if any. If @var{overlay} does not record any value for | 1303 @var{overlay}, if any. If @var{overlay} does not record any value for |
1319 | 1324 |
1320 @table @code | 1325 @table @code |
1321 @item priority | 1326 @item priority |
1322 @kindex priority @r{(overlay property)} | 1327 @kindex priority @r{(overlay property)} |
1323 This property's value (which should be a nonnegative integer number) | 1328 This property's value (which should be a nonnegative integer number) |
1324 determines the priority of the overlay. The priority matters when two | 1329 determines the priority of the overlay. No priority, or @code{nil}, |
1325 or more overlays cover the same character and both specify the same | 1330 means zero. |
1326 property; the one whose @code{priority} value is larger takes priority | 1331 |
1327 over the other. For the @code{face} property, the higher priority | 1332 The priority matters when two or more overlays cover the same |
1328 value does not completely replace the other; instead, its face | 1333 character and both specify the same property; the one whose |
1329 attributes override the face attributes of the lower priority | 1334 @code{priority} value is larger overrides the other. For the |
1330 @code{face} property. | 1335 @code{face} property, the higher priority overlay's value does not |
1336 completely override the other value; instead, its face attributes | |
1337 override the face attributes of the lower priority @code{face} | |
1338 property. | |
1331 | 1339 |
1332 Currently, all overlays take priority over text properties. Please | 1340 Currently, all overlays take priority over text properties. Please |
1333 avoid using negative priority values, as we have not yet decided just | 1341 avoid using negative priority values, as we have not yet decided just |
1334 what they should mean. | 1342 what they should mean. |
1335 | 1343 |