-This is Info file ../info/lispref.info, produced by Makeinfo version
-1.68 from the input file lispref/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
----------------
An image specifier is used to describe the actual image of a glyph.
-It works like other specifiers (*note Specifiers::.), in that it
-contains a number of specifications describing how the image should
-appear in a variety of circumstances. These specifications are called
-"image instantiators". When XEmacs wants to display the image, it
-instantiates the image into an "image instance". Image instances are
-their own primitive object type (similar to font instances and color
-instances), describing how the image appears in a particular domain.
-(On the other hand, image instantiators, which are just descriptions of
-how the image should appear, are represented using strings or vectors.)
-
- - Function: image-specifier-p OBJECT
+It works like other specifiers (*note Specifiers::), in that it contains
+a number of specifications describing how the image should appear in a
+variety of circumstances. These specifications are called "image
+instantiators". When XEmacs wants to display the image, it instantiates
+the image into an "image instance". Image instances are their own
+primitive object type (similar to font instances and color instances),
+describing how the image appears in a particular domain. (On the other
+hand, image instantiators, which are just descriptions of how the image
+should appear, are represented using strings or vectors.)
+
+ - Function: image-specifier-p object
This function returns non-`nil' if OBJECT is an image specifier.
Usually, an image specifier results from calling `glyph-image' on
a glyph.
- - Function: make-image-specifier SPEC-LIST
+ - Function: make-image-specifier spec-list
This function creates a new image specifier object and initializes
it according to SPEC-LIST. It is unlikely that you will ever want
to do this, but this function is provided for completeness and for
image, but does not need to exist at any other time (e.g. it may safely
be a temporary file).
- - Function: valid-image-instantiator-format-p FORMAT
+ - Function: valid-image-instantiator-format-p format
This function returns non-`nil' if FORMAT is a valid image
instantiator format. Note that the return value for many formats
listed above depends on whether XEmacs was compiled with support
`(COLOR-NAME FORM-TO-EVALUATE)'. The COLOR-NAME should be a
string, which is the name of the color to define; the
FORM-TO-EVALUATE should evaluate to a color specifier object, or a
- string to be passed to `make-color-instance' (*note Colors::.). If
+ string to be passed to `make-color-instance' (*note Colors::). If
a loaded XPM file references a symbolic color called COLOR-NAME,
it will display as the computed color instead.
Image Instantiator Conversion
-----------------------------
- - Function: set-console-type-image-conversion-list CONSOLE-TYPE LIST
+ - Function: set-console-type-image-conversion-list console-type list
This function sets the image-conversion-list for consoles of the
given CONSOLE-TYPE. The image-conversion-list specifies how image
instantiators that are strings should be interpreted. Each
affects newly-added instantiators. Existing instantiators in
glyphs and image specifiers will not be affected.
- - Function: console-type-image-conversion-list CONSOLE-TYPE
+ - Function: console-type-image-conversion-list console-type
This function returns the image-conversion-list for consoles of
the given CONSOLE-TYPE.
to explicitly create image instances, if you want more control over the
instantiation process.
- - Function: image-instance-p OBJECT
+ - Function: image-instance-p object
This function returns non-`nil' if OBJECT is an image instance.
* Menu:
another program to be responsible for drawing into the window.
Not currently implemented.
- - Function: valid-image-instance-type-p TYPE
+ - Function: valid-image-instance-type-p type
This function returns non-`nil' if TYPE is a valid image instance
type.
- Function: image-instance-type-list
This function returns a list of the valid image instance types.
- - Function: image-instance-type IMAGE-INSTANCE
+ - Function: image-instance-type image-instance
This function returns the type of the given image instance. The
return value will be one of `nothing', `text', `mono-pixmap',
`color-pixmap', `pointer', or `subwindow'.
- - Function: text-image-instance-p OBJECT
+ - Function: text-image-instance-p object
This function returns non-`nil' if OBJECT is an image instance of
type `text'.
- - Function: mono-pixmap-image-instance-p OBJECT
+ - Function: mono-pixmap-image-instance-p object
This function returns non-`nil' if OBJECT is an image instance of
type `mono-pixmap'.
- - Function: color-pixmap-image-instance-p OBJECT
+ - Function: color-pixmap-image-instance-p object
This function returns non-`nil' if OBJECT is an image instance of
type `color-pixmap'.
- - Function: pointer-image-instance-p OBJECT
+ - Function: pointer-image-instance-p object
This function returns non-`nil' if OBJECT is an image instance of
type `pointer'.
- - Function: subwindow-image-instance-p OBJECT
+ - Function: subwindow-image-instance-p object
This function returns non-`nil' if OBJECT is an image instance of
type `subwindow'.
- - Function: nothing-image-instance-p OBJECT
+ - Function: nothing-image-instance-p object
This function returns non-`nil' if OBJECT is an image instance of
type `nothing'.
Image Instance Functions
........................
- - Function: make-image-instance DATA &optional DEVICE DEST-TYPES
- NO-ERROR
+ - Function: make-image-instance data &optional device dest-types
+ no-error
This function creates a new image-instance object.
DATA is an image instantiator, which describes the image (*note
- Image Specifiers::.).
+ Image Specifiers::).
DEST-TYPES should be a list of allowed image instance types that
can be generated. The DEST-TYPES list is unordered. If multiple
generated and this function returns NIL. If anything else, a
warning message is generated and this function returns NIL.
- - Function: colorize-image-instance IMAGE-INSTANCE FOREGROUND
- BACKGROUND
+ - Function: colorize-image-instance image-instance foreground
+ background
This function makes the image instance be displayed in the given
colors. Image instances come in two varieties: bitmaps, which are
1 bit deep which are rendered in the prevailing foreground and
instance was a pixmap already, nothing is done (and `nil' is
returned). Otherwise `t' is returned.
- - Function: image-instance-name IMAGE-INSTANCE
+ - Function: image-instance-name image-instance
This function returns the name of the given image instance.
- - Function: image-instance-string IMAGE-INSTANCE
+ - Function: image-instance-string image-instance
This function returns the string of the given image instance.
This will only be non-`nil' for text image instances.
- - Function: image-instance-file-name IMAGE-INSTANCE
+ - Function: image-instance-file-name image-instance
This function returns the file name from which IMAGE-INSTANCE was
read, if known.
- - Function: image-instance-mask-file-name IMAGE-INSTANCE
+ - Function: image-instance-mask-file-name image-instance
This function returns the file name from which IMAGE-INSTANCE's
mask was read, if known.
- - Function: image-instance-depth IMAGE-INSTANCE
+ - Function: image-instance-depth image-instance
This function returns the depth of the image instance. This is 0
for a mono pixmap, or a positive integer for a color pixmap.
- - Function: image-instance-height IMAGE-INSTANCE
+ - Function: image-instance-height image-instance
This function returns the height of the image instance, in pixels.
- - Function: image-instance-width IMAGE-INSTANCE
+ - Function: image-instance-width image-instance
This function returns the width of the image instance, in pixels.
- - Function: image-instance-hotspot-x IMAGE-INSTANCE
+ - Function: image-instance-hotspot-x image-instance
This function returns the X coordinate of the image instance's
hotspot, if known. This is a point relative to the origin of the
pixmap. When an image is used as a mouse pointer, the hotspot is
This will always be `nil' for a non-pointer image instance.
- - Function: image-instance-hotspot-y IMAGE-INSTANCE
+ - Function: image-instance-hotspot-y image-instance
This function returns the Y coordinate of the image instance's
hotspot, if known.
- - Function: image-instance-foreground IMAGE-INSTANCE
+ - Function: image-instance-foreground image-instance
This function returns the foreground color of IMAGE-INSTANCE, if
applicable. This will be a color instance or `nil'. (It will only
be non-`nil' for colorized mono pixmaps and for pointers.)
- - Function: image-instance-background IMAGE-INSTANCE
+ - Function: image-instance-background image-instance
This function returns the background color of IMAGE-INSTANCE, if
applicable. This will be a color instance or `nil'. (It will only
be non-`nil' for colorized mono pixmaps and for pointers.)
iconified. Their image can be instantiated as `mono-pixmap' and
`color-pixmap'.
- - Function: glyph-type GLYPH
+ - Function: glyph-type glyph
This function returns the type of the given glyph. The return
value will be a symbol, one of `buffer', `pointer', or `icon'.
- - Function: valid-glyph-type-p GLYPH-TYPE
+ - Function: valid-glyph-type-p glyph-type
Given a GLYPH-TYPE, this function returns non-`nil' if it is valid.
- Function: glyph-type-list
This function returns a list of valid glyph types.
- - Function: buffer-glyph-p OBJECT
+ - Function: buffer-glyph-p object
This function returns non-`nil' if OBJECT is a glyph of type
`buffer'.
- - Function: icon-glyph-p OBJECT
+ - Function: icon-glyph-p object
This function returns non-`nil' if OBJECT is a glyph of type
`icon'.
- - Function: pointer-glyph-p OBJECT
+ - Function: pointer-glyph-p object
This function returns non-`nil' if OBJECT is a glyph of type
`pointer'.
per-frame, per-window, or per-device basis.
You should use `set-glyph-image' to set the following variables,
-*not* `setq'.
+_not_ `setq'.
- Glyph: text-pointer-glyph
This variable specifies the shape of the mouse pointer when over
mouse moves. That function calls `set-frame-pointer', which sets the
current mouse pointer for a frame.
- - Function: set-frame-pointer FRAME IMAGE-INSTANCE
+ - Function: set-frame-pointer frame image-instance
This function sets the mouse pointer of FRAME to the given pointer
image instance. You should not call this function directly. (If
you do, the pointer will change again the next time the mouse
Subwindows are not currently implemented.
- - Function: subwindowp OBJECT
+ - Function: subwindowp object
This function returns non-`nil' if OBJECT is a subwindow.
\1f
Annotations can be displayed intermixed with text, in any whitespace at
the beginning or end of a line, or in a special area at the left or
right side of the frame called a "margin", whose size is controllable.
-Annotations are implemented using extents (*note Extents::.); but you
+Annotations are implemented using extents (*note Extents::); but you
can work with annotations without knowing how extents work.
* Menu:
Annotation Primitives
=====================
- - Function: make-annotation GLYPH &optional POSITION LAYOUT BUFFER
- WITH-EVENT D-GLYPH RIGHTP
+ - Function: make-annotation glyph &optional position layout buffer
+ with-event d-glyph rightp
This function creates a marginal annotation at position POS in
BUFFER. The annotation is displayed using GLYPH, which should be
a glyph object or a string, and is positioned using layout policy
The newly created annotation is returned.
- - Function: delete-annotation ANNOTATION
+ - Function: delete-annotation annotation
This function removes ANNOTATION from its buffer. This does not
modify the buffer text.
- - Function: annotationp ANNOTATION
+ - Function: annotationp annotation
This function returns `t' if ANNOTATION is an annotation, `nil'
otherwise.
Annotation Properties
=====================
- - Function: annotation-glyph ANNOTATION
+ - Function: annotation-glyph annotation
This function returns the glyph object used to display ANNOTATION.
- - Function: set-annotation-glyph ANNOTATION GLYPH &optional LAYOUT SIDE
+ - Function: set-annotation-glyph annotation glyph &optional layout side
This function sets the glyph of ANNOTATION to GLYPH, which should
be a glyph object. If LAYOUT is non-`nil', set the layout policy
of ANNOTATION to LAYOUT. If SIDE is `left' or `right', change the
side of the buffer at which the annotation is displayed to the
given side. The new value of `annotation-glyph' is returned.
- - Function: annotation-down-glyph ANNOTATION
+ - Function: annotation-down-glyph annotation
This function returns the glyph used to display ANNOTATION when
the left mouse button is depressed on the annotation.
- - Function: set-annotation-down-glyph ANNOTATION GLYPH
+ - Function: set-annotation-down-glyph annotation glyph
This function returns the glyph used to display ANNOTATION when
the left mouse button is depressed on the annotation to GLYPH,
which should be a glyph object.
- - Function: annotation-face ANNOTATION
+ - Function: annotation-face annotation
This function returns the face associated with ANNOTATION.
- - Function: set-annotation-face ANNOTATION FACE
+ - Function: set-annotation-face annotation face
This function sets the face associated with ANNOTATION to FACE.
- - Function: annotation-layout ANNOTATION
+ - Function: annotation-layout annotation
This function returns the layout policy of ANNOTATION.
- - Function: set-annotation-layout ANNOTATION LAYOUT
+ - Function: set-annotation-layout annotation layout
This function sets the layout policy of ANNOTATION to LAYOUT.
- - Function: annotation-side ANNOTATION
+ - Function: annotation-side annotation
This function returns the side of the buffer that ANNOTATION is
displayed on. Return value is a symbol, either `left' or `right'.
- - Function: annotation-data ANNOTATION
+ - Function: annotation-data annotation
This function returns the data associated with ANNOTATION.
- - Function: set-annotation-data ANNOTATION DATA
+ - Function: set-annotation-data annotation data
This function sets the data field of ANNOTATION to DATA. DATA is
returned.
- - Function: annotation-action ANNOTATION
+ - Function: annotation-action annotation
This function returns the action associated with ANNOTATION.
- - Function: set-annotation-action ANNOTATION ACTION
+ - Function: set-annotation-action annotation action
This function sets the action field of ANNOTATION to ACTION.
ACTION is returned..
- - Function: annotation-menu ANNOTATION
+ - Function: annotation-menu annotation
This function returns the menu associated with ANNOTATION.
- - Function: set-annotation-menu ANNOTATION MENU
+ - Function: set-annotation-menu annotation menu
This function sets the menu associated with ANNOTATION to MENU.
This menu will be displayed when the right mouse button is pressed
over the annotation.
- - Function: annotation-visible ANNOTATION
+ - Function: annotation-visible annotation
This function returns `t' if there is enough available space to
display ANNOTATION, `nil' otherwise.
- - Function: annotation-width ANNOTATION
+ - Function: annotation-width annotation
This function returns the width of ANNOTATION in pixels.
- - Function: hide-annotation ANNOTATION
+ - Function: hide-annotation annotation
This function removes ANNOTATION's glyph, making it invisible.
- - Function: reveal-annotation ANNOTATION
+ - Function: reveal-annotation annotation
This function restores ANNOTATION's glyph, making it visible.
\1f
Locating Annotations
====================
- - Function: annotations-in-region START END BUFFER
+ - Function: annotations-in-region start end buffer
This function returns a list of all annotations in BUFFER which
are between START and END inclusively.
- - Function: annotations-at &optional POSITION BUFFER
+ - Function: annotations-at &optional position buffer
This function returns a list of all annotations at POSITION in
BUFFER. If POSITION is `nil' point is used. If BUFFER is `nil'
the current buffer is used.
- - Function: annotation-list &optional BUFFER
+ - Function: annotation-list &optional buffer
This function returns a list of all annotations in BUFFER. If
BUFFER is `nil', the current buffer is used.
to `nil'. This is a specifier variable; use `set-specifier' to
change its value.
- - Function: window-left-margin-pixel-width &optional WINDOW
+ - Function: window-left-margin-pixel-width &optional window
This function returns the width in pixels of the left outside
margin of WINDOW. If WINDOW is `nil', the selected window is
assumed.
- - Function: window-right-margin-pixel-width &optional WINDOW
+ - Function: window-right-margin-pixel-width &optional window
This function returns the width in pixels of the right outside
margin of WINDOW. If WINDOW is `nil', the selected window is
assumed.
The function `redraw-frame' redisplays the entire contents of a
given frame. *Note Frames::.
- - Function: redraw-frame FRAME
+ - Function: redraw-frame frame
This function clears and redisplays frame FRAME.
Even more powerful is `redraw-display':
- - Command: redraw-display &optional DEVICE
+ - Command: redraw-display &optional device
This function redraws all frames on DEVICE marked as having their
image garbled. DEVICE defaults to the selected device. If DEVICE
is `t', all devices will have their frames checked.
- User Option: truncate-partial-width-windows
This variable controls display of lines that extend beyond the
right edge of the window, in side-by-side windows (*note Splitting
- Windows::.). If it is non-`nil', these lines are truncated;
+ Windows::). If it is non-`nil', these lines are truncated;
otherwise, `truncate-lines' says what to do with them.
The backslash and curved arrow used to indicate truncated or
continued lines are only defaults, and can be changed. These images
-are actually glyphs (*note Glyphs::.). XEmacs provides a great deal of
+are actually glyphs (*note Glyphs::). XEmacs provides a great deal of
flexibility in how glyphs can be controlled. (This differs from FSF
Emacs, which uses display tables to control these images.)
projects / chise / xemacs-chise.git / blobdiff