Mercurial > hg > xemacs-beta

comparison man/lispref/glyphs.texi @ 404:2f8bb876ab1d r21-2-32

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r21-2-32
author cvs
date Mon, 13 Aug 2007 11:16:07 +0200
parents 74fd4e045ea6
children 501cfd01ee6d
comparison
equal deleted inserted replaced
403:9f011ab08d48 404:2f8bb876ab1d
460 i.e. a format symbol followed by zero or more alternating keyword-value 460 i.e. a format symbol followed by zero or more alternating keyword-value
461 pairs. The @dfn{format} field should be a symbol, one of 461 pairs. The @dfn{format} field should be a symbol, one of
462 462
463 @table @code 463 @table @code
464 @item nothing 464 @item nothing
465 (Don't display anything; no keywords are valid for this. Can only be 465 Don't display anything; no keywords are valid for this. Can only be
466 instanced as @code{nothing}.) 466 instanced as @code{nothing}.
467 @item string 467 @item string
468 (Display this image as a text string. Can only be instanced 468 Display this image as a text string. Can only be instanced
469 as @code{text}, although support for instancing as @code{mono-pixmap} 469 as @code{text}, although support for instancing as @code{mono-pixmap}
470 should be added.) 470 should be added.
471 @item formatted-string 471 @item formatted-string
472 (Display this image as a text string with replaceable fields, 472 Display this image as a text string with replaceable fields,
473 similar to a modeline format string; not currently implemented.) 473 similar to a modeline format string; not currently implemented.
474 @item xbm 474 @item xbm
475 (An X bitmap; only if X support was compiled into this XEmacs. Can be 475 An X bitmap; only if X support was compiled into this XEmacs. Can be
476 instanced as @code{mono-pixmap}, @code{color-pixmap}, or 476 instanced as @code{mono-pixmap}, @code{color-pixmap}, or
477 @code{pointer}.) 477 @code{pointer}.
478 @item xpm 478 @item xpm
479 (An XPM pixmap; only if XPM support was compiled into this XEmacs. Can 479 An XPM pixmap; only if XPM support was compiled into this XEmacs. Can
480 be instanced as @code{color-pixmap}, @code{mono-pixmap}, or 480 be instanced as @code{color-pixmap}, @code{mono-pixmap}, or
481 @code{pointer}. XPM is an add-on library for X that was designed to 481 @code{pointer}. XPM is an add-on library for X that was designed to
482 rectify the shortcomings of the XBM format. Most implementations of X 482 rectify the shortcomings of the XBM format. Most implementations of X
483 include the XPM library as a standard part. If your vendor does not, it 483 include the XPM library as a standard part. If your vendor does not, it
484 is highly recommended that you download it and install it. You can get 484 is highly recommended that you download it and install it. You can get
485 it from the standard XEmacs FTP site, among other places.) 485 it from the standard XEmacs FTP site, among other places.
486 @item xface 486 @item xface
487 (An X-Face bitmap, used to encode people's faces in e-mail messages; 487 An X-Face bitmap, used to encode people's faces in e-mail messages;
488 only if X-Face support was compiled into this XEmacs. Can be instanced 488 only if X-Face support was compiled into this XEmacs. Can be instanced
489 as @code{mono-pixmap}, @code{color-pixmap}, or @code{pointer}.) 489 as @code{mono-pixmap}, @code{color-pixmap}, or @code{pointer}.
490 @item gif 490 @item gif
491 (A GIF87 or GIF89 image; only if GIF support was compiled into this 491 A GIF87 or GIF89 image; only if GIF support was compiled into this
492 XEmacs. Can be instanced as @code{color-pixmap}. Note that XEmacs 492 XEmacs. Can be instanced as @code{color-pixmap}. Note that XEmacs
493 includes GIF decoding functions as a standard part of it, so if you have 493 includes GIF decoding functions as a standard part of it, so if you have
494 X support, you will normally have GIF support, unless you explicitly 494 X support, you will normally have GIF support, unless you explicitly
495 disable it at configure time.) 495 disable it at configure time.
496 @item jpeg 496 @item jpeg
497 (A JPEG-format image; only if JPEG support was compiled into this 497 A JPEG-format image; only if JPEG support was compiled into this
498 XEmacs. Can be instanced as @code{color-pixmap}. If you have the JPEG 498 XEmacs. Can be instanced as @code{color-pixmap}. If you have the JPEG
499 libraries present on your system when XEmacs is built, XEmacs will 499 libraries present on your system when XEmacs is built, XEmacs will
500 automatically detect this and use them, unless you explicitly disable it 500 automatically detect this and use them, unless you explicitly disable it
501 at configure time.) 501 at configure time.
502 @item png 502 @item png
503 (A PNG/GIF24 image; only if PNG support was compiled into this XEmacs. 503 A PNG/GIF24 image; only if PNG support was compiled into this XEmacs.
504 Can be instanced as @code{color-pixmap}.) 504 Can be instanced as @code{color-pixmap}.
505 @item tiff 505 @item tiff
506 (A TIFF-format image; only if TIFF support was compiled into this XEmacs. 506 A TIFF-format image; only if TIFF support was compiled into this XEmacs.
507 Not currently implemented.)
508 @item cursor-font 507 @item cursor-font
509 (One of the standard cursor-font names, such as @samp{watch} or 508 One of the standard cursor-font names, such as @samp{watch} or
510 @samp{right_ptr} under X. Under X, this is, more specifically, any of 509 @samp{right_ptr} under X. Under X, this is, more specifically, any of
511 the standard cursor names from appendix B of the Xlib manual [also known 510 the standard cursor names from appendix B of the Xlib manual [also known
512 as the file @file{<X11/cursorfont.h>}] minus the @samp{XC_} prefix. On 511 as the file @file{<X11/cursorfont.h>}] minus the @samp{XC_} prefix. On
513 other window systems, the valid names will be specific to the type of 512 other window systems, the valid names will be specific to the type of
514 window system. Can only be instanced as @code{pointer}.) 513 window system. Can only be instanced as @code{pointer}.
515 @item font 514 @item font
516 (A glyph from a font; i.e. the name of a font, and glyph index into it 515 A glyph from a font; i.e. the name of a font, and glyph index into it
517 of the form @samp{@var{font} fontname index [[mask-font] mask-index]}. 516 of the form @samp{@var{font} fontname index [[mask-font] mask-index]}.
518 Only if X support was compiled into this XEmacs. Currently can only be 517 Only if X support was compiled into this XEmacs. Currently can only be
519 instanced as @code{pointer}, although this should probably be fixed.) 518 instanced as @code{pointer}, although this should probably be fixed.
520 @item subwindow 519 @item subwindow
521 (An embedded X window; not currently implemented.) 520 An embedded X window; not currently implemented.
522 @item autodetect 521 @item autodetect
523 (XEmacs tries to guess what format the data is in. If X support exists, 522 XEmacs tries to guess what format the data is in. If X support exists,
524 the data string will be checked to see if it names a filename. If so, 523 the data string will be checked to see if it names a filename. If so,
525 and this filename contains XBM or XPM data, the appropriate sort of 524 and this filename contains XBM or XPM data, the appropriate sort of
526 pixmap or pointer will be created. [This includes picking up any 525 pixmap or pointer will be created. [This includes picking up any
527 specified hotspot or associated mask file.] Otherwise, if @code{pointer} 526 specified hotspot or associated mask file.] Otherwise, if @code{pointer}
528 is one of the allowable image-instance types and the string names a 527 is one of the allowable image-instance types and the string names a
529 valid cursor-font name, the image will be created as a pointer. 528 valid cursor-font name, the image will be created as a pointer.
530 Otherwise, the image will be displayed as text. If no X support exists, 529 Otherwise, the image will be displayed as text. If no X support exists,
531 the image will always be displayed as text.) 530 the image will always be displayed as text.
532 @end table 531 @end table
533 532
534 The valid keywords are: 533 The valid keywords are:
535 534
536 @table @code 535 @table @code
537 @item :data 536 @item :data
538 (Inline data. For most formats above, this should be a string. For 537 Inline data. For most formats above, this should be a string. For
539 XBM images, this should be a list of three elements: width, height, and 538 XBM images, this should be a list of three elements: width, height, and
540 a string of bit data. This keyword is not valid for instantiator 539 a string of bit data. This keyword is not valid for instantiator
541 format @code{nothing}.) 540 format @code{nothing}.
542 541
543 @item :file 542 @item :file
544 (Data is contained in a file. The value is the name of this file. If 543 Data is contained in a file. The value is the name of this file. If
545 both @code{:data} and @code{:file} are specified, the image is created 544 both @code{:data} and @code{:file} are specified, the image is created
546 from what is specified in @code{:data} and the string in @code{:file} 545 from what is specified in @code{:data} and the string in @code{:file}
547 becomes the value of the @code{image-instance-file-name} function when 546 becomes the value of the @code{image-instance-file-name} function when
548 applied to the resulting image-instance. This keyword is not valid for 547 applied to the resulting image-instance. This keyword is not valid for
549 instantiator formats @code{nothing}, @code{string}, 548 instantiator formats @code{nothing}, @code{string},
550 @code{formatted-string}, @code{cursor-font}, @code{font}, and 549 @code{formatted-string}, @code{cursor-font}, @code{font}, and
551 @code{autodetect}.) 550 @code{autodetect}.
552 551
553 @item :foreground 552 @item :foreground
554 @itemx :background 553 @itemx :background
555 (For @code{xbm}, @code{xface}, @code{cursor-font}, and @code{font}. 554 For @code{xbm}, @code{xface}, @code{cursor-font}, and @code{font}.
556 These keywords allow you to explicitly specify foreground and background 555 These keywords allow you to explicitly specify foreground and background
557 colors. The argument should be anything acceptable to 556 colors. The argument should be anything acceptable to
558 @code{make-color-instance}. This will cause what would be a 557 @code{make-color-instance}. This will cause what would be a
559 @code{mono-pixmap} to instead be colorized as a two-color color-pixmap, 558 @code{mono-pixmap} to instead be colorized as a two-color color-pixmap,
560 and specifies the foreground and/or background colors for a pointer 559 and specifies the foreground and/or background colors for a pointer
561 instead of black and white.) 560 instead of black and white.
562 561
563 @item :mask-data 562 @item :mask-data
564 (For @code{xbm} and @code{xface}. This specifies a mask to be used with the 563 For @code{xbm} and @code{xface}. This specifies a mask to be used with the
565 bitmap. The format is a list of width, height, and bits, like for 564 bitmap. The format is a list of width, height, and bits, like for
566 @code{:data}.) 565 @code{:data}.
567 566
568 @item :mask-file 567 @item :mask-file
569 (For @code{xbm} and @code{xface}. This specifies a file containing the 568 For @code{xbm} and @code{xface}. This specifies a file containing the
570 mask data. If neither a mask file nor inline mask data is given for an 569 mask data. If neither a mask file nor inline mask data is given for an
571 XBM image, and the XBM image comes from a file, XEmacs will look for a 570 XBM image, and the XBM image comes from a file, XEmacs will look for a
572 mask file with the same name as the image file but with @samp{Mask} or 571 mask file with the same name as the image file but with @samp{Mask} or
573 @samp{msk} appended. For example, if you specify the XBM file 572 @samp{msk} appended. For example, if you specify the XBM file
574 @file{left_ptr} [usually located in @file{/usr/include/X11/bitmaps}], 573 @file{left_ptr} [usually located in @file{/usr/include/X11/bitmaps}],
575 the associated mask file @file{left_ptrmsk} will automatically be picked 574 the associated mask file @file{left_ptrmsk} will automatically be picked
576 up.) 575 up.
577 576
578 @item :hotspot-x 577 @item :hotspot-x
579 @itemx :hotspot-y 578 @itemx :hotspot-y
580 (For @code{xbm} and @code{xface}. These keywords specify a hotspot if 579 For @code{xbm} and @code{xface}. These keywords specify a hotspot if
581 the image is instantiated as a @code{pointer}. Note that if the XBM 580 the image is instantiated as a @code{pointer}. Note that if the XBM
582 image file specifies a hotspot, it will automatically be picked up if no 581 image file specifies a hotspot, it will automatically be picked up if no
583 explicit hotspot is given.) 582 explicit hotspot is given.
584 583
585 @item :color-symbols 584 @item :color-symbols
586 (Only for @code{xpm}. This specifies an alist that maps strings that 585 Only for @code{xpm}. This specifies an alist that maps strings that
587 specify symbolic color names to the actual color to be used for that 586 specify symbolic color names to the actual color to be used for that
588 symbolic color (in the form of a string or a color-specifier object). 587 symbolic color (in the form of a string or a color-specifier object).
589 If this is not specified, the contents of @code{xpm-color-symbols} are 588 If this is not specified, the contents of @code{xpm-color-symbols} are
590 used to generate the alist.) 589 used to generate the alist.
591 @end table 590 @end table
592 591
593 If instead of a vector, the instantiator is a string, it will be 592 If instead of a vector, the instantiator is a string, it will be
594 converted into a vector by looking it up according to the specs in the 593 converted into a vector by looking it up according to the specs in the
595 @code{console-type-image-conversion-list} for the console type of 594 @code{console-type-image-conversion-list} for the console type of