-This is Info file ../../info/lispref.info, produced by Makeinfo version
-1.68 from the input file lispref.texi.
+This is ../info/lispref.info, produced by makeinfo version 4.0 from
+lispref/lispref.texi.
INFO-DIR-SECTION XEmacs Editor
START-INFO-DIR-ENTRY
specifier, unlike all the other built-in properties, and cannot
contain locale-specific values.
- - Function: set-face-property FACE PROPERTY VALUE &optional LOCALE TAG
- HOW-TO-ADD
+ - Function: set-face-property face property value &optional locale tag
+ how-to-add
This function changes a property of a FACE.
For built-in properties, the actual value of the property is a
If the value of the property is not a specifier, it will
automatically be converted into a `generic' specifier.
- - Function: face-property FACE PROPERTY &optional LOCALE
+ - Function: remove-face-property face property &optional local tag-set
+ exact-p
+ This function removes a property of a FACE.
+
+ For built-in properties, this is analogous to `remove-specifier'.
+ For more information, *Note Other Specification Functions::.
+
+ When PROPERTY is not a built-in property, this function will just
+ remove its value if LOCALE is `nil' or `all'. However, if LOCALE
+ is other than that, this function will attempt to remove VALUE as
+ the instantiator for the given LOCALE with `remove-specifier'. If
+ the value of the property is not a specifier, it will be converted
+ into a `generic' specifier automatically.
+
+ - Function: face-property face property &optional locale
This function returns FACE's value of the given PROPERTY.
If LOCALE is omitted, the FACE's actual value for PROPERTY will be
`face-property-instance' actually does all this, and is used to
determine how to display the face.
- - Function: face-property-instance FACE PROPERTY &optional DOMAIN
- DEFAULT NO-FALLBACK
+ - Function: face-property-instance face property &optional domain
+ default no-fallback
This function returns the instance of FACE's PROPERTY in the
specified DOMAIN.
Face Convenience Functions
--------------------------
- - Function: set-face-foreground FACE COLOR &optional LOCALE TAG
- HOW-TO-ADD
- - Function: set-face-background FACE COLOR &optional LOCALE TAG
- HOW-TO-ADD
+ - Function: set-face-foreground face color &optional locale tag
+ how-to-add
+ - Function: set-face-background face color &optional locale tag
+ how-to-add
These functions set the foreground (respectively, background)
color of face FACE to COLOR. The argument COLOR should be a
string (the name of a color) or a color object as returned by
- `make-color' (*note Colors::.).
+ `make-color' (*note Colors::).
- - Function: set-face-background-pixmap FACE PIXMAP &optional LOCALE
- TAG HOW-TO-ADD
+ - Function: set-face-background-pixmap face pixmap &optional locale
+ tag how-to-add
This function sets the background pixmap of face FACE to PIXMAP.
The argument PIXMAP should be a string (the name of a bitmap or
pixmap file; the directories listed in the variable
`x-bitmap-file-path' will be searched) or a glyph object as
- returned by `make-glyph' (*note Glyphs::.). The argument may also
+ returned by `make-glyph' (*note Glyphs::). The argument may also
be a list of the form `(WIDTH HEIGHT DATA)' where WIDTH and HEIGHT
are the size in pixels, and DATA is a string, containing the raw
bits of the bitmap.
- - Function: set-face-font FACE FONT &optional LOCALE TAG HOW-TO-ADD
+ - Function: set-face-font face font &optional locale tag how-to-add
This function sets the font of face FACE. The argument FONT
should be a string or a font object as returned by `make-font'
- (*note Fonts::.).
+ (*note Fonts::).
- - Function: set-face-underline-p FACE UNDERLINE-P &optional LOCALE TAG
- HOW-TO-ADD
+ - Function: set-face-underline-p face underline-p &optional locale tag
+ how-to-add
This function sets the underline property of face FACE.
- - Function: face-foreground FACE &optional LOCALE
- - Function: face-background FACE &optional LOCALE
+ - Function: face-foreground face &optional locale
+ - Function: face-background face &optional locale
These functions return the foreground (respectively, background)
color specifier of face FACE. *Note Colors::.
- - Function: face-background-pixmap FACE &optional LOCALE
+ - Function: face-background-pixmap face &optional locale
This function return the background-pixmap glyph object of face
FACE.
- - Function: face-font FACE &optional LOCALE
+ - Function: face-font face &optional locale
This function returns the font specifier of face FACE. (Note:
This is not the same as the function `face-font' in FSF Emacs.)
*Note Fonts::.
- - Function: face-font-name FACE &optional DOMAIN
+ - Function: face-font-name face &optional domain
This function returns the name of the font of face FACE, or `nil'
if it is unspecified. This is basically equivalent to `(font-name
(face-font FACE) DOMAIN)' except that it does not cause an error
if FACE's font is `nil'. (This function is named `face-font' in
FSF Emacs.)
- - Function: face-underline-p FACE &optional LOCALE
+ - Function: face-underline-p face &optional locale
This function returns the underline property of face FACE.
- - Function: face-foreground-instance FACE &optional DOMAIN
- - Function: face-background-instance FACE &optional DOMAIN
+ - Function: face-foreground-instance face &optional domain
+ - Function: face-background-instance face &optional domain
These functions return the foreground (respectively, background)
color specifier of face FACE. *Note Colors::.
- - Function: face-background-pixmap-instance FACE &optional DOMAIN
+ - Function: face-background-pixmap-instance face &optional domain
This function return the background-pixmap glyph object of face
FACE.
- - Function: face-font-instance FACE &optional DOMAIN
+ - Function: face-font-instance face &optional domain
This function returns the font specifier of face FACE. *Note
Fonts::.
Other Face Display Functions
----------------------------
- - Function: invert-face FACE &optional LOCALE
+ - Function: invert-face face &optional locale
Swap the foreground and background colors of face FACE. If the
face doesn't specify both foreground and background, then its
foreground and background are set to the default background and
foreground.
- - Function: face-equal FACE1 FACE2 &optional DOMAIN
+ - Function: face-equal face1 face2 &optional domain
This returns `t' if the faces FACE1 and FACE2 will display in the
same way. DOMAIN is as in `face-property-instance'.
- - Function: face-differs-from-default-p FACE &optional DOMAIN
+ - Function: face-differs-from-default-p face &optional domain
This returns `t' if the face FACE displays differently from the
default face. DOMAIN is as in `face-property-instance'.
Font Specifiers
---------------
- - Function: font-specifier-p OBJECT
+ - Function: font-specifier-p object
This predicate returns `t' if OBJECT is a font specifier, and
`nil' otherwise.
Font Instances
--------------
- - Function: font-instance-p OBJECT
+ - Function: font-instance-p object
This predicate returns `t' if OBJECT is a font instance, and `nil'
otherwise.
- - Function: make-font-instance NAME &optional DEVICE NOERROR
+ - Function: make-font-instance name &optional device noerror
This function creates a new font-instance object of the specified
name. DEVICE specifies the device this object applies to and
defaults to the selected device. An error is signalled if the
Font Instance Names
-------------------
- - Function: list-fonts PATTERN &optional DEVICE
+ - Function: list-fonts pattern &optional device
This function returns a list of font names matching the given
pattern. DEVICE specifies which device to search for names, and
defaults to the currently selected device.
- - Function: font-instance-name FONT-INSTANCE
+ - Function: font-instance-name font-instance
This function returns the name used to allocate FONT-INSTANCE.
- - Function: font-instance-truename FONT-INSTANCE
+ - Function: font-instance-truename font-instance
This function returns the canonical name of the given font
instance. Font names are patterns which may match any number of
fonts, of which the first found is used. This returns an
Font Instance Size
------------------
- - Function: x-font-size FONT
+ - Function: x-font-size font
This function returns the nominal size of the given font. This is
done by parsing its name, so it's likely to lose. X fonts can be
specified (by the user) in either pixels or 10ths of points, and
this returns the first one it finds, so you have to decide which
units the returned value is measured in yourself ...
- - Function: x-find-larger-font FONT &optional DEVICE
+ - Function: x-find-larger-font font &optional device
This function loads a new, slightly larger version of the given
font (or font name). Returns the font if it succeeds, `nil'
otherwise. If scalable fonts are available, this returns a font
which is 1 point larger. Otherwise, it returns the next larger
version of this font that is defined.
- - Function: x-find-smaller-font FONT &optional DEVICE
+ - Function: x-find-smaller-font font &optional device
This function loads a new, slightly smaller version of the given
font (or font name). Returns the font if it succeeds, `nil'
otherwise. If scalable fonts are available, this returns a font
Font Instance Characteristics
-----------------------------
- - Function: font-instance-properties FONT
+ - Function: font-instance-properties font
This function returns the properties (an alist or `nil') of
FONT-INSTANCE.
- - Function: x-make-font-bold FONT &optional DEVICE
+ - Function: x-make-font-bold font &optional device
Given an X font specification, this attempts to make a "bold" font.
If it fails, it returns `nil'.
- - Function: x-make-font-unbold FONT &optional DEVICE
+ - Function: x-make-font-unbold font &optional device
Given an X font specification, this attempts to make a non-bold
font. If it fails, it returns `nil'.
- - Function: x-make-font-italic FONT &optional DEVICE
+ - Function: x-make-font-italic font &optional device
Given an X font specification, this attempts to make an "italic"
font. If it fails, it returns `nil'.
- - Function: x-make-font-unitalic FONT &optional DEVICE
+ - Function: x-make-font-unitalic font &optional device
Given an X font specification, this attempts to make a non-italic
font. If it fails, it returns `nil'.
- - Function: x-make-font-bold-italic FONT &optional DEVICE
+ - Function: x-make-font-bold-italic font &optional device
Given an X font specification, this attempts to make a
"bold-italic" font. If it fails, it returns `nil'.
Font Convenience Functions
--------------------------
- - Function: font-name FONT &optional DOMAIN
+ - Function: font-name font &optional domain
This function returns the name of the FONT in the specified
DOMAIN, if any. FONT should be a font specifier object and DOMAIN
is normally a window and defaults to the selected window if
omitted. This is equivalent to using `specifier-instance' and
applying `font-instance-name' to the result.
- - Function: font-truename FONT &optional DOMAIN
+ - Function: font-truename font &optional domain
This function returns the truename of the FONT in the specified
DOMAIN, if any. FONT should be a font specifier object and DOMAIN
is normally a window and defaults to the selected window if
omitted. This is equivalent to using `specifier-instance' and
applying `font-instance-truename' to the result.
- - Function: font-properties FONT &optional DOMAIN
+ - Function: font-properties font &optional domain
This function returns the properties of the FONT in the specified
DOMAIN, if any. FONT should be a font specifier object and DOMAIN
is normally a window and defaults to the selected window if
Color Specifiers
----------------
- - Function: color-specifier-p OBJECT
+ - Function: color-specifier-p object
This function returns non-`nil' if OBJECT is a color specifier.
\1f
color of the `default' face is displayed in the next window after the
selected one.
- - Function: color-instance-p OBJECT
+ - Function: color-instance-p object
This function returns non-`nil' if OBJECT is a color-instance.
\1f
Color Instance Properties
-------------------------
- - Function: color-instance-name COLOR-INSTANCE
+ - Function: color-instance-name color-instance
This function returns the name used to allocate COLOR-INSTANCE.
- - Function: color-instance-rgb-components COLOR-INSTANCE
+ - Function: color-instance-rgb-components color-instance
This function returns a three element list containing the red,
green, and blue color components of COLOR-INSTANCE.
Color Convenience Functions
---------------------------
- - Function: color-name COLOR &optional DOMAIN
+ - Function: color-name color &optional domain
This function returns the name of the COLOR in the specified
DOMAIN, if any. COLOR should be a color specifier object and
DOMAIN is normally a window and defaults to the selected window if
omitted. This is equivalent to using `specifier-instance' and
applying `color-instance-name' to the result.
- - Function: color-rgb-components COLOR &optional DOMAIN
+ - Function: color-rgb-components color &optional domain
This function returns the RGB components of the COLOR in the
specified DOMAIN, if any. COLOR should be a color specifier
object and DOMAIN is normally a window and defaults to the
just the actual image: e.g. the face it is displayed in (for text
images), the alignment of the image (when it is in a buffer), etc.
- - Function: glyphp OBJECT
+ - Function: glyphp object
This function returns `t' if OBJECT is a glyph.
* Menu:
Creating Glyphs
---------------
- - Function: make-glyph &optional SPEC-LIST TYPE
+ - Function: make-glyph &optional spec-list type
This function creates a new glyph object of type TYPE.
SPEC-LIST is used to initialize the glyph's image. It is
for the mouse-pointer), or `icon' (used for a frame's icon), and
defaults to `buffer'. *Note Glyph Types::.
- - Function: make-glyph-internal &optional TYPE
+ - Function: make-glyph-internal &optional type
This function creates a new, uninitialized glyph of type TYPE.
- - Function: make-pointer-glyph &optional SPEC-LIST
+ - Function: make-pointer-glyph &optional spec-list
This function is equivalent to calling `make-glyph' with a TYPE of
`pointer'.
- - Function: make-icon-glyph &optional SPEC-LIST
+ - Function: make-icon-glyph &optional spec-list
This function is equivalent to calling `make-glyph' with a TYPE of
`icon'.
Only for glyphs displayed inside of a buffer.
`face'
- Face of this glyph (*not* a specifier).
+ Face of this glyph (_not_ a specifier).
- - Function: set-glyph-property GLYPH PROPERTY VALUE &optional LOCALE
- TAG-SET HOW-TO-ADD
+ - Function: set-glyph-property glyph property value &optional locale
+ tag-set how-to-add
This function changes a property of a GLYPH.
For built-in properties, the actual value of the property is a
If the value of the property is not a specifier, it will
automatically be converted into a `generic' specifier.
- - Function: glyph-property GLYPH PROPERTY &optional LOCALE
+ - Function: glyph-property glyph property &optional locale
This function returns GLYPH's value of the given PROPERTY.
If LOCALE is omitted, the GLYPH's actual value for PROPERTY will
`glyph-property-instance' actually does all this, and is used to
determine how to display the glyph.
- - Function: glyph-property-instance GLYPH PROPERTY &optional DOMAIN
- DEFAULT NO-FALLBACK
+ - Function: glyph-property-instance glyph property &optional domain
+ default no-fallback
This function returns the instance of GLYPH's PROPERTY in the
specified DOMAIN.
Optional arguments DEFAULT and NO-FALLBACK are the same as in
`specifier-instance'. *Note Specifiers::.
- - Function: remove-glyph-property GLYPH PROPERTY &optional LOCALE
- TAG-SET EXACT-P
+ - Function: remove-glyph-property glyph property &optional locale
+ tag-set exact-p
This function removes a property from a glyph. For built-in
properties, this is analogous to `remove-specifier'. *Note
remove-specifier-p: Specifiers, for the meaning of the LOCALE,
latter will return a boolean specifier or a list of specifications, and
you probably aren't concerned with these.)
- - Function: glyph-image GLYPH &optional LOCALE
+ - Function: glyph-image glyph &optional locale
This function is equivalent to calling `glyph-property' with a
property of `image'. The return value will be an image specifier
if LOCALE is `nil' or omitted; otherwise, it will be a
specification or list of specifications.
- - Function: set-glyph-image GLYPH SPEC &optional LOCALE TAG-SET
- HOW-TO-ADD
+ - Function: set-glyph-image glyph spec &optional locale tag-set
+ how-to-add
This function is equivalent to calling `set-glyph-property' with a
property of `image'.
- - Function: glyph-image-instance GLYPH &optional DOMAIN DEFAULT
- NO-FALLBACK
+ - Function: glyph-image-instance glyph &optional domain default
+ no-fallback
This function returns the instance of GLYPH's image in the given
DOMAIN, and is equivalent to calling `glyph-property-instance'
with a property of `image'. The return value will be an image
window), and an instance object describing how the image appears
in that particular window and buffer will be returned.
- - Function: glyph-contrib-p GLYPH &optional LOCALE
+ - Function: glyph-contrib-p glyph &optional locale
This function is equivalent to calling `glyph-property' with a
property of `contrib-p'. The return value will be a boolean
specifier if LOCALE is `nil' or omitted; otherwise, it will be a
specification or list of specifications.
- - Function: set-glyph-contrib-p GLYPH SPEC &optional LOCALE TAG-SET
- HOW-TO-ADD
+ - Function: set-glyph-contrib-p glyph spec &optional locale tag-set
+ how-to-add
This function is equivalent to calling `set-glyph-property' with a
property of `contrib-p'.
- - Function: glyph-contrib-p-instance GLYPH &optional DOMAIN DEFAULT
- NO-FALLBACK
+ - Function: glyph-contrib-p-instance glyph &optional domain default
+ no-fallback
This function returns whether the glyph contributes to its line
height in the given DOMAIN, and is equivalent to calling
`glyph-property-instance' with a property of `contrib-p'. The
return value will be either `nil' or `t'. (Normally DOMAIN will be
a window or `nil', meaning the selected window.)
- - Function: glyph-baseline GLYPH &optional LOCALE
+ - Function: glyph-baseline glyph &optional locale
This function is equivalent to calling `glyph-property' with a
property of `baseline'. The return value will be a specifier if
LOCALE is `nil' or omitted; otherwise, it will be a specification
or list of specifications.
- - Function: set-glyph-baseline GLYPH SPEC &optional LOCALE TAG-SET
- HOW-TO-ADD
+ - Function: set-glyph-baseline glyph spec &optional locale tag-set
+ how-to-add
This function is equivalent to calling `set-glyph-property' with a
property of `baseline'.
- - Function: glyph-baseline-instance GLYPH &optional DOMAIN DEFAULT
- NO-FALLBACK
+ - Function: glyph-baseline-instance glyph &optional domain default
+ no-fallback
This function returns the instance of GLYPH's baseline value in
the given DOMAIN, and is equivalent to calling
`glyph-property-instance' with a property of `baseline'. The
window), and an instance object describing the baseline value
appears in that particular window and buffer will be returned.
- - Function: glyph-face GLYPH
+ - Function: glyph-face glyph
This function returns the face of GLYPH. (Remember, this is not a
specifier, but a simple property.)
- - Function: set-glyph-face GLYPH FACE
+ - Function: set-glyph-face glyph face
This function changes the face of GLYPH to FACE.
\1f
Glyph Dimensions
----------------
- - Function: glyph-width GLYPH &optional WINDOW
+ - Function: glyph-width glyph &optional window
This function returns the width of GLYPH on WINDOW. This may not
be exact as it does not take into account all of the context that
redisplay will.
- - Function: glyph-ascent GLYPH &optional WINDOW
+ - Function: glyph-ascent glyph &optional window
This function returns the ascent value of GLYPH on WINDOW. This
may not be exact as it does not take into account all of the
context that redisplay will.
- - Function: glyph-descent GLYPH &optional WINDOW
+ - Function: glyph-descent glyph &optional window
This function returns the descent value of GLYPH on WINDOW. This
may not be exact as it does not take into account all of the
context that redisplay will.
- - Function: glyph-height GLYPH &optional WINDOW
+ - Function: glyph-height glyph &optional window
This function returns the height of GLYPH on WINDOW. (This is
equivalent to the sum of the ascent and descent values.) This may
not be exact as it does not take into account all of the context
projects / chise / xemacs-chise.git / blobdiff