annotate lisp/objects.el @ 400:a86b2b5e0111 r21-2-30

Import from CVS: tag r21-2-30
author cvs
date Mon, 13 Aug 2007 11:14:34 +0200
parents 70ad99077275
children 501cfd01ee6d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
1 ;;; objects.el --- Lisp interface to C window-system objects
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
2
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
3 ;; Copyright (C) 1994, 1997 Free Software Foundation, Inc.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
4 ;; Copyright (C) 1995 Ben Wing
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
5
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
6 ;; Author: Chuck Thompson <cthomp@xemacs.org>
298
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 272
diff changeset
7 ;; Author: Ben Wing <ben@xemacs.org>
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
8 ;; Maintainer: XEmacs Development Team
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
9 ;; Keywords: faces, internal, dumped
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
10
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
11 ;; This file is part of XEmacs.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
12
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
13 ;; XEmacs is free software; you can redistribute it and/or modify it
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
14 ;; under the terms of the GNU General Public License as published by
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
15 ;; the Free Software Foundation; either version 2, or (at your option)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
16 ;; any later version.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
17
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
18 ;; XEmacs is distributed in the hope that it will be useful, but
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
19 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
21 ;; General Public License for more details.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
22
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
23 ;; You should have received a copy of the GNU General Public License
272
c5d627a313b1 Import from CVS: tag r21-0b34
cvs
parents: 209
diff changeset
24 ;; along with XEmacs; see the file COPYING. If not, write to the
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
25 ;; Free Software Foundation, 59 Temple Place - Suite 330,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
26 ;; Boston, MA 02111-1307, USA.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
27
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
28 ;;; Synched up with: Not in FSF.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
29
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
30 ;;; Commentary:
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
31
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
32 ;; This file is dumped with XEmacs.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
33
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
34 ;;; Code:
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
35
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
36 (defun ws-object-property-1 (function object domain &optional matchspec)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
37 (let ((instance (if matchspec
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
38 (specifier-matching-instance object matchspec domain)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
39 (specifier-instance object domain))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
40 (and instance (funcall function instance))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
41
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
42 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; font specifiers
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
43
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
44 (defun make-font-specifier (spec-list)
272
c5d627a313b1 Import from CVS: tag r21-0b34
cvs
parents: 209
diff changeset
45 "Return a new `font' specifier object with the given specification list.
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
46 SPEC-LIST can be a list of specifications (each of which is a cons of a
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
47 locale and a list of instantiators), a single instantiator, or a list
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
48 of instantiators. See `make-specifier' for more information about
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
49 specifiers."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
50 (make-specifier-and-init 'font spec-list))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
51
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
52 (defun font-name (font &optional domain charset)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
53 "Return the name of the FONT in the specified DOMAIN, if any.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
54 FONT should be a font specifier object and DOMAIN is normally a window
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
55 and defaults to the selected window if omitted. This is equivalent
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
56 to using `specifier-instance' and applying `font-instance-name' to
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
57 the result. See `make-specifier' for more information about specifiers."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
58 (ws-object-property-1 'font-instance-name font domain charset))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
59
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
60 (defun font-ascent (font &optional domain charset)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
61 "Return the ascent of the FONT in the specified DOMAIN, if any.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
62 FONT should be a font specifier object and DOMAIN is normally a window
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
63 and defaults to the selected window if omitted. This is equivalent
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
64 to using `specifier-instance' and applying `font-instance-ascent' to
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
65 the result. See `make-specifier' for more information about specifiers."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
66 (ws-object-property-1 'font-instance-ascent font domain charset))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
67
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
68 (defun font-descent (font &optional domain charset)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
69 "Return the descent of the FONT in the specified DOMAIN, if any.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
70 FONT should be a font specifier object and DOMAIN is normally a window
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
71 and defaults to the selected window if omitted. This is equivalent
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
72 to using `specifier-instance' and applying `font-instance-descent' to
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
73 the result. See `make-specifier' for more information about specifiers."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
74 (ws-object-property-1 'font-instance-descent font domain charset))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
75
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
76 (defun font-width (font &optional domain charset)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
77 "Return the width of the FONT in the specified DOMAIN, if any.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
78 FONT should be a font specifier object and DOMAIN is normally a window
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
79 and defaults to the selected window if omitted. This is equivalent
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
80 to using `specifier-instance' and applying `font-instance-width' to
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
81 the result. See `make-specifier' for more information about specifiers."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
82 (ws-object-property-1 'font-instance-width font domain charset))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
83
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
84 (defun font-height (font &optional domain charset)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
85 "Return the height of the FONT in the specified DOMAIN, if any.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
86 FONT should be a font specifier object and DOMAIN is normally a window
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
87 and defaults to the selected window if omitted. This is equivalent
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
88 to using `specifier-instance' and applying `font-instance-height' to
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
89 the result. See `make-specifier' for more information about specifiers."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
90 (ws-object-property-1 'font-instance-height font domain charset))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
91
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
92 (defun font-proportional-p (font &optional domain charset)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
93 "Return whether FONT is proportional in the specified DOMAIN, if known.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
94 FONT should be a font specifier object and DOMAIN is normally a window
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
95 and defaults to the selected window if omitted. This is equivalent
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
96 to using `specifier-instance' and applying `font-instance-proportional-p' to
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
97 the result. See `make-specifier' for more information about specifiers."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
98 (ws-object-property-1 'font-instance-proportional-p font domain charset))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
99
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
100 (defun font-properties (font &optional domain charset)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
101 "Return the properties of the FONT in the specified DOMAIN, if any.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
102 FONT should be a font specifier object and DOMAIN is normally a window
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
103 and defaults to the selected window if omitted. This is equivalent
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
104 to using `specifier-instance' and applying `font-instance-properties'
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
105 to the result. See `make-specifier' for more information about specifiers."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
106 (ws-object-property-1 'font-instance-properties font domain charset))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
107
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
108 (defun font-truename (font &optional domain charset)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
109 "Return the truename of the FONT in the specified DOMAIN, if any.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
110 FONT should be a font specifier object and DOMAIN is normally a window
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
111 and defaults to the selected window if omitted. This is equivalent
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
112 to using `specifier-instance' and applying `font-instance-truename'
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
113 to the result. See `make-specifier' for more information about specifiers."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
114 (ws-object-property-1 'font-instance-truename font domain charset))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
115
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
116 (defun font-instance-height (font-instance)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
117 "Return the height in pixels of FONT-INSTANCE.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
118 The returned value is the maximum height for all characters in the font,\n\
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
119 and is equivalent to the sum of the font instance's ascent and descent."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
120 (+ (font-instance-ascent font-instance)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
121 (font-instance-descent font-instance)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
122
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
123 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; color specifiers
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
124
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
125 (defun make-color-specifier (spec-list)
272
c5d627a313b1 Import from CVS: tag r21-0b34
cvs
parents: 209
diff changeset
126 "Return a new `color' specifier object with the given specification list.
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
127 SPEC-LIST can be a list of specifications (each of which is a cons of a
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
128 locale and a list of instantiators), a single instantiator, or a list
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
129 of instantiators. See `make-specifier' for a detailed description of
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
130 how specifiers work."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
131 (make-specifier-and-init 'color spec-list))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
132
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
133 (defun color-name (color &optional domain)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
134 "Return the name of the COLOR in the specified DOMAIN, if any.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
135 COLOR should be a color specifier object and DOMAIN is normally a window
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
136 and defaults to the selected window if omitted. This is equivalent
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
137 to using `specifier-instance' and applying `color-instance-name' to
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
138 the result. See `make-specifier' for more information about specifiers."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
139 (ws-object-property-1 'color-instance-name color domain))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
140
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
141 (defun color-rgb-components (color &optional domain)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
142 "Return the RGB components of the COLOR in the specified DOMAIN, if any.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
143 COLOR should be a color specifier object and DOMAIN is normally a window
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
144 and defaults to the selected window if omitted. This is equivalent
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
145 to using `specifier-instance' and applying `color-instance-rgb-components'
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
146 to the result. See `make-specifier' for more information about specifiers."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
147 (ws-object-property-1 'color-instance-rgb-components color domain))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
148
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
149 ;;; objects.el ends here.