comparison man/lispref/specifiers.texi @ 408:501cfd01ee6d r21-2-34

Import from CVS: tag r21-2-34
author cvs
date Mon, 13 Aug 2007 11:18:11 +0200
parents 74fd4e045ea6
children 697ef44129c6
comparison
equal deleted inserted replaced
407:ed6218a7d4d3 408:501cfd01ee6d
701 A specifier tag set is an entity that is attached to an instantiator 701 A specifier tag set is an entity that is attached to an instantiator
702 and can be used to restrict the scope of that instantiator to a 702 and can be used to restrict the scope of that instantiator to a
703 particular device class or device type and/or to mark instantiators 703 particular device class or device type and/or to mark instantiators
704 added by a particular package so that they can be later removed. 704 added by a particular package so that they can be later removed.
705 705
706 A specifier tag set consists of a list of zero of more specifier tags, 706 A specifier tag set consists of a list of zero or more specifier tags,
707 each of which is a symbol that is recognized by XEmacs as a tag. (The 707 each of which is a symbol that is recognized by XEmacs as a tag. (The
708 valid device types and device classes are always tags, as are any tags 708 valid device types and device classes are always tags, as are any tags
709 defined by @code{define-specifier-tag}.) It is called a ``tag set'' (as 709 defined by @code{define-specifier-tag}.) It is called a ``tag set'' (as
710 opposed to a list) because the order of the tags or the number of times 710 opposed to a list) because the order of the tags or the number of times
711 a particular tag occurs does not matter. 711 a particular tag occurs does not matter.
932 of the symbols @code{generic}, @code{integer}, @code{natnum}, 932 of the symbols @code{generic}, @code{integer}, @code{natnum},
933 @code{boolean}, @code{color}, @code{font}, @code{image}, 933 @code{boolean}, @code{color}, @code{font}, @code{image},
934 @code{face-boolean}, or @code{toolbar}. 934 @code{face-boolean}, or @code{toolbar}.
935 935
936 For more information on particular types of specifiers, see the 936 For more information on particular types of specifiers, see the
937 functions @code{generic-specifier-p}, @code{integer-specifier-p}, 937 functions @code{make-generic-specifier}, @code{make-integer-specifier},
938 @code{natnum-specifier-p}, @code{boolean-specifier-p}, 938 @code{make-natnum-specifier}, @code{make-boolean-specifier},
939 @code{color-specifier-p}, @code{font-specifier-p}, 939 @code{make-color-specifier}, @code{make-font-specifier},
940 @code{image-specifier-p}, @code{face-boolean-specifier-p}, and 940 @code{make-image-specifier}, @code{make-face-boolean-specifier}, and
941 @code{toolbar-specifier-p}. 941 @code{make-toolbar-specifier}.
942 @end defun 942 @end defun
943 943
944 @defun make-specifier-and-init type spec-list &optional dont-canonicalize 944 @defun make-specifier-and-init type spec-list &optional dont-canonicalize
945 This function creates and initialize a new specifier. 945 This function creates and initialize a new specifier.
946 946
952 however, if optional argument @var{dont-canonicalize} is non-@code{nil}, 952 however, if optional argument @var{dont-canonicalize} is non-@code{nil},
953 this conversion is not performed, and the @var{spec-list} must already 953 this conversion is not performed, and the @var{spec-list} must already
954 be in full form. See @code{canonicalize-spec-list}. 954 be in full form. See @code{canonicalize-spec-list}.
955 @end defun 955 @end defun
956 956
957 @defun make-integer-specifier spec-list
958
959 Return a new @code{integer} specifier object with the given
960 specification list. @var{spec-list} can be a list of specifications
961 (each of which is a cons of a locale and a list of instantiators), a
962 single instantiator, or a list of instantiators.
963
964 Valid instantiators for integer specifiers are integers.
965 @end defun
966
967 @defun make-boolean-specifier spec-list
968
969 Return a new @code{boolean} specifier object with the given
970 specification list. @var{spec-list} can be a list of specifications
971 (each of which is a cons of a locale and a list of instantiators), a
972 single instantiator, or a list of instantiators.
973
974 Valid instantiators for boolean specifiers are @code{t} and @code{nil}.
975 @end defun
976
977 @defun make-natnum-specifier spec-list
978
979 Return a new @code{natnum} specifier object with the given specification
980 list. @var{spec-list} can be a list of specifications (each of which is
981 a cons of a locale and a list of instantiators), a single instantiator,
982 or a list of instantiators.
983
984 Valid instantiators for natnum specifiers are non-negative integers.
985 @end defun
986
987 @defun make-generic-specifier spec-list
988
989 Return a new @code{generic} specifier object with the given
990 specification list. @var{spec-list} can be a list of specifications
991 (each of which is a cons of a locale and a list of instantiators), a
992 single instantiator, or a list of instantiators.
993
994 Valid instantiators for generic specifiers are all Lisp values. They
995 are returned back unchanged when a specifier is instantiated.
996 @end defun
997
998 @defun make-display-table-specifier spec-list
999
1000 Return a new @code{display-table} specifier object with the given spec
1001 list. @var{spec-list} can be a list of specifications (each of which is
1002 a cons of a locale and a list of instantiators), a single instantiator,
1003 or a list of instantiators.
1004
1005 Valid instantiators for display-table specifiers are described in detail
1006 in the doc string for @code{current-display-table} (@pxref{Active
1007 Display Table}).
1008 @end defun
1009
957 @node Specifier Validation Functions 1010 @node Specifier Validation Functions
958 @section Functions for Checking the Validity of Specifier Components 1011 @section Functions for Checking the Validity of Specifier Components
959 1012
960 @defun valid-specifier-domain-p domain 1013 @defun valid-specifier-domain-p domain
961 This function returns non-@code{nil} if @var{domain} is a valid 1014 This function returns non-@code{nil} if @var{domain} is a valid