diff options
| author | Richard M. Stallman | 2001-03-12 03:45:12 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2001-03-12 03:45:12 +0000 |
| commit | 2cd8656efc8a0e1a291b9e04f19ac5c049560822 (patch) | |
| tree | e1be2e6026932dcbc0838e9700c6959122b1f429 /lispref | |
| parent | 0e824f4f0080f8a382717613094f88462b8ca00e (diff) | |
| download | emacs-2cd8656efc8a0e1a291b9e04f19ac5c049560822.tar.gz emacs-2cd8656efc8a0e1a291b9e04f19ac5c049560822.zip | |
Move :file, :data and :margin first in the table
of subproperties of `image' property.
Diffstat (limited to 'lispref')
| -rw-r--r-- | lispref/display.texi | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/lispref/display.texi b/lispref/display.texi index 23f826a56ec..2c896841593 100644 --- a/lispref/display.texi +++ b/lispref/display.texi | |||
| @@ -2450,6 +2450,31 @@ XPM format. | |||
| 2450 | types: | 2450 | types: |
| 2451 | 2451 | ||
| 2452 | @table @code | 2452 | @table @code |
| 2453 | @item :file @var{file} | ||
| 2454 | The @code{:file} property specifies to load the image from file | ||
| 2455 | @var{file}. If @var{file} is not an absolute file name, it is expanded | ||
| 2456 | in @code{data-directory}. | ||
| 2457 | |||
| 2458 | @item :data @var{data} | ||
| 2459 | The @code{:data} property specifies the actual contents of the image. | ||
| 2460 | Each image must use either @code{:data} or @code{:file}, but not both. | ||
| 2461 | For most image types, the value of the @code{:data} property should be a | ||
| 2462 | string containing the image data; we recommend using a unibyte string. | ||
| 2463 | |||
| 2464 | Before using @code{:data}, look for further information in the section | ||
| 2465 | below describing the specific image format. For some image types, | ||
| 2466 | @code{:data} may not be supported; for some, it allows other data types; | ||
| 2467 | for some, @code{:data} alone is not enough, so you need to use other | ||
| 2468 | image properties along with @code{:data}. | ||
| 2469 | |||
| 2470 | @item :margin @var{margin} | ||
| 2471 | The @code{:margin} property specifies how many pixels to add as an | ||
| 2472 | extra margin around the image. The value, @var{margin}, must be a a | ||
| 2473 | non-negative number, or a pair @code{(@var{x} . @var{y})} of such | ||
| 2474 | numbers. If it is a pair, @var{x} specifies how many pixels to add | ||
| 2475 | horizontally, and @var{y} specifies how many pixels to add vertically. | ||
| 2476 | If @code{:margin} is not specified, the default is zero. | ||
| 2477 | |||
| 2453 | @item :ascent @var{ascent} | 2478 | @item :ascent @var{ascent} |
| 2454 | The @code{:ascent} property specifies the amount of the image's | 2479 | The @code{:ascent} property specifies the amount of the image's |
| 2455 | height to use for its ascent---that is, the part above the baseline. | 2480 | height to use for its ascent---that is, the part above the baseline. |
| @@ -2466,14 +2491,6 @@ properties and overlays that apply to the image. | |||
| 2466 | 2491 | ||
| 2467 | If this property is omitted, it defaults to 50. | 2492 | If this property is omitted, it defaults to 50. |
| 2468 | 2493 | ||
| 2469 | @item :margin @var{margin} | ||
| 2470 | The @code{:margin} property specifies how many pixels to add as an | ||
| 2471 | extra margin around the image. The value, @var{margin}, must be a | ||
| 2472 | non-negative number, or a pair @code{(@var{x} . @var{y})} of such | ||
| 2473 | numbers. If it is a pair, @var{x} specifies how many pixels to add | ||
| 2474 | horizontally, and @var{y} specifies how many pixels to add vertically. | ||
| 2475 | If @code{:margin} is not specified, the default is zero. | ||
| 2476 | |||
| 2477 | @item :relief @var{relief} | 2494 | @item :relief @var{relief} |
| 2478 | The @code{:relief} property, if non-@code{nil}, adds a shadow rectangle | 2495 | The @code{:relief} property, if non-@code{nil}, adds a shadow rectangle |
| 2479 | around the image. The value, @var{relief}, specifies the width of the | 2496 | around the image. The value, @var{relief}, specifies the width of the |
| @@ -2572,23 +2589,6 @@ specifying the color to assume for the background of the image. | |||
| 2572 | If @var{mask} is nil, remove a mask from the image, if it has one. Images | 2589 | If @var{mask} is nil, remove a mask from the image, if it has one. Images |
| 2573 | in some formats include a mask which can be removed by specifying | 2590 | in some formats include a mask which can be removed by specifying |
| 2574 | @code{:mask nil}. | 2591 | @code{:mask nil}. |
| 2575 | |||
| 2576 | @item :file @var{file} | ||
| 2577 | The @code{:file} property specifies to load the image from file | ||
| 2578 | @var{file}. If @var{file} is not an absolute file name, it is expanded | ||
| 2579 | in @code{data-directory}. | ||
| 2580 | |||
| 2581 | @item :data @var{data} | ||
| 2582 | The @code{:data} property specifies the actual contents of the image. | ||
| 2583 | Each image must use either @code{:data} or @code{:file}, but not both. | ||
| 2584 | For most image types, the value of the @code{:data} property should be a | ||
| 2585 | string containing the image data; we recommend using a unibyte string. | ||
| 2586 | |||
| 2587 | Before using @code{:data}, look for further information in the section | ||
| 2588 | below describing the specific image format. For some image types, | ||
| 2589 | @code{:data} may not be supported; for some, it allows other data types; | ||
| 2590 | for some, @code{:data} alone is not enough, so you need to use other | ||
| 2591 | image properties along with @code{:data}. | ||
| 2592 | @end table | 2592 | @end table |
| 2593 | 2593 | ||
| 2594 | @defun image-mask-p spec &optional frame | 2594 | @defun image-mask-p spec &optional frame |